blob: 5ee2ce13ac766688e23eb577df3b441a602be76f [file] [log] [blame]
Bram Moolenaard7df2792020-01-02 21:34:42 +01001*options.txt* For Vim version 8.2. Last change: 2020 Jan 01
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 Moolenaar22dbc772013-06-28 18:44:48 +0200520 [text]{white}{vi:|vim:|Vim:|ex:}[white]se[t] {options}:[text]
Bram Moolenaar071d4272004-06-13 20:20:40 +0000521
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200522[text] any text or empty
523{white} at least one blank character (<Space> or <Tab>)
524{vi:|vim:|Vim:|ex:} the string "vi:", "vim:", "Vim:" or "ex:"
525[white] optional white space
Bram Moolenaar14b69452013-06-29 23:05:20 +0200526se[t] the string "set " or "se " (note the space); When
527 "Vim" is used it must be "set".
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200528{options} a list of options, separated with white space, which
529 is the argument for a ":set" command
530: a colon
531[text] any text or empty
Bram Moolenaar071d4272004-06-13 20:20:40 +0000532
Bram Moolenaar14b69452013-06-29 23:05:20 +0200533Examples:
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000534 /* vim: set ai tw=75: */ ~
Bram Moolenaar14b69452013-06-29 23:05:20 +0200535 /* Vim: set ai tw=75: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000536
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200537The white space before {vi:|vim:|Vim:|ex:} is required. This minimizes the
538chance that a normal word like "lex:" is caught. There is one exception:
539"vi:" and "vim:" can also be at the start of the line (for compatibility with
540version 3.0). Using "ex:" at the start of the line will be ignored (this
541could be short for "example:").
Bram Moolenaar071d4272004-06-13 20:20:40 +0000542
543 *modeline-local*
544The options are set like with ":setlocal": The new value only applies to the
Bram Moolenaar843ee412004-06-30 16:16:41 +0000545buffer and window that contain the file. Although it's possible to set global
546options from a modeline, this is unusual. If you have two windows open and
547the files in it set the same global option to a different value, the result
548depends on which one was opened last.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000549
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +0000550When editing a file that was already loaded, only the window-local options
551from the modeline are used. Thus if you manually changed a buffer-local
552option after opening the file, it won't be changed if you edit the same buffer
553in another window. But window-local options will be set.
554
Bram Moolenaar071d4272004-06-13 20:20:40 +0000555 *modeline-version*
556If the modeline is only to be used for some versions of Vim, the version
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200557number can be specified where "vim:" or "Vim:" is used:
Bram Moolenaar071d4272004-06-13 20:20:40 +0000558 vim{vers}: version {vers} or later
559 vim<{vers}: version before {vers}
560 vim={vers}: version {vers}
561 vim>{vers}: version after {vers}
Bram Moolenaar2b8388b2015-02-28 13:11:45 +0100562{vers} is 700 for Vim 7.0 (hundred times the major version plus minor).
563For example, to use a modeline only for Vim 7.0:
564 /* vim700: set foldmethod=marker */ ~
565To use a modeline for Vim after version 7.2:
566 /* vim>702: set cole=2: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000567There can be no blanks between "vim" and the ":".
568
569
570The number of lines that are checked can be set with the 'modelines' option.
571If 'modeline' is off or 'modelines' is 0 no lines are checked.
572
573Note that for the first form all of the rest of the line is used, thus a line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000574like:
575 /* vi:ts=4: */ ~
576will give an error message for the trailing "*/". This line is OK:
577 /* vi:set ts=4: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000578
579If an error is detected the rest of the line is skipped.
580
581If you want to include a ':' in a set command precede it with a '\'. The
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000582backslash in front of the ':' will be removed. Example:
Bram Moolenaar95a9dd12019-12-19 22:12:03 +0100583 /* vi:set fillchars=stl\:^,vert\:\|: */ ~
584This sets the 'fillchars' option to "stl:^,vert:\|". Only a single backslash
585before the ':' is removed. Thus to include "\:" you have to specify "\\:".
Bram Moolenaar110289e2019-05-23 15:38:06 +0200586 *E992*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000587No other commands than "set" are supported, for security reasons (somebody
Bram Moolenaar8243a792007-05-01 17:05:03 +0000588might create a Trojan horse text file with modelines). And not all options
Bram Moolenaar110289e2019-05-23 15:38:06 +0200589can be set. For some options a flag is set, so that when the value is used
590the |sandbox| is effective. Some options can only be set from the modeline
591when 'modelineexpr' is set (the default is off).
592
593Still, there is always a small risk that a modeline causes trouble. E.g.,
594when some joker sets 'textwidth' to 5 all your lines are wrapped unexpectedly.
595So disable modelines before editing untrusted text. The mail ftplugin does
596this, for example.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000597
598Hint: If you would like to do something else than setting an option, you could
599define an autocommand that checks the file for a specific string. For
600example: >
601 au BufReadPost * if getline(1) =~ "VAR" | call SetVar() | endif
602And define a function SetVar() that does something with the line containing
603"VAR".
604
605==============================================================================
6063. Options summary *option-summary*
607
608In the list below all the options are mentioned with their full name and with
609an abbreviation if there is one. Both forms may be used.
610
611In this document when a boolean option is "set" that means that ":set option"
612is entered. When an option is "reset", ":set nooption" is used.
613
614For some options there are two default values: The "Vim default", which is
615used when 'compatible' is not set, and the "Vi default", which is used when
616'compatible' is set.
617
618Most options are the same in all windows and buffers. There are a few that
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000619are specific to how the text is presented in a window. These can be set to a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000620different value in each window. For example the 'list' option can be set in
621one window and reset in another for the same text, giving both types of view
622at the same time. There are a few options that are specific to a certain
623file. These can have a different value for each file or buffer. For example
624the 'textwidth' option can be 78 for a normal text file and 0 for a C
625program.
626
627 global one option for all buffers and windows
628 local to window each window has its own copy of this option
629 local to buffer each buffer has its own copy of this option
630
631When creating a new window the option values from the currently active window
632are used as a default value for the window-specific options. For the
633buffer-specific options this depends on the 's' and 'S' flags in the
634'cpoptions' option. If 's' is included (which is the default) the values for
635buffer options are copied from the currently active buffer when a buffer is
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000636first entered. If 'S' is present the options are copied each time the buffer
637is entered, this is almost like having global options. If 's' and 'S' are not
Bram Moolenaar071d4272004-06-13 20:20:40 +0000638present, the options are copied from the currently active buffer when the
639buffer is created.
640
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000641Hidden options *hidden-options*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000642
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000643Not all options are supported in all versions. This depends on the supported
644features and sometimes on the system. A remark about this is in curly braces
645below. When an option is not supported it may still be set without getting an
646error, this is called a hidden option. You can't get the value of a hidden
647option though, it is not stored.
648
649To test if option "foo" can be used with ":set" use something like this: >
650 if exists('&foo')
651This also returns true for a hidden option. To test if option "foo" is really
652supported use something like this: >
653 if exists('+foo')
654<
Bram Moolenaar071d4272004-06-13 20:20:40 +0000655 *E355*
656A jump table for the options with a short description can be found at |Q_op|.
657
658 *'aleph'* *'al'* *aleph* *Aleph*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +0100659'aleph' 'al' number (default 128 for MS-Windows, 224 otherwise)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000660 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000661 {only available when compiled with the |+rightleft|
662 feature}
663 The ASCII code for the first letter of the Hebrew alphabet. The
664 routine that maps the keyboard in Hebrew mode, both in Insert mode
665 (when hkmap is set) and on the command-line (when hitting CTRL-_)
666 outputs the Hebrew characters in the range [aleph..aleph+26].
667 aleph=128 applies to PC code, and aleph=224 applies to ISO 8859-8.
668 See |rileft.txt|.
669
670 *'allowrevins'* *'ari'* *'noallowrevins'* *'noari'*
671'allowrevins' 'ari' boolean (default off)
672 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000673 {only available when compiled with the |+rightleft|
674 feature}
675 Allow CTRL-_ in Insert and Command-line mode. This is default off, to
676 avoid that users that accidentally type CTRL-_ instead of SHIFT-_ get
677 into reverse Insert mode, and don't know how to get out. See
678 'revins'.
679 NOTE: This option is reset when 'compatible' is set.
680
681 *'altkeymap'* *'akm'* *'noaltkeymap'* *'noakm'*
682'altkeymap' 'akm' boolean (default off)
683 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000684 {only available when compiled with the |+farsi|
685 feature}
Bram Moolenaar14184a32019-02-16 15:10:30 +0100686 This option was for using Farsi, which has been removed. See
687 |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000688
689 *'ambiwidth'* *'ambw'*
690'ambiwidth' 'ambw' string (default: "single")
691 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000692 Only effective when 'encoding' is "utf-8" or another Unicode encoding.
693 Tells Vim what to do with characters with East Asian Width Class
694 Ambiguous (such as Euro, Registered Sign, Copyright Sign, Greek
695 letters, Cyrillic letters).
696
697 There are currently two possible values:
Bram Moolenaar582fd852005-03-28 20:58:01 +0000698 "single": Use the same width as characters in US-ASCII. This is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000699 expected by most users.
700 "double": Use twice the width of ASCII characters.
Bram Moolenaar5c3bd0a2010-08-04 20:55:44 +0200701 *E834* *E835*
702 The value "double" cannot be used if 'listchars' or 'fillchars'
703 contains a character that would be double width.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000704
705 There are a number of CJK fonts for which the width of glyphs for
706 those characters are solely based on how many octets they take in
707 legacy/traditional CJK encodings. In those encodings, Euro,
708 Registered sign, Greek/Cyrillic letters are represented by two octets,
Bram Moolenaar582fd852005-03-28 20:58:01 +0000709 therefore those fonts have "wide" glyphs for them. This is also
Bram Moolenaar071d4272004-06-13 20:20:40 +0000710 true of some line drawing characters used to make tables in text
Bram Moolenaar582fd852005-03-28 20:58:01 +0000711 file. Therefore, when a CJK font is used for GUI Vim or
Bram Moolenaar071d4272004-06-13 20:20:40 +0000712 Vim is running inside a terminal (emulators) that uses a CJK font
713 (or Vim is run inside an xterm invoked with "-cjkwidth" option.),
714 this option should be set to "double" to match the width perceived
715 by Vim with the width of glyphs in the font. Perhaps it also has
Bram Moolenaar8024f932020-01-14 19:29:13 +0100716 to be set to "double" under CJK MS-Windows when the system locale is
717 set to one of CJK locales. See Unicode Standard Annex #11
718 (http://www.unicode.org/reports/tr11).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000719
Bram Moolenaarac7bd632013-03-19 11:35:58 +0100720 Vim may set this option automatically at startup time when Vim is
721 compiled with the |+termresponse| feature and if |t_u7| is set to the
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200722 escape sequence to request cursor position report. The response can
723 be found in |v:termu7resp|.
Bram Moolenaarac7bd632013-03-19 11:35:58 +0100724
Bram Moolenaar071d4272004-06-13 20:20:40 +0000725 *'antialias'* *'anti'* *'noantialias'* *'noanti'*
726'antialias' 'anti' boolean (default: off)
727 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000728 {only available when compiled with GUI enabled
729 on Mac OS X}
730 This option only has an effect in the GUI version of Vim on Mac OS X
731 v10.2 or later. When on, Vim will use smooth ("antialiased") fonts,
732 which can be easier to read at certain sizes on certain displays.
733 Setting this option can sometimes cause problems if 'guifont' is set
734 to its default (empty string).
Bram Moolenaar036986f2017-03-16 17:41:02 +0100735 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000736
737 *'autochdir'* *'acd'* *'noautochdir'* *'noacd'*
738'autochdir' 'acd' boolean (default off)
739 global
Bram Moolenaar00a927d2010-05-14 23:24:24 +0200740 {only available when compiled with it, use
741 exists("+autochdir") to check}
Bram Moolenaard8c00872005-07-22 21:52:15 +0000742 When on, Vim will change the current working directory whenever you
743 open a file, switch buffers, delete a buffer or open/close a window.
744 It will change to the directory containing the file which was opened
745 or selected.
Bram Moolenaar910f66f2006-04-05 20:41:53 +0000746 Note: When this option is on some plugins may not work.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000747
748 *'arabic'* *'arab'* *'noarabic'* *'noarab'*
749'arabic' 'arab' boolean (default off)
750 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +0000751 {only available when compiled with the |+arabic|
752 feature}
753 This option can be set to start editing Arabic text.
754 Setting this option will:
755 - Set the 'rightleft' option, unless 'termbidi' is set.
756 - Set the 'arabicshape' option, unless 'termbidi' is set.
757 - Set the 'keymap' option to "arabic"; in Insert mode CTRL-^ toggles
758 between typing English and Arabic key mapping.
759 - Set the 'delcombine' option
760 Note that 'encoding' must be "utf-8" for working with Arabic text.
761
762 Resetting this option will:
763 - Reset the 'rightleft' option.
764 - Disable the use of 'keymap' (without changing its value).
765 Note that 'arabicshape' and 'delcombine' are not reset (it is a global
Bram Moolenaarc8734422012-06-01 22:38:45 +0200766 option).
Bram Moolenaar036986f2017-03-16 17:41:02 +0100767 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000768 Also see |arabic.txt|.
769
770 *'arabicshape'* *'arshape'*
771 *'noarabicshape'* *'noarshape'*
772'arabicshape' 'arshape' boolean (default on)
773 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000774 {only available when compiled with the |+arabic|
775 feature}
776 When on and 'termbidi' is off, the required visual character
777 corrections that need to take place for displaying the Arabic language
Bram Moolenaar3a0d8092012-10-21 03:02:54 +0200778 take effect. Shaping, in essence, gets enabled; the term is a broad
Bram Moolenaar071d4272004-06-13 20:20:40 +0000779 one which encompasses:
780 a) the changing/morphing of characters based on their location
781 within a word (initial, medial, final and stand-alone).
782 b) the enabling of the ability to compose characters
783 c) the enabling of the required combining of some characters
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100784 When disabled the display shows each character's true stand-alone
785 form.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000786 Arabic is a complex language which requires other settings, for
787 further details see |arabic.txt|.
Bram Moolenaar036986f2017-03-16 17:41:02 +0100788 NOTE: This option is set when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000789
790 *'autoindent'* *'ai'* *'noautoindent'* *'noai'*
791'autoindent' 'ai' boolean (default off)
792 local to buffer
793 Copy indent from current line when starting a new line (typing <CR>
794 in Insert mode or when using the "o" or "O" command). If you do not
795 type anything on the new line except <BS> or CTRL-D and then type
Bram Moolenaar02467872007-05-06 13:22:01 +0000796 <Esc>, CTRL-O or <CR>, the indent is deleted again. Moving the cursor
797 to another line has the same effect, unless the 'I' flag is included
798 in 'cpoptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000799 When autoindent is on, formatting (with the "gq" command or when you
800 reach 'textwidth' in Insert mode) uses the indentation of the first
801 line.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000802 When 'smartindent' or 'cindent' is on the indent is changed in
803 a different way.
Bram Moolenaarca635012015-09-25 20:34:21 +0200804 The 'autoindent' option is reset when the 'paste' option is set and
805 restored when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000806
807 *'autoread'* *'ar'* *'noautoread'* *'noar'*
808'autoread' 'ar' boolean (default off)
809 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000810 When a file has been detected to have been changed outside of Vim and
811 it has not been changed inside of Vim, automatically read it again.
Bram Moolenaarfd358112018-07-07 23:21:31 +0200812 When the file has been deleted this is not done, so you have the text
813 from before it was deleted. When it appears again then it is read.
814 |timestamp|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000815 If this option has a local value, use this command to switch back to
816 using the global value: >
817 :set autoread<
818<
819 *'autowrite'* *'aw'* *'noautowrite'* *'noaw'*
820'autowrite' 'aw' boolean (default off)
821 global
822 Write the contents of the file, if it has been modified, on each
823 :next, :rewind, :last, :first, :previous, :stop, :suspend, :tag, :!,
Bram Moolenaar14716812006-05-04 21:54:08 +0000824 :make, CTRL-] and CTRL-^ command; and when a :buffer, CTRL-O, CTRL-I,
Bram Moolenaar071d4272004-06-13 20:20:40 +0000825 '{A-Z0-9}, or `{A-Z0-9} command takes one to another file.
826 Note that for some commands the 'autowrite' option is not used, see
827 'autowriteall' for that.
Bram Moolenaar93a1df22018-09-10 11:51:50 +0200828 Some buffers will not be written, specifically when 'buftype' is
Bram Moolenaar20aac6c2018-09-02 21:07:30 +0200829 "nowrite", "nofile", "terminal" or "prompt".
Bram Moolenaar071d4272004-06-13 20:20:40 +0000830
831 *'autowriteall'* *'awa'* *'noautowriteall'* *'noawa'*
832'autowriteall' 'awa' boolean (default off)
833 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000834 Like 'autowrite', but also used for commands ":edit", ":enew", ":quit",
835 ":qall", ":exit", ":xit", ":recover" and closing the Vim window.
836 Setting this option also implies that Vim behaves like 'autowrite' has
837 been set.
838
839 *'background'* *'bg'*
Bram Moolenaar446beb42011-05-10 17:18:44 +0200840'background' 'bg' string (default "dark" or "light", see below)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000841 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000842 When set to "dark", Vim will try to use colors that look good on a
843 dark background. When set to "light", Vim will try to use colors that
844 look good on a light background. Any other value is illegal.
845 Vim tries to set the default value according to the terminal used.
846 This will not always be correct.
847 Setting this option does not change the background color, it tells Vim
848 what the background color looks like. For changing the background
849 color, see |:hi-normal|.
850
851 When 'background' is set Vim will adjust the default color groups for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000852 the new value. But the colors used for syntax highlighting will not
Bram Moolenaar446cb832008-06-24 21:56:24 +0000853 change. *g:colors_name*
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100854 When a color scheme is loaded (the "g:colors_name" variable is set)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000855 setting 'background' will cause the color scheme to be reloaded. If
856 the color scheme adjusts to the value of 'background' this will work.
857 However, if the color scheme sets 'background' itself the effect may
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100858 be undone. First delete the "g:colors_name" variable when needed.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000859
860 When setting 'background' to the default value with: >
861 :set background&
862< Vim will guess the value. In the GUI this should work correctly,
863 in other cases Vim might not be able to guess the right value.
Bram Moolenaar2e693a82019-10-16 22:35:02 +0200864 If the GUI supports a dark theme, you can use the "d" flag in
Bram Moolenaar50bf7ce2019-09-15 13:17:00 +0200865 'guioptions', see 'go-d'.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000866
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200867 When the |t_RB| option is set, Vim will use it to request the background
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +0200868 color from the terminal. If the returned RGB value is dark/light and
869 'background' is not dark/light, 'background' will be set and the
870 screen is redrawn. This may have side effects, make t_BG empty in
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200871 your .vimrc if you suspect this problem. The response to |t_RB| can
Bram Moolenaar01164a62017-11-02 22:58:42 +0100872 be found in |v:termrbgresp|.
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +0200873
Bram Moolenaar071d4272004-06-13 20:20:40 +0000874 When starting the GUI, the default value for 'background' will be
875 "light". When the value is not set in the .gvimrc, and Vim detects
876 that the background is actually quite dark, 'background' is set to
877 "dark". But this happens only AFTER the .gvimrc file has been read
878 (because the window needs to be opened to find the actual background
879 color). To get around this, force the GUI window to be opened by
880 putting a ":gui" command in the .gvimrc file, before where the value
881 of 'background' is used (e.g., before ":syntax on").
Bram Moolenaar446beb42011-05-10 17:18:44 +0200882
Bram Moolenaar6f345a12019-12-17 21:27:18 +0100883 For MS-Windows the default is "dark".
Bram Moolenaar446beb42011-05-10 17:18:44 +0200884 For other systems "dark" is used when 'term' is "linux",
885 "screen.linux", "cygwin" or "putty", or $COLORFGBG suggests a dark
886 background. Otherwise the default is "light".
887
Bram Moolenaarc572da52017-08-27 16:52:01 +0200888 The |:terminal| command and the |term_start()| function use the
889 'background' value to decide whether the terminal window will start
890 with a white or black background.
891
Bram Moolenaar071d4272004-06-13 20:20:40 +0000892 Normally this option would be set in the .vimrc file. Possibly
893 depending on the terminal name. Example: >
894 :if &term == "pcterm"
895 : set background=dark
896 :endif
897< When this option is set, the default settings for the highlight groups
898 will change. To use other settings, place ":highlight" commands AFTER
899 the setting of the 'background' option.
900 This option is also used in the "$VIMRUNTIME/syntax/syntax.vim" file
901 to select the colors for syntax highlighting. After changing this
902 option, you must load syntax.vim again to see the result. This can be
903 done with ":syntax on".
904
905 *'backspace'* *'bs'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +0200906'backspace' 'bs' string (default "", set to "indent,eol,start"
907 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000908 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000909 Influences the working of <BS>, <Del>, CTRL-W and CTRL-U in Insert
910 mode. This is a list of items, separated by commas. Each item allows
911 a way to backspace over something:
912 value effect ~
913 indent allow backspacing over autoindent
914 eol allow backspacing over line breaks (join lines)
915 start allow backspacing over the start of insert; CTRL-W and CTRL-U
916 stop once at the start of insert.
917
918 When the value is empty, Vi compatible backspacing is used.
919
920 For backwards compatibility with version 5.4 and earlier:
921 value effect ~
922 0 same as ":set backspace=" (Vi compatible)
923 1 same as ":set backspace=indent,eol"
924 2 same as ":set backspace=indent,eol,start"
925
926 See |:fixdel| if your <BS> or <Del> key does not do what you want.
927 NOTE: This option is set to "" when 'compatible' is set.
928
929 *'backup'* *'bk'* *'nobackup'* *'nobk'*
930'backup' 'bk' boolean (default off)
931 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000932 Make a backup before overwriting a file. Leave it around after the
933 file has been successfully written. If you do not want to keep the
934 backup file, but you do want a backup while the file is being
935 written, reset this option and set the 'writebackup' option (this is
936 the default). If you do not want a backup file at all reset both
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000937 options (use this if your file system is almost full). See the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000938 |backup-table| for more explanations.
939 When the 'backupskip' pattern matches, a backup is not made anyway.
940 When 'patchmode' is set, the backup may be renamed to become the
941 oldest version of a file.
942 NOTE: This option is reset when 'compatible' is set.
943
944 *'backupcopy'* *'bkc'*
945'backupcopy' 'bkc' string (Vi default for Unix: "yes", otherwise: "auto")
Bram Moolenaarb8ee25a2014-09-23 15:45:08 +0200946 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000947 When writing a file and a backup is made, this option tells how it's
948 done. This is a comma separated list of words.
949
950 The main values are:
951 "yes" make a copy of the file and overwrite the original one
952 "no" rename the file and write a new one
953 "auto" one of the previous, what works best
954
955 Extra values that can be combined with the ones above are:
956 "breaksymlink" always break symlinks when writing
957 "breakhardlink" always break hardlinks when writing
958
959 Making a copy and overwriting the original file:
960 - Takes extra time to copy the file.
961 + When the file has special attributes, is a (hard/symbolic) link or
962 has a resource fork, all this is preserved.
963 - When the file is a link the backup will have the name of the link,
964 not of the real file.
965
966 Renaming the file and writing a new one:
967 + It's fast.
968 - Sometimes not all attributes of the file can be copied to the new
969 file.
970 - When the file is a link the new file will not be a link.
971
972 The "auto" value is the middle way: When Vim sees that renaming file
973 is possible without side effects (the attributes can be passed on and
Bram Moolenaar02467872007-05-06 13:22:01 +0000974 the file is not a link) that is used. When problems are expected, a
975 copy will be made.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000976
977 The "breaksymlink" and "breakhardlink" values can be used in
978 combination with any of "yes", "no" and "auto". When included, they
979 force Vim to always break either symbolic or hard links by doing
980 exactly what the "no" option does, renaming the original file to
981 become the backup and writing a new file in its place. This can be
982 useful for example in source trees where all the files are symbolic or
983 hard links and any changes should stay in the local source tree, not
984 be propagated back to the original source.
985 *crontab*
986 One situation where "no" and "auto" will cause problems: A program
987 that opens a file, invokes Vim to edit that file, and then tests if
988 the open file was changed (through the file descriptor) will check the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000989 backup file instead of the newly created file. "crontab -e" is an
Bram Moolenaar071d4272004-06-13 20:20:40 +0000990 example.
991
992 When a copy is made, the original file is truncated and then filled
993 with the new text. This means that protection bits, owner and
994 symbolic links of the original file are unmodified. The backup file
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000995 however, is a new file, owned by the user who edited the file. The
Bram Moolenaar071d4272004-06-13 20:20:40 +0000996 group of the backup is set to the group of the original file. If this
997 fails, the protection bits for the group are made the same as for
998 others.
999
1000 When the file is renamed this is the other way around: The backup has
1001 the same attributes of the original file, and the newly written file
1002 is owned by the current user. When the file was a (hard/symbolic)
1003 link, the new file will not! That's why the "auto" value doesn't
1004 rename when the file is a link. The owner and group of the newly
1005 written file will be set to the same ones as the original file, but
1006 the system may refuse to do this. In that case the "auto" value will
1007 again not rename the file.
1008
Bram Moolenaar036986f2017-03-16 17:41:02 +01001009 NOTE: This option is set to the Vi default value when 'compatible' is
1010 set and to the Vim default value when 'compatible' is reset.
1011
Bram Moolenaar071d4272004-06-13 20:20:40 +00001012 *'backupdir'* *'bdir'*
1013'backupdir' 'bdir' string (default for Amiga: ".,t:",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01001014 for Win32: ".,$TEMP,c:/tmp,c:/temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001015 for Unix: ".,~/tmp,~/")
1016 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001017 List of directories for the backup file, separated with commas.
1018 - The backup file will be created in the first directory in the list
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001019 where this is possible. The directory must exist, Vim will not
1020 create it for you.
Bram Moolenaar3848e002016-03-19 18:42:29 +01001021 - Empty means that no backup file will be created ('patchmode' is
Bram Moolenaar071d4272004-06-13 20:20:40 +00001022 impossible!). Writing may fail because of this.
1023 - A directory "." means to put the backup file in the same directory
1024 as the edited file.
Bram Moolenaar8024f932020-01-14 19:29:13 +01001025 - A directory starting with "./" (or ".\" for MS-Windows) means to put
1026 the backup file relative to where the edited file is. The leading
1027 "." is replaced with the path name of the edited file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001028 ("." inside a directory name has no special meaning).
1029 - Spaces after the comma are ignored, other spaces are considered part
1030 of the directory name. To have a space at the start of a directory
1031 name, precede it with a backslash.
1032 - To include a comma in a directory name precede it with a backslash.
1033 - A directory name may end in an '/'.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02001034 - For Unix and Win32, if a directory ends in two path separators "//",
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01001035 the backup file name will be built from the complete path to the
1036 file with all path separators changed to percent '%' signs. This
1037 will ensure file name uniqueness in the backup directory.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02001038 On Win32, it is also possible to end with "\\". However, When a
1039 separating comma is following, you must use "//", since "\\" will
1040 include the comma in the file name. Therefore it is recommended to
1041 use '//', instead of '\\'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001042 - Environment variables are expanded |:set_env|.
1043 - Careful with '\' characters, type one before a space, type two to
1044 get one in the option (see |option-backslash|), for example: >
1045 :set bdir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
1046< - For backwards compatibility with Vim version 3.0 a '>' at the start
1047 of the option is removed.
1048 See also 'backup' and 'writebackup' options.
1049 If you want to hide your backup files on Unix, consider this value: >
1050 :set backupdir=./.backup,~/.backup,.,/tmp
1051< You must create a ".backup" directory in each directory and in your
1052 home directory for this to work properly.
1053 The use of |:set+=| and |:set-=| is preferred when adding or removing
1054 directories from the list. This avoids problems when a future version
1055 uses another default.
1056 This option cannot be set from a |modeline| or in the |sandbox|, for
1057 security reasons.
1058
1059 *'backupext'* *'bex'* *E589*
1060'backupext' 'bex' string (default "~", for VMS: "_")
1061 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001062 String which is appended to a file name to make the name of the
1063 backup file. The default is quite unusual, because this avoids
1064 accidentally overwriting existing files with a backup file. You might
1065 prefer using ".bak", but make sure that you don't have files with
1066 ".bak" that you want to keep.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001067 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001068
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001069 If you like to keep a lot of backups, you could use a BufWritePre
1070 autocommand to change 'backupext' just before writing the file to
1071 include a timestamp. >
1072 :au BufWritePre * let &bex = '-' . strftime("%Y%b%d%X") . '~'
1073< Use 'backupdir' to put the backup in a different directory.
1074
Bram Moolenaar071d4272004-06-13 20:20:40 +00001075 *'backupskip'* *'bsk'*
Bram Moolenaarb8e22a02018-04-12 21:37:34 +02001076'backupskip' 'bsk' string (default: "$TMPDIR/*,$TMP/*,$TEMP/*"
1077 Unix: "/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*"
1078 Mac: "/private/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001079 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001080 {not available when compiled without the |+wildignore|
1081 feature}
1082 A list of file patterns. When one of the patterns matches with the
1083 name of the file which is written, no backup file is created. Both
1084 the specified file name and the full path name of the file are used.
1085 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
1086 Watch out for special characters, see |option-backslash|.
1087 When $TMPDIR, $TMP or $TEMP is not defined, it is not used for the
Bram Moolenaar582fd852005-03-28 20:58:01 +00001088 default value. "/tmp/*" is only used for Unix.
Bram Moolenaar02467872007-05-06 13:22:01 +00001089
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02001090 WARNING: Not having a backup file means that when Vim fails to write
1091 your buffer correctly and then, for whatever reason, Vim exits, you
1092 lose both the original file and what you were writing. Only disable
1093 backups if you don't care about losing the file.
1094
Bram Moolenaar02467872007-05-06 13:22:01 +00001095 Note that environment variables are not expanded. If you want to use
1096 $HOME you must expand it explicitly, e.g.: >
Bram Moolenaar7c1c6db2016-04-03 22:08:05 +02001097 :let &backupskip = escape(expand('$HOME'), '\') . '/tmp/*'
Bram Moolenaar02467872007-05-06 13:22:01 +00001098
1099< Note that the default also makes sure that "crontab -e" works (when a
Bram Moolenaara5792f52005-11-23 21:25:05 +00001100 backup would be made by renaming the original file crontab won't see
1101 the newly created file). Also see 'backupcopy' and |crontab|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001102
1103 *'balloondelay'* *'bdlay'*
1104'balloondelay' 'bdlay' number (default: 600)
1105 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001106 {only available when compiled with the |+balloon_eval|
1107 feature}
1108 Delay in milliseconds before a balloon may pop up. See |balloon-eval|.
1109
1110 *'ballooneval'* *'beval'* *'noballooneval'* *'nobeval'*
1111'ballooneval' 'beval' boolean (default off)
1112 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001113 {only available when compiled with the |+balloon_eval|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001114 feature}
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001115 Switch on the |balloon-eval| functionality for the GUI.
1116
1117 *'balloonevalterm'* *'bevalterm'* *'noballoonevalterm'*
1118 *'nobevalterm'*
1119'balloonevalterm' 'bevalterm' boolean (default off)
1120 global
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001121 {only available when compiled with the
1122 |+balloon_eval_term| feature}
1123 Switch on the |balloon-eval| functionality for the terminal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001124
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001125 *'balloonexpr'* *'bexpr'*
1126'balloonexpr' 'bexpr' string (default "")
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00001127 global or local to buffer |global-local|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001128 {only available when compiled with the |+balloon_eval|
1129 feature}
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00001130 Expression for text to show in evaluation balloon. It is only used
Bram Moolenaara6c27c42019-05-09 19:16:22 +02001131 when 'ballooneval' or 'balloonevalterm' is on. These variables can be
1132 used:
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001133
1134 v:beval_bufnr number of the buffer in which balloon is going to show
1135 v:beval_winnr number of the window
Bram Moolenaar82af8712016-06-04 20:20:29 +02001136 v:beval_winid ID of the window
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001137 v:beval_lnum line number
1138 v:beval_col column number (byte index)
1139 v:beval_text word under or after the mouse pointer
1140
Bram Moolenaar54775062019-07-31 21:07:14 +02001141 Instead of showing a balloon, which is limited to plain text, consider
1142 using a popup window, see |popup_beval_example|. A popup window can
1143 use highlighting and show a border.
1144
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001145 The evaluation of the expression must not have side effects!
1146 Example: >
Bram Moolenaara6c27c42019-05-09 19:16:22 +02001147 function MyBalloonExpr()
Bram Moolenaar45360022005-07-21 21:08:21 +00001148 return 'Cursor is at line ' . v:beval_lnum .
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001149 \', column ' . v:beval_col .
1150 \ ' of file ' . bufname(v:beval_bufnr) .
1151 \ ' on word "' . v:beval_text . '"'
1152 endfunction
1153 set bexpr=MyBalloonExpr()
1154 set ballooneval
1155<
Bram Moolenaar396e8292019-07-13 23:04:31 +02001156 Also see |balloon_show()|, it can be used if the content of the balloon
1157 is to be fetched asynchronously. In that case evaluating
1158 'balloonexpr' should result in an empty string. If you get a balloon
1159 with only "0" you probably didn't return anything from your function.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001160
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001161 NOTE: The balloon is displayed only if the cursor is on a text
1162 character. If the result of evaluating 'balloonexpr' is not empty,
1163 Vim does not try to send a message to an external debugger (Netbeans
1164 or Sun Workshop).
1165
Bram Moolenaar30b65812012-07-12 22:01:11 +02001166 The expression will be evaluated in the |sandbox| when set from a
1167 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02001168 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001169
1170 It is not allowed to change text or jump to another window while
Bram Moolenaar396e8292019-07-13 23:04:31 +02001171 evaluating 'balloonexpr', see |textlock|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001172
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001173 To check whether line breaks in the balloon text work use this check: >
Bram Moolenaar45360022005-07-21 21:08:21 +00001174 if has("balloon_multiline")
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001175< When they are supported "\n" characters will start a new line. If the
1176 expression evaluates to a |List| this is equal to using each List item
1177 as a string and putting "\n" in between them.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001178 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001179
Bram Moolenaar165bc692015-07-21 17:53:25 +02001180 *'belloff'* *'bo'*
1181'belloff' 'bo' string (default "")
1182 global
Bram Moolenaar165bc692015-07-21 17:53:25 +02001183 Specifies for which events the bell will not be rung. It is a comma
1184 separated list of items. For each item that is present, the bell
1185 will be silenced. This is most useful to specify specific events in
1186 insert mode to be silenced.
1187
1188 item meaning when present ~
1189 all All events.
1190 backspace When hitting <BS> or <Del> and deleting results in an
1191 error.
1192 cursor Fail to move around using the cursor keys or
1193 <PageUp>/<PageDown> in |Insert-mode|.
1194 complete Error occurred when using |i_CTRL-X_CTRL-K| or
1195 |i_CTRL-X_CTRL-T|.
1196 copy Cannot copy char from insert mode using |i_CTRL-Y| or
1197 |i_CTRL-E|.
1198 ctrlg Unknown Char after <C-G> in Insert mode.
1199 error Other Error occurred (e.g. try to join last line)
1200 (mostly used in |Normal-mode| or |Cmdline-mode|).
1201 esc hitting <Esc> in |Normal-mode|.
1202 ex In |Visual-mode|, hitting |Q| results in an error.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01001203 hangul Ignored.
Bram Moolenaar165bc692015-07-21 17:53:25 +02001204 insertmode Pressing <Esc> in 'insertmode'.
1205 lang Calling the beep module for Lua/Mzscheme/TCL.
1206 mess No output available for |g<|.
1207 showmatch Error occurred for 'showmatch' function.
1208 operator Empty region error |cpo-E|.
1209 register Unknown register after <C-R> in |Insert-mode|.
1210 shell Bell from shell output |:!|.
1211 spell Error happened on spell suggest.
1212 wildmode More matches in |cmdline-completion| available
1213 (depends on the 'wildmode' setting).
1214
Bram Moolenaar036986f2017-03-16 17:41:02 +01001215 This is most useful to fine tune when in Insert mode the bell should
1216 be rung. For Normal mode and Ex commands, the bell is often rung to
Bram Moolenaar165bc692015-07-21 17:53:25 +02001217 indicate that an error occurred. It can be silenced by adding the
1218 "error" keyword.
1219
Bram Moolenaar071d4272004-06-13 20:20:40 +00001220 *'binary'* *'bin'* *'nobinary'* *'nobin'*
1221'binary' 'bin' boolean (default off)
1222 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001223 This option should be set before editing a binary file. You can also
1224 use the |-b| Vim argument. When this option is switched on a few
1225 options will be changed (also when it already was on):
1226 'textwidth' will be set to 0
1227 'wrapmargin' will be set to 0
1228 'modeline' will be off
1229 'expandtab' will be off
1230 Also, 'fileformat' and 'fileformats' options will not be used, the
1231 file is read and written like 'fileformat' was "unix" (a single <NL>
1232 separates lines).
1233 The 'fileencoding' and 'fileencodings' options will not be used, the
1234 file is read without conversion.
1235 NOTE: When you start editing a(nother) file while the 'bin' option is
1236 on, settings from autocommands may change the settings again (e.g.,
1237 'textwidth'), causing trouble when editing. You might want to set
1238 'bin' again when the file has been loaded.
1239 The previous values of these options are remembered and restored when
1240 'bin' is switched from on to off. Each buffer has its own set of
1241 saved option values.
1242 To edit a file with 'binary' set you can use the |++bin| argument.
1243 This avoids you have to do ":set bin", which would have effect for all
1244 files you edit.
1245 When writing a file the <EOL> for the last line is only written if
1246 there was one in the original file (normally Vim appends an <EOL> to
1247 the last line if there is none; this would make the file longer). See
1248 the 'endofline' option.
1249
1250 *'bioskey'* *'biosk'* *'nobioskey'* *'nobiosk'*
1251'bioskey' 'biosk' boolean (default on)
1252 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02001253 {only for MS-DOS}
Bram Moolenaarf3913272016-02-25 00:00:01 +01001254 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001255
1256 *'bomb'* *'nobomb'*
1257'bomb' boolean (default off)
1258 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001259 When writing a file and the following conditions are met, a BOM (Byte
1260 Order Mark) is prepended to the file:
1261 - this option is on
1262 - the 'binary' option is off
1263 - 'fileencoding' is "utf-8", "ucs-2", "ucs-4" or one of the little/big
1264 endian variants.
1265 Some applications use the BOM to recognize the encoding of the file.
1266 Often used for UCS-2 files on MS-Windows. For other applications it
1267 causes trouble, for example: "cat file1 file2" makes the BOM of file2
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001268 appear halfway the resulting file. Gcc doesn't accept a BOM.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001269 When Vim reads a file and 'fileencodings' starts with "ucs-bom", a
1270 check for the presence of the BOM is done and 'bomb' set accordingly.
1271 Unless 'binary' is set, it is removed from the first line, so that you
1272 don't see it when editing. When you don't change the options, the BOM
1273 will be restored when writing the file.
1274
1275 *'breakat'* *'brk'*
1276'breakat' 'brk' string (default " ^I!@*-+;:,./?")
1277 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02001278 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001279 feature}
1280 This option lets you choose which characters might cause a line
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00001281 break if 'linebreak' is on. Only works for ASCII and also for 8-bit
1282 characters when 'encoding' is an 8-bit encoding.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001283
Bram Moolenaar7c1c6db2016-04-03 22:08:05 +02001284 *'breakindent'* *'bri'* *'nobreakindent'* *'nobri'*
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001285'breakindent' 'bri' boolean (default off)
1286 local to window
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001287 {not available when compiled without the |+linebreak|
1288 feature}
1289 Every wrapped line will continue visually indented (same amount of
1290 space as the beginning of that line), thus preserving horizontal blocks
1291 of text.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001292 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001293
1294 *'breakindentopt'* *'briopt'*
1295'breakindentopt' 'briopt' string (default empty)
1296 local to window
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001297 {not available when compiled without the |+linebreak|
1298 feature}
1299 Settings for 'breakindent'. It can consist of the following optional
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001300 items and must be separated by a comma:
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001301 min:{n} Minimum text width that will be kept after
1302 applying 'breakindent', even if the resulting
1303 text should normally be narrower. This prevents
1304 text indented almost to the right window border
1305 occupying lot of vertical space when broken.
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001306 shift:{n} After applying 'breakindent', the wrapped line's
1307 beginning will be shifted by the given number of
1308 characters. It permits dynamic French paragraph
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001309 indentation (negative) or emphasizing the line
1310 continuation (positive).
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01001311 sbr Display the 'showbreak' value before applying the
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001312 additional indent.
1313 The default value for min is 20 and shift is 0.
1314
Bram Moolenaar071d4272004-06-13 20:20:40 +00001315 *'browsedir'* *'bsdir'*
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001316'browsedir' 'bsdir' string (default: "last")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001317 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02001318 {only for Motif, Athena, GTK, Mac and Win32 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001319 Which directory to use for the file browser:
Bram Moolenaar446cb832008-06-24 21:56:24 +00001320 last Use same directory as with last file browser, where a
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02001321 file was opened or saved.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001322 buffer Use the directory of the related buffer.
1323 current Use the current directory.
1324 {path} Use the specified directory
1325
1326 *'bufhidden'* *'bh'*
1327'bufhidden' 'bh' string (default: "")
1328 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001329 This option specifies what happens when a buffer is no longer
1330 displayed in a window:
1331 <empty> follow the global 'hidden' option
1332 hide hide the buffer (don't unload it), also when 'hidden'
1333 is not set
1334 unload unload the buffer, also when 'hidden' is set or using
1335 |:hide|
1336 delete delete the buffer from the buffer list, also when
1337 'hidden' is set or using |:hide|, like using
1338 |:bdelete|
1339 wipe wipe out the buffer from the buffer list, also when
1340 'hidden' is set or using |:hide|, like using
1341 |:bwipeout|
1342
Bram Moolenaara14de3d2005-01-07 21:48:26 +00001343 CAREFUL: when "unload", "delete" or "wipe" is used changes in a buffer
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01001344 are lost without a warning. Also, these values may break autocommands
1345 that switch between buffers temporarily.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001346 This option is used together with 'buftype' and 'swapfile' to specify
1347 special kinds of buffers. See |special-buffers|.
1348
1349 *'buflisted'* *'bl'* *'nobuflisted'* *'nobl'* *E85*
1350'buflisted' 'bl' boolean (default: on)
1351 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001352 When this option is set, the buffer shows up in the buffer list. If
1353 it is reset it is not used for ":bnext", "ls", the Buffers menu, etc.
1354 This option is reset by Vim for buffers that are only used to remember
1355 a file name or marks. Vim sets it when starting to edit a buffer.
1356 But not when moving to a buffer with ":buffer".
1357
1358 *'buftype'* *'bt'* *E382*
1359'buftype' 'bt' string (default: "")
1360 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001361 The value of this option specifies the type of a buffer:
1362 <empty> normal buffer
1363 nofile buffer which is not related to a file and will not be
1364 written
1365 nowrite buffer which will not be written
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001366 acwrite buffer which will always be written with BufWriteCmd
Bram Moolenaarb5b75622018-03-09 22:22:21 +01001367 autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001368 quickfix quickfix buffer, contains list of errors |:cwindow|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001369 or list of locations |:lwindow|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001370 help help buffer (you are not supposed to set this
1371 manually)
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02001372 terminal buffer for a |terminal| (you are not supposed to set
1373 this manually)
Bram Moolenaarf2732452018-06-03 14:47:35 +02001374 prompt buffer where only the last line can be edited, meant
1375 to be used by a plugin, see |prompt-buffer|
1376 {only when compiled with the |+channel| feature}
Bram Moolenaar4d784b22019-05-25 19:51:39 +02001377 popup buffer used in a popup window, see |popup|.
1378 {only when compiled with the |+textprop| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001379
1380 This option is used together with 'bufhidden' and 'swapfile' to
1381 specify special kinds of buffers. See |special-buffers|.
1382
1383 Be careful with changing this option, it can have many side effects!
1384
Bram Moolenaar280f1262006-01-30 00:14:18 +00001385 A "quickfix" buffer is only used for the error list and the location
1386 list. This value is set by the |:cwindow| and |:lwindow| commands and
1387 you are not supposed to change it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001388
1389 "nofile" and "nowrite" buffers are similar:
1390 both: The buffer is not to be written to disk, ":w" doesn't
1391 work (":w filename" does work though).
1392 both: The buffer is never considered to be |'modified'|.
1393 There is no warning when the changes will be lost, for
1394 example when you quit Vim.
1395 both: A swap file is only created when using too much memory
1396 (when 'swapfile' has been reset there is never a swap
1397 file).
1398 nofile only: The buffer name is fixed, it is not handled like a
1399 file name. It is not modified in response to a |:cd|
1400 command.
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01001401 both: When using ":e bufname" and already editing "bufname"
1402 the buffer is made empty and autocommands are
1403 triggered as usual for |:edit|.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001404 *E676*
1405 "acwrite" implies that the buffer name is not related to a file, like
1406 "nofile", but it will be written. Thus, in contrast to "nofile" and
1407 "nowrite", ":w" does work and a modified buffer can't be abandoned
1408 without saving. For writing there must be matching |BufWriteCmd|,
1409 |FileWriteCmd| or |FileAppendCmd| autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001410
1411 *'casemap'* *'cmp'*
1412'casemap' 'cmp' string (default: "internal,keepascii")
1413 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001414 Specifies details about changing the case of letters. It may contain
1415 these words, separated by a comma:
1416 internal Use internal case mapping functions, the current
1417 locale does not change the case mapping. This only
Bram Moolenaar6f16eb82005-08-23 21:02:42 +00001418 matters when 'encoding' is a Unicode encoding,
1419 "latin1" or "iso-8859-15". When "internal" is
1420 omitted, the towupper() and towlower() system library
1421 functions are used when available.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001422 keepascii For the ASCII characters (0x00 to 0x7f) use the US
1423 case mapping, the current locale is not effective.
1424 This probably only matters for Turkish.
1425
1426 *'cdpath'* *'cd'* *E344* *E346*
1427'cdpath' 'cd' string (default: equivalent to $CDPATH or ",,")
1428 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001429 {not available when compiled without the
1430 |+file_in_path| feature}
1431 This is a list of directories which will be searched when using the
Bram Moolenaar00aa0692019-04-27 20:37:57 +02001432 |:cd|, |:tcd| and |:lcd| commands, provided that the directory being
1433 searched for has a relative path, not an absolute part starting with
1434 "/", "./" or "../", the 'cdpath' option is not used then.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001435 The 'cdpath' option's value has the same form and semantics as
1436 |'path'|. Also see |file-searching|.
1437 The default value is taken from $CDPATH, with a "," prepended to look
1438 in the current directory first.
1439 If the default value taken from $CDPATH is not what you want, include
1440 a modified version of the following command in your vimrc file to
1441 override it: >
1442 :let &cdpath = ',' . substitute(substitute($CDPATH, '[, ]', '\\\0', 'g'), ':', ',', 'g')
1443< This option cannot be set from a |modeline| or in the |sandbox|, for
1444 security reasons.
1445 (parts of 'cdpath' can be passed to the shell to expand file names).
1446
1447 *'cedit'*
1448'cedit' string (Vi default: "", Vim default: CTRL-F)
1449 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001450 The key used in Command-line Mode to open the command-line window.
1451 The default is CTRL-F when 'compatible' is off.
1452 Only non-printable keys are allowed.
1453 The key can be specified as a single character, but it is difficult to
1454 type. The preferred way is to use the <> notation. Examples: >
Bram Moolenaare18dbe82016-07-02 21:42:23 +02001455 :exe "set cedit=\<C-Y>"
1456 :exe "set cedit=\<Esc>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001457< |Nvi| also has this option, but it only uses the first character.
1458 See |cmdwin|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001459 NOTE: This option is set to the Vim default value when 'compatible'
1460 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001461
1462 *'charconvert'* *'ccv'* *E202* *E214* *E513*
1463'charconvert' 'ccv' string (default "")
1464 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01001465 {only available when compiled with the |+eval| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001466 An expression that is used for character encoding conversion. It is
1467 evaluated when a file that is to be read or has been written has a
1468 different encoding from what is desired.
1469 'charconvert' is not used when the internal iconv() function is
1470 supported and is able to do the conversion. Using iconv() is
1471 preferred, because it is much faster.
1472 'charconvert' is not used when reading stdin |--|, because there is no
1473 file to convert from. You will have to save the text in a file first.
1474 The expression must return zero or an empty string for success,
1475 non-zero for failure.
1476 The possible encoding names encountered are in 'encoding'.
1477 Additionally, names given in 'fileencodings' and 'fileencoding' are
1478 used.
1479 Conversion between "latin1", "unicode", "ucs-2", "ucs-4" and "utf-8"
1480 is done internally by Vim, 'charconvert' is not used for this.
1481 'charconvert' is also used to convert the viminfo file, if the 'c'
1482 flag is present in 'viminfo'. Also used for Unicode conversion.
1483 Example: >
1484 set charconvert=CharConvert()
1485 fun CharConvert()
1486 system("recode "
1487 \ . v:charconvert_from . ".." . v:charconvert_to
1488 \ . " <" . v:fname_in . " >" v:fname_out)
1489 return v:shell_error
1490 endfun
1491< The related Vim variables are:
1492 v:charconvert_from name of the current encoding
1493 v:charconvert_to name of the desired encoding
1494 v:fname_in name of the input file
1495 v:fname_out name of the output file
1496 Note that v:fname_in and v:fname_out will never be the same.
1497 Note that v:charconvert_from and v:charconvert_to may be different
1498 from 'encoding'. Vim internally uses UTF-8 instead of UCS-2 or UCS-4.
1499 Encryption is not done by Vim when using 'charconvert'. If you want
1500 to encrypt the file after conversion, 'charconvert' should take care
1501 of this.
1502 This option cannot be set from a |modeline| or in the |sandbox|, for
1503 security reasons.
1504
1505 *'cindent'* *'cin'* *'nocindent'* *'nocin'*
1506'cindent' 'cin' boolean (default off)
1507 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001508 {not available when compiled without the |+cindent|
1509 feature}
Bram Moolenaar446cb832008-06-24 21:56:24 +00001510 Enables automatic C program indenting. See 'cinkeys' to set the keys
Bram Moolenaar071d4272004-06-13 20:20:40 +00001511 that trigger reindenting in insert mode and 'cinoptions' to set your
1512 preferred indent style.
1513 If 'indentexpr' is not empty, it overrules 'cindent'.
1514 If 'lisp' is not on and both 'indentexpr' and 'equalprg' are empty,
1515 the "=" operator indents using this algorithm rather than calling an
1516 external program.
1517 See |C-indenting|.
1518 When you don't like the way 'cindent' works, try the 'smartindent'
1519 option or 'indentexpr'.
1520 This option is not used when 'paste' is set.
1521 NOTE: This option is reset when 'compatible' is set.
1522
1523 *'cinkeys'* *'cink'*
Bram Moolenaarce655742019-01-31 14:12:57 +01001524'cinkeys' 'cink' string (default "0{,0},0),0],:,0#,!^F,o,O,e")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001525 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001526 {not available when compiled without the |+cindent|
1527 feature}
1528 A list of keys that, when typed in Insert mode, cause reindenting of
1529 the current line. Only used if 'cindent' is on and 'indentexpr' is
1530 empty.
1531 For the format of this option see |cinkeys-format|.
1532 See |C-indenting|.
1533
1534 *'cinoptions'* *'cino'*
1535'cinoptions' 'cino' string (default "")
1536 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001537 {not available when compiled without the |+cindent|
1538 feature}
1539 The 'cinoptions' affect the way 'cindent' reindents lines in a C
1540 program. See |cinoptions-values| for the values of this option, and
1541 |C-indenting| for info on C indenting in general.
1542
1543
1544 *'cinwords'* *'cinw'*
1545'cinwords' 'cinw' string (default "if,else,while,do,for,switch")
1546 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001547 {not available when compiled without both the
1548 |+cindent| and the |+smartindent| features}
1549 These keywords start an extra indent in the next line when
1550 'smartindent' or 'cindent' is set. For 'cindent' this is only done at
1551 an appropriate place (inside {}).
1552 Note that 'ignorecase' isn't used for 'cinwords'. If case doesn't
1553 matter, include the keyword both the uppercase and lowercase:
1554 "if,If,IF".
1555
1556 *'clipboard'* *'cb'*
1557'clipboard' 'cb' string (default "autoselect,exclude:cons\|linux"
1558 for X-windows, "" otherwise)
1559 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001560 {only in GUI versions or when the |+xterm_clipboard|
1561 feature is included}
1562 This option is a list of comma separated names.
1563 These names are recognized:
1564
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001565 *clipboard-unnamed*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001566 unnamed When included, Vim will use the clipboard register '*'
1567 for all yank, delete, change and put operations which
1568 would normally go to the unnamed register. When a
1569 register is explicitly specified, it will always be
1570 used regardless of whether "unnamed" is in 'clipboard'
1571 or not. The clipboard register can always be
1572 explicitly accessed using the "* notation. Also see
1573 |gui-clipboard|.
1574
Bram Moolenaar30b65812012-07-12 22:01:11 +02001575 *clipboard-unnamedplus*
Bram Moolenaar00154502013-02-13 16:15:55 +01001576 unnamedplus A variant of the "unnamed" flag which uses the
1577 clipboard register '+' (|quoteplus|) instead of
1578 register '*' for all yank, delete, change and put
1579 operations which would normally go to the unnamed
1580 register. When "unnamed" is also included to the
1581 option, yank operations (but not delete, change or
1582 put) will additionally copy the text into register
1583 '*'.
Bram Moolenaar81af9252010-12-10 20:35:50 +01001584 Only available with the |+X11| feature.
Bram Moolenaarbf9680e2010-12-02 21:43:16 +01001585 Availability can be checked with: >
1586 if has('unnamedplus')
1587<
Bram Moolenaar30b65812012-07-12 22:01:11 +02001588 *clipboard-autoselect*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001589 autoselect Works like the 'a' flag in 'guioptions': If present,
1590 then whenever Visual mode is started, or the Visual
1591 area extended, Vim tries to become the owner of the
1592 windowing system's global selection or put the
1593 selected text on the clipboard used by the selection
Bram Moolenaarba3ff532018-11-04 14:45:49 +01001594 register "*. See |'go-a'| and |quotestar| for details.
1595 When the GUI is active, the 'a' flag in 'guioptions'
1596 is used, when the GUI is not active, this "autoselect"
1597 flag is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001598 Also applies to the modeless selection.
1599
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001600 *clipboard-autoselectplus*
1601 autoselectplus Like "autoselect" but using the + register instead of
1602 the * register. Compare to the 'P' flag in
1603 'guioptions'.
1604
1605 *clipboard-autoselectml*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001606 autoselectml Like "autoselect", but for the modeless selection
1607 only. Compare to the 'A' flag in 'guioptions'.
1608
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001609 *clipboard-html*
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001610 html When the clipboard contains HTML, use this when
1611 pasting. When putting text on the clipboard, mark it
1612 as HTML. This works to copy rendered HTML from
1613 Firefox, paste it as raw HTML in Vim, select the HTML
1614 in Vim and paste it in a rich edit box in Firefox.
Bram Moolenaar20a825a2010-05-31 21:27:30 +02001615 You probably want to add this only temporarily,
1616 possibly use BufEnter autocommands.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001617 Only supported for GTK version 2 and later.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001618
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001619 *clipboard-exclude*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001620 exclude:{pattern}
1621 Defines a pattern that is matched against the name of
1622 the terminal 'term'. If there is a match, no
1623 connection will be made to the X server. This is
1624 useful in this situation:
1625 - Running Vim in a console.
1626 - $DISPLAY is set to start applications on another
1627 display.
1628 - You do not want to connect to the X server in the
1629 console, but do want this in a terminal emulator.
1630 To never connect to the X server use: >
1631 exclude:.*
1632< This has the same effect as using the |-X| argument.
1633 Note that when there is no connection to the X server
1634 the window title won't be restored and the clipboard
1635 cannot be accessed.
1636 The value of 'magic' is ignored, {pattern} is
1637 interpreted as if 'magic' was on.
1638 The rest of the option value will be used for
1639 {pattern}, this must be the last entry.
1640
1641 *'cmdheight'* *'ch'*
1642'cmdheight' 'ch' number (default 1)
1643 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001644 Number of screen lines to use for the command-line. Helps avoiding
1645 |hit-enter| prompts.
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00001646 The value of this option is stored with the tab page, so that each tab
1647 page can have a different value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001648
1649 *'cmdwinheight'* *'cwh'*
1650'cmdwinheight' 'cwh' number (default 7)
1651 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001652 Number of screen lines to use for the command-line window. |cmdwin|
1653
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001654 *'colorcolumn'* *'cc'*
1655'colorcolumn' 'cc' string (default "")
1656 local to window
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001657 {not available when compiled without the |+syntax|
1658 feature}
1659 'colorcolumn' is a comma separated list of screen columns that are
1660 highlighted with ColorColumn |hl-ColorColumn|. Useful to align
1661 text. Will make screen redrawing slower.
1662 The screen column can be an absolute number, or a number preceded with
1663 '+' or '-', which is added to or subtracted from 'textwidth'. >
1664
1665 :set cc=+1 " highlight column after 'textwidth'
1666 :set cc=+1,+2,+3 " highlight three columns after 'textwidth'
1667 :hi ColorColumn ctermbg=lightgrey guibg=lightgrey
1668<
1669 When 'textwidth' is zero then the items with '-' and '+' are not used.
1670 A maximum of 256 columns are highlighted.
1671
Bram Moolenaar071d4272004-06-13 20:20:40 +00001672 *'columns'* *'co'* *E594*
1673'columns' 'co' number (default 80 or terminal width)
1674 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001675 Number of columns of the screen. Normally this is set by the terminal
Bram Moolenaar7c626922005-02-07 22:01:03 +00001676 initialization and does not have to be set by hand. Also see
1677 |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001678 When Vim is running in the GUI or in a resizable window, setting this
1679 option will cause the window size to be changed. When you only want
1680 to use the size for the GUI, put the command in your |gvimrc| file.
1681 When you set this option and Vim is unable to change the physical
Bram Moolenaar02467872007-05-06 13:22:01 +00001682 number of columns of the display, the display may be messed up. For
1683 the GUI it is always possible and Vim limits the number of columns to
1684 what fits on the screen. You can use this command to get the widest
1685 window possible: >
1686 :set columns=9999
1687< Minimum value is 12, maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001688
1689 *'comments'* *'com'* *E524* *E525*
1690'comments' 'com' string (default
1691 "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-")
1692 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001693 A comma separated list of strings that can start a comment line. See
1694 |format-comments|. See |option-backslash| about using backslashes to
1695 insert a space.
1696
1697 *'commentstring'* *'cms'* *E537*
1698'commentstring' 'cms' string (default "/*%s*/")
1699 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001700 {not available when compiled without the |+folding|
1701 feature}
1702 A template for a comment. The "%s" in the value is replaced with the
1703 comment text. Currently only used to add markers for folding, see
1704 |fold-marker|.
1705
1706 *'compatible'* *'cp'* *'nocompatible'* *'nocp'*
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001707'compatible' 'cp' boolean (default on, off when a |vimrc| or |gvimrc|
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02001708 file is found, reset in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001709 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001710 This option has the effect of making Vim either more Vi-compatible, or
1711 make Vim behave in a more useful way.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001712
Bram Moolenaar071d4272004-06-13 20:20:40 +00001713 This is a special kind of option, because when it's set or reset,
Bram Moolenaar214641f2017-03-05 17:04:09 +01001714 other options are also changed as a side effect.
1715 NOTE: Setting or resetting this option can have a lot of unexpected
1716 effects: Mappings are interpreted in another way, undo behaves
1717 differently, etc. If you set this option in your vimrc file, you
1718 should probably put it at the very start.
1719
Bram Moolenaar071d4272004-06-13 20:20:40 +00001720 By default this option is on and the Vi defaults are used for the
1721 options. This default was chosen for those people who want to use Vim
1722 just like Vi, and don't even (want to) know about the 'compatible'
1723 option.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001724 When a |vimrc| or |gvimrc| file is found while Vim is starting up,
Bram Moolenaard042c562005-06-30 22:04:15 +00001725 this option is switched off, and all options that have not been
1726 modified will be set to the Vim defaults. Effectively, this means
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001727 that when a |vimrc| or |gvimrc| file exists, Vim will use the Vim
Bram Moolenaard042c562005-06-30 22:04:15 +00001728 defaults, otherwise it will use the Vi defaults. (Note: This doesn't
Bram Moolenaar02467872007-05-06 13:22:01 +00001729 happen for the system-wide vimrc or gvimrc file, nor for a file given
1730 with the |-u| argument). Also see |compatible-default| and
1731 |posix-compliance|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001732 You can also set this option with the "-C" argument, and reset it with
1733 "-N". See |-C| and |-N|.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001734 See 'cpoptions' for more fine tuning of Vi compatibility.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001735
Bram Moolenaar214641f2017-03-05 17:04:09 +01001736 When this option is set, numerous other options are set to make Vim as
1737 Vi-compatible as possible. When this option is unset, various options
1738 are set to make Vim more useful. The table below lists all the
1739 options affected.
1740 The {?} column indicates when the options are affected:
1741 + Means that the option is set to the value given in {set value} when
1742 'compatible' is set.
1743 & Means that the option is set to the value given in {set value} when
1744 'compatible' is set AND is set to its Vim default value when
1745 'compatible' is unset.
1746 - Means the option is NOT changed when setting 'compatible' but IS
1747 set to its Vim default when 'compatible' is unset.
1748 The {effect} column summarises the change when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001749
Bram Moolenaar036986f2017-03-16 17:41:02 +01001750 option ? set value effect ~
Bram Moolenaar214641f2017-03-05 17:04:09 +01001751
1752 'allowrevins' + off no CTRL-_ command
1753 'antialias' + off don't use antialiased fonts
1754 'arabic' + off reset arabic-related options
1755 'arabicshape' + on correct character shapes
1756 'backspace' + "" normal backspace
1757 'backup' + off no backup file
1758 'backupcopy' & Unix: "yes" backup file is a copy
1759 else: "auto" copy or rename backup file
1760 'balloonexpr' + "" text to show in evaluation balloon
1761 'breakindent' + off don't indent when wrapping lines
1762 'cedit' - {unchanged} {set vim default only on resetting 'cp'}
1763 'cindent' + off no C code indentation
1764 'compatible' - {unchanged} {set vim default only on resetting 'cp'}
1765 'copyindent' + off don't copy indent structure
1766 'cpoptions' & (all flags) Vi-compatible flags
1767 'cscopepathcomp'+ 0 don't show directories in tags list
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01001768 'cscoperelative'+ off don't use basename of path as prefix
Bram Moolenaar214641f2017-03-05 17:04:09 +01001769 'cscopetag' + off don't use cscope for ":tag"
Bram Moolenaar036986f2017-03-16 17:41:02 +01001770 'cscopetagorder'+ 0 see |cscopetagorder|
Bram Moolenaar214641f2017-03-05 17:04:09 +01001771 'cscopeverbose' + off see |cscopeverbose|
1772 'delcombine' + off unicode: delete whole char combination
1773 'digraph' + off no digraphs
1774 'esckeys' & off no <Esc>-keys in Insert mode
1775 'expandtab' + off tabs not expanded to spaces
1776 'fileformats' & "" no automatic file format detection,
Bram Moolenaar6f345a12019-12-17 21:27:18 +01001777 "dos,unix" except for MS-Windows
Bram Moolenaar214641f2017-03-05 17:04:09 +01001778 'formatexpr' + "" use 'formatprg' for auto-formatting
1779 'formatoptions' & "vt" Vi compatible formatting
1780 'gdefault' + off no default 'g' flag for ":s"
1781 'history' & 0 no commandline history
1782 'hkmap' + off no Hebrew keyboard mapping
1783 'hkmapp' + off no phonetic Hebrew keyboard mapping
1784 'hlsearch' + off no highlighting of search matches
1785 'incsearch' + off no incremental searching
1786 'indentexpr' + "" no indenting by expression
1787 'insertmode' + off do not start in Insert mode
1788 'iskeyword' & "@,48-57,_" keywords contain alphanumeric
Bram Moolenaar071d4272004-06-13 20:20:40 +00001789 characters and '_'
Bram Moolenaar214641f2017-03-05 17:04:09 +01001790 'joinspaces' + on insert 2 spaces after period
1791 'modeline' & off no modelines
1792 'more' & off no pauses in listings
1793 'mzquantum' - {unchanged} {set vim default only on resetting 'cp'}
1794 'numberwidth' & 8 min number of columns for line number
1795 'preserveindent'+ off don't preserve current indent structure
1796 when changing it
1797 'revins' + off no reverse insert
1798 'ruler' + off no ruler
1799 'scrolljump' + 1 no jump scroll
1800 'scrolloff' + 0 no scroll offset
1801 'shelltemp' - {unchanged} {set vim default only on resetting 'cp'}
1802 'shiftround' + off indent not rounded to shiftwidth
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02001803 'shortmess' & "S" no shortening of messages
Bram Moolenaar214641f2017-03-05 17:04:09 +01001804 'showcmd' & off command characters not shown
1805 'showmode' & off current mode not shown
1806 'sidescrolloff' + 0 cursor moves to edge of screen in scroll
1807 'smartcase' + off no automatic ignore case switch
1808 'smartindent' + off no smart indentation
1809 'smarttab' + off no smart tab size
1810 'softtabstop' + 0 tabs are always 'tabstop' positions
1811 'startofline' + on goto startofline with some commands
1812 'tagcase' & "followic" 'ignorecase' when searching tags file
1813 'tagrelative' & off tag file names are not relative
1814 'termguicolors' + off don't use highlight-(guifg|guibg)
1815 'textauto' & off no automatic textmode detection
1816 'textwidth' + 0 no automatic line wrap
1817 'tildeop' + off tilde is not an operator
1818 'ttimeout' + off no terminal timeout
1819 'undofile' + off don't use an undo file
Bram Moolenaar036986f2017-03-16 17:41:02 +01001820 'viminfo' - {unchanged} {set Vim default only on resetting 'cp'}
Bram Moolenaar214641f2017-03-05 17:04:09 +01001821 'virtualedit' + "" cursor can only be placed on characters
1822 'whichwrap' & "" left-right movements don't wrap
1823 'wildchar' & CTRL-E only when the current value is <Tab>
Bram Moolenaar071d4272004-06-13 20:20:40 +00001824 use CTRL-E for cmdline completion
Bram Moolenaar214641f2017-03-05 17:04:09 +01001825 'writebackup' + on or off depends on the |+writebackup| feature
Bram Moolenaar071d4272004-06-13 20:20:40 +00001826
1827 *'complete'* *'cpt'* *E535*
1828'complete' 'cpt' string (default: ".,w,b,u,t,i")
1829 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001830 This option specifies how keyword completion |ins-completion| works
1831 when CTRL-P or CTRL-N are used. It is also used for whole-line
1832 completion |i_CTRL-X_CTRL-L|. It indicates the type of completion
1833 and the places to scan. It is a comma separated list of flags:
Bram Moolenaar3848e002016-03-19 18:42:29 +01001834 . scan the current buffer ('wrapscan' is ignored)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001835 w scan buffers from other windows
1836 b scan other loaded buffers that are in the buffer list
1837 u scan the unloaded buffers that are in the buffer list
1838 U scan the buffers that are not in the buffer list
1839 k scan the files given with the 'dictionary' option
Bram Moolenaar0b238792006-03-02 22:49:12 +00001840 kspell use the currently active spell checking |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001841 k{dict} scan the file {dict}. Several "k" flags can be given,
1842 patterns are valid too. For example: >
1843 :set cpt=k/usr/dict/*,k~/spanish
1844< s scan the files given with the 'thesaurus' option
1845 s{tsr} scan the file {tsr}. Several "s" flags can be given, patterns
1846 are valid too.
1847 i scan current and included files
1848 d scan current and included files for defined name or macro
1849 |i_CTRL-X_CTRL-D|
1850 ] tag completion
1851 t same as "]"
1852
1853 Unloaded buffers are not loaded, thus their autocmds |:autocmd| are
1854 not executed, this may lead to unexpected completions from some files
1855 (gzipped files for example). Unloaded buffers are not scanned for
1856 whole-line completion.
1857
1858 The default is ".,w,b,u,t,i", which means to scan:
1859 1. the current buffer
1860 2. buffers in other windows
1861 3. other loaded buffers
1862 4. unloaded buffers
1863 5. tags
1864 6. included files
1865
1866 As you can see, CTRL-N and CTRL-P can be used to do any 'iskeyword'-
Bram Moolenaar582fd852005-03-28 20:58:01 +00001867 based expansion (e.g., dictionary |i_CTRL-X_CTRL-K|, included patterns
1868 |i_CTRL-X_CTRL-I|, tags |i_CTRL-X_CTRL-]| and normal expansions).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001869
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001870 *'completefunc'* *'cfu'*
1871'completefunc' 'cfu' string (default: empty)
1872 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02001873 {not available when compiled without the |+eval|
Bram Moolenaare2c453d2019-08-21 14:37:09 +02001874 feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00001875 This option specifies a function to be used for Insert mode completion
1876 with CTRL-X CTRL-U. |i_CTRL-X_CTRL-U|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001877 See |complete-functions| for an explanation of how the function is
1878 invoked and what it should return.
Bram Moolenaar166af9b2010-11-16 20:34:40 +01001879 This option cannot be set from a |modeline| or in the |sandbox|, for
1880 security reasons.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00001881
Bram Moolenaarac3150d2019-07-28 16:36:39 +02001882 *'completeslash'* *'csl'*
1883'completeslash' 'csl' string (default: "")
1884 local to buffer
Bram Moolenaar2e693a82019-10-16 22:35:02 +02001885 {only for MS-Windows}
Bram Moolenaarac3150d2019-07-28 16:36:39 +02001886 When this option is set it overrules 'shellslash' for completion:
1887 - When this option is set to "slash", a forward slash is used for path
1888 completion in insert mode. This is useful when editing HTML tag, or
Bram Moolenaar6f345a12019-12-17 21:27:18 +01001889 Makefile with 'noshellslash' on MS-Windows.
Bram Moolenaarac3150d2019-07-28 16:36:39 +02001890 - When this option is set to "backslash", backslash is used. This is
Bram Moolenaar6f345a12019-12-17 21:27:18 +01001891 useful when editing a batch file with 'shellslash' set on MS-Windows.
Bram Moolenaarac3150d2019-07-28 16:36:39 +02001892 - When this option is empty, same character is used as for
1893 'shellslash'.
1894 For Insert mode completion the buffer-local value is used. For
1895 command line completion the global value is used.
1896
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001897 *'completeopt'* *'cot'*
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001898'completeopt' 'cot' string (default: "menu,preview")
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001899 global
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001900 A comma separated list of options for Insert mode completion
1901 |ins-completion|. The supported values are:
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001902
1903 menu Use a popup menu to show the possible completions. The
1904 menu is only shown when there is more than one match and
1905 sufficient colors are available. |ins-completion-menu|
1906
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001907 menuone Use the popup menu also when there is only one match.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00001908 Useful when there is additional information about the
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001909 match, e.g., what file it comes from.
1910
Bram Moolenaarc1e37902006-04-18 21:55:01 +00001911 longest Only insert the longest common text of the matches. If
1912 the menu is displayed you can use CTRL-L to add more
1913 characters. Whether case is ignored depends on the kind
1914 of completion. For buffer text the 'ignorecase' option is
1915 used.
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001916
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001917 preview Show extra information about the currently selected
Bram Moolenaar02467872007-05-06 13:22:01 +00001918 completion in the preview window. Only works in
1919 combination with "menu" or "menuone".
1920
Bram Moolenaar576a4a62019-08-18 15:25:17 +02001921 popup Show extra information about the currently selected
1922 completion in a popup window. Only works in combination
1923 with "menu" or "menuone". Overrides "preview".
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02001924 See |'completepopup'| for specifying properties.
Bram Moolenaar2e693a82019-10-16 22:35:02 +02001925 {only works when compiled with the |+textprop| feature}
Bram Moolenaar576a4a62019-08-18 15:25:17 +02001926
Bram Moolenaardca7abe2019-10-20 18:17:57 +02001927 popuphidden
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01001928 Just like "popup" but initially hide the popup. Use a
Bram Moolenaardca7abe2019-10-20 18:17:57 +02001929 |CompleteChanged| autocommand to fetch the info and call
1930 |popup_show()| once the popup has been filled.
1931 See the example at |complete-popuphidden|.
1932 {only works when compiled with the |+textprop| feature}
1933
Bram Moolenaarb6be1e22015-07-10 18:18:40 +02001934 noinsert Do not insert any text for a match until the user selects
1935 a match from the menu. Only works in combination with
1936 "menu" or "menuone". No effect if "longest" is present.
1937
1938 noselect Do not select a match in the menu, force the user to
1939 select one from the menu. Only works in combination with
1940 "menu" or "menuone".
1941
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001942
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02001943 *'completepopup'* *'cpp'*
1944'completepopup' 'cpp' string (default empty)
1945 global
1946 {not available when compiled without the |+textprop|
1947 or |+quickfix| feature}
1948 When 'completeopt' contains "popup" then this option is used for the
Bram Moolenaar06fe74a2019-08-31 16:20:32 +02001949 properties of the info popup when it is created. You can also use
1950 |popup_findinfo()| and then set properties for an existing info popup
1951 with |popup_setoptions()|. See |complete-popup|.
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02001952
1953
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001954 *'concealcursor'* *'cocu'*
1955'concealcursor' 'cocu' string (default: "")
1956 local to window
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001957 {not available when compiled without the |+conceal|
1958 feature}
1959 Sets the modes in which text in the cursor line can also be concealed.
1960 When the current mode is listed then concealing happens just like in
1961 other lines.
1962 n Normal mode
1963 v Visual mode
1964 i Insert mode
Bram Moolenaarca8c9862010-07-24 15:00:38 +02001965 c Command line editing, for 'incsearch'
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001966
Bram Moolenaare6dc5732010-07-24 23:52:26 +02001967 'v' applies to all lines in the Visual area, not only the cursor.
Bram Moolenaarca8c9862010-07-24 15:00:38 +02001968 A useful value is "nc". This is used in help files. So long as you
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001969 are moving around text is concealed, but when starting to insert text
1970 or selecting a Visual area the concealed text is displayed, so that
1971 you can see what you are doing.
Bram Moolenaarf70e3d62010-07-24 13:15:07 +02001972 Keep in mind that the cursor position is not always where it's
1973 displayed. E.g., when moving vertically it may change column.
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001974
1975
Bram Moolenaar95bafa22018-10-02 13:26:25 +02001976 *'conceallevel'* *'cole'*
1977'conceallevel' 'cole' number (default 0)
Bram Moolenaar860cae12010-06-05 23:22:07 +02001978 local to window
Bram Moolenaar860cae12010-06-05 23:22:07 +02001979 {not available when compiled without the |+conceal|
1980 feature}
Bram Moolenaar6df6f472010-07-18 18:04:50 +02001981 Determine how text with the "conceal" syntax attribute |:syn-conceal|
1982 is shown:
Bram Moolenaar860cae12010-06-05 23:22:07 +02001983
Bram Moolenaar6df6f472010-07-18 18:04:50 +02001984 Value Effect ~
Bram Moolenaar860cae12010-06-05 23:22:07 +02001985 0 Text is shown normally
Bram Moolenaar477db062010-07-28 18:17:41 +02001986 1 Each block of concealed text is replaced with one
1987 character. If the syntax item does not have a custom
1988 replacement character defined (see |:syn-cchar|) the
1989 character defined in 'listchars' is used (default is a
1990 space).
1991 It is highlighted with the "Conceal" highlight group.
Bram Moolenaar860cae12010-06-05 23:22:07 +02001992 2 Concealed text is completely hidden unless it has a
1993 custom replacement character defined (see
Bram Moolenaar477db062010-07-28 18:17:41 +02001994 |:syn-cchar|).
Bram Moolenaara7781e02010-07-19 20:13:22 +02001995 3 Concealed text is completely hidden.
Bram Moolenaar860cae12010-06-05 23:22:07 +02001996
Bram Moolenaara7781e02010-07-19 20:13:22 +02001997 Note: in the cursor line concealed text is not hidden, so that you can
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001998 edit and copy the text. This can be changed with the 'concealcursor'
1999 option.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002000
Bram Moolenaar071d4272004-06-13 20:20:40 +00002001 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
2002'confirm' 'cf' boolean (default off)
2003 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002004 When 'confirm' is on, certain operations that would normally
2005 fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
2006 instead raise a |dialog| asking if you wish to save the current
2007 file(s). You can still use a ! to unconditionally |abandon| a buffer.
2008 If 'confirm' is off you can still activate confirmation for one
2009 command only (this is most useful in mappings) with the |:confirm|
2010 command.
2011 Also see the |confirm()| function and the 'v' flag in 'guioptions'.
2012
2013 *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
2014'conskey' 'consk' boolean (default off)
2015 global
Bram Moolenaarf3913272016-02-25 00:00:01 +01002016 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002017
2018 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
2019'copyindent' 'ci' boolean (default off)
2020 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002021 Copy the structure of the existing lines indent when autoindenting a
2022 new line. Normally the new indent is reconstructed by a series of
2023 tabs followed by spaces as required (unless |'expandtab'| is enabled,
2024 in which case only spaces are used). Enabling this option makes the
2025 new line copy whatever characters were used for indenting on the
Bram Moolenaar446cb832008-06-24 21:56:24 +00002026 existing line. 'expandtab' has no effect on these characters, a Tab
2027 remains a Tab. If the new indent is greater than on the existing
Bram Moolenaar071d4272004-06-13 20:20:40 +00002028 line, the remaining space is filled in the normal manner.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002029 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002030 Also see 'preserveindent'.
2031
Bram Moolenaare0fa3742016-02-20 15:47:01 +01002032 *'cpoptions'* *'cpo'* *cpo*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002033'cpoptions' 'cpo' string (Vim default: "aABceFs",
2034 Vi default: all flags)
2035 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002036 A sequence of single character flags. When a character is present
Bram Moolenaar7cba6c02013-09-05 22:13:31 +02002037 this indicates Vi-compatible behavior. This is used for things where
2038 not being Vi-compatible is mostly or sometimes preferred.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002039 'cpoptions' stands for "compatible-options".
2040 Commas can be added for readability.
2041 To avoid problems with flags that are added in the future, use the
2042 "+=" and "-=" feature of ":set" |add-option-flags|.
2043 NOTE: This option is set to the Vi default value when 'compatible' is
2044 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002045 NOTE: This option is set to the POSIX default value at startup when
2046 the Vi default value would be used and the $VIM_POSIX environment
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002047 variable exists |posix|. This means Vim tries to behave like the
2048 POSIX specification.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002049
2050 contains behavior ~
2051 *cpo-a*
2052 a When included, a ":read" command with a file name
2053 argument will set the alternate file name for the
2054 current window.
2055 *cpo-A*
2056 A When included, a ":write" command with a file name
2057 argument will set the alternate file name for the
2058 current window.
2059 *cpo-b*
2060 b "\|" in a ":map" command is recognized as the end of
2061 the map command. The '\' is included in the mapping,
2062 the text after the '|' is interpreted as the next
2063 command. Use a CTRL-V instead of a backslash to
2064 include the '|' in the mapping. Applies to all
2065 mapping, abbreviation, menu and autocmd commands.
2066 See also |map_bar|.
2067 *cpo-B*
2068 B A backslash has no special meaning in mappings,
Bram Moolenaara9604e62018-07-21 05:56:22 +02002069 abbreviations, user commands and the "to" part of the
2070 menu commands. Remove this flag to be able to use a
2071 backslash like a CTRL-V. For example, the command
2072 ":map X \<Esc>" results in X being mapped to:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002073 'B' included: "\^[" (^[ is a real <Esc>)
2074 'B' excluded: "<Esc>" (5 characters)
2075 ('<' excluded in both cases)
2076 *cpo-c*
2077 c Searching continues at the end of any match at the
2078 cursor position, but not further than the start of the
2079 next line. When not present searching continues
2080 one character from the cursor position. With 'c'
2081 "abababababab" only gets three matches when repeating
2082 "/abab", without 'c' there are five matches.
2083 *cpo-C*
2084 C Do not concatenate sourced lines that start with a
2085 backslash. See |line-continuation|.
2086 *cpo-d*
2087 d Using "./" in the 'tags' option doesn't mean to use
2088 the tags file relative to the current file, but the
2089 tags file in the current directory.
2090 *cpo-D*
2091 D Can't use CTRL-K to enter a digraph after Normal mode
2092 commands with a character argument, like |r|, |f| and
2093 |t|.
2094 *cpo-e*
2095 e When executing a register with ":@r", always add a
2096 <CR> to the last line, also when the register is not
2097 linewise. If this flag is not present, the register
2098 is not linewise and the last line does not end in a
2099 <CR>, then the last line is put on the command-line
2100 and can be edited before hitting <CR>.
2101 *cpo-E*
2102 E It is an error when using "y", "d", "c", "g~", "gu" or
2103 "gU" on an Empty region. The operators only work when
Bram Moolenaar15142e22018-04-30 22:19:58 +02002104 at least one character is to be operated on. Example:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002105 This makes "y0" fail in the first column.
2106 *cpo-f*
2107 f When included, a ":read" command with a file name
2108 argument will set the file name for the current buffer,
2109 if the current buffer doesn't have a file name yet.
2110 *cpo-F*
2111 F When included, a ":write" command with a file name
2112 argument will set the file name for the current
2113 buffer, if the current buffer doesn't have a file name
Bram Moolenaarb3480382005-12-11 21:33:32 +00002114 yet. Also see |cpo-P|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002115 *cpo-g*
2116 g Goto line 1 when using ":edit" without argument.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002117 *cpo-H*
2118 H When using "I" on a line with only blanks, insert
2119 before the last blank. Without this flag insert after
2120 the last blank.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002121 *cpo-i*
2122 i When included, interrupting the reading of a file will
2123 leave it modified.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002124 *cpo-I*
2125 I When moving the cursor up or down just after inserting
2126 indent for 'autoindent', do not delete the indent.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002127 *cpo-j*
2128 j When joining lines, only add two spaces after a '.',
2129 not after '!' or '?'. Also see 'joinspaces'.
2130 *cpo-J*
2131 J A |sentence| has to be followed by two spaces after
Bram Moolenaar582fd852005-03-28 20:58:01 +00002132 the '.', '!' or '?'. A <Tab> is not recognized as
Bram Moolenaar071d4272004-06-13 20:20:40 +00002133 white space.
2134 *cpo-k*
2135 k Disable the recognition of raw key codes in
2136 mappings, abbreviations, and the "to" part of menu
2137 commands. For example, if <Key> sends ^[OA (where ^[
2138 is <Esc>), the command ":map X ^[OA" results in X
2139 being mapped to:
2140 'k' included: "^[OA" (3 characters)
2141 'k' excluded: "<Key>" (one key code)
2142 Also see the '<' flag below.
2143 *cpo-K*
2144 K Don't wait for a key code to complete when it is
2145 halfway a mapping. This breaks mapping <F1><F1> when
2146 only part of the second <F1> has been read. It
2147 enables cancelling the mapping by typing <F1><Esc>.
2148 *cpo-l*
2149 l Backslash in a [] range in a search pattern is taken
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002150 literally, only "\]", "\^", "\-" and "\\" are special.
2151 See |/[]|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002152 'l' included: "/[ \t]" finds <Space>, '\' and 't'
2153 'l' excluded: "/[ \t]" finds <Space> and <Tab>
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002154 Also see |cpo-\|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002155 *cpo-L*
2156 L When the 'list' option is set, 'wrapmargin',
2157 'textwidth', 'softtabstop' and Virtual Replace mode
2158 (see |gR|) count a <Tab> as two characters, instead of
2159 the normal behavior of a <Tab>.
2160 *cpo-m*
2161 m When included, a showmatch will always wait half a
2162 second. When not included, a showmatch will wait half
2163 a second or until a character is typed. |'showmatch'|
2164 *cpo-M*
2165 M When excluded, "%" matching will take backslashes into
2166 account. Thus in "( \( )" and "\( ( \)" the outer
2167 parenthesis match. When included "%" ignores
2168 backslashes, which is Vi compatible.
2169 *cpo-n*
Bram Moolenaar64486672010-05-16 15:46:46 +02002170 n When included, the column used for 'number' and
2171 'relativenumber' will also be used for text of wrapped
2172 lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002173 *cpo-o*
2174 o Line offset to search command is not remembered for
2175 next search.
2176 *cpo-O*
2177 O Don't complain if a file is being overwritten, even
2178 when it didn't exist when editing it. This is a
2179 protection against a file unexpectedly created by
2180 someone else. Vi didn't complain about this.
2181 *cpo-p*
2182 p Vi compatible Lisp indenting. When not present, a
2183 slightly better algorithm is used.
Bram Moolenaarb3480382005-12-11 21:33:32 +00002184 *cpo-P*
2185 P When included, a ":write" command that appends to a
2186 file will set the file name for the current buffer, if
2187 the current buffer doesn't have a file name yet and
2188 the 'F' flag is also included |cpo-F|.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002189 *cpo-q*
2190 q When joining multiple lines leave the cursor at the
2191 position where it would be when joining two lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002192 *cpo-r*
2193 r Redo ("." command) uses "/" to repeat a search
2194 command, instead of the actually used search string.
2195 *cpo-R*
2196 R Remove marks from filtered lines. Without this flag
2197 marks are kept like |:keepmarks| was used.
2198 *cpo-s*
2199 s Set buffer options when entering the buffer for the
2200 first time. This is like it is in Vim version 3.0.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002201 And it is the default. If not present the options are
Bram Moolenaar071d4272004-06-13 20:20:40 +00002202 set when the buffer is created.
2203 *cpo-S*
2204 S Set buffer options always when entering a buffer
2205 (except 'readonly', 'fileformat', 'filetype' and
2206 'syntax'). This is the (most) Vi compatible setting.
2207 The options are set to the values in the current
2208 buffer. When you change an option and go to another
2209 buffer, the value is copied. Effectively makes the
2210 buffer options global to all buffers.
2211
2212 's' 'S' copy buffer options
2213 no no when buffer created
2214 yes no when buffer first entered (default)
2215 X yes each time when buffer entered (vi comp.)
2216 *cpo-t*
2217 t Search pattern for the tag command is remembered for
2218 "n" command. Otherwise Vim only puts the pattern in
2219 the history for search pattern, but doesn't change the
2220 last used search pattern.
2221 *cpo-u*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002222 u Undo is Vi compatible. See |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002223 *cpo-v*
2224 v Backspaced characters remain visible on the screen in
2225 Insert mode. Without this flag the characters are
2226 erased from the screen right away. With this flag the
2227 screen newly typed text overwrites backspaced
2228 characters.
2229 *cpo-w*
2230 w When using "cw" on a blank character, only change one
2231 character and not all blanks until the start of the
2232 next word.
2233 *cpo-W*
2234 W Don't overwrite a readonly file. When omitted, ":w!"
2235 overwrites a readonly file, if possible.
2236 *cpo-x*
2237 x <Esc> on the command-line executes the command-line.
2238 The default in Vim is to abandon the command-line,
2239 because <Esc> normally aborts a command. |c_<Esc>|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002240 *cpo-X*
2241 X When using a count with "R" the replaced text is
2242 deleted only once. Also when repeating "R" with "."
2243 and a count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002244 *cpo-y*
Bram Moolenaard09091d2019-01-17 16:07:22 +01002245 y A yank command can be redone with ".". Think twice if
2246 you really want to use this, it may break some
2247 plugins, since most people expect "." to only repeat a
2248 change.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002249 *cpo-Z*
2250 Z When using "w!" while the 'readonly' option is set,
2251 don't reset 'readonly'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002252 *cpo-!*
2253 ! When redoing a filter command, use the last used
2254 external command, whatever it was. Otherwise the last
2255 used -filter- command is used.
2256 *cpo-$*
2257 $ When making a change to one line, don't redisplay the
2258 line, but put a '$' at the end of the changed text.
2259 The changed text will be overwritten when you type the
2260 new text. The line is redisplayed if you type any
2261 command that moves the cursor from the insertion
2262 point.
2263 *cpo-%*
2264 % Vi-compatible matching is done for the "%" command.
2265 Does not recognize "#if", "#endif", etc.
2266 Does not recognize "/*" and "*/".
2267 Parens inside single and double quotes are also
2268 counted, causing a string that contains a paren to
2269 disturb the matching. For example, in a line like
2270 "if (strcmp("foo(", s))" the first paren does not
2271 match the last one. When this flag is not included,
2272 parens inside single and double quotes are treated
2273 specially. When matching a paren outside of quotes,
2274 everything inside quotes is ignored. When matching a
2275 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002276 there is one). This works very well for C programs.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002277 This flag is also used for other features, such as
2278 C-indenting.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002279 *cpo--*
2280 - When included, a vertical movement command fails when
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002281 it would go above the first line or below the last
2282 line. Without it the cursor moves to the first or
2283 last line, unless it already was in that line.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002284 Applies to the commands "-", "k", CTRL-P, "+", "j",
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002285 CTRL-N, CTRL-J and ":1234".
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002286 *cpo-+*
2287 + When included, a ":write file" command will reset the
2288 'modified' flag of the buffer, even though the buffer
2289 itself may still be different from its file.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002290 *cpo-star*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002291 * Use ":*" in the same way as ":@". When not included,
2292 ":*" is an alias for ":'<,'>", select the Visual area.
2293 *cpo-<*
2294 < Disable the recognition of special key codes in |<>|
2295 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002296 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00002297 ":map X <Tab>" results in X being mapped to:
2298 '<' included: "<Tab>" (5 characters)
2299 '<' excluded: "^I" (^I is a real <Tab>)
2300 Also see the 'k' flag above.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002301 *cpo->*
2302 > When appending to a register, put a line break before
2303 the appended text.
Bram Moolenaar8b3e0332011-06-26 05:36:34 +02002304 *cpo-;*
2305 ; When using |,| or |;| to repeat the last |t| search
2306 and the cursor is right in front of the searched
2307 character, the cursor won't move. When not included,
2308 the cursor would skip over it and jump to the
Bram Moolenaarc8734422012-06-01 22:38:45 +02002309 following occurrence.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002310
2311 POSIX flags. These are not included in the Vi default value, except
2312 when $VIM_POSIX was set on startup. |posix|
2313
2314 contains behavior ~
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002315 *cpo-#*
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002316 # A count before "D", "o" and "O" has no effect.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002317 *cpo-&*
2318 & When ":preserve" was used keep the swap file when
2319 exiting normally while this buffer is still loaded.
2320 This flag is tested when exiting.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002321 *cpo-\*
2322 \ Backslash in a [] range in a search pattern is taken
2323 literally, only "\]" is special See |/[]|
Bram Moolenaar90915b52005-08-21 22:17:52 +00002324 '\' included: "/[ \-]" finds <Space>, '\' and '-'
2325 '\' excluded: "/[ \-]" finds <Space> and '-'
2326 Also see |cpo-l|.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002327 *cpo-/*
2328 / When "%" is used as the replacement string in a |:s|
2329 command, use the previous replacement string. |:s%|
2330 *cpo-{*
2331 { The |{| and |}| commands also stop at a "{" character
2332 at the start of a line.
2333 *cpo-.*
2334 . The ":chdir" and ":cd" commands fail if the current
2335 buffer is modified, unless ! is used. Vim doesn't
2336 need this, since it remembers the full path of an
2337 opened file.
2338 *cpo-bar*
2339 | The value of the $LINES and $COLUMNS environment
2340 variables overrule the terminal size values obtained
2341 with system specific functions.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002342
Bram Moolenaar071d4272004-06-13 20:20:40 +00002343
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002344 *'cryptmethod'* *'cm'*
Bram Moolenaara86187b2018-12-16 18:20:00 +01002345'cryptmethod' 'cm' string (default "blowfish2")
Bram Moolenaar49771f42010-07-20 17:32:38 +02002346 global or local to buffer |global-local|
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002347 Method used for encryption when the buffer is written to a file:
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002348 *pkzip*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002349 zip PkZip compatible method. A weak kind of encryption.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002350 Backwards compatible with Vim 7.2 and older.
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002351 *blowfish*
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002352 blowfish Blowfish method. Medium strong encryption but it has
2353 an implementation flaw. Requires Vim 7.3 or later,
2354 files can NOT be read by Vim 7.2 and older. This adds
2355 a "seed" to the file, every time you write the file
2356 the encrypted bytes will be different.
2357 *blowfish2*
2358 blowfish2 Blowfish method. Medium strong encryption. Requires
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01002359 Vim 7.4.401 or later, files can NOT be read by Vim 7.3
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002360 and older. This adds a "seed" to the file, every time
2361 you write the file the encrypted bytes will be
2362 different. The whole undo file is encrypted, not just
2363 the pieces of text.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002364
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01002365 You should use "blowfish2", also to re-encrypt older files.
2366
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002367 When reading an encrypted file 'cryptmethod' will be set automatically
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002368 to the detected method of the file being read. Thus if you write it
2369 without changing 'cryptmethod' the same method will be used.
2370 Changing 'cryptmethod' does not mark the file as modified, you have to
Bram Moolenaar49771f42010-07-20 17:32:38 +02002371 explicitly write it, you don't get a warning unless there are other
2372 modifications. Also see |:X|.
2373
2374 When setting the global value to an empty string, it will end up with
Bram Moolenaara86187b2018-12-16 18:20:00 +01002375 the value "blowfish2". When setting the local value to an empty
2376 string the buffer will use the global value.
Bram Moolenaar49771f42010-07-20 17:32:38 +02002377
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002378 When a new encryption method is added in a later version of Vim, and
2379 the current version does not recognize it, you will get *E821* .
Bram Moolenaar49771f42010-07-20 17:32:38 +02002380 You need to edit this file with the later version of Vim.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002381
2382
Bram Moolenaar071d4272004-06-13 20:20:40 +00002383 *'cscopepathcomp'* *'cspc'*
2384'cscopepathcomp' 'cspc' number (default 0)
2385 global
2386 {not available when compiled without the |+cscope|
2387 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002388 Determines how many components of the path to show in a list of tags.
2389 See |cscopepathcomp|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002390 NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002391
2392 *'cscopeprg'* *'csprg'*
2393'cscopeprg' 'csprg' string (default "cscope")
2394 global
2395 {not available when compiled without the |+cscope|
2396 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002397 Specifies the command to execute cscope. See |cscopeprg|.
2398 This option cannot be set from a |modeline| or in the |sandbox|, for
2399 security reasons.
2400
2401 *'cscopequickfix'* *'csqf'*
2402'cscopequickfix' 'csqf' string (default "")
2403 global
2404 {not available when compiled without the |+cscope|
2405 or |+quickfix| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002406 Specifies whether to use quickfix window to show cscope results.
2407 See |cscopequickfix|.
2408
Bram Moolenaarec7944a2013-06-12 21:29:15 +02002409 *'cscoperelative'* *'csre'* *'nocscoperelative'* *'nocsre'*
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002410'cscoperelative' 'csre' boolean (default off)
2411 global
2412 {not available when compiled without the |+cscope|
2413 feature}
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002414 In the absence of a prefix (-P) for cscope. setting this option enables
2415 to use the basename of cscope.out path as the prefix.
2416 See |cscoperelative|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002417 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002418
Bram Moolenaar071d4272004-06-13 20:20:40 +00002419 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
2420'cscopetag' 'cst' boolean (default off)
2421 global
2422 {not available when compiled without the |+cscope|
2423 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002424 Use cscope for tag commands. See |cscope-options|.
2425 NOTE: This option is reset when 'compatible' is set.
2426
2427 *'cscopetagorder'* *'csto'*
2428'cscopetagorder' 'csto' number (default 0)
2429 global
2430 {not available when compiled without the |+cscope|
2431 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002432 Determines the order in which ":cstag" performs a search. See
2433 |cscopetagorder|.
2434 NOTE: This option is set to 0 when 'compatible' is set.
2435
2436 *'cscopeverbose'* *'csverb'*
2437 *'nocscopeverbose'* *'nocsverb'*
2438'cscopeverbose' 'csverb' boolean (default off)
2439 global
2440 {not available when compiled without the |+cscope|
2441 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002442 Give messages when adding a cscope database. See |cscopeverbose|.
2443 NOTE: This option is reset when 'compatible' is set.
2444
Bram Moolenaar860cae12010-06-05 23:22:07 +02002445 *'cursorbind'* *'crb'* *'nocursorbind'* *'nocrb'*
2446'cursorbind' 'crb' boolean (default off)
2447 local to window
Bram Moolenaar860cae12010-06-05 23:22:07 +02002448 When this option is set, as the cursor in the current
2449 window moves other cursorbound windows (windows that also have
2450 this option set) move their cursors to the corresponding line and
2451 column. This option is useful for viewing the
2452 differences between two versions of a file (see 'diff'); in diff mode,
2453 inserted and deleted lines (though not characters within a line) are
Bram Moolenaar1a384422010-07-14 19:53:30 +02002454 taken into account.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002455
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002456
2457 *'cursorcolumn'* *'cuc'* *'nocursorcolumn'* *'nocuc'*
2458'cursorcolumn' 'cuc' boolean (default off)
2459 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02002460 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002461 feature}
2462 Highlight the screen column of the cursor with CursorColumn
2463 |hl-CursorColumn|. Useful to align text. Will make screen redrawing
2464 slower.
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00002465 If you only want the highlighting in the current window you can use
2466 these autocommands: >
2467 au WinLeave * set nocursorline nocursorcolumn
2468 au WinEnter * set cursorline cursorcolumn
2469<
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002470
2471 *'cursorline'* *'cul'* *'nocursorline'* *'nocul'*
2472'cursorline' 'cul' boolean (default off)
2473 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02002474 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002475 feature}
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002476 Highlight the text line of the cursor with CursorLine |hl-CursorLine|.
2477 Useful to easily spot the cursor. Will make screen redrawing slower.
Bram Moolenaare2f98b92006-03-29 21:18:24 +00002478 When Visual mode is active the highlighting isn't used to make it
Bram Moolenaar779b74b2006-04-10 14:55:34 +00002479 easier to see the selected text.
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002480
2481
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002482 *'cursorlineopt'* *'culopt'*
Bram Moolenaar017ba072019-09-14 21:01:23 +02002483'cursorlineopt' 'culopt' string (default: "number,line")
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002484 local to window
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002485 {not available when compiled without the |+syntax|
2486 feature}
Bram Moolenaar017ba072019-09-14 21:01:23 +02002487 Comma separated list of settings for how 'cursorline' is displayed.
2488 Valid values:
2489 "line" Highlight the text line of the cursor with
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002490 CursorLine |hl-CursorLine|.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002491 "screenline" Highlight only the screen line of the cursor with
2492 CursorLine |hl-CursorLine|.
2493 "number" Highlight the line number of the cursor with
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002494 CursorLineNr |hl-CursorLineNr|.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002495
2496 Special value:
2497 "both" Alias for the values "line,number".
2498
2499 "line" and "screenline" cannot be used together.
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002500
2501
Bram Moolenaar071d4272004-06-13 20:20:40 +00002502 *'debug'*
2503'debug' string (default "")
2504 global
Bram Moolenaar57657d82006-04-21 22:12:41 +00002505 These values can be used:
2506 msg Error messages that would otherwise be omitted will be given
2507 anyway.
2508 throw Error messages that would otherwise be omitted will be given
2509 anyway and also throw an exception and set |v:errmsg|.
2510 beep A message will be given when otherwise only a beep would be
2511 produced.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002512 The values can be combined, separated by a comma.
Bram Moolenaar57657d82006-04-21 22:12:41 +00002513 "msg" and "throw" are useful for debugging 'foldexpr', 'formatexpr' or
2514 'indentexpr'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002515
2516 *'define'* *'def'*
2517'define' 'def' string (default "^\s*#\s*define")
2518 global or local to buffer |global-local|
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002519 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002520 pattern, just like for the "/" command. This option is used for the
2521 commands like "[i" and "[d" |include-search|. The 'isident' option is
2522 used to recognize the defined name after the match:
2523 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2524 See |option-backslash| about inserting backslashes to include a space
2525 or backslash.
2526 The default value is for C programs. For C++ this value would be
2527 useful, to include const type declarations: >
2528 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
Bram Moolenaar63b74a82019-03-24 15:09:13 +01002529< You can also use "\ze" just before the name and continue the pattern
2530 to check what is following. E.g. for Javascript, if a function is
2531 defined with "func_name = function(args)": >
2532 ^\s*\ze\i\+\s*=\s*function(
2533< If the function is defined with "func_name : function() {...": >
2534 ^\s*\ze\i\+\s*[:]\s*(*function\s*(
Bram Moolenaar071d4272004-06-13 20:20:40 +00002535< When using the ":set" command, you need to double the backslashes!
Bram Moolenaar63b74a82019-03-24 15:09:13 +01002536 To avoid that use `:let` with a single quote string: >
2537 let &l:define = '^\s*\ze\k\+\s*=\s*function('
Bram Moolenaar911ead12019-04-21 00:03:35 +02002538<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002539
2540 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2541'delcombine' 'deco' boolean (default off)
2542 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002543 If editing Unicode and this option is set, backspace and Normal mode
2544 "x" delete each combining character on its own. When it is off (the
2545 default) the character along with its combining characters are
2546 deleted.
2547 Note: When 'delcombine' is set "xx" may work different from "2x"!
2548
2549 This is useful for Arabic, Hebrew and many other languages where one
2550 may have combining characters overtop of base characters, and want
2551 to remove only the combining ones.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002552 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002553
2554 *'dictionary'* *'dict'*
2555'dictionary' 'dict' string (default "")
2556 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002557 List of file names, separated by commas, that are used to lookup words
2558 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2559 contain a list of words. This can be one word per line, or several
2560 words per line, separated by non-keyword characters (white space is
2561 preferred). Maximum line length is 510 bytes.
Bram Moolenaar259f26a2018-05-15 22:25:40 +02002562
2563 When this option is empty or an entry "spell" is present, and spell
2564 checking is enabled, words in the word lists for the currently active
2565 'spelllang' are used. See |spell|.
2566
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002567 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002568 after a comma are ignored, otherwise spaces are included in the file
2569 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002570 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002571 Where to find a list of words?
2572 - On FreeBSD, there is the file "/usr/share/dict/words".
2573 - In the Simtel archive, look in the "msdos/linguist" directory.
2574 - In "miscfiles" of the GNU collection.
2575 The use of |:set+=| and |:set-=| is preferred when adding or removing
2576 directories from the list. This avoids problems when a future version
2577 uses another default.
2578 Backticks cannot be used in this option for security reasons.
2579
2580 *'diff'* *'nodiff'*
2581'diff' boolean (default off)
2582 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00002583 {not available when compiled without the |+diff|
2584 feature}
2585 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002586 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002587
2588 *'dex'* *'diffexpr'*
2589'diffexpr' 'dex' string (default "")
2590 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002591 {not available when compiled without the |+diff|
2592 feature}
Bram Moolenaare828b762018-09-10 17:51:58 +02002593 Expression which is evaluated to obtain a diff file (either ed-style
2594 or unified-style) from two versions of a file. See |diff-diffexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002595 This option cannot be set from a |modeline| or in the |sandbox|, for
2596 security reasons.
2597
2598 *'dip'* *'diffopt'*
Bram Moolenaarc8234772019-11-10 21:00:27 +01002599'diffopt' 'dip' string (default "internal,filler,closeoff")
Bram Moolenaar071d4272004-06-13 20:20:40 +00002600 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002601 {not available when compiled without the |+diff|
2602 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002603 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002604 All are optional. Items must be separated by a comma.
2605
2606 filler Show filler lines, to keep the text
2607 synchronized with a window that has inserted
2608 lines at the same position. Mostly useful
2609 when windows are side-by-side and 'scrollbind'
2610 is set.
2611
2612 context:{n} Use a context of {n} lines between a change
2613 and a fold that contains unchanged lines.
2614 When omitted a context of six lines is used.
Bram Moolenaarf6b40102019-02-22 15:24:03 +01002615 When using zero the context is actually one,
2616 since folds require a line in between, also
2617 for a deleted line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002618 See |fold-diff|.
2619
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002620 iblank Ignore changes where lines are all blank. Adds
2621 the "-B" flag to the "diff" command if
2622 'diffexpr' is empty. Check the documentation
2623 of the "diff" command for what this does
2624 exactly.
2625 NOTE: the diff windows will get out of sync,
2626 because no differences between blank lines are
2627 taken into account.
2628
Bram Moolenaar071d4272004-06-13 20:20:40 +00002629 icase Ignore changes in case of text. "a" and "A"
2630 are considered the same. Adds the "-i" flag
2631 to the "diff" command if 'diffexpr' is empty.
2632
2633 iwhite Ignore changes in amount of white space. Adds
2634 the "-b" flag to the "diff" command if
2635 'diffexpr' is empty. Check the documentation
2636 of the "diff" command for what this does
2637 exactly. It should ignore adding trailing
2638 white space, but not leading white space.
2639
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002640 iwhiteall Ignore all white space changes. Adds
2641 the "-w" flag to the "diff" command if
2642 'diffexpr' is empty. Check the documentation
2643 of the "diff" command for what this does
2644 exactly.
2645
2646 iwhiteeol Ignore white space changes at end of line.
2647 Adds the "-Z" flag to the "diff" command if
2648 'diffexpr' is empty. Check the documentation
2649 of the "diff" command for what this does
2650 exactly.
2651
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002652 horizontal Start diff mode with horizontal splits (unless
2653 explicitly specified otherwise).
2654
2655 vertical Start diff mode with vertical splits (unless
2656 explicitly specified otherwise).
2657
Bram Moolenaarc8234772019-11-10 21:00:27 +01002658 closeoff When a window is closed where 'diff' is set
2659 and there is only one window remaining in the
2660 same tab page with 'diff' set, execute
2661 `:diffoff` in that window. This undoes a
2662 `:diffsplit` command.
2663
Bram Moolenaar97ce4192017-12-01 20:35:58 +01002664 hiddenoff Do not use diff mode for a buffer when it
2665 becomes hidden.
2666
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002667 foldcolumn:{n} Set the 'foldcolumn' option to {n} when
2668 starting diff mode. Without this 2 is used.
2669
Bram Moolenaare828b762018-09-10 17:51:58 +02002670 internal Use the internal diff library. This is
2671 ignored when 'diffexpr' is set. *E960*
2672 When running out of memory when writing a
2673 buffer this item will be ignored for diffs
2674 involving that buffer. Set the 'verbose'
2675 option to see when this happens.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002676
Bram Moolenaare828b762018-09-10 17:51:58 +02002677 indent-heuristic
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01002678 Use the indent heuristic for the internal
2679 diff library.
Bram Moolenaare828b762018-09-10 17:51:58 +02002680
2681 algorithm:{text} Use the specified diff algorithm with the
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01002682 internal diff engine. Currently supported
Bram Moolenaare828b762018-09-10 17:51:58 +02002683 algorithms are:
2684 myers the default algorithm
2685 minimal spend extra time to generate the
2686 smallest possible diff
2687 patience patience diff algorithm
2688 histogram histogram diff algorithm
2689
2690 Examples: >
2691 :set diffopt=internal,filler,context:4
Bram Moolenaar071d4272004-06-13 20:20:40 +00002692 :set diffopt=
Bram Moolenaare828b762018-09-10 17:51:58 +02002693 :set diffopt=internal,filler,foldcolumn:3
2694 :set diffopt-=internal " do NOT use the internal diff parser
Bram Moolenaar071d4272004-06-13 20:20:40 +00002695<
2696 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
2697'digraph' 'dg' boolean (default off)
2698 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002699 {not available when compiled without the |+digraphs|
2700 feature}
2701 Enable the entering of digraphs in Insert mode with {char1} <BS>
2702 {char2}. See |digraphs|.
2703 NOTE: This option is reset when 'compatible' is set.
2704
2705 *'directory'* *'dir'*
2706'directory' 'dir' string (default for Amiga: ".,t:",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01002707 for Win32: ".,$TEMP,c:\tmp,c:\temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00002708 for Unix: ".,~/tmp,/var/tmp,/tmp")
2709 global
2710 List of directory names for the swap file, separated with commas.
2711 - The swap file will be created in the first directory where this is
2712 possible.
2713 - Empty means that no swap file will be used (recovery is
Bram Moolenaar00e192b2019-10-19 17:01:28 +02002714 impossible!) and no |E303| error will be given.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002715 - A directory "." means to put the swap file in the same directory as
2716 the edited file. On Unix, a dot is prepended to the file name, so
2717 it doesn't show in a directory listing. On MS-Windows the "hidden"
2718 attribute is set and a dot prepended if possible.
Bram Moolenaar8024f932020-01-14 19:29:13 +01002719 - A directory starting with "./" (or ".\" for MS-Windows) means to put
2720 the swap file relative to where the edited file is. The leading "."
2721 is replaced with the path name of the edited file.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02002722 - For Unix and Win32, if a directory ends in two path separators "//",
2723 the swap file name will be built from the complete path to the file
2724 with all path separators substituted to percent '%' signs. This will
2725 ensure file name uniqueness in the preserve directory.
2726 On Win32, it is also possible to end with "\\". However, When a
2727 separating comma is following, you must use "//", since "\\" will
2728 include the comma in the file name. Therefore it is recommended to
2729 use '//', instead of '\\'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002730 - Spaces after the comma are ignored, other spaces are considered part
2731 of the directory name. To have a space at the start of a directory
2732 name, precede it with a backslash.
2733 - To include a comma in a directory name precede it with a backslash.
2734 - A directory name may end in an ':' or '/'.
2735 - Environment variables are expanded |:set_env|.
2736 - Careful with '\' characters, type one before a space, type two to
2737 get one in the option (see |option-backslash|), for example: >
2738 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
2739< - For backwards compatibility with Vim version 3.0 a '>' at the start
2740 of the option is removed.
2741 Using "." first in the list is recommended. This means that editing
2742 the same file twice will result in a warning. Using "/tmp" on Unix is
2743 discouraged: When the system crashes you lose the swap file.
2744 "/var/tmp" is often not cleared when rebooting, thus is a better
2745 choice than "/tmp". But it can contain a lot of files, your swap
2746 files get lost in the crowd. That is why a "tmp" directory in your
2747 home directory is tried first.
2748 The use of |:set+=| and |:set-=| is preferred when adding or removing
2749 directories from the list. This avoids problems when a future version
2750 uses another default.
2751 This option cannot be set from a |modeline| or in the |sandbox|, for
2752 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002753
2754 *'display'* *'dy'*
Bram Moolenaarbc8801c2016-08-02 21:04:33 +02002755'display' 'dy' string (default "", set to "truncate" in
2756 |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002757 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002758 Change the way text is displayed. This is comma separated list of
2759 flags:
2760 lastline When included, as much as possible of the last line
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02002761 in a window will be displayed. "@@@" is put in the
2762 last columns of the last screen line to indicate the
2763 rest of the line is not displayed.
2764 truncate Like "lastline", but "@@@" is displayed in the first
2765 column of the last screen line. Overrules "lastline".
Bram Moolenaar071d4272004-06-13 20:20:40 +00002766 uhex Show unprintable characters hexadecimal as <xx>
2767 instead of using ^C and ~C.
2768
Bram Moolenaard0796902016-09-16 20:02:31 +02002769 When neither "lastline" nor "truncate" is included, a last line that
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02002770 doesn't fit is replaced with "@" lines.
2771
Bram Moolenaar071d4272004-06-13 20:20:40 +00002772 *'eadirection'* *'ead'*
2773'eadirection' 'ead' string (default "both")
2774 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002775 Tells when the 'equalalways' option applies:
2776 ver vertically, width of windows is not affected
2777 hor horizontally, height of windows is not affected
2778 both width and height of windows is affected
2779
2780 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
2781'edcompatible' 'ed' boolean (default off)
2782 global
2783 Makes the 'g' and 'c' flags of the ":substitute" command to be
2784 toggled each time the flag is given. See |complex-change|. See
2785 also 'gdefault' option.
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +02002786 Switching this option on may break plugins!
Bram Moolenaar071d4272004-06-13 20:20:40 +00002787
Bram Moolenaar03413f42016-04-12 21:07:15 +02002788 *'emoji'* *'emo'* *'noemoji'* *'noemo'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01002789'emoji' 'emo' boolean (default: on)
2790 global
Bram Moolenaar3848e002016-03-19 18:42:29 +01002791 When on all Unicode emoji characters are considered to be full width.
2792
2793
Bram Moolenaar071d4272004-06-13 20:20:40 +00002794 *'encoding'* *'enc'* *E543*
2795'encoding' 'enc' string (default: "latin1" or value from $LANG)
2796 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002797 Sets the character encoding used inside Vim. It applies to text in
2798 the buffers, registers, Strings in expressions, text stored in the
2799 viminfo file, etc. It sets the kind of characters which Vim can work
2800 with. See |encoding-names| for the possible values.
2801
2802 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002803 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002804 It should normally be kept at its default value, or set when Vim
Bram Moolenaar02467872007-05-06 13:22:01 +00002805 starts up. See |multibyte|. To reload the menus see |:menutrans|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002806
Bram Moolenaar865242e2010-07-14 21:12:05 +02002807 This option cannot be set from a |modeline|. It would most likely
2808 corrupt the text.
2809
Bram Moolenaar3df01732017-02-17 22:47:16 +01002810 NOTE: For GTK+ 2 or later, it is highly recommended to set 'encoding'
2811 to "utf-8". Although care has been taken to allow different values of
Bram Moolenaar071d4272004-06-13 20:20:40 +00002812 'encoding', "utf-8" is the natural choice for the environment and
2813 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002814 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00002815 versions, and to avoid changing the encoding of newly created files
2816 without your knowledge (in case 'fileencodings' is empty).
2817
2818 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002819 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00002820 iconv() or as specified with 'charconvert'.
2821
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002822 If you need to know whether 'encoding' is a multi-byte encoding, you
2823 can use: >
2824 if has("multi_byte_encoding")
2825<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002826 Normally 'encoding' will be equal to your current locale. This will
2827 be the default if Vim recognizes your environment settings. If
2828 'encoding' is not set to the current locale, 'termencoding' must be
2829 set to convert typed and displayed text. See |encoding-table|.
2830
2831 When you set this option, it fires the |EncodingChanged| autocommand
2832 event so that you can set up fonts if necessary.
2833
2834 When the option is set, the value is converted to lowercase. Thus
2835 you can set it with uppercase values too. Underscores are translated
2836 to '-' signs.
2837 When the encoding is recognized, it is changed to the standard name.
2838 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
2839 "iso-8859-2" and "utf8" becomes "utf-8".
2840
2841 Note: "latin1" is also used when the encoding could not be detected.
2842 This only works when editing files in the same encoding! When the
2843 actual character set is not latin1, make sure 'fileencoding' and
2844 'fileencodings' are empty. When conversion is needed, switch to using
2845 utf-8.
2846
2847 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
2848 You don't notice this while editing, but it does matter for the
2849 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
2850 setting 'encoding' to one of these values instead of utf-8 only has
2851 effect for encoding used for files when 'fileencoding' is empty.
2852
Bram Moolenaar661b1822005-07-28 22:36:45 +00002853 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
2854 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002855
2856 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
2857'endofline' 'eol' boolean (default on)
2858 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002859 When writing a file and this option is off and the 'binary' option
Bram Moolenaar34d72d42015-07-17 14:18:08 +02002860 is on, or 'fixeol' option is off, no <EOL> will be written for the
2861 last line in the file. This option is automatically set or reset when
2862 starting to edit a new file, depending on whether file has an <EOL>
2863 for the last line in the file. Normally you don't have to set or
2864 reset this option.
2865 When 'binary' is off and 'fixeol' is on the value is not used when
2866 writing the file. When 'binary' is on or 'fixeol' is off it is used
2867 to remember the presence of a <EOL> for the last line in the file, so
2868 that when you write the file the situation from the original file can
2869 be kept. But you can change it if you want to.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002870
2871 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
2872'equalalways' 'ea' boolean (default on)
2873 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002874 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00002875 splitting or closing a window. This also happens the moment the
2876 option is switched on. When off, splitting a window will reduce the
2877 size of the current window and leave the other windows the same. When
2878 closing a window the extra lines are given to the window next to it
2879 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00002880 When mixing vertically and horizontally split windows, a minimal size
2881 is computed and some windows may be larger if there is room. The
2882 'eadirection' option tells in which direction the size is affected.
Bram Moolenaar67f71312007-08-12 14:55:56 +00002883 Changing the height and width of a window can be avoided by setting
2884 'winfixheight' and 'winfixwidth', respectively.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002885 If a window size is specified when creating a new window sizes are
2886 currently not equalized (it's complicated, but may be implemented in
2887 the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002888
2889 *'equalprg'* *'ep'*
2890'equalprg' 'ep' string (default "")
2891 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002892 External program to use for "=" command. When this option is empty
Bram Moolenaar446cb832008-06-24 21:56:24 +00002893 the internal formatting functions are used; either 'lisp', 'cindent'
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002894 or 'indentexpr'. When Vim was compiled without internal formatting,
2895 the "indent" program is used.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002896 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002897 about including spaces and backslashes.
2898 This option cannot be set from a |modeline| or in the |sandbox|, for
2899 security reasons.
2900
2901 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
2902'errorbells' 'eb' boolean (default off)
2903 global
2904 Ring the bell (beep or screen flash) for error messages. This only
2905 makes a difference for error messages, the bell will be used always
2906 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002907 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar165bc692015-07-21 17:53:25 +02002908 screen flash or do nothing. See 'belloff' to finetune when to ring the
2909 bell.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002910
2911 *'errorfile'* *'ef'*
2912'errorfile' 'ef' string (Amiga default: "AztecC.Err",
2913 others: "errors.err")
2914 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002915 {not available when compiled without the |+quickfix|
2916 feature}
2917 Name of the errorfile for the QuickFix mode (see |:cf|).
2918 When the "-q" command-line argument is used, 'errorfile' is set to the
2919 following argument. See |-q|.
2920 NOT used for the ":make" command. See 'makeef' for that.
2921 Environment variables are expanded |:set_env|.
2922 See |option-backslash| about including spaces and backslashes.
2923 This option cannot be set from a |modeline| or in the |sandbox|, for
2924 security reasons.
2925
2926 *'errorformat'* *'efm'*
2927'errorformat' 'efm' string (default is very long)
2928 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002929 {not available when compiled without the |+quickfix|
2930 feature}
2931 Scanf-like description of the format for the lines in the error file
2932 (see |errorformat|).
2933
2934 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
2935'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
2936 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002937 Function keys that start with an <Esc> are recognized in Insert
2938 mode. When this option is off, the cursor and function keys cannot be
2939 used in Insert mode if they start with an <Esc>. The advantage of
2940 this is that the single <Esc> is recognized immediately, instead of
2941 after one second. Instead of resetting this option, you might want to
2942 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
2943 when 'esckeys' is off, you can still map anything, but the cursor keys
2944 won't work by default.
2945 NOTE: This option is set to the Vi default value when 'compatible' is
2946 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaarc8234772019-11-10 21:00:27 +01002947 NOTE: when this option is off then the |modifyOtherKeys| functionality
2948 is disabled while in Insert mode to avoid ending Insert mode with any
2949 key that has a modifier.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002950
2951 *'eventignore'* *'ei'*
2952'eventignore' 'ei' string (default "")
2953 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002954 A list of autocommand event names, which are to be ignored.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00002955 When set to "all" or when "all" is one of the items, all autocommand
2956 events are ignored, autocommands will not be executed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002957 Otherwise this is a comma separated list of event names. Example: >
2958 :set ei=WinEnter,WinLeave
2959<
2960 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
2961'expandtab' 'et' boolean (default off)
2962 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002963 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002964 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002965 when 'autoindent' is on. To insert a real tab when 'expandtab' is
2966 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
Bram Moolenaarca635012015-09-25 20:34:21 +02002967 This option is reset when the 'paste' option is set and restored when
2968 the 'paste' option is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002969 NOTE: This option is reset when 'compatible' is set.
2970
2971 *'exrc'* *'ex'* *'noexrc'* *'noex'*
2972'exrc' 'ex' boolean (default off)
2973 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002974 Enables the reading of .vimrc, .exrc and .gvimrc in the current
Bram Moolenaar36f44c22016-08-28 18:17:20 +02002975 directory.
2976
2977 Setting this option is a potential security leak. E.g., consider
2978 unpacking a package or fetching files from github, a .vimrc in there
2979 might be a trojan horse. BETTER NOT SET THIS OPTION!
2980 Instead, define an autocommand in your .vimrc to set options for a
2981 matching directory.
2982
2983 If you do switch this option on you should also consider setting the
2984 'secure' option (see |initialization|).
2985 Also see |.vimrc| and |gui-init|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002986 This option cannot be set from a |modeline| or in the |sandbox|, for
2987 security reasons.
2988
2989 *'fileencoding'* *'fenc'* *E213*
2990'fileencoding' 'fenc' string (default: "")
2991 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002992 Sets the character encoding for the file of this buffer.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002993
Bram Moolenaar071d4272004-06-13 20:20:40 +00002994 When 'fileencoding' is different from 'encoding', conversion will be
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002995 done when writing the file. For reading see below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002996 When 'fileencoding' is empty, the same value as 'encoding' will be
2997 used (no conversion when reading or writing a file).
Bram Moolenaar214641f2017-03-05 17:04:09 +01002998 No error will be given when the value is set, only when it is used,
2999 only when writing a file.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003000 Conversion will also be done when 'encoding' and 'fileencoding' are
3001 both a Unicode encoding and 'fileencoding' is not utf-8. That's
3002 because internally Unicode is always stored as utf-8.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003003 WARNING: Conversion can cause loss of information! When
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003004 'encoding' is "utf-8" or another Unicode encoding, conversion
3005 is most likely done in a way that the reverse conversion
3006 results in the same text. When 'encoding' is not "utf-8" some
3007 characters may be lost!
Bram Moolenaar865242e2010-07-14 21:12:05 +02003008
Bram Moolenaar071d4272004-06-13 20:20:40 +00003009 See 'encoding' for the possible values. Additionally, values may be
3010 specified that can be handled by the converter, see
3011 |mbyte-conversion|.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003012
Bram Moolenaar071d4272004-06-13 20:20:40 +00003013 When reading a file 'fileencoding' will be set from 'fileencodings'.
3014 To read a file in a certain encoding it won't work by setting
Bram Moolenaar02467872007-05-06 13:22:01 +00003015 'fileencoding', use the |++enc| argument. One exception: when
3016 'fileencodings' is empty the value of 'fileencoding' is used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003017 For a new file the global value of 'fileencoding' is used.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003018
Bram Moolenaar071d4272004-06-13 20:20:40 +00003019 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
3020 When the option is set, the value is converted to lowercase. Thus
3021 you can set it with uppercase values too. '_' characters are
3022 replaced with '-'. If a name is recognized from the list for
3023 'encoding', it is replaced by the standard name. For example
3024 "ISO8859-2" becomes "iso-8859-2".
Bram Moolenaar865242e2010-07-14 21:12:05 +02003025
Bram Moolenaar071d4272004-06-13 20:20:40 +00003026 When this option is set, after starting to edit a file, the 'modified'
3027 option is set, because the file would be different when written.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003028
3029 Keep in mind that changing 'fenc' from a modeline happens
3030 AFTER the text has been read, thus it applies to when the file will be
3031 written. If you do set 'fenc' in a modeline, you might want to set
3032 'nomodified' to avoid not being able to ":q".
3033
Bram Moolenaar071d4272004-06-13 20:20:40 +00003034 This option can not be changed when 'modifiable' is off.
3035
3036 *'fe'*
3037 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003038 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003039 old short name was 'fe', which is no longer used.
3040
3041 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003042'fileencodings' 'fencs' string (default: "ucs-bom",
3043 "ucs-bom,utf-8,default,latin1" when
3044 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003045 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003046 This is a list of character encodings considered when starting to edit
3047 an existing file. When a file is read, Vim tries to use the first
3048 mentioned character encoding. If an error is detected, the next one
3049 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003050 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00003051 an empty string, which means the value of 'encoding' is used.
3052 WARNING: Conversion can cause loss of information! When
3053 'encoding' is "utf-8" (or one of the other Unicode variants)
3054 conversion is most likely done in a way that the reverse
3055 conversion results in the same text. When 'encoding' is not
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003056 "utf-8" some non-ASCII characters may be lost! You can use
3057 the |++bad| argument to specify what is done with characters
3058 that can't be converted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003059 For an empty file or a file with only ASCII characters most encodings
3060 will work and the first entry of 'fileencodings' will be used (except
3061 "ucs-bom", which requires the BOM to be present). If you prefer
3062 another encoding use an BufReadPost autocommand event to test if your
3063 preferred encoding is to be used. Example: >
3064 au BufReadPost * if search('\S', 'w') == 0 |
3065 \ set fenc=iso-2022-jp | endif
3066< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
3067 non-blank characters.
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003068 When the |++enc| argument is used then the value of 'fileencodings' is
3069 not used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003070 Note that 'fileencodings' is not used for a new file, the global value
3071 of 'fileencoding' is used instead. You can set it with: >
3072 :setglobal fenc=iso-8859-2
3073< This means that a non-existing file may get a different encoding than
3074 an empty file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003075 The special value "ucs-bom" can be used to check for a Unicode BOM
3076 (Byte Order Mark) at the start of the file. It must not be preceded
3077 by "utf-8" or another Unicode encoding for this to work properly.
3078 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
3079 because Vim cannot detect an error, thus the encoding is always
3080 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003081 The special value "default" can be used for the encoding from the
3082 environment. This is the default value for 'encoding'. It is useful
3083 when 'encoding' is set to "utf-8" and your environment uses a
3084 non-latin1 encoding, such as Russian.
Bram Moolenaarca003e12006-03-17 23:19:38 +00003085 When 'encoding' is "utf-8" and a file contains an illegal byte
3086 sequence it won't be recognized as UTF-8. You can use the |8g8|
3087 command to find the illegal byte sequence.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003088 WRONG VALUES: WHAT'S WRONG:
3089 latin1,utf-8 "latin1" will always be used
3090 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
3091 file
3092 cp1250,latin1 "cp1250" will always be used
3093 If 'fileencodings' is empty, 'fileencoding' is not modified.
3094 See 'fileencoding' for the possible values.
3095 Setting this option does not have an effect until the next time a file
3096 is read.
3097
3098 *'fileformat'* *'ff'*
Bram Moolenaar00590742019-02-15 21:06:09 +01003099'fileformat' 'ff' string (MS-Windows default: "dos",
3100 Unix, macOS default: "unix")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003101 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003102 This gives the <EOL> of the current buffer, which is used for
3103 reading/writing the buffer from/to a file:
3104 dos <CR> <NL>
3105 unix <NL>
3106 mac <CR>
3107 When "dos" is used, CTRL-Z at the end of a file is ignored.
3108 See |file-formats| and |file-read|.
3109 For the character encoding of the file see 'fileencoding'.
3110 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
Bram Moolenaarbf884932013-04-05 22:26:15 +02003111 works like it was set to "unix".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003112 This option is set automatically when starting to edit a file and
3113 'fileformats' is not empty and 'binary' is off.
3114 When this option is set, after starting to edit a file, the 'modified'
3115 option is set, because the file would be different when written.
3116 This option can not be changed when 'modifiable' is off.
3117 For backwards compatibility: When this option is set to "dos",
3118 'textmode' is set, otherwise 'textmode' is reset.
3119
3120 *'fileformats'* *'ffs'*
3121'fileformats' 'ffs' string (default:
Bram Moolenaar00590742019-02-15 21:06:09 +01003122 Vim+Vi MS-Windows: "dos,unix",
3123 Vim Unix, macOS: "unix,dos",
Bram Moolenaar071d4272004-06-13 20:20:40 +00003124 Vi Cygwin: "unix,dos",
3125 Vi others: "")
3126 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003127 This gives the end-of-line (<EOL>) formats that will be tried when
3128 starting to edit a new buffer and when reading a file into an existing
3129 buffer:
3130 - When empty, the format defined with 'fileformat' will be used
3131 always. It is not set automatically.
3132 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003133 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003134 'fileformats' name will be used when a file is read into an existing
3135 buffer, no matter what 'fileformat' for that buffer is set to.
3136 - When more than one name is present, separated by commas, automatic
3137 <EOL> detection will be done when reading a file. When starting to
3138 edit a file, a check is done for the <EOL>:
3139 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
3140 'fileformat' is set to "dos".
3141 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003142 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003143 preceding <CR>, "unix" is preferred over "dos".
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01003144 3. If 'fileformat' has not yet been set, and if a <CR> is found, and
3145 if 'fileformats' includes "mac", 'fileformat' is set to "mac".
Bram Moolenaar00659062010-09-21 22:34:02 +02003146 This means that "mac" is only chosen when:
3147 "unix" is not present or no <NL> is found in the file, and
3148 "dos" is not present or no <CR><NL> is found in the file.
3149 Except: if "unix" was chosen, but there is a <CR> before
3150 the first <NL>, and there appear to be more <CR>s than <NL>s in
Bram Moolenaar166af9b2010-11-16 20:34:40 +01003151 the first few lines, "mac" is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003152 4. If 'fileformat' is still not set, the first name from
3153 'fileformats' is used.
3154 When reading a file into an existing buffer, the same is done, but
3155 this happens like 'fileformat' has been set appropriately for that
3156 file only, the option is not changed.
3157 When 'binary' is set, the value of 'fileformats' is not used.
3158
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01003159 When Vim starts up with an empty buffer the first item is used. You
3160 can overrule this by setting 'fileformat' in your .vimrc.
Bram Moolenaar81af9252010-12-10 20:35:50 +01003161
Bram Moolenaar071d4272004-06-13 20:20:40 +00003162 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
3163 are ":source"ed and for vimrc files, automatic <EOL> detection may be
3164 done:
3165 - When 'fileformats' is empty, there is no automatic detection. Dos
3166 format will be used.
3167 - When 'fileformats' is set to one or more names, automatic detection
3168 is done. This is based on the first <NL> in the file: If there is a
3169 <CR> in front of it, Dos format is used, otherwise Unix format is
3170 used.
3171 Also see |file-formats|.
3172 For backwards compatibility: When this option is set to an empty
3173 string or one format (no comma is included), 'textauto' is reset,
3174 otherwise 'textauto' is set.
3175 NOTE: This option is set to the Vi default value when 'compatible' is
3176 set and to the Vim default value when 'compatible' is reset.
3177
Bram Moolenaarbf884932013-04-05 22:26:15 +02003178 *'fileignorecase'* *'fic'* *'nofileignorecase'* *'nofic'*
3179'fileignorecase' 'fic' boolean (default on for systems where case in file
3180 names is normally ignored)
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003181 global
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003182 When set case is ignored when using file names and directories.
3183 See 'wildignorecase' for only ignoring case when doing completion.
3184
Bram Moolenaar071d4272004-06-13 20:20:40 +00003185 *'filetype'* *'ft'*
3186'filetype' 'ft' string (default: "")
3187 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003188 When this option is set, the FileType autocommand event is triggered.
3189 All autocommands that match with the value of this option will be
3190 executed. Thus the value of 'filetype' is used in place of the file
3191 name.
3192 Otherwise this option does not always reflect the current file type.
3193 This option is normally set when the file type is detected. To enable
3194 this use the ":filetype on" command. |:filetype|
3195 Setting this option to a different value is most useful in a modeline,
3196 for a file for which the file type is not automatically recognized.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003197 Example, for in an IDL file:
3198 /* vim: set filetype=idl : */ ~
3199 |FileType| |filetypes|
3200 When a dot appears in the value then this separates two filetype
3201 names. Example:
3202 /* vim: set filetype=c.doxygen : */ ~
3203 This will use the "c" filetype first, then the "doxygen" filetype.
3204 This works both for filetype plugins and for syntax files. More than
3205 one dot may appear.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003206 This option is not copied to another buffer, independent of the 's' or
3207 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003208 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003209
3210 *'fillchars'* *'fcs'*
3211'fillchars' 'fcs' string (default "vert:|,fold:-")
3212 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02003213 {not available when compiled without the |+folding|
3214 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003215 Characters to fill the statuslines and vertical separators.
3216 It is a comma separated list of items:
3217
3218 item default Used for ~
3219 stl:c ' ' or '^' statusline of the current window
Bram Moolenaar38a55632016-02-15 22:07:32 +01003220 stlnc:c ' ' or '=' statusline of the non-current windows
Bram Moolenaar071d4272004-06-13 20:20:40 +00003221 vert:c '|' vertical separators |:vsplit|
3222 fold:c '-' filling 'foldtext'
3223 diff:c '-' deleted lines of the 'diff' option
3224
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003225 Any one that is omitted will fall back to the default. For "stl" and
Bram Moolenaar38a55632016-02-15 22:07:32 +01003226 "stlnc" the space will be used when there is highlighting, '^' or '='
Bram Moolenaar071d4272004-06-13 20:20:40 +00003227 otherwise.
3228
3229 Example: >
Bram Moolenaar38a55632016-02-15 22:07:32 +01003230 :set fillchars=stl:^,stlnc:=,vert:\|,fold:-,diff:-
Bram Moolenaar071d4272004-06-13 20:20:40 +00003231< This is similar to the default, except that these characters will also
3232 be used when there is highlighting.
3233
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003234 for "stl" and "stlnc" only single-byte values are supported.
3235
Bram Moolenaar071d4272004-06-13 20:20:40 +00003236 The highlighting used for these items:
3237 item highlight group ~
3238 stl:c StatusLine |hl-StatusLine|
3239 stlnc:c StatusLineNC |hl-StatusLineNC|
3240 vert:c VertSplit |hl-VertSplit|
3241 fold:c Folded |hl-Folded|
3242 diff:c DiffDelete |hl-DiffDelete|
3243
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003244 *'fixendofline'* *'fixeol'* *'nofixendofline'* *'nofixeol'*
3245'fixendofline' 'fixeol' boolean (default on)
3246 local to buffer
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003247 When writing a file and this option is on, <EOL> at the end of file
3248 will be restored if missing. Turn this option off if you want to
3249 preserve the situation from the original file.
3250 When the 'binary' option is set the value of this option doesn't
3251 matter.
3252 See the 'endofline' option.
3253
Bram Moolenaar071d4272004-06-13 20:20:40 +00003254 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
3255'fkmap' 'fk' boolean (default off) *E198*
3256 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003257 {only available when compiled with the |+rightleft|
3258 feature}
Bram Moolenaar14184a32019-02-16 15:10:30 +01003259 This option was for using Farsi, which has been removed. See
3260 |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003261
3262 *'foldclose'* *'fcl'*
3263'foldclose' 'fcl' string (default "")
3264 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003265 {not available when compiled without the |+folding|
3266 feature}
3267 When set to "all", a fold is closed when the cursor isn't in it and
3268 its level is higher than 'foldlevel'. Useful if you want folds to
3269 automatically close when moving out of them.
3270
3271 *'foldcolumn'* *'fdc'*
3272'foldcolumn' 'fdc' number (default 0)
3273 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003274 {not available when compiled without the |+folding|
3275 feature}
3276 When non-zero, a column with the specified width is shown at the side
3277 of the window which indicates open and closed folds. The maximum
3278 value is 12.
3279 See |folding|.
3280
3281 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
3282'foldenable' 'fen' boolean (default on)
3283 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003284 {not available when compiled without the |+folding|
3285 feature}
3286 When off, all folds are open. This option can be used to quickly
3287 switch between showing all text unfolded and viewing the text with
3288 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003289 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00003290 'foldenable' is off.
3291 This option is set by commands that create a new fold or close a fold.
3292 See |folding|.
3293
3294 *'foldexpr'* *'fde'*
3295'foldexpr' 'fde' string (default: "0")
3296 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003297 {not available when compiled without the |+folding|
Bram Moolenaardb84e452010-08-15 13:50:43 +02003298 or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003299 The expression used for when 'foldmethod' is "expr". It is evaluated
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003300 for each line to obtain its fold level. See |fold-expr|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003301
Bram Moolenaar30b65812012-07-12 22:01:11 +02003302 The expression will be evaluated in the |sandbox| if set from a
3303 modeline, see |sandbox-option|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003304 This option can't be set from a |modeline| when the 'diff' option is
Bram Moolenaar110289e2019-05-23 15:38:06 +02003305 on or the 'modelineexpr' option is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003306
3307 It is not allowed to change text or jump to another window while
3308 evaluating 'foldexpr' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003309
3310 *'foldignore'* *'fdi'*
3311'foldignore' 'fdi' string (default: "#")
3312 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003313 {not available when compiled without the |+folding|
3314 feature}
3315 Used only when 'foldmethod' is "indent". Lines starting with
3316 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003317 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003318 The default "#" works well for C programs. See |fold-indent|.
3319
3320 *'foldlevel'* *'fdl'*
3321'foldlevel' 'fdl' number (default: 0)
3322 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003323 {not available when compiled without the |+folding|
3324 feature}
3325 Sets the fold level: Folds with a higher level will be closed.
3326 Setting this option to zero will close all folds. Higher numbers will
3327 close fewer folds.
3328 This option is set by commands like |zm|, |zM| and |zR|.
3329 See |fold-foldlevel|.
3330
3331 *'foldlevelstart'* *'fdls'*
3332'foldlevelstart' 'fdls' number (default: -1)
3333 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003334 {not available when compiled without the |+folding|
3335 feature}
3336 Sets 'foldlevel' when starting to edit another buffer in a window.
3337 Useful to always start editing with all folds closed (value zero),
3338 some folds closed (one) or no folds closed (99).
3339 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003340 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00003341 ignores this option and closes all folds.
3342 It is also done before BufReadPre autocommands, to allow an autocmd to
3343 overrule the 'foldlevel' value for specific files.
3344 When the value is negative, it is not used.
3345
3346 *'foldmarker'* *'fmr'* *E536*
3347'foldmarker' 'fmr' string (default: "{{{,}}}")
3348 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003349 {not available when compiled without the |+folding|
3350 feature}
3351 The start and end marker used when 'foldmethod' is "marker". There
3352 must be one comma, which separates the start and end marker. The
3353 marker is a literal string (a regular expression would be too slow).
3354 See |fold-marker|.
3355
3356 *'foldmethod'* *'fdm'*
3357'foldmethod' 'fdm' string (default: "manual")
3358 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003359 {not available when compiled without the |+folding|
3360 feature}
3361 The kind of folding used for the current window. Possible values:
3362 |fold-manual| manual Folds are created manually.
3363 |fold-indent| indent Lines with equal indent form a fold.
3364 |fold-expr| expr 'foldexpr' gives the fold level of a line.
3365 |fold-marker| marker Markers are used to specify folds.
3366 |fold-syntax| syntax Syntax highlighting items specify folds.
3367 |fold-diff| diff Fold text that is not changed.
3368
3369 *'foldminlines'* *'fml'*
3370'foldminlines' 'fml' number (default: 1)
3371 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003372 {not available when compiled without the |+folding|
3373 feature}
Bram Moolenaar00654022011-02-25 14:42:19 +01003374 Sets the number of screen lines above which a fold can be displayed
3375 closed. Also for manually closed folds. With the default value of
3376 one a fold can only be closed if it takes up two or more screen lines.
3377 Set to zero to be able to close folds of just one screen line.
Bram Moolenaar446beb42011-05-10 17:18:44 +02003378 Note that this only has an effect on what is displayed. After using
Bram Moolenaar071d4272004-06-13 20:20:40 +00003379 "zc" to close a fold, which is displayed open because it's smaller
3380 than 'foldminlines', a following "zc" may close a containing fold.
3381
3382 *'foldnestmax'* *'fdn'*
3383'foldnestmax' 'fdn' number (default: 20)
3384 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003385 {not available when compiled without the |+folding|
3386 feature}
3387 Sets the maximum nesting of folds for the "indent" and "syntax"
3388 methods. This avoids that too many folds will be created. Using more
3389 than 20 doesn't work, because the internal limit is 20.
3390
3391 *'foldopen'* *'fdo'*
3392'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
3393 search,tag,undo")
3394 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003395 {not available when compiled without the |+folding|
3396 feature}
3397 Specifies for which type of commands folds will be opened, if the
3398 command moves the cursor into a closed fold. It is a comma separated
3399 list of items.
Bram Moolenaar05365702010-10-27 18:34:44 +02003400 NOTE: When the command is part of a mapping this option is not used.
3401 Add the |zv| command to the mapping to get the same effect.
3402 (rationale: the mapping may want to control opening folds itself)
3403
Bram Moolenaar071d4272004-06-13 20:20:40 +00003404 item commands ~
3405 all any
3406 block "(", "{", "[[", "[{", etc.
3407 hor horizontal movements: "l", "w", "fx", etc.
3408 insert any command in Insert mode
3409 jump far jumps: "G", "gg", etc.
3410 mark jumping to a mark: "'m", CTRL-O, etc.
3411 percent "%"
3412 quickfix ":cn", ":crew", ":make", etc.
3413 search search for a pattern: "/", "n", "*", "gd", etc.
3414 (not for a search pattern in a ":" command)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003415 Also for |[s| and |]s|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003416 tag jumping to a tag: ":ta", CTRL-T, etc.
3417 undo undo or redo: "u" and CTRL-R
Bram Moolenaar071d4272004-06-13 20:20:40 +00003418 When a movement command is used for an operator (e.g., "dl" or "y%")
3419 this option is not used. This means the operator will include the
3420 whole closed fold.
3421 Note that vertical movements are not here, because it would make it
3422 very difficult to move onto a closed fold.
3423 In insert mode the folds containing the cursor will always be open
3424 when text is inserted.
3425 To close folds you can re-apply 'foldlevel' with the |zx| command or
3426 set the 'foldclose' option to "all".
3427
3428 *'foldtext'* *'fdt'*
3429'foldtext' 'fdt' string (default: "foldtext()")
3430 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003431 {not available when compiled without the |+folding|
3432 feature}
3433 An expression which is used to specify the text displayed for a closed
3434 fold. See |fold-foldtext|.
3435
Bram Moolenaar30b65812012-07-12 22:01:11 +02003436 The expression will be evaluated in the |sandbox| if set from a
3437 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003438 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003439
3440 It is not allowed to change text or jump to another window while
3441 evaluating 'foldtext' |textlock|.
3442
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003443 *'formatexpr'* *'fex'*
3444'formatexpr' 'fex' string (default "")
3445 local to buffer
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003446 {not available when compiled without the |+eval|
3447 feature}
3448 Expression which is evaluated to format a range of lines for the |gq|
3449 operator or automatic formatting (see 'formatoptions'). When this
3450 option is empty 'formatprg' is used.
3451
3452 The |v:lnum| variable holds the first line to be formatted.
3453 The |v:count| variable holds the number of lines to be formatted.
3454 The |v:char| variable holds the character that is going to be
3455 inserted if the expression is being evaluated due to
3456 automatic formatting. This can be empty. Don't insert
3457 it yet!
3458
3459 Example: >
3460 :set formatexpr=mylang#Format()
3461< This will invoke the mylang#Format() function in the
3462 autoload/mylang.vim file in 'runtimepath'. |autoload|
3463
3464 The expression is also evaluated when 'textwidth' is set and adding
3465 text beyond that limit. This happens under the same conditions as
3466 when internal formatting is used. Make sure the cursor is kept in the
3467 same spot relative to the text then! The |mode()| function will
3468 return "i" or "R" in this situation.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01003469
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003470 When the expression evaluates to non-zero Vim will fall back to using
3471 the internal format mechanism.
3472
3473 The expression will be evaluated in the |sandbox| when set from a
3474 modeline, see |sandbox-option|. That stops the option from working,
3475 since changing the buffer text is not allowed.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003476 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaar036986f2017-03-16 17:41:02 +01003477 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003478
Bram Moolenaar86b68352004-12-27 21:59:20 +00003479 *'formatlistpat'* *'flp'*
3480'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
3481 local to buffer
Bram Moolenaar86b68352004-12-27 21:59:20 +00003482 A pattern that is used to recognize a list header. This is used for
3483 the "n" flag in 'formatoptions'.
3484 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00003485 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00003486 while still checking more characters. There must be a character
3487 following the pattern, when it matches the whole line it is handled
3488 like there is no match.
3489 The default recognizes a number, followed by an optional punctuation
3490 character and white space.
3491
Bram Moolenaar6c60f472019-04-28 16:00:35 +02003492 *'formatoptions'* *'fo'*
3493'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
3494 local to buffer
3495 This is a sequence of letters which describes how automatic
3496 formatting is to be done. See |fo-table|. When the 'paste' option is
3497 on, no formatting is done (like 'formatoptions' is empty). Commas can
3498 be inserted for readability.
3499 To avoid problems with flags that are added in the future, use the
3500 "+=" and "-=" feature of ":set" |add-option-flags|.
3501 NOTE: This option is set to the Vi default value when 'compatible' is
3502 set and to the Vim default value when 'compatible' is reset.
3503
Bram Moolenaar071d4272004-06-13 20:20:40 +00003504 *'formatprg'* *'fp'*
3505'formatprg' 'fp' string (default "")
Bram Moolenaar9be7c042017-01-14 14:28:30 +01003506 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003507 The name of an external program that will be used to format the lines
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003508 selected with the |gq| operator. The program must take the input on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003509 stdin and produce the output on stdout. The Unix program "fmt" is
Bram Moolenaara5792f52005-11-23 21:25:05 +00003510 such a program.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003511 If the 'formatexpr' option is not empty it will be used instead.
3512 Otherwise, if 'formatprg' option is an empty string, the internal
3513 format function will be used |C-indenting|.
Bram Moolenaara5792f52005-11-23 21:25:05 +00003514 Environment variables are expanded |:set_env|. See |option-backslash|
3515 about including spaces and backslashes.
Bram Moolenaar30b65812012-07-12 22:01:11 +02003516 This option cannot be set from a |modeline| or in the |sandbox|, for
3517 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003518
Bram Moolenaard94464e2015-11-02 15:28:18 +01003519 *'fsync'* *'fs'* *'nofsync'* *'nofs'*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003520'fsync' 'fs' boolean (default on)
3521 global
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003522 When on, the library function fsync() will be called after writing a
3523 file. This will flush a file to disk, ensuring that it is safely
3524 written even on filesystems which do metadata-only journaling. This
3525 will force the harddrive to spin up on Linux systems running in laptop
3526 mode, so it may be undesirable in some situations. Be warned that
3527 turning this off increases the chances of data loss after a crash. On
3528 systems without an fsync() implementation, this variable is always
3529 off.
3530 Also see 'swapsync' for controlling fsync() on swap files.
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003531 'fsync' also applies to |writefile()|, unless a flag is used to
3532 overrule it.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003533 This option cannot be set from a |modeline| or in the |sandbox|, for
3534 security reasons.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003535
Bram Moolenaar071d4272004-06-13 20:20:40 +00003536 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
3537'gdefault' 'gd' boolean (default off)
3538 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003539 When on, the ":substitute" flag 'g' is default on. This means that
3540 all matches in a line are substituted instead of one. When a 'g' flag
3541 is given to a ":substitute" command, this will toggle the substitution
3542 of all or one match. See |complex-change|.
3543
3544 command 'gdefault' on 'gdefault' off ~
3545 :s/// subst. all subst. one
3546 :s///g subst. one subst. all
3547 :s///gg subst. all subst. one
3548
3549 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar21020352017-06-13 17:21:04 +02003550 DEPRECATED: Setting this option may break plugins that are not aware
3551 of this option. Also, many users get confused that adding the /g flag
3552 has the opposite effect of that it normally does.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003553
3554 *'grepformat'* *'gfm'*
Bram Moolenaar6e932462014-09-09 18:48:09 +02003555'grepformat' 'gfm' string (default "%f:%l:%m,%f:%l%m,%f %l%m")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003556 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003557 Format to recognize for the ":grep" command output.
3558 This is a scanf-like string that uses the same format as the
3559 'errorformat' option: see |errorformat|.
3560
3561 *'grepprg'* *'gp'*
3562'grepprg' 'gp' string (default "grep -n ",
3563 Unix: "grep -n $* /dev/null",
3564 Win32: "findstr /n" or "grep -n",
3565 VMS: "SEARCH/NUMBERS ")
3566 global or local to buffer |global-local|
Bram Moolenaar582fd852005-03-28 20:58:01 +00003567 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003568 and '#' characters, which are expanded like when used in a command-
3569 line. The placeholder "$*" is allowed to specify where the arguments
3570 will be included. Environment variables are expanded |:set_env|. See
3571 |option-backslash| about including spaces and backslashes.
3572 When your "grep" accepts the "-H" argument, use this to make ":grep"
3573 also work well with a single file: >
3574 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00003575< Special value: When 'grepprg' is set to "internal" the |:grep| command
Bram Moolenaara6557602006-02-04 22:43:20 +00003576 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like
3577 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00003578 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00003579 apply equally to 'grepprg'.
3580 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
3581 otherwise it's "grep -n".
3582 This option cannot be set from a |modeline| or in the |sandbox|, for
3583 security reasons.
3584
3585 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
3586'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
3587 ve:ver35-Cursor,
3588 o:hor50-Cursor,
3589 i-ci:ver25-Cursor/lCursor,
3590 r-cr:hor20-Cursor/lCursor,
3591 sm:block-Cursor
3592 -blinkwait175-blinkoff150-blinkon175",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003593 for Win32 console:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003594 "n-v-c:block,o:hor50,i-ci:hor15,
3595 r-cr:hor30,sm:block")
3596 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003597 {only available when compiled with GUI enabled, and
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003598 for Win32 console}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003599 This option tells Vim what the cursor should look like in different
Bram Moolenaar8024f932020-01-14 19:29:13 +01003600 modes. It fully works in the GUI. In a Win32 console, only the
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003601 height of the cursor can be changed. This can be done by specifying a
3602 block cursor, or a percentage for a vertical or horizontal cursor.
Bram Moolenaar1e7813a2015-03-31 18:31:03 +02003603 For a console the 't_SI', 't_SR', and 't_EI' escape sequences are
3604 used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003605
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003606 The option is a comma separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003607 mode-list and an argument-list:
3608 mode-list:argument-list,mode-list:argument-list,..
3609 The mode-list is a dash separated list of these modes:
3610 n Normal mode
3611 v Visual mode
3612 ve Visual mode with 'selection' "exclusive" (same as 'v',
3613 if not specified)
3614 o Operator-pending mode
3615 i Insert mode
3616 r Replace mode
3617 c Command-line Normal (append) mode
3618 ci Command-line Insert mode
3619 cr Command-line Replace mode
3620 sm showmatch in Insert mode
3621 a all modes
3622 The argument-list is a dash separated list of these arguments:
3623 hor{N} horizontal bar, {N} percent of the character height
3624 ver{N} vertical bar, {N} percent of the character width
3625 block block cursor, fills the whole character
3626 [only one of the above three should be present]
3627 blinkwait{N} *cursor-blinking*
3628 blinkon{N}
3629 blinkoff{N}
3630 blink times for cursor: blinkwait is the delay before
3631 the cursor starts blinking, blinkon is the time that
3632 the cursor is shown and blinkoff is the time that the
3633 cursor is not shown. The times are in msec. When one
3634 of the numbers is zero, there is no blinking. The
3635 default is: "blinkwait700-blinkon400-blinkoff250".
3636 These numbers are used for a missing entry. This
3637 means that blinking is enabled by default. To switch
3638 blinking off you can use "blinkon0". The cursor only
3639 blinks when Vim is waiting for input, not while
3640 executing a command.
3641 To make the cursor blink in an xterm, see
3642 |xterm-blink|.
3643 {group-name}
3644 a highlight group name, that sets the color and font
3645 for the cursor
3646 {group-name}/{group-name}
3647 Two highlight group names, the first is used when
3648 no language mappings are used, the other when they
3649 are. |language-mapping|
3650
3651 Examples of parts:
3652 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
3653 block cursor with colors from the "nCursor"
3654 highlight group
3655 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
3656 In Insert and Command-line Insert mode, use a
3657 30% vertical bar cursor with colors from the
3658 "iCursor" highlight group. Blink a bit
3659 faster.
3660
3661 The 'a' mode is different. It will set the given argument-list for
3662 all modes. It does not reset anything to defaults. This can be used
3663 to do a common setting for all modes. For example, to switch off
3664 blinking: "a:blinkon0"
3665
3666 Examples of cursor highlighting: >
3667 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
3668 :highlight Cursor gui=NONE guifg=bg guibg=fg
3669<
3670 *'guifont'* *'gfn'*
Bram Moolenaar251e1912011-06-19 05:09:16 +02003671 *E235* *E596*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003672'guifont' 'gfn' string (default "")
3673 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003674 {only available when compiled with GUI enabled}
3675 This is a list of fonts which will be used for the GUI version of Vim.
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003676 In its simplest form the value is just one font name.
3677 See |gui-font| for the details.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003678
3679 *'guifontset'* *'gfs'*
3680 *E250* *E252* *E234* *E597* *E598*
3681'guifontset' 'gfs' string (default "")
3682 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003683 {only available when compiled with GUI enabled and
3684 with the |+xfontset| feature}
Bram Moolenaar3df01732017-02-17 22:47:16 +01003685 {not available in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003686 When not empty, specifies two (or more) fonts to be used. The first
3687 one for normal English, the second one for your special language. See
3688 |xfontset|.
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003689
Bram Moolenaar071d4272004-06-13 20:20:40 +00003690 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
3691'guifontwide' 'gfw' string (default "")
3692 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003693 {only available when compiled with GUI enabled}
3694 When not empty, specifies a comma-separated list of fonts to be used
3695 for double-width characters. The first font that can be loaded is
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003696 used. See |gui-fontwide|.
Bram Moolenaar0f272122013-01-23 18:37:40 +01003697
Bram Moolenaar071d4272004-06-13 20:20:40 +00003698 *'guiheadroom'* *'ghr'*
3699'guiheadroom' 'ghr' number (default 50)
3700 global
Bram Moolenaar110289e2019-05-23 15:38:06 +02003701 {only for GTK and X11 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003702 The number of pixels subtracted from the screen height when fitting
3703 the GUI window on the screen. Set this before the GUI is started,
3704 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003705 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00003706 lines will be left for window decorations and other items on the
3707 screen. Set it to a negative value to allow windows taller than the
3708 screen.
3709
3710 *'guioptions'* *'go'*
Bram Moolenaar2c64ca12018-10-19 16:22:31 +02003711'guioptions' 'go' string (default "egmrLtT" (MS-Windows,
3712 "t" is removed in |defaults.vim|),
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02003713 "aegimrLtT" (GTK, Motif and Athena),
3714 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00003715 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003716 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00003717 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003718 sequence of letters which describes what components and options of the
3719 GUI should be used.
3720 To avoid problems with flags that are added in the future, use the
3721 "+=" and "-=" feature of ":set" |add-option-flags|.
3722
Bram Moolenaar13568252018-03-16 20:46:58 +01003723 Valid characters are as follows:
3724 *'go-!'*
3725 '!' External commands are executed in a terminal window. Without
3726 this flag the MS-Windows GUI will open a console window to
3727 execute the command. The Unix GUI will simulate a dumb
3728 terminal to list the command output.
3729 The terminal window will be positioned at the bottom, and grow
3730 upwards as needed.
Bram Moolenaarba3ff532018-11-04 14:45:49 +01003731 *'go-a'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003732 'a' Autoselect: If present, then whenever VISUAL mode is started,
3733 or the Visual area extended, Vim tries to become the owner of
3734 the windowing system's global selection. This means that the
3735 Visually highlighted text is available for pasting into other
3736 applications as well as into Vim itself. When the Visual mode
3737 ends, possibly due to an operation on the text, or when an
3738 application wants to paste the selection, the highlighted text
3739 is automatically yanked into the "* selection register.
3740 Thus the selection is still available for pasting into other
3741 applications after the VISUAL mode has ended.
3742 If not present, then Vim won't become the owner of the
3743 windowing system's global selection unless explicitly told to
3744 by a yank or delete operation for the "* register.
3745 The same applies to the modeless selection.
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02003746 *'go-P'*
3747 'P' Like autoselect but using the "+ register instead of the "*
Bram Moolenaar3848e002016-03-19 18:42:29 +01003748 register.
Bram Moolenaar02467872007-05-06 13:22:01 +00003749 *'go-A'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003750 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003751 applies to the modeless selection.
3752
3753 'guioptions' autoselect Visual autoselect modeless ~
3754 "" - -
3755 "a" yes yes
3756 "A" - yes
3757 "aA" yes yes
3758
Bram Moolenaar02467872007-05-06 13:22:01 +00003759 *'go-c'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003760 'c' Use console dialogs instead of popup dialogs for simple
3761 choices.
Bram Moolenaar50bf7ce2019-09-15 13:17:00 +02003762 *'go-d'*
3763 'd' Use dark theme variant if available. Currently only works for
3764 GTK+ GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00003765 *'go-e'*
Bram Moolenaare224ffa2006-03-01 00:01:28 +00003766 'e' Add tab pages when indicated with 'showtabline'.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003767 'guitablabel' can be used to change the text in the labels.
3768 When 'e' is missing a non-GUI tab pages line may be used.
Bram Moolenaard68071d2006-05-02 22:08:30 +00003769 The GUI tabs are only supported on some systems, currently
Bram Moolenaar446cb832008-06-24 21:56:24 +00003770 GTK, Motif, Mac OS/X and MS-Windows.
Bram Moolenaar02467872007-05-06 13:22:01 +00003771 *'go-f'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003772 'f' Foreground: Don't use fork() to detach the GUI from the shell
3773 where it was started. Use this for programs that wait for the
3774 editor to finish (e.g., an e-mail program). Alternatively you
3775 can use "gvim -f" or ":gui -f" to start the GUI in the
3776 foreground. |gui-fork|
3777 Note: Set this option in the vimrc file. The forking may have
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003778 happened already when the |gvimrc| file is read.
Bram Moolenaar02467872007-05-06 13:22:01 +00003779 *'go-i'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003780 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
3781 corner of the window. It's black&white on non-GTK, because of
3782 limitations of X11. For a color icon, see |X11-icon|.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003783 *'go-m'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003784 'm' Menu bar is present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003785 *'go-M'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003786 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00003787 that this flag must be added in the .vimrc file, before
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003788 switching on syntax or filetype recognition (when the |gvimrc|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003789 file is sourced the system menu has already been loaded; the
Bram Moolenaar01164a62017-11-02 22:58:42 +01003790 `:syntax on` and `:filetype on` commands load the menu too).
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003791 *'go-g'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003792 'g' Grey menu items: Make menu items that are not active grey. If
3793 'g' is not included inactive menu items are not shown at all.
3794 Exception: Athena will always use grey menu items.
Bram Moolenaar02467872007-05-06 13:22:01 +00003795 *'go-t'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003796 't' Include tearoff menu items. Currently only works for Win32,
3797 GTK+, and Motif 1.2 GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00003798 *'go-T'*
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00003799 'T' Include Toolbar. Currently only in Win32, GTK+, Motif, Photon
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00003800 and Athena GUIs.
Bram Moolenaar02467872007-05-06 13:22:01 +00003801 *'go-r'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003802 'r' Right-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003803 *'go-R'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003804 'R' Right-hand scrollbar is present when there is a vertically
3805 split window.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003806 *'go-l'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003807 'l' Left-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003808 *'go-L'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003809 'L' Left-hand scrollbar is present when there is a vertically
3810 split window.
Bram Moolenaar02467872007-05-06 13:22:01 +00003811 *'go-b'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003812 'b' Bottom (horizontal) scrollbar is present. Its size depends on
3813 the longest visible line, or on the cursor line if the 'h'
3814 flag is included. |gui-horiz-scroll|
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003815 *'go-h'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003816 'h' Limit horizontal scrollbar size to the length of the cursor
3817 line. Reduces computations. |gui-horiz-scroll|
3818
3819 And yes, you may even have scrollbars on the left AND the right if
3820 you really want to :-). See |gui-scrollbars| for more information.
3821
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003822 *'go-v'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003823 'v' Use a vertical button layout for dialogs. When not included,
3824 a horizontal layout is preferred, but when it doesn't fit a
3825 vertical layout is used anyway.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003826 *'go-p'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003827 'p' Use Pointer callbacks for X11 GUI. This is required for some
3828 window managers. If the cursor is not blinking or hollow at
3829 the right moment, try adding this flag. This must be done
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003830 before starting the GUI. Set it in your |gvimrc|. Adding or
Bram Moolenaar071d4272004-06-13 20:20:40 +00003831 removing it after the GUI has started has no effect.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003832 *'go-F'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003833 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar8ac44152017-11-09 18:33:29 +01003834 *'go-k'*
3835 'k' Keep the GUI window size when adding/removing a scrollbar, or
3836 toolbar, tabline, etc. Instead, the behavior is similar to
3837 when the window is maximized and will adjust 'lines' and
3838 'columns' to fit to the window. Without the 'k' flag Vim will
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003839 try to keep 'lines' and 'columns' the same when adding and
Bram Moolenaar8ac44152017-11-09 18:33:29 +01003840 removing GUI components.
Bram Moolenaar02467872007-05-06 13:22:01 +00003841
Bram Moolenaar071d4272004-06-13 20:20:40 +00003842 *'guipty'* *'noguipty'*
3843'guipty' boolean (default on)
3844 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003845 {only available when compiled with GUI enabled}
3846 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
3847 I/O to/from shell commands. See |gui-pty|.
3848
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003849 *'guitablabel'* *'gtl'*
3850'guitablabel' 'gtl' string (default empty)
3851 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02003852 {only available when compiled with GUI enabled}
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003853 When nonempty describes the text to use in a label of the GUI tab
Bram Moolenaard68071d2006-05-02 22:08:30 +00003854 pages line. When empty and when the result is empty Vim will use a
3855 default label. See |setting-guitablabel| for more info.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003856
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003857 The format of this option is like that of 'statusline'.
Bram Moolenaar57657d82006-04-21 22:12:41 +00003858 'guitabtooltip' is used for the tooltip, see below.
Bram Moolenaar51628222016-12-01 23:03:28 +01003859 The expression will be evaluated in the |sandbox| when set from a
3860 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003861 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003862
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003863 Only used when the GUI tab pages line is displayed. 'e' must be
3864 present in 'guioptions'. For the non-GUI tab pages line 'tabline' is
3865 used.
3866
Bram Moolenaar57657d82006-04-21 22:12:41 +00003867 *'guitabtooltip'* *'gtt'*
3868'guitabtooltip' 'gtt' string (default empty)
3869 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02003870 {only available when compiled with GUI enabled}
Bram Moolenaar57657d82006-04-21 22:12:41 +00003871 When nonempty describes the text to use in a tooltip for the GUI tab
3872 pages line. When empty Vim will use a default tooltip.
3873 This option is otherwise just like 'guitablabel' above.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003874 You can include a line break. Simplest method is to use |:let|: >
3875 :let &guitabtooltip = "line one\nline two"
3876<
Bram Moolenaar57657d82006-04-21 22:12:41 +00003877
Bram Moolenaar071d4272004-06-13 20:20:40 +00003878 *'helpfile'* *'hf'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003879'helpfile' 'hf' string (default (MS-Windows) "$VIMRUNTIME\doc\help.txt"
Bram Moolenaar071d4272004-06-13 20:20:40 +00003880 (others) "$VIMRUNTIME/doc/help.txt")
3881 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003882 Name of the main help file. All distributed help files should be
3883 placed together in one directory. Additionally, all "doc" directories
3884 in 'runtimepath' will be used.
3885 Environment variables are expanded |:set_env|. For example:
3886 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003887 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00003888 spaces and backslashes.
3889 This option cannot be set from a |modeline| or in the |sandbox|, for
3890 security reasons.
3891
3892 *'helpheight'* *'hh'*
3893'helpheight' 'hh' number (default 20)
3894 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003895 Minimal initial height of the help window when it is opened with the
3896 ":help" command. The initial height of the help window is half of the
3897 current window, or (when the 'ea' option is on) the same as other
3898 windows. When the height is less than 'helpheight', the height is
3899 set to 'helpheight'. Set to zero to disable.
3900
3901 *'helplang'* *'hlg'*
3902'helplang' 'hlg' string (default: messages language or empty)
3903 global
3904 {only available when compiled with the |+multi_lang|
3905 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003906 Comma separated list of languages. Vim will use the first language
3907 for which the desired help can be found. The English help will always
3908 be used as a last resort. You can add "en" to prefer English over
3909 another language, but that will only find tags that exist in that
3910 language and not in the English help.
3911 Example: >
3912 :set helplang=de,it
3913< This will first search German, then Italian and finally English help
3914 files.
3915 When using |CTRL-]| and ":help!" in a non-English help file Vim will
3916 try to find the tag in the current language before using this option.
3917 See |help-translated|.
3918
3919 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
3920'hidden' 'hid' boolean (default off)
3921 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003922 When off a buffer is unloaded when it is |abandon|ed. When on a
3923 buffer becomes hidden when it is |abandon|ed. If the buffer is still
3924 displayed in another window, it does not become hidden, of course.
3925 The commands that move through the buffer list sometimes make a buffer
3926 hidden although the 'hidden' option is off: When the buffer is
3927 modified, 'autowrite' is off or writing is not possible, and the '!'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003928 flag was used. See also |windows.txt|.
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00003929 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003930 This option is set for one command with ":hide {command}" |:hide|.
3931 WARNING: It's easy to forget that you have changes in hidden buffers.
3932 Think twice when using ":q!" or ":qa!".
3933
3934 *'highlight'* *'hl'*
3935'highlight' 'hl' string (default (as a single string):
Bram Moolenaar58b85342016-08-14 19:54:54 +02003936 "8:SpecialKey,~:EndOfBuffer,@:NonText,
3937 d:Directory,e:ErrorMsg,i:IncSearch,
3938 l:Search,m:MoreMsg,M:ModeMsg,n:LineNr,
Bram Moolenaarefae76a2019-10-27 22:54:58 +01003939 a:LineNrAbove,b:LineNrBelow,
Bram Moolenaar58b85342016-08-14 19:54:54 +02003940 N:CursorLineNr,r:Question,s:StatusLine,
3941 S:StatusLineNC,c:VertSplit,t:Title,
Bram Moolenaar9d87a372018-12-18 21:41:50 +01003942 v:Visual,V:VisualNOS,w:WarningMsg,
3943 W:WildMenu,f:Folded,F:FoldColumn,
3944 A:DiffAdd,C:DiffChange,D:DiffDelete,
3945 T:DiffText,>:SignColumn,-:Conceal,
Bram Moolenaarc8c88492018-12-27 23:59:26 +01003946 B:SpellBad,P:SpellCap,R:SpellRare,
Bram Moolenaar9d87a372018-12-18 21:41:50 +01003947 L:SpellLocal,+:Pmenu,=:PmenuSel,
Bram Moolenaar21020352017-06-13 17:21:04 +02003948 x:PmenuSbar,X:PmenuThumb,*:TabLine,
3949 #:TabLineSel,_:TabLineFill,!:CursorColumn,
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02003950 .:CursorLine,o:ColorColumn,q:QuickFixLine,
Bram Moolenaarc572da52017-08-27 16:52:01 +02003951 z:StatusLineTerm,Z:StatusLineTermNC")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003952 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003953 This option can be used to set highlighting mode for various
3954 occasions. It is a comma separated list of character pairs. The
3955 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003956 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003957 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
Bram Moolenaar58b85342016-08-14 19:54:54 +02003958 |hl-EndOfBuffer| ~ lines after the last line in the buffer
3959 |hl-NonText| @ '@' at the end of the window and
Bram Moolenaar071d4272004-06-13 20:20:40 +00003960 characters from 'showbreak'
3961 |hl-Directory| d directories in CTRL-D listing and other special
3962 things in listings
3963 |hl-ErrorMsg| e error messages
3964 h (obsolete, ignored)
3965 |hl-IncSearch| i 'incsearch' highlighting
3966 |hl-Search| l last search pattern highlighting (see 'hlsearch')
3967 |hl-MoreMsg| m |more-prompt|
3968 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
Bram Moolenaar64486672010-05-16 15:46:46 +02003969 |hl-LineNr| n line number for ":number" and ":#" commands, and
3970 when 'number' or 'relativenumber' option is set.
Bram Moolenaarefae76a2019-10-27 22:54:58 +01003971 |hl-LineNrAbove| a line number above the cursor for when the
3972 'relativenumber' option is set.
3973 |hl-LineNrBelow| b line number below the cursor for when the
3974 'relativenumber' option is set.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01003975 |hl-CursorLineNr| N like n for when 'cursorline' or 'relativenumber' is
3976 set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003977 |hl-Question| r |hit-enter| prompt and yes/no questions
3978 |hl-StatusLine| s status line of current window |status-line|
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01003979 |hl-StatusLineNC| S status lines of not-current windows
Bram Moolenaar071d4272004-06-13 20:20:40 +00003980 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
3981 |hl-VertSplit| c column used to separate vertically split windows
3982 |hl-Visual| v Visual mode
3983 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
3984 Selection" Only X11 Gui's |gui-x11| and
3985 |xterm-clipboard|.
3986 |hl-WarningMsg| w warning messages
3987 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
3988 |hl-Folded| f line used for closed folds
3989 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003990 |hl-DiffAdd| A added line in diff mode
3991 |hl-DiffChange| C changed line in diff mode
3992 |hl-DiffDelete| D deleted line in diff mode
3993 |hl-DiffText| T inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00003994 |hl-SignColumn| > column used for |signs|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01003995 |hl-Conceal| - the placeholders used for concealed characters
3996 (see 'conceallevel')
Bram Moolenaar217ad922005-03-20 22:37:15 +00003997 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02003998 |hl-SpellCap| P word that should start with capital |spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00003999 |hl-SpellRare| R rare word |spell|
4000 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004001 |hl-Pmenu| + popup menu normal line
4002 |hl-PmenuSel| = popup menu selected line
4003 |hl-PmenuSbar| x popup menu scrollbar
4004 |hl-PmenuThumb| X popup menu scrollbar thumb
Bram Moolenaar071d4272004-06-13 20:20:40 +00004005
4006 The display modes are:
4007 r reverse (termcap entry "mr" and "me")
4008 i italic (termcap entry "ZH" and "ZR")
4009 b bold (termcap entry "md" and "me")
4010 s standout (termcap entry "so" and "se")
4011 u underline (termcap entry "us" and "ue")
Bram Moolenaare2cc9702005-03-15 22:43:58 +00004012 c undercurl (termcap entry "Cs" and "Ce")
Bram Moolenaarcf4b00c2017-09-02 18:33:56 +02004013 t strikethrough (termcap entry "Ts" and "Te")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004014 n no highlighting
4015 - no highlighting
4016 : use a highlight group
4017 The default is used for occasions that are not included.
4018 If you want to change what the display modes do, see |dos-colors|
4019 for an example.
4020 When using the ':' display mode, this must be followed by the name of
4021 a highlight group. A highlight group can be used to define any type
4022 of highlighting, including using color. See |:highlight| on how to
4023 define one. The default uses a different group for each occasion.
4024 See |highlight-default| for the default highlight groups.
4025
Bram Moolenaar071d4272004-06-13 20:20:40 +00004026 *'history'* *'hi'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004027'history' 'hi' number (Vim default: 50, Vi default: 0,
4028 set to 200 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004029 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004030 A history of ":" commands, and a history of previous search patterns
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004031 is remembered. This option decides how many entries may be stored in
Bram Moolenaar071d4272004-06-13 20:20:40 +00004032 each of these histories (see |cmdline-editing|).
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004033 The maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004034 NOTE: This option is set to the Vi default value when 'compatible' is
4035 set and to the Vim default value when 'compatible' is reset.
4036
4037 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
4038'hkmap' 'hk' boolean (default off)
4039 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004040 {only available when compiled with the |+rightleft|
4041 feature}
4042 When on, the keyboard is mapped for the Hebrew character set.
4043 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
4044 toggle this option. See |rileft.txt|.
4045 NOTE: This option is reset when 'compatible' is set.
4046
4047 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
4048'hkmapp' 'hkp' boolean (default off)
4049 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004050 {only available when compiled with the |+rightleft|
4051 feature}
4052 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
4053 This is useful if you have a non-Hebrew keyboard.
4054 See |rileft.txt|.
4055 NOTE: This option is reset when 'compatible' is set.
4056
Bram Moolenaar036986f2017-03-16 17:41:02 +01004057 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
4058'hlsearch' 'hls' boolean (default off)
4059 global
Bram Moolenaar036986f2017-03-16 17:41:02 +01004060 {not available when compiled without the
4061 |+extra_search| feature}
4062 When there is a previous search pattern, highlight all its matches.
4063 The type of highlighting used can be set with the 'l' occasion in the
4064 'highlight' option. This uses the "Search" highlight group by
4065 default. Note that only the matching text is highlighted, any offsets
4066 are not applied.
4067 See also: 'incsearch' and |:match|.
4068 When you get bored looking at the highlighted matches, you can turn it
4069 off with |:nohlsearch|. This does not change the option value, as
4070 soon as you use a search command, the highlighting comes back.
4071 'redrawtime' specifies the maximum time spent on finding matches.
4072 When the search pattern can match an end-of-line, Vim will try to
4073 highlight all of the matched text. However, this depends on where the
4074 search starts. This will be the first line in the window or the first
4075 line below a closed fold. A match in a previous line which is not
4076 drawn may not continue in a newly drawn line.
4077 You can specify whether the highlight status is restored on startup
4078 with the 'h' flag in 'viminfo' |viminfo-h|.
4079 NOTE: This option is reset when 'compatible' is set.
4080
Bram Moolenaar071d4272004-06-13 20:20:40 +00004081 *'icon'* *'noicon'*
4082'icon' boolean (default off, on when title can be restored)
4083 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004084 {not available when compiled without the |+title|
4085 feature}
4086 When on, the icon text of the window will be set to the value of
4087 'iconstring' (if it is not empty), or to the name of the file
4088 currently being edited. Only the last part of the name is used.
4089 Overridden by the 'iconstring' option.
4090 Only works if the terminal supports setting window icons (currently
4091 only X11 GUI and terminals with a non-empty 't_IS' option - these are
4092 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
4093 builtin termcap).
4094 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00004095 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00004096 X11.
Bram Moolenaar3a991dd2014-10-02 01:41:41 +02004097 For MS-Windows the icon can be changed, see |windows-icon|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004098
4099 *'iconstring'*
4100'iconstring' string (default "")
4101 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004102 {not available when compiled without the |+title|
4103 feature}
4104 When this option is not empty, it will be used for the icon text of
4105 the window. This happens only when the 'icon' option is on.
4106 Only works if the terminal supports setting window icon text
4107 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
4108 Does not work for MS Windows.
4109 When Vim was compiled with HAVE_X11 defined, the original icon will be
4110 restored if possible |X11|.
4111 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004112 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004113 'titlestring' for example settings.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004114 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004115 {not available when compiled without the |+statusline| feature}
4116
4117 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
4118'ignorecase' 'ic' boolean (default off)
4119 global
4120 Ignore case in search patterns. Also used when searching in the tags
4121 file.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01004122 Also see 'smartcase' and 'tagcase'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004123 Can be overruled by using "\c" or "\C" in the pattern, see
4124 |/ignorecase|.
4125
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004126 *'imactivatefunc'* *'imaf'*
4127'imactivatefunc' 'imaf' string (default "")
4128 global
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004129 This option specifies a function that will be called to
Bram Moolenaar2877d332017-11-26 14:56:16 +01004130 activate or deactivate the Input Method.
4131 It is not used in the GUI.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004132 The expression will be evaluated in the |sandbox| when set from a
4133 modeline, see |sandbox-option|.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004134
4135 Example: >
4136 function ImActivateFunc(active)
4137 if a:active
4138 ... do something
4139 else
4140 ... do something
4141 endif
4142 " return value is not used
4143 endfunction
4144 set imactivatefunc=ImActivateFunc
4145<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004146 *'imactivatekey'* *'imak'*
4147'imactivatekey' 'imak' string (default "")
4148 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004149 {only available when compiled with |+xim| and
Bram Moolenaar67c53842010-05-22 18:28:27 +02004150 |+GUI_GTK|} *E599*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004151 Specifies the key that your Input Method in X-Windows uses for
4152 activation. When this is specified correctly, vim can fully control
4153 IM with 'imcmdline', 'iminsert' and 'imsearch'.
4154 You can't use this option to change the activation key, the option
4155 tells Vim what the key is.
4156 Format:
4157 [MODIFIER_FLAG-]KEY_STRING
4158
4159 These characters can be used for MODIFIER_FLAG (case is ignored):
4160 S Shift key
4161 L Lock key
4162 C Control key
4163 1 Mod1 key
4164 2 Mod2 key
4165 3 Mod3 key
4166 4 Mod4 key
4167 5 Mod5 key
4168 Combinations are allowed, for example "S-C-space" or "SC-space" are
4169 both shift+ctrl+space.
4170 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
4171
4172 Example: >
4173 :set imactivatekey=S-space
4174< "S-space" means shift+space. This is the activation key for kinput2 +
4175 canna (Japanese), and ami (Korean).
4176
4177 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
4178'imcmdline' 'imc' boolean (default off)
4179 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004180 When set the Input Method is always on when starting to edit a command
4181 line, unless entering a search pattern (see 'imsearch' for that).
4182 Setting this option is useful when your input method allows entering
4183 English characters directly, e.g., when it's used to type accented
4184 characters with dead keys.
4185
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004186 *'imdisable'* *'imd'* *'noimdisable'* *'noimd'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004187'imdisable' 'imd' boolean (default off, on for some systems (SGI))
4188 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004189 When set the Input Method is never used. This is useful to disable
4190 the IM when it doesn't work properly.
4191 Currently this option is on by default for SGI/IRIX machines. This
4192 may change in later releases.
4193
4194 *'iminsert'* *'imi'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004195'iminsert' 'imi' number (default 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004196 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004197 Specifies whether :lmap or an Input Method (IM) is to be used in
4198 Insert mode. Valid values:
4199 0 :lmap is off and IM is off
4200 1 :lmap is ON and IM is off
4201 2 :lmap is off and IM is ON
Bram Moolenaar071d4272004-06-13 20:20:40 +00004202 To always reset the option to zero when leaving Insert mode with <Esc>
4203 this can be used: >
4204 :inoremap <ESC> <ESC>:set iminsert=0<CR>
4205< This makes :lmap and IM turn off automatically when leaving Insert
4206 mode.
4207 Note that this option changes when using CTRL-^ in Insert mode
4208 |i_CTRL-^|.
4209 The value is set to 1 when setting 'keymap' to a valid keymap name.
4210 It is also used for the argument of commands like "r" and "f".
4211 The value 0 may not work correctly with Athena and Motif with some XIM
4212 methods. Use 'imdisable' to disable XIM then.
4213
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004214 You can set 'imactivatefunc' and 'imstatusfunc' to handle IME/XIM
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004215 via external command if Vim is not compiled with the |+xim|,
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004216 |+multi_byte_ime| or |global-ime|.
4217
Bram Moolenaar071d4272004-06-13 20:20:40 +00004218 *'imsearch'* *'ims'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004219'imsearch' 'ims' number (default -1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004220 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004221 Specifies whether :lmap or an Input Method (IM) is to be used when
4222 entering a search pattern. Valid values:
4223 -1 the value of 'iminsert' is used, makes it look like
4224 'iminsert' is also used when typing a search pattern
4225 0 :lmap is off and IM is off
4226 1 :lmap is ON and IM is off
4227 2 :lmap is off and IM is ON
4228 Note that this option changes when using CTRL-^ in Command-line mode
4229 |c_CTRL-^|.
4230 The value is set to 1 when it is not -1 and setting the 'keymap'
4231 option to a valid keymap name.
4232 The value 0 may not work correctly with Athena and Motif with some XIM
4233 methods. Use 'imdisable' to disable XIM then.
4234
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004235 *'imstatusfunc'* *'imsf'*
4236'imstatusfunc' 'imsf' string (default "")
4237 global
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004238 This option specifies a function that is called to obtain the status
4239 of Input Method. It must return a positive number when IME is active.
Bram Moolenaar2877d332017-11-26 14:56:16 +01004240 It is not used in the GUI.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004241
4242 Example: >
4243 function ImStatusFunc()
4244 let is_active = ...do something
4245 return is_active ? 1 : 0
4246 endfunction
4247 set imstatusfunc=ImStatusFunc
4248<
4249 NOTE: This function is invoked very often. Keep it fast.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004250 The expression will be evaluated in the |sandbox| when set from a
4251 modeline, see |sandbox-option|.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004252
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004253 *'imstyle'* *'imst'*
4254'imstyle' 'imst' number (default 1)
4255 global
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004256 {only available when compiled with |+xim| and
4257 |+GUI_GTK|}
Bram Moolenaar37c64c72017-09-19 22:06:03 +02004258 This option specifies the input style of Input Method:
4259 0 use on-the-spot style
4260 1 over-the-spot style
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004261 See: |xim-input-style|
4262
Bram Moolenaar24a98a02017-09-27 22:23:55 +02004263 For a long time on-the-spot style had been used in the GTK version of
4264 vim, however, it is known that it causes troubles when using mappings,
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004265 |single-repeat|, etc. Therefore over-the-spot style becomes the
4266 default now. This should work fine for most people, however if you
4267 have any problem with it, try using on-the-spot style.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004268 The expression will be evaluated in the |sandbox| when set from a
4269 modeline, see |sandbox-option|.
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004270
Bram Moolenaar071d4272004-06-13 20:20:40 +00004271 *'include'* *'inc'*
4272'include' 'inc' string (default "^\s*#\s*include")
4273 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004274 {not available when compiled without the
4275 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004276 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00004277 pattern, just like for the "/" command (See |pattern|). The default
4278 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar1e015462005-09-25 22:16:38 +00004279 "]I", "[d", etc.
4280 Normally the 'isfname' option is used to recognize the file name that
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004281 comes after the matched pattern. But if "\zs" appears in the pattern
4282 then the text matched from "\zs" to the end, or until "\ze" if it
4283 appears, is used as the file name. Use this to include characters
4284 that are not in 'isfname', such as a space. You can then use
4285 'includeexpr' to process the matched text.
Bram Moolenaar1e015462005-09-25 22:16:38 +00004286 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004287
4288 *'includeexpr'* *'inex'*
4289'includeexpr' 'inex' string (default "")
4290 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004291 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004292 |+find_in_path| or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004293 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004294 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004295 :set includeexpr=substitute(v:fname,'\\.','/','g')
4296< The "v:fname" variable will be set to the file name that was detected.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004297
Bram Moolenaar071d4272004-06-13 20:20:40 +00004298 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004299 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004300 Also used for |<cfile>|.
4301
Bram Moolenaar30b65812012-07-12 22:01:11 +02004302 The expression will be evaluated in the |sandbox| when set from a
4303 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004304 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004305
4306 It is not allowed to change text or jump to another window while
4307 evaluating 'includeexpr' |textlock|.
4308
Bram Moolenaar071d4272004-06-13 20:20:40 +00004309 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004310'incsearch' 'is' boolean (default off, set in |defaults.vim| if the
4311 +reltime feature is supported)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004312 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004313 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004314 |+extra_search| features}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004315 While typing a search command, show where the pattern, as it was typed
4316 so far, matches. The matched string is highlighted. If the pattern
4317 is invalid or not found, nothing is shown. The screen will be updated
4318 often, this is only useful on fast terminals.
Bram Moolenaarfc65cab2018-08-28 22:58:02 +02004319 Also applies to the pattern in commands: >
4320 :global
4321 :lvimgrep
4322 :lvimgrepadd
4323 :smagic
4324 :snomagic
4325 :sort
4326 :substitute
4327 :vglobal
4328 :vimgrep
4329 :vimgrepadd
4330< Note that the match will be shown, but the cursor will return to its
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004331 original position when no match is found and when pressing <Esc>. You
4332 still need to finish the search command with <Enter> to move the
4333 cursor to the match.
Bram Moolenaardc083282016-10-11 08:57:33 +02004334 You can use the CTRL-G and CTRL-T keys to move to the next and
4335 previous match. |c_CTRL-G| |c_CTRL-T|
Bram Moolenaar91a4e822008-01-19 14:59:58 +00004336 When compiled with the |+reltime| feature Vim only searches for about
4337 half a second. With a complicated pattern and/or a lot of text the
4338 match may not be found. This is to avoid that Vim hangs while you
4339 are typing the pattern.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004340 The highlighting can be set with the 'i' flag in 'highlight'.
Bram Moolenaar2f058492017-11-30 20:27:52 +01004341 When 'hlsearch' is on, all matched strings are highlighted too while
4342 typing a search command. See also: 'hlsearch'.
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004343 If you don't want to turn 'hlsearch' on, but want to highlight all
4344 matches while searching, you can turn on and off 'hlsearch' with
4345 autocmd. Example: >
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004346 augroup vimrc-incsearch-highlight
4347 autocmd!
Bram Moolenaarf8f8b2e2017-11-02 19:08:48 +01004348 autocmd CmdlineEnter /,\? :set hlsearch
4349 autocmd CmdlineLeave /,\? :set nohlsearch
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004350 augroup END
4351<
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004352 CTRL-L can be used to add one character from after the current match
Bram Moolenaara9dc3752010-07-11 20:46:53 +02004353 to the command line. If 'ignorecase' and 'smartcase' are set and the
4354 command line has no uppercase characters, the added character is
4355 converted to lowercase.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004356 CTRL-R CTRL-W can be used to add the word at the end of the current
4357 match, excluding the characters that were already typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004358 NOTE: This option is reset when 'compatible' is set.
4359
4360 *'indentexpr'* *'inde'*
4361'indentexpr' 'inde' string (default "")
4362 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004363 {not available when compiled without the |+cindent|
4364 or |+eval| features}
4365 Expression which is evaluated to obtain the proper indent for a line.
4366 It is used when a new line is created, for the |=| operator and
4367 in Insert mode as specified with the 'indentkeys' option.
4368 When this option is not empty, it overrules the 'cindent' and
Bram Moolenaar20f90cf2011-05-19 12:22:51 +02004369 'smartindent' indenting. When 'lisp' is set, this option is
4370 overridden by the Lisp indentation algorithm.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004371 When 'paste' is set this option is not used for indenting.
4372 The expression is evaluated with |v:lnum| set to the line number for
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004373 which the indent is to be computed. The cursor is also in this line
Bram Moolenaar071d4272004-06-13 20:20:40 +00004374 when the expression is evaluated (but it may be moved around).
4375 The expression must return the number of spaces worth of indent. It
4376 can return "-1" to keep the current indent (this means 'autoindent' is
4377 used for the indent).
4378 Functions useful for computing the indent are |indent()|, |cindent()|
4379 and |lispindent()|.
4380 The evaluation of the expression must not have side effects! It must
4381 not change the text, jump to another window, etc. Afterwards the
4382 cursor position is always restored, thus the cursor may be moved.
4383 Normally this option would be set to call a function: >
4384 :set indentexpr=GetMyIndent()
4385< Error messages will be suppressed, unless the 'debug' option contains
4386 "msg".
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004387 See |indent-expression|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01004388 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004389
Bram Moolenaar30b65812012-07-12 22:01:11 +02004390 The expression will be evaluated in the |sandbox| when set from a
4391 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004392 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004393
4394 It is not allowed to change text or jump to another window while
4395 evaluating 'indentexpr' |textlock|.
4396
4397
Bram Moolenaar071d4272004-06-13 20:20:40 +00004398 *'indentkeys'* *'indk'*
Bram Moolenaarce655742019-01-31 14:12:57 +01004399'indentkeys' 'indk' string (default "0{,0},0),0],:,0#,!^F,o,O,e")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004400 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004401 {not available when compiled without the |+cindent|
4402 feature}
4403 A list of keys that, when typed in Insert mode, cause reindenting of
4404 the current line. Only happens if 'indentexpr' isn't empty.
4405 The format is identical to 'cinkeys', see |indentkeys-format|.
4406 See |C-indenting| and |indent-expression|.
4407
4408 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
4409'infercase' 'inf' boolean (default off)
4410 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004411 When doing keyword completion in insert mode |ins-completion|, and
Bram Moolenaar446cb832008-06-24 21:56:24 +00004412 'ignorecase' is also on, the case of the match is adjusted depending
4413 on the typed text. If the typed text contains a lowercase letter
4414 where the match has an upper case letter, the completed part is made
4415 lowercase. If the typed text has no lowercase letters and the match
4416 has a lowercase letter where the typed text has an uppercase letter,
4417 and there is a letter before it, the completed part is made uppercase.
4418 With 'noinfercase' the match is used as-is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004419
4420 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
4421'insertmode' 'im' boolean (default off)
4422 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004423 Makes Vim work in a way that Insert mode is the default mode. Useful
4424 if you want to use Vim as a modeless editor. Used for |evim|.
4425 These Insert mode commands will be useful:
4426 - Use the cursor keys to move around.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02004427 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|. When
Bram Moolenaar071d4272004-06-13 20:20:40 +00004428 this is a mapping, it is executed as if 'insertmode' was off.
4429 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004430 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00004431 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
4432 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004433
4434 These items change when 'insertmode' is set:
4435 - when starting to edit of a file, Vim goes to Insert mode.
4436 - <Esc> in Insert mode is a no-op and beeps.
4437 - <Esc> in Normal mode makes Vim go to Insert mode.
4438 - CTRL-L in Insert mode is a command, it is not inserted.
4439 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
4440 However, when <Esc> is used inside a mapping, it behaves like
4441 'insertmode' was not set. This was done to be able to use the same
4442 mappings with 'insertmode' set or not set.
4443 When executing commands with |:normal| 'insertmode' is not used.
4444
4445 NOTE: This option is reset when 'compatible' is set.
4446
4447 *'isfname'* *'isf'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004448'isfname' 'isf' string (default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004449 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
4450 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
4451 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
4452 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
4453 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
4454 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004455 The characters specified by this option are included in file names and
4456 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004457 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004458 Multi-byte characters 256 and above are always included, only the
4459 characters up to 255 are specified with this option.
4460 For UTF-8 the characters 0xa0 to 0xff are included as well.
Bram Moolenaar446cb832008-06-24 21:56:24 +00004461 Think twice before adding white space to this option. Although a
4462 space may appear inside a file name, the effect will be that Vim
4463 doesn't know where a file name starts or ends when doing completion.
4464 It most likely works better without a space in 'isfname'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004465
4466 Note that on systems using a backslash as path separator, Vim tries to
4467 do its best to make it work as you would expect. That is a bit
4468 tricky, since Vi originally used the backslash to escape special
4469 characters. Vim will not remove a backslash in front of a normal file
4470 name character on these systems, but it will on Unix and alikes. The
4471 '&' and '^' are not included by default, because these are special for
4472 cmd.exe.
4473
4474 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004475 Each part can be a single character number or a range. A range is two
4476 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004477 decimal number between 0 and 255 or the ASCII character itself (does
4478 not work for digits). Example:
4479 "_,-,128-140,#-43" (include '_' and '-' and the range
4480 128 to 140 and '#' to 43)
4481 If a part starts with '^', the following character number or range
4482 will be excluded from the option. The option is interpreted from left
4483 to right. Put the excluded character after the range where it is
4484 included. To include '^' itself use it as the last character of the
4485 option or the end of a range. Example:
4486 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
4487 If the character is '@', all characters where isalpha() returns TRUE
4488 are included. Normally these are the characters a to z and A to Z,
4489 plus accented characters. To include '@' itself use "@-@". Examples:
4490 "@,^a-z" All alphabetic characters, excluding lower
Bram Moolenaar446cb832008-06-24 21:56:24 +00004491 case ASCII letters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004492 "a-z,A-Z,@-@" All letters plus the '@' character.
4493 A comma can be included by using it where a character number is
4494 expected. Example:
4495 "48-57,,,_" Digits, comma and underscore.
4496 A comma can be excluded by prepending a '^'. Example:
4497 " -~,^,,9" All characters from space to '~', excluding
4498 comma, plus <Tab>.
4499 See |option-backslash| about including spaces and backslashes.
4500
4501 *'isident'* *'isi'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004502'isident' 'isi' string (default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004503 "@,48-57,_,128-167,224-235"
4504 otherwise: "@,48-57,_,192-255")
4505 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004506 The characters given by this option are included in identifiers.
4507 Identifiers are used in recognizing environment variables and after a
4508 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00004509 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004510 option. For '@' only characters up to 255 are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004511 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004512 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00004513 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
4514
4515 *'iskeyword'* *'isk'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004516'iskeyword' 'isk' string (Vim default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004517 "@,48-57,_,128-167,224-235"
4518 otherwise: "@,48-57,_,192-255"
4519 Vi default: "@,48-57,_")
4520 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004521 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004522 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004523 'isfname' for a description of the format of this option. For '@'
4524 characters above 255 check the "word" character class.
4525 For C programs you could use "a-z,A-Z,48-57,_,.,-,>".
Bram Moolenaar071d4272004-06-13 20:20:40 +00004526 For a help file it is set to all non-blank printable characters except
4527 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
4528 command).
4529 When the 'lisp' option is on the '-' character is always included.
Bram Moolenaarb8060fe2016-01-19 22:29:28 +01004530 This option also influences syntax highlighting, unless the syntax
4531 uses |:syn-iskeyword|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004532 NOTE: This option is set to the Vi default value when 'compatible' is
4533 set and to the Vim default value when 'compatible' is reset.
4534
4535 *'isprint'* *'isp'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004536'isprint' 'isp' string (default for Win32 and Macintosh:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004537 "@,~-255"; otherwise: "@,161-255")
4538 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004539 The characters given by this option are displayed directly on the
4540 screen. It is also used for "\p" in a |pattern|. The characters from
4541 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
4542 even when they are not included in 'isprint' or excluded. See
4543 'isfname' for a description of the format of this option.
4544
4545 Non-printable characters are displayed with two characters:
4546 0 - 31 "^@" - "^_"
4547 32 - 126 always single characters
4548 127 "^?"
4549 128 - 159 "~@" - "~_"
4550 160 - 254 "| " - "|~"
4551 255 "~?"
4552 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
4553 displayed as <xx>, with the hexadecimal value of the byte.
4554 When 'display' contains "uhex" all unprintable characters are
4555 displayed as <xx>.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004556 The SpecialKey highlighting will be used for unprintable characters.
4557 |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004558
4559 Multi-byte characters 256 and above are always included, only the
4560 characters up to 255 are specified with this option. When a character
4561 is printable but it is not available in the current font, a
4562 replacement character will be shown.
4563 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
4564 There is no option to specify these characters.
4565
4566 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
4567'joinspaces' 'js' boolean (default on)
4568 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004569 Insert two spaces after a '.', '?' and '!' with a join command.
4570 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
4571 Otherwise only one space is inserted.
4572 NOTE: This option is set when 'compatible' is set.
4573
4574 *'key'*
4575'key' string (default "")
4576 local to buffer
Bram Moolenaar996343d2010-07-04 22:20:21 +02004577 {only available when compiled with the |+cryptv|
4578 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004579 The key that is used for encrypting and decrypting the current buffer.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02004580 See |encryption| and 'cryptmethod'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004581 Careful: Do not set the key value by hand, someone might see the typed
4582 key. Use the |:X| command. But you can make 'key' empty: >
4583 :set key=
4584< It is not possible to get the value of this option with ":set key" or
4585 "echo &key". This is to avoid showing it to someone who shouldn't
4586 know. It also means you cannot see it yourself once you have set it,
4587 be careful not to make a typing error!
Bram Moolenaard58e9292011-02-09 17:07:58 +01004588 You can use "&key" in an expression to detect whether encryption is
4589 enabled. When 'key' is set it returns "*****" (five stars).
Bram Moolenaar071d4272004-06-13 20:20:40 +00004590
4591 *'keymap'* *'kmp'* *E544*
4592'keymap' 'kmp' string (default "")
4593 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004594 {only available when compiled with the |+keymap|
4595 feature}
4596 Name of a keyboard mapping. See |mbyte-keymap|.
4597 Setting this option to a valid keymap name has the side effect of
4598 setting 'iminsert' to one, so that the keymap becomes effective.
4599 'imsearch' is also set to one, unless it was -1
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004600 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004601
4602 *'keymodel'* *'km'*
4603'keymodel' 'km' string (default "")
4604 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004605 List of comma separated words, which enable special things that keys
4606 can do. These values can be used:
4607 startsel Using a shifted special key starts selection (either
4608 Select mode or Visual mode, depending on "key" being
4609 present in 'selectmode').
4610 stopsel Using a not-shifted special key stops selection.
4611 Special keys in this context are the cursor keys, <End>, <Home>,
4612 <PageUp> and <PageDown>.
4613 The 'keymodel' option is set by the |:behave| command.
4614
4615 *'keywordprg'* *'kp'*
4616'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02004617 VMS: "help")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004618 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004619 Program to use for the |K| command. Environment variables are
4620 expanded |:set_env|. ":help" may be used to access the Vim internal
4621 help. (Note that previously setting the global option to the empty
4622 value did this, which is now deprecated.)
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02004623 When the first character is ":", the command is invoked as a Vim
4624 Ex command prefixed with [count].
4625 When "man", "man -s" or an Ex command is used, Vim will automatically
4626 translate a count for the "K" command and pass it as the first
4627 argument. For "man -s" the "-s" is removed when there is no count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004628 See |option-backslash| about including spaces and backslashes.
4629 Example: >
4630 :set keywordprg=man\ -s
4631< This option cannot be set from a |modeline| or in the |sandbox|, for
4632 security reasons.
4633
4634 *'langmap'* *'lmap'* *E357* *E358*
4635'langmap' 'lmap' string (default "")
4636 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004637 {only available when compiled with the |+langmap|
4638 feature}
4639 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004640 mode. When you are typing text in Insert mode the characters are
Bram Moolenaarfa735342016-01-03 22:14:44 +01004641 inserted directly. When in Normal mode the 'langmap' option takes
Bram Moolenaar071d4272004-06-13 20:20:40 +00004642 care of translating these special characters to the original meaning
4643 of the key. This means you don't have to change the keyboard mode to
4644 be able to execute Normal mode commands.
4645 This is the opposite of the 'keymap' option, where characters are
4646 mapped in Insert mode.
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004647 Also consider resetting 'langremap' to avoid 'langmap' applies to
Bram Moolenaarc2299672014-11-13 14:25:38 +01004648 characters resulting from a mapping.
Bram Moolenaare968e362014-05-13 20:23:24 +02004649 This option cannot be set from a |modeline| or in the |sandbox|, for
4650 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004651
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00004652 Example (for Greek, in UTF-8): *greek* >
4653 :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 +00004654< Example (exchanges meaning of z and y for commands): >
4655 :set langmap=zy,yz,ZY,YZ
4656<
4657 The 'langmap' option is a list of parts, separated with commas. Each
4658 part can be in one of two forms:
4659 1. A list of pairs. Each pair is a "from" character immediately
4660 followed by the "to" character. Examples: "aA", "aAbBcC".
4661 2. A list of "from" characters, a semi-colon and a list of "to"
4662 characters. Example: "abc;ABC"
4663 Example: "aA,fgh;FGH,cCdDeE"
4664 Special characters need to be preceded with a backslash. These are
4665 ";", ',' and backslash itself.
4666
4667 This will allow you to activate vim actions without having to switch
4668 back and forth between the languages. Your language characters will
4669 be understood as normal vim English characters (according to the
4670 langmap mappings) in the following cases:
4671 o Normal/Visual mode (commands, buffer/register names, user mappings)
4672 o Insert/Replace Mode: Register names after CTRL-R
4673 o Insert/Replace Mode: Mappings
4674 Characters entered in Command-line mode will NOT be affected by
4675 this option. Note that this option can be changed at any time
4676 allowing to switch between mappings for different languages/encodings.
4677 Use a mapping to avoid having to type it each time!
4678
4679 *'langmenu'* *'lm'*
4680'langmenu' 'lm' string (default "")
4681 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004682 {only available when compiled with the |+menu| and
4683 |+multi_lang| features}
4684 Language to use for menu translation. Tells which file is loaded
4685 from the "lang" directory in 'runtimepath': >
4686 "lang/menu_" . &langmenu . ".vim"
4687< (without the spaces). For example, to always use the Dutch menus, no
4688 matter what $LANG is set to: >
4689 :set langmenu=nl_NL.ISO_8859-1
4690< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004691 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004692 If your $LANG is set to a non-English language but you do want to use
4693 the English menus: >
4694 :set langmenu=none
4695< This option must be set before loading menus, switching on filetype
4696 detection or syntax highlighting. Once the menus are defined setting
4697 this option has no effect. But you could do this: >
4698 :source $VIMRUNTIME/delmenu.vim
4699 :set langmenu=de_DE.ISO_8859-1
4700 :source $VIMRUNTIME/menu.vim
4701< Warning: This deletes all menus that you defined yourself!
4702
Bram Moolenaard94464e2015-11-02 15:28:18 +01004703 *'langnoremap'* *'lnr'* *'nolangnoremap'* *'nolnr'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004704'langnoremap' 'lnr' boolean (default off, set in |defaults.vim|)
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004705 global
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004706 {only available when compiled with the |+langmap|
4707 feature}
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004708 This is just like 'langremap' but with the value inverted. It only
4709 exists for backwards compatibility. When setting 'langremap' then
4710 'langnoremap' is set to the inverted value, and the other way around.
4711
4712 *'langremap'* *'lrm'* *'nolangremap'* *'nolrm'*
4713'langremap' 'lrm' boolean (default on, reset in |defaults.vim|)
4714 global
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004715 {only available when compiled with the |+langmap|
4716 feature}
4717 When off, setting 'langmap' does not apply to characters resulting from
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004718 a mapping. This basically means, if you noticed that setting
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004719 'langmap' disables some of your mappings, try resetting this option.
4720 This option defaults to on for backwards compatibility. Set it off if
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004721 that works for you to avoid mappings to break.
4722
Bram Moolenaar071d4272004-06-13 20:20:40 +00004723 *'laststatus'* *'ls'*
4724'laststatus' 'ls' number (default 1)
4725 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004726 The value of this option influences when the last window will have a
4727 status line:
4728 0: never
4729 1: only if there are at least two windows
4730 2: always
4731 The screen looks nicer with a status line if you have several
4732 windows, but it takes another screen line. |status-line|
4733
4734 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
4735'lazyredraw' 'lz' boolean (default off)
4736 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004737 When this option is set, the screen will not be redrawn while
4738 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004739 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00004740 update use |:redraw|.
4741
4742 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
4743'linebreak' 'lbr' boolean (default off)
4744 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02004745 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004746 feature}
Bram Moolenaar946e27a2014-06-25 18:50:27 +02004747 If on, Vim will wrap long lines at a character in 'breakat' rather
Bram Moolenaar071d4272004-06-13 20:20:40 +00004748 than at the last character that fits on the screen. Unlike
4749 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
Bram Moolenaar946e27a2014-06-25 18:50:27 +02004750 it only affects the way the file is displayed, not its contents.
4751 If 'breakindent' is set, line is visually indented. Then, the value
4752 of 'showbreak' is used to put in front of wrapped lines. This option
Bram Moolenaar86b17e92014-07-02 20:00:47 +02004753 is not used when the 'wrap' option is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004754 Note that <Tab> characters after an <EOL> are mostly not displayed
4755 with the right amount of white space.
4756
4757 *'lines'* *E593*
4758'lines' number (default 24 or terminal height)
4759 global
4760 Number of lines of the Vim window.
4761 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00004762 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004763 When Vim is running in the GUI or in a resizable window, setting this
4764 option will cause the window size to be changed. When you only want
4765 to use the size for the GUI, put the command in your |gvimrc| file.
4766 Vim limits the number of lines to what fits on the screen. You can
4767 use this command to get the tallest window possible: >
4768 :set lines=999
Bram Moolenaarf4d11452005-12-02 00:46:37 +00004769< Minimum value is 2, maximum value is 1000.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02004770 If you get fewer lines than expected, check the 'guiheadroom' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004771 When you set this option and Vim is unable to change the physical
4772 number of lines of the display, the display may be messed up.
4773
4774 *'linespace'* *'lsp'*
4775'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
4776 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004777 {only in the GUI}
4778 Number of pixel lines inserted between characters. Useful if the font
4779 uses the full character cell height, making lines touch each other.
4780 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004781 With some fonts there can be too much room between lines (to have
4782 space for ascents and descents). Then it makes sense to set
4783 'linespace' to a negative value. This may cause display problems
4784 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00004785
4786 *'lisp'* *'nolisp'*
4787'lisp' boolean (default off)
4788 local to buffer
4789 {not available when compiled without the |+lispindent|
4790 feature}
4791 Lisp mode: When <Enter> is typed in insert mode set the indent for
4792 the next line to Lisp standards (well, sort of). Also happens with
4793 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
4794 flag in 'cpoptions' changes the method of indenting: Vi compatible or
4795 better. Also see 'lispwords'.
4796 The '-' character is included in keyword characters. Redefines the
4797 "=" operator to use this same indentation algorithm rather than
4798 calling an external program if 'equalprg' is empty.
4799 This option is not used when 'paste' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004800
4801 *'lispwords'* *'lw'*
4802'lispwords' 'lw' string (default is very long)
Bram Moolenaaraf6c1312014-03-12 18:55:58 +01004803 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004804 {not available when compiled without the |+lispindent|
4805 feature}
4806 Comma separated list of words that influence the Lisp indenting.
4807 |'lisp'|
4808
4809 *'list'* *'nolist'*
4810'list' boolean (default off)
4811 local to window
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004812 List mode: Show tabs as CTRL-I is displayed, display $ after end of
4813 line. Useful to see the difference between tabs and spaces and for
4814 trailing blanks. Further changed by the 'listchars' option.
4815
4816 The cursor is displayed at the start of the space a Tab character
4817 occupies, not at the end as usual in Normal mode. To get this cursor
4818 position while displaying Tabs with spaces, use: >
Bram Moolenaardd007ed2013-07-09 15:44:17 +02004819 :set list lcs=tab:\ \
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004820<
4821 Note that list mode will also affect formatting (set with 'textwidth'
4822 or 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
Bram Moolenaar071d4272004-06-13 20:20:40 +00004823 changing the way tabs are displayed.
4824
4825 *'listchars'* *'lcs'*
4826'listchars' 'lcs' string (default "eol:$")
4827 global
Bram Moolenaarf9d5ca12010-08-01 16:13:51 +02004828 Strings to use in 'list' mode and for the |:list| command. It is a
4829 comma separated list of string settings.
Bram Moolenaar79278362015-04-21 18:33:48 +02004830 *lcs-eol*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004831 eol:c Character to show at the end of each line. When
4832 omitted, there is no extra character at the end of the
4833 line.
Bram Moolenaar79278362015-04-21 18:33:48 +02004834 *lcs-tab*
Bram Moolenaar83a52172019-01-16 22:41:54 +01004835 tab:xy[z] Two or three characters to be used to show a tab.
4836 The third character is optional.
4837
4838 tab:xy The 'x' is always used, then 'y' as many times as will
4839 fit. Thus "tab:>-" displays:
4840 >
4841 >-
4842 >--
4843 etc.
4844
4845 tab:xyz The 'z' is always used, then 'x' is prepended, and
4846 then 'y' is used as many times as will fit. Thus
4847 "tab:<->" displays:
4848 >
4849 <>
4850 <->
4851 <-->
4852 etc.
4853
4854 When "tab:" is omitted, a tab is shown as ^I.
Bram Moolenaar79278362015-04-21 18:33:48 +02004855 *lcs-space*
4856 space:c Character to show for a space. When omitted, spaces
4857 are left blank.
4858 *lcs-trail*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004859 trail:c Character to show for trailing spaces. When omitted,
Bram Moolenaar79278362015-04-21 18:33:48 +02004860 trailing spaces are blank. Overrides the "space"
4861 setting for trailing spaces.
4862 *lcs-extends*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004863 extends:c Character to show in the last column, when 'wrap' is
4864 off and the line continues beyond the right of the
4865 screen.
Bram Moolenaar79278362015-04-21 18:33:48 +02004866 *lcs-precedes*
Bram Moolenaarbffba7f2019-09-20 17:00:17 +02004867 precedes:c Character to show in the first visible column of the
4868 physical line, when there is text preceding the
4869 character visible in the first column.
Bram Moolenaar79278362015-04-21 18:33:48 +02004870 *lcs-conceal*
Bram Moolenaar860cae12010-06-05 23:22:07 +02004871 conceal:c Character to show in place of concealed text, when
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004872 'conceallevel' is set to 1.
Bram Moolenaar79278362015-04-21 18:33:48 +02004873 *lcs-nbsp*
Bram Moolenaar73284b92015-05-04 17:28:22 +02004874 nbsp:c Character to show for a non-breakable space character
4875 (0xA0 (160 decimal) and U+202F). Left blank when
4876 omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004877
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004878 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00004879 be used when 'encoding' is "utf-8", otherwise only printable
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004880 characters are allowed. All characters must be single width.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004881
4882 Examples: >
4883 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004884 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00004885 :set lcs=extends:>,precedes:<
4886< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaar79278362015-04-21 18:33:48 +02004887 "precedes". "SpecialKey" for "nbsp", "space", "tab" and "trail".
Bram Moolenaar02467872007-05-06 13:22:01 +00004888 |hl-NonText| |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004889
4890 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
4891'loadplugins' 'lpl' boolean (default on)
4892 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004893 When on the plugin scripts are loaded when starting up |load-plugins|.
4894 This option can be reset in your |vimrc| file to disable the loading
4895 of plugins.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02004896 Note that using the "-u NONE", "-u DEFAULTS" and "--noplugin" command
4897 line arguments reset this option. See |-u| and |--noplugin|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004898
Bram Moolenaard94464e2015-11-02 15:28:18 +01004899 *'luadll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01004900'luadll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01004901 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01004902 {only available when compiled with the |+lua/dyn|
4903 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01004904 Specifies the name of the Lua shared library. The default is
4905 DYNAMIC_LUA_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02004906 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01004907 This option cannot be set from a |modeline| or in the |sandbox|, for
4908 security reasons.
4909
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00004910 *'macatsui'* *'nomacatsui'*
4911'macatsui' boolean (default on)
4912 global
4913 {only available in Mac GUI version}
4914 This is a workaround for when drawing doesn't work properly. When set
4915 and compiled with multi-byte support ATSUI text drawing is used. When
4916 not set ATSUI text drawing is not used. Switch this option off when
4917 you experience drawing problems. In a future version the problems may
4918 be solved and this option becomes obsolete. Therefore use this method
4919 to unset it: >
4920 if exists('&macatsui')
4921 set nomacatsui
4922 endif
Bram Moolenaar02467872007-05-06 13:22:01 +00004923< Another option to check if you have drawing problems is
4924 'termencoding'.
4925
Bram Moolenaar071d4272004-06-13 20:20:40 +00004926 *'magic'* *'nomagic'*
4927'magic' boolean (default on)
4928 global
4929 Changes the special characters that can be used in search patterns.
4930 See |pattern|.
Bram Moolenaar64d8e252016-09-06 22:12:34 +02004931 WARNING: Switching this option off most likely breaks plugins! That
4932 is because many patterns assume it's on and will fail when it's off.
4933 Only switch it off when working with old Vi scripts. In any other
4934 situation write patterns that work when 'magic' is on. Include "\M"
4935 when you want to |/\M|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004936
4937 *'makeef'* *'mef'*
4938'makeef' 'mef' string (default: "")
4939 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004940 {not available when compiled without the |+quickfix|
4941 feature}
4942 Name of the errorfile for the |:make| command (see |:make_makeprg|)
4943 and the |:grep| command.
4944 When it is empty, an internally generated temp file will be used.
4945 When "##" is included, it is replaced by a number to make the name
4946 unique. This makes sure that the ":make" command doesn't overwrite an
4947 existing file.
4948 NOT used for the ":cf" command. See 'errorfile' for that.
4949 Environment variables are expanded |:set_env|.
4950 See |option-backslash| about including spaces and backslashes.
4951 This option cannot be set from a |modeline| or in the |sandbox|, for
4952 security reasons.
4953
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01004954 *'makeencoding'* *'menc'*
4955'makeencoding' 'menc' string (default "")
4956 global or local to buffer |global-local|
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01004957 Encoding used for reading the output of external commands. When empty,
4958 encoding is not converted.
4959 This is used for `:make`, `:lmake`, `:grep`, `:lgrep`, `:grepadd`,
4960 `:lgrepadd`, `:cfile`, `:cgetfile`, `:caddfile`, `:lfile`, `:lgetfile`,
4961 and `:laddfile`.
4962
4963 This would be mostly useful when you use MS-Windows and set 'encoding'
4964 to "utf-8". If |+iconv| is enabled and GNU libiconv is used, setting
4965 'makeencoding' to "char" has the same effect as setting to the system
4966 locale encoding. Example: >
4967 :set encoding=utf-8
4968 :set makeencoding=char " system locale is used
4969<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004970 *'makeprg'* *'mp'*
4971'makeprg' 'mp' string (default "make", VMS: "MMS")
4972 global or local to buffer |global-local|
Bram Moolenaar02467872007-05-06 13:22:01 +00004973 Program to use for the ":make" command. See |:make_makeprg|.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01004974 This option may contain '%' and '#' characters (see |:_%| and |:_#|),
4975 which are expanded to the current and alternate file name. Use |::S|
Bram Moolenaar26df0922014-02-23 23:39:13 +01004976 to escape file names in case they contain special characters.
Bram Moolenaar02467872007-05-06 13:22:01 +00004977 Environment variables are expanded |:set_env|. See |option-backslash|
4978 about including spaces and backslashes.
4979 Note that a '|' must be escaped twice: once for ":set" and once for
4980 the interpretation of a command. When you use a filter called
4981 "myfilter" do it like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004982 :set makeprg=gmake\ \\\|\ myfilter
4983< The placeholder "$*" can be given (even multiple times) to specify
4984 where the arguments will be included, for example: >
4985 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
4986< This option cannot be set from a |modeline| or in the |sandbox|, for
4987 security reasons.
4988
4989 *'matchpairs'* *'mps'*
4990'matchpairs' 'mps' string (default "(:),{:},[:]")
4991 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004992 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01004993 other.
4994 Only character pairs are allowed that are different, thus you cannot
4995 jump between two double quotes.
4996 The characters must be separated by a colon.
Bram Moolenaar02467872007-05-06 13:22:01 +00004997 The pairs must be separated by a comma. Example for including '<' and
4998 '>' (HTML): >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004999 :set mps+=<:>
5000
5001< A more exotic example, to jump between the '=' and ';' in an
5002 assignment, useful for languages like C and Java: >
5003 :au FileType c,cpp,java set mps+==:;
5004
5005< For a more advanced way of using "%", see the matchit.vim plugin in
Bram Moolenaar01164a62017-11-02 22:58:42 +01005006 the $VIMRUNTIME/pack/dist/opt/matchit directory. |add-local-help|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005007
5008 *'matchtime'* *'mat'*
5009'matchtime' 'mat' number (default 5)
5010 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005011 Tenths of a second to show the matching paren, when 'showmatch' is
5012 set. Note that this is not in milliseconds, like other options that
5013 set a time. This is to be compatible with Nvi.
5014
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005015 *'maxcombine'* *'mco'*
5016'maxcombine' 'mco' number (default 2)
5017 global
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005018 The maximum number of combining characters supported for displaying.
5019 Only used when 'encoding' is "utf-8".
5020 The default is OK for most languages. Hebrew may require 4.
5021 Maximum value is 6.
5022 Even when this option is set to 2 you can still edit text with more
5023 combining characters, you just can't see them. Use |g8| or |ga|.
5024 See |mbyte-combining|.
5025
Bram Moolenaar071d4272004-06-13 20:20:40 +00005026 *'maxfuncdepth'* *'mfd'*
5027'maxfuncdepth' 'mfd' number (default 100)
5028 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02005029 {not available when compiled without the |+eval|
Bram Moolenaar02467872007-05-06 13:22:01 +00005030 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005031 Maximum depth of function calls for user functions. This normally
5032 catches endless recursion. When using a recursive function with
5033 more depth, set 'maxfuncdepth' to a bigger number. But this will use
5034 more memory, there is the danger of failing when memory is exhausted.
Bram Moolenaarbc2eada2017-01-02 21:27:47 +01005035 Increasing this limit above 200 also changes the maximum for Ex
Bram Moolenaar0b0f0992018-05-22 21:41:30 +02005036 command recursion, see |E169|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005037 See also |:function|.
5038
5039 *'maxmapdepth'* *'mmd'* *E223*
5040'maxmapdepth' 'mmd' number (default 1000)
5041 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005042 Maximum number of times a mapping is done without resulting in a
5043 character to be used. This normally catches endless mappings, like
5044 ":map x y" with ":map y x". It still does not catch ":map g wg",
5045 because the 'w' is used before the next mapping is done. See also
5046 |key-mapping|.
5047
5048 *'maxmem'* *'mm'*
5049'maxmem' 'mm' number (default between 256 to 5120 (system
5050 dependent) or half the amount of memory
5051 available)
5052 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005053 Maximum amount of memory (in Kbyte) to use for one buffer. When this
5054 limit is reached allocating extra memory for a buffer will cause
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005055 other memory to be freed.
5056 The maximum usable value is about 2000000. Use this to work without a
5057 limit.
5058 The value is ignored when 'swapfile' is off.
5059 Also see 'maxmemtot'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005060
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005061 *'maxmempattern'* *'mmp'*
5062'maxmempattern' 'mmp' number (default 1000)
5063 global
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005064 Maximum amount of memory (in Kbyte) to use for pattern matching.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005065 The maximum value is about 2000000. Use this to work without a limit.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005066 *E363*
Bram Moolenaar02467872007-05-06 13:22:01 +00005067 When Vim runs into the limit it gives an error message and mostly
5068 behaves like CTRL-C was typed.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005069 Running into the limit often means that the pattern is very
5070 inefficient or too complex. This may already happen with the pattern
5071 "\(.\)*" on a very long line. ".*" works much better.
Bram Moolenaarfd358112018-07-07 23:21:31 +02005072 Might also happen on redraw, when syntax rules try to match a complex
5073 text structure.
5074 Vim may run out of memory before hitting the 'maxmempattern' limit, in
5075 which case you get an "Out of memory" error instead.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005076
Bram Moolenaar071d4272004-06-13 20:20:40 +00005077 *'maxmemtot'* *'mmt'*
5078'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
5079 dependent) or half the amount of memory
5080 available)
5081 global
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005082 Maximum amount of memory in Kbyte to use for all buffers together.
5083 The maximum usable value is about 2000000 (2 Gbyte). Use this to work
Bram Moolenaarfa735342016-01-03 22:14:44 +01005084 without a limit.
5085 On 64 bit machines higher values might work. But hey, do you really
5086 need more than 2 Gbyte for text editing? Keep in mind that text is
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005087 stored in the swap file, one can edit files > 2 Gbyte anyway. We do
Bram Moolenaarfa735342016-01-03 22:14:44 +01005088 need the memory to store undo info.
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005089 Buffers with 'swapfile' off still count to the total amount of memory
5090 used.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005091 Also see 'maxmem'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005092
5093 *'menuitems'* *'mis'*
5094'menuitems' 'mis' number (default 25)
5095 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005096 {not available when compiled without the |+menu|
5097 feature}
5098 Maximum number of items to use in a menu. Used for menus that are
5099 generated from a list of items, e.g., the Buffers menu. Changing this
5100 option has no direct effect, the menu must be refreshed first.
5101
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005102 *'mkspellmem'* *'msm'*
5103'mkspellmem' 'msm' string (default "460000,2000,500")
5104 global
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005105 {not available when compiled without the |+syntax|
5106 feature}
5107 Parameters for |:mkspell|. This tunes when to start compressing the
5108 word tree. Compression can be slow when there are many words, but
5109 it's needed to avoid running out of memory. The amount of memory used
5110 per word depends very much on how similar the words are, that's why
5111 this tuning is complicated.
5112
5113 There are three numbers, separated by commas:
5114 {start},{inc},{added}
5115
5116 For most languages the uncompressed word tree fits in memory. {start}
5117 gives the amount of memory in Kbyte that can be used before any
5118 compression is done. It should be a bit smaller than the amount of
5119 memory that is available to Vim.
5120
5121 When going over the {start} limit the {inc} number specifies the
5122 amount of memory in Kbyte that can be allocated before another
5123 compression is done. A low number means compression is done after
5124 less words are added, which is slow. A high number means more memory
5125 will be allocated.
5126
5127 After doing compression, {added} times 1024 words can be added before
5128 the {inc} limit is ignored and compression is done when any extra
5129 amount of memory is needed. A low number means there is a smaller
5130 chance of hitting the {inc} limit, less memory is used but it's
5131 slower.
5132
5133 The languages for which these numbers are important are Italian and
5134 Hungarian. The default works for when you have about 512 Mbyte. If
5135 you have 1 Gbyte you could use: >
5136 :set mkspellmem=900000,3000,800
5137< If you have less than 512 Mbyte |:mkspell| may fail for some
5138 languages, no matter what you set 'mkspellmem' to.
5139
Bram Moolenaar07607392019-05-26 19:20:43 +02005140 This option cannot be set from a |modeline| or in the |sandbox|.
5141
Bram Moolenaar071d4272004-06-13 20:20:40 +00005142 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
Bram Moolenaar8243a792007-05-01 17:05:03 +00005143'modeline' 'ml' boolean (Vim default: on (off for root),
5144 Vi default: off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005145 local to buffer
Bram Moolenaar110289e2019-05-23 15:38:06 +02005146 If 'modeline' is on 'modelines' gives the number of lines that is
5147 checked for set commands. If 'modeline' is off or 'modelines' is zero
5148 no lines are checked. See |modeline|.
5149
5150 *'modelineexpr'* *'mle'* *'nomodelineexpr'* *'nomle'*
5151'modelineexpr' 'mle' boolean (default: off)
5152 global
5153 When on allow some options that are an expression to be set in the
5154 modeline. Check the option for whether it is affected by
5155 'modelineexpr'. Also see |modeline|.
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02005156 This option cannot be set from a |modeline| or in the |sandbox|, for
5157 security reasons.
Bram Moolenaar110289e2019-05-23 15:38:06 +02005158
Bram Moolenaar071d4272004-06-13 20:20:40 +00005159 *'modelines'* *'mls'*
5160'modelines' 'mls' number (default 5)
5161 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005162 If 'modeline' is on 'modelines' gives the number of lines that is
5163 checked for set commands. If 'modeline' is off or 'modelines' is zero
5164 no lines are checked. See |modeline|.
5165 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
5166 set and to the Vim default value when 'compatible' is reset.
5167
5168 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
Bram Moolenaar110289e2019-05-23 15:38:06 +02005169 *E21*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005170'modifiable' 'ma' boolean (default on)
5171 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005172 When off the buffer contents cannot be changed. The 'fileformat' and
5173 'fileencoding' options also can't be changed.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01005174 Can be reset on startup with the |-M| command line argument.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005175
5176 *'modified'* *'mod'* *'nomodified'* *'nomod'*
5177'modified' 'mod' boolean (default off)
5178 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005179 When on, the buffer is considered to be modified. This option is set
5180 when:
5181 1. A change was made to the text since it was last written. Using the
5182 |undo| command to go back to the original text will reset the
5183 option. But undoing changes that were made before writing the
5184 buffer will set the option again, since the text is different from
5185 when it was written.
5186 2. 'fileformat' or 'fileencoding' is different from its original
5187 value. The original value is set when the buffer is read or
5188 written. A ":set nomodified" command also resets the original
5189 values to the current values and the 'modified' option will be
5190 reset.
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01005191 Similarly for 'eol' and 'bomb'.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02005192 This option is not set when a change is made to the buffer as the
5193 result of a BufNewFile, BufRead/BufReadPost, BufWritePost,
5194 FileAppendPost or VimLeave autocommand event. See |gzip-example| for
5195 an explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005196 When 'buftype' is "nowrite" or "nofile" this option may be set, but
5197 will be ignored.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01005198 Note that the text may actually be the same, e.g. 'modified' is set
5199 when using "rA" on an "A".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005200
5201 *'more'* *'nomore'*
5202'more' boolean (Vim default: on, Vi default: off)
5203 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005204 When on, listings pause when the whole screen is filled. You will get
5205 the |more-prompt|. When this option is off there are no pauses, the
5206 listing continues until finished.
5207 NOTE: This option is set to the Vi default value when 'compatible' is
5208 set and to the Vim default value when 'compatible' is reset.
5209
5210 *'mouse'* *E538*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005211'mouse' string (default "", "a" for GUI and Win32,
Bram Moolenaar5b418992019-10-27 18:50:25 +01005212 set to "a" or "nvi" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005213 global
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005214 Enable the use of the mouse. Works for most terminals (xterm, Win32
5215 |win32-mouse|, QNX pterm, *BSD console with sysmouse and Linux console
5216 with gpm). For using the mouse in the GUI, see |gui-mouse|. The
5217 mouse can be enabled for different modes:
Bram Moolenaar7f2e9d72017-11-11 20:58:53 +01005218 n Normal mode and Terminal modes
Bram Moolenaar071d4272004-06-13 20:20:40 +00005219 v Visual mode
5220 i Insert mode
5221 c Command-line mode
5222 h all previous modes when editing a help file
5223 a all previous modes
5224 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005225 Normally you would enable the mouse in all five modes with: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005226 :set mouse=a
Bram Moolenaar5b418992019-10-27 18:50:25 +01005227< If your terminal can't overrule the mouse events going to the
5228 application, use: >
5229 :set mouse=nvi
5230< The you can press ":", select text for the system, and press Esc to go
5231 back to Vim using the mouse events.
5232 In |defaults.vim| "nvi" is used if the 'term' option is not matching
5233 "xterm".
5234
5235 When the mouse is not enabled, the GUI will still use the mouse for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005236 modeless selection. This doesn't move the text cursor.
5237
5238 See |mouse-using|. Also see |'clipboard'|.
5239
5240 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005241 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005242 the mouse buttons can still be used by keeping the shift key pressed.
5243 Also see the 'clipboard' option.
5244
5245 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
5246'mousefocus' 'mousef' boolean (default off)
5247 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005248 {only works in the GUI}
5249 The window that the mouse pointer is on is automatically activated.
5250 When changing the window layout or window focus in another way, the
5251 mouse pointer is moved to the window with keyboard focus. Off is the
5252 default because it makes using the pull down menus a little goofy, as
5253 a pointer transit may activate a window unintentionally.
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01005254 MS-Windows: Also see 'scrollfocus' for what window is scrolled when
5255 using the mouse scroll whel.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005256
5257 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
5258'mousehide' 'mh' boolean (default on)
5259 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005260 {only works in the GUI}
5261 When on, the mouse pointer is hidden when characters are typed.
5262 The mouse pointer is restored when the mouse is moved.
5263
5264 *'mousemodel'* *'mousem'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005265'mousemodel' 'mousem' string (default "extend", "popup" for Win32)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005266 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005267 Sets the model to use for the mouse. The name mostly specifies what
5268 the right mouse button is used for:
5269 extend Right mouse button extends a selection. This works
5270 like in an xterm.
5271 popup Right mouse button pops up a menu. The shifted left
5272 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00005273 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005274 popup_setpos Like "popup", but the cursor will be moved to the
5275 position where the mouse was clicked, and thus the
5276 selected operation will act upon the clicked object.
5277 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00005278 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005279 course, that right clicking outside a selection will
5280 end Visual mode.
5281 Overview of what button does what for each model:
5282 mouse extend popup(_setpos) ~
5283 left click place cursor place cursor
5284 left drag start selection start selection
5285 shift-left search word extend selection
5286 right click extend selection popup menu (place cursor)
5287 right drag extend selection -
5288 middle click paste paste
5289
5290 In the "popup" model the right mouse button produces a pop-up menu.
5291 You need to define this first, see |popup-menu|.
5292
5293 Note that you can further refine the meaning of buttons with mappings.
5294 See |gui-mouse-mapping|. But mappings are NOT used for modeless
5295 selection (because that's handled in the GUI code directly).
5296
5297 The 'mousemodel' option is set by the |:behave| command.
5298
5299 *'mouseshape'* *'mouses'* *E547*
Bram Moolenaarf6b40102019-02-22 15:24:03 +01005300'mouseshape' 'mouses' string (default "i-r:beam,s:updown,sd:udsizing,
5301 vs:leftright,vd:lrsizing,m:no,
5302 ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005303 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005304 {only available when compiled with the |+mouseshape|
5305 feature}
5306 This option tells Vim what the mouse pointer should look like in
5307 different modes. The option is a comma separated list of parts, much
5308 like used for 'guicursor'. Each part consist of a mode/location-list
5309 and an argument-list:
5310 mode-list:shape,mode-list:shape,..
5311 The mode-list is a dash separated list of these modes/locations:
5312 In a normal window: ~
5313 n Normal mode
5314 v Visual mode
5315 ve Visual mode with 'selection' "exclusive" (same as 'v',
5316 if not specified)
5317 o Operator-pending mode
5318 i Insert mode
5319 r Replace mode
5320
5321 Others: ~
5322 c appending to the command-line
5323 ci inserting in the command-line
5324 cr replacing in the command-line
5325 m at the 'Hit ENTER' or 'More' prompts
5326 ml idem, but cursor in the last line
5327 e any mode, pointer below last window
5328 s any mode, pointer on a status line
5329 sd any mode, while dragging a status line
5330 vs any mode, pointer on a vertical separator line
5331 vd any mode, while dragging a vertical separator line
5332 a everywhere
5333
5334 The shape is one of the following:
5335 avail name looks like ~
5336 w x arrow Normal mouse pointer
5337 w x blank no pointer at all (use with care!)
5338 w x beam I-beam
5339 w x updown up-down sizing arrows
5340 w x leftright left-right sizing arrows
5341 w x busy The system's usual busy pointer
5342 w x no The system's usual 'no input' pointer
5343 x udsizing indicates up-down resizing
5344 x lrsizing indicates left-right resizing
5345 x crosshair like a big thin +
5346 x hand1 black hand
5347 x hand2 white hand
5348 x pencil what you write with
5349 x question big ?
5350 x rightup-arrow arrow pointing right-up
5351 w x up-arrow arrow pointing up
5352 x <number> any X11 pointer number (see X11/cursorfont.h)
5353
5354 The "avail" column contains a 'w' if the shape is available for Win32,
5355 x for X11.
5356 Any modes not specified or shapes not available use the normal mouse
5357 pointer.
5358
5359 Example: >
5360 :set mouseshape=s:udsizing,m:no
5361< will make the mouse turn to a sizing arrow over the status lines and
5362 indicate no input when the hit-enter prompt is displayed (since
5363 clicking the mouse has no effect in this state.)
5364
5365 *'mousetime'* *'mouset'*
5366'mousetime' 'mouset' number (default 500)
5367 global
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005368 Only for GUI, Win32 and Unix with xterm. Defines the maximum
Bram Moolenaar071d4272004-06-13 20:20:40 +00005369 time in msec between two mouse clicks for the second click to be
5370 recognized as a multi click.
5371
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005372 *'mzschemedll'*
5373'mzschemedll' string (default depends on the build)
5374 global
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005375 {only available when compiled with the |+mzscheme/dyn|
5376 feature}
5377 Specifies the name of the MzScheme shared library. The default is
5378 DYNAMIC_MZSCH_DLL which was specified at compile time.
5379 Environment variables are expanded |:set_env|.
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01005380 The value must be set in the |vimrc| script or earlier. In the
Bram Moolenaar01164a62017-11-02 22:58:42 +01005381 startup, before the |load-plugins| step.
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005382 This option cannot be set from a |modeline| or in the |sandbox|, for
5383 security reasons.
5384
5385 *'mzschemegcdll'*
5386'mzschemegcdll' string (default depends on the build)
5387 global
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005388 {only available when compiled with the |+mzscheme/dyn|
5389 feature}
5390 Specifies the name of the MzScheme GC shared library. The default is
5391 DYNAMIC_MZGC_DLL which was specified at compile time.
5392 The value can be equal to 'mzschemedll' if it includes the GC code.
5393 Environment variables are expanded |:set_env|.
5394 This option cannot be set from a |modeline| or in the |sandbox|, for
5395 security reasons.
5396
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005397 *'mzquantum'* *'mzq'*
5398'mzquantum' 'mzq' number (default 100)
5399 global
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005400 {not available when compiled without the |+mzscheme|
5401 feature}
5402 The number of milliseconds between polls for MzScheme threads.
5403 Negative or zero value means no thread scheduling.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005404 NOTE: This option is set to the Vim default value when 'compatible'
5405 is reset.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005406
Bram Moolenaar071d4272004-06-13 20:20:40 +00005407 *'nrformats'* *'nf'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02005408'nrformats' 'nf' string (default "bin,octal,hex",
5409 set to "bin,hex" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005410 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005411 This defines what bases Vim will consider for numbers when using the
5412 CTRL-A and CTRL-X commands for adding to and subtracting from a number
5413 respectively; see |CTRL-A| for more info on these commands.
Bram Moolenaar4770d092006-01-12 23:22:24 +00005414 alpha If included, single alphabetical characters will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005415 incremented or decremented. This is useful for a list with a
Bram Moolenaar3848e002016-03-19 18:42:29 +01005416 letter index a), b), etc. *octal-nrformats*
Bram Moolenaar4770d092006-01-12 23:22:24 +00005417 octal If included, numbers that start with a zero will be considered
Bram Moolenaar071d4272004-06-13 20:20:40 +00005418 to be octal. Example: Using CTRL-A on "007" results in "010".
Bram Moolenaar4770d092006-01-12 23:22:24 +00005419 hex If included, numbers starting with "0x" or "0X" will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005420 considered to be hexadecimal. Example: Using CTRL-X on
5421 "0x100" results in "0x0ff".
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005422 bin If included, numbers starting with "0b" or "0B" will be
5423 considered to be binary. Example: Using CTRL-X on
5424 "0b1000" subtracts one, resulting in "0b0111".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005425 Numbers which simply begin with a digit in the range 1-9 are always
5426 considered decimal. This also happens for numbers that are not
5427 recognized as octal or hex.
5428
5429 *'number'* *'nu'* *'nonumber'* *'nonu'*
5430'number' 'nu' boolean (default off)
5431 local to window
5432 Print the line number in front of each line. When the 'n' option is
5433 excluded from 'cpoptions' a wrapped line will not use the column of
5434 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005435 The 'numberwidth' option can be used to set the room used for the line
5436 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005437 When a long, wrapped line doesn't start with the first character, '-'
5438 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02005439 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
5440 the number.
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005441 *number_relativenumber*
5442 The 'relativenumber' option changes the displayed number to be
5443 relative to the cursor. Together with 'number' there are these
5444 four combinations (cursor in line 3):
5445
Bram Moolenaar3848e002016-03-19 18:42:29 +01005446 'nonu' 'nu' 'nonu' 'nu'
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005447 'nornu' 'nornu' 'rnu' 'rnu'
5448
5449 |apple | 1 apple | 2 apple | 2 apple
5450 |pear | 2 pear | 1 pear | 1 pear
5451 |nobody | 3 nobody | 0 nobody |3 nobody
5452 |there | 4 there | 1 there | 1 there
Bram Moolenaar071d4272004-06-13 20:20:40 +00005453
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005454 *'numberwidth'* *'nuw'*
5455'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
5456 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005457 {only available when compiled with the |+linebreak|
5458 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005459 Minimal number of columns to use for the line number. Only relevant
Bram Moolenaar64486672010-05-16 15:46:46 +02005460 when the 'number' or 'relativenumber' option is set or printing lines
5461 with a line number. Since one space is always between the number and
5462 the text, there is one less character for the number itself.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005463 The value is the minimum width. A bigger width is used when needed to
Bram Moolenaar64486672010-05-16 15:46:46 +02005464 fit the highest line number in the buffer respectively the number of
5465 rows in the window, depending on whether 'number' or 'relativenumber'
5466 is set. Thus with the Vim default of 4 there is room for a line number
5467 up to 999. When the buffer has 1000 lines five columns will be used.
Bram Moolenaarf8a07122019-07-01 22:06:07 +02005468 The minimum value is 1, the maximum value is 20.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005469 NOTE: This option is set to the Vi default value when 'compatible' is
5470 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005471
Bram Moolenaarf75a9632005-09-13 21:20:47 +00005472 *'omnifunc'* *'ofu'*
5473'omnifunc' 'ofu' string (default: empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00005474 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02005475 {not available when compiled without the |+eval|
Bram Moolenaare2c453d2019-08-21 14:37:09 +02005476 feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00005477 This option specifies a function to be used for Insert mode omni
5478 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
Bram Moolenaar280f1262006-01-30 00:14:18 +00005479 See |complete-functions| for an explanation of how the function is
5480 invoked and what it should return.
Bram Moolenaar043545e2006-10-10 16:44:07 +00005481 This option is usually set by a filetype plugin:
Bram Moolenaar9c102382006-05-03 21:26:49 +00005482 |:filetype-plugin-on|
Bram Moolenaar30b65812012-07-12 22:01:11 +02005483 This option cannot be set from a |modeline| or in the |sandbox|, for
5484 security reasons.
Bram Moolenaare344bea2005-09-01 20:46:49 +00005485
5486
Bram Moolenaar02467872007-05-06 13:22:01 +00005487 *'opendevice'* *'odev'* *'noopendevice'* *'noodev'*
Bram Moolenaar043545e2006-10-10 16:44:07 +00005488'opendevice' 'odev' boolean (default off)
5489 global
Bram Moolenaar6f345a12019-12-17 21:27:18 +01005490 {only for MS-Windows}
Bram Moolenaar043545e2006-10-10 16:44:07 +00005491 Enable reading and writing from devices. This may get Vim stuck on a
5492 device that can be opened but doesn't actually do the I/O. Therefore
5493 it is off by default.
5494 Note that on MS-Windows editing "aux.h", "lpt1.txt" and the like also
5495 result in editing a device.
5496
5497
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005498 *'operatorfunc'* *'opfunc'*
5499'operatorfunc' 'opfunc' string (default: empty)
5500 global
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005501 This option specifies a function to be called by the |g@| operator.
5502 See |:map-operator| for more info and an example.
5503
5504 This option cannot be set from a |modeline| or in the |sandbox|, for
5505 security reasons.
5506
5507
Bram Moolenaar251e1912011-06-19 05:09:16 +02005508 *'osfiletype'* *'oft'*
5509'osfiletype' 'oft' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005510 local to buffer
Bram Moolenaar251e1912011-06-19 05:09:16 +02005511 This option was supported on RISC OS, which has been removed.
5512
Bram Moolenaar071d4272004-06-13 20:20:40 +00005513
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005514 *'packpath'* *'pp'*
5515'packpath' 'pp' string (default: see 'runtimepath')
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005516 Directories used to find packages. See |packages|.
5517
5518
Bram Moolenaar071d4272004-06-13 20:20:40 +00005519 *'paragraphs'* *'para'*
Bram Moolenaar57e48462008-03-12 16:38:55 +00005520'paragraphs' 'para' string (default "IPLPPPQPP TPHPLIPpLpItpplpipbp")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005521 global
5522 Specifies the nroff macros that separate paragraphs. These are pairs
5523 of two letters (see |object-motions|).
5524
5525 *'paste'* *'nopaste'*
5526'paste' boolean (default off)
5527 global
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005528 Put Vim in Paste mode. This is useful if you want to cut or copy
5529 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005530 unexpected effects.
5531 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005532 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00005533 knows about pasting and will mostly do the right thing without 'paste'
5534 being set. The same is true for a terminal where Vim handles the
5535 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00005536 This option is reset when starting the GUI. Thus if you set it in
5537 your .vimrc it will work in a terminal, but not in the GUI. Setting
5538 'paste' in the GUI has side effects: e.g., the Paste toolbar button
5539 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005540 When the 'paste' option is switched on (also when it was already on):
5541 - mapping in Insert mode and Command-line mode is disabled
5542 - abbreviations are disabled
Bram Moolenaar071d4272004-06-13 20:20:40 +00005543 - 'autoindent' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02005544 - 'expandtab' is reset
5545 - 'formatoptions' is used like it is empty
Bram Moolenaar071d4272004-06-13 20:20:40 +00005546 - 'revins' is reset
5547 - 'ruler' is reset
5548 - 'showmatch' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02005549 - 'smartindent' is reset
5550 - 'smarttab' is reset
5551 - 'softtabstop' is set to 0
5552 - 'textwidth' is set to 0
5553 - 'wrapmargin' is set to 0
Bram Moolenaar071d4272004-06-13 20:20:40 +00005554 These options keep their value, but their effect is disabled:
Bram Moolenaar071d4272004-06-13 20:20:40 +00005555 - 'cindent'
Bram Moolenaarca635012015-09-25 20:34:21 +02005556 - 'indentexpr'
5557 - 'lisp'
Bram Moolenaar071d4272004-06-13 20:20:40 +00005558 NOTE: When you start editing another file while the 'paste' option is
5559 on, settings from the modelines or autocommands may change the
5560 settings again, causing trouble when pasting text. You might want to
5561 set the 'paste' option again.
5562 When the 'paste' option is reset the mentioned options are restored to
5563 the value before the moment 'paste' was switched from off to on.
5564 Resetting 'paste' before ever setting it does not have any effect.
5565 Since mapping doesn't work while 'paste' is active, you need to use
5566 the 'pastetoggle' option to toggle the 'paste' option with some key.
5567
5568 *'pastetoggle'* *'pt'*
5569'pastetoggle' 'pt' string (default "")
5570 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005571 When non-empty, specifies the key sequence that toggles the 'paste'
5572 option. This is like specifying a mapping: >
5573 :map {keys} :set invpaste<CR>
5574< Where {keys} is the value of 'pastetoggle'.
5575 The difference is that it will work even when 'paste' is set.
5576 'pastetoggle' works in Insert mode and Normal mode, but not in
5577 Command-line mode.
5578 Mappings are checked first, thus overrule 'pastetoggle'. However,
5579 when 'paste' is on mappings are ignored in Insert mode, thus you can do
5580 this: >
5581 :map <F10> :set paste<CR>
5582 :map <F11> :set nopaste<CR>
5583 :imap <F10> <C-O>:set paste<CR>
5584 :imap <F11> <nop>
5585 :set pastetoggle=<F11>
5586< This will make <F10> start paste mode and <F11> stop paste mode.
5587 Note that typing <F10> in paste mode inserts "<F10>", since in paste
5588 mode everything is inserted literally, except the 'pastetoggle' key
5589 sequence.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005590 When the value has several bytes 'ttimeoutlen' applies.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005591
5592 *'pex'* *'patchexpr'*
5593'patchexpr' 'pex' string (default "")
5594 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005595 {not available when compiled without the |+diff|
5596 feature}
5597 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005598 the resulting new version of the file. See |diff-patchexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005599
Bram Moolenaardbc28022014-07-26 13:40:44 +02005600 *'patchmode'* *'pm'* *E205* *E206*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005601'patchmode' 'pm' string (default "")
5602 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005603 When non-empty the oldest version of a file is kept. This can be used
5604 to keep the original version of a file if you are changing files in a
5605 source distribution. Only the first time that a file is written a
5606 copy of the original file will be kept. The name of the copy is the
5607 name of the original file with the string in the 'patchmode' option
5608 appended. This option should start with a dot. Use a string like
Bram Moolenaardf980db2017-12-24 13:22:00 +01005609 ".orig" or ".org". 'backupdir' must not be empty for this to work
5610 (Detail: The backup file is renamed to the patchmode file after the
5611 new file has been successfully written, that's why it must be possible
5612 to write a backup file). If there was no file to be backed up, an
5613 empty file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005614 When the 'backupskip' pattern matches, a patchmode file is not made.
5615 Using 'patchmode' for compressed files appends the extension at the
5616 end (e.g., "file.gz.orig"), thus the resulting name isn't always
5617 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005618 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005619
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01005620 *'path'* *'pa'* *E343* *E345* *E347* *E854*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005621'path' 'pa' string (default on Unix: ".,/usr/include,,"
Bram Moolenaar071d4272004-06-13 20:20:40 +00005622 other systems: ".,,")
5623 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005624 This is a list of directories which will be searched when using the
Bram Moolenaarc236c162008-07-13 17:41:49 +00005625 |gf|, [f, ]f, ^Wf, |:find|, |:sfind|, |:tabfind| and other commands,
5626 provided that the file being searched for has a relative path (not
5627 starting with "/", "./" or "../"). The directories in the 'path'
5628 option may be relative or absolute.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005629 - Use commas to separate directory names: >
5630 :set path=.,/usr/local/include,/usr/include
5631< - Spaces can also be used to separate directory names (for backwards
5632 compatibility with version 3.0). To have a space in a directory
5633 name, precede it with an extra backslash, and escape the space: >
5634 :set path=.,/dir/with\\\ space
5635< - To include a comma in a directory name precede it with an extra
5636 backslash: >
5637 :set path=.,/dir/with\\,comma
5638< - To search relative to the directory of the current file, use: >
5639 :set path=.
5640< - To search in the current directory use an empty string between two
5641 commas: >
5642 :set path=,,
5643< - A directory name may end in a ':' or '/'.
5644 - Environment variables are expanded |:set_env|.
5645 - When using |netrw.vim| URLs can be used. For example, adding
5646 "http://www.vim.org" will make ":find index.html" work.
Bram Moolenaarc236c162008-07-13 17:41:49 +00005647 - Search upwards and downwards in a directory tree using "*", "**" and
5648 ";". See |file-searching| for info and syntax.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005649 {not available when compiled without the |+path_extra| feature}
5650 - Careful with '\' characters, type two to get one in the option: >
5651 :set path=.,c:\\include
5652< Or just use '/' instead: >
5653 :set path=.,c:/include
5654< Don't forget "." or files won't even be found in the same directory as
5655 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005656 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00005657 it is something like 256 or 1024 characters.
5658 You can check if all the include files are found, using the value of
5659 'path', see |:checkpath|.
5660 The use of |:set+=| and |:set-=| is preferred when adding or removing
5661 directories from the list. This avoids problems when a future version
5662 uses another default. To remove the current directory use: >
5663 :set path-=
5664< To add the current directory use: >
5665 :set path+=
5666< To use an environment variable, you probably need to replace the
5667 separator. Here is an example to append $INCL, in which directory
5668 names are separated with a semi-colon: >
5669 :let &path = &path . "," . substitute($INCL, ';', ',', 'g')
5670< Replace the ';' with a ':' or whatever separator is used. Note that
5671 this doesn't work when $INCL contains a comma or white space.
5672
Bram Moolenaar37c64c72017-09-19 22:06:03 +02005673 *'perldll'*
5674'perldll' string (default depends on the build)
5675 global
Bram Moolenaar37c64c72017-09-19 22:06:03 +02005676 {only available when compiled with the |+perl/dyn|
5677 feature}
5678 Specifies the name of the Perl shared library. The default is
5679 DYNAMIC_PERL_DLL, which was specified at compile time.
5680 Environment variables are expanded |:set_env|.
5681 This option cannot be set from a |modeline| or in the |sandbox|, for
5682 security reasons.
5683
Bram Moolenaar071d4272004-06-13 20:20:40 +00005684 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
5685'preserveindent' 'pi' boolean (default off)
5686 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005687 When changing the indent of the current line, preserve as much of the
5688 indent structure as possible. Normally the indent is replaced by a
5689 series of tabs followed by spaces as required (unless |'expandtab'| is
5690 enabled, in which case only spaces are used). Enabling this option
5691 means the indent will preserve as many existing characters as possible
5692 for indenting, and only add additional tabs or spaces as required.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005693 'expandtab' does not apply to the preserved white space, a Tab remains
5694 a Tab.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005695 NOTE: When using ">>" multiple times the resulting indent is a mix of
5696 tabs and spaces. You might not like this.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005697 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005698 Also see 'copyindent'.
5699 Use |:retab| to clean up white space.
5700
5701 *'previewheight'* *'pvh'*
5702'previewheight' 'pvh' number (default 12)
5703 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02005704 {not available when compiled without the |+quickfix|
5705 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005706 Default height for a preview window. Used for |:ptag| and associated
Bram Moolenaar79648732019-07-18 21:43:07 +02005707 commands. Used for |CTRL-W_}| when no count is given. Not used when
5708 'previewpopup' is set.
5709
5710 *'previewpopup'* *'pvp'*
5711'previewpopup' 'pvp' string (default empty)
5712 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02005713 {not available when compiled without the |+textprop|
5714 or |+quickfix| feature}
Bram Moolenaar79648732019-07-18 21:43:07 +02005715 When not empty a popup window is used for commands that would open a
5716 preview window. See |preview-popup|.
Bram Moolenaar576a4a62019-08-18 15:25:17 +02005717 Not used for the insert completion info, add "popup" to
5718 'completeopt' for that.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005719
5720 *'previewwindow'* *'nopreviewwindow'*
5721 *'pvw'* *'nopvw'* *E590*
5722'previewwindow' 'pvw' boolean (default off)
5723 local to window
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02005724 {not available when compiled without the |+quickfix|
5725 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005726 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00005727 set. It's normally not set directly, but by using one of the commands
5728 |:ptag|, |:pedit|, etc.
5729
5730 *'printdevice'* *'pdev'*
5731'printdevice' 'pdev' string (default empty)
5732 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005733 {only available when compiled with the |+printer|
5734 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005735 The name of the printer to be used for |:hardcopy|.
5736 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005737 This option cannot be set from a |modeline| or in the |sandbox|, for
5738 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005739
Bram Moolenaar8299df92004-07-10 09:47:34 +00005740 *'printencoding'* *'penc'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005741'printencoding' 'penc' string (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005742 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005743 {only available when compiled with the |+printer|
5744 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005745 Sets the character encoding used when printing.
5746 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005747
5748 *'printexpr'* *'pexpr'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005749'printexpr' 'pexpr' string (default: see below)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005750 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005751 {only available when compiled with the |+printer|
5752 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005753 Expression used to print the PostScript produced with |:hardcopy|.
5754 See |pexpr-option|.
Bram Moolenaar51628222016-12-01 23:03:28 +01005755 This option cannot be set from a |modeline| or in the |sandbox|, for
5756 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005757
Bram Moolenaar8299df92004-07-10 09:47:34 +00005758 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005759'printfont' 'pfn' string (default "courier")
5760 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005761 {only available when compiled with the |+printer|
5762 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005763 The name of the font that will be used for |:hardcopy|.
5764 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005765
5766 *'printheader'* *'pheader'*
5767'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
5768 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005769 {only available when compiled with the |+printer|
5770 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005771 The format of the header produced in |:hardcopy| output.
5772 See |pheader-option|.
5773
5774 *'printmbcharset'* *'pmbcs'*
5775'printmbcharset' 'pmbcs' string (default "")
5776 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01005777 {only available when compiled with the |+printer|
5778 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005779 The CJK character set to be used for CJK output from |:hardcopy|.
5780 See |pmbcs-option|.
5781
5782 *'printmbfont'* *'pmbfn'*
5783'printmbfont' 'pmbfn' string (default "")
5784 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01005785 {only available when compiled with the |+printer|
5786 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005787 List of font names to be used for CJK output from |:hardcopy|.
5788 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005789
5790 *'printoptions'* *'popt'*
5791'printoptions' 'popt' string (default "")
5792 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005793 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005794 List of items that control the format of the output of |:hardcopy|.
5795 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005796
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005797 *'prompt'* *'noprompt'*
5798'prompt' boolean (default on)
5799 global
5800 When on a ":" prompt is used in Ex mode.
5801
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005802 *'pumheight'* *'ph'*
5803'pumheight' 'ph' number (default 0)
5804 global
Bram Moolenaar06a89a52006-04-29 22:01:03 +00005805 Determines the maximum number of items to show in the popup menu for
5806 Insert mode completion. When zero as much space as available is used.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005807 |ins-completion-menu|.
5808
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01005809 *'pumwidth'* *'pw'*
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005810'pumwidth' 'pw' number (default 15)
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01005811 global
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01005812 Determines the minimum width to use for the popup menu for Insert mode
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005813 completion. |ins-completion-menu|.
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01005814
Bram Moolenaard94464e2015-11-02 15:28:18 +01005815 *'pythondll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01005816'pythondll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01005817 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01005818 {only available when compiled with the |+python/dyn|
5819 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005820 Specifies the name of the Python 2.x shared library. The default is
5821 DYNAMIC_PYTHON_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005822 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01005823 This option cannot be set from a |modeline| or in the |sandbox|, for
5824 security reasons.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005825
Bram Moolenaar94073162018-01-31 21:49:05 +01005826 *'pythonhome'*
5827'pythonhome' string (default "")
5828 global
Bram Moolenaar94073162018-01-31 21:49:05 +01005829 {only available when compiled with the |+python/dyn|
5830 feature}
5831 Specifies the name of the Python 2.x home directory. When 'pythonhome'
5832 and the PYTHONHOME environment variable are not set, PYTHON_HOME,
5833 which was specified at compile time, will be used for the Python 2.x
5834 home directory.
5835 Environment variables are expanded |:set_env|.
5836 This option cannot be set from a |modeline| or in the |sandbox|, for
5837 security reasons.
5838
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005839 *'pythonthreedll'*
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005840'pythonthreedll' string (default depends on the build)
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005841 global
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005842 {only available when compiled with the |+python3/dyn|
5843 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005844 Specifies the name of the Python 3 shared library. The default is
5845 DYNAMIC_PYTHON3_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005846 Environment variables are expanded |:set_env|.
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005847 This option cannot be set from a |modeline| or in the |sandbox|, for
5848 security reasons.
5849
Bram Moolenaar94073162018-01-31 21:49:05 +01005850 *'pythonthreehome'*
5851'pythonthreehome' string (default "")
5852 global
Bram Moolenaar94073162018-01-31 21:49:05 +01005853 {only available when compiled with the |+python3/dyn|
5854 feature}
5855 Specifies the name of the Python 3 home directory. When
5856 'pythonthreehome' and the PYTHONHOME environment variable are not set,
5857 PYTHON3_HOME, which was specified at compile time, will be used for
5858 the Python 3 home directory.
5859 Environment variables are expanded |:set_env|.
5860 This option cannot be set from a |modeline| or in the |sandbox|, for
5861 security reasons.
5862
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01005863 *'pyxversion'* *'pyx'*
5864'pyxversion' 'pyx' number (default depends on the build)
5865 global
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01005866 {only available when compiled with the |+python| or
5867 the |+python3| feature}
5868 Specifies the python version used for pyx* functions and commands
5869 |python_x|. The default value is as follows:
5870
5871 Compiled with Default ~
5872 |+python| and |+python3| 0
5873 only |+python| 2
5874 only |+python3| 3
5875
5876 Available values are 0, 2 and 3.
5877 If 'pyxversion' is 0, it is set to 2 or 3 after the first execution of
5878 any python2/3 commands or functions. E.g. `:py` sets to 2, and `:py3`
5879 sets to 3. `:pyx` sets it to 3 if Python 3 is available, otherwise sets
5880 to 2 if Python 2 is available.
5881 See also: |has-pythonx|
5882
5883 If Vim is compiled with only |+python| or |+python3| setting
5884 'pyxversion' has no effect. The pyx* functions and commands are
5885 always the same as the compiled version.
5886
5887 This option cannot be set from a |modeline| or in the |sandbox|, for
5888 security reasons.
5889
Bram Moolenaar677ee682005-01-27 14:41:15 +00005890 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005891'quoteescape' 'qe' string (default "\")
5892 local to buffer
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005893 The characters that are used to escape quotes in a string. Used for
5894 objects like a', a" and a` |a'|.
5895 When one of the characters in this option is found inside a string,
5896 the following character will be skipped. The default value makes the
5897 text "foo\"bar\\" considered to be one string.
5898
Bram Moolenaar071d4272004-06-13 20:20:40 +00005899 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
5900'readonly' 'ro' boolean (default off)
5901 local to buffer
5902 If on, writes fail unless you use a '!'. Protects you from
5903 accidentally overwriting a file. Default on when Vim is started
5904 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005905 When using ":w!" the 'readonly' option is reset for the current
5906 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar6c60f472019-04-28 16:00:35 +02005907 When using the ":view" command the 'readonly' option is set for the
5908 newly edited buffer.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01005909 See 'modifiable' for disallowing changes to the buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005910
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005911 *'redrawtime'* *'rdt'*
5912'redrawtime' 'rdt' number (default 2000)
5913 global
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005914 {only available when compiled with the |+reltime|
5915 feature}
5916 The time in milliseconds for redrawing the display. This applies to
Bram Moolenaar15142e22018-04-30 22:19:58 +02005917 searching for patterns for 'hlsearch', |:match| highlighting and syntax
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02005918 highlighting.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005919 When redrawing takes more than this many milliseconds no further
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02005920 matches will be highlighted.
5921 For syntax highlighting the time applies per window. When over the
5922 limit syntax highlighting is disabled until |CTRL-L| is used.
5923 This is used to avoid that Vim hangs when using a very complicated
5924 pattern.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005925
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02005926 *'regexpengine'* *'re'*
Bram Moolenaare6ae6222013-05-21 21:01:10 +02005927'regexpengine' 're' number (default 0)
5928 global
Bram Moolenaare6ae6222013-05-21 21:01:10 +02005929 This selects the default regexp engine. |two-engines|
5930 The possible values are:
5931 0 automatic selection
5932 1 old engine
5933 2 NFA engine
5934 Note that when using the NFA engine and the pattern contains something
5935 that is not supported the pattern will not match. This is only useful
5936 for debugging the regexp engine.
Bram Moolenaarfda37292014-11-05 14:27:36 +01005937 Using automatic selection enables Vim to switch the engine, if the
5938 default engine becomes too costly. E.g., when the NFA engine uses too
5939 many states. This should prevent Vim from hanging on a combination of
5940 a complex pattern with long text.
Bram Moolenaare6ae6222013-05-21 21:01:10 +02005941
Bram Moolenaar64486672010-05-16 15:46:46 +02005942 *'relativenumber'* *'rnu'* *'norelativenumber'* *'nornu'*
5943'relativenumber' 'rnu' boolean (default off)
5944 local to window
Bram Moolenaar64486672010-05-16 15:46:46 +02005945 Show the line number relative to the line with the cursor in front of
Bram Moolenaar06b5d512010-05-22 15:37:44 +02005946 each line. Relative line numbers help you use the |count| you can
Bram Moolenaar64486672010-05-16 15:46:46 +02005947 precede some vertical motion commands (e.g. j k + -) with, without
5948 having to calculate it yourself. Especially useful in combination with
5949 other commands (e.g. y d c < > gq gw =).
5950 When the 'n' option is excluded from 'cpoptions' a wrapped
5951 line will not use the column of line numbers (this is the default when
5952 'compatible' isn't set).
5953 The 'numberwidth' option can be used to set the room used for the line
5954 number.
5955 When a long, wrapped line doesn't start with the first character, '-'
5956 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02005957 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
5958 the number.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01005959
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005960 The number in front of the cursor line also depends on the value of
5961 'number', see |number_relativenumber| for all combinations of the two
5962 options.
Bram Moolenaar64486672010-05-16 15:46:46 +02005963
Bram Moolenaar071d4272004-06-13 20:20:40 +00005964 *'remap'* *'noremap'*
5965'remap' boolean (default on)
5966 global
5967 Allows for mappings to work recursively. If you do not want this for
5968 a single entry, use the :noremap[!] command.
Bram Moolenaara3227e22006-03-08 21:32:40 +00005969 NOTE: To avoid portability problems with Vim scripts, always keep
5970 this option at the default "on". Only switch it off when working with
5971 old Vi scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005972
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02005973 *'renderoptions'* *'rop'*
5974'renderoptions' 'rop' string (default: empty)
5975 global
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02005976 {only available when compiled with GUI and DIRECTX on
5977 MS-Windows}
5978 Select a text renderer and set its options. The options depend on the
5979 renderer.
5980
5981 Syntax: >
5982 set rop=type:{renderer}(,{name}:{value})*
5983<
5984 Currently, only one optional renderer is available.
5985
5986 render behavior ~
5987 directx Vim will draw text using DirectX (DirectWrite). It makes
5988 drawn glyphs more beautiful than default GDI.
5989 It requires 'encoding' is "utf-8", and only works on
5990 MS-Windows Vista or newer version.
5991
5992 Options:
5993 name meaning type value ~
5994 gamma gamma float 1.0 - 2.2 (maybe)
5995 contrast enhancedContrast float (unknown)
5996 level clearTypeLevel float (unknown)
5997 geom pixelGeometry int 0 - 2 (see below)
5998 renmode renderingMode int 0 - 6 (see below)
5999 taamode textAntialiasMode int 0 - 3 (see below)
Bram Moolenaara338adc2018-01-31 20:51:47 +01006000 scrlines Scroll Lines int (deprecated)
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006001
Bram Moolenaar92467d32017-12-05 13:22:16 +01006002 See this URL for detail (except for scrlines):
6003 https://msdn.microsoft.com/en-us/library/dd368190.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006004
6005 For geom: structure of a device pixel.
6006 0 - DWRITE_PIXEL_GEOMETRY_FLAT
6007 1 - DWRITE_PIXEL_GEOMETRY_RGB
6008 2 - DWRITE_PIXEL_GEOMETRY_BGR
6009
6010 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006011 https://msdn.microsoft.com/en-us/library/dd368114.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006012
6013 For renmode: method of rendering glyphs.
6014 0 - DWRITE_RENDERING_MODE_DEFAULT
6015 1 - DWRITE_RENDERING_MODE_ALIASED
6016 2 - DWRITE_RENDERING_MODE_GDI_CLASSIC
6017 3 - DWRITE_RENDERING_MODE_GDI_NATURAL
6018 4 - DWRITE_RENDERING_MODE_NATURAL
6019 5 - DWRITE_RENDERING_MODE_NATURAL_SYMMETRIC
6020 6 - DWRITE_RENDERING_MODE_OUTLINE
6021
6022 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006023 https://msdn.microsoft.com/en-us/library/dd368118.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006024
6025 For taamode: antialiasing mode used for drawing text.
6026 0 - D2D1_TEXT_ANTIALIAS_MODE_DEFAULT
6027 1 - D2D1_TEXT_ANTIALIAS_MODE_CLEARTYPE
6028 2 - D2D1_TEXT_ANTIALIAS_MODE_GRAYSCALE
6029 3 - D2D1_TEXT_ANTIALIAS_MODE_ALIASED
6030
6031 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006032 https://msdn.microsoft.com/en-us/library/dd368170.aspx
6033
Bram Moolenaara338adc2018-01-31 20:51:47 +01006034 For scrlines:
6035 This was used for optimizing scrolling behavior, however this
6036 is now deprecated. If specified, it is simply ignored.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006037
6038 Example: >
6039 set encoding=utf-8
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006040 set gfn=Ricty_Diminished:h12
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006041 set rop=type:directx
6042<
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006043 If select a raster font (Courier, Terminal or FixedSys which
6044 have ".fon" extension in file name) to 'guifont', it will be
Bram Moolenaar92467d32017-12-05 13:22:16 +01006045 drawn by GDI as a fallback.
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006046
6047 NOTE: It is known that some fonts and options combination
6048 causes trouble on drawing glyphs.
6049
Bram Moolenaar92467d32017-12-05 13:22:16 +01006050 - 'renmode:5' and 'renmode:6' will not work with some
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006051 special made fonts (True-Type fonts which includes only
6052 bitmap glyphs).
6053 - 'taamode:3' will not work with some vector fonts.
6054
6055 NOTE: With this option, you can display colored emoji
6056 (emoticon) in Windows 8.1 or later. To display colored emoji,
6057 there are some conditions which you should notice.
6058
6059 - If your font includes non-colored emoji already, it will
6060 be used.
6061 - If your font doesn't have emoji, the system chooses an
6062 alternative symbol font. On Windows 10, "Segoe UI Emoji"
6063 will be used.
6064 - When this alternative font didn't have fixed width glyph,
6065 emoji might be rendered beyond the bounding box of drawing
6066 cell.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006067
6068 Other render types are currently not supported.
6069
Bram Moolenaar071d4272004-06-13 20:20:40 +00006070 *'report'*
6071'report' number (default 2)
6072 global
6073 Threshold for reporting number of lines changed. When the number of
6074 changed lines is more than 'report' a message will be given for most
6075 ":" commands. If you want it always, set 'report' to 0.
6076 For the ":substitute" command the number of substitutions is used
6077 instead of the number of lines.
6078
6079 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
6080'restorescreen' 'rs' boolean (default on)
6081 global
Bram Moolenaar8024f932020-01-14 19:29:13 +01006082 {only in MS-Windows console version}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006083 When set, the screen contents is restored when exiting Vim. This also
6084 happens when executing external commands.
6085
6086 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
6087 options in your .vimrc. To disable restoring:
6088 set t_ti= t_te=
6089 To enable restoring (for an xterm):
6090 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
6091 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
6092
6093 *'revins'* *'ri'* *'norevins'* *'nori'*
6094'revins' 'ri' boolean (default off)
6095 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006096 {only available when compiled with the |+rightleft|
6097 feature}
6098 Inserting characters in Insert mode will work backwards. See "typing
6099 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
6100 command in Insert mode, when 'allowrevins' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02006101 NOTE: This option is reset when 'compatible' is set.
6102 This option is reset when 'paste' is set and restored when 'paste' is
6103 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006104
6105 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
6106'rightleft' 'rl' boolean (default off)
6107 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006108 {only available when compiled with the |+rightleft|
6109 feature}
6110 When on, display orientation becomes right-to-left, i.e., characters
6111 that are stored in the file appear from the right to the left.
6112 Using this option, it is possible to edit files for languages that
6113 are written from the right to the left such as Hebrew and Arabic.
6114 This option is per window, so it is possible to edit mixed files
6115 simultaneously, or to view the same file in both ways (this is
6116 useful whenever you have a mixed text file with both right-to-left
6117 and left-to-right strings so that both sets are displayed properly
6118 in different windows). Also see |rileft.txt|.
6119
Bram Moolenaar607cc1e2010-07-18 18:47:44 +02006120 *'rightleftcmd'* *'rlc'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006121'rightleftcmd' 'rlc' string (default "search")
6122 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006123 {only available when compiled with the |+rightleft|
6124 feature}
6125 Each word in this option enables the command line editing to work in
6126 right-to-left mode for a group of commands:
6127
6128 search "/" and "?" commands
6129
6130 This is useful for languages such as Hebrew, Arabic and Farsi.
6131 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
6132
Bram Moolenaard94464e2015-11-02 15:28:18 +01006133 *'rubydll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01006134'rubydll' string (default: depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01006135 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01006136 {only available when compiled with the |+ruby/dyn|
6137 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006138 Specifies the name of the Ruby shared library. The default is
6139 DYNAMIC_RUBY_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006140 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01006141 This option cannot be set from a |modeline| or in the |sandbox|, for
6142 security reasons.
6143
Bram Moolenaar071d4272004-06-13 20:20:40 +00006144 *'ruler'* *'ru'* *'noruler'* *'noru'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02006145'ruler' 'ru' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006146 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006147 {not available when compiled without the
6148 |+cmdline_info| feature}
6149 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006150 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00006151 text in the file is shown on the far right:
6152 Top first line is visible
6153 Bot last line is visible
6154 All first and last line are visible
6155 45% relative position in the file
6156 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006157 Each window has its own ruler. If a window has a status line, the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006158 ruler is shown there. Otherwise it is shown in the last line of the
Bram Moolenaar582fd852005-03-28 20:58:01 +00006159 screen. If the statusline is given by 'statusline' (i.e. not empty),
Bram Moolenaar071d4272004-06-13 20:20:40 +00006160 this option takes precedence over 'ruler' and 'rulerformat'
6161 If the number of characters displayed is different from the number of
6162 bytes in the text (e.g., for a TAB or a multi-byte character), both
6163 the text column (byte number) and the screen column are shown,
6164 separated with a dash.
6165 For an empty line "0-1" is shown.
6166 For an empty buffer the line number will also be zero: "0,0-1".
Bram Moolenaarca635012015-09-25 20:34:21 +02006167 This option is reset when 'paste' is set and restored when 'paste' is
6168 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006169 If you don't want to see the ruler all the time but want to know where
6170 you are, use "g CTRL-G" |g_CTRL-G|.
6171 NOTE: This option is reset when 'compatible' is set.
6172
6173 *'rulerformat'* *'ruf'*
6174'rulerformat' 'ruf' string (default empty)
6175 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006176 {not available when compiled without the |+statusline|
6177 feature}
6178 When this option is not empty, it determines the content of the ruler
6179 string, as displayed for the 'ruler' option.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00006180 The format of this option is like that of 'statusline'.
Bram Moolenaar110289e2019-05-23 15:38:06 +02006181 This option cannot be set in a modeline when 'modelineexpr' is off.
6182
Bram Moolenaar071d4272004-06-13 20:20:40 +00006183 The default ruler width is 17 characters. To make the ruler 15
6184 characters wide, put "%15(" at the start and "%)" at the end.
6185 Example: >
6186 :set rulerformat=%15(%c%V\ %p%%%)
6187<
6188 *'runtimepath'* *'rtp'* *vimfiles*
6189'runtimepath' 'rtp' string (default:
6190 Unix: "$HOME/.vim,
6191 $VIM/vimfiles,
6192 $VIMRUNTIME,
6193 $VIM/vimfiles/after,
6194 $HOME/.vim/after"
6195 Amiga: "home:vimfiles,
6196 $VIM/vimfiles,
6197 $VIMRUNTIME,
6198 $VIM/vimfiles/after,
6199 home:vimfiles/after"
Bram Moolenaar6f345a12019-12-17 21:27:18 +01006200 PC: "$HOME/vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006201 $VIM/vimfiles,
6202 $VIMRUNTIME,
6203 $VIM/vimfiles/after,
6204 $HOME/vimfiles/after"
6205 Macintosh: "$VIM:vimfiles,
6206 $VIMRUNTIME,
6207 $VIM:vimfiles:after"
Bram Moolenaar071d4272004-06-13 20:20:40 +00006208 VMS: "sys$login:vimfiles,
6209 $VIM/vimfiles,
6210 $VIMRUNTIME,
6211 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00006212 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006213 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006214 This is a list of directories which will be searched for runtime
6215 files:
6216 filetype.vim filetypes by file name |new-filetype|
6217 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006218 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006219 colors/ color scheme files |:colorscheme|
6220 compiler/ compiler files |:compiler|
6221 doc/ documentation |write-local-help|
6222 ftplugin/ filetype plugins |write-filetype-plugin|
6223 indent/ indent scripts |indent-expression|
6224 keymap/ key mapping files |mbyte-keymap|
6225 lang/ menu translations |:menutrans|
6226 menu.vim GUI menus |menu.vim|
Bram Moolenaar26852122016-05-24 20:02:38 +02006227 pack/ packages |:packadd|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006228 plugin/ plugin scripts |write-plugin|
6229 print/ files for printing |postscript-print-encoding|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006230 spell/ spell checking files |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006231 syntax/ syntax files |mysyntaxfile|
6232 tutor/ files for vimtutor |tutor|
6233
6234 And any other file searched for with the |:runtime| command.
6235
6236 The defaults for most systems are setup to search five locations:
6237 1. In your home directory, for your personal preferences.
6238 2. In a system-wide Vim directory, for preferences from the system
6239 administrator.
6240 3. In $VIMRUNTIME, for files distributed with Vim.
6241 *after-directory*
6242 4. In the "after" directory in the system-wide Vim directory. This is
6243 for the system administrator to overrule or add to the distributed
6244 defaults (rarely needed)
6245 5. In the "after" directory in your home directory. This is for
6246 personal preferences to overrule or add to the distributed defaults
6247 or system-wide settings (rarely needed).
6248
Bram Moolenaard0796902016-09-16 20:02:31 +02006249 More entries are added when using |packages|. If it gets very long
6250 then `:set rtp` will be truncated, use `:echo &rtp` to see the full
6251 string.
Bram Moolenaar26852122016-05-24 20:02:38 +02006252
Bram Moolenaar071d4272004-06-13 20:20:40 +00006253 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
6254 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006255 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00006256 wildcards.
6257 See |:runtime|.
6258 Example: >
6259 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
6260< This will use the directory "~/vimruntime" first (containing your
6261 personal Vim runtime files), then "/mygroup/vim" (shared between a
6262 group of people) and finally "$VIMRUNTIME" (the distributed runtime
6263 files).
6264 You probably should always include $VIMRUNTIME somewhere, to use the
6265 distributed runtime files. You can put a directory before $VIMRUNTIME
6266 to find files which replace a distributed runtime files. You can put
6267 a directory after $VIMRUNTIME to find files which add to distributed
6268 runtime files.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006269 When Vim is started with |--clean| the home directory entries are not
6270 included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006271 This option cannot be set from a |modeline| or in the |sandbox|, for
6272 security reasons.
6273
6274 *'scroll'* *'scr'*
6275'scroll' 'scr' number (default: half the window height)
6276 local to window
6277 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
6278 set to half the number of lines in the window when the window size
6279 changes. If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006280 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar25c9c682019-05-05 18:13:34 +02006281 height with ":set scroll=0".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006282
6283 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
6284'scrollbind' 'scb' boolean (default off)
6285 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006286 See also |scroll-binding|. When this option is set, the current
6287 window scrolls as other scrollbind windows (windows that also have
6288 this option set) scroll. This option is useful for viewing the
6289 differences between two versions of a file, see 'diff'.
6290 See |'scrollopt'| for options that determine how this option should be
6291 interpreted.
6292 This option is mostly reset when splitting a window to edit another
6293 file. This means that ":split | edit file" results in two windows
6294 with scroll-binding, but ":split file" does not.
6295
Bram Moolenaarae20f342019-11-05 21:09:23 +01006296 *'scrollfocus'* *'scf'* *'noscrollfocus'* *'noscf'*
6297'scrollfocus' 'scf' boolean (default off)
6298 global
6299 {only for MS-Windows GUI}
6300 When using the scroll wheel and this option is set, the window under
6301 the mouse pointer is scrolled. With this option off the current
6302 window is scrolled.
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01006303 Systems other than MS-Windows always behave like this option is on.
Bram Moolenaarae20f342019-11-05 21:09:23 +01006304
Bram Moolenaar071d4272004-06-13 20:20:40 +00006305 *'scrolljump'* *'sj'*
6306'scrolljump' 'sj' number (default 1)
6307 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006308 Minimal number of lines to scroll when the cursor gets off the
6309 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
6310 CTRL-D). Useful if your terminal scrolls very slowly.
Bram Moolenaar1e015462005-09-25 22:16:38 +00006311 When set to a negative number from -1 to -100 this is used as the
6312 percentage of the window height. Thus -50 scrolls half the window
6313 height.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006314 NOTE: This option is set to 1 when 'compatible' is set.
6315
6316 *'scrolloff'* *'so'*
Bram Moolenaar50ba5262016-09-22 22:33:02 +02006317'scrolloff' 'so' number (default 0, set to 5 in |defaults.vim|)
Bram Moolenaar375e3392019-01-31 18:26:10 +01006318 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006319 Minimal number of screen lines to keep above and below the cursor.
6320 This will make some context visible around where you are working. If
6321 you set it to a very large value (999) the cursor line will always be
6322 in the middle of the window (except at the start or end of the file or
6323 when long lines wrap).
Bram Moolenaar375e3392019-01-31 18:26:10 +01006324 After using the local value, go back the global value with one of
6325 these two: >
6326 setlocal scrolloff<
6327 setlocal scrolloff=-1
6328< For scrolling horizontally see 'sidescrolloff'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006329 NOTE: This option is set to 0 when 'compatible' is set.
6330
6331 *'scrollopt'* *'sbo'*
6332'scrollopt' 'sbo' string (default "ver,jump")
6333 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006334 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006335 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
6336 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006337 The following words are available:
6338 ver Bind vertical scrolling for 'scrollbind' windows
6339 hor Bind horizontal scrolling for 'scrollbind' windows
6340 jump Applies to the offset between two windows for vertical
6341 scrolling. This offset is the difference in the first
6342 displayed line of the bound windows. When moving
6343 around in a window, another 'scrollbind' window may
6344 reach a position before the start or after the end of
6345 the buffer. The offset is not changed though, when
6346 moving back the 'scrollbind' window will try to scroll
6347 to the desired position when possible.
6348 When now making that window the current one, two
6349 things can be done with the relative offset:
6350 1. When "jump" is not included, the relative offset is
6351 adjusted for the scroll position in the new current
6352 window. When going back to the other window, the
Bram Moolenaar02467872007-05-06 13:22:01 +00006353 new relative offset will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006354 2. When "jump" is included, the other windows are
6355 scrolled to keep the same relative offset. When
6356 going back to the other window, it still uses the
6357 same relative offset.
6358 Also see |scroll-binding|.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006359 When 'diff' mode is active there always is vertical scroll binding,
6360 even when "ver" isn't there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006361
6362 *'sections'* *'sect'*
6363'sections' 'sect' string (default "SHNHH HUnhsh")
6364 global
6365 Specifies the nroff macros that separate sections. These are pairs of
6366 two letters (See |object-motions|). The default makes a section start
6367 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
6368
6369 *'secure'* *'nosecure'* *E523*
6370'secure' boolean (default off)
6371 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006372 When on, ":autocmd", shell and write commands are not allowed in
6373 ".vimrc" and ".exrc" in the current directory and map commands are
6374 displayed. Switch it off only if you know that you will not run into
6375 problems, or when the 'exrc' option is off. On Unix this option is
6376 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006377 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00006378 'secure' at the end of your ~/.vimrc then.
6379 This option cannot be set from a |modeline| or in the |sandbox|, for
6380 security reasons.
6381
6382 *'selection'* *'sel'*
6383'selection' 'sel' string (default "inclusive")
6384 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006385 This option defines the behavior of the selection. It is only used
6386 in Visual and Select mode.
6387 Possible values:
6388 value past line inclusive ~
6389 old no yes
6390 inclusive yes yes
6391 exclusive yes no
6392 "past line" means that the cursor is allowed to be positioned one
6393 character past the line.
6394 "inclusive" means that the last character of the selection is included
6395 in an operation. For example, when "x" is used to delete the
6396 selection.
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02006397 When "old" is used and 'virtualedit' allows the cursor to move past
6398 the end of line the line break still isn't included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006399 Note that when "exclusive" is used and selecting from the end
6400 backwards, you cannot include the last character of a line, when
6401 starting in Normal mode and 'virtualedit' empty.
6402
6403 The 'selection' option is set by the |:behave| command.
6404
6405 *'selectmode'* *'slm'*
6406'selectmode' 'slm' string (default "")
6407 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006408 This is a comma separated list of words, which specifies when to start
6409 Select mode instead of Visual mode, when a selection is started.
6410 Possible values:
6411 mouse when using the mouse
6412 key when using shifted special keys
6413 cmd when using "v", "V" or CTRL-V
6414 See |Select-mode|.
6415 The 'selectmode' option is set by the |:behave| command.
6416
6417 *'sessionoptions'* *'ssop'*
6418'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006419 help,options,tabpages,winsize,terminal")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006420 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02006421 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006422 feature}
6423 Changes the effect of the |:mksession| command. It is a comma
6424 separated list of words. Each word enables saving and restoring
6425 something:
6426 word save and restore ~
6427 blank empty windows
6428 buffers hidden and unloaded buffers, not just those in windows
6429 curdir the current directory
6430 folds manually created folds, opened/closed folds and local
6431 fold options
6432 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00006433 and contain at least one lowercase letter. Only
6434 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006435 help the help window
6436 localoptions options and mappings local to a window or buffer (not
6437 global values for local options)
6438 options all options and mappings (also global values for local
6439 options)
6440 resize size of the Vim window: 'lines' and 'columns'
6441 sesdir the directory in which the session file is located
6442 will become the current directory (useful with
6443 projects accessed over a network from different
6444 systems)
6445 slash backslashes in file names replaced with forward
6446 slashes
Bram Moolenaar18144c82006-04-12 21:52:12 +00006447 tabpages all tab pages; without this only the current tab page
6448 is restored, so that you can make a session for each
6449 tab page separately
Bram Moolenaard473c8c2018-08-11 18:00:22 +02006450 terminal include terminal windows where the command can be
6451 restored
Bram Moolenaar071d4272004-06-13 20:20:40 +00006452 unix with Unix end-of-line format (single <NL>), even when
6453 on Windows or DOS
6454 winpos position of the whole Vim window
6455 winsize window sizes
6456
6457 Don't include both "curdir" and "sesdir".
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006458 When neither "curdir" nor "sesdir" is included, file names are stored
6459 with absolute paths.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006460 "slash" and "unix" are useful on Windows when sharing session files
6461 with Unix. The Unix version of Vim cannot source dos format scripts,
6462 but the Windows version of Vim can source unix format scripts.
6463
6464 *'shell'* *'sh'* *E91*
Bram Moolenaar95a9dd12019-12-19 22:12:03 +01006465'shell' 'sh' string (default $SHELL or "sh", Win32: "cmd.exe")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006466 global
6467 Name of the shell to use for ! and :! commands. When changing the
6468 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
6469 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006470 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006471 See |option-backslash| about including spaces and backslashes.
6472 Environment variables are expanded |:set_env|.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006473
Bram Moolenaar1ff14ba2019-11-02 14:09:23 +01006474 If the name of the shell contains a space, you need to enclose it in
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01006475 quotes and escape the space. Example with quotes: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006476 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
6477< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006478 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006479 "-f" is not inside the quotes, because it is not part of the command
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006480 name. Vim automagically recognizes the backslashes that are path
Bram Moolenaar071d4272004-06-13 20:20:40 +00006481 separators.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006482 Example with escaped space (Vim will do this when initializing the
6483 option from $SHELL): >
6484 :set shell=/bin/with\\\ space/sh
Bram Moolenaard473c8c2018-08-11 18:00:22 +02006485< The resulting value of 'shell' is "/bin/with\ space/sh", two
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006486 backslashes are consumed by `:set`.
6487
Bram Moolenaar071d4272004-06-13 20:20:40 +00006488 Under MS-Windows, when the executable ends in ".com" it must be
6489 included. Thus setting the shell to "command.com" or "4dos.com"
6490 works, but "command" and "4dos" do not work for all commands (e.g.,
6491 filtering).
6492 For unknown reasons, when using "4dos.com" the current directory is
6493 changed to "C:\". To avoid this set 'shell' like this: >
6494 :set shell=command.com\ /c\ 4dos
6495< This option cannot be set from a |modeline| or in the |sandbox|, for
6496 security reasons.
6497
6498 *'shellcmdflag'* *'shcf'*
Bram Moolenaar5dc62522012-02-13 00:05:22 +01006499'shellcmdflag' 'shcf' string (default: "-c";
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006500 Win32, when 'shell' does not contain "sh"
6501 somewhere: "/c")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006502 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006503 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
Bram Moolenaar8024f932020-01-14 19:29:13 +01006504 "bash.exe -c ls" or "cmd.exe /c dir". For MS-Windows, the default is
6505 set according to the value of 'shell', to reduce the need to set this
6506 option by the user.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02006507 On Unix it can have more than one flag. Each white space separated
6508 part is passed as an argument to the shell command.
6509 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006510 Also see |dos-shell| for MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006511 This option cannot be set from a |modeline| or in the |sandbox|, for
6512 security reasons.
6513
6514 *'shellpipe'* *'sp'*
Bram Moolenaar8024f932020-01-14 19:29:13 +01006515'shellpipe' 'sp' string (default ">", ">%s 2>&1", "| tee", "|& tee" or
6516 "2>&1| tee")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006517 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006518 {not available when compiled without the |+quickfix|
6519 feature}
6520 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006521 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00006522 including spaces and backslashes.
6523 The name of the temporary file can be represented by "%s" if necessary
6524 (the file name is appended automatically if no %s appears in the value
6525 of this option).
Bram Moolenaar8024f932020-01-14 19:29:13 +01006526 For the Amiga the default is ">". For MS-Windows the default is
6527 ">%s 2>&1". The output is directly saved in a file and not echoed to
6528 the screen.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006529 For Unix the default it "| tee". The stdout of the compiler is saved
6530 in a file and echoed to the screen. If the 'shell' option is "csh" or
6531 "tcsh" after initializations, the default becomes "|& tee". If the
Bram Moolenaar96f45c02019-10-26 19:53:45 +02006532 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh", "zsh-beta",
6533 "bash" or "fish" the default becomes "2>&1| tee". This means that
6534 stderr is also included. Before using the 'shell' option a path is
6535 removed, thus "/bin/sh" uses "sh".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006536 The initialization of this option is done after reading the ".vimrc"
6537 and the other initializations, so that when the 'shell' option is set
6538 there, the 'shellpipe' option changes automatically, unless it was
6539 explicitly set before.
6540 When 'shellpipe' is set to an empty string, no redirection of the
6541 ":make" output will be done. This is useful if you use a 'makeprg'
6542 that writes to 'makeef' by itself. If you want no piping, but do
6543 want to include the 'makeef', set 'shellpipe' to a single space.
6544 Don't forget to precede the space with a backslash: ":set sp=\ ".
6545 In the future pipes may be used for filtering and this option will
6546 become obsolete (at least for Unix).
6547 This option cannot be set from a |modeline| or in the |sandbox|, for
6548 security reasons.
6549
6550 *'shellquote'* *'shq'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006551'shellquote' 'shq' string (default: ""; Win32, when 'shell'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006552 contains "sh" somewhere: "\"")
6553 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006554 Quoting character(s), put around the command passed to the shell, for
6555 the "!" and ":!" commands. The redirection is kept outside of the
6556 quoting. See 'shellxquote' to include the redirection. It's
6557 probably not useful to set both options.
6558 This is an empty string by default. Only known to be useful for
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006559 third-party shells on MS-Windows-like systems, such as the MKS Korn
6560 Shell or bash, where it should be "\"". The default is adjusted
6561 according the value of 'shell', to reduce the need to set this option
6562 by the user. See |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006563 This option cannot be set from a |modeline| or in the |sandbox|, for
6564 security reasons.
6565
6566 *'shellredir'* *'srr'*
6567'shellredir' 'srr' string (default ">", ">&" or ">%s 2>&1")
6568 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006569 String to be used to put the output of a filter command in a temporary
6570 file. See also |:!|. See |option-backslash| about including spaces
6571 and backslashes.
6572 The name of the temporary file can be represented by "%s" if necessary
6573 (the file name is appended automatically if no %s appears in the value
6574 of this option).
Bram Moolenaar96f45c02019-10-26 19:53:45 +02006575 The default is ">". For Unix, if the 'shell' option is "csh" or
6576 "tcsh" during initializations, the default becomes ">&". If the
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01006577 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh", "zsh-beta",
6578 "bash" or "fish", the default becomes ">%s 2>&1". This means that
6579 stderr is also included. For Win32, the Unix checks are done and
6580 additionally "cmd" is checked for, which makes the default ">%s 2>&1".
6581 Also, the same names with ".exe" appended are checked for.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006582 The initialization of this option is done after reading the ".vimrc"
6583 and the other initializations, so that when the 'shell' option is set
6584 there, the 'shellredir' option changes automatically unless it was
6585 explicitly set before.
6586 In the future pipes may be used for filtering and this option will
6587 become obsolete (at least for Unix).
6588 This option cannot be set from a |modeline| or in the |sandbox|, for
6589 security reasons.
6590
6591 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
6592'shellslash' 'ssl' boolean (default off)
6593 global
Bram Moolenaar6f345a12019-12-17 21:27:18 +01006594 {only for MS-Windows}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006595 When set, a forward slash is used when expanding file names. This is
Bram Moolenaar8024f932020-01-14 19:29:13 +01006596 useful when a Unix-like shell is used instead of cmd.exe. Backward
6597 slashes can still be typed, but they are changed to forward slashes by
6598 Vim.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006599 Note that setting or resetting this option has no effect for some
6600 existing file names, thus this option needs to be set before opening
6601 any file for best results. This might change in the future.
6602 'shellslash' only works when a backslash can be used as a path
6603 separator. To test if this is so use: >
6604 if exists('+shellslash')
Bram Moolenaarac3150d2019-07-28 16:36:39 +02006605< Also see 'completeslash'.
6606
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006607 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
6608'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
6609 global
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006610 When on, use temp files for shell commands. When off use a pipe.
6611 When using a pipe is not possible temp files are used anyway.
Bram Moolenaar97293012011-07-18 19:40:27 +02006612 Currently a pipe is only supported on Unix and MS-Windows 2K and
6613 later. You can check it with: >
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006614 :if has("filterpipe")
6615< The advantage of using a pipe is that nobody can read the temp file
6616 and the 'shell' command does not need to support redirection.
6617 The advantage of using a temp file is that the file type and encoding
6618 can be detected.
6619 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
6620 |FilterWritePost| autocommands event are not triggered when
6621 'shelltemp' is off.
Bram Moolenaar269f5952016-07-15 22:54:41 +02006622 The `system()` function does not respect this option and always uses
6623 temp files.
Bram Moolenaar036986f2017-03-16 17:41:02 +01006624 NOTE: This option is set to the Vim default value when 'compatible'
6625 is reset.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006626
Bram Moolenaar071d4272004-06-13 20:20:40 +00006627 *'shelltype'* *'st'*
6628'shelltype' 'st' number (default 0)
6629 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02006630 {only for the Amiga}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006631 On the Amiga this option influences the way how the commands work
6632 which use a shell.
6633 0 and 1: always use the shell
6634 2 and 3: use the shell only to filter lines
6635 4 and 5: use shell only for ':sh' command
6636 When not using the shell, the command is executed directly.
6637
6638 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
6639 1 and 3: use "shell cmd" to start external commands
6640
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006641 *'shellxescape'* *'sxe'*
6642'shellxescape' 'sxe' string (default: "";
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006643 for MS-Windows: "\"&|<>()@^")
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006644 global
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006645 When 'shellxquote' is set to "(" then the characters listed in this
6646 option will be escaped with a '^' character. This makes it possible
6647 to execute most external commands with cmd.exe.
6648
Bram Moolenaar071d4272004-06-13 20:20:40 +00006649 *'shellxquote'* *'sxq'*
6650'shellxquote' 'sxq' string (default: "";
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006651 for Win32, when 'shell' is cmd.exe: "("
6652 for Win32, when 'shell' contains "sh"
6653 somewhere: "\""
Bram Moolenaar071d4272004-06-13 20:20:40 +00006654 for Unix, when using system(): "\"")
6655 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006656 Quoting character(s), put around the command passed to the shell, for
6657 the "!" and ":!" commands. Includes the redirection. See
6658 'shellquote' to exclude the redirection. It's probably not useful
6659 to set both options.
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006660 When the value is '(' then ')' is appended. When the value is '"('
6661 then ')"' is appended.
6662 When the value is '(' then also see 'shellxescape'.
Bram Moolenaara64ba222012-02-12 23:23:31 +01006663 This is an empty string by default on most systems, but is known to be
6664 useful for on Win32 version, either for cmd.exe which automatically
6665 strips off the first and last quote on a command, or 3rd-party shells
6666 such as the MKS Korn Shell or bash, where it should be "\"". The
6667 default is adjusted according the value of 'shell', to reduce the need
6668 to set this option by the user. See |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006669 This option cannot be set from a |modeline| or in the |sandbox|, for
6670 security reasons.
6671
6672 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
6673'shiftround' 'sr' boolean (default off)
6674 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006675 Round indent to multiple of 'shiftwidth'. Applies to > and <
6676 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
6677 a multiple of 'shiftwidth' (this is Vi compatible).
6678 NOTE: This option is reset when 'compatible' is set.
6679
6680 *'shiftwidth'* *'sw'*
6681'shiftwidth' 'sw' number (default 8)
6682 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006683 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00006684 |'cindent'|, |>>|, |<<|, etc.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02006685 When zero the 'ts' value will be used. Use the |shiftwidth()|
6686 function to get the effective shiftwidth value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006687
6688 *'shortmess'* *'shm'*
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02006689'shortmess' 'shm' string (Vim default "filnxtToOS", Vi default: "S",
6690 POSIX default: "AS")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006691 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006692 This option helps to avoid all the |hit-enter| prompts caused by file
6693 messages, for example with CTRL-G, and to avoid some other messages.
6694 It is a list of flags:
6695 flag meaning when present ~
6696 f use "(3 of 5)" instead of "(file 3 of 5)"
6697 i use "[noeol]" instead of "[Incomplete last line]"
6698 l use "999L, 888C" instead of "999 lines, 888 characters"
6699 m use "[+]" instead of "[Modified]"
6700 n use "[New]" instead of "[New File]"
6701 r use "[RO]" instead of "[readonly]"
6702 w use "[w]" instead of "written" for file write message
6703 and "[a]" instead of "appended" for ':w >> file' command
6704 x use "[dos]" instead of "[dos format]", "[unix]" instead of
6705 "[unix format]" and "[mac]" instead of "[mac format]".
6706 a all of the above abbreviations
6707
6708 o overwrite message for writing a file with subsequent message
6709 for reading a file (useful for ":wn" or when 'autowrite' on)
6710 O message for reading a file overwrites any previous message.
6711 Also for quickfix message (e.g., ":cn").
6712 s don't give "search hit BOTTOM, continuing at TOP" or "search
Bram Moolenaara6c27c42019-05-09 19:16:22 +02006713 hit TOP, continuing at BOTTOM" messages; when using the search
6714 count do not show "W" after the count message (see S below)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006715 t truncate file message at the start if it is too long to fit
6716 on the command-line, "<" will appear in the left most column.
6717 Ignored in Ex mode.
6718 T truncate other messages in the middle if they are too long to
Bram Moolenaar582fd852005-03-28 20:58:01 +00006719 fit on the command line. "..." will appear in the middle.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006720 Ignored in Ex mode.
6721 W don't give "written" or "[w]" when writing a file
6722 A don't give the "ATTENTION" message when an existing swap file
6723 is found.
6724 I don't give the intro message when starting Vim |:intro|.
Bram Moolenaarea389e92014-05-28 21:40:52 +02006725 c don't give |ins-completion-menu| messages. For example,
6726 "-- XXX completion (YYY)", "match 1 of 2", "The only match",
6727 "Pattern not found", "Back at original", etc.
Bram Moolenaar426dd022016-03-15 15:09:29 +01006728 q use "recording" instead of "recording @a"
6729 F don't give the file info when editing a file, like `:silent`
Bram Moolenaar110289e2019-05-23 15:38:06 +02006730 was used for the command; note that this also affects messages
6731 from autocommands
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02006732 S do not show search count message when searching, e.g.
6733 "[1/5]"
Bram Moolenaar071d4272004-06-13 20:20:40 +00006734
6735 This gives you the opportunity to avoid that a change between buffers
6736 requires you to hit <Enter>, but still gives as useful a message as
6737 possible for the space available. To get the whole message that you
6738 would have got with 'shm' empty, use ":file!"
6739 Useful values:
6740 shm= No abbreviation of message.
6741 shm=a Abbreviation, but no loss of information.
6742 shm=at Abbreviation, and truncate message when necessary.
6743
6744 NOTE: This option is set to the Vi default value when 'compatible' is
6745 set and to the Vim default value when 'compatible' is reset.
6746
6747 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
6748'shortname' 'sn' boolean (default off)
6749 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00006750 Filenames are assumed to be 8 characters plus one extension of 3
6751 characters. Multiple dots in file names are not allowed. When this
6752 option is on, dots in file names are replaced with underscores when
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006753 adding an extension (".~" or ".swp"). This option is useful
Bram Moolenaar071d4272004-06-13 20:20:40 +00006754 when editing files on an MS-DOS compatible filesystem, e.g., messydos
6755 or crossdos. When running the Win32 GUI version under Win32s, this
6756 option is always on by default.
6757
6758 *'showbreak'* *'sbr'* *E595*
6759'showbreak' 'sbr' string (default "")
Bram Moolenaaree857022019-11-09 23:26:40 +01006760 global or local to window |global-local|
Bram Moolenaardb84e452010-08-15 13:50:43 +02006761 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006762 feature}
6763 String to put at the start of lines that have been wrapped. Useful
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006764 values are "> " or "+++ ": >
6765 :set showbreak=>\
6766< Note the backslash to escape the trailing space. It's easier like
6767 this: >
Bram Moolenaar1a384422010-07-14 19:53:30 +02006768 :let &showbreak = '+++ '
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006769< Only printable single-cell characters are allowed, excluding <Tab> and
Bram Moolenaar071d4272004-06-13 20:20:40 +00006770 comma (in a future version the comma might be used to separate the
6771 part that is shown at the end and at the start of a line).
6772 The characters are highlighted according to the '@' flag in
6773 'highlight'.
6774 Note that tabs after the showbreak will be displayed differently.
6775 If you want the 'showbreak' to appear in between line numbers, add the
6776 "n" flag to 'cpoptions'.
Bram Moolenaaree857022019-11-09 23:26:40 +01006777 A window-local value overrules a global value. If the global value is
6778 set and you want no value in the current window use NONE: >
6779 :setlocal showbreak=NONE
6780<
Bram Moolenaar071d4272004-06-13 20:20:40 +00006781 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02006782'showcmd' 'sc' boolean (Vim default: on, off for Unix,
6783 Vi default: off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006784 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006785 {not available when compiled without the
6786 |+cmdline_info| feature}
Bram Moolenaar02467872007-05-06 13:22:01 +00006787 Show (partial) command in the last line of the screen. Set this
6788 option off if your terminal is slow.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006789 In Visual mode the size of the selected area is shown:
6790 - When selecting characters within a line, the number of characters.
Bram Moolenaarf91787c2010-07-17 12:47:16 +02006791 If the number of bytes is different it is also displayed: "2-6"
6792 means two characters and six bytes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006793 - When selecting more than one line, the number of lines.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006794 - When selecting a block, the size in screen characters:
6795 {lines}x{columns}.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006796 NOTE: This option is set to the Vi default value when 'compatible' is
6797 set and to the Vim default value when 'compatible' is reset.
6798
6799 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
6800'showfulltag' 'sft' boolean (default off)
6801 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006802 When completing a word in insert mode (see |ins-completion|) from the
6803 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006804 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00006805 matched a C function, you can see a template for what arguments are
6806 required (coding style permitting).
Bram Moolenaar446cb832008-06-24 21:56:24 +00006807 Note that this doesn't work well together with having "longest" in
6808 'completeopt', because the completion from the search pattern may not
6809 match the typed text.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006810
6811 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
6812'showmatch' 'sm' boolean (default off)
6813 global
6814 When a bracket is inserted, briefly jump to the matching one. The
6815 jump is only done if the match can be seen on the screen. The time to
6816 show the match can be set with 'matchtime'.
6817 A Beep is given if there is no match (no matter if the match can be
Bram Moolenaarca635012015-09-25 20:34:21 +02006818 seen or not).
6819 This option is reset when 'paste' is set and restored when 'paste' is
6820 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006821 When the 'm' flag is not included in 'cpoptions', typing a character
6822 will immediately move the cursor back to where it belongs.
6823 See the "sm" field in 'guicursor' for setting the cursor shape and
6824 blinking when showing the match.
6825 The 'matchpairs' option can be used to specify the characters to show
6826 matches for. 'rightleft' and 'revins' are used to look for opposite
6827 matches.
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006828 Also see the matchparen plugin for highlighting the match when moving
6829 around |pi_paren.txt|.
6830 Note: Use of the short form is rated PG.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006831
6832 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
6833'showmode' 'smd' boolean (Vim default: on, Vi default: off)
6834 global
6835 If in Insert, Replace or Visual mode put a message on the last line.
6836 Use the 'M' flag in 'highlight' to set the type of highlighting for
6837 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006838 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00006839 doesn't mean XIM is really active, especially when 'imactivatekey' is
6840 not set.
6841 NOTE: This option is set to the Vi default value when 'compatible' is
6842 set and to the Vim default value when 'compatible' is reset.
6843
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006844 *'showtabline'* *'stal'*
6845'showtabline' 'stal' number (default 1)
6846 global
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006847 The value of this option specifies when the line with tab page labels
6848 will be displayed:
6849 0: never
6850 1: only if there are at least two tab pages
6851 2: always
6852 This is both for the GUI and non-GUI implementation of the tab pages
6853 line.
6854 See |tab-page| for more information about tab pages.
6855
Bram Moolenaar071d4272004-06-13 20:20:40 +00006856 *'sidescroll'* *'ss'*
6857'sidescroll' 'ss' number (default 0)
6858 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006859 The minimal number of columns to scroll horizontally. Used only when
6860 the 'wrap' option is off and the cursor is moved off of the screen.
6861 When it is zero the cursor will be put in the middle of the screen.
6862 When using a slow terminal set it to a large number or 0. When using
6863 a fast terminal use a small number or 1. Not used for "zh" and "zl"
6864 commands.
6865
6866 *'sidescrolloff'* *'siso'*
6867'sidescrolloff' 'siso' number (default 0)
Bram Moolenaar375e3392019-01-31 18:26:10 +01006868 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006869 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00006870 right of the cursor if 'nowrap' is set. Setting this option to a
6871 value greater than 0 while having |'sidescroll'| also at a non-zero
6872 value makes some context visible in the line you are scrolling in
6873 horizontally (except at beginning of the line). Setting this option
6874 to a large value (like 999) has the effect of keeping the cursor
6875 horizontally centered in the window, as long as one does not come too
6876 close to the beginning of the line.
Bram Moolenaar375e3392019-01-31 18:26:10 +01006877 After using the local value, go back the global value with one of
6878 these two: >
6879 setlocal sidescrolloff<
6880 setlocal sidescrolloff=-1
6881< NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006882
6883 Example: Try this together with 'sidescroll' and 'listchars' as
6884 in the following example to never allow the cursor to move
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02006885 onto the "extends" character: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006886
6887 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
6888 :set sidescrolloff=1
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02006889<
6890 *'signcolumn'* *'scl'*
6891'signcolumn' 'scl' string (default "auto")
6892 local to window
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02006893 {not available when compiled without the |+signs|
6894 feature}
Bram Moolenaar09521312016-08-12 22:54:35 +02006895 Whether or not to draw the signcolumn. Valid values are:
6896 "auto" only when there is a sign to display
6897 "no" never
6898 "yes" always
Bram Moolenaar394c5d82019-06-17 21:48:05 +02006899 "number" display signs in the 'number' column. If the number
Bram Moolenaar6c1e1572019-06-22 02:13:00 +02006900 column is not present, then behaves like "auto".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006901
6902
6903 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
6904'smartcase' 'scs' boolean (default off)
6905 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006906 Override the 'ignorecase' option if the search pattern contains upper
6907 case characters. Only used when the search pattern is typed and
6908 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarc8734422012-06-01 22:38:45 +02006909 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00006910 "*" and "#" you can make 'smartcase' used by doing a "/" command,
6911 recalling the search pattern from history and hitting <Enter>.
6912 NOTE: This option is reset when 'compatible' is set.
6913
6914 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
6915'smartindent' 'si' boolean (default off)
6916 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00006917 {not available when compiled without the
6918 |+smartindent| feature}
6919 Do smart autoindenting when starting a new line. Works for C-like
6920 programs, but can also be used for other languages. 'cindent' does
6921 something like this, works better in most cases, but is more strict,
Bram Moolenaar81af9252010-12-10 20:35:50 +01006922 see |C-indenting|. When 'cindent' is on or 'indentexpr' is set,
Bram Moolenaar166af9b2010-11-16 20:34:40 +01006923 setting 'si' has no effect. 'indentexpr' is a more advanced
6924 alternative.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006925 Normally 'autoindent' should also be on when using 'smartindent'.
6926 An indent is automatically inserted:
6927 - After a line ending in '{'.
6928 - After a line starting with a keyword from 'cinwords'.
6929 - Before a line starting with '}' (only with the "O" command).
6930 When typing '}' as the first character in a new line, that line is
6931 given the same indent as the matching '{'.
6932 When typing '#' as the first character in a new line, the indent for
6933 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006934 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00006935 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
6936 When using the ">>" command, lines starting with '#' are not shifted
6937 right.
Bram Moolenaar036986f2017-03-16 17:41:02 +01006938 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02006939 This option is reset when 'paste' is set and restored when 'paste' is
6940 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006941
6942 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
6943'smarttab' 'sta' boolean (default off)
6944 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006945 When on, a <Tab> in front of a line inserts blanks according to
Bram Moolenaar280f1262006-01-30 00:14:18 +00006946 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A
6947 <BS> will delete a 'shiftwidth' worth of space at the start of the
6948 line.
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006949 When off, a <Tab> always inserts blanks according to 'tabstop' or
Bram Moolenaar280f1262006-01-30 00:14:18 +00006950 'softtabstop'. 'shiftwidth' is only used for shifting text left or
6951 right |shift-left-right|.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00006952 What gets inserted (a <Tab> or spaces) depends on the 'expandtab'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006953 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00006954 number of spaces is minimized by using <Tab>s.
Bram Moolenaarca635012015-09-25 20:34:21 +02006955 This option is reset when 'paste' is set and restored when 'paste' is
6956 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006957 NOTE: This option is reset when 'compatible' is set.
6958
6959 *'softtabstop'* *'sts'*
6960'softtabstop' 'sts' number (default 0)
6961 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00006962 Number of spaces that a <Tab> counts for while performing editing
6963 operations, like inserting a <Tab> or using <BS>. It "feels" like
6964 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
6965 used. This is useful to keep the 'ts' setting at its standard value
6966 of 8, while being able to edit like it is set to 'sts'. However,
6967 commands like "x" still work on the actual characters.
6968 When 'sts' is zero, this feature is off.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02006969 When 'sts' is negative, the value of 'shiftwidth' is used.
Bram Moolenaarca635012015-09-25 20:34:21 +02006970 'softtabstop' is set to 0 when the 'paste' option is set and restored
6971 when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006972 See also |ins-expandtab|. When 'expandtab' is not set, the number of
6973 spaces is minimized by using <Tab>s.
6974 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
6975 set.
6976 NOTE: This option is set to 0 when 'compatible' is set.
6977
Bram Moolenaar04958cb2018-06-23 19:23:02 +02006978 If Vim is compiled with the |+vartabs| feature then the value of
6979 'softtabstop' will be ignored if |'varsofttabstop'| is set to
6980 anything other than an empty string.
6981
Bram Moolenaar217ad922005-03-20 22:37:15 +00006982 *'spell'* *'nospell'*
6983'spell' boolean (default off)
6984 local to window
Bram Moolenaar217ad922005-03-20 22:37:15 +00006985 {not available when compiled without the |+syntax|
6986 feature}
6987 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006988 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00006989
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006990 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00006991'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006992 local to buffer
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006993 {not available when compiled without the |+syntax|
6994 feature}
6995 Pattern to locate the end of a sentence. The following word will be
6996 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006997 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006998 When this check is not wanted make this option empty.
6999 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00007000 Be careful with special characters, see |option-backslash| about
7001 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007002 To set this option automatically depending on the language, see
7003 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007004
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007005 *'spellfile'* *'spf'*
7006'spellfile' 'spf' string (default empty)
7007 local to buffer
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007008 {not available when compiled without the |+syntax|
7009 feature}
7010 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00007011 commands. It must end in ".{encoding}.add". You need to include the
7012 path, otherwise the file is placed in the current directory.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007013 *E765*
7014 It may also be a comma separated list of names. A count before the
7015 |zg| and |zw| commands can be used to access each. This allows using
7016 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007017 When a word is added while this option is empty Vim will set it for
Bram Moolenaar910f66f2006-04-05 20:41:53 +00007018 you: Using the first directory in 'runtimepath' that is writable. If
7019 there is no "spell" directory yet it will be created. For the file
7020 name the first language name that appears in 'spelllang' is used,
Bram Moolenaar3b506942005-06-23 22:36:45 +00007021 ignoring the region.
7022 The resulting ".spl" file will be used for spell checking, it does not
7023 have to appear in 'spelllang'.
7024 Normally one file is used for all regions, but you can add the region
7025 name if you want to. However, it will then only be used when
7026 'spellfile' is set to it, for entries in 'spelllang' only files
7027 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00007028 This option cannot be set from a |modeline| or in the |sandbox|, for
7029 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007030
Bram Moolenaar217ad922005-03-20 22:37:15 +00007031 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007032'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00007033 local to buffer
Bram Moolenaar217ad922005-03-20 22:37:15 +00007034 {not available when compiled without the |+syntax|
7035 feature}
Bram Moolenaar3b506942005-06-23 22:36:45 +00007036 A comma separated list of word list names. When the 'spell' option is
7037 on spellchecking will be done for these languages. Example: >
7038 set spelllang=en_us,nl,medical
7039< This means US English, Dutch and medical words are recognized. Words
7040 that are not recognized will be highlighted.
Bram Moolenaar911ead12019-04-21 00:03:35 +02007041 The word list name must consist of alphanumeric characters, a dash or
7042 an underscore. It should not include a comma or dot. Using a dash is
Bram Moolenaar3b506942005-06-23 22:36:45 +00007043 recommended to separate the two letter language name from a
7044 specification. Thus "en-rare" is used for rare English words.
7045 A region name must come last and have the form "_xx", where "xx" is
7046 the two-letter, lower case region name. You can use more than one
7047 region by listing them: "en_us,en_ca" supports both US and Canadian
7048 English, but not words specific for Australia, New Zealand or Great
Bram Moolenaarfa735342016-01-03 22:14:44 +01007049 Britain. (Note: currently en_au and en_nz dictionaries are older than
7050 en_ca, en_gb and en_us).
Bram Moolenaarcc63c642013-11-12 04:44:01 +01007051 If the name "cjk" is included East Asian characters are excluded from
7052 spell checking. This is useful when editing text that also has Asian
7053 words.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007054 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007055 As a special case the name of a .spl file can be given as-is. The
7056 first "_xx" in the name is removed and used as the region name
7057 (_xx is an underscore, two letters and followed by a non-letter).
7058 This is mainly for testing purposes. You must make sure the correct
7059 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007060 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007061 idea to set 'spelllang' after setting 'encoding' to avoid loading the
7062 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00007063 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007064
Bram Moolenaar98692072006-02-04 00:57:42 +00007065 If the |spellfile.vim| plugin is active and you use a language name
7066 for which Vim cannot find the .spl file in 'runtimepath' the plugin
7067 will ask you if you want to download the file.
7068
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007069 After this option has been set successfully, Vim will source the files
7070 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
Bram Moolenaarb730f0c2018-11-25 03:56:26 +01007071 up to the first character that is not an ASCII letter or number and
7072 not a dash. Also see |set-spc-auto|.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007073
7074
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007075 *'spellsuggest'* *'sps'*
7076'spellsuggest' 'sps' string (default "best")
7077 global
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007078 {not available when compiled without the |+syntax|
7079 feature}
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007080 Methods used for spelling suggestions. Both for the |z=| command and
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007081 the |spellsuggest()| function. This is a comma-separated list of
7082 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007083
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007084 best Internal method that works best for English. Finds
7085 changes like "fast" and uses a bit of sound-a-like
7086 scoring to improve the ordering.
7087
7088 double Internal method that uses two methods and mixes the
7089 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007090 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007091 word. That only works when the language specifies
7092 sound folding. Can be slow and doesn't always give
7093 better results.
7094
7095 fast Internal method that only checks for simple changes:
7096 character inserts/deletes/swaps. Works well for
7097 simple typing mistakes.
7098
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007099 {number} The maximum number of suggestions listed for |z=|.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007100 Not used for |spellsuggest()|. The number of
7101 suggestions is never more than the value of 'lines'
7102 minus two.
7103
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007104 file:{filename} Read file {filename}, which must have two columns,
7105 separated by a slash. The first column contains the
7106 bad word, the second column the suggested good word.
7107 Example:
7108 theribal/terrible ~
7109 Use this for common mistakes that do not appear at the
7110 top of the suggestion list with the internal methods.
7111 Lines without a slash are ignored, use this for
7112 comments.
Bram Moolenaarbcb98982014-05-01 14:08:19 +02007113 The word in the second column must be correct,
7114 otherwise it will not be used. Add the word to an
7115 ".add" file if it is currently flagged as a spelling
7116 mistake.
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007117 The file is used for all languages.
7118
7119 expr:{expr} Evaluate expression {expr}. Use a function to avoid
7120 trouble with spaces. |v:val| holds the badly spelled
7121 word. The expression must evaluate to a List of
7122 Lists, each with a suggestion and a score.
7123 Example:
Bram Moolenaar214641f2017-03-05 17:04:09 +01007124 [['the', 33], ['that', 44]] ~
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007125 Set 'verbose' and use |z=| to see the scores that the
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007126 internal methods use. A lower score is better.
7127 This may invoke |spellsuggest()| if you temporarily
7128 set 'spellsuggest' to exclude the "expr:" part.
7129 Errors are silently ignored, unless you set the
7130 'verbose' option to a non-zero value.
7131
7132 Only one of "best", "double" or "fast" may be used. The others may
7133 appear several times in any order. Example: >
7134 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
7135<
7136 This option cannot be set from a |modeline| or in the |sandbox|, for
7137 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007138
7139
Bram Moolenaar071d4272004-06-13 20:20:40 +00007140 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
7141'splitbelow' 'sb' boolean (default off)
7142 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007143 When on, splitting a window will put the new window below the current
7144 one. |:split|
7145
7146 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
7147'splitright' 'spr' boolean (default off)
7148 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007149 When on, splitting a window will put the new window right of the
7150 current one. |:vsplit|
7151
7152 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
7153'startofline' 'sol' boolean (default on)
7154 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007155 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00007156 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007157 (if possible). This applies to the commands: CTRL-D, CTRL-U, CTRL-B,
Bram Moolenaar843ee412004-06-30 16:16:41 +00007158 CTRL-F, "G", "H", "M", "L", gg, and to the commands "d", "<<" and ">>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007159 with a linewise operator, with "%" with a count and to buffer changing
7160 commands (CTRL-^, :bnext, :bNext, etc.). Also for an Ex command that
7161 only has a line number, e.g., ":25" or ":+".
7162 In case of buffer changing commands the cursor is placed at the column
7163 where it was the last time the buffer was edited.
7164 NOTE: This option is set when 'compatible' is set.
7165
Bram Moolenaar00654022011-02-25 14:42:19 +01007166 *'statusline'* *'stl'* *E540* *E542*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007167'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007168 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007169 {not available when compiled without the |+statusline|
7170 feature}
7171 When nonempty, this option determines the content of the status line.
7172 Also see |status-line|.
7173
7174 The option consists of printf style '%' items interspersed with
7175 normal text. Each status line item is of the form:
7176 %-0{minwid}.{maxwid}{item}
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01007177 All fields except the {item} are optional. A single percent sign can
Bram Moolenaar00654022011-02-25 14:42:19 +01007178 be given as "%%". Up to 80 items can be specified. *E541*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007179
Bram Moolenaar238a5642006-02-21 22:12:05 +00007180 When the option starts with "%!" then it is used as an expression,
7181 evaluated and the result is used as the option value. Example: >
7182 :set statusline=%!MyStatusLine()
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02007183< The *g:statusline_winid* variable will be set to the |window-ID| of the
7184 window that the status line belongs to.
7185 The result can contain %{} items that will be evaluated too.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02007186 Note that the "%!" expression is evaluated in the context of the
7187 current window and buffer, while %{} items are evaluated in the
7188 context of the window that the statusline belongs to.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007189
7190 When there is error while evaluating the option then it will be made
7191 empty to avoid further errors. Otherwise screen updating would loop.
7192
Bram Moolenaar071d4272004-06-13 20:20:40 +00007193 Note that the only effect of 'ruler' when this option is set (and
7194 'laststatus' is 2) is controlling the output of |CTRL-G|.
7195
7196 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00007197 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00007198 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007199 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007200 minwid Minimum width of the item, padding as set by '-' & '0'.
7201 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007202 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007203 on the left for text items. Numeric items will be
7204 shifted down to maxwid-2 digits followed by '>'number
7205 where number is the amount of missing digits, much like
7206 an exponential notation.
7207 item A one letter code as described below.
7208
7209 Following is a description of the possible statusline items. The
7210 second character in "item" is the type:
7211 N for number
7212 S for string
7213 F for flags as described below
7214 - not applicable
7215
7216 item meaning ~
Bram Moolenaar02467872007-05-06 13:22:01 +00007217 f S Path to the file in the buffer, as typed or relative to current
7218 directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007219 F S Full path to the file in the buffer.
7220 t S File name (tail) of file in the buffer.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007221 m F Modified flag, text is "[+]"; "[-]" if 'modifiable' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007222 M F Modified flag, text is ",+" or ",-".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007223 r F Readonly flag, text is "[RO]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007224 R F Readonly flag, text is ",RO".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007225 h F Help buffer flag, text is "[help]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007226 H F Help buffer flag, text is ",HLP".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007227 w F Preview window flag, text is "[Preview]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007228 W F Preview window flag, text is ",PRV".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007229 y F Type of file in the buffer, e.g., "[vim]". See 'filetype'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007230 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
Bram Moolenaar7fd73202010-07-25 16:58:46 +02007231 q S "[Quickfix List]", "[Location List]" or empty.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007232 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
7233 being used: "<keymap>"
7234 n N Buffer number.
Bram Moolenaar00654022011-02-25 14:42:19 +01007235 b N Value of character under cursor.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007236 B N As above, in hexadecimal.
7237 o N Byte number in file of byte under cursor, first byte is 1.
7238 Mnemonic: Offset from start of file (with one added)
7239 {not available when compiled without |+byte_offset| feature}
7240 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007241 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007242 l N Line number.
7243 L N Number of lines in buffer.
7244 c N Column number.
7245 v N Virtual column number.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007246 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007247 p N Percentage through file in lines as in |CTRL-G|.
7248 P S Percentage through file of displayed window. This is like the
Bram Moolenaar14b69452013-06-29 23:05:20 +02007249 percentage described for 'ruler'. Always 3 in length, unless
7250 translated.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007251 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00007252 Empty if the argument file count is zero or one.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007253 { NF Evaluate expression between '%{' and '}' and substitute result.
Bram Moolenaar6d150f72018-04-21 20:03:20 +02007254 Note that there is no '%' before the closing '}'. The
7255 expression cannot contain a '}' character, call a function to
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007256 work around that. See |stl-%{| below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007257 ( - Start of item group. Can be used for setting the width and
7258 alignment of a section. Must be followed by %) somewhere.
7259 ) - End of item group. No width fields allowed.
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007260 T N For 'tabline': start of tab page N label. Use %T after the last
7261 label. This information is used for mouse clicks.
7262 X N For 'tabline': start of close tab N label. Use %X after the
7263 label, e.g.: %3Xclose%X. Use %999X for a "close current tab"
7264 mark. This information is used for mouse clicks.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007265 < - Where to truncate line if too long. Default is at the start.
7266 No width fields allowed.
7267 = - Separation point between left and right aligned items.
7268 No width fields allowed.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007269 # - Set highlight group. The name must follow and then a # again.
7270 Thus use %#HLname# for highlight group HLname. The same
7271 highlighting is used, also for the statusline of non-current
7272 windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007273 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00007274 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007275 The difference between User{N} and StatusLine will be applied
7276 to StatusLineNC for the statusline of non-current windows.
7277 The number N must be between 1 and 9. See |hl-User1..9|
7278
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007279 When displaying a flag, Vim removes the leading comma, if any, when
7280 that flag comes right after plaintext. This will make a nice display
7281 when flags are used like in the examples below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007282
Bram Moolenaar582fd852005-03-28 20:58:01 +00007283 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00007284 not set) and a minwid is not set for the group, the whole group will
7285 become empty. This will make a group like the following disappear
7286 completely from the statusline when none of the flags are set. >
7287 :set statusline=...%(\ [%M%R%H]%)...
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02007288< Beware that an expression is evaluated each and every time the status
7289 line is displayed.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007290 *stl-%{* *g:actual_curbuf* *g:actual_curwin*
7291 While evaluationg %{} the current buffer and current window will be
7292 set temporarily to that of the window (and buffer) whose statusline is
7293 currently being drawn. The expression will evaluate in this context.
7294 The variable "g:actual_curbuf" is set to the `bufnr()` number of the
7295 real current buffer and "g:actual_curwin" to the |window-ID| of the
7296 real current window. These values are strings.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007297
Bram Moolenaar30b65812012-07-12 22:01:11 +02007298 The 'statusline' option will be evaluated in the |sandbox| if set from
7299 a modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02007300 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007301
7302 It is not allowed to change text or jump to another window while
7303 evaluating 'statusline' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007304
7305 If the statusline is not updated when you want it (e.g., after setting
7306 a variable that's used in an expression), you can force an update by
7307 setting an option without changing its value. Example: >
7308 :let &ro = &ro
7309
7310< A result of all digits is regarded a number for display purposes.
7311 Otherwise the result is taken as flag text and applied to the rules
7312 described above.
7313
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00007314 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00007315 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
Bram Moolenaarc4da1132017-07-15 19:39:43 +02007316 edit your .vimrc or whatever with "vim --clean" to get it right.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007317
7318 Examples:
7319 Emulate standard status line with 'ruler' set >
7320 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
7321< Similar, but add ASCII value of char under the cursor (like "ga") >
7322 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
7323< Display byte count and byte value, modified flag in red. >
7324 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
7325 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
7326< Display a ,GZ flag if a compressed file is loaded >
7327 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
7328< In the |:autocmd|'s: >
7329 :let b:gzflag = 1
7330< And: >
7331 :unlet b:gzflag
7332< And define this function: >
7333 :function VarExists(var, val)
7334 : if exists(a:var) | return a:val | else | return '' | endif
7335 :endfunction
7336<
7337 *'suffixes'* *'su'*
7338'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
7339 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007340 Files with these suffixes get a lower priority when multiple files
7341 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007342 suffixes. Spaces after the comma are ignored. A dot is also seen as
7343 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007344 separator, precede it with a backslash (see |option-backslash| about
7345 including spaces and backslashes).
7346 See 'wildignore' for completely ignoring files.
7347 The use of |:set+=| and |:set-=| is preferred when adding or removing
7348 suffixes from the list. This avoids problems when a future version
7349 uses another default.
7350
7351 *'suffixesadd'* *'sua'*
7352'suffixesadd' 'sua' string (default "")
7353 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007354 {not available when compiled without the
7355 |+file_in_path| feature}
7356 Comma separated list of suffixes, which are used when searching for a
7357 file for the "gf", "[I", etc. commands. Example: >
7358 :set suffixesadd=.java
7359<
7360 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
7361'swapfile' 'swf' boolean (default on)
7362 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007363 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007364 swapfile is not wanted for a specific buffer. For example, with
7365 confidential information that even root must not be able to access.
7366 Careful: All text will be in memory:
7367 - Don't use this for big files.
7368 - Recovery will be impossible!
7369 A swapfile will only be present when |'updatecount'| is non-zero and
7370 'swapfile' is set.
7371 When 'swapfile' is reset, the swap file for the current buffer is
7372 immediately deleted. When 'swapfile' is set, and 'updatecount' is
7373 non-zero, a swap file is immediately created.
7374 Also see |swap-file| and |'swapsync'|.
Bram Moolenaar76f3b1a2014-03-27 22:30:07 +01007375 If you want to open a new buffer without creating a swap file for it,
7376 use the |:noswapfile| modifier.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01007377 See 'directory' for where the swap file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007378
7379 This option is used together with 'bufhidden' and 'buftype' to
7380 specify special kinds of buffers. See |special-buffers|.
7381
7382 *'swapsync'* *'sws'*
7383'swapsync' 'sws' string (default "fsync")
7384 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007385 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007386 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007387 When this option is empty parts of the swap file may be in memory and
7388 not written to disk. When the system crashes you may lose more work.
7389 On Unix the system does a sync now and then without Vim asking for it,
7390 so the disadvantage of setting this option off is small. On some
7391 systems the swap file will not be written at all. For a unix system
7392 setting it to "sync" will use the sync() call instead of the default
7393 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007394 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007395
7396 *'switchbuf'* *'swb'*
7397'switchbuf' 'swb' string (default "")
7398 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007399 This option controls the behavior when switching between buffers.
7400 Possible values (comma separated list):
7401 useopen If included, jump to the first open window that
7402 contains the specified buffer (if there is one).
7403 Otherwise: Do not examine other windows.
7404 This setting is checked with |quickfix| commands, when
7405 jumping to errors (":cc", ":cn", "cp", etc.). It is
7406 also used in all buffer related split commands, for
7407 example ":sbuffer", ":sbnext", or ":sbrewind".
Bram Moolenaar779b74b2006-04-10 14:55:34 +00007408 usetab Like "useopen", but also consider windows in other tab
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00007409 pages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007410 split If included, split the current window before loading
Bram Moolenaar15146672011-10-20 22:22:38 +02007411 a buffer for a |quickfix| command that display errors.
Bram Moolenaar63b74a82019-03-24 15:09:13 +01007412 Otherwise: do not split, use current window (when used
7413 in the quickfix window: the previously used window or
7414 split if there is no other window).
Bram Moolenaara594d772015-06-19 14:41:49 +02007415 vsplit Just like "split" but split vertically.
Bram Moolenaar446cb832008-06-24 21:56:24 +00007416 newtab Like "split", but open a new tab page. Overrules
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02007417 "split" when both are present.
Bram Moolenaar539aa6b2019-11-17 18:09:38 +01007418 uselast If included, jump to the previously used window when
7419 jumping to errors with |quickfix| commands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007420
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007421 *'synmaxcol'* *'smc'*
7422'synmaxcol' 'smc' number (default 3000)
7423 local to buffer
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007424 {not available when compiled without the |+syntax|
7425 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007426 Maximum column in which to search for syntax items. In long lines the
7427 text after this column is not highlighted and following lines may not
7428 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007429 This helps to avoid very slow redrawing for an XML file that is one
7430 long line.
7431 Set to zero to remove the limit.
7432
Bram Moolenaar071d4272004-06-13 20:20:40 +00007433 *'syntax'* *'syn'*
7434'syntax' 'syn' string (default empty)
7435 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007436 {not available when compiled without the |+syntax|
7437 feature}
7438 When this option is set, the syntax with this name is loaded, unless
7439 syntax highlighting has been switched off with ":syntax off".
7440 Otherwise this option does not always reflect the current syntax (the
7441 b:current_syntax variable does).
7442 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007443 not automatically recognized. Example, in an IDL file:
7444 /* vim: set syntax=idl : */ ~
7445 When a dot appears in the value then this separates two filetype
7446 names. Example:
7447 /* vim: set syntax=c.doxygen : */ ~
7448 This will use the "c" syntax first, then the "doxygen" syntax.
7449 Note that the second one must be prepared to be loaded as an addition,
7450 otherwise it will be skipped. More than one dot may appear.
7451 To switch off syntax highlighting for the current file, use: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007452 :set syntax=OFF
7453< To switch syntax highlighting on according to the current value of the
7454 'filetype' option: >
7455 :set syntax=ON
7456< What actually happens when setting the 'syntax' option is that the
7457 Syntax autocommand event is triggered with the value as argument.
7458 This option is not copied to another buffer, independent of the 's' or
7459 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007460 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007461
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007462 *'tabline'* *'tal'*
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007463'tabline' 'tal' string (default empty)
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007464 global
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007465 When nonempty, this option determines the content of the tab pages
7466 line at the top of the Vim window. When empty Vim will use a default
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007467 tab pages line. See |setting-tabline| for more info.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007468
7469 The tab pages line only appears as specified with the 'showtabline'
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00007470 option and only when there is no GUI tab line. When 'e' is in
7471 'guioptions' and the GUI supports a tab line 'guitablabel' is used
Bram Moolenaar7f036442010-08-15 15:24:20 +02007472 instead. Note that the two tab pages lines are very different.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007473
7474 The value is evaluated like with 'statusline'. You can use
7475 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007476 the text to be displayed. Use "%1T" for the first label, "%2T" for
7477 the second one, etc. Use "%X" items for closing labels.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007478
Bram Moolenaare12bab32019-01-08 22:02:56 +01007479 When changing something that is used in 'tabline' that does not
7480 trigger it to be updated, use |:redrawtabline|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02007481 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaare12bab32019-01-08 22:02:56 +01007482
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007483 Keep in mind that only one of the tab pages is the current one, others
7484 are invisible and you can't jump to their windows.
7485
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007486
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007487 *'tabpagemax'* *'tpm'*
7488'tabpagemax' 'tpm' number (default 10)
7489 global
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007490 Maximum number of tab pages to be opened by the |-p| command line
7491 argument or the ":tab all" command. |tabpage|
7492
7493
7494 *'tabstop'* *'ts'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007495'tabstop' 'ts' number (default 8)
7496 local to buffer
7497 Number of spaces that a <Tab> in the file counts for. Also see
7498 |:retab| command, and 'softtabstop' option.
7499
7500 Note: Setting 'tabstop' to any other value than 8 can make your file
7501 appear wrong in many places (e.g., when printing it).
7502
7503 There are four main ways to use tabs in Vim:
7504 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
7505 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007506 will use a mix of tabs and spaces, but typing <Tab> and <BS> will
Bram Moolenaar071d4272004-06-13 20:20:40 +00007507 behave like a tab appears every 4 (or 3) characters.
7508 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
7509 'expandtab'. This way you will always insert spaces. The
7510 formatting will never be messed up when 'tabstop' is changed.
7511 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007512 |modeline| to set these values when editing the file again. Only
Bram Moolenaar071d4272004-06-13 20:20:40 +00007513 works when using Vim to edit the file.
7514 4. Always set 'tabstop' and 'shiftwidth' to the same value, and
7515 'noexpandtab'. This should then work (for initial indents only)
7516 for any tabstop setting that people use. It might be nice to have
7517 tabs after the first non-blank inserted as spaces if you do this
7518 though. Otherwise aligned comments will be wrong when 'tabstop' is
7519 changed.
7520
Bram Moolenaar04958cb2018-06-23 19:23:02 +02007521 If Vim is compiled with the |+vartabs| feature then the value of
7522 'tabstop' will be ignored if |'vartabstop'| is set to anything other
7523 than an empty string.
7524
Bram Moolenaar071d4272004-06-13 20:20:40 +00007525 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
7526'tagbsearch' 'tbs' boolean (default on)
7527 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007528 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007529 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00007530 searching makes searching for a tag a LOT faster, but a linear search
7531 will find more tags if the tags file wasn't properly sorted.
7532 Vim normally assumes that your tags files are sorted, or indicate that
7533 they are not sorted. Only when this is not the case does the
7534 'tagbsearch' option need to be switched off.
7535
7536 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007537 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00007538 certain files, or retry all files with a linear search. When
7539 'tagbsearch' is off, only a linear search is done.
7540
7541 Linear searching is done anyway, for one file, when Vim finds a line
7542 at the start of the file indicating that it's not sorted: >
Bram Moolenaar446cb832008-06-24 21:56:24 +00007543 !_TAG_FILE_SORTED 0 /some comment/
Bram Moolenaar071d4272004-06-13 20:20:40 +00007544< [The whitespace before and after the '0' must be a single <Tab>]
7545
7546 When a binary search was done and no match was found in any of the
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007547 files listed in 'tags', and case is ignored or a pattern is used
Bram Moolenaar071d4272004-06-13 20:20:40 +00007548 instead of a normal tag name, a retry is done with a linear search.
7549 Tags in unsorted tags files, and matches with different case will only
7550 be found in the retry.
7551
Bram Moolenaard4755bb2004-09-02 19:12:26 +00007552 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007553 linear search can be avoided when case is ignored. Use a value of '2'
7554 in the "!_TAG_FILE_SORTED" line for this. A tag file can be case-fold
7555 sorted with the -f switch to "sort" in most unices, as in the command:
7556 "sort -f -o tags tags". For "Exuberant ctags" version 5.x or higher
7557 (at least 5.5) the --sort=foldcase switch can be used for this as
7558 well. Note that case must be folded to uppercase for this to work.
7559
7560 By default, tag searches are case-sensitive. Case is ignored when
7561 'ignorecase' is set and 'tagcase' is "followic", or when 'tagcase' is
7562 "ignore".
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007563 Also when 'tagcase' is "followscs" and 'smartcase' is set, or
7564 'tagcase' is "smart", and the pattern contains only lowercase
7565 characters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007566
7567 When 'tagbsearch' is off, tags searching is slower when a full match
7568 exists, but faster when no full match exists. Tags in unsorted tags
7569 files may only be found with 'tagbsearch' off.
7570 When the tags file is not sorted, or sorted in a wrong way (not on
7571 ASCII byte value), 'tagbsearch' should be off, or the line given above
7572 must be included in the tags file.
7573 This option doesn't affect commands that find all matching tags (e.g.,
7574 command-line completion and ":help").
Bram Moolenaar071d4272004-06-13 20:20:40 +00007575
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007576 *'tagcase'* *'tc'*
7577'tagcase' 'tc' string (default "followic")
7578 global or local to buffer |global-local|
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007579 This option specifies how case is handled when searching the tags
7580 file:
7581 followic Follow the 'ignorecase' option
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007582 followscs Follow the 'smartcase' and 'ignorecase' options
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007583 ignore Ignore case
7584 match Match case
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007585 smart Ignore case unless an upper case letter is used
Bram Moolenaar036986f2017-03-16 17:41:02 +01007586 NOTE: This option is set to the Vi default value when 'compatible' is
7587 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007588
Bram Moolenaar45e18cb2019-04-28 18:05:35 +02007589 *'tagfunc'* *'tfu'*
7590'tagfunc' 'tfu' string (default: empty)
7591 local to buffer
7592 {not available when compiled without the |+eval|
7593 feature}
7594 This option specifies a function to be used to perform tag searches.
7595 The function gets the tag pattern and should return a List of matching
7596 tags. See |tag-function| for an explanation of how to write the
7597 function and an example.
7598
Bram Moolenaar071d4272004-06-13 20:20:40 +00007599 *'taglength'* *'tl'*
7600'taglength' 'tl' number (default 0)
7601 global
7602 If non-zero, tags are significant up to this number of characters.
7603
7604 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
7605'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
7606 global
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00007607 If on and using a tags file in another directory, file names in that
7608 tags file are relative to the directory where the tags file is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007609 NOTE: This option is set to the Vi default value when 'compatible' is
7610 set and to the Vim default value when 'compatible' is reset.
7611
7612 *'tags'* *'tag'* *E433*
7613'tags' 'tag' string (default "./tags,tags", when compiled with
7614 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
7615 global or local to buffer |global-local|
7616 Filenames for the tag command, separated by spaces or commas. To
7617 include a space or comma in a file name, precede it with a backslash
7618 (see |option-backslash| about including spaces and backslashes).
7619 When a file name starts with "./", the '.' is replaced with the path
7620 of the current file. But only when the 'd' flag is not included in
7621 'cpoptions'. Environment variables are expanded |:set_env|. Also see
7622 |tags-option|.
7623 "*", "**" and other wildcards can be used to search for tags files in
Bram Moolenaare2b590e2010-08-08 18:29:48 +02007624 a directory tree. See |file-searching|. E.g., "/lib/**/tags" will
7625 find all files named "tags" below "/lib". The filename itself cannot
7626 contain wildcards, it is used as-is. E.g., "/lib/**/tags?" will find
7627 files called "tags?". {not available when compiled without the
7628 |+path_extra| feature}
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00007629 The |tagfiles()| function can be used to get a list of the file names
7630 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007631 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
7632 files are also supported. They are automatically recognized. The
7633 default value becomes "./tags,./TAGS,tags,TAGS", unless case
7634 differences are ignored (MS-Windows). |emacs-tags|
7635 The use of |:set+=| and |:set-=| is preferred when adding or removing
7636 file names from the list. This avoids problems when a future version
7637 uses another default.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007638
7639 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
7640'tagstack' 'tgst' boolean (default on)
7641 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007642 When on, the |tagstack| is used normally. When off, a ":tag" or
7643 ":tselect" command with an argument will not push the tag onto the
7644 tagstack. A following ":tag" without an argument, a ":pop" command or
7645 any other command that uses the tagstack will use the unmodified
7646 tagstack, but does change the pointer to the active entry.
7647 Resetting this option is useful when using a ":tag" command in a
7648 mapping which should not change the tagstack.
7649
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007650 *'tcldll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01007651'tcldll' string (default depends on the build)
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007652 global
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007653 {only available when compiled with the |+tcl/dyn|
7654 feature}
7655 Specifies the name of the Tcl shared library. The default is
7656 DYNAMIC_TCL_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02007657 Environment variables are expanded |:set_env|.
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007658 This option cannot be set from a |modeline| or in the |sandbox|, for
7659 security reasons.
7660
Bram Moolenaar071d4272004-06-13 20:20:40 +00007661 *'term'* *E529* *E530* *E531*
7662'term' string (default is $TERM, if that fails:
7663 in the GUI: "builtin_gui"
7664 on Amiga: "amiga"
7665 on BeOS: "beos-ansi"
7666 on Mac: "mac-ansi"
7667 on MiNT: "vt52"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007668 on Unix: "ansi"
7669 on VMS: "ansi"
7670 on Win 32: "win32")
7671 global
7672 Name of the terminal. Used for choosing the terminal control
7673 characters. Environment variables are expanded |:set_env|.
7674 For example: >
7675 :set term=$TERM
7676< See |termcap|.
7677
7678 *'termbidi'* *'tbidi'*
7679 *'notermbidi'* *'notbidi'*
7680'termbidi' 'tbidi' boolean (default off, on for "mlterm")
7681 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007682 {only available when compiled with the |+arabic|
7683 feature}
7684 The terminal is in charge of Bi-directionality of text (as specified
7685 by Unicode). The terminal is also expected to do the required shaping
7686 that some languages (such as Arabic) require.
7687 Setting this option implies that 'rightleft' will not be set when
7688 'arabic' is set and the value of 'arabicshape' will be ignored.
7689 Note that setting 'termbidi' has the immediate effect that
7690 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
7691 This option is reset when the GUI is started.
7692 For further details see |arabic.txt|.
7693
7694 *'termencoding'* *'tenc'*
Bram Moolenaar3df01732017-02-17 22:47:16 +01007695'termencoding' 'tenc' string (default ""; with GTK+ GUI: "utf-8"; with
Bram Moolenaar071d4272004-06-13 20:20:40 +00007696 Macintosh GUI: "macroman")
7697 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007698 Encoding used for the terminal. This specifies what character
7699 encoding the keyboard produces and the display will understand. For
Bram Moolenaar3848e002016-03-19 18:42:29 +01007700 the GUI it only applies to the keyboard ('encoding' is used for the
Bram Moolenaar02467872007-05-06 13:22:01 +00007701 display). Except for the Mac when 'macatsui' is off, then
7702 'termencoding' should be "macroman".
Bram Moolenaar4b7cdca2020-01-01 16:18:38 +01007703 *E617* *E950*
Bram Moolenaar3df01732017-02-17 22:47:16 +01007704 Note: This does not apply to the GTK+ GUI. After the GUI has been
Bram Moolenaar071d4272004-06-13 20:20:40 +00007705 successfully initialized, 'termencoding' is forcibly set to "utf-8".
7706 Any attempts to set a different value will be rejected, and an error
7707 message is shown.
Bram Moolenaarac360bf2015-09-01 20:31:20 +02007708 For the Win32 GUI and console versions 'termencoding' is not used,
Bram Moolenaar071d4272004-06-13 20:20:40 +00007709 because the Win32 system always passes Unicode characters.
7710 When empty, the same encoding is used as for the 'encoding' option.
7711 This is the normal value.
7712 Not all combinations for 'termencoding' and 'encoding' are valid. See
7713 |encoding-table|.
7714 The value for this option must be supported by internal conversions or
7715 iconv(). When this is not possible no conversion will be done and you
7716 will probably experience problems with non-ASCII characters.
7717 Example: You are working with the locale set to euc-jp (Japanese) and
7718 want to edit a UTF-8 file: >
7719 :let &termencoding = &encoding
7720 :set encoding=utf-8
7721< You need to do this when your system has no locale support for UTF-8.
7722
Bram Moolenaarcafafb32018-02-22 21:07:09 +01007723 *'termguicolors'* *'tgc'* *E954*
Bram Moolenaar61be73b2016-04-29 22:59:22 +02007724'termguicolors' 'tgc' boolean (default off)
7725 global
Bram Moolenaar61be73b2016-04-29 22:59:22 +02007726 {not available when compiled without the
7727 |+termguicolors| feature}
7728 When on, uses |highlight-guifg| and |highlight-guibg| attributes in
Bram Moolenaarcafafb32018-02-22 21:07:09 +01007729 the terminal (thus using 24-bit color).
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01007730
Bram Moolenaarcafafb32018-02-22 21:07:09 +01007731 Requires a ISO-8613-3 compatible terminal. If setting this option
7732 does not work (produces a colorless UI) reading |xterm-true-color|
7733 might help.
7734
7735 For Win32 console, Windows 10 version 1703 (Creators Update) or later
7736 is required. Use this check to find out: >
7737 if has('vcon')
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01007738< This requires Vim to be built with the |+vtp| feature.
7739
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +02007740 Note that the "cterm" attributes are still used, not the "gui" ones.
Bram Moolenaar036986f2017-03-16 17:41:02 +01007741 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar61be73b2016-04-29 22:59:22 +02007742
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02007743 *'termwinkey'* *'twk'*
7744'termwinkey' 'twk' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02007745 local to window
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007746 The key that starts a CTRL-W command in a terminal window. Other keys
Bram Moolenaar74675a62017-07-15 13:53:23 +02007747 are sent to the job running in the window.
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007748 The <> notation can be used, e.g.: >
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02007749 :set termwinkey=<C-L>
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007750< The string must be one key stroke but can be multiple bytes.
7751 When not set CTRL-W is used, so that CTRL-W : gets you to the command
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02007752 line. If 'termwinkey' is set to CTRL-L then CTRL-L : gets you to the
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007753 command line.
Bram Moolenaar74675a62017-07-15 13:53:23 +02007754
Bram Moolenaar6c60f472019-04-28 16:00:35 +02007755 *'termwinscroll'* *'twsl'*
7756'termwinscroll' 'twsl' number (default 10000)
7757 local to buffer
7758 {not available when compiled without the
7759 |+terminal| feature}
7760 Number of scrollback lines to keep. When going over this limit the
7761 first 10% of the scrollback lines are deleted. This is just to reduce
7762 the memory usage. See |Terminal-Normal|.
7763
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02007764 *'termwinsize'* *'tws'*
7765'termwinsize' 'tws' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02007766 local to window
Bram Moolenaar498c2562018-04-15 23:45:15 +02007767 Size of the |terminal| window. Format: {rows}x{columns} or
7768 {rows}*{columns}.
Bram Moolenaar74675a62017-07-15 13:53:23 +02007769 - When empty the terminal gets the size from the window.
Bram Moolenaar498c2562018-04-15 23:45:15 +02007770 - When set with a "x" (e.g., "24x80") the terminal size is not
7771 adjusted to the window size. If the window is smaller only the
7772 top-left part is displayed.
7773 - When set with a "*" (e.g., "10*50") the terminal size follows the
7774 window size, but will not be smaller than the specified rows and/or
7775 columns.
7776 - When rows is zero then use the height of the window.
7777 - When columns is zero then use the width of the window.
7778 - Using "0x0" or "0*0" is the same as empty.
7779
7780 Examples:
7781 "30x0" uses 30 rows and the current window width.
7782 "20*0" uses at least 20 rows and the current window width.
7783 "0*40" uses the current window height and at least 40 columns.
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02007784 Note that the command running in the terminal window may still change
7785 the size of the terminal. In that case the Vim window will be
7786 adjusted to that size, if possible.
Bram Moolenaar74675a62017-07-15 13:53:23 +02007787
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01007788 *'termwintype'* *'twt'*
7789'termwintype' 'twt' string (default "")
7790 global
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01007791 {only available when compiled with the |terminal|
7792 feature on MS-Windows}
7793 Specify the virtual console (pty) used when opening the terminal
7794 window.
7795
7796 Possible values are:
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01007797 "" use ConPTY if it is stable, winpty otherwise
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01007798 "winpty" use winpty, fail if not supported
7799 "conpty" use |ConPTY|, fail if not supported
7800
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01007801 |ConPTY| support depends on the platform. Windows 10 October 2018
7802 Update is the first version that supports ConPTY, however it is still
7803 considered unstable. ConPTY might become stable in the next release
7804 of Windows 10. winpty support needs to be installed. If neither is
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01007805 supported then you cannot open a terminal window.
7806
Bram Moolenaar071d4272004-06-13 20:20:40 +00007807 *'terse'* *'noterse'*
7808'terse' boolean (default off)
7809 global
7810 When set: Add 's' flag to 'shortmess' option (this makes the message
7811 for a search that hits the start or end of the file not being
7812 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
7813 shortens a lot of messages}
7814
7815 *'textauto'* *'ta'* *'notextauto'* *'nota'*
7816'textauto' 'ta' boolean (Vim default: on, Vi default: off)
7817 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007818 This option is obsolete. Use 'fileformats'.
7819 For backwards compatibility, when 'textauto' is set, 'fileformats' is
7820 set to the default value for the current system. When 'textauto' is
7821 reset, 'fileformats' is made empty.
7822 NOTE: This option is set to the Vi default value when 'compatible' is
7823 set and to the Vim default value when 'compatible' is reset.
7824
7825 *'textmode'* *'tx'* *'notextmode'* *'notx'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01007826'textmode' 'tx' boolean (Win32: default on,
Bram Moolenaar071d4272004-06-13 20:20:40 +00007827 others: default off)
7828 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007829 This option is obsolete. Use 'fileformat'.
7830 For backwards compatibility, when 'textmode' is set, 'fileformat' is
7831 set to "dos". When 'textmode' is reset, 'fileformat' is set to
7832 "unix".
7833
7834 *'textwidth'* *'tw'*
7835'textwidth' 'tw' number (default 0)
7836 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007837 Maximum width of text that is being inserted. A longer line will be
7838 broken after white space to get this width. A zero value disables
Bram Moolenaarca635012015-09-25 20:34:21 +02007839 this.
7840 'textwidth' is set to 0 when the 'paste' option is set and restored
7841 when 'paste' is reset.
7842 When 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00007843 'formatoptions' and |ins-textwidth|.
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00007844 When 'formatexpr' is set it will be used to break the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007845 NOTE: This option is set to 0 when 'compatible' is set.
7846
7847 *'thesaurus'* *'tsr'*
7848'thesaurus' 'tsr' string (default "")
7849 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007850 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01007851 for thesaurus completion commands |i_CTRL-X_CTRL-T|.
7852
7853 Each line in the file should contain words with similar meaning,
7854 separated by non-keyword characters (white space is preferred).
7855 Maximum line length is 510 bytes.
7856
Bram Moolenaard47d5222018-12-09 20:43:55 +01007857 An English word list was added to this github issue:
7858 https://github.com/vim/vim/issues/629#issuecomment-443293282
7859 Unpack thesaurus_pkg.zip, put the thesaurus.txt file somewhere, e.g.
7860 ~/.vim/thesaurus/english.txt, and the 'thesaurus' option to this file
7861 name.
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01007862
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007863 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00007864 after a comma are ignored, otherwise spaces are included in the file
7865 name. See |option-backslash| about using backslashes.
7866 The use of |:set+=| and |:set-=| is preferred when adding or removing
7867 directories from the list. This avoids problems when a future version
7868 uses another default.
7869 Backticks cannot be used in this option for security reasons.
7870
7871 *'tildeop'* *'top'* *'notildeop'* *'notop'*
7872'tildeop' 'top' boolean (default off)
7873 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007874 When on: The tilde command "~" behaves like an operator.
7875 NOTE: This option is reset when 'compatible' is set.
7876
7877 *'timeout'* *'to'* *'notimeout'* *'noto'*
7878'timeout' 'to' boolean (default on)
7879 global
7880 *'ttimeout'* *'nottimeout'*
Bram Moolenaar94237492017-04-23 18:40:21 +02007881'ttimeout' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007882 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007883 These two options together determine the behavior when part of a
7884 mapped key sequence or keyboard code has been received:
7885
7886 'timeout' 'ttimeout' action ~
7887 off off do not time out
7888 on on or off time out on :mappings and key codes
7889 off on time out on key codes
7890
7891 If both options are off, Vim will wait until either the complete
7892 mapping or key sequence has been received, or it is clear that there
7893 is no mapping or key sequence for the received characters. For
7894 example: if you have mapped "vl" and Vim has received 'v', the next
7895 character is needed to see if the 'v' is followed by an 'l'.
7896 When one of the options is on, Vim will wait for about 1 second for
7897 the next character to arrive. After that the already received
7898 characters are interpreted as single characters. The waiting time can
7899 be changed with the 'timeoutlen' option.
7900 On slow terminals or very busy systems timing out may cause
7901 malfunctioning cursor keys. If both options are off, Vim waits
7902 forever after an entered <Esc> if there are key codes that start
7903 with <Esc>. You will have to type <Esc> twice. If you do not have
7904 problems with key codes, but would like to have :mapped key
7905 sequences not timing out in 1 second, set the 'ttimeout' option and
7906 reset the 'timeout' option.
7907
7908 NOTE: 'ttimeout' is reset when 'compatible' is set.
7909
7910 *'timeoutlen'* *'tm'*
7911'timeoutlen' 'tm' number (default 1000)
7912 global
Bram Moolenaar25c9c682019-05-05 18:13:34 +02007913
Bram Moolenaar071d4272004-06-13 20:20:40 +00007914 *'ttimeoutlen'* *'ttm'*
Bram Moolenaar94237492017-04-23 18:40:21 +02007915'ttimeoutlen' 'ttm' number (default -1, set to 100 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007916 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007917 The time in milliseconds that is waited for a key code or mapped key
7918 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
7919 when part of a command has been typed.
7920 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
7921 different timeout value for key codes is desired set 'ttimeoutlen' to
7922 a non-negative number.
7923
7924 ttimeoutlen mapping delay key code delay ~
7925 < 0 'timeoutlen' 'timeoutlen'
7926 >= 0 'timeoutlen' 'ttimeoutlen'
7927
7928 The timeout only happens when the 'timeout' and 'ttimeout' options
7929 tell so. A useful setting would be >
7930 :set timeout timeoutlen=3000 ttimeoutlen=100
7931< (time out on mapping after three seconds, time out on key codes after
7932 a tenth of a second).
7933
7934 *'title'* *'notitle'*
7935'title' boolean (default off, on when title can be restored)
7936 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007937 {not available when compiled without the |+title|
7938 feature}
7939 When on, the title of the window will be set to the value of
7940 'titlestring' (if it is not empty), or to:
7941 filename [+=-] (path) - VIM
7942 Where:
7943 filename the name of the file being edited
7944 - indicates the file cannot be modified, 'ma' off
7945 + indicates the file was modified
7946 = indicates the file is read-only
7947 =+ indicates the file is read-only and modified
7948 (path) is the path of the file being edited
7949 - VIM the server name |v:servername| or "VIM"
7950 Only works if the terminal supports setting window titles
7951 (currently Amiga console, Win32 console, all GUI versions and
7952 terminals with a non- empty 't_ts' option - these are Unix xterm and
7953 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
7954 *X11*
7955 When Vim was compiled with HAVE_X11 defined, the original title will
7956 be restored if possible. The output of ":version" will include "+X11"
7957 when HAVE_X11 was defined, otherwise it will be "-X11". This also
7958 works for the icon name |'icon'|.
7959 But: When Vim was started with the |-X| argument, restoring the title
7960 will not work (except in the GUI).
7961 If the title cannot be restored, it is set to the value of 'titleold'.
7962 You might want to restore the title outside of Vim then.
7963 When using an xterm from a remote machine you can use this command:
7964 rsh machine_name xterm -display $DISPLAY &
7965 then the WINDOWID environment variable should be inherited and the
7966 title of the window should change back to what it should be after
7967 exiting Vim.
7968
7969 *'titlelen'*
7970'titlelen' number (default 85)
7971 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007972 {not available when compiled without the |+title|
7973 feature}
7974 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007975 title. When the title is longer, only the end of the path name is
7976 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007977 Using a percentage makes this adapt to the width of the window. But
7978 it won't work perfectly, because the actual number of characters
7979 available also depends on the font used and other things in the title
7980 bar. When 'titlelen' is zero the full path is used. Otherwise,
7981 values from 1 to 30000 percent can be used.
7982 'titlelen' is also used for the 'titlestring' option.
7983
7984 *'titleold'*
7985'titleold' string (default "Thanks for flying Vim")
7986 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007987 {only available when compiled with the |+title|
7988 feature}
7989 This option will be used for the window title when exiting Vim if the
7990 original title cannot be restored. Only happens if 'title' is on or
7991 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007992 This option cannot be set from a |modeline| or in the |sandbox|, for
7993 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007994 *'titlestring'*
7995'titlestring' string (default "")
7996 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007997 {not available when compiled without the |+title|
7998 feature}
7999 When this option is not empty, it will be used for the title of the
8000 window. This happens only when the 'title' option is on.
8001 Only works if the terminal supports setting window titles (currently
8002 Amiga console, Win32 console, all GUI versions and terminals with a
8003 non-empty 't_ts' option).
8004 When Vim was compiled with HAVE_X11 defined, the original title will
Bram Moolenaar51628222016-12-01 23:03:28 +01008005 be restored if possible, see |X11|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008006
Bram Moolenaar071d4272004-06-13 20:20:40 +00008007 When this option contains printf-style '%' items, they will be
8008 expanded according to the rules used for 'statusline'.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008009 This option cannot be set in a modeline when 'modelineexpr' is off.
8010
Bram Moolenaar071d4272004-06-13 20:20:40 +00008011 Example: >
8012 :auto BufEnter * let &titlestring = hostname() . "/" . expand("%:p")
8013 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
8014< The value of 'titlelen' is used to align items in the middle or right
8015 of the available space.
8016 Some people prefer to have the file name first: >
8017 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
8018< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008019 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00008020 separating space only when needed.
8021 NOTE: Use of special characters in 'titlestring' may cause the display
8022 to be garbled (e.g., when it contains a CR or NL character).
8023 {not available when compiled without the |+statusline| feature}
8024
8025 *'toolbar'* *'tb'*
8026'toolbar' 'tb' string (default "icons,tooltips")
8027 global
8028 {only for |+GUI_GTK|, |+GUI_Athena|, |+GUI_Motif| and
8029 |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008030 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00008031 possible values are:
8032 icons Toolbar buttons are shown with icons.
8033 text Toolbar buttons shown with text.
8034 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008035 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008036 tooltips Tooltips are active for toolbar buttons.
8037 Tooltips refer to the popup help text which appears after the mouse
8038 cursor is placed over a toolbar button for a brief moment.
8039
8040 If you want the toolbar to be shown with icons as well as text, do the
8041 following: >
8042 :set tb=icons,text
8043< Motif and Athena cannot display icons and text at the same time. They
8044 will show icons if both are requested.
8045
8046 If none of the strings specified in 'toolbar' are valid or if
8047 'toolbar' is empty, this option is ignored. If you want to disable
8048 the toolbar, you need to set the 'guioptions' option. For example: >
8049 :set guioptions-=T
8050< Also see |gui-toolbar|.
8051
8052 *'toolbariconsize'* *'tbis'*
8053'toolbariconsize' 'tbis' string (default "small")
8054 global
Bram Moolenaar3df01732017-02-17 22:47:16 +01008055 {only in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008056 Controls the size of toolbar icons. The possible values are:
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008057 tiny Use tiny icons.
8058 small Use small icons (default).
8059 medium Use medium-sized icons.
8060 large Use large icons.
8061 huge Use even larger icons.
8062 giant Use very big icons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008063 The exact dimensions in pixels of the various icon sizes depend on
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008064 the current theme. Common dimensions are giant=48x48, huge=32x32,
8065 large=24x24, medium=24x24, small=20x20 and tiny=16x16.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008066
8067 If 'toolbariconsize' is empty, the global default size as determined
8068 by user preferences or the current theme is used.
8069
8070 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
8071'ttybuiltin' 'tbi' boolean (default on)
8072 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008073 When on, the builtin termcaps are searched before the external ones.
8074 When off the builtin termcaps are searched after the external ones.
8075 When this option is changed, you should set the 'term' option next for
8076 the change to take effect, for example: >
8077 :set notbi term=$TERM
8078< See also |termcap|.
8079 Rationale: The default for this option is "on", because the builtin
8080 termcap entries are generally better (many systems contain faulty
8081 xterm entries...).
8082
8083 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
8084'ttyfast' 'tf' boolean (default off, on when 'term' is xterm, hpterm,
8085 sun-cmd, screen, rxvt, dtterm or
8086 iris-ansi; also on when running Vim in
8087 a DOS console)
8088 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008089 Indicates a fast terminal connection. More characters will be sent to
8090 the screen for redrawing, instead of using insert/delete line
8091 commands. Improves smoothness of redrawing when there are multiple
8092 windows and the terminal does not support a scrolling region.
8093 Also enables the extra writing of characters at the end of each screen
8094 line for lines that wrap. This helps when using copy/paste with the
8095 mouse in an xterm and other terminals.
8096
8097 *'ttymouse'* *'ttym'*
8098'ttymouse' 'ttym' string (default depends on 'term')
8099 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008100 {only in Unix and VMS, doesn't work in the GUI; not
8101 available when compiled without |+mouse|}
8102 Name of the terminal type for which mouse codes are to be recognized.
Bram Moolenaar2c7a7632007-05-10 18:19:11 +00008103 Currently these strings are valid:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008104 *xterm-mouse*
8105 xterm xterm-like mouse handling. The mouse generates
8106 "<Esc>[Mscr", where "scr" is three bytes:
8107 "s" = button state
8108 "c" = column plus 33
8109 "r" = row plus 33
Bram Moolenaare968e362014-05-13 20:23:24 +02008110 This only works up to 223 columns! See "dec",
8111 "urxvt", and "sgr" for solutions.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008112 xterm2 Works like "xterm", but with the xterm reporting the
8113 mouse position while the mouse is dragged. This works
8114 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00008115 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00008116 work. See below for how Vim detects this
8117 automatically.
8118 *netterm-mouse*
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008119 netterm NetTerm mouse handling. A left mouse click generates
Bram Moolenaar071d4272004-06-13 20:20:40 +00008120 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008121 for the row and column. No other mouse events are
8122 supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008123 *dec-mouse*
8124 dec DEC terminal mouse handling. The mouse generates a
8125 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00008126 This is also available for an Xterm, if it was
8127 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00008128 *jsbterm-mouse*
8129 jsbterm JSB term mouse handling.
8130 *pterm-mouse*
8131 pterm QNX pterm mouse handling.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008132 *urxvt-mouse*
8133 urxvt Mouse handling for the urxvt (rxvt-unicode) terminal.
Bram Moolenaare968e362014-05-13 20:23:24 +02008134 The mouse works only if the terminal supports this
8135 encoding style, but it does not have 223 columns limit
8136 unlike "xterm" or "xterm2".
Bram Moolenaar9b451252012-08-15 17:43:31 +02008137 *sgr-mouse*
8138 sgr Mouse handling for the terminal that emits SGR-styled
Bram Moolenaare968e362014-05-13 20:23:24 +02008139 mouse reporting. The mouse works even in columns
8140 beyond 223. This option is backward compatible with
8141 "xterm2" because it can also decode "xterm2" style
8142 mouse codes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008143
8144 The mouse handling must be enabled at compile time |+mouse_xterm|
Bram Moolenaare968e362014-05-13 20:23:24 +02008145 |+mouse_dec| |+mouse_netterm| |+mouse_jsbterm| |+mouse_urxvt|
8146 |+mouse_sgr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008147 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
8148 recognized, if enabled at compile time. DEC terminal mouse codes
8149 are recognized if enabled at compile time, and 'ttymouse' is not
Bram Moolenaare968e362014-05-13 20:23:24 +02008150 "xterm", "xterm2", "urxvt" or "sgr" (because dec mouse codes conflict
8151 with them).
Bram Moolenaar071d4272004-06-13 20:20:40 +00008152 This option is automatically set to "xterm", when the 'term' option is
Bram Moolenaar45758762016-10-12 23:08:06 +02008153 set to a name that starts with "xterm", "mlterm", "screen", "tmux",
8154 "st" (full match only), "st-" or "stterm", and 'ttymouse' is not set
8155 already.
Bram Moolenaare968e362014-05-13 20:23:24 +02008156 Additionally, if vim is compiled with the |+termresponse| feature and
8157 |t_RV| is set to the escape sequence to request the xterm version
Bram Moolenaarf8a07122019-07-01 22:06:07 +02008158 number, more intelligent detection is done.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008159 The "xterm2" value will be set if the xterm version is reported to be
Bram Moolenaard47d5222018-12-09 20:43:55 +01008160 from 95 to 276. The "sgr" value will be set if Vim detects Mac
8161 Terminal.app, iTerm2 or mintty, and when the xterm version is 277 or
8162 higher.
Bram Moolenaare968e362014-05-13 20:23:24 +02008163 If you do not want 'ttymouse' to be set to "xterm2" or "sgr"
8164 automatically, set t_RV to an empty string: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008165 :set t_RV=
8166<
8167 *'ttyscroll'* *'tsl'*
8168'ttyscroll' 'tsl' number (default 999)
8169 global
8170 Maximum number of lines to scroll the screen. If there are more lines
8171 to scroll the window is redrawn. For terminals where scrolling is
8172 very slow and redrawing is not slow this can be set to a small number,
8173 e.g., 3, to speed up displaying.
8174
8175 *'ttytype'* *'tty'*
8176'ttytype' 'tty' string (default from $TERM)
8177 global
8178 Alias for 'term', see above.
8179
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008180 *'undodir'* *'udir'*
8181'undodir' 'udir' string (default ".")
8182 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008183 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008184 List of directory names for undo files, separated with commas.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008185 See |'backupdir'| for details of the format.
Bram Moolenaar6a244fe2010-05-24 22:02:24 +02008186 "." means using the directory of the file. The undo file name for
8187 "file.txt" is ".file.txt.un~".
8188 For other directories the file name is the full path of the edited
8189 file, with path separators replaced with "%".
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008190 When writing: The first directory that exists is used. "." always
8191 works, no directories after "." will be used for writing.
8192 When reading all entries are tried to find an undo file. The first
8193 undo file that exists is used. When it cannot be read an error is
8194 given, no further entry is used.
8195 See |undo-persistence|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008196 This option cannot be set from a |modeline| or in the |sandbox|, for
8197 security reasons.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008198
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02008199 *'undofile'* *'noundofile'* *'udf'* *'noudf'*
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008200'undofile' 'udf' boolean (default off)
8201 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02008202 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008203 When on, Vim automatically saves undo history to an undo file when
8204 writing a buffer to a file, and restores undo history from the same
8205 file on buffer read.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008206 The directory where the undo file is stored is specified by 'undodir'.
8207 For more information about this feature see |undo-persistence|.
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008208 The undo file is not read when 'undoreload' causes the buffer from
8209 before a reload to be saved for undo.
Bram Moolenaar97d62492012-11-15 21:28:22 +01008210 When 'undofile' is turned off the undo file is NOT deleted.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008211 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008212
Bram Moolenaar071d4272004-06-13 20:20:40 +00008213 *'undolevels'* *'ul'*
Bram Moolenaar8024f932020-01-14 19:29:13 +01008214'undolevels' 'ul' number (default 100, 1000 for Unix, VMS and Win32)
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008215 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008216 Maximum number of changes that can be undone. Since undo information
Bram Moolenaar5be4cee2019-09-27 19:34:08 +02008217 is kept in memory, higher numbers will cause more memory to be used.
8218 Nevertheless, a single change can already use a large amount of memory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008219 Set to 0 for Vi compatibility: One level of undo and "u" undoes
8220 itself: >
8221 set ul=0
8222< But you can also get Vi compatibility by including the 'u' flag in
8223 'cpoptions', and still be able to use CTRL-R to repeat undo.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008224 Also see |undo-two-ways|.
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008225 Set to -1 for no undo at all. You might want to do this only for the
8226 current buffer: >
8227 setlocal ul=-1
Bram Moolenaar071d4272004-06-13 20:20:40 +00008228< This helps when you run out of memory for a single change.
Bram Moolenaar32efaf62014-11-05 17:02:17 +01008229
8230 The local value is set to -123456 when the global value is to be used.
8231
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008232 Also see |clear-undo|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008233
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008234 *'undoreload'* *'ur'*
8235'undoreload' 'ur' number (default 10000)
8236 global
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008237 Save the whole buffer for undo when reloading it. This applies to the
8238 ":e!" command and reloading for when the buffer changed outside of
8239 Vim. |FileChangedShell|
Bram Moolenaar24a98a02017-09-27 22:23:55 +02008240 The save only happens when this option is negative or when the number
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008241 of lines is smaller than the value of this option.
8242 Set this option to zero to disable undo for a reload.
8243
8244 When saving undo for a reload, any undo file is not read.
8245
8246 Note that this causes the whole buffer to be stored in memory. Set
8247 this option to a lower value if you run out of memory.
8248
Bram Moolenaar071d4272004-06-13 20:20:40 +00008249 *'updatecount'* *'uc'*
8250'updatecount' 'uc' number (default: 200)
8251 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008252 After typing this many characters the swap file will be written to
8253 disk. When zero, no swap file will be created at all (see chapter on
8254 recovery |crash-recovery|). 'updatecount' is set to zero by starting
8255 Vim with the "-n" option, see |startup|. When editing in readonly
8256 mode this option will be initialized to 10000.
8257 The swapfile can be disabled per buffer with |'swapfile'|.
8258 When 'updatecount' is set from zero to non-zero, swap files are
8259 created for all buffers that have 'swapfile' set. When 'updatecount'
8260 is set to zero, existing swap files are not deleted.
8261 Also see |'swapsync'|.
8262 This option has no meaning in buffers where |'buftype'| is "nofile"
8263 or "nowrite".
8264
8265 *'updatetime'* *'ut'*
8266'updatetime' 'ut' number (default 4000)
8267 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008268 If this many milliseconds nothing is typed the swap file will be
8269 written to disk (see |crash-recovery|). Also used for the
8270 |CursorHold| autocommand event.
8271
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008272 *'varsofttabstop'* *'vsts'*
8273'varsofttabstop' 'vsts' string (default "")
8274 local to buffer
8275 {only available when compiled with the |+vartabs|
8276 feature}
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008277 A list of the number of spaces that a <Tab> counts for while editing,
8278 such as inserting a <Tab> or using <BS>. It "feels" like variable-
8279 width <Tab>s are being inserted, while in fact a mixture of spaces
8280 and <Tab>s is used. Tab widths are separated with commas, with the
8281 final value applying to all subsequent tabs.
8282
8283 For example, when editing assembly language files where statements
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02008284 start in the 9th column and comments in the 41st, it may be useful
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008285 to use the following: >
8286 :set varsofttabstop=8,32,8
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02008287< This will set soft tabstops with 8 and 8 + 32 spaces, and 8 more
8288 for every column thereafter.
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008289
8290 Note that the value of |'softtabstop'| will be ignored while
8291 'varsofttabstop' is set.
8292
8293 *'vartabstop'* *'vts'*
8294'vartabstop' 'vts' string (default "")
8295 local to buffer
8296 {only available when compiled with the |+vartabs|
8297 feature}
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008298 A list of the number of spaces that a <Tab> in the file counts for,
8299 separated by commas. Each value corresponds to one tab, with the
8300 final value applying to all subsequent tabs. For example: >
8301 :set vartabstop=4,20,10,8
8302< This will make the first tab 4 spaces wide, the second 20 spaces,
8303 the third 10 spaces, and all following tabs 8 spaces.
8304
8305 Note that the value of |'tabstop'| will be ignored while 'vartabstop'
8306 is set.
8307
Bram Moolenaar071d4272004-06-13 20:20:40 +00008308 *'verbose'* *'vbs'*
8309'verbose' 'vbs' number (default 0)
8310 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008311 When bigger than zero, Vim will give messages about what it is doing.
8312 Currently, these messages are given:
8313 >= 1 When the viminfo file is read or written.
8314 >= 2 When a file is ":source"'ed.
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008315 >= 5 Every searched tags file and include file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008316 >= 8 Files for which a group of autocommands is executed.
8317 >= 9 Every executed autocommand.
8318 >= 12 Every executed function.
8319 >= 13 When an exception is thrown, caught, finished, or discarded.
8320 >= 14 Anything pending in a ":finally" clause.
8321 >= 15 Every executed Ex command (truncated at 200 characters).
8322
8323 This option can also be set with the "-V" argument. See |-V|.
8324 This option is also set by the |:verbose| command.
8325
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008326 When the 'verbosefile' option is set then the verbose messages are not
8327 displayed.
8328
8329 *'verbosefile'* *'vfile'*
8330'verbosefile' 'vfile' string (default empty)
8331 global
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008332 When not empty all messages are written in a file with this name.
8333 When the file exists messages are appended.
8334 Writing to the file ends when Vim exits or when 'verbosefile' is made
Bram Moolenaar80794b12010-06-13 05:20:42 +02008335 empty. Writes are buffered, thus may not show up for some time.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008336 Setting 'verbosefile' to a new value is like making it empty first.
8337 The difference with |:redir| is that verbose messages are not
8338 displayed when 'verbosefile' is set.
8339
Bram Moolenaar071d4272004-06-13 20:20:40 +00008340 *'viewdir'* *'vdir'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008341'viewdir' 'vdir' string (default for Amiga and Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008342 "$VIM/vimfiles/view",
8343 for Unix: "~/.vim/view",
8344 for Macintosh: "$VIM:vimfiles:view"
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01008345 for VMS: "sys$login:vimfiles/view")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008346 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008347 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008348 feature}
8349 Name of the directory where to store files for |:mkview|.
8350 This option cannot be set from a |modeline| or in the |sandbox|, for
8351 security reasons.
8352
8353 *'viewoptions'* *'vop'*
Bram Moolenaar13e90412017-11-11 18:16:48 +01008354'viewoptions' 'vop' string (default: "folds,options,cursor,curdir")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008355 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008356 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008357 feature}
8358 Changes the effect of the |:mkview| command. It is a comma separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008359 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008360 word save and restore ~
8361 cursor cursor position in file and in window
8362 folds manually created folds, opened/closed folds and local
8363 fold options
8364 options options and mappings local to a window or buffer (not
8365 global values for local options)
Bram Moolenaar6e932462014-09-09 18:48:09 +02008366 localoptions same as "options"
Bram Moolenaar071d4272004-06-13 20:20:40 +00008367 slash backslashes in file names replaced with forward
8368 slashes
8369 unix with Unix end-of-line format (single <NL>), even when
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008370 on MS-Windows
Bram Moolenaar13e90412017-11-11 18:16:48 +01008371 curdir the window-local directory, if set with `:lcd`
Bram Moolenaar071d4272004-06-13 20:20:40 +00008372
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008373 "slash" and "unix" are useful on MS-Windows when sharing view files
Bram Moolenaar071d4272004-06-13 20:20:40 +00008374 with Unix. The Unix version of Vim cannot source dos format scripts,
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008375 but the MS-Windows version of Vim can source unix format scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008376
8377 *'viminfo'* *'vi'* *E526* *E527* *E528*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008378'viminfo' 'vi' string (Vi default: "", Vim default for
8379 MS-Windows: '100,<50,s10,h,rA:,rB:,
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01008380 for Amiga: '100,<50,s10,h,rdf0:,rdf1:,rdf2:
8381 for others: '100,<50,s10,h)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008382 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008383 {not available when compiled without the |+viminfo|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008384 feature}
8385 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008386 when exiting Vim (see |viminfo-file|). Except when 'viminfofile' is
8387 "NONE".
8388 The string should be a comma separated list of parameters, each
8389 consisting of a single character identifying the particular parameter,
8390 followed by a number or string which specifies the value of that
8391 parameter. If a particular character is left out, then the default
8392 value is used for that parameter. The following is a list of the
8393 identifying characters and the effect of their value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008394 CHAR VALUE ~
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008395 *viminfo-!*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008396 ! When included, save and restore global variables that start
8397 with an uppercase letter, and don't contain a lowercase
8398 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar680eeca2010-10-20 17:44:42 +02008399 and "_K_L_M" are not. Nested List and Dict items may not be
Bram Moolenaar166af9b2010-11-16 20:34:40 +01008400 read back correctly, you end up with an empty item.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008401 *viminfo-quote*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008402 " Maximum number of lines saved for each register. Old name of
8403 the '<' item, with the disadvantage that you need to put a
8404 backslash before the ", otherwise it will be recognized as the
8405 start of a comment!
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008406 *viminfo-%*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008407 % When included, save and restore the buffer list. If Vim is
8408 started with a file name argument, the buffer list is not
8409 restored. If Vim is started without a file name argument, the
Bram Moolenaard042dc82015-11-24 19:18:36 +01008410 buffer list is restored from the viminfo file. Quickfix
8411 ('buftype'), unlisted ('buflisted'), unnamed and buffers on
8412 removable media (|viminfo-r|) are not saved.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00008413 When followed by a number, the number specifies the maximum
8414 number of buffers that are stored. Without a number all
8415 buffers are stored.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008416 *viminfo-'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008417 ' Maximum number of previously edited files for which the marks
8418 are remembered. This parameter must always be included when
8419 'viminfo' is non-empty.
8420 Including this item also means that the |jumplist| and the
8421 |changelist| are stored in the viminfo file.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008422 *viminfo-/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008423 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008424 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00008425 patterns are also saved. When not included, the value of
8426 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008427 *viminfo-:*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008428 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008429 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008430 *viminfo-<*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008431 < Maximum number of lines saved for each register. If zero then
8432 registers are not saved. When not included, all lines are
8433 saved. '"' is the old name for this item.
8434 Also see the 's' item below: limit specified in Kbyte.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008435 *viminfo-@*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008436 @ Maximum number of items in the input-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-c*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008439 c When included, convert the text in the viminfo file from the
8440 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00008441 'encoding'. See |viminfo-encoding|.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008442 *viminfo-f*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008443 f Whether file marks need to be stored. If zero, file marks ('0
8444 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008445 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00008446 cursor position (when exiting or when doing ":wviminfo").
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008447 *viminfo-h*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008448 h Disable the effect of 'hlsearch' when loading the viminfo
8449 file. When not included, it depends on whether ":nohlsearch"
8450 has been used since the last search command.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008451 *viminfo-n*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008452 n Name of the viminfo file. The name must immediately follow
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008453 the 'n'. Must be at the end of the option! If the
8454 'viminfofile' option is set, that file name overrides the one
8455 given here with 'viminfo'. Environment variables are
Bram Moolenaar063b9d12016-07-09 20:21:48 +02008456 expanded when opening the file, not when setting the option.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008457 *viminfo-r*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008458 r Removable media. The argument is a string (up to the next
8459 ','). This parameter can be given several times. Each
8460 specifies the start of a path for which no marks will be
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01008461 stored. This is to avoid removable media. For MS-Windows you
Bram Moolenaar071d4272004-06-13 20:20:40 +00008462 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
8463 also use it for temp files, e.g., for Unix: "r/tmp". Case is
8464 ignored. Maximum length of each 'r' argument is 50
8465 characters.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008466 *viminfo-s*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008467 s Maximum size of an item in Kbyte. If zero then registers are
8468 not saved. Currently only applies to registers. The default
8469 "s10" will exclude registers with more than 10 Kbyte of text.
8470 Also see the '<' item above: line count limit.
8471
8472 Example: >
8473 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
8474<
8475 '50 Marks will be remembered for the last 50 files you
8476 edited.
8477 <1000 Contents of registers (up to 1000 lines each) will be
8478 remembered.
8479 s100 Registers with more than 100 Kbyte text are skipped.
8480 :0 Command-line history will not be saved.
8481 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
8482 no / Since '/' is not specified, the default will be used,
8483 that is, save all of the search history, and also the
8484 previous search and substitute patterns.
8485 no % The buffer list will not be saved nor read back.
8486 no h 'hlsearch' highlighting will be restored.
8487
8488 When setting 'viminfo' from an empty value you can use |:rviminfo| to
8489 load the contents of the file, this is not done automatically.
8490
8491 This option cannot be set from a |modeline| or in the |sandbox|, for
8492 security reasons.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008493 NOTE: This option is set to the Vim default value when 'compatible'
8494 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008495
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008496 *'viminfofile'* *'vif'*
8497'viminfofile' 'vif' string (default: "")
8498 global
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008499 {not available when compiled without the |+viminfo|
8500 feature}
8501 When non-empty, overrides the file name used for viminfo.
8502 When equal to "NONE" no viminfo file will be read or written.
8503 This option can be set with the |-i| command line flag. The |--clean|
8504 command line flag sets it to "NONE".
Bram Moolenaar110289e2019-05-23 15:38:06 +02008505 This option cannot be set from a |modeline| or in the |sandbox|, for
8506 security reasons.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008507
Bram Moolenaar071d4272004-06-13 20:20:40 +00008508 *'virtualedit'* *'ve'*
8509'virtualedit' 've' string (default "")
8510 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008511 {not available when compiled without the
8512 |+virtualedit| feature}
8513 A comma separated list of these words:
8514 block Allow virtual editing in Visual block mode.
8515 insert Allow virtual editing in Insert mode.
8516 all Allow virtual editing in all modes.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008517 onemore Allow the cursor to move just past the end of the line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008518
Bram Moolenaar071d4272004-06-13 20:20:40 +00008519 Virtual editing means that the cursor can be positioned where there is
Bram Moolenaarebcbd022007-05-12 14:28:25 +00008520 no actual character. This can be halfway into a tab or beyond the end
Bram Moolenaar071d4272004-06-13 20:20:40 +00008521 of the line. Useful for selecting a rectangle in Visual mode and
8522 editing a table.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008523 "onemore" is not the same, it will only allow moving the cursor just
8524 after the last character of the line. This makes some commands more
8525 consistent. Previously the cursor was always past the end of the line
8526 if the line was empty. But it is far from Vi compatible. It may also
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008527 break some plugins or Vim scripts. For example because |l| can move
8528 the cursor after the last character. Use with care!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02008529 Using the `$` command will move to the last character in the line, not
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008530 past it. This may actually move the cursor to the left!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02008531 The `g$` command will move to the end of the screen line.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008532 It doesn't make sense to combine "all" with "onemore", but you will
8533 not get a warning for it.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008534 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008535
8536 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
8537'visualbell' 'vb' boolean (default off)
8538 global
Bram Moolenaar74675a62017-07-15 13:53:23 +02008539 Use a visual bell instead of beeping. The terminal code to display the
Bram Moolenaar071d4272004-06-13 20:20:40 +00008540 visual bell is given with 't_vb'. When no beep or flash is wanted,
Bram Moolenaar74675a62017-07-15 13:53:23 +02008541 use: >
8542 :set vb t_vb=
8543< If you want a short flash, you can use this on many terminals: >
8544 :set vb t_vb=[?5h$<100>[?5l
8545< Here $<100> specifies the time, you can use a smaller or bigger value
8546 to get a shorter or longer flash.
8547
8548 Note: Vim will limit the bell to once per half a second. This avoids
8549 having to wait for the flashing to finish when there are lots of
8550 bells, e.g. on key repeat. This also happens without 'visualbell'
8551 set.
8552
Bram Moolenaar071d4272004-06-13 20:20:40 +00008553 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
8554 for 20 msec. If you want to use a different time, use "<Esc>|40f",
8555 where 40 is the time in msec.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008556
8557 Note: When the GUI starts, 't_vb' is reset to its default value. You
8558 might want to set it again in your |gvimrc|.
8559
Bram Moolenaar071d4272004-06-13 20:20:40 +00008560 Does not work on the Amiga, you always get a screen flash.
8561 Also see 'errorbells'.
8562
8563 *'warn'* *'nowarn'*
8564'warn' boolean (default on)
8565 global
8566 Give a warning message when a shell command is used while the buffer
8567 has been changed.
8568
8569 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
8570'weirdinvert' 'wiv' boolean (default off)
8571 global
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00008572 This option has the same effect as the 't_xs' terminal option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008573 It is provided for backwards compatibility with version 4.x.
8574 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
8575 vice versa. Has no effect when the GUI is running.
8576
8577 *'whichwrap'* *'ww'*
8578'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
8579 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008580 Allow specified keys that move the cursor left/right to move to the
8581 previous/next line when the cursor is on the first/last character in
8582 the line. Concatenate characters to allow this for these keys:
8583 char key mode ~
8584 b <BS> Normal and Visual
8585 s <Space> Normal and Visual
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008586 h "h" Normal and Visual (not recommended)
8587 l "l" Normal and Visual (not recommended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008588 < <Left> Normal and Visual
8589 > <Right> Normal and Visual
8590 ~ "~" Normal
8591 [ <Left> Insert and Replace
8592 ] <Right> Insert and Replace
8593 For example: >
8594 :set ww=<,>,[,]
8595< allows wrap only when cursor keys are used.
8596 When the movement keys are used in combination with a delete or change
8597 operator, the <EOL> also counts for a character. This makes "3h"
8598 different from "3dh" when the cursor crosses the end of a line. This
8599 is also true for "x" and "X", because they do the same as "dl" and
8600 "dh". If you use this, you may also want to use the mapping
8601 ":map <BS> X" to make backspace delete the character in front of the
8602 cursor.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00008603 When 'l' is included and it is used after an operator at the end of a
Bram Moolenaar589edb32019-09-20 14:38:13 +02008604 line (not an empty line) then it will not move to the next line. This
8605 makes "dl", "cl", "yl" etc. work normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008606 NOTE: This option is set to the Vi default value when 'compatible' is
8607 set and to the Vim default value when 'compatible' is reset.
8608
8609 *'wildchar'* *'wc'*
8610'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
8611 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008612 Character you have to type to start wildcard expansion in the
8613 command-line, as specified with 'wildmode'.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008614 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008615 The character is not recognized when used inside a macro. See
8616 'wildcharm' for that.
8617 Although 'wc' is a number option, you can set it to a special key: >
8618 :set wc=<Esc>
8619< NOTE: This option is set to the Vi default value when 'compatible' is
8620 set and to the Vim default value when 'compatible' is reset.
8621
8622 *'wildcharm'* *'wcm'*
8623'wildcharm' 'wcm' number (default: none (0))
8624 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008625 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00008626 recognized when used inside a macro. You can find "spare" command-line
8627 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00008628 you'll never actually type 'wildcharm', just use it in mappings that
8629 automatically invoke completion mode, e.g.: >
8630 :set wcm=<C-Z>
Bram Moolenaar446cb832008-06-24 21:56:24 +00008631 :cnoremap ss so $vim/sessions/*.vim<C-Z>
Bram Moolenaar071d4272004-06-13 20:20:40 +00008632< Then after typing :ss you can use CTRL-P & CTRL-N.
8633
8634 *'wildignore'* *'wig'*
8635'wildignore' 'wig' string (default "")
8636 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008637 {not available when compiled without the |+wildignore|
8638 feature}
8639 A list of file patterns. A file that matches with one of these
Bram Moolenaar30b65812012-07-12 22:01:11 +02008640 patterns is ignored when expanding |wildcards|, completing file or
8641 directory names, and influences the result of |expand()|, |glob()| and
8642 |globpath()| unless a flag is passed to disable this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008643 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
8644 Also see 'suffixes'.
8645 Example: >
8646 :set wildignore=*.o,*.obj
8647< The use of |:set+=| and |:set-=| is preferred when adding or removing
8648 a pattern from the list. This avoids problems when a future version
8649 uses another default.
8650
Bram Moolenaar94950a92010-12-02 16:01:29 +01008651
Bram Moolenaar81af9252010-12-10 20:35:50 +01008652 *'wildignorecase'* *'wic'* *'nowildignorecase'* *'nowic'*
Bram Moolenaar94950a92010-12-02 16:01:29 +01008653'wildignorecase' 'wic' boolean (default off)
8654 global
Bram Moolenaar94950a92010-12-02 16:01:29 +01008655 When set case is ignored when completing file names and directories.
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01008656 Has no effect when 'fileignorecase' is set.
Bram Moolenaar94950a92010-12-02 16:01:29 +01008657 Does not apply when the shell is used to expand wildcards, which
8658 happens when there are special characters.
8659
8660
Bram Moolenaar071d4272004-06-13 20:20:40 +00008661 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02008662'wildmenu' 'wmnu' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008663 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008664 {not available if compiled without the |+wildmenu|
8665 feature}
8666 When 'wildmenu' is on, command-line completion operates in an enhanced
8667 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
8668 the possible matches are shown just above the command line, with the
8669 first match highlighted (overwriting the status line, if there is
8670 one). Keys that show the previous/next match, such as <Tab> or
8671 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
8672 When 'wildmode' is used, "wildmenu" mode is used where "full" is
8673 specified. "longest" and "list" do not start "wildmenu" mode.
Bram Moolenaar26402cb2013-02-20 21:26:00 +01008674 You can check the current mode with |wildmenumode()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008675 If there are more matches than can fit in the line, a ">" is shown on
8676 the right and/or a "<" is shown on the left. The status line scrolls
8677 as needed.
8678 The "wildmenu" mode is abandoned when a key is hit that is not used
8679 for selecting a completion.
8680 While the "wildmenu" is active the following keys have special
8681 meanings:
8682
8683 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
8684 <Down> - in filename/menu name completion: move into a
8685 subdirectory or submenu.
8686 <CR> - in menu completion, when the cursor is just after a
8687 dot: move into a submenu.
8688 <Up> - in filename/menu name completion: move up into
8689 parent directory or parent menu.
8690
8691 This makes the menus accessible from the console |console-menus|.
8692
8693 If you prefer the <Left> and <Right> keys to move the cursor instead
8694 of selecting a different match, use this: >
8695 :cnoremap <Left> <Space><BS><Left>
8696 :cnoremap <Right> <Space><BS><Right>
8697<
8698 The "WildMenu" highlighting is used for displaying the current match
8699 |hl-WildMenu|.
8700
8701 *'wildmode'* *'wim'*
8702'wildmode' 'wim' string (Vim default: "full")
8703 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008704 Completion mode that is used for the character specified with
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008705 'wildchar'. It is a comma separated list of up to four parts. Each
Bram Moolenaar02467872007-05-06 13:22:01 +00008706 part specifies what to do for each consecutive use of 'wildchar'. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00008707 first part specifies the behavior for the first use of 'wildchar',
8708 The second part for the second use, etc.
8709 These are the possible values for each part:
8710 "" Complete only the first match.
8711 "full" Complete the next full match. After the last match,
8712 the original string is used and then the first match
8713 again.
8714 "longest" Complete till longest common string. If this doesn't
8715 result in a longer string, use the next part.
8716 "longest:full" Like "longest", but also start 'wildmenu' if it is
8717 enabled.
8718 "list" When more than one match, list all matches.
8719 "list:full" When more than one match, list all matches and
8720 complete first match.
8721 "list:longest" When more than one match, list all matches and
8722 complete till longest common string.
Bram Moolenaar52410572019-10-27 05:12:45 +01008723 "list:lastused" When more than one buffer matches, sort buffers
8724 by time last used (other than the current buffer).
Bram Moolenaar071d4272004-06-13 20:20:40 +00008725 When there is only a single match, it is fully completed in all cases.
8726
8727 Examples: >
8728 :set wildmode=full
Bram Moolenaar582fd852005-03-28 20:58:01 +00008729< Complete first full match, next match, etc. (the default) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008730 :set wildmode=longest,full
8731< Complete longest common string, then each full match >
8732 :set wildmode=list:full
8733< List all matches and complete each full match >
8734 :set wildmode=list,full
8735< List all matches without completing, then each full match >
8736 :set wildmode=longest,list
8737< Complete longest common string, then list alternatives.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008738 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008739
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00008740 *'wildoptions'* *'wop'*
8741'wildoptions' 'wop' string (default "")
8742 global
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00008743 {not available when compiled without the |+wildignore|
8744 feature}
8745 A list of words that change how command line completion is done.
8746 Currently only one word is allowed:
8747 tagfile When using CTRL-D to list matching tags, the kind of
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00008748 tag and the file of the tag is listed. Only one match
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00008749 is displayed per line. Often used tag kinds are:
8750 d #define
8751 f function
8752 Also see |cmdline-completion|.
8753
Bram Moolenaar071d4272004-06-13 20:20:40 +00008754 *'winaltkeys'* *'wak'*
8755'winaltkeys' 'wak' string (default "menu")
8756 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008757 {only used in Win32, Motif, GTK and Photon GUI}
8758 Some GUI versions allow the access to menu entries by using the ALT
8759 key in combination with a character that appears underlined in the
8760 menu. This conflicts with the use of the ALT key for mappings and
8761 entering special characters. This option tells what to do:
8762 no Don't use ALT keys for menus. ALT key combinations can be
8763 mapped, but there is no automatic handling. This can then be
8764 done with the |:simalt| command.
8765 yes ALT key handling is done by the windowing system. ALT key
8766 combinations cannot be mapped.
8767 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008768 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00008769 keys can be mapped.
8770 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
8771 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00008772 This option is not used for <F10>; on Win32 and with GTK <F10> will
8773 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008774
Bram Moolenaar4d784b22019-05-25 19:51:39 +02008775 *'wincolor'* *'wcr'*
8776'wincolor' 'wcr' string (default empty)
8777 local to window
8778 Highlight group name to use for this window instead of the Normal
8779 color |hl-Normal|.
8780
Bram Moolenaar4399ef42005-02-12 14:29:27 +00008781 *'window'* *'wi'*
8782'window' 'wi' number (default screen height - 1)
8783 global
8784 Window height. Do not confuse this with the height of the Vim window,
8785 use 'lines' for that.
Bram Moolenaar19a09a12005-03-04 23:39:37 +00008786 Used for |CTRL-F| and |CTRL-B| when there is only one window and the
8787 value is smaller than 'lines' minus one. The screen will scroll
8788 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00008789 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
8790 in a much smarter way, taking care of wrapping lines.
8791 When resizing the Vim window, the value is smaller than 1 or more than
8792 or equal to 'lines' it will be set to 'lines' minus 1.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00008793
Bram Moolenaar071d4272004-06-13 20:20:40 +00008794 *'winheight'* *'wh'* *E591*
8795'winheight' 'wh' number (default 1)
8796 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008797 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008798 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar446cb832008-06-24 21:56:24 +00008799 focus goes to a window that is smaller, its size is increased, at the
8800 cost of the height of other windows.
8801 Set 'winheight' to a small number for normal editing.
8802 Set it to 999 to make the current window fill most of the screen.
8803 Other windows will be only 'winminheight' high. This has the drawback
8804 that ":all" will create only two windows. To avoid "vim -o 1 2 3 4"
8805 to create only two windows, set the option after startup is done,
8806 using the |VimEnter| event: >
8807 au VimEnter * set winheight=999
8808< Minimum value is 1.
8809 The height is not adjusted after one of the commands that change the
Bram Moolenaar071d4272004-06-13 20:20:40 +00008810 height of the current window.
8811 'winheight' applies to the current window. Use 'winminheight' to set
8812 the minimal height for other windows.
8813
8814 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
8815'winfixheight' 'wfh' boolean (default off)
8816 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00008817 Keep the window height when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00008818 'equalalways' is set. Also for |CTRL-W_=|. Set by default for the
8819 |preview-window| and |quickfix-window|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008820 The height may be changed anyway when running out of room.
8821
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008822 *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'*
8823'winfixwidth' 'wfw' boolean (default off)
8824 local to window
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008825 Keep the window width when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00008826 'equalalways' is set. Also for |CTRL-W_=|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008827 The width may be changed anyway when running out of room.
8828
Bram Moolenaar071d4272004-06-13 20:20:40 +00008829 *'winminheight'* *'wmh'*
8830'winminheight' 'wmh' number (default 1)
8831 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008832 The minimal height of a window, when it's not the current window.
8833 This is a hard minimum, windows will never become smaller.
8834 When set to zero, windows may be "squashed" to zero lines (i.e. just a
8835 status bar) if necessary. They will return to at least one line when
8836 they become active (since the cursor has to have somewhere to go.)
8837 Use 'winheight' to set the minimal height of the current window.
8838 This option is only checked when making a window smaller. Don't use a
8839 large number, it will cause errors when opening more than a few
8840 windows. A value of 0 to 3 is reasonable.
8841
8842 *'winminwidth'* *'wmw'*
8843'winminwidth' 'wmw' number (default 1)
8844 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008845 The minimal width of a window, when it's not the current window.
8846 This is a hard minimum, windows will never become smaller.
8847 When set to zero, windows may be "squashed" to zero columns (i.e. just
8848 a vertical separator) if necessary. They will return to at least one
8849 line when they become active (since the cursor has to have somewhere
8850 to go.)
8851 Use 'winwidth' to set the minimal width of the current window.
8852 This option is only checked when making a window smaller. Don't use a
8853 large number, it will cause errors when opening more than a few
8854 windows. A value of 0 to 12 is reasonable.
8855
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02008856 *'winptydll'*
8857'winptydll' string (default "winpty32.dll" or "winpty64.dll")
8858 global
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02008859 {only available when compiled with the |terminal|
8860 feature on MS-Windows}
8861 Specifies the name of the winpty shared library, used for the
8862 |:terminal| command. The default depends on whether was build as a
Bram Moolenaarc572da52017-08-27 16:52:01 +02008863 32-bit or 64-bit executable. If not found, "winpty.dll" is tried as
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02008864 a fallback.
8865 Environment variables are expanded |:set_env|.
8866 This option cannot be set from a |modeline| or in the |sandbox|, for
8867 security reasons.
8868
Bram Moolenaar071d4272004-06-13 20:20:40 +00008869 *'winwidth'* *'wiw'* *E592*
8870'winwidth' 'wiw' number (default 20)
8871 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008872 Minimal number of columns for the current window. This is not a hard
8873 minimum, Vim will use fewer columns if there is not enough room. If
8874 the current window is smaller, its size is increased, at the cost of
8875 the width of other windows. Set it to 999 to make the current window
8876 always fill the screen. Set it to a small number for normal editing.
8877 The width is not adjusted after one of the commands to change the
8878 width of the current window.
8879 'winwidth' applies to the current window. Use 'winminwidth' to set
8880 the minimal width for other windows.
8881
8882 *'wrap'* *'nowrap'*
8883'wrap' boolean (default on)
8884 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00008885 This option changes how text is displayed. It doesn't change the text
8886 in the buffer, see 'textwidth' for that.
8887 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008888 displaying continues on the next line. When off lines will not wrap
8889 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00008890 moved to a part that is not shown, the screen will scroll
8891 horizontally.
8892 The line will be broken in the middle of a word if necessary. See
8893 'linebreak' to get the break at a word boundary.
8894 To make scrolling horizontally a bit more useful, try this: >
8895 :set sidescroll=5
8896 :set listchars+=precedes:<,extends:>
8897< See 'sidescroll', 'listchars' and |wrap-off|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01008898 This option can't be set from a |modeline| when the 'diff' option is
8899 on.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008900
8901 *'wrapmargin'* *'wm'*
8902'wrapmargin' 'wm' number (default 0)
8903 local to buffer
8904 Number of characters from the right window border where wrapping
8905 starts. When typing text beyond this limit, an <EOL> will be inserted
8906 and inserting continues on the next line.
8907 Options that add a margin, such as 'number' and 'foldcolumn', cause
8908 the text width to be further reduced. This is Vi compatible.
8909 When 'textwidth' is non-zero, this option is not used.
Bram Moolenaarca635012015-09-25 20:34:21 +02008910 This option is set to 0 when 'paste' is set and restored when 'paste'
8911 is reset.
Bram Moolenaara6c27c42019-05-09 19:16:22 +02008912 See also 'formatoptions' and |ins-textwidth|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008913
8914 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
8915'wrapscan' 'ws' boolean (default on) *E384* *E385*
8916 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00008917 Searches wrap around the end of the file. Also applies to |]s| and
8918 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008919
8920 *'write'* *'nowrite'*
8921'write' boolean (default on)
8922 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008923 Allows writing files. When not set, writing a file is not allowed.
8924 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008925 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00008926 argument. Filtering text is still possible, even though this requires
8927 writing a temporary file.
8928
8929 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
8930'writeany' 'wa' boolean (default off)
8931 global
8932 Allows writing to any file with no need for "!" override.
8933
8934 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
8935'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
8936 otherwise)
8937 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008938 Make a backup before overwriting a file. The backup is removed after
8939 the file was successfully written, unless the 'backup' option is
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02008940 also on.
8941 WARNING: Switching this option off means that when Vim fails to write
8942 your buffer correctly and then, for whatever reason, Vim exits, you
8943 lose both the original file and what you were writing. Only reset
8944 this option if your file system is almost full and it makes the write
8945 fail (and make sure not to exit Vim until the write was successful).
8946 See |backup-table| for another explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008947 When the 'backupskip' pattern matches, a backup is not made anyway.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01008948 Depending on 'backupcopy' the backup is a new file or the original
8949 file renamed (and a new file is written).
Bram Moolenaar071d4272004-06-13 20:20:40 +00008950 NOTE: This option is set to the default value when 'compatible' is
8951 set.
8952
8953 *'writedelay'* *'wd'*
8954'writedelay' 'wd' number (default 0)
8955 global
Bram Moolenaar802a0d92016-06-26 16:17:58 +02008956 The number of milliseconds to wait for each character sent to the
Bram Moolenaar071d4272004-06-13 20:20:40 +00008957 screen. When non-zero, characters are sent to the terminal one by
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01008958 one. For debugging purposes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008959
Bram Moolenaar91f84f62018-07-29 15:07:52 +02008960 vim:tw=78:ts=8:noet:ft=help:norl: