blob: 9410726d08fb71424591a84cf00c253ef39fff6e [file] [log] [blame]
Bram Moolenaard1caa942020-04-10 22:10:56 +02001*options.txt* For Vim version 8.2. Last change: 2020 Apr 10
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.
918
919 When the value is empty, Vi compatible backspacing is used.
920
921 For backwards compatibility with version 5.4 and earlier:
922 value effect ~
923 0 same as ":set backspace=" (Vi compatible)
924 1 same as ":set backspace=indent,eol"
925 2 same as ":set backspace=indent,eol,start"
926
927 See |:fixdel| if your <BS> or <Del> key does not do what you want.
928 NOTE: This option is set to "" when 'compatible' is set.
929
930 *'backup'* *'bk'* *'nobackup'* *'nobk'*
931'backup' 'bk' boolean (default off)
932 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000933 Make a backup before overwriting a file. Leave it around after the
934 file has been successfully written. If you do not want to keep the
935 backup file, but you do want a backup while the file is being
936 written, reset this option and set the 'writebackup' option (this is
937 the default). If you do not want a backup file at all reset both
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000938 options (use this if your file system is almost full). See the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000939 |backup-table| for more explanations.
940 When the 'backupskip' pattern matches, a backup is not made anyway.
941 When 'patchmode' is set, the backup may be renamed to become the
942 oldest version of a file.
943 NOTE: This option is reset when 'compatible' is set.
944
945 *'backupcopy'* *'bkc'*
946'backupcopy' 'bkc' string (Vi default for Unix: "yes", otherwise: "auto")
Bram Moolenaarb8ee25a2014-09-23 15:45:08 +0200947 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000948 When writing a file and a backup is made, this option tells how it's
949 done. This is a comma separated list of words.
950
951 The main values are:
952 "yes" make a copy of the file and overwrite the original one
953 "no" rename the file and write a new one
954 "auto" one of the previous, what works best
955
956 Extra values that can be combined with the ones above are:
957 "breaksymlink" always break symlinks when writing
958 "breakhardlink" always break hardlinks when writing
959
960 Making a copy and overwriting the original file:
961 - Takes extra time to copy the file.
962 + When the file has special attributes, is a (hard/symbolic) link or
963 has a resource fork, all this is preserved.
964 - When the file is a link the backup will have the name of the link,
965 not of the real file.
966
967 Renaming the file and writing a new one:
968 + It's fast.
969 - Sometimes not all attributes of the file can be copied to the new
970 file.
971 - When the file is a link the new file will not be a link.
972
973 The "auto" value is the middle way: When Vim sees that renaming file
974 is possible without side effects (the attributes can be passed on and
Bram Moolenaar02467872007-05-06 13:22:01 +0000975 the file is not a link) that is used. When problems are expected, a
976 copy will be made.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000977
978 The "breaksymlink" and "breakhardlink" values can be used in
979 combination with any of "yes", "no" and "auto". When included, they
980 force Vim to always break either symbolic or hard links by doing
981 exactly what the "no" option does, renaming the original file to
982 become the backup and writing a new file in its place. This can be
983 useful for example in source trees where all the files are symbolic or
984 hard links and any changes should stay in the local source tree, not
985 be propagated back to the original source.
986 *crontab*
987 One situation where "no" and "auto" will cause problems: A program
988 that opens a file, invokes Vim to edit that file, and then tests if
989 the open file was changed (through the file descriptor) will check the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000990 backup file instead of the newly created file. "crontab -e" is an
Bram Moolenaar071d4272004-06-13 20:20:40 +0000991 example.
992
993 When a copy is made, the original file is truncated and then filled
994 with the new text. This means that protection bits, owner and
995 symbolic links of the original file are unmodified. The backup file
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000996 however, is a new file, owned by the user who edited the file. The
Bram Moolenaar071d4272004-06-13 20:20:40 +0000997 group of the backup is set to the group of the original file. If this
998 fails, the protection bits for the group are made the same as for
999 others.
1000
1001 When the file is renamed this is the other way around: The backup has
1002 the same attributes of the original file, and the newly written file
1003 is owned by the current user. When the file was a (hard/symbolic)
1004 link, the new file will not! That's why the "auto" value doesn't
1005 rename when the file is a link. The owner and group of the newly
1006 written file will be set to the same ones as the original file, but
1007 the system may refuse to do this. In that case the "auto" value will
1008 again not rename the file.
1009
Bram Moolenaar036986f2017-03-16 17:41:02 +01001010 NOTE: This option is set to the Vi default value when 'compatible' is
1011 set and to the Vim default value when 'compatible' is reset.
1012
Bram Moolenaar071d4272004-06-13 20:20:40 +00001013 *'backupdir'* *'bdir'*
1014'backupdir' 'bdir' string (default for Amiga: ".,t:",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01001015 for Win32: ".,$TEMP,c:/tmp,c:/temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001016 for Unix: ".,~/tmp,~/")
1017 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001018 List of directories for the backup file, separated with commas.
1019 - The backup file will be created in the first directory in the list
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001020 where this is possible. The directory must exist, Vim will not
1021 create it for you.
Bram Moolenaar3848e002016-03-19 18:42:29 +01001022 - Empty means that no backup file will be created ('patchmode' is
Bram Moolenaar071d4272004-06-13 20:20:40 +00001023 impossible!). Writing may fail because of this.
1024 - A directory "." means to put the backup file in the same directory
1025 as the edited file.
Bram Moolenaar8024f932020-01-14 19:29:13 +01001026 - A directory starting with "./" (or ".\" for MS-Windows) means to put
1027 the backup file relative to where the edited file is. The leading
1028 "." is replaced with the path name of the edited file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001029 ("." inside a directory name has no special meaning).
1030 - Spaces after the comma are ignored, other spaces are considered part
1031 of the directory name. To have a space at the start of a directory
1032 name, precede it with a backslash.
1033 - To include a comma in a directory name precede it with a backslash.
1034 - A directory name may end in an '/'.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02001035 - For Unix and Win32, if a directory ends in two path separators "//",
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01001036 the backup file name will be built from the complete path to the
1037 file with all path separators changed to percent '%' signs. This
1038 will ensure file name uniqueness in the backup directory.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02001039 On Win32, it is also possible to end with "\\". However, When a
1040 separating comma is following, you must use "//", since "\\" will
1041 include the comma in the file name. Therefore it is recommended to
1042 use '//', instead of '\\'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001043 - Environment variables are expanded |:set_env|.
1044 - Careful with '\' characters, type one before a space, type two to
1045 get one in the option (see |option-backslash|), for example: >
1046 :set bdir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
1047< - For backwards compatibility with Vim version 3.0 a '>' at the start
1048 of the option is removed.
1049 See also 'backup' and 'writebackup' options.
1050 If you want to hide your backup files on Unix, consider this value: >
1051 :set backupdir=./.backup,~/.backup,.,/tmp
1052< You must create a ".backup" directory in each directory and in your
1053 home directory for this to work properly.
1054 The use of |:set+=| and |:set-=| is preferred when adding or removing
1055 directories from the list. This avoids problems when a future version
1056 uses another default.
1057 This option cannot be set from a |modeline| or in the |sandbox|, for
1058 security reasons.
1059
1060 *'backupext'* *'bex'* *E589*
1061'backupext' 'bex' string (default "~", for VMS: "_")
1062 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001063 String which is appended to a file name to make the name of the
1064 backup file. The default is quite unusual, because this avoids
1065 accidentally overwriting existing files with a backup file. You might
1066 prefer using ".bak", but make sure that you don't have files with
1067 ".bak" that you want to keep.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001068 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001069
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001070 If you like to keep a lot of backups, you could use a BufWritePre
1071 autocommand to change 'backupext' just before writing the file to
1072 include a timestamp. >
1073 :au BufWritePre * let &bex = '-' . strftime("%Y%b%d%X") . '~'
1074< Use 'backupdir' to put the backup in a different directory.
1075
Bram Moolenaar071d4272004-06-13 20:20:40 +00001076 *'backupskip'* *'bsk'*
Bram Moolenaarb8e22a02018-04-12 21:37:34 +02001077'backupskip' 'bsk' string (default: "$TMPDIR/*,$TMP/*,$TEMP/*"
1078 Unix: "/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*"
1079 Mac: "/private/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001080 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001081 {not available when compiled without the |+wildignore|
1082 feature}
1083 A list of file patterns. When one of the patterns matches with the
1084 name of the file which is written, no backup file is created. Both
1085 the specified file name and the full path name of the file are used.
1086 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
1087 Watch out for special characters, see |option-backslash|.
1088 When $TMPDIR, $TMP or $TEMP is not defined, it is not used for the
Bram Moolenaar582fd852005-03-28 20:58:01 +00001089 default value. "/tmp/*" is only used for Unix.
Bram Moolenaar02467872007-05-06 13:22:01 +00001090
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02001091 WARNING: Not having a backup file means that when Vim fails to write
1092 your buffer correctly and then, for whatever reason, Vim exits, you
1093 lose both the original file and what you were writing. Only disable
1094 backups if you don't care about losing the file.
1095
Bram Moolenaar02467872007-05-06 13:22:01 +00001096 Note that environment variables are not expanded. If you want to use
1097 $HOME you must expand it explicitly, e.g.: >
Bram Moolenaar7c1c6db2016-04-03 22:08:05 +02001098 :let &backupskip = escape(expand('$HOME'), '\') . '/tmp/*'
Bram Moolenaar02467872007-05-06 13:22:01 +00001099
1100< Note that the default also makes sure that "crontab -e" works (when a
Bram Moolenaara5792f52005-11-23 21:25:05 +00001101 backup would be made by renaming the original file crontab won't see
1102 the newly created file). Also see 'backupcopy' and |crontab|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001103
1104 *'balloondelay'* *'bdlay'*
1105'balloondelay' 'bdlay' number (default: 600)
1106 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001107 {only available when compiled with the |+balloon_eval|
1108 feature}
1109 Delay in milliseconds before a balloon may pop up. See |balloon-eval|.
1110
1111 *'ballooneval'* *'beval'* *'noballooneval'* *'nobeval'*
1112'ballooneval' 'beval' boolean (default off)
1113 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001114 {only available when compiled with the |+balloon_eval|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001115 feature}
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001116 Switch on the |balloon-eval| functionality for the GUI.
1117
1118 *'balloonevalterm'* *'bevalterm'* *'noballoonevalterm'*
1119 *'nobevalterm'*
1120'balloonevalterm' 'bevalterm' boolean (default off)
1121 global
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001122 {only available when compiled with the
1123 |+balloon_eval_term| feature}
1124 Switch on the |balloon-eval| functionality for the terminal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001125
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001126 *'balloonexpr'* *'bexpr'*
1127'balloonexpr' 'bexpr' string (default "")
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00001128 global or local to buffer |global-local|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001129 {only available when compiled with the |+balloon_eval|
1130 feature}
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00001131 Expression for text to show in evaluation balloon. It is only used
Bram Moolenaara6c27c42019-05-09 19:16:22 +02001132 when 'ballooneval' or 'balloonevalterm' is on. These variables can be
1133 used:
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001134
1135 v:beval_bufnr number of the buffer in which balloon is going to show
1136 v:beval_winnr number of the window
Bram Moolenaar82af8712016-06-04 20:20:29 +02001137 v:beval_winid ID of the window
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001138 v:beval_lnum line number
1139 v:beval_col column number (byte index)
1140 v:beval_text word under or after the mouse pointer
1141
Bram Moolenaar54775062019-07-31 21:07:14 +02001142 Instead of showing a balloon, which is limited to plain text, consider
1143 using a popup window, see |popup_beval_example|. A popup window can
1144 use highlighting and show a border.
1145
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001146 The evaluation of the expression must not have side effects!
1147 Example: >
Bram Moolenaara6c27c42019-05-09 19:16:22 +02001148 function MyBalloonExpr()
Bram Moolenaar45360022005-07-21 21:08:21 +00001149 return 'Cursor is at line ' . v:beval_lnum .
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001150 \', column ' . v:beval_col .
1151 \ ' of file ' . bufname(v:beval_bufnr) .
1152 \ ' on word "' . v:beval_text . '"'
1153 endfunction
1154 set bexpr=MyBalloonExpr()
1155 set ballooneval
1156<
Bram Moolenaar396e8292019-07-13 23:04:31 +02001157 Also see |balloon_show()|, it can be used if the content of the balloon
1158 is to be fetched asynchronously. In that case evaluating
1159 'balloonexpr' should result in an empty string. If you get a balloon
1160 with only "0" you probably didn't return anything from your function.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001161
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001162 NOTE: The balloon is displayed only if the cursor is on a text
1163 character. If the result of evaluating 'balloonexpr' is not empty,
1164 Vim does not try to send a message to an external debugger (Netbeans
1165 or Sun Workshop).
1166
Bram Moolenaar30b65812012-07-12 22:01:11 +02001167 The expression will be evaluated in the |sandbox| when set from a
1168 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02001169 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001170
1171 It is not allowed to change text or jump to another window while
Bram Moolenaar396e8292019-07-13 23:04:31 +02001172 evaluating 'balloonexpr', see |textlock|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001173
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001174 To check whether line breaks in the balloon text work use this check: >
Bram Moolenaar45360022005-07-21 21:08:21 +00001175 if has("balloon_multiline")
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001176< When they are supported "\n" characters will start a new line. If the
1177 expression evaluates to a |List| this is equal to using each List item
1178 as a string and putting "\n" in between them.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001179 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001180
Bram Moolenaar165bc692015-07-21 17:53:25 +02001181 *'belloff'* *'bo'*
1182'belloff' 'bo' string (default "")
1183 global
Bram Moolenaar165bc692015-07-21 17:53:25 +02001184 Specifies for which events the bell will not be rung. It is a comma
1185 separated list of items. For each item that is present, the bell
1186 will be silenced. This is most useful to specify specific events in
1187 insert mode to be silenced.
1188
1189 item meaning when present ~
1190 all All events.
1191 backspace When hitting <BS> or <Del> and deleting results in an
1192 error.
1193 cursor Fail to move around using the cursor keys or
1194 <PageUp>/<PageDown> in |Insert-mode|.
1195 complete Error occurred when using |i_CTRL-X_CTRL-K| or
1196 |i_CTRL-X_CTRL-T|.
1197 copy Cannot copy char from insert mode using |i_CTRL-Y| or
1198 |i_CTRL-E|.
1199 ctrlg Unknown Char after <C-G> in Insert mode.
1200 error Other Error occurred (e.g. try to join last line)
1201 (mostly used in |Normal-mode| or |Cmdline-mode|).
1202 esc hitting <Esc> in |Normal-mode|.
1203 ex In |Visual-mode|, hitting |Q| results in an error.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01001204 hangul Ignored.
Bram Moolenaar165bc692015-07-21 17:53:25 +02001205 insertmode Pressing <Esc> in 'insertmode'.
1206 lang Calling the beep module for Lua/Mzscheme/TCL.
1207 mess No output available for |g<|.
1208 showmatch Error occurred for 'showmatch' function.
1209 operator Empty region error |cpo-E|.
1210 register Unknown register after <C-R> in |Insert-mode|.
1211 shell Bell from shell output |:!|.
1212 spell Error happened on spell suggest.
1213 wildmode More matches in |cmdline-completion| available
1214 (depends on the 'wildmode' setting).
1215
Bram Moolenaar036986f2017-03-16 17:41:02 +01001216 This is most useful to fine tune when in Insert mode the bell should
1217 be rung. For Normal mode and Ex commands, the bell is often rung to
Bram Moolenaar165bc692015-07-21 17:53:25 +02001218 indicate that an error occurred. It can be silenced by adding the
1219 "error" keyword.
1220
Bram Moolenaar071d4272004-06-13 20:20:40 +00001221 *'binary'* *'bin'* *'nobinary'* *'nobin'*
1222'binary' 'bin' boolean (default off)
1223 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001224 This option should be set before editing a binary file. You can also
1225 use the |-b| Vim argument. When this option is switched on a few
1226 options will be changed (also when it already was on):
1227 'textwidth' will be set to 0
1228 'wrapmargin' will be set to 0
1229 'modeline' will be off
1230 'expandtab' will be off
1231 Also, 'fileformat' and 'fileformats' options will not be used, the
1232 file is read and written like 'fileformat' was "unix" (a single <NL>
1233 separates lines).
1234 The 'fileencoding' and 'fileencodings' options will not be used, the
1235 file is read without conversion.
1236 NOTE: When you start editing a(nother) file while the 'bin' option is
1237 on, settings from autocommands may change the settings again (e.g.,
1238 'textwidth'), causing trouble when editing. You might want to set
1239 'bin' again when the file has been loaded.
1240 The previous values of these options are remembered and restored when
1241 'bin' is switched from on to off. Each buffer has its own set of
1242 saved option values.
1243 To edit a file with 'binary' set you can use the |++bin| argument.
1244 This avoids you have to do ":set bin", which would have effect for all
1245 files you edit.
1246 When writing a file the <EOL> for the last line is only written if
1247 there was one in the original file (normally Vim appends an <EOL> to
1248 the last line if there is none; this would make the file longer). See
1249 the 'endofline' option.
1250
1251 *'bioskey'* *'biosk'* *'nobioskey'* *'nobiosk'*
1252'bioskey' 'biosk' boolean (default on)
1253 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02001254 {only for MS-DOS}
Bram Moolenaarf3913272016-02-25 00:00:01 +01001255 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001256
1257 *'bomb'* *'nobomb'*
1258'bomb' boolean (default off)
1259 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001260 When writing a file and the following conditions are met, a BOM (Byte
1261 Order Mark) is prepended to the file:
1262 - this option is on
1263 - the 'binary' option is off
1264 - 'fileencoding' is "utf-8", "ucs-2", "ucs-4" or one of the little/big
1265 endian variants.
1266 Some applications use the BOM to recognize the encoding of the file.
1267 Often used for UCS-2 files on MS-Windows. For other applications it
1268 causes trouble, for example: "cat file1 file2" makes the BOM of file2
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001269 appear halfway the resulting file. Gcc doesn't accept a BOM.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001270 When Vim reads a file and 'fileencodings' starts with "ucs-bom", a
1271 check for the presence of the BOM is done and 'bomb' set accordingly.
1272 Unless 'binary' is set, it is removed from the first line, so that you
1273 don't see it when editing. When you don't change the options, the BOM
1274 will be restored when writing the file.
1275
1276 *'breakat'* *'brk'*
1277'breakat' 'brk' string (default " ^I!@*-+;:,./?")
1278 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02001279 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001280 feature}
1281 This option lets you choose which characters might cause a line
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00001282 break if 'linebreak' is on. Only works for ASCII and also for 8-bit
1283 characters when 'encoding' is an 8-bit encoding.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001284
Bram Moolenaar7c1c6db2016-04-03 22:08:05 +02001285 *'breakindent'* *'bri'* *'nobreakindent'* *'nobri'*
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001286'breakindent' 'bri' boolean (default off)
1287 local to window
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001288 {not available when compiled without the |+linebreak|
1289 feature}
1290 Every wrapped line will continue visually indented (same amount of
1291 space as the beginning of that line), thus preserving horizontal blocks
1292 of text.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001293 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001294
1295 *'breakindentopt'* *'briopt'*
1296'breakindentopt' 'briopt' string (default empty)
1297 local to window
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001298 {not available when compiled without the |+linebreak|
1299 feature}
1300 Settings for 'breakindent'. It can consist of the following optional
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001301 items and must be separated by a comma:
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001302 min:{n} Minimum text width that will be kept after
1303 applying 'breakindent', even if the resulting
1304 text should normally be narrower. This prevents
1305 text indented almost to the right window border
1306 occupying lot of vertical space when broken.
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001307 shift:{n} After applying 'breakindent', the wrapped line's
1308 beginning will be shifted by the given number of
1309 characters. It permits dynamic French paragraph
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001310 indentation (negative) or emphasizing the line
1311 continuation (positive).
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01001312 sbr Display the 'showbreak' value before applying the
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001313 additional indent.
1314 The default value for min is 20 and shift is 0.
1315
Bram Moolenaar071d4272004-06-13 20:20:40 +00001316 *'browsedir'* *'bsdir'*
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001317'browsedir' 'bsdir' string (default: "last")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001318 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02001319 {only for Motif, Athena, GTK, Mac and Win32 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001320 Which directory to use for the file browser:
Bram Moolenaar446cb832008-06-24 21:56:24 +00001321 last Use same directory as with last file browser, where a
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02001322 file was opened or saved.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001323 buffer Use the directory of the related buffer.
1324 current Use the current directory.
1325 {path} Use the specified directory
1326
1327 *'bufhidden'* *'bh'*
1328'bufhidden' 'bh' string (default: "")
1329 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001330 This option specifies what happens when a buffer is no longer
1331 displayed in a window:
1332 <empty> follow the global 'hidden' option
1333 hide hide the buffer (don't unload it), also when 'hidden'
1334 is not set
1335 unload unload the buffer, also when 'hidden' is set or using
1336 |:hide|
1337 delete delete the buffer from the buffer list, also when
1338 'hidden' is set or using |:hide|, like using
1339 |:bdelete|
1340 wipe wipe out the buffer from the buffer list, also when
1341 'hidden' is set or using |:hide|, like using
1342 |:bwipeout|
1343
Bram Moolenaara14de3d2005-01-07 21:48:26 +00001344 CAREFUL: when "unload", "delete" or "wipe" is used changes in a buffer
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01001345 are lost without a warning. Also, these values may break autocommands
1346 that switch between buffers temporarily.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001347 This option is used together with 'buftype' and 'swapfile' to specify
1348 special kinds of buffers. See |special-buffers|.
1349
1350 *'buflisted'* *'bl'* *'nobuflisted'* *'nobl'* *E85*
1351'buflisted' 'bl' boolean (default: on)
1352 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001353 When this option is set, the buffer shows up in the buffer list. If
1354 it is reset it is not used for ":bnext", "ls", the Buffers menu, etc.
1355 This option is reset by Vim for buffers that are only used to remember
1356 a file name or marks. Vim sets it when starting to edit a buffer.
1357 But not when moving to a buffer with ":buffer".
1358
1359 *'buftype'* *'bt'* *E382*
1360'buftype' 'bt' string (default: "")
1361 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001362 The value of this option specifies the type of a buffer:
1363 <empty> normal buffer
1364 nofile buffer which is not related to a file and will not be
1365 written
1366 nowrite buffer which will not be written
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001367 acwrite buffer which will always be written with BufWriteCmd
Bram Moolenaarb5b75622018-03-09 22:22:21 +01001368 autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001369 quickfix quickfix buffer, contains list of errors |:cwindow|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001370 or list of locations |:lwindow|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001371 help help buffer (you are not supposed to set this
1372 manually)
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02001373 terminal buffer for a |terminal| (you are not supposed to set
1374 this manually)
Bram Moolenaarf2732452018-06-03 14:47:35 +02001375 prompt buffer where only the last line can be edited, meant
1376 to be used by a plugin, see |prompt-buffer|
1377 {only when compiled with the |+channel| feature}
Bram Moolenaar4d784b22019-05-25 19:51:39 +02001378 popup buffer used in a popup window, see |popup|.
1379 {only when compiled with the |+textprop| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001380
1381 This option is used together with 'bufhidden' and 'swapfile' to
1382 specify special kinds of buffers. See |special-buffers|.
Bram Moolenaarebdf3c92020-02-15 21:41:42 +01001383 Also see |win_gettype()|, which returns the type of the window.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001384
1385 Be careful with changing this option, it can have many side effects!
1386
Bram Moolenaar280f1262006-01-30 00:14:18 +00001387 A "quickfix" buffer is only used for the error list and the location
1388 list. This value is set by the |:cwindow| and |:lwindow| commands and
1389 you are not supposed to change it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001390
1391 "nofile" and "nowrite" buffers are similar:
1392 both: The buffer is not to be written to disk, ":w" doesn't
1393 work (":w filename" does work though).
1394 both: The buffer is never considered to be |'modified'|.
1395 There is no warning when the changes will be lost, for
1396 example when you quit Vim.
1397 both: A swap file is only created when using too much memory
1398 (when 'swapfile' has been reset there is never a swap
1399 file).
1400 nofile only: The buffer name is fixed, it is not handled like a
1401 file name. It is not modified in response to a |:cd|
1402 command.
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01001403 both: When using ":e bufname" and already editing "bufname"
1404 the buffer is made empty and autocommands are
1405 triggered as usual for |:edit|.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001406 *E676*
1407 "acwrite" implies that the buffer name is not related to a file, like
1408 "nofile", but it will be written. Thus, in contrast to "nofile" and
1409 "nowrite", ":w" does work and a modified buffer can't be abandoned
1410 without saving. For writing there must be matching |BufWriteCmd|,
1411 |FileWriteCmd| or |FileAppendCmd| autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001412
1413 *'casemap'* *'cmp'*
1414'casemap' 'cmp' string (default: "internal,keepascii")
1415 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001416 Specifies details about changing the case of letters. It may contain
1417 these words, separated by a comma:
1418 internal Use internal case mapping functions, the current
1419 locale does not change the case mapping. This only
Bram Moolenaar6f16eb82005-08-23 21:02:42 +00001420 matters when 'encoding' is a Unicode encoding,
1421 "latin1" or "iso-8859-15". When "internal" is
1422 omitted, the towupper() and towlower() system library
1423 functions are used when available.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001424 keepascii For the ASCII characters (0x00 to 0x7f) use the US
1425 case mapping, the current locale is not effective.
1426 This probably only matters for Turkish.
1427
1428 *'cdpath'* *'cd'* *E344* *E346*
1429'cdpath' 'cd' string (default: equivalent to $CDPATH or ",,")
1430 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001431 {not available when compiled without the
1432 |+file_in_path| feature}
1433 This is a list of directories which will be searched when using the
Bram Moolenaar00aa0692019-04-27 20:37:57 +02001434 |:cd|, |:tcd| and |:lcd| commands, provided that the directory being
1435 searched for has a relative path, not an absolute part starting with
1436 "/", "./" or "../", the 'cdpath' option is not used then.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001437 The 'cdpath' option's value has the same form and semantics as
1438 |'path'|. Also see |file-searching|.
1439 The default value is taken from $CDPATH, with a "," prepended to look
1440 in the current directory first.
1441 If the default value taken from $CDPATH is not what you want, include
1442 a modified version of the following command in your vimrc file to
1443 override it: >
1444 :let &cdpath = ',' . substitute(substitute($CDPATH, '[, ]', '\\\0', 'g'), ':', ',', 'g')
1445< This option cannot be set from a |modeline| or in the |sandbox|, for
1446 security reasons.
1447 (parts of 'cdpath' can be passed to the shell to expand file names).
1448
1449 *'cedit'*
1450'cedit' string (Vi default: "", Vim default: CTRL-F)
1451 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001452 The key used in Command-line Mode to open the command-line window.
1453 The default is CTRL-F when 'compatible' is off.
1454 Only non-printable keys are allowed.
1455 The key can be specified as a single character, but it is difficult to
1456 type. The preferred way is to use the <> notation. Examples: >
Bram Moolenaare18dbe82016-07-02 21:42:23 +02001457 :exe "set cedit=\<C-Y>"
1458 :exe "set cedit=\<Esc>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001459< |Nvi| also has this option, but it only uses the first character.
1460 See |cmdwin|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001461 NOTE: This option is set to the Vim default value when 'compatible'
1462 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001463
1464 *'charconvert'* *'ccv'* *E202* *E214* *E513*
1465'charconvert' 'ccv' string (default "")
1466 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01001467 {only available when compiled with the |+eval| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001468 An expression that is used for character encoding conversion. It is
1469 evaluated when a file that is to be read or has been written has a
1470 different encoding from what is desired.
1471 'charconvert' is not used when the internal iconv() function is
1472 supported and is able to do the conversion. Using iconv() is
1473 preferred, because it is much faster.
1474 'charconvert' is not used when reading stdin |--|, because there is no
1475 file to convert from. You will have to save the text in a file first.
1476 The expression must return zero or an empty string for success,
1477 non-zero for failure.
1478 The possible encoding names encountered are in 'encoding'.
1479 Additionally, names given in 'fileencodings' and 'fileencoding' are
1480 used.
1481 Conversion between "latin1", "unicode", "ucs-2", "ucs-4" and "utf-8"
1482 is done internally by Vim, 'charconvert' is not used for this.
1483 'charconvert' is also used to convert the viminfo file, if the 'c'
1484 flag is present in 'viminfo'. Also used for Unicode conversion.
1485 Example: >
1486 set charconvert=CharConvert()
1487 fun CharConvert()
1488 system("recode "
1489 \ . v:charconvert_from . ".." . v:charconvert_to
1490 \ . " <" . v:fname_in . " >" v:fname_out)
1491 return v:shell_error
1492 endfun
1493< The related Vim variables are:
1494 v:charconvert_from name of the current encoding
1495 v:charconvert_to name of the desired encoding
1496 v:fname_in name of the input file
1497 v:fname_out name of the output file
1498 Note that v:fname_in and v:fname_out will never be the same.
1499 Note that v:charconvert_from and v:charconvert_to may be different
1500 from 'encoding'. Vim internally uses UTF-8 instead of UCS-2 or UCS-4.
1501 Encryption is not done by Vim when using 'charconvert'. If you want
1502 to encrypt the file after conversion, 'charconvert' should take care
1503 of this.
1504 This option cannot be set from a |modeline| or in the |sandbox|, for
1505 security reasons.
1506
1507 *'cindent'* *'cin'* *'nocindent'* *'nocin'*
1508'cindent' 'cin' boolean (default off)
1509 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001510 {not available when compiled without the |+cindent|
1511 feature}
Bram Moolenaar446cb832008-06-24 21:56:24 +00001512 Enables automatic C program indenting. See 'cinkeys' to set the keys
Bram Moolenaar071d4272004-06-13 20:20:40 +00001513 that trigger reindenting in insert mode and 'cinoptions' to set your
1514 preferred indent style.
1515 If 'indentexpr' is not empty, it overrules 'cindent'.
1516 If 'lisp' is not on and both 'indentexpr' and 'equalprg' are empty,
1517 the "=" operator indents using this algorithm rather than calling an
1518 external program.
1519 See |C-indenting|.
1520 When you don't like the way 'cindent' works, try the 'smartindent'
1521 option or 'indentexpr'.
1522 This option is not used when 'paste' is set.
1523 NOTE: This option is reset when 'compatible' is set.
1524
1525 *'cinkeys'* *'cink'*
Bram Moolenaarce655742019-01-31 14:12:57 +01001526'cinkeys' 'cink' string (default "0{,0},0),0],:,0#,!^F,o,O,e")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001527 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001528 {not available when compiled without the |+cindent|
1529 feature}
1530 A list of keys that, when typed in Insert mode, cause reindenting of
1531 the current line. Only used if 'cindent' is on and 'indentexpr' is
1532 empty.
1533 For the format of this option see |cinkeys-format|.
1534 See |C-indenting|.
1535
1536 *'cinoptions'* *'cino'*
1537'cinoptions' 'cino' string (default "")
1538 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001539 {not available when compiled without the |+cindent|
1540 feature}
1541 The 'cinoptions' affect the way 'cindent' reindents lines in a C
1542 program. See |cinoptions-values| for the values of this option, and
1543 |C-indenting| for info on C indenting in general.
1544
1545
1546 *'cinwords'* *'cinw'*
1547'cinwords' 'cinw' string (default "if,else,while,do,for,switch")
1548 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001549 {not available when compiled without both the
1550 |+cindent| and the |+smartindent| features}
1551 These keywords start an extra indent in the next line when
1552 'smartindent' or 'cindent' is set. For 'cindent' this is only done at
1553 an appropriate place (inside {}).
1554 Note that 'ignorecase' isn't used for 'cinwords'. If case doesn't
1555 matter, include the keyword both the uppercase and lowercase:
1556 "if,If,IF".
1557
1558 *'clipboard'* *'cb'*
1559'clipboard' 'cb' string (default "autoselect,exclude:cons\|linux"
1560 for X-windows, "" otherwise)
1561 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001562 {only in GUI versions or when the |+xterm_clipboard|
1563 feature is included}
1564 This option is a list of comma separated names.
1565 These names are recognized:
1566
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001567 *clipboard-unnamed*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001568 unnamed When included, Vim will use the clipboard register '*'
1569 for all yank, delete, change and put operations which
1570 would normally go to the unnamed register. When a
1571 register is explicitly specified, it will always be
1572 used regardless of whether "unnamed" is in 'clipboard'
1573 or not. The clipboard register can always be
1574 explicitly accessed using the "* notation. Also see
1575 |gui-clipboard|.
1576
Bram Moolenaar30b65812012-07-12 22:01:11 +02001577 *clipboard-unnamedplus*
Bram Moolenaar00154502013-02-13 16:15:55 +01001578 unnamedplus A variant of the "unnamed" flag which uses the
1579 clipboard register '+' (|quoteplus|) instead of
1580 register '*' for all yank, delete, change and put
1581 operations which would normally go to the unnamed
1582 register. When "unnamed" is also included to the
1583 option, yank operations (but not delete, change or
1584 put) will additionally copy the text into register
1585 '*'.
Bram Moolenaar81af9252010-12-10 20:35:50 +01001586 Only available with the |+X11| feature.
Bram Moolenaarbf9680e2010-12-02 21:43:16 +01001587 Availability can be checked with: >
1588 if has('unnamedplus')
1589<
Bram Moolenaar30b65812012-07-12 22:01:11 +02001590 *clipboard-autoselect*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001591 autoselect Works like the 'a' flag in 'guioptions': If present,
1592 then whenever Visual mode is started, or the Visual
1593 area extended, Vim tries to become the owner of the
1594 windowing system's global selection or put the
1595 selected text on the clipboard used by the selection
Bram Moolenaarba3ff532018-11-04 14:45:49 +01001596 register "*. See |'go-a'| and |quotestar| for details.
1597 When the GUI is active, the 'a' flag in 'guioptions'
1598 is used, when the GUI is not active, this "autoselect"
1599 flag is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001600 Also applies to the modeless selection.
1601
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001602 *clipboard-autoselectplus*
1603 autoselectplus Like "autoselect" but using the + register instead of
1604 the * register. Compare to the 'P' flag in
1605 'guioptions'.
1606
1607 *clipboard-autoselectml*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001608 autoselectml Like "autoselect", but for the modeless selection
1609 only. Compare to the 'A' flag in 'guioptions'.
1610
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001611 *clipboard-html*
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001612 html When the clipboard contains HTML, use this when
1613 pasting. When putting text on the clipboard, mark it
1614 as HTML. This works to copy rendered HTML from
1615 Firefox, paste it as raw HTML in Vim, select the HTML
1616 in Vim and paste it in a rich edit box in Firefox.
Bram Moolenaar20a825a2010-05-31 21:27:30 +02001617 You probably want to add this only temporarily,
1618 possibly use BufEnter autocommands.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001619 Only supported for GTK version 2 and later.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001620
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001621 *clipboard-exclude*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001622 exclude:{pattern}
1623 Defines a pattern that is matched against the name of
1624 the terminal 'term'. If there is a match, no
1625 connection will be made to the X server. This is
1626 useful in this situation:
1627 - Running Vim in a console.
1628 - $DISPLAY is set to start applications on another
1629 display.
1630 - You do not want to connect to the X server in the
1631 console, but do want this in a terminal emulator.
1632 To never connect to the X server use: >
1633 exclude:.*
1634< This has the same effect as using the |-X| argument.
1635 Note that when there is no connection to the X server
1636 the window title won't be restored and the clipboard
1637 cannot be accessed.
1638 The value of 'magic' is ignored, {pattern} is
1639 interpreted as if 'magic' was on.
1640 The rest of the option value will be used for
1641 {pattern}, this must be the last entry.
1642
1643 *'cmdheight'* *'ch'*
1644'cmdheight' 'ch' number (default 1)
1645 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001646 Number of screen lines to use for the command-line. Helps avoiding
1647 |hit-enter| prompts.
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00001648 The value of this option is stored with the tab page, so that each tab
1649 page can have a different value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001650
1651 *'cmdwinheight'* *'cwh'*
1652'cmdwinheight' 'cwh' number (default 7)
1653 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001654 Number of screen lines to use for the command-line window. |cmdwin|
1655
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001656 *'colorcolumn'* *'cc'*
1657'colorcolumn' 'cc' string (default "")
1658 local to window
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001659 {not available when compiled without the |+syntax|
1660 feature}
1661 'colorcolumn' is a comma separated list of screen columns that are
1662 highlighted with ColorColumn |hl-ColorColumn|. Useful to align
1663 text. Will make screen redrawing slower.
1664 The screen column can be an absolute number, or a number preceded with
1665 '+' or '-', which is added to or subtracted from 'textwidth'. >
1666
1667 :set cc=+1 " highlight column after 'textwidth'
1668 :set cc=+1,+2,+3 " highlight three columns after 'textwidth'
1669 :hi ColorColumn ctermbg=lightgrey guibg=lightgrey
1670<
1671 When 'textwidth' is zero then the items with '-' and '+' are not used.
1672 A maximum of 256 columns are highlighted.
1673
Bram Moolenaar071d4272004-06-13 20:20:40 +00001674 *'columns'* *'co'* *E594*
1675'columns' 'co' number (default 80 or terminal width)
1676 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001677 Number of columns of the screen. Normally this is set by the terminal
Bram Moolenaar7c626922005-02-07 22:01:03 +00001678 initialization and does not have to be set by hand. Also see
1679 |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001680 When Vim is running in the GUI or in a resizable window, setting this
1681 option will cause the window size to be changed. When you only want
1682 to use the size for the GUI, put the command in your |gvimrc| file.
1683 When you set this option and Vim is unable to change the physical
Bram Moolenaar02467872007-05-06 13:22:01 +00001684 number of columns of the display, the display may be messed up. For
1685 the GUI it is always possible and Vim limits the number of columns to
1686 what fits on the screen. You can use this command to get the widest
1687 window possible: >
1688 :set columns=9999
1689< Minimum value is 12, maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001690
1691 *'comments'* *'com'* *E524* *E525*
1692'comments' 'com' string (default
1693 "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-")
1694 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001695 A comma separated list of strings that can start a comment line. See
1696 |format-comments|. See |option-backslash| about using backslashes to
1697 insert a space.
1698
1699 *'commentstring'* *'cms'* *E537*
1700'commentstring' 'cms' string (default "/*%s*/")
1701 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001702 {not available when compiled without the |+folding|
1703 feature}
1704 A template for a comment. The "%s" in the value is replaced with the
1705 comment text. Currently only used to add markers for folding, see
1706 |fold-marker|.
1707
1708 *'compatible'* *'cp'* *'nocompatible'* *'nocp'*
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001709'compatible' 'cp' boolean (default on, off when a |vimrc| or |gvimrc|
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02001710 file is found, reset in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001711 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001712 This option has the effect of making Vim either more Vi-compatible, or
1713 make Vim behave in a more useful way.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001714
Bram Moolenaar071d4272004-06-13 20:20:40 +00001715 This is a special kind of option, because when it's set or reset,
Bram Moolenaar214641f2017-03-05 17:04:09 +01001716 other options are also changed as a side effect.
1717 NOTE: Setting or resetting this option can have a lot of unexpected
1718 effects: Mappings are interpreted in another way, undo behaves
1719 differently, etc. If you set this option in your vimrc file, you
1720 should probably put it at the very start.
1721
Bram Moolenaar071d4272004-06-13 20:20:40 +00001722 By default this option is on and the Vi defaults are used for the
1723 options. This default was chosen for those people who want to use Vim
1724 just like Vi, and don't even (want to) know about the 'compatible'
1725 option.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001726 When a |vimrc| or |gvimrc| file is found while Vim is starting up,
Bram Moolenaard042c562005-06-30 22:04:15 +00001727 this option is switched off, and all options that have not been
1728 modified will be set to the Vim defaults. Effectively, this means
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001729 that when a |vimrc| or |gvimrc| file exists, Vim will use the Vim
Bram Moolenaard042c562005-06-30 22:04:15 +00001730 defaults, otherwise it will use the Vi defaults. (Note: This doesn't
Bram Moolenaar02467872007-05-06 13:22:01 +00001731 happen for the system-wide vimrc or gvimrc file, nor for a file given
1732 with the |-u| argument). Also see |compatible-default| and
1733 |posix-compliance|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001734 You can also set this option with the "-C" argument, and reset it with
1735 "-N". See |-C| and |-N|.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001736 See 'cpoptions' for more fine tuning of Vi compatibility.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001737
Bram Moolenaar214641f2017-03-05 17:04:09 +01001738 When this option is set, numerous other options are set to make Vim as
1739 Vi-compatible as possible. When this option is unset, various options
1740 are set to make Vim more useful. The table below lists all the
1741 options affected.
1742 The {?} column indicates when the options are affected:
1743 + Means that the option is set to the value given in {set value} when
1744 'compatible' is set.
1745 & Means that the option is set to the value given in {set value} when
1746 'compatible' is set AND is set to its Vim default value when
1747 'compatible' is unset.
1748 - Means the option is NOT changed when setting 'compatible' but IS
1749 set to its Vim default when 'compatible' is unset.
1750 The {effect} column summarises the change when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001751
Bram Moolenaar036986f2017-03-16 17:41:02 +01001752 option ? set value effect ~
Bram Moolenaar214641f2017-03-05 17:04:09 +01001753
1754 'allowrevins' + off no CTRL-_ command
1755 'antialias' + off don't use antialiased fonts
1756 'arabic' + off reset arabic-related options
1757 'arabicshape' + on correct character shapes
1758 'backspace' + "" normal backspace
1759 'backup' + off no backup file
1760 'backupcopy' & Unix: "yes" backup file is a copy
1761 else: "auto" copy or rename backup file
1762 'balloonexpr' + "" text to show in evaluation balloon
1763 'breakindent' + off don't indent when wrapping lines
1764 'cedit' - {unchanged} {set vim default only on resetting 'cp'}
1765 'cindent' + off no C code indentation
1766 'compatible' - {unchanged} {set vim default only on resetting 'cp'}
1767 'copyindent' + off don't copy indent structure
1768 'cpoptions' & (all flags) Vi-compatible flags
1769 'cscopepathcomp'+ 0 don't show directories in tags list
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01001770 'cscoperelative'+ off don't use basename of path as prefix
Bram Moolenaar214641f2017-03-05 17:04:09 +01001771 'cscopetag' + off don't use cscope for ":tag"
Bram Moolenaar036986f2017-03-16 17:41:02 +01001772 'cscopetagorder'+ 0 see |cscopetagorder|
Bram Moolenaar214641f2017-03-05 17:04:09 +01001773 'cscopeverbose' + off see |cscopeverbose|
1774 'delcombine' + off unicode: delete whole char combination
1775 'digraph' + off no digraphs
1776 'esckeys' & off no <Esc>-keys in Insert mode
1777 'expandtab' + off tabs not expanded to spaces
1778 'fileformats' & "" no automatic file format detection,
Bram Moolenaar6f345a12019-12-17 21:27:18 +01001779 "dos,unix" except for MS-Windows
Bram Moolenaar214641f2017-03-05 17:04:09 +01001780 'formatexpr' + "" use 'formatprg' for auto-formatting
1781 'formatoptions' & "vt" Vi compatible formatting
1782 'gdefault' + off no default 'g' flag for ":s"
1783 'history' & 0 no commandline history
1784 'hkmap' + off no Hebrew keyboard mapping
1785 'hkmapp' + off no phonetic Hebrew keyboard mapping
1786 'hlsearch' + off no highlighting of search matches
1787 'incsearch' + off no incremental searching
1788 'indentexpr' + "" no indenting by expression
1789 'insertmode' + off do not start in Insert mode
1790 'iskeyword' & "@,48-57,_" keywords contain alphanumeric
Bram Moolenaar071d4272004-06-13 20:20:40 +00001791 characters and '_'
Bram Moolenaar214641f2017-03-05 17:04:09 +01001792 'joinspaces' + on insert 2 spaces after period
1793 'modeline' & off no modelines
1794 'more' & off no pauses in listings
1795 'mzquantum' - {unchanged} {set vim default only on resetting 'cp'}
1796 'numberwidth' & 8 min number of columns for line number
1797 'preserveindent'+ off don't preserve current indent structure
1798 when changing it
1799 'revins' + off no reverse insert
1800 'ruler' + off no ruler
1801 'scrolljump' + 1 no jump scroll
1802 'scrolloff' + 0 no scroll offset
1803 'shelltemp' - {unchanged} {set vim default only on resetting 'cp'}
1804 'shiftround' + off indent not rounded to shiftwidth
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02001805 'shortmess' & "S" no shortening of messages
Bram Moolenaar214641f2017-03-05 17:04:09 +01001806 'showcmd' & off command characters not shown
1807 'showmode' & off current mode not shown
1808 'sidescrolloff' + 0 cursor moves to edge of screen in scroll
1809 'smartcase' + off no automatic ignore case switch
1810 'smartindent' + off no smart indentation
1811 'smarttab' + off no smart tab size
1812 'softtabstop' + 0 tabs are always 'tabstop' positions
1813 'startofline' + on goto startofline with some commands
1814 'tagcase' & "followic" 'ignorecase' when searching tags file
1815 'tagrelative' & off tag file names are not relative
1816 'termguicolors' + off don't use highlight-(guifg|guibg)
1817 'textauto' & off no automatic textmode detection
1818 'textwidth' + 0 no automatic line wrap
1819 'tildeop' + off tilde is not an operator
1820 'ttimeout' + off no terminal timeout
1821 'undofile' + off don't use an undo file
Bram Moolenaar036986f2017-03-16 17:41:02 +01001822 'viminfo' - {unchanged} {set Vim default only on resetting 'cp'}
Bram Moolenaar214641f2017-03-05 17:04:09 +01001823 'virtualedit' + "" cursor can only be placed on characters
1824 'whichwrap' & "" left-right movements don't wrap
1825 'wildchar' & CTRL-E only when the current value is <Tab>
Bram Moolenaar071d4272004-06-13 20:20:40 +00001826 use CTRL-E for cmdline completion
Bram Moolenaar214641f2017-03-05 17:04:09 +01001827 'writebackup' + on or off depends on the |+writebackup| feature
Bram Moolenaar071d4272004-06-13 20:20:40 +00001828
1829 *'complete'* *'cpt'* *E535*
1830'complete' 'cpt' string (default: ".,w,b,u,t,i")
1831 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001832 This option specifies how keyword completion |ins-completion| works
1833 when CTRL-P or CTRL-N are used. It is also used for whole-line
1834 completion |i_CTRL-X_CTRL-L|. It indicates the type of completion
1835 and the places to scan. It is a comma separated list of flags:
Bram Moolenaar3848e002016-03-19 18:42:29 +01001836 . scan the current buffer ('wrapscan' is ignored)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001837 w scan buffers from other windows
1838 b scan other loaded buffers that are in the buffer list
1839 u scan the unloaded buffers that are in the buffer list
1840 U scan the buffers that are not in the buffer list
1841 k scan the files given with the 'dictionary' option
Bram Moolenaar0b238792006-03-02 22:49:12 +00001842 kspell use the currently active spell checking |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001843 k{dict} scan the file {dict}. Several "k" flags can be given,
1844 patterns are valid too. For example: >
1845 :set cpt=k/usr/dict/*,k~/spanish
1846< s scan the files given with the 'thesaurus' option
1847 s{tsr} scan the file {tsr}. Several "s" flags can be given, patterns
1848 are valid too.
1849 i scan current and included files
1850 d scan current and included files for defined name or macro
1851 |i_CTRL-X_CTRL-D|
1852 ] tag completion
1853 t same as "]"
1854
1855 Unloaded buffers are not loaded, thus their autocmds |:autocmd| are
1856 not executed, this may lead to unexpected completions from some files
1857 (gzipped files for example). Unloaded buffers are not scanned for
1858 whole-line completion.
1859
1860 The default is ".,w,b,u,t,i", which means to scan:
1861 1. the current buffer
1862 2. buffers in other windows
1863 3. other loaded buffers
1864 4. unloaded buffers
1865 5. tags
1866 6. included files
1867
1868 As you can see, CTRL-N and CTRL-P can be used to do any 'iskeyword'-
Bram Moolenaar582fd852005-03-28 20:58:01 +00001869 based expansion (e.g., dictionary |i_CTRL-X_CTRL-K|, included patterns
1870 |i_CTRL-X_CTRL-I|, tags |i_CTRL-X_CTRL-]| and normal expansions).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001871
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001872 *'completefunc'* *'cfu'*
1873'completefunc' 'cfu' string (default: empty)
1874 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02001875 {not available when compiled without the |+eval|
Bram Moolenaare2c453d2019-08-21 14:37:09 +02001876 feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00001877 This option specifies a function to be used for Insert mode completion
1878 with CTRL-X CTRL-U. |i_CTRL-X_CTRL-U|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001879 See |complete-functions| for an explanation of how the function is
1880 invoked and what it should return.
Bram Moolenaar166af9b2010-11-16 20:34:40 +01001881 This option cannot be set from a |modeline| or in the |sandbox|, for
1882 security reasons.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00001883
Bram Moolenaarac3150d2019-07-28 16:36:39 +02001884 *'completeslash'* *'csl'*
1885'completeslash' 'csl' string (default: "")
1886 local to buffer
Bram Moolenaar2e693a82019-10-16 22:35:02 +02001887 {only for MS-Windows}
Bram Moolenaarac3150d2019-07-28 16:36:39 +02001888 When this option is set it overrules 'shellslash' for completion:
1889 - When this option is set to "slash", a forward slash is used for path
1890 completion in insert mode. This is useful when editing HTML tag, or
Bram Moolenaar6f345a12019-12-17 21:27:18 +01001891 Makefile with 'noshellslash' on MS-Windows.
Bram Moolenaarac3150d2019-07-28 16:36:39 +02001892 - When this option is set to "backslash", backslash is used. This is
Bram Moolenaar6f345a12019-12-17 21:27:18 +01001893 useful when editing a batch file with 'shellslash' set on MS-Windows.
Bram Moolenaarac3150d2019-07-28 16:36:39 +02001894 - When this option is empty, same character is used as for
1895 'shellslash'.
1896 For Insert mode completion the buffer-local value is used. For
1897 command line completion the global value is used.
1898
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001899 *'completeopt'* *'cot'*
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001900'completeopt' 'cot' string (default: "menu,preview")
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001901 global
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001902 A comma separated list of options for Insert mode completion
1903 |ins-completion|. The supported values are:
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001904
1905 menu Use a popup menu to show the possible completions. The
1906 menu is only shown when there is more than one match and
1907 sufficient colors are available. |ins-completion-menu|
1908
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001909 menuone Use the popup menu also when there is only one match.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00001910 Useful when there is additional information about the
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001911 match, e.g., what file it comes from.
1912
Bram Moolenaarc1e37902006-04-18 21:55:01 +00001913 longest Only insert the longest common text of the matches. If
1914 the menu is displayed you can use CTRL-L to add more
1915 characters. Whether case is ignored depends on the kind
1916 of completion. For buffer text the 'ignorecase' option is
1917 used.
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001918
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001919 preview Show extra information about the currently selected
Bram Moolenaar02467872007-05-06 13:22:01 +00001920 completion in the preview window. Only works in
1921 combination with "menu" or "menuone".
1922
Bram Moolenaar576a4a62019-08-18 15:25:17 +02001923 popup Show extra information about the currently selected
1924 completion in a popup window. Only works in combination
1925 with "menu" or "menuone". Overrides "preview".
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02001926 See |'completepopup'| for specifying properties.
Bram Moolenaar2e693a82019-10-16 22:35:02 +02001927 {only works when compiled with the |+textprop| feature}
Bram Moolenaar576a4a62019-08-18 15:25:17 +02001928
Bram Moolenaardca7abe2019-10-20 18:17:57 +02001929 popuphidden
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01001930 Just like "popup" but initially hide the popup. Use a
Bram Moolenaardca7abe2019-10-20 18:17:57 +02001931 |CompleteChanged| autocommand to fetch the info and call
1932 |popup_show()| once the popup has been filled.
1933 See the example at |complete-popuphidden|.
1934 {only works when compiled with the |+textprop| feature}
1935
Bram Moolenaarb6be1e22015-07-10 18:18:40 +02001936 noinsert Do not insert any text for a match until the user selects
1937 a match from the menu. Only works in combination with
1938 "menu" or "menuone". No effect if "longest" is present.
1939
1940 noselect Do not select a match in the menu, force the user to
1941 select one from the menu. Only works in combination with
1942 "menu" or "menuone".
1943
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001944
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02001945 *'completepopup'* *'cpp'*
1946'completepopup' 'cpp' string (default empty)
1947 global
1948 {not available when compiled without the |+textprop|
1949 or |+quickfix| feature}
1950 When 'completeopt' contains "popup" then this option is used for the
Bram Moolenaar06fe74a2019-08-31 16:20:32 +02001951 properties of the info popup when it is created. You can also use
1952 |popup_findinfo()| and then set properties for an existing info popup
1953 with |popup_setoptions()|. See |complete-popup|.
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02001954
1955
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001956 *'concealcursor'* *'cocu'*
1957'concealcursor' 'cocu' string (default: "")
1958 local to window
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001959 {not available when compiled without the |+conceal|
1960 feature}
1961 Sets the modes in which text in the cursor line can also be concealed.
1962 When the current mode is listed then concealing happens just like in
1963 other lines.
1964 n Normal mode
1965 v Visual mode
1966 i Insert mode
Bram Moolenaarca8c9862010-07-24 15:00:38 +02001967 c Command line editing, for 'incsearch'
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001968
Bram Moolenaare6dc5732010-07-24 23:52:26 +02001969 'v' applies to all lines in the Visual area, not only the cursor.
Bram Moolenaarca8c9862010-07-24 15:00:38 +02001970 A useful value is "nc". This is used in help files. So long as you
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001971 are moving around text is concealed, but when starting to insert text
1972 or selecting a Visual area the concealed text is displayed, so that
1973 you can see what you are doing.
Bram Moolenaarf70e3d62010-07-24 13:15:07 +02001974 Keep in mind that the cursor position is not always where it's
1975 displayed. E.g., when moving vertically it may change column.
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001976
1977
Bram Moolenaar95bafa22018-10-02 13:26:25 +02001978 *'conceallevel'* *'cole'*
1979'conceallevel' 'cole' number (default 0)
Bram Moolenaar860cae12010-06-05 23:22:07 +02001980 local to window
Bram Moolenaar860cae12010-06-05 23:22:07 +02001981 {not available when compiled without the |+conceal|
1982 feature}
Bram Moolenaar6df6f472010-07-18 18:04:50 +02001983 Determine how text with the "conceal" syntax attribute |:syn-conceal|
1984 is shown:
Bram Moolenaar860cae12010-06-05 23:22:07 +02001985
Bram Moolenaar6df6f472010-07-18 18:04:50 +02001986 Value Effect ~
Bram Moolenaar860cae12010-06-05 23:22:07 +02001987 0 Text is shown normally
Bram Moolenaar477db062010-07-28 18:17:41 +02001988 1 Each block of concealed text is replaced with one
1989 character. If the syntax item does not have a custom
1990 replacement character defined (see |:syn-cchar|) the
1991 character defined in 'listchars' is used (default is a
1992 space).
1993 It is highlighted with the "Conceal" highlight group.
Bram Moolenaar860cae12010-06-05 23:22:07 +02001994 2 Concealed text is completely hidden unless it has a
1995 custom replacement character defined (see
Bram Moolenaar477db062010-07-28 18:17:41 +02001996 |:syn-cchar|).
Bram Moolenaara7781e02010-07-19 20:13:22 +02001997 3 Concealed text is completely hidden.
Bram Moolenaar860cae12010-06-05 23:22:07 +02001998
Bram Moolenaara7781e02010-07-19 20:13:22 +02001999 Note: in the cursor line concealed text is not hidden, so that you can
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002000 edit and copy the text. This can be changed with the 'concealcursor'
2001 option.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002002
Bram Moolenaar071d4272004-06-13 20:20:40 +00002003 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
2004'confirm' 'cf' boolean (default off)
2005 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002006 When 'confirm' is on, certain operations that would normally
2007 fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
2008 instead raise a |dialog| asking if you wish to save the current
2009 file(s). You can still use a ! to unconditionally |abandon| a buffer.
2010 If 'confirm' is off you can still activate confirmation for one
2011 command only (this is most useful in mappings) with the |:confirm|
2012 command.
2013 Also see the |confirm()| function and the 'v' flag in 'guioptions'.
2014
2015 *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
2016'conskey' 'consk' boolean (default off)
2017 global
Bram Moolenaarf3913272016-02-25 00:00:01 +01002018 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002019
2020 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
2021'copyindent' 'ci' boolean (default off)
2022 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002023 Copy the structure of the existing lines indent when autoindenting a
2024 new line. Normally the new indent is reconstructed by a series of
2025 tabs followed by spaces as required (unless |'expandtab'| is enabled,
2026 in which case only spaces are used). Enabling this option makes the
2027 new line copy whatever characters were used for indenting on the
Bram Moolenaar446cb832008-06-24 21:56:24 +00002028 existing line. 'expandtab' has no effect on these characters, a Tab
2029 remains a Tab. If the new indent is greater than on the existing
Bram Moolenaar071d4272004-06-13 20:20:40 +00002030 line, the remaining space is filled in the normal manner.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002031 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002032 Also see 'preserveindent'.
2033
Bram Moolenaare0fa3742016-02-20 15:47:01 +01002034 *'cpoptions'* *'cpo'* *cpo*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002035'cpoptions' 'cpo' string (Vim default: "aABceFs",
2036 Vi default: all flags)
2037 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002038 A sequence of single character flags. When a character is present
Bram Moolenaar7cba6c02013-09-05 22:13:31 +02002039 this indicates Vi-compatible behavior. This is used for things where
2040 not being Vi-compatible is mostly or sometimes preferred.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002041 'cpoptions' stands for "compatible-options".
2042 Commas can be added for readability.
2043 To avoid problems with flags that are added in the future, use the
2044 "+=" and "-=" feature of ":set" |add-option-flags|.
2045 NOTE: This option is set to the Vi default value when 'compatible' is
2046 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002047 NOTE: This option is set to the POSIX default value at startup when
2048 the Vi default value would be used and the $VIM_POSIX environment
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002049 variable exists |posix|. This means Vim tries to behave like the
2050 POSIX specification.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002051
2052 contains behavior ~
2053 *cpo-a*
2054 a When included, a ":read" command with a file name
2055 argument will set the alternate file name for the
2056 current window.
2057 *cpo-A*
2058 A When included, a ":write" command with a file name
2059 argument will set the alternate file name for the
2060 current window.
2061 *cpo-b*
2062 b "\|" in a ":map" command is recognized as the end of
2063 the map command. The '\' is included in the mapping,
2064 the text after the '|' is interpreted as the next
2065 command. Use a CTRL-V instead of a backslash to
2066 include the '|' in the mapping. Applies to all
2067 mapping, abbreviation, menu and autocmd commands.
2068 See also |map_bar|.
2069 *cpo-B*
2070 B A backslash has no special meaning in mappings,
Bram Moolenaara9604e62018-07-21 05:56:22 +02002071 abbreviations, user commands and the "to" part of the
2072 menu commands. Remove this flag to be able to use a
2073 backslash like a CTRL-V. For example, the command
2074 ":map X \<Esc>" results in X being mapped to:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002075 'B' included: "\^[" (^[ is a real <Esc>)
2076 'B' excluded: "<Esc>" (5 characters)
2077 ('<' excluded in both cases)
2078 *cpo-c*
2079 c Searching continues at the end of any match at the
2080 cursor position, but not further than the start of the
2081 next line. When not present searching continues
2082 one character from the cursor position. With 'c'
2083 "abababababab" only gets three matches when repeating
2084 "/abab", without 'c' there are five matches.
2085 *cpo-C*
2086 C Do not concatenate sourced lines that start with a
2087 backslash. See |line-continuation|.
2088 *cpo-d*
2089 d Using "./" in the 'tags' option doesn't mean to use
2090 the tags file relative to the current file, but the
2091 tags file in the current directory.
2092 *cpo-D*
2093 D Can't use CTRL-K to enter a digraph after Normal mode
2094 commands with a character argument, like |r|, |f| and
2095 |t|.
2096 *cpo-e*
2097 e When executing a register with ":@r", always add a
2098 <CR> to the last line, also when the register is not
2099 linewise. If this flag is not present, the register
2100 is not linewise and the last line does not end in a
2101 <CR>, then the last line is put on the command-line
2102 and can be edited before hitting <CR>.
2103 *cpo-E*
2104 E It is an error when using "y", "d", "c", "g~", "gu" or
2105 "gU" on an Empty region. The operators only work when
Bram Moolenaar15142e22018-04-30 22:19:58 +02002106 at least one character is to be operated on. Example:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002107 This makes "y0" fail in the first column.
2108 *cpo-f*
2109 f When included, a ":read" command with a file name
2110 argument will set the file name for the current buffer,
2111 if the current buffer doesn't have a file name yet.
2112 *cpo-F*
2113 F When included, a ":write" command with a file name
2114 argument will set the file name for the current
2115 buffer, if the current buffer doesn't have a file name
Bram Moolenaarb3480382005-12-11 21:33:32 +00002116 yet. Also see |cpo-P|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002117 *cpo-g*
2118 g Goto line 1 when using ":edit" without argument.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002119 *cpo-H*
2120 H When using "I" on a line with only blanks, insert
2121 before the last blank. Without this flag insert after
2122 the last blank.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002123 *cpo-i*
2124 i When included, interrupting the reading of a file will
2125 leave it modified.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002126 *cpo-I*
2127 I When moving the cursor up or down just after inserting
2128 indent for 'autoindent', do not delete the indent.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002129 *cpo-j*
2130 j When joining lines, only add two spaces after a '.',
2131 not after '!' or '?'. Also see 'joinspaces'.
2132 *cpo-J*
2133 J A |sentence| has to be followed by two spaces after
Bram Moolenaar582fd852005-03-28 20:58:01 +00002134 the '.', '!' or '?'. A <Tab> is not recognized as
Bram Moolenaar071d4272004-06-13 20:20:40 +00002135 white space.
2136 *cpo-k*
2137 k Disable the recognition of raw key codes in
2138 mappings, abbreviations, and the "to" part of menu
2139 commands. For example, if <Key> sends ^[OA (where ^[
2140 is <Esc>), the command ":map X ^[OA" results in X
2141 being mapped to:
2142 'k' included: "^[OA" (3 characters)
2143 'k' excluded: "<Key>" (one key code)
2144 Also see the '<' flag below.
2145 *cpo-K*
2146 K Don't wait for a key code to complete when it is
2147 halfway a mapping. This breaks mapping <F1><F1> when
2148 only part of the second <F1> has been read. It
2149 enables cancelling the mapping by typing <F1><Esc>.
2150 *cpo-l*
2151 l Backslash in a [] range in a search pattern is taken
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002152 literally, only "\]", "\^", "\-" and "\\" are special.
2153 See |/[]|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002154 'l' included: "/[ \t]" finds <Space>, '\' and 't'
2155 'l' excluded: "/[ \t]" finds <Space> and <Tab>
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002156 Also see |cpo-\|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002157 *cpo-L*
2158 L When the 'list' option is set, 'wrapmargin',
2159 'textwidth', 'softtabstop' and Virtual Replace mode
2160 (see |gR|) count a <Tab> as two characters, instead of
2161 the normal behavior of a <Tab>.
2162 *cpo-m*
2163 m When included, a showmatch will always wait half a
2164 second. When not included, a showmatch will wait half
2165 a second or until a character is typed. |'showmatch'|
2166 *cpo-M*
2167 M When excluded, "%" matching will take backslashes into
2168 account. Thus in "( \( )" and "\( ( \)" the outer
2169 parenthesis match. When included "%" ignores
2170 backslashes, which is Vi compatible.
2171 *cpo-n*
Bram Moolenaar64486672010-05-16 15:46:46 +02002172 n When included, the column used for 'number' and
2173 'relativenumber' will also be used for text of wrapped
2174 lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002175 *cpo-o*
2176 o Line offset to search command is not remembered for
2177 next search.
2178 *cpo-O*
2179 O Don't complain if a file is being overwritten, even
2180 when it didn't exist when editing it. This is a
2181 protection against a file unexpectedly created by
2182 someone else. Vi didn't complain about this.
2183 *cpo-p*
2184 p Vi compatible Lisp indenting. When not present, a
2185 slightly better algorithm is used.
Bram Moolenaarb3480382005-12-11 21:33:32 +00002186 *cpo-P*
2187 P When included, a ":write" command that appends to a
2188 file will set the file name for the current buffer, if
2189 the current buffer doesn't have a file name yet and
2190 the 'F' flag is also included |cpo-F|.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002191 *cpo-q*
2192 q When joining multiple lines leave the cursor at the
2193 position where it would be when joining two lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002194 *cpo-r*
2195 r Redo ("." command) uses "/" to repeat a search
2196 command, instead of the actually used search string.
2197 *cpo-R*
2198 R Remove marks from filtered lines. Without this flag
2199 marks are kept like |:keepmarks| was used.
2200 *cpo-s*
2201 s Set buffer options when entering the buffer for the
2202 first time. This is like it is in Vim version 3.0.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002203 And it is the default. If not present the options are
Bram Moolenaar071d4272004-06-13 20:20:40 +00002204 set when the buffer is created.
2205 *cpo-S*
2206 S Set buffer options always when entering a buffer
2207 (except 'readonly', 'fileformat', 'filetype' and
2208 'syntax'). This is the (most) Vi compatible setting.
2209 The options are set to the values in the current
2210 buffer. When you change an option and go to another
2211 buffer, the value is copied. Effectively makes the
2212 buffer options global to all buffers.
2213
2214 's' 'S' copy buffer options
2215 no no when buffer created
2216 yes no when buffer first entered (default)
2217 X yes each time when buffer entered (vi comp.)
2218 *cpo-t*
2219 t Search pattern for the tag command is remembered for
2220 "n" command. Otherwise Vim only puts the pattern in
2221 the history for search pattern, but doesn't change the
2222 last used search pattern.
2223 *cpo-u*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002224 u Undo is Vi compatible. See |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002225 *cpo-v*
2226 v Backspaced characters remain visible on the screen in
2227 Insert mode. Without this flag the characters are
2228 erased from the screen right away. With this flag the
2229 screen newly typed text overwrites backspaced
2230 characters.
2231 *cpo-w*
2232 w When using "cw" on a blank character, only change one
2233 character and not all blanks until the start of the
2234 next word.
2235 *cpo-W*
2236 W Don't overwrite a readonly file. When omitted, ":w!"
2237 overwrites a readonly file, if possible.
2238 *cpo-x*
2239 x <Esc> on the command-line executes the command-line.
2240 The default in Vim is to abandon the command-line,
2241 because <Esc> normally aborts a command. |c_<Esc>|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002242 *cpo-X*
2243 X When using a count with "R" the replaced text is
2244 deleted only once. Also when repeating "R" with "."
2245 and a count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002246 *cpo-y*
Bram Moolenaard09091d2019-01-17 16:07:22 +01002247 y A yank command can be redone with ".". Think twice if
2248 you really want to use this, it may break some
2249 plugins, since most people expect "." to only repeat a
2250 change.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002251 *cpo-Z*
2252 Z When using "w!" while the 'readonly' option is set,
2253 don't reset 'readonly'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002254 *cpo-!*
2255 ! When redoing a filter command, use the last used
2256 external command, whatever it was. Otherwise the last
2257 used -filter- command is used.
2258 *cpo-$*
2259 $ When making a change to one line, don't redisplay the
2260 line, but put a '$' at the end of the changed text.
2261 The changed text will be overwritten when you type the
2262 new text. The line is redisplayed if you type any
2263 command that moves the cursor from the insertion
2264 point.
2265 *cpo-%*
2266 % Vi-compatible matching is done for the "%" command.
2267 Does not recognize "#if", "#endif", etc.
2268 Does not recognize "/*" and "*/".
2269 Parens inside single and double quotes are also
2270 counted, causing a string that contains a paren to
2271 disturb the matching. For example, in a line like
2272 "if (strcmp("foo(", s))" the first paren does not
2273 match the last one. When this flag is not included,
2274 parens inside single and double quotes are treated
2275 specially. When matching a paren outside of quotes,
2276 everything inside quotes is ignored. When matching a
2277 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002278 there is one). This works very well for C programs.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002279 This flag is also used for other features, such as
2280 C-indenting.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002281 *cpo--*
2282 - When included, a vertical movement command fails when
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002283 it would go above the first line or below the last
2284 line. Without it the cursor moves to the first or
2285 last line, unless it already was in that line.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002286 Applies to the commands "-", "k", CTRL-P, "+", "j",
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002287 CTRL-N, CTRL-J and ":1234".
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002288 *cpo-+*
2289 + When included, a ":write file" command will reset the
2290 'modified' flag of the buffer, even though the buffer
2291 itself may still be different from its file.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002292 *cpo-star*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002293 * Use ":*" in the same way as ":@". When not included,
2294 ":*" is an alias for ":'<,'>", select the Visual area.
2295 *cpo-<*
2296 < Disable the recognition of special key codes in |<>|
2297 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002298 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00002299 ":map X <Tab>" results in X being mapped to:
2300 '<' included: "<Tab>" (5 characters)
2301 '<' excluded: "^I" (^I is a real <Tab>)
2302 Also see the 'k' flag above.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002303 *cpo->*
2304 > When appending to a register, put a line break before
2305 the appended text.
Bram Moolenaar8b3e0332011-06-26 05:36:34 +02002306 *cpo-;*
2307 ; When using |,| or |;| to repeat the last |t| search
2308 and the cursor is right in front of the searched
2309 character, the cursor won't move. When not included,
2310 the cursor would skip over it and jump to the
Bram Moolenaarc8734422012-06-01 22:38:45 +02002311 following occurrence.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002312
2313 POSIX flags. These are not included in the Vi default value, except
2314 when $VIM_POSIX was set on startup. |posix|
2315
2316 contains behavior ~
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002317 *cpo-#*
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002318 # A count before "D", "o" and "O" has no effect.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002319 *cpo-&*
2320 & When ":preserve" was used keep the swap file when
2321 exiting normally while this buffer is still loaded.
2322 This flag is tested when exiting.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002323 *cpo-\*
2324 \ Backslash in a [] range in a search pattern is taken
2325 literally, only "\]" is special See |/[]|
Bram Moolenaar90915b52005-08-21 22:17:52 +00002326 '\' included: "/[ \-]" finds <Space>, '\' and '-'
2327 '\' excluded: "/[ \-]" finds <Space> and '-'
2328 Also see |cpo-l|.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002329 *cpo-/*
2330 / When "%" is used as the replacement string in a |:s|
2331 command, use the previous replacement string. |:s%|
2332 *cpo-{*
2333 { The |{| and |}| commands also stop at a "{" character
2334 at the start of a line.
2335 *cpo-.*
2336 . The ":chdir" and ":cd" commands fail if the current
2337 buffer is modified, unless ! is used. Vim doesn't
2338 need this, since it remembers the full path of an
2339 opened file.
2340 *cpo-bar*
2341 | The value of the $LINES and $COLUMNS environment
2342 variables overrule the terminal size values obtained
2343 with system specific functions.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002344
Bram Moolenaar071d4272004-06-13 20:20:40 +00002345
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002346 *'cryptmethod'* *'cm'*
Bram Moolenaara86187b2018-12-16 18:20:00 +01002347'cryptmethod' 'cm' string (default "blowfish2")
Bram Moolenaar49771f42010-07-20 17:32:38 +02002348 global or local to buffer |global-local|
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002349 Method used for encryption when the buffer is written to a file:
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002350 *pkzip*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002351 zip PkZip compatible method. A weak kind of encryption.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002352 Backwards compatible with Vim 7.2 and older.
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002353 *blowfish*
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002354 blowfish Blowfish method. Medium strong encryption but it has
2355 an implementation flaw. Requires Vim 7.3 or later,
2356 files can NOT be read by Vim 7.2 and older. This adds
2357 a "seed" to the file, every time you write the file
2358 the encrypted bytes will be different.
2359 *blowfish2*
2360 blowfish2 Blowfish method. Medium strong encryption. Requires
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01002361 Vim 7.4.401 or later, files can NOT be read by Vim 7.3
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002362 and older. This adds a "seed" to the file, every time
2363 you write the file the encrypted bytes will be
2364 different. The whole undo file is encrypted, not just
2365 the pieces of text.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002366
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01002367 You should use "blowfish2", also to re-encrypt older files.
2368
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002369 When reading an encrypted file 'cryptmethod' will be set automatically
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002370 to the detected method of the file being read. Thus if you write it
2371 without changing 'cryptmethod' the same method will be used.
2372 Changing 'cryptmethod' does not mark the file as modified, you have to
Bram Moolenaar49771f42010-07-20 17:32:38 +02002373 explicitly write it, you don't get a warning unless there are other
2374 modifications. Also see |:X|.
2375
2376 When setting the global value to an empty string, it will end up with
Bram Moolenaara86187b2018-12-16 18:20:00 +01002377 the value "blowfish2". When setting the local value to an empty
2378 string the buffer will use the global value.
Bram Moolenaar49771f42010-07-20 17:32:38 +02002379
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002380 When a new encryption method is added in a later version of Vim, and
2381 the current version does not recognize it, you will get *E821* .
Bram Moolenaar49771f42010-07-20 17:32:38 +02002382 You need to edit this file with the later version of Vim.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002383
2384
Bram Moolenaar071d4272004-06-13 20:20:40 +00002385 *'cscopepathcomp'* *'cspc'*
2386'cscopepathcomp' 'cspc' number (default 0)
2387 global
2388 {not available when compiled without the |+cscope|
2389 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002390 Determines how many components of the path to show in a list of tags.
2391 See |cscopepathcomp|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002392 NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002393
2394 *'cscopeprg'* *'csprg'*
2395'cscopeprg' 'csprg' string (default "cscope")
2396 global
2397 {not available when compiled without the |+cscope|
2398 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002399 Specifies the command to execute cscope. See |cscopeprg|.
2400 This option cannot be set from a |modeline| or in the |sandbox|, for
2401 security reasons.
2402
2403 *'cscopequickfix'* *'csqf'*
2404'cscopequickfix' 'csqf' string (default "")
2405 global
2406 {not available when compiled without the |+cscope|
2407 or |+quickfix| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002408 Specifies whether to use quickfix window to show cscope results.
2409 See |cscopequickfix|.
2410
Bram Moolenaarec7944a2013-06-12 21:29:15 +02002411 *'cscoperelative'* *'csre'* *'nocscoperelative'* *'nocsre'*
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002412'cscoperelative' 'csre' boolean (default off)
2413 global
2414 {not available when compiled without the |+cscope|
2415 feature}
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002416 In the absence of a prefix (-P) for cscope. setting this option enables
2417 to use the basename of cscope.out path as the prefix.
2418 See |cscoperelative|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002419 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002420
Bram Moolenaar071d4272004-06-13 20:20:40 +00002421 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
2422'cscopetag' 'cst' boolean (default off)
2423 global
2424 {not available when compiled without the |+cscope|
2425 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002426 Use cscope for tag commands. See |cscope-options|.
2427 NOTE: This option is reset when 'compatible' is set.
2428
2429 *'cscopetagorder'* *'csto'*
2430'cscopetagorder' 'csto' number (default 0)
2431 global
2432 {not available when compiled without the |+cscope|
2433 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002434 Determines the order in which ":cstag" performs a search. See
2435 |cscopetagorder|.
2436 NOTE: This option is set to 0 when 'compatible' is set.
2437
2438 *'cscopeverbose'* *'csverb'*
2439 *'nocscopeverbose'* *'nocsverb'*
2440'cscopeverbose' 'csverb' boolean (default off)
2441 global
2442 {not available when compiled without the |+cscope|
2443 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002444 Give messages when adding a cscope database. See |cscopeverbose|.
2445 NOTE: This option is reset when 'compatible' is set.
2446
Bram Moolenaar860cae12010-06-05 23:22:07 +02002447 *'cursorbind'* *'crb'* *'nocursorbind'* *'nocrb'*
2448'cursorbind' 'crb' boolean (default off)
2449 local to window
Bram Moolenaar860cae12010-06-05 23:22:07 +02002450 When this option is set, as the cursor in the current
2451 window moves other cursorbound windows (windows that also have
2452 this option set) move their cursors to the corresponding line and
2453 column. This option is useful for viewing the
2454 differences between two versions of a file (see 'diff'); in diff mode,
2455 inserted and deleted lines (though not characters within a line) are
Bram Moolenaar1a384422010-07-14 19:53:30 +02002456 taken into account.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002457
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002458
2459 *'cursorcolumn'* *'cuc'* *'nocursorcolumn'* *'nocuc'*
2460'cursorcolumn' 'cuc' boolean (default off)
2461 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02002462 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002463 feature}
2464 Highlight the screen column of the cursor with CursorColumn
2465 |hl-CursorColumn|. Useful to align text. Will make screen redrawing
2466 slower.
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00002467 If you only want the highlighting in the current window you can use
2468 these autocommands: >
2469 au WinLeave * set nocursorline nocursorcolumn
2470 au WinEnter * set cursorline cursorcolumn
2471<
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002472
2473 *'cursorline'* *'cul'* *'nocursorline'* *'nocul'*
2474'cursorline' 'cul' boolean (default off)
2475 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02002476 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002477 feature}
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002478 Highlight the text line of the cursor with CursorLine |hl-CursorLine|.
2479 Useful to easily spot the cursor. Will make screen redrawing slower.
Bram Moolenaare2f98b92006-03-29 21:18:24 +00002480 When Visual mode is active the highlighting isn't used to make it
Bram Moolenaar779b74b2006-04-10 14:55:34 +00002481 easier to see the selected text.
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002482
2483
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002484 *'cursorlineopt'* *'culopt'*
Bram Moolenaar017ba072019-09-14 21:01:23 +02002485'cursorlineopt' 'culopt' string (default: "number,line")
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002486 local to window
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002487 {not available when compiled without the |+syntax|
2488 feature}
Bram Moolenaar017ba072019-09-14 21:01:23 +02002489 Comma separated list of settings for how 'cursorline' is displayed.
2490 Valid values:
2491 "line" Highlight the text line of the cursor with
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002492 CursorLine |hl-CursorLine|.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002493 "screenline" Highlight only the screen line of the cursor with
2494 CursorLine |hl-CursorLine|.
2495 "number" Highlight the line number of the cursor with
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002496 CursorLineNr |hl-CursorLineNr|.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002497
2498 Special value:
2499 "both" Alias for the values "line,number".
2500
2501 "line" and "screenline" cannot be used together.
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002502
2503
Bram Moolenaar071d4272004-06-13 20:20:40 +00002504 *'debug'*
2505'debug' string (default "")
2506 global
Bram Moolenaar57657d82006-04-21 22:12:41 +00002507 These values can be used:
2508 msg Error messages that would otherwise be omitted will be given
2509 anyway.
2510 throw Error messages that would otherwise be omitted will be given
2511 anyway and also throw an exception and set |v:errmsg|.
2512 beep A message will be given when otherwise only a beep would be
2513 produced.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002514 The values can be combined, separated by a comma.
Bram Moolenaar57657d82006-04-21 22:12:41 +00002515 "msg" and "throw" are useful for debugging 'foldexpr', 'formatexpr' or
2516 'indentexpr'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002517
2518 *'define'* *'def'*
2519'define' 'def' string (default "^\s*#\s*define")
2520 global or local to buffer |global-local|
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002521 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002522 pattern, just like for the "/" command. This option is used for the
2523 commands like "[i" and "[d" |include-search|. The 'isident' option is
2524 used to recognize the defined name after the match:
2525 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2526 See |option-backslash| about inserting backslashes to include a space
2527 or backslash.
2528 The default value is for C programs. For C++ this value would be
2529 useful, to include const type declarations: >
2530 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
Bram Moolenaar63b74a82019-03-24 15:09:13 +01002531< You can also use "\ze" just before the name and continue the pattern
2532 to check what is following. E.g. for Javascript, if a function is
2533 defined with "func_name = function(args)": >
2534 ^\s*\ze\i\+\s*=\s*function(
2535< If the function is defined with "func_name : function() {...": >
2536 ^\s*\ze\i\+\s*[:]\s*(*function\s*(
Bram Moolenaar071d4272004-06-13 20:20:40 +00002537< When using the ":set" command, you need to double the backslashes!
Bram Moolenaar63b74a82019-03-24 15:09:13 +01002538 To avoid that use `:let` with a single quote string: >
2539 let &l:define = '^\s*\ze\k\+\s*=\s*function('
Bram Moolenaar911ead12019-04-21 00:03:35 +02002540<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002541
2542 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2543'delcombine' 'deco' boolean (default off)
2544 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002545 If editing Unicode and this option is set, backspace and Normal mode
2546 "x" delete each combining character on its own. When it is off (the
2547 default) the character along with its combining characters are
2548 deleted.
2549 Note: When 'delcombine' is set "xx" may work different from "2x"!
2550
2551 This is useful for Arabic, Hebrew and many other languages where one
2552 may have combining characters overtop of base characters, and want
2553 to remove only the combining ones.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002554 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002555
2556 *'dictionary'* *'dict'*
2557'dictionary' 'dict' string (default "")
2558 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002559 List of file names, separated by commas, that are used to lookup words
2560 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2561 contain a list of words. This can be one word per line, or several
2562 words per line, separated by non-keyword characters (white space is
2563 preferred). Maximum line length is 510 bytes.
Bram Moolenaar259f26a2018-05-15 22:25:40 +02002564
2565 When this option is empty or an entry "spell" is present, and spell
2566 checking is enabled, words in the word lists for the currently active
2567 'spelllang' are used. See |spell|.
2568
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002569 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002570 after a comma are ignored, otherwise spaces are included in the file
2571 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002572 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002573 Where to find a list of words?
2574 - On FreeBSD, there is the file "/usr/share/dict/words".
2575 - In the Simtel archive, look in the "msdos/linguist" directory.
2576 - In "miscfiles" of the GNU collection.
2577 The use of |:set+=| and |:set-=| is preferred when adding or removing
2578 directories from the list. This avoids problems when a future version
2579 uses another default.
2580 Backticks cannot be used in this option for security reasons.
2581
2582 *'diff'* *'nodiff'*
2583'diff' boolean (default off)
2584 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00002585 {not available when compiled without the |+diff|
2586 feature}
2587 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002588 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002589
2590 *'dex'* *'diffexpr'*
2591'diffexpr' 'dex' string (default "")
2592 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002593 {not available when compiled without the |+diff|
2594 feature}
Bram Moolenaare828b762018-09-10 17:51:58 +02002595 Expression which is evaluated to obtain a diff file (either ed-style
2596 or unified-style) from two versions of a file. See |diff-diffexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002597 This option cannot be set from a |modeline| or in the |sandbox|, for
2598 security reasons.
2599
2600 *'dip'* *'diffopt'*
Bram Moolenaarc8234772019-11-10 21:00:27 +01002601'diffopt' 'dip' string (default "internal,filler,closeoff")
Bram Moolenaar071d4272004-06-13 20:20:40 +00002602 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002603 {not available when compiled without the |+diff|
2604 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002605 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002606 All are optional. Items must be separated by a comma.
2607
2608 filler Show filler lines, to keep the text
2609 synchronized with a window that has inserted
2610 lines at the same position. Mostly useful
2611 when windows are side-by-side and 'scrollbind'
2612 is set.
2613
2614 context:{n} Use a context of {n} lines between a change
2615 and a fold that contains unchanged lines.
2616 When omitted a context of six lines is used.
Bram Moolenaarf6b40102019-02-22 15:24:03 +01002617 When using zero the context is actually one,
2618 since folds require a line in between, also
2619 for a deleted line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002620 See |fold-diff|.
2621
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002622 iblank Ignore changes where lines are all blank. Adds
2623 the "-B" flag to the "diff" command if
2624 'diffexpr' is empty. Check the documentation
2625 of the "diff" command for what this does
2626 exactly.
2627 NOTE: the diff windows will get out of sync,
2628 because no differences between blank lines are
2629 taken into account.
2630
Bram Moolenaar071d4272004-06-13 20:20:40 +00002631 icase Ignore changes in case of text. "a" and "A"
2632 are considered the same. Adds the "-i" flag
2633 to the "diff" command if 'diffexpr' is empty.
2634
2635 iwhite Ignore changes in amount of white space. Adds
2636 the "-b" flag to the "diff" command if
2637 'diffexpr' is empty. Check the documentation
2638 of the "diff" command for what this does
2639 exactly. It should ignore adding trailing
2640 white space, but not leading white space.
2641
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002642 iwhiteall Ignore all white space changes. Adds
2643 the "-w" flag to the "diff" command if
2644 'diffexpr' is empty. Check the documentation
2645 of the "diff" command for what this does
2646 exactly.
2647
2648 iwhiteeol Ignore white space changes at end of line.
2649 Adds the "-Z" flag to the "diff" command if
2650 'diffexpr' is empty. Check the documentation
2651 of the "diff" command for what this does
2652 exactly.
2653
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002654 horizontal Start diff mode with horizontal splits (unless
2655 explicitly specified otherwise).
2656
2657 vertical Start diff mode with vertical splits (unless
2658 explicitly specified otherwise).
2659
Bram Moolenaarc8234772019-11-10 21:00:27 +01002660 closeoff When a window is closed where 'diff' is set
2661 and there is only one window remaining in the
2662 same tab page with 'diff' set, execute
2663 `:diffoff` in that window. This undoes a
2664 `:diffsplit` command.
2665
Bram Moolenaar97ce4192017-12-01 20:35:58 +01002666 hiddenoff Do not use diff mode for a buffer when it
2667 becomes hidden.
2668
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002669 foldcolumn:{n} Set the 'foldcolumn' option to {n} when
2670 starting diff mode. Without this 2 is used.
2671
Bram Moolenaare828b762018-09-10 17:51:58 +02002672 internal Use the internal diff library. This is
2673 ignored when 'diffexpr' is set. *E960*
2674 When running out of memory when writing a
2675 buffer this item will be ignored for diffs
2676 involving that buffer. Set the 'verbose'
2677 option to see when this happens.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002678
Bram Moolenaare828b762018-09-10 17:51:58 +02002679 indent-heuristic
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01002680 Use the indent heuristic for the internal
2681 diff library.
Bram Moolenaare828b762018-09-10 17:51:58 +02002682
2683 algorithm:{text} Use the specified diff algorithm with the
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01002684 internal diff engine. Currently supported
Bram Moolenaare828b762018-09-10 17:51:58 +02002685 algorithms are:
2686 myers the default algorithm
2687 minimal spend extra time to generate the
2688 smallest possible diff
2689 patience patience diff algorithm
2690 histogram histogram diff algorithm
2691
2692 Examples: >
2693 :set diffopt=internal,filler,context:4
Bram Moolenaar071d4272004-06-13 20:20:40 +00002694 :set diffopt=
Bram Moolenaare828b762018-09-10 17:51:58 +02002695 :set diffopt=internal,filler,foldcolumn:3
2696 :set diffopt-=internal " do NOT use the internal diff parser
Bram Moolenaar071d4272004-06-13 20:20:40 +00002697<
2698 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
2699'digraph' 'dg' boolean (default off)
2700 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002701 {not available when compiled without the |+digraphs|
2702 feature}
2703 Enable the entering of digraphs in Insert mode with {char1} <BS>
2704 {char2}. See |digraphs|.
2705 NOTE: This option is reset when 'compatible' is set.
2706
2707 *'directory'* *'dir'*
2708'directory' 'dir' string (default for Amiga: ".,t:",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01002709 for Win32: ".,$TEMP,c:\tmp,c:\temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00002710 for Unix: ".,~/tmp,/var/tmp,/tmp")
2711 global
2712 List of directory names for the swap file, separated with commas.
2713 - The swap file will be created in the first directory where this is
2714 possible.
2715 - Empty means that no swap file will be used (recovery is
Bram Moolenaar00e192b2019-10-19 17:01:28 +02002716 impossible!) and no |E303| error will be given.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002717 - A directory "." means to put the swap file in the same directory as
2718 the edited file. On Unix, a dot is prepended to the file name, so
2719 it doesn't show in a directory listing. On MS-Windows the "hidden"
2720 attribute is set and a dot prepended if possible.
Bram Moolenaar8024f932020-01-14 19:29:13 +01002721 - A directory starting with "./" (or ".\" for MS-Windows) means to put
2722 the swap file relative to where the edited file is. The leading "."
2723 is replaced with the path name of the edited file.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02002724 - For Unix and Win32, if a directory ends in two path separators "//",
2725 the swap file name will be built from the complete path to the file
2726 with all path separators substituted to percent '%' signs. This will
2727 ensure file name uniqueness in the preserve directory.
2728 On Win32, it is also possible to end with "\\". However, When a
2729 separating comma is following, you must use "//", since "\\" will
2730 include the comma in the file name. Therefore it is recommended to
2731 use '//', instead of '\\'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002732 - Spaces after the comma are ignored, other spaces are considered part
2733 of the directory name. To have a space at the start of a directory
2734 name, precede it with a backslash.
2735 - To include a comma in a directory name precede it with a backslash.
2736 - A directory name may end in an ':' or '/'.
2737 - Environment variables are expanded |:set_env|.
2738 - Careful with '\' characters, type one before a space, type two to
2739 get one in the option (see |option-backslash|), for example: >
2740 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
2741< - For backwards compatibility with Vim version 3.0 a '>' at the start
2742 of the option is removed.
2743 Using "." first in the list is recommended. This means that editing
2744 the same file twice will result in a warning. Using "/tmp" on Unix is
2745 discouraged: When the system crashes you lose the swap file.
2746 "/var/tmp" is often not cleared when rebooting, thus is a better
2747 choice than "/tmp". But it can contain a lot of files, your swap
2748 files get lost in the crowd. That is why a "tmp" directory in your
2749 home directory is tried first.
2750 The use of |:set+=| and |:set-=| is preferred when adding or removing
2751 directories from the list. This avoids problems when a future version
2752 uses another default.
2753 This option cannot be set from a |modeline| or in the |sandbox|, for
2754 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002755
2756 *'display'* *'dy'*
Bram Moolenaarbc8801c2016-08-02 21:04:33 +02002757'display' 'dy' string (default "", set to "truncate" in
2758 |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002759 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002760 Change the way text is displayed. This is comma separated list of
2761 flags:
2762 lastline When included, as much as possible of the last line
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02002763 in a window will be displayed. "@@@" is put in the
2764 last columns of the last screen line to indicate the
2765 rest of the line is not displayed.
2766 truncate Like "lastline", but "@@@" is displayed in the first
2767 column of the last screen line. Overrules "lastline".
Bram Moolenaar071d4272004-06-13 20:20:40 +00002768 uhex Show unprintable characters hexadecimal as <xx>
2769 instead of using ^C and ~C.
2770
Bram Moolenaard0796902016-09-16 20:02:31 +02002771 When neither "lastline" nor "truncate" is included, a last line that
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02002772 doesn't fit is replaced with "@" lines.
2773
Bram Moolenaar071d4272004-06-13 20:20:40 +00002774 *'eadirection'* *'ead'*
2775'eadirection' 'ead' string (default "both")
2776 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002777 Tells when the 'equalalways' option applies:
2778 ver vertically, width of windows is not affected
2779 hor horizontally, height of windows is not affected
2780 both width and height of windows is affected
2781
2782 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
2783'edcompatible' 'ed' boolean (default off)
2784 global
2785 Makes the 'g' and 'c' flags of the ":substitute" command to be
2786 toggled each time the flag is given. See |complex-change|. See
2787 also 'gdefault' option.
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +02002788 Switching this option on may break plugins!
Bram Moolenaar071d4272004-06-13 20:20:40 +00002789
Bram Moolenaar03413f42016-04-12 21:07:15 +02002790 *'emoji'* *'emo'* *'noemoji'* *'noemo'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01002791'emoji' 'emo' boolean (default: on)
2792 global
Bram Moolenaar3848e002016-03-19 18:42:29 +01002793 When on all Unicode emoji characters are considered to be full width.
2794
2795
Bram Moolenaar071d4272004-06-13 20:20:40 +00002796 *'encoding'* *'enc'* *E543*
2797'encoding' 'enc' string (default: "latin1" or value from $LANG)
2798 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002799 Sets the character encoding used inside Vim. It applies to text in
2800 the buffers, registers, Strings in expressions, text stored in the
2801 viminfo file, etc. It sets the kind of characters which Vim can work
2802 with. See |encoding-names| for the possible values.
2803
2804 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002805 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002806 It should normally be kept at its default value, or set when Vim
Bram Moolenaar02467872007-05-06 13:22:01 +00002807 starts up. See |multibyte|. To reload the menus see |:menutrans|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002808
Bram Moolenaar865242e2010-07-14 21:12:05 +02002809 This option cannot be set from a |modeline|. It would most likely
2810 corrupt the text.
2811
Bram Moolenaar3df01732017-02-17 22:47:16 +01002812 NOTE: For GTK+ 2 or later, it is highly recommended to set 'encoding'
2813 to "utf-8". Although care has been taken to allow different values of
Bram Moolenaar071d4272004-06-13 20:20:40 +00002814 'encoding', "utf-8" is the natural choice for the environment and
2815 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002816 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00002817 versions, and to avoid changing the encoding of newly created files
2818 without your knowledge (in case 'fileencodings' is empty).
2819
2820 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002821 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00002822 iconv() or as specified with 'charconvert'.
2823
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002824 If you need to know whether 'encoding' is a multi-byte encoding, you
2825 can use: >
2826 if has("multi_byte_encoding")
2827<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002828 Normally 'encoding' will be equal to your current locale. This will
2829 be the default if Vim recognizes your environment settings. If
2830 'encoding' is not set to the current locale, 'termencoding' must be
2831 set to convert typed and displayed text. See |encoding-table|.
2832
2833 When you set this option, it fires the |EncodingChanged| autocommand
2834 event so that you can set up fonts if necessary.
2835
2836 When the option is set, the value is converted to lowercase. Thus
2837 you can set it with uppercase values too. Underscores are translated
2838 to '-' signs.
2839 When the encoding is recognized, it is changed to the standard name.
2840 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
2841 "iso-8859-2" and "utf8" becomes "utf-8".
2842
2843 Note: "latin1" is also used when the encoding could not be detected.
2844 This only works when editing files in the same encoding! When the
2845 actual character set is not latin1, make sure 'fileencoding' and
2846 'fileencodings' are empty. When conversion is needed, switch to using
2847 utf-8.
2848
2849 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
2850 You don't notice this while editing, but it does matter for the
2851 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
2852 setting 'encoding' to one of these values instead of utf-8 only has
2853 effect for encoding used for files when 'fileencoding' is empty.
2854
Bram Moolenaar661b1822005-07-28 22:36:45 +00002855 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
2856 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002857
2858 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
2859'endofline' 'eol' boolean (default on)
2860 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002861 When writing a file and this option is off and the 'binary' option
Bram Moolenaar34d72d42015-07-17 14:18:08 +02002862 is on, or 'fixeol' option is off, no <EOL> will be written for the
2863 last line in the file. This option is automatically set or reset when
2864 starting to edit a new file, depending on whether file has an <EOL>
2865 for the last line in the file. Normally you don't have to set or
2866 reset this option.
2867 When 'binary' is off and 'fixeol' is on the value is not used when
2868 writing the file. When 'binary' is on or 'fixeol' is off it is used
2869 to remember the presence of a <EOL> for the last line in the file, so
2870 that when you write the file the situation from the original file can
2871 be kept. But you can change it if you want to.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002872
2873 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
2874'equalalways' 'ea' boolean (default on)
2875 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002876 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00002877 splitting or closing a window. This also happens the moment the
2878 option is switched on. When off, splitting a window will reduce the
2879 size of the current window and leave the other windows the same. When
2880 closing a window the extra lines are given to the window next to it
2881 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00002882 When mixing vertically and horizontally split windows, a minimal size
2883 is computed and some windows may be larger if there is room. The
2884 'eadirection' option tells in which direction the size is affected.
Bram Moolenaar67f71312007-08-12 14:55:56 +00002885 Changing the height and width of a window can be avoided by setting
2886 'winfixheight' and 'winfixwidth', respectively.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002887 If a window size is specified when creating a new window sizes are
2888 currently not equalized (it's complicated, but may be implemented in
2889 the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002890
2891 *'equalprg'* *'ep'*
2892'equalprg' 'ep' string (default "")
2893 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002894 External program to use for "=" command. When this option is empty
Bram Moolenaar446cb832008-06-24 21:56:24 +00002895 the internal formatting functions are used; either 'lisp', 'cindent'
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002896 or 'indentexpr'. When Vim was compiled without internal formatting,
2897 the "indent" program is used.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002898 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002899 about including spaces and backslashes.
2900 This option cannot be set from a |modeline| or in the |sandbox|, for
2901 security reasons.
2902
2903 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
2904'errorbells' 'eb' boolean (default off)
2905 global
2906 Ring the bell (beep or screen flash) for error messages. This only
2907 makes a difference for error messages, the bell will be used always
2908 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002909 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar165bc692015-07-21 17:53:25 +02002910 screen flash or do nothing. See 'belloff' to finetune when to ring the
2911 bell.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002912
2913 *'errorfile'* *'ef'*
2914'errorfile' 'ef' string (Amiga default: "AztecC.Err",
2915 others: "errors.err")
2916 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002917 {not available when compiled without the |+quickfix|
2918 feature}
2919 Name of the errorfile for the QuickFix mode (see |:cf|).
2920 When the "-q" command-line argument is used, 'errorfile' is set to the
2921 following argument. See |-q|.
2922 NOT used for the ":make" command. See 'makeef' for that.
2923 Environment variables are expanded |:set_env|.
2924 See |option-backslash| about including spaces and backslashes.
2925 This option cannot be set from a |modeline| or in the |sandbox|, for
2926 security reasons.
2927
2928 *'errorformat'* *'efm'*
2929'errorformat' 'efm' string (default is very long)
2930 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002931 {not available when compiled without the |+quickfix|
2932 feature}
2933 Scanf-like description of the format for the lines in the error file
2934 (see |errorformat|).
2935
2936 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
2937'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
2938 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002939 Function keys that start with an <Esc> are recognized in Insert
2940 mode. When this option is off, the cursor and function keys cannot be
2941 used in Insert mode if they start with an <Esc>. The advantage of
2942 this is that the single <Esc> is recognized immediately, instead of
2943 after one second. Instead of resetting this option, you might want to
2944 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
2945 when 'esckeys' is off, you can still map anything, but the cursor keys
2946 won't work by default.
2947 NOTE: This option is set to the Vi default value when 'compatible' is
2948 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaarc8234772019-11-10 21:00:27 +01002949 NOTE: when this option is off then the |modifyOtherKeys| functionality
2950 is disabled while in Insert mode to avoid ending Insert mode with any
2951 key that has a modifier.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002952
2953 *'eventignore'* *'ei'*
2954'eventignore' 'ei' string (default "")
2955 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002956 A list of autocommand event names, which are to be ignored.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00002957 When set to "all" or when "all" is one of the items, all autocommand
2958 events are ignored, autocommands will not be executed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002959 Otherwise this is a comma separated list of event names. Example: >
2960 :set ei=WinEnter,WinLeave
2961<
2962 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
2963'expandtab' 'et' boolean (default off)
2964 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002965 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002966 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002967 when 'autoindent' is on. To insert a real tab when 'expandtab' is
2968 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
Bram Moolenaarca635012015-09-25 20:34:21 +02002969 This option is reset when the 'paste' option is set and restored when
2970 the 'paste' option is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002971 NOTE: This option is reset when 'compatible' is set.
2972
2973 *'exrc'* *'ex'* *'noexrc'* *'noex'*
2974'exrc' 'ex' boolean (default off)
2975 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002976 Enables the reading of .vimrc, .exrc and .gvimrc in the current
Bram Moolenaar36f44c22016-08-28 18:17:20 +02002977 directory.
2978
2979 Setting this option is a potential security leak. E.g., consider
2980 unpacking a package or fetching files from github, a .vimrc in there
2981 might be a trojan horse. BETTER NOT SET THIS OPTION!
2982 Instead, define an autocommand in your .vimrc to set options for a
2983 matching directory.
2984
2985 If you do switch this option on you should also consider setting the
2986 'secure' option (see |initialization|).
2987 Also see |.vimrc| and |gui-init|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002988 This option cannot be set from a |modeline| or in the |sandbox|, for
2989 security reasons.
2990
2991 *'fileencoding'* *'fenc'* *E213*
2992'fileencoding' 'fenc' string (default: "")
2993 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002994 Sets the character encoding for the file of this buffer.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002995
Bram Moolenaar071d4272004-06-13 20:20:40 +00002996 When 'fileencoding' is different from 'encoding', conversion will be
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002997 done when writing the file. For reading see below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002998 When 'fileencoding' is empty, the same value as 'encoding' will be
2999 used (no conversion when reading or writing a file).
Bram Moolenaar214641f2017-03-05 17:04:09 +01003000 No error will be given when the value is set, only when it is used,
3001 only when writing a file.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003002 Conversion will also be done when 'encoding' and 'fileencoding' are
3003 both a Unicode encoding and 'fileencoding' is not utf-8. That's
3004 because internally Unicode is always stored as utf-8.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003005 WARNING: Conversion can cause loss of information! When
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003006 'encoding' is "utf-8" or another Unicode encoding, conversion
3007 is most likely done in a way that the reverse conversion
3008 results in the same text. When 'encoding' is not "utf-8" some
3009 characters may be lost!
Bram Moolenaar865242e2010-07-14 21:12:05 +02003010
Bram Moolenaar071d4272004-06-13 20:20:40 +00003011 See 'encoding' for the possible values. Additionally, values may be
3012 specified that can be handled by the converter, see
3013 |mbyte-conversion|.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003014
Bram Moolenaar071d4272004-06-13 20:20:40 +00003015 When reading a file 'fileencoding' will be set from 'fileencodings'.
3016 To read a file in a certain encoding it won't work by setting
Bram Moolenaar02467872007-05-06 13:22:01 +00003017 'fileencoding', use the |++enc| argument. One exception: when
3018 'fileencodings' is empty the value of 'fileencoding' is used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003019 For a new file the global value of 'fileencoding' is used.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003020
Bram Moolenaar071d4272004-06-13 20:20:40 +00003021 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
3022 When the option is set, the value is converted to lowercase. Thus
3023 you can set it with uppercase values too. '_' characters are
3024 replaced with '-'. If a name is recognized from the list for
3025 'encoding', it is replaced by the standard name. For example
3026 "ISO8859-2" becomes "iso-8859-2".
Bram Moolenaar865242e2010-07-14 21:12:05 +02003027
Bram Moolenaar071d4272004-06-13 20:20:40 +00003028 When this option is set, after starting to edit a file, the 'modified'
3029 option is set, because the file would be different when written.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003030
3031 Keep in mind that changing 'fenc' from a modeline happens
3032 AFTER the text has been read, thus it applies to when the file will be
3033 written. If you do set 'fenc' in a modeline, you might want to set
3034 'nomodified' to avoid not being able to ":q".
3035
Bram Moolenaar071d4272004-06-13 20:20:40 +00003036 This option can not be changed when 'modifiable' is off.
3037
3038 *'fe'*
3039 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003040 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003041 old short name was 'fe', which is no longer used.
3042
3043 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003044'fileencodings' 'fencs' string (default: "ucs-bom",
3045 "ucs-bom,utf-8,default,latin1" when
3046 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003047 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003048 This is a list of character encodings considered when starting to edit
3049 an existing file. When a file is read, Vim tries to use the first
3050 mentioned character encoding. If an error is detected, the next one
3051 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003052 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00003053 an empty string, which means the value of 'encoding' is used.
3054 WARNING: Conversion can cause loss of information! When
3055 'encoding' is "utf-8" (or one of the other Unicode variants)
3056 conversion is most likely done in a way that the reverse
3057 conversion results in the same text. When 'encoding' is not
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003058 "utf-8" some non-ASCII characters may be lost! You can use
3059 the |++bad| argument to specify what is done with characters
3060 that can't be converted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003061 For an empty file or a file with only ASCII characters most encodings
3062 will work and the first entry of 'fileencodings' will be used (except
3063 "ucs-bom", which requires the BOM to be present). If you prefer
3064 another encoding use an BufReadPost autocommand event to test if your
3065 preferred encoding is to be used. Example: >
3066 au BufReadPost * if search('\S', 'w') == 0 |
3067 \ set fenc=iso-2022-jp | endif
3068< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
3069 non-blank characters.
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003070 When the |++enc| argument is used then the value of 'fileencodings' is
3071 not used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003072 Note that 'fileencodings' is not used for a new file, the global value
3073 of 'fileencoding' is used instead. You can set it with: >
3074 :setglobal fenc=iso-8859-2
3075< This means that a non-existing file may get a different encoding than
3076 an empty file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003077 The special value "ucs-bom" can be used to check for a Unicode BOM
3078 (Byte Order Mark) at the start of the file. It must not be preceded
3079 by "utf-8" or another Unicode encoding for this to work properly.
3080 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
3081 because Vim cannot detect an error, thus the encoding is always
3082 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003083 The special value "default" can be used for the encoding from the
3084 environment. This is the default value for 'encoding'. It is useful
3085 when 'encoding' is set to "utf-8" and your environment uses a
3086 non-latin1 encoding, such as Russian.
Bram Moolenaarca003e12006-03-17 23:19:38 +00003087 When 'encoding' is "utf-8" and a file contains an illegal byte
3088 sequence it won't be recognized as UTF-8. You can use the |8g8|
3089 command to find the illegal byte sequence.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003090 WRONG VALUES: WHAT'S WRONG:
3091 latin1,utf-8 "latin1" will always be used
3092 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
3093 file
3094 cp1250,latin1 "cp1250" will always be used
3095 If 'fileencodings' is empty, 'fileencoding' is not modified.
3096 See 'fileencoding' for the possible values.
3097 Setting this option does not have an effect until the next time a file
3098 is read.
3099
3100 *'fileformat'* *'ff'*
Bram Moolenaar00590742019-02-15 21:06:09 +01003101'fileformat' 'ff' string (MS-Windows default: "dos",
3102 Unix, macOS default: "unix")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003103 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003104 This gives the <EOL> of the current buffer, which is used for
3105 reading/writing the buffer from/to a file:
3106 dos <CR> <NL>
3107 unix <NL>
3108 mac <CR>
3109 When "dos" is used, CTRL-Z at the end of a file is ignored.
3110 See |file-formats| and |file-read|.
3111 For the character encoding of the file see 'fileencoding'.
3112 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
Bram Moolenaarbf884932013-04-05 22:26:15 +02003113 works like it was set to "unix".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003114 This option is set automatically when starting to edit a file and
3115 'fileformats' is not empty and 'binary' is off.
3116 When this option is set, after starting to edit a file, the 'modified'
3117 option is set, because the file would be different when written.
3118 This option can not be changed when 'modifiable' is off.
3119 For backwards compatibility: When this option is set to "dos",
3120 'textmode' is set, otherwise 'textmode' is reset.
3121
3122 *'fileformats'* *'ffs'*
3123'fileformats' 'ffs' string (default:
Bram Moolenaar00590742019-02-15 21:06:09 +01003124 Vim+Vi MS-Windows: "dos,unix",
3125 Vim Unix, macOS: "unix,dos",
Bram Moolenaar071d4272004-06-13 20:20:40 +00003126 Vi Cygwin: "unix,dos",
3127 Vi others: "")
3128 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003129 This gives the end-of-line (<EOL>) formats that will be tried when
3130 starting to edit a new buffer and when reading a file into an existing
3131 buffer:
3132 - When empty, the format defined with 'fileformat' will be used
3133 always. It is not set automatically.
3134 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003135 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003136 'fileformats' name will be used when a file is read into an existing
3137 buffer, no matter what 'fileformat' for that buffer is set to.
3138 - When more than one name is present, separated by commas, automatic
3139 <EOL> detection will be done when reading a file. When starting to
3140 edit a file, a check is done for the <EOL>:
3141 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
3142 'fileformat' is set to "dos".
3143 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003144 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003145 preceding <CR>, "unix" is preferred over "dos".
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01003146 3. If 'fileformat' has not yet been set, and if a <CR> is found, and
3147 if 'fileformats' includes "mac", 'fileformat' is set to "mac".
Bram Moolenaar00659062010-09-21 22:34:02 +02003148 This means that "mac" is only chosen when:
3149 "unix" is not present or no <NL> is found in the file, and
3150 "dos" is not present or no <CR><NL> is found in the file.
3151 Except: if "unix" was chosen, but there is a <CR> before
3152 the first <NL>, and there appear to be more <CR>s than <NL>s in
Bram Moolenaar166af9b2010-11-16 20:34:40 +01003153 the first few lines, "mac" is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003154 4. If 'fileformat' is still not set, the first name from
3155 'fileformats' is used.
3156 When reading a file into an existing buffer, the same is done, but
3157 this happens like 'fileformat' has been set appropriately for that
3158 file only, the option is not changed.
3159 When 'binary' is set, the value of 'fileformats' is not used.
3160
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01003161 When Vim starts up with an empty buffer the first item is used. You
3162 can overrule this by setting 'fileformat' in your .vimrc.
Bram Moolenaar81af9252010-12-10 20:35:50 +01003163
Bram Moolenaar071d4272004-06-13 20:20:40 +00003164 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
3165 are ":source"ed and for vimrc files, automatic <EOL> detection may be
3166 done:
3167 - When 'fileformats' is empty, there is no automatic detection. Dos
3168 format will be used.
3169 - When 'fileformats' is set to one or more names, automatic detection
3170 is done. This is based on the first <NL> in the file: If there is a
3171 <CR> in front of it, Dos format is used, otherwise Unix format is
3172 used.
3173 Also see |file-formats|.
3174 For backwards compatibility: When this option is set to an empty
3175 string or one format (no comma is included), 'textauto' is reset,
3176 otherwise 'textauto' is set.
3177 NOTE: This option is set to the Vi default value when 'compatible' is
3178 set and to the Vim default value when 'compatible' is reset.
3179
Bram Moolenaarbf884932013-04-05 22:26:15 +02003180 *'fileignorecase'* *'fic'* *'nofileignorecase'* *'nofic'*
3181'fileignorecase' 'fic' boolean (default on for systems where case in file
3182 names is normally ignored)
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003183 global
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003184 When set case is ignored when using file names and directories.
3185 See 'wildignorecase' for only ignoring case when doing completion.
3186
Bram Moolenaar071d4272004-06-13 20:20:40 +00003187 *'filetype'* *'ft'*
3188'filetype' 'ft' string (default: "")
3189 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003190 When this option is set, the FileType autocommand event is triggered.
3191 All autocommands that match with the value of this option will be
3192 executed. Thus the value of 'filetype' is used in place of the file
3193 name.
3194 Otherwise this option does not always reflect the current file type.
3195 This option is normally set when the file type is detected. To enable
3196 this use the ":filetype on" command. |:filetype|
3197 Setting this option to a different value is most useful in a modeline,
3198 for a file for which the file type is not automatically recognized.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003199 Example, for in an IDL file:
3200 /* vim: set filetype=idl : */ ~
3201 |FileType| |filetypes|
3202 When a dot appears in the value then this separates two filetype
3203 names. Example:
3204 /* vim: set filetype=c.doxygen : */ ~
3205 This will use the "c" filetype first, then the "doxygen" filetype.
3206 This works both for filetype plugins and for syntax files. More than
3207 one dot may appear.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003208 This option is not copied to another buffer, independent of the 's' or
3209 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003210 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003211
3212 *'fillchars'* *'fcs'*
3213'fillchars' 'fcs' string (default "vert:|,fold:-")
3214 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02003215 {not available when compiled without the |+folding|
3216 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003217 Characters to fill the statuslines and vertical separators.
3218 It is a comma separated list of items:
3219
3220 item default Used for ~
3221 stl:c ' ' or '^' statusline of the current window
Bram Moolenaar38a55632016-02-15 22:07:32 +01003222 stlnc:c ' ' or '=' statusline of the non-current windows
Bram Moolenaar071d4272004-06-13 20:20:40 +00003223 vert:c '|' vertical separators |:vsplit|
3224 fold:c '-' filling 'foldtext'
3225 diff:c '-' deleted lines of the 'diff' option
3226
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003227 Any one that is omitted will fall back to the default. For "stl" and
Bram Moolenaar38a55632016-02-15 22:07:32 +01003228 "stlnc" the space will be used when there is highlighting, '^' or '='
Bram Moolenaar071d4272004-06-13 20:20:40 +00003229 otherwise.
3230
3231 Example: >
Bram Moolenaar38a55632016-02-15 22:07:32 +01003232 :set fillchars=stl:^,stlnc:=,vert:\|,fold:-,diff:-
Bram Moolenaar071d4272004-06-13 20:20:40 +00003233< This is similar to the default, except that these characters will also
3234 be used when there is highlighting.
3235
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003236 for "stl" and "stlnc" only single-byte values are supported.
3237
Bram Moolenaar071d4272004-06-13 20:20:40 +00003238 The highlighting used for these items:
3239 item highlight group ~
3240 stl:c StatusLine |hl-StatusLine|
3241 stlnc:c StatusLineNC |hl-StatusLineNC|
3242 vert:c VertSplit |hl-VertSplit|
3243 fold:c Folded |hl-Folded|
3244 diff:c DiffDelete |hl-DiffDelete|
3245
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003246 *'fixendofline'* *'fixeol'* *'nofixendofline'* *'nofixeol'*
3247'fixendofline' 'fixeol' boolean (default on)
3248 local to buffer
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003249 When writing a file and this option is on, <EOL> at the end of file
3250 will be restored if missing. Turn this option off if you want to
3251 preserve the situation from the original file.
3252 When the 'binary' option is set the value of this option doesn't
3253 matter.
3254 See the 'endofline' option.
3255
Bram Moolenaar071d4272004-06-13 20:20:40 +00003256 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
3257'fkmap' 'fk' boolean (default off) *E198*
3258 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003259 {only available when compiled with the |+rightleft|
3260 feature}
Bram Moolenaar14184a32019-02-16 15:10:30 +01003261 This option was for using Farsi, which has been removed. See
3262 |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003263
3264 *'foldclose'* *'fcl'*
3265'foldclose' 'fcl' string (default "")
3266 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003267 {not available when compiled without the |+folding|
3268 feature}
3269 When set to "all", a fold is closed when the cursor isn't in it and
3270 its level is higher than 'foldlevel'. Useful if you want folds to
3271 automatically close when moving out of them.
3272
3273 *'foldcolumn'* *'fdc'*
3274'foldcolumn' 'fdc' number (default 0)
3275 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003276 {not available when compiled without the |+folding|
3277 feature}
3278 When non-zero, a column with the specified width is shown at the side
3279 of the window which indicates open and closed folds. The maximum
3280 value is 12.
3281 See |folding|.
3282
3283 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
3284'foldenable' 'fen' boolean (default on)
3285 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003286 {not available when compiled without the |+folding|
3287 feature}
3288 When off, all folds are open. This option can be used to quickly
3289 switch between showing all text unfolded and viewing the text with
3290 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003291 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00003292 'foldenable' is off.
3293 This option is set by commands that create a new fold or close a fold.
3294 See |folding|.
3295
3296 *'foldexpr'* *'fde'*
3297'foldexpr' 'fde' string (default: "0")
3298 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003299 {not available when compiled without the |+folding|
Bram Moolenaardb84e452010-08-15 13:50:43 +02003300 or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003301 The expression used for when 'foldmethod' is "expr". It is evaluated
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003302 for each line to obtain its fold level. See |fold-expr|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003303
Bram Moolenaar30b65812012-07-12 22:01:11 +02003304 The expression will be evaluated in the |sandbox| if set from a
3305 modeline, see |sandbox-option|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003306 This option can't be set from a |modeline| when the 'diff' option is
Bram Moolenaar110289e2019-05-23 15:38:06 +02003307 on or the 'modelineexpr' option is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003308
3309 It is not allowed to change text or jump to another window while
3310 evaluating 'foldexpr' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003311
3312 *'foldignore'* *'fdi'*
3313'foldignore' 'fdi' string (default: "#")
3314 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003315 {not available when compiled without the |+folding|
3316 feature}
3317 Used only when 'foldmethod' is "indent". Lines starting with
3318 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003319 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003320 The default "#" works well for C programs. See |fold-indent|.
3321
3322 *'foldlevel'* *'fdl'*
3323'foldlevel' 'fdl' number (default: 0)
3324 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003325 {not available when compiled without the |+folding|
3326 feature}
3327 Sets the fold level: Folds with a higher level will be closed.
3328 Setting this option to zero will close all folds. Higher numbers will
3329 close fewer folds.
3330 This option is set by commands like |zm|, |zM| and |zR|.
3331 See |fold-foldlevel|.
3332
3333 *'foldlevelstart'* *'fdls'*
3334'foldlevelstart' 'fdls' number (default: -1)
3335 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003336 {not available when compiled without the |+folding|
3337 feature}
3338 Sets 'foldlevel' when starting to edit another buffer in a window.
3339 Useful to always start editing with all folds closed (value zero),
3340 some folds closed (one) or no folds closed (99).
3341 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003342 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00003343 ignores this option and closes all folds.
3344 It is also done before BufReadPre autocommands, to allow an autocmd to
3345 overrule the 'foldlevel' value for specific files.
3346 When the value is negative, it is not used.
3347
3348 *'foldmarker'* *'fmr'* *E536*
3349'foldmarker' 'fmr' string (default: "{{{,}}}")
3350 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003351 {not available when compiled without the |+folding|
3352 feature}
3353 The start and end marker used when 'foldmethod' is "marker". There
3354 must be one comma, which separates the start and end marker. The
3355 marker is a literal string (a regular expression would be too slow).
3356 See |fold-marker|.
3357
3358 *'foldmethod'* *'fdm'*
3359'foldmethod' 'fdm' string (default: "manual")
3360 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003361 {not available when compiled without the |+folding|
3362 feature}
3363 The kind of folding used for the current window. Possible values:
3364 |fold-manual| manual Folds are created manually.
3365 |fold-indent| indent Lines with equal indent form a fold.
3366 |fold-expr| expr 'foldexpr' gives the fold level of a line.
3367 |fold-marker| marker Markers are used to specify folds.
3368 |fold-syntax| syntax Syntax highlighting items specify folds.
3369 |fold-diff| diff Fold text that is not changed.
3370
3371 *'foldminlines'* *'fml'*
3372'foldminlines' 'fml' number (default: 1)
3373 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003374 {not available when compiled without the |+folding|
3375 feature}
Bram Moolenaar00654022011-02-25 14:42:19 +01003376 Sets the number of screen lines above which a fold can be displayed
3377 closed. Also for manually closed folds. With the default value of
3378 one a fold can only be closed if it takes up two or more screen lines.
3379 Set to zero to be able to close folds of just one screen line.
Bram Moolenaar446beb42011-05-10 17:18:44 +02003380 Note that this only has an effect on what is displayed. After using
Bram Moolenaar071d4272004-06-13 20:20:40 +00003381 "zc" to close a fold, which is displayed open because it's smaller
3382 than 'foldminlines', a following "zc" may close a containing fold.
3383
3384 *'foldnestmax'* *'fdn'*
3385'foldnestmax' 'fdn' number (default: 20)
3386 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003387 {not available when compiled without the |+folding|
3388 feature}
3389 Sets the maximum nesting of folds for the "indent" and "syntax"
3390 methods. This avoids that too many folds will be created. Using more
3391 than 20 doesn't work, because the internal limit is 20.
3392
3393 *'foldopen'* *'fdo'*
3394'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
3395 search,tag,undo")
3396 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003397 {not available when compiled without the |+folding|
3398 feature}
3399 Specifies for which type of commands folds will be opened, if the
3400 command moves the cursor into a closed fold. It is a comma separated
3401 list of items.
Bram Moolenaar05365702010-10-27 18:34:44 +02003402 NOTE: When the command is part of a mapping this option is not used.
3403 Add the |zv| command to the mapping to get the same effect.
3404 (rationale: the mapping may want to control opening folds itself)
3405
Bram Moolenaar071d4272004-06-13 20:20:40 +00003406 item commands ~
3407 all any
3408 block "(", "{", "[[", "[{", etc.
3409 hor horizontal movements: "l", "w", "fx", etc.
3410 insert any command in Insert mode
3411 jump far jumps: "G", "gg", etc.
3412 mark jumping to a mark: "'m", CTRL-O, etc.
3413 percent "%"
3414 quickfix ":cn", ":crew", ":make", etc.
3415 search search for a pattern: "/", "n", "*", "gd", etc.
3416 (not for a search pattern in a ":" command)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003417 Also for |[s| and |]s|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003418 tag jumping to a tag: ":ta", CTRL-T, etc.
3419 undo undo or redo: "u" and CTRL-R
Bram Moolenaar071d4272004-06-13 20:20:40 +00003420 When a movement command is used for an operator (e.g., "dl" or "y%")
3421 this option is not used. This means the operator will include the
3422 whole closed fold.
3423 Note that vertical movements are not here, because it would make it
3424 very difficult to move onto a closed fold.
3425 In insert mode the folds containing the cursor will always be open
3426 when text is inserted.
3427 To close folds you can re-apply 'foldlevel' with the |zx| command or
3428 set the 'foldclose' option to "all".
3429
3430 *'foldtext'* *'fdt'*
3431'foldtext' 'fdt' string (default: "foldtext()")
3432 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003433 {not available when compiled without the |+folding|
3434 feature}
3435 An expression which is used to specify the text displayed for a closed
3436 fold. See |fold-foldtext|.
3437
Bram Moolenaar30b65812012-07-12 22:01:11 +02003438 The expression will be evaluated in the |sandbox| if set from a
3439 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003440 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003441
3442 It is not allowed to change text or jump to another window while
3443 evaluating 'foldtext' |textlock|.
3444
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003445 *'formatexpr'* *'fex'*
3446'formatexpr' 'fex' string (default "")
3447 local to buffer
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003448 {not available when compiled without the |+eval|
3449 feature}
3450 Expression which is evaluated to format a range of lines for the |gq|
3451 operator or automatic formatting (see 'formatoptions'). When this
3452 option is empty 'formatprg' is used.
3453
3454 The |v:lnum| variable holds the first line to be formatted.
3455 The |v:count| variable holds the number of lines to be formatted.
3456 The |v:char| variable holds the character that is going to be
3457 inserted if the expression is being evaluated due to
3458 automatic formatting. This can be empty. Don't insert
3459 it yet!
3460
3461 Example: >
3462 :set formatexpr=mylang#Format()
3463< This will invoke the mylang#Format() function in the
3464 autoload/mylang.vim file in 'runtimepath'. |autoload|
3465
3466 The expression is also evaluated when 'textwidth' is set and adding
3467 text beyond that limit. This happens under the same conditions as
3468 when internal formatting is used. Make sure the cursor is kept in the
3469 same spot relative to the text then! The |mode()| function will
3470 return "i" or "R" in this situation.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01003471
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003472 When the expression evaluates to non-zero Vim will fall back to using
3473 the internal format mechanism.
3474
3475 The expression will be evaluated in the |sandbox| when set from a
3476 modeline, see |sandbox-option|. That stops the option from working,
3477 since changing the buffer text is not allowed.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003478 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaar036986f2017-03-16 17:41:02 +01003479 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003480
Bram Moolenaar86b68352004-12-27 21:59:20 +00003481 *'formatlistpat'* *'flp'*
3482'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
3483 local to buffer
Bram Moolenaar86b68352004-12-27 21:59:20 +00003484 A pattern that is used to recognize a list header. This is used for
3485 the "n" flag in 'formatoptions'.
3486 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00003487 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00003488 while still checking more characters. There must be a character
3489 following the pattern, when it matches the whole line it is handled
3490 like there is no match.
3491 The default recognizes a number, followed by an optional punctuation
3492 character and white space.
3493
Bram Moolenaar6c60f472019-04-28 16:00:35 +02003494 *'formatoptions'* *'fo'*
3495'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
3496 local to buffer
3497 This is a sequence of letters which describes how automatic
3498 formatting is to be done. See |fo-table|. When the 'paste' option is
3499 on, no formatting is done (like 'formatoptions' is empty). Commas can
3500 be inserted for readability.
3501 To avoid problems with flags that are added in the future, use the
3502 "+=" and "-=" feature of ":set" |add-option-flags|.
3503 NOTE: This option is set to the Vi default value when 'compatible' is
3504 set and to the Vim default value when 'compatible' is reset.
3505
Bram Moolenaar071d4272004-06-13 20:20:40 +00003506 *'formatprg'* *'fp'*
3507'formatprg' 'fp' string (default "")
Bram Moolenaar9be7c042017-01-14 14:28:30 +01003508 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003509 The name of an external program that will be used to format the lines
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003510 selected with the |gq| operator. The program must take the input on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003511 stdin and produce the output on stdout. The Unix program "fmt" is
Bram Moolenaara5792f52005-11-23 21:25:05 +00003512 such a program.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003513 If the 'formatexpr' option is not empty it will be used instead.
3514 Otherwise, if 'formatprg' option is an empty string, the internal
3515 format function will be used |C-indenting|.
Bram Moolenaara5792f52005-11-23 21:25:05 +00003516 Environment variables are expanded |:set_env|. See |option-backslash|
3517 about including spaces and backslashes.
Bram Moolenaar30b65812012-07-12 22:01:11 +02003518 This option cannot be set from a |modeline| or in the |sandbox|, for
3519 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003520
Bram Moolenaard94464e2015-11-02 15:28:18 +01003521 *'fsync'* *'fs'* *'nofsync'* *'nofs'*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003522'fsync' 'fs' boolean (default on)
3523 global
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003524 When on, the library function fsync() will be called after writing a
3525 file. This will flush a file to disk, ensuring that it is safely
3526 written even on filesystems which do metadata-only journaling. This
3527 will force the harddrive to spin up on Linux systems running in laptop
3528 mode, so it may be undesirable in some situations. Be warned that
3529 turning this off increases the chances of data loss after a crash. On
3530 systems without an fsync() implementation, this variable is always
3531 off.
3532 Also see 'swapsync' for controlling fsync() on swap files.
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003533 'fsync' also applies to |writefile()|, unless a flag is used to
3534 overrule it.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003535 This option cannot be set from a |modeline| or in the |sandbox|, for
3536 security reasons.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003537
Bram Moolenaar071d4272004-06-13 20:20:40 +00003538 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
3539'gdefault' 'gd' boolean (default off)
3540 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003541 When on, the ":substitute" flag 'g' is default on. This means that
3542 all matches in a line are substituted instead of one. When a 'g' flag
3543 is given to a ":substitute" command, this will toggle the substitution
3544 of all or one match. See |complex-change|.
3545
3546 command 'gdefault' on 'gdefault' off ~
3547 :s/// subst. all subst. one
3548 :s///g subst. one subst. all
3549 :s///gg subst. all subst. one
3550
3551 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar21020352017-06-13 17:21:04 +02003552 DEPRECATED: Setting this option may break plugins that are not aware
3553 of this option. Also, many users get confused that adding the /g flag
3554 has the opposite effect of that it normally does.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003555
3556 *'grepformat'* *'gfm'*
Bram Moolenaar6e932462014-09-09 18:48:09 +02003557'grepformat' 'gfm' string (default "%f:%l:%m,%f:%l%m,%f %l%m")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003558 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003559 Format to recognize for the ":grep" command output.
3560 This is a scanf-like string that uses the same format as the
3561 'errorformat' option: see |errorformat|.
3562
3563 *'grepprg'* *'gp'*
3564'grepprg' 'gp' string (default "grep -n ",
3565 Unix: "grep -n $* /dev/null",
3566 Win32: "findstr /n" or "grep -n",
3567 VMS: "SEARCH/NUMBERS ")
3568 global or local to buffer |global-local|
Bram Moolenaar582fd852005-03-28 20:58:01 +00003569 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003570 and '#' characters, which are expanded like when used in a command-
3571 line. The placeholder "$*" is allowed to specify where the arguments
3572 will be included. Environment variables are expanded |:set_env|. See
3573 |option-backslash| about including spaces and backslashes.
3574 When your "grep" accepts the "-H" argument, use this to make ":grep"
3575 also work well with a single file: >
3576 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00003577< Special value: When 'grepprg' is set to "internal" the |:grep| command
Bram Moolenaara6557602006-02-04 22:43:20 +00003578 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like
3579 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00003580 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00003581 apply equally to 'grepprg'.
3582 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
3583 otherwise it's "grep -n".
3584 This option cannot be set from a |modeline| or in the |sandbox|, for
3585 security reasons.
3586
3587 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
3588'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
3589 ve:ver35-Cursor,
3590 o:hor50-Cursor,
3591 i-ci:ver25-Cursor/lCursor,
3592 r-cr:hor20-Cursor/lCursor,
3593 sm:block-Cursor
3594 -blinkwait175-blinkoff150-blinkon175",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003595 for Win32 console:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003596 "n-v-c:block,o:hor50,i-ci:hor15,
3597 r-cr:hor30,sm:block")
3598 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003599 {only available when compiled with GUI enabled, and
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003600 for Win32 console}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003601 This option tells Vim what the cursor should look like in different
Bram Moolenaar8024f932020-01-14 19:29:13 +01003602 modes. It fully works in the GUI. In a Win32 console, only the
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003603 height of the cursor can be changed. This can be done by specifying a
3604 block cursor, or a percentage for a vertical or horizontal cursor.
Bram Moolenaar1e7813a2015-03-31 18:31:03 +02003605 For a console the 't_SI', 't_SR', and 't_EI' escape sequences are
3606 used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003607
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003608 The option is a comma separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003609 mode-list and an argument-list:
3610 mode-list:argument-list,mode-list:argument-list,..
3611 The mode-list is a dash separated list of these modes:
3612 n Normal mode
3613 v Visual mode
3614 ve Visual mode with 'selection' "exclusive" (same as 'v',
3615 if not specified)
3616 o Operator-pending mode
3617 i Insert mode
3618 r Replace mode
3619 c Command-line Normal (append) mode
3620 ci Command-line Insert mode
3621 cr Command-line Replace mode
3622 sm showmatch in Insert mode
3623 a all modes
3624 The argument-list is a dash separated list of these arguments:
3625 hor{N} horizontal bar, {N} percent of the character height
3626 ver{N} vertical bar, {N} percent of the character width
3627 block block cursor, fills the whole character
3628 [only one of the above three should be present]
3629 blinkwait{N} *cursor-blinking*
3630 blinkon{N}
3631 blinkoff{N}
3632 blink times for cursor: blinkwait is the delay before
3633 the cursor starts blinking, blinkon is the time that
3634 the cursor is shown and blinkoff is the time that the
3635 cursor is not shown. The times are in msec. When one
3636 of the numbers is zero, there is no blinking. The
3637 default is: "blinkwait700-blinkon400-blinkoff250".
3638 These numbers are used for a missing entry. This
3639 means that blinking is enabled by default. To switch
3640 blinking off you can use "blinkon0". The cursor only
3641 blinks when Vim is waiting for input, not while
3642 executing a command.
3643 To make the cursor blink in an xterm, see
3644 |xterm-blink|.
3645 {group-name}
3646 a highlight group name, that sets the color and font
3647 for the cursor
3648 {group-name}/{group-name}
3649 Two highlight group names, the first is used when
3650 no language mappings are used, the other when they
3651 are. |language-mapping|
3652
3653 Examples of parts:
3654 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
3655 block cursor with colors from the "nCursor"
3656 highlight group
3657 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
3658 In Insert and Command-line Insert mode, use a
3659 30% vertical bar cursor with colors from the
3660 "iCursor" highlight group. Blink a bit
3661 faster.
3662
3663 The 'a' mode is different. It will set the given argument-list for
3664 all modes. It does not reset anything to defaults. This can be used
3665 to do a common setting for all modes. For example, to switch off
3666 blinking: "a:blinkon0"
3667
3668 Examples of cursor highlighting: >
3669 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
3670 :highlight Cursor gui=NONE guifg=bg guibg=fg
3671<
3672 *'guifont'* *'gfn'*
Bram Moolenaar251e1912011-06-19 05:09:16 +02003673 *E235* *E596*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003674'guifont' 'gfn' string (default "")
3675 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003676 {only available when compiled with GUI enabled}
3677 This is a list of fonts which will be used for the GUI version of Vim.
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003678 In its simplest form the value is just one font name.
3679 See |gui-font| for the details.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003680
3681 *'guifontset'* *'gfs'*
3682 *E250* *E252* *E234* *E597* *E598*
3683'guifontset' 'gfs' string (default "")
3684 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003685 {only available when compiled with GUI enabled and
3686 with the |+xfontset| feature}
Bram Moolenaar3df01732017-02-17 22:47:16 +01003687 {not available in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003688 When not empty, specifies two (or more) fonts to be used. The first
3689 one for normal English, the second one for your special language. See
3690 |xfontset|.
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003691
Bram Moolenaar071d4272004-06-13 20:20:40 +00003692 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
3693'guifontwide' 'gfw' string (default "")
3694 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003695 {only available when compiled with GUI enabled}
3696 When not empty, specifies a comma-separated list of fonts to be used
3697 for double-width characters. The first font that can be loaded is
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003698 used. See |gui-fontwide|.
Bram Moolenaar0f272122013-01-23 18:37:40 +01003699
Bram Moolenaar071d4272004-06-13 20:20:40 +00003700 *'guiheadroom'* *'ghr'*
3701'guiheadroom' 'ghr' number (default 50)
3702 global
Bram Moolenaar110289e2019-05-23 15:38:06 +02003703 {only for GTK and X11 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003704 The number of pixels subtracted from the screen height when fitting
3705 the GUI window on the screen. Set this before the GUI is started,
3706 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003707 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00003708 lines will be left for window decorations and other items on the
3709 screen. Set it to a negative value to allow windows taller than the
3710 screen.
3711
3712 *'guioptions'* *'go'*
Bram Moolenaar2c64ca12018-10-19 16:22:31 +02003713'guioptions' 'go' string (default "egmrLtT" (MS-Windows,
3714 "t" is removed in |defaults.vim|),
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02003715 "aegimrLtT" (GTK, Motif and Athena),
3716 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00003717 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003718 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00003719 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003720 sequence of letters which describes what components and options of the
3721 GUI should be used.
3722 To avoid problems with flags that are added in the future, use the
3723 "+=" and "-=" feature of ":set" |add-option-flags|.
3724
Bram Moolenaar13568252018-03-16 20:46:58 +01003725 Valid characters are as follows:
3726 *'go-!'*
3727 '!' External commands are executed in a terminal window. Without
3728 this flag the MS-Windows GUI will open a console window to
3729 execute the command. The Unix GUI will simulate a dumb
3730 terminal to list the command output.
3731 The terminal window will be positioned at the bottom, and grow
3732 upwards as needed.
Bram Moolenaarba3ff532018-11-04 14:45:49 +01003733 *'go-a'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003734 'a' Autoselect: If present, then whenever VISUAL mode is started,
3735 or the Visual area extended, Vim tries to become the owner of
3736 the windowing system's global selection. This means that the
3737 Visually highlighted text is available for pasting into other
3738 applications as well as into Vim itself. When the Visual mode
3739 ends, possibly due to an operation on the text, or when an
3740 application wants to paste the selection, the highlighted text
3741 is automatically yanked into the "* selection register.
3742 Thus the selection is still available for pasting into other
3743 applications after the VISUAL mode has ended.
3744 If not present, then Vim won't become the owner of the
3745 windowing system's global selection unless explicitly told to
3746 by a yank or delete operation for the "* register.
3747 The same applies to the modeless selection.
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02003748 *'go-P'*
3749 'P' Like autoselect but using the "+ register instead of the "*
Bram Moolenaar3848e002016-03-19 18:42:29 +01003750 register.
Bram Moolenaar02467872007-05-06 13:22:01 +00003751 *'go-A'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003752 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003753 applies to the modeless selection.
3754
3755 'guioptions' autoselect Visual autoselect modeless ~
3756 "" - -
3757 "a" yes yes
3758 "A" - yes
3759 "aA" yes yes
3760
Bram Moolenaar02467872007-05-06 13:22:01 +00003761 *'go-c'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003762 'c' Use console dialogs instead of popup dialogs for simple
3763 choices.
Bram Moolenaar50bf7ce2019-09-15 13:17:00 +02003764 *'go-d'*
3765 'd' Use dark theme variant if available. Currently only works for
3766 GTK+ GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00003767 *'go-e'*
Bram Moolenaare224ffa2006-03-01 00:01:28 +00003768 'e' Add tab pages when indicated with 'showtabline'.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003769 'guitablabel' can be used to change the text in the labels.
3770 When 'e' is missing a non-GUI tab pages line may be used.
Bram Moolenaard68071d2006-05-02 22:08:30 +00003771 The GUI tabs are only supported on some systems, currently
Bram Moolenaarb3f74062020-02-26 16:16:53 +01003772 GTK, Motif, Mac OS/X, Haiku, and MS-Windows.
Bram Moolenaar02467872007-05-06 13:22:01 +00003773 *'go-f'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003774 'f' Foreground: Don't use fork() to detach the GUI from the shell
3775 where it was started. Use this for programs that wait for the
3776 editor to finish (e.g., an e-mail program). Alternatively you
3777 can use "gvim -f" or ":gui -f" to start the GUI in the
3778 foreground. |gui-fork|
3779 Note: Set this option in the vimrc file. The forking may have
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003780 happened already when the |gvimrc| file is read.
Bram Moolenaar02467872007-05-06 13:22:01 +00003781 *'go-i'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003782 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
3783 corner of the window. It's black&white on non-GTK, because of
3784 limitations of X11. For a color icon, see |X11-icon|.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003785 *'go-m'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003786 'm' Menu bar is present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003787 *'go-M'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003788 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00003789 that this flag must be added in the .vimrc file, before
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003790 switching on syntax or filetype recognition (when the |gvimrc|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003791 file is sourced the system menu has already been loaded; the
Bram Moolenaar01164a62017-11-02 22:58:42 +01003792 `:syntax on` and `:filetype on` commands load the menu too).
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003793 *'go-g'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003794 'g' Grey menu items: Make menu items that are not active grey. If
3795 'g' is not included inactive menu items are not shown at all.
3796 Exception: Athena will always use grey menu items.
Bram Moolenaar02467872007-05-06 13:22:01 +00003797 *'go-t'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003798 't' Include tearoff menu items. Currently only works for Win32,
3799 GTK+, and Motif 1.2 GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00003800 *'go-T'*
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00003801 'T' Include Toolbar. Currently only in Win32, GTK+, Motif, Photon
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00003802 and Athena GUIs.
Bram Moolenaar02467872007-05-06 13:22:01 +00003803 *'go-r'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003804 'r' Right-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003805 *'go-R'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003806 'R' Right-hand scrollbar is present when there is a vertically
3807 split window.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003808 *'go-l'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003809 'l' Left-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003810 *'go-L'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003811 'L' Left-hand scrollbar is present when there is a vertically
3812 split window.
Bram Moolenaar02467872007-05-06 13:22:01 +00003813 *'go-b'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003814 'b' Bottom (horizontal) scrollbar is present. Its size depends on
3815 the longest visible line, or on the cursor line if the 'h'
3816 flag is included. |gui-horiz-scroll|
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003817 *'go-h'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003818 'h' Limit horizontal scrollbar size to the length of the cursor
3819 line. Reduces computations. |gui-horiz-scroll|
3820
3821 And yes, you may even have scrollbars on the left AND the right if
3822 you really want to :-). See |gui-scrollbars| for more information.
3823
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003824 *'go-v'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003825 'v' Use a vertical button layout for dialogs. When not included,
3826 a horizontal layout is preferred, but when it doesn't fit a
3827 vertical layout is used anyway.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003828 *'go-p'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003829 'p' Use Pointer callbacks for X11 GUI. This is required for some
3830 window managers. If the cursor is not blinking or hollow at
3831 the right moment, try adding this flag. This must be done
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003832 before starting the GUI. Set it in your |gvimrc|. Adding or
Bram Moolenaar071d4272004-06-13 20:20:40 +00003833 removing it after the GUI has started has no effect.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003834 *'go-F'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003835 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar8ac44152017-11-09 18:33:29 +01003836 *'go-k'*
3837 'k' Keep the GUI window size when adding/removing a scrollbar, or
3838 toolbar, tabline, etc. Instead, the behavior is similar to
3839 when the window is maximized and will adjust 'lines' and
3840 'columns' to fit to the window. Without the 'k' flag Vim will
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003841 try to keep 'lines' and 'columns' the same when adding and
Bram Moolenaar8ac44152017-11-09 18:33:29 +01003842 removing GUI components.
Bram Moolenaar02467872007-05-06 13:22:01 +00003843
Bram Moolenaar071d4272004-06-13 20:20:40 +00003844 *'guipty'* *'noguipty'*
3845'guipty' boolean (default on)
3846 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003847 {only available when compiled with GUI enabled}
3848 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
3849 I/O to/from shell commands. See |gui-pty|.
3850
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003851 *'guitablabel'* *'gtl'*
3852'guitablabel' 'gtl' string (default empty)
3853 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02003854 {only available when compiled with GUI enabled}
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003855 When nonempty describes the text to use in a label of the GUI tab
Bram Moolenaard68071d2006-05-02 22:08:30 +00003856 pages line. When empty and when the result is empty Vim will use a
3857 default label. See |setting-guitablabel| for more info.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003858
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003859 The format of this option is like that of 'statusline'.
Bram Moolenaar57657d82006-04-21 22:12:41 +00003860 'guitabtooltip' is used for the tooltip, see below.
Bram Moolenaar51628222016-12-01 23:03:28 +01003861 The expression will be evaluated in the |sandbox| when set from a
3862 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003863 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003864
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003865 Only used when the GUI tab pages line is displayed. 'e' must be
3866 present in 'guioptions'. For the non-GUI tab pages line 'tabline' is
3867 used.
3868
Bram Moolenaar57657d82006-04-21 22:12:41 +00003869 *'guitabtooltip'* *'gtt'*
3870'guitabtooltip' 'gtt' string (default empty)
3871 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02003872 {only available when compiled with GUI enabled}
Bram Moolenaar57657d82006-04-21 22:12:41 +00003873 When nonempty describes the text to use in a tooltip for the GUI tab
3874 pages line. When empty Vim will use a default tooltip.
3875 This option is otherwise just like 'guitablabel' above.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003876 You can include a line break. Simplest method is to use |:let|: >
3877 :let &guitabtooltip = "line one\nline two"
3878<
Bram Moolenaar57657d82006-04-21 22:12:41 +00003879
Bram Moolenaar071d4272004-06-13 20:20:40 +00003880 *'helpfile'* *'hf'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003881'helpfile' 'hf' string (default (MS-Windows) "$VIMRUNTIME\doc\help.txt"
Bram Moolenaar071d4272004-06-13 20:20:40 +00003882 (others) "$VIMRUNTIME/doc/help.txt")
3883 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003884 Name of the main help file. All distributed help files should be
3885 placed together in one directory. Additionally, all "doc" directories
3886 in 'runtimepath' will be used.
3887 Environment variables are expanded |:set_env|. For example:
3888 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003889 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00003890 spaces and backslashes.
3891 This option cannot be set from a |modeline| or in the |sandbox|, for
3892 security reasons.
3893
3894 *'helpheight'* *'hh'*
3895'helpheight' 'hh' number (default 20)
3896 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003897 Minimal initial height of the help window when it is opened with the
3898 ":help" command. The initial height of the help window is half of the
3899 current window, or (when the 'ea' option is on) the same as other
3900 windows. When the height is less than 'helpheight', the height is
3901 set to 'helpheight'. Set to zero to disable.
3902
3903 *'helplang'* *'hlg'*
3904'helplang' 'hlg' string (default: messages language or empty)
3905 global
3906 {only available when compiled with the |+multi_lang|
3907 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003908 Comma separated list of languages. Vim will use the first language
3909 for which the desired help can be found. The English help will always
3910 be used as a last resort. You can add "en" to prefer English over
3911 another language, but that will only find tags that exist in that
3912 language and not in the English help.
3913 Example: >
3914 :set helplang=de,it
3915< This will first search German, then Italian and finally English help
3916 files.
3917 When using |CTRL-]| and ":help!" in a non-English help file Vim will
3918 try to find the tag in the current language before using this option.
3919 See |help-translated|.
3920
3921 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
3922'hidden' 'hid' boolean (default off)
3923 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003924 When off a buffer is unloaded when it is |abandon|ed. When on a
3925 buffer becomes hidden when it is |abandon|ed. If the buffer is still
3926 displayed in another window, it does not become hidden, of course.
3927 The commands that move through the buffer list sometimes make a buffer
3928 hidden although the 'hidden' option is off: When the buffer is
3929 modified, 'autowrite' is off or writing is not possible, and the '!'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003930 flag was used. See also |windows.txt|.
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00003931 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003932 This option is set for one command with ":hide {command}" |:hide|.
3933 WARNING: It's easy to forget that you have changes in hidden buffers.
3934 Think twice when using ":q!" or ":qa!".
3935
3936 *'highlight'* *'hl'*
3937'highlight' 'hl' string (default (as a single string):
Bram Moolenaar58b85342016-08-14 19:54:54 +02003938 "8:SpecialKey,~:EndOfBuffer,@:NonText,
3939 d:Directory,e:ErrorMsg,i:IncSearch,
3940 l:Search,m:MoreMsg,M:ModeMsg,n:LineNr,
Bram Moolenaarefae76a2019-10-27 22:54:58 +01003941 a:LineNrAbove,b:LineNrBelow,
Bram Moolenaar58b85342016-08-14 19:54:54 +02003942 N:CursorLineNr,r:Question,s:StatusLine,
3943 S:StatusLineNC,c:VertSplit,t:Title,
Bram Moolenaar9d87a372018-12-18 21:41:50 +01003944 v:Visual,V:VisualNOS,w:WarningMsg,
3945 W:WildMenu,f:Folded,F:FoldColumn,
3946 A:DiffAdd,C:DiffChange,D:DiffDelete,
3947 T:DiffText,>:SignColumn,-:Conceal,
Bram Moolenaarc8c88492018-12-27 23:59:26 +01003948 B:SpellBad,P:SpellCap,R:SpellRare,
Bram Moolenaar9d87a372018-12-18 21:41:50 +01003949 L:SpellLocal,+:Pmenu,=:PmenuSel,
Bram Moolenaar21020352017-06-13 17:21:04 +02003950 x:PmenuSbar,X:PmenuThumb,*:TabLine,
3951 #:TabLineSel,_:TabLineFill,!:CursorColumn,
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02003952 .:CursorLine,o:ColorColumn,q:QuickFixLine,
Bram Moolenaarc572da52017-08-27 16:52:01 +02003953 z:StatusLineTerm,Z:StatusLineTermNC")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003954 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003955 This option can be used to set highlighting mode for various
3956 occasions. It is a comma separated list of character pairs. The
3957 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003958 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003959 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
Bram Moolenaar58b85342016-08-14 19:54:54 +02003960 |hl-EndOfBuffer| ~ lines after the last line in the buffer
3961 |hl-NonText| @ '@' at the end of the window and
Bram Moolenaar071d4272004-06-13 20:20:40 +00003962 characters from 'showbreak'
3963 |hl-Directory| d directories in CTRL-D listing and other special
3964 things in listings
3965 |hl-ErrorMsg| e error messages
3966 h (obsolete, ignored)
3967 |hl-IncSearch| i 'incsearch' highlighting
3968 |hl-Search| l last search pattern highlighting (see 'hlsearch')
3969 |hl-MoreMsg| m |more-prompt|
3970 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
Bram Moolenaar64486672010-05-16 15:46:46 +02003971 |hl-LineNr| n line number for ":number" and ":#" commands, and
3972 when 'number' or 'relativenumber' option is set.
Bram Moolenaarefae76a2019-10-27 22:54:58 +01003973 |hl-LineNrAbove| a line number above the cursor for when the
3974 'relativenumber' option is set.
3975 |hl-LineNrBelow| b line number below the cursor for when the
3976 'relativenumber' option is set.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01003977 |hl-CursorLineNr| N like n for when 'cursorline' or 'relativenumber' is
3978 set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003979 |hl-Question| r |hit-enter| prompt and yes/no questions
3980 |hl-StatusLine| s status line of current window |status-line|
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01003981 |hl-StatusLineNC| S status lines of not-current windows
Bram Moolenaar071d4272004-06-13 20:20:40 +00003982 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
3983 |hl-VertSplit| c column used to separate vertically split windows
3984 |hl-Visual| v Visual mode
3985 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
3986 Selection" Only X11 Gui's |gui-x11| and
3987 |xterm-clipboard|.
3988 |hl-WarningMsg| w warning messages
3989 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
3990 |hl-Folded| f line used for closed folds
3991 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003992 |hl-DiffAdd| A added line in diff mode
3993 |hl-DiffChange| C changed line in diff mode
3994 |hl-DiffDelete| D deleted line in diff mode
3995 |hl-DiffText| T inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00003996 |hl-SignColumn| > column used for |signs|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01003997 |hl-Conceal| - the placeholders used for concealed characters
3998 (see 'conceallevel')
Bram Moolenaar217ad922005-03-20 22:37:15 +00003999 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02004000 |hl-SpellCap| P word that should start with capital |spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00004001 |hl-SpellRare| R rare word |spell|
4002 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004003 |hl-Pmenu| + popup menu normal line
4004 |hl-PmenuSel| = popup menu selected line
4005 |hl-PmenuSbar| x popup menu scrollbar
4006 |hl-PmenuThumb| X popup menu scrollbar thumb
Bram Moolenaar071d4272004-06-13 20:20:40 +00004007
4008 The display modes are:
4009 r reverse (termcap entry "mr" and "me")
4010 i italic (termcap entry "ZH" and "ZR")
4011 b bold (termcap entry "md" and "me")
4012 s standout (termcap entry "so" and "se")
4013 u underline (termcap entry "us" and "ue")
Bram Moolenaare2cc9702005-03-15 22:43:58 +00004014 c undercurl (termcap entry "Cs" and "Ce")
Bram Moolenaarcf4b00c2017-09-02 18:33:56 +02004015 t strikethrough (termcap entry "Ts" and "Te")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004016 n no highlighting
4017 - no highlighting
4018 : use a highlight group
4019 The default is used for occasions that are not included.
4020 If you want to change what the display modes do, see |dos-colors|
4021 for an example.
4022 When using the ':' display mode, this must be followed by the name of
4023 a highlight group. A highlight group can be used to define any type
4024 of highlighting, including using color. See |:highlight| on how to
4025 define one. The default uses a different group for each occasion.
4026 See |highlight-default| for the default highlight groups.
4027
Bram Moolenaar071d4272004-06-13 20:20:40 +00004028 *'history'* *'hi'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004029'history' 'hi' number (Vim default: 50, Vi default: 0,
4030 set to 200 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004031 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004032 A history of ":" commands, and a history of previous search patterns
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004033 is remembered. This option decides how many entries may be stored in
Bram Moolenaar071d4272004-06-13 20:20:40 +00004034 each of these histories (see |cmdline-editing|).
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004035 The maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004036 NOTE: This option is set to the Vi default value when 'compatible' is
4037 set and to the Vim default value when 'compatible' is reset.
4038
4039 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
4040'hkmap' 'hk' boolean (default off)
4041 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004042 {only available when compiled with the |+rightleft|
4043 feature}
4044 When on, the keyboard is mapped for the Hebrew character set.
4045 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
4046 toggle this option. See |rileft.txt|.
4047 NOTE: This option is reset when 'compatible' is set.
4048
4049 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
4050'hkmapp' 'hkp' boolean (default off)
4051 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004052 {only available when compiled with the |+rightleft|
4053 feature}
4054 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
4055 This is useful if you have a non-Hebrew keyboard.
4056 See |rileft.txt|.
4057 NOTE: This option is reset when 'compatible' is set.
4058
Bram Moolenaar036986f2017-03-16 17:41:02 +01004059 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
4060'hlsearch' 'hls' boolean (default off)
4061 global
Bram Moolenaar036986f2017-03-16 17:41:02 +01004062 {not available when compiled without the
4063 |+extra_search| feature}
4064 When there is a previous search pattern, highlight all its matches.
4065 The type of highlighting used can be set with the 'l' occasion in the
4066 'highlight' option. This uses the "Search" highlight group by
4067 default. Note that only the matching text is highlighted, any offsets
4068 are not applied.
4069 See also: 'incsearch' and |:match|.
4070 When you get bored looking at the highlighted matches, you can turn it
4071 off with |:nohlsearch|. This does not change the option value, as
4072 soon as you use a search command, the highlighting comes back.
4073 'redrawtime' specifies the maximum time spent on finding matches.
4074 When the search pattern can match an end-of-line, Vim will try to
4075 highlight all of the matched text. However, this depends on where the
4076 search starts. This will be the first line in the window or the first
4077 line below a closed fold. A match in a previous line which is not
4078 drawn may not continue in a newly drawn line.
4079 You can specify whether the highlight status is restored on startup
4080 with the 'h' flag in 'viminfo' |viminfo-h|.
4081 NOTE: This option is reset when 'compatible' is set.
4082
Bram Moolenaar071d4272004-06-13 20:20:40 +00004083 *'icon'* *'noicon'*
4084'icon' boolean (default off, on when title can be restored)
4085 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004086 {not available when compiled without the |+title|
4087 feature}
4088 When on, the icon text of the window will be set to the value of
4089 'iconstring' (if it is not empty), or to the name of the file
4090 currently being edited. Only the last part of the name is used.
4091 Overridden by the 'iconstring' option.
4092 Only works if the terminal supports setting window icons (currently
4093 only X11 GUI and terminals with a non-empty 't_IS' option - these are
4094 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
4095 builtin termcap).
4096 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00004097 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00004098 X11.
Bram Moolenaar3a991dd2014-10-02 01:41:41 +02004099 For MS-Windows the icon can be changed, see |windows-icon|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004100
4101 *'iconstring'*
4102'iconstring' string (default "")
4103 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004104 {not available when compiled without the |+title|
4105 feature}
4106 When this option is not empty, it will be used for the icon text of
4107 the window. This happens only when the 'icon' option is on.
4108 Only works if the terminal supports setting window icon text
4109 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
4110 Does not work for MS Windows.
4111 When Vim was compiled with HAVE_X11 defined, the original icon will be
4112 restored if possible |X11|.
4113 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004114 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004115 'titlestring' for example settings.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004116 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004117 {not available when compiled without the |+statusline| feature}
4118
4119 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
4120'ignorecase' 'ic' boolean (default off)
4121 global
4122 Ignore case in search patterns. Also used when searching in the tags
4123 file.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01004124 Also see 'smartcase' and 'tagcase'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004125 Can be overruled by using "\c" or "\C" in the pattern, see
4126 |/ignorecase|.
4127
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004128 *'imactivatefunc'* *'imaf'*
4129'imactivatefunc' 'imaf' string (default "")
4130 global
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004131 This option specifies a function that will be called to
Bram Moolenaar2877d332017-11-26 14:56:16 +01004132 activate or deactivate the Input Method.
4133 It is not used in the GUI.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004134 The expression will be evaluated in the |sandbox| when set from a
4135 modeline, see |sandbox-option|.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004136
4137 Example: >
4138 function ImActivateFunc(active)
4139 if a:active
4140 ... do something
4141 else
4142 ... do something
4143 endif
4144 " return value is not used
4145 endfunction
4146 set imactivatefunc=ImActivateFunc
4147<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004148 *'imactivatekey'* *'imak'*
4149'imactivatekey' 'imak' string (default "")
4150 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004151 {only available when compiled with |+xim| and
Bram Moolenaar67c53842010-05-22 18:28:27 +02004152 |+GUI_GTK|} *E599*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004153 Specifies the key that your Input Method in X-Windows uses for
4154 activation. When this is specified correctly, vim can fully control
4155 IM with 'imcmdline', 'iminsert' and 'imsearch'.
4156 You can't use this option to change the activation key, the option
4157 tells Vim what the key is.
4158 Format:
4159 [MODIFIER_FLAG-]KEY_STRING
4160
4161 These characters can be used for MODIFIER_FLAG (case is ignored):
4162 S Shift key
4163 L Lock key
4164 C Control key
4165 1 Mod1 key
4166 2 Mod2 key
4167 3 Mod3 key
4168 4 Mod4 key
4169 5 Mod5 key
4170 Combinations are allowed, for example "S-C-space" or "SC-space" are
4171 both shift+ctrl+space.
4172 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
4173
4174 Example: >
4175 :set imactivatekey=S-space
4176< "S-space" means shift+space. This is the activation key for kinput2 +
4177 canna (Japanese), and ami (Korean).
4178
4179 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
4180'imcmdline' 'imc' boolean (default off)
4181 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004182 When set the Input Method is always on when starting to edit a command
4183 line, unless entering a search pattern (see 'imsearch' for that).
4184 Setting this option is useful when your input method allows entering
4185 English characters directly, e.g., when it's used to type accented
4186 characters with dead keys.
4187
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004188 *'imdisable'* *'imd'* *'noimdisable'* *'noimd'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004189'imdisable' 'imd' boolean (default off, on for some systems (SGI))
4190 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004191 When set the Input Method is never used. This is useful to disable
4192 the IM when it doesn't work properly.
4193 Currently this option is on by default for SGI/IRIX machines. This
4194 may change in later releases.
4195
4196 *'iminsert'* *'imi'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004197'iminsert' 'imi' number (default 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004198 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004199 Specifies whether :lmap or an Input Method (IM) is to be used in
4200 Insert mode. Valid values:
4201 0 :lmap is off and IM is off
4202 1 :lmap is ON and IM is off
4203 2 :lmap is off and IM is ON
Bram Moolenaar071d4272004-06-13 20:20:40 +00004204 To always reset the option to zero when leaving Insert mode with <Esc>
4205 this can be used: >
4206 :inoremap <ESC> <ESC>:set iminsert=0<CR>
4207< This makes :lmap and IM turn off automatically when leaving Insert
4208 mode.
4209 Note that this option changes when using CTRL-^ in Insert mode
4210 |i_CTRL-^|.
4211 The value is set to 1 when setting 'keymap' to a valid keymap name.
4212 It is also used for the argument of commands like "r" and "f".
4213 The value 0 may not work correctly with Athena and Motif with some XIM
4214 methods. Use 'imdisable' to disable XIM then.
4215
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004216 You can set 'imactivatefunc' and 'imstatusfunc' to handle IME/XIM
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004217 via external command if Vim is not compiled with the |+xim|,
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004218 |+multi_byte_ime| or |global-ime|.
4219
Bram Moolenaar071d4272004-06-13 20:20:40 +00004220 *'imsearch'* *'ims'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004221'imsearch' 'ims' number (default -1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004222 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004223 Specifies whether :lmap or an Input Method (IM) is to be used when
4224 entering a search pattern. Valid values:
4225 -1 the value of 'iminsert' is used, makes it look like
4226 'iminsert' is also used when typing a search pattern
4227 0 :lmap is off and IM is off
4228 1 :lmap is ON and IM is off
4229 2 :lmap is off and IM is ON
4230 Note that this option changes when using CTRL-^ in Command-line mode
4231 |c_CTRL-^|.
4232 The value is set to 1 when it is not -1 and setting the 'keymap'
4233 option to a valid keymap name.
4234 The value 0 may not work correctly with Athena and Motif with some XIM
4235 methods. Use 'imdisable' to disable XIM then.
4236
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004237 *'imstatusfunc'* *'imsf'*
4238'imstatusfunc' 'imsf' string (default "")
4239 global
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004240 This option specifies a function that is called to obtain the status
4241 of Input Method. It must return a positive number when IME is active.
Bram Moolenaar2877d332017-11-26 14:56:16 +01004242 It is not used in the GUI.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004243
4244 Example: >
4245 function ImStatusFunc()
4246 let is_active = ...do something
4247 return is_active ? 1 : 0
4248 endfunction
4249 set imstatusfunc=ImStatusFunc
4250<
4251 NOTE: This function is invoked very often. Keep it fast.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004252 The expression will be evaluated in the |sandbox| when set from a
4253 modeline, see |sandbox-option|.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004254
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004255 *'imstyle'* *'imst'*
4256'imstyle' 'imst' number (default 1)
4257 global
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004258 {only available when compiled with |+xim| and
4259 |+GUI_GTK|}
Bram Moolenaar37c64c72017-09-19 22:06:03 +02004260 This option specifies the input style of Input Method:
4261 0 use on-the-spot style
4262 1 over-the-spot style
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004263 See: |xim-input-style|
4264
Bram Moolenaar24a98a02017-09-27 22:23:55 +02004265 For a long time on-the-spot style had been used in the GTK version of
4266 vim, however, it is known that it causes troubles when using mappings,
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004267 |single-repeat|, etc. Therefore over-the-spot style becomes the
4268 default now. This should work fine for most people, however if you
4269 have any problem with it, try using on-the-spot style.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004270 The expression will be evaluated in the |sandbox| when set from a
4271 modeline, see |sandbox-option|.
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004272
Bram Moolenaar071d4272004-06-13 20:20:40 +00004273 *'include'* *'inc'*
4274'include' 'inc' string (default "^\s*#\s*include")
4275 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004276 {not available when compiled without the
4277 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004278 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00004279 pattern, just like for the "/" command (See |pattern|). The default
4280 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar1e015462005-09-25 22:16:38 +00004281 "]I", "[d", etc.
4282 Normally the 'isfname' option is used to recognize the file name that
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004283 comes after the matched pattern. But if "\zs" appears in the pattern
4284 then the text matched from "\zs" to the end, or until "\ze" if it
4285 appears, is used as the file name. Use this to include characters
4286 that are not in 'isfname', such as a space. You can then use
4287 'includeexpr' to process the matched text.
Bram Moolenaar1e015462005-09-25 22:16:38 +00004288 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004289
4290 *'includeexpr'* *'inex'*
4291'includeexpr' 'inex' string (default "")
4292 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004293 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004294 |+find_in_path| or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004295 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004296 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004297 :set includeexpr=substitute(v:fname,'\\.','/','g')
4298< The "v:fname" variable will be set to the file name that was detected.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004299
Bram Moolenaar071d4272004-06-13 20:20:40 +00004300 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004301 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004302 Also used for |<cfile>|.
4303
Bram Moolenaar30b65812012-07-12 22:01:11 +02004304 The expression will be evaluated in the |sandbox| when set from a
4305 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004306 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004307
4308 It is not allowed to change text or jump to another window while
4309 evaluating 'includeexpr' |textlock|.
4310
Bram Moolenaar071d4272004-06-13 20:20:40 +00004311 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004312'incsearch' 'is' boolean (default off, set in |defaults.vim| if the
4313 +reltime feature is supported)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004314 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004315 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004316 |+extra_search| features}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004317 While typing a search command, show where the pattern, as it was typed
4318 so far, matches. The matched string is highlighted. If the pattern
4319 is invalid or not found, nothing is shown. The screen will be updated
4320 often, this is only useful on fast terminals.
Bram Moolenaarfc65cab2018-08-28 22:58:02 +02004321 Also applies to the pattern in commands: >
4322 :global
4323 :lvimgrep
4324 :lvimgrepadd
4325 :smagic
4326 :snomagic
4327 :sort
4328 :substitute
4329 :vglobal
4330 :vimgrep
4331 :vimgrepadd
4332< Note that the match will be shown, but the cursor will return to its
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004333 original position when no match is found and when pressing <Esc>. You
4334 still need to finish the search command with <Enter> to move the
4335 cursor to the match.
Bram Moolenaardc083282016-10-11 08:57:33 +02004336 You can use the CTRL-G and CTRL-T keys to move to the next and
4337 previous match. |c_CTRL-G| |c_CTRL-T|
Bram Moolenaar91a4e822008-01-19 14:59:58 +00004338 When compiled with the |+reltime| feature Vim only searches for about
4339 half a second. With a complicated pattern and/or a lot of text the
4340 match may not be found. This is to avoid that Vim hangs while you
4341 are typing the pattern.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004342 The highlighting can be set with the 'i' flag in 'highlight'.
Bram Moolenaar2f058492017-11-30 20:27:52 +01004343 When 'hlsearch' is on, all matched strings are highlighted too while
4344 typing a search command. See also: 'hlsearch'.
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004345 If you don't want to turn 'hlsearch' on, but want to highlight all
4346 matches while searching, you can turn on and off 'hlsearch' with
4347 autocmd. Example: >
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004348 augroup vimrc-incsearch-highlight
4349 autocmd!
Bram Moolenaarf8f8b2e2017-11-02 19:08:48 +01004350 autocmd CmdlineEnter /,\? :set hlsearch
4351 autocmd CmdlineLeave /,\? :set nohlsearch
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004352 augroup END
4353<
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004354 CTRL-L can be used to add one character from after the current match
Bram Moolenaara9dc3752010-07-11 20:46:53 +02004355 to the command line. If 'ignorecase' and 'smartcase' are set and the
4356 command line has no uppercase characters, the added character is
4357 converted to lowercase.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004358 CTRL-R CTRL-W can be used to add the word at the end of the current
4359 match, excluding the characters that were already typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004360 NOTE: This option is reset when 'compatible' is set.
4361
4362 *'indentexpr'* *'inde'*
4363'indentexpr' 'inde' string (default "")
4364 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004365 {not available when compiled without the |+cindent|
4366 or |+eval| features}
4367 Expression which is evaluated to obtain the proper indent for a line.
4368 It is used when a new line is created, for the |=| operator and
4369 in Insert mode as specified with the 'indentkeys' option.
4370 When this option is not empty, it overrules the 'cindent' and
Bram Moolenaar20f90cf2011-05-19 12:22:51 +02004371 'smartindent' indenting. When 'lisp' is set, this option is
4372 overridden by the Lisp indentation algorithm.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004373 When 'paste' is set this option is not used for indenting.
4374 The expression is evaluated with |v:lnum| set to the line number for
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004375 which the indent is to be computed. The cursor is also in this line
Bram Moolenaar071d4272004-06-13 20:20:40 +00004376 when the expression is evaluated (but it may be moved around).
4377 The expression must return the number of spaces worth of indent. It
4378 can return "-1" to keep the current indent (this means 'autoindent' is
4379 used for the indent).
4380 Functions useful for computing the indent are |indent()|, |cindent()|
4381 and |lispindent()|.
4382 The evaluation of the expression must not have side effects! It must
4383 not change the text, jump to another window, etc. Afterwards the
4384 cursor position is always restored, thus the cursor may be moved.
4385 Normally this option would be set to call a function: >
4386 :set indentexpr=GetMyIndent()
4387< Error messages will be suppressed, unless the 'debug' option contains
4388 "msg".
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004389 See |indent-expression|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01004390 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004391
Bram Moolenaar30b65812012-07-12 22:01:11 +02004392 The expression will be evaluated in the |sandbox| when set from a
4393 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004394 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004395
4396 It is not allowed to change text or jump to another window while
4397 evaluating 'indentexpr' |textlock|.
4398
4399
Bram Moolenaar071d4272004-06-13 20:20:40 +00004400 *'indentkeys'* *'indk'*
Bram Moolenaarce655742019-01-31 14:12:57 +01004401'indentkeys' 'indk' string (default "0{,0},0),0],:,0#,!^F,o,O,e")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004402 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004403 {not available when compiled without the |+cindent|
4404 feature}
4405 A list of keys that, when typed in Insert mode, cause reindenting of
4406 the current line. Only happens if 'indentexpr' isn't empty.
4407 The format is identical to 'cinkeys', see |indentkeys-format|.
4408 See |C-indenting| and |indent-expression|.
4409
4410 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
4411'infercase' 'inf' boolean (default off)
4412 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004413 When doing keyword completion in insert mode |ins-completion|, and
Bram Moolenaar446cb832008-06-24 21:56:24 +00004414 'ignorecase' is also on, the case of the match is adjusted depending
4415 on the typed text. If the typed text contains a lowercase letter
4416 where the match has an upper case letter, the completed part is made
4417 lowercase. If the typed text has no lowercase letters and the match
4418 has a lowercase letter where the typed text has an uppercase letter,
4419 and there is a letter before it, the completed part is made uppercase.
4420 With 'noinfercase' the match is used as-is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004421
4422 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
4423'insertmode' 'im' boolean (default off)
4424 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004425 Makes Vim work in a way that Insert mode is the default mode. Useful
4426 if you want to use Vim as a modeless editor. Used for |evim|.
4427 These Insert mode commands will be useful:
4428 - Use the cursor keys to move around.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02004429 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|. When
Bram Moolenaar071d4272004-06-13 20:20:40 +00004430 this is a mapping, it is executed as if 'insertmode' was off.
4431 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004432 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00004433 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
4434 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004435
4436 These items change when 'insertmode' is set:
4437 - when starting to edit of a file, Vim goes to Insert mode.
4438 - <Esc> in Insert mode is a no-op and beeps.
4439 - <Esc> in Normal mode makes Vim go to Insert mode.
4440 - CTRL-L in Insert mode is a command, it is not inserted.
4441 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
4442 However, when <Esc> is used inside a mapping, it behaves like
4443 'insertmode' was not set. This was done to be able to use the same
4444 mappings with 'insertmode' set or not set.
4445 When executing commands with |:normal| 'insertmode' is not used.
4446
4447 NOTE: This option is reset when 'compatible' is set.
4448
4449 *'isfname'* *'isf'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004450'isfname' 'isf' string (default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004451 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
4452 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
4453 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
4454 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
4455 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
4456 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004457 The characters specified by this option are included in file names and
4458 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004459 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004460 Multi-byte characters 256 and above are always included, only the
4461 characters up to 255 are specified with this option.
4462 For UTF-8 the characters 0xa0 to 0xff are included as well.
Bram Moolenaar446cb832008-06-24 21:56:24 +00004463 Think twice before adding white space to this option. Although a
4464 space may appear inside a file name, the effect will be that Vim
4465 doesn't know where a file name starts or ends when doing completion.
4466 It most likely works better without a space in 'isfname'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004467
4468 Note that on systems using a backslash as path separator, Vim tries to
4469 do its best to make it work as you would expect. That is a bit
4470 tricky, since Vi originally used the backslash to escape special
4471 characters. Vim will not remove a backslash in front of a normal file
4472 name character on these systems, but it will on Unix and alikes. The
4473 '&' and '^' are not included by default, because these are special for
4474 cmd.exe.
4475
4476 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004477 Each part can be a single character number or a range. A range is two
4478 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004479 decimal number between 0 and 255 or the ASCII character itself (does
4480 not work for digits). Example:
4481 "_,-,128-140,#-43" (include '_' and '-' and the range
4482 128 to 140 and '#' to 43)
4483 If a part starts with '^', the following character number or range
4484 will be excluded from the option. The option is interpreted from left
4485 to right. Put the excluded character after the range where it is
4486 included. To include '^' itself use it as the last character of the
4487 option or the end of a range. Example:
4488 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
4489 If the character is '@', all characters where isalpha() returns TRUE
4490 are included. Normally these are the characters a to z and A to Z,
4491 plus accented characters. To include '@' itself use "@-@". Examples:
4492 "@,^a-z" All alphabetic characters, excluding lower
Bram Moolenaar446cb832008-06-24 21:56:24 +00004493 case ASCII letters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004494 "a-z,A-Z,@-@" All letters plus the '@' character.
4495 A comma can be included by using it where a character number is
4496 expected. Example:
4497 "48-57,,,_" Digits, comma and underscore.
4498 A comma can be excluded by prepending a '^'. Example:
4499 " -~,^,,9" All characters from space to '~', excluding
4500 comma, plus <Tab>.
4501 See |option-backslash| about including spaces and backslashes.
4502
4503 *'isident'* *'isi'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004504'isident' 'isi' string (default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004505 "@,48-57,_,128-167,224-235"
4506 otherwise: "@,48-57,_,192-255")
4507 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004508 The characters given by this option are included in identifiers.
4509 Identifiers are used in recognizing environment variables and after a
4510 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00004511 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004512 option. For '@' only characters up to 255 are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004513 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004514 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00004515 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
4516
4517 *'iskeyword'* *'isk'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004518'iskeyword' 'isk' string (Vim default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004519 "@,48-57,_,128-167,224-235"
4520 otherwise: "@,48-57,_,192-255"
4521 Vi default: "@,48-57,_")
4522 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004523 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004524 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004525 'isfname' for a description of the format of this option. For '@'
4526 characters above 255 check the "word" character class.
4527 For C programs you could use "a-z,A-Z,48-57,_,.,-,>".
Bram Moolenaar071d4272004-06-13 20:20:40 +00004528 For a help file it is set to all non-blank printable characters except
4529 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
4530 command).
4531 When the 'lisp' option is on the '-' character is always included.
Bram Moolenaarb8060fe2016-01-19 22:29:28 +01004532 This option also influences syntax highlighting, unless the syntax
4533 uses |:syn-iskeyword|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004534 NOTE: This option is set to the Vi default value when 'compatible' is
4535 set and to the Vim default value when 'compatible' is reset.
4536
4537 *'isprint'* *'isp'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004538'isprint' 'isp' string (default for Win32 and Macintosh:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004539 "@,~-255"; otherwise: "@,161-255")
4540 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004541 The characters given by this option are displayed directly on the
4542 screen. It is also used for "\p" in a |pattern|. The characters from
4543 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
4544 even when they are not included in 'isprint' or excluded. See
4545 'isfname' for a description of the format of this option.
4546
4547 Non-printable characters are displayed with two characters:
4548 0 - 31 "^@" - "^_"
4549 32 - 126 always single characters
4550 127 "^?"
4551 128 - 159 "~@" - "~_"
4552 160 - 254 "| " - "|~"
4553 255 "~?"
4554 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
4555 displayed as <xx>, with the hexadecimal value of the byte.
4556 When 'display' contains "uhex" all unprintable characters are
4557 displayed as <xx>.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004558 The SpecialKey highlighting will be used for unprintable characters.
4559 |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004560
4561 Multi-byte characters 256 and above are always included, only the
4562 characters up to 255 are specified with this option. When a character
4563 is printable but it is not available in the current font, a
4564 replacement character will be shown.
4565 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
4566 There is no option to specify these characters.
4567
4568 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
4569'joinspaces' 'js' boolean (default on)
4570 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004571 Insert two spaces after a '.', '?' and '!' with a join command.
4572 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
4573 Otherwise only one space is inserted.
4574 NOTE: This option is set when 'compatible' is set.
4575
4576 *'key'*
4577'key' string (default "")
4578 local to buffer
Bram Moolenaar996343d2010-07-04 22:20:21 +02004579 {only available when compiled with the |+cryptv|
4580 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004581 The key that is used for encrypting and decrypting the current buffer.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02004582 See |encryption| and 'cryptmethod'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004583 Careful: Do not set the key value by hand, someone might see the typed
4584 key. Use the |:X| command. But you can make 'key' empty: >
4585 :set key=
4586< It is not possible to get the value of this option with ":set key" or
4587 "echo &key". This is to avoid showing it to someone who shouldn't
4588 know. It also means you cannot see it yourself once you have set it,
4589 be careful not to make a typing error!
Bram Moolenaard58e9292011-02-09 17:07:58 +01004590 You can use "&key" in an expression to detect whether encryption is
4591 enabled. When 'key' is set it returns "*****" (five stars).
Bram Moolenaar071d4272004-06-13 20:20:40 +00004592
4593 *'keymap'* *'kmp'* *E544*
4594'keymap' 'kmp' string (default "")
4595 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004596 {only available when compiled with the |+keymap|
4597 feature}
4598 Name of a keyboard mapping. See |mbyte-keymap|.
4599 Setting this option to a valid keymap name has the side effect of
4600 setting 'iminsert' to one, so that the keymap becomes effective.
4601 'imsearch' is also set to one, unless it was -1
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004602 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004603
4604 *'keymodel'* *'km'*
4605'keymodel' 'km' string (default "")
4606 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004607 List of comma separated words, which enable special things that keys
4608 can do. These values can be used:
4609 startsel Using a shifted special key starts selection (either
4610 Select mode or Visual mode, depending on "key" being
4611 present in 'selectmode').
4612 stopsel Using a not-shifted special key stops selection.
4613 Special keys in this context are the cursor keys, <End>, <Home>,
4614 <PageUp> and <PageDown>.
4615 The 'keymodel' option is set by the |:behave| command.
4616
4617 *'keywordprg'* *'kp'*
4618'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02004619 VMS: "help")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004620 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004621 Program to use for the |K| command. Environment variables are
4622 expanded |:set_env|. ":help" may be used to access the Vim internal
4623 help. (Note that previously setting the global option to the empty
4624 value did this, which is now deprecated.)
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02004625 When the first character is ":", the command is invoked as a Vim
4626 Ex command prefixed with [count].
4627 When "man", "man -s" or an Ex command is used, Vim will automatically
4628 translate a count for the "K" command and pass it as the first
4629 argument. For "man -s" the "-s" is removed when there is no count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004630 See |option-backslash| about including spaces and backslashes.
4631 Example: >
4632 :set keywordprg=man\ -s
4633< This option cannot be set from a |modeline| or in the |sandbox|, for
4634 security reasons.
4635
4636 *'langmap'* *'lmap'* *E357* *E358*
4637'langmap' 'lmap' string (default "")
4638 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004639 {only available when compiled with the |+langmap|
4640 feature}
4641 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004642 mode. When you are typing text in Insert mode the characters are
Bram Moolenaarfa735342016-01-03 22:14:44 +01004643 inserted directly. When in Normal mode the 'langmap' option takes
Bram Moolenaar071d4272004-06-13 20:20:40 +00004644 care of translating these special characters to the original meaning
4645 of the key. This means you don't have to change the keyboard mode to
4646 be able to execute Normal mode commands.
4647 This is the opposite of the 'keymap' option, where characters are
4648 mapped in Insert mode.
Bram Moolenaarb17893a2020-03-14 08:19:51 +01004649 Also consider setting 'langremap' to off, to prevent 'langmap' from
4650 applying to characters resulting from a mapping.
Bram Moolenaare968e362014-05-13 20:23:24 +02004651 This option cannot be set from a |modeline| or in the |sandbox|, for
4652 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004653
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00004654 Example (for Greek, in UTF-8): *greek* >
4655 :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 +00004656< Example (exchanges meaning of z and y for commands): >
4657 :set langmap=zy,yz,ZY,YZ
4658<
4659 The 'langmap' option is a list of parts, separated with commas. Each
4660 part can be in one of two forms:
4661 1. A list of pairs. Each pair is a "from" character immediately
4662 followed by the "to" character. Examples: "aA", "aAbBcC".
4663 2. A list of "from" characters, a semi-colon and a list of "to"
4664 characters. Example: "abc;ABC"
4665 Example: "aA,fgh;FGH,cCdDeE"
4666 Special characters need to be preceded with a backslash. These are
4667 ";", ',' and backslash itself.
4668
4669 This will allow you to activate vim actions without having to switch
4670 back and forth between the languages. Your language characters will
4671 be understood as normal vim English characters (according to the
4672 langmap mappings) in the following cases:
4673 o Normal/Visual mode (commands, buffer/register names, user mappings)
4674 o Insert/Replace Mode: Register names after CTRL-R
4675 o Insert/Replace Mode: Mappings
4676 Characters entered in Command-line mode will NOT be affected by
4677 this option. Note that this option can be changed at any time
4678 allowing to switch between mappings for different languages/encodings.
4679 Use a mapping to avoid having to type it each time!
4680
4681 *'langmenu'* *'lm'*
4682'langmenu' 'lm' string (default "")
4683 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004684 {only available when compiled with the |+menu| and
4685 |+multi_lang| features}
4686 Language to use for menu translation. Tells which file is loaded
4687 from the "lang" directory in 'runtimepath': >
4688 "lang/menu_" . &langmenu . ".vim"
4689< (without the spaces). For example, to always use the Dutch menus, no
4690 matter what $LANG is set to: >
4691 :set langmenu=nl_NL.ISO_8859-1
4692< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004693 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004694 If your $LANG is set to a non-English language but you do want to use
4695 the English menus: >
4696 :set langmenu=none
4697< This option must be set before loading menus, switching on filetype
4698 detection or syntax highlighting. Once the menus are defined setting
4699 this option has no effect. But you could do this: >
4700 :source $VIMRUNTIME/delmenu.vim
4701 :set langmenu=de_DE.ISO_8859-1
4702 :source $VIMRUNTIME/menu.vim
4703< Warning: This deletes all menus that you defined yourself!
4704
Bram Moolenaard94464e2015-11-02 15:28:18 +01004705 *'langnoremap'* *'lnr'* *'nolangnoremap'* *'nolnr'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004706'langnoremap' 'lnr' boolean (default off, set in |defaults.vim|)
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004707 global
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004708 {only available when compiled with the |+langmap|
4709 feature}
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004710 This is just like 'langremap' but with the value inverted. It only
4711 exists for backwards compatibility. When setting 'langremap' then
4712 'langnoremap' is set to the inverted value, and the other way around.
4713
4714 *'langremap'* *'lrm'* *'nolangremap'* *'nolrm'*
Bram Moolenaarb17893a2020-03-14 08:19:51 +01004715'langremap' 'lrm' boolean (default on, set to off in |defaults.vim|)
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004716 global
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004717 {only available when compiled with the |+langmap|
4718 feature}
4719 When off, setting 'langmap' does not apply to characters resulting from
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004720 a mapping. This basically means, if you noticed that setting
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004721 'langmap' disables some of your mappings, try resetting this option.
4722 This option defaults to on for backwards compatibility. Set it off if
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004723 that works for you to avoid mappings to break.
4724
Bram Moolenaar071d4272004-06-13 20:20:40 +00004725 *'laststatus'* *'ls'*
4726'laststatus' 'ls' number (default 1)
4727 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004728 The value of this option influences when the last window will have a
4729 status line:
4730 0: never
4731 1: only if there are at least two windows
4732 2: always
4733 The screen looks nicer with a status line if you have several
4734 windows, but it takes another screen line. |status-line|
4735
4736 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
4737'lazyredraw' 'lz' boolean (default off)
4738 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004739 When this option is set, the screen will not be redrawn while
4740 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004741 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00004742 update use |:redraw|.
4743
4744 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
4745'linebreak' 'lbr' boolean (default off)
4746 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02004747 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004748 feature}
Bram Moolenaar946e27a2014-06-25 18:50:27 +02004749 If on, Vim will wrap long lines at a character in 'breakat' rather
Bram Moolenaar071d4272004-06-13 20:20:40 +00004750 than at the last character that fits on the screen. Unlike
4751 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
Bram Moolenaar946e27a2014-06-25 18:50:27 +02004752 it only affects the way the file is displayed, not its contents.
4753 If 'breakindent' is set, line is visually indented. Then, the value
4754 of 'showbreak' is used to put in front of wrapped lines. This option
Bram Moolenaar86b17e92014-07-02 20:00:47 +02004755 is not used when the 'wrap' option is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004756 Note that <Tab> characters after an <EOL> are mostly not displayed
4757 with the right amount of white space.
4758
4759 *'lines'* *E593*
4760'lines' number (default 24 or terminal height)
4761 global
4762 Number of lines of the Vim window.
4763 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00004764 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004765 When Vim is running in the GUI or in a resizable window, setting this
4766 option will cause the window size to be changed. When you only want
4767 to use the size for the GUI, put the command in your |gvimrc| file.
4768 Vim limits the number of lines to what fits on the screen. You can
4769 use this command to get the tallest window possible: >
4770 :set lines=999
Bram Moolenaarf4d11452005-12-02 00:46:37 +00004771< Minimum value is 2, maximum value is 1000.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02004772 If you get fewer lines than expected, check the 'guiheadroom' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004773 When you set this option and Vim is unable to change the physical
4774 number of lines of the display, the display may be messed up.
4775
4776 *'linespace'* *'lsp'*
4777'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
4778 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004779 {only in the GUI}
4780 Number of pixel lines inserted between characters. Useful if the font
4781 uses the full character cell height, making lines touch each other.
4782 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004783 With some fonts there can be too much room between lines (to have
4784 space for ascents and descents). Then it makes sense to set
4785 'linespace' to a negative value. This may cause display problems
4786 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00004787
4788 *'lisp'* *'nolisp'*
4789'lisp' boolean (default off)
4790 local to buffer
4791 {not available when compiled without the |+lispindent|
4792 feature}
4793 Lisp mode: When <Enter> is typed in insert mode set the indent for
4794 the next line to Lisp standards (well, sort of). Also happens with
4795 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
4796 flag in 'cpoptions' changes the method of indenting: Vi compatible or
4797 better. Also see 'lispwords'.
4798 The '-' character is included in keyword characters. Redefines the
4799 "=" operator to use this same indentation algorithm rather than
4800 calling an external program if 'equalprg' is empty.
4801 This option is not used when 'paste' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004802
4803 *'lispwords'* *'lw'*
4804'lispwords' 'lw' string (default is very long)
Bram Moolenaaraf6c1312014-03-12 18:55:58 +01004805 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004806 {not available when compiled without the |+lispindent|
4807 feature}
4808 Comma separated list of words that influence the Lisp indenting.
4809 |'lisp'|
4810
4811 *'list'* *'nolist'*
4812'list' boolean (default off)
4813 local to window
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004814 List mode: Show tabs as CTRL-I is displayed, display $ after end of
4815 line. Useful to see the difference between tabs and spaces and for
4816 trailing blanks. Further changed by the 'listchars' option.
4817
4818 The cursor is displayed at the start of the space a Tab character
4819 occupies, not at the end as usual in Normal mode. To get this cursor
4820 position while displaying Tabs with spaces, use: >
Bram Moolenaardd007ed2013-07-09 15:44:17 +02004821 :set list lcs=tab:\ \
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004822<
4823 Note that list mode will also affect formatting (set with 'textwidth'
4824 or 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
Bram Moolenaar071d4272004-06-13 20:20:40 +00004825 changing the way tabs are displayed.
4826
4827 *'listchars'* *'lcs'*
4828'listchars' 'lcs' string (default "eol:$")
4829 global
Bram Moolenaarf9d5ca12010-08-01 16:13:51 +02004830 Strings to use in 'list' mode and for the |:list| command. It is a
4831 comma separated list of string settings.
Bram Moolenaar79278362015-04-21 18:33:48 +02004832 *lcs-eol*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004833 eol:c Character to show at the end of each line. When
4834 omitted, there is no extra character at the end of the
4835 line.
Bram Moolenaar79278362015-04-21 18:33:48 +02004836 *lcs-tab*
Bram Moolenaar83a52172019-01-16 22:41:54 +01004837 tab:xy[z] Two or three characters to be used to show a tab.
4838 The third character is optional.
4839
4840 tab:xy The 'x' is always used, then 'y' as many times as will
4841 fit. Thus "tab:>-" displays:
4842 >
4843 >-
4844 >--
4845 etc.
4846
4847 tab:xyz The 'z' is always used, then 'x' is prepended, and
4848 then 'y' is used as many times as will fit. Thus
4849 "tab:<->" displays:
4850 >
4851 <>
4852 <->
4853 <-->
4854 etc.
4855
4856 When "tab:" is omitted, a tab is shown as ^I.
Bram Moolenaar79278362015-04-21 18:33:48 +02004857 *lcs-space*
4858 space:c Character to show for a space. When omitted, spaces
4859 are left blank.
4860 *lcs-trail*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004861 trail:c Character to show for trailing spaces. When omitted,
Bram Moolenaar79278362015-04-21 18:33:48 +02004862 trailing spaces are blank. Overrides the "space"
4863 setting for trailing spaces.
4864 *lcs-extends*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004865 extends:c Character to show in the last column, when 'wrap' is
4866 off and the line continues beyond the right of the
4867 screen.
Bram Moolenaar79278362015-04-21 18:33:48 +02004868 *lcs-precedes*
Bram Moolenaarbffba7f2019-09-20 17:00:17 +02004869 precedes:c Character to show in the first visible column of the
4870 physical line, when there is text preceding the
4871 character visible in the first column.
Bram Moolenaar79278362015-04-21 18:33:48 +02004872 *lcs-conceal*
Bram Moolenaar860cae12010-06-05 23:22:07 +02004873 conceal:c Character to show in place of concealed text, when
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004874 'conceallevel' is set to 1.
Bram Moolenaar79278362015-04-21 18:33:48 +02004875 *lcs-nbsp*
Bram Moolenaar73284b92015-05-04 17:28:22 +02004876 nbsp:c Character to show for a non-breakable space character
4877 (0xA0 (160 decimal) and U+202F). Left blank when
4878 omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004879
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004880 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00004881 be used when 'encoding' is "utf-8", otherwise only printable
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004882 characters are allowed. All characters must be single width.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004883
4884 Examples: >
4885 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004886 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00004887 :set lcs=extends:>,precedes:<
4888< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaar79278362015-04-21 18:33:48 +02004889 "precedes". "SpecialKey" for "nbsp", "space", "tab" and "trail".
Bram Moolenaar02467872007-05-06 13:22:01 +00004890 |hl-NonText| |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004891
4892 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
4893'loadplugins' 'lpl' boolean (default on)
4894 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004895 When on the plugin scripts are loaded when starting up |load-plugins|.
4896 This option can be reset in your |vimrc| file to disable the loading
4897 of plugins.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02004898 Note that using the "-u NONE", "-u DEFAULTS" and "--noplugin" command
4899 line arguments reset this option. See |-u| and |--noplugin|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004900
Bram Moolenaard94464e2015-11-02 15:28:18 +01004901 *'luadll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01004902'luadll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01004903 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01004904 {only available when compiled with the |+lua/dyn|
4905 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01004906 Specifies the name of the Lua shared library. The default is
4907 DYNAMIC_LUA_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02004908 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01004909 This option cannot be set from a |modeline| or in the |sandbox|, for
4910 security reasons.
4911
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00004912 *'macatsui'* *'nomacatsui'*
4913'macatsui' boolean (default on)
4914 global
4915 {only available in Mac GUI version}
4916 This is a workaround for when drawing doesn't work properly. When set
4917 and compiled with multi-byte support ATSUI text drawing is used. When
4918 not set ATSUI text drawing is not used. Switch this option off when
4919 you experience drawing problems. In a future version the problems may
4920 be solved and this option becomes obsolete. Therefore use this method
4921 to unset it: >
4922 if exists('&macatsui')
4923 set nomacatsui
4924 endif
Bram Moolenaar02467872007-05-06 13:22:01 +00004925< Another option to check if you have drawing problems is
4926 'termencoding'.
4927
Bram Moolenaar071d4272004-06-13 20:20:40 +00004928 *'magic'* *'nomagic'*
4929'magic' boolean (default on)
4930 global
4931 Changes the special characters that can be used in search patterns.
4932 See |pattern|.
Bram Moolenaar64d8e252016-09-06 22:12:34 +02004933 WARNING: Switching this option off most likely breaks plugins! That
4934 is because many patterns assume it's on and will fail when it's off.
4935 Only switch it off when working with old Vi scripts. In any other
4936 situation write patterns that work when 'magic' is on. Include "\M"
4937 when you want to |/\M|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004938
4939 *'makeef'* *'mef'*
4940'makeef' 'mef' string (default: "")
4941 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004942 {not available when compiled without the |+quickfix|
4943 feature}
4944 Name of the errorfile for the |:make| command (see |:make_makeprg|)
4945 and the |:grep| command.
4946 When it is empty, an internally generated temp file will be used.
4947 When "##" is included, it is replaced by a number to make the name
4948 unique. This makes sure that the ":make" command doesn't overwrite an
4949 existing file.
4950 NOT used for the ":cf" command. See 'errorfile' for that.
4951 Environment variables are expanded |:set_env|.
4952 See |option-backslash| about including spaces and backslashes.
4953 This option cannot be set from a |modeline| or in the |sandbox|, for
4954 security reasons.
4955
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01004956 *'makeencoding'* *'menc'*
4957'makeencoding' 'menc' string (default "")
4958 global or local to buffer |global-local|
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01004959 Encoding used for reading the output of external commands. When empty,
4960 encoding is not converted.
4961 This is used for `:make`, `:lmake`, `:grep`, `:lgrep`, `:grepadd`,
4962 `:lgrepadd`, `:cfile`, `:cgetfile`, `:caddfile`, `:lfile`, `:lgetfile`,
4963 and `:laddfile`.
4964
4965 This would be mostly useful when you use MS-Windows and set 'encoding'
4966 to "utf-8". If |+iconv| is enabled and GNU libiconv is used, setting
4967 'makeencoding' to "char" has the same effect as setting to the system
4968 locale encoding. Example: >
4969 :set encoding=utf-8
4970 :set makeencoding=char " system locale is used
4971<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004972 *'makeprg'* *'mp'*
4973'makeprg' 'mp' string (default "make", VMS: "MMS")
4974 global or local to buffer |global-local|
Bram Moolenaar02467872007-05-06 13:22:01 +00004975 Program to use for the ":make" command. See |:make_makeprg|.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01004976 This option may contain '%' and '#' characters (see |:_%| and |:_#|),
4977 which are expanded to the current and alternate file name. Use |::S|
Bram Moolenaar26df0922014-02-23 23:39:13 +01004978 to escape file names in case they contain special characters.
Bram Moolenaar02467872007-05-06 13:22:01 +00004979 Environment variables are expanded |:set_env|. See |option-backslash|
4980 about including spaces and backslashes.
4981 Note that a '|' must be escaped twice: once for ":set" and once for
4982 the interpretation of a command. When you use a filter called
4983 "myfilter" do it like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004984 :set makeprg=gmake\ \\\|\ myfilter
4985< The placeholder "$*" can be given (even multiple times) to specify
4986 where the arguments will be included, for example: >
4987 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
4988< This option cannot be set from a |modeline| or in the |sandbox|, for
4989 security reasons.
4990
4991 *'matchpairs'* *'mps'*
4992'matchpairs' 'mps' string (default "(:),{:},[:]")
4993 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004994 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01004995 other.
4996 Only character pairs are allowed that are different, thus you cannot
4997 jump between two double quotes.
4998 The characters must be separated by a colon.
Bram Moolenaar02467872007-05-06 13:22:01 +00004999 The pairs must be separated by a comma. Example for including '<' and
5000 '>' (HTML): >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005001 :set mps+=<:>
5002
5003< A more exotic example, to jump between the '=' and ';' in an
5004 assignment, useful for languages like C and Java: >
5005 :au FileType c,cpp,java set mps+==:;
5006
5007< For a more advanced way of using "%", see the matchit.vim plugin in
Bram Moolenaar01164a62017-11-02 22:58:42 +01005008 the $VIMRUNTIME/pack/dist/opt/matchit directory. |add-local-help|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005009
5010 *'matchtime'* *'mat'*
5011'matchtime' 'mat' number (default 5)
5012 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005013 Tenths of a second to show the matching paren, when 'showmatch' is
5014 set. Note that this is not in milliseconds, like other options that
5015 set a time. This is to be compatible with Nvi.
5016
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005017 *'maxcombine'* *'mco'*
5018'maxcombine' 'mco' number (default 2)
5019 global
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005020 The maximum number of combining characters supported for displaying.
5021 Only used when 'encoding' is "utf-8".
5022 The default is OK for most languages. Hebrew may require 4.
5023 Maximum value is 6.
5024 Even when this option is set to 2 you can still edit text with more
5025 combining characters, you just can't see them. Use |g8| or |ga|.
5026 See |mbyte-combining|.
5027
Bram Moolenaar071d4272004-06-13 20:20:40 +00005028 *'maxfuncdepth'* *'mfd'*
5029'maxfuncdepth' 'mfd' number (default 100)
5030 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02005031 {not available when compiled without the |+eval|
Bram Moolenaar02467872007-05-06 13:22:01 +00005032 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005033 Maximum depth of function calls for user functions. This normally
5034 catches endless recursion. When using a recursive function with
5035 more depth, set 'maxfuncdepth' to a bigger number. But this will use
5036 more memory, there is the danger of failing when memory is exhausted.
Bram Moolenaarbc2eada2017-01-02 21:27:47 +01005037 Increasing this limit above 200 also changes the maximum for Ex
Bram Moolenaar0b0f0992018-05-22 21:41:30 +02005038 command recursion, see |E169|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005039 See also |:function|.
5040
5041 *'maxmapdepth'* *'mmd'* *E223*
5042'maxmapdepth' 'mmd' number (default 1000)
5043 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005044 Maximum number of times a mapping is done without resulting in a
5045 character to be used. This normally catches endless mappings, like
5046 ":map x y" with ":map y x". It still does not catch ":map g wg",
5047 because the 'w' is used before the next mapping is done. See also
5048 |key-mapping|.
5049
5050 *'maxmem'* *'mm'*
5051'maxmem' 'mm' number (default between 256 to 5120 (system
5052 dependent) or half the amount of memory
5053 available)
5054 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005055 Maximum amount of memory (in Kbyte) to use for one buffer. When this
5056 limit is reached allocating extra memory for a buffer will cause
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005057 other memory to be freed.
5058 The maximum usable value is about 2000000. Use this to work without a
5059 limit.
5060 The value is ignored when 'swapfile' is off.
5061 Also see 'maxmemtot'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005062
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005063 *'maxmempattern'* *'mmp'*
5064'maxmempattern' 'mmp' number (default 1000)
5065 global
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005066 Maximum amount of memory (in Kbyte) to use for pattern matching.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005067 The maximum value is about 2000000. Use this to work without a limit.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005068 *E363*
Bram Moolenaar02467872007-05-06 13:22:01 +00005069 When Vim runs into the limit it gives an error message and mostly
5070 behaves like CTRL-C was typed.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005071 Running into the limit often means that the pattern is very
5072 inefficient or too complex. This may already happen with the pattern
5073 "\(.\)*" on a very long line. ".*" works much better.
Bram Moolenaarfd358112018-07-07 23:21:31 +02005074 Might also happen on redraw, when syntax rules try to match a complex
5075 text structure.
5076 Vim may run out of memory before hitting the 'maxmempattern' limit, in
5077 which case you get an "Out of memory" error instead.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005078
Bram Moolenaar071d4272004-06-13 20:20:40 +00005079 *'maxmemtot'* *'mmt'*
5080'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
5081 dependent) or half the amount of memory
5082 available)
5083 global
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005084 Maximum amount of memory in Kbyte to use for all buffers together.
5085 The maximum usable value is about 2000000 (2 Gbyte). Use this to work
Bram Moolenaarfa735342016-01-03 22:14:44 +01005086 without a limit.
5087 On 64 bit machines higher values might work. But hey, do you really
5088 need more than 2 Gbyte for text editing? Keep in mind that text is
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005089 stored in the swap file, one can edit files > 2 Gbyte anyway. We do
Bram Moolenaarfa735342016-01-03 22:14:44 +01005090 need the memory to store undo info.
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005091 Buffers with 'swapfile' off still count to the total amount of memory
5092 used.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005093 Also see 'maxmem'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005094
5095 *'menuitems'* *'mis'*
5096'menuitems' 'mis' number (default 25)
5097 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005098 {not available when compiled without the |+menu|
5099 feature}
5100 Maximum number of items to use in a menu. Used for menus that are
5101 generated from a list of items, e.g., the Buffers menu. Changing this
5102 option has no direct effect, the menu must be refreshed first.
5103
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005104 *'mkspellmem'* *'msm'*
5105'mkspellmem' 'msm' string (default "460000,2000,500")
5106 global
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005107 {not available when compiled without the |+syntax|
5108 feature}
5109 Parameters for |:mkspell|. This tunes when to start compressing the
5110 word tree. Compression can be slow when there are many words, but
5111 it's needed to avoid running out of memory. The amount of memory used
5112 per word depends very much on how similar the words are, that's why
5113 this tuning is complicated.
5114
5115 There are three numbers, separated by commas:
5116 {start},{inc},{added}
5117
5118 For most languages the uncompressed word tree fits in memory. {start}
5119 gives the amount of memory in Kbyte that can be used before any
5120 compression is done. It should be a bit smaller than the amount of
5121 memory that is available to Vim.
5122
5123 When going over the {start} limit the {inc} number specifies the
5124 amount of memory in Kbyte that can be allocated before another
5125 compression is done. A low number means compression is done after
5126 less words are added, which is slow. A high number means more memory
5127 will be allocated.
5128
5129 After doing compression, {added} times 1024 words can be added before
5130 the {inc} limit is ignored and compression is done when any extra
5131 amount of memory is needed. A low number means there is a smaller
5132 chance of hitting the {inc} limit, less memory is used but it's
5133 slower.
5134
5135 The languages for which these numbers are important are Italian and
5136 Hungarian. The default works for when you have about 512 Mbyte. If
5137 you have 1 Gbyte you could use: >
5138 :set mkspellmem=900000,3000,800
5139< If you have less than 512 Mbyte |:mkspell| may fail for some
5140 languages, no matter what you set 'mkspellmem' to.
5141
Bram Moolenaar07607392019-05-26 19:20:43 +02005142 This option cannot be set from a |modeline| or in the |sandbox|.
5143
Bram Moolenaar071d4272004-06-13 20:20:40 +00005144 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
Bram Moolenaar8243a792007-05-01 17:05:03 +00005145'modeline' 'ml' boolean (Vim default: on (off for root),
5146 Vi default: off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005147 local to buffer
Bram Moolenaar110289e2019-05-23 15:38:06 +02005148 If 'modeline' is on 'modelines' gives the number of lines that is
5149 checked for set commands. If 'modeline' is off or 'modelines' is zero
5150 no lines are checked. See |modeline|.
5151
5152 *'modelineexpr'* *'mle'* *'nomodelineexpr'* *'nomle'*
5153'modelineexpr' 'mle' boolean (default: off)
5154 global
5155 When on allow some options that are an expression to be set in the
5156 modeline. Check the option for whether it is affected by
5157 'modelineexpr'. Also see |modeline|.
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02005158 This option cannot be set from a |modeline| or in the |sandbox|, for
5159 security reasons.
Bram Moolenaar110289e2019-05-23 15:38:06 +02005160
Bram Moolenaar071d4272004-06-13 20:20:40 +00005161 *'modelines'* *'mls'*
5162'modelines' 'mls' number (default 5)
5163 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005164 If 'modeline' is on 'modelines' gives the number of lines that is
5165 checked for set commands. If 'modeline' is off or 'modelines' is zero
5166 no lines are checked. See |modeline|.
5167 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
5168 set and to the Vim default value when 'compatible' is reset.
5169
5170 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
Bram Moolenaar110289e2019-05-23 15:38:06 +02005171 *E21*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005172'modifiable' 'ma' boolean (default on)
5173 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005174 When off the buffer contents cannot be changed. The 'fileformat' and
5175 'fileencoding' options also can't be changed.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01005176 Can be reset on startup with the |-M| command line argument.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005177
5178 *'modified'* *'mod'* *'nomodified'* *'nomod'*
5179'modified' 'mod' boolean (default off)
5180 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005181 When on, the buffer is considered to be modified. This option is set
5182 when:
5183 1. A change was made to the text since it was last written. Using the
5184 |undo| command to go back to the original text will reset the
5185 option. But undoing changes that were made before writing the
5186 buffer will set the option again, since the text is different from
5187 when it was written.
5188 2. 'fileformat' or 'fileencoding' is different from its original
5189 value. The original value is set when the buffer is read or
5190 written. A ":set nomodified" command also resets the original
5191 values to the current values and the 'modified' option will be
5192 reset.
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01005193 Similarly for 'eol' and 'bomb'.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02005194 This option is not set when a change is made to the buffer as the
5195 result of a BufNewFile, BufRead/BufReadPost, BufWritePost,
5196 FileAppendPost or VimLeave autocommand event. See |gzip-example| for
5197 an explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005198 When 'buftype' is "nowrite" or "nofile" this option may be set, but
5199 will be ignored.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01005200 Note that the text may actually be the same, e.g. 'modified' is set
5201 when using "rA" on an "A".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005202
5203 *'more'* *'nomore'*
5204'more' boolean (Vim default: on, Vi default: off)
5205 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005206 When on, listings pause when the whole screen is filled. You will get
5207 the |more-prompt|. When this option is off there are no pauses, the
5208 listing continues until finished.
5209 NOTE: This option is set to the Vi default value when 'compatible' is
5210 set and to the Vim default value when 'compatible' is reset.
5211
5212 *'mouse'* *E538*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005213'mouse' string (default "", "a" for GUI and Win32,
Bram Moolenaar5b418992019-10-27 18:50:25 +01005214 set to "a" or "nvi" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005215 global
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005216 Enable the use of the mouse. Works for most terminals (xterm, Win32
5217 |win32-mouse|, QNX pterm, *BSD console with sysmouse and Linux console
5218 with gpm). For using the mouse in the GUI, see |gui-mouse|. The
5219 mouse can be enabled for different modes:
Bram Moolenaar7f2e9d72017-11-11 20:58:53 +01005220 n Normal mode and Terminal modes
Bram Moolenaar071d4272004-06-13 20:20:40 +00005221 v Visual mode
5222 i Insert mode
5223 c Command-line mode
5224 h all previous modes when editing a help file
5225 a all previous modes
5226 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005227 Normally you would enable the mouse in all five modes with: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005228 :set mouse=a
Bram Moolenaar5b418992019-10-27 18:50:25 +01005229< If your terminal can't overrule the mouse events going to the
5230 application, use: >
5231 :set mouse=nvi
5232< The you can press ":", select text for the system, and press Esc to go
5233 back to Vim using the mouse events.
5234 In |defaults.vim| "nvi" is used if the 'term' option is not matching
5235 "xterm".
5236
5237 When the mouse is not enabled, the GUI will still use the mouse for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005238 modeless selection. This doesn't move the text cursor.
5239
5240 See |mouse-using|. Also see |'clipboard'|.
5241
5242 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005243 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005244 the mouse buttons can still be used by keeping the shift key pressed.
5245 Also see the 'clipboard' option.
5246
5247 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
5248'mousefocus' 'mousef' boolean (default off)
5249 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005250 {only works in the GUI}
5251 The window that the mouse pointer is on is automatically activated.
5252 When changing the window layout or window focus in another way, the
5253 mouse pointer is moved to the window with keyboard focus. Off is the
5254 default because it makes using the pull down menus a little goofy, as
5255 a pointer transit may activate a window unintentionally.
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01005256 MS-Windows: Also see 'scrollfocus' for what window is scrolled when
Bram Moolenaar1d9215b2020-01-25 13:27:42 +01005257 using the mouse scroll wheel.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005258
5259 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
5260'mousehide' 'mh' boolean (default on)
5261 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005262 {only works in the GUI}
5263 When on, the mouse pointer is hidden when characters are typed.
5264 The mouse pointer is restored when the mouse is moved.
5265
5266 *'mousemodel'* *'mousem'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005267'mousemodel' 'mousem' string (default "extend", "popup" for Win32)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005268 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005269 Sets the model to use for the mouse. The name mostly specifies what
5270 the right mouse button is used for:
5271 extend Right mouse button extends a selection. This works
5272 like in an xterm.
5273 popup Right mouse button pops up a menu. The shifted left
5274 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00005275 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005276 popup_setpos Like "popup", but the cursor will be moved to the
5277 position where the mouse was clicked, and thus the
5278 selected operation will act upon the clicked object.
5279 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00005280 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005281 course, that right clicking outside a selection will
5282 end Visual mode.
5283 Overview of what button does what for each model:
5284 mouse extend popup(_setpos) ~
5285 left click place cursor place cursor
5286 left drag start selection start selection
5287 shift-left search word extend selection
5288 right click extend selection popup menu (place cursor)
5289 right drag extend selection -
5290 middle click paste paste
5291
5292 In the "popup" model the right mouse button produces a pop-up menu.
5293 You need to define this first, see |popup-menu|.
5294
5295 Note that you can further refine the meaning of buttons with mappings.
5296 See |gui-mouse-mapping|. But mappings are NOT used for modeless
5297 selection (because that's handled in the GUI code directly).
5298
5299 The 'mousemodel' option is set by the |:behave| command.
5300
5301 *'mouseshape'* *'mouses'* *E547*
Bram Moolenaarf6b40102019-02-22 15:24:03 +01005302'mouseshape' 'mouses' string (default "i-r:beam,s:updown,sd:udsizing,
5303 vs:leftright,vd:lrsizing,m:no,
5304 ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005305 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005306 {only available when compiled with the |+mouseshape|
5307 feature}
5308 This option tells Vim what the mouse pointer should look like in
5309 different modes. The option is a comma separated list of parts, much
5310 like used for 'guicursor'. Each part consist of a mode/location-list
5311 and an argument-list:
5312 mode-list:shape,mode-list:shape,..
5313 The mode-list is a dash separated list of these modes/locations:
5314 In a normal window: ~
5315 n Normal mode
5316 v Visual mode
5317 ve Visual mode with 'selection' "exclusive" (same as 'v',
5318 if not specified)
5319 o Operator-pending mode
5320 i Insert mode
5321 r Replace mode
5322
5323 Others: ~
5324 c appending to the command-line
5325 ci inserting in the command-line
5326 cr replacing in the command-line
5327 m at the 'Hit ENTER' or 'More' prompts
5328 ml idem, but cursor in the last line
5329 e any mode, pointer below last window
5330 s any mode, pointer on a status line
5331 sd any mode, while dragging a status line
5332 vs any mode, pointer on a vertical separator line
5333 vd any mode, while dragging a vertical separator line
5334 a everywhere
5335
5336 The shape is one of the following:
5337 avail name looks like ~
5338 w x arrow Normal mouse pointer
5339 w x blank no pointer at all (use with care!)
5340 w x beam I-beam
5341 w x updown up-down sizing arrows
5342 w x leftright left-right sizing arrows
5343 w x busy The system's usual busy pointer
5344 w x no The system's usual 'no input' pointer
5345 x udsizing indicates up-down resizing
5346 x lrsizing indicates left-right resizing
5347 x crosshair like a big thin +
5348 x hand1 black hand
5349 x hand2 white hand
5350 x pencil what you write with
5351 x question big ?
5352 x rightup-arrow arrow pointing right-up
5353 w x up-arrow arrow pointing up
5354 x <number> any X11 pointer number (see X11/cursorfont.h)
5355
5356 The "avail" column contains a 'w' if the shape is available for Win32,
5357 x for X11.
5358 Any modes not specified or shapes not available use the normal mouse
5359 pointer.
5360
5361 Example: >
5362 :set mouseshape=s:udsizing,m:no
5363< will make the mouse turn to a sizing arrow over the status lines and
5364 indicate no input when the hit-enter prompt is displayed (since
5365 clicking the mouse has no effect in this state.)
5366
5367 *'mousetime'* *'mouset'*
5368'mousetime' 'mouset' number (default 500)
5369 global
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005370 Only for GUI, Win32 and Unix with xterm. Defines the maximum
Bram Moolenaar071d4272004-06-13 20:20:40 +00005371 time in msec between two mouse clicks for the second click to be
5372 recognized as a multi click.
5373
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005374 *'mzschemedll'*
5375'mzschemedll' string (default depends on the build)
5376 global
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005377 {only available when compiled with the |+mzscheme/dyn|
5378 feature}
5379 Specifies the name of the MzScheme shared library. The default is
5380 DYNAMIC_MZSCH_DLL which was specified at compile time.
5381 Environment variables are expanded |:set_env|.
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01005382 The value must be set in the |vimrc| script or earlier. In the
Bram Moolenaar01164a62017-11-02 22:58:42 +01005383 startup, before the |load-plugins| step.
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005384 This option cannot be set from a |modeline| or in the |sandbox|, for
5385 security reasons.
5386
5387 *'mzschemegcdll'*
5388'mzschemegcdll' string (default depends on the build)
5389 global
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005390 {only available when compiled with the |+mzscheme/dyn|
5391 feature}
5392 Specifies the name of the MzScheme GC shared library. The default is
5393 DYNAMIC_MZGC_DLL which was specified at compile time.
5394 The value can be equal to 'mzschemedll' if it includes the GC code.
5395 Environment variables are expanded |:set_env|.
5396 This option cannot be set from a |modeline| or in the |sandbox|, for
5397 security reasons.
5398
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005399 *'mzquantum'* *'mzq'*
5400'mzquantum' 'mzq' number (default 100)
5401 global
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005402 {not available when compiled without the |+mzscheme|
5403 feature}
5404 The number of milliseconds between polls for MzScheme threads.
5405 Negative or zero value means no thread scheduling.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005406 NOTE: This option is set to the Vim default value when 'compatible'
5407 is reset.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005408
Bram Moolenaar071d4272004-06-13 20:20:40 +00005409 *'nrformats'* *'nf'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02005410'nrformats' 'nf' string (default "bin,octal,hex",
5411 set to "bin,hex" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005412 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005413 This defines what bases Vim will consider for numbers when using the
5414 CTRL-A and CTRL-X commands for adding to and subtracting from a number
5415 respectively; see |CTRL-A| for more info on these commands.
Bram Moolenaar4770d092006-01-12 23:22:24 +00005416 alpha If included, single alphabetical characters will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005417 incremented or decremented. This is useful for a list with a
Bram Moolenaar3848e002016-03-19 18:42:29 +01005418 letter index a), b), etc. *octal-nrformats*
Bram Moolenaar4770d092006-01-12 23:22:24 +00005419 octal If included, numbers that start with a zero will be considered
Bram Moolenaar071d4272004-06-13 20:20:40 +00005420 to be octal. Example: Using CTRL-A on "007" results in "010".
Bram Moolenaar4770d092006-01-12 23:22:24 +00005421 hex If included, numbers starting with "0x" or "0X" will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005422 considered to be hexadecimal. Example: Using CTRL-X on
5423 "0x100" results in "0x0ff".
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005424 bin If included, numbers starting with "0b" or "0B" will be
5425 considered to be binary. Example: Using CTRL-X on
5426 "0b1000" subtracts one, resulting in "0b0111".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005427 Numbers which simply begin with a digit in the range 1-9 are always
5428 considered decimal. This also happens for numbers that are not
5429 recognized as octal or hex.
5430
5431 *'number'* *'nu'* *'nonumber'* *'nonu'*
5432'number' 'nu' boolean (default off)
5433 local to window
5434 Print the line number in front of each line. When the 'n' option is
5435 excluded from 'cpoptions' a wrapped line will not use the column of
5436 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005437 The 'numberwidth' option can be used to set the room used for the line
5438 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005439 When a long, wrapped line doesn't start with the first character, '-'
5440 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02005441 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
5442 the number.
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005443 *number_relativenumber*
5444 The 'relativenumber' option changes the displayed number to be
5445 relative to the cursor. Together with 'number' there are these
5446 four combinations (cursor in line 3):
5447
Bram Moolenaar3848e002016-03-19 18:42:29 +01005448 'nonu' 'nu' 'nonu' 'nu'
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005449 'nornu' 'nornu' 'rnu' 'rnu'
5450
5451 |apple | 1 apple | 2 apple | 2 apple
5452 |pear | 2 pear | 1 pear | 1 pear
5453 |nobody | 3 nobody | 0 nobody |3 nobody
5454 |there | 4 there | 1 there | 1 there
Bram Moolenaar071d4272004-06-13 20:20:40 +00005455
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005456 *'numberwidth'* *'nuw'*
5457'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
5458 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005459 {only available when compiled with the |+linebreak|
5460 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005461 Minimal number of columns to use for the line number. Only relevant
Bram Moolenaar64486672010-05-16 15:46:46 +02005462 when the 'number' or 'relativenumber' option is set or printing lines
5463 with a line number. Since one space is always between the number and
5464 the text, there is one less character for the number itself.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005465 The value is the minimum width. A bigger width is used when needed to
Bram Moolenaar64486672010-05-16 15:46:46 +02005466 fit the highest line number in the buffer respectively the number of
5467 rows in the window, depending on whether 'number' or 'relativenumber'
5468 is set. Thus with the Vim default of 4 there is room for a line number
5469 up to 999. When the buffer has 1000 lines five columns will be used.
Bram Moolenaarf8a07122019-07-01 22:06:07 +02005470 The minimum value is 1, the maximum value is 20.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005471 NOTE: This option is set to the Vi default value when 'compatible' is
5472 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005473
Bram Moolenaarf75a9632005-09-13 21:20:47 +00005474 *'omnifunc'* *'ofu'*
5475'omnifunc' 'ofu' string (default: empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00005476 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02005477 {not available when compiled without the |+eval|
Bram Moolenaare2c453d2019-08-21 14:37:09 +02005478 feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00005479 This option specifies a function to be used for Insert mode omni
5480 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
Bram Moolenaar280f1262006-01-30 00:14:18 +00005481 See |complete-functions| for an explanation of how the function is
5482 invoked and what it should return.
Bram Moolenaar043545e2006-10-10 16:44:07 +00005483 This option is usually set by a filetype plugin:
Bram Moolenaar9c102382006-05-03 21:26:49 +00005484 |:filetype-plugin-on|
Bram Moolenaar30b65812012-07-12 22:01:11 +02005485 This option cannot be set from a |modeline| or in the |sandbox|, for
5486 security reasons.
Bram Moolenaare344bea2005-09-01 20:46:49 +00005487
5488
Bram Moolenaar02467872007-05-06 13:22:01 +00005489 *'opendevice'* *'odev'* *'noopendevice'* *'noodev'*
Bram Moolenaar043545e2006-10-10 16:44:07 +00005490'opendevice' 'odev' boolean (default off)
5491 global
Bram Moolenaar6f345a12019-12-17 21:27:18 +01005492 {only for MS-Windows}
Bram Moolenaar043545e2006-10-10 16:44:07 +00005493 Enable reading and writing from devices. This may get Vim stuck on a
5494 device that can be opened but doesn't actually do the I/O. Therefore
5495 it is off by default.
5496 Note that on MS-Windows editing "aux.h", "lpt1.txt" and the like also
5497 result in editing a device.
5498
5499
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005500 *'operatorfunc'* *'opfunc'*
5501'operatorfunc' 'opfunc' string (default: empty)
5502 global
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005503 This option specifies a function to be called by the |g@| operator.
5504 See |:map-operator| for more info and an example.
5505
5506 This option cannot be set from a |modeline| or in the |sandbox|, for
5507 security reasons.
5508
5509
Bram Moolenaar251e1912011-06-19 05:09:16 +02005510 *'osfiletype'* *'oft'*
5511'osfiletype' 'oft' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005512 local to buffer
Bram Moolenaar251e1912011-06-19 05:09:16 +02005513 This option was supported on RISC OS, which has been removed.
5514
Bram Moolenaar071d4272004-06-13 20:20:40 +00005515
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005516 *'packpath'* *'pp'*
5517'packpath' 'pp' string (default: see 'runtimepath')
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005518 Directories used to find packages. See |packages|.
5519
5520
Bram Moolenaar071d4272004-06-13 20:20:40 +00005521 *'paragraphs'* *'para'*
Bram Moolenaar57e48462008-03-12 16:38:55 +00005522'paragraphs' 'para' string (default "IPLPPPQPP TPHPLIPpLpItpplpipbp")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005523 global
5524 Specifies the nroff macros that separate paragraphs. These are pairs
5525 of two letters (see |object-motions|).
5526
5527 *'paste'* *'nopaste'*
5528'paste' boolean (default off)
5529 global
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005530 Put Vim in Paste mode. This is useful if you want to cut or copy
5531 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005532 unexpected effects.
5533 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005534 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00005535 knows about pasting and will mostly do the right thing without 'paste'
5536 being set. The same is true for a terminal where Vim handles the
5537 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00005538 This option is reset when starting the GUI. Thus if you set it in
5539 your .vimrc it will work in a terminal, but not in the GUI. Setting
5540 'paste' in the GUI has side effects: e.g., the Paste toolbar button
5541 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005542 When the 'paste' option is switched on (also when it was already on):
5543 - mapping in Insert mode and Command-line mode is disabled
5544 - abbreviations are disabled
Bram Moolenaar071d4272004-06-13 20:20:40 +00005545 - 'autoindent' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02005546 - 'expandtab' is reset
5547 - 'formatoptions' is used like it is empty
Bram Moolenaar071d4272004-06-13 20:20:40 +00005548 - 'revins' is reset
5549 - 'ruler' is reset
5550 - 'showmatch' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02005551 - 'smartindent' is reset
5552 - 'smarttab' is reset
5553 - 'softtabstop' is set to 0
5554 - 'textwidth' is set to 0
5555 - 'wrapmargin' is set to 0
Bram Moolenaar071d4272004-06-13 20:20:40 +00005556 These options keep their value, but their effect is disabled:
Bram Moolenaar071d4272004-06-13 20:20:40 +00005557 - 'cindent'
Bram Moolenaarca635012015-09-25 20:34:21 +02005558 - 'indentexpr'
5559 - 'lisp'
Bram Moolenaar071d4272004-06-13 20:20:40 +00005560 NOTE: When you start editing another file while the 'paste' option is
5561 on, settings from the modelines or autocommands may change the
5562 settings again, causing trouble when pasting text. You might want to
5563 set the 'paste' option again.
5564 When the 'paste' option is reset the mentioned options are restored to
5565 the value before the moment 'paste' was switched from off to on.
5566 Resetting 'paste' before ever setting it does not have any effect.
5567 Since mapping doesn't work while 'paste' is active, you need to use
5568 the 'pastetoggle' option to toggle the 'paste' option with some key.
5569
5570 *'pastetoggle'* *'pt'*
5571'pastetoggle' 'pt' string (default "")
5572 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005573 When non-empty, specifies the key sequence that toggles the 'paste'
5574 option. This is like specifying a mapping: >
5575 :map {keys} :set invpaste<CR>
5576< Where {keys} is the value of 'pastetoggle'.
5577 The difference is that it will work even when 'paste' is set.
5578 'pastetoggle' works in Insert mode and Normal mode, but not in
5579 Command-line mode.
5580 Mappings are checked first, thus overrule 'pastetoggle'. However,
5581 when 'paste' is on mappings are ignored in Insert mode, thus you can do
5582 this: >
5583 :map <F10> :set paste<CR>
5584 :map <F11> :set nopaste<CR>
5585 :imap <F10> <C-O>:set paste<CR>
5586 :imap <F11> <nop>
5587 :set pastetoggle=<F11>
5588< This will make <F10> start paste mode and <F11> stop paste mode.
5589 Note that typing <F10> in paste mode inserts "<F10>", since in paste
5590 mode everything is inserted literally, except the 'pastetoggle' key
5591 sequence.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005592 When the value has several bytes 'ttimeoutlen' applies.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005593
5594 *'pex'* *'patchexpr'*
5595'patchexpr' 'pex' string (default "")
5596 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005597 {not available when compiled without the |+diff|
5598 feature}
5599 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005600 the resulting new version of the file. See |diff-patchexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005601
Bram Moolenaardbc28022014-07-26 13:40:44 +02005602 *'patchmode'* *'pm'* *E205* *E206*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005603'patchmode' 'pm' string (default "")
5604 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005605 When non-empty the oldest version of a file is kept. This can be used
5606 to keep the original version of a file if you are changing files in a
5607 source distribution. Only the first time that a file is written a
5608 copy of the original file will be kept. The name of the copy is the
5609 name of the original file with the string in the 'patchmode' option
5610 appended. This option should start with a dot. Use a string like
Bram Moolenaardf980db2017-12-24 13:22:00 +01005611 ".orig" or ".org". 'backupdir' must not be empty for this to work
5612 (Detail: The backup file is renamed to the patchmode file after the
5613 new file has been successfully written, that's why it must be possible
5614 to write a backup file). If there was no file to be backed up, an
5615 empty file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005616 When the 'backupskip' pattern matches, a patchmode file is not made.
5617 Using 'patchmode' for compressed files appends the extension at the
5618 end (e.g., "file.gz.orig"), thus the resulting name isn't always
5619 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005620 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005621
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01005622 *'path'* *'pa'* *E343* *E345* *E347* *E854*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005623'path' 'pa' string (default on Unix: ".,/usr/include,,"
Bram Moolenaar071d4272004-06-13 20:20:40 +00005624 other systems: ".,,")
5625 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005626 This is a list of directories which will be searched when using the
Bram Moolenaarc236c162008-07-13 17:41:49 +00005627 |gf|, [f, ]f, ^Wf, |:find|, |:sfind|, |:tabfind| and other commands,
5628 provided that the file being searched for has a relative path (not
5629 starting with "/", "./" or "../"). The directories in the 'path'
5630 option may be relative or absolute.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005631 - Use commas to separate directory names: >
5632 :set path=.,/usr/local/include,/usr/include
5633< - Spaces can also be used to separate directory names (for backwards
5634 compatibility with version 3.0). To have a space in a directory
5635 name, precede it with an extra backslash, and escape the space: >
5636 :set path=.,/dir/with\\\ space
5637< - To include a comma in a directory name precede it with an extra
5638 backslash: >
5639 :set path=.,/dir/with\\,comma
5640< - To search relative to the directory of the current file, use: >
5641 :set path=.
5642< - To search in the current directory use an empty string between two
5643 commas: >
5644 :set path=,,
5645< - A directory name may end in a ':' or '/'.
5646 - Environment variables are expanded |:set_env|.
5647 - When using |netrw.vim| URLs can be used. For example, adding
5648 "http://www.vim.org" will make ":find index.html" work.
Bram Moolenaarc236c162008-07-13 17:41:49 +00005649 - Search upwards and downwards in a directory tree using "*", "**" and
5650 ";". See |file-searching| for info and syntax.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005651 {not available when compiled without the |+path_extra| feature}
5652 - Careful with '\' characters, type two to get one in the option: >
5653 :set path=.,c:\\include
5654< Or just use '/' instead: >
5655 :set path=.,c:/include
5656< Don't forget "." or files won't even be found in the same directory as
5657 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005658 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00005659 it is something like 256 or 1024 characters.
5660 You can check if all the include files are found, using the value of
5661 'path', see |:checkpath|.
5662 The use of |:set+=| and |:set-=| is preferred when adding or removing
5663 directories from the list. This avoids problems when a future version
5664 uses another default. To remove the current directory use: >
5665 :set path-=
5666< To add the current directory use: >
5667 :set path+=
5668< To use an environment variable, you probably need to replace the
5669 separator. Here is an example to append $INCL, in which directory
5670 names are separated with a semi-colon: >
5671 :let &path = &path . "," . substitute($INCL, ';', ',', 'g')
5672< Replace the ';' with a ':' or whatever separator is used. Note that
5673 this doesn't work when $INCL contains a comma or white space.
5674
Bram Moolenaar37c64c72017-09-19 22:06:03 +02005675 *'perldll'*
5676'perldll' string (default depends on the build)
5677 global
Bram Moolenaar37c64c72017-09-19 22:06:03 +02005678 {only available when compiled with the |+perl/dyn|
5679 feature}
5680 Specifies the name of the Perl shared library. The default is
5681 DYNAMIC_PERL_DLL, which was specified at compile time.
5682 Environment variables are expanded |:set_env|.
5683 This option cannot be set from a |modeline| or in the |sandbox|, for
5684 security reasons.
5685
Bram Moolenaar071d4272004-06-13 20:20:40 +00005686 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
5687'preserveindent' 'pi' boolean (default off)
5688 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005689 When changing the indent of the current line, preserve as much of the
5690 indent structure as possible. Normally the indent is replaced by a
5691 series of tabs followed by spaces as required (unless |'expandtab'| is
5692 enabled, in which case only spaces are used). Enabling this option
5693 means the indent will preserve as many existing characters as possible
5694 for indenting, and only add additional tabs or spaces as required.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005695 'expandtab' does not apply to the preserved white space, a Tab remains
5696 a Tab.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005697 NOTE: When using ">>" multiple times the resulting indent is a mix of
5698 tabs and spaces. You might not like this.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005699 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005700 Also see 'copyindent'.
5701 Use |:retab| to clean up white space.
5702
5703 *'previewheight'* *'pvh'*
5704'previewheight' 'pvh' number (default 12)
5705 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02005706 {not available when compiled without the |+quickfix|
5707 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005708 Default height for a preview window. Used for |:ptag| and associated
Bram Moolenaar79648732019-07-18 21:43:07 +02005709 commands. Used for |CTRL-W_}| when no count is given. Not used when
5710 'previewpopup' is set.
5711
5712 *'previewpopup'* *'pvp'*
5713'previewpopup' 'pvp' string (default empty)
5714 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02005715 {not available when compiled without the |+textprop|
5716 or |+quickfix| feature}
Bram Moolenaar79648732019-07-18 21:43:07 +02005717 When not empty a popup window is used for commands that would open a
5718 preview window. See |preview-popup|.
Bram Moolenaar576a4a62019-08-18 15:25:17 +02005719 Not used for the insert completion info, add "popup" to
5720 'completeopt' for that.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005721
5722 *'previewwindow'* *'nopreviewwindow'*
5723 *'pvw'* *'nopvw'* *E590*
5724'previewwindow' 'pvw' boolean (default off)
5725 local to window
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02005726 {not available when compiled without the |+quickfix|
5727 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005728 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00005729 set. It's normally not set directly, but by using one of the commands
5730 |:ptag|, |:pedit|, etc.
5731
5732 *'printdevice'* *'pdev'*
5733'printdevice' 'pdev' string (default empty)
5734 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005735 {only available when compiled with the |+printer|
5736 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005737 The name of the printer to be used for |:hardcopy|.
5738 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005739 This option cannot be set from a |modeline| or in the |sandbox|, for
5740 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005741
Bram Moolenaar8299df92004-07-10 09:47:34 +00005742 *'printencoding'* *'penc'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005743'printencoding' 'penc' string (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005744 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005745 {only available when compiled with the |+printer|
5746 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005747 Sets the character encoding used when printing.
5748 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005749
5750 *'printexpr'* *'pexpr'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005751'printexpr' 'pexpr' string (default: see below)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005752 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005753 {only available when compiled with the |+printer|
5754 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005755 Expression used to print the PostScript produced with |:hardcopy|.
5756 See |pexpr-option|.
Bram Moolenaar51628222016-12-01 23:03:28 +01005757 This option cannot be set from a |modeline| or in the |sandbox|, for
5758 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005759
Bram Moolenaar8299df92004-07-10 09:47:34 +00005760 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005761'printfont' 'pfn' string (default "courier")
5762 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005763 {only available when compiled with the |+printer|
5764 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005765 The name of the font that will be used for |:hardcopy|.
5766 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005767
5768 *'printheader'* *'pheader'*
5769'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
5770 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005771 {only available when compiled with the |+printer|
5772 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005773 The format of the header produced in |:hardcopy| output.
5774 See |pheader-option|.
5775
5776 *'printmbcharset'* *'pmbcs'*
5777'printmbcharset' 'pmbcs' string (default "")
5778 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01005779 {only available when compiled with the |+printer|
5780 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005781 The CJK character set to be used for CJK output from |:hardcopy|.
5782 See |pmbcs-option|.
5783
5784 *'printmbfont'* *'pmbfn'*
5785'printmbfont' 'pmbfn' string (default "")
5786 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01005787 {only available when compiled with the |+printer|
5788 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005789 List of font names to be used for CJK output from |:hardcopy|.
5790 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005791
5792 *'printoptions'* *'popt'*
5793'printoptions' 'popt' string (default "")
5794 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005795 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005796 List of items that control the format of the output of |:hardcopy|.
5797 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005798
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005799 *'prompt'* *'noprompt'*
5800'prompt' boolean (default on)
5801 global
5802 When on a ":" prompt is used in Ex mode.
5803
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005804 *'pumheight'* *'ph'*
5805'pumheight' 'ph' number (default 0)
5806 global
Bram Moolenaar06a89a52006-04-29 22:01:03 +00005807 Determines the maximum number of items to show in the popup menu for
5808 Insert mode completion. When zero as much space as available is used.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005809 |ins-completion-menu|.
5810
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01005811 *'pumwidth'* *'pw'*
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005812'pumwidth' 'pw' number (default 15)
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01005813 global
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01005814 Determines the minimum width to use for the popup menu for Insert mode
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005815 completion. |ins-completion-menu|.
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01005816
Bram Moolenaard94464e2015-11-02 15:28:18 +01005817 *'pythondll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01005818'pythondll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01005819 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01005820 {only available when compiled with the |+python/dyn|
5821 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005822 Specifies the name of the Python 2.x shared library. The default is
5823 DYNAMIC_PYTHON_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005824 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01005825 This option cannot be set from a |modeline| or in the |sandbox|, for
5826 security reasons.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005827
Bram Moolenaar94073162018-01-31 21:49:05 +01005828 *'pythonhome'*
5829'pythonhome' string (default "")
5830 global
Bram Moolenaar94073162018-01-31 21:49:05 +01005831 {only available when compiled with the |+python/dyn|
5832 feature}
5833 Specifies the name of the Python 2.x home directory. When 'pythonhome'
5834 and the PYTHONHOME environment variable are not set, PYTHON_HOME,
5835 which was specified at compile time, will be used for the Python 2.x
5836 home directory.
5837 Environment variables are expanded |:set_env|.
5838 This option cannot be set from a |modeline| or in the |sandbox|, for
5839 security reasons.
5840
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005841 *'pythonthreedll'*
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005842'pythonthreedll' string (default depends on the build)
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005843 global
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005844 {only available when compiled with the |+python3/dyn|
5845 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005846 Specifies the name of the Python 3 shared library. The default is
5847 DYNAMIC_PYTHON3_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005848 Environment variables are expanded |:set_env|.
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005849 This option cannot be set from a |modeline| or in the |sandbox|, for
5850 security reasons.
5851
Bram Moolenaar94073162018-01-31 21:49:05 +01005852 *'pythonthreehome'*
5853'pythonthreehome' string (default "")
5854 global
Bram Moolenaar94073162018-01-31 21:49:05 +01005855 {only available when compiled with the |+python3/dyn|
5856 feature}
5857 Specifies the name of the Python 3 home directory. When
5858 'pythonthreehome' and the PYTHONHOME environment variable are not set,
5859 PYTHON3_HOME, which was specified at compile time, will be used for
5860 the Python 3 home directory.
5861 Environment variables are expanded |:set_env|.
5862 This option cannot be set from a |modeline| or in the |sandbox|, for
5863 security reasons.
5864
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01005865 *'pyxversion'* *'pyx'*
5866'pyxversion' 'pyx' number (default depends on the build)
5867 global
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01005868 {only available when compiled with the |+python| or
5869 the |+python3| feature}
5870 Specifies the python version used for pyx* functions and commands
5871 |python_x|. The default value is as follows:
5872
5873 Compiled with Default ~
5874 |+python| and |+python3| 0
5875 only |+python| 2
5876 only |+python3| 3
5877
5878 Available values are 0, 2 and 3.
5879 If 'pyxversion' is 0, it is set to 2 or 3 after the first execution of
5880 any python2/3 commands or functions. E.g. `:py` sets to 2, and `:py3`
5881 sets to 3. `:pyx` sets it to 3 if Python 3 is available, otherwise sets
5882 to 2 if Python 2 is available.
5883 See also: |has-pythonx|
5884
5885 If Vim is compiled with only |+python| or |+python3| setting
5886 'pyxversion' has no effect. The pyx* functions and commands are
5887 always the same as the compiled version.
5888
5889 This option cannot be set from a |modeline| or in the |sandbox|, for
5890 security reasons.
5891
Bram Moolenaar677ee682005-01-27 14:41:15 +00005892 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005893'quoteescape' 'qe' string (default "\")
5894 local to buffer
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005895 The characters that are used to escape quotes in a string. Used for
5896 objects like a', a" and a` |a'|.
5897 When one of the characters in this option is found inside a string,
5898 the following character will be skipped. The default value makes the
5899 text "foo\"bar\\" considered to be one string.
5900
Bram Moolenaar071d4272004-06-13 20:20:40 +00005901 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
5902'readonly' 'ro' boolean (default off)
5903 local to buffer
5904 If on, writes fail unless you use a '!'. Protects you from
5905 accidentally overwriting a file. Default on when Vim is started
5906 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005907 When using ":w!" the 'readonly' option is reset for the current
5908 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar6c60f472019-04-28 16:00:35 +02005909 When using the ":view" command the 'readonly' option is set for the
5910 newly edited buffer.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01005911 See 'modifiable' for disallowing changes to the buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005912
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005913 *'redrawtime'* *'rdt'*
5914'redrawtime' 'rdt' number (default 2000)
5915 global
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005916 {only available when compiled with the |+reltime|
5917 feature}
5918 The time in milliseconds for redrawing the display. This applies to
Bram Moolenaar15142e22018-04-30 22:19:58 +02005919 searching for patterns for 'hlsearch', |:match| highlighting and syntax
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02005920 highlighting.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005921 When redrawing takes more than this many milliseconds no further
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02005922 matches will be highlighted.
5923 For syntax highlighting the time applies per window. When over the
5924 limit syntax highlighting is disabled until |CTRL-L| is used.
5925 This is used to avoid that Vim hangs when using a very complicated
5926 pattern.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005927
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02005928 *'regexpengine'* *'re'*
Bram Moolenaare6ae6222013-05-21 21:01:10 +02005929'regexpengine' 're' number (default 0)
5930 global
Bram Moolenaare6ae6222013-05-21 21:01:10 +02005931 This selects the default regexp engine. |two-engines|
5932 The possible values are:
5933 0 automatic selection
5934 1 old engine
5935 2 NFA engine
5936 Note that when using the NFA engine and the pattern contains something
5937 that is not supported the pattern will not match. This is only useful
5938 for debugging the regexp engine.
Bram Moolenaarfda37292014-11-05 14:27:36 +01005939 Using automatic selection enables Vim to switch the engine, if the
5940 default engine becomes too costly. E.g., when the NFA engine uses too
5941 many states. This should prevent Vim from hanging on a combination of
5942 a complex pattern with long text.
Bram Moolenaare6ae6222013-05-21 21:01:10 +02005943
Bram Moolenaar64486672010-05-16 15:46:46 +02005944 *'relativenumber'* *'rnu'* *'norelativenumber'* *'nornu'*
5945'relativenumber' 'rnu' boolean (default off)
5946 local to window
Bram Moolenaar64486672010-05-16 15:46:46 +02005947 Show the line number relative to the line with the cursor in front of
Bram Moolenaar06b5d512010-05-22 15:37:44 +02005948 each line. Relative line numbers help you use the |count| you can
Bram Moolenaar64486672010-05-16 15:46:46 +02005949 precede some vertical motion commands (e.g. j k + -) with, without
5950 having to calculate it yourself. Especially useful in combination with
5951 other commands (e.g. y d c < > gq gw =).
5952 When the 'n' option is excluded from 'cpoptions' a wrapped
5953 line will not use the column of line numbers (this is the default when
5954 'compatible' isn't set).
5955 The 'numberwidth' option can be used to set the room used for the line
5956 number.
5957 When a long, wrapped line doesn't start with the first character, '-'
5958 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02005959 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
5960 the number.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01005961
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005962 The number in front of the cursor line also depends on the value of
5963 'number', see |number_relativenumber| for all combinations of the two
5964 options.
Bram Moolenaar64486672010-05-16 15:46:46 +02005965
Bram Moolenaar071d4272004-06-13 20:20:40 +00005966 *'remap'* *'noremap'*
5967'remap' boolean (default on)
5968 global
5969 Allows for mappings to work recursively. If you do not want this for
5970 a single entry, use the :noremap[!] command.
Bram Moolenaara3227e22006-03-08 21:32:40 +00005971 NOTE: To avoid portability problems with Vim scripts, always keep
5972 this option at the default "on". Only switch it off when working with
5973 old Vi scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005974
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02005975 *'renderoptions'* *'rop'*
5976'renderoptions' 'rop' string (default: empty)
5977 global
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02005978 {only available when compiled with GUI and DIRECTX on
5979 MS-Windows}
5980 Select a text renderer and set its options. The options depend on the
5981 renderer.
5982
5983 Syntax: >
5984 set rop=type:{renderer}(,{name}:{value})*
5985<
5986 Currently, only one optional renderer is available.
5987
5988 render behavior ~
5989 directx Vim will draw text using DirectX (DirectWrite). It makes
5990 drawn glyphs more beautiful than default GDI.
5991 It requires 'encoding' is "utf-8", and only works on
5992 MS-Windows Vista or newer version.
5993
5994 Options:
5995 name meaning type value ~
5996 gamma gamma float 1.0 - 2.2 (maybe)
5997 contrast enhancedContrast float (unknown)
5998 level clearTypeLevel float (unknown)
5999 geom pixelGeometry int 0 - 2 (see below)
6000 renmode renderingMode int 0 - 6 (see below)
6001 taamode textAntialiasMode int 0 - 3 (see below)
Bram Moolenaara338adc2018-01-31 20:51:47 +01006002 scrlines Scroll Lines int (deprecated)
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006003
Bram Moolenaar92467d32017-12-05 13:22:16 +01006004 See this URL for detail (except for scrlines):
6005 https://msdn.microsoft.com/en-us/library/dd368190.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006006
6007 For geom: structure of a device pixel.
6008 0 - DWRITE_PIXEL_GEOMETRY_FLAT
6009 1 - DWRITE_PIXEL_GEOMETRY_RGB
6010 2 - DWRITE_PIXEL_GEOMETRY_BGR
6011
6012 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006013 https://msdn.microsoft.com/en-us/library/dd368114.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006014
6015 For renmode: method of rendering glyphs.
6016 0 - DWRITE_RENDERING_MODE_DEFAULT
6017 1 - DWRITE_RENDERING_MODE_ALIASED
6018 2 - DWRITE_RENDERING_MODE_GDI_CLASSIC
6019 3 - DWRITE_RENDERING_MODE_GDI_NATURAL
6020 4 - DWRITE_RENDERING_MODE_NATURAL
6021 5 - DWRITE_RENDERING_MODE_NATURAL_SYMMETRIC
6022 6 - DWRITE_RENDERING_MODE_OUTLINE
6023
6024 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006025 https://msdn.microsoft.com/en-us/library/dd368118.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006026
6027 For taamode: antialiasing mode used for drawing text.
6028 0 - D2D1_TEXT_ANTIALIAS_MODE_DEFAULT
6029 1 - D2D1_TEXT_ANTIALIAS_MODE_CLEARTYPE
6030 2 - D2D1_TEXT_ANTIALIAS_MODE_GRAYSCALE
6031 3 - D2D1_TEXT_ANTIALIAS_MODE_ALIASED
6032
6033 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006034 https://msdn.microsoft.com/en-us/library/dd368170.aspx
6035
Bram Moolenaara338adc2018-01-31 20:51:47 +01006036 For scrlines:
6037 This was used for optimizing scrolling behavior, however this
6038 is now deprecated. If specified, it is simply ignored.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006039
6040 Example: >
6041 set encoding=utf-8
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006042 set gfn=Ricty_Diminished:h12
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006043 set rop=type:directx
6044<
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006045 If select a raster font (Courier, Terminal or FixedSys which
6046 have ".fon" extension in file name) to 'guifont', it will be
Bram Moolenaar92467d32017-12-05 13:22:16 +01006047 drawn by GDI as a fallback.
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006048
6049 NOTE: It is known that some fonts and options combination
6050 causes trouble on drawing glyphs.
6051
Bram Moolenaar92467d32017-12-05 13:22:16 +01006052 - 'renmode:5' and 'renmode:6' will not work with some
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006053 special made fonts (True-Type fonts which includes only
6054 bitmap glyphs).
6055 - 'taamode:3' will not work with some vector fonts.
6056
6057 NOTE: With this option, you can display colored emoji
6058 (emoticon) in Windows 8.1 or later. To display colored emoji,
6059 there are some conditions which you should notice.
6060
6061 - If your font includes non-colored emoji already, it will
6062 be used.
6063 - If your font doesn't have emoji, the system chooses an
6064 alternative symbol font. On Windows 10, "Segoe UI Emoji"
6065 will be used.
6066 - When this alternative font didn't have fixed width glyph,
6067 emoji might be rendered beyond the bounding box of drawing
6068 cell.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006069
6070 Other render types are currently not supported.
6071
Bram Moolenaar071d4272004-06-13 20:20:40 +00006072 *'report'*
6073'report' number (default 2)
6074 global
6075 Threshold for reporting number of lines changed. When the number of
6076 changed lines is more than 'report' a message will be given for most
6077 ":" commands. If you want it always, set 'report' to 0.
6078 For the ":substitute" command the number of substitutions is used
6079 instead of the number of lines.
6080
6081 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
6082'restorescreen' 'rs' boolean (default on)
6083 global
Bram Moolenaar8024f932020-01-14 19:29:13 +01006084 {only in MS-Windows console version}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006085 When set, the screen contents is restored when exiting Vim. This also
6086 happens when executing external commands.
6087
6088 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
6089 options in your .vimrc. To disable restoring:
6090 set t_ti= t_te=
6091 To enable restoring (for an xterm):
6092 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
6093 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
6094
6095 *'revins'* *'ri'* *'norevins'* *'nori'*
6096'revins' 'ri' boolean (default off)
6097 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006098 {only available when compiled with the |+rightleft|
6099 feature}
6100 Inserting characters in Insert mode will work backwards. See "typing
6101 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
6102 command in Insert mode, when 'allowrevins' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02006103 NOTE: This option is reset when 'compatible' is set.
6104 This option is reset when 'paste' is set and restored when 'paste' is
6105 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006106
6107 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
6108'rightleft' 'rl' boolean (default off)
6109 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006110 {only available when compiled with the |+rightleft|
6111 feature}
6112 When on, display orientation becomes right-to-left, i.e., characters
6113 that are stored in the file appear from the right to the left.
6114 Using this option, it is possible to edit files for languages that
6115 are written from the right to the left such as Hebrew and Arabic.
6116 This option is per window, so it is possible to edit mixed files
6117 simultaneously, or to view the same file in both ways (this is
6118 useful whenever you have a mixed text file with both right-to-left
6119 and left-to-right strings so that both sets are displayed properly
6120 in different windows). Also see |rileft.txt|.
6121
Bram Moolenaar607cc1e2010-07-18 18:47:44 +02006122 *'rightleftcmd'* *'rlc'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006123'rightleftcmd' 'rlc' string (default "search")
6124 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006125 {only available when compiled with the |+rightleft|
6126 feature}
6127 Each word in this option enables the command line editing to work in
6128 right-to-left mode for a group of commands:
6129
6130 search "/" and "?" commands
6131
6132 This is useful for languages such as Hebrew, Arabic and Farsi.
6133 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
6134
Bram Moolenaard94464e2015-11-02 15:28:18 +01006135 *'rubydll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01006136'rubydll' string (default: depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01006137 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01006138 {only available when compiled with the |+ruby/dyn|
6139 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006140 Specifies the name of the Ruby shared library. The default is
6141 DYNAMIC_RUBY_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006142 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01006143 This option cannot be set from a |modeline| or in the |sandbox|, for
6144 security reasons.
6145
Bram Moolenaar071d4272004-06-13 20:20:40 +00006146 *'ruler'* *'ru'* *'noruler'* *'noru'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02006147'ruler' 'ru' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006148 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006149 {not available when compiled without the
6150 |+cmdline_info| feature}
6151 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006152 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00006153 text in the file is shown on the far right:
6154 Top first line is visible
6155 Bot last line is visible
6156 All first and last line are visible
6157 45% relative position in the file
6158 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006159 Each window has its own ruler. If a window has a status line, the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006160 ruler is shown there. Otherwise it is shown in the last line of the
Bram Moolenaar582fd852005-03-28 20:58:01 +00006161 screen. If the statusline is given by 'statusline' (i.e. not empty),
Bram Moolenaar071d4272004-06-13 20:20:40 +00006162 this option takes precedence over 'ruler' and 'rulerformat'
6163 If the number of characters displayed is different from the number of
6164 bytes in the text (e.g., for a TAB or a multi-byte character), both
6165 the text column (byte number) and the screen column are shown,
6166 separated with a dash.
6167 For an empty line "0-1" is shown.
6168 For an empty buffer the line number will also be zero: "0,0-1".
Bram Moolenaarca635012015-09-25 20:34:21 +02006169 This option is reset when 'paste' is set and restored when 'paste' is
6170 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006171 If you don't want to see the ruler all the time but want to know where
6172 you are, use "g CTRL-G" |g_CTRL-G|.
6173 NOTE: This option is reset when 'compatible' is set.
6174
6175 *'rulerformat'* *'ruf'*
6176'rulerformat' 'ruf' string (default empty)
6177 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006178 {not available when compiled without the |+statusline|
6179 feature}
6180 When this option is not empty, it determines the content of the ruler
6181 string, as displayed for the 'ruler' option.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00006182 The format of this option is like that of 'statusline'.
Bram Moolenaar110289e2019-05-23 15:38:06 +02006183 This option cannot be set in a modeline when 'modelineexpr' is off.
6184
Bram Moolenaar071d4272004-06-13 20:20:40 +00006185 The default ruler width is 17 characters. To make the ruler 15
6186 characters wide, put "%15(" at the start and "%)" at the end.
6187 Example: >
6188 :set rulerformat=%15(%c%V\ %p%%%)
6189<
6190 *'runtimepath'* *'rtp'* *vimfiles*
6191'runtimepath' 'rtp' string (default:
6192 Unix: "$HOME/.vim,
6193 $VIM/vimfiles,
6194 $VIMRUNTIME,
6195 $VIM/vimfiles/after,
6196 $HOME/.vim/after"
6197 Amiga: "home:vimfiles,
6198 $VIM/vimfiles,
6199 $VIMRUNTIME,
6200 $VIM/vimfiles/after,
6201 home:vimfiles/after"
Bram Moolenaar6f345a12019-12-17 21:27:18 +01006202 PC: "$HOME/vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006203 $VIM/vimfiles,
6204 $VIMRUNTIME,
6205 $VIM/vimfiles/after,
6206 $HOME/vimfiles/after"
6207 Macintosh: "$VIM:vimfiles,
6208 $VIMRUNTIME,
6209 $VIM:vimfiles:after"
Bram Moolenaarb3f74062020-02-26 16:16:53 +01006210 Haiku: "$BE_USER_SETTINGS/vim,
6211 $VIM/vimfiles,
6212 $VIMRUNTIME,
6213 $VIM/vimfiles/after,
6214 $BE_USER_SETTINGS/vim/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006215 VMS: "sys$login:vimfiles,
6216 $VIM/vimfiles,
6217 $VIMRUNTIME,
6218 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00006219 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006220 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006221 This is a list of directories which will be searched for runtime
6222 files:
6223 filetype.vim filetypes by file name |new-filetype|
6224 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006225 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006226 colors/ color scheme files |:colorscheme|
6227 compiler/ compiler files |:compiler|
6228 doc/ documentation |write-local-help|
6229 ftplugin/ filetype plugins |write-filetype-plugin|
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01006230 import/ files that are found by `:import`
Bram Moolenaar071d4272004-06-13 20:20:40 +00006231 indent/ indent scripts |indent-expression|
6232 keymap/ key mapping files |mbyte-keymap|
6233 lang/ menu translations |:menutrans|
6234 menu.vim GUI menus |menu.vim|
Bram Moolenaar26852122016-05-24 20:02:38 +02006235 pack/ packages |:packadd|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006236 plugin/ plugin scripts |write-plugin|
6237 print/ files for printing |postscript-print-encoding|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006238 spell/ spell checking files |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006239 syntax/ syntax files |mysyntaxfile|
6240 tutor/ files for vimtutor |tutor|
6241
6242 And any other file searched for with the |:runtime| command.
6243
6244 The defaults for most systems are setup to search five locations:
6245 1. In your home directory, for your personal preferences.
6246 2. In a system-wide Vim directory, for preferences from the system
6247 administrator.
6248 3. In $VIMRUNTIME, for files distributed with Vim.
6249 *after-directory*
6250 4. In the "after" directory in the system-wide Vim directory. This is
6251 for the system administrator to overrule or add to the distributed
6252 defaults (rarely needed)
6253 5. In the "after" directory in your home directory. This is for
6254 personal preferences to overrule or add to the distributed defaults
6255 or system-wide settings (rarely needed).
6256
Bram Moolenaard0796902016-09-16 20:02:31 +02006257 More entries are added when using |packages|. If it gets very long
6258 then `:set rtp` will be truncated, use `:echo &rtp` to see the full
6259 string.
Bram Moolenaar26852122016-05-24 20:02:38 +02006260
Bram Moolenaar071d4272004-06-13 20:20:40 +00006261 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
6262 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006263 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00006264 wildcards.
6265 See |:runtime|.
6266 Example: >
6267 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
6268< This will use the directory "~/vimruntime" first (containing your
6269 personal Vim runtime files), then "/mygroup/vim" (shared between a
6270 group of people) and finally "$VIMRUNTIME" (the distributed runtime
6271 files).
6272 You probably should always include $VIMRUNTIME somewhere, to use the
6273 distributed runtime files. You can put a directory before $VIMRUNTIME
6274 to find files which replace a distributed runtime files. You can put
6275 a directory after $VIMRUNTIME to find files which add to distributed
6276 runtime files.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006277 When Vim is started with |--clean| the home directory entries are not
6278 included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006279 This option cannot be set from a |modeline| or in the |sandbox|, for
6280 security reasons.
6281
6282 *'scroll'* *'scr'*
6283'scroll' 'scr' number (default: half the window height)
6284 local to window
6285 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
6286 set to half the number of lines in the window when the window size
6287 changes. If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006288 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar25c9c682019-05-05 18:13:34 +02006289 height with ":set scroll=0".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006290
6291 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
6292'scrollbind' 'scb' boolean (default off)
6293 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006294 See also |scroll-binding|. When this option is set, the current
6295 window scrolls as other scrollbind windows (windows that also have
6296 this option set) scroll. This option is useful for viewing the
6297 differences between two versions of a file, see 'diff'.
6298 See |'scrollopt'| for options that determine how this option should be
6299 interpreted.
6300 This option is mostly reset when splitting a window to edit another
6301 file. This means that ":split | edit file" results in two windows
6302 with scroll-binding, but ":split file" does not.
6303
Bram Moolenaarae20f342019-11-05 21:09:23 +01006304 *'scrollfocus'* *'scf'* *'noscrollfocus'* *'noscf'*
6305'scrollfocus' 'scf' boolean (default off)
6306 global
6307 {only for MS-Windows GUI}
6308 When using the scroll wheel and this option is set, the window under
6309 the mouse pointer is scrolled. With this option off the current
6310 window is scrolled.
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01006311 Systems other than MS-Windows always behave like this option is on.
Bram Moolenaarae20f342019-11-05 21:09:23 +01006312
Bram Moolenaar071d4272004-06-13 20:20:40 +00006313 *'scrolljump'* *'sj'*
6314'scrolljump' 'sj' number (default 1)
6315 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006316 Minimal number of lines to scroll when the cursor gets off the
6317 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
6318 CTRL-D). Useful if your terminal scrolls very slowly.
Bram Moolenaar1e015462005-09-25 22:16:38 +00006319 When set to a negative number from -1 to -100 this is used as the
6320 percentage of the window height. Thus -50 scrolls half the window
6321 height.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006322 NOTE: This option is set to 1 when 'compatible' is set.
6323
6324 *'scrolloff'* *'so'*
Bram Moolenaar50ba5262016-09-22 22:33:02 +02006325'scrolloff' 'so' number (default 0, set to 5 in |defaults.vim|)
Bram Moolenaar375e3392019-01-31 18:26:10 +01006326 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006327 Minimal number of screen lines to keep above and below the cursor.
6328 This will make some context visible around where you are working. If
6329 you set it to a very large value (999) the cursor line will always be
6330 in the middle of the window (except at the start or end of the file or
6331 when long lines wrap).
Bram Moolenaar375e3392019-01-31 18:26:10 +01006332 After using the local value, go back the global value with one of
6333 these two: >
6334 setlocal scrolloff<
6335 setlocal scrolloff=-1
6336< For scrolling horizontally see 'sidescrolloff'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006337 NOTE: This option is set to 0 when 'compatible' is set.
6338
6339 *'scrollopt'* *'sbo'*
6340'scrollopt' 'sbo' string (default "ver,jump")
6341 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006342 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006343 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
6344 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006345 The following words are available:
6346 ver Bind vertical scrolling for 'scrollbind' windows
6347 hor Bind horizontal scrolling for 'scrollbind' windows
6348 jump Applies to the offset between two windows for vertical
6349 scrolling. This offset is the difference in the first
6350 displayed line of the bound windows. When moving
6351 around in a window, another 'scrollbind' window may
6352 reach a position before the start or after the end of
6353 the buffer. The offset is not changed though, when
6354 moving back the 'scrollbind' window will try to scroll
6355 to the desired position when possible.
6356 When now making that window the current one, two
6357 things can be done with the relative offset:
6358 1. When "jump" is not included, the relative offset is
6359 adjusted for the scroll position in the new current
6360 window. When going back to the other window, the
Bram Moolenaar02467872007-05-06 13:22:01 +00006361 new relative offset will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006362 2. When "jump" is included, the other windows are
6363 scrolled to keep the same relative offset. When
6364 going back to the other window, it still uses the
6365 same relative offset.
6366 Also see |scroll-binding|.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006367 When 'diff' mode is active there always is vertical scroll binding,
6368 even when "ver" isn't there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006369
6370 *'sections'* *'sect'*
6371'sections' 'sect' string (default "SHNHH HUnhsh")
6372 global
6373 Specifies the nroff macros that separate sections. These are pairs of
6374 two letters (See |object-motions|). The default makes a section start
6375 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
6376
6377 *'secure'* *'nosecure'* *E523*
6378'secure' boolean (default off)
6379 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006380 When on, ":autocmd", shell and write commands are not allowed in
6381 ".vimrc" and ".exrc" in the current directory and map commands are
6382 displayed. Switch it off only if you know that you will not run into
6383 problems, or when the 'exrc' option is off. On Unix this option is
6384 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006385 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00006386 'secure' at the end of your ~/.vimrc then.
6387 This option cannot be set from a |modeline| or in the |sandbox|, for
6388 security reasons.
6389
6390 *'selection'* *'sel'*
6391'selection' 'sel' string (default "inclusive")
6392 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006393 This option defines the behavior of the selection. It is only used
6394 in Visual and Select mode.
6395 Possible values:
6396 value past line inclusive ~
6397 old no yes
6398 inclusive yes yes
6399 exclusive yes no
6400 "past line" means that the cursor is allowed to be positioned one
6401 character past the line.
6402 "inclusive" means that the last character of the selection is included
6403 in an operation. For example, when "x" is used to delete the
6404 selection.
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02006405 When "old" is used and 'virtualedit' allows the cursor to move past
6406 the end of line the line break still isn't included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006407 Note that when "exclusive" is used and selecting from the end
6408 backwards, you cannot include the last character of a line, when
6409 starting in Normal mode and 'virtualedit' empty.
6410
6411 The 'selection' option is set by the |:behave| command.
6412
6413 *'selectmode'* *'slm'*
6414'selectmode' 'slm' string (default "")
6415 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006416 This is a comma separated list of words, which specifies when to start
6417 Select mode instead of Visual mode, when a selection is started.
6418 Possible values:
6419 mouse when using the mouse
6420 key when using shifted special keys
6421 cmd when using "v", "V" or CTRL-V
6422 See |Select-mode|.
6423 The 'selectmode' option is set by the |:behave| command.
6424
6425 *'sessionoptions'* *'ssop'*
6426'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006427 help,options,tabpages,winsize,terminal")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006428 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02006429 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006430 feature}
6431 Changes the effect of the |:mksession| command. It is a comma
6432 separated list of words. Each word enables saving and restoring
6433 something:
6434 word save and restore ~
6435 blank empty windows
6436 buffers hidden and unloaded buffers, not just those in windows
6437 curdir the current directory
6438 folds manually created folds, opened/closed folds and local
6439 fold options
6440 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00006441 and contain at least one lowercase letter. Only
6442 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006443 help the help window
6444 localoptions options and mappings local to a window or buffer (not
6445 global values for local options)
6446 options all options and mappings (also global values for local
6447 options)
6448 resize size of the Vim window: 'lines' and 'columns'
6449 sesdir the directory in which the session file is located
6450 will become the current directory (useful with
6451 projects accessed over a network from different
6452 systems)
6453 slash backslashes in file names replaced with forward
6454 slashes
Bram Moolenaar18144c82006-04-12 21:52:12 +00006455 tabpages all tab pages; without this only the current tab page
6456 is restored, so that you can make a session for each
6457 tab page separately
Bram Moolenaard473c8c2018-08-11 18:00:22 +02006458 terminal include terminal windows where the command can be
6459 restored
Bram Moolenaar071d4272004-06-13 20:20:40 +00006460 unix with Unix end-of-line format (single <NL>), even when
6461 on Windows or DOS
6462 winpos position of the whole Vim window
6463 winsize window sizes
6464
6465 Don't include both "curdir" and "sesdir".
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006466 When neither "curdir" nor "sesdir" is included, file names are stored
6467 with absolute paths.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006468 "slash" and "unix" are useful on Windows when sharing session files
6469 with Unix. The Unix version of Vim cannot source dos format scripts,
6470 but the Windows version of Vim can source unix format scripts.
6471
6472 *'shell'* *'sh'* *E91*
Bram Moolenaar95a9dd12019-12-19 22:12:03 +01006473'shell' 'sh' string (default $SHELL or "sh", Win32: "cmd.exe")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006474 global
6475 Name of the shell to use for ! and :! commands. When changing the
6476 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
6477 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006478 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006479 See |option-backslash| about including spaces and backslashes.
6480 Environment variables are expanded |:set_env|.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006481
Bram Moolenaar1ff14ba2019-11-02 14:09:23 +01006482 If the name of the shell contains a space, you need to enclose it in
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01006483 quotes and escape the space. Example with quotes: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006484 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
6485< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006486 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006487 "-f" is not inside the quotes, because it is not part of the command
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006488 name. Vim automagically recognizes the backslashes that are path
Bram Moolenaar071d4272004-06-13 20:20:40 +00006489 separators.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006490 Example with escaped space (Vim will do this when initializing the
6491 option from $SHELL): >
6492 :set shell=/bin/with\\\ space/sh
Bram Moolenaard473c8c2018-08-11 18:00:22 +02006493< The resulting value of 'shell' is "/bin/with\ space/sh", two
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006494 backslashes are consumed by `:set`.
6495
Bram Moolenaar071d4272004-06-13 20:20:40 +00006496 Under MS-Windows, when the executable ends in ".com" it must be
6497 included. Thus setting the shell to "command.com" or "4dos.com"
6498 works, but "command" and "4dos" do not work for all commands (e.g.,
6499 filtering).
6500 For unknown reasons, when using "4dos.com" the current directory is
6501 changed to "C:\". To avoid this set 'shell' like this: >
6502 :set shell=command.com\ /c\ 4dos
6503< This option cannot be set from a |modeline| or in the |sandbox|, for
6504 security reasons.
6505
6506 *'shellcmdflag'* *'shcf'*
Bram Moolenaar5dc62522012-02-13 00:05:22 +01006507'shellcmdflag' 'shcf' string (default: "-c";
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006508 Win32, when 'shell' does not contain "sh"
6509 somewhere: "/c")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006510 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006511 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
Bram Moolenaar8024f932020-01-14 19:29:13 +01006512 "bash.exe -c ls" or "cmd.exe /c dir". For MS-Windows, the default is
6513 set according to the value of 'shell', to reduce the need to set this
6514 option by the user.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02006515 On Unix it can have more than one flag. Each white space separated
6516 part is passed as an argument to the shell command.
6517 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006518 Also see |dos-shell| for MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006519 This option cannot be set from a |modeline| or in the |sandbox|, for
6520 security reasons.
6521
6522 *'shellpipe'* *'sp'*
Bram Moolenaar8024f932020-01-14 19:29:13 +01006523'shellpipe' 'sp' string (default ">", ">%s 2>&1", "| tee", "|& tee" or
6524 "2>&1| tee")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006525 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006526 {not available when compiled without the |+quickfix|
6527 feature}
6528 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006529 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00006530 including spaces and backslashes.
6531 The name of the temporary file can be represented by "%s" if necessary
6532 (the file name is appended automatically if no %s appears in the value
6533 of this option).
Bram Moolenaar8024f932020-01-14 19:29:13 +01006534 For the Amiga the default is ">". For MS-Windows the default is
6535 ">%s 2>&1". The output is directly saved in a file and not echoed to
6536 the screen.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006537 For Unix the default it "| tee". The stdout of the compiler is saved
6538 in a file and echoed to the screen. If the 'shell' option is "csh" or
6539 "tcsh" after initializations, the default becomes "|& tee". If the
Bram Moolenaar96f45c02019-10-26 19:53:45 +02006540 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh", "zsh-beta",
6541 "bash" or "fish" the default becomes "2>&1| tee". This means that
6542 stderr is also included. Before using the 'shell' option a path is
6543 removed, thus "/bin/sh" uses "sh".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006544 The initialization of this option is done after reading the ".vimrc"
6545 and the other initializations, so that when the 'shell' option is set
6546 there, the 'shellpipe' option changes automatically, unless it was
6547 explicitly set before.
6548 When 'shellpipe' is set to an empty string, no redirection of the
6549 ":make" output will be done. This is useful if you use a 'makeprg'
6550 that writes to 'makeef' by itself. If you want no piping, but do
6551 want to include the 'makeef', set 'shellpipe' to a single space.
6552 Don't forget to precede the space with a backslash: ":set sp=\ ".
6553 In the future pipes may be used for filtering and this option will
6554 become obsolete (at least for Unix).
6555 This option cannot be set from a |modeline| or in the |sandbox|, for
6556 security reasons.
6557
6558 *'shellquote'* *'shq'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006559'shellquote' 'shq' string (default: ""; Win32, when 'shell'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006560 contains "sh" somewhere: "\"")
6561 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006562 Quoting character(s), put around the command passed to the shell, for
6563 the "!" and ":!" commands. The redirection is kept outside of the
6564 quoting. See 'shellxquote' to include the redirection. It's
6565 probably not useful to set both options.
6566 This is an empty string by default. Only known to be useful for
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006567 third-party shells on MS-Windows-like systems, such as the MKS Korn
6568 Shell or bash, where it should be "\"". The default is adjusted
6569 according the value of 'shell', to reduce the need to set this option
6570 by the user. See |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006571 This option cannot be set from a |modeline| or in the |sandbox|, for
6572 security reasons.
6573
6574 *'shellredir'* *'srr'*
6575'shellredir' 'srr' string (default ">", ">&" or ">%s 2>&1")
6576 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006577 String to be used to put the output of a filter command in a temporary
6578 file. See also |:!|. See |option-backslash| about including spaces
6579 and backslashes.
6580 The name of the temporary file can be represented by "%s" if necessary
6581 (the file name is appended automatically if no %s appears in the value
6582 of this option).
Bram Moolenaar96f45c02019-10-26 19:53:45 +02006583 The default is ">". For Unix, if the 'shell' option is "csh" or
6584 "tcsh" during initializations, the default becomes ">&". If the
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01006585 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh", "zsh-beta",
6586 "bash" or "fish", the default becomes ">%s 2>&1". This means that
6587 stderr is also included. For Win32, the Unix checks are done and
6588 additionally "cmd" is checked for, which makes the default ">%s 2>&1".
6589 Also, the same names with ".exe" appended are checked for.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006590 The initialization of this option is done after reading the ".vimrc"
6591 and the other initializations, so that when the 'shell' option is set
6592 there, the 'shellredir' option changes automatically unless it was
6593 explicitly set before.
6594 In the future pipes may be used for filtering and this option will
6595 become obsolete (at least for Unix).
6596 This option cannot be set from a |modeline| or in the |sandbox|, for
6597 security reasons.
6598
6599 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
6600'shellslash' 'ssl' boolean (default off)
6601 global
Bram Moolenaar6f345a12019-12-17 21:27:18 +01006602 {only for MS-Windows}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006603 When set, a forward slash is used when expanding file names. This is
Bram Moolenaar8024f932020-01-14 19:29:13 +01006604 useful when a Unix-like shell is used instead of cmd.exe. Backward
6605 slashes can still be typed, but they are changed to forward slashes by
6606 Vim.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006607 Note that setting or resetting this option has no effect for some
6608 existing file names, thus this option needs to be set before opening
6609 any file for best results. This might change in the future.
6610 'shellslash' only works when a backslash can be used as a path
6611 separator. To test if this is so use: >
6612 if exists('+shellslash')
Bram Moolenaarac3150d2019-07-28 16:36:39 +02006613< Also see 'completeslash'.
6614
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006615 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
6616'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
6617 global
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006618 When on, use temp files for shell commands. When off use a pipe.
6619 When using a pipe is not possible temp files are used anyway.
Bram Moolenaar97293012011-07-18 19:40:27 +02006620 Currently a pipe is only supported on Unix and MS-Windows 2K and
6621 later. You can check it with: >
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006622 :if has("filterpipe")
6623< The advantage of using a pipe is that nobody can read the temp file
6624 and the 'shell' command does not need to support redirection.
6625 The advantage of using a temp file is that the file type and encoding
6626 can be detected.
6627 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
6628 |FilterWritePost| autocommands event are not triggered when
6629 'shelltemp' is off.
Bram Moolenaar269f5952016-07-15 22:54:41 +02006630 The `system()` function does not respect this option and always uses
6631 temp files.
Bram Moolenaar036986f2017-03-16 17:41:02 +01006632 NOTE: This option is set to the Vim default value when 'compatible'
6633 is reset.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006634
Bram Moolenaar071d4272004-06-13 20:20:40 +00006635 *'shelltype'* *'st'*
6636'shelltype' 'st' number (default 0)
6637 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02006638 {only for the Amiga}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006639 On the Amiga this option influences the way how the commands work
6640 which use a shell.
6641 0 and 1: always use the shell
6642 2 and 3: use the shell only to filter lines
6643 4 and 5: use shell only for ':sh' command
6644 When not using the shell, the command is executed directly.
6645
6646 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
6647 1 and 3: use "shell cmd" to start external commands
6648
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006649 *'shellxescape'* *'sxe'*
6650'shellxescape' 'sxe' string (default: "";
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006651 for MS-Windows: "\"&|<>()@^")
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006652 global
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006653 When 'shellxquote' is set to "(" then the characters listed in this
6654 option will be escaped with a '^' character. This makes it possible
6655 to execute most external commands with cmd.exe.
6656
Bram Moolenaar071d4272004-06-13 20:20:40 +00006657 *'shellxquote'* *'sxq'*
6658'shellxquote' 'sxq' string (default: "";
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006659 for Win32, when 'shell' is cmd.exe: "("
6660 for Win32, when 'shell' contains "sh"
6661 somewhere: "\""
Bram Moolenaar071d4272004-06-13 20:20:40 +00006662 for Unix, when using system(): "\"")
6663 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006664 Quoting character(s), put around the command passed to the shell, for
6665 the "!" and ":!" commands. Includes the redirection. See
6666 'shellquote' to exclude the redirection. It's probably not useful
6667 to set both options.
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006668 When the value is '(' then ')' is appended. When the value is '"('
6669 then ')"' is appended.
6670 When the value is '(' then also see 'shellxescape'.
Bram Moolenaara64ba222012-02-12 23:23:31 +01006671 This is an empty string by default on most systems, but is known to be
6672 useful for on Win32 version, either for cmd.exe which automatically
6673 strips off the first and last quote on a command, or 3rd-party shells
6674 such as the MKS Korn Shell or bash, where it should be "\"". The
6675 default is adjusted according the value of 'shell', to reduce the need
6676 to set this option by the user. See |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006677 This option cannot be set from a |modeline| or in the |sandbox|, for
6678 security reasons.
6679
6680 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
6681'shiftround' 'sr' boolean (default off)
6682 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006683 Round indent to multiple of 'shiftwidth'. Applies to > and <
6684 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
6685 a multiple of 'shiftwidth' (this is Vi compatible).
6686 NOTE: This option is reset when 'compatible' is set.
6687
6688 *'shiftwidth'* *'sw'*
6689'shiftwidth' 'sw' number (default 8)
6690 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006691 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00006692 |'cindent'|, |>>|, |<<|, etc.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02006693 When zero the 'ts' value will be used. Use the |shiftwidth()|
6694 function to get the effective shiftwidth value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006695
6696 *'shortmess'* *'shm'*
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02006697'shortmess' 'shm' string (Vim default "filnxtToOS", Vi default: "S",
6698 POSIX default: "AS")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006699 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006700 This option helps to avoid all the |hit-enter| prompts caused by file
6701 messages, for example with CTRL-G, and to avoid some other messages.
6702 It is a list of flags:
6703 flag meaning when present ~
6704 f use "(3 of 5)" instead of "(file 3 of 5)"
6705 i use "[noeol]" instead of "[Incomplete last line]"
6706 l use "999L, 888C" instead of "999 lines, 888 characters"
6707 m use "[+]" instead of "[Modified]"
6708 n use "[New]" instead of "[New File]"
6709 r use "[RO]" instead of "[readonly]"
6710 w use "[w]" instead of "written" for file write message
6711 and "[a]" instead of "appended" for ':w >> file' command
6712 x use "[dos]" instead of "[dos format]", "[unix]" instead of
6713 "[unix format]" and "[mac]" instead of "[mac format]".
6714 a all of the above abbreviations
6715
6716 o overwrite message for writing a file with subsequent message
6717 for reading a file (useful for ":wn" or when 'autowrite' on)
6718 O message for reading a file overwrites any previous message.
6719 Also for quickfix message (e.g., ":cn").
6720 s don't give "search hit BOTTOM, continuing at TOP" or "search
Bram Moolenaara6c27c42019-05-09 19:16:22 +02006721 hit TOP, continuing at BOTTOM" messages; when using the search
6722 count do not show "W" after the count message (see S below)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006723 t truncate file message at the start if it is too long to fit
6724 on the command-line, "<" will appear in the left most column.
6725 Ignored in Ex mode.
6726 T truncate other messages in the middle if they are too long to
Bram Moolenaar582fd852005-03-28 20:58:01 +00006727 fit on the command line. "..." will appear in the middle.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006728 Ignored in Ex mode.
6729 W don't give "written" or "[w]" when writing a file
6730 A don't give the "ATTENTION" message when an existing swap file
6731 is found.
6732 I don't give the intro message when starting Vim |:intro|.
Bram Moolenaarea389e92014-05-28 21:40:52 +02006733 c don't give |ins-completion-menu| messages. For example,
6734 "-- XXX completion (YYY)", "match 1 of 2", "The only match",
6735 "Pattern not found", "Back at original", etc.
Bram Moolenaar426dd022016-03-15 15:09:29 +01006736 q use "recording" instead of "recording @a"
6737 F don't give the file info when editing a file, like `:silent`
Bram Moolenaar110289e2019-05-23 15:38:06 +02006738 was used for the command; note that this also affects messages
6739 from autocommands
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02006740 S do not show search count message when searching, e.g.
6741 "[1/5]"
Bram Moolenaar071d4272004-06-13 20:20:40 +00006742
6743 This gives you the opportunity to avoid that a change between buffers
6744 requires you to hit <Enter>, but still gives as useful a message as
6745 possible for the space available. To get the whole message that you
6746 would have got with 'shm' empty, use ":file!"
6747 Useful values:
6748 shm= No abbreviation of message.
6749 shm=a Abbreviation, but no loss of information.
6750 shm=at Abbreviation, and truncate message when necessary.
6751
6752 NOTE: This option is set to the Vi default value when 'compatible' is
6753 set and to the Vim default value when 'compatible' is reset.
6754
6755 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
6756'shortname' 'sn' boolean (default off)
6757 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00006758 Filenames are assumed to be 8 characters plus one extension of 3
6759 characters. Multiple dots in file names are not allowed. When this
6760 option is on, dots in file names are replaced with underscores when
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006761 adding an extension (".~" or ".swp"). This option is useful
Bram Moolenaar071d4272004-06-13 20:20:40 +00006762 when editing files on an MS-DOS compatible filesystem, e.g., messydos
Bram Moolenaarade0d392020-01-21 22:33:58 +01006763 or crossdos.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006764
6765 *'showbreak'* *'sbr'* *E595*
6766'showbreak' 'sbr' string (default "")
Bram Moolenaaree857022019-11-09 23:26:40 +01006767 global or local to window |global-local|
Bram Moolenaardb84e452010-08-15 13:50:43 +02006768 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006769 feature}
6770 String to put at the start of lines that have been wrapped. Useful
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006771 values are "> " or "+++ ": >
6772 :set showbreak=>\
6773< Note the backslash to escape the trailing space. It's easier like
6774 this: >
Bram Moolenaar1a384422010-07-14 19:53:30 +02006775 :let &showbreak = '+++ '
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006776< Only printable single-cell characters are allowed, excluding <Tab> and
Bram Moolenaar071d4272004-06-13 20:20:40 +00006777 comma (in a future version the comma might be used to separate the
6778 part that is shown at the end and at the start of a line).
6779 The characters are highlighted according to the '@' flag in
6780 'highlight'.
6781 Note that tabs after the showbreak will be displayed differently.
6782 If you want the 'showbreak' to appear in between line numbers, add the
6783 "n" flag to 'cpoptions'.
Bram Moolenaaree857022019-11-09 23:26:40 +01006784 A window-local value overrules a global value. If the global value is
6785 set and you want no value in the current window use NONE: >
6786 :setlocal showbreak=NONE
6787<
Bram Moolenaar071d4272004-06-13 20:20:40 +00006788 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02006789'showcmd' 'sc' boolean (Vim default: on, off for Unix,
6790 Vi default: off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006791 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006792 {not available when compiled without the
6793 |+cmdline_info| feature}
Bram Moolenaar02467872007-05-06 13:22:01 +00006794 Show (partial) command in the last line of the screen. Set this
6795 option off if your terminal is slow.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006796 In Visual mode the size of the selected area is shown:
6797 - When selecting characters within a line, the number of characters.
Bram Moolenaarf91787c2010-07-17 12:47:16 +02006798 If the number of bytes is different it is also displayed: "2-6"
6799 means two characters and six bytes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006800 - When selecting more than one line, the number of lines.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006801 - When selecting a block, the size in screen characters:
6802 {lines}x{columns}.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006803 NOTE: This option is set to the Vi default value when 'compatible' is
6804 set and to the Vim default value when 'compatible' is reset.
6805
6806 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
6807'showfulltag' 'sft' boolean (default off)
6808 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006809 When completing a word in insert mode (see |ins-completion|) from the
6810 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006811 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00006812 matched a C function, you can see a template for what arguments are
6813 required (coding style permitting).
Bram Moolenaar446cb832008-06-24 21:56:24 +00006814 Note that this doesn't work well together with having "longest" in
6815 'completeopt', because the completion from the search pattern may not
6816 match the typed text.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006817
6818 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
6819'showmatch' 'sm' boolean (default off)
6820 global
6821 When a bracket is inserted, briefly jump to the matching one. The
6822 jump is only done if the match can be seen on the screen. The time to
6823 show the match can be set with 'matchtime'.
6824 A Beep is given if there is no match (no matter if the match can be
Bram Moolenaarca635012015-09-25 20:34:21 +02006825 seen or not).
6826 This option is reset when 'paste' is set and restored when 'paste' is
6827 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006828 When the 'm' flag is not included in 'cpoptions', typing a character
6829 will immediately move the cursor back to where it belongs.
6830 See the "sm" field in 'guicursor' for setting the cursor shape and
6831 blinking when showing the match.
6832 The 'matchpairs' option can be used to specify the characters to show
6833 matches for. 'rightleft' and 'revins' are used to look for opposite
6834 matches.
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006835 Also see the matchparen plugin for highlighting the match when moving
6836 around |pi_paren.txt|.
6837 Note: Use of the short form is rated PG.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006838
6839 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
6840'showmode' 'smd' boolean (Vim default: on, Vi default: off)
6841 global
6842 If in Insert, Replace or Visual mode put a message on the last line.
6843 Use the 'M' flag in 'highlight' to set the type of highlighting for
6844 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006845 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00006846 doesn't mean XIM is really active, especially when 'imactivatekey' is
6847 not set.
6848 NOTE: This option is set to the Vi default value when 'compatible' is
6849 set and to the Vim default value when 'compatible' is reset.
6850
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006851 *'showtabline'* *'stal'*
6852'showtabline' 'stal' number (default 1)
6853 global
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006854 The value of this option specifies when the line with tab page labels
6855 will be displayed:
6856 0: never
6857 1: only if there are at least two tab pages
6858 2: always
6859 This is both for the GUI and non-GUI implementation of the tab pages
6860 line.
6861 See |tab-page| for more information about tab pages.
6862
Bram Moolenaar071d4272004-06-13 20:20:40 +00006863 *'sidescroll'* *'ss'*
6864'sidescroll' 'ss' number (default 0)
6865 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006866 The minimal number of columns to scroll horizontally. Used only when
6867 the 'wrap' option is off and the cursor is moved off of the screen.
6868 When it is zero the cursor will be put in the middle of the screen.
6869 When using a slow terminal set it to a large number or 0. When using
6870 a fast terminal use a small number or 1. Not used for "zh" and "zl"
6871 commands.
6872
6873 *'sidescrolloff'* *'siso'*
6874'sidescrolloff' 'siso' number (default 0)
Bram Moolenaar375e3392019-01-31 18:26:10 +01006875 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006876 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00006877 right of the cursor if 'nowrap' is set. Setting this option to a
6878 value greater than 0 while having |'sidescroll'| also at a non-zero
6879 value makes some context visible in the line you are scrolling in
6880 horizontally (except at beginning of the line). Setting this option
6881 to a large value (like 999) has the effect of keeping the cursor
6882 horizontally centered in the window, as long as one does not come too
6883 close to the beginning of the line.
Bram Moolenaar375e3392019-01-31 18:26:10 +01006884 After using the local value, go back the global value with one of
6885 these two: >
6886 setlocal sidescrolloff<
6887 setlocal sidescrolloff=-1
6888< NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006889
6890 Example: Try this together with 'sidescroll' and 'listchars' as
6891 in the following example to never allow the cursor to move
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02006892 onto the "extends" character: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006893
6894 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
6895 :set sidescrolloff=1
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02006896<
6897 *'signcolumn'* *'scl'*
6898'signcolumn' 'scl' string (default "auto")
6899 local to window
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02006900 {not available when compiled without the |+signs|
6901 feature}
Bram Moolenaar09521312016-08-12 22:54:35 +02006902 Whether or not to draw the signcolumn. Valid values are:
6903 "auto" only when there is a sign to display
6904 "no" never
6905 "yes" always
Bram Moolenaar394c5d82019-06-17 21:48:05 +02006906 "number" display signs in the 'number' column. If the number
Bram Moolenaar6c1e1572019-06-22 02:13:00 +02006907 column is not present, then behaves like "auto".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006908
6909
6910 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
6911'smartcase' 'scs' boolean (default off)
6912 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006913 Override the 'ignorecase' option if the search pattern contains upper
6914 case characters. Only used when the search pattern is typed and
6915 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarc8734422012-06-01 22:38:45 +02006916 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00006917 "*" and "#" you can make 'smartcase' used by doing a "/" command,
6918 recalling the search pattern from history and hitting <Enter>.
6919 NOTE: This option is reset when 'compatible' is set.
6920
6921 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
6922'smartindent' 'si' boolean (default off)
6923 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00006924 {not available when compiled without the
6925 |+smartindent| feature}
6926 Do smart autoindenting when starting a new line. Works for C-like
6927 programs, but can also be used for other languages. 'cindent' does
6928 something like this, works better in most cases, but is more strict,
Bram Moolenaar81af9252010-12-10 20:35:50 +01006929 see |C-indenting|. When 'cindent' is on or 'indentexpr' is set,
Bram Moolenaar166af9b2010-11-16 20:34:40 +01006930 setting 'si' has no effect. 'indentexpr' is a more advanced
6931 alternative.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006932 Normally 'autoindent' should also be on when using 'smartindent'.
6933 An indent is automatically inserted:
6934 - After a line ending in '{'.
6935 - After a line starting with a keyword from 'cinwords'.
6936 - Before a line starting with '}' (only with the "O" command).
6937 When typing '}' as the first character in a new line, that line is
6938 given the same indent as the matching '{'.
6939 When typing '#' as the first character in a new line, the indent for
6940 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006941 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00006942 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
6943 When using the ">>" command, lines starting with '#' are not shifted
6944 right.
Bram Moolenaar036986f2017-03-16 17:41:02 +01006945 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02006946 This option is reset when 'paste' is set and restored when 'paste' is
6947 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006948
6949 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
6950'smarttab' 'sta' boolean (default off)
6951 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006952 When on, a <Tab> in front of a line inserts blanks according to
Bram Moolenaar280f1262006-01-30 00:14:18 +00006953 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A
6954 <BS> will delete a 'shiftwidth' worth of space at the start of the
6955 line.
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006956 When off, a <Tab> always inserts blanks according to 'tabstop' or
Bram Moolenaar280f1262006-01-30 00:14:18 +00006957 'softtabstop'. 'shiftwidth' is only used for shifting text left or
6958 right |shift-left-right|.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00006959 What gets inserted (a <Tab> or spaces) depends on the 'expandtab'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006960 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00006961 number of spaces is minimized by using <Tab>s.
Bram Moolenaarca635012015-09-25 20:34:21 +02006962 This option is reset when 'paste' is set and restored when 'paste' is
6963 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006964 NOTE: This option is reset when 'compatible' is set.
6965
6966 *'softtabstop'* *'sts'*
6967'softtabstop' 'sts' number (default 0)
6968 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00006969 Number of spaces that a <Tab> counts for while performing editing
6970 operations, like inserting a <Tab> or using <BS>. It "feels" like
6971 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
6972 used. This is useful to keep the 'ts' setting at its standard value
6973 of 8, while being able to edit like it is set to 'sts'. However,
6974 commands like "x" still work on the actual characters.
6975 When 'sts' is zero, this feature is off.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02006976 When 'sts' is negative, the value of 'shiftwidth' is used.
Bram Moolenaarca635012015-09-25 20:34:21 +02006977 'softtabstop' is set to 0 when the 'paste' option is set and restored
6978 when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006979 See also |ins-expandtab|. When 'expandtab' is not set, the number of
6980 spaces is minimized by using <Tab>s.
6981 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
6982 set.
6983 NOTE: This option is set to 0 when 'compatible' is set.
6984
Bram Moolenaar04958cb2018-06-23 19:23:02 +02006985 If Vim is compiled with the |+vartabs| feature then the value of
6986 'softtabstop' will be ignored if |'varsofttabstop'| is set to
6987 anything other than an empty string.
6988
Bram Moolenaar217ad922005-03-20 22:37:15 +00006989 *'spell'* *'nospell'*
6990'spell' boolean (default off)
6991 local to window
Bram Moolenaar217ad922005-03-20 22:37:15 +00006992 {not available when compiled without the |+syntax|
6993 feature}
6994 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006995 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00006996
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006997 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00006998'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006999 local to buffer
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007000 {not available when compiled without the |+syntax|
7001 feature}
7002 Pattern to locate the end of a sentence. The following word will be
7003 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007004 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007005 When this check is not wanted make this option empty.
7006 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00007007 Be careful with special characters, see |option-backslash| about
7008 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007009 To set this option automatically depending on the language, see
7010 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007011
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007012 *'spellfile'* *'spf'*
7013'spellfile' 'spf' string (default empty)
7014 local to buffer
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007015 {not available when compiled without the |+syntax|
7016 feature}
7017 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00007018 commands. It must end in ".{encoding}.add". You need to include the
7019 path, otherwise the file is placed in the current directory.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007020 *E765*
7021 It may also be a comma separated list of names. A count before the
7022 |zg| and |zw| commands can be used to access each. This allows using
7023 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007024 When a word is added while this option is empty Vim will set it for
Bram Moolenaar910f66f2006-04-05 20:41:53 +00007025 you: Using the first directory in 'runtimepath' that is writable. If
7026 there is no "spell" directory yet it will be created. For the file
7027 name the first language name that appears in 'spelllang' is used,
Bram Moolenaar3b506942005-06-23 22:36:45 +00007028 ignoring the region.
7029 The resulting ".spl" file will be used for spell checking, it does not
7030 have to appear in 'spelllang'.
7031 Normally one file is used for all regions, but you can add the region
7032 name if you want to. However, it will then only be used when
7033 'spellfile' is set to it, for entries in 'spelllang' only files
7034 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00007035 This option cannot be set from a |modeline| or in the |sandbox|, for
7036 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007037
Bram Moolenaar217ad922005-03-20 22:37:15 +00007038 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007039'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00007040 local to buffer
Bram Moolenaar217ad922005-03-20 22:37:15 +00007041 {not available when compiled without the |+syntax|
7042 feature}
Bram Moolenaar3b506942005-06-23 22:36:45 +00007043 A comma separated list of word list names. When the 'spell' option is
7044 on spellchecking will be done for these languages. Example: >
7045 set spelllang=en_us,nl,medical
7046< This means US English, Dutch and medical words are recognized. Words
7047 that are not recognized will be highlighted.
Bram Moolenaar911ead12019-04-21 00:03:35 +02007048 The word list name must consist of alphanumeric characters, a dash or
7049 an underscore. It should not include a comma or dot. Using a dash is
Bram Moolenaar3b506942005-06-23 22:36:45 +00007050 recommended to separate the two letter language name from a
7051 specification. Thus "en-rare" is used for rare English words.
7052 A region name must come last and have the form "_xx", where "xx" is
7053 the two-letter, lower case region name. You can use more than one
7054 region by listing them: "en_us,en_ca" supports both US and Canadian
7055 English, but not words specific for Australia, New Zealand or Great
Bram Moolenaarfa735342016-01-03 22:14:44 +01007056 Britain. (Note: currently en_au and en_nz dictionaries are older than
7057 en_ca, en_gb and en_us).
Bram Moolenaarcc63c642013-11-12 04:44:01 +01007058 If the name "cjk" is included East Asian characters are excluded from
7059 spell checking. This is useful when editing text that also has Asian
7060 words.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007061 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007062 As a special case the name of a .spl file can be given as-is. The
7063 first "_xx" in the name is removed and used as the region name
7064 (_xx is an underscore, two letters and followed by a non-letter).
7065 This is mainly for testing purposes. You must make sure the correct
7066 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007067 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007068 idea to set 'spelllang' after setting 'encoding' to avoid loading the
7069 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00007070 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007071
Bram Moolenaar98692072006-02-04 00:57:42 +00007072 If the |spellfile.vim| plugin is active and you use a language name
7073 for which Vim cannot find the .spl file in 'runtimepath' the plugin
7074 will ask you if you want to download the file.
7075
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007076 After this option has been set successfully, Vim will source the files
7077 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
Bram Moolenaarb730f0c2018-11-25 03:56:26 +01007078 up to the first character that is not an ASCII letter or number and
7079 not a dash. Also see |set-spc-auto|.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007080
7081
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007082 *'spellsuggest'* *'sps'*
7083'spellsuggest' 'sps' string (default "best")
7084 global
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007085 {not available when compiled without the |+syntax|
7086 feature}
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007087 Methods used for spelling suggestions. Both for the |z=| command and
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007088 the |spellsuggest()| function. This is a comma-separated list of
7089 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007090
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007091 best Internal method that works best for English. Finds
7092 changes like "fast" and uses a bit of sound-a-like
7093 scoring to improve the ordering.
7094
7095 double Internal method that uses two methods and mixes the
7096 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007097 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007098 word. That only works when the language specifies
7099 sound folding. Can be slow and doesn't always give
7100 better results.
7101
7102 fast Internal method that only checks for simple changes:
7103 character inserts/deletes/swaps. Works well for
7104 simple typing mistakes.
7105
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007106 {number} The maximum number of suggestions listed for |z=|.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007107 Not used for |spellsuggest()|. The number of
7108 suggestions is never more than the value of 'lines'
7109 minus two.
7110
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007111 file:{filename} Read file {filename}, which must have two columns,
7112 separated by a slash. The first column contains the
7113 bad word, the second column the suggested good word.
7114 Example:
7115 theribal/terrible ~
7116 Use this for common mistakes that do not appear at the
7117 top of the suggestion list with the internal methods.
7118 Lines without a slash are ignored, use this for
7119 comments.
Bram Moolenaarbcb98982014-05-01 14:08:19 +02007120 The word in the second column must be correct,
7121 otherwise it will not be used. Add the word to an
7122 ".add" file if it is currently flagged as a spelling
7123 mistake.
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007124 The file is used for all languages.
7125
7126 expr:{expr} Evaluate expression {expr}. Use a function to avoid
7127 trouble with spaces. |v:val| holds the badly spelled
7128 word. The expression must evaluate to a List of
7129 Lists, each with a suggestion and a score.
7130 Example:
Bram Moolenaar214641f2017-03-05 17:04:09 +01007131 [['the', 33], ['that', 44]] ~
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007132 Set 'verbose' and use |z=| to see the scores that the
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007133 internal methods use. A lower score is better.
7134 This may invoke |spellsuggest()| if you temporarily
7135 set 'spellsuggest' to exclude the "expr:" part.
7136 Errors are silently ignored, unless you set the
7137 'verbose' option to a non-zero value.
7138
7139 Only one of "best", "double" or "fast" may be used. The others may
7140 appear several times in any order. Example: >
7141 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
7142<
7143 This option cannot be set from a |modeline| or in the |sandbox|, for
7144 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007145
7146
Bram Moolenaar071d4272004-06-13 20:20:40 +00007147 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
7148'splitbelow' 'sb' boolean (default off)
7149 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007150 When on, splitting a window will put the new window below the current
7151 one. |:split|
7152
7153 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
7154'splitright' 'spr' boolean (default off)
7155 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007156 When on, splitting a window will put the new window right of the
7157 current one. |:vsplit|
7158
7159 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
7160'startofline' 'sol' boolean (default on)
7161 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007162 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00007163 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007164 (if possible). This applies to the commands: CTRL-D, CTRL-U, CTRL-B,
Bram Moolenaar843ee412004-06-30 16:16:41 +00007165 CTRL-F, "G", "H", "M", "L", gg, and to the commands "d", "<<" and ">>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007166 with a linewise operator, with "%" with a count and to buffer changing
7167 commands (CTRL-^, :bnext, :bNext, etc.). Also for an Ex command that
7168 only has a line number, e.g., ":25" or ":+".
7169 In case of buffer changing commands the cursor is placed at the column
7170 where it was the last time the buffer was edited.
7171 NOTE: This option is set when 'compatible' is set.
7172
Bram Moolenaar00654022011-02-25 14:42:19 +01007173 *'statusline'* *'stl'* *E540* *E542*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007174'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007175 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007176 {not available when compiled without the |+statusline|
7177 feature}
7178 When nonempty, this option determines the content of the status line.
7179 Also see |status-line|.
7180
7181 The option consists of printf style '%' items interspersed with
7182 normal text. Each status line item is of the form:
7183 %-0{minwid}.{maxwid}{item}
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01007184 All fields except the {item} are optional. A single percent sign can
Bram Moolenaar00654022011-02-25 14:42:19 +01007185 be given as "%%". Up to 80 items can be specified. *E541*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007186
Bram Moolenaar238a5642006-02-21 22:12:05 +00007187 When the option starts with "%!" then it is used as an expression,
7188 evaluated and the result is used as the option value. Example: >
7189 :set statusline=%!MyStatusLine()
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02007190< The *g:statusline_winid* variable will be set to the |window-ID| of the
7191 window that the status line belongs to.
7192 The result can contain %{} items that will be evaluated too.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02007193 Note that the "%!" expression is evaluated in the context of the
7194 current window and buffer, while %{} items are evaluated in the
7195 context of the window that the statusline belongs to.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007196
7197 When there is error while evaluating the option then it will be made
7198 empty to avoid further errors. Otherwise screen updating would loop.
7199
Bram Moolenaar071d4272004-06-13 20:20:40 +00007200 Note that the only effect of 'ruler' when this option is set (and
7201 'laststatus' is 2) is controlling the output of |CTRL-G|.
7202
7203 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00007204 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00007205 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007206 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007207 minwid Minimum width of the item, padding as set by '-' & '0'.
7208 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007209 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007210 on the left for text items. Numeric items will be
7211 shifted down to maxwid-2 digits followed by '>'number
7212 where number is the amount of missing digits, much like
7213 an exponential notation.
7214 item A one letter code as described below.
7215
7216 Following is a description of the possible statusline items. The
7217 second character in "item" is the type:
7218 N for number
7219 S for string
7220 F for flags as described below
7221 - not applicable
7222
7223 item meaning ~
Bram Moolenaar02467872007-05-06 13:22:01 +00007224 f S Path to the file in the buffer, as typed or relative to current
7225 directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007226 F S Full path to the file in the buffer.
7227 t S File name (tail) of file in the buffer.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007228 m F Modified flag, text is "[+]"; "[-]" if 'modifiable' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007229 M F Modified flag, text is ",+" or ",-".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007230 r F Readonly flag, text is "[RO]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007231 R F Readonly flag, text is ",RO".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007232 h F Help buffer flag, text is "[help]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007233 H F Help buffer flag, text is ",HLP".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007234 w F Preview window flag, text is "[Preview]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007235 W F Preview window flag, text is ",PRV".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007236 y F Type of file in the buffer, e.g., "[vim]". See 'filetype'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007237 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
Bram Moolenaar7fd73202010-07-25 16:58:46 +02007238 q S "[Quickfix List]", "[Location List]" or empty.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007239 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
7240 being used: "<keymap>"
7241 n N Buffer number.
Bram Moolenaar00654022011-02-25 14:42:19 +01007242 b N Value of character under cursor.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007243 B N As above, in hexadecimal.
7244 o N Byte number in file of byte under cursor, first byte is 1.
7245 Mnemonic: Offset from start of file (with one added)
7246 {not available when compiled without |+byte_offset| feature}
7247 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007248 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007249 l N Line number.
7250 L N Number of lines in buffer.
7251 c N Column number.
7252 v N Virtual column number.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007253 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007254 p N Percentage through file in lines as in |CTRL-G|.
7255 P S Percentage through file of displayed window. This is like the
Bram Moolenaar14b69452013-06-29 23:05:20 +02007256 percentage described for 'ruler'. Always 3 in length, unless
7257 translated.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007258 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00007259 Empty if the argument file count is zero or one.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007260 { NF Evaluate expression between '%{' and '}' and substitute result.
Bram Moolenaar6d150f72018-04-21 20:03:20 +02007261 Note that there is no '%' before the closing '}'. The
7262 expression cannot contain a '}' character, call a function to
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007263 work around that. See |stl-%{| below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007264 ( - Start of item group. Can be used for setting the width and
7265 alignment of a section. Must be followed by %) somewhere.
7266 ) - End of item group. No width fields allowed.
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007267 T N For 'tabline': start of tab page N label. Use %T after the last
7268 label. This information is used for mouse clicks.
7269 X N For 'tabline': start of close tab N label. Use %X after the
7270 label, e.g.: %3Xclose%X. Use %999X for a "close current tab"
7271 mark. This information is used for mouse clicks.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007272 < - Where to truncate line if too long. Default is at the start.
7273 No width fields allowed.
7274 = - Separation point between left and right aligned items.
7275 No width fields allowed.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007276 # - Set highlight group. The name must follow and then a # again.
7277 Thus use %#HLname# for highlight group HLname. The same
7278 highlighting is used, also for the statusline of non-current
7279 windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007280 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00007281 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007282 The difference between User{N} and StatusLine will be applied
7283 to StatusLineNC for the statusline of non-current windows.
7284 The number N must be between 1 and 9. See |hl-User1..9|
7285
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007286 When displaying a flag, Vim removes the leading comma, if any, when
7287 that flag comes right after plaintext. This will make a nice display
7288 when flags are used like in the examples below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007289
Bram Moolenaar582fd852005-03-28 20:58:01 +00007290 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00007291 not set) and a minwid is not set for the group, the whole group will
7292 become empty. This will make a group like the following disappear
7293 completely from the statusline when none of the flags are set. >
7294 :set statusline=...%(\ [%M%R%H]%)...
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02007295< Beware that an expression is evaluated each and every time the status
7296 line is displayed.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007297 *stl-%{* *g:actual_curbuf* *g:actual_curwin*
Bram Moolenaarade0d392020-01-21 22:33:58 +01007298 While evaluating %{} the current buffer and current window will be set
7299 temporarily to that of the window (and buffer) whose statusline is
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007300 currently being drawn. The expression will evaluate in this context.
7301 The variable "g:actual_curbuf" is set to the `bufnr()` number of the
7302 real current buffer and "g:actual_curwin" to the |window-ID| of the
7303 real current window. These values are strings.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007304
Bram Moolenaar30b65812012-07-12 22:01:11 +02007305 The 'statusline' option will be evaluated in the |sandbox| if set from
7306 a modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02007307 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007308
7309 It is not allowed to change text or jump to another window while
7310 evaluating 'statusline' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007311
7312 If the statusline is not updated when you want it (e.g., after setting
7313 a variable that's used in an expression), you can force an update by
7314 setting an option without changing its value. Example: >
7315 :let &ro = &ro
7316
7317< A result of all digits is regarded a number for display purposes.
7318 Otherwise the result is taken as flag text and applied to the rules
7319 described above.
7320
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00007321 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00007322 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
Bram Moolenaarc4da1132017-07-15 19:39:43 +02007323 edit your .vimrc or whatever with "vim --clean" to get it right.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007324
7325 Examples:
7326 Emulate standard status line with 'ruler' set >
7327 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
7328< Similar, but add ASCII value of char under the cursor (like "ga") >
7329 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
7330< Display byte count and byte value, modified flag in red. >
7331 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
7332 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
7333< Display a ,GZ flag if a compressed file is loaded >
7334 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
7335< In the |:autocmd|'s: >
7336 :let b:gzflag = 1
7337< And: >
7338 :unlet b:gzflag
7339< And define this function: >
7340 :function VarExists(var, val)
7341 : if exists(a:var) | return a:val | else | return '' | endif
7342 :endfunction
7343<
7344 *'suffixes'* *'su'*
7345'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
7346 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007347 Files with these suffixes get a lower priority when multiple files
7348 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007349 suffixes. Spaces after the comma are ignored. A dot is also seen as
7350 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007351 separator, precede it with a backslash (see |option-backslash| about
7352 including spaces and backslashes).
7353 See 'wildignore' for completely ignoring files.
7354 The use of |:set+=| and |:set-=| is preferred when adding or removing
7355 suffixes from the list. This avoids problems when a future version
7356 uses another default.
7357
7358 *'suffixesadd'* *'sua'*
7359'suffixesadd' 'sua' string (default "")
7360 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007361 {not available when compiled without the
7362 |+file_in_path| feature}
7363 Comma separated list of suffixes, which are used when searching for a
7364 file for the "gf", "[I", etc. commands. Example: >
7365 :set suffixesadd=.java
7366<
7367 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
7368'swapfile' 'swf' boolean (default on)
7369 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007370 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007371 swapfile is not wanted for a specific buffer. For example, with
7372 confidential information that even root must not be able to access.
7373 Careful: All text will be in memory:
7374 - Don't use this for big files.
7375 - Recovery will be impossible!
7376 A swapfile will only be present when |'updatecount'| is non-zero and
7377 'swapfile' is set.
7378 When 'swapfile' is reset, the swap file for the current buffer is
7379 immediately deleted. When 'swapfile' is set, and 'updatecount' is
7380 non-zero, a swap file is immediately created.
7381 Also see |swap-file| and |'swapsync'|.
Bram Moolenaar76f3b1a2014-03-27 22:30:07 +01007382 If you want to open a new buffer without creating a swap file for it,
7383 use the |:noswapfile| modifier.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01007384 See 'directory' for where the swap file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007385
7386 This option is used together with 'bufhidden' and 'buftype' to
7387 specify special kinds of buffers. See |special-buffers|.
7388
7389 *'swapsync'* *'sws'*
7390'swapsync' 'sws' string (default "fsync")
7391 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007392 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007393 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007394 When this option is empty parts of the swap file may be in memory and
7395 not written to disk. When the system crashes you may lose more work.
7396 On Unix the system does a sync now and then without Vim asking for it,
7397 so the disadvantage of setting this option off is small. On some
7398 systems the swap file will not be written at all. For a unix system
7399 setting it to "sync" will use the sync() call instead of the default
7400 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007401 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007402
7403 *'switchbuf'* *'swb'*
7404'switchbuf' 'swb' string (default "")
7405 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007406 This option controls the behavior when switching between buffers.
7407 Possible values (comma separated list):
7408 useopen If included, jump to the first open window that
7409 contains the specified buffer (if there is one).
7410 Otherwise: Do not examine other windows.
7411 This setting is checked with |quickfix| commands, when
7412 jumping to errors (":cc", ":cn", "cp", etc.). It is
7413 also used in all buffer related split commands, for
7414 example ":sbuffer", ":sbnext", or ":sbrewind".
Bram Moolenaar779b74b2006-04-10 14:55:34 +00007415 usetab Like "useopen", but also consider windows in other tab
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00007416 pages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007417 split If included, split the current window before loading
Bram Moolenaar15146672011-10-20 22:22:38 +02007418 a buffer for a |quickfix| command that display errors.
Bram Moolenaar63b74a82019-03-24 15:09:13 +01007419 Otherwise: do not split, use current window (when used
7420 in the quickfix window: the previously used window or
7421 split if there is no other window).
Bram Moolenaara594d772015-06-19 14:41:49 +02007422 vsplit Just like "split" but split vertically.
Bram Moolenaar446cb832008-06-24 21:56:24 +00007423 newtab Like "split", but open a new tab page. Overrules
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02007424 "split" when both are present.
Bram Moolenaar539aa6b2019-11-17 18:09:38 +01007425 uselast If included, jump to the previously used window when
7426 jumping to errors with |quickfix| commands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007427
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007428 *'synmaxcol'* *'smc'*
7429'synmaxcol' 'smc' number (default 3000)
7430 local to buffer
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007431 {not available when compiled without the |+syntax|
7432 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007433 Maximum column in which to search for syntax items. In long lines the
7434 text after this column is not highlighted and following lines may not
7435 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007436 This helps to avoid very slow redrawing for an XML file that is one
7437 long line.
7438 Set to zero to remove the limit.
7439
Bram Moolenaar071d4272004-06-13 20:20:40 +00007440 *'syntax'* *'syn'*
7441'syntax' 'syn' string (default empty)
7442 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007443 {not available when compiled without the |+syntax|
7444 feature}
7445 When this option is set, the syntax with this name is loaded, unless
7446 syntax highlighting has been switched off with ":syntax off".
7447 Otherwise this option does not always reflect the current syntax (the
7448 b:current_syntax variable does).
7449 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007450 not automatically recognized. Example, in an IDL file:
7451 /* vim: set syntax=idl : */ ~
7452 When a dot appears in the value then this separates two filetype
7453 names. Example:
7454 /* vim: set syntax=c.doxygen : */ ~
7455 This will use the "c" syntax first, then the "doxygen" syntax.
7456 Note that the second one must be prepared to be loaded as an addition,
7457 otherwise it will be skipped. More than one dot may appear.
7458 To switch off syntax highlighting for the current file, use: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007459 :set syntax=OFF
7460< To switch syntax highlighting on according to the current value of the
7461 'filetype' option: >
7462 :set syntax=ON
7463< What actually happens when setting the 'syntax' option is that the
7464 Syntax autocommand event is triggered with the value as argument.
7465 This option is not copied to another buffer, independent of the 's' or
7466 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007467 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007468
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007469 *'tabline'* *'tal'*
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007470'tabline' 'tal' string (default empty)
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007471 global
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007472 When nonempty, this option determines the content of the tab pages
7473 line at the top of the Vim window. When empty Vim will use a default
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007474 tab pages line. See |setting-tabline| for more info.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007475
7476 The tab pages line only appears as specified with the 'showtabline'
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00007477 option and only when there is no GUI tab line. When 'e' is in
7478 'guioptions' and the GUI supports a tab line 'guitablabel' is used
Bram Moolenaar7f036442010-08-15 15:24:20 +02007479 instead. Note that the two tab pages lines are very different.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007480
7481 The value is evaluated like with 'statusline'. You can use
7482 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007483 the text to be displayed. Use "%1T" for the first label, "%2T" for
7484 the second one, etc. Use "%X" items for closing labels.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007485
Bram Moolenaare12bab32019-01-08 22:02:56 +01007486 When changing something that is used in 'tabline' that does not
7487 trigger it to be updated, use |:redrawtabline|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02007488 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaare12bab32019-01-08 22:02:56 +01007489
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007490 Keep in mind that only one of the tab pages is the current one, others
7491 are invisible and you can't jump to their windows.
7492
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007493
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007494 *'tabpagemax'* *'tpm'*
7495'tabpagemax' 'tpm' number (default 10)
7496 global
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007497 Maximum number of tab pages to be opened by the |-p| command line
7498 argument or the ":tab all" command. |tabpage|
7499
7500
7501 *'tabstop'* *'ts'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007502'tabstop' 'ts' number (default 8)
7503 local to buffer
7504 Number of spaces that a <Tab> in the file counts for. Also see
7505 |:retab| command, and 'softtabstop' option.
7506
7507 Note: Setting 'tabstop' to any other value than 8 can make your file
7508 appear wrong in many places (e.g., when printing it).
7509
7510 There are four main ways to use tabs in Vim:
7511 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
7512 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007513 will use a mix of tabs and spaces, but typing <Tab> and <BS> will
Bram Moolenaar071d4272004-06-13 20:20:40 +00007514 behave like a tab appears every 4 (or 3) characters.
7515 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
7516 'expandtab'. This way you will always insert spaces. The
7517 formatting will never be messed up when 'tabstop' is changed.
7518 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007519 |modeline| to set these values when editing the file again. Only
Bram Moolenaar071d4272004-06-13 20:20:40 +00007520 works when using Vim to edit the file.
7521 4. Always set 'tabstop' and 'shiftwidth' to the same value, and
7522 'noexpandtab'. This should then work (for initial indents only)
7523 for any tabstop setting that people use. It might be nice to have
7524 tabs after the first non-blank inserted as spaces if you do this
7525 though. Otherwise aligned comments will be wrong when 'tabstop' is
7526 changed.
7527
Bram Moolenaar04958cb2018-06-23 19:23:02 +02007528 If Vim is compiled with the |+vartabs| feature then the value of
7529 'tabstop' will be ignored if |'vartabstop'| is set to anything other
7530 than an empty string.
7531
Bram Moolenaar071d4272004-06-13 20:20:40 +00007532 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
7533'tagbsearch' 'tbs' boolean (default on)
7534 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007535 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007536 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00007537 searching makes searching for a tag a LOT faster, but a linear search
7538 will find more tags if the tags file wasn't properly sorted.
7539 Vim normally assumes that your tags files are sorted, or indicate that
7540 they are not sorted. Only when this is not the case does the
7541 'tagbsearch' option need to be switched off.
7542
7543 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007544 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00007545 certain files, or retry all files with a linear search. When
7546 'tagbsearch' is off, only a linear search is done.
7547
7548 Linear searching is done anyway, for one file, when Vim finds a line
7549 at the start of the file indicating that it's not sorted: >
Bram Moolenaar446cb832008-06-24 21:56:24 +00007550 !_TAG_FILE_SORTED 0 /some comment/
Bram Moolenaar071d4272004-06-13 20:20:40 +00007551< [The whitespace before and after the '0' must be a single <Tab>]
7552
7553 When a binary search was done and no match was found in any of the
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007554 files listed in 'tags', and case is ignored or a pattern is used
Bram Moolenaar071d4272004-06-13 20:20:40 +00007555 instead of a normal tag name, a retry is done with a linear search.
7556 Tags in unsorted tags files, and matches with different case will only
7557 be found in the retry.
7558
Bram Moolenaard4755bb2004-09-02 19:12:26 +00007559 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007560 linear search can be avoided when case is ignored. Use a value of '2'
7561 in the "!_TAG_FILE_SORTED" line for this. A tag file can be case-fold
7562 sorted with the -f switch to "sort" in most unices, as in the command:
7563 "sort -f -o tags tags". For "Exuberant ctags" version 5.x or higher
7564 (at least 5.5) the --sort=foldcase switch can be used for this as
7565 well. Note that case must be folded to uppercase for this to work.
7566
7567 By default, tag searches are case-sensitive. Case is ignored when
7568 'ignorecase' is set and 'tagcase' is "followic", or when 'tagcase' is
7569 "ignore".
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007570 Also when 'tagcase' is "followscs" and 'smartcase' is set, or
7571 'tagcase' is "smart", and the pattern contains only lowercase
7572 characters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007573
7574 When 'tagbsearch' is off, tags searching is slower when a full match
7575 exists, but faster when no full match exists. Tags in unsorted tags
7576 files may only be found with 'tagbsearch' off.
7577 When the tags file is not sorted, or sorted in a wrong way (not on
7578 ASCII byte value), 'tagbsearch' should be off, or the line given above
7579 must be included in the tags file.
7580 This option doesn't affect commands that find all matching tags (e.g.,
7581 command-line completion and ":help").
Bram Moolenaar071d4272004-06-13 20:20:40 +00007582
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007583 *'tagcase'* *'tc'*
7584'tagcase' 'tc' string (default "followic")
7585 global or local to buffer |global-local|
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007586 This option specifies how case is handled when searching the tags
7587 file:
7588 followic Follow the 'ignorecase' option
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007589 followscs Follow the 'smartcase' and 'ignorecase' options
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007590 ignore Ignore case
7591 match Match case
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007592 smart Ignore case unless an upper case letter is used
Bram Moolenaar036986f2017-03-16 17:41:02 +01007593 NOTE: This option is set to the Vi default value when 'compatible' is
7594 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007595
Bram Moolenaar45e18cb2019-04-28 18:05:35 +02007596 *'tagfunc'* *'tfu'*
7597'tagfunc' 'tfu' string (default: empty)
7598 local to buffer
7599 {not available when compiled without the |+eval|
7600 feature}
7601 This option specifies a function to be used to perform tag searches.
7602 The function gets the tag pattern and should return a List of matching
7603 tags. See |tag-function| for an explanation of how to write the
7604 function and an example.
7605
Bram Moolenaar071d4272004-06-13 20:20:40 +00007606 *'taglength'* *'tl'*
7607'taglength' 'tl' number (default 0)
7608 global
7609 If non-zero, tags are significant up to this number of characters.
7610
7611 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
7612'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
7613 global
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00007614 If on and using a tags file in another directory, file names in that
7615 tags file are relative to the directory where the tags file is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007616 NOTE: This option is set to the Vi default value when 'compatible' is
7617 set and to the Vim default value when 'compatible' is reset.
7618
7619 *'tags'* *'tag'* *E433*
7620'tags' 'tag' string (default "./tags,tags", when compiled with
7621 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
7622 global or local to buffer |global-local|
7623 Filenames for the tag command, separated by spaces or commas. To
7624 include a space or comma in a file name, precede it with a backslash
7625 (see |option-backslash| about including spaces and backslashes).
7626 When a file name starts with "./", the '.' is replaced with the path
7627 of the current file. But only when the 'd' flag is not included in
7628 'cpoptions'. Environment variables are expanded |:set_env|. Also see
7629 |tags-option|.
7630 "*", "**" and other wildcards can be used to search for tags files in
Bram Moolenaare2b590e2010-08-08 18:29:48 +02007631 a directory tree. See |file-searching|. E.g., "/lib/**/tags" will
7632 find all files named "tags" below "/lib". The filename itself cannot
7633 contain wildcards, it is used as-is. E.g., "/lib/**/tags?" will find
7634 files called "tags?". {not available when compiled without the
7635 |+path_extra| feature}
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00007636 The |tagfiles()| function can be used to get a list of the file names
7637 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007638 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
7639 files are also supported. They are automatically recognized. The
7640 default value becomes "./tags,./TAGS,tags,TAGS", unless case
7641 differences are ignored (MS-Windows). |emacs-tags|
7642 The use of |:set+=| and |:set-=| is preferred when adding or removing
7643 file names from the list. This avoids problems when a future version
7644 uses another default.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007645
7646 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
7647'tagstack' 'tgst' boolean (default on)
7648 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007649 When on, the |tagstack| is used normally. When off, a ":tag" or
7650 ":tselect" command with an argument will not push the tag onto the
7651 tagstack. A following ":tag" without an argument, a ":pop" command or
7652 any other command that uses the tagstack will use the unmodified
7653 tagstack, but does change the pointer to the active entry.
7654 Resetting this option is useful when using a ":tag" command in a
7655 mapping which should not change the tagstack.
7656
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007657 *'tcldll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01007658'tcldll' string (default depends on the build)
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007659 global
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007660 {only available when compiled with the |+tcl/dyn|
7661 feature}
7662 Specifies the name of the Tcl shared library. The default is
7663 DYNAMIC_TCL_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02007664 Environment variables are expanded |:set_env|.
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007665 This option cannot be set from a |modeline| or in the |sandbox|, for
7666 security reasons.
7667
Bram Moolenaar071d4272004-06-13 20:20:40 +00007668 *'term'* *E529* *E530* *E531*
7669'term' string (default is $TERM, if that fails:
7670 in the GUI: "builtin_gui"
7671 on Amiga: "amiga"
7672 on BeOS: "beos-ansi"
Bram Moolenaarb3f74062020-02-26 16:16:53 +01007673 on Haiku: "xterm"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007674 on Mac: "mac-ansi"
7675 on MiNT: "vt52"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007676 on Unix: "ansi"
7677 on VMS: "ansi"
7678 on Win 32: "win32")
7679 global
7680 Name of the terminal. Used for choosing the terminal control
7681 characters. Environment variables are expanded |:set_env|.
7682 For example: >
7683 :set term=$TERM
7684< See |termcap|.
7685
7686 *'termbidi'* *'tbidi'*
7687 *'notermbidi'* *'notbidi'*
7688'termbidi' 'tbidi' boolean (default off, on for "mlterm")
7689 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007690 {only available when compiled with the |+arabic|
7691 feature}
7692 The terminal is in charge of Bi-directionality of text (as specified
7693 by Unicode). The terminal is also expected to do the required shaping
7694 that some languages (such as Arabic) require.
7695 Setting this option implies that 'rightleft' will not be set when
7696 'arabic' is set and the value of 'arabicshape' will be ignored.
7697 Note that setting 'termbidi' has the immediate effect that
7698 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
7699 This option is reset when the GUI is started.
7700 For further details see |arabic.txt|.
7701
7702 *'termencoding'* *'tenc'*
Bram Moolenaar3df01732017-02-17 22:47:16 +01007703'termencoding' 'tenc' string (default ""; with GTK+ GUI: "utf-8"; with
Bram Moolenaar071d4272004-06-13 20:20:40 +00007704 Macintosh GUI: "macroman")
7705 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007706 Encoding used for the terminal. This specifies what character
7707 encoding the keyboard produces and the display will understand. For
Bram Moolenaar3848e002016-03-19 18:42:29 +01007708 the GUI it only applies to the keyboard ('encoding' is used for the
Bram Moolenaar02467872007-05-06 13:22:01 +00007709 display). Except for the Mac when 'macatsui' is off, then
7710 'termencoding' should be "macroman".
Bram Moolenaar4b7cdca2020-01-01 16:18:38 +01007711 *E617* *E950*
Bram Moolenaar3df01732017-02-17 22:47:16 +01007712 Note: This does not apply to the GTK+ GUI. After the GUI has been
Bram Moolenaar071d4272004-06-13 20:20:40 +00007713 successfully initialized, 'termencoding' is forcibly set to "utf-8".
7714 Any attempts to set a different value will be rejected, and an error
7715 message is shown.
Bram Moolenaarac360bf2015-09-01 20:31:20 +02007716 For the Win32 GUI and console versions 'termencoding' is not used,
Bram Moolenaar071d4272004-06-13 20:20:40 +00007717 because the Win32 system always passes Unicode characters.
7718 When empty, the same encoding is used as for the 'encoding' option.
7719 This is the normal value.
7720 Not all combinations for 'termencoding' and 'encoding' are valid. See
7721 |encoding-table|.
7722 The value for this option must be supported by internal conversions or
7723 iconv(). When this is not possible no conversion will be done and you
7724 will probably experience problems with non-ASCII characters.
7725 Example: You are working with the locale set to euc-jp (Japanese) and
7726 want to edit a UTF-8 file: >
7727 :let &termencoding = &encoding
7728 :set encoding=utf-8
7729< You need to do this when your system has no locale support for UTF-8.
7730
Bram Moolenaarcafafb32018-02-22 21:07:09 +01007731 *'termguicolors'* *'tgc'* *E954*
Bram Moolenaar61be73b2016-04-29 22:59:22 +02007732'termguicolors' 'tgc' boolean (default off)
7733 global
Bram Moolenaar61be73b2016-04-29 22:59:22 +02007734 {not available when compiled without the
7735 |+termguicolors| feature}
7736 When on, uses |highlight-guifg| and |highlight-guibg| attributes in
Bram Moolenaarcafafb32018-02-22 21:07:09 +01007737 the terminal (thus using 24-bit color).
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01007738
Bram Moolenaarcafafb32018-02-22 21:07:09 +01007739 Requires a ISO-8613-3 compatible terminal. If setting this option
7740 does not work (produces a colorless UI) reading |xterm-true-color|
7741 might help.
7742
7743 For Win32 console, Windows 10 version 1703 (Creators Update) or later
7744 is required. Use this check to find out: >
7745 if has('vcon')
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01007746< This requires Vim to be built with the |+vtp| feature.
7747
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +02007748 Note that the "cterm" attributes are still used, not the "gui" ones.
Bram Moolenaar036986f2017-03-16 17:41:02 +01007749 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar61be73b2016-04-29 22:59:22 +02007750
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02007751 *'termwinkey'* *'twk'*
7752'termwinkey' 'twk' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02007753 local to window
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007754 The key that starts a CTRL-W command in a terminal window. Other keys
Bram Moolenaar74675a62017-07-15 13:53:23 +02007755 are sent to the job running in the window.
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007756 The <> notation can be used, e.g.: >
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02007757 :set termwinkey=<C-L>
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007758< The string must be one key stroke but can be multiple bytes.
7759 When not set CTRL-W is used, so that CTRL-W : gets you to the command
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02007760 line. If 'termwinkey' is set to CTRL-L then CTRL-L : gets you to the
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007761 command line.
Bram Moolenaar74675a62017-07-15 13:53:23 +02007762
Bram Moolenaar6c60f472019-04-28 16:00:35 +02007763 *'termwinscroll'* *'twsl'*
7764'termwinscroll' 'twsl' number (default 10000)
7765 local to buffer
7766 {not available when compiled without the
7767 |+terminal| feature}
7768 Number of scrollback lines to keep. When going over this limit the
7769 first 10% of the scrollback lines are deleted. This is just to reduce
7770 the memory usage. See |Terminal-Normal|.
7771
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02007772 *'termwinsize'* *'tws'*
7773'termwinsize' 'tws' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02007774 local to window
Bram Moolenaar498c2562018-04-15 23:45:15 +02007775 Size of the |terminal| window. Format: {rows}x{columns} or
7776 {rows}*{columns}.
Bram Moolenaar74675a62017-07-15 13:53:23 +02007777 - When empty the terminal gets the size from the window.
Bram Moolenaar498c2562018-04-15 23:45:15 +02007778 - When set with a "x" (e.g., "24x80") the terminal size is not
7779 adjusted to the window size. If the window is smaller only the
7780 top-left part is displayed.
7781 - When set with a "*" (e.g., "10*50") the terminal size follows the
7782 window size, but will not be smaller than the specified rows and/or
7783 columns.
7784 - When rows is zero then use the height of the window.
7785 - When columns is zero then use the width of the window.
7786 - Using "0x0" or "0*0" is the same as empty.
7787
7788 Examples:
7789 "30x0" uses 30 rows and the current window width.
7790 "20*0" uses at least 20 rows and the current window width.
7791 "0*40" uses the current window height and at least 40 columns.
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02007792 Note that the command running in the terminal window may still change
7793 the size of the terminal. In that case the Vim window will be
7794 adjusted to that size, if possible.
Bram Moolenaar74675a62017-07-15 13:53:23 +02007795
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01007796 *'termwintype'* *'twt'*
7797'termwintype' 'twt' string (default "")
7798 global
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01007799 {only available when compiled with the |terminal|
7800 feature on MS-Windows}
7801 Specify the virtual console (pty) used when opening the terminal
7802 window.
7803
7804 Possible values are:
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01007805 "" use ConPTY if it is stable, winpty otherwise
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01007806 "winpty" use winpty, fail if not supported
7807 "conpty" use |ConPTY|, fail if not supported
7808
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01007809 |ConPTY| support depends on the platform. Windows 10 October 2018
7810 Update is the first version that supports ConPTY, however it is still
7811 considered unstable. ConPTY might become stable in the next release
7812 of Windows 10. winpty support needs to be installed. If neither is
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01007813 supported then you cannot open a terminal window.
7814
Bram Moolenaar071d4272004-06-13 20:20:40 +00007815 *'terse'* *'noterse'*
7816'terse' boolean (default off)
7817 global
7818 When set: Add 's' flag to 'shortmess' option (this makes the message
7819 for a search that hits the start or end of the file not being
7820 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
7821 shortens a lot of messages}
7822
7823 *'textauto'* *'ta'* *'notextauto'* *'nota'*
7824'textauto' 'ta' boolean (Vim default: on, Vi default: off)
7825 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007826 This option is obsolete. Use 'fileformats'.
7827 For backwards compatibility, when 'textauto' is set, 'fileformats' is
7828 set to the default value for the current system. When 'textauto' is
7829 reset, 'fileformats' is made empty.
7830 NOTE: This option is set to the Vi default value when 'compatible' is
7831 set and to the Vim default value when 'compatible' is reset.
7832
7833 *'textmode'* *'tx'* *'notextmode'* *'notx'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01007834'textmode' 'tx' boolean (Win32: default on,
Bram Moolenaar071d4272004-06-13 20:20:40 +00007835 others: default off)
7836 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007837 This option is obsolete. Use 'fileformat'.
7838 For backwards compatibility, when 'textmode' is set, 'fileformat' is
7839 set to "dos". When 'textmode' is reset, 'fileformat' is set to
7840 "unix".
7841
7842 *'textwidth'* *'tw'*
7843'textwidth' 'tw' number (default 0)
7844 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007845 Maximum width of text that is being inserted. A longer line will be
7846 broken after white space to get this width. A zero value disables
Bram Moolenaarca635012015-09-25 20:34:21 +02007847 this.
7848 'textwidth' is set to 0 when the 'paste' option is set and restored
7849 when 'paste' is reset.
7850 When 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00007851 'formatoptions' and |ins-textwidth|.
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00007852 When 'formatexpr' is set it will be used to break the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007853 NOTE: This option is set to 0 when 'compatible' is set.
7854
7855 *'thesaurus'* *'tsr'*
7856'thesaurus' 'tsr' string (default "")
7857 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007858 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01007859 for thesaurus completion commands |i_CTRL-X_CTRL-T|.
7860
7861 Each line in the file should contain words with similar meaning,
7862 separated by non-keyword characters (white space is preferred).
7863 Maximum line length is 510 bytes.
7864
Bram Moolenaard47d5222018-12-09 20:43:55 +01007865 An English word list was added to this github issue:
7866 https://github.com/vim/vim/issues/629#issuecomment-443293282
7867 Unpack thesaurus_pkg.zip, put the thesaurus.txt file somewhere, e.g.
7868 ~/.vim/thesaurus/english.txt, and the 'thesaurus' option to this file
7869 name.
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01007870
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007871 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00007872 after a comma are ignored, otherwise spaces are included in the file
7873 name. See |option-backslash| about using backslashes.
7874 The use of |:set+=| and |:set-=| is preferred when adding or removing
7875 directories from the list. This avoids problems when a future version
7876 uses another default.
7877 Backticks cannot be used in this option for security reasons.
7878
7879 *'tildeop'* *'top'* *'notildeop'* *'notop'*
7880'tildeop' 'top' boolean (default off)
7881 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007882 When on: The tilde command "~" behaves like an operator.
7883 NOTE: This option is reset when 'compatible' is set.
7884
7885 *'timeout'* *'to'* *'notimeout'* *'noto'*
7886'timeout' 'to' boolean (default on)
7887 global
7888 *'ttimeout'* *'nottimeout'*
Bram Moolenaar94237492017-04-23 18:40:21 +02007889'ttimeout' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007890 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007891 These two options together determine the behavior when part of a
7892 mapped key sequence or keyboard code has been received:
7893
7894 'timeout' 'ttimeout' action ~
7895 off off do not time out
7896 on on or off time out on :mappings and key codes
7897 off on time out on key codes
7898
7899 If both options are off, Vim will wait until either the complete
7900 mapping or key sequence has been received, or it is clear that there
7901 is no mapping or key sequence for the received characters. For
7902 example: if you have mapped "vl" and Vim has received 'v', the next
7903 character is needed to see if the 'v' is followed by an 'l'.
7904 When one of the options is on, Vim will wait for about 1 second for
7905 the next character to arrive. After that the already received
7906 characters are interpreted as single characters. The waiting time can
7907 be changed with the 'timeoutlen' option.
7908 On slow terminals or very busy systems timing out may cause
7909 malfunctioning cursor keys. If both options are off, Vim waits
7910 forever after an entered <Esc> if there are key codes that start
7911 with <Esc>. You will have to type <Esc> twice. If you do not have
7912 problems with key codes, but would like to have :mapped key
7913 sequences not timing out in 1 second, set the 'ttimeout' option and
7914 reset the 'timeout' option.
7915
7916 NOTE: 'ttimeout' is reset when 'compatible' is set.
7917
7918 *'timeoutlen'* *'tm'*
7919'timeoutlen' 'tm' number (default 1000)
7920 global
Bram Moolenaar25c9c682019-05-05 18:13:34 +02007921
Bram Moolenaar071d4272004-06-13 20:20:40 +00007922 *'ttimeoutlen'* *'ttm'*
Bram Moolenaar94237492017-04-23 18:40:21 +02007923'ttimeoutlen' 'ttm' number (default -1, set to 100 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007924 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007925 The time in milliseconds that is waited for a key code or mapped key
7926 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
7927 when part of a command has been typed.
7928 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
7929 different timeout value for key codes is desired set 'ttimeoutlen' to
7930 a non-negative number.
7931
7932 ttimeoutlen mapping delay key code delay ~
7933 < 0 'timeoutlen' 'timeoutlen'
7934 >= 0 'timeoutlen' 'ttimeoutlen'
7935
7936 The timeout only happens when the 'timeout' and 'ttimeout' options
7937 tell so. A useful setting would be >
7938 :set timeout timeoutlen=3000 ttimeoutlen=100
7939< (time out on mapping after three seconds, time out on key codes after
7940 a tenth of a second).
7941
7942 *'title'* *'notitle'*
7943'title' boolean (default off, on when title can be restored)
7944 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007945 {not available when compiled without the |+title|
7946 feature}
7947 When on, the title of the window will be set to the value of
7948 'titlestring' (if it is not empty), or to:
7949 filename [+=-] (path) - VIM
7950 Where:
7951 filename the name of the file being edited
7952 - indicates the file cannot be modified, 'ma' off
7953 + indicates the file was modified
7954 = indicates the file is read-only
7955 =+ indicates the file is read-only and modified
7956 (path) is the path of the file being edited
7957 - VIM the server name |v:servername| or "VIM"
7958 Only works if the terminal supports setting window titles
7959 (currently Amiga console, Win32 console, all GUI versions and
Bram Moolenaard1caa942020-04-10 22:10:56 +02007960 terminals with a non-empty 't_ts' option - these are Unix xterm and
Bram Moolenaar071d4272004-06-13 20:20:40 +00007961 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
7962 *X11*
7963 When Vim was compiled with HAVE_X11 defined, the original title will
7964 be restored if possible. The output of ":version" will include "+X11"
7965 when HAVE_X11 was defined, otherwise it will be "-X11". This also
7966 works for the icon name |'icon'|.
7967 But: When Vim was started with the |-X| argument, restoring the title
7968 will not work (except in the GUI).
7969 If the title cannot be restored, it is set to the value of 'titleold'.
7970 You might want to restore the title outside of Vim then.
7971 When using an xterm from a remote machine you can use this command:
7972 rsh machine_name xterm -display $DISPLAY &
7973 then the WINDOWID environment variable should be inherited and the
7974 title of the window should change back to what it should be after
7975 exiting Vim.
7976
7977 *'titlelen'*
7978'titlelen' number (default 85)
7979 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007980 {not available when compiled without the |+title|
7981 feature}
7982 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007983 title. When the title is longer, only the end of the path name is
7984 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007985 Using a percentage makes this adapt to the width of the window. But
7986 it won't work perfectly, because the actual number of characters
7987 available also depends on the font used and other things in the title
7988 bar. When 'titlelen' is zero the full path is used. Otherwise,
7989 values from 1 to 30000 percent can be used.
7990 'titlelen' is also used for the 'titlestring' option.
7991
7992 *'titleold'*
7993'titleold' string (default "Thanks for flying Vim")
7994 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007995 {only available when compiled with the |+title|
7996 feature}
7997 This option will be used for the window title when exiting Vim if the
7998 original title cannot be restored. Only happens if 'title' is on or
7999 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00008000 This option cannot be set from a |modeline| or in the |sandbox|, for
8001 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008002 *'titlestring'*
8003'titlestring' string (default "")
8004 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008005 {not available when compiled without the |+title|
8006 feature}
8007 When this option is not empty, it will be used for the title of the
8008 window. This happens only when the 'title' option is on.
8009 Only works if the terminal supports setting window titles (currently
8010 Amiga console, Win32 console, all GUI versions and terminals with a
8011 non-empty 't_ts' option).
8012 When Vim was compiled with HAVE_X11 defined, the original title will
Bram Moolenaar51628222016-12-01 23:03:28 +01008013 be restored if possible, see |X11|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008014
Bram Moolenaar071d4272004-06-13 20:20:40 +00008015 When this option contains printf-style '%' items, they will be
8016 expanded according to the rules used for 'statusline'.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008017 This option cannot be set in a modeline when 'modelineexpr' is off.
8018
Bram Moolenaar071d4272004-06-13 20:20:40 +00008019 Example: >
8020 :auto BufEnter * let &titlestring = hostname() . "/" . expand("%:p")
8021 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
8022< The value of 'titlelen' is used to align items in the middle or right
8023 of the available space.
8024 Some people prefer to have the file name first: >
8025 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
8026< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008027 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00008028 separating space only when needed.
8029 NOTE: Use of special characters in 'titlestring' may cause the display
8030 to be garbled (e.g., when it contains a CR or NL character).
8031 {not available when compiled without the |+statusline| feature}
8032
8033 *'toolbar'* *'tb'*
8034'toolbar' 'tb' string (default "icons,tooltips")
8035 global
8036 {only for |+GUI_GTK|, |+GUI_Athena|, |+GUI_Motif| and
8037 |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008038 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00008039 possible values are:
8040 icons Toolbar buttons are shown with icons.
8041 text Toolbar buttons shown with text.
8042 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008043 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008044 tooltips Tooltips are active for toolbar buttons.
8045 Tooltips refer to the popup help text which appears after the mouse
8046 cursor is placed over a toolbar button for a brief moment.
8047
8048 If you want the toolbar to be shown with icons as well as text, do the
8049 following: >
8050 :set tb=icons,text
8051< Motif and Athena cannot display icons and text at the same time. They
8052 will show icons if both are requested.
8053
8054 If none of the strings specified in 'toolbar' are valid or if
8055 'toolbar' is empty, this option is ignored. If you want to disable
8056 the toolbar, you need to set the 'guioptions' option. For example: >
8057 :set guioptions-=T
8058< Also see |gui-toolbar|.
8059
8060 *'toolbariconsize'* *'tbis'*
8061'toolbariconsize' 'tbis' string (default "small")
8062 global
Bram Moolenaar3df01732017-02-17 22:47:16 +01008063 {only in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008064 Controls the size of toolbar icons. The possible values are:
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008065 tiny Use tiny icons.
8066 small Use small icons (default).
8067 medium Use medium-sized icons.
8068 large Use large icons.
8069 huge Use even larger icons.
8070 giant Use very big icons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008071 The exact dimensions in pixels of the various icon sizes depend on
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008072 the current theme. Common dimensions are giant=48x48, huge=32x32,
8073 large=24x24, medium=24x24, small=20x20 and tiny=16x16.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008074
8075 If 'toolbariconsize' is empty, the global default size as determined
8076 by user preferences or the current theme is used.
8077
8078 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
8079'ttybuiltin' 'tbi' boolean (default on)
8080 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008081 When on, the builtin termcaps are searched before the external ones.
8082 When off the builtin termcaps are searched after the external ones.
8083 When this option is changed, you should set the 'term' option next for
8084 the change to take effect, for example: >
8085 :set notbi term=$TERM
8086< See also |termcap|.
8087 Rationale: The default for this option is "on", because the builtin
8088 termcap entries are generally better (many systems contain faulty
8089 xterm entries...).
8090
8091 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
8092'ttyfast' 'tf' boolean (default off, on when 'term' is xterm, hpterm,
8093 sun-cmd, screen, rxvt, dtterm or
8094 iris-ansi; also on when running Vim in
8095 a DOS console)
8096 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008097 Indicates a fast terminal connection. More characters will be sent to
8098 the screen for redrawing, instead of using insert/delete line
8099 commands. Improves smoothness of redrawing when there are multiple
8100 windows and the terminal does not support a scrolling region.
8101 Also enables the extra writing of characters at the end of each screen
8102 line for lines that wrap. This helps when using copy/paste with the
8103 mouse in an xterm and other terminals.
8104
8105 *'ttymouse'* *'ttym'*
8106'ttymouse' 'ttym' string (default depends on 'term')
8107 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008108 {only in Unix and VMS, doesn't work in the GUI; not
8109 available when compiled without |+mouse|}
8110 Name of the terminal type for which mouse codes are to be recognized.
Bram Moolenaar2c7a7632007-05-10 18:19:11 +00008111 Currently these strings are valid:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008112 *xterm-mouse*
8113 xterm xterm-like mouse handling. The mouse generates
8114 "<Esc>[Mscr", where "scr" is three bytes:
8115 "s" = button state
8116 "c" = column plus 33
8117 "r" = row plus 33
Bram Moolenaare968e362014-05-13 20:23:24 +02008118 This only works up to 223 columns! See "dec",
8119 "urxvt", and "sgr" for solutions.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008120 xterm2 Works like "xterm", but with the xterm reporting the
8121 mouse position while the mouse is dragged. This works
8122 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00008123 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00008124 work. See below for how Vim detects this
8125 automatically.
8126 *netterm-mouse*
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008127 netterm NetTerm mouse handling. A left mouse click generates
Bram Moolenaar071d4272004-06-13 20:20:40 +00008128 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008129 for the row and column. No other mouse events are
8130 supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008131 *dec-mouse*
8132 dec DEC terminal mouse handling. The mouse generates a
8133 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00008134 This is also available for an Xterm, if it was
8135 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00008136 *jsbterm-mouse*
8137 jsbterm JSB term mouse handling.
8138 *pterm-mouse*
8139 pterm QNX pterm mouse handling.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008140 *urxvt-mouse*
8141 urxvt Mouse handling for the urxvt (rxvt-unicode) terminal.
Bram Moolenaare968e362014-05-13 20:23:24 +02008142 The mouse works only if the terminal supports this
8143 encoding style, but it does not have 223 columns limit
8144 unlike "xterm" or "xterm2".
Bram Moolenaar9b451252012-08-15 17:43:31 +02008145 *sgr-mouse*
8146 sgr Mouse handling for the terminal that emits SGR-styled
Bram Moolenaare968e362014-05-13 20:23:24 +02008147 mouse reporting. The mouse works even in columns
8148 beyond 223. This option is backward compatible with
8149 "xterm2" because it can also decode "xterm2" style
8150 mouse codes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008151
8152 The mouse handling must be enabled at compile time |+mouse_xterm|
Bram Moolenaare968e362014-05-13 20:23:24 +02008153 |+mouse_dec| |+mouse_netterm| |+mouse_jsbterm| |+mouse_urxvt|
8154 |+mouse_sgr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008155 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
8156 recognized, if enabled at compile time. DEC terminal mouse codes
8157 are recognized if enabled at compile time, and 'ttymouse' is not
Bram Moolenaare968e362014-05-13 20:23:24 +02008158 "xterm", "xterm2", "urxvt" or "sgr" (because dec mouse codes conflict
8159 with them).
Bram Moolenaar071d4272004-06-13 20:20:40 +00008160 This option is automatically set to "xterm", when the 'term' option is
Bram Moolenaar45758762016-10-12 23:08:06 +02008161 set to a name that starts with "xterm", "mlterm", "screen", "tmux",
8162 "st" (full match only), "st-" or "stterm", and 'ttymouse' is not set
8163 already.
Bram Moolenaare968e362014-05-13 20:23:24 +02008164 Additionally, if vim is compiled with the |+termresponse| feature and
8165 |t_RV| is set to the escape sequence to request the xterm version
Bram Moolenaarf8a07122019-07-01 22:06:07 +02008166 number, more intelligent detection is done.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008167 The "xterm2" value will be set if the xterm version is reported to be
Bram Moolenaard47d5222018-12-09 20:43:55 +01008168 from 95 to 276. The "sgr" value will be set if Vim detects Mac
8169 Terminal.app, iTerm2 or mintty, and when the xterm version is 277 or
8170 higher.
Bram Moolenaare968e362014-05-13 20:23:24 +02008171 If you do not want 'ttymouse' to be set to "xterm2" or "sgr"
8172 automatically, set t_RV to an empty string: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008173 :set t_RV=
8174<
8175 *'ttyscroll'* *'tsl'*
8176'ttyscroll' 'tsl' number (default 999)
8177 global
8178 Maximum number of lines to scroll the screen. If there are more lines
8179 to scroll the window is redrawn. For terminals where scrolling is
8180 very slow and redrawing is not slow this can be set to a small number,
8181 e.g., 3, to speed up displaying.
8182
8183 *'ttytype'* *'tty'*
8184'ttytype' 'tty' string (default from $TERM)
8185 global
8186 Alias for 'term', see above.
8187
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008188 *'undodir'* *'udir'*
8189'undodir' 'udir' string (default ".")
8190 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008191 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008192 List of directory names for undo files, separated with commas.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008193 See |'backupdir'| for details of the format.
Bram Moolenaar6a244fe2010-05-24 22:02:24 +02008194 "." means using the directory of the file. The undo file name for
8195 "file.txt" is ".file.txt.un~".
8196 For other directories the file name is the full path of the edited
8197 file, with path separators replaced with "%".
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008198 When writing: The first directory that exists is used. "." always
8199 works, no directories after "." will be used for writing.
8200 When reading all entries are tried to find an undo file. The first
8201 undo file that exists is used. When it cannot be read an error is
8202 given, no further entry is used.
8203 See |undo-persistence|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008204 This option cannot be set from a |modeline| or in the |sandbox|, for
8205 security reasons.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008206
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02008207 *'undofile'* *'noundofile'* *'udf'* *'noudf'*
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008208'undofile' 'udf' boolean (default off)
8209 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02008210 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008211 When on, Vim automatically saves undo history to an undo file when
8212 writing a buffer to a file, and restores undo history from the same
8213 file on buffer read.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008214 The directory where the undo file is stored is specified by 'undodir'.
8215 For more information about this feature see |undo-persistence|.
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008216 The undo file is not read when 'undoreload' causes the buffer from
8217 before a reload to be saved for undo.
Bram Moolenaar97d62492012-11-15 21:28:22 +01008218 When 'undofile' is turned off the undo file is NOT deleted.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008219 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008220
Bram Moolenaar071d4272004-06-13 20:20:40 +00008221 *'undolevels'* *'ul'*
Bram Moolenaar8024f932020-01-14 19:29:13 +01008222'undolevels' 'ul' number (default 100, 1000 for Unix, VMS and Win32)
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008223 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008224 Maximum number of changes that can be undone. Since undo information
Bram Moolenaar5be4cee2019-09-27 19:34:08 +02008225 is kept in memory, higher numbers will cause more memory to be used.
8226 Nevertheless, a single change can already use a large amount of memory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008227 Set to 0 for Vi compatibility: One level of undo and "u" undoes
8228 itself: >
8229 set ul=0
8230< But you can also get Vi compatibility by including the 'u' flag in
8231 'cpoptions', and still be able to use CTRL-R to repeat undo.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008232 Also see |undo-two-ways|.
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008233 Set to -1 for no undo at all. You might want to do this only for the
8234 current buffer: >
8235 setlocal ul=-1
Bram Moolenaar071d4272004-06-13 20:20:40 +00008236< This helps when you run out of memory for a single change.
Bram Moolenaar32efaf62014-11-05 17:02:17 +01008237
8238 The local value is set to -123456 when the global value is to be used.
8239
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008240 Also see |clear-undo|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008241
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008242 *'undoreload'* *'ur'*
8243'undoreload' 'ur' number (default 10000)
8244 global
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008245 Save the whole buffer for undo when reloading it. This applies to the
8246 ":e!" command and reloading for when the buffer changed outside of
8247 Vim. |FileChangedShell|
Bram Moolenaar24a98a02017-09-27 22:23:55 +02008248 The save only happens when this option is negative or when the number
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008249 of lines is smaller than the value of this option.
8250 Set this option to zero to disable undo for a reload.
8251
8252 When saving undo for a reload, any undo file is not read.
8253
8254 Note that this causes the whole buffer to be stored in memory. Set
8255 this option to a lower value if you run out of memory.
8256
Bram Moolenaar071d4272004-06-13 20:20:40 +00008257 *'updatecount'* *'uc'*
8258'updatecount' 'uc' number (default: 200)
8259 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008260 After typing this many characters the swap file will be written to
8261 disk. When zero, no swap file will be created at all (see chapter on
8262 recovery |crash-recovery|). 'updatecount' is set to zero by starting
8263 Vim with the "-n" option, see |startup|. When editing in readonly
8264 mode this option will be initialized to 10000.
8265 The swapfile can be disabled per buffer with |'swapfile'|.
8266 When 'updatecount' is set from zero to non-zero, swap files are
8267 created for all buffers that have 'swapfile' set. When 'updatecount'
8268 is set to zero, existing swap files are not deleted.
8269 Also see |'swapsync'|.
8270 This option has no meaning in buffers where |'buftype'| is "nofile"
8271 or "nowrite".
8272
8273 *'updatetime'* *'ut'*
8274'updatetime' 'ut' number (default 4000)
8275 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008276 If this many milliseconds nothing is typed the swap file will be
8277 written to disk (see |crash-recovery|). Also used for the
8278 |CursorHold| autocommand event.
8279
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008280 *'varsofttabstop'* *'vsts'*
8281'varsofttabstop' 'vsts' string (default "")
8282 local to buffer
8283 {only available when compiled with the |+vartabs|
8284 feature}
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008285 A list of the number of spaces that a <Tab> counts for while editing,
8286 such as inserting a <Tab> or using <BS>. It "feels" like variable-
8287 width <Tab>s are being inserted, while in fact a mixture of spaces
8288 and <Tab>s is used. Tab widths are separated with commas, with the
8289 final value applying to all subsequent tabs.
8290
8291 For example, when editing assembly language files where statements
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02008292 start in the 9th column and comments in the 41st, it may be useful
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008293 to use the following: >
8294 :set varsofttabstop=8,32,8
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02008295< This will set soft tabstops with 8 and 8 + 32 spaces, and 8 more
8296 for every column thereafter.
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008297
8298 Note that the value of |'softtabstop'| will be ignored while
8299 'varsofttabstop' is set.
8300
8301 *'vartabstop'* *'vts'*
8302'vartabstop' 'vts' string (default "")
8303 local to buffer
8304 {only available when compiled with the |+vartabs|
8305 feature}
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008306 A list of the number of spaces that a <Tab> in the file counts for,
8307 separated by commas. Each value corresponds to one tab, with the
8308 final value applying to all subsequent tabs. For example: >
8309 :set vartabstop=4,20,10,8
8310< This will make the first tab 4 spaces wide, the second 20 spaces,
8311 the third 10 spaces, and all following tabs 8 spaces.
8312
8313 Note that the value of |'tabstop'| will be ignored while 'vartabstop'
8314 is set.
8315
Bram Moolenaar071d4272004-06-13 20:20:40 +00008316 *'verbose'* *'vbs'*
8317'verbose' 'vbs' number (default 0)
8318 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008319 When bigger than zero, Vim will give messages about what it is doing.
8320 Currently, these messages are given:
8321 >= 1 When the viminfo file is read or written.
8322 >= 2 When a file is ":source"'ed.
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008323 >= 5 Every searched tags file and include file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008324 >= 8 Files for which a group of autocommands is executed.
8325 >= 9 Every executed autocommand.
8326 >= 12 Every executed function.
8327 >= 13 When an exception is thrown, caught, finished, or discarded.
8328 >= 14 Anything pending in a ":finally" clause.
8329 >= 15 Every executed Ex command (truncated at 200 characters).
8330
8331 This option can also be set with the "-V" argument. See |-V|.
8332 This option is also set by the |:verbose| command.
8333
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008334 When the 'verbosefile' option is set then the verbose messages are not
8335 displayed.
8336
8337 *'verbosefile'* *'vfile'*
8338'verbosefile' 'vfile' string (default empty)
8339 global
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008340 When not empty all messages are written in a file with this name.
8341 When the file exists messages are appended.
8342 Writing to the file ends when Vim exits or when 'verbosefile' is made
Bram Moolenaar80794b12010-06-13 05:20:42 +02008343 empty. Writes are buffered, thus may not show up for some time.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008344 Setting 'verbosefile' to a new value is like making it empty first.
8345 The difference with |:redir| is that verbose messages are not
8346 displayed when 'verbosefile' is set.
8347
Bram Moolenaar071d4272004-06-13 20:20:40 +00008348 *'viewdir'* *'vdir'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008349'viewdir' 'vdir' string (default for Amiga and Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008350 "$VIM/vimfiles/view",
8351 for Unix: "~/.vim/view",
8352 for Macintosh: "$VIM:vimfiles:view"
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01008353 for VMS: "sys$login:vimfiles/view")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008354 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008355 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008356 feature}
8357 Name of the directory where to store files for |:mkview|.
8358 This option cannot be set from a |modeline| or in the |sandbox|, for
8359 security reasons.
8360
8361 *'viewoptions'* *'vop'*
Bram Moolenaar13e90412017-11-11 18:16:48 +01008362'viewoptions' 'vop' string (default: "folds,options,cursor,curdir")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008363 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008364 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008365 feature}
8366 Changes the effect of the |:mkview| command. It is a comma separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008367 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008368 word save and restore ~
8369 cursor cursor position in file and in window
8370 folds manually created folds, opened/closed folds and local
8371 fold options
8372 options options and mappings local to a window or buffer (not
8373 global values for local options)
Bram Moolenaar6e932462014-09-09 18:48:09 +02008374 localoptions same as "options"
Bram Moolenaar071d4272004-06-13 20:20:40 +00008375 slash backslashes in file names replaced with forward
8376 slashes
8377 unix with Unix end-of-line format (single <NL>), even when
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008378 on MS-Windows
Bram Moolenaar13e90412017-11-11 18:16:48 +01008379 curdir the window-local directory, if set with `:lcd`
Bram Moolenaar071d4272004-06-13 20:20:40 +00008380
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008381 "slash" and "unix" are useful on MS-Windows when sharing view files
Bram Moolenaar071d4272004-06-13 20:20:40 +00008382 with Unix. The Unix version of Vim cannot source dos format scripts,
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008383 but the MS-Windows version of Vim can source unix format scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008384
8385 *'viminfo'* *'vi'* *E526* *E527* *E528*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008386'viminfo' 'vi' string (Vi default: "", Vim default for
8387 MS-Windows: '100,<50,s10,h,rA:,rB:,
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01008388 for Amiga: '100,<50,s10,h,rdf0:,rdf1:,rdf2:
8389 for others: '100,<50,s10,h)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008390 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008391 {not available when compiled without the |+viminfo|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008392 feature}
8393 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008394 when exiting Vim (see |viminfo-file|). Except when 'viminfofile' is
8395 "NONE".
8396 The string should be a comma separated list of parameters, each
8397 consisting of a single character identifying the particular parameter,
8398 followed by a number or string which specifies the value of that
8399 parameter. If a particular character is left out, then the default
8400 value is used for that parameter. The following is a list of the
8401 identifying characters and the effect of their value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008402 CHAR VALUE ~
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008403 *viminfo-!*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008404 ! When included, save and restore global variables that start
8405 with an uppercase letter, and don't contain a lowercase
8406 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar680eeca2010-10-20 17:44:42 +02008407 and "_K_L_M" are not. Nested List and Dict items may not be
Bram Moolenaar166af9b2010-11-16 20:34:40 +01008408 read back correctly, you end up with an empty item.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008409 *viminfo-quote*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008410 " Maximum number of lines saved for each register. Old name of
8411 the '<' item, with the disadvantage that you need to put a
8412 backslash before the ", otherwise it will be recognized as the
8413 start of a comment!
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008414 *viminfo-%*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008415 % When included, save and restore the buffer list. If Vim is
8416 started with a file name argument, the buffer list is not
8417 restored. If Vim is started without a file name argument, the
Bram Moolenaard042dc82015-11-24 19:18:36 +01008418 buffer list is restored from the viminfo file. Quickfix
8419 ('buftype'), unlisted ('buflisted'), unnamed and buffers on
8420 removable media (|viminfo-r|) are not saved.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00008421 When followed by a number, the number specifies the maximum
8422 number of buffers that are stored. Without a number all
8423 buffers are stored.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008424 *viminfo-'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008425 ' Maximum number of previously edited files for which the marks
8426 are remembered. This parameter must always be included when
8427 'viminfo' is non-empty.
8428 Including this item also means that the |jumplist| and the
8429 |changelist| are stored in the viminfo file.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008430 *viminfo-/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008431 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008432 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00008433 patterns are also saved. When not included, the value of
8434 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008435 *viminfo-:*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008436 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008437 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008438 *viminfo-<*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008439 < Maximum number of lines saved for each register. If zero then
8440 registers are not saved. When not included, all lines are
8441 saved. '"' is the old name for this item.
8442 Also see the 's' item below: limit specified in Kbyte.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008443 *viminfo-@*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008444 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008445 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008446 *viminfo-c*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008447 c When included, convert the text in the viminfo file from the
8448 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00008449 'encoding'. See |viminfo-encoding|.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008450 *viminfo-f*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008451 f Whether file marks need to be stored. If zero, file marks ('0
8452 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008453 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00008454 cursor position (when exiting or when doing ":wviminfo").
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008455 *viminfo-h*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008456 h Disable the effect of 'hlsearch' when loading the viminfo
8457 file. When not included, it depends on whether ":nohlsearch"
8458 has been used since the last search command.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008459 *viminfo-n*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008460 n Name of the viminfo file. The name must immediately follow
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008461 the 'n'. Must be at the end of the option! If the
8462 'viminfofile' option is set, that file name overrides the one
8463 given here with 'viminfo'. Environment variables are
Bram Moolenaar063b9d12016-07-09 20:21:48 +02008464 expanded when opening the file, not when setting the option.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008465 *viminfo-r*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008466 r Removable media. The argument is a string (up to the next
8467 ','). This parameter can be given several times. Each
8468 specifies the start of a path for which no marks will be
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01008469 stored. This is to avoid removable media. For MS-Windows you
Bram Moolenaar071d4272004-06-13 20:20:40 +00008470 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
8471 also use it for temp files, e.g., for Unix: "r/tmp". Case is
8472 ignored. Maximum length of each 'r' argument is 50
8473 characters.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008474 *viminfo-s*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008475 s Maximum size of an item in Kbyte. If zero then registers are
8476 not saved. Currently only applies to registers. The default
8477 "s10" will exclude registers with more than 10 Kbyte of text.
8478 Also see the '<' item above: line count limit.
8479
8480 Example: >
8481 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
8482<
8483 '50 Marks will be remembered for the last 50 files you
8484 edited.
8485 <1000 Contents of registers (up to 1000 lines each) will be
8486 remembered.
8487 s100 Registers with more than 100 Kbyte text are skipped.
8488 :0 Command-line history will not be saved.
8489 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
8490 no / Since '/' is not specified, the default will be used,
8491 that is, save all of the search history, and also the
8492 previous search and substitute patterns.
8493 no % The buffer list will not be saved nor read back.
8494 no h 'hlsearch' highlighting will be restored.
8495
8496 When setting 'viminfo' from an empty value you can use |:rviminfo| to
8497 load the contents of the file, this is not done automatically.
8498
8499 This option cannot be set from a |modeline| or in the |sandbox|, for
8500 security reasons.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008501 NOTE: This option is set to the Vim default value when 'compatible'
8502 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008503
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008504 *'viminfofile'* *'vif'*
8505'viminfofile' 'vif' string (default: "")
8506 global
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008507 {not available when compiled without the |+viminfo|
8508 feature}
8509 When non-empty, overrides the file name used for viminfo.
8510 When equal to "NONE" no viminfo file will be read or written.
8511 This option can be set with the |-i| command line flag. The |--clean|
8512 command line flag sets it to "NONE".
Bram Moolenaar110289e2019-05-23 15:38:06 +02008513 This option cannot be set from a |modeline| or in the |sandbox|, for
8514 security reasons.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008515
Bram Moolenaar071d4272004-06-13 20:20:40 +00008516 *'virtualedit'* *'ve'*
8517'virtualedit' 've' string (default "")
8518 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008519 {not available when compiled without the
8520 |+virtualedit| feature}
8521 A comma separated list of these words:
8522 block Allow virtual editing in Visual block mode.
8523 insert Allow virtual editing in Insert mode.
8524 all Allow virtual editing in all modes.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008525 onemore Allow the cursor to move just past the end of the line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008526
Bram Moolenaar071d4272004-06-13 20:20:40 +00008527 Virtual editing means that the cursor can be positioned where there is
Bram Moolenaarebcbd022007-05-12 14:28:25 +00008528 no actual character. This can be halfway into a tab or beyond the end
Bram Moolenaar071d4272004-06-13 20:20:40 +00008529 of the line. Useful for selecting a rectangle in Visual mode and
8530 editing a table.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008531 "onemore" is not the same, it will only allow moving the cursor just
8532 after the last character of the line. This makes some commands more
8533 consistent. Previously the cursor was always past the end of the line
8534 if the line was empty. But it is far from Vi compatible. It may also
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008535 break some plugins or Vim scripts. For example because |l| can move
8536 the cursor after the last character. Use with care!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02008537 Using the `$` command will move to the last character in the line, not
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008538 past it. This may actually move the cursor to the left!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02008539 The `g$` command will move to the end of the screen line.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008540 It doesn't make sense to combine "all" with "onemore", but you will
8541 not get a warning for it.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008542 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008543
8544 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
8545'visualbell' 'vb' boolean (default off)
8546 global
Bram Moolenaar74675a62017-07-15 13:53:23 +02008547 Use a visual bell instead of beeping. The terminal code to display the
Bram Moolenaar071d4272004-06-13 20:20:40 +00008548 visual bell is given with 't_vb'. When no beep or flash is wanted,
Bram Moolenaar74675a62017-07-15 13:53:23 +02008549 use: >
8550 :set vb t_vb=
8551< If you want a short flash, you can use this on many terminals: >
8552 :set vb t_vb=[?5h$<100>[?5l
8553< Here $<100> specifies the time, you can use a smaller or bigger value
8554 to get a shorter or longer flash.
8555
8556 Note: Vim will limit the bell to once per half a second. This avoids
8557 having to wait for the flashing to finish when there are lots of
8558 bells, e.g. on key repeat. This also happens without 'visualbell'
8559 set.
8560
Bram Moolenaar071d4272004-06-13 20:20:40 +00008561 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
8562 for 20 msec. If you want to use a different time, use "<Esc>|40f",
8563 where 40 is the time in msec.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008564
8565 Note: When the GUI starts, 't_vb' is reset to its default value. You
8566 might want to set it again in your |gvimrc|.
8567
Bram Moolenaar071d4272004-06-13 20:20:40 +00008568 Does not work on the Amiga, you always get a screen flash.
8569 Also see 'errorbells'.
8570
8571 *'warn'* *'nowarn'*
8572'warn' boolean (default on)
8573 global
8574 Give a warning message when a shell command is used while the buffer
8575 has been changed.
8576
8577 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
8578'weirdinvert' 'wiv' boolean (default off)
8579 global
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00008580 This option has the same effect as the 't_xs' terminal option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008581 It is provided for backwards compatibility with version 4.x.
8582 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
8583 vice versa. Has no effect when the GUI is running.
8584
8585 *'whichwrap'* *'ww'*
8586'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
8587 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008588 Allow specified keys that move the cursor left/right to move to the
8589 previous/next line when the cursor is on the first/last character in
8590 the line. Concatenate characters to allow this for these keys:
8591 char key mode ~
8592 b <BS> Normal and Visual
8593 s <Space> Normal and Visual
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008594 h "h" Normal and Visual (not recommended)
8595 l "l" Normal and Visual (not recommended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008596 < <Left> Normal and Visual
8597 > <Right> Normal and Visual
8598 ~ "~" Normal
8599 [ <Left> Insert and Replace
8600 ] <Right> Insert and Replace
8601 For example: >
8602 :set ww=<,>,[,]
8603< allows wrap only when cursor keys are used.
8604 When the movement keys are used in combination with a delete or change
8605 operator, the <EOL> also counts for a character. This makes "3h"
8606 different from "3dh" when the cursor crosses the end of a line. This
8607 is also true for "x" and "X", because they do the same as "dl" and
8608 "dh". If you use this, you may also want to use the mapping
8609 ":map <BS> X" to make backspace delete the character in front of the
8610 cursor.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00008611 When 'l' is included and it is used after an operator at the end of a
Bram Moolenaar589edb32019-09-20 14:38:13 +02008612 line (not an empty line) then it will not move to the next line. This
8613 makes "dl", "cl", "yl" etc. work normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008614 NOTE: This option is set to the Vi default value when 'compatible' is
8615 set and to the Vim default value when 'compatible' is reset.
8616
8617 *'wildchar'* *'wc'*
8618'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
8619 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008620 Character you have to type to start wildcard expansion in the
8621 command-line, as specified with 'wildmode'.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008622 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008623 The character is not recognized when used inside a macro. See
8624 'wildcharm' for that.
8625 Although 'wc' is a number option, you can set it to a special key: >
8626 :set wc=<Esc>
8627< NOTE: This option is set to the Vi default value when 'compatible' is
8628 set and to the Vim default value when 'compatible' is reset.
8629
8630 *'wildcharm'* *'wcm'*
8631'wildcharm' 'wcm' number (default: none (0))
8632 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008633 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00008634 recognized when used inside a macro. You can find "spare" command-line
8635 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00008636 you'll never actually type 'wildcharm', just use it in mappings that
8637 automatically invoke completion mode, e.g.: >
8638 :set wcm=<C-Z>
Bram Moolenaar446cb832008-06-24 21:56:24 +00008639 :cnoremap ss so $vim/sessions/*.vim<C-Z>
Bram Moolenaar071d4272004-06-13 20:20:40 +00008640< Then after typing :ss you can use CTRL-P & CTRL-N.
8641
8642 *'wildignore'* *'wig'*
8643'wildignore' 'wig' string (default "")
8644 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008645 {not available when compiled without the |+wildignore|
8646 feature}
8647 A list of file patterns. A file that matches with one of these
Bram Moolenaar30b65812012-07-12 22:01:11 +02008648 patterns is ignored when expanding |wildcards|, completing file or
8649 directory names, and influences the result of |expand()|, |glob()| and
8650 |globpath()| unless a flag is passed to disable this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008651 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
8652 Also see 'suffixes'.
8653 Example: >
8654 :set wildignore=*.o,*.obj
8655< The use of |:set+=| and |:set-=| is preferred when adding or removing
8656 a pattern from the list. This avoids problems when a future version
8657 uses another default.
8658
Bram Moolenaar94950a92010-12-02 16:01:29 +01008659
Bram Moolenaar81af9252010-12-10 20:35:50 +01008660 *'wildignorecase'* *'wic'* *'nowildignorecase'* *'nowic'*
Bram Moolenaar94950a92010-12-02 16:01:29 +01008661'wildignorecase' 'wic' boolean (default off)
8662 global
Bram Moolenaar94950a92010-12-02 16:01:29 +01008663 When set case is ignored when completing file names and directories.
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01008664 Has no effect when 'fileignorecase' is set.
Bram Moolenaar94950a92010-12-02 16:01:29 +01008665 Does not apply when the shell is used to expand wildcards, which
8666 happens when there are special characters.
8667
8668
Bram Moolenaar071d4272004-06-13 20:20:40 +00008669 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02008670'wildmenu' 'wmnu' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008671 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008672 {not available if compiled without the |+wildmenu|
8673 feature}
8674 When 'wildmenu' is on, command-line completion operates in an enhanced
8675 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
8676 the possible matches are shown just above the command line, with the
8677 first match highlighted (overwriting the status line, if there is
8678 one). Keys that show the previous/next match, such as <Tab> or
8679 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
8680 When 'wildmode' is used, "wildmenu" mode is used where "full" is
8681 specified. "longest" and "list" do not start "wildmenu" mode.
Bram Moolenaar26402cb2013-02-20 21:26:00 +01008682 You can check the current mode with |wildmenumode()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008683 If there are more matches than can fit in the line, a ">" is shown on
8684 the right and/or a "<" is shown on the left. The status line scrolls
8685 as needed.
8686 The "wildmenu" mode is abandoned when a key is hit that is not used
8687 for selecting a completion.
8688 While the "wildmenu" is active the following keys have special
8689 meanings:
8690
8691 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
8692 <Down> - in filename/menu name completion: move into a
8693 subdirectory or submenu.
8694 <CR> - in menu completion, when the cursor is just after a
8695 dot: move into a submenu.
8696 <Up> - in filename/menu name completion: move up into
8697 parent directory or parent menu.
8698
8699 This makes the menus accessible from the console |console-menus|.
8700
8701 If you prefer the <Left> and <Right> keys to move the cursor instead
8702 of selecting a different match, use this: >
8703 :cnoremap <Left> <Space><BS><Left>
8704 :cnoremap <Right> <Space><BS><Right>
8705<
8706 The "WildMenu" highlighting is used for displaying the current match
8707 |hl-WildMenu|.
8708
8709 *'wildmode'* *'wim'*
8710'wildmode' 'wim' string (Vim default: "full")
8711 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008712 Completion mode that is used for the character specified with
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008713 'wildchar'. It is a comma separated list of up to four parts. Each
Bram Moolenaar02467872007-05-06 13:22:01 +00008714 part specifies what to do for each consecutive use of 'wildchar'. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00008715 first part specifies the behavior for the first use of 'wildchar',
8716 The second part for the second use, etc.
8717 These are the possible values for each part:
8718 "" Complete only the first match.
8719 "full" Complete the next full match. After the last match,
8720 the original string is used and then the first match
8721 again.
8722 "longest" Complete till longest common string. If this doesn't
8723 result in a longer string, use the next part.
8724 "longest:full" Like "longest", but also start 'wildmenu' if it is
8725 enabled.
8726 "list" When more than one match, list all matches.
8727 "list:full" When more than one match, list all matches and
8728 complete first match.
8729 "list:longest" When more than one match, list all matches and
8730 complete till longest common string.
Bram Moolenaar52410572019-10-27 05:12:45 +01008731 "list:lastused" When more than one buffer matches, sort buffers
8732 by time last used (other than the current buffer).
Bram Moolenaar071d4272004-06-13 20:20:40 +00008733 When there is only a single match, it is fully completed in all cases.
8734
8735 Examples: >
8736 :set wildmode=full
Bram Moolenaar582fd852005-03-28 20:58:01 +00008737< Complete first full match, next match, etc. (the default) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008738 :set wildmode=longest,full
8739< Complete longest common string, then each full match >
8740 :set wildmode=list:full
8741< List all matches and complete each full match >
8742 :set wildmode=list,full
8743< List all matches without completing, then each full match >
8744 :set wildmode=longest,list
8745< Complete longest common string, then list alternatives.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008746 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008747
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00008748 *'wildoptions'* *'wop'*
8749'wildoptions' 'wop' string (default "")
8750 global
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00008751 {not available when compiled without the |+wildignore|
8752 feature}
8753 A list of words that change how command line completion is done.
8754 Currently only one word is allowed:
8755 tagfile When using CTRL-D to list matching tags, the kind of
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00008756 tag and the file of the tag is listed. Only one match
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00008757 is displayed per line. Often used tag kinds are:
8758 d #define
8759 f function
8760 Also see |cmdline-completion|.
8761
Bram Moolenaar071d4272004-06-13 20:20:40 +00008762 *'winaltkeys'* *'wak'*
8763'winaltkeys' 'wak' string (default "menu")
8764 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008765 {only used in Win32, Motif, GTK and Photon GUI}
8766 Some GUI versions allow the access to menu entries by using the ALT
8767 key in combination with a character that appears underlined in the
8768 menu. This conflicts with the use of the ALT key for mappings and
8769 entering special characters. This option tells what to do:
8770 no Don't use ALT keys for menus. ALT key combinations can be
8771 mapped, but there is no automatic handling. This can then be
8772 done with the |:simalt| command.
8773 yes ALT key handling is done by the windowing system. ALT key
8774 combinations cannot be mapped.
8775 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008776 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00008777 keys can be mapped.
8778 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
8779 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00008780 This option is not used for <F10>; on Win32 and with GTK <F10> will
8781 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008782
Bram Moolenaar4d784b22019-05-25 19:51:39 +02008783 *'wincolor'* *'wcr'*
8784'wincolor' 'wcr' string (default empty)
8785 local to window
8786 Highlight group name to use for this window instead of the Normal
8787 color |hl-Normal|.
8788
Bram Moolenaar4399ef42005-02-12 14:29:27 +00008789 *'window'* *'wi'*
8790'window' 'wi' number (default screen height - 1)
8791 global
8792 Window height. Do not confuse this with the height of the Vim window,
8793 use 'lines' for that.
Bram Moolenaar19a09a12005-03-04 23:39:37 +00008794 Used for |CTRL-F| and |CTRL-B| when there is only one window and the
8795 value is smaller than 'lines' minus one. The screen will scroll
8796 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00008797 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
8798 in a much smarter way, taking care of wrapping lines.
8799 When resizing the Vim window, the value is smaller than 1 or more than
8800 or equal to 'lines' it will be set to 'lines' minus 1.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00008801
Bram Moolenaar071d4272004-06-13 20:20:40 +00008802 *'winheight'* *'wh'* *E591*
8803'winheight' 'wh' number (default 1)
8804 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008805 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008806 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar446cb832008-06-24 21:56:24 +00008807 focus goes to a window that is smaller, its size is increased, at the
8808 cost of the height of other windows.
8809 Set 'winheight' to a small number for normal editing.
8810 Set it to 999 to make the current window fill most of the screen.
8811 Other windows will be only 'winminheight' high. This has the drawback
8812 that ":all" will create only two windows. To avoid "vim -o 1 2 3 4"
8813 to create only two windows, set the option after startup is done,
8814 using the |VimEnter| event: >
8815 au VimEnter * set winheight=999
8816< Minimum value is 1.
8817 The height is not adjusted after one of the commands that change the
Bram Moolenaar071d4272004-06-13 20:20:40 +00008818 height of the current window.
8819 'winheight' applies to the current window. Use 'winminheight' to set
8820 the minimal height for other windows.
8821
8822 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
8823'winfixheight' 'wfh' boolean (default off)
8824 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00008825 Keep the window height when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00008826 'equalalways' is set. Also for |CTRL-W_=|. Set by default for the
8827 |preview-window| and |quickfix-window|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008828 The height may be changed anyway when running out of room.
8829
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008830 *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'*
8831'winfixwidth' 'wfw' boolean (default off)
8832 local to window
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008833 Keep the window width when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00008834 'equalalways' is set. Also for |CTRL-W_=|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008835 The width may be changed anyway when running out of room.
8836
Bram Moolenaar071d4272004-06-13 20:20:40 +00008837 *'winminheight'* *'wmh'*
8838'winminheight' 'wmh' number (default 1)
8839 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008840 The minimal height of a window, when it's not the current window.
8841 This is a hard minimum, windows will never become smaller.
8842 When set to zero, windows may be "squashed" to zero lines (i.e. just a
8843 status bar) if necessary. They will return to at least one line when
8844 they become active (since the cursor has to have somewhere to go.)
8845 Use 'winheight' to set the minimal height of the current window.
8846 This option is only checked when making a window smaller. Don't use a
8847 large number, it will cause errors when opening more than a few
8848 windows. A value of 0 to 3 is reasonable.
8849
8850 *'winminwidth'* *'wmw'*
8851'winminwidth' 'wmw' number (default 1)
8852 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008853 The minimal width of a window, when it's not the current window.
8854 This is a hard minimum, windows will never become smaller.
8855 When set to zero, windows may be "squashed" to zero columns (i.e. just
8856 a vertical separator) if necessary. They will return to at least one
8857 line when they become active (since the cursor has to have somewhere
8858 to go.)
8859 Use 'winwidth' to set the minimal width of the current window.
8860 This option is only checked when making a window smaller. Don't use a
8861 large number, it will cause errors when opening more than a few
8862 windows. A value of 0 to 12 is reasonable.
8863
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02008864 *'winptydll'*
8865'winptydll' string (default "winpty32.dll" or "winpty64.dll")
8866 global
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02008867 {only available when compiled with the |terminal|
8868 feature on MS-Windows}
8869 Specifies the name of the winpty shared library, used for the
8870 |:terminal| command. The default depends on whether was build as a
Bram Moolenaarc572da52017-08-27 16:52:01 +02008871 32-bit or 64-bit executable. If not found, "winpty.dll" is tried as
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02008872 a fallback.
8873 Environment variables are expanded |:set_env|.
8874 This option cannot be set from a |modeline| or in the |sandbox|, for
8875 security reasons.
8876
Bram Moolenaar071d4272004-06-13 20:20:40 +00008877 *'winwidth'* *'wiw'* *E592*
8878'winwidth' 'wiw' number (default 20)
8879 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008880 Minimal number of columns for the current window. This is not a hard
8881 minimum, Vim will use fewer columns if there is not enough room. If
8882 the current window is smaller, its size is increased, at the cost of
8883 the width of other windows. Set it to 999 to make the current window
8884 always fill the screen. Set it to a small number for normal editing.
8885 The width is not adjusted after one of the commands to change the
8886 width of the current window.
8887 'winwidth' applies to the current window. Use 'winminwidth' to set
8888 the minimal width for other windows.
8889
8890 *'wrap'* *'nowrap'*
8891'wrap' boolean (default on)
8892 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00008893 This option changes how text is displayed. It doesn't change the text
8894 in the buffer, see 'textwidth' for that.
8895 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008896 displaying continues on the next line. When off lines will not wrap
8897 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00008898 moved to a part that is not shown, the screen will scroll
8899 horizontally.
8900 The line will be broken in the middle of a word if necessary. See
8901 'linebreak' to get the break at a word boundary.
8902 To make scrolling horizontally a bit more useful, try this: >
8903 :set sidescroll=5
8904 :set listchars+=precedes:<,extends:>
8905< See 'sidescroll', 'listchars' and |wrap-off|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01008906 This option can't be set from a |modeline| when the 'diff' option is
8907 on.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008908
8909 *'wrapmargin'* *'wm'*
8910'wrapmargin' 'wm' number (default 0)
8911 local to buffer
8912 Number of characters from the right window border where wrapping
8913 starts. When typing text beyond this limit, an <EOL> will be inserted
8914 and inserting continues on the next line.
8915 Options that add a margin, such as 'number' and 'foldcolumn', cause
8916 the text width to be further reduced. This is Vi compatible.
8917 When 'textwidth' is non-zero, this option is not used.
Bram Moolenaarca635012015-09-25 20:34:21 +02008918 This option is set to 0 when 'paste' is set and restored when 'paste'
8919 is reset.
Bram Moolenaara6c27c42019-05-09 19:16:22 +02008920 See also 'formatoptions' and |ins-textwidth|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008921
8922 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
8923'wrapscan' 'ws' boolean (default on) *E384* *E385*
8924 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00008925 Searches wrap around the end of the file. Also applies to |]s| and
8926 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008927
8928 *'write'* *'nowrite'*
8929'write' boolean (default on)
8930 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008931 Allows writing files. When not set, writing a file is not allowed.
8932 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008933 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00008934 argument. Filtering text is still possible, even though this requires
8935 writing a temporary file.
8936
8937 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
8938'writeany' 'wa' boolean (default off)
8939 global
8940 Allows writing to any file with no need for "!" override.
8941
8942 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
8943'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
8944 otherwise)
8945 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008946 Make a backup before overwriting a file. The backup is removed after
8947 the file was successfully written, unless the 'backup' option is
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02008948 also on.
8949 WARNING: Switching this option off means that when Vim fails to write
8950 your buffer correctly and then, for whatever reason, Vim exits, you
8951 lose both the original file and what you were writing. Only reset
8952 this option if your file system is almost full and it makes the write
8953 fail (and make sure not to exit Vim until the write was successful).
8954 See |backup-table| for another explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008955 When the 'backupskip' pattern matches, a backup is not made anyway.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01008956 Depending on 'backupcopy' the backup is a new file or the original
8957 file renamed (and a new file is written).
Bram Moolenaar071d4272004-06-13 20:20:40 +00008958 NOTE: This option is set to the default value when 'compatible' is
8959 set.
8960
8961 *'writedelay'* *'wd'*
8962'writedelay' 'wd' number (default 0)
8963 global
Bram Moolenaar802a0d92016-06-26 16:17:58 +02008964 The number of milliseconds to wait for each character sent to the
Bram Moolenaar071d4272004-06-13 20:20:40 +00008965 screen. When non-zero, characters are sent to the terminal one by
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01008966 one. For debugging purposes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008967
Bram Moolenaar91f84f62018-07-29 15:07:52 +02008968 vim:tw=78:ts=8:noet:ft=help:norl: