blob: 102eb62abd19e735aaf7b63c0f7277acfc7712d4 [file] [log] [blame]
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02001*options.txt* For Vim version 8.2. Last change: 2020 Aug 07
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*
Bram Moolenaar6b915c02020-01-18 15:53:19 +010025:se[t][!] Show all options that differ from their default value.
26 When [!] is present every option is on a separate
27 line.
Bram Moolenaar071d4272004-06-13 20:20:40 +000028
Bram Moolenaar6b915c02020-01-18 15:53:19 +010029:se[t][!] all Show all but terminal options.
30 When [!] is present every option is on a separate
31 line.
Bram Moolenaar071d4272004-06-13 20:20:40 +000032
33:se[t] termcap Show all terminal options. Note that in the GUI the
34 key codes are not shown, because they are generated
35 internally and can't be changed. Changing the terminal
36 codes in the GUI is not useful either...
37
38 *E518* *E519*
39:se[t] {option}? Show value of {option}.
40
41:se[t] {option} Toggle option: set, switch it on.
42 Number option: show value.
43 String option: show value.
44
45:se[t] no{option} Toggle option: Reset, switch it off.
46
Bram Moolenaar00a927d2010-05-14 23:24:24 +020047 *:set-!* *:set-inv*
Bram Moolenaar071d4272004-06-13 20:20:40 +000048:se[t] {option}! or
Bram Moolenaar6c60f472019-04-28 16:00:35 +020049:se[t] inv{option} Toggle option: Invert value.
Bram Moolenaar071d4272004-06-13 20:20:40 +000050
51 *:set-default* *:set-&* *:set-&vi* *:set-&vim*
52:se[t] {option}& Reset option to its default value. May depend on the
Bram Moolenaar6c60f472019-04-28 16:00:35 +020053 current value of 'compatible'.
54:se[t] {option}&vi Reset option to its Vi default value.
55:se[t] {option}&vim Reset option to its Vim default value.
Bram Moolenaar071d4272004-06-13 20:20:40 +000056
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +010057:se[t] all& Set all options to their default value. The values of
Bram Moolenaar88774fd2015-08-25 19:52:04 +020058 these options are not changed:
59 all terminal options, starting with t_
60 'columns'
61 'cryptmethod'
62 'encoding'
63 'key'
64 'lines'
65 'term'
66 'ttymouse'
67 'ttytype'
68 Warning: This may have a lot of side effects.
Bram Moolenaar071d4272004-06-13 20:20:40 +000069
70 *:set-args* *E487* *E521*
71:se[t] {option}={value} or
72:se[t] {option}:{value}
73 Set string or number option to {value}.
74 For numeric options the value can be given in decimal,
Bram Moolenaar3848e002016-03-19 18:42:29 +010075 hex (preceded with 0x) or octal (preceded with '0').
Bram Moolenaar071d4272004-06-13 20:20:40 +000076 The old value can be inserted by typing 'wildchar' (by
77 default this is a <Tab> or CTRL-E if 'compatible' is
78 set). See |cmdline-completion|.
79 White space between {option} and '=' is allowed and
80 will be ignored. White space between '=' and {value}
81 is not allowed.
82 See |option-backslash| for using white space and
83 backslashes in {value}.
84
85:se[t] {option}+={value} *:set+=*
86 Add the {value} to a number option, or append the
87 {value} to a string option. When the option is a
88 comma separated list, a comma is added, unless the
89 value was empty.
90 If the option is a list of flags, superfluous flags
Bram Moolenaara5792f52005-11-23 21:25:05 +000091 are removed. When adding a flag that was already
92 present the option value doesn't change.
Bram Moolenaar899dddf2006-03-26 21:06:50 +000093 Also see |:set-args| above.
Bram Moolenaar071d4272004-06-13 20:20:40 +000094
95:se[t] {option}^={value} *:set^=*
96 Multiply the {value} to a number option, or prepend
97 the {value} to a string option. When the option is a
98 comma separated list, a comma is added, unless the
99 value was empty.
100 Also see |:set-args| above.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000101
102:se[t] {option}-={value} *:set-=*
103 Subtract the {value} from a number option, or remove
104 the {value} from a string option, if it is there.
105 If the {value} is not found in a string option, there
106 is no error or warning. When the option is a comma
107 separated list, a comma is deleted, unless the option
108 becomes empty.
109 When the option is a list of flags, {value} must be
110 exactly as they appear in the option. Remove flags
111 one by one to avoid problems.
112 Also see |:set-args| above.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000113
114The {option} arguments to ":set" may be repeated. For example: >
115 :set ai nosi sw=3 ts=3
116If you make an error in one of the arguments, an error message will be given
117and the following arguments will be ignored.
118
119 *:set-verbose*
120When 'verbose' is non-zero, displaying an option value will also tell where it
121was last set. Example: >
122 :verbose set shiftwidth cindent?
Bram Moolenaar95bafa22018-10-02 13:26:25 +0200123< shiftwidth=4 ~
124 Last set from modeline line 1 ~
125 cindent ~
126 Last set from /usr/local/share/vim/vim60/ftplugin/c.vim line 30 ~
Bram Moolenaar446cb832008-06-24 21:56:24 +0000127This is only done when specific option values are requested, not for ":verbose
128set all" or ":verbose set" without an argument.
129When the option was set by hand there is no "Last set" message.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000130When the option was set while executing a function, user command or
131autocommand, the script in which it was defined is reported.
132Note that an option may also have been set as a side effect of setting
133'compatible'.
Bram Moolenaar446cb832008-06-24 21:56:24 +0000134A few special texts:
Bram Moolenaar95bafa22018-10-02 13:26:25 +0200135 Last set from modeline line 1 ~
Bram Moolenaar446cb832008-06-24 21:56:24 +0000136 Option was set in a |modeline|.
137 Last set from --cmd argument ~
138 Option was set with command line argument |--cmd| or +.
139 Last set from -c argument ~
140 Option was set with command line argument |-c|, +, |-S| or
141 |-q|.
142 Last set from environment variable ~
143 Option was set from an environment variable, $VIMINIT,
144 $GVIMINIT or $EXINIT.
145 Last set from error handler ~
146 Option was cleared when evaluating it resulted in an error.
147
Bram Moolenaardb84e452010-08-15 13:50:43 +0200148{not available when compiled without the |+eval| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000149
150 *:set-termcap* *E522*
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +0000151For {option} the form "t_xx" may be used to set a terminal option. This will
Bram Moolenaar071d4272004-06-13 20:20:40 +0000152override the value from the termcap. You can then use it in a mapping. If
153the "xx" part contains special characters, use the <t_xx> form: >
154 :set <t_#4>=^[Ot
155This can also be used to translate a special code for a normal key. For
156example, if Alt-b produces <Esc>b, use this: >
157 :set <M-b>=^[b
158(the ^[ is a real <Esc> here, use CTRL-V <Esc> to enter it)
159The advantage over a mapping is that it works in all situations.
160
Bram Moolenaar0b2f94d2011-03-22 14:35:05 +0100161You can define any key codes, e.g.: >
162 :set t_xy=^[foo;
163There is no warning for using a name that isn't recognized. You can map these
164codes as you like: >
165 :map <t_xy> something
166< *E846*
167When a key code is not set, it's like it does not exist. Trying to get its
168value will result in an error: >
169 :set t_kb=
170 :set t_kb
171 E846: Key code not set: t_kb
172
Bram Moolenaar293ee4d2004-12-09 21:34:53 +0000173The t_xx options cannot be set from a |modeline| or in the |sandbox|, for
174security reasons.
175
Bram Moolenaar071d4272004-06-13 20:20:40 +0000176The listing from ":set" looks different from Vi. Long string options are put
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000177at the end of the list. The number of options is quite large. The output of
Bram Moolenaar071d4272004-06-13 20:20:40 +0000178"set all" probably does not fit on the screen, causing Vim to give the
179|more-prompt|.
180
181 *option-backslash*
182To include white space in a string option value it has to be preceded with a
183backslash. To include a backslash you have to use two. Effectively this
184means that the number of backslashes in an option value is halved (rounded
185down).
186A few examples: >
187 :set tags=tags\ /usr/tags results in "tags /usr/tags"
188 :set tags=tags\\,file results in "tags\,file"
189 :set tags=tags\\\ file results in "tags\ file"
190
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000191The "|" character separates a ":set" command from a following command. To
192include the "|" in the option value, use "\|" instead. This example sets the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000193'titlestring' option to "hi|there": >
194 :set titlestring=hi\|there
195This sets the 'titlestring' option to "hi" and 'iconstring' to "there": >
196 :set titlestring=hi|set iconstring=there
197
Bram Moolenaar7df351e2006-01-23 22:30:28 +0000198Similarly, the double quote character starts a comment. To include the '"' in
199the option value, use '\"' instead. This example sets the 'titlestring'
200option to 'hi "there"': >
201 :set titlestring=hi\ \"there\"
202
Bram Moolenaar5666fcd2019-12-26 14:35:26 +0100203For Win32 backslashes in file names are mostly not removed. More precise: For
204options that expect a file name (those where environment variables are
205expanded) a backslash before a normal file name character is not removed. But
206a backslash before a special character (space, backslash, comma, etc.) is used
207like explained above.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000208There is one special situation, when the value starts with "\\": >
209 :set dir=\\machine\path results in "\\machine\path"
210 :set dir=\\\\machine\\path results in "\\machine\path"
211 :set dir=\\path\\file results in "\\path\file" (wrong!)
212For the first one the start is kept, but for the second one the backslashes
213are halved. This makes sure it works both when you expect backslashes to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000214halved and when you expect the backslashes to be kept. The third gives a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000215result which is probably not what you want. Avoid it.
216
217 *add-option-flags* *remove-option-flags*
218 *E539* *E550* *E551* *E552*
219Some options are a list of flags. When you want to add a flag to such an
220option, without changing the existing ones, you can do it like this: >
221 :set guioptions+=a
222Remove a flag from an option like this: >
223 :set guioptions-=a
224This removes the 'a' flag from 'guioptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000225Note that you should add or remove one flag at a time. If 'guioptions' has
Bram Moolenaar071d4272004-06-13 20:20:40 +0000226the value "ab", using "set guioptions-=ba" won't work, because the string "ba"
227doesn't appear.
228
229 *:set_env* *expand-env* *expand-environment-var*
Bram Moolenaard4755bb2004-09-02 19:12:26 +0000230Environment variables in specific string options will be expanded. If the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000231environment variable exists the '$' and the following environment variable
232name is replaced with its value. If it does not exist the '$' and the name
233are not modified. Any non-id character (not a letter, digit or '_') may
234follow the environment variable name. That character and what follows is
235appended to the value of the environment variable. Examples: >
236 :set term=$TERM.new
237 :set path=/usr/$INCLUDE,$HOME/include,.
238When adding or removing a string from an option with ":set opt-=val" or ":set
239opt+=val" the expansion is done before the adding or removing.
240
241
242Handling of local options *local-options*
243
244Some of the options only apply to a window or buffer. Each window or buffer
Bram Moolenaar51628222016-12-01 23:03:28 +0100245has its own copy of this option, thus each can have its own value. This
Bram Moolenaar071d4272004-06-13 20:20:40 +0000246allows you to set 'list' in one window but not in another. And set
247'shiftwidth' to 3 in one buffer and 4 in another.
248
249The following explains what happens to these local options in specific
250situations. You don't really need to know all of this, since Vim mostly uses
251the option values you would expect. Unfortunately, doing what the user
252expects is a bit complicated...
253
254When splitting a window, the local options are copied to the new window. Thus
255right after the split the contents of the two windows look the same.
256
257When editing a new buffer, its local option values must be initialized. Since
258the local options of the current buffer might be specifically for that buffer,
259these are not used. Instead, for each buffer-local option there also is a
260global value, which is used for new buffers. With ":set" both the local and
261global value is changed. With "setlocal" only the local value is changed,
262thus this value is not used when editing a new buffer.
263
Bram Moolenaar95ec9d62016-08-12 18:29:59 +0200264When editing a buffer that has been edited before, the options from the window
265that was last closed are used again. If this buffer has been edited in this
266window, the values from back then are used. Otherwise the values from the
267last closed window where the buffer was edited last are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000268
269It's possible to set a local window option specifically for a type of buffer.
270When you edit another buffer in the same window, you don't want to keep
271using these local window options. Therefore Vim keeps a global value of the
272local window options, which is used when editing another buffer. Each window
273has its own copy of these values. Thus these are local to the window, but
274global to all buffers in the window. With this you can do: >
275 :e one
276 :set list
277 :e two
278Now the 'list' option will also be set in "two", since with the ":set list"
279command you have also set the global value. >
280 :set nolist
281 :e one
282 :setlocal list
283 :e two
284Now the 'list' option is not set, because ":set nolist" resets the global
285value, ":setlocal list" only changes the local value and ":e two" gets the
286global value. Note that if you do this next: >
287 :e one
Bram Moolenaar531da592013-05-06 05:58:55 +0200288You will get back the 'list' value as it was the last time you edited "one".
289The options local to a window are remembered for each buffer. This also
290happens when the buffer is not loaded, but they are lost when the buffer is
291wiped out |:bwipe|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000292
293 *:setl* *:setlocal*
Bram Moolenaar6b915c02020-01-18 15:53:19 +0100294:setl[ocal][!] ... Like ":set" but set only the value local to the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000295 current buffer or window. Not all options have a
296 local value. If the option does not have a local
297 value the global value is set.
Bram Moolenaarc3301872010-07-25 20:53:06 +0200298 With the "all" argument: display local values for all
299 local options.
300 Without argument: Display local values for all local
301 options which are different from the default.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000302 When displaying a specific local option, show the
Bram Moolenaar446cb832008-06-24 21:56:24 +0000303 local value. For a global/local boolean option, when
304 the global value is being used, "--" is displayed
305 before the option name.
306 For a global option the global value is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000307 shown (but that might change in the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000308
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000309:setl[ocal] {option}< Set the local value of {option} to its global value by
310 copying the value.
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000311
Bram Moolenaar6be7f872012-01-20 21:08:56 +0100312:se[t] {option}< For |global-local| options: Remove the local value of
313 {option}, so that the global value will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000314
315 *:setg* *:setglobal*
Bram Moolenaar6b915c02020-01-18 15:53:19 +0100316:setg[lobal][!] ... Like ":set" but set only the global value for a local
Bram Moolenaar071d4272004-06-13 20:20:40 +0000317 option without changing the local value.
318 When displaying an option, the global value is shown.
Bram Moolenaarc3301872010-07-25 20:53:06 +0200319 With the "all" argument: display global values for all
320 local options.
321 Without argument: display global values for all local
322 options which are different from the default.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000323
324For buffer-local and window-local options:
325 Command global value local value ~
326 :set option=value set set
327 :setlocal option=value - set
328:setglobal option=value set -
329 :set option? - display
330 :setlocal option? - display
331:setglobal option? display -
332
333
334Global options with a local value *global-local*
335
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +0000336Options are global when you mostly use one value for all buffers and windows.
337For some global options it's useful to sometimes have a different local value.
338You can set the local value with ":setlocal". That buffer or window will then
339use the local value, while other buffers and windows continue using the global
340value.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000341
342For example, you have two windows, both on C source code. They use the global
343'makeprg' option. If you do this in one of the two windows: >
344 :set makeprg=gmake
345then the other window will switch to the same value. There is no need to set
346the 'makeprg' option in the other C source window too.
347However, if you start editing a Perl file in a new window, you want to use
Bram Moolenaar02467872007-05-06 13:22:01 +0000348another 'makeprg' for it, without changing the value used for the C source
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000349files. You use this command: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000350 :setlocal makeprg=perlmake
351You can switch back to using the global value by making the local value empty: >
352 :setlocal makeprg=
Bram Moolenaar314dd792019-02-03 15:27:20 +0100353This only works for a string option. For a number or boolean option you need
354to use the "<" flag, like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000355 :setlocal autoread<
Bram Moolenaar314dd792019-02-03 15:27:20 +0100356Note that for non-boolean and non-number options using "<" copies the global
357value to the local value, it doesn't switch back to using the global value
358(that matters when the global value changes later). You can also use: >
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000359 :set path<
360This will make the local value of 'path' empty, so that the global value is
361used. Thus it does the same as: >
362 :setlocal path=
Bram Moolenaar071d4272004-06-13 20:20:40 +0000363Note: In the future more global options can be made global-local. Using
364":setlocal" on a global option might work differently then.
365
366
367Setting the filetype
368
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200369:setf[iletype] [FALLBACK] {filetype} *:setf* *:setfiletype*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000370 Set the 'filetype' option to {filetype}, but only if
371 not done yet in a sequence of (nested) autocommands.
372 This is short for: >
373 :if !did_filetype()
374 : setlocal filetype={filetype}
375 :endif
376< This command is used in a filetype.vim file to avoid
377 setting the 'filetype' option twice, causing different
378 settings and syntax files to be loaded.
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200379
380 When the optional FALLBACK argument is present, a
381 later :setfiletype command will override the
Bram Moolenaar26967612019-03-17 17:13:16 +0100382 'filetype'. This is to be used for filetype
383 detections that are just a guess. |did_filetype()|
384 will return false after this command.
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200385
Bram Moolenaard58e9292011-02-09 17:07:58 +0100386 *option-window* *optwin*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000387:bro[wse] se[t] *:set-browse* *:browse-set* *:opt* *:options*
388:opt[ions] Open a window for viewing and setting all options.
389 Options are grouped by function.
390 Offers short help for each option. Hit <CR> on the
391 short help to open a help window with more help for
392 the option.
393 Modify the value of the option and hit <CR> on the
394 "set" line to set the new value. For window and
395 buffer specific options, the last accessed window is
396 used to set the option value in, unless this is a help
397 window, in which case the window below help window is
398 used (skipping the option-window).
Bram Moolenaarb5b75622018-03-09 22:22:21 +0100399 {not available when compiled without the |+eval|
400 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000401
402 *$HOME*
403Using "~" is like using "$HOME", but it is only recognized at the start of an
404option and after a space or comma.
405
406On Unix systems "~user" can be used too. It is replaced by the home directory
407of user "user". Example: >
408 :set path=~mool/include,/usr/include,.
409
410On Unix systems the form "${HOME}" can be used too. The name between {} can
411contain non-id characters then. Note that if you want to use this for the
412"gf" command, you need to add the '{' and '}' characters to 'isfname'.
413
414NOTE: expanding environment variables and "~/" is only done with the ":set"
415command, not when assigning a value to an option with ":let".
416
Bram Moolenaarc572da52017-08-27 16:52:01 +0200417 *$HOME-windows*
418On MS-Windows, if $HOME is not defined as an environment variable, then
419at runtime Vim will set it to the expansion of $HOMEDRIVE$HOMEPATH.
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200420If $HOMEDRIVE is not set then $USERPROFILE is used.
421
422This expanded value is not exported to the environment, this matters when
423running an external command: >
424 :echo system('set | findstr ^HOME=')
425and >
426 :echo luaeval('os.getenv("HOME")')
427should echo nothing (an empty string) despite exists('$HOME') being true.
428When setting $HOME to a non-empty string it will be exported to the
429subprocesses.
Bram Moolenaarc572da52017-08-27 16:52:01 +0200430
Bram Moolenaar071d4272004-06-13 20:20:40 +0000431
432Note the maximum length of an expanded option is limited. How much depends on
433the system, mostly it is something like 256 or 1024 characters.
434
435 *:fix* *:fixdel*
436:fix[del] Set the value of 't_kD':
437 't_kb' is 't_kD' becomes ~
438 CTRL-? CTRL-H
439 not CTRL-? CTRL-?
440
Bram Moolenaar6c60f472019-04-28 16:00:35 +0200441 (CTRL-? is 0177 octal, 0x7f hex)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000442
443 If your delete key terminal code is wrong, but the
444 code for backspace is alright, you can put this in
445 your .vimrc: >
446 :fixdel
447< This works no matter what the actual code for
448 backspace is.
449
450 If the backspace key terminal code is wrong you can
451 use this: >
452 :if &term == "termname"
453 : set t_kb=^V<BS>
454 : fixdel
455 :endif
456< Where "^V" is CTRL-V and "<BS>" is the backspace key
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000457 (don't type four characters!). Replace "termname"
Bram Moolenaar071d4272004-06-13 20:20:40 +0000458 with your terminal name.
459
460 If your <Delete> key sends a strange key sequence (not
461 CTRL-? or CTRL-H) you cannot use ":fixdel". Then use: >
462 :if &term == "termname"
463 : set t_kD=^V<Delete>
464 :endif
465< Where "^V" is CTRL-V and "<Delete>" is the delete key
466 (don't type eight characters!). Replace "termname"
467 with your terminal name.
468
469 *Linux-backspace*
470 Note about Linux: By default the backspace key
471 produces CTRL-?, which is wrong. You can fix it by
472 putting this line in your rc.local: >
473 echo "keycode 14 = BackSpace" | loadkeys
474<
475 *NetBSD-backspace*
476 Note about NetBSD: If your backspace doesn't produce
477 the right code, try this: >
478 xmodmap -e "keycode 22 = BackSpace"
479< If this works, add this in your .Xmodmap file: >
480 keysym 22 = BackSpace
481< You need to restart for this to take effect.
482
483==============================================================================
4842. Automatically setting options *auto-setting*
485
486Besides changing options with the ":set" command, there are three alternatives
487to set options automatically for one or more files:
488
4891. When starting Vim initializations are read from various places. See
490 |initialization|. Most of them are performed for all editing sessions,
491 and some of them depend on the directory where Vim is started.
492 You can create an initialization file with |:mkvimrc|, |:mkview| and
493 |:mksession|.
4942. If you start editing a new file, the automatic commands are executed.
495 This can be used to set options for files matching a particular pattern and
496 many other things. See |autocommand|.
4973. If you start editing a new file, and the 'modeline' option is on, a
498 number of lines at the beginning and end of the file are checked for
499 modelines. This is explained here.
500
501 *modeline* *vim:* *vi:* *ex:* *E520*
502There are two forms of modelines. The first form:
Bram Moolenaar664f3cf2019-12-07 16:03:51 +0100503 [text{white}]{vi:|vim:|ex:}[white]{options}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000504
Bram Moolenaar664f3cf2019-12-07 16:03:51 +0100505[text{white}] empty or any text followed by at least one blank
506 character (<Space> or <Tab>); "ex:" always requires at
507 least one blank character
Bram Moolenaar14b69452013-06-29 23:05:20 +0200508{vi:|vim:|ex:} the string "vi:", "vim:" or "ex:"
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200509[white] optional white space
510{options} a list of option settings, separated with white space
511 or ':', where each part between ':' is the argument
512 for a ":set" command (can be empty)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000513
Bram Moolenaar14b69452013-06-29 23:05:20 +0200514Examples:
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000515 vi:noai:sw=3 ts=6 ~
Bram Moolenaar14b69452013-06-29 23:05:20 +0200516 vim: tw=77 ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000517
518The second form (this is compatible with some versions of Vi):
519
Bram Moolenaarade0d392020-01-21 22:33:58 +0100520 [text{white}]{vi:|vim:|Vim:|ex:}[white]se[t] {options}:[text]
Bram Moolenaar071d4272004-06-13 20:20:40 +0000521
Bram Moolenaarade0d392020-01-21 22:33:58 +0100522[text{white}] empty or any text followed by at least one blank
523 character (<Space> or <Tab>); "ex:" always requires at
524 least one blank character
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200525{vi:|vim:|Vim:|ex:} the string "vi:", "vim:", "Vim:" or "ex:"
526[white] optional white space
Bram Moolenaar14b69452013-06-29 23:05:20 +0200527se[t] the string "set " or "se " (note the space); When
528 "Vim" is used it must be "set".
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200529{options} a list of options, separated with white space, which
530 is the argument for a ":set" command
531: a colon
532[text] any text or empty
Bram Moolenaar071d4272004-06-13 20:20:40 +0000533
Bram Moolenaar14b69452013-06-29 23:05:20 +0200534Examples:
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000535 /* vim: set ai tw=75: */ ~
Bram Moolenaar14b69452013-06-29 23:05:20 +0200536 /* Vim: set ai tw=75: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000537
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200538The white space before {vi:|vim:|Vim:|ex:} is required. This minimizes the
539chance that a normal word like "lex:" is caught. There is one exception:
540"vi:" and "vim:" can also be at the start of the line (for compatibility with
541version 3.0). Using "ex:" at the start of the line will be ignored (this
542could be short for "example:").
Bram Moolenaar071d4272004-06-13 20:20:40 +0000543
544 *modeline-local*
545The options are set like with ":setlocal": The new value only applies to the
Bram Moolenaar843ee412004-06-30 16:16:41 +0000546buffer and window that contain the file. Although it's possible to set global
547options from a modeline, this is unusual. If you have two windows open and
548the files in it set the same global option to a different value, the result
549depends on which one was opened last.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000550
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +0000551When editing a file that was already loaded, only the window-local options
552from the modeline are used. Thus if you manually changed a buffer-local
553option after opening the file, it won't be changed if you edit the same buffer
554in another window. But window-local options will be set.
555
Bram Moolenaar071d4272004-06-13 20:20:40 +0000556 *modeline-version*
557If the modeline is only to be used for some versions of Vim, the version
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200558number can be specified where "vim:" or "Vim:" is used:
Bram Moolenaar071d4272004-06-13 20:20:40 +0000559 vim{vers}: version {vers} or later
560 vim<{vers}: version before {vers}
561 vim={vers}: version {vers}
562 vim>{vers}: version after {vers}
Bram Moolenaar2b8388b2015-02-28 13:11:45 +0100563{vers} is 700 for Vim 7.0 (hundred times the major version plus minor).
564For example, to use a modeline only for Vim 7.0:
565 /* vim700: set foldmethod=marker */ ~
566To use a modeline for Vim after version 7.2:
567 /* vim>702: set cole=2: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000568There can be no blanks between "vim" and the ":".
569
570
571The number of lines that are checked can be set with the 'modelines' option.
572If 'modeline' is off or 'modelines' is 0 no lines are checked.
573
574Note that for the first form all of the rest of the line is used, thus a line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000575like:
576 /* vi:ts=4: */ ~
577will give an error message for the trailing "*/". This line is OK:
578 /* vi:set ts=4: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000579
580If an error is detected the rest of the line is skipped.
581
582If you want to include a ':' in a set command precede it with a '\'. The
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000583backslash in front of the ':' will be removed. Example:
Bram Moolenaar95a9dd12019-12-19 22:12:03 +0100584 /* vi:set fillchars=stl\:^,vert\:\|: */ ~
585This sets the 'fillchars' option to "stl:^,vert:\|". Only a single backslash
586before the ':' is removed. Thus to include "\:" you have to specify "\\:".
Bram Moolenaar110289e2019-05-23 15:38:06 +0200587 *E992*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000588No other commands than "set" are supported, for security reasons (somebody
Bram Moolenaar8243a792007-05-01 17:05:03 +0000589might create a Trojan horse text file with modelines). And not all options
Bram Moolenaar110289e2019-05-23 15:38:06 +0200590can be set. For some options a flag is set, so that when the value is used
591the |sandbox| is effective. Some options can only be set from the modeline
592when 'modelineexpr' is set (the default is off).
593
594Still, there is always a small risk that a modeline causes trouble. E.g.,
595when some joker sets 'textwidth' to 5 all your lines are wrapped unexpectedly.
596So disable modelines before editing untrusted text. The mail ftplugin does
597this, for example.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000598
599Hint: If you would like to do something else than setting an option, you could
600define an autocommand that checks the file for a specific string. For
601example: >
602 au BufReadPost * if getline(1) =~ "VAR" | call SetVar() | endif
603And define a function SetVar() that does something with the line containing
604"VAR".
605
606==============================================================================
6073. Options summary *option-summary*
608
609In the list below all the options are mentioned with their full name and with
610an abbreviation if there is one. Both forms may be used.
611
612In this document when a boolean option is "set" that means that ":set option"
613is entered. When an option is "reset", ":set nooption" is used.
614
615For some options there are two default values: The "Vim default", which is
616used when 'compatible' is not set, and the "Vi default", which is used when
617'compatible' is set.
618
619Most options are the same in all windows and buffers. There are a few that
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000620are specific to how the text is presented in a window. These can be set to a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000621different value in each window. For example the 'list' option can be set in
622one window and reset in another for the same text, giving both types of view
623at the same time. There are a few options that are specific to a certain
624file. These can have a different value for each file or buffer. For example
625the 'textwidth' option can be 78 for a normal text file and 0 for a C
626program.
627
628 global one option for all buffers and windows
629 local to window each window has its own copy of this option
630 local to buffer each buffer has its own copy of this option
631
632When creating a new window the option values from the currently active window
633are used as a default value for the window-specific options. For the
634buffer-specific options this depends on the 's' and 'S' flags in the
635'cpoptions' option. If 's' is included (which is the default) the values for
636buffer options are copied from the currently active buffer when a buffer is
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000637first entered. If 'S' is present the options are copied each time the buffer
638is entered, this is almost like having global options. If 's' and 'S' are not
Bram Moolenaar071d4272004-06-13 20:20:40 +0000639present, the options are copied from the currently active buffer when the
640buffer is created.
641
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000642Hidden options *hidden-options*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000643
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000644Not all options are supported in all versions. This depends on the supported
645features and sometimes on the system. A remark about this is in curly braces
646below. When an option is not supported it may still be set without getting an
647error, this is called a hidden option. You can't get the value of a hidden
648option though, it is not stored.
649
650To test if option "foo" can be used with ":set" use something like this: >
651 if exists('&foo')
652This also returns true for a hidden option. To test if option "foo" is really
653supported use something like this: >
654 if exists('+foo')
655<
Bram Moolenaar071d4272004-06-13 20:20:40 +0000656 *E355*
657A jump table for the options with a short description can be found at |Q_op|.
658
659 *'aleph'* *'al'* *aleph* *Aleph*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +0100660'aleph' 'al' number (default 128 for MS-Windows, 224 otherwise)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000661 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000662 {only available when compiled with the |+rightleft|
663 feature}
664 The ASCII code for the first letter of the Hebrew alphabet. The
665 routine that maps the keyboard in Hebrew mode, both in Insert mode
666 (when hkmap is set) and on the command-line (when hitting CTRL-_)
667 outputs the Hebrew characters in the range [aleph..aleph+26].
668 aleph=128 applies to PC code, and aleph=224 applies to ISO 8859-8.
669 See |rileft.txt|.
670
671 *'allowrevins'* *'ari'* *'noallowrevins'* *'noari'*
672'allowrevins' 'ari' boolean (default off)
673 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000674 {only available when compiled with the |+rightleft|
675 feature}
676 Allow CTRL-_ in Insert and Command-line mode. This is default off, to
677 avoid that users that accidentally type CTRL-_ instead of SHIFT-_ get
678 into reverse Insert mode, and don't know how to get out. See
679 'revins'.
680 NOTE: This option is reset when 'compatible' is set.
681
682 *'altkeymap'* *'akm'* *'noaltkeymap'* *'noakm'*
683'altkeymap' 'akm' boolean (default off)
684 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000685 {only available when compiled with the |+farsi|
686 feature}
Bram Moolenaar14184a32019-02-16 15:10:30 +0100687 This option was for using Farsi, which has been removed. See
688 |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000689
690 *'ambiwidth'* *'ambw'*
691'ambiwidth' 'ambw' string (default: "single")
692 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000693 Only effective when 'encoding' is "utf-8" or another Unicode encoding.
694 Tells Vim what to do with characters with East Asian Width Class
695 Ambiguous (such as Euro, Registered Sign, Copyright Sign, Greek
696 letters, Cyrillic letters).
697
698 There are currently two possible values:
Bram Moolenaar582fd852005-03-28 20:58:01 +0000699 "single": Use the same width as characters in US-ASCII. This is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000700 expected by most users.
701 "double": Use twice the width of ASCII characters.
Bram Moolenaar5c3bd0a2010-08-04 20:55:44 +0200702 *E834* *E835*
703 The value "double" cannot be used if 'listchars' or 'fillchars'
704 contains a character that would be double width.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000705
706 There are a number of CJK fonts for which the width of glyphs for
707 those characters are solely based on how many octets they take in
708 legacy/traditional CJK encodings. In those encodings, Euro,
709 Registered sign, Greek/Cyrillic letters are represented by two octets,
Bram Moolenaar582fd852005-03-28 20:58:01 +0000710 therefore those fonts have "wide" glyphs for them. This is also
Bram Moolenaar071d4272004-06-13 20:20:40 +0000711 true of some line drawing characters used to make tables in text
Bram Moolenaar582fd852005-03-28 20:58:01 +0000712 file. Therefore, when a CJK font is used for GUI Vim or
Bram Moolenaar071d4272004-06-13 20:20:40 +0000713 Vim is running inside a terminal (emulators) that uses a CJK font
714 (or Vim is run inside an xterm invoked with "-cjkwidth" option.),
715 this option should be set to "double" to match the width perceived
716 by Vim with the width of glyphs in the font. Perhaps it also has
Bram Moolenaar8024f932020-01-14 19:29:13 +0100717 to be set to "double" under CJK MS-Windows when the system locale is
718 set to one of CJK locales. See Unicode Standard Annex #11
719 (http://www.unicode.org/reports/tr11).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000720
Bram Moolenaarac7bd632013-03-19 11:35:58 +0100721 Vim may set this option automatically at startup time when Vim is
722 compiled with the |+termresponse| feature and if |t_u7| is set to the
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200723 escape sequence to request cursor position report. The response can
724 be found in |v:termu7resp|.
Bram Moolenaarac7bd632013-03-19 11:35:58 +0100725
Bram Moolenaar071d4272004-06-13 20:20:40 +0000726 *'antialias'* *'anti'* *'noantialias'* *'noanti'*
727'antialias' 'anti' boolean (default: off)
728 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000729 {only available when compiled with GUI enabled
730 on Mac OS X}
731 This option only has an effect in the GUI version of Vim on Mac OS X
732 v10.2 or later. When on, Vim will use smooth ("antialiased") fonts,
733 which can be easier to read at certain sizes on certain displays.
734 Setting this option can sometimes cause problems if 'guifont' is set
735 to its default (empty string).
Bram Moolenaar036986f2017-03-16 17:41:02 +0100736 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000737
738 *'autochdir'* *'acd'* *'noautochdir'* *'noacd'*
739'autochdir' 'acd' boolean (default off)
740 global
Bram Moolenaar00a927d2010-05-14 23:24:24 +0200741 {only available when compiled with it, use
742 exists("+autochdir") to check}
Bram Moolenaard8c00872005-07-22 21:52:15 +0000743 When on, Vim will change the current working directory whenever you
744 open a file, switch buffers, delete a buffer or open/close a window.
745 It will change to the directory containing the file which was opened
746 or selected.
Bram Moolenaar910f66f2006-04-05 20:41:53 +0000747 Note: When this option is on some plugins may not work.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000748
749 *'arabic'* *'arab'* *'noarabic'* *'noarab'*
750'arabic' 'arab' boolean (default off)
751 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +0000752 {only available when compiled with the |+arabic|
753 feature}
754 This option can be set to start editing Arabic text.
755 Setting this option will:
756 - Set the 'rightleft' option, unless 'termbidi' is set.
757 - Set the 'arabicshape' option, unless 'termbidi' is set.
758 - Set the 'keymap' option to "arabic"; in Insert mode CTRL-^ toggles
759 between typing English and Arabic key mapping.
760 - Set the 'delcombine' option
761 Note that 'encoding' must be "utf-8" for working with Arabic text.
762
763 Resetting this option will:
764 - Reset the 'rightleft' option.
765 - Disable the use of 'keymap' (without changing its value).
766 Note that 'arabicshape' and 'delcombine' are not reset (it is a global
Bram Moolenaarc8734422012-06-01 22:38:45 +0200767 option).
Bram Moolenaar036986f2017-03-16 17:41:02 +0100768 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000769 Also see |arabic.txt|.
770
771 *'arabicshape'* *'arshape'*
772 *'noarabicshape'* *'noarshape'*
773'arabicshape' 'arshape' boolean (default on)
774 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000775 {only available when compiled with the |+arabic|
776 feature}
777 When on and 'termbidi' is off, the required visual character
778 corrections that need to take place for displaying the Arabic language
Bram Moolenaar3a0d8092012-10-21 03:02:54 +0200779 take effect. Shaping, in essence, gets enabled; the term is a broad
Bram Moolenaar071d4272004-06-13 20:20:40 +0000780 one which encompasses:
781 a) the changing/morphing of characters based on their location
782 within a word (initial, medial, final and stand-alone).
783 b) the enabling of the ability to compose characters
784 c) the enabling of the required combining of some characters
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100785 When disabled the display shows each character's true stand-alone
786 form.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000787 Arabic is a complex language which requires other settings, for
788 further details see |arabic.txt|.
Bram Moolenaar036986f2017-03-16 17:41:02 +0100789 NOTE: This option is set when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000790
791 *'autoindent'* *'ai'* *'noautoindent'* *'noai'*
792'autoindent' 'ai' boolean (default off)
793 local to buffer
794 Copy indent from current line when starting a new line (typing <CR>
795 in Insert mode or when using the "o" or "O" command). If you do not
796 type anything on the new line except <BS> or CTRL-D and then type
Bram Moolenaar02467872007-05-06 13:22:01 +0000797 <Esc>, CTRL-O or <CR>, the indent is deleted again. Moving the cursor
798 to another line has the same effect, unless the 'I' flag is included
799 in 'cpoptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000800 When autoindent is on, formatting (with the "gq" command or when you
801 reach 'textwidth' in Insert mode) uses the indentation of the first
802 line.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000803 When 'smartindent' or 'cindent' is on the indent is changed in
804 a different way.
Bram Moolenaarca635012015-09-25 20:34:21 +0200805 The 'autoindent' option is reset when the 'paste' option is set and
806 restored when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000807
808 *'autoread'* *'ar'* *'noautoread'* *'noar'*
809'autoread' 'ar' boolean (default off)
810 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000811 When a file has been detected to have been changed outside of Vim and
812 it has not been changed inside of Vim, automatically read it again.
Bram Moolenaarfd358112018-07-07 23:21:31 +0200813 When the file has been deleted this is not done, so you have the text
814 from before it was deleted. When it appears again then it is read.
815 |timestamp|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000816 If this option has a local value, use this command to switch back to
817 using the global value: >
818 :set autoread<
819<
820 *'autowrite'* *'aw'* *'noautowrite'* *'noaw'*
821'autowrite' 'aw' boolean (default off)
822 global
823 Write the contents of the file, if it has been modified, on each
824 :next, :rewind, :last, :first, :previous, :stop, :suspend, :tag, :!,
Bram Moolenaar14716812006-05-04 21:54:08 +0000825 :make, CTRL-] and CTRL-^ command; and when a :buffer, CTRL-O, CTRL-I,
Bram Moolenaar071d4272004-06-13 20:20:40 +0000826 '{A-Z0-9}, or `{A-Z0-9} command takes one to another file.
827 Note that for some commands the 'autowrite' option is not used, see
828 'autowriteall' for that.
Bram Moolenaar93a1df22018-09-10 11:51:50 +0200829 Some buffers will not be written, specifically when 'buftype' is
Bram Moolenaar20aac6c2018-09-02 21:07:30 +0200830 "nowrite", "nofile", "terminal" or "prompt".
Bram Moolenaar071d4272004-06-13 20:20:40 +0000831
832 *'autowriteall'* *'awa'* *'noautowriteall'* *'noawa'*
833'autowriteall' 'awa' boolean (default off)
834 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000835 Like 'autowrite', but also used for commands ":edit", ":enew", ":quit",
836 ":qall", ":exit", ":xit", ":recover" and closing the Vim window.
837 Setting this option also implies that Vim behaves like 'autowrite' has
838 been set.
839
840 *'background'* *'bg'*
Bram Moolenaar446beb42011-05-10 17:18:44 +0200841'background' 'bg' string (default "dark" or "light", see below)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000842 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000843 When set to "dark", Vim will try to use colors that look good on a
844 dark background. When set to "light", Vim will try to use colors that
845 look good on a light background. Any other value is illegal.
846 Vim tries to set the default value according to the terminal used.
847 This will not always be correct.
848 Setting this option does not change the background color, it tells Vim
849 what the background color looks like. For changing the background
850 color, see |:hi-normal|.
851
852 When 'background' is set Vim will adjust the default color groups for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000853 the new value. But the colors used for syntax highlighting will not
Bram Moolenaar446cb832008-06-24 21:56:24 +0000854 change. *g:colors_name*
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100855 When a color scheme is loaded (the "g:colors_name" variable is set)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000856 setting 'background' will cause the color scheme to be reloaded. If
857 the color scheme adjusts to the value of 'background' this will work.
858 However, if the color scheme sets 'background' itself the effect may
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100859 be undone. First delete the "g:colors_name" variable when needed.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000860
861 When setting 'background' to the default value with: >
862 :set background&
863< Vim will guess the value. In the GUI this should work correctly,
864 in other cases Vim might not be able to guess the right value.
Bram Moolenaar2e693a82019-10-16 22:35:02 +0200865 If the GUI supports a dark theme, you can use the "d" flag in
Bram Moolenaar50bf7ce2019-09-15 13:17:00 +0200866 'guioptions', see 'go-d'.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000867
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200868 When the |t_RB| option is set, Vim will use it to request the background
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +0200869 color from the terminal. If the returned RGB value is dark/light and
870 'background' is not dark/light, 'background' will be set and the
871 screen is redrawn. This may have side effects, make t_BG empty in
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200872 your .vimrc if you suspect this problem. The response to |t_RB| can
Bram Moolenaar01164a62017-11-02 22:58:42 +0100873 be found in |v:termrbgresp|.
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +0200874
Bram Moolenaar071d4272004-06-13 20:20:40 +0000875 When starting the GUI, the default value for 'background' will be
876 "light". When the value is not set in the .gvimrc, and Vim detects
877 that the background is actually quite dark, 'background' is set to
878 "dark". But this happens only AFTER the .gvimrc file has been read
879 (because the window needs to be opened to find the actual background
880 color). To get around this, force the GUI window to be opened by
881 putting a ":gui" command in the .gvimrc file, before where the value
882 of 'background' is used (e.g., before ":syntax on").
Bram Moolenaar446beb42011-05-10 17:18:44 +0200883
Bram Moolenaar6f345a12019-12-17 21:27:18 +0100884 For MS-Windows the default is "dark".
Bram Moolenaar446beb42011-05-10 17:18:44 +0200885 For other systems "dark" is used when 'term' is "linux",
886 "screen.linux", "cygwin" or "putty", or $COLORFGBG suggests a dark
887 background. Otherwise the default is "light".
888
Bram Moolenaarc572da52017-08-27 16:52:01 +0200889 The |:terminal| command and the |term_start()| function use the
890 'background' value to decide whether the terminal window will start
891 with a white or black background.
892
Bram Moolenaar071d4272004-06-13 20:20:40 +0000893 Normally this option would be set in the .vimrc file. Possibly
894 depending on the terminal name. Example: >
895 :if &term == "pcterm"
896 : set background=dark
897 :endif
898< When this option is set, the default settings for the highlight groups
899 will change. To use other settings, place ":highlight" commands AFTER
900 the setting of the 'background' option.
901 This option is also used in the "$VIMRUNTIME/syntax/syntax.vim" file
902 to select the colors for syntax highlighting. After changing this
903 option, you must load syntax.vim again to see the result. This can be
904 done with ":syntax on".
905
906 *'backspace'* *'bs'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +0200907'backspace' 'bs' string (default "", set to "indent,eol,start"
908 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000909 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000910 Influences the working of <BS>, <Del>, CTRL-W and CTRL-U in Insert
911 mode. This is a list of items, separated by commas. Each item allows
912 a way to backspace over something:
913 value effect ~
914 indent allow backspacing over autoindent
915 eol allow backspacing over line breaks (join lines)
916 start allow backspacing over the start of insert; CTRL-W and CTRL-U
917 stop once at the start of insert.
Bram Moolenaaraa0489e2020-04-17 19:41:21 +0200918 nostop like start, except CTRL-W and CTRL-U do not stop at the start of
919 insert.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000920
921 When the value is empty, Vi compatible backspacing is used.
922
923 For backwards compatibility with version 5.4 and earlier:
924 value effect ~
925 0 same as ":set backspace=" (Vi compatible)
926 1 same as ":set backspace=indent,eol"
927 2 same as ":set backspace=indent,eol,start"
Bram Moolenaaraa0489e2020-04-17 19:41:21 +0200928 3 same as ":set backspace=indent,eol,nostop"
Bram Moolenaar071d4272004-06-13 20:20:40 +0000929
930 See |:fixdel| if your <BS> or <Del> key does not do what you want.
931 NOTE: This option is set to "" when 'compatible' is set.
932
933 *'backup'* *'bk'* *'nobackup'* *'nobk'*
934'backup' 'bk' boolean (default off)
935 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000936 Make a backup before overwriting a file. Leave it around after the
937 file has been successfully written. If you do not want to keep the
938 backup file, but you do want a backup while the file is being
939 written, reset this option and set the 'writebackup' option (this is
940 the default). If you do not want a backup file at all reset both
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000941 options (use this if your file system is almost full). See the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000942 |backup-table| for more explanations.
943 When the 'backupskip' pattern matches, a backup is not made anyway.
944 When 'patchmode' is set, the backup may be renamed to become the
945 oldest version of a file.
946 NOTE: This option is reset when 'compatible' is set.
947
948 *'backupcopy'* *'bkc'*
949'backupcopy' 'bkc' string (Vi default for Unix: "yes", otherwise: "auto")
Bram Moolenaarb8ee25a2014-09-23 15:45:08 +0200950 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000951 When writing a file and a backup is made, this option tells how it's
952 done. This is a comma separated list of words.
953
954 The main values are:
955 "yes" make a copy of the file and overwrite the original one
956 "no" rename the file and write a new one
957 "auto" one of the previous, what works best
958
959 Extra values that can be combined with the ones above are:
960 "breaksymlink" always break symlinks when writing
961 "breakhardlink" always break hardlinks when writing
962
963 Making a copy and overwriting the original file:
964 - Takes extra time to copy the file.
965 + When the file has special attributes, is a (hard/symbolic) link or
966 has a resource fork, all this is preserved.
967 - When the file is a link the backup will have the name of the link,
968 not of the real file.
969
970 Renaming the file and writing a new one:
971 + It's fast.
972 - Sometimes not all attributes of the file can be copied to the new
973 file.
974 - When the file is a link the new file will not be a link.
975
976 The "auto" value is the middle way: When Vim sees that renaming file
977 is possible without side effects (the attributes can be passed on and
Bram Moolenaar02467872007-05-06 13:22:01 +0000978 the file is not a link) that is used. When problems are expected, a
979 copy will be made.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000980
981 The "breaksymlink" and "breakhardlink" values can be used in
982 combination with any of "yes", "no" and "auto". When included, they
983 force Vim to always break either symbolic or hard links by doing
984 exactly what the "no" option does, renaming the original file to
985 become the backup and writing a new file in its place. This can be
986 useful for example in source trees where all the files are symbolic or
987 hard links and any changes should stay in the local source tree, not
988 be propagated back to the original source.
989 *crontab*
990 One situation where "no" and "auto" will cause problems: A program
991 that opens a file, invokes Vim to edit that file, and then tests if
992 the open file was changed (through the file descriptor) will check the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000993 backup file instead of the newly created file. "crontab -e" is an
Bram Moolenaar071d4272004-06-13 20:20:40 +0000994 example.
995
996 When a copy is made, the original file is truncated and then filled
997 with the new text. This means that protection bits, owner and
998 symbolic links of the original file are unmodified. The backup file
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000999 however, is a new file, owned by the user who edited the file. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00001000 group of the backup is set to the group of the original file. If this
1001 fails, the protection bits for the group are made the same as for
1002 others.
1003
1004 When the file is renamed this is the other way around: The backup has
1005 the same attributes of the original file, and the newly written file
1006 is owned by the current user. When the file was a (hard/symbolic)
1007 link, the new file will not! That's why the "auto" value doesn't
1008 rename when the file is a link. The owner and group of the newly
1009 written file will be set to the same ones as the original file, but
1010 the system may refuse to do this. In that case the "auto" value will
1011 again not rename the file.
1012
Bram Moolenaar036986f2017-03-16 17:41:02 +01001013 NOTE: This option is set to the Vi default value when 'compatible' is
1014 set and to the Vim default value when 'compatible' is reset.
1015
Bram Moolenaar071d4272004-06-13 20:20:40 +00001016 *'backupdir'* *'bdir'*
1017'backupdir' 'bdir' string (default for Amiga: ".,t:",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01001018 for Win32: ".,$TEMP,c:/tmp,c:/temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001019 for Unix: ".,~/tmp,~/")
1020 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001021 List of directories for the backup file, separated with commas.
1022 - The backup file will be created in the first directory in the list
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001023 where this is possible. The directory must exist, Vim will not
1024 create it for you.
Bram Moolenaar3848e002016-03-19 18:42:29 +01001025 - Empty means that no backup file will be created ('patchmode' is
Bram Moolenaar071d4272004-06-13 20:20:40 +00001026 impossible!). Writing may fail because of this.
1027 - A directory "." means to put the backup file in the same directory
1028 as the edited file.
Bram Moolenaar8024f932020-01-14 19:29:13 +01001029 - A directory starting with "./" (or ".\" for MS-Windows) means to put
1030 the backup file relative to where the edited file is. The leading
1031 "." is replaced with the path name of the edited file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001032 ("." inside a directory name has no special meaning).
1033 - Spaces after the comma are ignored, other spaces are considered part
1034 of the directory name. To have a space at the start of a directory
1035 name, precede it with a backslash.
1036 - To include a comma in a directory name precede it with a backslash.
1037 - A directory name may end in an '/'.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02001038 - For Unix and Win32, if a directory ends in two path separators "//",
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01001039 the backup file name will be built from the complete path to the
1040 file with all path separators changed to percent '%' signs. This
1041 will ensure file name uniqueness in the backup directory.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02001042 On Win32, it is also possible to end with "\\". However, When a
1043 separating comma is following, you must use "//", since "\\" will
1044 include the comma in the file name. Therefore it is recommended to
1045 use '//', instead of '\\'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001046 - Environment variables are expanded |:set_env|.
1047 - Careful with '\' characters, type one before a space, type two to
1048 get one in the option (see |option-backslash|), for example: >
1049 :set bdir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
1050< - For backwards compatibility with Vim version 3.0 a '>' at the start
1051 of the option is removed.
1052 See also 'backup' and 'writebackup' options.
1053 If you want to hide your backup files on Unix, consider this value: >
1054 :set backupdir=./.backup,~/.backup,.,/tmp
1055< You must create a ".backup" directory in each directory and in your
1056 home directory for this to work properly.
1057 The use of |:set+=| and |:set-=| is preferred when adding or removing
1058 directories from the list. This avoids problems when a future version
1059 uses another default.
1060 This option cannot be set from a |modeline| or in the |sandbox|, for
1061 security reasons.
1062
1063 *'backupext'* *'bex'* *E589*
1064'backupext' 'bex' string (default "~", for VMS: "_")
1065 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001066 String which is appended to a file name to make the name of the
1067 backup file. The default is quite unusual, because this avoids
1068 accidentally overwriting existing files with a backup file. You might
1069 prefer using ".bak", but make sure that you don't have files with
1070 ".bak" that you want to keep.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001071 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001072
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001073 If you like to keep a lot of backups, you could use a BufWritePre
1074 autocommand to change 'backupext' just before writing the file to
1075 include a timestamp. >
1076 :au BufWritePre * let &bex = '-' . strftime("%Y%b%d%X") . '~'
1077< Use 'backupdir' to put the backup in a different directory.
1078
Bram Moolenaar071d4272004-06-13 20:20:40 +00001079 *'backupskip'* *'bsk'*
Bram Moolenaarb8e22a02018-04-12 21:37:34 +02001080'backupskip' 'bsk' string (default: "$TMPDIR/*,$TMP/*,$TEMP/*"
1081 Unix: "/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*"
1082 Mac: "/private/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001083 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001084 {not available when compiled without the |+wildignore|
1085 feature}
1086 A list of file patterns. When one of the patterns matches with the
1087 name of the file which is written, no backup file is created. Both
1088 the specified file name and the full path name of the file are used.
1089 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
1090 Watch out for special characters, see |option-backslash|.
1091 When $TMPDIR, $TMP or $TEMP is not defined, it is not used for the
Bram Moolenaar582fd852005-03-28 20:58:01 +00001092 default value. "/tmp/*" is only used for Unix.
Bram Moolenaar02467872007-05-06 13:22:01 +00001093
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02001094 WARNING: Not having a backup file means that when Vim fails to write
1095 your buffer correctly and then, for whatever reason, Vim exits, you
1096 lose both the original file and what you were writing. Only disable
1097 backups if you don't care about losing the file.
1098
Bram Moolenaar02467872007-05-06 13:22:01 +00001099 Note that environment variables are not expanded. If you want to use
1100 $HOME you must expand it explicitly, e.g.: >
Bram Moolenaar7c1c6db2016-04-03 22:08:05 +02001101 :let &backupskip = escape(expand('$HOME'), '\') . '/tmp/*'
Bram Moolenaar02467872007-05-06 13:22:01 +00001102
1103< Note that the default also makes sure that "crontab -e" works (when a
Bram Moolenaara5792f52005-11-23 21:25:05 +00001104 backup would be made by renaming the original file crontab won't see
1105 the newly created file). Also see 'backupcopy' and |crontab|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001106
1107 *'balloondelay'* *'bdlay'*
1108'balloondelay' 'bdlay' number (default: 600)
1109 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001110 {only available when compiled with the |+balloon_eval|
1111 feature}
1112 Delay in milliseconds before a balloon may pop up. See |balloon-eval|.
1113
1114 *'ballooneval'* *'beval'* *'noballooneval'* *'nobeval'*
1115'ballooneval' 'beval' boolean (default off)
1116 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001117 {only available when compiled with the |+balloon_eval|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001118 feature}
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001119 Switch on the |balloon-eval| functionality for the GUI.
1120
1121 *'balloonevalterm'* *'bevalterm'* *'noballoonevalterm'*
1122 *'nobevalterm'*
1123'balloonevalterm' 'bevalterm' boolean (default off)
1124 global
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001125 {only available when compiled with the
1126 |+balloon_eval_term| feature}
1127 Switch on the |balloon-eval| functionality for the terminal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001128
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001129 *'balloonexpr'* *'bexpr'*
1130'balloonexpr' 'bexpr' string (default "")
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00001131 global or local to buffer |global-local|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001132 {only available when compiled with the |+balloon_eval|
1133 feature}
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00001134 Expression for text to show in evaluation balloon. It is only used
Bram Moolenaara6c27c42019-05-09 19:16:22 +02001135 when 'ballooneval' or 'balloonevalterm' is on. These variables can be
1136 used:
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001137
1138 v:beval_bufnr number of the buffer in which balloon is going to show
1139 v:beval_winnr number of the window
Bram Moolenaar82af8712016-06-04 20:20:29 +02001140 v:beval_winid ID of the window
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001141 v:beval_lnum line number
1142 v:beval_col column number (byte index)
1143 v:beval_text word under or after the mouse pointer
1144
Bram Moolenaar54775062019-07-31 21:07:14 +02001145 Instead of showing a balloon, which is limited to plain text, consider
1146 using a popup window, see |popup_beval_example|. A popup window can
1147 use highlighting and show a border.
1148
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001149 The evaluation of the expression must not have side effects!
1150 Example: >
Bram Moolenaara6c27c42019-05-09 19:16:22 +02001151 function MyBalloonExpr()
Bram Moolenaar45360022005-07-21 21:08:21 +00001152 return 'Cursor is at line ' . v:beval_lnum .
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001153 \', column ' . v:beval_col .
1154 \ ' of file ' . bufname(v:beval_bufnr) .
1155 \ ' on word "' . v:beval_text . '"'
1156 endfunction
1157 set bexpr=MyBalloonExpr()
1158 set ballooneval
1159<
Bram Moolenaar396e8292019-07-13 23:04:31 +02001160 Also see |balloon_show()|, it can be used if the content of the balloon
1161 is to be fetched asynchronously. In that case evaluating
1162 'balloonexpr' should result in an empty string. If you get a balloon
1163 with only "0" you probably didn't return anything from your function.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001164
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001165 NOTE: The balloon is displayed only if the cursor is on a text
1166 character. If the result of evaluating 'balloonexpr' is not empty,
1167 Vim does not try to send a message to an external debugger (Netbeans
1168 or Sun Workshop).
1169
Bram Moolenaar30b65812012-07-12 22:01:11 +02001170 The expression will be evaluated in the |sandbox| when set from a
1171 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02001172 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001173
1174 It is not allowed to change text or jump to another window while
Bram Moolenaar396e8292019-07-13 23:04:31 +02001175 evaluating 'balloonexpr', see |textlock|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001176
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001177 To check whether line breaks in the balloon text work use this check: >
Bram Moolenaar45360022005-07-21 21:08:21 +00001178 if has("balloon_multiline")
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001179< When they are supported "\n" characters will start a new line. If the
1180 expression evaluates to a |List| this is equal to using each List item
1181 as a string and putting "\n" in between them.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001182 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001183
Bram Moolenaar165bc692015-07-21 17:53:25 +02001184 *'belloff'* *'bo'*
1185'belloff' 'bo' string (default "")
1186 global
Bram Moolenaar165bc692015-07-21 17:53:25 +02001187 Specifies for which events the bell will not be rung. It is a comma
1188 separated list of items. For each item that is present, the bell
1189 will be silenced. This is most useful to specify specific events in
1190 insert mode to be silenced.
1191
1192 item meaning when present ~
1193 all All events.
1194 backspace When hitting <BS> or <Del> and deleting results in an
1195 error.
1196 cursor Fail to move around using the cursor keys or
1197 <PageUp>/<PageDown> in |Insert-mode|.
1198 complete Error occurred when using |i_CTRL-X_CTRL-K| or
1199 |i_CTRL-X_CTRL-T|.
1200 copy Cannot copy char from insert mode using |i_CTRL-Y| or
1201 |i_CTRL-E|.
1202 ctrlg Unknown Char after <C-G> in Insert mode.
1203 error Other Error occurred (e.g. try to join last line)
1204 (mostly used in |Normal-mode| or |Cmdline-mode|).
1205 esc hitting <Esc> in |Normal-mode|.
1206 ex In |Visual-mode|, hitting |Q| results in an error.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01001207 hangul Ignored.
Bram Moolenaar165bc692015-07-21 17:53:25 +02001208 insertmode Pressing <Esc> in 'insertmode'.
1209 lang Calling the beep module for Lua/Mzscheme/TCL.
1210 mess No output available for |g<|.
1211 showmatch Error occurred for 'showmatch' function.
1212 operator Empty region error |cpo-E|.
1213 register Unknown register after <C-R> in |Insert-mode|.
1214 shell Bell from shell output |:!|.
1215 spell Error happened on spell suggest.
1216 wildmode More matches in |cmdline-completion| available
1217 (depends on the 'wildmode' setting).
1218
Bram Moolenaar036986f2017-03-16 17:41:02 +01001219 This is most useful to fine tune when in Insert mode the bell should
1220 be rung. For Normal mode and Ex commands, the bell is often rung to
Bram Moolenaar165bc692015-07-21 17:53:25 +02001221 indicate that an error occurred. It can be silenced by adding the
1222 "error" keyword.
1223
Bram Moolenaar071d4272004-06-13 20:20:40 +00001224 *'binary'* *'bin'* *'nobinary'* *'nobin'*
1225'binary' 'bin' boolean (default off)
1226 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001227 This option should be set before editing a binary file. You can also
1228 use the |-b| Vim argument. When this option is switched on a few
1229 options will be changed (also when it already was on):
1230 'textwidth' will be set to 0
1231 'wrapmargin' will be set to 0
1232 'modeline' will be off
1233 'expandtab' will be off
1234 Also, 'fileformat' and 'fileformats' options will not be used, the
1235 file is read and written like 'fileformat' was "unix" (a single <NL>
1236 separates lines).
1237 The 'fileencoding' and 'fileencodings' options will not be used, the
1238 file is read without conversion.
1239 NOTE: When you start editing a(nother) file while the 'bin' option is
1240 on, settings from autocommands may change the settings again (e.g.,
1241 'textwidth'), causing trouble when editing. You might want to set
1242 'bin' again when the file has been loaded.
1243 The previous values of these options are remembered and restored when
1244 'bin' is switched from on to off. Each buffer has its own set of
1245 saved option values.
1246 To edit a file with 'binary' set you can use the |++bin| argument.
1247 This avoids you have to do ":set bin", which would have effect for all
1248 files you edit.
1249 When writing a file the <EOL> for the last line is only written if
1250 there was one in the original file (normally Vim appends an <EOL> to
1251 the last line if there is none; this would make the file longer). See
1252 the 'endofline' option.
1253
1254 *'bioskey'* *'biosk'* *'nobioskey'* *'nobiosk'*
1255'bioskey' 'biosk' boolean (default on)
1256 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02001257 {only for MS-DOS}
Bram Moolenaarf3913272016-02-25 00:00:01 +01001258 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001259
1260 *'bomb'* *'nobomb'*
1261'bomb' boolean (default off)
1262 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001263 When writing a file and the following conditions are met, a BOM (Byte
1264 Order Mark) is prepended to the file:
1265 - this option is on
1266 - the 'binary' option is off
1267 - 'fileencoding' is "utf-8", "ucs-2", "ucs-4" or one of the little/big
1268 endian variants.
1269 Some applications use the BOM to recognize the encoding of the file.
1270 Often used for UCS-2 files on MS-Windows. For other applications it
1271 causes trouble, for example: "cat file1 file2" makes the BOM of file2
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001272 appear halfway the resulting file. Gcc doesn't accept a BOM.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001273 When Vim reads a file and 'fileencodings' starts with "ucs-bom", a
1274 check for the presence of the BOM is done and 'bomb' set accordingly.
1275 Unless 'binary' is set, it is removed from the first line, so that you
1276 don't see it when editing. When you don't change the options, the BOM
1277 will be restored when writing the file.
1278
1279 *'breakat'* *'brk'*
1280'breakat' 'brk' string (default " ^I!@*-+;:,./?")
1281 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02001282 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001283 feature}
1284 This option lets you choose which characters might cause a line
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00001285 break if 'linebreak' is on. Only works for ASCII and also for 8-bit
1286 characters when 'encoding' is an 8-bit encoding.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001287
Bram Moolenaar7c1c6db2016-04-03 22:08:05 +02001288 *'breakindent'* *'bri'* *'nobreakindent'* *'nobri'*
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001289'breakindent' 'bri' boolean (default off)
1290 local to window
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001291 {not available when compiled without the |+linebreak|
1292 feature}
1293 Every wrapped line will continue visually indented (same amount of
1294 space as the beginning of that line), thus preserving horizontal blocks
1295 of text.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001296 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001297
1298 *'breakindentopt'* *'briopt'*
1299'breakindentopt' 'briopt' string (default empty)
1300 local to window
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001301 {not available when compiled without the |+linebreak|
1302 feature}
1303 Settings for 'breakindent'. It can consist of the following optional
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001304 items and must be separated by a comma:
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001305 min:{n} Minimum text width that will be kept after
1306 applying 'breakindent', even if the resulting
1307 text should normally be narrower. This prevents
1308 text indented almost to the right window border
1309 occupying lot of vertical space when broken.
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001310 shift:{n} After applying 'breakindent', the wrapped line's
1311 beginning will be shifted by the given number of
1312 characters. It permits dynamic French paragraph
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001313 indentation (negative) or emphasizing the line
1314 continuation (positive).
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01001315 sbr Display the 'showbreak' value before applying the
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001316 additional indent.
1317 The default value for min is 20 and shift is 0.
1318
Bram Moolenaar071d4272004-06-13 20:20:40 +00001319 *'browsedir'* *'bsdir'*
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001320'browsedir' 'bsdir' string (default: "last")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001321 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02001322 {only for Motif, Athena, GTK, Mac and Win32 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001323 Which directory to use for the file browser:
Bram Moolenaar446cb832008-06-24 21:56:24 +00001324 last Use same directory as with last file browser, where a
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02001325 file was opened or saved.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001326 buffer Use the directory of the related buffer.
1327 current Use the current directory.
1328 {path} Use the specified directory
1329
1330 *'bufhidden'* *'bh'*
1331'bufhidden' 'bh' string (default: "")
1332 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001333 This option specifies what happens when a buffer is no longer
1334 displayed in a window:
1335 <empty> follow the global 'hidden' option
1336 hide hide the buffer (don't unload it), also when 'hidden'
1337 is not set
1338 unload unload the buffer, also when 'hidden' is set or using
1339 |:hide|
1340 delete delete the buffer from the buffer list, also when
1341 'hidden' is set or using |:hide|, like using
1342 |:bdelete|
1343 wipe wipe out the buffer from the buffer list, also when
1344 'hidden' is set or using |:hide|, like using
1345 |:bwipeout|
1346
Bram Moolenaara14de3d2005-01-07 21:48:26 +00001347 CAREFUL: when "unload", "delete" or "wipe" is used changes in a buffer
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01001348 are lost without a warning. Also, these values may break autocommands
1349 that switch between buffers temporarily.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001350 This option is used together with 'buftype' and 'swapfile' to specify
1351 special kinds of buffers. See |special-buffers|.
1352
1353 *'buflisted'* *'bl'* *'nobuflisted'* *'nobl'* *E85*
1354'buflisted' 'bl' boolean (default: on)
1355 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001356 When this option is set, the buffer shows up in the buffer list. If
1357 it is reset it is not used for ":bnext", "ls", the Buffers menu, etc.
1358 This option is reset by Vim for buffers that are only used to remember
1359 a file name or marks. Vim sets it when starting to edit a buffer.
1360 But not when moving to a buffer with ":buffer".
1361
1362 *'buftype'* *'bt'* *E382*
1363'buftype' 'bt' string (default: "")
1364 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001365 The value of this option specifies the type of a buffer:
1366 <empty> normal buffer
1367 nofile buffer which is not related to a file and will not be
1368 written
1369 nowrite buffer which will not be written
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001370 acwrite buffer which will always be written with BufWriteCmd
Bram Moolenaarb5b75622018-03-09 22:22:21 +01001371 autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001372 quickfix quickfix buffer, contains list of errors |:cwindow|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001373 or list of locations |:lwindow|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001374 help help buffer (you are not supposed to set this
1375 manually)
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02001376 terminal buffer for a |terminal| (you are not supposed to set
1377 this manually)
Bram Moolenaarf2732452018-06-03 14:47:35 +02001378 prompt buffer where only the last line can be edited, meant
1379 to be used by a plugin, see |prompt-buffer|
1380 {only when compiled with the |+channel| feature}
Bram Moolenaar4d784b22019-05-25 19:51:39 +02001381 popup buffer used in a popup window, see |popup|.
1382 {only when compiled with the |+textprop| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001383
1384 This option is used together with 'bufhidden' and 'swapfile' to
1385 specify special kinds of buffers. See |special-buffers|.
Bram Moolenaarebdf3c92020-02-15 21:41:42 +01001386 Also see |win_gettype()|, which returns the type of the window.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001387
1388 Be careful with changing this option, it can have many side effects!
1389
Bram Moolenaar280f1262006-01-30 00:14:18 +00001390 A "quickfix" buffer is only used for the error list and the location
1391 list. This value is set by the |:cwindow| and |:lwindow| commands and
1392 you are not supposed to change it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001393
1394 "nofile" and "nowrite" buffers are similar:
1395 both: The buffer is not to be written to disk, ":w" doesn't
1396 work (":w filename" does work though).
1397 both: The buffer is never considered to be |'modified'|.
1398 There is no warning when the changes will be lost, for
1399 example when you quit Vim.
1400 both: A swap file is only created when using too much memory
1401 (when 'swapfile' has been reset there is never a swap
1402 file).
1403 nofile only: The buffer name is fixed, it is not handled like a
1404 file name. It is not modified in response to a |:cd|
1405 command.
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01001406 both: When using ":e bufname" and already editing "bufname"
1407 the buffer is made empty and autocommands are
1408 triggered as usual for |:edit|.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001409 *E676*
1410 "acwrite" implies that the buffer name is not related to a file, like
1411 "nofile", but it will be written. Thus, in contrast to "nofile" and
1412 "nowrite", ":w" does work and a modified buffer can't be abandoned
1413 without saving. For writing there must be matching |BufWriteCmd|,
1414 |FileWriteCmd| or |FileAppendCmd| autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001415
1416 *'casemap'* *'cmp'*
1417'casemap' 'cmp' string (default: "internal,keepascii")
1418 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001419 Specifies details about changing the case of letters. It may contain
1420 these words, separated by a comma:
1421 internal Use internal case mapping functions, the current
1422 locale does not change the case mapping. This only
Bram Moolenaar6f16eb82005-08-23 21:02:42 +00001423 matters when 'encoding' is a Unicode encoding,
1424 "latin1" or "iso-8859-15". When "internal" is
1425 omitted, the towupper() and towlower() system library
1426 functions are used when available.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001427 keepascii For the ASCII characters (0x00 to 0x7f) use the US
1428 case mapping, the current locale is not effective.
1429 This probably only matters for Turkish.
1430
1431 *'cdpath'* *'cd'* *E344* *E346*
1432'cdpath' 'cd' string (default: equivalent to $CDPATH or ",,")
1433 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001434 {not available when compiled without the
1435 |+file_in_path| feature}
1436 This is a list of directories which will be searched when using the
Bram Moolenaar00aa0692019-04-27 20:37:57 +02001437 |:cd|, |:tcd| and |:lcd| commands, provided that the directory being
1438 searched for has a relative path, not an absolute part starting with
1439 "/", "./" or "../", the 'cdpath' option is not used then.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001440 The 'cdpath' option's value has the same form and semantics as
1441 |'path'|. Also see |file-searching|.
1442 The default value is taken from $CDPATH, with a "," prepended to look
1443 in the current directory first.
1444 If the default value taken from $CDPATH is not what you want, include
1445 a modified version of the following command in your vimrc file to
1446 override it: >
1447 :let &cdpath = ',' . substitute(substitute($CDPATH, '[, ]', '\\\0', 'g'), ':', ',', 'g')
1448< This option cannot be set from a |modeline| or in the |sandbox|, for
1449 security reasons.
1450 (parts of 'cdpath' can be passed to the shell to expand file names).
1451
1452 *'cedit'*
1453'cedit' string (Vi default: "", Vim default: CTRL-F)
1454 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001455 The key used in Command-line Mode to open the command-line window.
1456 The default is CTRL-F when 'compatible' is off.
1457 Only non-printable keys are allowed.
1458 The key can be specified as a single character, but it is difficult to
1459 type. The preferred way is to use the <> notation. Examples: >
Bram Moolenaare18dbe82016-07-02 21:42:23 +02001460 :exe "set cedit=\<C-Y>"
1461 :exe "set cedit=\<Esc>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001462< |Nvi| also has this option, but it only uses the first character.
1463 See |cmdwin|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001464 NOTE: This option is set to the Vim default value when 'compatible'
1465 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001466
1467 *'charconvert'* *'ccv'* *E202* *E214* *E513*
1468'charconvert' 'ccv' string (default "")
1469 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01001470 {only available when compiled with the |+eval| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001471 An expression that is used for character encoding conversion. It is
1472 evaluated when a file that is to be read or has been written has a
1473 different encoding from what is desired.
1474 'charconvert' is not used when the internal iconv() function is
1475 supported and is able to do the conversion. Using iconv() is
1476 preferred, because it is much faster.
1477 'charconvert' is not used when reading stdin |--|, because there is no
1478 file to convert from. You will have to save the text in a file first.
1479 The expression must return zero or an empty string for success,
1480 non-zero for failure.
1481 The possible encoding names encountered are in 'encoding'.
1482 Additionally, names given in 'fileencodings' and 'fileencoding' are
1483 used.
1484 Conversion between "latin1", "unicode", "ucs-2", "ucs-4" and "utf-8"
1485 is done internally by Vim, 'charconvert' is not used for this.
1486 'charconvert' is also used to convert the viminfo file, if the 'c'
1487 flag is present in 'viminfo'. Also used for Unicode conversion.
1488 Example: >
1489 set charconvert=CharConvert()
1490 fun CharConvert()
1491 system("recode "
1492 \ . v:charconvert_from . ".." . v:charconvert_to
1493 \ . " <" . v:fname_in . " >" v:fname_out)
1494 return v:shell_error
1495 endfun
1496< The related Vim variables are:
1497 v:charconvert_from name of the current encoding
1498 v:charconvert_to name of the desired encoding
1499 v:fname_in name of the input file
1500 v:fname_out name of the output file
1501 Note that v:fname_in and v:fname_out will never be the same.
1502 Note that v:charconvert_from and v:charconvert_to may be different
1503 from 'encoding'. Vim internally uses UTF-8 instead of UCS-2 or UCS-4.
1504 Encryption is not done by Vim when using 'charconvert'. If you want
1505 to encrypt the file after conversion, 'charconvert' should take care
1506 of this.
1507 This option cannot be set from a |modeline| or in the |sandbox|, for
1508 security reasons.
1509
1510 *'cindent'* *'cin'* *'nocindent'* *'nocin'*
1511'cindent' 'cin' boolean (default off)
1512 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001513 {not available when compiled without the |+cindent|
1514 feature}
Bram Moolenaar446cb832008-06-24 21:56:24 +00001515 Enables automatic C program indenting. See 'cinkeys' to set the keys
Bram Moolenaar071d4272004-06-13 20:20:40 +00001516 that trigger reindenting in insert mode and 'cinoptions' to set your
1517 preferred indent style.
1518 If 'indentexpr' is not empty, it overrules 'cindent'.
1519 If 'lisp' is not on and both 'indentexpr' and 'equalprg' are empty,
1520 the "=" operator indents using this algorithm rather than calling an
1521 external program.
1522 See |C-indenting|.
1523 When you don't like the way 'cindent' works, try the 'smartindent'
1524 option or 'indentexpr'.
1525 This option is not used when 'paste' is set.
1526 NOTE: This option is reset when 'compatible' is set.
1527
1528 *'cinkeys'* *'cink'*
Bram Moolenaarce655742019-01-31 14:12:57 +01001529'cinkeys' 'cink' string (default "0{,0},0),0],:,0#,!^F,o,O,e")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001530 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001531 {not available when compiled without the |+cindent|
1532 feature}
1533 A list of keys that, when typed in Insert mode, cause reindenting of
1534 the current line. Only used if 'cindent' is on and 'indentexpr' is
1535 empty.
1536 For the format of this option see |cinkeys-format|.
1537 See |C-indenting|.
1538
1539 *'cinoptions'* *'cino'*
1540'cinoptions' 'cino' string (default "")
1541 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001542 {not available when compiled without the |+cindent|
1543 feature}
1544 The 'cinoptions' affect the way 'cindent' reindents lines in a C
1545 program. See |cinoptions-values| for the values of this option, and
1546 |C-indenting| for info on C indenting in general.
1547
1548
1549 *'cinwords'* *'cinw'*
1550'cinwords' 'cinw' string (default "if,else,while,do,for,switch")
1551 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001552 {not available when compiled without both the
1553 |+cindent| and the |+smartindent| features}
1554 These keywords start an extra indent in the next line when
1555 'smartindent' or 'cindent' is set. For 'cindent' this is only done at
1556 an appropriate place (inside {}).
1557 Note that 'ignorecase' isn't used for 'cinwords'. If case doesn't
1558 matter, include the keyword both the uppercase and lowercase:
1559 "if,If,IF".
1560
1561 *'clipboard'* *'cb'*
1562'clipboard' 'cb' string (default "autoselect,exclude:cons\|linux"
1563 for X-windows, "" otherwise)
1564 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001565 {only in GUI versions or when the |+xterm_clipboard|
1566 feature is included}
1567 This option is a list of comma separated names.
1568 These names are recognized:
1569
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001570 *clipboard-unnamed*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001571 unnamed When included, Vim will use the clipboard register '*'
1572 for all yank, delete, change and put operations which
1573 would normally go to the unnamed register. When a
1574 register is explicitly specified, it will always be
1575 used regardless of whether "unnamed" is in 'clipboard'
1576 or not. The clipboard register can always be
1577 explicitly accessed using the "* notation. Also see
1578 |gui-clipboard|.
1579
Bram Moolenaar30b65812012-07-12 22:01:11 +02001580 *clipboard-unnamedplus*
Bram Moolenaar00154502013-02-13 16:15:55 +01001581 unnamedplus A variant of the "unnamed" flag which uses the
1582 clipboard register '+' (|quoteplus|) instead of
1583 register '*' for all yank, delete, change and put
1584 operations which would normally go to the unnamed
1585 register. When "unnamed" is also included to the
1586 option, yank operations (but not delete, change or
1587 put) will additionally copy the text into register
1588 '*'.
Bram Moolenaar81af9252010-12-10 20:35:50 +01001589 Only available with the |+X11| feature.
Bram Moolenaarbf9680e2010-12-02 21:43:16 +01001590 Availability can be checked with: >
1591 if has('unnamedplus')
1592<
Bram Moolenaar30b65812012-07-12 22:01:11 +02001593 *clipboard-autoselect*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001594 autoselect Works like the 'a' flag in 'guioptions': If present,
1595 then whenever Visual mode is started, or the Visual
1596 area extended, Vim tries to become the owner of the
1597 windowing system's global selection or put the
1598 selected text on the clipboard used by the selection
Bram Moolenaarba3ff532018-11-04 14:45:49 +01001599 register "*. See |'go-a'| and |quotestar| for details.
1600 When the GUI is active, the 'a' flag in 'guioptions'
1601 is used, when the GUI is not active, this "autoselect"
1602 flag is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001603 Also applies to the modeless selection.
1604
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001605 *clipboard-autoselectplus*
1606 autoselectplus Like "autoselect" but using the + register instead of
1607 the * register. Compare to the 'P' flag in
1608 'guioptions'.
1609
1610 *clipboard-autoselectml*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001611 autoselectml Like "autoselect", but for the modeless selection
1612 only. Compare to the 'A' flag in 'guioptions'.
1613
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001614 *clipboard-html*
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001615 html When the clipboard contains HTML, use this when
1616 pasting. When putting text on the clipboard, mark it
1617 as HTML. This works to copy rendered HTML from
1618 Firefox, paste it as raw HTML in Vim, select the HTML
1619 in Vim and paste it in a rich edit box in Firefox.
Bram Moolenaar20a825a2010-05-31 21:27:30 +02001620 You probably want to add this only temporarily,
1621 possibly use BufEnter autocommands.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001622 Only supported for GTK version 2 and later.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001623
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001624 *clipboard-exclude*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001625 exclude:{pattern}
1626 Defines a pattern that is matched against the name of
1627 the terminal 'term'. If there is a match, no
1628 connection will be made to the X server. This is
1629 useful in this situation:
1630 - Running Vim in a console.
1631 - $DISPLAY is set to start applications on another
1632 display.
1633 - You do not want to connect to the X server in the
1634 console, but do want this in a terminal emulator.
1635 To never connect to the X server use: >
1636 exclude:.*
1637< This has the same effect as using the |-X| argument.
1638 Note that when there is no connection to the X server
1639 the window title won't be restored and the clipboard
1640 cannot be accessed.
1641 The value of 'magic' is ignored, {pattern} is
1642 interpreted as if 'magic' was on.
1643 The rest of the option value will be used for
1644 {pattern}, this must be the last entry.
1645
1646 *'cmdheight'* *'ch'*
1647'cmdheight' 'ch' number (default 1)
1648 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001649 Number of screen lines to use for the command-line. Helps avoiding
1650 |hit-enter| prompts.
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00001651 The value of this option is stored with the tab page, so that each tab
1652 page can have a different value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001653
1654 *'cmdwinheight'* *'cwh'*
1655'cmdwinheight' 'cwh' number (default 7)
1656 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001657 Number of screen lines to use for the command-line window. |cmdwin|
1658
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001659 *'colorcolumn'* *'cc'*
1660'colorcolumn' 'cc' string (default "")
1661 local to window
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001662 {not available when compiled without the |+syntax|
1663 feature}
1664 'colorcolumn' is a comma separated list of screen columns that are
1665 highlighted with ColorColumn |hl-ColorColumn|. Useful to align
1666 text. Will make screen redrawing slower.
1667 The screen column can be an absolute number, or a number preceded with
1668 '+' or '-', which is added to or subtracted from 'textwidth'. >
1669
1670 :set cc=+1 " highlight column after 'textwidth'
1671 :set cc=+1,+2,+3 " highlight three columns after 'textwidth'
1672 :hi ColorColumn ctermbg=lightgrey guibg=lightgrey
1673<
1674 When 'textwidth' is zero then the items with '-' and '+' are not used.
1675 A maximum of 256 columns are highlighted.
1676
Bram Moolenaar071d4272004-06-13 20:20:40 +00001677 *'columns'* *'co'* *E594*
1678'columns' 'co' number (default 80 or terminal width)
1679 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001680 Number of columns of the screen. Normally this is set by the terminal
Bram Moolenaar7c626922005-02-07 22:01:03 +00001681 initialization and does not have to be set by hand. Also see
1682 |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001683 When Vim is running in the GUI or in a resizable window, setting this
1684 option will cause the window size to be changed. When you only want
1685 to use the size for the GUI, put the command in your |gvimrc| file.
1686 When you set this option and Vim is unable to change the physical
Bram Moolenaar02467872007-05-06 13:22:01 +00001687 number of columns of the display, the display may be messed up. For
1688 the GUI it is always possible and Vim limits the number of columns to
1689 what fits on the screen. You can use this command to get the widest
1690 window possible: >
1691 :set columns=9999
1692< Minimum value is 12, maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001693
1694 *'comments'* *'com'* *E524* *E525*
1695'comments' 'com' string (default
1696 "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-")
1697 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001698 A comma separated list of strings that can start a comment line. See
1699 |format-comments|. See |option-backslash| about using backslashes to
1700 insert a space.
1701
1702 *'commentstring'* *'cms'* *E537*
1703'commentstring' 'cms' string (default "/*%s*/")
1704 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001705 {not available when compiled without the |+folding|
1706 feature}
1707 A template for a comment. The "%s" in the value is replaced with the
1708 comment text. Currently only used to add markers for folding, see
1709 |fold-marker|.
1710
1711 *'compatible'* *'cp'* *'nocompatible'* *'nocp'*
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001712'compatible' 'cp' boolean (default on, off when a |vimrc| or |gvimrc|
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02001713 file is found, reset in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001714 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001715 This option has the effect of making Vim either more Vi-compatible, or
1716 make Vim behave in a more useful way.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001717
Bram Moolenaar071d4272004-06-13 20:20:40 +00001718 This is a special kind of option, because when it's set or reset,
Bram Moolenaar214641f2017-03-05 17:04:09 +01001719 other options are also changed as a side effect.
1720 NOTE: Setting or resetting this option can have a lot of unexpected
1721 effects: Mappings are interpreted in another way, undo behaves
1722 differently, etc. If you set this option in your vimrc file, you
1723 should probably put it at the very start.
1724
Bram Moolenaar071d4272004-06-13 20:20:40 +00001725 By default this option is on and the Vi defaults are used for the
1726 options. This default was chosen for those people who want to use Vim
1727 just like Vi, and don't even (want to) know about the 'compatible'
1728 option.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001729 When a |vimrc| or |gvimrc| file is found while Vim is starting up,
Bram Moolenaard042c562005-06-30 22:04:15 +00001730 this option is switched off, and all options that have not been
1731 modified will be set to the Vim defaults. Effectively, this means
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001732 that when a |vimrc| or |gvimrc| file exists, Vim will use the Vim
Bram Moolenaard042c562005-06-30 22:04:15 +00001733 defaults, otherwise it will use the Vi defaults. (Note: This doesn't
Bram Moolenaar02467872007-05-06 13:22:01 +00001734 happen for the system-wide vimrc or gvimrc file, nor for a file given
1735 with the |-u| argument). Also see |compatible-default| and
1736 |posix-compliance|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001737 You can also set this option with the "-C" argument, and reset it with
1738 "-N". See |-C| and |-N|.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001739 See 'cpoptions' for more fine tuning of Vi compatibility.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001740
Bram Moolenaar214641f2017-03-05 17:04:09 +01001741 When this option is set, numerous other options are set to make Vim as
1742 Vi-compatible as possible. When this option is unset, various options
1743 are set to make Vim more useful. The table below lists all the
1744 options affected.
1745 The {?} column indicates when the options are affected:
1746 + Means that the option is set to the value given in {set value} when
1747 'compatible' is set.
1748 & Means that the option is set to the value given in {set value} when
1749 'compatible' is set AND is set to its Vim default value when
1750 'compatible' is unset.
1751 - Means the option is NOT changed when setting 'compatible' but IS
1752 set to its Vim default when 'compatible' is unset.
1753 The {effect} column summarises the change when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001754
Bram Moolenaar036986f2017-03-16 17:41:02 +01001755 option ? set value effect ~
Bram Moolenaar214641f2017-03-05 17:04:09 +01001756
1757 'allowrevins' + off no CTRL-_ command
1758 'antialias' + off don't use antialiased fonts
1759 'arabic' + off reset arabic-related options
1760 'arabicshape' + on correct character shapes
1761 'backspace' + "" normal backspace
1762 'backup' + off no backup file
1763 'backupcopy' & Unix: "yes" backup file is a copy
1764 else: "auto" copy or rename backup file
1765 'balloonexpr' + "" text to show in evaluation balloon
1766 'breakindent' + off don't indent when wrapping lines
1767 'cedit' - {unchanged} {set vim default only on resetting 'cp'}
1768 'cindent' + off no C code indentation
1769 'compatible' - {unchanged} {set vim default only on resetting 'cp'}
1770 'copyindent' + off don't copy indent structure
1771 'cpoptions' & (all flags) Vi-compatible flags
1772 'cscopepathcomp'+ 0 don't show directories in tags list
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01001773 'cscoperelative'+ off don't use basename of path as prefix
Bram Moolenaar214641f2017-03-05 17:04:09 +01001774 'cscopetag' + off don't use cscope for ":tag"
Bram Moolenaar036986f2017-03-16 17:41:02 +01001775 'cscopetagorder'+ 0 see |cscopetagorder|
Bram Moolenaar214641f2017-03-05 17:04:09 +01001776 'cscopeverbose' + off see |cscopeverbose|
1777 'delcombine' + off unicode: delete whole char combination
1778 'digraph' + off no digraphs
1779 'esckeys' & off no <Esc>-keys in Insert mode
1780 'expandtab' + off tabs not expanded to spaces
1781 'fileformats' & "" no automatic file format detection,
Bram Moolenaar6f345a12019-12-17 21:27:18 +01001782 "dos,unix" except for MS-Windows
Bram Moolenaar214641f2017-03-05 17:04:09 +01001783 'formatexpr' + "" use 'formatprg' for auto-formatting
1784 'formatoptions' & "vt" Vi compatible formatting
1785 'gdefault' + off no default 'g' flag for ":s"
1786 'history' & 0 no commandline history
1787 'hkmap' + off no Hebrew keyboard mapping
1788 'hkmapp' + off no phonetic Hebrew keyboard mapping
1789 'hlsearch' + off no highlighting of search matches
1790 'incsearch' + off no incremental searching
1791 'indentexpr' + "" no indenting by expression
1792 'insertmode' + off do not start in Insert mode
1793 'iskeyword' & "@,48-57,_" keywords contain alphanumeric
Bram Moolenaar071d4272004-06-13 20:20:40 +00001794 characters and '_'
Bram Moolenaar214641f2017-03-05 17:04:09 +01001795 'joinspaces' + on insert 2 spaces after period
1796 'modeline' & off no modelines
1797 'more' & off no pauses in listings
1798 'mzquantum' - {unchanged} {set vim default only on resetting 'cp'}
1799 'numberwidth' & 8 min number of columns for line number
1800 'preserveindent'+ off don't preserve current indent structure
1801 when changing it
1802 'revins' + off no reverse insert
1803 'ruler' + off no ruler
1804 'scrolljump' + 1 no jump scroll
1805 'scrolloff' + 0 no scroll offset
1806 'shelltemp' - {unchanged} {set vim default only on resetting 'cp'}
1807 'shiftround' + off indent not rounded to shiftwidth
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02001808 'shortmess' & "S" no shortening of messages
Bram Moolenaar214641f2017-03-05 17:04:09 +01001809 'showcmd' & off command characters not shown
1810 'showmode' & off current mode not shown
1811 'sidescrolloff' + 0 cursor moves to edge of screen in scroll
1812 'smartcase' + off no automatic ignore case switch
1813 'smartindent' + off no smart indentation
1814 'smarttab' + off no smart tab size
1815 'softtabstop' + 0 tabs are always 'tabstop' positions
1816 'startofline' + on goto startofline with some commands
1817 'tagcase' & "followic" 'ignorecase' when searching tags file
1818 'tagrelative' & off tag file names are not relative
1819 'termguicolors' + off don't use highlight-(guifg|guibg)
1820 'textauto' & off no automatic textmode detection
1821 'textwidth' + 0 no automatic line wrap
1822 'tildeop' + off tilde is not an operator
1823 'ttimeout' + off no terminal timeout
1824 'undofile' + off don't use an undo file
Bram Moolenaar036986f2017-03-16 17:41:02 +01001825 'viminfo' - {unchanged} {set Vim default only on resetting 'cp'}
Bram Moolenaar214641f2017-03-05 17:04:09 +01001826 'virtualedit' + "" cursor can only be placed on characters
1827 'whichwrap' & "" left-right movements don't wrap
1828 'wildchar' & CTRL-E only when the current value is <Tab>
Bram Moolenaar071d4272004-06-13 20:20:40 +00001829 use CTRL-E for cmdline completion
Bram Moolenaar214641f2017-03-05 17:04:09 +01001830 'writebackup' + on or off depends on the |+writebackup| feature
Bram Moolenaar071d4272004-06-13 20:20:40 +00001831
1832 *'complete'* *'cpt'* *E535*
1833'complete' 'cpt' string (default: ".,w,b,u,t,i")
1834 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001835 This option specifies how keyword completion |ins-completion| works
1836 when CTRL-P or CTRL-N are used. It is also used for whole-line
1837 completion |i_CTRL-X_CTRL-L|. It indicates the type of completion
1838 and the places to scan. It is a comma separated list of flags:
Bram Moolenaar3848e002016-03-19 18:42:29 +01001839 . scan the current buffer ('wrapscan' is ignored)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001840 w scan buffers from other windows
1841 b scan other loaded buffers that are in the buffer list
1842 u scan the unloaded buffers that are in the buffer list
1843 U scan the buffers that are not in the buffer list
1844 k scan the files given with the 'dictionary' option
Bram Moolenaar0b238792006-03-02 22:49:12 +00001845 kspell use the currently active spell checking |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001846 k{dict} scan the file {dict}. Several "k" flags can be given,
1847 patterns are valid too. For example: >
1848 :set cpt=k/usr/dict/*,k~/spanish
1849< s scan the files given with the 'thesaurus' option
1850 s{tsr} scan the file {tsr}. Several "s" flags can be given, patterns
1851 are valid too.
1852 i scan current and included files
1853 d scan current and included files for defined name or macro
1854 |i_CTRL-X_CTRL-D|
1855 ] tag completion
1856 t same as "]"
1857
1858 Unloaded buffers are not loaded, thus their autocmds |:autocmd| are
1859 not executed, this may lead to unexpected completions from some files
1860 (gzipped files for example). Unloaded buffers are not scanned for
1861 whole-line completion.
1862
1863 The default is ".,w,b,u,t,i", which means to scan:
1864 1. the current buffer
1865 2. buffers in other windows
1866 3. other loaded buffers
1867 4. unloaded buffers
1868 5. tags
1869 6. included files
1870
1871 As you can see, CTRL-N and CTRL-P can be used to do any 'iskeyword'-
Bram Moolenaar582fd852005-03-28 20:58:01 +00001872 based expansion (e.g., dictionary |i_CTRL-X_CTRL-K|, included patterns
1873 |i_CTRL-X_CTRL-I|, tags |i_CTRL-X_CTRL-]| and normal expansions).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001874
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001875 *'completefunc'* *'cfu'*
1876'completefunc' 'cfu' string (default: empty)
1877 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02001878 {not available when compiled without the |+eval|
Bram Moolenaare2c453d2019-08-21 14:37:09 +02001879 feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00001880 This option specifies a function to be used for Insert mode completion
1881 with CTRL-X CTRL-U. |i_CTRL-X_CTRL-U|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001882 See |complete-functions| for an explanation of how the function is
1883 invoked and what it should return.
Bram Moolenaar166af9b2010-11-16 20:34:40 +01001884 This option cannot be set from a |modeline| or in the |sandbox|, for
1885 security reasons.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00001886
Bram Moolenaarac3150d2019-07-28 16:36:39 +02001887 *'completeslash'* *'csl'*
1888'completeslash' 'csl' string (default: "")
1889 local to buffer
Bram Moolenaar2e693a82019-10-16 22:35:02 +02001890 {only for MS-Windows}
Bram Moolenaarac3150d2019-07-28 16:36:39 +02001891 When this option is set it overrules 'shellslash' for completion:
1892 - When this option is set to "slash", a forward slash is used for path
1893 completion in insert mode. This is useful when editing HTML tag, or
Bram Moolenaar6f345a12019-12-17 21:27:18 +01001894 Makefile with 'noshellslash' on MS-Windows.
Bram Moolenaarac3150d2019-07-28 16:36:39 +02001895 - When this option is set to "backslash", backslash is used. This is
Bram Moolenaar6f345a12019-12-17 21:27:18 +01001896 useful when editing a batch file with 'shellslash' set on MS-Windows.
Bram Moolenaarac3150d2019-07-28 16:36:39 +02001897 - When this option is empty, same character is used as for
1898 'shellslash'.
1899 For Insert mode completion the buffer-local value is used. For
1900 command line completion the global value is used.
1901
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001902 *'completeopt'* *'cot'*
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001903'completeopt' 'cot' string (default: "menu,preview")
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001904 global
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001905 A comma separated list of options for Insert mode completion
1906 |ins-completion|. The supported values are:
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001907
1908 menu Use a popup menu to show the possible completions. The
1909 menu is only shown when there is more than one match and
1910 sufficient colors are available. |ins-completion-menu|
1911
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001912 menuone Use the popup menu also when there is only one match.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00001913 Useful when there is additional information about the
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001914 match, e.g., what file it comes from.
1915
Bram Moolenaarc1e37902006-04-18 21:55:01 +00001916 longest Only insert the longest common text of the matches. If
1917 the menu is displayed you can use CTRL-L to add more
1918 characters. Whether case is ignored depends on the kind
1919 of completion. For buffer text the 'ignorecase' option is
1920 used.
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001921
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001922 preview Show extra information about the currently selected
Bram Moolenaar02467872007-05-06 13:22:01 +00001923 completion in the preview window. Only works in
1924 combination with "menu" or "menuone".
1925
Bram Moolenaar576a4a62019-08-18 15:25:17 +02001926 popup Show extra information about the currently selected
1927 completion in a popup window. Only works in combination
1928 with "menu" or "menuone". Overrides "preview".
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02001929 See |'completepopup'| for specifying properties.
Bram Moolenaar2e693a82019-10-16 22:35:02 +02001930 {only works when compiled with the |+textprop| feature}
Bram Moolenaar576a4a62019-08-18 15:25:17 +02001931
Bram Moolenaardca7abe2019-10-20 18:17:57 +02001932 popuphidden
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01001933 Just like "popup" but initially hide the popup. Use a
Bram Moolenaardca7abe2019-10-20 18:17:57 +02001934 |CompleteChanged| autocommand to fetch the info and call
1935 |popup_show()| once the popup has been filled.
1936 See the example at |complete-popuphidden|.
1937 {only works when compiled with the |+textprop| feature}
1938
Bram Moolenaarb6be1e22015-07-10 18:18:40 +02001939 noinsert Do not insert any text for a match until the user selects
1940 a match from the menu. Only works in combination with
1941 "menu" or "menuone". No effect if "longest" is present.
1942
1943 noselect Do not select a match in the menu, force the user to
1944 select one from the menu. Only works in combination with
1945 "menu" or "menuone".
1946
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001947
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02001948 *'completepopup'* *'cpp'*
1949'completepopup' 'cpp' string (default empty)
1950 global
1951 {not available when compiled without the |+textprop|
1952 or |+quickfix| feature}
1953 When 'completeopt' contains "popup" then this option is used for the
Bram Moolenaar447bfba2020-07-18 16:07:16 +02001954 properties of the info popup when it is created. If an info popup
1955 window already exists it is closed, so that the option value is
1956 applied when it is created again.
1957 You can also use |popup_findinfo()| and then set properties for an
1958 existing info popup with |popup_setoptions()|. See |complete-popup|.
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02001959
1960
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001961 *'concealcursor'* *'cocu'*
1962'concealcursor' 'cocu' string (default: "")
1963 local to window
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001964 {not available when compiled without the |+conceal|
1965 feature}
1966 Sets the modes in which text in the cursor line can also be concealed.
1967 When the current mode is listed then concealing happens just like in
1968 other lines.
1969 n Normal mode
1970 v Visual mode
1971 i Insert mode
Bram Moolenaarca8c9862010-07-24 15:00:38 +02001972 c Command line editing, for 'incsearch'
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001973
Bram Moolenaare6dc5732010-07-24 23:52:26 +02001974 'v' applies to all lines in the Visual area, not only the cursor.
Bram Moolenaarca8c9862010-07-24 15:00:38 +02001975 A useful value is "nc". This is used in help files. So long as you
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001976 are moving around text is concealed, but when starting to insert text
1977 or selecting a Visual area the concealed text is displayed, so that
1978 you can see what you are doing.
Bram Moolenaarf70e3d62010-07-24 13:15:07 +02001979 Keep in mind that the cursor position is not always where it's
1980 displayed. E.g., when moving vertically it may change column.
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001981
1982
Bram Moolenaar95bafa22018-10-02 13:26:25 +02001983 *'conceallevel'* *'cole'*
1984'conceallevel' 'cole' number (default 0)
Bram Moolenaar860cae12010-06-05 23:22:07 +02001985 local to window
Bram Moolenaar860cae12010-06-05 23:22:07 +02001986 {not available when compiled without the |+conceal|
1987 feature}
Bram Moolenaar6df6f472010-07-18 18:04:50 +02001988 Determine how text with the "conceal" syntax attribute |:syn-conceal|
1989 is shown:
Bram Moolenaar860cae12010-06-05 23:22:07 +02001990
Bram Moolenaar6df6f472010-07-18 18:04:50 +02001991 Value Effect ~
Bram Moolenaar860cae12010-06-05 23:22:07 +02001992 0 Text is shown normally
Bram Moolenaar477db062010-07-28 18:17:41 +02001993 1 Each block of concealed text is replaced with one
1994 character. If the syntax item does not have a custom
1995 replacement character defined (see |:syn-cchar|) the
1996 character defined in 'listchars' is used (default is a
1997 space).
1998 It is highlighted with the "Conceal" highlight group.
Bram Moolenaar860cae12010-06-05 23:22:07 +02001999 2 Concealed text is completely hidden unless it has a
2000 custom replacement character defined (see
Bram Moolenaar477db062010-07-28 18:17:41 +02002001 |:syn-cchar|).
Bram Moolenaara7781e02010-07-19 20:13:22 +02002002 3 Concealed text is completely hidden.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002003
Bram Moolenaara7781e02010-07-19 20:13:22 +02002004 Note: in the cursor line concealed text is not hidden, so that you can
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002005 edit and copy the text. This can be changed with the 'concealcursor'
2006 option.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002007
Bram Moolenaar071d4272004-06-13 20:20:40 +00002008 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
2009'confirm' 'cf' boolean (default off)
2010 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002011 When 'confirm' is on, certain operations that would normally
2012 fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
2013 instead raise a |dialog| asking if you wish to save the current
2014 file(s). You can still use a ! to unconditionally |abandon| a buffer.
2015 If 'confirm' is off you can still activate confirmation for one
2016 command only (this is most useful in mappings) with the |:confirm|
2017 command.
2018 Also see the |confirm()| function and the 'v' flag in 'guioptions'.
2019
2020 *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
2021'conskey' 'consk' boolean (default off)
2022 global
Bram Moolenaarf3913272016-02-25 00:00:01 +01002023 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002024
2025 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
2026'copyindent' 'ci' boolean (default off)
2027 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002028 Copy the structure of the existing lines indent when autoindenting a
2029 new line. Normally the new indent is reconstructed by a series of
2030 tabs followed by spaces as required (unless |'expandtab'| is enabled,
2031 in which case only spaces are used). Enabling this option makes the
2032 new line copy whatever characters were used for indenting on the
Bram Moolenaar446cb832008-06-24 21:56:24 +00002033 existing line. 'expandtab' has no effect on these characters, a Tab
2034 remains a Tab. If the new indent is greater than on the existing
Bram Moolenaar071d4272004-06-13 20:20:40 +00002035 line, the remaining space is filled in the normal manner.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002036 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002037 Also see 'preserveindent'.
2038
Bram Moolenaare0fa3742016-02-20 15:47:01 +01002039 *'cpoptions'* *'cpo'* *cpo*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002040'cpoptions' 'cpo' string (Vim default: "aABceFs",
2041 Vi default: all flags)
2042 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002043 A sequence of single character flags. When a character is present
Bram Moolenaar7cba6c02013-09-05 22:13:31 +02002044 this indicates Vi-compatible behavior. This is used for things where
2045 not being Vi-compatible is mostly or sometimes preferred.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002046 'cpoptions' stands for "compatible-options".
2047 Commas can be added for readability.
2048 To avoid problems with flags that are added in the future, use the
2049 "+=" and "-=" feature of ":set" |add-option-flags|.
2050 NOTE: This option is set to the Vi default value when 'compatible' is
2051 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002052 NOTE: This option is set to the POSIX default value at startup when
2053 the Vi default value would be used and the $VIM_POSIX environment
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002054 variable exists |posix|. This means Vim tries to behave like the
2055 POSIX specification.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002056
2057 contains behavior ~
2058 *cpo-a*
2059 a When included, a ":read" command with a file name
2060 argument will set the alternate file name for the
2061 current window.
2062 *cpo-A*
2063 A When included, a ":write" command with a file name
2064 argument will set the alternate file name for the
2065 current window.
2066 *cpo-b*
2067 b "\|" in a ":map" command is recognized as the end of
2068 the map command. The '\' is included in the mapping,
2069 the text after the '|' is interpreted as the next
2070 command. Use a CTRL-V instead of a backslash to
2071 include the '|' in the mapping. Applies to all
2072 mapping, abbreviation, menu and autocmd commands.
2073 See also |map_bar|.
2074 *cpo-B*
2075 B A backslash has no special meaning in mappings,
Bram Moolenaara9604e62018-07-21 05:56:22 +02002076 abbreviations, user commands and the "to" part of the
2077 menu commands. Remove this flag to be able to use a
2078 backslash like a CTRL-V. For example, the command
2079 ":map X \<Esc>" results in X being mapped to:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002080 'B' included: "\^[" (^[ is a real <Esc>)
2081 'B' excluded: "<Esc>" (5 characters)
2082 ('<' excluded in both cases)
2083 *cpo-c*
2084 c Searching continues at the end of any match at the
2085 cursor position, but not further than the start of the
2086 next line. When not present searching continues
2087 one character from the cursor position. With 'c'
2088 "abababababab" only gets three matches when repeating
2089 "/abab", without 'c' there are five matches.
2090 *cpo-C*
2091 C Do not concatenate sourced lines that start with a
2092 backslash. See |line-continuation|.
2093 *cpo-d*
2094 d Using "./" in the 'tags' option doesn't mean to use
2095 the tags file relative to the current file, but the
2096 tags file in the current directory.
2097 *cpo-D*
2098 D Can't use CTRL-K to enter a digraph after Normal mode
2099 commands with a character argument, like |r|, |f| and
2100 |t|.
2101 *cpo-e*
2102 e When executing a register with ":@r", always add a
2103 <CR> to the last line, also when the register is not
2104 linewise. If this flag is not present, the register
2105 is not linewise and the last line does not end in a
2106 <CR>, then the last line is put on the command-line
2107 and can be edited before hitting <CR>.
2108 *cpo-E*
2109 E It is an error when using "y", "d", "c", "g~", "gu" or
2110 "gU" on an Empty region. The operators only work when
Bram Moolenaar15142e22018-04-30 22:19:58 +02002111 at least one character is to be operated on. Example:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002112 This makes "y0" fail in the first column.
2113 *cpo-f*
2114 f When included, a ":read" command with a file name
2115 argument will set the file name for the current buffer,
2116 if the current buffer doesn't have a file name yet.
2117 *cpo-F*
2118 F When included, a ":write" command with a file name
2119 argument will set the file name for the current
2120 buffer, if the current buffer doesn't have a file name
Bram Moolenaarb3480382005-12-11 21:33:32 +00002121 yet. Also see |cpo-P|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002122 *cpo-g*
2123 g Goto line 1 when using ":edit" without argument.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002124 *cpo-H*
2125 H When using "I" on a line with only blanks, insert
2126 before the last blank. Without this flag insert after
2127 the last blank.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002128 *cpo-i*
2129 i When included, interrupting the reading of a file will
2130 leave it modified.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002131 *cpo-I*
2132 I When moving the cursor up or down just after inserting
2133 indent for 'autoindent', do not delete the indent.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002134 *cpo-j*
2135 j When joining lines, only add two spaces after a '.',
2136 not after '!' or '?'. Also see 'joinspaces'.
2137 *cpo-J*
2138 J A |sentence| has to be followed by two spaces after
Bram Moolenaar582fd852005-03-28 20:58:01 +00002139 the '.', '!' or '?'. A <Tab> is not recognized as
Bram Moolenaar071d4272004-06-13 20:20:40 +00002140 white space.
2141 *cpo-k*
2142 k Disable the recognition of raw key codes in
2143 mappings, abbreviations, and the "to" part of menu
2144 commands. For example, if <Key> sends ^[OA (where ^[
2145 is <Esc>), the command ":map X ^[OA" results in X
2146 being mapped to:
2147 'k' included: "^[OA" (3 characters)
2148 'k' excluded: "<Key>" (one key code)
2149 Also see the '<' flag below.
2150 *cpo-K*
2151 K Don't wait for a key code to complete when it is
2152 halfway a mapping. This breaks mapping <F1><F1> when
2153 only part of the second <F1> has been read. It
2154 enables cancelling the mapping by typing <F1><Esc>.
2155 *cpo-l*
2156 l Backslash in a [] range in a search pattern is taken
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002157 literally, only "\]", "\^", "\-" and "\\" are special.
2158 See |/[]|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002159 'l' included: "/[ \t]" finds <Space>, '\' and 't'
2160 'l' excluded: "/[ \t]" finds <Space> and <Tab>
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002161 Also see |cpo-\|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002162 *cpo-L*
2163 L When the 'list' option is set, 'wrapmargin',
2164 'textwidth', 'softtabstop' and Virtual Replace mode
2165 (see |gR|) count a <Tab> as two characters, instead of
2166 the normal behavior of a <Tab>.
2167 *cpo-m*
2168 m When included, a showmatch will always wait half a
2169 second. When not included, a showmatch will wait half
2170 a second or until a character is typed. |'showmatch'|
2171 *cpo-M*
2172 M When excluded, "%" matching will take backslashes into
2173 account. Thus in "( \( )" and "\( ( \)" the outer
2174 parenthesis match. When included "%" ignores
2175 backslashes, which is Vi compatible.
2176 *cpo-n*
Bram Moolenaar64486672010-05-16 15:46:46 +02002177 n When included, the column used for 'number' and
2178 'relativenumber' will also be used for text of wrapped
2179 lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002180 *cpo-o*
2181 o Line offset to search command is not remembered for
2182 next search.
2183 *cpo-O*
2184 O Don't complain if a file is being overwritten, even
2185 when it didn't exist when editing it. This is a
2186 protection against a file unexpectedly created by
2187 someone else. Vi didn't complain about this.
2188 *cpo-p*
2189 p Vi compatible Lisp indenting. When not present, a
2190 slightly better algorithm is used.
Bram Moolenaarb3480382005-12-11 21:33:32 +00002191 *cpo-P*
2192 P When included, a ":write" command that appends to a
2193 file will set the file name for the current buffer, if
2194 the current buffer doesn't have a file name yet and
2195 the 'F' flag is also included |cpo-F|.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002196 *cpo-q*
2197 q When joining multiple lines leave the cursor at the
2198 position where it would be when joining two lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002199 *cpo-r*
2200 r Redo ("." command) uses "/" to repeat a search
2201 command, instead of the actually used search string.
2202 *cpo-R*
2203 R Remove marks from filtered lines. Without this flag
2204 marks are kept like |:keepmarks| was used.
2205 *cpo-s*
2206 s Set buffer options when entering the buffer for the
2207 first time. This is like it is in Vim version 3.0.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002208 And it is the default. If not present the options are
Bram Moolenaar071d4272004-06-13 20:20:40 +00002209 set when the buffer is created.
2210 *cpo-S*
2211 S Set buffer options always when entering a buffer
2212 (except 'readonly', 'fileformat', 'filetype' and
2213 'syntax'). This is the (most) Vi compatible setting.
2214 The options are set to the values in the current
2215 buffer. When you change an option and go to another
2216 buffer, the value is copied. Effectively makes the
2217 buffer options global to all buffers.
2218
2219 's' 'S' copy buffer options
2220 no no when buffer created
2221 yes no when buffer first entered (default)
2222 X yes each time when buffer entered (vi comp.)
2223 *cpo-t*
2224 t Search pattern for the tag command is remembered for
2225 "n" command. Otherwise Vim only puts the pattern in
2226 the history for search pattern, but doesn't change the
2227 last used search pattern.
2228 *cpo-u*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002229 u Undo is Vi compatible. See |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002230 *cpo-v*
2231 v Backspaced characters remain visible on the screen in
2232 Insert mode. Without this flag the characters are
2233 erased from the screen right away. With this flag the
2234 screen newly typed text overwrites backspaced
2235 characters.
2236 *cpo-w*
2237 w When using "cw" on a blank character, only change one
2238 character and not all blanks until the start of the
2239 next word.
2240 *cpo-W*
2241 W Don't overwrite a readonly file. When omitted, ":w!"
2242 overwrites a readonly file, if possible.
2243 *cpo-x*
2244 x <Esc> on the command-line executes the command-line.
2245 The default in Vim is to abandon the command-line,
2246 because <Esc> normally aborts a command. |c_<Esc>|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002247 *cpo-X*
2248 X When using a count with "R" the replaced text is
2249 deleted only once. Also when repeating "R" with "."
2250 and a count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002251 *cpo-y*
Bram Moolenaard09091d2019-01-17 16:07:22 +01002252 y A yank command can be redone with ".". Think twice if
2253 you really want to use this, it may break some
2254 plugins, since most people expect "." to only repeat a
2255 change.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002256 *cpo-Z*
2257 Z When using "w!" while the 'readonly' option is set,
2258 don't reset 'readonly'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002259 *cpo-!*
2260 ! When redoing a filter command, use the last used
2261 external command, whatever it was. Otherwise the last
2262 used -filter- command is used.
2263 *cpo-$*
2264 $ When making a change to one line, don't redisplay the
2265 line, but put a '$' at the end of the changed text.
2266 The changed text will be overwritten when you type the
2267 new text. The line is redisplayed if you type any
2268 command that moves the cursor from the insertion
2269 point.
2270 *cpo-%*
2271 % Vi-compatible matching is done for the "%" command.
2272 Does not recognize "#if", "#endif", etc.
2273 Does not recognize "/*" and "*/".
2274 Parens inside single and double quotes are also
2275 counted, causing a string that contains a paren to
2276 disturb the matching. For example, in a line like
2277 "if (strcmp("foo(", s))" the first paren does not
2278 match the last one. When this flag is not included,
2279 parens inside single and double quotes are treated
2280 specially. When matching a paren outside of quotes,
2281 everything inside quotes is ignored. When matching a
2282 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002283 there is one). This works very well for C programs.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002284 This flag is also used for other features, such as
2285 C-indenting.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002286 *cpo--*
2287 - When included, a vertical movement command fails when
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002288 it would go above the first line or below the last
2289 line. Without it the cursor moves to the first or
2290 last line, unless it already was in that line.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002291 Applies to the commands "-", "k", CTRL-P, "+", "j",
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002292 CTRL-N, CTRL-J and ":1234".
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002293 *cpo-+*
2294 + When included, a ":write file" command will reset the
2295 'modified' flag of the buffer, even though the buffer
2296 itself may still be different from its file.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002297 *cpo-star*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002298 * Use ":*" in the same way as ":@". When not included,
2299 ":*" is an alias for ":'<,'>", select the Visual area.
2300 *cpo-<*
2301 < Disable the recognition of special key codes in |<>|
2302 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002303 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00002304 ":map X <Tab>" results in X being mapped to:
2305 '<' included: "<Tab>" (5 characters)
2306 '<' excluded: "^I" (^I is a real <Tab>)
2307 Also see the 'k' flag above.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002308 *cpo->*
2309 > When appending to a register, put a line break before
2310 the appended text.
Bram Moolenaar8b3e0332011-06-26 05:36:34 +02002311 *cpo-;*
2312 ; When using |,| or |;| to repeat the last |t| search
2313 and the cursor is right in front of the searched
2314 character, the cursor won't move. When not included,
2315 the cursor would skip over it and jump to the
Bram Moolenaarc8734422012-06-01 22:38:45 +02002316 following occurrence.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002317
2318 POSIX flags. These are not included in the Vi default value, except
2319 when $VIM_POSIX was set on startup. |posix|
2320
2321 contains behavior ~
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002322 *cpo-#*
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002323 # A count before "D", "o" and "O" has no effect.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002324 *cpo-&*
2325 & When ":preserve" was used keep the swap file when
2326 exiting normally while this buffer is still loaded.
2327 This flag is tested when exiting.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002328 *cpo-\*
2329 \ Backslash in a [] range in a search pattern is taken
2330 literally, only "\]" is special See |/[]|
Bram Moolenaar90915b52005-08-21 22:17:52 +00002331 '\' included: "/[ \-]" finds <Space>, '\' and '-'
2332 '\' excluded: "/[ \-]" finds <Space> and '-'
2333 Also see |cpo-l|.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002334 *cpo-/*
2335 / When "%" is used as the replacement string in a |:s|
2336 command, use the previous replacement string. |:s%|
2337 *cpo-{*
2338 { The |{| and |}| commands also stop at a "{" character
2339 at the start of a line.
2340 *cpo-.*
2341 . The ":chdir" and ":cd" commands fail if the current
2342 buffer is modified, unless ! is used. Vim doesn't
2343 need this, since it remembers the full path of an
2344 opened file.
2345 *cpo-bar*
2346 | The value of the $LINES and $COLUMNS environment
2347 variables overrule the terminal size values obtained
2348 with system specific functions.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002349
Bram Moolenaar071d4272004-06-13 20:20:40 +00002350
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002351 *'cryptmethod'* *'cm'*
Bram Moolenaara86187b2018-12-16 18:20:00 +01002352'cryptmethod' 'cm' string (default "blowfish2")
Bram Moolenaar49771f42010-07-20 17:32:38 +02002353 global or local to buffer |global-local|
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002354 Method used for encryption when the buffer is written to a file:
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002355 *pkzip*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002356 zip PkZip compatible method. A weak kind of encryption.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002357 Backwards compatible with Vim 7.2 and older.
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002358 *blowfish*
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002359 blowfish Blowfish method. Medium strong encryption but it has
2360 an implementation flaw. Requires Vim 7.3 or later,
2361 files can NOT be read by Vim 7.2 and older. This adds
2362 a "seed" to the file, every time you write the file
2363 the encrypted bytes will be different.
2364 *blowfish2*
2365 blowfish2 Blowfish method. Medium strong encryption. Requires
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01002366 Vim 7.4.401 or later, files can NOT be read by Vim 7.3
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002367 and older. This adds a "seed" to the file, every time
2368 you write the file the encrypted bytes will be
2369 different. The whole undo file is encrypted, not just
2370 the pieces of text.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002371
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01002372 You should use "blowfish2", also to re-encrypt older files.
2373
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002374 When reading an encrypted file 'cryptmethod' will be set automatically
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002375 to the detected method of the file being read. Thus if you write it
2376 without changing 'cryptmethod' the same method will be used.
2377 Changing 'cryptmethod' does not mark the file as modified, you have to
Bram Moolenaar49771f42010-07-20 17:32:38 +02002378 explicitly write it, you don't get a warning unless there are other
2379 modifications. Also see |:X|.
2380
2381 When setting the global value to an empty string, it will end up with
Bram Moolenaara86187b2018-12-16 18:20:00 +01002382 the value "blowfish2". When setting the local value to an empty
2383 string the buffer will use the global value.
Bram Moolenaar49771f42010-07-20 17:32:38 +02002384
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002385 When a new encryption method is added in a later version of Vim, and
2386 the current version does not recognize it, you will get *E821* .
Bram Moolenaar49771f42010-07-20 17:32:38 +02002387 You need to edit this file with the later version of Vim.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002388
2389
Bram Moolenaar071d4272004-06-13 20:20:40 +00002390 *'cscopepathcomp'* *'cspc'*
2391'cscopepathcomp' 'cspc' number (default 0)
2392 global
2393 {not available when compiled without the |+cscope|
2394 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002395 Determines how many components of the path to show in a list of tags.
2396 See |cscopepathcomp|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002397 NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002398
2399 *'cscopeprg'* *'csprg'*
2400'cscopeprg' 'csprg' string (default "cscope")
2401 global
2402 {not available when compiled without the |+cscope|
2403 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002404 Specifies the command to execute cscope. See |cscopeprg|.
2405 This option cannot be set from a |modeline| or in the |sandbox|, for
2406 security reasons.
2407
2408 *'cscopequickfix'* *'csqf'*
2409'cscopequickfix' 'csqf' string (default "")
2410 global
2411 {not available when compiled without the |+cscope|
2412 or |+quickfix| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002413 Specifies whether to use quickfix window to show cscope results.
2414 See |cscopequickfix|.
2415
Bram Moolenaarec7944a2013-06-12 21:29:15 +02002416 *'cscoperelative'* *'csre'* *'nocscoperelative'* *'nocsre'*
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002417'cscoperelative' 'csre' boolean (default off)
2418 global
2419 {not available when compiled without the |+cscope|
2420 feature}
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002421 In the absence of a prefix (-P) for cscope. setting this option enables
2422 to use the basename of cscope.out path as the prefix.
2423 See |cscoperelative|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002424 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002425
Bram Moolenaar071d4272004-06-13 20:20:40 +00002426 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
2427'cscopetag' 'cst' boolean (default off)
2428 global
2429 {not available when compiled without the |+cscope|
2430 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002431 Use cscope for tag commands. See |cscope-options|.
2432 NOTE: This option is reset when 'compatible' is set.
2433
2434 *'cscopetagorder'* *'csto'*
2435'cscopetagorder' 'csto' number (default 0)
2436 global
2437 {not available when compiled without the |+cscope|
2438 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002439 Determines the order in which ":cstag" performs a search. See
2440 |cscopetagorder|.
2441 NOTE: This option is set to 0 when 'compatible' is set.
2442
2443 *'cscopeverbose'* *'csverb'*
2444 *'nocscopeverbose'* *'nocsverb'*
2445'cscopeverbose' 'csverb' boolean (default off)
2446 global
2447 {not available when compiled without the |+cscope|
2448 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002449 Give messages when adding a cscope database. See |cscopeverbose|.
2450 NOTE: This option is reset when 'compatible' is set.
2451
Bram Moolenaar860cae12010-06-05 23:22:07 +02002452 *'cursorbind'* *'crb'* *'nocursorbind'* *'nocrb'*
2453'cursorbind' 'crb' boolean (default off)
2454 local to window
Bram Moolenaar860cae12010-06-05 23:22:07 +02002455 When this option is set, as the cursor in the current
2456 window moves other cursorbound windows (windows that also have
2457 this option set) move their cursors to the corresponding line and
2458 column. This option is useful for viewing the
2459 differences between two versions of a file (see 'diff'); in diff mode,
2460 inserted and deleted lines (though not characters within a line) are
Bram Moolenaar1a384422010-07-14 19:53:30 +02002461 taken into account.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002462
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002463
2464 *'cursorcolumn'* *'cuc'* *'nocursorcolumn'* *'nocuc'*
2465'cursorcolumn' 'cuc' boolean (default off)
2466 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02002467 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002468 feature}
2469 Highlight the screen column of the cursor with CursorColumn
2470 |hl-CursorColumn|. Useful to align text. Will make screen redrawing
2471 slower.
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00002472 If you only want the highlighting in the current window you can use
2473 these autocommands: >
2474 au WinLeave * set nocursorline nocursorcolumn
2475 au WinEnter * set cursorline cursorcolumn
2476<
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002477
2478 *'cursorline'* *'cul'* *'nocursorline'* *'nocul'*
2479'cursorline' 'cul' boolean (default off)
2480 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02002481 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002482 feature}
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002483 Highlight the text line of the cursor with CursorLine |hl-CursorLine|.
2484 Useful to easily spot the cursor. Will make screen redrawing slower.
Bram Moolenaare2f98b92006-03-29 21:18:24 +00002485 When Visual mode is active the highlighting isn't used to make it
Bram Moolenaar779b74b2006-04-10 14:55:34 +00002486 easier to see the selected text.
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002487
2488
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002489 *'cursorlineopt'* *'culopt'*
Bram Moolenaar017ba072019-09-14 21:01:23 +02002490'cursorlineopt' 'culopt' string (default: "number,line")
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002491 local to window
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002492 {not available when compiled without the |+syntax|
2493 feature}
Bram Moolenaar017ba072019-09-14 21:01:23 +02002494 Comma separated list of settings for how 'cursorline' is displayed.
2495 Valid values:
2496 "line" Highlight the text line of the cursor with
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002497 CursorLine |hl-CursorLine|.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002498 "screenline" Highlight only the screen line of the cursor with
2499 CursorLine |hl-CursorLine|.
2500 "number" Highlight the line number of the cursor with
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002501 CursorLineNr |hl-CursorLineNr|.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002502
2503 Special value:
2504 "both" Alias for the values "line,number".
2505
2506 "line" and "screenline" cannot be used together.
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002507
2508
Bram Moolenaar071d4272004-06-13 20:20:40 +00002509 *'debug'*
2510'debug' string (default "")
2511 global
Bram Moolenaar57657d82006-04-21 22:12:41 +00002512 These values can be used:
2513 msg Error messages that would otherwise be omitted will be given
2514 anyway.
2515 throw Error messages that would otherwise be omitted will be given
2516 anyway and also throw an exception and set |v:errmsg|.
2517 beep A message will be given when otherwise only a beep would be
2518 produced.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002519 The values can be combined, separated by a comma.
Bram Moolenaar57657d82006-04-21 22:12:41 +00002520 "msg" and "throw" are useful for debugging 'foldexpr', 'formatexpr' or
2521 'indentexpr'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002522
2523 *'define'* *'def'*
2524'define' 'def' string (default "^\s*#\s*define")
2525 global or local to buffer |global-local|
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002526 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002527 pattern, just like for the "/" command. This option is used for the
2528 commands like "[i" and "[d" |include-search|. The 'isident' option is
2529 used to recognize the defined name after the match:
2530 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2531 See |option-backslash| about inserting backslashes to include a space
2532 or backslash.
2533 The default value is for C programs. For C++ this value would be
2534 useful, to include const type declarations: >
2535 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
Bram Moolenaar63b74a82019-03-24 15:09:13 +01002536< You can also use "\ze" just before the name and continue the pattern
2537 to check what is following. E.g. for Javascript, if a function is
2538 defined with "func_name = function(args)": >
2539 ^\s*\ze\i\+\s*=\s*function(
2540< If the function is defined with "func_name : function() {...": >
2541 ^\s*\ze\i\+\s*[:]\s*(*function\s*(
Bram Moolenaar071d4272004-06-13 20:20:40 +00002542< When using the ":set" command, you need to double the backslashes!
Bram Moolenaar63b74a82019-03-24 15:09:13 +01002543 To avoid that use `:let` with a single quote string: >
2544 let &l:define = '^\s*\ze\k\+\s*=\s*function('
Bram Moolenaar911ead12019-04-21 00:03:35 +02002545<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002546
2547 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2548'delcombine' 'deco' boolean (default off)
2549 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002550 If editing Unicode and this option is set, backspace and Normal mode
2551 "x" delete each combining character on its own. When it is off (the
2552 default) the character along with its combining characters are
2553 deleted.
2554 Note: When 'delcombine' is set "xx" may work different from "2x"!
2555
2556 This is useful for Arabic, Hebrew and many other languages where one
2557 may have combining characters overtop of base characters, and want
2558 to remove only the combining ones.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002559 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002560
2561 *'dictionary'* *'dict'*
2562'dictionary' 'dict' string (default "")
2563 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002564 List of file names, separated by commas, that are used to lookup words
2565 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2566 contain a list of words. This can be one word per line, or several
2567 words per line, separated by non-keyword characters (white space is
2568 preferred). Maximum line length is 510 bytes.
Bram Moolenaar259f26a2018-05-15 22:25:40 +02002569
2570 When this option is empty or an entry "spell" is present, and spell
2571 checking is enabled, words in the word lists for the currently active
2572 'spelllang' are used. See |spell|.
2573
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002574 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002575 after a comma are ignored, otherwise spaces are included in the file
2576 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002577 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002578 Where to find a list of words?
2579 - On FreeBSD, there is the file "/usr/share/dict/words".
2580 - In the Simtel archive, look in the "msdos/linguist" directory.
2581 - In "miscfiles" of the GNU collection.
2582 The use of |:set+=| and |:set-=| is preferred when adding or removing
2583 directories from the list. This avoids problems when a future version
2584 uses another default.
2585 Backticks cannot be used in this option for security reasons.
2586
2587 *'diff'* *'nodiff'*
2588'diff' boolean (default off)
2589 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00002590 {not available when compiled without the |+diff|
2591 feature}
2592 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002593 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002594
2595 *'dex'* *'diffexpr'*
2596'diffexpr' 'dex' string (default "")
2597 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002598 {not available when compiled without the |+diff|
2599 feature}
Bram Moolenaare828b762018-09-10 17:51:58 +02002600 Expression which is evaluated to obtain a diff file (either ed-style
2601 or unified-style) from two versions of a file. See |diff-diffexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002602 This option cannot be set from a |modeline| or in the |sandbox|, for
2603 security reasons.
2604
2605 *'dip'* *'diffopt'*
Bram Moolenaarc8234772019-11-10 21:00:27 +01002606'diffopt' 'dip' string (default "internal,filler,closeoff")
Bram Moolenaar071d4272004-06-13 20:20:40 +00002607 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002608 {not available when compiled without the |+diff|
2609 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002610 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002611 All are optional. Items must be separated by a comma.
2612
2613 filler Show filler lines, to keep the text
2614 synchronized with a window that has inserted
2615 lines at the same position. Mostly useful
2616 when windows are side-by-side and 'scrollbind'
2617 is set.
2618
2619 context:{n} Use a context of {n} lines between a change
2620 and a fold that contains unchanged lines.
2621 When omitted a context of six lines is used.
Bram Moolenaarf6b40102019-02-22 15:24:03 +01002622 When using zero the context is actually one,
2623 since folds require a line in between, also
2624 for a deleted line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002625 See |fold-diff|.
2626
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002627 iblank Ignore changes where lines are all blank. Adds
2628 the "-B" flag to the "diff" command if
2629 'diffexpr' is empty. Check the documentation
2630 of the "diff" command for what this does
2631 exactly.
2632 NOTE: the diff windows will get out of sync,
2633 because no differences between blank lines are
2634 taken into account.
2635
Bram Moolenaar071d4272004-06-13 20:20:40 +00002636 icase Ignore changes in case of text. "a" and "A"
2637 are considered the same. Adds the "-i" flag
2638 to the "diff" command if 'diffexpr' is empty.
2639
2640 iwhite Ignore changes in amount of white space. Adds
2641 the "-b" flag to the "diff" command if
2642 'diffexpr' is empty. Check the documentation
2643 of the "diff" command for what this does
2644 exactly. It should ignore adding trailing
2645 white space, but not leading white space.
2646
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002647 iwhiteall Ignore all white space changes. Adds
2648 the "-w" flag to the "diff" command if
2649 'diffexpr' is empty. Check the documentation
2650 of the "diff" command for what this does
2651 exactly.
2652
2653 iwhiteeol Ignore white space changes at end of line.
2654 Adds the "-Z" flag to the "diff" command if
2655 'diffexpr' is empty. Check the documentation
2656 of the "diff" command for what this does
2657 exactly.
2658
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002659 horizontal Start diff mode with horizontal splits (unless
2660 explicitly specified otherwise).
2661
2662 vertical Start diff mode with vertical splits (unless
2663 explicitly specified otherwise).
2664
Bram Moolenaarc8234772019-11-10 21:00:27 +01002665 closeoff When a window is closed where 'diff' is set
2666 and there is only one window remaining in the
2667 same tab page with 'diff' set, execute
2668 `:diffoff` in that window. This undoes a
2669 `:diffsplit` command.
2670
Bram Moolenaar97ce4192017-12-01 20:35:58 +01002671 hiddenoff Do not use diff mode for a buffer when it
2672 becomes hidden.
2673
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002674 foldcolumn:{n} Set the 'foldcolumn' option to {n} when
2675 starting diff mode. Without this 2 is used.
2676
Bram Moolenaare828b762018-09-10 17:51:58 +02002677 internal Use the internal diff library. This is
2678 ignored when 'diffexpr' is set. *E960*
2679 When running out of memory when writing a
2680 buffer this item will be ignored for diffs
2681 involving that buffer. Set the 'verbose'
2682 option to see when this happens.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002683
Bram Moolenaare828b762018-09-10 17:51:58 +02002684 indent-heuristic
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01002685 Use the indent heuristic for the internal
2686 diff library.
Bram Moolenaare828b762018-09-10 17:51:58 +02002687
2688 algorithm:{text} Use the specified diff algorithm with the
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01002689 internal diff engine. Currently supported
Bram Moolenaare828b762018-09-10 17:51:58 +02002690 algorithms are:
2691 myers the default algorithm
2692 minimal spend extra time to generate the
2693 smallest possible diff
2694 patience patience diff algorithm
2695 histogram histogram diff algorithm
2696
2697 Examples: >
2698 :set diffopt=internal,filler,context:4
Bram Moolenaar071d4272004-06-13 20:20:40 +00002699 :set diffopt=
Bram Moolenaare828b762018-09-10 17:51:58 +02002700 :set diffopt=internal,filler,foldcolumn:3
2701 :set diffopt-=internal " do NOT use the internal diff parser
Bram Moolenaar071d4272004-06-13 20:20:40 +00002702<
2703 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
2704'digraph' 'dg' boolean (default off)
2705 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002706 {not available when compiled without the |+digraphs|
2707 feature}
2708 Enable the entering of digraphs in Insert mode with {char1} <BS>
2709 {char2}. See |digraphs|.
2710 NOTE: This option is reset when 'compatible' is set.
2711
2712 *'directory'* *'dir'*
2713'directory' 'dir' string (default for Amiga: ".,t:",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01002714 for Win32: ".,$TEMP,c:\tmp,c:\temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00002715 for Unix: ".,~/tmp,/var/tmp,/tmp")
2716 global
2717 List of directory names for the swap file, separated with commas.
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02002718 Recommended value: ".,~/vimswap//" - this will put the swap file next
2719 to the edited file if possible, and in your personal swap directory
2720 otherwise. Make sure "~/vimswap//" is only readable for you.
2721
2722 Possible items:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002723 - The swap file will be created in the first directory where this is
2724 possible.
2725 - Empty means that no swap file will be used (recovery is
Bram Moolenaar00e192b2019-10-19 17:01:28 +02002726 impossible!) and no |E303| error will be given.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002727 - A directory "." means to put the swap file in the same directory as
2728 the edited file. On Unix, a dot is prepended to the file name, so
2729 it doesn't show in a directory listing. On MS-Windows the "hidden"
2730 attribute is set and a dot prepended if possible.
Bram Moolenaar8024f932020-01-14 19:29:13 +01002731 - A directory starting with "./" (or ".\" for MS-Windows) means to put
2732 the swap file relative to where the edited file is. The leading "."
2733 is replaced with the path name of the edited file.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02002734 - For Unix and Win32, if a directory ends in two path separators "//",
2735 the swap file name will be built from the complete path to the file
2736 with all path separators substituted to percent '%' signs. This will
2737 ensure file name uniqueness in the preserve directory.
2738 On Win32, it is also possible to end with "\\". However, When a
2739 separating comma is following, you must use "//", since "\\" will
2740 include the comma in the file name. Therefore it is recommended to
2741 use '//', instead of '\\'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002742 - Spaces after the comma are ignored, other spaces are considered part
2743 of the directory name. To have a space at the start of a directory
2744 name, precede it with a backslash.
2745 - To include a comma in a directory name precede it with a backslash.
2746 - A directory name may end in an ':' or '/'.
2747 - Environment variables are expanded |:set_env|.
2748 - Careful with '\' characters, type one before a space, type two to
2749 get one in the option (see |option-backslash|), for example: >
2750 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
2751< - For backwards compatibility with Vim version 3.0 a '>' at the start
2752 of the option is removed.
2753 Using "." first in the list is recommended. This means that editing
2754 the same file twice will result in a warning. Using "/tmp" on Unix is
2755 discouraged: When the system crashes you lose the swap file.
2756 "/var/tmp" is often not cleared when rebooting, thus is a better
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02002757 choice than "/tmp". But others on the computer may be able to see the
2758 files, and it can contain a lot of files, your swap files get lost in
2759 the crowd. That is why a "tmp" directory in your home directory is
2760 tried first.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002761 The use of |:set+=| and |:set-=| is preferred when adding or removing
2762 directories from the list. This avoids problems when a future version
2763 uses another default.
2764 This option cannot be set from a |modeline| or in the |sandbox|, for
2765 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002766
2767 *'display'* *'dy'*
Bram Moolenaarbc8801c2016-08-02 21:04:33 +02002768'display' 'dy' string (default "", set to "truncate" in
2769 |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002770 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002771 Change the way text is displayed. This is comma separated list of
2772 flags:
2773 lastline When included, as much as possible of the last line
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02002774 in a window will be displayed. "@@@" is put in the
2775 last columns of the last screen line to indicate the
2776 rest of the line is not displayed.
2777 truncate Like "lastline", but "@@@" is displayed in the first
2778 column of the last screen line. Overrules "lastline".
Bram Moolenaar071d4272004-06-13 20:20:40 +00002779 uhex Show unprintable characters hexadecimal as <xx>
2780 instead of using ^C and ~C.
2781
Bram Moolenaard0796902016-09-16 20:02:31 +02002782 When neither "lastline" nor "truncate" is included, a last line that
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02002783 doesn't fit is replaced with "@" lines.
2784
Bram Moolenaar071d4272004-06-13 20:20:40 +00002785 *'eadirection'* *'ead'*
2786'eadirection' 'ead' string (default "both")
2787 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002788 Tells when the 'equalalways' option applies:
2789 ver vertically, width of windows is not affected
2790 hor horizontally, height of windows is not affected
2791 both width and height of windows is affected
2792
2793 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
2794'edcompatible' 'ed' boolean (default off)
2795 global
2796 Makes the 'g' and 'c' flags of the ":substitute" command to be
2797 toggled each time the flag is given. See |complex-change|. See
2798 also 'gdefault' option.
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +02002799 Switching this option on may break plugins!
Bram Moolenaar071d4272004-06-13 20:20:40 +00002800
Bram Moolenaar03413f42016-04-12 21:07:15 +02002801 *'emoji'* *'emo'* *'noemoji'* *'noemo'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01002802'emoji' 'emo' boolean (default: on)
2803 global
Bram Moolenaar3848e002016-03-19 18:42:29 +01002804 When on all Unicode emoji characters are considered to be full width.
2805
2806
Bram Moolenaar071d4272004-06-13 20:20:40 +00002807 *'encoding'* *'enc'* *E543*
2808'encoding' 'enc' string (default: "latin1" or value from $LANG)
2809 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002810 Sets the character encoding used inside Vim. It applies to text in
2811 the buffers, registers, Strings in expressions, text stored in the
2812 viminfo file, etc. It sets the kind of characters which Vim can work
2813 with. See |encoding-names| for the possible values.
2814
2815 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002816 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002817 It should normally be kept at its default value, or set when Vim
Bram Moolenaar02467872007-05-06 13:22:01 +00002818 starts up. See |multibyte|. To reload the menus see |:menutrans|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002819
Bram Moolenaar865242e2010-07-14 21:12:05 +02002820 This option cannot be set from a |modeline|. It would most likely
2821 corrupt the text.
2822
Bram Moolenaar3df01732017-02-17 22:47:16 +01002823 NOTE: For GTK+ 2 or later, it is highly recommended to set 'encoding'
2824 to "utf-8". Although care has been taken to allow different values of
Bram Moolenaar071d4272004-06-13 20:20:40 +00002825 'encoding', "utf-8" is the natural choice for the environment and
2826 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002827 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00002828 versions, and to avoid changing the encoding of newly created files
2829 without your knowledge (in case 'fileencodings' is empty).
2830
2831 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002832 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00002833 iconv() or as specified with 'charconvert'.
2834
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002835 If you need to know whether 'encoding' is a multi-byte encoding, you
2836 can use: >
2837 if has("multi_byte_encoding")
2838<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002839 Normally 'encoding' will be equal to your current locale. This will
2840 be the default if Vim recognizes your environment settings. If
2841 'encoding' is not set to the current locale, 'termencoding' must be
2842 set to convert typed and displayed text. See |encoding-table|.
2843
2844 When you set this option, it fires the |EncodingChanged| autocommand
2845 event so that you can set up fonts if necessary.
2846
2847 When the option is set, the value is converted to lowercase. Thus
2848 you can set it with uppercase values too. Underscores are translated
2849 to '-' signs.
2850 When the encoding is recognized, it is changed to the standard name.
2851 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
2852 "iso-8859-2" and "utf8" becomes "utf-8".
2853
2854 Note: "latin1" is also used when the encoding could not be detected.
2855 This only works when editing files in the same encoding! When the
2856 actual character set is not latin1, make sure 'fileencoding' and
2857 'fileencodings' are empty. When conversion is needed, switch to using
2858 utf-8.
2859
2860 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
2861 You don't notice this while editing, but it does matter for the
2862 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
2863 setting 'encoding' to one of these values instead of utf-8 only has
2864 effect for encoding used for files when 'fileencoding' is empty.
2865
Bram Moolenaar661b1822005-07-28 22:36:45 +00002866 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
2867 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002868
2869 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
2870'endofline' 'eol' boolean (default on)
2871 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002872 When writing a file and this option is off and the 'binary' option
Bram Moolenaar34d72d42015-07-17 14:18:08 +02002873 is on, or 'fixeol' option is off, no <EOL> will be written for the
2874 last line in the file. This option is automatically set or reset when
2875 starting to edit a new file, depending on whether file has an <EOL>
2876 for the last line in the file. Normally you don't have to set or
2877 reset this option.
2878 When 'binary' is off and 'fixeol' is on the value is not used when
2879 writing the file. When 'binary' is on or 'fixeol' is off it is used
2880 to remember the presence of a <EOL> for the last line in the file, so
2881 that when you write the file the situation from the original file can
2882 be kept. But you can change it if you want to.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002883
2884 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
2885'equalalways' 'ea' boolean (default on)
2886 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002887 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00002888 splitting or closing a window. This also happens the moment the
2889 option is switched on. When off, splitting a window will reduce the
2890 size of the current window and leave the other windows the same. When
2891 closing a window the extra lines are given to the window next to it
2892 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00002893 When mixing vertically and horizontally split windows, a minimal size
2894 is computed and some windows may be larger if there is room. The
2895 'eadirection' option tells in which direction the size is affected.
Bram Moolenaar67f71312007-08-12 14:55:56 +00002896 Changing the height and width of a window can be avoided by setting
2897 'winfixheight' and 'winfixwidth', respectively.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002898 If a window size is specified when creating a new window sizes are
2899 currently not equalized (it's complicated, but may be implemented in
2900 the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002901
2902 *'equalprg'* *'ep'*
2903'equalprg' 'ep' string (default "")
2904 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002905 External program to use for "=" command. When this option is empty
Bram Moolenaar446cb832008-06-24 21:56:24 +00002906 the internal formatting functions are used; either 'lisp', 'cindent'
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002907 or 'indentexpr'. When Vim was compiled without internal formatting,
2908 the "indent" program is used.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002909 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002910 about including spaces and backslashes.
2911 This option cannot be set from a |modeline| or in the |sandbox|, for
2912 security reasons.
2913
2914 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
2915'errorbells' 'eb' boolean (default off)
2916 global
2917 Ring the bell (beep or screen flash) for error messages. This only
2918 makes a difference for error messages, the bell will be used always
2919 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002920 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar165bc692015-07-21 17:53:25 +02002921 screen flash or do nothing. See 'belloff' to finetune when to ring the
2922 bell.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002923
2924 *'errorfile'* *'ef'*
2925'errorfile' 'ef' string (Amiga default: "AztecC.Err",
2926 others: "errors.err")
2927 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002928 {not available when compiled without the |+quickfix|
2929 feature}
2930 Name of the errorfile for the QuickFix mode (see |:cf|).
2931 When the "-q" command-line argument is used, 'errorfile' is set to the
2932 following argument. See |-q|.
2933 NOT used for the ":make" command. See 'makeef' for that.
2934 Environment variables are expanded |:set_env|.
2935 See |option-backslash| about including spaces and backslashes.
2936 This option cannot be set from a |modeline| or in the |sandbox|, for
2937 security reasons.
2938
2939 *'errorformat'* *'efm'*
2940'errorformat' 'efm' string (default is very long)
2941 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002942 {not available when compiled without the |+quickfix|
2943 feature}
2944 Scanf-like description of the format for the lines in the error file
2945 (see |errorformat|).
2946
2947 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
2948'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
2949 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002950 Function keys that start with an <Esc> are recognized in Insert
2951 mode. When this option is off, the cursor and function keys cannot be
2952 used in Insert mode if they start with an <Esc>. The advantage of
2953 this is that the single <Esc> is recognized immediately, instead of
2954 after one second. Instead of resetting this option, you might want to
2955 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
2956 when 'esckeys' is off, you can still map anything, but the cursor keys
2957 won't work by default.
2958 NOTE: This option is set to the Vi default value when 'compatible' is
2959 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaarc8234772019-11-10 21:00:27 +01002960 NOTE: when this option is off then the |modifyOtherKeys| functionality
2961 is disabled while in Insert mode to avoid ending Insert mode with any
2962 key that has a modifier.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002963
2964 *'eventignore'* *'ei'*
2965'eventignore' 'ei' string (default "")
2966 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002967 A list of autocommand event names, which are to be ignored.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00002968 When set to "all" or when "all" is one of the items, all autocommand
2969 events are ignored, autocommands will not be executed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002970 Otherwise this is a comma separated list of event names. Example: >
2971 :set ei=WinEnter,WinLeave
2972<
2973 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
2974'expandtab' 'et' boolean (default off)
2975 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002976 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002977 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002978 when 'autoindent' is on. To insert a real tab when 'expandtab' is
2979 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
Bram Moolenaarca635012015-09-25 20:34:21 +02002980 This option is reset when the 'paste' option is set and restored when
2981 the 'paste' option is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002982 NOTE: This option is reset when 'compatible' is set.
2983
2984 *'exrc'* *'ex'* *'noexrc'* *'noex'*
2985'exrc' 'ex' boolean (default off)
2986 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002987 Enables the reading of .vimrc, .exrc and .gvimrc in the current
Bram Moolenaar36f44c22016-08-28 18:17:20 +02002988 directory.
2989
2990 Setting this option is a potential security leak. E.g., consider
2991 unpacking a package or fetching files from github, a .vimrc in there
2992 might be a trojan horse. BETTER NOT SET THIS OPTION!
2993 Instead, define an autocommand in your .vimrc to set options for a
2994 matching directory.
2995
2996 If you do switch this option on you should also consider setting the
2997 'secure' option (see |initialization|).
2998 Also see |.vimrc| and |gui-init|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002999 This option cannot be set from a |modeline| or in the |sandbox|, for
3000 security reasons.
3001
3002 *'fileencoding'* *'fenc'* *E213*
3003'fileencoding' 'fenc' string (default: "")
3004 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003005 Sets the character encoding for the file of this buffer.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003006
Bram Moolenaar071d4272004-06-13 20:20:40 +00003007 When 'fileencoding' is different from 'encoding', conversion will be
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003008 done when writing the file. For reading see below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003009 When 'fileencoding' is empty, the same value as 'encoding' will be
3010 used (no conversion when reading or writing a file).
Bram Moolenaar214641f2017-03-05 17:04:09 +01003011 No error will be given when the value is set, only when it is used,
3012 only when writing a file.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003013 Conversion will also be done when 'encoding' and 'fileencoding' are
3014 both a Unicode encoding and 'fileencoding' is not utf-8. That's
3015 because internally Unicode is always stored as utf-8.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003016 WARNING: Conversion can cause loss of information! When
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003017 'encoding' is "utf-8" or another Unicode encoding, conversion
3018 is most likely done in a way that the reverse conversion
3019 results in the same text. When 'encoding' is not "utf-8" some
3020 characters may be lost!
Bram Moolenaar865242e2010-07-14 21:12:05 +02003021
Bram Moolenaar071d4272004-06-13 20:20:40 +00003022 See 'encoding' for the possible values. Additionally, values may be
3023 specified that can be handled by the converter, see
3024 |mbyte-conversion|.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003025
Bram Moolenaar071d4272004-06-13 20:20:40 +00003026 When reading a file 'fileencoding' will be set from 'fileencodings'.
3027 To read a file in a certain encoding it won't work by setting
Bram Moolenaar02467872007-05-06 13:22:01 +00003028 'fileencoding', use the |++enc| argument. One exception: when
3029 'fileencodings' is empty the value of 'fileencoding' is used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003030 For a new file the global value of 'fileencoding' is used.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003031
Bram Moolenaar071d4272004-06-13 20:20:40 +00003032 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
3033 When the option is set, the value is converted to lowercase. Thus
3034 you can set it with uppercase values too. '_' characters are
3035 replaced with '-'. If a name is recognized from the list for
3036 'encoding', it is replaced by the standard name. For example
3037 "ISO8859-2" becomes "iso-8859-2".
Bram Moolenaar865242e2010-07-14 21:12:05 +02003038
Bram Moolenaar071d4272004-06-13 20:20:40 +00003039 When this option is set, after starting to edit a file, the 'modified'
3040 option is set, because the file would be different when written.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003041
3042 Keep in mind that changing 'fenc' from a modeline happens
3043 AFTER the text has been read, thus it applies to when the file will be
3044 written. If you do set 'fenc' in a modeline, you might want to set
3045 'nomodified' to avoid not being able to ":q".
3046
Bram Moolenaar071d4272004-06-13 20:20:40 +00003047 This option can not be changed when 'modifiable' is off.
3048
3049 *'fe'*
3050 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003051 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003052 old short name was 'fe', which is no longer used.
3053
3054 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003055'fileencodings' 'fencs' string (default: "ucs-bom",
3056 "ucs-bom,utf-8,default,latin1" when
3057 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003058 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003059 This is a list of character encodings considered when starting to edit
3060 an existing file. When a file is read, Vim tries to use the first
3061 mentioned character encoding. If an error is detected, the next one
3062 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003063 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00003064 an empty string, which means the value of 'encoding' is used.
3065 WARNING: Conversion can cause loss of information! When
3066 'encoding' is "utf-8" (or one of the other Unicode variants)
3067 conversion is most likely done in a way that the reverse
3068 conversion results in the same text. When 'encoding' is not
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003069 "utf-8" some non-ASCII characters may be lost! You can use
3070 the |++bad| argument to specify what is done with characters
3071 that can't be converted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003072 For an empty file or a file with only ASCII characters most encodings
3073 will work and the first entry of 'fileencodings' will be used (except
3074 "ucs-bom", which requires the BOM to be present). If you prefer
3075 another encoding use an BufReadPost autocommand event to test if your
3076 preferred encoding is to be used. Example: >
3077 au BufReadPost * if search('\S', 'w') == 0 |
3078 \ set fenc=iso-2022-jp | endif
3079< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
3080 non-blank characters.
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003081 When the |++enc| argument is used then the value of 'fileencodings' is
3082 not used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003083 Note that 'fileencodings' is not used for a new file, the global value
3084 of 'fileencoding' is used instead. You can set it with: >
3085 :setglobal fenc=iso-8859-2
3086< This means that a non-existing file may get a different encoding than
3087 an empty file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003088 The special value "ucs-bom" can be used to check for a Unicode BOM
3089 (Byte Order Mark) at the start of the file. It must not be preceded
3090 by "utf-8" or another Unicode encoding for this to work properly.
3091 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
3092 because Vim cannot detect an error, thus the encoding is always
3093 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003094 The special value "default" can be used for the encoding from the
3095 environment. This is the default value for 'encoding'. It is useful
3096 when 'encoding' is set to "utf-8" and your environment uses a
3097 non-latin1 encoding, such as Russian.
Bram Moolenaarca003e12006-03-17 23:19:38 +00003098 When 'encoding' is "utf-8" and a file contains an illegal byte
3099 sequence it won't be recognized as UTF-8. You can use the |8g8|
3100 command to find the illegal byte sequence.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003101 WRONG VALUES: WHAT'S WRONG:
3102 latin1,utf-8 "latin1" will always be used
3103 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
3104 file
3105 cp1250,latin1 "cp1250" will always be used
3106 If 'fileencodings' is empty, 'fileencoding' is not modified.
3107 See 'fileencoding' for the possible values.
3108 Setting this option does not have an effect until the next time a file
3109 is read.
3110
3111 *'fileformat'* *'ff'*
Bram Moolenaar00590742019-02-15 21:06:09 +01003112'fileformat' 'ff' string (MS-Windows default: "dos",
3113 Unix, macOS default: "unix")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003114 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003115 This gives the <EOL> of the current buffer, which is used for
3116 reading/writing the buffer from/to a file:
3117 dos <CR> <NL>
3118 unix <NL>
3119 mac <CR>
3120 When "dos" is used, CTRL-Z at the end of a file is ignored.
3121 See |file-formats| and |file-read|.
3122 For the character encoding of the file see 'fileencoding'.
3123 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
Bram Moolenaarbf884932013-04-05 22:26:15 +02003124 works like it was set to "unix".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003125 This option is set automatically when starting to edit a file and
3126 'fileformats' is not empty and 'binary' is off.
3127 When this option is set, after starting to edit a file, the 'modified'
3128 option is set, because the file would be different when written.
3129 This option can not be changed when 'modifiable' is off.
3130 For backwards compatibility: When this option is set to "dos",
3131 'textmode' is set, otherwise 'textmode' is reset.
3132
3133 *'fileformats'* *'ffs'*
3134'fileformats' 'ffs' string (default:
Bram Moolenaar00590742019-02-15 21:06:09 +01003135 Vim+Vi MS-Windows: "dos,unix",
3136 Vim Unix, macOS: "unix,dos",
Bram Moolenaar071d4272004-06-13 20:20:40 +00003137 Vi Cygwin: "unix,dos",
3138 Vi others: "")
3139 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003140 This gives the end-of-line (<EOL>) formats that will be tried when
3141 starting to edit a new buffer and when reading a file into an existing
3142 buffer:
3143 - When empty, the format defined with 'fileformat' will be used
3144 always. It is not set automatically.
3145 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003146 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003147 'fileformats' name will be used when a file is read into an existing
3148 buffer, no matter what 'fileformat' for that buffer is set to.
3149 - When more than one name is present, separated by commas, automatic
3150 <EOL> detection will be done when reading a file. When starting to
3151 edit a file, a check is done for the <EOL>:
3152 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
3153 'fileformat' is set to "dos".
3154 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003155 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003156 preceding <CR>, "unix" is preferred over "dos".
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01003157 3. If 'fileformat' has not yet been set, and if a <CR> is found, and
3158 if 'fileformats' includes "mac", 'fileformat' is set to "mac".
Bram Moolenaar00659062010-09-21 22:34:02 +02003159 This means that "mac" is only chosen when:
3160 "unix" is not present or no <NL> is found in the file, and
3161 "dos" is not present or no <CR><NL> is found in the file.
3162 Except: if "unix" was chosen, but there is a <CR> before
3163 the first <NL>, and there appear to be more <CR>s than <NL>s in
Bram Moolenaar166af9b2010-11-16 20:34:40 +01003164 the first few lines, "mac" is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003165 4. If 'fileformat' is still not set, the first name from
3166 'fileformats' is used.
3167 When reading a file into an existing buffer, the same is done, but
3168 this happens like 'fileformat' has been set appropriately for that
3169 file only, the option is not changed.
3170 When 'binary' is set, the value of 'fileformats' is not used.
3171
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01003172 When Vim starts up with an empty buffer the first item is used. You
3173 can overrule this by setting 'fileformat' in your .vimrc.
Bram Moolenaar81af9252010-12-10 20:35:50 +01003174
Bram Moolenaar071d4272004-06-13 20:20:40 +00003175 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
3176 are ":source"ed and for vimrc files, automatic <EOL> detection may be
3177 done:
3178 - When 'fileformats' is empty, there is no automatic detection. Dos
3179 format will be used.
3180 - When 'fileformats' is set to one or more names, automatic detection
3181 is done. This is based on the first <NL> in the file: If there is a
3182 <CR> in front of it, Dos format is used, otherwise Unix format is
3183 used.
3184 Also see |file-formats|.
3185 For backwards compatibility: When this option is set to an empty
3186 string or one format (no comma is included), 'textauto' is reset,
3187 otherwise 'textauto' is set.
3188 NOTE: This option is set to the Vi default value when 'compatible' is
3189 set and to the Vim default value when 'compatible' is reset.
3190
Bram Moolenaarbf884932013-04-05 22:26:15 +02003191 *'fileignorecase'* *'fic'* *'nofileignorecase'* *'nofic'*
3192'fileignorecase' 'fic' boolean (default on for systems where case in file
3193 names is normally ignored)
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003194 global
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003195 When set case is ignored when using file names and directories.
3196 See 'wildignorecase' for only ignoring case when doing completion.
3197
Bram Moolenaar071d4272004-06-13 20:20:40 +00003198 *'filetype'* *'ft'*
3199'filetype' 'ft' string (default: "")
3200 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003201 When this option is set, the FileType autocommand event is triggered.
3202 All autocommands that match with the value of this option will be
3203 executed. Thus the value of 'filetype' is used in place of the file
3204 name.
3205 Otherwise this option does not always reflect the current file type.
3206 This option is normally set when the file type is detected. To enable
3207 this use the ":filetype on" command. |:filetype|
3208 Setting this option to a different value is most useful in a modeline,
3209 for a file for which the file type is not automatically recognized.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003210 Example, for in an IDL file:
3211 /* vim: set filetype=idl : */ ~
3212 |FileType| |filetypes|
3213 When a dot appears in the value then this separates two filetype
3214 names. Example:
3215 /* vim: set filetype=c.doxygen : */ ~
3216 This will use the "c" filetype first, then the "doxygen" filetype.
3217 This works both for filetype plugins and for syntax files. More than
3218 one dot may appear.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003219 This option is not copied to another buffer, independent of the 's' or
3220 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003221 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003222
3223 *'fillchars'* *'fcs'*
3224'fillchars' 'fcs' string (default "vert:|,fold:-")
3225 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02003226 {not available when compiled without the |+folding|
3227 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003228 Characters to fill the statuslines and vertical separators.
3229 It is a comma separated list of items:
3230
3231 item default Used for ~
3232 stl:c ' ' or '^' statusline of the current window
Bram Moolenaar38a55632016-02-15 22:07:32 +01003233 stlnc:c ' ' or '=' statusline of the non-current windows
Bram Moolenaar071d4272004-06-13 20:20:40 +00003234 vert:c '|' vertical separators |:vsplit|
3235 fold:c '-' filling 'foldtext'
3236 diff:c '-' deleted lines of the 'diff' option
3237
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003238 Any one that is omitted will fall back to the default. For "stl" and
Bram Moolenaar38a55632016-02-15 22:07:32 +01003239 "stlnc" the space will be used when there is highlighting, '^' or '='
Bram Moolenaar071d4272004-06-13 20:20:40 +00003240 otherwise.
3241
3242 Example: >
Bram Moolenaar38a55632016-02-15 22:07:32 +01003243 :set fillchars=stl:^,stlnc:=,vert:\|,fold:-,diff:-
Bram Moolenaar071d4272004-06-13 20:20:40 +00003244< This is similar to the default, except that these characters will also
3245 be used when there is highlighting.
3246
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003247 for "stl" and "stlnc" only single-byte values are supported.
3248
Bram Moolenaar071d4272004-06-13 20:20:40 +00003249 The highlighting used for these items:
3250 item highlight group ~
3251 stl:c StatusLine |hl-StatusLine|
3252 stlnc:c StatusLineNC |hl-StatusLineNC|
3253 vert:c VertSplit |hl-VertSplit|
3254 fold:c Folded |hl-Folded|
3255 diff:c DiffDelete |hl-DiffDelete|
3256
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003257 *'fixendofline'* *'fixeol'* *'nofixendofline'* *'nofixeol'*
3258'fixendofline' 'fixeol' boolean (default on)
3259 local to buffer
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003260 When writing a file and this option is on, <EOL> at the end of file
3261 will be restored if missing. Turn this option off if you want to
3262 preserve the situation from the original file.
3263 When the 'binary' option is set the value of this option doesn't
3264 matter.
3265 See the 'endofline' option.
3266
Bram Moolenaar071d4272004-06-13 20:20:40 +00003267 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
3268'fkmap' 'fk' boolean (default off) *E198*
3269 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003270 {only available when compiled with the |+rightleft|
3271 feature}
Bram Moolenaar14184a32019-02-16 15:10:30 +01003272 This option was for using Farsi, which has been removed. See
3273 |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003274
3275 *'foldclose'* *'fcl'*
3276'foldclose' 'fcl' string (default "")
3277 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003278 {not available when compiled without the |+folding|
3279 feature}
3280 When set to "all", a fold is closed when the cursor isn't in it and
3281 its level is higher than 'foldlevel'. Useful if you want folds to
3282 automatically close when moving out of them.
3283
3284 *'foldcolumn'* *'fdc'*
3285'foldcolumn' 'fdc' number (default 0)
3286 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003287 {not available when compiled without the |+folding|
3288 feature}
3289 When non-zero, a column with the specified width is shown at the side
3290 of the window which indicates open and closed folds. The maximum
3291 value is 12.
3292 See |folding|.
3293
3294 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
3295'foldenable' 'fen' boolean (default on)
3296 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003297 {not available when compiled without the |+folding|
3298 feature}
3299 When off, all folds are open. This option can be used to quickly
3300 switch between showing all text unfolded and viewing the text with
3301 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003302 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00003303 'foldenable' is off.
3304 This option is set by commands that create a new fold or close a fold.
3305 See |folding|.
3306
3307 *'foldexpr'* *'fde'*
3308'foldexpr' 'fde' string (default: "0")
3309 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003310 {not available when compiled without the |+folding|
Bram Moolenaardb84e452010-08-15 13:50:43 +02003311 or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003312 The expression used for when 'foldmethod' is "expr". It is evaluated
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003313 for each line to obtain its fold level. See |fold-expr|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003314
Bram Moolenaar30b65812012-07-12 22:01:11 +02003315 The expression will be evaluated in the |sandbox| if set from a
3316 modeline, see |sandbox-option|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003317 This option can't be set from a |modeline| when the 'diff' option is
Bram Moolenaar110289e2019-05-23 15:38:06 +02003318 on or the 'modelineexpr' option is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003319
3320 It is not allowed to change text or jump to another window while
3321 evaluating 'foldexpr' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003322
3323 *'foldignore'* *'fdi'*
3324'foldignore' 'fdi' string (default: "#")
3325 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003326 {not available when compiled without the |+folding|
3327 feature}
3328 Used only when 'foldmethod' is "indent". Lines starting with
3329 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003330 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003331 The default "#" works well for C programs. See |fold-indent|.
3332
3333 *'foldlevel'* *'fdl'*
3334'foldlevel' 'fdl' number (default: 0)
3335 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003336 {not available when compiled without the |+folding|
3337 feature}
3338 Sets the fold level: Folds with a higher level will be closed.
3339 Setting this option to zero will close all folds. Higher numbers will
3340 close fewer folds.
3341 This option is set by commands like |zm|, |zM| and |zR|.
3342 See |fold-foldlevel|.
3343
3344 *'foldlevelstart'* *'fdls'*
3345'foldlevelstart' 'fdls' number (default: -1)
3346 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003347 {not available when compiled without the |+folding|
3348 feature}
3349 Sets 'foldlevel' when starting to edit another buffer in a window.
3350 Useful to always start editing with all folds closed (value zero),
3351 some folds closed (one) or no folds closed (99).
3352 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003353 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00003354 ignores this option and closes all folds.
3355 It is also done before BufReadPre autocommands, to allow an autocmd to
3356 overrule the 'foldlevel' value for specific files.
3357 When the value is negative, it is not used.
3358
3359 *'foldmarker'* *'fmr'* *E536*
3360'foldmarker' 'fmr' string (default: "{{{,}}}")
3361 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003362 {not available when compiled without the |+folding|
3363 feature}
3364 The start and end marker used when 'foldmethod' is "marker". There
3365 must be one comma, which separates the start and end marker. The
3366 marker is a literal string (a regular expression would be too slow).
3367 See |fold-marker|.
3368
3369 *'foldmethod'* *'fdm'*
3370'foldmethod' 'fdm' string (default: "manual")
3371 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003372 {not available when compiled without the |+folding|
3373 feature}
3374 The kind of folding used for the current window. Possible values:
3375 |fold-manual| manual Folds are created manually.
3376 |fold-indent| indent Lines with equal indent form a fold.
3377 |fold-expr| expr 'foldexpr' gives the fold level of a line.
3378 |fold-marker| marker Markers are used to specify folds.
3379 |fold-syntax| syntax Syntax highlighting items specify folds.
3380 |fold-diff| diff Fold text that is not changed.
3381
3382 *'foldminlines'* *'fml'*
3383'foldminlines' 'fml' number (default: 1)
3384 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003385 {not available when compiled without the |+folding|
3386 feature}
Bram Moolenaar00654022011-02-25 14:42:19 +01003387 Sets the number of screen lines above which a fold can be displayed
3388 closed. Also for manually closed folds. With the default value of
3389 one a fold can only be closed if it takes up two or more screen lines.
3390 Set to zero to be able to close folds of just one screen line.
Bram Moolenaar446beb42011-05-10 17:18:44 +02003391 Note that this only has an effect on what is displayed. After using
Bram Moolenaar071d4272004-06-13 20:20:40 +00003392 "zc" to close a fold, which is displayed open because it's smaller
3393 than 'foldminlines', a following "zc" may close a containing fold.
3394
3395 *'foldnestmax'* *'fdn'*
3396'foldnestmax' 'fdn' number (default: 20)
3397 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003398 {not available when compiled without the |+folding|
3399 feature}
3400 Sets the maximum nesting of folds for the "indent" and "syntax"
3401 methods. This avoids that too many folds will be created. Using more
3402 than 20 doesn't work, because the internal limit is 20.
3403
3404 *'foldopen'* *'fdo'*
3405'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
3406 search,tag,undo")
3407 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003408 {not available when compiled without the |+folding|
3409 feature}
3410 Specifies for which type of commands folds will be opened, if the
3411 command moves the cursor into a closed fold. It is a comma separated
3412 list of items.
Bram Moolenaar05365702010-10-27 18:34:44 +02003413 NOTE: When the command is part of a mapping this option is not used.
3414 Add the |zv| command to the mapping to get the same effect.
3415 (rationale: the mapping may want to control opening folds itself)
3416
Bram Moolenaar071d4272004-06-13 20:20:40 +00003417 item commands ~
3418 all any
3419 block "(", "{", "[[", "[{", etc.
3420 hor horizontal movements: "l", "w", "fx", etc.
3421 insert any command in Insert mode
3422 jump far jumps: "G", "gg", etc.
3423 mark jumping to a mark: "'m", CTRL-O, etc.
3424 percent "%"
3425 quickfix ":cn", ":crew", ":make", etc.
3426 search search for a pattern: "/", "n", "*", "gd", etc.
3427 (not for a search pattern in a ":" command)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003428 Also for |[s| and |]s|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003429 tag jumping to a tag: ":ta", CTRL-T, etc.
3430 undo undo or redo: "u" and CTRL-R
Bram Moolenaar071d4272004-06-13 20:20:40 +00003431 When a movement command is used for an operator (e.g., "dl" or "y%")
3432 this option is not used. This means the operator will include the
3433 whole closed fold.
3434 Note that vertical movements are not here, because it would make it
3435 very difficult to move onto a closed fold.
3436 In insert mode the folds containing the cursor will always be open
3437 when text is inserted.
3438 To close folds you can re-apply 'foldlevel' with the |zx| command or
3439 set the 'foldclose' option to "all".
3440
3441 *'foldtext'* *'fdt'*
3442'foldtext' 'fdt' string (default: "foldtext()")
3443 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003444 {not available when compiled without the |+folding|
3445 feature}
3446 An expression which is used to specify the text displayed for a closed
3447 fold. See |fold-foldtext|.
3448
Bram Moolenaar30b65812012-07-12 22:01:11 +02003449 The expression will be evaluated in the |sandbox| if set from a
3450 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003451 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003452
3453 It is not allowed to change text or jump to another window while
3454 evaluating 'foldtext' |textlock|.
3455
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003456 *'formatexpr'* *'fex'*
3457'formatexpr' 'fex' string (default "")
3458 local to buffer
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003459 {not available when compiled without the |+eval|
3460 feature}
3461 Expression which is evaluated to format a range of lines for the |gq|
3462 operator or automatic formatting (see 'formatoptions'). When this
3463 option is empty 'formatprg' is used.
3464
3465 The |v:lnum| variable holds the first line to be formatted.
3466 The |v:count| variable holds the number of lines to be formatted.
3467 The |v:char| variable holds the character that is going to be
3468 inserted if the expression is being evaluated due to
3469 automatic formatting. This can be empty. Don't insert
3470 it yet!
3471
3472 Example: >
3473 :set formatexpr=mylang#Format()
3474< This will invoke the mylang#Format() function in the
3475 autoload/mylang.vim file in 'runtimepath'. |autoload|
3476
3477 The expression is also evaluated when 'textwidth' is set and adding
3478 text beyond that limit. This happens under the same conditions as
3479 when internal formatting is used. Make sure the cursor is kept in the
3480 same spot relative to the text then! The |mode()| function will
3481 return "i" or "R" in this situation.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01003482
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003483 When the expression evaluates to non-zero Vim will fall back to using
3484 the internal format mechanism.
3485
3486 The expression will be evaluated in the |sandbox| when set from a
3487 modeline, see |sandbox-option|. That stops the option from working,
3488 since changing the buffer text is not allowed.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003489 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaar036986f2017-03-16 17:41:02 +01003490 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003491
Bram Moolenaar86b68352004-12-27 21:59:20 +00003492 *'formatlistpat'* *'flp'*
3493'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
3494 local to buffer
Bram Moolenaar86b68352004-12-27 21:59:20 +00003495 A pattern that is used to recognize a list header. This is used for
3496 the "n" flag in 'formatoptions'.
3497 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00003498 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00003499 while still checking more characters. There must be a character
3500 following the pattern, when it matches the whole line it is handled
3501 like there is no match.
3502 The default recognizes a number, followed by an optional punctuation
3503 character and white space.
3504
Bram Moolenaar6c60f472019-04-28 16:00:35 +02003505 *'formatoptions'* *'fo'*
3506'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
3507 local to buffer
3508 This is a sequence of letters which describes how automatic
3509 formatting is to be done. See |fo-table|. When the 'paste' option is
3510 on, no formatting is done (like 'formatoptions' is empty). Commas can
3511 be inserted for readability.
3512 To avoid problems with flags that are added in the future, use the
3513 "+=" and "-=" feature of ":set" |add-option-flags|.
3514 NOTE: This option is set to the Vi default value when 'compatible' is
3515 set and to the Vim default value when 'compatible' is reset.
3516
Bram Moolenaar071d4272004-06-13 20:20:40 +00003517 *'formatprg'* *'fp'*
3518'formatprg' 'fp' string (default "")
Bram Moolenaar9be7c042017-01-14 14:28:30 +01003519 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003520 The name of an external program that will be used to format the lines
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003521 selected with the |gq| operator. The program must take the input on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003522 stdin and produce the output on stdout. The Unix program "fmt" is
Bram Moolenaara5792f52005-11-23 21:25:05 +00003523 such a program.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003524 If the 'formatexpr' option is not empty it will be used instead.
3525 Otherwise, if 'formatprg' option is an empty string, the internal
3526 format function will be used |C-indenting|.
Bram Moolenaara5792f52005-11-23 21:25:05 +00003527 Environment variables are expanded |:set_env|. See |option-backslash|
3528 about including spaces and backslashes.
Bram Moolenaar30b65812012-07-12 22:01:11 +02003529 This option cannot be set from a |modeline| or in the |sandbox|, for
3530 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003531
Bram Moolenaard94464e2015-11-02 15:28:18 +01003532 *'fsync'* *'fs'* *'nofsync'* *'nofs'*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003533'fsync' 'fs' boolean (default on)
3534 global
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003535 When on, the library function fsync() will be called after writing a
3536 file. This will flush a file to disk, ensuring that it is safely
3537 written even on filesystems which do metadata-only journaling. This
3538 will force the harddrive to spin up on Linux systems running in laptop
3539 mode, so it may be undesirable in some situations. Be warned that
3540 turning this off increases the chances of data loss after a crash. On
3541 systems without an fsync() implementation, this variable is always
3542 off.
3543 Also see 'swapsync' for controlling fsync() on swap files.
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003544 'fsync' also applies to |writefile()|, unless a flag is used to
3545 overrule it.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003546 This option cannot be set from a |modeline| or in the |sandbox|, for
3547 security reasons.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003548
Bram Moolenaar071d4272004-06-13 20:20:40 +00003549 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
3550'gdefault' 'gd' boolean (default off)
3551 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003552 When on, the ":substitute" flag 'g' is default on. This means that
3553 all matches in a line are substituted instead of one. When a 'g' flag
3554 is given to a ":substitute" command, this will toggle the substitution
3555 of all or one match. See |complex-change|.
3556
3557 command 'gdefault' on 'gdefault' off ~
3558 :s/// subst. all subst. one
3559 :s///g subst. one subst. all
3560 :s///gg subst. all subst. one
3561
3562 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar21020352017-06-13 17:21:04 +02003563 DEPRECATED: Setting this option may break plugins that are not aware
3564 of this option. Also, many users get confused that adding the /g flag
3565 has the opposite effect of that it normally does.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003566
3567 *'grepformat'* *'gfm'*
Bram Moolenaar6e932462014-09-09 18:48:09 +02003568'grepformat' 'gfm' string (default "%f:%l:%m,%f:%l%m,%f %l%m")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003569 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003570 Format to recognize for the ":grep" command output.
3571 This is a scanf-like string that uses the same format as the
3572 'errorformat' option: see |errorformat|.
3573
3574 *'grepprg'* *'gp'*
3575'grepprg' 'gp' string (default "grep -n ",
3576 Unix: "grep -n $* /dev/null",
3577 Win32: "findstr /n" or "grep -n",
3578 VMS: "SEARCH/NUMBERS ")
3579 global or local to buffer |global-local|
Bram Moolenaar582fd852005-03-28 20:58:01 +00003580 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003581 and '#' characters, which are expanded like when used in a command-
3582 line. The placeholder "$*" is allowed to specify where the arguments
3583 will be included. Environment variables are expanded |:set_env|. See
3584 |option-backslash| about including spaces and backslashes.
3585 When your "grep" accepts the "-H" argument, use this to make ":grep"
3586 also work well with a single file: >
3587 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00003588< Special value: When 'grepprg' is set to "internal" the |:grep| command
Bram Moolenaara6557602006-02-04 22:43:20 +00003589 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like
3590 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00003591 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00003592 apply equally to 'grepprg'.
3593 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
3594 otherwise it's "grep -n".
3595 This option cannot be set from a |modeline| or in the |sandbox|, for
3596 security reasons.
3597
3598 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
3599'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
3600 ve:ver35-Cursor,
3601 o:hor50-Cursor,
3602 i-ci:ver25-Cursor/lCursor,
3603 r-cr:hor20-Cursor/lCursor,
3604 sm:block-Cursor
3605 -blinkwait175-blinkoff150-blinkon175",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003606 for Win32 console:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003607 "n-v-c:block,o:hor50,i-ci:hor15,
3608 r-cr:hor30,sm:block")
3609 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003610 {only available when compiled with GUI enabled, and
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003611 for Win32 console}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003612 This option tells Vim what the cursor should look like in different
Bram Moolenaar8024f932020-01-14 19:29:13 +01003613 modes. It fully works in the GUI. In a Win32 console, only the
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003614 height of the cursor can be changed. This can be done by specifying a
3615 block cursor, or a percentage for a vertical or horizontal cursor.
Bram Moolenaar1e7813a2015-03-31 18:31:03 +02003616 For a console the 't_SI', 't_SR', and 't_EI' escape sequences are
3617 used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003618
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003619 The option is a comma separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003620 mode-list and an argument-list:
3621 mode-list:argument-list,mode-list:argument-list,..
3622 The mode-list is a dash separated list of these modes:
3623 n Normal mode
3624 v Visual mode
3625 ve Visual mode with 'selection' "exclusive" (same as 'v',
3626 if not specified)
3627 o Operator-pending mode
3628 i Insert mode
3629 r Replace mode
3630 c Command-line Normal (append) mode
3631 ci Command-line Insert mode
3632 cr Command-line Replace mode
3633 sm showmatch in Insert mode
3634 a all modes
3635 The argument-list is a dash separated list of these arguments:
3636 hor{N} horizontal bar, {N} percent of the character height
3637 ver{N} vertical bar, {N} percent of the character width
3638 block block cursor, fills the whole character
3639 [only one of the above three should be present]
3640 blinkwait{N} *cursor-blinking*
3641 blinkon{N}
3642 blinkoff{N}
3643 blink times for cursor: blinkwait is the delay before
3644 the cursor starts blinking, blinkon is the time that
3645 the cursor is shown and blinkoff is the time that the
3646 cursor is not shown. The times are in msec. When one
3647 of the numbers is zero, there is no blinking. The
3648 default is: "blinkwait700-blinkon400-blinkoff250".
3649 These numbers are used for a missing entry. This
3650 means that blinking is enabled by default. To switch
3651 blinking off you can use "blinkon0". The cursor only
3652 blinks when Vim is waiting for input, not while
3653 executing a command.
3654 To make the cursor blink in an xterm, see
3655 |xterm-blink|.
3656 {group-name}
3657 a highlight group name, that sets the color and font
3658 for the cursor
3659 {group-name}/{group-name}
3660 Two highlight group names, the first is used when
3661 no language mappings are used, the other when they
3662 are. |language-mapping|
3663
3664 Examples of parts:
3665 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
3666 block cursor with colors from the "nCursor"
3667 highlight group
3668 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
3669 In Insert and Command-line Insert mode, use a
3670 30% vertical bar cursor with colors from the
3671 "iCursor" highlight group. Blink a bit
3672 faster.
3673
3674 The 'a' mode is different. It will set the given argument-list for
3675 all modes. It does not reset anything to defaults. This can be used
3676 to do a common setting for all modes. For example, to switch off
3677 blinking: "a:blinkon0"
3678
3679 Examples of cursor highlighting: >
3680 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
3681 :highlight Cursor gui=NONE guifg=bg guibg=fg
3682<
3683 *'guifont'* *'gfn'*
Bram Moolenaar251e1912011-06-19 05:09:16 +02003684 *E235* *E596*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003685'guifont' 'gfn' string (default "")
3686 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003687 {only available when compiled with GUI enabled}
3688 This is a list of fonts which will be used for the GUI version of Vim.
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003689 In its simplest form the value is just one font name.
3690 See |gui-font| for the details.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003691
3692 *'guifontset'* *'gfs'*
3693 *E250* *E252* *E234* *E597* *E598*
3694'guifontset' 'gfs' string (default "")
3695 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003696 {only available when compiled with GUI enabled and
3697 with the |+xfontset| feature}
Bram Moolenaar3df01732017-02-17 22:47:16 +01003698 {not available in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003699 When not empty, specifies two (or more) fonts to be used. The first
3700 one for normal English, the second one for your special language. See
3701 |xfontset|.
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003702
Bram Moolenaar071d4272004-06-13 20:20:40 +00003703 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
3704'guifontwide' 'gfw' string (default "")
3705 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003706 {only available when compiled with GUI enabled}
3707 When not empty, specifies a comma-separated list of fonts to be used
3708 for double-width characters. The first font that can be loaded is
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003709 used. See |gui-fontwide|.
Bram Moolenaar0f272122013-01-23 18:37:40 +01003710
Bram Moolenaar071d4272004-06-13 20:20:40 +00003711 *'guiheadroom'* *'ghr'*
3712'guiheadroom' 'ghr' number (default 50)
3713 global
Bram Moolenaar110289e2019-05-23 15:38:06 +02003714 {only for GTK and X11 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003715 The number of pixels subtracted from the screen height when fitting
3716 the GUI window on the screen. Set this before the GUI is started,
3717 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003718 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00003719 lines will be left for window decorations and other items on the
3720 screen. Set it to a negative value to allow windows taller than the
3721 screen.
3722
3723 *'guioptions'* *'go'*
Bram Moolenaar2c64ca12018-10-19 16:22:31 +02003724'guioptions' 'go' string (default "egmrLtT" (MS-Windows,
3725 "t" is removed in |defaults.vim|),
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02003726 "aegimrLtT" (GTK, Motif and Athena),
3727 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00003728 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003729 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00003730 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003731 sequence of letters which describes what components and options of the
3732 GUI should be used.
3733 To avoid problems with flags that are added in the future, use the
3734 "+=" and "-=" feature of ":set" |add-option-flags|.
3735
Bram Moolenaar13568252018-03-16 20:46:58 +01003736 Valid characters are as follows:
3737 *'go-!'*
3738 '!' External commands are executed in a terminal window. Without
3739 this flag the MS-Windows GUI will open a console window to
3740 execute the command. The Unix GUI will simulate a dumb
3741 terminal to list the command output.
3742 The terminal window will be positioned at the bottom, and grow
3743 upwards as needed.
Bram Moolenaarba3ff532018-11-04 14:45:49 +01003744 *'go-a'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003745 'a' Autoselect: If present, then whenever VISUAL mode is started,
3746 or the Visual area extended, Vim tries to become the owner of
3747 the windowing system's global selection. This means that the
3748 Visually highlighted text is available for pasting into other
3749 applications as well as into Vim itself. When the Visual mode
3750 ends, possibly due to an operation on the text, or when an
3751 application wants to paste the selection, the highlighted text
3752 is automatically yanked into the "* selection register.
3753 Thus the selection is still available for pasting into other
3754 applications after the VISUAL mode has ended.
3755 If not present, then Vim won't become the owner of the
3756 windowing system's global selection unless explicitly told to
3757 by a yank or delete operation for the "* register.
3758 The same applies to the modeless selection.
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02003759 *'go-P'*
3760 'P' Like autoselect but using the "+ register instead of the "*
Bram Moolenaar3848e002016-03-19 18:42:29 +01003761 register.
Bram Moolenaar02467872007-05-06 13:22:01 +00003762 *'go-A'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003763 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003764 applies to the modeless selection.
3765
3766 'guioptions' autoselect Visual autoselect modeless ~
3767 "" - -
3768 "a" yes yes
3769 "A" - yes
3770 "aA" yes yes
3771
Bram Moolenaar02467872007-05-06 13:22:01 +00003772 *'go-c'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003773 'c' Use console dialogs instead of popup dialogs for simple
3774 choices.
Bram Moolenaar50bf7ce2019-09-15 13:17:00 +02003775 *'go-d'*
3776 'd' Use dark theme variant if available. Currently only works for
3777 GTK+ GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00003778 *'go-e'*
Bram Moolenaare224ffa2006-03-01 00:01:28 +00003779 'e' Add tab pages when indicated with 'showtabline'.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003780 'guitablabel' can be used to change the text in the labels.
3781 When 'e' is missing a non-GUI tab pages line may be used.
Bram Moolenaard68071d2006-05-02 22:08:30 +00003782 The GUI tabs are only supported on some systems, currently
Bram Moolenaarb3f74062020-02-26 16:16:53 +01003783 GTK, Motif, Mac OS/X, Haiku, and MS-Windows.
Bram Moolenaar02467872007-05-06 13:22:01 +00003784 *'go-f'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003785 'f' Foreground: Don't use fork() to detach the GUI from the shell
3786 where it was started. Use this for programs that wait for the
3787 editor to finish (e.g., an e-mail program). Alternatively you
3788 can use "gvim -f" or ":gui -f" to start the GUI in the
3789 foreground. |gui-fork|
3790 Note: Set this option in the vimrc file. The forking may have
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003791 happened already when the |gvimrc| file is read.
Bram Moolenaar02467872007-05-06 13:22:01 +00003792 *'go-i'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003793 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
3794 corner of the window. It's black&white on non-GTK, because of
3795 limitations of X11. For a color icon, see |X11-icon|.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003796 *'go-m'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003797 'm' Menu bar is present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003798 *'go-M'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003799 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00003800 that this flag must be added in the .vimrc file, before
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003801 switching on syntax or filetype recognition (when the |gvimrc|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003802 file is sourced the system menu has already been loaded; the
Bram Moolenaar01164a62017-11-02 22:58:42 +01003803 `:syntax on` and `:filetype on` commands load the menu too).
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003804 *'go-g'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003805 'g' Grey menu items: Make menu items that are not active grey. If
3806 'g' is not included inactive menu items are not shown at all.
3807 Exception: Athena will always use grey menu items.
Bram Moolenaar02467872007-05-06 13:22:01 +00003808 *'go-t'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003809 't' Include tearoff menu items. Currently only works for Win32,
3810 GTK+, and Motif 1.2 GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00003811 *'go-T'*
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00003812 'T' Include Toolbar. Currently only in Win32, GTK+, Motif, Photon
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00003813 and Athena GUIs.
Bram Moolenaar02467872007-05-06 13:22:01 +00003814 *'go-r'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003815 'r' Right-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003816 *'go-R'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003817 'R' Right-hand scrollbar is present when there is a vertically
3818 split window.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003819 *'go-l'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003820 'l' Left-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003821 *'go-L'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003822 'L' Left-hand scrollbar is present when there is a vertically
3823 split window.
Bram Moolenaar02467872007-05-06 13:22:01 +00003824 *'go-b'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003825 'b' Bottom (horizontal) scrollbar is present. Its size depends on
3826 the longest visible line, or on the cursor line if the 'h'
3827 flag is included. |gui-horiz-scroll|
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003828 *'go-h'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003829 'h' Limit horizontal scrollbar size to the length of the cursor
3830 line. Reduces computations. |gui-horiz-scroll|
3831
3832 And yes, you may even have scrollbars on the left AND the right if
3833 you really want to :-). See |gui-scrollbars| for more information.
3834
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003835 *'go-v'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003836 'v' Use a vertical button layout for dialogs. When not included,
3837 a horizontal layout is preferred, but when it doesn't fit a
3838 vertical layout is used anyway.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003839 *'go-p'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003840 'p' Use Pointer callbacks for X11 GUI. This is required for some
3841 window managers. If the cursor is not blinking or hollow at
3842 the right moment, try adding this flag. This must be done
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003843 before starting the GUI. Set it in your |gvimrc|. Adding or
Bram Moolenaar071d4272004-06-13 20:20:40 +00003844 removing it after the GUI has started has no effect.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003845 *'go-F'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003846 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar8ac44152017-11-09 18:33:29 +01003847 *'go-k'*
3848 'k' Keep the GUI window size when adding/removing a scrollbar, or
3849 toolbar, tabline, etc. Instead, the behavior is similar to
3850 when the window is maximized and will adjust 'lines' and
3851 'columns' to fit to the window. Without the 'k' flag Vim will
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003852 try to keep 'lines' and 'columns' the same when adding and
Bram Moolenaar8ac44152017-11-09 18:33:29 +01003853 removing GUI components.
Bram Moolenaar02467872007-05-06 13:22:01 +00003854
Bram Moolenaar071d4272004-06-13 20:20:40 +00003855 *'guipty'* *'noguipty'*
3856'guipty' boolean (default on)
3857 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003858 {only available when compiled with GUI enabled}
3859 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
3860 I/O to/from shell commands. See |gui-pty|.
3861
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003862 *'guitablabel'* *'gtl'*
3863'guitablabel' 'gtl' string (default empty)
3864 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02003865 {only available when compiled with GUI enabled}
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003866 When nonempty describes the text to use in a label of the GUI tab
Bram Moolenaard68071d2006-05-02 22:08:30 +00003867 pages line. When empty and when the result is empty Vim will use a
3868 default label. See |setting-guitablabel| for more info.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003869
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003870 The format of this option is like that of 'statusline'.
Bram Moolenaar57657d82006-04-21 22:12:41 +00003871 'guitabtooltip' is used for the tooltip, see below.
Bram Moolenaar51628222016-12-01 23:03:28 +01003872 The expression will be evaluated in the |sandbox| when set from a
3873 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003874 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003875
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003876 Only used when the GUI tab pages line is displayed. 'e' must be
3877 present in 'guioptions'. For the non-GUI tab pages line 'tabline' is
3878 used.
3879
Bram Moolenaar57657d82006-04-21 22:12:41 +00003880 *'guitabtooltip'* *'gtt'*
3881'guitabtooltip' 'gtt' string (default empty)
3882 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02003883 {only available when compiled with GUI enabled}
Bram Moolenaar57657d82006-04-21 22:12:41 +00003884 When nonempty describes the text to use in a tooltip for the GUI tab
3885 pages line. When empty Vim will use a default tooltip.
3886 This option is otherwise just like 'guitablabel' above.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003887 You can include a line break. Simplest method is to use |:let|: >
3888 :let &guitabtooltip = "line one\nline two"
3889<
Bram Moolenaar57657d82006-04-21 22:12:41 +00003890
Bram Moolenaar071d4272004-06-13 20:20:40 +00003891 *'helpfile'* *'hf'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003892'helpfile' 'hf' string (default (MS-Windows) "$VIMRUNTIME\doc\help.txt"
Bram Moolenaar071d4272004-06-13 20:20:40 +00003893 (others) "$VIMRUNTIME/doc/help.txt")
3894 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003895 Name of the main help file. All distributed help files should be
3896 placed together in one directory. Additionally, all "doc" directories
3897 in 'runtimepath' will be used.
3898 Environment variables are expanded |:set_env|. For example:
3899 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003900 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00003901 spaces and backslashes.
3902 This option cannot be set from a |modeline| or in the |sandbox|, for
3903 security reasons.
3904
3905 *'helpheight'* *'hh'*
3906'helpheight' 'hh' number (default 20)
3907 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003908 Minimal initial height of the help window when it is opened with the
3909 ":help" command. The initial height of the help window is half of the
3910 current window, or (when the 'ea' option is on) the same as other
3911 windows. When the height is less than 'helpheight', the height is
3912 set to 'helpheight'. Set to zero to disable.
3913
3914 *'helplang'* *'hlg'*
3915'helplang' 'hlg' string (default: messages language or empty)
3916 global
3917 {only available when compiled with the |+multi_lang|
3918 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003919 Comma separated list of languages. Vim will use the first language
3920 for which the desired help can be found. The English help will always
3921 be used as a last resort. You can add "en" to prefer English over
3922 another language, but that will only find tags that exist in that
3923 language and not in the English help.
3924 Example: >
3925 :set helplang=de,it
3926< This will first search German, then Italian and finally English help
3927 files.
3928 When using |CTRL-]| and ":help!" in a non-English help file Vim will
3929 try to find the tag in the current language before using this option.
3930 See |help-translated|.
3931
3932 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
3933'hidden' 'hid' boolean (default off)
3934 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003935 When off a buffer is unloaded when it is |abandon|ed. When on a
3936 buffer becomes hidden when it is |abandon|ed. If the buffer is still
3937 displayed in another window, it does not become hidden, of course.
3938 The commands that move through the buffer list sometimes make a buffer
3939 hidden although the 'hidden' option is off: When the buffer is
3940 modified, 'autowrite' is off or writing is not possible, and the '!'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003941 flag was used. See also |windows.txt|.
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00003942 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003943 This option is set for one command with ":hide {command}" |:hide|.
3944 WARNING: It's easy to forget that you have changes in hidden buffers.
3945 Think twice when using ":q!" or ":qa!".
3946
3947 *'highlight'* *'hl'*
3948'highlight' 'hl' string (default (as a single string):
Bram Moolenaar58b85342016-08-14 19:54:54 +02003949 "8:SpecialKey,~:EndOfBuffer,@:NonText,
3950 d:Directory,e:ErrorMsg,i:IncSearch,
3951 l:Search,m:MoreMsg,M:ModeMsg,n:LineNr,
Bram Moolenaarefae76a2019-10-27 22:54:58 +01003952 a:LineNrAbove,b:LineNrBelow,
Bram Moolenaar58b85342016-08-14 19:54:54 +02003953 N:CursorLineNr,r:Question,s:StatusLine,
3954 S:StatusLineNC,c:VertSplit,t:Title,
Bram Moolenaar9d87a372018-12-18 21:41:50 +01003955 v:Visual,V:VisualNOS,w:WarningMsg,
3956 W:WildMenu,f:Folded,F:FoldColumn,
3957 A:DiffAdd,C:DiffChange,D:DiffDelete,
3958 T:DiffText,>:SignColumn,-:Conceal,
Bram Moolenaarc8c88492018-12-27 23:59:26 +01003959 B:SpellBad,P:SpellCap,R:SpellRare,
Bram Moolenaar9d87a372018-12-18 21:41:50 +01003960 L:SpellLocal,+:Pmenu,=:PmenuSel,
Bram Moolenaar21020352017-06-13 17:21:04 +02003961 x:PmenuSbar,X:PmenuThumb,*:TabLine,
3962 #:TabLineSel,_:TabLineFill,!:CursorColumn,
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02003963 .:CursorLine,o:ColorColumn,q:QuickFixLine,
Bram Moolenaarc572da52017-08-27 16:52:01 +02003964 z:StatusLineTerm,Z:StatusLineTermNC")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003965 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003966 This option can be used to set highlighting mode for various
3967 occasions. It is a comma separated list of character pairs. The
3968 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003969 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003970 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
Bram Moolenaar58b85342016-08-14 19:54:54 +02003971 |hl-EndOfBuffer| ~ lines after the last line in the buffer
3972 |hl-NonText| @ '@' at the end of the window and
Bram Moolenaar071d4272004-06-13 20:20:40 +00003973 characters from 'showbreak'
3974 |hl-Directory| d directories in CTRL-D listing and other special
3975 things in listings
3976 |hl-ErrorMsg| e error messages
3977 h (obsolete, ignored)
3978 |hl-IncSearch| i 'incsearch' highlighting
3979 |hl-Search| l last search pattern highlighting (see 'hlsearch')
3980 |hl-MoreMsg| m |more-prompt|
3981 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
Bram Moolenaar64486672010-05-16 15:46:46 +02003982 |hl-LineNr| n line number for ":number" and ":#" commands, and
3983 when 'number' or 'relativenumber' option is set.
Bram Moolenaarefae76a2019-10-27 22:54:58 +01003984 |hl-LineNrAbove| a line number above the cursor for when the
3985 'relativenumber' option is set.
3986 |hl-LineNrBelow| b line number below the cursor for when the
3987 'relativenumber' option is set.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01003988 |hl-CursorLineNr| N like n for when 'cursorline' or 'relativenumber' is
3989 set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003990 |hl-Question| r |hit-enter| prompt and yes/no questions
3991 |hl-StatusLine| s status line of current window |status-line|
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01003992 |hl-StatusLineNC| S status lines of not-current windows
Bram Moolenaar071d4272004-06-13 20:20:40 +00003993 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
3994 |hl-VertSplit| c column used to separate vertically split windows
3995 |hl-Visual| v Visual mode
3996 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
3997 Selection" Only X11 Gui's |gui-x11| and
3998 |xterm-clipboard|.
3999 |hl-WarningMsg| w warning messages
4000 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
4001 |hl-Folded| f line used for closed folds
4002 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00004003 |hl-DiffAdd| A added line in diff mode
4004 |hl-DiffChange| C changed line in diff mode
4005 |hl-DiffDelete| D deleted line in diff mode
4006 |hl-DiffText| T inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00004007 |hl-SignColumn| > column used for |signs|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004008 |hl-Conceal| - the placeholders used for concealed characters
4009 (see 'conceallevel')
Bram Moolenaar217ad922005-03-20 22:37:15 +00004010 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02004011 |hl-SpellCap| P word that should start with capital |spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00004012 |hl-SpellRare| R rare word |spell|
4013 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004014 |hl-Pmenu| + popup menu normal line
4015 |hl-PmenuSel| = popup menu selected line
4016 |hl-PmenuSbar| x popup menu scrollbar
4017 |hl-PmenuThumb| X popup menu scrollbar thumb
Bram Moolenaar071d4272004-06-13 20:20:40 +00004018
4019 The display modes are:
4020 r reverse (termcap entry "mr" and "me")
4021 i italic (termcap entry "ZH" and "ZR")
4022 b bold (termcap entry "md" and "me")
4023 s standout (termcap entry "so" and "se")
4024 u underline (termcap entry "us" and "ue")
Bram Moolenaare2cc9702005-03-15 22:43:58 +00004025 c undercurl (termcap entry "Cs" and "Ce")
Bram Moolenaarcf4b00c2017-09-02 18:33:56 +02004026 t strikethrough (termcap entry "Ts" and "Te")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004027 n no highlighting
4028 - no highlighting
4029 : use a highlight group
4030 The default is used for occasions that are not included.
4031 If you want to change what the display modes do, see |dos-colors|
4032 for an example.
4033 When using the ':' display mode, this must be followed by the name of
4034 a highlight group. A highlight group can be used to define any type
4035 of highlighting, including using color. See |:highlight| on how to
4036 define one. The default uses a different group for each occasion.
4037 See |highlight-default| for the default highlight groups.
4038
Bram Moolenaar071d4272004-06-13 20:20:40 +00004039 *'history'* *'hi'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004040'history' 'hi' number (Vim default: 50, Vi default: 0,
4041 set to 200 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004042 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004043 A history of ":" commands, and a history of previous search patterns
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004044 is remembered. This option decides how many entries may be stored in
Bram Moolenaar071d4272004-06-13 20:20:40 +00004045 each of these histories (see |cmdline-editing|).
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004046 The maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004047 NOTE: This option is set to the Vi default value when 'compatible' is
4048 set and to the Vim default value when 'compatible' is reset.
4049
4050 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
4051'hkmap' 'hk' boolean (default off)
4052 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004053 {only available when compiled with the |+rightleft|
4054 feature}
4055 When on, the keyboard is mapped for the Hebrew character set.
4056 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
4057 toggle this option. See |rileft.txt|.
4058 NOTE: This option is reset when 'compatible' is set.
4059
4060 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
4061'hkmapp' 'hkp' boolean (default off)
4062 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004063 {only available when compiled with the |+rightleft|
4064 feature}
4065 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
4066 This is useful if you have a non-Hebrew keyboard.
4067 See |rileft.txt|.
4068 NOTE: This option is reset when 'compatible' is set.
4069
Bram Moolenaar036986f2017-03-16 17:41:02 +01004070 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
4071'hlsearch' 'hls' boolean (default off)
4072 global
Bram Moolenaar036986f2017-03-16 17:41:02 +01004073 {not available when compiled without the
4074 |+extra_search| feature}
4075 When there is a previous search pattern, highlight all its matches.
4076 The type of highlighting used can be set with the 'l' occasion in the
4077 'highlight' option. This uses the "Search" highlight group by
4078 default. Note that only the matching text is highlighted, any offsets
4079 are not applied.
4080 See also: 'incsearch' and |:match|.
4081 When you get bored looking at the highlighted matches, you can turn it
4082 off with |:nohlsearch|. This does not change the option value, as
4083 soon as you use a search command, the highlighting comes back.
4084 'redrawtime' specifies the maximum time spent on finding matches.
4085 When the search pattern can match an end-of-line, Vim will try to
4086 highlight all of the matched text. However, this depends on where the
4087 search starts. This will be the first line in the window or the first
4088 line below a closed fold. A match in a previous line which is not
4089 drawn may not continue in a newly drawn line.
4090 You can specify whether the highlight status is restored on startup
4091 with the 'h' flag in 'viminfo' |viminfo-h|.
4092 NOTE: This option is reset when 'compatible' is set.
4093
Bram Moolenaar071d4272004-06-13 20:20:40 +00004094 *'icon'* *'noicon'*
4095'icon' boolean (default off, on when title can be restored)
4096 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004097 {not available when compiled without the |+title|
4098 feature}
4099 When on, the icon text of the window will be set to the value of
4100 'iconstring' (if it is not empty), or to the name of the file
4101 currently being edited. Only the last part of the name is used.
4102 Overridden by the 'iconstring' option.
4103 Only works if the terminal supports setting window icons (currently
4104 only X11 GUI and terminals with a non-empty 't_IS' option - these are
4105 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
4106 builtin termcap).
4107 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00004108 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00004109 X11.
Bram Moolenaar3a991dd2014-10-02 01:41:41 +02004110 For MS-Windows the icon can be changed, see |windows-icon|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004111
4112 *'iconstring'*
4113'iconstring' string (default "")
4114 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004115 {not available when compiled without the |+title|
4116 feature}
4117 When this option is not empty, it will be used for the icon text of
4118 the window. This happens only when the 'icon' option is on.
4119 Only works if the terminal supports setting window icon text
4120 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
4121 Does not work for MS Windows.
4122 When Vim was compiled with HAVE_X11 defined, the original icon will be
4123 restored if possible |X11|.
4124 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004125 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004126 'titlestring' for example settings.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004127 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004128 {not available when compiled without the |+statusline| feature}
4129
4130 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
4131'ignorecase' 'ic' boolean (default off)
4132 global
4133 Ignore case in search patterns. Also used when searching in the tags
4134 file.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01004135 Also see 'smartcase' and 'tagcase'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004136 Can be overruled by using "\c" or "\C" in the pattern, see
4137 |/ignorecase|.
4138
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004139 *'imactivatefunc'* *'imaf'*
4140'imactivatefunc' 'imaf' string (default "")
4141 global
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004142 This option specifies a function that will be called to
Bram Moolenaar2877d332017-11-26 14:56:16 +01004143 activate or deactivate the Input Method.
Bram Moolenaaref8c6172020-07-01 15:12:44 +02004144 It is not used in the MS-Windows GUI version.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004145 The expression will be evaluated in the |sandbox| when set from a
4146 modeline, see |sandbox-option|.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004147
4148 Example: >
4149 function ImActivateFunc(active)
4150 if a:active
4151 ... do something
4152 else
4153 ... do something
4154 endif
4155 " return value is not used
4156 endfunction
4157 set imactivatefunc=ImActivateFunc
4158<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004159 *'imactivatekey'* *'imak'*
4160'imactivatekey' 'imak' string (default "")
4161 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004162 {only available when compiled with |+xim| and
Bram Moolenaar67c53842010-05-22 18:28:27 +02004163 |+GUI_GTK|} *E599*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004164 Specifies the key that your Input Method in X-Windows uses for
4165 activation. When this is specified correctly, vim can fully control
4166 IM with 'imcmdline', 'iminsert' and 'imsearch'.
4167 You can't use this option to change the activation key, the option
4168 tells Vim what the key is.
4169 Format:
4170 [MODIFIER_FLAG-]KEY_STRING
4171
4172 These characters can be used for MODIFIER_FLAG (case is ignored):
4173 S Shift key
4174 L Lock key
4175 C Control key
4176 1 Mod1 key
4177 2 Mod2 key
4178 3 Mod3 key
4179 4 Mod4 key
4180 5 Mod5 key
4181 Combinations are allowed, for example "S-C-space" or "SC-space" are
4182 both shift+ctrl+space.
4183 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
4184
4185 Example: >
4186 :set imactivatekey=S-space
4187< "S-space" means shift+space. This is the activation key for kinput2 +
4188 canna (Japanese), and ami (Korean).
4189
4190 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
4191'imcmdline' 'imc' boolean (default off)
4192 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004193 When set the Input Method is always on when starting to edit a command
4194 line, unless entering a search pattern (see 'imsearch' for that).
4195 Setting this option is useful when your input method allows entering
4196 English characters directly, e.g., when it's used to type accented
4197 characters with dead keys.
4198
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004199 *'imdisable'* *'imd'* *'noimdisable'* *'noimd'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004200'imdisable' 'imd' boolean (default off, on for some systems (SGI))
4201 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004202 When set the Input Method is never used. This is useful to disable
4203 the IM when it doesn't work properly.
4204 Currently this option is on by default for SGI/IRIX machines. This
4205 may change in later releases.
4206
4207 *'iminsert'* *'imi'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004208'iminsert' 'imi' number (default 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004209 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004210 Specifies whether :lmap or an Input Method (IM) is to be used in
4211 Insert mode. Valid values:
4212 0 :lmap is off and IM is off
4213 1 :lmap is ON and IM is off
4214 2 :lmap is off and IM is ON
Bram Moolenaar071d4272004-06-13 20:20:40 +00004215 To always reset the option to zero when leaving Insert mode with <Esc>
4216 this can be used: >
4217 :inoremap <ESC> <ESC>:set iminsert=0<CR>
4218< This makes :lmap and IM turn off automatically when leaving Insert
4219 mode.
4220 Note that this option changes when using CTRL-^ in Insert mode
4221 |i_CTRL-^|.
4222 The value is set to 1 when setting 'keymap' to a valid keymap name.
4223 It is also used for the argument of commands like "r" and "f".
4224 The value 0 may not work correctly with Athena and Motif with some XIM
4225 methods. Use 'imdisable' to disable XIM then.
4226
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004227 You can set 'imactivatefunc' and 'imstatusfunc' to handle IME/XIM
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004228 via external command if Vim is not compiled with the |+xim|,
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004229 |+multi_byte_ime| or |global-ime|.
4230
Bram Moolenaar071d4272004-06-13 20:20:40 +00004231 *'imsearch'* *'ims'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004232'imsearch' 'ims' number (default -1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004233 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004234 Specifies whether :lmap or an Input Method (IM) is to be used when
4235 entering a search pattern. Valid values:
4236 -1 the value of 'iminsert' is used, makes it look like
4237 'iminsert' is also used when typing a search pattern
4238 0 :lmap is off and IM is off
4239 1 :lmap is ON and IM is off
4240 2 :lmap is off and IM is ON
4241 Note that this option changes when using CTRL-^ in Command-line mode
4242 |c_CTRL-^|.
4243 The value is set to 1 when it is not -1 and setting the 'keymap'
4244 option to a valid keymap name.
4245 The value 0 may not work correctly with Athena and Motif with some XIM
4246 methods. Use 'imdisable' to disable XIM then.
4247
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004248 *'imstatusfunc'* *'imsf'*
4249'imstatusfunc' 'imsf' string (default "")
4250 global
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004251 This option specifies a function that is called to obtain the status
4252 of Input Method. It must return a positive number when IME is active.
Bram Moolenaaref8c6172020-07-01 15:12:44 +02004253 It is not used in the MS-Windows GUI version.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004254
4255 Example: >
4256 function ImStatusFunc()
4257 let is_active = ...do something
4258 return is_active ? 1 : 0
4259 endfunction
4260 set imstatusfunc=ImStatusFunc
4261<
4262 NOTE: This function is invoked very often. Keep it fast.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004263 The expression will be evaluated in the |sandbox| when set from a
4264 modeline, see |sandbox-option|.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004265
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004266 *'imstyle'* *'imst'*
4267'imstyle' 'imst' number (default 1)
4268 global
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004269 {only available when compiled with |+xim| and
4270 |+GUI_GTK|}
Bram Moolenaar37c64c72017-09-19 22:06:03 +02004271 This option specifies the input style of Input Method:
4272 0 use on-the-spot style
4273 1 over-the-spot style
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004274 See: |xim-input-style|
4275
Bram Moolenaar24a98a02017-09-27 22:23:55 +02004276 For a long time on-the-spot style had been used in the GTK version of
4277 vim, however, it is known that it causes troubles when using mappings,
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004278 |single-repeat|, etc. Therefore over-the-spot style becomes the
4279 default now. This should work fine for most people, however if you
4280 have any problem with it, try using on-the-spot style.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004281 The expression will be evaluated in the |sandbox| when set from a
4282 modeline, see |sandbox-option|.
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004283
Bram Moolenaar071d4272004-06-13 20:20:40 +00004284 *'include'* *'inc'*
4285'include' 'inc' string (default "^\s*#\s*include")
4286 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004287 {not available when compiled without the
4288 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004289 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00004290 pattern, just like for the "/" command (See |pattern|). The default
4291 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar1e015462005-09-25 22:16:38 +00004292 "]I", "[d", etc.
4293 Normally the 'isfname' option is used to recognize the file name that
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004294 comes after the matched pattern. But if "\zs" appears in the pattern
4295 then the text matched from "\zs" to the end, or until "\ze" if it
4296 appears, is used as the file name. Use this to include characters
4297 that are not in 'isfname', such as a space. You can then use
4298 'includeexpr' to process the matched text.
Bram Moolenaar1e015462005-09-25 22:16:38 +00004299 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004300
4301 *'includeexpr'* *'inex'*
4302'includeexpr' 'inex' string (default "")
4303 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004304 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004305 |+find_in_path| or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004306 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004307 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004308 :set includeexpr=substitute(v:fname,'\\.','/','g')
4309< The "v:fname" variable will be set to the file name that was detected.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004310
Bram Moolenaar071d4272004-06-13 20:20:40 +00004311 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004312 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004313 Also used for |<cfile>|.
4314
Bram Moolenaar30b65812012-07-12 22:01:11 +02004315 The expression will be evaluated in the |sandbox| when set from a
4316 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004317 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004318
4319 It is not allowed to change text or jump to another window while
4320 evaluating 'includeexpr' |textlock|.
4321
Bram Moolenaar071d4272004-06-13 20:20:40 +00004322 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004323'incsearch' 'is' boolean (default off, set in |defaults.vim| if the
4324 +reltime feature is supported)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004325 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004326 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004327 |+extra_search| features}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004328 While typing a search command, show where the pattern, as it was typed
4329 so far, matches. The matched string is highlighted. If the pattern
4330 is invalid or not found, nothing is shown. The screen will be updated
4331 often, this is only useful on fast terminals.
Bram Moolenaarfc65cab2018-08-28 22:58:02 +02004332 Also applies to the pattern in commands: >
4333 :global
4334 :lvimgrep
4335 :lvimgrepadd
4336 :smagic
4337 :snomagic
4338 :sort
4339 :substitute
4340 :vglobal
4341 :vimgrep
4342 :vimgrepadd
4343< Note that the match will be shown, but the cursor will return to its
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004344 original position when no match is found and when pressing <Esc>. You
4345 still need to finish the search command with <Enter> to move the
4346 cursor to the match.
Bram Moolenaardc083282016-10-11 08:57:33 +02004347 You can use the CTRL-G and CTRL-T keys to move to the next and
4348 previous match. |c_CTRL-G| |c_CTRL-T|
Bram Moolenaar91a4e822008-01-19 14:59:58 +00004349 When compiled with the |+reltime| feature Vim only searches for about
4350 half a second. With a complicated pattern and/or a lot of text the
4351 match may not be found. This is to avoid that Vim hangs while you
4352 are typing the pattern.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004353 The highlighting can be set with the 'i' flag in 'highlight'.
Bram Moolenaar2f058492017-11-30 20:27:52 +01004354 When 'hlsearch' is on, all matched strings are highlighted too while
4355 typing a search command. See also: 'hlsearch'.
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004356 If you don't want to turn 'hlsearch' on, but want to highlight all
4357 matches while searching, you can turn on and off 'hlsearch' with
4358 autocmd. Example: >
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004359 augroup vimrc-incsearch-highlight
4360 autocmd!
Bram Moolenaarf8f8b2e2017-11-02 19:08:48 +01004361 autocmd CmdlineEnter /,\? :set hlsearch
4362 autocmd CmdlineLeave /,\? :set nohlsearch
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004363 augroup END
4364<
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004365 CTRL-L can be used to add one character from after the current match
Bram Moolenaara9dc3752010-07-11 20:46:53 +02004366 to the command line. If 'ignorecase' and 'smartcase' are set and the
4367 command line has no uppercase characters, the added character is
4368 converted to lowercase.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004369 CTRL-R CTRL-W can be used to add the word at the end of the current
4370 match, excluding the characters that were already typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004371 NOTE: This option is reset when 'compatible' is set.
4372
4373 *'indentexpr'* *'inde'*
4374'indentexpr' 'inde' string (default "")
4375 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004376 {not available when compiled without the |+cindent|
4377 or |+eval| features}
4378 Expression which is evaluated to obtain the proper indent for a line.
4379 It is used when a new line is created, for the |=| operator and
4380 in Insert mode as specified with the 'indentkeys' option.
4381 When this option is not empty, it overrules the 'cindent' and
Bram Moolenaar20f90cf2011-05-19 12:22:51 +02004382 'smartindent' indenting. When 'lisp' is set, this option is
4383 overridden by the Lisp indentation algorithm.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004384 When 'paste' is set this option is not used for indenting.
4385 The expression is evaluated with |v:lnum| set to the line number for
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004386 which the indent is to be computed. The cursor is also in this line
Bram Moolenaar071d4272004-06-13 20:20:40 +00004387 when the expression is evaluated (but it may be moved around).
4388 The expression must return the number of spaces worth of indent. It
4389 can return "-1" to keep the current indent (this means 'autoindent' is
4390 used for the indent).
4391 Functions useful for computing the indent are |indent()|, |cindent()|
4392 and |lispindent()|.
4393 The evaluation of the expression must not have side effects! It must
4394 not change the text, jump to another window, etc. Afterwards the
4395 cursor position is always restored, thus the cursor may be moved.
4396 Normally this option would be set to call a function: >
4397 :set indentexpr=GetMyIndent()
4398< Error messages will be suppressed, unless the 'debug' option contains
4399 "msg".
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004400 See |indent-expression|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01004401 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004402
Bram Moolenaar30b65812012-07-12 22:01:11 +02004403 The expression will be evaluated in the |sandbox| when set from a
4404 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004405 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004406
4407 It is not allowed to change text or jump to another window while
4408 evaluating 'indentexpr' |textlock|.
4409
4410
Bram Moolenaar071d4272004-06-13 20:20:40 +00004411 *'indentkeys'* *'indk'*
Bram Moolenaarce655742019-01-31 14:12:57 +01004412'indentkeys' 'indk' string (default "0{,0},0),0],:,0#,!^F,o,O,e")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004413 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004414 {not available when compiled without the |+cindent|
4415 feature}
4416 A list of keys that, when typed in Insert mode, cause reindenting of
4417 the current line. Only happens if 'indentexpr' isn't empty.
4418 The format is identical to 'cinkeys', see |indentkeys-format|.
4419 See |C-indenting| and |indent-expression|.
4420
4421 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
4422'infercase' 'inf' boolean (default off)
4423 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004424 When doing keyword completion in insert mode |ins-completion|, and
Bram Moolenaar446cb832008-06-24 21:56:24 +00004425 'ignorecase' is also on, the case of the match is adjusted depending
4426 on the typed text. If the typed text contains a lowercase letter
4427 where the match has an upper case letter, the completed part is made
4428 lowercase. If the typed text has no lowercase letters and the match
4429 has a lowercase letter where the typed text has an uppercase letter,
4430 and there is a letter before it, the completed part is made uppercase.
4431 With 'noinfercase' the match is used as-is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004432
4433 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
4434'insertmode' 'im' boolean (default off)
4435 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004436 Makes Vim work in a way that Insert mode is the default mode. Useful
4437 if you want to use Vim as a modeless editor. Used for |evim|.
4438 These Insert mode commands will be useful:
4439 - Use the cursor keys to move around.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02004440 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|. When
Bram Moolenaar071d4272004-06-13 20:20:40 +00004441 this is a mapping, it is executed as if 'insertmode' was off.
4442 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004443 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00004444 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
4445 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004446
4447 These items change when 'insertmode' is set:
4448 - when starting to edit of a file, Vim goes to Insert mode.
4449 - <Esc> in Insert mode is a no-op and beeps.
4450 - <Esc> in Normal mode makes Vim go to Insert mode.
4451 - CTRL-L in Insert mode is a command, it is not inserted.
4452 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
4453 However, when <Esc> is used inside a mapping, it behaves like
4454 'insertmode' was not set. This was done to be able to use the same
4455 mappings with 'insertmode' set or not set.
4456 When executing commands with |:normal| 'insertmode' is not used.
4457
4458 NOTE: This option is reset when 'compatible' is set.
4459
4460 *'isfname'* *'isf'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004461'isfname' 'isf' string (default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004462 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
4463 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
4464 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
4465 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
4466 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
4467 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004468 The characters specified by this option are included in file names and
4469 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004470 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004471 Multi-byte characters 256 and above are always included, only the
4472 characters up to 255 are specified with this option.
4473 For UTF-8 the characters 0xa0 to 0xff are included as well.
Bram Moolenaar446cb832008-06-24 21:56:24 +00004474 Think twice before adding white space to this option. Although a
4475 space may appear inside a file name, the effect will be that Vim
4476 doesn't know where a file name starts or ends when doing completion.
4477 It most likely works better without a space in 'isfname'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004478
4479 Note that on systems using a backslash as path separator, Vim tries to
4480 do its best to make it work as you would expect. That is a bit
4481 tricky, since Vi originally used the backslash to escape special
4482 characters. Vim will not remove a backslash in front of a normal file
4483 name character on these systems, but it will on Unix and alikes. The
4484 '&' and '^' are not included by default, because these are special for
4485 cmd.exe.
4486
4487 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004488 Each part can be a single character number or a range. A range is two
4489 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004490 decimal number between 0 and 255 or the ASCII character itself (does
4491 not work for digits). Example:
4492 "_,-,128-140,#-43" (include '_' and '-' and the range
4493 128 to 140 and '#' to 43)
4494 If a part starts with '^', the following character number or range
4495 will be excluded from the option. The option is interpreted from left
4496 to right. Put the excluded character after the range where it is
4497 included. To include '^' itself use it as the last character of the
4498 option or the end of a range. Example:
4499 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
4500 If the character is '@', all characters where isalpha() returns TRUE
4501 are included. Normally these are the characters a to z and A to Z,
4502 plus accented characters. To include '@' itself use "@-@". Examples:
4503 "@,^a-z" All alphabetic characters, excluding lower
Bram Moolenaar446cb832008-06-24 21:56:24 +00004504 case ASCII letters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004505 "a-z,A-Z,@-@" All letters plus the '@' character.
4506 A comma can be included by using it where a character number is
4507 expected. Example:
4508 "48-57,,,_" Digits, comma and underscore.
4509 A comma can be excluded by prepending a '^'. Example:
4510 " -~,^,,9" All characters from space to '~', excluding
4511 comma, plus <Tab>.
4512 See |option-backslash| about including spaces and backslashes.
4513
4514 *'isident'* *'isi'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004515'isident' 'isi' string (default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004516 "@,48-57,_,128-167,224-235"
4517 otherwise: "@,48-57,_,192-255")
4518 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004519 The characters given by this option are included in identifiers.
4520 Identifiers are used in recognizing environment variables and after a
4521 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00004522 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004523 option. For '@' only characters up to 255 are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004524 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004525 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00004526 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
4527
4528 *'iskeyword'* *'isk'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004529'iskeyword' 'isk' string (Vim default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004530 "@,48-57,_,128-167,224-235"
4531 otherwise: "@,48-57,_,192-255"
4532 Vi default: "@,48-57,_")
4533 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004534 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004535 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004536 'isfname' for a description of the format of this option. For '@'
4537 characters above 255 check the "word" character class.
4538 For C programs you could use "a-z,A-Z,48-57,_,.,-,>".
Bram Moolenaar071d4272004-06-13 20:20:40 +00004539 For a help file it is set to all non-blank printable characters except
4540 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
4541 command).
4542 When the 'lisp' option is on the '-' character is always included.
Bram Moolenaarb8060fe2016-01-19 22:29:28 +01004543 This option also influences syntax highlighting, unless the syntax
4544 uses |:syn-iskeyword|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004545 NOTE: This option is set to the Vi default value when 'compatible' is
4546 set and to the Vim default value when 'compatible' is reset.
4547
4548 *'isprint'* *'isp'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004549'isprint' 'isp' string (default for Win32 and Macintosh:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004550 "@,~-255"; otherwise: "@,161-255")
4551 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004552 The characters given by this option are displayed directly on the
4553 screen. It is also used for "\p" in a |pattern|. The characters from
4554 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
4555 even when they are not included in 'isprint' or excluded. See
4556 'isfname' for a description of the format of this option.
4557
4558 Non-printable characters are displayed with two characters:
4559 0 - 31 "^@" - "^_"
4560 32 - 126 always single characters
4561 127 "^?"
4562 128 - 159 "~@" - "~_"
4563 160 - 254 "| " - "|~"
4564 255 "~?"
4565 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
4566 displayed as <xx>, with the hexadecimal value of the byte.
4567 When 'display' contains "uhex" all unprintable characters are
4568 displayed as <xx>.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004569 The SpecialKey highlighting will be used for unprintable characters.
4570 |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004571
4572 Multi-byte characters 256 and above are always included, only the
4573 characters up to 255 are specified with this option. When a character
4574 is printable but it is not available in the current font, a
4575 replacement character will be shown.
4576 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
4577 There is no option to specify these characters.
4578
4579 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
4580'joinspaces' 'js' boolean (default on)
4581 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004582 Insert two spaces after a '.', '?' and '!' with a join command.
4583 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
4584 Otherwise only one space is inserted.
4585 NOTE: This option is set when 'compatible' is set.
4586
4587 *'key'*
4588'key' string (default "")
4589 local to buffer
Bram Moolenaar996343d2010-07-04 22:20:21 +02004590 {only available when compiled with the |+cryptv|
4591 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004592 The key that is used for encrypting and decrypting the current buffer.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02004593 See |encryption| and 'cryptmethod'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004594 Careful: Do not set the key value by hand, someone might see the typed
4595 key. Use the |:X| command. But you can make 'key' empty: >
4596 :set key=
4597< It is not possible to get the value of this option with ":set key" or
4598 "echo &key". This is to avoid showing it to someone who shouldn't
4599 know. It also means you cannot see it yourself once you have set it,
4600 be careful not to make a typing error!
Bram Moolenaard58e9292011-02-09 17:07:58 +01004601 You can use "&key" in an expression to detect whether encryption is
4602 enabled. When 'key' is set it returns "*****" (five stars).
Bram Moolenaar071d4272004-06-13 20:20:40 +00004603
4604 *'keymap'* *'kmp'* *E544*
4605'keymap' 'kmp' string (default "")
4606 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004607 {only available when compiled with the |+keymap|
4608 feature}
4609 Name of a keyboard mapping. See |mbyte-keymap|.
4610 Setting this option to a valid keymap name has the side effect of
4611 setting 'iminsert' to one, so that the keymap becomes effective.
4612 'imsearch' is also set to one, unless it was -1
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004613 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004614
4615 *'keymodel'* *'km'*
4616'keymodel' 'km' string (default "")
4617 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004618 List of comma separated words, which enable special things that keys
4619 can do. These values can be used:
4620 startsel Using a shifted special key starts selection (either
4621 Select mode or Visual mode, depending on "key" being
4622 present in 'selectmode').
4623 stopsel Using a not-shifted special key stops selection.
4624 Special keys in this context are the cursor keys, <End>, <Home>,
4625 <PageUp> and <PageDown>.
4626 The 'keymodel' option is set by the |:behave| command.
4627
4628 *'keywordprg'* *'kp'*
4629'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02004630 VMS: "help")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004631 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004632 Program to use for the |K| command. Environment variables are
4633 expanded |:set_env|. ":help" may be used to access the Vim internal
4634 help. (Note that previously setting the global option to the empty
4635 value did this, which is now deprecated.)
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02004636 When the first character is ":", the command is invoked as a Vim
4637 Ex command prefixed with [count].
4638 When "man", "man -s" or an Ex command is used, Vim will automatically
4639 translate a count for the "K" command and pass it as the first
4640 argument. For "man -s" the "-s" is removed when there is no count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004641 See |option-backslash| about including spaces and backslashes.
4642 Example: >
4643 :set keywordprg=man\ -s
4644< This option cannot be set from a |modeline| or in the |sandbox|, for
4645 security reasons.
4646
4647 *'langmap'* *'lmap'* *E357* *E358*
4648'langmap' 'lmap' string (default "")
4649 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004650 {only available when compiled with the |+langmap|
4651 feature}
4652 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004653 mode. When you are typing text in Insert mode the characters are
Bram Moolenaarfa735342016-01-03 22:14:44 +01004654 inserted directly. When in Normal mode the 'langmap' option takes
Bram Moolenaar071d4272004-06-13 20:20:40 +00004655 care of translating these special characters to the original meaning
4656 of the key. This means you don't have to change the keyboard mode to
4657 be able to execute Normal mode commands.
4658 This is the opposite of the 'keymap' option, where characters are
4659 mapped in Insert mode.
Bram Moolenaarb17893a2020-03-14 08:19:51 +01004660 Also consider setting 'langremap' to off, to prevent 'langmap' from
4661 applying to characters resulting from a mapping.
Bram Moolenaare968e362014-05-13 20:23:24 +02004662 This option cannot be set from a |modeline| or in the |sandbox|, for
4663 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004664
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00004665 Example (for Greek, in UTF-8): *greek* >
4666 :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 +00004667< Example (exchanges meaning of z and y for commands): >
4668 :set langmap=zy,yz,ZY,YZ
4669<
4670 The 'langmap' option is a list of parts, separated with commas. Each
4671 part can be in one of two forms:
4672 1. A list of pairs. Each pair is a "from" character immediately
4673 followed by the "to" character. Examples: "aA", "aAbBcC".
4674 2. A list of "from" characters, a semi-colon and a list of "to"
4675 characters. Example: "abc;ABC"
4676 Example: "aA,fgh;FGH,cCdDeE"
4677 Special characters need to be preceded with a backslash. These are
4678 ";", ',' and backslash itself.
4679
4680 This will allow you to activate vim actions without having to switch
4681 back and forth between the languages. Your language characters will
4682 be understood as normal vim English characters (according to the
4683 langmap mappings) in the following cases:
4684 o Normal/Visual mode (commands, buffer/register names, user mappings)
4685 o Insert/Replace Mode: Register names after CTRL-R
4686 o Insert/Replace Mode: Mappings
4687 Characters entered in Command-line mode will NOT be affected by
4688 this option. Note that this option can be changed at any time
4689 allowing to switch between mappings for different languages/encodings.
4690 Use a mapping to avoid having to type it each time!
4691
4692 *'langmenu'* *'lm'*
4693'langmenu' 'lm' string (default "")
4694 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004695 {only available when compiled with the |+menu| and
4696 |+multi_lang| features}
4697 Language to use for menu translation. Tells which file is loaded
4698 from the "lang" directory in 'runtimepath': >
4699 "lang/menu_" . &langmenu . ".vim"
4700< (without the spaces). For example, to always use the Dutch menus, no
4701 matter what $LANG is set to: >
4702 :set langmenu=nl_NL.ISO_8859-1
4703< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004704 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004705 If your $LANG is set to a non-English language but you do want to use
4706 the English menus: >
4707 :set langmenu=none
4708< This option must be set before loading menus, switching on filetype
4709 detection or syntax highlighting. Once the menus are defined setting
4710 this option has no effect. But you could do this: >
4711 :source $VIMRUNTIME/delmenu.vim
4712 :set langmenu=de_DE.ISO_8859-1
4713 :source $VIMRUNTIME/menu.vim
4714< Warning: This deletes all menus that you defined yourself!
4715
Bram Moolenaard94464e2015-11-02 15:28:18 +01004716 *'langnoremap'* *'lnr'* *'nolangnoremap'* *'nolnr'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004717'langnoremap' 'lnr' boolean (default off, set in |defaults.vim|)
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004718 global
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004719 {only available when compiled with the |+langmap|
4720 feature}
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004721 This is just like 'langremap' but with the value inverted. It only
4722 exists for backwards compatibility. When setting 'langremap' then
4723 'langnoremap' is set to the inverted value, and the other way around.
4724
4725 *'langremap'* *'lrm'* *'nolangremap'* *'nolrm'*
Bram Moolenaarb17893a2020-03-14 08:19:51 +01004726'langremap' 'lrm' boolean (default on, set to off in |defaults.vim|)
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004727 global
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004728 {only available when compiled with the |+langmap|
4729 feature}
4730 When off, setting 'langmap' does not apply to characters resulting from
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004731 a mapping. This basically means, if you noticed that setting
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004732 'langmap' disables some of your mappings, try resetting this option.
4733 This option defaults to on for backwards compatibility. Set it off if
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004734 that works for you to avoid mappings to break.
4735
Bram Moolenaar071d4272004-06-13 20:20:40 +00004736 *'laststatus'* *'ls'*
4737'laststatus' 'ls' number (default 1)
4738 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004739 The value of this option influences when the last window will have a
4740 status line:
4741 0: never
4742 1: only if there are at least two windows
4743 2: always
4744 The screen looks nicer with a status line if you have several
4745 windows, but it takes another screen line. |status-line|
4746
4747 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
4748'lazyredraw' 'lz' boolean (default off)
4749 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004750 When this option is set, the screen will not be redrawn while
4751 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004752 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00004753 update use |:redraw|.
4754
4755 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
4756'linebreak' 'lbr' boolean (default off)
4757 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02004758 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004759 feature}
Bram Moolenaar946e27a2014-06-25 18:50:27 +02004760 If on, Vim will wrap long lines at a character in 'breakat' rather
Bram Moolenaar071d4272004-06-13 20:20:40 +00004761 than at the last character that fits on the screen. Unlike
4762 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
Bram Moolenaar946e27a2014-06-25 18:50:27 +02004763 it only affects the way the file is displayed, not its contents.
4764 If 'breakindent' is set, line is visually indented. Then, the value
4765 of 'showbreak' is used to put in front of wrapped lines. This option
Bram Moolenaar86b17e92014-07-02 20:00:47 +02004766 is not used when the 'wrap' option is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004767 Note that <Tab> characters after an <EOL> are mostly not displayed
4768 with the right amount of white space.
4769
4770 *'lines'* *E593*
4771'lines' number (default 24 or terminal height)
4772 global
4773 Number of lines of the Vim window.
4774 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00004775 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004776 When Vim is running in the GUI or in a resizable window, setting this
4777 option will cause the window size to be changed. When you only want
4778 to use the size for the GUI, put the command in your |gvimrc| file.
4779 Vim limits the number of lines to what fits on the screen. You can
4780 use this command to get the tallest window possible: >
4781 :set lines=999
Bram Moolenaarf4d11452005-12-02 00:46:37 +00004782< Minimum value is 2, maximum value is 1000.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02004783 If you get fewer lines than expected, check the 'guiheadroom' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004784 When you set this option and Vim is unable to change the physical
4785 number of lines of the display, the display may be messed up.
4786
4787 *'linespace'* *'lsp'*
4788'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
4789 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004790 {only in the GUI}
4791 Number of pixel lines inserted between characters. Useful if the font
4792 uses the full character cell height, making lines touch each other.
4793 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004794 With some fonts there can be too much room between lines (to have
4795 space for ascents and descents). Then it makes sense to set
4796 'linespace' to a negative value. This may cause display problems
4797 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00004798
4799 *'lisp'* *'nolisp'*
4800'lisp' boolean (default off)
4801 local to buffer
4802 {not available when compiled without the |+lispindent|
4803 feature}
4804 Lisp mode: When <Enter> is typed in insert mode set the indent for
4805 the next line to Lisp standards (well, sort of). Also happens with
4806 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
4807 flag in 'cpoptions' changes the method of indenting: Vi compatible or
4808 better. Also see 'lispwords'.
4809 The '-' character is included in keyword characters. Redefines the
4810 "=" operator to use this same indentation algorithm rather than
4811 calling an external program if 'equalprg' is empty.
4812 This option is not used when 'paste' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004813
4814 *'lispwords'* *'lw'*
4815'lispwords' 'lw' string (default is very long)
Bram Moolenaaraf6c1312014-03-12 18:55:58 +01004816 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004817 {not available when compiled without the |+lispindent|
4818 feature}
4819 Comma separated list of words that influence the Lisp indenting.
4820 |'lisp'|
4821
4822 *'list'* *'nolist'*
4823'list' boolean (default off)
4824 local to window
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004825 List mode: Show tabs as CTRL-I is displayed, display $ after end of
4826 line. Useful to see the difference between tabs and spaces and for
4827 trailing blanks. Further changed by the 'listchars' option.
4828
4829 The cursor is displayed at the start of the space a Tab character
4830 occupies, not at the end as usual in Normal mode. To get this cursor
4831 position while displaying Tabs with spaces, use: >
Bram Moolenaardd007ed2013-07-09 15:44:17 +02004832 :set list lcs=tab:\ \
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004833<
4834 Note that list mode will also affect formatting (set with 'textwidth'
4835 or 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
Bram Moolenaar071d4272004-06-13 20:20:40 +00004836 changing the way tabs are displayed.
4837
4838 *'listchars'* *'lcs'*
4839'listchars' 'lcs' string (default "eol:$")
4840 global
Bram Moolenaarf9d5ca12010-08-01 16:13:51 +02004841 Strings to use in 'list' mode and for the |:list| command. It is a
4842 comma separated list of string settings.
Bram Moolenaar79278362015-04-21 18:33:48 +02004843 *lcs-eol*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004844 eol:c Character to show at the end of each line. When
4845 omitted, there is no extra character at the end of the
4846 line.
Bram Moolenaar79278362015-04-21 18:33:48 +02004847 *lcs-tab*
Bram Moolenaar83a52172019-01-16 22:41:54 +01004848 tab:xy[z] Two or three characters to be used to show a tab.
4849 The third character is optional.
4850
4851 tab:xy The 'x' is always used, then 'y' as many times as will
4852 fit. Thus "tab:>-" displays:
4853 >
4854 >-
4855 >--
4856 etc.
4857
4858 tab:xyz The 'z' is always used, then 'x' is prepended, and
4859 then 'y' is used as many times as will fit. Thus
4860 "tab:<->" displays:
4861 >
4862 <>
4863 <->
4864 <-->
4865 etc.
4866
4867 When "tab:" is omitted, a tab is shown as ^I.
Bram Moolenaar79278362015-04-21 18:33:48 +02004868 *lcs-space*
4869 space:c Character to show for a space. When omitted, spaces
4870 are left blank.
4871 *lcs-trail*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004872 trail:c Character to show for trailing spaces. When omitted,
Bram Moolenaar79278362015-04-21 18:33:48 +02004873 trailing spaces are blank. Overrides the "space"
4874 setting for trailing spaces.
4875 *lcs-extends*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004876 extends:c Character to show in the last column, when 'wrap' is
4877 off and the line continues beyond the right of the
4878 screen.
Bram Moolenaar79278362015-04-21 18:33:48 +02004879 *lcs-precedes*
Bram Moolenaarbffba7f2019-09-20 17:00:17 +02004880 precedes:c Character to show in the first visible column of the
4881 physical line, when there is text preceding the
4882 character visible in the first column.
Bram Moolenaar79278362015-04-21 18:33:48 +02004883 *lcs-conceal*
Bram Moolenaar860cae12010-06-05 23:22:07 +02004884 conceal:c Character to show in place of concealed text, when
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004885 'conceallevel' is set to 1.
Bram Moolenaar79278362015-04-21 18:33:48 +02004886 *lcs-nbsp*
Bram Moolenaar73284b92015-05-04 17:28:22 +02004887 nbsp:c Character to show for a non-breakable space character
4888 (0xA0 (160 decimal) and U+202F). Left blank when
4889 omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004890
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004891 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00004892 be used when 'encoding' is "utf-8", otherwise only printable
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004893 characters are allowed. All characters must be single width.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004894
4895 Examples: >
4896 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004897 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00004898 :set lcs=extends:>,precedes:<
4899< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaar79278362015-04-21 18:33:48 +02004900 "precedes". "SpecialKey" for "nbsp", "space", "tab" and "trail".
Bram Moolenaar02467872007-05-06 13:22:01 +00004901 |hl-NonText| |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004902
4903 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
4904'loadplugins' 'lpl' boolean (default on)
4905 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004906 When on the plugin scripts are loaded when starting up |load-plugins|.
4907 This option can be reset in your |vimrc| file to disable the loading
4908 of plugins.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02004909 Note that using the "-u NONE", "-u DEFAULTS" and "--noplugin" command
4910 line arguments reset this option. See |-u| and |--noplugin|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004911
Bram Moolenaard94464e2015-11-02 15:28:18 +01004912 *'luadll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01004913'luadll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01004914 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01004915 {only available when compiled with the |+lua/dyn|
4916 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01004917 Specifies the name of the Lua shared library. The default is
4918 DYNAMIC_LUA_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02004919 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01004920 This option cannot be set from a |modeline| or in the |sandbox|, for
4921 security reasons.
4922
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00004923 *'macatsui'* *'nomacatsui'*
4924'macatsui' boolean (default on)
4925 global
4926 {only available in Mac GUI version}
4927 This is a workaround for when drawing doesn't work properly. When set
4928 and compiled with multi-byte support ATSUI text drawing is used. When
4929 not set ATSUI text drawing is not used. Switch this option off when
4930 you experience drawing problems. In a future version the problems may
4931 be solved and this option becomes obsolete. Therefore use this method
4932 to unset it: >
4933 if exists('&macatsui')
4934 set nomacatsui
4935 endif
Bram Moolenaar02467872007-05-06 13:22:01 +00004936< Another option to check if you have drawing problems is
4937 'termencoding'.
4938
Bram Moolenaar071d4272004-06-13 20:20:40 +00004939 *'magic'* *'nomagic'*
4940'magic' boolean (default on)
4941 global
4942 Changes the special characters that can be used in search patterns.
4943 See |pattern|.
Bram Moolenaar64d8e252016-09-06 22:12:34 +02004944 WARNING: Switching this option off most likely breaks plugins! That
4945 is because many patterns assume it's on and will fail when it's off.
4946 Only switch it off when working with old Vi scripts. In any other
4947 situation write patterns that work when 'magic' is on. Include "\M"
4948 when you want to |/\M|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004949
4950 *'makeef'* *'mef'*
4951'makeef' 'mef' string (default: "")
4952 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004953 {not available when compiled without the |+quickfix|
4954 feature}
4955 Name of the errorfile for the |:make| command (see |:make_makeprg|)
4956 and the |:grep| command.
4957 When it is empty, an internally generated temp file will be used.
4958 When "##" is included, it is replaced by a number to make the name
4959 unique. This makes sure that the ":make" command doesn't overwrite an
4960 existing file.
4961 NOT used for the ":cf" command. See 'errorfile' for that.
4962 Environment variables are expanded |:set_env|.
4963 See |option-backslash| about including spaces and backslashes.
4964 This option cannot be set from a |modeline| or in the |sandbox|, for
4965 security reasons.
4966
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01004967 *'makeencoding'* *'menc'*
4968'makeencoding' 'menc' string (default "")
4969 global or local to buffer |global-local|
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01004970 Encoding used for reading the output of external commands. When empty,
4971 encoding is not converted.
4972 This is used for `:make`, `:lmake`, `:grep`, `:lgrep`, `:grepadd`,
4973 `:lgrepadd`, `:cfile`, `:cgetfile`, `:caddfile`, `:lfile`, `:lgetfile`,
4974 and `:laddfile`.
4975
4976 This would be mostly useful when you use MS-Windows and set 'encoding'
4977 to "utf-8". If |+iconv| is enabled and GNU libiconv is used, setting
4978 'makeencoding' to "char" has the same effect as setting to the system
4979 locale encoding. Example: >
4980 :set encoding=utf-8
4981 :set makeencoding=char " system locale is used
4982<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004983 *'makeprg'* *'mp'*
4984'makeprg' 'mp' string (default "make", VMS: "MMS")
4985 global or local to buffer |global-local|
Bram Moolenaar02467872007-05-06 13:22:01 +00004986 Program to use for the ":make" command. See |:make_makeprg|.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01004987 This option may contain '%' and '#' characters (see |:_%| and |:_#|),
4988 which are expanded to the current and alternate file name. Use |::S|
Bram Moolenaar26df0922014-02-23 23:39:13 +01004989 to escape file names in case they contain special characters.
Bram Moolenaar02467872007-05-06 13:22:01 +00004990 Environment variables are expanded |:set_env|. See |option-backslash|
4991 about including spaces and backslashes.
4992 Note that a '|' must be escaped twice: once for ":set" and once for
4993 the interpretation of a command. When you use a filter called
4994 "myfilter" do it like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004995 :set makeprg=gmake\ \\\|\ myfilter
4996< The placeholder "$*" can be given (even multiple times) to specify
4997 where the arguments will be included, for example: >
4998 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
4999< This option cannot be set from a |modeline| or in the |sandbox|, for
5000 security reasons.
5001
5002 *'matchpairs'* *'mps'*
5003'matchpairs' 'mps' string (default "(:),{:},[:]")
5004 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005005 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01005006 other.
5007 Only character pairs are allowed that are different, thus you cannot
5008 jump between two double quotes.
5009 The characters must be separated by a colon.
Bram Moolenaar02467872007-05-06 13:22:01 +00005010 The pairs must be separated by a comma. Example for including '<' and
5011 '>' (HTML): >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005012 :set mps+=<:>
5013
5014< A more exotic example, to jump between the '=' and ';' in an
5015 assignment, useful for languages like C and Java: >
5016 :au FileType c,cpp,java set mps+==:;
5017
5018< For a more advanced way of using "%", see the matchit.vim plugin in
Bram Moolenaar01164a62017-11-02 22:58:42 +01005019 the $VIMRUNTIME/pack/dist/opt/matchit directory. |add-local-help|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005020
5021 *'matchtime'* *'mat'*
5022'matchtime' 'mat' number (default 5)
5023 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005024 Tenths of a second to show the matching paren, when 'showmatch' is
5025 set. Note that this is not in milliseconds, like other options that
5026 set a time. This is to be compatible with Nvi.
5027
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005028 *'maxcombine'* *'mco'*
5029'maxcombine' 'mco' number (default 2)
5030 global
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005031 The maximum number of combining characters supported for displaying.
5032 Only used when 'encoding' is "utf-8".
5033 The default is OK for most languages. Hebrew may require 4.
5034 Maximum value is 6.
5035 Even when this option is set to 2 you can still edit text with more
5036 combining characters, you just can't see them. Use |g8| or |ga|.
5037 See |mbyte-combining|.
5038
Bram Moolenaar071d4272004-06-13 20:20:40 +00005039 *'maxfuncdepth'* *'mfd'*
5040'maxfuncdepth' 'mfd' number (default 100)
5041 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02005042 {not available when compiled without the |+eval|
Bram Moolenaar02467872007-05-06 13:22:01 +00005043 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005044 Maximum depth of function calls for user functions. This normally
5045 catches endless recursion. When using a recursive function with
5046 more depth, set 'maxfuncdepth' to a bigger number. But this will use
5047 more memory, there is the danger of failing when memory is exhausted.
Bram Moolenaarbc2eada2017-01-02 21:27:47 +01005048 Increasing this limit above 200 also changes the maximum for Ex
Bram Moolenaar0b0f0992018-05-22 21:41:30 +02005049 command recursion, see |E169|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005050 See also |:function|.
5051
5052 *'maxmapdepth'* *'mmd'* *E223*
5053'maxmapdepth' 'mmd' number (default 1000)
5054 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005055 Maximum number of times a mapping is done without resulting in a
5056 character to be used. This normally catches endless mappings, like
5057 ":map x y" with ":map y x". It still does not catch ":map g wg",
5058 because the 'w' is used before the next mapping is done. See also
5059 |key-mapping|.
5060
5061 *'maxmem'* *'mm'*
5062'maxmem' 'mm' number (default between 256 to 5120 (system
5063 dependent) or half the amount of memory
5064 available)
5065 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005066 Maximum amount of memory (in Kbyte) to use for one buffer. When this
5067 limit is reached allocating extra memory for a buffer will cause
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005068 other memory to be freed.
5069 The maximum usable value is about 2000000. Use this to work without a
5070 limit.
5071 The value is ignored when 'swapfile' is off.
5072 Also see 'maxmemtot'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005073
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005074 *'maxmempattern'* *'mmp'*
5075'maxmempattern' 'mmp' number (default 1000)
5076 global
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005077 Maximum amount of memory (in Kbyte) to use for pattern matching.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005078 The maximum value is about 2000000. Use this to work without a limit.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005079 *E363*
Bram Moolenaar02467872007-05-06 13:22:01 +00005080 When Vim runs into the limit it gives an error message and mostly
5081 behaves like CTRL-C was typed.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005082 Running into the limit often means that the pattern is very
5083 inefficient or too complex. This may already happen with the pattern
5084 "\(.\)*" on a very long line. ".*" works much better.
Bram Moolenaarfd358112018-07-07 23:21:31 +02005085 Might also happen on redraw, when syntax rules try to match a complex
5086 text structure.
5087 Vim may run out of memory before hitting the 'maxmempattern' limit, in
5088 which case you get an "Out of memory" error instead.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005089
Bram Moolenaar071d4272004-06-13 20:20:40 +00005090 *'maxmemtot'* *'mmt'*
5091'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
5092 dependent) or half the amount of memory
5093 available)
5094 global
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005095 Maximum amount of memory in Kbyte to use for all buffers together.
5096 The maximum usable value is about 2000000 (2 Gbyte). Use this to work
Bram Moolenaarfa735342016-01-03 22:14:44 +01005097 without a limit.
5098 On 64 bit machines higher values might work. But hey, do you really
5099 need more than 2 Gbyte for text editing? Keep in mind that text is
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005100 stored in the swap file, one can edit files > 2 Gbyte anyway. We do
Bram Moolenaarfa735342016-01-03 22:14:44 +01005101 need the memory to store undo info.
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005102 Buffers with 'swapfile' off still count to the total amount of memory
5103 used.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005104 Also see 'maxmem'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005105
5106 *'menuitems'* *'mis'*
5107'menuitems' 'mis' number (default 25)
5108 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005109 {not available when compiled without the |+menu|
5110 feature}
5111 Maximum number of items to use in a menu. Used for menus that are
5112 generated from a list of items, e.g., the Buffers menu. Changing this
5113 option has no direct effect, the menu must be refreshed first.
5114
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005115 *'mkspellmem'* *'msm'*
5116'mkspellmem' 'msm' string (default "460000,2000,500")
5117 global
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005118 {not available when compiled without the |+syntax|
5119 feature}
5120 Parameters for |:mkspell|. This tunes when to start compressing the
5121 word tree. Compression can be slow when there are many words, but
5122 it's needed to avoid running out of memory. The amount of memory used
5123 per word depends very much on how similar the words are, that's why
5124 this tuning is complicated.
5125
5126 There are three numbers, separated by commas:
5127 {start},{inc},{added}
5128
5129 For most languages the uncompressed word tree fits in memory. {start}
5130 gives the amount of memory in Kbyte that can be used before any
5131 compression is done. It should be a bit smaller than the amount of
5132 memory that is available to Vim.
5133
5134 When going over the {start} limit the {inc} number specifies the
5135 amount of memory in Kbyte that can be allocated before another
5136 compression is done. A low number means compression is done after
5137 less words are added, which is slow. A high number means more memory
5138 will be allocated.
5139
5140 After doing compression, {added} times 1024 words can be added before
5141 the {inc} limit is ignored and compression is done when any extra
5142 amount of memory is needed. A low number means there is a smaller
5143 chance of hitting the {inc} limit, less memory is used but it's
5144 slower.
5145
5146 The languages for which these numbers are important are Italian and
5147 Hungarian. The default works for when you have about 512 Mbyte. If
5148 you have 1 Gbyte you could use: >
5149 :set mkspellmem=900000,3000,800
5150< If you have less than 512 Mbyte |:mkspell| may fail for some
5151 languages, no matter what you set 'mkspellmem' to.
5152
Bram Moolenaar07607392019-05-26 19:20:43 +02005153 This option cannot be set from a |modeline| or in the |sandbox|.
5154
Bram Moolenaar071d4272004-06-13 20:20:40 +00005155 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
Bram Moolenaar8243a792007-05-01 17:05:03 +00005156'modeline' 'ml' boolean (Vim default: on (off for root),
5157 Vi default: off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005158 local to buffer
Bram Moolenaar110289e2019-05-23 15:38:06 +02005159 If 'modeline' is on 'modelines' gives the number of lines that is
5160 checked for set commands. If 'modeline' is off or 'modelines' is zero
5161 no lines are checked. See |modeline|.
5162
5163 *'modelineexpr'* *'mle'* *'nomodelineexpr'* *'nomle'*
5164'modelineexpr' 'mle' boolean (default: off)
5165 global
5166 When on allow some options that are an expression to be set in the
5167 modeline. Check the option for whether it is affected by
5168 'modelineexpr'. Also see |modeline|.
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02005169 This option cannot be set from a |modeline| or in the |sandbox|, for
5170 security reasons.
Bram Moolenaar110289e2019-05-23 15:38:06 +02005171
Bram Moolenaar071d4272004-06-13 20:20:40 +00005172 *'modelines'* *'mls'*
5173'modelines' 'mls' number (default 5)
5174 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005175 If 'modeline' is on 'modelines' gives the number of lines that is
5176 checked for set commands. If 'modeline' is off or 'modelines' is zero
5177 no lines are checked. See |modeline|.
5178 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
5179 set and to the Vim default value when 'compatible' is reset.
5180
5181 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
Bram Moolenaar110289e2019-05-23 15:38:06 +02005182 *E21*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005183'modifiable' 'ma' boolean (default on)
5184 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005185 When off the buffer contents cannot be changed. The 'fileformat' and
5186 'fileencoding' options also can't be changed.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01005187 Can be reset on startup with the |-M| command line argument.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005188
5189 *'modified'* *'mod'* *'nomodified'* *'nomod'*
5190'modified' 'mod' boolean (default off)
5191 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005192 When on, the buffer is considered to be modified. This option is set
5193 when:
5194 1. A change was made to the text since it was last written. Using the
5195 |undo| command to go back to the original text will reset the
5196 option. But undoing changes that were made before writing the
5197 buffer will set the option again, since the text is different from
5198 when it was written.
5199 2. 'fileformat' or 'fileencoding' is different from its original
5200 value. The original value is set when the buffer is read or
5201 written. A ":set nomodified" command also resets the original
5202 values to the current values and the 'modified' option will be
5203 reset.
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01005204 Similarly for 'eol' and 'bomb'.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02005205 This option is not set when a change is made to the buffer as the
5206 result of a BufNewFile, BufRead/BufReadPost, BufWritePost,
5207 FileAppendPost or VimLeave autocommand event. See |gzip-example| for
5208 an explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005209 When 'buftype' is "nowrite" or "nofile" this option may be set, but
5210 will be ignored.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01005211 Note that the text may actually be the same, e.g. 'modified' is set
5212 when using "rA" on an "A".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005213
5214 *'more'* *'nomore'*
5215'more' boolean (Vim default: on, Vi default: off)
5216 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005217 When on, listings pause when the whole screen is filled. You will get
5218 the |more-prompt|. When this option is off there are no pauses, the
5219 listing continues until finished.
5220 NOTE: This option is set to the Vi default value when 'compatible' is
5221 set and to the Vim default value when 'compatible' is reset.
5222
5223 *'mouse'* *E538*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005224'mouse' string (default "", "a" for GUI and Win32,
Bram Moolenaar5b418992019-10-27 18:50:25 +01005225 set to "a" or "nvi" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005226 global
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005227 Enable the use of the mouse. Works for most terminals (xterm, Win32
5228 |win32-mouse|, QNX pterm, *BSD console with sysmouse and Linux console
5229 with gpm). For using the mouse in the GUI, see |gui-mouse|. The
5230 mouse can be enabled for different modes:
Bram Moolenaar7f2e9d72017-11-11 20:58:53 +01005231 n Normal mode and Terminal modes
Bram Moolenaar071d4272004-06-13 20:20:40 +00005232 v Visual mode
5233 i Insert mode
5234 c Command-line mode
5235 h all previous modes when editing a help file
5236 a all previous modes
5237 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005238 Normally you would enable the mouse in all five modes with: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005239 :set mouse=a
Bram Moolenaar5b418992019-10-27 18:50:25 +01005240< If your terminal can't overrule the mouse events going to the
5241 application, use: >
5242 :set mouse=nvi
Bram Moolenaar65e0d772020-06-14 17:29:55 +02005243< Then you can press ":", select text for the system, and press Esc to go
Bram Moolenaar5b418992019-10-27 18:50:25 +01005244 back to Vim using the mouse events.
5245 In |defaults.vim| "nvi" is used if the 'term' option is not matching
5246 "xterm".
5247
5248 When the mouse is not enabled, the GUI will still use the mouse for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005249 modeless selection. This doesn't move the text cursor.
5250
5251 See |mouse-using|. Also see |'clipboard'|.
5252
5253 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005254 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005255 the mouse buttons can still be used by keeping the shift key pressed.
5256 Also see the 'clipboard' option.
5257
5258 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
5259'mousefocus' 'mousef' boolean (default off)
5260 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005261 {only works in the GUI}
5262 The window that the mouse pointer is on is automatically activated.
5263 When changing the window layout or window focus in another way, the
5264 mouse pointer is moved to the window with keyboard focus. Off is the
5265 default because it makes using the pull down menus a little goofy, as
5266 a pointer transit may activate a window unintentionally.
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01005267 MS-Windows: Also see 'scrollfocus' for what window is scrolled when
Bram Moolenaar1d9215b2020-01-25 13:27:42 +01005268 using the mouse scroll wheel.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005269
5270 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
5271'mousehide' 'mh' boolean (default on)
5272 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005273 {only works in the GUI}
5274 When on, the mouse pointer is hidden when characters are typed.
5275 The mouse pointer is restored when the mouse is moved.
5276
5277 *'mousemodel'* *'mousem'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005278'mousemodel' 'mousem' string (default "extend", "popup" for Win32)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005279 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005280 Sets the model to use for the mouse. The name mostly specifies what
5281 the right mouse button is used for:
5282 extend Right mouse button extends a selection. This works
5283 like in an xterm.
5284 popup Right mouse button pops up a menu. The shifted left
5285 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00005286 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005287 popup_setpos Like "popup", but the cursor will be moved to the
5288 position where the mouse was clicked, and thus the
5289 selected operation will act upon the clicked object.
5290 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00005291 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005292 course, that right clicking outside a selection will
5293 end Visual mode.
5294 Overview of what button does what for each model:
5295 mouse extend popup(_setpos) ~
5296 left click place cursor place cursor
5297 left drag start selection start selection
5298 shift-left search word extend selection
5299 right click extend selection popup menu (place cursor)
5300 right drag extend selection -
5301 middle click paste paste
5302
5303 In the "popup" model the right mouse button produces a pop-up menu.
5304 You need to define this first, see |popup-menu|.
5305
5306 Note that you can further refine the meaning of buttons with mappings.
5307 See |gui-mouse-mapping|. But mappings are NOT used for modeless
5308 selection (because that's handled in the GUI code directly).
5309
5310 The 'mousemodel' option is set by the |:behave| command.
5311
5312 *'mouseshape'* *'mouses'* *E547*
Bram Moolenaarf6b40102019-02-22 15:24:03 +01005313'mouseshape' 'mouses' string (default "i-r:beam,s:updown,sd:udsizing,
5314 vs:leftright,vd:lrsizing,m:no,
5315 ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005316 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005317 {only available when compiled with the |+mouseshape|
5318 feature}
5319 This option tells Vim what the mouse pointer should look like in
5320 different modes. The option is a comma separated list of parts, much
5321 like used for 'guicursor'. Each part consist of a mode/location-list
5322 and an argument-list:
5323 mode-list:shape,mode-list:shape,..
5324 The mode-list is a dash separated list of these modes/locations:
5325 In a normal window: ~
5326 n Normal mode
5327 v Visual mode
5328 ve Visual mode with 'selection' "exclusive" (same as 'v',
5329 if not specified)
5330 o Operator-pending mode
5331 i Insert mode
5332 r Replace mode
5333
5334 Others: ~
5335 c appending to the command-line
5336 ci inserting in the command-line
5337 cr replacing in the command-line
5338 m at the 'Hit ENTER' or 'More' prompts
5339 ml idem, but cursor in the last line
5340 e any mode, pointer below last window
5341 s any mode, pointer on a status line
5342 sd any mode, while dragging a status line
5343 vs any mode, pointer on a vertical separator line
5344 vd any mode, while dragging a vertical separator line
5345 a everywhere
5346
5347 The shape is one of the following:
5348 avail name looks like ~
5349 w x arrow Normal mouse pointer
5350 w x blank no pointer at all (use with care!)
5351 w x beam I-beam
5352 w x updown up-down sizing arrows
5353 w x leftright left-right sizing arrows
5354 w x busy The system's usual busy pointer
5355 w x no The system's usual 'no input' pointer
5356 x udsizing indicates up-down resizing
5357 x lrsizing indicates left-right resizing
5358 x crosshair like a big thin +
5359 x hand1 black hand
5360 x hand2 white hand
5361 x pencil what you write with
5362 x question big ?
5363 x rightup-arrow arrow pointing right-up
5364 w x up-arrow arrow pointing up
5365 x <number> any X11 pointer number (see X11/cursorfont.h)
5366
5367 The "avail" column contains a 'w' if the shape is available for Win32,
5368 x for X11.
5369 Any modes not specified or shapes not available use the normal mouse
5370 pointer.
5371
5372 Example: >
5373 :set mouseshape=s:udsizing,m:no
5374< will make the mouse turn to a sizing arrow over the status lines and
5375 indicate no input when the hit-enter prompt is displayed (since
5376 clicking the mouse has no effect in this state.)
5377
5378 *'mousetime'* *'mouset'*
5379'mousetime' 'mouset' number (default 500)
5380 global
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005381 Only for GUI, Win32 and Unix with xterm. Defines the maximum
Bram Moolenaar071d4272004-06-13 20:20:40 +00005382 time in msec between two mouse clicks for the second click to be
5383 recognized as a multi click.
5384
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005385 *'mzschemedll'*
5386'mzschemedll' string (default depends on the build)
5387 global
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005388 {only available when compiled with the |+mzscheme/dyn|
5389 feature}
5390 Specifies the name of the MzScheme shared library. The default is
5391 DYNAMIC_MZSCH_DLL which was specified at compile time.
5392 Environment variables are expanded |:set_env|.
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01005393 The value must be set in the |vimrc| script or earlier. In the
Bram Moolenaar01164a62017-11-02 22:58:42 +01005394 startup, before the |load-plugins| step.
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005395 This option cannot be set from a |modeline| or in the |sandbox|, for
5396 security reasons.
5397
5398 *'mzschemegcdll'*
5399'mzschemegcdll' string (default depends on the build)
5400 global
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005401 {only available when compiled with the |+mzscheme/dyn|
5402 feature}
5403 Specifies the name of the MzScheme GC shared library. The default is
5404 DYNAMIC_MZGC_DLL which was specified at compile time.
5405 The value can be equal to 'mzschemedll' if it includes the GC code.
5406 Environment variables are expanded |:set_env|.
5407 This option cannot be set from a |modeline| or in the |sandbox|, for
5408 security reasons.
5409
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005410 *'mzquantum'* *'mzq'*
5411'mzquantum' 'mzq' number (default 100)
5412 global
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005413 {not available when compiled without the |+mzscheme|
5414 feature}
5415 The number of milliseconds between polls for MzScheme threads.
5416 Negative or zero value means no thread scheduling.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005417 NOTE: This option is set to the Vim default value when 'compatible'
5418 is reset.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005419
Bram Moolenaar071d4272004-06-13 20:20:40 +00005420 *'nrformats'* *'nf'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02005421'nrformats' 'nf' string (default "bin,octal,hex",
5422 set to "bin,hex" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005423 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005424 This defines what bases Vim will consider for numbers when using the
5425 CTRL-A and CTRL-X commands for adding to and subtracting from a number
5426 respectively; see |CTRL-A| for more info on these commands.
Bram Moolenaar4770d092006-01-12 23:22:24 +00005427 alpha If included, single alphabetical characters will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005428 incremented or decremented. This is useful for a list with a
Bram Moolenaar3848e002016-03-19 18:42:29 +01005429 letter index a), b), etc. *octal-nrformats*
Bram Moolenaar4770d092006-01-12 23:22:24 +00005430 octal If included, numbers that start with a zero will be considered
Bram Moolenaar071d4272004-06-13 20:20:40 +00005431 to be octal. Example: Using CTRL-A on "007" results in "010".
Bram Moolenaar4770d092006-01-12 23:22:24 +00005432 hex If included, numbers starting with "0x" or "0X" will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005433 considered to be hexadecimal. Example: Using CTRL-X on
5434 "0x100" results in "0x0ff".
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005435 bin If included, numbers starting with "0b" or "0B" will be
5436 considered to be binary. Example: Using CTRL-X on
5437 "0b1000" subtracts one, resulting in "0b0111".
Bram Moolenaaraaad9952020-05-31 15:08:59 +02005438 unsigned If included, numbers are recognized as unsigned. Thus a
5439 leading dash or negative sign won't be considered as part of
5440 the number. Examples:
5441 Using CTRL-X on "2020" in "9-2020" results in "9-2019"
5442 (without "unsigned" it would become "9-2021").
5443 Using CTRL-A on "2020" in "9-2020" results in "9-2021"
5444 (without "unsigned" it would become "9-2019").
Bram Moolenaaracc22402020-06-07 21:07:18 +02005445 Using CTRL-X on "0" or CTRL-A on "18446744073709551615"
5446 (2^64 - 1) has no effect, overflow is prevented.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005447 Numbers which simply begin with a digit in the range 1-9 are always
5448 considered decimal. This also happens for numbers that are not
5449 recognized as octal or hex.
5450
5451 *'number'* *'nu'* *'nonumber'* *'nonu'*
5452'number' 'nu' boolean (default off)
5453 local to window
5454 Print the line number in front of each line. When the 'n' option is
5455 excluded from 'cpoptions' a wrapped line will not use the column of
5456 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005457 The 'numberwidth' option can be used to set the room used for the line
5458 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005459 When a long, wrapped line doesn't start with the first character, '-'
5460 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02005461 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
5462 the number.
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005463 *number_relativenumber*
5464 The 'relativenumber' option changes the displayed number to be
5465 relative to the cursor. Together with 'number' there are these
5466 four combinations (cursor in line 3):
5467
Bram Moolenaar3848e002016-03-19 18:42:29 +01005468 'nonu' 'nu' 'nonu' 'nu'
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005469 'nornu' 'nornu' 'rnu' 'rnu'
5470
5471 |apple | 1 apple | 2 apple | 2 apple
5472 |pear | 2 pear | 1 pear | 1 pear
5473 |nobody | 3 nobody | 0 nobody |3 nobody
5474 |there | 4 there | 1 there | 1 there
Bram Moolenaar071d4272004-06-13 20:20:40 +00005475
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005476 *'numberwidth'* *'nuw'*
5477'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
5478 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005479 {only available when compiled with the |+linebreak|
5480 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005481 Minimal number of columns to use for the line number. Only relevant
Bram Moolenaar64486672010-05-16 15:46:46 +02005482 when the 'number' or 'relativenumber' option is set or printing lines
5483 with a line number. Since one space is always between the number and
5484 the text, there is one less character for the number itself.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005485 The value is the minimum width. A bigger width is used when needed to
Bram Moolenaar64486672010-05-16 15:46:46 +02005486 fit the highest line number in the buffer respectively the number of
5487 rows in the window, depending on whether 'number' or 'relativenumber'
5488 is set. Thus with the Vim default of 4 there is room for a line number
5489 up to 999. When the buffer has 1000 lines five columns will be used.
Bram Moolenaarf8a07122019-07-01 22:06:07 +02005490 The minimum value is 1, the maximum value is 20.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005491 NOTE: This option is set to the Vi default value when 'compatible' is
5492 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005493
Bram Moolenaarf75a9632005-09-13 21:20:47 +00005494 *'omnifunc'* *'ofu'*
5495'omnifunc' 'ofu' string (default: empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00005496 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02005497 {not available when compiled without the |+eval|
Bram Moolenaare2c453d2019-08-21 14:37:09 +02005498 feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00005499 This option specifies a function to be used for Insert mode omni
5500 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
Bram Moolenaar280f1262006-01-30 00:14:18 +00005501 See |complete-functions| for an explanation of how the function is
5502 invoked and what it should return.
Bram Moolenaar043545e2006-10-10 16:44:07 +00005503 This option is usually set by a filetype plugin:
Bram Moolenaar9c102382006-05-03 21:26:49 +00005504 |:filetype-plugin-on|
Bram Moolenaar30b65812012-07-12 22:01:11 +02005505 This option cannot be set from a |modeline| or in the |sandbox|, for
5506 security reasons.
Bram Moolenaare344bea2005-09-01 20:46:49 +00005507
5508
Bram Moolenaar02467872007-05-06 13:22:01 +00005509 *'opendevice'* *'odev'* *'noopendevice'* *'noodev'*
Bram Moolenaar043545e2006-10-10 16:44:07 +00005510'opendevice' 'odev' boolean (default off)
5511 global
Bram Moolenaar6f345a12019-12-17 21:27:18 +01005512 {only for MS-Windows}
Bram Moolenaar043545e2006-10-10 16:44:07 +00005513 Enable reading and writing from devices. This may get Vim stuck on a
5514 device that can be opened but doesn't actually do the I/O. Therefore
5515 it is off by default.
5516 Note that on MS-Windows editing "aux.h", "lpt1.txt" and the like also
5517 result in editing a device.
5518
5519
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005520 *'operatorfunc'* *'opfunc'*
5521'operatorfunc' 'opfunc' string (default: empty)
5522 global
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005523 This option specifies a function to be called by the |g@| operator.
5524 See |:map-operator| for more info and an example.
5525
5526 This option cannot be set from a |modeline| or in the |sandbox|, for
5527 security reasons.
5528
5529
Bram Moolenaar251e1912011-06-19 05:09:16 +02005530 *'osfiletype'* *'oft'*
5531'osfiletype' 'oft' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005532 local to buffer
Bram Moolenaar251e1912011-06-19 05:09:16 +02005533 This option was supported on RISC OS, which has been removed.
5534
Bram Moolenaar071d4272004-06-13 20:20:40 +00005535
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005536 *'packpath'* *'pp'*
5537'packpath' 'pp' string (default: see 'runtimepath')
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005538 Directories used to find packages. See |packages|.
5539
5540
Bram Moolenaar071d4272004-06-13 20:20:40 +00005541 *'paragraphs'* *'para'*
Bram Moolenaar57e48462008-03-12 16:38:55 +00005542'paragraphs' 'para' string (default "IPLPPPQPP TPHPLIPpLpItpplpipbp")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005543 global
5544 Specifies the nroff macros that separate paragraphs. These are pairs
5545 of two letters (see |object-motions|).
5546
5547 *'paste'* *'nopaste'*
5548'paste' boolean (default off)
5549 global
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005550 Put Vim in Paste mode. This is useful if you want to cut or copy
5551 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005552 unexpected effects.
5553 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005554 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00005555 knows about pasting and will mostly do the right thing without 'paste'
5556 being set. The same is true for a terminal where Vim handles the
5557 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00005558 This option is reset when starting the GUI. Thus if you set it in
5559 your .vimrc it will work in a terminal, but not in the GUI. Setting
5560 'paste' in the GUI has side effects: e.g., the Paste toolbar button
5561 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005562 When the 'paste' option is switched on (also when it was already on):
5563 - mapping in Insert mode and Command-line mode is disabled
5564 - abbreviations are disabled
Bram Moolenaar071d4272004-06-13 20:20:40 +00005565 - 'autoindent' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02005566 - 'expandtab' is reset
5567 - 'formatoptions' is used like it is empty
Bram Moolenaar071d4272004-06-13 20:20:40 +00005568 - 'revins' is reset
5569 - 'ruler' is reset
5570 - 'showmatch' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02005571 - 'smartindent' is reset
5572 - 'smarttab' is reset
5573 - 'softtabstop' is set to 0
5574 - 'textwidth' is set to 0
5575 - 'wrapmargin' is set to 0
Bram Moolenaar071d4272004-06-13 20:20:40 +00005576 These options keep their value, but their effect is disabled:
Bram Moolenaar071d4272004-06-13 20:20:40 +00005577 - 'cindent'
Bram Moolenaarca635012015-09-25 20:34:21 +02005578 - 'indentexpr'
5579 - 'lisp'
Bram Moolenaar071d4272004-06-13 20:20:40 +00005580 NOTE: When you start editing another file while the 'paste' option is
5581 on, settings from the modelines or autocommands may change the
5582 settings again, causing trouble when pasting text. You might want to
5583 set the 'paste' option again.
5584 When the 'paste' option is reset the mentioned options are restored to
5585 the value before the moment 'paste' was switched from off to on.
5586 Resetting 'paste' before ever setting it does not have any effect.
5587 Since mapping doesn't work while 'paste' is active, you need to use
5588 the 'pastetoggle' option to toggle the 'paste' option with some key.
5589
5590 *'pastetoggle'* *'pt'*
5591'pastetoggle' 'pt' string (default "")
5592 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005593 When non-empty, specifies the key sequence that toggles the 'paste'
5594 option. This is like specifying a mapping: >
5595 :map {keys} :set invpaste<CR>
5596< Where {keys} is the value of 'pastetoggle'.
5597 The difference is that it will work even when 'paste' is set.
5598 'pastetoggle' works in Insert mode and Normal mode, but not in
5599 Command-line mode.
5600 Mappings are checked first, thus overrule 'pastetoggle'. However,
5601 when 'paste' is on mappings are ignored in Insert mode, thus you can do
5602 this: >
5603 :map <F10> :set paste<CR>
5604 :map <F11> :set nopaste<CR>
5605 :imap <F10> <C-O>:set paste<CR>
5606 :imap <F11> <nop>
5607 :set pastetoggle=<F11>
5608< This will make <F10> start paste mode and <F11> stop paste mode.
5609 Note that typing <F10> in paste mode inserts "<F10>", since in paste
5610 mode everything is inserted literally, except the 'pastetoggle' key
5611 sequence.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005612 When the value has several bytes 'ttimeoutlen' applies.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005613
5614 *'pex'* *'patchexpr'*
5615'patchexpr' 'pex' string (default "")
5616 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005617 {not available when compiled without the |+diff|
5618 feature}
5619 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005620 the resulting new version of the file. See |diff-patchexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005621
Bram Moolenaardbc28022014-07-26 13:40:44 +02005622 *'patchmode'* *'pm'* *E205* *E206*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005623'patchmode' 'pm' string (default "")
5624 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005625 When non-empty the oldest version of a file is kept. This can be used
5626 to keep the original version of a file if you are changing files in a
5627 source distribution. Only the first time that a file is written a
5628 copy of the original file will be kept. The name of the copy is the
5629 name of the original file with the string in the 'patchmode' option
5630 appended. This option should start with a dot. Use a string like
Bram Moolenaardf980db2017-12-24 13:22:00 +01005631 ".orig" or ".org". 'backupdir' must not be empty for this to work
5632 (Detail: The backup file is renamed to the patchmode file after the
5633 new file has been successfully written, that's why it must be possible
5634 to write a backup file). If there was no file to be backed up, an
5635 empty file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005636 When the 'backupskip' pattern matches, a patchmode file is not made.
5637 Using 'patchmode' for compressed files appends the extension at the
5638 end (e.g., "file.gz.orig"), thus the resulting name isn't always
5639 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005640 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005641
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01005642 *'path'* *'pa'* *E343* *E345* *E347* *E854*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005643'path' 'pa' string (default on Unix: ".,/usr/include,,"
Bram Moolenaar071d4272004-06-13 20:20:40 +00005644 other systems: ".,,")
5645 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005646 This is a list of directories which will be searched when using the
Bram Moolenaarc236c162008-07-13 17:41:49 +00005647 |gf|, [f, ]f, ^Wf, |:find|, |:sfind|, |:tabfind| and other commands,
5648 provided that the file being searched for has a relative path (not
5649 starting with "/", "./" or "../"). The directories in the 'path'
5650 option may be relative or absolute.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005651 - Use commas to separate directory names: >
5652 :set path=.,/usr/local/include,/usr/include
5653< - Spaces can also be used to separate directory names (for backwards
5654 compatibility with version 3.0). To have a space in a directory
5655 name, precede it with an extra backslash, and escape the space: >
5656 :set path=.,/dir/with\\\ space
5657< - To include a comma in a directory name precede it with an extra
5658 backslash: >
5659 :set path=.,/dir/with\\,comma
5660< - To search relative to the directory of the current file, use: >
5661 :set path=.
5662< - To search in the current directory use an empty string between two
5663 commas: >
5664 :set path=,,
5665< - A directory name may end in a ':' or '/'.
5666 - Environment variables are expanded |:set_env|.
5667 - When using |netrw.vim| URLs can be used. For example, adding
5668 "http://www.vim.org" will make ":find index.html" work.
Bram Moolenaarc236c162008-07-13 17:41:49 +00005669 - Search upwards and downwards in a directory tree using "*", "**" and
5670 ";". See |file-searching| for info and syntax.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005671 {not available when compiled without the |+path_extra| feature}
5672 - Careful with '\' characters, type two to get one in the option: >
5673 :set path=.,c:\\include
5674< Or just use '/' instead: >
5675 :set path=.,c:/include
5676< Don't forget "." or files won't even be found in the same directory as
5677 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005678 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00005679 it is something like 256 or 1024 characters.
5680 You can check if all the include files are found, using the value of
5681 'path', see |:checkpath|.
5682 The use of |:set+=| and |:set-=| is preferred when adding or removing
5683 directories from the list. This avoids problems when a future version
5684 uses another default. To remove the current directory use: >
5685 :set path-=
5686< To add the current directory use: >
5687 :set path+=
5688< To use an environment variable, you probably need to replace the
5689 separator. Here is an example to append $INCL, in which directory
5690 names are separated with a semi-colon: >
5691 :let &path = &path . "," . substitute($INCL, ';', ',', 'g')
5692< Replace the ';' with a ':' or whatever separator is used. Note that
5693 this doesn't work when $INCL contains a comma or white space.
5694
Bram Moolenaar37c64c72017-09-19 22:06:03 +02005695 *'perldll'*
5696'perldll' string (default depends on the build)
5697 global
Bram Moolenaar37c64c72017-09-19 22:06:03 +02005698 {only available when compiled with the |+perl/dyn|
5699 feature}
5700 Specifies the name of the Perl shared library. The default is
5701 DYNAMIC_PERL_DLL, which was specified at compile time.
5702 Environment variables are expanded |:set_env|.
5703 This option cannot be set from a |modeline| or in the |sandbox|, for
5704 security reasons.
5705
Bram Moolenaar071d4272004-06-13 20:20:40 +00005706 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
5707'preserveindent' 'pi' boolean (default off)
5708 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005709 When changing the indent of the current line, preserve as much of the
5710 indent structure as possible. Normally the indent is replaced by a
5711 series of tabs followed by spaces as required (unless |'expandtab'| is
5712 enabled, in which case only spaces are used). Enabling this option
5713 means the indent will preserve as many existing characters as possible
5714 for indenting, and only add additional tabs or spaces as required.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005715 'expandtab' does not apply to the preserved white space, a Tab remains
5716 a Tab.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005717 NOTE: When using ">>" multiple times the resulting indent is a mix of
5718 tabs and spaces. You might not like this.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005719 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005720 Also see 'copyindent'.
5721 Use |:retab| to clean up white space.
5722
5723 *'previewheight'* *'pvh'*
5724'previewheight' 'pvh' number (default 12)
5725 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02005726 {not available when compiled without the |+quickfix|
5727 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005728 Default height for a preview window. Used for |:ptag| and associated
Bram Moolenaar79648732019-07-18 21:43:07 +02005729 commands. Used for |CTRL-W_}| when no count is given. Not used when
5730 'previewpopup' is set.
5731
5732 *'previewpopup'* *'pvp'*
5733'previewpopup' 'pvp' string (default empty)
5734 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02005735 {not available when compiled without the |+textprop|
5736 or |+quickfix| feature}
Bram Moolenaar79648732019-07-18 21:43:07 +02005737 When not empty a popup window is used for commands that would open a
5738 preview window. See |preview-popup|.
Bram Moolenaar576a4a62019-08-18 15:25:17 +02005739 Not used for the insert completion info, add "popup" to
5740 'completeopt' for that.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005741
5742 *'previewwindow'* *'nopreviewwindow'*
5743 *'pvw'* *'nopvw'* *E590*
5744'previewwindow' 'pvw' boolean (default off)
5745 local to window
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02005746 {not available when compiled without the |+quickfix|
5747 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005748 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00005749 set. It's normally not set directly, but by using one of the commands
5750 |:ptag|, |:pedit|, etc.
5751
5752 *'printdevice'* *'pdev'*
5753'printdevice' 'pdev' string (default empty)
5754 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005755 {only available when compiled with the |+printer|
5756 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005757 The name of the printer to be used for |:hardcopy|.
5758 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005759 This option cannot be set from a |modeline| or in the |sandbox|, for
5760 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005761
Bram Moolenaar8299df92004-07-10 09:47:34 +00005762 *'printencoding'* *'penc'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005763'printencoding' 'penc' string (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005764 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005765 {only available when compiled with the |+printer|
5766 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005767 Sets the character encoding used when printing.
5768 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005769
5770 *'printexpr'* *'pexpr'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005771'printexpr' 'pexpr' string (default: see below)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005772 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005773 {only available when compiled with the |+printer|
5774 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005775 Expression used to print the PostScript produced with |:hardcopy|.
5776 See |pexpr-option|.
Bram Moolenaar51628222016-12-01 23:03:28 +01005777 This option cannot be set from a |modeline| or in the |sandbox|, for
5778 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005779
Bram Moolenaar8299df92004-07-10 09:47:34 +00005780 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005781'printfont' 'pfn' string (default "courier")
5782 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005783 {only available when compiled with the |+printer|
5784 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005785 The name of the font that will be used for |:hardcopy|.
5786 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005787
5788 *'printheader'* *'pheader'*
5789'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
5790 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005791 {only available when compiled with the |+printer|
5792 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005793 The format of the header produced in |:hardcopy| output.
5794 See |pheader-option|.
5795
5796 *'printmbcharset'* *'pmbcs'*
5797'printmbcharset' 'pmbcs' string (default "")
5798 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01005799 {only available when compiled with the |+printer|
5800 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005801 The CJK character set to be used for CJK output from |:hardcopy|.
5802 See |pmbcs-option|.
5803
5804 *'printmbfont'* *'pmbfn'*
5805'printmbfont' 'pmbfn' string (default "")
5806 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01005807 {only available when compiled with the |+printer|
5808 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005809 List of font names to be used for CJK output from |:hardcopy|.
5810 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005811
5812 *'printoptions'* *'popt'*
5813'printoptions' 'popt' string (default "")
5814 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005815 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005816 List of items that control the format of the output of |:hardcopy|.
5817 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005818
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005819 *'prompt'* *'noprompt'*
5820'prompt' boolean (default on)
5821 global
5822 When on a ":" prompt is used in Ex mode.
5823
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005824 *'pumheight'* *'ph'*
5825'pumheight' 'ph' number (default 0)
5826 global
Bram Moolenaar06a89a52006-04-29 22:01:03 +00005827 Determines the maximum number of items to show in the popup menu for
5828 Insert mode completion. When zero as much space as available is used.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005829 |ins-completion-menu|.
5830
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01005831 *'pumwidth'* *'pw'*
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005832'pumwidth' 'pw' number (default 15)
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01005833 global
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01005834 Determines the minimum width to use for the popup menu for Insert mode
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005835 completion. |ins-completion-menu|.
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01005836
Bram Moolenaard94464e2015-11-02 15:28:18 +01005837 *'pythondll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01005838'pythondll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01005839 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01005840 {only available when compiled with the |+python/dyn|
5841 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005842 Specifies the name of the Python 2.x shared library. The default is
5843 DYNAMIC_PYTHON_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005844 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01005845 This option cannot be set from a |modeline| or in the |sandbox|, for
5846 security reasons.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005847
Bram Moolenaar94073162018-01-31 21:49:05 +01005848 *'pythonhome'*
5849'pythonhome' string (default "")
5850 global
Bram Moolenaar94073162018-01-31 21:49:05 +01005851 {only available when compiled with the |+python/dyn|
5852 feature}
5853 Specifies the name of the Python 2.x home directory. When 'pythonhome'
5854 and the PYTHONHOME environment variable are not set, PYTHON_HOME,
5855 which was specified at compile time, will be used for the Python 2.x
5856 home directory.
5857 Environment variables are expanded |:set_env|.
5858 This option cannot be set from a |modeline| or in the |sandbox|, for
5859 security reasons.
5860
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005861 *'pythonthreedll'*
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005862'pythonthreedll' string (default depends on the build)
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005863 global
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005864 {only available when compiled with the |+python3/dyn|
5865 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005866 Specifies the name of the Python 3 shared library. The default is
5867 DYNAMIC_PYTHON3_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005868 Environment variables are expanded |:set_env|.
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005869 This option cannot be set from a |modeline| or in the |sandbox|, for
5870 security reasons.
5871
Bram Moolenaar94073162018-01-31 21:49:05 +01005872 *'pythonthreehome'*
5873'pythonthreehome' string (default "")
5874 global
Bram Moolenaar94073162018-01-31 21:49:05 +01005875 {only available when compiled with the |+python3/dyn|
5876 feature}
5877 Specifies the name of the Python 3 home directory. When
5878 'pythonthreehome' and the PYTHONHOME environment variable are not set,
5879 PYTHON3_HOME, which was specified at compile time, will be used for
5880 the Python 3 home directory.
5881 Environment variables are expanded |:set_env|.
5882 This option cannot be set from a |modeline| or in the |sandbox|, for
5883 security reasons.
5884
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01005885 *'pyxversion'* *'pyx'*
5886'pyxversion' 'pyx' number (default depends on the build)
5887 global
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01005888 {only available when compiled with the |+python| or
5889 the |+python3| feature}
5890 Specifies the python version used for pyx* functions and commands
5891 |python_x|. The default value is as follows:
5892
5893 Compiled with Default ~
5894 |+python| and |+python3| 0
5895 only |+python| 2
5896 only |+python3| 3
5897
5898 Available values are 0, 2 and 3.
5899 If 'pyxversion' is 0, it is set to 2 or 3 after the first execution of
5900 any python2/3 commands or functions. E.g. `:py` sets to 2, and `:py3`
5901 sets to 3. `:pyx` sets it to 3 if Python 3 is available, otherwise sets
5902 to 2 if Python 2 is available.
5903 See also: |has-pythonx|
5904
5905 If Vim is compiled with only |+python| or |+python3| setting
5906 'pyxversion' has no effect. The pyx* functions and commands are
5907 always the same as the compiled version.
5908
5909 This option cannot be set from a |modeline| or in the |sandbox|, for
5910 security reasons.
5911
Bram Moolenaar858ba062020-05-31 23:11:59 +02005912 *'quickfixtextfunc'* *'qftf'*
5913'quickfixtextfunc' 'qftf' string (default "")
5914 global
5915 {only available when compiled with the |+quickfix|
5916 feature}
5917 This option specifies a function to be used to get the text to display
5918 in the quickfix and location list windows. This can be used to
5919 customize the information displayed in the quickfix or location window
5920 for each entry in the corresponding quickfix or location list. See
5921 |quickfix-window-function| for an explanation of how to write the
Bram Moolenaard43906d2020-07-20 21:31:32 +02005922 function and an example. The value can be the name of a function or a
5923 lambda.
Bram Moolenaar858ba062020-05-31 23:11:59 +02005924
5925 This option cannot be set from a |modeline| or in the |sandbox|, for
5926 security reasons.
5927
Bram Moolenaar677ee682005-01-27 14:41:15 +00005928 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005929'quoteescape' 'qe' string (default "\")
5930 local to buffer
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005931 The characters that are used to escape quotes in a string. Used for
5932 objects like a', a" and a` |a'|.
5933 When one of the characters in this option is found inside a string,
5934 the following character will be skipped. The default value makes the
5935 text "foo\"bar\\" considered to be one string.
5936
Bram Moolenaar071d4272004-06-13 20:20:40 +00005937 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
5938'readonly' 'ro' boolean (default off)
5939 local to buffer
5940 If on, writes fail unless you use a '!'. Protects you from
5941 accidentally overwriting a file. Default on when Vim is started
5942 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005943 When using ":w!" the 'readonly' option is reset for the current
5944 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar6c60f472019-04-28 16:00:35 +02005945 When using the ":view" command the 'readonly' option is set for the
5946 newly edited buffer.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01005947 See 'modifiable' for disallowing changes to the buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005948
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005949 *'redrawtime'* *'rdt'*
5950'redrawtime' 'rdt' number (default 2000)
5951 global
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005952 {only available when compiled with the |+reltime|
5953 feature}
5954 The time in milliseconds for redrawing the display. This applies to
Bram Moolenaar15142e22018-04-30 22:19:58 +02005955 searching for patterns for 'hlsearch', |:match| highlighting and syntax
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02005956 highlighting.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005957 When redrawing takes more than this many milliseconds no further
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02005958 matches will be highlighted.
5959 For syntax highlighting the time applies per window. When over the
5960 limit syntax highlighting is disabled until |CTRL-L| is used.
5961 This is used to avoid that Vim hangs when using a very complicated
5962 pattern.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005963
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02005964 *'regexpengine'* *'re'*
Bram Moolenaare6ae6222013-05-21 21:01:10 +02005965'regexpengine' 're' number (default 0)
5966 global
Bram Moolenaare6ae6222013-05-21 21:01:10 +02005967 This selects the default regexp engine. |two-engines|
5968 The possible values are:
5969 0 automatic selection
5970 1 old engine
5971 2 NFA engine
5972 Note that when using the NFA engine and the pattern contains something
5973 that is not supported the pattern will not match. This is only useful
5974 for debugging the regexp engine.
Bram Moolenaarfda37292014-11-05 14:27:36 +01005975 Using automatic selection enables Vim to switch the engine, if the
5976 default engine becomes too costly. E.g., when the NFA engine uses too
5977 many states. This should prevent Vim from hanging on a combination of
5978 a complex pattern with long text.
Bram Moolenaare6ae6222013-05-21 21:01:10 +02005979
Bram Moolenaar64486672010-05-16 15:46:46 +02005980 *'relativenumber'* *'rnu'* *'norelativenumber'* *'nornu'*
5981'relativenumber' 'rnu' boolean (default off)
5982 local to window
Bram Moolenaar64486672010-05-16 15:46:46 +02005983 Show the line number relative to the line with the cursor in front of
Bram Moolenaar06b5d512010-05-22 15:37:44 +02005984 each line. Relative line numbers help you use the |count| you can
Bram Moolenaar64486672010-05-16 15:46:46 +02005985 precede some vertical motion commands (e.g. j k + -) with, without
5986 having to calculate it yourself. Especially useful in combination with
5987 other commands (e.g. y d c < > gq gw =).
5988 When the 'n' option is excluded from 'cpoptions' a wrapped
5989 line will not use the column of line numbers (this is the default when
5990 'compatible' isn't set).
5991 The 'numberwidth' option can be used to set the room used for the line
5992 number.
5993 When a long, wrapped line doesn't start with the first character, '-'
5994 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02005995 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
5996 the number.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01005997
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005998 The number in front of the cursor line also depends on the value of
5999 'number', see |number_relativenumber| for all combinations of the two
6000 options.
Bram Moolenaar64486672010-05-16 15:46:46 +02006001
Bram Moolenaar071d4272004-06-13 20:20:40 +00006002 *'remap'* *'noremap'*
6003'remap' boolean (default on)
6004 global
6005 Allows for mappings to work recursively. If you do not want this for
6006 a single entry, use the :noremap[!] command.
Bram Moolenaara3227e22006-03-08 21:32:40 +00006007 NOTE: To avoid portability problems with Vim scripts, always keep
6008 this option at the default "on". Only switch it off when working with
6009 old Vi scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006010
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006011 *'renderoptions'* *'rop'*
6012'renderoptions' 'rop' string (default: empty)
6013 global
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006014 {only available when compiled with GUI and DIRECTX on
6015 MS-Windows}
6016 Select a text renderer and set its options. The options depend on the
6017 renderer.
6018
6019 Syntax: >
6020 set rop=type:{renderer}(,{name}:{value})*
6021<
6022 Currently, only one optional renderer is available.
6023
6024 render behavior ~
6025 directx Vim will draw text using DirectX (DirectWrite). It makes
6026 drawn glyphs more beautiful than default GDI.
6027 It requires 'encoding' is "utf-8", and only works on
6028 MS-Windows Vista or newer version.
6029
6030 Options:
6031 name meaning type value ~
6032 gamma gamma float 1.0 - 2.2 (maybe)
6033 contrast enhancedContrast float (unknown)
6034 level clearTypeLevel float (unknown)
6035 geom pixelGeometry int 0 - 2 (see below)
6036 renmode renderingMode int 0 - 6 (see below)
6037 taamode textAntialiasMode int 0 - 3 (see below)
Bram Moolenaara338adc2018-01-31 20:51:47 +01006038 scrlines Scroll Lines int (deprecated)
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006039
Bram Moolenaar92467d32017-12-05 13:22:16 +01006040 See this URL for detail (except for scrlines):
6041 https://msdn.microsoft.com/en-us/library/dd368190.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006042
6043 For geom: structure of a device pixel.
6044 0 - DWRITE_PIXEL_GEOMETRY_FLAT
6045 1 - DWRITE_PIXEL_GEOMETRY_RGB
6046 2 - DWRITE_PIXEL_GEOMETRY_BGR
6047
6048 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006049 https://msdn.microsoft.com/en-us/library/dd368114.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006050
6051 For renmode: method of rendering glyphs.
6052 0 - DWRITE_RENDERING_MODE_DEFAULT
6053 1 - DWRITE_RENDERING_MODE_ALIASED
6054 2 - DWRITE_RENDERING_MODE_GDI_CLASSIC
6055 3 - DWRITE_RENDERING_MODE_GDI_NATURAL
6056 4 - DWRITE_RENDERING_MODE_NATURAL
6057 5 - DWRITE_RENDERING_MODE_NATURAL_SYMMETRIC
6058 6 - DWRITE_RENDERING_MODE_OUTLINE
6059
6060 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006061 https://msdn.microsoft.com/en-us/library/dd368118.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006062
6063 For taamode: antialiasing mode used for drawing text.
6064 0 - D2D1_TEXT_ANTIALIAS_MODE_DEFAULT
6065 1 - D2D1_TEXT_ANTIALIAS_MODE_CLEARTYPE
6066 2 - D2D1_TEXT_ANTIALIAS_MODE_GRAYSCALE
6067 3 - D2D1_TEXT_ANTIALIAS_MODE_ALIASED
6068
6069 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006070 https://msdn.microsoft.com/en-us/library/dd368170.aspx
6071
Bram Moolenaara338adc2018-01-31 20:51:47 +01006072 For scrlines:
6073 This was used for optimizing scrolling behavior, however this
6074 is now deprecated. If specified, it is simply ignored.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006075
6076 Example: >
6077 set encoding=utf-8
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006078 set gfn=Ricty_Diminished:h12
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006079 set rop=type:directx
6080<
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006081 If select a raster font (Courier, Terminal or FixedSys which
6082 have ".fon" extension in file name) to 'guifont', it will be
Bram Moolenaar92467d32017-12-05 13:22:16 +01006083 drawn by GDI as a fallback.
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006084
6085 NOTE: It is known that some fonts and options combination
6086 causes trouble on drawing glyphs.
6087
Bram Moolenaar92467d32017-12-05 13:22:16 +01006088 - 'renmode:5' and 'renmode:6' will not work with some
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006089 special made fonts (True-Type fonts which includes only
6090 bitmap glyphs).
6091 - 'taamode:3' will not work with some vector fonts.
6092
6093 NOTE: With this option, you can display colored emoji
6094 (emoticon) in Windows 8.1 or later. To display colored emoji,
6095 there are some conditions which you should notice.
6096
6097 - If your font includes non-colored emoji already, it will
6098 be used.
6099 - If your font doesn't have emoji, the system chooses an
6100 alternative symbol font. On Windows 10, "Segoe UI Emoji"
6101 will be used.
6102 - When this alternative font didn't have fixed width glyph,
6103 emoji might be rendered beyond the bounding box of drawing
6104 cell.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006105
6106 Other render types are currently not supported.
6107
Bram Moolenaar071d4272004-06-13 20:20:40 +00006108 *'report'*
6109'report' number (default 2)
6110 global
6111 Threshold for reporting number of lines changed. When the number of
6112 changed lines is more than 'report' a message will be given for most
6113 ":" commands. If you want it always, set 'report' to 0.
6114 For the ":substitute" command the number of substitutions is used
6115 instead of the number of lines.
6116
6117 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
6118'restorescreen' 'rs' boolean (default on)
6119 global
Bram Moolenaar8024f932020-01-14 19:29:13 +01006120 {only in MS-Windows console version}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006121 When set, the screen contents is restored when exiting Vim. This also
6122 happens when executing external commands.
6123
6124 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
6125 options in your .vimrc. To disable restoring:
6126 set t_ti= t_te=
6127 To enable restoring (for an xterm):
6128 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
6129 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
6130
6131 *'revins'* *'ri'* *'norevins'* *'nori'*
6132'revins' 'ri' boolean (default off)
6133 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006134 {only available when compiled with the |+rightleft|
6135 feature}
6136 Inserting characters in Insert mode will work backwards. See "typing
6137 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
6138 command in Insert mode, when 'allowrevins' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02006139 NOTE: This option is reset when 'compatible' is set.
6140 This option is reset when 'paste' is set and restored when 'paste' is
6141 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006142
6143 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
6144'rightleft' 'rl' boolean (default off)
6145 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006146 {only available when compiled with the |+rightleft|
6147 feature}
6148 When on, display orientation becomes right-to-left, i.e., characters
6149 that are stored in the file appear from the right to the left.
6150 Using this option, it is possible to edit files for languages that
6151 are written from the right to the left such as Hebrew and Arabic.
6152 This option is per window, so it is possible to edit mixed files
6153 simultaneously, or to view the same file in both ways (this is
6154 useful whenever you have a mixed text file with both right-to-left
6155 and left-to-right strings so that both sets are displayed properly
6156 in different windows). Also see |rileft.txt|.
6157
Bram Moolenaar607cc1e2010-07-18 18:47:44 +02006158 *'rightleftcmd'* *'rlc'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006159'rightleftcmd' 'rlc' string (default "search")
6160 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006161 {only available when compiled with the |+rightleft|
6162 feature}
6163 Each word in this option enables the command line editing to work in
6164 right-to-left mode for a group of commands:
6165
6166 search "/" and "?" commands
6167
6168 This is useful for languages such as Hebrew, Arabic and Farsi.
6169 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
6170
Bram Moolenaard94464e2015-11-02 15:28:18 +01006171 *'rubydll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01006172'rubydll' string (default: depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01006173 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01006174 {only available when compiled with the |+ruby/dyn|
6175 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006176 Specifies the name of the Ruby shared library. The default is
6177 DYNAMIC_RUBY_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006178 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01006179 This option cannot be set from a |modeline| or in the |sandbox|, for
6180 security reasons.
6181
Bram Moolenaar071d4272004-06-13 20:20:40 +00006182 *'ruler'* *'ru'* *'noruler'* *'noru'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02006183'ruler' 'ru' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006184 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006185 {not available when compiled without the
6186 |+cmdline_info| feature}
6187 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006188 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00006189 text in the file is shown on the far right:
6190 Top first line is visible
6191 Bot last line is visible
6192 All first and last line are visible
6193 45% relative position in the file
6194 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006195 Each window has its own ruler. If a window has a status line, the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006196 ruler is shown there. Otherwise it is shown in the last line of the
Bram Moolenaar582fd852005-03-28 20:58:01 +00006197 screen. If the statusline is given by 'statusline' (i.e. not empty),
Bram Moolenaar071d4272004-06-13 20:20:40 +00006198 this option takes precedence over 'ruler' and 'rulerformat'
6199 If the number of characters displayed is different from the number of
6200 bytes in the text (e.g., for a TAB or a multi-byte character), both
6201 the text column (byte number) and the screen column are shown,
6202 separated with a dash.
6203 For an empty line "0-1" is shown.
6204 For an empty buffer the line number will also be zero: "0,0-1".
Bram Moolenaarca635012015-09-25 20:34:21 +02006205 This option is reset when 'paste' is set and restored when 'paste' is
6206 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006207 If you don't want to see the ruler all the time but want to know where
6208 you are, use "g CTRL-G" |g_CTRL-G|.
6209 NOTE: This option is reset when 'compatible' is set.
6210
6211 *'rulerformat'* *'ruf'*
6212'rulerformat' 'ruf' string (default empty)
6213 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006214 {not available when compiled without the |+statusline|
6215 feature}
6216 When this option is not empty, it determines the content of the ruler
6217 string, as displayed for the 'ruler' option.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00006218 The format of this option is like that of 'statusline'.
Bram Moolenaar110289e2019-05-23 15:38:06 +02006219 This option cannot be set in a modeline when 'modelineexpr' is off.
6220
Bram Moolenaar071d4272004-06-13 20:20:40 +00006221 The default ruler width is 17 characters. To make the ruler 15
6222 characters wide, put "%15(" at the start and "%)" at the end.
6223 Example: >
6224 :set rulerformat=%15(%c%V\ %p%%%)
6225<
6226 *'runtimepath'* *'rtp'* *vimfiles*
6227'runtimepath' 'rtp' string (default:
6228 Unix: "$HOME/.vim,
6229 $VIM/vimfiles,
6230 $VIMRUNTIME,
6231 $VIM/vimfiles/after,
6232 $HOME/.vim/after"
6233 Amiga: "home:vimfiles,
6234 $VIM/vimfiles,
6235 $VIMRUNTIME,
6236 $VIM/vimfiles/after,
6237 home:vimfiles/after"
Bram Moolenaar6f345a12019-12-17 21:27:18 +01006238 PC: "$HOME/vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006239 $VIM/vimfiles,
6240 $VIMRUNTIME,
6241 $VIM/vimfiles/after,
6242 $HOME/vimfiles/after"
6243 Macintosh: "$VIM:vimfiles,
6244 $VIMRUNTIME,
6245 $VIM:vimfiles:after"
Bram Moolenaarb3f74062020-02-26 16:16:53 +01006246 Haiku: "$BE_USER_SETTINGS/vim,
6247 $VIM/vimfiles,
6248 $VIMRUNTIME,
6249 $VIM/vimfiles/after,
6250 $BE_USER_SETTINGS/vim/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006251 VMS: "sys$login:vimfiles,
6252 $VIM/vimfiles,
6253 $VIMRUNTIME,
6254 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00006255 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006256 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006257 This is a list of directories which will be searched for runtime
6258 files:
6259 filetype.vim filetypes by file name |new-filetype|
6260 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006261 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006262 colors/ color scheme files |:colorscheme|
6263 compiler/ compiler files |:compiler|
6264 doc/ documentation |write-local-help|
6265 ftplugin/ filetype plugins |write-filetype-plugin|
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01006266 import/ files that are found by `:import`
Bram Moolenaar071d4272004-06-13 20:20:40 +00006267 indent/ indent scripts |indent-expression|
6268 keymap/ key mapping files |mbyte-keymap|
6269 lang/ menu translations |:menutrans|
6270 menu.vim GUI menus |menu.vim|
Bram Moolenaar26852122016-05-24 20:02:38 +02006271 pack/ packages |:packadd|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006272 plugin/ plugin scripts |write-plugin|
6273 print/ files for printing |postscript-print-encoding|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006274 spell/ spell checking files |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006275 syntax/ syntax files |mysyntaxfile|
6276 tutor/ files for vimtutor |tutor|
6277
6278 And any other file searched for with the |:runtime| command.
6279
6280 The defaults for most systems are setup to search five locations:
6281 1. In your home directory, for your personal preferences.
6282 2. In a system-wide Vim directory, for preferences from the system
6283 administrator.
6284 3. In $VIMRUNTIME, for files distributed with Vim.
6285 *after-directory*
6286 4. In the "after" directory in the system-wide Vim directory. This is
6287 for the system administrator to overrule or add to the distributed
6288 defaults (rarely needed)
6289 5. In the "after" directory in your home directory. This is for
6290 personal preferences to overrule or add to the distributed defaults
6291 or system-wide settings (rarely needed).
6292
Bram Moolenaard0796902016-09-16 20:02:31 +02006293 More entries are added when using |packages|. If it gets very long
6294 then `:set rtp` will be truncated, use `:echo &rtp` to see the full
6295 string.
Bram Moolenaar26852122016-05-24 20:02:38 +02006296
Bram Moolenaar071d4272004-06-13 20:20:40 +00006297 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
6298 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006299 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00006300 wildcards.
6301 See |:runtime|.
6302 Example: >
6303 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
6304< This will use the directory "~/vimruntime" first (containing your
6305 personal Vim runtime files), then "/mygroup/vim" (shared between a
6306 group of people) and finally "$VIMRUNTIME" (the distributed runtime
6307 files).
6308 You probably should always include $VIMRUNTIME somewhere, to use the
6309 distributed runtime files. You can put a directory before $VIMRUNTIME
6310 to find files which replace a distributed runtime files. You can put
6311 a directory after $VIMRUNTIME to find files which add to distributed
6312 runtime files.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006313 When Vim is started with |--clean| the home directory entries are not
6314 included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006315 This option cannot be set from a |modeline| or in the |sandbox|, for
6316 security reasons.
6317
6318 *'scroll'* *'scr'*
6319'scroll' 'scr' number (default: half the window height)
6320 local to window
6321 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
6322 set to half the number of lines in the window when the window size
6323 changes. If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006324 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar25c9c682019-05-05 18:13:34 +02006325 height with ":set scroll=0".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006326
6327 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
6328'scrollbind' 'scb' boolean (default off)
6329 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006330 See also |scroll-binding|. When this option is set, the current
6331 window scrolls as other scrollbind windows (windows that also have
6332 this option set) scroll. This option is useful for viewing the
6333 differences between two versions of a file, see 'diff'.
6334 See |'scrollopt'| for options that determine how this option should be
6335 interpreted.
6336 This option is mostly reset when splitting a window to edit another
6337 file. This means that ":split | edit file" results in two windows
6338 with scroll-binding, but ":split file" does not.
6339
Bram Moolenaarae20f342019-11-05 21:09:23 +01006340 *'scrollfocus'* *'scf'* *'noscrollfocus'* *'noscf'*
6341'scrollfocus' 'scf' boolean (default off)
6342 global
6343 {only for MS-Windows GUI}
6344 When using the scroll wheel and this option is set, the window under
6345 the mouse pointer is scrolled. With this option off the current
6346 window is scrolled.
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01006347 Systems other than MS-Windows always behave like this option is on.
Bram Moolenaarae20f342019-11-05 21:09:23 +01006348
Bram Moolenaar071d4272004-06-13 20:20:40 +00006349 *'scrolljump'* *'sj'*
6350'scrolljump' 'sj' number (default 1)
6351 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006352 Minimal number of lines to scroll when the cursor gets off the
6353 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
6354 CTRL-D). Useful if your terminal scrolls very slowly.
Bram Moolenaar1e015462005-09-25 22:16:38 +00006355 When set to a negative number from -1 to -100 this is used as the
6356 percentage of the window height. Thus -50 scrolls half the window
6357 height.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006358 NOTE: This option is set to 1 when 'compatible' is set.
6359
6360 *'scrolloff'* *'so'*
Bram Moolenaar50ba5262016-09-22 22:33:02 +02006361'scrolloff' 'so' number (default 0, set to 5 in |defaults.vim|)
Bram Moolenaar375e3392019-01-31 18:26:10 +01006362 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006363 Minimal number of screen lines to keep above and below the cursor.
6364 This will make some context visible around where you are working. If
6365 you set it to a very large value (999) the cursor line will always be
6366 in the middle of the window (except at the start or end of the file or
6367 when long lines wrap).
Bram Moolenaar375e3392019-01-31 18:26:10 +01006368 After using the local value, go back the global value with one of
6369 these two: >
6370 setlocal scrolloff<
6371 setlocal scrolloff=-1
6372< For scrolling horizontally see 'sidescrolloff'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006373 NOTE: This option is set to 0 when 'compatible' is set.
6374
6375 *'scrollopt'* *'sbo'*
6376'scrollopt' 'sbo' string (default "ver,jump")
6377 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006378 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006379 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
6380 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006381 The following words are available:
6382 ver Bind vertical scrolling for 'scrollbind' windows
6383 hor Bind horizontal scrolling for 'scrollbind' windows
6384 jump Applies to the offset between two windows for vertical
6385 scrolling. This offset is the difference in the first
6386 displayed line of the bound windows. When moving
6387 around in a window, another 'scrollbind' window may
6388 reach a position before the start or after the end of
6389 the buffer. The offset is not changed though, when
6390 moving back the 'scrollbind' window will try to scroll
6391 to the desired position when possible.
6392 When now making that window the current one, two
6393 things can be done with the relative offset:
6394 1. When "jump" is not included, the relative offset is
6395 adjusted for the scroll position in the new current
6396 window. When going back to the other window, the
Bram Moolenaar02467872007-05-06 13:22:01 +00006397 new relative offset will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006398 2. When "jump" is included, the other windows are
6399 scrolled to keep the same relative offset. When
6400 going back to the other window, it still uses the
6401 same relative offset.
6402 Also see |scroll-binding|.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006403 When 'diff' mode is active there always is vertical scroll binding,
6404 even when "ver" isn't there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006405
6406 *'sections'* *'sect'*
6407'sections' 'sect' string (default "SHNHH HUnhsh")
6408 global
6409 Specifies the nroff macros that separate sections. These are pairs of
6410 two letters (See |object-motions|). The default makes a section start
6411 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
6412
6413 *'secure'* *'nosecure'* *E523*
6414'secure' boolean (default off)
6415 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006416 When on, ":autocmd", shell and write commands are not allowed in
6417 ".vimrc" and ".exrc" in the current directory and map commands are
6418 displayed. Switch it off only if you know that you will not run into
6419 problems, or when the 'exrc' option is off. On Unix this option is
6420 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006421 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00006422 'secure' at the end of your ~/.vimrc then.
6423 This option cannot be set from a |modeline| or in the |sandbox|, for
6424 security reasons.
6425
6426 *'selection'* *'sel'*
6427'selection' 'sel' string (default "inclusive")
6428 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006429 This option defines the behavior of the selection. It is only used
6430 in Visual and Select mode.
6431 Possible values:
6432 value past line inclusive ~
6433 old no yes
6434 inclusive yes yes
6435 exclusive yes no
6436 "past line" means that the cursor is allowed to be positioned one
6437 character past the line.
6438 "inclusive" means that the last character of the selection is included
6439 in an operation. For example, when "x" is used to delete the
6440 selection.
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02006441 When "old" is used and 'virtualedit' allows the cursor to move past
6442 the end of line the line break still isn't included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006443 Note that when "exclusive" is used and selecting from the end
6444 backwards, you cannot include the last character of a line, when
6445 starting in Normal mode and 'virtualedit' empty.
6446
6447 The 'selection' option is set by the |:behave| command.
6448
6449 *'selectmode'* *'slm'*
6450'selectmode' 'slm' string (default "")
6451 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006452 This is a comma separated list of words, which specifies when to start
6453 Select mode instead of Visual mode, when a selection is started.
6454 Possible values:
6455 mouse when using the mouse
6456 key when using shifted special keys
6457 cmd when using "v", "V" or CTRL-V
6458 See |Select-mode|.
6459 The 'selectmode' option is set by the |:behave| command.
6460
6461 *'sessionoptions'* *'ssop'*
6462'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006463 help,options,tabpages,winsize,terminal")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006464 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02006465 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006466 feature}
6467 Changes the effect of the |:mksession| command. It is a comma
6468 separated list of words. Each word enables saving and restoring
6469 something:
6470 word save and restore ~
6471 blank empty windows
6472 buffers hidden and unloaded buffers, not just those in windows
6473 curdir the current directory
6474 folds manually created folds, opened/closed folds and local
6475 fold options
6476 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00006477 and contain at least one lowercase letter. Only
6478 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006479 help the help window
6480 localoptions options and mappings local to a window or buffer (not
6481 global values for local options)
6482 options all options and mappings (also global values for local
6483 options)
6484 resize size of the Vim window: 'lines' and 'columns'
6485 sesdir the directory in which the session file is located
6486 will become the current directory (useful with
6487 projects accessed over a network from different
6488 systems)
6489 slash backslashes in file names replaced with forward
6490 slashes
Bram Moolenaar18144c82006-04-12 21:52:12 +00006491 tabpages all tab pages; without this only the current tab page
6492 is restored, so that you can make a session for each
6493 tab page separately
Bram Moolenaard473c8c2018-08-11 18:00:22 +02006494 terminal include terminal windows where the command can be
6495 restored
Bram Moolenaar071d4272004-06-13 20:20:40 +00006496 unix with Unix end-of-line format (single <NL>), even when
6497 on Windows or DOS
6498 winpos position of the whole Vim window
6499 winsize window sizes
6500
6501 Don't include both "curdir" and "sesdir".
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006502 When neither "curdir" nor "sesdir" is included, file names are stored
6503 with absolute paths.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006504 "slash" and "unix" are useful on Windows when sharing session files
6505 with Unix. The Unix version of Vim cannot source dos format scripts,
6506 but the Windows version of Vim can source unix format scripts.
6507
6508 *'shell'* *'sh'* *E91*
Bram Moolenaar95a9dd12019-12-19 22:12:03 +01006509'shell' 'sh' string (default $SHELL or "sh", Win32: "cmd.exe")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006510 global
6511 Name of the shell to use for ! and :! commands. When changing the
6512 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
6513 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006514 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006515 See |option-backslash| about including spaces and backslashes.
6516 Environment variables are expanded |:set_env|.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006517
Bram Moolenaar1ff14ba2019-11-02 14:09:23 +01006518 If the name of the shell contains a space, you need to enclose it in
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01006519 quotes and escape the space. Example with quotes: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006520 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
6521< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006522 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006523 "-f" is not inside the quotes, because it is not part of the command
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006524 name. Vim automagically recognizes the backslashes that are path
Bram Moolenaar071d4272004-06-13 20:20:40 +00006525 separators.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006526 Example with escaped space (Vim will do this when initializing the
6527 option from $SHELL): >
6528 :set shell=/bin/with\\\ space/sh
Bram Moolenaard473c8c2018-08-11 18:00:22 +02006529< The resulting value of 'shell' is "/bin/with\ space/sh", two
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006530 backslashes are consumed by `:set`.
6531
Bram Moolenaar071d4272004-06-13 20:20:40 +00006532 Under MS-Windows, when the executable ends in ".com" it must be
6533 included. Thus setting the shell to "command.com" or "4dos.com"
6534 works, but "command" and "4dos" do not work for all commands (e.g.,
6535 filtering).
6536 For unknown reasons, when using "4dos.com" the current directory is
6537 changed to "C:\". To avoid this set 'shell' like this: >
6538 :set shell=command.com\ /c\ 4dos
6539< This option cannot be set from a |modeline| or in the |sandbox|, for
6540 security reasons.
6541
6542 *'shellcmdflag'* *'shcf'*
Bram Moolenaar5dc62522012-02-13 00:05:22 +01006543'shellcmdflag' 'shcf' string (default: "-c";
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006544 Win32, when 'shell' does not contain "sh"
6545 somewhere: "/c")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006546 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006547 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
Bram Moolenaar8024f932020-01-14 19:29:13 +01006548 "bash.exe -c ls" or "cmd.exe /c dir". For MS-Windows, the default is
6549 set according to the value of 'shell', to reduce the need to set this
6550 option by the user.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02006551 On Unix it can have more than one flag. Each white space separated
6552 part is passed as an argument to the shell command.
6553 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006554 Also see |dos-shell| for MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006555 This option cannot be set from a |modeline| or in the |sandbox|, for
6556 security reasons.
6557
6558 *'shellpipe'* *'sp'*
Bram Moolenaar8024f932020-01-14 19:29:13 +01006559'shellpipe' 'sp' string (default ">", ">%s 2>&1", "| tee", "|& tee" or
6560 "2>&1| tee")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006561 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006562 {not available when compiled without the |+quickfix|
6563 feature}
6564 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006565 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00006566 including spaces and backslashes.
6567 The name of the temporary file can be represented by "%s" if necessary
6568 (the file name is appended automatically if no %s appears in the value
6569 of this option).
Bram Moolenaar8024f932020-01-14 19:29:13 +01006570 For the Amiga the default is ">". For MS-Windows the default is
6571 ">%s 2>&1". The output is directly saved in a file and not echoed to
6572 the screen.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006573 For Unix the default it "| tee". The stdout of the compiler is saved
6574 in a file and echoed to the screen. If the 'shell' option is "csh" or
6575 "tcsh" after initializations, the default becomes "|& tee". If the
Bram Moolenaar96f45c02019-10-26 19:53:45 +02006576 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh", "zsh-beta",
6577 "bash" or "fish" the default becomes "2>&1| tee". This means that
6578 stderr is also included. Before using the 'shell' option a path is
6579 removed, thus "/bin/sh" uses "sh".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006580 The initialization of this option is done after reading the ".vimrc"
6581 and the other initializations, so that when the 'shell' option is set
6582 there, the 'shellpipe' option changes automatically, unless it was
6583 explicitly set before.
6584 When 'shellpipe' is set to an empty string, no redirection of the
6585 ":make" output will be done. This is useful if you use a 'makeprg'
6586 that writes to 'makeef' by itself. If you want no piping, but do
6587 want to include the 'makeef', set 'shellpipe' to a single space.
6588 Don't forget to precede the space with a backslash: ":set sp=\ ".
6589 In the future pipes may be used for filtering and this option will
6590 become obsolete (at least for Unix).
6591 This option cannot be set from a |modeline| or in the |sandbox|, for
6592 security reasons.
6593
6594 *'shellquote'* *'shq'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006595'shellquote' 'shq' string (default: ""; Win32, when 'shell'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006596 contains "sh" somewhere: "\"")
6597 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006598 Quoting character(s), put around the command passed to the shell, for
6599 the "!" and ":!" commands. The redirection is kept outside of the
6600 quoting. See 'shellxquote' to include the redirection. It's
6601 probably not useful to set both options.
6602 This is an empty string by default. Only known to be useful for
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006603 third-party shells on MS-Windows-like systems, such as the MKS Korn
6604 Shell or bash, where it should be "\"". The default is adjusted
6605 according the value of 'shell', to reduce the need to set this option
6606 by the user. See |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006607 This option cannot be set from a |modeline| or in the |sandbox|, for
6608 security reasons.
6609
6610 *'shellredir'* *'srr'*
6611'shellredir' 'srr' string (default ">", ">&" or ">%s 2>&1")
6612 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006613 String to be used to put the output of a filter command in a temporary
6614 file. See also |:!|. See |option-backslash| about including spaces
6615 and backslashes.
6616 The name of the temporary file can be represented by "%s" if necessary
6617 (the file name is appended automatically if no %s appears in the value
6618 of this option).
Bram Moolenaar96f45c02019-10-26 19:53:45 +02006619 The default is ">". For Unix, if the 'shell' option is "csh" or
6620 "tcsh" during initializations, the default becomes ">&". If the
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01006621 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh", "zsh-beta",
6622 "bash" or "fish", the default becomes ">%s 2>&1". This means that
6623 stderr is also included. For Win32, the Unix checks are done and
6624 additionally "cmd" is checked for, which makes the default ">%s 2>&1".
6625 Also, the same names with ".exe" appended are checked for.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006626 The initialization of this option is done after reading the ".vimrc"
6627 and the other initializations, so that when the 'shell' option is set
6628 there, the 'shellredir' option changes automatically unless it was
6629 explicitly set before.
6630 In the future pipes may be used for filtering and this option will
6631 become obsolete (at least for Unix).
6632 This option cannot be set from a |modeline| or in the |sandbox|, for
6633 security reasons.
6634
6635 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
6636'shellslash' 'ssl' boolean (default off)
6637 global
Bram Moolenaar6f345a12019-12-17 21:27:18 +01006638 {only for MS-Windows}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006639 When set, a forward slash is used when expanding file names. This is
Bram Moolenaar8024f932020-01-14 19:29:13 +01006640 useful when a Unix-like shell is used instead of cmd.exe. Backward
6641 slashes can still be typed, but they are changed to forward slashes by
6642 Vim.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006643 Note that setting or resetting this option has no effect for some
6644 existing file names, thus this option needs to be set before opening
6645 any file for best results. This might change in the future.
6646 'shellslash' only works when a backslash can be used as a path
6647 separator. To test if this is so use: >
6648 if exists('+shellslash')
Bram Moolenaarac3150d2019-07-28 16:36:39 +02006649< Also see 'completeslash'.
6650
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006651 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
6652'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
6653 global
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006654 When on, use temp files for shell commands. When off use a pipe.
6655 When using a pipe is not possible temp files are used anyway.
Bram Moolenaar97293012011-07-18 19:40:27 +02006656 Currently a pipe is only supported on Unix and MS-Windows 2K and
6657 later. You can check it with: >
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006658 :if has("filterpipe")
6659< The advantage of using a pipe is that nobody can read the temp file
6660 and the 'shell' command does not need to support redirection.
6661 The advantage of using a temp file is that the file type and encoding
6662 can be detected.
6663 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
6664 |FilterWritePost| autocommands event are not triggered when
6665 'shelltemp' is off.
Bram Moolenaar269f5952016-07-15 22:54:41 +02006666 The `system()` function does not respect this option and always uses
6667 temp files.
Bram Moolenaar036986f2017-03-16 17:41:02 +01006668 NOTE: This option is set to the Vim default value when 'compatible'
6669 is reset.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006670
Bram Moolenaar071d4272004-06-13 20:20:40 +00006671 *'shelltype'* *'st'*
6672'shelltype' 'st' number (default 0)
6673 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02006674 {only for the Amiga}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006675 On the Amiga this option influences the way how the commands work
6676 which use a shell.
6677 0 and 1: always use the shell
6678 2 and 3: use the shell only to filter lines
6679 4 and 5: use shell only for ':sh' command
6680 When not using the shell, the command is executed directly.
6681
6682 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
6683 1 and 3: use "shell cmd" to start external commands
6684
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006685 *'shellxescape'* *'sxe'*
6686'shellxescape' 'sxe' string (default: "";
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006687 for MS-Windows: "\"&|<>()@^")
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006688 global
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006689 When 'shellxquote' is set to "(" then the characters listed in this
6690 option will be escaped with a '^' character. This makes it possible
6691 to execute most external commands with cmd.exe.
6692
Bram Moolenaar071d4272004-06-13 20:20:40 +00006693 *'shellxquote'* *'sxq'*
6694'shellxquote' 'sxq' string (default: "";
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006695 for Win32, when 'shell' is cmd.exe: "("
6696 for Win32, when 'shell' contains "sh"
6697 somewhere: "\""
Bram Moolenaar071d4272004-06-13 20:20:40 +00006698 for Unix, when using system(): "\"")
6699 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006700 Quoting character(s), put around the command passed to the shell, for
6701 the "!" and ":!" commands. Includes the redirection. See
6702 'shellquote' to exclude the redirection. It's probably not useful
6703 to set both options.
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006704 When the value is '(' then ')' is appended. When the value is '"('
6705 then ')"' is appended.
6706 When the value is '(' then also see 'shellxescape'.
Bram Moolenaara64ba222012-02-12 23:23:31 +01006707 This is an empty string by default on most systems, but is known to be
6708 useful for on Win32 version, either for cmd.exe which automatically
6709 strips off the first and last quote on a command, or 3rd-party shells
6710 such as the MKS Korn Shell or bash, where it should be "\"". The
6711 default is adjusted according the value of 'shell', to reduce the need
6712 to set this option by the user. See |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006713 This option cannot be set from a |modeline| or in the |sandbox|, for
6714 security reasons.
6715
6716 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
6717'shiftround' 'sr' boolean (default off)
6718 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006719 Round indent to multiple of 'shiftwidth'. Applies to > and <
6720 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
6721 a multiple of 'shiftwidth' (this is Vi compatible).
6722 NOTE: This option is reset when 'compatible' is set.
6723
6724 *'shiftwidth'* *'sw'*
6725'shiftwidth' 'sw' number (default 8)
6726 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006727 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00006728 |'cindent'|, |>>|, |<<|, etc.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02006729 When zero the 'ts' value will be used. Use the |shiftwidth()|
6730 function to get the effective shiftwidth value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006731
6732 *'shortmess'* *'shm'*
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02006733'shortmess' 'shm' string (Vim default "filnxtToOS", Vi default: "S",
6734 POSIX default: "AS")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006735 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006736 This option helps to avoid all the |hit-enter| prompts caused by file
6737 messages, for example with CTRL-G, and to avoid some other messages.
6738 It is a list of flags:
6739 flag meaning when present ~
6740 f use "(3 of 5)" instead of "(file 3 of 5)"
6741 i use "[noeol]" instead of "[Incomplete last line]"
Bram Moolenaar3f40ce72020-07-05 14:10:13 +02006742 l use "999L, 888B" instead of "999 lines, 888 bytes"
Bram Moolenaar071d4272004-06-13 20:20:40 +00006743 m use "[+]" instead of "[Modified]"
6744 n use "[New]" instead of "[New File]"
6745 r use "[RO]" instead of "[readonly]"
6746 w use "[w]" instead of "written" for file write message
6747 and "[a]" instead of "appended" for ':w >> file' command
6748 x use "[dos]" instead of "[dos format]", "[unix]" instead of
6749 "[unix format]" and "[mac]" instead of "[mac format]".
6750 a all of the above abbreviations
6751
6752 o overwrite message for writing a file with subsequent message
6753 for reading a file (useful for ":wn" or when 'autowrite' on)
6754 O message for reading a file overwrites any previous message.
6755 Also for quickfix message (e.g., ":cn").
6756 s don't give "search hit BOTTOM, continuing at TOP" or "search
Bram Moolenaara6c27c42019-05-09 19:16:22 +02006757 hit TOP, continuing at BOTTOM" messages; when using the search
6758 count do not show "W" after the count message (see S below)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006759 t truncate file message at the start if it is too long to fit
6760 on the command-line, "<" will appear in the left most column.
6761 Ignored in Ex mode.
6762 T truncate other messages in the middle if they are too long to
Bram Moolenaar582fd852005-03-28 20:58:01 +00006763 fit on the command line. "..." will appear in the middle.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006764 Ignored in Ex mode.
6765 W don't give "written" or "[w]" when writing a file
6766 A don't give the "ATTENTION" message when an existing swap file
6767 is found.
6768 I don't give the intro message when starting Vim |:intro|.
Bram Moolenaarea389e92014-05-28 21:40:52 +02006769 c don't give |ins-completion-menu| messages. For example,
6770 "-- XXX completion (YYY)", "match 1 of 2", "The only match",
6771 "Pattern not found", "Back at original", etc.
Bram Moolenaar426dd022016-03-15 15:09:29 +01006772 q use "recording" instead of "recording @a"
6773 F don't give the file info when editing a file, like `:silent`
Bram Moolenaar110289e2019-05-23 15:38:06 +02006774 was used for the command; note that this also affects messages
6775 from autocommands
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02006776 S do not show search count message when searching, e.g.
6777 "[1/5]"
Bram Moolenaar071d4272004-06-13 20:20:40 +00006778
6779 This gives you the opportunity to avoid that a change between buffers
6780 requires you to hit <Enter>, but still gives as useful a message as
6781 possible for the space available. To get the whole message that you
6782 would have got with 'shm' empty, use ":file!"
6783 Useful values:
6784 shm= No abbreviation of message.
6785 shm=a Abbreviation, but no loss of information.
6786 shm=at Abbreviation, and truncate message when necessary.
6787
6788 NOTE: This option is set to the Vi default value when 'compatible' is
6789 set and to the Vim default value when 'compatible' is reset.
6790
6791 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
6792'shortname' 'sn' boolean (default off)
6793 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00006794 Filenames are assumed to be 8 characters plus one extension of 3
6795 characters. Multiple dots in file names are not allowed. When this
6796 option is on, dots in file names are replaced with underscores when
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006797 adding an extension (".~" or ".swp"). This option is useful
Bram Moolenaar071d4272004-06-13 20:20:40 +00006798 when editing files on an MS-DOS compatible filesystem, e.g., messydos
Bram Moolenaarade0d392020-01-21 22:33:58 +01006799 or crossdos.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006800
6801 *'showbreak'* *'sbr'* *E595*
6802'showbreak' 'sbr' string (default "")
Bram Moolenaaree857022019-11-09 23:26:40 +01006803 global or local to window |global-local|
Bram Moolenaardb84e452010-08-15 13:50:43 +02006804 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006805 feature}
6806 String to put at the start of lines that have been wrapped. Useful
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006807 values are "> " or "+++ ": >
6808 :set showbreak=>\
6809< Note the backslash to escape the trailing space. It's easier like
6810 this: >
Bram Moolenaar1a384422010-07-14 19:53:30 +02006811 :let &showbreak = '+++ '
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006812< Only printable single-cell characters are allowed, excluding <Tab> and
Bram Moolenaar071d4272004-06-13 20:20:40 +00006813 comma (in a future version the comma might be used to separate the
6814 part that is shown at the end and at the start of a line).
6815 The characters are highlighted according to the '@' flag in
6816 'highlight'.
6817 Note that tabs after the showbreak will be displayed differently.
6818 If you want the 'showbreak' to appear in between line numbers, add the
6819 "n" flag to 'cpoptions'.
Bram Moolenaaree857022019-11-09 23:26:40 +01006820 A window-local value overrules a global value. If the global value is
6821 set and you want no value in the current window use NONE: >
6822 :setlocal showbreak=NONE
6823<
Bram Moolenaar071d4272004-06-13 20:20:40 +00006824 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02006825'showcmd' 'sc' boolean (Vim default: on, off for Unix,
6826 Vi default: off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006827 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006828 {not available when compiled without the
6829 |+cmdline_info| feature}
Bram Moolenaar02467872007-05-06 13:22:01 +00006830 Show (partial) command in the last line of the screen. Set this
6831 option off if your terminal is slow.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006832 In Visual mode the size of the selected area is shown:
6833 - When selecting characters within a line, the number of characters.
Bram Moolenaarf91787c2010-07-17 12:47:16 +02006834 If the number of bytes is different it is also displayed: "2-6"
6835 means two characters and six bytes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006836 - When selecting more than one line, the number of lines.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006837 - When selecting a block, the size in screen characters:
6838 {lines}x{columns}.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006839 NOTE: This option is set to the Vi default value when 'compatible' is
6840 set and to the Vim default value when 'compatible' is reset.
6841
6842 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
6843'showfulltag' 'sft' boolean (default off)
6844 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006845 When completing a word in insert mode (see |ins-completion|) from the
6846 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006847 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00006848 matched a C function, you can see a template for what arguments are
6849 required (coding style permitting).
Bram Moolenaar446cb832008-06-24 21:56:24 +00006850 Note that this doesn't work well together with having "longest" in
6851 'completeopt', because the completion from the search pattern may not
6852 match the typed text.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006853
6854 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
6855'showmatch' 'sm' boolean (default off)
6856 global
6857 When a bracket is inserted, briefly jump to the matching one. The
6858 jump is only done if the match can be seen on the screen. The time to
6859 show the match can be set with 'matchtime'.
6860 A Beep is given if there is no match (no matter if the match can be
Bram Moolenaarca635012015-09-25 20:34:21 +02006861 seen or not).
6862 This option is reset when 'paste' is set and restored when 'paste' is
6863 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006864 When the 'm' flag is not included in 'cpoptions', typing a character
6865 will immediately move the cursor back to where it belongs.
6866 See the "sm" field in 'guicursor' for setting the cursor shape and
6867 blinking when showing the match.
6868 The 'matchpairs' option can be used to specify the characters to show
6869 matches for. 'rightleft' and 'revins' are used to look for opposite
6870 matches.
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006871 Also see the matchparen plugin for highlighting the match when moving
6872 around |pi_paren.txt|.
6873 Note: Use of the short form is rated PG.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006874
6875 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
6876'showmode' 'smd' boolean (Vim default: on, Vi default: off)
6877 global
6878 If in Insert, Replace or Visual mode put a message on the last line.
6879 Use the 'M' flag in 'highlight' to set the type of highlighting for
6880 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006881 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00006882 doesn't mean XIM is really active, especially when 'imactivatekey' is
6883 not set.
6884 NOTE: This option is set to the Vi default value when 'compatible' is
6885 set and to the Vim default value when 'compatible' is reset.
6886
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006887 *'showtabline'* *'stal'*
6888'showtabline' 'stal' number (default 1)
6889 global
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006890 The value of this option specifies when the line with tab page labels
6891 will be displayed:
6892 0: never
6893 1: only if there are at least two tab pages
6894 2: always
6895 This is both for the GUI and non-GUI implementation of the tab pages
6896 line.
6897 See |tab-page| for more information about tab pages.
6898
Bram Moolenaar071d4272004-06-13 20:20:40 +00006899 *'sidescroll'* *'ss'*
6900'sidescroll' 'ss' number (default 0)
6901 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006902 The minimal number of columns to scroll horizontally. Used only when
6903 the 'wrap' option is off and the cursor is moved off of the screen.
6904 When it is zero the cursor will be put in the middle of the screen.
6905 When using a slow terminal set it to a large number or 0. When using
6906 a fast terminal use a small number or 1. Not used for "zh" and "zl"
6907 commands.
6908
6909 *'sidescrolloff'* *'siso'*
6910'sidescrolloff' 'siso' number (default 0)
Bram Moolenaar375e3392019-01-31 18:26:10 +01006911 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006912 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00006913 right of the cursor if 'nowrap' is set. Setting this option to a
6914 value greater than 0 while having |'sidescroll'| also at a non-zero
6915 value makes some context visible in the line you are scrolling in
6916 horizontally (except at beginning of the line). Setting this option
6917 to a large value (like 999) has the effect of keeping the cursor
6918 horizontally centered in the window, as long as one does not come too
6919 close to the beginning of the line.
Bram Moolenaar375e3392019-01-31 18:26:10 +01006920 After using the local value, go back the global value with one of
6921 these two: >
6922 setlocal sidescrolloff<
6923 setlocal sidescrolloff=-1
6924< NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006925
6926 Example: Try this together with 'sidescroll' and 'listchars' as
6927 in the following example to never allow the cursor to move
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02006928 onto the "extends" character: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006929
6930 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
6931 :set sidescrolloff=1
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02006932<
6933 *'signcolumn'* *'scl'*
6934'signcolumn' 'scl' string (default "auto")
6935 local to window
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02006936 {not available when compiled without the |+signs|
6937 feature}
Bram Moolenaar09521312016-08-12 22:54:35 +02006938 Whether or not to draw the signcolumn. Valid values are:
6939 "auto" only when there is a sign to display
6940 "no" never
6941 "yes" always
Bram Moolenaar394c5d82019-06-17 21:48:05 +02006942 "number" display signs in the 'number' column. If the number
Bram Moolenaar6c1e1572019-06-22 02:13:00 +02006943 column is not present, then behaves like "auto".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006944
6945
6946 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
6947'smartcase' 'scs' boolean (default off)
6948 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006949 Override the 'ignorecase' option if the search pattern contains upper
6950 case characters. Only used when the search pattern is typed and
6951 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarc8734422012-06-01 22:38:45 +02006952 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00006953 "*" and "#" you can make 'smartcase' used by doing a "/" command,
6954 recalling the search pattern from history and hitting <Enter>.
6955 NOTE: This option is reset when 'compatible' is set.
6956
6957 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
6958'smartindent' 'si' boolean (default off)
6959 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00006960 {not available when compiled without the
6961 |+smartindent| feature}
6962 Do smart autoindenting when starting a new line. Works for C-like
6963 programs, but can also be used for other languages. 'cindent' does
6964 something like this, works better in most cases, but is more strict,
Bram Moolenaar81af9252010-12-10 20:35:50 +01006965 see |C-indenting|. When 'cindent' is on or 'indentexpr' is set,
Bram Moolenaar166af9b2010-11-16 20:34:40 +01006966 setting 'si' has no effect. 'indentexpr' is a more advanced
6967 alternative.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006968 Normally 'autoindent' should also be on when using 'smartindent'.
6969 An indent is automatically inserted:
6970 - After a line ending in '{'.
6971 - After a line starting with a keyword from 'cinwords'.
6972 - Before a line starting with '}' (only with the "O" command).
6973 When typing '}' as the first character in a new line, that line is
6974 given the same indent as the matching '{'.
6975 When typing '#' as the first character in a new line, the indent for
6976 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006977 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00006978 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
6979 When using the ">>" command, lines starting with '#' are not shifted
6980 right.
Bram Moolenaar036986f2017-03-16 17:41:02 +01006981 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02006982 This option is reset when 'paste' is set and restored when 'paste' is
6983 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006984
6985 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
6986'smarttab' 'sta' boolean (default off)
6987 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006988 When on, a <Tab> in front of a line inserts blanks according to
Bram Moolenaar280f1262006-01-30 00:14:18 +00006989 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A
6990 <BS> will delete a 'shiftwidth' worth of space at the start of the
6991 line.
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006992 When off, a <Tab> always inserts blanks according to 'tabstop' or
Bram Moolenaar280f1262006-01-30 00:14:18 +00006993 'softtabstop'. 'shiftwidth' is only used for shifting text left or
6994 right |shift-left-right|.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00006995 What gets inserted (a <Tab> or spaces) depends on the 'expandtab'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006996 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00006997 number of spaces is minimized by using <Tab>s.
Bram Moolenaarca635012015-09-25 20:34:21 +02006998 This option is reset when 'paste' is set and restored when 'paste' is
6999 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007000 NOTE: This option is reset when 'compatible' is set.
7001
7002 *'softtabstop'* *'sts'*
7003'softtabstop' 'sts' number (default 0)
7004 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007005 Number of spaces that a <Tab> counts for while performing editing
7006 operations, like inserting a <Tab> or using <BS>. It "feels" like
7007 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
7008 used. This is useful to keep the 'ts' setting at its standard value
7009 of 8, while being able to edit like it is set to 'sts'. However,
7010 commands like "x" still work on the actual characters.
7011 When 'sts' is zero, this feature is off.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02007012 When 'sts' is negative, the value of 'shiftwidth' is used.
Bram Moolenaarca635012015-09-25 20:34:21 +02007013 'softtabstop' is set to 0 when the 'paste' option is set and restored
7014 when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007015 See also |ins-expandtab|. When 'expandtab' is not set, the number of
7016 spaces is minimized by using <Tab>s.
7017 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
7018 set.
7019 NOTE: This option is set to 0 when 'compatible' is set.
7020
Bram Moolenaar04958cb2018-06-23 19:23:02 +02007021 If Vim is compiled with the |+vartabs| feature then the value of
7022 'softtabstop' will be ignored if |'varsofttabstop'| is set to
7023 anything other than an empty string.
7024
Bram Moolenaar217ad922005-03-20 22:37:15 +00007025 *'spell'* *'nospell'*
7026'spell' boolean (default off)
7027 local to window
Bram Moolenaar217ad922005-03-20 22:37:15 +00007028 {not available when compiled without the |+syntax|
7029 feature}
7030 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007031 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007032
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007033 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00007034'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007035 local to buffer
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007036 {not available when compiled without the |+syntax|
7037 feature}
7038 Pattern to locate the end of a sentence. The following word will be
7039 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007040 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007041 When this check is not wanted make this option empty.
7042 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00007043 Be careful with special characters, see |option-backslash| about
7044 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007045 To set this option automatically depending on the language, see
7046 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007047
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007048 *'spellfile'* *'spf'*
7049'spellfile' 'spf' string (default empty)
7050 local to buffer
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007051 {not available when compiled without the |+syntax|
7052 feature}
7053 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00007054 commands. It must end in ".{encoding}.add". You need to include the
7055 path, otherwise the file is placed in the current directory.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007056 *E765*
7057 It may also be a comma separated list of names. A count before the
7058 |zg| and |zw| commands can be used to access each. This allows using
7059 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007060 When a word is added while this option is empty Vim will set it for
Bram Moolenaar910f66f2006-04-05 20:41:53 +00007061 you: Using the first directory in 'runtimepath' that is writable. If
7062 there is no "spell" directory yet it will be created. For the file
7063 name the first language name that appears in 'spelllang' is used,
Bram Moolenaar3b506942005-06-23 22:36:45 +00007064 ignoring the region.
7065 The resulting ".spl" file will be used for spell checking, it does not
7066 have to appear in 'spelllang'.
7067 Normally one file is used for all regions, but you can add the region
7068 name if you want to. However, it will then only be used when
7069 'spellfile' is set to it, for entries in 'spelllang' only files
7070 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00007071 This option cannot be set from a |modeline| or in the |sandbox|, for
7072 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007073
Bram Moolenaar217ad922005-03-20 22:37:15 +00007074 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007075'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00007076 local to buffer
Bram Moolenaar217ad922005-03-20 22:37:15 +00007077 {not available when compiled without the |+syntax|
7078 feature}
Bram Moolenaar3b506942005-06-23 22:36:45 +00007079 A comma separated list of word list names. When the 'spell' option is
7080 on spellchecking will be done for these languages. Example: >
7081 set spelllang=en_us,nl,medical
7082< This means US English, Dutch and medical words are recognized. Words
7083 that are not recognized will be highlighted.
Bram Moolenaar911ead12019-04-21 00:03:35 +02007084 The word list name must consist of alphanumeric characters, a dash or
7085 an underscore. It should not include a comma or dot. Using a dash is
Bram Moolenaar3b506942005-06-23 22:36:45 +00007086 recommended to separate the two letter language name from a
7087 specification. Thus "en-rare" is used for rare English words.
7088 A region name must come last and have the form "_xx", where "xx" is
7089 the two-letter, lower case region name. You can use more than one
7090 region by listing them: "en_us,en_ca" supports both US and Canadian
7091 English, but not words specific for Australia, New Zealand or Great
Bram Moolenaarfa735342016-01-03 22:14:44 +01007092 Britain. (Note: currently en_au and en_nz dictionaries are older than
7093 en_ca, en_gb and en_us).
Bram Moolenaarcc63c642013-11-12 04:44:01 +01007094 If the name "cjk" is included East Asian characters are excluded from
7095 spell checking. This is useful when editing text that also has Asian
7096 words.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007097 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007098 As a special case the name of a .spl file can be given as-is. The
7099 first "_xx" in the name is removed and used as the region name
7100 (_xx is an underscore, two letters and followed by a non-letter).
7101 This is mainly for testing purposes. You must make sure the correct
7102 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007103 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007104 idea to set 'spelllang' after setting 'encoding' to avoid loading the
7105 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00007106 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007107
Bram Moolenaar98692072006-02-04 00:57:42 +00007108 If the |spellfile.vim| plugin is active and you use a language name
7109 for which Vim cannot find the .spl file in 'runtimepath' the plugin
7110 will ask you if you want to download the file.
7111
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007112 After this option has been set successfully, Vim will source the files
7113 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
Bram Moolenaarb730f0c2018-11-25 03:56:26 +01007114 up to the first character that is not an ASCII letter or number and
7115 not a dash. Also see |set-spc-auto|.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007116
Bram Moolenaar362b44b2020-06-10 21:47:00 +02007117 *'spelloptions'* *'spo'*
7118'spelloptions' 'spo' string (default "")
7119 local to buffer
7120 {not available when compiled without the |+syntax|
7121 feature}
7122 A comma separated list of options for spell checking:
7123 camel When a word is CamelCased, assume "Cased" is a
7124 separate word: every upper-case character in a word
7125 that comes after a lower case character indicates the
7126 start of a new word.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007127
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007128 *'spellsuggest'* *'sps'*
7129'spellsuggest' 'sps' string (default "best")
7130 global
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007131 {not available when compiled without the |+syntax|
7132 feature}
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007133 Methods used for spelling suggestions. Both for the |z=| command and
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007134 the |spellsuggest()| function. This is a comma-separated list of
7135 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007136
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007137 best Internal method that works best for English. Finds
7138 changes like "fast" and uses a bit of sound-a-like
7139 scoring to improve the ordering.
7140
7141 double Internal method that uses two methods and mixes the
7142 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007143 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007144 word. That only works when the language specifies
7145 sound folding. Can be slow and doesn't always give
7146 better results.
7147
7148 fast Internal method that only checks for simple changes:
7149 character inserts/deletes/swaps. Works well for
7150 simple typing mistakes.
7151
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007152 {number} The maximum number of suggestions listed for |z=|.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007153 Not used for |spellsuggest()|. The number of
7154 suggestions is never more than the value of 'lines'
7155 minus two.
7156
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007157 file:{filename} Read file {filename}, which must have two columns,
7158 separated by a slash. The first column contains the
7159 bad word, the second column the suggested good word.
7160 Example:
7161 theribal/terrible ~
7162 Use this for common mistakes that do not appear at the
7163 top of the suggestion list with the internal methods.
7164 Lines without a slash are ignored, use this for
7165 comments.
Bram Moolenaarbcb98982014-05-01 14:08:19 +02007166 The word in the second column must be correct,
7167 otherwise it will not be used. Add the word to an
7168 ".add" file if it is currently flagged as a spelling
7169 mistake.
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007170 The file is used for all languages.
7171
7172 expr:{expr} Evaluate expression {expr}. Use a function to avoid
7173 trouble with spaces. |v:val| holds the badly spelled
7174 word. The expression must evaluate to a List of
7175 Lists, each with a suggestion and a score.
7176 Example:
Bram Moolenaar214641f2017-03-05 17:04:09 +01007177 [['the', 33], ['that', 44]] ~
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007178 Set 'verbose' and use |z=| to see the scores that the
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007179 internal methods use. A lower score is better.
7180 This may invoke |spellsuggest()| if you temporarily
7181 set 'spellsuggest' to exclude the "expr:" part.
7182 Errors are silently ignored, unless you set the
7183 'verbose' option to a non-zero value.
7184
7185 Only one of "best", "double" or "fast" may be used. The others may
7186 appear several times in any order. Example: >
7187 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
7188<
7189 This option cannot be set from a |modeline| or in the |sandbox|, for
7190 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007191
7192
Bram Moolenaar071d4272004-06-13 20:20:40 +00007193 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
7194'splitbelow' 'sb' boolean (default off)
7195 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007196 When on, splitting a window will put the new window below the current
7197 one. |:split|
7198
7199 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
7200'splitright' 'spr' boolean (default off)
7201 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007202 When on, splitting a window will put the new window right of the
7203 current one. |:vsplit|
7204
7205 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
7206'startofline' 'sol' boolean (default on)
7207 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007208 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00007209 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007210 (if possible). This applies to the commands: CTRL-D, CTRL-U, CTRL-B,
Bram Moolenaar843ee412004-06-30 16:16:41 +00007211 CTRL-F, "G", "H", "M", "L", gg, and to the commands "d", "<<" and ">>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007212 with a linewise operator, with "%" with a count and to buffer changing
7213 commands (CTRL-^, :bnext, :bNext, etc.). Also for an Ex command that
7214 only has a line number, e.g., ":25" or ":+".
7215 In case of buffer changing commands the cursor is placed at the column
7216 where it was the last time the buffer was edited.
7217 NOTE: This option is set when 'compatible' is set.
7218
Bram Moolenaar00654022011-02-25 14:42:19 +01007219 *'statusline'* *'stl'* *E540* *E542*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007220'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007221 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007222 {not available when compiled without the |+statusline|
7223 feature}
7224 When nonempty, this option determines the content of the status line.
7225 Also see |status-line|.
7226
7227 The option consists of printf style '%' items interspersed with
7228 normal text. Each status line item is of the form:
7229 %-0{minwid}.{maxwid}{item}
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01007230 All fields except the {item} are optional. A single percent sign can
Bram Moolenaar00654022011-02-25 14:42:19 +01007231 be given as "%%". Up to 80 items can be specified. *E541*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007232
Bram Moolenaar238a5642006-02-21 22:12:05 +00007233 When the option starts with "%!" then it is used as an expression,
7234 evaluated and the result is used as the option value. Example: >
7235 :set statusline=%!MyStatusLine()
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02007236< The *g:statusline_winid* variable will be set to the |window-ID| of the
7237 window that the status line belongs to.
7238 The result can contain %{} items that will be evaluated too.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02007239 Note that the "%!" expression is evaluated in the context of the
7240 current window and buffer, while %{} items are evaluated in the
7241 context of the window that the statusline belongs to.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007242
7243 When there is error while evaluating the option then it will be made
7244 empty to avoid further errors. Otherwise screen updating would loop.
7245
Bram Moolenaar071d4272004-06-13 20:20:40 +00007246 Note that the only effect of 'ruler' when this option is set (and
7247 'laststatus' is 2) is controlling the output of |CTRL-G|.
7248
7249 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00007250 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00007251 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007252 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007253 minwid Minimum width of the item, padding as set by '-' & '0'.
7254 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007255 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007256 on the left for text items. Numeric items will be
7257 shifted down to maxwid-2 digits followed by '>'number
7258 where number is the amount of missing digits, much like
7259 an exponential notation.
7260 item A one letter code as described below.
7261
7262 Following is a description of the possible statusline items. The
7263 second character in "item" is the type:
7264 N for number
7265 S for string
7266 F for flags as described below
7267 - not applicable
7268
7269 item meaning ~
Bram Moolenaar02467872007-05-06 13:22:01 +00007270 f S Path to the file in the buffer, as typed or relative to current
7271 directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007272 F S Full path to the file in the buffer.
7273 t S File name (tail) of file in the buffer.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007274 m F Modified flag, text is "[+]"; "[-]" if 'modifiable' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007275 M F Modified flag, text is ",+" or ",-".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007276 r F Readonly flag, text is "[RO]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007277 R F Readonly flag, text is ",RO".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007278 h F Help buffer flag, text is "[help]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007279 H F Help buffer flag, text is ",HLP".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007280 w F Preview window flag, text is "[Preview]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007281 W F Preview window flag, text is ",PRV".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007282 y F Type of file in the buffer, e.g., "[vim]". See 'filetype'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007283 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
Bram Moolenaar7fd73202010-07-25 16:58:46 +02007284 q S "[Quickfix List]", "[Location List]" or empty.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007285 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
7286 being used: "<keymap>"
7287 n N Buffer number.
Bram Moolenaar00654022011-02-25 14:42:19 +01007288 b N Value of character under cursor.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007289 B N As above, in hexadecimal.
7290 o N Byte number in file of byte under cursor, first byte is 1.
7291 Mnemonic: Offset from start of file (with one added)
7292 {not available when compiled without |+byte_offset| feature}
7293 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007294 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007295 l N Line number.
7296 L N Number of lines in buffer.
7297 c N Column number.
7298 v N Virtual column number.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007299 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007300 p N Percentage through file in lines as in |CTRL-G|.
7301 P S Percentage through file of displayed window. This is like the
Bram Moolenaar14b69452013-06-29 23:05:20 +02007302 percentage described for 'ruler'. Always 3 in length, unless
7303 translated.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007304 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00007305 Empty if the argument file count is zero or one.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007306 { NF Evaluate expression between '%{' and '}' and substitute result.
Bram Moolenaar6d150f72018-04-21 20:03:20 +02007307 Note that there is no '%' before the closing '}'. The
7308 expression cannot contain a '}' character, call a function to
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007309 work around that. See |stl-%{| below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007310 ( - Start of item group. Can be used for setting the width and
7311 alignment of a section. Must be followed by %) somewhere.
7312 ) - End of item group. No width fields allowed.
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007313 T N For 'tabline': start of tab page N label. Use %T after the last
7314 label. This information is used for mouse clicks.
7315 X N For 'tabline': start of close tab N label. Use %X after the
7316 label, e.g.: %3Xclose%X. Use %999X for a "close current tab"
7317 mark. This information is used for mouse clicks.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007318 < - Where to truncate line if too long. Default is at the start.
7319 No width fields allowed.
7320 = - Separation point between left and right aligned items.
7321 No width fields allowed.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007322 # - Set highlight group. The name must follow and then a # again.
7323 Thus use %#HLname# for highlight group HLname. The same
7324 highlighting is used, also for the statusline of non-current
7325 windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007326 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00007327 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007328 The difference between User{N} and StatusLine will be applied
7329 to StatusLineNC for the statusline of non-current windows.
7330 The number N must be between 1 and 9. See |hl-User1..9|
7331
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007332 When displaying a flag, Vim removes the leading comma, if any, when
7333 that flag comes right after plaintext. This will make a nice display
7334 when flags are used like in the examples below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007335
Bram Moolenaar582fd852005-03-28 20:58:01 +00007336 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00007337 not set) and a minwid is not set for the group, the whole group will
7338 become empty. This will make a group like the following disappear
7339 completely from the statusline when none of the flags are set. >
7340 :set statusline=...%(\ [%M%R%H]%)...
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02007341< Beware that an expression is evaluated each and every time the status
7342 line is displayed.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007343 *stl-%{* *g:actual_curbuf* *g:actual_curwin*
Bram Moolenaarade0d392020-01-21 22:33:58 +01007344 While evaluating %{} the current buffer and current window will be set
7345 temporarily to that of the window (and buffer) whose statusline is
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007346 currently being drawn. The expression will evaluate in this context.
7347 The variable "g:actual_curbuf" is set to the `bufnr()` number of the
7348 real current buffer and "g:actual_curwin" to the |window-ID| of the
7349 real current window. These values are strings.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007350
Bram Moolenaar30b65812012-07-12 22:01:11 +02007351 The 'statusline' option will be evaluated in the |sandbox| if set from
7352 a modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02007353 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007354
7355 It is not allowed to change text or jump to another window while
7356 evaluating 'statusline' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007357
7358 If the statusline is not updated when you want it (e.g., after setting
7359 a variable that's used in an expression), you can force an update by
7360 setting an option without changing its value. Example: >
7361 :let &ro = &ro
7362
7363< A result of all digits is regarded a number for display purposes.
7364 Otherwise the result is taken as flag text and applied to the rules
7365 described above.
7366
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00007367 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00007368 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
Bram Moolenaarc4da1132017-07-15 19:39:43 +02007369 edit your .vimrc or whatever with "vim --clean" to get it right.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007370
7371 Examples:
7372 Emulate standard status line with 'ruler' set >
7373 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
7374< Similar, but add ASCII value of char under the cursor (like "ga") >
7375 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
7376< Display byte count and byte value, modified flag in red. >
7377 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
7378 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
7379< Display a ,GZ flag if a compressed file is loaded >
7380 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
7381< In the |:autocmd|'s: >
7382 :let b:gzflag = 1
7383< And: >
7384 :unlet b:gzflag
7385< And define this function: >
7386 :function VarExists(var, val)
7387 : if exists(a:var) | return a:val | else | return '' | endif
7388 :endfunction
7389<
7390 *'suffixes'* *'su'*
7391'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
7392 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007393 Files with these suffixes get a lower priority when multiple files
7394 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007395 suffixes. Spaces after the comma are ignored. A dot is also seen as
7396 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007397 separator, precede it with a backslash (see |option-backslash| about
7398 including spaces and backslashes).
7399 See 'wildignore' for completely ignoring files.
7400 The use of |:set+=| and |:set-=| is preferred when adding or removing
7401 suffixes from the list. This avoids problems when a future version
7402 uses another default.
7403
7404 *'suffixesadd'* *'sua'*
7405'suffixesadd' 'sua' string (default "")
7406 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007407 {not available when compiled without the
7408 |+file_in_path| feature}
7409 Comma separated list of suffixes, which are used when searching for a
7410 file for the "gf", "[I", etc. commands. Example: >
7411 :set suffixesadd=.java
7412<
7413 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
7414'swapfile' 'swf' boolean (default on)
7415 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007416 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007417 swapfile is not wanted for a specific buffer. For example, with
7418 confidential information that even root must not be able to access.
7419 Careful: All text will be in memory:
7420 - Don't use this for big files.
7421 - Recovery will be impossible!
7422 A swapfile will only be present when |'updatecount'| is non-zero and
7423 'swapfile' is set.
7424 When 'swapfile' is reset, the swap file for the current buffer is
7425 immediately deleted. When 'swapfile' is set, and 'updatecount' is
7426 non-zero, a swap file is immediately created.
7427 Also see |swap-file| and |'swapsync'|.
Bram Moolenaar76f3b1a2014-03-27 22:30:07 +01007428 If you want to open a new buffer without creating a swap file for it,
7429 use the |:noswapfile| modifier.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01007430 See 'directory' for where the swap file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007431
7432 This option is used together with 'bufhidden' and 'buftype' to
7433 specify special kinds of buffers. See |special-buffers|.
7434
7435 *'swapsync'* *'sws'*
7436'swapsync' 'sws' string (default "fsync")
7437 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007438 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007439 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007440 When this option is empty parts of the swap file may be in memory and
7441 not written to disk. When the system crashes you may lose more work.
7442 On Unix the system does a sync now and then without Vim asking for it,
7443 so the disadvantage of setting this option off is small. On some
7444 systems the swap file will not be written at all. For a unix system
7445 setting it to "sync" will use the sync() call instead of the default
7446 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007447 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007448
7449 *'switchbuf'* *'swb'*
7450'switchbuf' 'swb' string (default "")
7451 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007452 This option controls the behavior when switching between buffers.
7453 Possible values (comma separated list):
7454 useopen If included, jump to the first open window that
7455 contains the specified buffer (if there is one).
7456 Otherwise: Do not examine other windows.
7457 This setting is checked with |quickfix| commands, when
7458 jumping to errors (":cc", ":cn", "cp", etc.). It is
7459 also used in all buffer related split commands, for
7460 example ":sbuffer", ":sbnext", or ":sbrewind".
Bram Moolenaar779b74b2006-04-10 14:55:34 +00007461 usetab Like "useopen", but also consider windows in other tab
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00007462 pages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007463 split If included, split the current window before loading
Bram Moolenaar15146672011-10-20 22:22:38 +02007464 a buffer for a |quickfix| command that display errors.
Bram Moolenaar63b74a82019-03-24 15:09:13 +01007465 Otherwise: do not split, use current window (when used
7466 in the quickfix window: the previously used window or
7467 split if there is no other window).
Bram Moolenaara594d772015-06-19 14:41:49 +02007468 vsplit Just like "split" but split vertically.
Bram Moolenaar446cb832008-06-24 21:56:24 +00007469 newtab Like "split", but open a new tab page. Overrules
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02007470 "split" when both are present.
Bram Moolenaar539aa6b2019-11-17 18:09:38 +01007471 uselast If included, jump to the previously used window when
7472 jumping to errors with |quickfix| commands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007473
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007474 *'synmaxcol'* *'smc'*
7475'synmaxcol' 'smc' number (default 3000)
7476 local to buffer
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007477 {not available when compiled without the |+syntax|
7478 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007479 Maximum column in which to search for syntax items. In long lines the
7480 text after this column is not highlighted and following lines may not
7481 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007482 This helps to avoid very slow redrawing for an XML file that is one
7483 long line.
7484 Set to zero to remove the limit.
7485
Bram Moolenaar071d4272004-06-13 20:20:40 +00007486 *'syntax'* *'syn'*
7487'syntax' 'syn' string (default empty)
7488 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007489 {not available when compiled without the |+syntax|
7490 feature}
7491 When this option is set, the syntax with this name is loaded, unless
7492 syntax highlighting has been switched off with ":syntax off".
7493 Otherwise this option does not always reflect the current syntax (the
7494 b:current_syntax variable does).
7495 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007496 not automatically recognized. Example, in an IDL file:
7497 /* vim: set syntax=idl : */ ~
7498 When a dot appears in the value then this separates two filetype
7499 names. Example:
7500 /* vim: set syntax=c.doxygen : */ ~
7501 This will use the "c" syntax first, then the "doxygen" syntax.
7502 Note that the second one must be prepared to be loaded as an addition,
7503 otherwise it will be skipped. More than one dot may appear.
7504 To switch off syntax highlighting for the current file, use: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007505 :set syntax=OFF
7506< To switch syntax highlighting on according to the current value of the
7507 'filetype' option: >
7508 :set syntax=ON
7509< What actually happens when setting the 'syntax' option is that the
7510 Syntax autocommand event is triggered with the value as argument.
7511 This option is not copied to another buffer, independent of the 's' or
7512 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007513 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007514
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007515 *'tabline'* *'tal'*
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007516'tabline' 'tal' string (default empty)
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007517 global
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007518 When nonempty, this option determines the content of the tab pages
7519 line at the top of the Vim window. When empty Vim will use a default
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007520 tab pages line. See |setting-tabline| for more info.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007521
7522 The tab pages line only appears as specified with the 'showtabline'
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00007523 option and only when there is no GUI tab line. When 'e' is in
7524 'guioptions' and the GUI supports a tab line 'guitablabel' is used
Bram Moolenaar7f036442010-08-15 15:24:20 +02007525 instead. Note that the two tab pages lines are very different.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007526
7527 The value is evaluated like with 'statusline'. You can use
7528 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007529 the text to be displayed. Use "%1T" for the first label, "%2T" for
7530 the second one, etc. Use "%X" items for closing labels.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007531
Bram Moolenaare12bab32019-01-08 22:02:56 +01007532 When changing something that is used in 'tabline' that does not
7533 trigger it to be updated, use |:redrawtabline|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02007534 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaare12bab32019-01-08 22:02:56 +01007535
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007536 Keep in mind that only one of the tab pages is the current one, others
7537 are invisible and you can't jump to their windows.
7538
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007539
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007540 *'tabpagemax'* *'tpm'*
7541'tabpagemax' 'tpm' number (default 10)
7542 global
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007543 Maximum number of tab pages to be opened by the |-p| command line
7544 argument or the ":tab all" command. |tabpage|
7545
7546
7547 *'tabstop'* *'ts'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007548'tabstop' 'ts' number (default 8)
7549 local to buffer
7550 Number of spaces that a <Tab> in the file counts for. Also see
7551 |:retab| command, and 'softtabstop' option.
7552
7553 Note: Setting 'tabstop' to any other value than 8 can make your file
7554 appear wrong in many places (e.g., when printing it).
7555
7556 There are four main ways to use tabs in Vim:
7557 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
7558 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007559 will use a mix of tabs and spaces, but typing <Tab> and <BS> will
Bram Moolenaar071d4272004-06-13 20:20:40 +00007560 behave like a tab appears every 4 (or 3) characters.
7561 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
7562 'expandtab'. This way you will always insert spaces. The
7563 formatting will never be messed up when 'tabstop' is changed.
7564 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007565 |modeline| to set these values when editing the file again. Only
Bram Moolenaar071d4272004-06-13 20:20:40 +00007566 works when using Vim to edit the file.
7567 4. Always set 'tabstop' and 'shiftwidth' to the same value, and
7568 'noexpandtab'. This should then work (for initial indents only)
7569 for any tabstop setting that people use. It might be nice to have
7570 tabs after the first non-blank inserted as spaces if you do this
7571 though. Otherwise aligned comments will be wrong when 'tabstop' is
7572 changed.
7573
Bram Moolenaar04958cb2018-06-23 19:23:02 +02007574 If Vim is compiled with the |+vartabs| feature then the value of
7575 'tabstop' will be ignored if |'vartabstop'| is set to anything other
7576 than an empty string.
7577
Bram Moolenaar071d4272004-06-13 20:20:40 +00007578 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
7579'tagbsearch' 'tbs' boolean (default on)
7580 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007581 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007582 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00007583 searching makes searching for a tag a LOT faster, but a linear search
7584 will find more tags if the tags file wasn't properly sorted.
7585 Vim normally assumes that your tags files are sorted, or indicate that
7586 they are not sorted. Only when this is not the case does the
7587 'tagbsearch' option need to be switched off.
7588
7589 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007590 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00007591 certain files, or retry all files with a linear search. When
7592 'tagbsearch' is off, only a linear search is done.
7593
7594 Linear searching is done anyway, for one file, when Vim finds a line
7595 at the start of the file indicating that it's not sorted: >
Bram Moolenaar446cb832008-06-24 21:56:24 +00007596 !_TAG_FILE_SORTED 0 /some comment/
Bram Moolenaar071d4272004-06-13 20:20:40 +00007597< [The whitespace before and after the '0' must be a single <Tab>]
7598
7599 When a binary search was done and no match was found in any of the
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007600 files listed in 'tags', and case is ignored or a pattern is used
Bram Moolenaar071d4272004-06-13 20:20:40 +00007601 instead of a normal tag name, a retry is done with a linear search.
7602 Tags in unsorted tags files, and matches with different case will only
7603 be found in the retry.
7604
Bram Moolenaard4755bb2004-09-02 19:12:26 +00007605 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007606 linear search can be avoided when case is ignored. Use a value of '2'
7607 in the "!_TAG_FILE_SORTED" line for this. A tag file can be case-fold
7608 sorted with the -f switch to "sort" in most unices, as in the command:
7609 "sort -f -o tags tags". For "Exuberant ctags" version 5.x or higher
7610 (at least 5.5) the --sort=foldcase switch can be used for this as
7611 well. Note that case must be folded to uppercase for this to work.
7612
7613 By default, tag searches are case-sensitive. Case is ignored when
7614 'ignorecase' is set and 'tagcase' is "followic", or when 'tagcase' is
7615 "ignore".
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007616 Also when 'tagcase' is "followscs" and 'smartcase' is set, or
7617 'tagcase' is "smart", and the pattern contains only lowercase
7618 characters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007619
7620 When 'tagbsearch' is off, tags searching is slower when a full match
7621 exists, but faster when no full match exists. Tags in unsorted tags
7622 files may only be found with 'tagbsearch' off.
7623 When the tags file is not sorted, or sorted in a wrong way (not on
7624 ASCII byte value), 'tagbsearch' should be off, or the line given above
7625 must be included in the tags file.
7626 This option doesn't affect commands that find all matching tags (e.g.,
7627 command-line completion and ":help").
Bram Moolenaar071d4272004-06-13 20:20:40 +00007628
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007629 *'tagcase'* *'tc'*
7630'tagcase' 'tc' string (default "followic")
7631 global or local to buffer |global-local|
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007632 This option specifies how case is handled when searching the tags
7633 file:
7634 followic Follow the 'ignorecase' option
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007635 followscs Follow the 'smartcase' and 'ignorecase' options
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007636 ignore Ignore case
7637 match Match case
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007638 smart Ignore case unless an upper case letter is used
Bram Moolenaar036986f2017-03-16 17:41:02 +01007639 NOTE: This option is set to the Vi default value when 'compatible' is
7640 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007641
Bram Moolenaar45e18cb2019-04-28 18:05:35 +02007642 *'tagfunc'* *'tfu'*
7643'tagfunc' 'tfu' string (default: empty)
7644 local to buffer
7645 {not available when compiled without the |+eval|
7646 feature}
7647 This option specifies a function to be used to perform tag searches.
7648 The function gets the tag pattern and should return a List of matching
7649 tags. See |tag-function| for an explanation of how to write the
7650 function and an example.
7651
Bram Moolenaar071d4272004-06-13 20:20:40 +00007652 *'taglength'* *'tl'*
7653'taglength' 'tl' number (default 0)
7654 global
7655 If non-zero, tags are significant up to this number of characters.
7656
7657 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
7658'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
7659 global
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00007660 If on and using a tags file in another directory, file names in that
7661 tags file are relative to the directory where the tags file is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007662 NOTE: This option is set to the Vi default value when 'compatible' is
7663 set and to the Vim default value when 'compatible' is reset.
7664
7665 *'tags'* *'tag'* *E433*
7666'tags' 'tag' string (default "./tags,tags", when compiled with
7667 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
7668 global or local to buffer |global-local|
7669 Filenames for the tag command, separated by spaces or commas. To
7670 include a space or comma in a file name, precede it with a backslash
7671 (see |option-backslash| about including spaces and backslashes).
7672 When a file name starts with "./", the '.' is replaced with the path
7673 of the current file. But only when the 'd' flag is not included in
7674 'cpoptions'. Environment variables are expanded |:set_env|. Also see
7675 |tags-option|.
7676 "*", "**" and other wildcards can be used to search for tags files in
Bram Moolenaare2b590e2010-08-08 18:29:48 +02007677 a directory tree. See |file-searching|. E.g., "/lib/**/tags" will
7678 find all files named "tags" below "/lib". The filename itself cannot
7679 contain wildcards, it is used as-is. E.g., "/lib/**/tags?" will find
7680 files called "tags?". {not available when compiled without the
7681 |+path_extra| feature}
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00007682 The |tagfiles()| function can be used to get a list of the file names
7683 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007684 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
7685 files are also supported. They are automatically recognized. The
7686 default value becomes "./tags,./TAGS,tags,TAGS", unless case
7687 differences are ignored (MS-Windows). |emacs-tags|
7688 The use of |:set+=| and |:set-=| is preferred when adding or removing
7689 file names from the list. This avoids problems when a future version
7690 uses another default.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007691
7692 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
7693'tagstack' 'tgst' boolean (default on)
7694 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007695 When on, the |tagstack| is used normally. When off, a ":tag" or
7696 ":tselect" command with an argument will not push the tag onto the
7697 tagstack. A following ":tag" without an argument, a ":pop" command or
7698 any other command that uses the tagstack will use the unmodified
7699 tagstack, but does change the pointer to the active entry.
7700 Resetting this option is useful when using a ":tag" command in a
7701 mapping which should not change the tagstack.
7702
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007703 *'tcldll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01007704'tcldll' string (default depends on the build)
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007705 global
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007706 {only available when compiled with the |+tcl/dyn|
7707 feature}
7708 Specifies the name of the Tcl shared library. The default is
7709 DYNAMIC_TCL_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02007710 Environment variables are expanded |:set_env|.
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007711 This option cannot be set from a |modeline| or in the |sandbox|, for
7712 security reasons.
7713
Bram Moolenaar071d4272004-06-13 20:20:40 +00007714 *'term'* *E529* *E530* *E531*
7715'term' string (default is $TERM, if that fails:
7716 in the GUI: "builtin_gui"
7717 on Amiga: "amiga"
Bram Moolenaarb3f74062020-02-26 16:16:53 +01007718 on Haiku: "xterm"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007719 on Mac: "mac-ansi"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007720 on Unix: "ansi"
7721 on VMS: "ansi"
7722 on Win 32: "win32")
7723 global
7724 Name of the terminal. Used for choosing the terminal control
7725 characters. Environment variables are expanded |:set_env|.
7726 For example: >
7727 :set term=$TERM
7728< See |termcap|.
7729
7730 *'termbidi'* *'tbidi'*
7731 *'notermbidi'* *'notbidi'*
7732'termbidi' 'tbidi' boolean (default off, on for "mlterm")
7733 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007734 {only available when compiled with the |+arabic|
7735 feature}
7736 The terminal is in charge of Bi-directionality of text (as specified
7737 by Unicode). The terminal is also expected to do the required shaping
7738 that some languages (such as Arabic) require.
7739 Setting this option implies that 'rightleft' will not be set when
7740 'arabic' is set and the value of 'arabicshape' will be ignored.
7741 Note that setting 'termbidi' has the immediate effect that
7742 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
7743 This option is reset when the GUI is started.
7744 For further details see |arabic.txt|.
7745
7746 *'termencoding'* *'tenc'*
Bram Moolenaar3df01732017-02-17 22:47:16 +01007747'termencoding' 'tenc' string (default ""; with GTK+ GUI: "utf-8"; with
Bram Moolenaar071d4272004-06-13 20:20:40 +00007748 Macintosh GUI: "macroman")
7749 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007750 Encoding used for the terminal. This specifies what character
7751 encoding the keyboard produces and the display will understand. For
Bram Moolenaar3848e002016-03-19 18:42:29 +01007752 the GUI it only applies to the keyboard ('encoding' is used for the
Bram Moolenaar02467872007-05-06 13:22:01 +00007753 display). Except for the Mac when 'macatsui' is off, then
7754 'termencoding' should be "macroman".
Bram Moolenaar4b7cdca2020-01-01 16:18:38 +01007755 *E617* *E950*
Bram Moolenaar3df01732017-02-17 22:47:16 +01007756 Note: This does not apply to the GTK+ GUI. After the GUI has been
Bram Moolenaar071d4272004-06-13 20:20:40 +00007757 successfully initialized, 'termencoding' is forcibly set to "utf-8".
7758 Any attempts to set a different value will be rejected, and an error
7759 message is shown.
Bram Moolenaarac360bf2015-09-01 20:31:20 +02007760 For the Win32 GUI and console versions 'termencoding' is not used,
Bram Moolenaar071d4272004-06-13 20:20:40 +00007761 because the Win32 system always passes Unicode characters.
7762 When empty, the same encoding is used as for the 'encoding' option.
7763 This is the normal value.
7764 Not all combinations for 'termencoding' and 'encoding' are valid. See
7765 |encoding-table|.
7766 The value for this option must be supported by internal conversions or
7767 iconv(). When this is not possible no conversion will be done and you
7768 will probably experience problems with non-ASCII characters.
7769 Example: You are working with the locale set to euc-jp (Japanese) and
7770 want to edit a UTF-8 file: >
7771 :let &termencoding = &encoding
7772 :set encoding=utf-8
7773< You need to do this when your system has no locale support for UTF-8.
7774
Bram Moolenaarcafafb32018-02-22 21:07:09 +01007775 *'termguicolors'* *'tgc'* *E954*
Bram Moolenaar61be73b2016-04-29 22:59:22 +02007776'termguicolors' 'tgc' boolean (default off)
7777 global
Bram Moolenaar61be73b2016-04-29 22:59:22 +02007778 {not available when compiled without the
7779 |+termguicolors| feature}
7780 When on, uses |highlight-guifg| and |highlight-guibg| attributes in
Bram Moolenaarcafafb32018-02-22 21:07:09 +01007781 the terminal (thus using 24-bit color).
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01007782
Bram Moolenaarcafafb32018-02-22 21:07:09 +01007783 Requires a ISO-8613-3 compatible terminal. If setting this option
7784 does not work (produces a colorless UI) reading |xterm-true-color|
7785 might help.
7786
7787 For Win32 console, Windows 10 version 1703 (Creators Update) or later
7788 is required. Use this check to find out: >
7789 if has('vcon')
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01007790< This requires Vim to be built with the |+vtp| feature.
7791
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +02007792 Note that the "cterm" attributes are still used, not the "gui" ones.
Bram Moolenaar036986f2017-03-16 17:41:02 +01007793 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar61be73b2016-04-29 22:59:22 +02007794
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02007795 *'termwinkey'* *'twk'*
7796'termwinkey' 'twk' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02007797 local to window
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007798 The key that starts a CTRL-W command in a terminal window. Other keys
Bram Moolenaar74675a62017-07-15 13:53:23 +02007799 are sent to the job running in the window.
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007800 The <> notation can be used, e.g.: >
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02007801 :set termwinkey=<C-L>
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007802< The string must be one key stroke but can be multiple bytes.
7803 When not set CTRL-W is used, so that CTRL-W : gets you to the command
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02007804 line. If 'termwinkey' is set to CTRL-L then CTRL-L : gets you to the
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007805 command line.
Bram Moolenaar74675a62017-07-15 13:53:23 +02007806
Bram Moolenaar6c60f472019-04-28 16:00:35 +02007807 *'termwinscroll'* *'twsl'*
7808'termwinscroll' 'twsl' number (default 10000)
7809 local to buffer
7810 {not available when compiled without the
7811 |+terminal| feature}
7812 Number of scrollback lines to keep. When going over this limit the
7813 first 10% of the scrollback lines are deleted. This is just to reduce
7814 the memory usage. See |Terminal-Normal|.
7815
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02007816 *'termwinsize'* *'tws'*
7817'termwinsize' 'tws' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02007818 local to window
Bram Moolenaar498c2562018-04-15 23:45:15 +02007819 Size of the |terminal| window. Format: {rows}x{columns} or
7820 {rows}*{columns}.
Bram Moolenaar74675a62017-07-15 13:53:23 +02007821 - When empty the terminal gets the size from the window.
Bram Moolenaar498c2562018-04-15 23:45:15 +02007822 - When set with a "x" (e.g., "24x80") the terminal size is not
7823 adjusted to the window size. If the window is smaller only the
7824 top-left part is displayed.
7825 - When set with a "*" (e.g., "10*50") the terminal size follows the
7826 window size, but will not be smaller than the specified rows and/or
7827 columns.
7828 - When rows is zero then use the height of the window.
7829 - When columns is zero then use the width of the window.
7830 - Using "0x0" or "0*0" is the same as empty.
7831
7832 Examples:
7833 "30x0" uses 30 rows and the current window width.
7834 "20*0" uses at least 20 rows and the current window width.
7835 "0*40" uses the current window height and at least 40 columns.
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02007836 Note that the command running in the terminal window may still change
7837 the size of the terminal. In that case the Vim window will be
7838 adjusted to that size, if possible.
Bram Moolenaar74675a62017-07-15 13:53:23 +02007839
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01007840 *'termwintype'* *'twt'*
7841'termwintype' 'twt' string (default "")
7842 global
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01007843 {only available when compiled with the |terminal|
7844 feature on MS-Windows}
7845 Specify the virtual console (pty) used when opening the terminal
7846 window.
7847
7848 Possible values are:
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01007849 "" use ConPTY if it is stable, winpty otherwise
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01007850 "winpty" use winpty, fail if not supported
7851 "conpty" use |ConPTY|, fail if not supported
7852
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01007853 |ConPTY| support depends on the platform. Windows 10 October 2018
7854 Update is the first version that supports ConPTY, however it is still
7855 considered unstable. ConPTY might become stable in the next release
7856 of Windows 10. winpty support needs to be installed. If neither is
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01007857 supported then you cannot open a terminal window.
7858
Bram Moolenaar071d4272004-06-13 20:20:40 +00007859 *'terse'* *'noterse'*
7860'terse' boolean (default off)
7861 global
7862 When set: Add 's' flag to 'shortmess' option (this makes the message
7863 for a search that hits the start or end of the file not being
7864 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
7865 shortens a lot of messages}
7866
7867 *'textauto'* *'ta'* *'notextauto'* *'nota'*
7868'textauto' 'ta' boolean (Vim default: on, Vi default: off)
7869 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007870 This option is obsolete. Use 'fileformats'.
7871 For backwards compatibility, when 'textauto' is set, 'fileformats' is
7872 set to the default value for the current system. When 'textauto' is
7873 reset, 'fileformats' is made empty.
7874 NOTE: This option is set to the Vi default value when 'compatible' is
7875 set and to the Vim default value when 'compatible' is reset.
7876
7877 *'textmode'* *'tx'* *'notextmode'* *'notx'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01007878'textmode' 'tx' boolean (Win32: default on,
Bram Moolenaar071d4272004-06-13 20:20:40 +00007879 others: default off)
7880 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007881 This option is obsolete. Use 'fileformat'.
7882 For backwards compatibility, when 'textmode' is set, 'fileformat' is
7883 set to "dos". When 'textmode' is reset, 'fileformat' is set to
7884 "unix".
7885
7886 *'textwidth'* *'tw'*
7887'textwidth' 'tw' number (default 0)
7888 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007889 Maximum width of text that is being inserted. A longer line will be
7890 broken after white space to get this width. A zero value disables
Bram Moolenaarca635012015-09-25 20:34:21 +02007891 this.
7892 'textwidth' is set to 0 when the 'paste' option is set and restored
7893 when 'paste' is reset.
7894 When 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00007895 'formatoptions' and |ins-textwidth|.
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00007896 When 'formatexpr' is set it will be used to break the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007897 NOTE: This option is set to 0 when 'compatible' is set.
7898
7899 *'thesaurus'* *'tsr'*
7900'thesaurus' 'tsr' string (default "")
7901 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007902 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01007903 for thesaurus completion commands |i_CTRL-X_CTRL-T|.
7904
7905 Each line in the file should contain words with similar meaning,
7906 separated by non-keyword characters (white space is preferred).
7907 Maximum line length is 510 bytes.
7908
Bram Moolenaard47d5222018-12-09 20:43:55 +01007909 An English word list was added to this github issue:
7910 https://github.com/vim/vim/issues/629#issuecomment-443293282
7911 Unpack thesaurus_pkg.zip, put the thesaurus.txt file somewhere, e.g.
7912 ~/.vim/thesaurus/english.txt, and the 'thesaurus' option to this file
7913 name.
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01007914
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007915 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00007916 after a comma are ignored, otherwise spaces are included in the file
7917 name. See |option-backslash| about using backslashes.
7918 The use of |:set+=| and |:set-=| is preferred when adding or removing
7919 directories from the list. This avoids problems when a future version
7920 uses another default.
7921 Backticks cannot be used in this option for security reasons.
7922
7923 *'tildeop'* *'top'* *'notildeop'* *'notop'*
7924'tildeop' 'top' boolean (default off)
7925 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007926 When on: The tilde command "~" behaves like an operator.
7927 NOTE: This option is reset when 'compatible' is set.
7928
7929 *'timeout'* *'to'* *'notimeout'* *'noto'*
7930'timeout' 'to' boolean (default on)
7931 global
7932 *'ttimeout'* *'nottimeout'*
Bram Moolenaar94237492017-04-23 18:40:21 +02007933'ttimeout' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007934 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007935 These two options together determine the behavior when part of a
7936 mapped key sequence or keyboard code has been received:
7937
7938 'timeout' 'ttimeout' action ~
7939 off off do not time out
7940 on on or off time out on :mappings and key codes
7941 off on time out on key codes
7942
7943 If both options are off, Vim will wait until either the complete
7944 mapping or key sequence has been received, or it is clear that there
7945 is no mapping or key sequence for the received characters. For
7946 example: if you have mapped "vl" and Vim has received 'v', the next
7947 character is needed to see if the 'v' is followed by an 'l'.
7948 When one of the options is on, Vim will wait for about 1 second for
7949 the next character to arrive. After that the already received
7950 characters are interpreted as single characters. The waiting time can
7951 be changed with the 'timeoutlen' option.
7952 On slow terminals or very busy systems timing out may cause
7953 malfunctioning cursor keys. If both options are off, Vim waits
7954 forever after an entered <Esc> if there are key codes that start
7955 with <Esc>. You will have to type <Esc> twice. If you do not have
7956 problems with key codes, but would like to have :mapped key
7957 sequences not timing out in 1 second, set the 'ttimeout' option and
7958 reset the 'timeout' option.
7959
7960 NOTE: 'ttimeout' is reset when 'compatible' is set.
7961
7962 *'timeoutlen'* *'tm'*
7963'timeoutlen' 'tm' number (default 1000)
7964 global
Bram Moolenaar25c9c682019-05-05 18:13:34 +02007965
Bram Moolenaar071d4272004-06-13 20:20:40 +00007966 *'ttimeoutlen'* *'ttm'*
Bram Moolenaar94237492017-04-23 18:40:21 +02007967'ttimeoutlen' 'ttm' number (default -1, set to 100 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007968 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007969 The time in milliseconds that is waited for a key code or mapped key
7970 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
7971 when part of a command has been typed.
7972 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
7973 different timeout value for key codes is desired set 'ttimeoutlen' to
7974 a non-negative number.
7975
7976 ttimeoutlen mapping delay key code delay ~
7977 < 0 'timeoutlen' 'timeoutlen'
7978 >= 0 'timeoutlen' 'ttimeoutlen'
7979
7980 The timeout only happens when the 'timeout' and 'ttimeout' options
7981 tell so. A useful setting would be >
7982 :set timeout timeoutlen=3000 ttimeoutlen=100
7983< (time out on mapping after three seconds, time out on key codes after
7984 a tenth of a second).
7985
7986 *'title'* *'notitle'*
7987'title' boolean (default off, on when title can be restored)
7988 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007989 {not available when compiled without the |+title|
7990 feature}
7991 When on, the title of the window will be set to the value of
7992 'titlestring' (if it is not empty), or to:
7993 filename [+=-] (path) - VIM
7994 Where:
7995 filename the name of the file being edited
7996 - indicates the file cannot be modified, 'ma' off
7997 + indicates the file was modified
7998 = indicates the file is read-only
7999 =+ indicates the file is read-only and modified
8000 (path) is the path of the file being edited
8001 - VIM the server name |v:servername| or "VIM"
8002 Only works if the terminal supports setting window titles
8003 (currently Amiga console, Win32 console, all GUI versions and
Bram Moolenaard1caa942020-04-10 22:10:56 +02008004 terminals with a non-empty 't_ts' option - these are Unix xterm and
Bram Moolenaar071d4272004-06-13 20:20:40 +00008005 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
8006 *X11*
8007 When Vim was compiled with HAVE_X11 defined, the original title will
8008 be restored if possible. The output of ":version" will include "+X11"
8009 when HAVE_X11 was defined, otherwise it will be "-X11". This also
8010 works for the icon name |'icon'|.
8011 But: When Vim was started with the |-X| argument, restoring the title
8012 will not work (except in the GUI).
8013 If the title cannot be restored, it is set to the value of 'titleold'.
8014 You might want to restore the title outside of Vim then.
8015 When using an xterm from a remote machine you can use this command:
8016 rsh machine_name xterm -display $DISPLAY &
8017 then the WINDOWID environment variable should be inherited and the
8018 title of the window should change back to what it should be after
8019 exiting Vim.
8020
8021 *'titlelen'*
8022'titlelen' number (default 85)
8023 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008024 {not available when compiled without the |+title|
8025 feature}
8026 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008027 title. When the title is longer, only the end of the path name is
8028 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008029 Using a percentage makes this adapt to the width of the window. But
8030 it won't work perfectly, because the actual number of characters
8031 available also depends on the font used and other things in the title
8032 bar. When 'titlelen' is zero the full path is used. Otherwise,
8033 values from 1 to 30000 percent can be used.
8034 'titlelen' is also used for the 'titlestring' option.
8035
8036 *'titleold'*
8037'titleold' string (default "Thanks for flying Vim")
8038 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008039 {only available when compiled with the |+title|
8040 feature}
8041 This option will be used for the window title when exiting Vim if the
8042 original title cannot be restored. Only happens if 'title' is on or
8043 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00008044 This option cannot be set from a |modeline| or in the |sandbox|, for
8045 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008046 *'titlestring'*
8047'titlestring' string (default "")
8048 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008049 {not available when compiled without the |+title|
8050 feature}
8051 When this option is not empty, it will be used for the title of the
8052 window. This happens only when the 'title' option is on.
8053 Only works if the terminal supports setting window titles (currently
8054 Amiga console, Win32 console, all GUI versions and terminals with a
8055 non-empty 't_ts' option).
8056 When Vim was compiled with HAVE_X11 defined, the original title will
Bram Moolenaar51628222016-12-01 23:03:28 +01008057 be restored if possible, see |X11|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008058
Bram Moolenaar071d4272004-06-13 20:20:40 +00008059 When this option contains printf-style '%' items, they will be
8060 expanded according to the rules used for 'statusline'.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008061 This option cannot be set in a modeline when 'modelineexpr' is off.
8062
Bram Moolenaar071d4272004-06-13 20:20:40 +00008063 Example: >
8064 :auto BufEnter * let &titlestring = hostname() . "/" . expand("%:p")
8065 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
8066< The value of 'titlelen' is used to align items in the middle or right
8067 of the available space.
8068 Some people prefer to have the file name first: >
8069 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
8070< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008071 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00008072 separating space only when needed.
8073 NOTE: Use of special characters in 'titlestring' may cause the display
8074 to be garbled (e.g., when it contains a CR or NL character).
8075 {not available when compiled without the |+statusline| feature}
8076
8077 *'toolbar'* *'tb'*
8078'toolbar' 'tb' string (default "icons,tooltips")
8079 global
8080 {only for |+GUI_GTK|, |+GUI_Athena|, |+GUI_Motif| and
8081 |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008082 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00008083 possible values are:
8084 icons Toolbar buttons are shown with icons.
8085 text Toolbar buttons shown with text.
8086 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008087 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008088 tooltips Tooltips are active for toolbar buttons.
8089 Tooltips refer to the popup help text which appears after the mouse
8090 cursor is placed over a toolbar button for a brief moment.
8091
8092 If you want the toolbar to be shown with icons as well as text, do the
8093 following: >
8094 :set tb=icons,text
8095< Motif and Athena cannot display icons and text at the same time. They
8096 will show icons if both are requested.
8097
8098 If none of the strings specified in 'toolbar' are valid or if
8099 'toolbar' is empty, this option is ignored. If you want to disable
8100 the toolbar, you need to set the 'guioptions' option. For example: >
8101 :set guioptions-=T
8102< Also see |gui-toolbar|.
8103
8104 *'toolbariconsize'* *'tbis'*
8105'toolbariconsize' 'tbis' string (default "small")
8106 global
Bram Moolenaar3df01732017-02-17 22:47:16 +01008107 {only in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008108 Controls the size of toolbar icons. The possible values are:
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008109 tiny Use tiny icons.
8110 small Use small icons (default).
8111 medium Use medium-sized icons.
8112 large Use large icons.
8113 huge Use even larger icons.
8114 giant Use very big icons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008115 The exact dimensions in pixels of the various icon sizes depend on
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008116 the current theme. Common dimensions are giant=48x48, huge=32x32,
8117 large=24x24, medium=24x24, small=20x20 and tiny=16x16.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008118
8119 If 'toolbariconsize' is empty, the global default size as determined
8120 by user preferences or the current theme is used.
8121
8122 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
8123'ttybuiltin' 'tbi' boolean (default on)
8124 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008125 When on, the builtin termcaps are searched before the external ones.
8126 When off the builtin termcaps are searched after the external ones.
8127 When this option is changed, you should set the 'term' option next for
8128 the change to take effect, for example: >
8129 :set notbi term=$TERM
8130< See also |termcap|.
8131 Rationale: The default for this option is "on", because the builtin
8132 termcap entries are generally better (many systems contain faulty
8133 xterm entries...).
8134
8135 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
8136'ttyfast' 'tf' boolean (default off, on when 'term' is xterm, hpterm,
8137 sun-cmd, screen, rxvt, dtterm or
8138 iris-ansi; also on when running Vim in
8139 a DOS console)
8140 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008141 Indicates a fast terminal connection. More characters will be sent to
8142 the screen for redrawing, instead of using insert/delete line
8143 commands. Improves smoothness of redrawing when there are multiple
8144 windows and the terminal does not support a scrolling region.
8145 Also enables the extra writing of characters at the end of each screen
8146 line for lines that wrap. This helps when using copy/paste with the
8147 mouse in an xterm and other terminals.
8148
8149 *'ttymouse'* *'ttym'*
8150'ttymouse' 'ttym' string (default depends on 'term')
8151 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008152 {only in Unix and VMS, doesn't work in the GUI; not
8153 available when compiled without |+mouse|}
8154 Name of the terminal type for which mouse codes are to be recognized.
Bram Moolenaar2c7a7632007-05-10 18:19:11 +00008155 Currently these strings are valid:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008156 *xterm-mouse*
8157 xterm xterm-like mouse handling. The mouse generates
8158 "<Esc>[Mscr", where "scr" is three bytes:
8159 "s" = button state
8160 "c" = column plus 33
8161 "r" = row plus 33
Bram Moolenaare968e362014-05-13 20:23:24 +02008162 This only works up to 223 columns! See "dec",
8163 "urxvt", and "sgr" for solutions.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008164 xterm2 Works like "xterm", but with the xterm reporting the
8165 mouse position while the mouse is dragged. This works
8166 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00008167 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00008168 work. See below for how Vim detects this
8169 automatically.
8170 *netterm-mouse*
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008171 netterm NetTerm mouse handling. A left mouse click generates
Bram Moolenaar071d4272004-06-13 20:20:40 +00008172 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008173 for the row and column. No other mouse events are
8174 supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008175 *dec-mouse*
8176 dec DEC terminal mouse handling. The mouse generates a
8177 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00008178 This is also available for an Xterm, if it was
8179 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00008180 *jsbterm-mouse*
8181 jsbterm JSB term mouse handling.
8182 *pterm-mouse*
8183 pterm QNX pterm mouse handling.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008184 *urxvt-mouse*
8185 urxvt Mouse handling for the urxvt (rxvt-unicode) terminal.
Bram Moolenaare968e362014-05-13 20:23:24 +02008186 The mouse works only if the terminal supports this
8187 encoding style, but it does not have 223 columns limit
8188 unlike "xterm" or "xterm2".
Bram Moolenaar9b451252012-08-15 17:43:31 +02008189 *sgr-mouse*
8190 sgr Mouse handling for the terminal that emits SGR-styled
Bram Moolenaare968e362014-05-13 20:23:24 +02008191 mouse reporting. The mouse works even in columns
8192 beyond 223. This option is backward compatible with
8193 "xterm2" because it can also decode "xterm2" style
8194 mouse codes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008195
8196 The mouse handling must be enabled at compile time |+mouse_xterm|
Bram Moolenaare968e362014-05-13 20:23:24 +02008197 |+mouse_dec| |+mouse_netterm| |+mouse_jsbterm| |+mouse_urxvt|
8198 |+mouse_sgr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008199 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
8200 recognized, if enabled at compile time. DEC terminal mouse codes
8201 are recognized if enabled at compile time, and 'ttymouse' is not
Bram Moolenaare968e362014-05-13 20:23:24 +02008202 "xterm", "xterm2", "urxvt" or "sgr" (because dec mouse codes conflict
8203 with them).
Bram Moolenaar071d4272004-06-13 20:20:40 +00008204 This option is automatically set to "xterm", when the 'term' option is
Bram Moolenaar45758762016-10-12 23:08:06 +02008205 set to a name that starts with "xterm", "mlterm", "screen", "tmux",
8206 "st" (full match only), "st-" or "stterm", and 'ttymouse' is not set
8207 already.
Bram Moolenaare968e362014-05-13 20:23:24 +02008208 Additionally, if vim is compiled with the |+termresponse| feature and
8209 |t_RV| is set to the escape sequence to request the xterm version
Bram Moolenaarf8a07122019-07-01 22:06:07 +02008210 number, more intelligent detection is done.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008211 The "xterm2" value will be set if the xterm version is reported to be
Bram Moolenaard47d5222018-12-09 20:43:55 +01008212 from 95 to 276. The "sgr" value will be set if Vim detects Mac
8213 Terminal.app, iTerm2 or mintty, and when the xterm version is 277 or
8214 higher.
Bram Moolenaare968e362014-05-13 20:23:24 +02008215 If you do not want 'ttymouse' to be set to "xterm2" or "sgr"
8216 automatically, set t_RV to an empty string: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008217 :set t_RV=
8218<
8219 *'ttyscroll'* *'tsl'*
8220'ttyscroll' 'tsl' number (default 999)
8221 global
8222 Maximum number of lines to scroll the screen. If there are more lines
8223 to scroll the window is redrawn. For terminals where scrolling is
8224 very slow and redrawing is not slow this can be set to a small number,
8225 e.g., 3, to speed up displaying.
8226
8227 *'ttytype'* *'tty'*
8228'ttytype' 'tty' string (default from $TERM)
8229 global
8230 Alias for 'term', see above.
8231
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008232 *'undodir'* *'udir'*
8233'undodir' 'udir' string (default ".")
8234 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008235 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008236 List of directory names for undo files, separated with commas.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008237 See |'backupdir'| for details of the format.
Bram Moolenaar6a244fe2010-05-24 22:02:24 +02008238 "." means using the directory of the file. The undo file name for
8239 "file.txt" is ".file.txt.un~".
8240 For other directories the file name is the full path of the edited
8241 file, with path separators replaced with "%".
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008242 When writing: The first directory that exists is used. "." always
8243 works, no directories after "." will be used for writing.
8244 When reading all entries are tried to find an undo file. The first
8245 undo file that exists is used. When it cannot be read an error is
8246 given, no further entry is used.
8247 See |undo-persistence|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008248 This option cannot be set from a |modeline| or in the |sandbox|, for
8249 security reasons.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008250
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02008251 *'undofile'* *'noundofile'* *'udf'* *'noudf'*
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008252'undofile' 'udf' boolean (default off)
8253 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02008254 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008255 When on, Vim automatically saves undo history to an undo file when
8256 writing a buffer to a file, and restores undo history from the same
8257 file on buffer read.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008258 The directory where the undo file is stored is specified by 'undodir'.
8259 For more information about this feature see |undo-persistence|.
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008260 The undo file is not read when 'undoreload' causes the buffer from
8261 before a reload to be saved for undo.
Bram Moolenaar97d62492012-11-15 21:28:22 +01008262 When 'undofile' is turned off the undo file is NOT deleted.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008263 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008264
Bram Moolenaar071d4272004-06-13 20:20:40 +00008265 *'undolevels'* *'ul'*
Bram Moolenaar8024f932020-01-14 19:29:13 +01008266'undolevels' 'ul' number (default 100, 1000 for Unix, VMS and Win32)
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008267 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008268 Maximum number of changes that can be undone. Since undo information
Bram Moolenaar5be4cee2019-09-27 19:34:08 +02008269 is kept in memory, higher numbers will cause more memory to be used.
8270 Nevertheless, a single change can already use a large amount of memory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008271 Set to 0 for Vi compatibility: One level of undo and "u" undoes
8272 itself: >
8273 set ul=0
8274< But you can also get Vi compatibility by including the 'u' flag in
8275 'cpoptions', and still be able to use CTRL-R to repeat undo.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008276 Also see |undo-two-ways|.
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008277 Set to -1 for no undo at all. You might want to do this only for the
8278 current buffer: >
8279 setlocal ul=-1
Bram Moolenaar071d4272004-06-13 20:20:40 +00008280< This helps when you run out of memory for a single change.
Bram Moolenaar32efaf62014-11-05 17:02:17 +01008281
8282 The local value is set to -123456 when the global value is to be used.
8283
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008284 Also see |clear-undo|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008285
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008286 *'undoreload'* *'ur'*
8287'undoreload' 'ur' number (default 10000)
8288 global
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008289 Save the whole buffer for undo when reloading it. This applies to the
8290 ":e!" command and reloading for when the buffer changed outside of
8291 Vim. |FileChangedShell|
Bram Moolenaar24a98a02017-09-27 22:23:55 +02008292 The save only happens when this option is negative or when the number
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008293 of lines is smaller than the value of this option.
8294 Set this option to zero to disable undo for a reload.
8295
8296 When saving undo for a reload, any undo file is not read.
8297
8298 Note that this causes the whole buffer to be stored in memory. Set
8299 this option to a lower value if you run out of memory.
8300
Bram Moolenaar071d4272004-06-13 20:20:40 +00008301 *'updatecount'* *'uc'*
8302'updatecount' 'uc' number (default: 200)
8303 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008304 After typing this many characters the swap file will be written to
8305 disk. When zero, no swap file will be created at all (see chapter on
8306 recovery |crash-recovery|). 'updatecount' is set to zero by starting
8307 Vim with the "-n" option, see |startup|. When editing in readonly
8308 mode this option will be initialized to 10000.
8309 The swapfile can be disabled per buffer with |'swapfile'|.
8310 When 'updatecount' is set from zero to non-zero, swap files are
8311 created for all buffers that have 'swapfile' set. When 'updatecount'
8312 is set to zero, existing swap files are not deleted.
8313 Also see |'swapsync'|.
8314 This option has no meaning in buffers where |'buftype'| is "nofile"
8315 or "nowrite".
8316
8317 *'updatetime'* *'ut'*
8318'updatetime' 'ut' number (default 4000)
8319 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008320 If this many milliseconds nothing is typed the swap file will be
8321 written to disk (see |crash-recovery|). Also used for the
8322 |CursorHold| autocommand event.
8323
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008324 *'varsofttabstop'* *'vsts'*
8325'varsofttabstop' 'vsts' string (default "")
8326 local to buffer
8327 {only available when compiled with the |+vartabs|
8328 feature}
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008329 A list of the number of spaces that a <Tab> counts for while editing,
8330 such as inserting a <Tab> or using <BS>. It "feels" like variable-
8331 width <Tab>s are being inserted, while in fact a mixture of spaces
8332 and <Tab>s is used. Tab widths are separated with commas, with the
8333 final value applying to all subsequent tabs.
8334
8335 For example, when editing assembly language files where statements
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02008336 start in the 9th column and comments in the 41st, it may be useful
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008337 to use the following: >
8338 :set varsofttabstop=8,32,8
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02008339< This will set soft tabstops with 8 and 8 + 32 spaces, and 8 more
8340 for every column thereafter.
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008341
8342 Note that the value of |'softtabstop'| will be ignored while
8343 'varsofttabstop' is set.
8344
8345 *'vartabstop'* *'vts'*
8346'vartabstop' 'vts' string (default "")
8347 local to buffer
8348 {only available when compiled with the |+vartabs|
8349 feature}
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008350 A list of the number of spaces that a <Tab> in the file counts for,
8351 separated by commas. Each value corresponds to one tab, with the
8352 final value applying to all subsequent tabs. For example: >
8353 :set vartabstop=4,20,10,8
8354< This will make the first tab 4 spaces wide, the second 20 spaces,
8355 the third 10 spaces, and all following tabs 8 spaces.
8356
8357 Note that the value of |'tabstop'| will be ignored while 'vartabstop'
8358 is set.
8359
Bram Moolenaar071d4272004-06-13 20:20:40 +00008360 *'verbose'* *'vbs'*
8361'verbose' 'vbs' number (default 0)
8362 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008363 When bigger than zero, Vim will give messages about what it is doing.
8364 Currently, these messages are given:
8365 >= 1 When the viminfo file is read or written.
8366 >= 2 When a file is ":source"'ed.
Bram Moolenaar647a5302020-05-03 17:01:24 +02008367 >= 4 Shell commands.
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008368 >= 5 Every searched tags file and include file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008369 >= 8 Files for which a group of autocommands is executed.
8370 >= 9 Every executed autocommand.
Bram Moolenaar647a5302020-05-03 17:01:24 +02008371 >= 11 Finding items in a path
Bram Moolenaar071d4272004-06-13 20:20:40 +00008372 >= 12 Every executed function.
8373 >= 13 When an exception is thrown, caught, finished, or discarded.
8374 >= 14 Anything pending in a ":finally" clause.
Bram Moolenaar823654b2020-05-29 23:03:09 +02008375 >= 15 Every executed Ex command from a script (truncated at 200
8376 characters).
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02008377 >= 16 Every executed Ex command.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008378
8379 This option can also be set with the "-V" argument. See |-V|.
8380 This option is also set by the |:verbose| command.
8381
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008382 When the 'verbosefile' option is set then the verbose messages are not
8383 displayed.
8384
8385 *'verbosefile'* *'vfile'*
8386'verbosefile' 'vfile' string (default empty)
8387 global
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008388 When not empty all messages are written in a file with this name.
8389 When the file exists messages are appended.
8390 Writing to the file ends when Vim exits or when 'verbosefile' is made
Bram Moolenaar80794b12010-06-13 05:20:42 +02008391 empty. Writes are buffered, thus may not show up for some time.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008392 Setting 'verbosefile' to a new value is like making it empty first.
8393 The difference with |:redir| is that verbose messages are not
8394 displayed when 'verbosefile' is set.
8395
Bram Moolenaar071d4272004-06-13 20:20:40 +00008396 *'viewdir'* *'vdir'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008397'viewdir' 'vdir' string (default for Amiga and Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008398 "$VIM/vimfiles/view",
8399 for Unix: "~/.vim/view",
8400 for Macintosh: "$VIM:vimfiles:view"
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01008401 for VMS: "sys$login:vimfiles/view")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008402 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008403 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008404 feature}
8405 Name of the directory where to store files for |:mkview|.
8406 This option cannot be set from a |modeline| or in the |sandbox|, for
8407 security reasons.
8408
8409 *'viewoptions'* *'vop'*
Bram Moolenaar13e90412017-11-11 18:16:48 +01008410'viewoptions' 'vop' string (default: "folds,options,cursor,curdir")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008411 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008412 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008413 feature}
8414 Changes the effect of the |:mkview| command. It is a comma separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008415 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008416 word save and restore ~
8417 cursor cursor position in file and in window
8418 folds manually created folds, opened/closed folds and local
8419 fold options
8420 options options and mappings local to a window or buffer (not
8421 global values for local options)
Bram Moolenaar6e932462014-09-09 18:48:09 +02008422 localoptions same as "options"
Bram Moolenaar071d4272004-06-13 20:20:40 +00008423 slash backslashes in file names replaced with forward
8424 slashes
8425 unix with Unix end-of-line format (single <NL>), even when
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008426 on MS-Windows
Bram Moolenaar13e90412017-11-11 18:16:48 +01008427 curdir the window-local directory, if set with `:lcd`
Bram Moolenaar071d4272004-06-13 20:20:40 +00008428
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008429 "slash" and "unix" are useful on MS-Windows when sharing view files
Bram Moolenaar071d4272004-06-13 20:20:40 +00008430 with Unix. The Unix version of Vim cannot source dos format scripts,
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008431 but the MS-Windows version of Vim can source unix format scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008432
8433 *'viminfo'* *'vi'* *E526* *E527* *E528*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008434'viminfo' 'vi' string (Vi default: "", Vim default for
8435 MS-Windows: '100,<50,s10,h,rA:,rB:,
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01008436 for Amiga: '100,<50,s10,h,rdf0:,rdf1:,rdf2:
8437 for others: '100,<50,s10,h)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008438 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008439 {not available when compiled without the |+viminfo|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008440 feature}
8441 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008442 when exiting Vim (see |viminfo-file|). Except when 'viminfofile' is
8443 "NONE".
8444 The string should be a comma separated list of parameters, each
8445 consisting of a single character identifying the particular parameter,
8446 followed by a number or string which specifies the value of that
8447 parameter. If a particular character is left out, then the default
8448 value is used for that parameter. The following is a list of the
8449 identifying characters and the effect of their value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008450 CHAR VALUE ~
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008451 *viminfo-!*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008452 ! When included, save and restore global variables that start
8453 with an uppercase letter, and don't contain a lowercase
8454 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar680eeca2010-10-20 17:44:42 +02008455 and "_K_L_M" are not. Nested List and Dict items may not be
Bram Moolenaar166af9b2010-11-16 20:34:40 +01008456 read back correctly, you end up with an empty item.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008457 *viminfo-quote*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008458 " Maximum number of lines saved for each register. Old name of
8459 the '<' item, with the disadvantage that you need to put a
8460 backslash before the ", otherwise it will be recognized as the
8461 start of a comment!
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008462 *viminfo-%*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008463 % When included, save and restore the buffer list. If Vim is
8464 started with a file name argument, the buffer list is not
8465 restored. If Vim is started without a file name argument, the
Bram Moolenaard042dc82015-11-24 19:18:36 +01008466 buffer list is restored from the viminfo file. Quickfix
8467 ('buftype'), unlisted ('buflisted'), unnamed and buffers on
8468 removable media (|viminfo-r|) are not saved.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00008469 When followed by a number, the number specifies the maximum
8470 number of buffers that are stored. Without a number all
8471 buffers are stored.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008472 *viminfo-'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008473 ' Maximum number of previously edited files for which the marks
8474 are remembered. This parameter must always be included when
8475 'viminfo' is non-empty.
8476 Including this item also means that the |jumplist| and the
8477 |changelist| are stored in the viminfo file.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008478 *viminfo-/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008479 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008480 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00008481 patterns are also saved. When not included, the value of
8482 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008483 *viminfo-:*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008484 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008485 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008486 *viminfo-<*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008487 < Maximum number of lines saved for each register. If zero then
8488 registers are not saved. When not included, all lines are
8489 saved. '"' is the old name for this item.
8490 Also see the 's' item below: limit specified in Kbyte.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008491 *viminfo-@*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008492 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008493 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008494 *viminfo-c*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008495 c When included, convert the text in the viminfo file from the
8496 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00008497 'encoding'. See |viminfo-encoding|.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008498 *viminfo-f*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008499 f Whether file marks need to be stored. If zero, file marks ('0
8500 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008501 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00008502 cursor position (when exiting or when doing ":wviminfo").
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008503 *viminfo-h*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008504 h Disable the effect of 'hlsearch' when loading the viminfo
8505 file. When not included, it depends on whether ":nohlsearch"
8506 has been used since the last search command.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008507 *viminfo-n*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008508 n Name of the viminfo file. The name must immediately follow
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008509 the 'n'. Must be at the end of the option! If the
8510 'viminfofile' option is set, that file name overrides the one
8511 given here with 'viminfo'. Environment variables are
Bram Moolenaar063b9d12016-07-09 20:21:48 +02008512 expanded when opening the file, not when setting the option.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008513 *viminfo-r*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008514 r Removable media. The argument is a string (up to the next
8515 ','). This parameter can be given several times. Each
8516 specifies the start of a path for which no marks will be
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01008517 stored. This is to avoid removable media. For MS-Windows you
Bram Moolenaar071d4272004-06-13 20:20:40 +00008518 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
8519 also use it for temp files, e.g., for Unix: "r/tmp". Case is
8520 ignored. Maximum length of each 'r' argument is 50
8521 characters.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008522 *viminfo-s*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008523 s Maximum size of an item in Kbyte. If zero then registers are
8524 not saved. Currently only applies to registers. The default
8525 "s10" will exclude registers with more than 10 Kbyte of text.
8526 Also see the '<' item above: line count limit.
8527
8528 Example: >
8529 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
8530<
8531 '50 Marks will be remembered for the last 50 files you
8532 edited.
8533 <1000 Contents of registers (up to 1000 lines each) will be
8534 remembered.
8535 s100 Registers with more than 100 Kbyte text are skipped.
8536 :0 Command-line history will not be saved.
8537 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
8538 no / Since '/' is not specified, the default will be used,
8539 that is, save all of the search history, and also the
8540 previous search and substitute patterns.
8541 no % The buffer list will not be saved nor read back.
8542 no h 'hlsearch' highlighting will be restored.
8543
8544 When setting 'viminfo' from an empty value you can use |:rviminfo| to
8545 load the contents of the file, this is not done automatically.
8546
8547 This option cannot be set from a |modeline| or in the |sandbox|, for
8548 security reasons.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008549 NOTE: This option is set to the Vim default value when 'compatible'
8550 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008551
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008552 *'viminfofile'* *'vif'*
8553'viminfofile' 'vif' string (default: "")
8554 global
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008555 {not available when compiled without the |+viminfo|
8556 feature}
8557 When non-empty, overrides the file name used for viminfo.
8558 When equal to "NONE" no viminfo file will be read or written.
8559 This option can be set with the |-i| command line flag. The |--clean|
8560 command line flag sets it to "NONE".
Bram Moolenaar110289e2019-05-23 15:38:06 +02008561 This option cannot be set from a |modeline| or in the |sandbox|, for
8562 security reasons.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008563
Bram Moolenaar071d4272004-06-13 20:20:40 +00008564 *'virtualedit'* *'ve'*
8565'virtualedit' 've' string (default "")
8566 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008567 A comma separated list of these words:
8568 block Allow virtual editing in Visual block mode.
8569 insert Allow virtual editing in Insert mode.
8570 all Allow virtual editing in all modes.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008571 onemore Allow the cursor to move just past the end of the line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008572
Bram Moolenaar071d4272004-06-13 20:20:40 +00008573 Virtual editing means that the cursor can be positioned where there is
Bram Moolenaarebcbd022007-05-12 14:28:25 +00008574 no actual character. This can be halfway into a tab or beyond the end
Bram Moolenaar071d4272004-06-13 20:20:40 +00008575 of the line. Useful for selecting a rectangle in Visual mode and
8576 editing a table.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008577 "onemore" is not the same, it will only allow moving the cursor just
8578 after the last character of the line. This makes some commands more
8579 consistent. Previously the cursor was always past the end of the line
8580 if the line was empty. But it is far from Vi compatible. It may also
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008581 break some plugins or Vim scripts. For example because |l| can move
8582 the cursor after the last character. Use with care!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02008583 Using the `$` command will move to the last character in the line, not
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008584 past it. This may actually move the cursor to the left!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02008585 The `g$` command will move to the end of the screen line.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008586 It doesn't make sense to combine "all" with "onemore", but you will
8587 not get a warning for it.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008588 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008589
8590 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
8591'visualbell' 'vb' boolean (default off)
8592 global
Bram Moolenaar74675a62017-07-15 13:53:23 +02008593 Use a visual bell instead of beeping. The terminal code to display the
Bram Moolenaar071d4272004-06-13 20:20:40 +00008594 visual bell is given with 't_vb'. When no beep or flash is wanted,
Bram Moolenaar74675a62017-07-15 13:53:23 +02008595 use: >
8596 :set vb t_vb=
8597< If you want a short flash, you can use this on many terminals: >
8598 :set vb t_vb=[?5h$<100>[?5l
8599< Here $<100> specifies the time, you can use a smaller or bigger value
8600 to get a shorter or longer flash.
8601
8602 Note: Vim will limit the bell to once per half a second. This avoids
8603 having to wait for the flashing to finish when there are lots of
8604 bells, e.g. on key repeat. This also happens without 'visualbell'
8605 set.
8606
Bram Moolenaar071d4272004-06-13 20:20:40 +00008607 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
8608 for 20 msec. If you want to use a different time, use "<Esc>|40f",
8609 where 40 is the time in msec.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008610
8611 Note: When the GUI starts, 't_vb' is reset to its default value. You
8612 might want to set it again in your |gvimrc|.
8613
Bram Moolenaar071d4272004-06-13 20:20:40 +00008614 Does not work on the Amiga, you always get a screen flash.
8615 Also see 'errorbells'.
8616
8617 *'warn'* *'nowarn'*
8618'warn' boolean (default on)
8619 global
8620 Give a warning message when a shell command is used while the buffer
8621 has been changed.
8622
8623 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
8624'weirdinvert' 'wiv' boolean (default off)
8625 global
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00008626 This option has the same effect as the 't_xs' terminal option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008627 It is provided for backwards compatibility with version 4.x.
8628 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
8629 vice versa. Has no effect when the GUI is running.
8630
8631 *'whichwrap'* *'ww'*
8632'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
8633 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008634 Allow specified keys that move the cursor left/right to move to the
8635 previous/next line when the cursor is on the first/last character in
8636 the line. Concatenate characters to allow this for these keys:
8637 char key mode ~
8638 b <BS> Normal and Visual
8639 s <Space> Normal and Visual
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008640 h "h" Normal and Visual (not recommended)
8641 l "l" Normal and Visual (not recommended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008642 < <Left> Normal and Visual
8643 > <Right> Normal and Visual
8644 ~ "~" Normal
8645 [ <Left> Insert and Replace
8646 ] <Right> Insert and Replace
8647 For example: >
8648 :set ww=<,>,[,]
8649< allows wrap only when cursor keys are used.
8650 When the movement keys are used in combination with a delete or change
8651 operator, the <EOL> also counts for a character. This makes "3h"
8652 different from "3dh" when the cursor crosses the end of a line. This
8653 is also true for "x" and "X", because they do the same as "dl" and
8654 "dh". If you use this, you may also want to use the mapping
8655 ":map <BS> X" to make backspace delete the character in front of the
8656 cursor.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00008657 When 'l' is included and it is used after an operator at the end of a
Bram Moolenaar589edb32019-09-20 14:38:13 +02008658 line (not an empty line) then it will not move to the next line. This
8659 makes "dl", "cl", "yl" etc. work normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008660 NOTE: This option is set to the Vi default value when 'compatible' is
8661 set and to the Vim default value when 'compatible' is reset.
8662
8663 *'wildchar'* *'wc'*
8664'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
8665 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008666 Character you have to type to start wildcard expansion in the
8667 command-line, as specified with 'wildmode'.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008668 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008669 The character is not recognized when used inside a macro. See
8670 'wildcharm' for that.
8671 Although 'wc' is a number option, you can set it to a special key: >
8672 :set wc=<Esc>
8673< NOTE: This option is set to the Vi default value when 'compatible' is
8674 set and to the Vim default value when 'compatible' is reset.
8675
8676 *'wildcharm'* *'wcm'*
8677'wildcharm' 'wcm' number (default: none (0))
8678 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008679 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00008680 recognized when used inside a macro. You can find "spare" command-line
8681 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00008682 you'll never actually type 'wildcharm', just use it in mappings that
8683 automatically invoke completion mode, e.g.: >
8684 :set wcm=<C-Z>
Bram Moolenaar446cb832008-06-24 21:56:24 +00008685 :cnoremap ss so $vim/sessions/*.vim<C-Z>
Bram Moolenaar071d4272004-06-13 20:20:40 +00008686< Then after typing :ss you can use CTRL-P & CTRL-N.
8687
8688 *'wildignore'* *'wig'*
8689'wildignore' 'wig' string (default "")
8690 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008691 {not available when compiled without the |+wildignore|
8692 feature}
8693 A list of file patterns. A file that matches with one of these
Bram Moolenaar30b65812012-07-12 22:01:11 +02008694 patterns is ignored when expanding |wildcards|, completing file or
8695 directory names, and influences the result of |expand()|, |glob()| and
8696 |globpath()| unless a flag is passed to disable this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008697 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
8698 Also see 'suffixes'.
8699 Example: >
8700 :set wildignore=*.o,*.obj
8701< The use of |:set+=| and |:set-=| is preferred when adding or removing
8702 a pattern from the list. This avoids problems when a future version
8703 uses another default.
8704
Bram Moolenaar94950a92010-12-02 16:01:29 +01008705
Bram Moolenaar81af9252010-12-10 20:35:50 +01008706 *'wildignorecase'* *'wic'* *'nowildignorecase'* *'nowic'*
Bram Moolenaar94950a92010-12-02 16:01:29 +01008707'wildignorecase' 'wic' boolean (default off)
8708 global
Bram Moolenaar94950a92010-12-02 16:01:29 +01008709 When set case is ignored when completing file names and directories.
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01008710 Has no effect when 'fileignorecase' is set.
Bram Moolenaar94950a92010-12-02 16:01:29 +01008711 Does not apply when the shell is used to expand wildcards, which
8712 happens when there are special characters.
8713
8714
Bram Moolenaar071d4272004-06-13 20:20:40 +00008715 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02008716'wildmenu' 'wmnu' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008717 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008718 {not available if compiled without the |+wildmenu|
8719 feature}
8720 When 'wildmenu' is on, command-line completion operates in an enhanced
8721 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
8722 the possible matches are shown just above the command line, with the
8723 first match highlighted (overwriting the status line, if there is
8724 one). Keys that show the previous/next match, such as <Tab> or
8725 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
8726 When 'wildmode' is used, "wildmenu" mode is used where "full" is
8727 specified. "longest" and "list" do not start "wildmenu" mode.
Bram Moolenaar26402cb2013-02-20 21:26:00 +01008728 You can check the current mode with |wildmenumode()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008729 If there are more matches than can fit in the line, a ">" is shown on
8730 the right and/or a "<" is shown on the left. The status line scrolls
8731 as needed.
8732 The "wildmenu" mode is abandoned when a key is hit that is not used
8733 for selecting a completion.
8734 While the "wildmenu" is active the following keys have special
8735 meanings:
8736
8737 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
8738 <Down> - in filename/menu name completion: move into a
8739 subdirectory or submenu.
8740 <CR> - in menu completion, when the cursor is just after a
8741 dot: move into a submenu.
8742 <Up> - in filename/menu name completion: move up into
8743 parent directory or parent menu.
8744
8745 This makes the menus accessible from the console |console-menus|.
8746
8747 If you prefer the <Left> and <Right> keys to move the cursor instead
8748 of selecting a different match, use this: >
8749 :cnoremap <Left> <Space><BS><Left>
8750 :cnoremap <Right> <Space><BS><Right>
8751<
8752 The "WildMenu" highlighting is used for displaying the current match
8753 |hl-WildMenu|.
8754
8755 *'wildmode'* *'wim'*
8756'wildmode' 'wim' string (Vim default: "full")
8757 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008758 Completion mode that is used for the character specified with
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008759 'wildchar'. It is a comma separated list of up to four parts. Each
Bram Moolenaar02467872007-05-06 13:22:01 +00008760 part specifies what to do for each consecutive use of 'wildchar'. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00008761 first part specifies the behavior for the first use of 'wildchar',
8762 The second part for the second use, etc.
8763 These are the possible values for each part:
8764 "" Complete only the first match.
8765 "full" Complete the next full match. After the last match,
8766 the original string is used and then the first match
8767 again.
8768 "longest" Complete till longest common string. If this doesn't
8769 result in a longer string, use the next part.
8770 "longest:full" Like "longest", but also start 'wildmenu' if it is
8771 enabled.
8772 "list" When more than one match, list all matches.
8773 "list:full" When more than one match, list all matches and
8774 complete first match.
8775 "list:longest" When more than one match, list all matches and
8776 complete till longest common string.
Bram Moolenaar52410572019-10-27 05:12:45 +01008777 "list:lastused" When more than one buffer matches, sort buffers
8778 by time last used (other than the current buffer).
Bram Moolenaar071d4272004-06-13 20:20:40 +00008779 When there is only a single match, it is fully completed in all cases.
8780
8781 Examples: >
8782 :set wildmode=full
Bram Moolenaar582fd852005-03-28 20:58:01 +00008783< Complete first full match, next match, etc. (the default) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008784 :set wildmode=longest,full
8785< Complete longest common string, then each full match >
8786 :set wildmode=list:full
8787< List all matches and complete each full match >
8788 :set wildmode=list,full
8789< List all matches without completing, then each full match >
8790 :set wildmode=longest,list
8791< Complete longest common string, then list alternatives.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008792 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008793
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00008794 *'wildoptions'* *'wop'*
8795'wildoptions' 'wop' string (default "")
8796 global
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00008797 {not available when compiled without the |+wildignore|
8798 feature}
8799 A list of words that change how command line completion is done.
8800 Currently only one word is allowed:
8801 tagfile When using CTRL-D to list matching tags, the kind of
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00008802 tag and the file of the tag is listed. Only one match
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00008803 is displayed per line. Often used tag kinds are:
8804 d #define
8805 f function
8806 Also see |cmdline-completion|.
8807
Bram Moolenaar071d4272004-06-13 20:20:40 +00008808 *'winaltkeys'* *'wak'*
8809'winaltkeys' 'wak' string (default "menu")
8810 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008811 {only used in Win32, Motif, GTK and Photon GUI}
8812 Some GUI versions allow the access to menu entries by using the ALT
8813 key in combination with a character that appears underlined in the
8814 menu. This conflicts with the use of the ALT key for mappings and
8815 entering special characters. This option tells what to do:
8816 no Don't use ALT keys for menus. ALT key combinations can be
8817 mapped, but there is no automatic handling. This can then be
8818 done with the |:simalt| command.
8819 yes ALT key handling is done by the windowing system. ALT key
8820 combinations cannot be mapped.
8821 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008822 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00008823 keys can be mapped.
8824 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
8825 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00008826 This option is not used for <F10>; on Win32 and with GTK <F10> will
8827 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008828
Bram Moolenaar4d784b22019-05-25 19:51:39 +02008829 *'wincolor'* *'wcr'*
8830'wincolor' 'wcr' string (default empty)
8831 local to window
8832 Highlight group name to use for this window instead of the Normal
8833 color |hl-Normal|.
8834
Bram Moolenaar4399ef42005-02-12 14:29:27 +00008835 *'window'* *'wi'*
8836'window' 'wi' number (default screen height - 1)
8837 global
8838 Window height. Do not confuse this with the height of the Vim window,
8839 use 'lines' for that.
Bram Moolenaar19a09a12005-03-04 23:39:37 +00008840 Used for |CTRL-F| and |CTRL-B| when there is only one window and the
8841 value is smaller than 'lines' minus one. The screen will scroll
8842 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00008843 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
8844 in a much smarter way, taking care of wrapping lines.
8845 When resizing the Vim window, the value is smaller than 1 or more than
8846 or equal to 'lines' it will be set to 'lines' minus 1.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00008847
Bram Moolenaar071d4272004-06-13 20:20:40 +00008848 *'winheight'* *'wh'* *E591*
8849'winheight' 'wh' number (default 1)
8850 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008851 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008852 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar446cb832008-06-24 21:56:24 +00008853 focus goes to a window that is smaller, its size is increased, at the
8854 cost of the height of other windows.
8855 Set 'winheight' to a small number for normal editing.
8856 Set it to 999 to make the current window fill most of the screen.
8857 Other windows will be only 'winminheight' high. This has the drawback
8858 that ":all" will create only two windows. To avoid "vim -o 1 2 3 4"
8859 to create only two windows, set the option after startup is done,
8860 using the |VimEnter| event: >
8861 au VimEnter * set winheight=999
8862< Minimum value is 1.
8863 The height is not adjusted after one of the commands that change the
Bram Moolenaar071d4272004-06-13 20:20:40 +00008864 height of the current window.
8865 'winheight' applies to the current window. Use 'winminheight' to set
8866 the minimal height for other windows.
8867
8868 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
8869'winfixheight' 'wfh' boolean (default off)
8870 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00008871 Keep the window height when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00008872 'equalalways' is set. Also for |CTRL-W_=|. Set by default for the
8873 |preview-window| and |quickfix-window|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008874 The height may be changed anyway when running out of room.
8875
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008876 *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'*
8877'winfixwidth' 'wfw' boolean (default off)
8878 local to window
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008879 Keep the window width when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00008880 'equalalways' is set. Also for |CTRL-W_=|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008881 The width may be changed anyway when running out of room.
8882
Bram Moolenaar071d4272004-06-13 20:20:40 +00008883 *'winminheight'* *'wmh'*
8884'winminheight' 'wmh' number (default 1)
8885 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008886 The minimal height of a window, when it's not the current window.
8887 This is a hard minimum, windows will never become smaller.
8888 When set to zero, windows may be "squashed" to zero lines (i.e. just a
8889 status bar) if necessary. They will return to at least one line when
8890 they become active (since the cursor has to have somewhere to go.)
8891 Use 'winheight' to set the minimal height of the current window.
8892 This option is only checked when making a window smaller. Don't use a
8893 large number, it will cause errors when opening more than a few
8894 windows. A value of 0 to 3 is reasonable.
8895
8896 *'winminwidth'* *'wmw'*
8897'winminwidth' 'wmw' number (default 1)
8898 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008899 The minimal width of a window, when it's not the current window.
8900 This is a hard minimum, windows will never become smaller.
8901 When set to zero, windows may be "squashed" to zero columns (i.e. just
8902 a vertical separator) if necessary. They will return to at least one
8903 line when they become active (since the cursor has to have somewhere
8904 to go.)
8905 Use 'winwidth' to set the minimal width of the current window.
8906 This option is only checked when making a window smaller. Don't use a
8907 large number, it will cause errors when opening more than a few
8908 windows. A value of 0 to 12 is reasonable.
8909
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02008910 *'winptydll'*
8911'winptydll' string (default "winpty32.dll" or "winpty64.dll")
8912 global
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02008913 {only available when compiled with the |terminal|
8914 feature on MS-Windows}
8915 Specifies the name of the winpty shared library, used for the
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02008916 |:terminal| command. The default depends on whether Vim was built as a
Bram Moolenaarc572da52017-08-27 16:52:01 +02008917 32-bit or 64-bit executable. If not found, "winpty.dll" is tried as
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02008918 a fallback.
8919 Environment variables are expanded |:set_env|.
8920 This option cannot be set from a |modeline| or in the |sandbox|, for
8921 security reasons.
8922
Bram Moolenaar071d4272004-06-13 20:20:40 +00008923 *'winwidth'* *'wiw'* *E592*
8924'winwidth' 'wiw' number (default 20)
8925 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008926 Minimal number of columns for the current window. This is not a hard
8927 minimum, Vim will use fewer columns if there is not enough room. If
8928 the current window is smaller, its size is increased, at the cost of
8929 the width of other windows. Set it to 999 to make the current window
8930 always fill the screen. Set it to a small number for normal editing.
8931 The width is not adjusted after one of the commands to change the
8932 width of the current window.
8933 'winwidth' applies to the current window. Use 'winminwidth' to set
8934 the minimal width for other windows.
8935
8936 *'wrap'* *'nowrap'*
8937'wrap' boolean (default on)
8938 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00008939 This option changes how text is displayed. It doesn't change the text
8940 in the buffer, see 'textwidth' for that.
8941 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008942 displaying continues on the next line. When off lines will not wrap
8943 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00008944 moved to a part that is not shown, the screen will scroll
8945 horizontally.
8946 The line will be broken in the middle of a word if necessary. See
8947 'linebreak' to get the break at a word boundary.
8948 To make scrolling horizontally a bit more useful, try this: >
8949 :set sidescroll=5
8950 :set listchars+=precedes:<,extends:>
8951< See 'sidescroll', 'listchars' and |wrap-off|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01008952 This option can't be set from a |modeline| when the 'diff' option is
8953 on.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008954
8955 *'wrapmargin'* *'wm'*
8956'wrapmargin' 'wm' number (default 0)
8957 local to buffer
8958 Number of characters from the right window border where wrapping
8959 starts. When typing text beyond this limit, an <EOL> will be inserted
8960 and inserting continues on the next line.
8961 Options that add a margin, such as 'number' and 'foldcolumn', cause
8962 the text width to be further reduced. This is Vi compatible.
8963 When 'textwidth' is non-zero, this option is not used.
Bram Moolenaarca635012015-09-25 20:34:21 +02008964 This option is set to 0 when 'paste' is set and restored when 'paste'
8965 is reset.
Bram Moolenaara6c27c42019-05-09 19:16:22 +02008966 See also 'formatoptions' and |ins-textwidth|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008967
8968 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
8969'wrapscan' 'ws' boolean (default on) *E384* *E385*
8970 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00008971 Searches wrap around the end of the file. Also applies to |]s| and
8972 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008973
8974 *'write'* *'nowrite'*
8975'write' boolean (default on)
8976 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008977 Allows writing files. When not set, writing a file is not allowed.
8978 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008979 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00008980 argument. Filtering text is still possible, even though this requires
8981 writing a temporary file.
8982
8983 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
8984'writeany' 'wa' boolean (default off)
8985 global
8986 Allows writing to any file with no need for "!" override.
8987
8988 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
8989'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
8990 otherwise)
8991 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008992 Make a backup before overwriting a file. The backup is removed after
8993 the file was successfully written, unless the 'backup' option is
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02008994 also on.
8995 WARNING: Switching this option off means that when Vim fails to write
8996 your buffer correctly and then, for whatever reason, Vim exits, you
8997 lose both the original file and what you were writing. Only reset
8998 this option if your file system is almost full and it makes the write
8999 fail (and make sure not to exit Vim until the write was successful).
9000 See |backup-table| for another explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009001 When the 'backupskip' pattern matches, a backup is not made anyway.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01009002 Depending on 'backupcopy' the backup is a new file or the original
9003 file renamed (and a new file is written).
Bram Moolenaar071d4272004-06-13 20:20:40 +00009004 NOTE: This option is set to the default value when 'compatible' is
9005 set.
9006
9007 *'writedelay'* *'wd'*
9008'writedelay' 'wd' number (default 0)
9009 global
Bram Moolenaar802a0d92016-06-26 16:17:58 +02009010 The number of milliseconds to wait for each character sent to the
Bram Moolenaar071d4272004-06-13 20:20:40 +00009011 screen. When non-zero, characters are sent to the terminal one by
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01009012 one. For debugging purposes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009013
Bram Moolenaar91f84f62018-07-29 15:07:52 +02009014 vim:tw=78:ts=8:noet:ft=help:norl: