blob: de8dd487f67ea3b9d7e66ceec3bcd448aed9c740 [file] [log] [blame]
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02001*options.txt* For Vim version 8.2. Last change: 2020 Aug 13
Bram Moolenaar071d4272004-06-13 20:20:40 +00002
3
4 VIM REFERENCE MANUAL by Bram Moolenaar
5
6
7Options *options*
8
91. Setting options |set-option|
102. Automatically setting options |auto-setting|
113. Options summary |option-summary|
12
Bram Moolenaar2ec618c2016-10-01 14:47:05 +020013For an overview of options see quickref.txt |option-list|.
Bram Moolenaar071d4272004-06-13 20:20:40 +000014
15Vim has a number of internal variables and switches which can be set to
16achieve special effects. These options come in three forms:
17 boolean can only be on or off *boolean* *toggle*
18 number has a numeric value
19 string has a string value
20
21==============================================================================
Bram Moolenaarf75a9632005-09-13 21:20:47 +0000221. Setting options *set-option* *E764*
Bram Moolenaar071d4272004-06-13 20:20:40 +000023
24 *:se* *:set*
Bram Moolenaar6b915c02020-01-18 15:53:19 +010025:se[t][!] Show all options that differ from their default value.
26 When [!] is present every option is on a separate
27 line.
Bram Moolenaar071d4272004-06-13 20:20:40 +000028
Bram Moolenaar6b915c02020-01-18 15:53:19 +010029:se[t][!] all Show all but terminal options.
30 When [!] is present every option is on a separate
31 line.
Bram Moolenaar071d4272004-06-13 20:20:40 +000032
33:se[t] termcap Show all terminal options. Note that in the GUI the
34 key codes are not shown, because they are generated
35 internally and can't be changed. Changing the terminal
36 codes in the GUI is not useful either...
37
38 *E518* *E519*
39:se[t] {option}? Show value of {option}.
40
41:se[t] {option} Toggle option: set, switch it on.
42 Number option: show value.
43 String option: show value.
44
45:se[t] no{option} Toggle option: Reset, switch it off.
46
Bram Moolenaar00a927d2010-05-14 23:24:24 +020047 *:set-!* *:set-inv*
Bram Moolenaar071d4272004-06-13 20:20:40 +000048:se[t] {option}! or
Bram Moolenaar6c60f472019-04-28 16:00:35 +020049:se[t] inv{option} Toggle option: Invert value.
Bram Moolenaar071d4272004-06-13 20:20:40 +000050
51 *:set-default* *:set-&* *:set-&vi* *:set-&vim*
52:se[t] {option}& Reset option to its default value. May depend on the
Bram Moolenaar6c60f472019-04-28 16:00:35 +020053 current value of 'compatible'.
54:se[t] {option}&vi Reset option to its Vi default value.
55:se[t] {option}&vim Reset option to its Vim default value.
Bram Moolenaar071d4272004-06-13 20:20:40 +000056
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +010057:se[t] all& Set all options to their default value. The values of
Bram Moolenaar88774fd2015-08-25 19:52:04 +020058 these options are not changed:
59 all terminal options, starting with t_
60 'columns'
61 'cryptmethod'
62 'encoding'
63 'key'
64 'lines'
65 'term'
66 'ttymouse'
67 'ttytype'
68 Warning: This may have a lot of side effects.
Bram Moolenaar071d4272004-06-13 20:20:40 +000069
70 *:set-args* *E487* *E521*
71:se[t] {option}={value} or
72:se[t] {option}:{value}
73 Set string or number option to {value}.
74 For numeric options the value can be given in decimal,
Bram Moolenaar3848e002016-03-19 18:42:29 +010075 hex (preceded with 0x) or octal (preceded with '0').
Bram Moolenaar071d4272004-06-13 20:20:40 +000076 The old value can be inserted by typing 'wildchar' (by
77 default this is a <Tab> or CTRL-E if 'compatible' is
78 set). See |cmdline-completion|.
79 White space between {option} and '=' is allowed and
80 will be ignored. White space between '=' and {value}
81 is not allowed.
82 See |option-backslash| for using white space and
83 backslashes in {value}.
84
85:se[t] {option}+={value} *:set+=*
86 Add the {value} to a number option, or append the
87 {value} to a string option. When the option is a
88 comma separated list, a comma is added, unless the
89 value was empty.
90 If the option is a list of flags, superfluous flags
Bram Moolenaara5792f52005-11-23 21:25:05 +000091 are removed. When adding a flag that was already
92 present the option value doesn't change.
Bram Moolenaar899dddf2006-03-26 21:06:50 +000093 Also see |:set-args| above.
Bram Moolenaar071d4272004-06-13 20:20:40 +000094
95:se[t] {option}^={value} *:set^=*
96 Multiply the {value} to a number option, or prepend
97 the {value} to a string option. When the option is a
98 comma separated list, a comma is added, unless the
99 value was empty.
100 Also see |:set-args| above.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000101
102:se[t] {option}-={value} *:set-=*
103 Subtract the {value} from a number option, or remove
104 the {value} from a string option, if it is there.
105 If the {value} is not found in a string option, there
106 is no error or warning. When the option is a comma
107 separated list, a comma is deleted, unless the option
108 becomes empty.
109 When the option is a list of flags, {value} must be
110 exactly as they appear in the option. Remove flags
111 one by one to avoid problems.
112 Also see |:set-args| above.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000113
114The {option} arguments to ":set" may be repeated. For example: >
115 :set ai nosi sw=3 ts=3
116If you make an error in one of the arguments, an error message will be given
117and the following arguments will be ignored.
118
119 *:set-verbose*
120When 'verbose' is non-zero, displaying an option value will also tell where it
121was last set. Example: >
122 :verbose set shiftwidth cindent?
Bram Moolenaar95bafa22018-10-02 13:26:25 +0200123< shiftwidth=4 ~
124 Last set from modeline line 1 ~
125 cindent ~
126 Last set from /usr/local/share/vim/vim60/ftplugin/c.vim line 30 ~
Bram Moolenaar446cb832008-06-24 21:56:24 +0000127This is only done when specific option values are requested, not for ":verbose
128set all" or ":verbose set" without an argument.
129When the option was set by hand there is no "Last set" message.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000130When the option was set while executing a function, user command or
131autocommand, the script in which it was defined is reported.
132Note that an option may also have been set as a side effect of setting
133'compatible'.
Bram Moolenaar446cb832008-06-24 21:56:24 +0000134A few special texts:
Bram Moolenaar95bafa22018-10-02 13:26:25 +0200135 Last set from modeline line 1 ~
Bram Moolenaar446cb832008-06-24 21:56:24 +0000136 Option was set in a |modeline|.
137 Last set from --cmd argument ~
138 Option was set with command line argument |--cmd| or +.
139 Last set from -c argument ~
140 Option was set with command line argument |-c|, +, |-S| or
141 |-q|.
142 Last set from environment variable ~
143 Option was set from an environment variable, $VIMINIT,
144 $GVIMINIT or $EXINIT.
145 Last set from error handler ~
146 Option was cleared when evaluating it resulted in an error.
147
Bram Moolenaardb84e452010-08-15 13:50:43 +0200148{not available when compiled without the |+eval| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000149
150 *:set-termcap* *E522*
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +0000151For {option} the form "t_xx" may be used to set a terminal option. This will
Bram Moolenaar071d4272004-06-13 20:20:40 +0000152override the value from the termcap. You can then use it in a mapping. If
153the "xx" part contains special characters, use the <t_xx> form: >
154 :set <t_#4>=^[Ot
155This can also be used to translate a special code for a normal key. For
156example, if Alt-b produces <Esc>b, use this: >
157 :set <M-b>=^[b
158(the ^[ is a real <Esc> here, use CTRL-V <Esc> to enter it)
159The advantage over a mapping is that it works in all situations.
160
Bram Moolenaar0b2f94d2011-03-22 14:35:05 +0100161You can define any key codes, e.g.: >
162 :set t_xy=^[foo;
163There is no warning for using a name that isn't recognized. You can map these
164codes as you like: >
165 :map <t_xy> something
166< *E846*
167When a key code is not set, it's like it does not exist. Trying to get its
168value will result in an error: >
169 :set t_kb=
170 :set t_kb
171 E846: Key code not set: t_kb
172
Bram Moolenaar293ee4d2004-12-09 21:34:53 +0000173The t_xx options cannot be set from a |modeline| or in the |sandbox|, for
174security reasons.
175
Bram Moolenaar071d4272004-06-13 20:20:40 +0000176The listing from ":set" looks different from Vi. Long string options are put
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000177at the end of the list. The number of options is quite large. The output of
Bram Moolenaar071d4272004-06-13 20:20:40 +0000178"set all" probably does not fit on the screen, causing Vim to give the
179|more-prompt|.
180
181 *option-backslash*
182To include white space in a string option value it has to be preceded with a
183backslash. To include a backslash you have to use two. Effectively this
184means that the number of backslashes in an option value is halved (rounded
185down).
186A few examples: >
187 :set tags=tags\ /usr/tags results in "tags /usr/tags"
188 :set tags=tags\\,file results in "tags\,file"
189 :set tags=tags\\\ file results in "tags\ file"
190
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000191The "|" character separates a ":set" command from a following command. To
192include the "|" in the option value, use "\|" instead. This example sets the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000193'titlestring' option to "hi|there": >
194 :set titlestring=hi\|there
195This sets the 'titlestring' option to "hi" and 'iconstring' to "there": >
196 :set titlestring=hi|set iconstring=there
197
Bram Moolenaar7df351e2006-01-23 22:30:28 +0000198Similarly, the double quote character starts a comment. To include the '"' in
199the option value, use '\"' instead. This example sets the 'titlestring'
200option to 'hi "there"': >
201 :set titlestring=hi\ \"there\"
202
Bram Moolenaar5666fcd2019-12-26 14:35:26 +0100203For Win32 backslashes in file names are mostly not removed. More precise: For
204options that expect a file name (those where environment variables are
205expanded) a backslash before a normal file name character is not removed. But
206a backslash before a special character (space, backslash, comma, etc.) is used
207like explained above.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000208There is one special situation, when the value starts with "\\": >
209 :set dir=\\machine\path results in "\\machine\path"
210 :set dir=\\\\machine\\path results in "\\machine\path"
211 :set dir=\\path\\file results in "\\path\file" (wrong!)
212For the first one the start is kept, but for the second one the backslashes
213are halved. This makes sure it works both when you expect backslashes to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000214halved and when you expect the backslashes to be kept. The third gives a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000215result which is probably not what you want. Avoid it.
216
217 *add-option-flags* *remove-option-flags*
218 *E539* *E550* *E551* *E552*
219Some options are a list of flags. When you want to add a flag to such an
220option, without changing the existing ones, you can do it like this: >
221 :set guioptions+=a
222Remove a flag from an option like this: >
223 :set guioptions-=a
224This removes the 'a' flag from 'guioptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000225Note that you should add or remove one flag at a time. If 'guioptions' has
Bram Moolenaar071d4272004-06-13 20:20:40 +0000226the value "ab", using "set guioptions-=ba" won't work, because the string "ba"
227doesn't appear.
228
229 *:set_env* *expand-env* *expand-environment-var*
Bram Moolenaard4755bb2004-09-02 19:12:26 +0000230Environment variables in specific string options will be expanded. If the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000231environment variable exists the '$' and the following environment variable
232name is replaced with its value. If it does not exist the '$' and the name
233are not modified. Any non-id character (not a letter, digit or '_') may
234follow the environment variable name. That character and what follows is
235appended to the value of the environment variable. Examples: >
236 :set term=$TERM.new
237 :set path=/usr/$INCLUDE,$HOME/include,.
238When adding or removing a string from an option with ":set opt-=val" or ":set
239opt+=val" the expansion is done before the adding or removing.
240
241
242Handling of local options *local-options*
243
244Some of the options only apply to a window or buffer. Each window or buffer
Bram Moolenaar51628222016-12-01 23:03:28 +0100245has its own copy of this option, thus each can have its own value. This
Bram Moolenaar071d4272004-06-13 20:20:40 +0000246allows you to set 'list' in one window but not in another. And set
247'shiftwidth' to 3 in one buffer and 4 in another.
248
249The following explains what happens to these local options in specific
250situations. You don't really need to know all of this, since Vim mostly uses
251the option values you would expect. Unfortunately, doing what the user
252expects is a bit complicated...
253
254When splitting a window, the local options are copied to the new window. Thus
255right after the split the contents of the two windows look the same.
256
257When editing a new buffer, its local option values must be initialized. Since
258the local options of the current buffer might be specifically for that buffer,
259these are not used. Instead, for each buffer-local option there also is a
260global value, which is used for new buffers. With ":set" both the local and
261global value is changed. With "setlocal" only the local value is changed,
262thus this value is not used when editing a new buffer.
263
Bram Moolenaar95ec9d62016-08-12 18:29:59 +0200264When editing a buffer that has been edited before, the options from the window
265that was last closed are used again. If this buffer has been edited in this
266window, the values from back then are used. Otherwise the values from the
267last closed window where the buffer was edited last are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000268
269It's possible to set a local window option specifically for a type of buffer.
270When you edit another buffer in the same window, you don't want to keep
271using these local window options. Therefore Vim keeps a global value of the
272local window options, which is used when editing another buffer. Each window
273has its own copy of these values. Thus these are local to the window, but
274global to all buffers in the window. With this you can do: >
275 :e one
276 :set list
277 :e two
278Now the 'list' option will also be set in "two", since with the ":set list"
279command you have also set the global value. >
280 :set nolist
281 :e one
282 :setlocal list
283 :e two
284Now the 'list' option is not set, because ":set nolist" resets the global
285value, ":setlocal list" only changes the local value and ":e two" gets the
286global value. Note that if you do this next: >
287 :e one
Bram Moolenaar531da592013-05-06 05:58:55 +0200288You will get back the 'list' value as it was the last time you edited "one".
289The options local to a window are remembered for each buffer. This also
290happens when the buffer is not loaded, but they are lost when the buffer is
291wiped out |:bwipe|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000292
293 *:setl* *:setlocal*
Bram Moolenaar6b915c02020-01-18 15:53:19 +0100294:setl[ocal][!] ... Like ":set" but set only the value local to the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000295 current buffer or window. Not all options have a
296 local value. If the option does not have a local
297 value the global value is set.
Bram Moolenaarc3301872010-07-25 20:53:06 +0200298 With the "all" argument: display local values for all
299 local options.
300 Without argument: Display local values for all local
301 options which are different from the default.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000302 When displaying a specific local option, show the
Bram Moolenaar446cb832008-06-24 21:56:24 +0000303 local value. For a global/local boolean option, when
304 the global value is being used, "--" is displayed
305 before the option name.
306 For a global option the global value is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000307 shown (but that might change in the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000308
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000309:setl[ocal] {option}< Set the local value of {option} to its global value by
310 copying the value.
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000311
Bram Moolenaar6be7f872012-01-20 21:08:56 +0100312:se[t] {option}< For |global-local| options: Remove the local value of
313 {option}, so that the global value will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000314
315 *:setg* *:setglobal*
Bram Moolenaar6b915c02020-01-18 15:53:19 +0100316:setg[lobal][!] ... Like ":set" but set only the global value for a local
Bram Moolenaar071d4272004-06-13 20:20:40 +0000317 option without changing the local value.
318 When displaying an option, the global value is shown.
Bram Moolenaarc3301872010-07-25 20:53:06 +0200319 With the "all" argument: display global values for all
320 local options.
321 Without argument: display global values for all local
322 options which are different from the default.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000323
324For buffer-local and window-local options:
325 Command global value local value ~
326 :set option=value set set
327 :setlocal option=value - set
328:setglobal option=value set -
329 :set option? - display
330 :setlocal option? - display
331:setglobal option? display -
332
333
334Global options with a local value *global-local*
335
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +0000336Options are global when you mostly use one value for all buffers and windows.
337For some global options it's useful to sometimes have a different local value.
338You can set the local value with ":setlocal". That buffer or window will then
339use the local value, while other buffers and windows continue using the global
340value.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000341
342For example, you have two windows, both on C source code. They use the global
343'makeprg' option. If you do this in one of the two windows: >
344 :set makeprg=gmake
345then the other window will switch to the same value. There is no need to set
346the 'makeprg' option in the other C source window too.
347However, if you start editing a Perl file in a new window, you want to use
Bram Moolenaar02467872007-05-06 13:22:01 +0000348another 'makeprg' for it, without changing the value used for the C source
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000349files. You use this command: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000350 :setlocal makeprg=perlmake
351You can switch back to using the global value by making the local value empty: >
352 :setlocal makeprg=
Bram Moolenaar314dd792019-02-03 15:27:20 +0100353This only works for a string option. For a number or boolean option you need
354to use the "<" flag, like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000355 :setlocal autoread<
Bram Moolenaar314dd792019-02-03 15:27:20 +0100356Note that for non-boolean and non-number options using "<" copies the global
357value to the local value, it doesn't switch back to using the global value
358(that matters when the global value changes later). You can also use: >
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000359 :set path<
360This will make the local value of 'path' empty, so that the global value is
361used. Thus it does the same as: >
362 :setlocal path=
Bram Moolenaar071d4272004-06-13 20:20:40 +0000363Note: In the future more global options can be made global-local. Using
364":setlocal" on a global option might work differently then.
365
366
367Setting the filetype
368
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200369:setf[iletype] [FALLBACK] {filetype} *:setf* *:setfiletype*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000370 Set the 'filetype' option to {filetype}, but only if
371 not done yet in a sequence of (nested) autocommands.
372 This is short for: >
373 :if !did_filetype()
374 : setlocal filetype={filetype}
375 :endif
376< This command is used in a filetype.vim file to avoid
377 setting the 'filetype' option twice, causing different
378 settings and syntax files to be loaded.
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200379
380 When the optional FALLBACK argument is present, a
381 later :setfiletype command will override the
Bram Moolenaar26967612019-03-17 17:13:16 +0100382 'filetype'. This is to be used for filetype
383 detections that are just a guess. |did_filetype()|
384 will return false after this command.
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200385
Bram Moolenaard58e9292011-02-09 17:07:58 +0100386 *option-window* *optwin*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000387:bro[wse] se[t] *:set-browse* *:browse-set* *:opt* *:options*
388:opt[ions] Open a window for viewing and setting all options.
389 Options are grouped by function.
390 Offers short help for each option. Hit <CR> on the
391 short help to open a help window with more help for
392 the option.
393 Modify the value of the option and hit <CR> on the
394 "set" line to set the new value. For window and
395 buffer specific options, the last accessed window is
396 used to set the option value in, unless this is a help
397 window, in which case the window below help window is
398 used (skipping the option-window).
Bram Moolenaarb5b75622018-03-09 22:22:21 +0100399 {not available when compiled without the |+eval|
400 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000401
402 *$HOME*
403Using "~" is like using "$HOME", but it is only recognized at the start of an
404option and after a space or comma.
405
406On Unix systems "~user" can be used too. It is replaced by the home directory
407of user "user". Example: >
408 :set path=~mool/include,/usr/include,.
409
410On Unix systems the form "${HOME}" can be used too. The name between {} can
411contain non-id characters then. Note that if you want to use this for the
412"gf" command, you need to add the '{' and '}' characters to 'isfname'.
413
414NOTE: expanding environment variables and "~/" is only done with the ":set"
415command, not when assigning a value to an option with ":let".
416
Bram Moolenaarc572da52017-08-27 16:52:01 +0200417 *$HOME-windows*
418On MS-Windows, if $HOME is not defined as an environment variable, then
419at runtime Vim will set it to the expansion of $HOMEDRIVE$HOMEPATH.
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200420If $HOMEDRIVE is not set then $USERPROFILE is used.
421
422This expanded value is not exported to the environment, this matters when
423running an external command: >
424 :echo system('set | findstr ^HOME=')
425and >
426 :echo luaeval('os.getenv("HOME")')
427should echo nothing (an empty string) despite exists('$HOME') being true.
428When setting $HOME to a non-empty string it will be exported to the
429subprocesses.
Bram Moolenaarc572da52017-08-27 16:52:01 +0200430
Bram Moolenaar071d4272004-06-13 20:20:40 +0000431
432Note the maximum length of an expanded option is limited. How much depends on
433the system, mostly it is something like 256 or 1024 characters.
434
435 *:fix* *:fixdel*
436:fix[del] Set the value of 't_kD':
437 't_kb' is 't_kD' becomes ~
438 CTRL-? CTRL-H
439 not CTRL-? CTRL-?
440
Bram Moolenaar6c60f472019-04-28 16:00:35 +0200441 (CTRL-? is 0177 octal, 0x7f hex)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000442
443 If your delete key terminal code is wrong, but the
444 code for backspace is alright, you can put this in
445 your .vimrc: >
446 :fixdel
447< This works no matter what the actual code for
448 backspace is.
449
450 If the backspace key terminal code is wrong you can
451 use this: >
452 :if &term == "termname"
453 : set t_kb=^V<BS>
454 : fixdel
455 :endif
456< Where "^V" is CTRL-V and "<BS>" is the backspace key
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000457 (don't type four characters!). Replace "termname"
Bram Moolenaar071d4272004-06-13 20:20:40 +0000458 with your terminal name.
459
460 If your <Delete> key sends a strange key sequence (not
461 CTRL-? or CTRL-H) you cannot use ":fixdel". Then use: >
462 :if &term == "termname"
463 : set t_kD=^V<Delete>
464 :endif
465< Where "^V" is CTRL-V and "<Delete>" is the delete key
466 (don't type eight characters!). Replace "termname"
467 with your terminal name.
468
469 *Linux-backspace*
470 Note about Linux: By default the backspace key
471 produces CTRL-?, which is wrong. You can fix it by
472 putting this line in your rc.local: >
473 echo "keycode 14 = BackSpace" | loadkeys
474<
475 *NetBSD-backspace*
476 Note about NetBSD: If your backspace doesn't produce
477 the right code, try this: >
478 xmodmap -e "keycode 22 = BackSpace"
479< If this works, add this in your .Xmodmap file: >
480 keysym 22 = BackSpace
481< You need to restart for this to take effect.
482
483==============================================================================
4842. Automatically setting options *auto-setting*
485
486Besides changing options with the ":set" command, there are three alternatives
487to set options automatically for one or more files:
488
4891. When starting Vim initializations are read from various places. See
490 |initialization|. Most of them are performed for all editing sessions,
491 and some of them depend on the directory where Vim is started.
492 You can create an initialization file with |:mkvimrc|, |:mkview| and
493 |:mksession|.
4942. If you start editing a new file, the automatic commands are executed.
495 This can be used to set options for files matching a particular pattern and
496 many other things. See |autocommand|.
4973. If you start editing a new file, and the 'modeline' option is on, a
498 number of lines at the beginning and end of the file are checked for
499 modelines. This is explained here.
500
501 *modeline* *vim:* *vi:* *ex:* *E520*
502There are two forms of modelines. The first form:
Bram Moolenaar664f3cf2019-12-07 16:03:51 +0100503 [text{white}]{vi:|vim:|ex:}[white]{options}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000504
Bram Moolenaar664f3cf2019-12-07 16:03:51 +0100505[text{white}] empty or any text followed by at least one blank
506 character (<Space> or <Tab>); "ex:" always requires at
507 least one blank character
Bram Moolenaar14b69452013-06-29 23:05:20 +0200508{vi:|vim:|ex:} the string "vi:", "vim:" or "ex:"
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200509[white] optional white space
510{options} a list of option settings, separated with white space
511 or ':', where each part between ':' is the argument
512 for a ":set" command (can be empty)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000513
Bram Moolenaar14b69452013-06-29 23:05:20 +0200514Examples:
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000515 vi:noai:sw=3 ts=6 ~
Bram Moolenaar14b69452013-06-29 23:05:20 +0200516 vim: tw=77 ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000517
518The second form (this is compatible with some versions of Vi):
519
Bram Moolenaarade0d392020-01-21 22:33:58 +0100520 [text{white}]{vi:|vim:|Vim:|ex:}[white]se[t] {options}:[text]
Bram Moolenaar071d4272004-06-13 20:20:40 +0000521
Bram Moolenaarade0d392020-01-21 22:33:58 +0100522[text{white}] empty or any text followed by at least one blank
523 character (<Space> or <Tab>); "ex:" always requires at
524 least one blank character
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200525{vi:|vim:|Vim:|ex:} the string "vi:", "vim:", "Vim:" or "ex:"
526[white] optional white space
Bram Moolenaar14b69452013-06-29 23:05:20 +0200527se[t] the string "set " or "se " (note the space); When
528 "Vim" is used it must be "set".
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200529{options} a list of options, separated with white space, which
530 is the argument for a ":set" command
531: a colon
532[text] any text or empty
Bram Moolenaar071d4272004-06-13 20:20:40 +0000533
Bram Moolenaar14b69452013-06-29 23:05:20 +0200534Examples:
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000535 /* vim: set ai tw=75: */ ~
Bram Moolenaar14b69452013-06-29 23:05:20 +0200536 /* Vim: set ai tw=75: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000537
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200538The white space before {vi:|vim:|Vim:|ex:} is required. This minimizes the
539chance that a normal word like "lex:" is caught. There is one exception:
540"vi:" and "vim:" can also be at the start of the line (for compatibility with
541version 3.0). Using "ex:" at the start of the line will be ignored (this
542could be short for "example:").
Bram Moolenaar071d4272004-06-13 20:20:40 +0000543
544 *modeline-local*
545The options are set like with ":setlocal": The new value only applies to the
Bram Moolenaar843ee412004-06-30 16:16:41 +0000546buffer and window that contain the file. Although it's possible to set global
547options from a modeline, this is unusual. If you have two windows open and
548the files in it set the same global option to a different value, the result
549depends on which one was opened last.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000550
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +0000551When editing a file that was already loaded, only the window-local options
552from the modeline are used. Thus if you manually changed a buffer-local
553option after opening the file, it won't be changed if you edit the same buffer
554in another window. But window-local options will be set.
555
Bram Moolenaar071d4272004-06-13 20:20:40 +0000556 *modeline-version*
557If the modeline is only to be used for some versions of Vim, the version
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200558number can be specified where "vim:" or "Vim:" is used:
Bram Moolenaar071d4272004-06-13 20:20:40 +0000559 vim{vers}: version {vers} or later
560 vim<{vers}: version before {vers}
561 vim={vers}: version {vers}
562 vim>{vers}: version after {vers}
Bram Moolenaar2b8388b2015-02-28 13:11:45 +0100563{vers} is 700 for Vim 7.0 (hundred times the major version plus minor).
564For example, to use a modeline only for Vim 7.0:
565 /* vim700: set foldmethod=marker */ ~
566To use a modeline for Vim after version 7.2:
567 /* vim>702: set cole=2: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000568There can be no blanks between "vim" and the ":".
569
570
571The number of lines that are checked can be set with the 'modelines' option.
572If 'modeline' is off or 'modelines' is 0 no lines are checked.
573
574Note that for the first form all of the rest of the line is used, thus a line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000575like:
576 /* vi:ts=4: */ ~
577will give an error message for the trailing "*/". This line is OK:
578 /* vi:set ts=4: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000579
580If an error is detected the rest of the line is skipped.
581
582If you want to include a ':' in a set command precede it with a '\'. The
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000583backslash in front of the ':' will be removed. Example:
Bram Moolenaar95a9dd12019-12-19 22:12:03 +0100584 /* vi:set fillchars=stl\:^,vert\:\|: */ ~
585This sets the 'fillchars' option to "stl:^,vert:\|". Only a single backslash
586before the ':' is removed. Thus to include "\:" you have to specify "\\:".
Bram Moolenaar110289e2019-05-23 15:38:06 +0200587 *E992*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000588No other commands than "set" are supported, for security reasons (somebody
Bram Moolenaar8243a792007-05-01 17:05:03 +0000589might create a Trojan horse text file with modelines). And not all options
Bram Moolenaar110289e2019-05-23 15:38:06 +0200590can be set. For some options a flag is set, so that when the value is used
591the |sandbox| is effective. Some options can only be set from the modeline
592when 'modelineexpr' is set (the default is off).
593
594Still, there is always a small risk that a modeline causes trouble. E.g.,
595when some joker sets 'textwidth' to 5 all your lines are wrapped unexpectedly.
596So disable modelines before editing untrusted text. The mail ftplugin does
597this, for example.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000598
599Hint: If you would like to do something else than setting an option, you could
600define an autocommand that checks the file for a specific string. For
601example: >
602 au BufReadPost * if getline(1) =~ "VAR" | call SetVar() | endif
603And define a function SetVar() that does something with the line containing
604"VAR".
605
606==============================================================================
6073. Options summary *option-summary*
608
609In the list below all the options are mentioned with their full name and with
610an abbreviation if there is one. Both forms may be used.
611
612In this document when a boolean option is "set" that means that ":set option"
613is entered. When an option is "reset", ":set nooption" is used.
614
615For some options there are two default values: The "Vim default", which is
616used when 'compatible' is not set, and the "Vi default", which is used when
617'compatible' is set.
618
619Most options are the same in all windows and buffers. There are a few that
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000620are specific to how the text is presented in a window. These can be set to a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000621different value in each window. For example the 'list' option can be set in
622one window and reset in another for the same text, giving both types of view
623at the same time. There are a few options that are specific to a certain
624file. These can have a different value for each file or buffer. For example
625the 'textwidth' option can be 78 for a normal text file and 0 for a C
626program.
627
628 global one option for all buffers and windows
629 local to window each window has its own copy of this option
630 local to buffer each buffer has its own copy of this option
631
632When creating a new window the option values from the currently active window
633are used as a default value for the window-specific options. For the
634buffer-specific options this depends on the 's' and 'S' flags in the
635'cpoptions' option. If 's' is included (which is the default) the values for
636buffer options are copied from the currently active buffer when a buffer is
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000637first entered. If 'S' is present the options are copied each time the buffer
638is entered, this is almost like having global options. If 's' and 'S' are not
Bram Moolenaar071d4272004-06-13 20:20:40 +0000639present, the options are copied from the currently active buffer when the
640buffer is created.
641
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000642Hidden options *hidden-options*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000643
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000644Not all options are supported in all versions. This depends on the supported
645features and sometimes on the system. A remark about this is in curly braces
646below. When an option is not supported it may still be set without getting an
647error, this is called a hidden option. You can't get the value of a hidden
648option though, it is not stored.
649
650To test if option "foo" can be used with ":set" use something like this: >
651 if exists('&foo')
652This also returns true for a hidden option. To test if option "foo" is really
653supported use something like this: >
654 if exists('+foo')
655<
Bram Moolenaar071d4272004-06-13 20:20:40 +0000656 *E355*
657A jump table for the options with a short description can be found at |Q_op|.
658
659 *'aleph'* *'al'* *aleph* *Aleph*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +0100660'aleph' 'al' number (default 128 for MS-Windows, 224 otherwise)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000661 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000662 {only available when compiled with the |+rightleft|
663 feature}
664 The ASCII code for the first letter of the Hebrew alphabet. The
665 routine that maps the keyboard in Hebrew mode, both in Insert mode
666 (when hkmap is set) and on the command-line (when hitting CTRL-_)
667 outputs the Hebrew characters in the range [aleph..aleph+26].
668 aleph=128 applies to PC code, and aleph=224 applies to ISO 8859-8.
669 See |rileft.txt|.
670
671 *'allowrevins'* *'ari'* *'noallowrevins'* *'noari'*
672'allowrevins' 'ari' boolean (default off)
673 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000674 {only available when compiled with the |+rightleft|
675 feature}
676 Allow CTRL-_ in Insert and Command-line mode. This is default off, to
677 avoid that users that accidentally type CTRL-_ instead of SHIFT-_ get
678 into reverse Insert mode, and don't know how to get out. See
679 'revins'.
680 NOTE: This option is reset when 'compatible' is set.
681
682 *'altkeymap'* *'akm'* *'noaltkeymap'* *'noakm'*
683'altkeymap' 'akm' boolean (default off)
684 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000685 {only available when compiled with the |+farsi|
686 feature}
Bram Moolenaar14184a32019-02-16 15:10:30 +0100687 This option was for using Farsi, which has been removed. See
688 |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000689
690 *'ambiwidth'* *'ambw'*
691'ambiwidth' 'ambw' string (default: "single")
692 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000693 Only effective when 'encoding' is "utf-8" or another Unicode encoding.
694 Tells Vim what to do with characters with East Asian Width Class
695 Ambiguous (such as Euro, Registered Sign, Copyright Sign, Greek
696 letters, Cyrillic letters).
697
698 There are currently two possible values:
Bram Moolenaar582fd852005-03-28 20:58:01 +0000699 "single": Use the same width as characters in US-ASCII. This is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000700 expected by most users.
701 "double": Use twice the width of ASCII characters.
Bram Moolenaar5c3bd0a2010-08-04 20:55:44 +0200702 *E834* *E835*
703 The value "double" cannot be used if 'listchars' or 'fillchars'
Bram Moolenaar08aac3c2020-08-28 21:04:24 +0200704
705 The values are overruled for characters specified with
706 |setcellwidths()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000707
708 There are a number of CJK fonts for which the width of glyphs for
709 those characters are solely based on how many octets they take in
710 legacy/traditional CJK encodings. In those encodings, Euro,
711 Registered sign, Greek/Cyrillic letters are represented by two octets,
Bram Moolenaar582fd852005-03-28 20:58:01 +0000712 therefore those fonts have "wide" glyphs for them. This is also
Bram Moolenaar071d4272004-06-13 20:20:40 +0000713 true of some line drawing characters used to make tables in text
Bram Moolenaar582fd852005-03-28 20:58:01 +0000714 file. Therefore, when a CJK font is used for GUI Vim or
Bram Moolenaar071d4272004-06-13 20:20:40 +0000715 Vim is running inside a terminal (emulators) that uses a CJK font
716 (or Vim is run inside an xterm invoked with "-cjkwidth" option.),
717 this option should be set to "double" to match the width perceived
718 by Vim with the width of glyphs in the font. Perhaps it also has
Bram Moolenaar8024f932020-01-14 19:29:13 +0100719 to be set to "double" under CJK MS-Windows when the system locale is
720 set to one of CJK locales. See Unicode Standard Annex #11
721 (http://www.unicode.org/reports/tr11).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000722
Bram Moolenaarac7bd632013-03-19 11:35:58 +0100723 Vim may set this option automatically at startup time when Vim is
724 compiled with the |+termresponse| feature and if |t_u7| is set to the
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200725 escape sequence to request cursor position report. The response can
726 be found in |v:termu7resp|.
Bram Moolenaarac7bd632013-03-19 11:35:58 +0100727
Bram Moolenaar071d4272004-06-13 20:20:40 +0000728 *'antialias'* *'anti'* *'noantialias'* *'noanti'*
729'antialias' 'anti' boolean (default: off)
730 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000731 {only available when compiled with GUI enabled
Bram Moolenaar3d1cde82020-08-15 18:55:18 +0200732 on macOS}
733 This option only has an effect in the GUI version of Vim on macOS
Bram Moolenaar071d4272004-06-13 20:20:40 +0000734 v10.2 or later. When on, Vim will use smooth ("antialiased") fonts,
735 which can be easier to read at certain sizes on certain displays.
736 Setting this option can sometimes cause problems if 'guifont' is set
737 to its default (empty string).
Bram Moolenaar036986f2017-03-16 17:41:02 +0100738 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000739
740 *'autochdir'* *'acd'* *'noautochdir'* *'noacd'*
741'autochdir' 'acd' boolean (default off)
742 global
Bram Moolenaar00a927d2010-05-14 23:24:24 +0200743 {only available when compiled with it, use
744 exists("+autochdir") to check}
Bram Moolenaard8c00872005-07-22 21:52:15 +0000745 When on, Vim will change the current working directory whenever you
746 open a file, switch buffers, delete a buffer or open/close a window.
747 It will change to the directory containing the file which was opened
748 or selected.
Bram Moolenaar910f66f2006-04-05 20:41:53 +0000749 Note: When this option is on some plugins may not work.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000750
751 *'arabic'* *'arab'* *'noarabic'* *'noarab'*
752'arabic' 'arab' boolean (default off)
753 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +0000754 {only available when compiled with the |+arabic|
755 feature}
756 This option can be set to start editing Arabic text.
757 Setting this option will:
758 - Set the 'rightleft' option, unless 'termbidi' is set.
759 - Set the 'arabicshape' option, unless 'termbidi' is set.
760 - Set the 'keymap' option to "arabic"; in Insert mode CTRL-^ toggles
761 between typing English and Arabic key mapping.
762 - Set the 'delcombine' option
763 Note that 'encoding' must be "utf-8" for working with Arabic text.
764
765 Resetting this option will:
766 - Reset the 'rightleft' option.
767 - Disable the use of 'keymap' (without changing its value).
768 Note that 'arabicshape' and 'delcombine' are not reset (it is a global
Bram Moolenaarc8734422012-06-01 22:38:45 +0200769 option).
Bram Moolenaar036986f2017-03-16 17:41:02 +0100770 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000771 Also see |arabic.txt|.
772
773 *'arabicshape'* *'arshape'*
774 *'noarabicshape'* *'noarshape'*
775'arabicshape' 'arshape' boolean (default on)
776 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000777 {only available when compiled with the |+arabic|
778 feature}
779 When on and 'termbidi' is off, the required visual character
780 corrections that need to take place for displaying the Arabic language
Bram Moolenaar3a0d8092012-10-21 03:02:54 +0200781 take effect. Shaping, in essence, gets enabled; the term is a broad
Bram Moolenaar071d4272004-06-13 20:20:40 +0000782 one which encompasses:
783 a) the changing/morphing of characters based on their location
784 within a word (initial, medial, final and stand-alone).
785 b) the enabling of the ability to compose characters
786 c) the enabling of the required combining of some characters
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100787 When disabled the display shows each character's true stand-alone
788 form.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000789 Arabic is a complex language which requires other settings, for
790 further details see |arabic.txt|.
Bram Moolenaar036986f2017-03-16 17:41:02 +0100791 NOTE: This option is set when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000792
793 *'autoindent'* *'ai'* *'noautoindent'* *'noai'*
794'autoindent' 'ai' boolean (default off)
795 local to buffer
796 Copy indent from current line when starting a new line (typing <CR>
797 in Insert mode or when using the "o" or "O" command). If you do not
798 type anything on the new line except <BS> or CTRL-D and then type
Bram Moolenaar02467872007-05-06 13:22:01 +0000799 <Esc>, CTRL-O or <CR>, the indent is deleted again. Moving the cursor
800 to another line has the same effect, unless the 'I' flag is included
801 in 'cpoptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000802 When autoindent is on, formatting (with the "gq" command or when you
803 reach 'textwidth' in Insert mode) uses the indentation of the first
804 line.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000805 When 'smartindent' or 'cindent' is on the indent is changed in
806 a different way.
Bram Moolenaarca635012015-09-25 20:34:21 +0200807 The 'autoindent' option is reset when the 'paste' option is set and
808 restored when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000809
810 *'autoread'* *'ar'* *'noautoread'* *'noar'*
811'autoread' 'ar' boolean (default off)
812 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000813 When a file has been detected to have been changed outside of Vim and
814 it has not been changed inside of Vim, automatically read it again.
Bram Moolenaarfd358112018-07-07 23:21:31 +0200815 When the file has been deleted this is not done, so you have the text
816 from before it was deleted. When it appears again then it is read.
817 |timestamp|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000818 If this option has a local value, use this command to switch back to
819 using the global value: >
820 :set autoread<
821<
822 *'autowrite'* *'aw'* *'noautowrite'* *'noaw'*
823'autowrite' 'aw' boolean (default off)
824 global
825 Write the contents of the file, if it has been modified, on each
826 :next, :rewind, :last, :first, :previous, :stop, :suspend, :tag, :!,
Bram Moolenaar14716812006-05-04 21:54:08 +0000827 :make, CTRL-] and CTRL-^ command; and when a :buffer, CTRL-O, CTRL-I,
Bram Moolenaar071d4272004-06-13 20:20:40 +0000828 '{A-Z0-9}, or `{A-Z0-9} command takes one to another file.
829 Note that for some commands the 'autowrite' option is not used, see
830 'autowriteall' for that.
Bram Moolenaar93a1df22018-09-10 11:51:50 +0200831 Some buffers will not be written, specifically when 'buftype' is
Bram Moolenaar20aac6c2018-09-02 21:07:30 +0200832 "nowrite", "nofile", "terminal" or "prompt".
Bram Moolenaar071d4272004-06-13 20:20:40 +0000833
834 *'autowriteall'* *'awa'* *'noautowriteall'* *'noawa'*
835'autowriteall' 'awa' boolean (default off)
836 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000837 Like 'autowrite', but also used for commands ":edit", ":enew", ":quit",
838 ":qall", ":exit", ":xit", ":recover" and closing the Vim window.
839 Setting this option also implies that Vim behaves like 'autowrite' has
840 been set.
841
842 *'background'* *'bg'*
Bram Moolenaar446beb42011-05-10 17:18:44 +0200843'background' 'bg' string (default "dark" or "light", see below)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000844 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000845 When set to "dark", Vim will try to use colors that look good on a
846 dark background. When set to "light", Vim will try to use colors that
847 look good on a light background. Any other value is illegal.
848 Vim tries to set the default value according to the terminal used.
849 This will not always be correct.
850 Setting this option does not change the background color, it tells Vim
851 what the background color looks like. For changing the background
852 color, see |:hi-normal|.
853
854 When 'background' is set Vim will adjust the default color groups for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000855 the new value. But the colors used for syntax highlighting will not
Bram Moolenaar446cb832008-06-24 21:56:24 +0000856 change. *g:colors_name*
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100857 When a color scheme is loaded (the "g:colors_name" variable is set)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000858 setting 'background' will cause the color scheme to be reloaded. If
859 the color scheme adjusts to the value of 'background' this will work.
860 However, if the color scheme sets 'background' itself the effect may
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100861 be undone. First delete the "g:colors_name" variable when needed.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000862
863 When setting 'background' to the default value with: >
864 :set background&
865< Vim will guess the value. In the GUI this should work correctly,
866 in other cases Vim might not be able to guess the right value.
Bram Moolenaar2e693a82019-10-16 22:35:02 +0200867 If the GUI supports a dark theme, you can use the "d" flag in
Bram Moolenaar50bf7ce2019-09-15 13:17:00 +0200868 'guioptions', see 'go-d'.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000869
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200870 When the |t_RB| option is set, Vim will use it to request the background
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +0200871 color from the terminal. If the returned RGB value is dark/light and
872 'background' is not dark/light, 'background' will be set and the
873 screen is redrawn. This may have side effects, make t_BG empty in
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200874 your .vimrc if you suspect this problem. The response to |t_RB| can
Bram Moolenaar01164a62017-11-02 22:58:42 +0100875 be found in |v:termrbgresp|.
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +0200876
Bram Moolenaar071d4272004-06-13 20:20:40 +0000877 When starting the GUI, the default value for 'background' will be
878 "light". When the value is not set in the .gvimrc, and Vim detects
879 that the background is actually quite dark, 'background' is set to
880 "dark". But this happens only AFTER the .gvimrc file has been read
881 (because the window needs to be opened to find the actual background
882 color). To get around this, force the GUI window to be opened by
883 putting a ":gui" command in the .gvimrc file, before where the value
884 of 'background' is used (e.g., before ":syntax on").
Bram Moolenaar446beb42011-05-10 17:18:44 +0200885
Bram Moolenaar6f345a12019-12-17 21:27:18 +0100886 For MS-Windows the default is "dark".
Bram Moolenaar446beb42011-05-10 17:18:44 +0200887 For other systems "dark" is used when 'term' is "linux",
888 "screen.linux", "cygwin" or "putty", or $COLORFGBG suggests a dark
889 background. Otherwise the default is "light".
890
Bram Moolenaarc572da52017-08-27 16:52:01 +0200891 The |:terminal| command and the |term_start()| function use the
892 'background' value to decide whether the terminal window will start
893 with a white or black background.
894
Bram Moolenaar071d4272004-06-13 20:20:40 +0000895 Normally this option would be set in the .vimrc file. Possibly
896 depending on the terminal name. Example: >
897 :if &term == "pcterm"
898 : set background=dark
899 :endif
900< When this option is set, the default settings for the highlight groups
901 will change. To use other settings, place ":highlight" commands AFTER
902 the setting of the 'background' option.
903 This option is also used in the "$VIMRUNTIME/syntax/syntax.vim" file
904 to select the colors for syntax highlighting. After changing this
905 option, you must load syntax.vim again to see the result. This can be
906 done with ":syntax on".
907
908 *'backspace'* *'bs'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +0200909'backspace' 'bs' string (default "", set to "indent,eol,start"
910 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000911 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000912 Influences the working of <BS>, <Del>, CTRL-W and CTRL-U in Insert
913 mode. This is a list of items, separated by commas. Each item allows
914 a way to backspace over something:
915 value effect ~
916 indent allow backspacing over autoindent
917 eol allow backspacing over line breaks (join lines)
918 start allow backspacing over the start of insert; CTRL-W and CTRL-U
919 stop once at the start of insert.
Bram Moolenaaraa0489e2020-04-17 19:41:21 +0200920 nostop like start, except CTRL-W and CTRL-U do not stop at the start of
921 insert.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000922
923 When the value is empty, Vi compatible backspacing is used.
924
925 For backwards compatibility with version 5.4 and earlier:
926 value effect ~
927 0 same as ":set backspace=" (Vi compatible)
928 1 same as ":set backspace=indent,eol"
929 2 same as ":set backspace=indent,eol,start"
Bram Moolenaaraa0489e2020-04-17 19:41:21 +0200930 3 same as ":set backspace=indent,eol,nostop"
Bram Moolenaar071d4272004-06-13 20:20:40 +0000931
932 See |:fixdel| if your <BS> or <Del> key does not do what you want.
933 NOTE: This option is set to "" when 'compatible' is set.
934
935 *'backup'* *'bk'* *'nobackup'* *'nobk'*
936'backup' 'bk' boolean (default off)
937 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000938 Make a backup before overwriting a file. Leave it around after the
939 file has been successfully written. If you do not want to keep the
940 backup file, but you do want a backup while the file is being
941 written, reset this option and set the 'writebackup' option (this is
942 the default). If you do not want a backup file at all reset both
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000943 options (use this if your file system is almost full). See the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000944 |backup-table| for more explanations.
945 When the 'backupskip' pattern matches, a backup is not made anyway.
946 When 'patchmode' is set, the backup may be renamed to become the
947 oldest version of a file.
948 NOTE: This option is reset when 'compatible' is set.
949
950 *'backupcopy'* *'bkc'*
951'backupcopy' 'bkc' string (Vi default for Unix: "yes", otherwise: "auto")
Bram Moolenaarb8ee25a2014-09-23 15:45:08 +0200952 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000953 When writing a file and a backup is made, this option tells how it's
954 done. This is a comma separated list of words.
955
956 The main values are:
957 "yes" make a copy of the file and overwrite the original one
958 "no" rename the file and write a new one
959 "auto" one of the previous, what works best
960
961 Extra values that can be combined with the ones above are:
962 "breaksymlink" always break symlinks when writing
963 "breakhardlink" always break hardlinks when writing
964
965 Making a copy and overwriting the original file:
966 - Takes extra time to copy the file.
967 + When the file has special attributes, is a (hard/symbolic) link or
968 has a resource fork, all this is preserved.
969 - When the file is a link the backup will have the name of the link,
970 not of the real file.
971
972 Renaming the file and writing a new one:
973 + It's fast.
974 - Sometimes not all attributes of the file can be copied to the new
975 file.
976 - When the file is a link the new file will not be a link.
977
978 The "auto" value is the middle way: When Vim sees that renaming file
979 is possible without side effects (the attributes can be passed on and
Bram Moolenaar02467872007-05-06 13:22:01 +0000980 the file is not a link) that is used. When problems are expected, a
981 copy will be made.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000982
983 The "breaksymlink" and "breakhardlink" values can be used in
984 combination with any of "yes", "no" and "auto". When included, they
985 force Vim to always break either symbolic or hard links by doing
986 exactly what the "no" option does, renaming the original file to
987 become the backup and writing a new file in its place. This can be
988 useful for example in source trees where all the files are symbolic or
989 hard links and any changes should stay in the local source tree, not
990 be propagated back to the original source.
991 *crontab*
992 One situation where "no" and "auto" will cause problems: A program
993 that opens a file, invokes Vim to edit that file, and then tests if
994 the open file was changed (through the file descriptor) will check the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000995 backup file instead of the newly created file. "crontab -e" is an
Bram Moolenaar071d4272004-06-13 20:20:40 +0000996 example.
997
998 When a copy is made, the original file is truncated and then filled
999 with the new text. This means that protection bits, owner and
1000 symbolic links of the original file are unmodified. The backup file
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001001 however, is a new file, owned by the user who edited the file. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00001002 group of the backup is set to the group of the original file. If this
1003 fails, the protection bits for the group are made the same as for
1004 others.
1005
1006 When the file is renamed this is the other way around: The backup has
1007 the same attributes of the original file, and the newly written file
1008 is owned by the current user. When the file was a (hard/symbolic)
1009 link, the new file will not! That's why the "auto" value doesn't
1010 rename when the file is a link. The owner and group of the newly
1011 written file will be set to the same ones as the original file, but
1012 the system may refuse to do this. In that case the "auto" value will
1013 again not rename the file.
1014
Bram Moolenaar036986f2017-03-16 17:41:02 +01001015 NOTE: This option is set to the Vi default value when 'compatible' is
1016 set and to the Vim default value when 'compatible' is reset.
1017
Bram Moolenaar071d4272004-06-13 20:20:40 +00001018 *'backupdir'* *'bdir'*
1019'backupdir' 'bdir' string (default for Amiga: ".,t:",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01001020 for Win32: ".,$TEMP,c:/tmp,c:/temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001021 for Unix: ".,~/tmp,~/")
1022 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001023 List of directories for the backup file, separated with commas.
1024 - The backup file will be created in the first directory in the list
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001025 where this is possible. The directory must exist, Vim will not
1026 create it for you.
Bram Moolenaar3848e002016-03-19 18:42:29 +01001027 - Empty means that no backup file will be created ('patchmode' is
Bram Moolenaar071d4272004-06-13 20:20:40 +00001028 impossible!). Writing may fail because of this.
1029 - A directory "." means to put the backup file in the same directory
1030 as the edited file.
Bram Moolenaar8024f932020-01-14 19:29:13 +01001031 - A directory starting with "./" (or ".\" for MS-Windows) means to put
1032 the backup file relative to where the edited file is. The leading
1033 "." is replaced with the path name of the edited file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001034 ("." inside a directory name has no special meaning).
1035 - Spaces after the comma are ignored, other spaces are considered part
1036 of the directory name. To have a space at the start of a directory
1037 name, precede it with a backslash.
1038 - To include a comma in a directory name precede it with a backslash.
1039 - A directory name may end in an '/'.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02001040 - For Unix and Win32, if a directory ends in two path separators "//",
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01001041 the backup file name will be built from the complete path to the
1042 file with all path separators changed to percent '%' signs. This
1043 will ensure file name uniqueness in the backup directory.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02001044 On Win32, it is also possible to end with "\\". However, When a
1045 separating comma is following, you must use "//", since "\\" will
1046 include the comma in the file name. Therefore it is recommended to
1047 use '//', instead of '\\'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001048 - Environment variables are expanded |:set_env|.
1049 - Careful with '\' characters, type one before a space, type two to
1050 get one in the option (see |option-backslash|), for example: >
1051 :set bdir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
1052< - For backwards compatibility with Vim version 3.0 a '>' at the start
1053 of the option is removed.
1054 See also 'backup' and 'writebackup' options.
1055 If you want to hide your backup files on Unix, consider this value: >
1056 :set backupdir=./.backup,~/.backup,.,/tmp
1057< You must create a ".backup" directory in each directory and in your
1058 home directory for this to work properly.
1059 The use of |:set+=| and |:set-=| is preferred when adding or removing
1060 directories from the list. This avoids problems when a future version
1061 uses another default.
1062 This option cannot be set from a |modeline| or in the |sandbox|, for
1063 security reasons.
1064
1065 *'backupext'* *'bex'* *E589*
1066'backupext' 'bex' string (default "~", for VMS: "_")
1067 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001068 String which is appended to a file name to make the name of the
1069 backup file. The default is quite unusual, because this avoids
1070 accidentally overwriting existing files with a backup file. You might
1071 prefer using ".bak", but make sure that you don't have files with
1072 ".bak" that you want to keep.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001073 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001074
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001075 If you like to keep a lot of backups, you could use a BufWritePre
1076 autocommand to change 'backupext' just before writing the file to
1077 include a timestamp. >
1078 :au BufWritePre * let &bex = '-' . strftime("%Y%b%d%X") . '~'
1079< Use 'backupdir' to put the backup in a different directory.
1080
Bram Moolenaar071d4272004-06-13 20:20:40 +00001081 *'backupskip'* *'bsk'*
Bram Moolenaarb8e22a02018-04-12 21:37:34 +02001082'backupskip' 'bsk' string (default: "$TMPDIR/*,$TMP/*,$TEMP/*"
1083 Unix: "/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*"
1084 Mac: "/private/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001085 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001086 {not available when compiled without the |+wildignore|
1087 feature}
1088 A list of file patterns. When one of the patterns matches with the
1089 name of the file which is written, no backup file is created. Both
1090 the specified file name and the full path name of the file are used.
1091 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
1092 Watch out for special characters, see |option-backslash|.
1093 When $TMPDIR, $TMP or $TEMP is not defined, it is not used for the
Bram Moolenaar582fd852005-03-28 20:58:01 +00001094 default value. "/tmp/*" is only used for Unix.
Bram Moolenaar02467872007-05-06 13:22:01 +00001095
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02001096 WARNING: Not having a backup file means that when Vim fails to write
1097 your buffer correctly and then, for whatever reason, Vim exits, you
1098 lose both the original file and what you were writing. Only disable
1099 backups if you don't care about losing the file.
1100
Bram Moolenaar02467872007-05-06 13:22:01 +00001101 Note that environment variables are not expanded. If you want to use
1102 $HOME you must expand it explicitly, e.g.: >
Bram Moolenaar7c1c6db2016-04-03 22:08:05 +02001103 :let &backupskip = escape(expand('$HOME'), '\') . '/tmp/*'
Bram Moolenaar02467872007-05-06 13:22:01 +00001104
1105< Note that the default also makes sure that "crontab -e" works (when a
Bram Moolenaara5792f52005-11-23 21:25:05 +00001106 backup would be made by renaming the original file crontab won't see
1107 the newly created file). Also see 'backupcopy' and |crontab|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001108
1109 *'balloondelay'* *'bdlay'*
1110'balloondelay' 'bdlay' number (default: 600)
1111 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001112 {only available when compiled with the |+balloon_eval|
1113 feature}
1114 Delay in milliseconds before a balloon may pop up. See |balloon-eval|.
1115
1116 *'ballooneval'* *'beval'* *'noballooneval'* *'nobeval'*
1117'ballooneval' 'beval' boolean (default off)
1118 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001119 {only available when compiled with the |+balloon_eval|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001120 feature}
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001121 Switch on the |balloon-eval| functionality for the GUI.
1122
1123 *'balloonevalterm'* *'bevalterm'* *'noballoonevalterm'*
1124 *'nobevalterm'*
1125'balloonevalterm' 'bevalterm' boolean (default off)
1126 global
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001127 {only available when compiled with the
1128 |+balloon_eval_term| feature}
1129 Switch on the |balloon-eval| functionality for the terminal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001130
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001131 *'balloonexpr'* *'bexpr'*
1132'balloonexpr' 'bexpr' string (default "")
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00001133 global or local to buffer |global-local|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001134 {only available when compiled with the |+balloon_eval|
1135 feature}
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00001136 Expression for text to show in evaluation balloon. It is only used
Bram Moolenaara6c27c42019-05-09 19:16:22 +02001137 when 'ballooneval' or 'balloonevalterm' is on. These variables can be
1138 used:
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001139
1140 v:beval_bufnr number of the buffer in which balloon is going to show
1141 v:beval_winnr number of the window
Bram Moolenaar82af8712016-06-04 20:20:29 +02001142 v:beval_winid ID of the window
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001143 v:beval_lnum line number
1144 v:beval_col column number (byte index)
1145 v:beval_text word under or after the mouse pointer
1146
Bram Moolenaar54775062019-07-31 21:07:14 +02001147 Instead of showing a balloon, which is limited to plain text, consider
1148 using a popup window, see |popup_beval_example|. A popup window can
1149 use highlighting and show a border.
1150
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001151 The evaluation of the expression must not have side effects!
1152 Example: >
Bram Moolenaara6c27c42019-05-09 19:16:22 +02001153 function MyBalloonExpr()
Bram Moolenaar45360022005-07-21 21:08:21 +00001154 return 'Cursor is at line ' . v:beval_lnum .
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001155 \', column ' . v:beval_col .
1156 \ ' of file ' . bufname(v:beval_bufnr) .
1157 \ ' on word "' . v:beval_text . '"'
1158 endfunction
1159 set bexpr=MyBalloonExpr()
1160 set ballooneval
1161<
Bram Moolenaar396e8292019-07-13 23:04:31 +02001162 Also see |balloon_show()|, it can be used if the content of the balloon
1163 is to be fetched asynchronously. In that case evaluating
1164 'balloonexpr' should result in an empty string. If you get a balloon
1165 with only "0" you probably didn't return anything from your function.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001166
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001167 NOTE: The balloon is displayed only if the cursor is on a text
1168 character. If the result of evaluating 'balloonexpr' is not empty,
1169 Vim does not try to send a message to an external debugger (Netbeans
1170 or Sun Workshop).
1171
Bram Moolenaar30b65812012-07-12 22:01:11 +02001172 The expression will be evaluated in the |sandbox| when set from a
1173 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02001174 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001175
1176 It is not allowed to change text or jump to another window while
Bram Moolenaar396e8292019-07-13 23:04:31 +02001177 evaluating 'balloonexpr', see |textlock|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001178
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001179 To check whether line breaks in the balloon text work use this check: >
Bram Moolenaar45360022005-07-21 21:08:21 +00001180 if has("balloon_multiline")
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001181< When they are supported "\n" characters will start a new line. If the
1182 expression evaluates to a |List| this is equal to using each List item
1183 as a string and putting "\n" in between them.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001184 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001185
Bram Moolenaar165bc692015-07-21 17:53:25 +02001186 *'belloff'* *'bo'*
1187'belloff' 'bo' string (default "")
1188 global
Bram Moolenaar165bc692015-07-21 17:53:25 +02001189 Specifies for which events the bell will not be rung. It is a comma
1190 separated list of items. For each item that is present, the bell
1191 will be silenced. This is most useful to specify specific events in
1192 insert mode to be silenced.
1193
1194 item meaning when present ~
1195 all All events.
1196 backspace When hitting <BS> or <Del> and deleting results in an
1197 error.
1198 cursor Fail to move around using the cursor keys or
1199 <PageUp>/<PageDown> in |Insert-mode|.
1200 complete Error occurred when using |i_CTRL-X_CTRL-K| or
1201 |i_CTRL-X_CTRL-T|.
1202 copy Cannot copy char from insert mode using |i_CTRL-Y| or
1203 |i_CTRL-E|.
1204 ctrlg Unknown Char after <C-G> in Insert mode.
1205 error Other Error occurred (e.g. try to join last line)
1206 (mostly used in |Normal-mode| or |Cmdline-mode|).
1207 esc hitting <Esc> in |Normal-mode|.
1208 ex In |Visual-mode|, hitting |Q| results in an error.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01001209 hangul Ignored.
Bram Moolenaar165bc692015-07-21 17:53:25 +02001210 insertmode Pressing <Esc> in 'insertmode'.
1211 lang Calling the beep module for Lua/Mzscheme/TCL.
1212 mess No output available for |g<|.
1213 showmatch Error occurred for 'showmatch' function.
1214 operator Empty region error |cpo-E|.
1215 register Unknown register after <C-R> in |Insert-mode|.
1216 shell Bell from shell output |:!|.
1217 spell Error happened on spell suggest.
1218 wildmode More matches in |cmdline-completion| available
1219 (depends on the 'wildmode' setting).
1220
Bram Moolenaar036986f2017-03-16 17:41:02 +01001221 This is most useful to fine tune when in Insert mode the bell should
1222 be rung. For Normal mode and Ex commands, the bell is often rung to
Bram Moolenaar165bc692015-07-21 17:53:25 +02001223 indicate that an error occurred. It can be silenced by adding the
1224 "error" keyword.
1225
Bram Moolenaar071d4272004-06-13 20:20:40 +00001226 *'binary'* *'bin'* *'nobinary'* *'nobin'*
1227'binary' 'bin' boolean (default off)
1228 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001229 This option should be set before editing a binary file. You can also
1230 use the |-b| Vim argument. When this option is switched on a few
1231 options will be changed (also when it already was on):
1232 'textwidth' will be set to 0
1233 'wrapmargin' will be set to 0
1234 'modeline' will be off
1235 'expandtab' will be off
1236 Also, 'fileformat' and 'fileformats' options will not be used, the
1237 file is read and written like 'fileformat' was "unix" (a single <NL>
1238 separates lines).
1239 The 'fileencoding' and 'fileencodings' options will not be used, the
1240 file is read without conversion.
1241 NOTE: When you start editing a(nother) file while the 'bin' option is
1242 on, settings from autocommands may change the settings again (e.g.,
1243 'textwidth'), causing trouble when editing. You might want to set
1244 'bin' again when the file has been loaded.
1245 The previous values of these options are remembered and restored when
1246 'bin' is switched from on to off. Each buffer has its own set of
1247 saved option values.
1248 To edit a file with 'binary' set you can use the |++bin| argument.
1249 This avoids you have to do ":set bin", which would have effect for all
1250 files you edit.
1251 When writing a file the <EOL> for the last line is only written if
1252 there was one in the original file (normally Vim appends an <EOL> to
1253 the last line if there is none; this would make the file longer). See
1254 the 'endofline' option.
1255
1256 *'bioskey'* *'biosk'* *'nobioskey'* *'nobiosk'*
1257'bioskey' 'biosk' boolean (default on)
1258 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02001259 {only for MS-DOS}
Bram Moolenaarf3913272016-02-25 00:00:01 +01001260 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001261
1262 *'bomb'* *'nobomb'*
1263'bomb' boolean (default off)
1264 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001265 When writing a file and the following conditions are met, a BOM (Byte
1266 Order Mark) is prepended to the file:
1267 - this option is on
1268 - the 'binary' option is off
1269 - 'fileencoding' is "utf-8", "ucs-2", "ucs-4" or one of the little/big
1270 endian variants.
1271 Some applications use the BOM to recognize the encoding of the file.
1272 Often used for UCS-2 files on MS-Windows. For other applications it
1273 causes trouble, for example: "cat file1 file2" makes the BOM of file2
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001274 appear halfway the resulting file. Gcc doesn't accept a BOM.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001275 When Vim reads a file and 'fileencodings' starts with "ucs-bom", a
1276 check for the presence of the BOM is done and 'bomb' set accordingly.
1277 Unless 'binary' is set, it is removed from the first line, so that you
1278 don't see it when editing. When you don't change the options, the BOM
1279 will be restored when writing the file.
1280
1281 *'breakat'* *'brk'*
1282'breakat' 'brk' string (default " ^I!@*-+;:,./?")
1283 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02001284 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001285 feature}
1286 This option lets you choose which characters might cause a line
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00001287 break if 'linebreak' is on. Only works for ASCII and also for 8-bit
1288 characters when 'encoding' is an 8-bit encoding.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001289
Bram Moolenaar7c1c6db2016-04-03 22:08:05 +02001290 *'breakindent'* *'bri'* *'nobreakindent'* *'nobri'*
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001291'breakindent' 'bri' boolean (default off)
1292 local to window
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001293 {not available when compiled without the |+linebreak|
1294 feature}
1295 Every wrapped line will continue visually indented (same amount of
1296 space as the beginning of that line), thus preserving horizontal blocks
1297 of text.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001298 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001299
1300 *'breakindentopt'* *'briopt'*
1301'breakindentopt' 'briopt' string (default empty)
1302 local to window
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001303 {not available when compiled without the |+linebreak|
1304 feature}
1305 Settings for 'breakindent'. It can consist of the following optional
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001306 items and must be separated by a comma:
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001307 min:{n} Minimum text width that will be kept after
1308 applying 'breakindent', even if the resulting
1309 text should normally be narrower. This prevents
1310 text indented almost to the right window border
1311 occupying lot of vertical space when broken.
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001312 shift:{n} After applying 'breakindent', the wrapped line's
1313 beginning will be shifted by the given number of
1314 characters. It permits dynamic French paragraph
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001315 indentation (negative) or emphasizing the line
1316 continuation (positive).
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01001317 sbr Display the 'showbreak' value before applying the
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001318 additional indent.
1319 The default value for min is 20 and shift is 0.
1320
Bram Moolenaar071d4272004-06-13 20:20:40 +00001321 *'browsedir'* *'bsdir'*
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001322'browsedir' 'bsdir' string (default: "last")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001323 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02001324 {only for Motif, Athena, GTK, Mac and Win32 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001325 Which directory to use for the file browser:
Bram Moolenaar446cb832008-06-24 21:56:24 +00001326 last Use same directory as with last file browser, where a
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02001327 file was opened or saved.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001328 buffer Use the directory of the related buffer.
1329 current Use the current directory.
1330 {path} Use the specified directory
1331
1332 *'bufhidden'* *'bh'*
1333'bufhidden' 'bh' string (default: "")
1334 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001335 This option specifies what happens when a buffer is no longer
1336 displayed in a window:
1337 <empty> follow the global 'hidden' option
1338 hide hide the buffer (don't unload it), also when 'hidden'
1339 is not set
1340 unload unload the buffer, also when 'hidden' is set or using
1341 |:hide|
1342 delete delete the buffer from the buffer list, also when
1343 'hidden' is set or using |:hide|, like using
1344 |:bdelete|
1345 wipe wipe out the buffer from the buffer list, also when
1346 'hidden' is set or using |:hide|, like using
1347 |:bwipeout|
1348
Bram Moolenaara14de3d2005-01-07 21:48:26 +00001349 CAREFUL: when "unload", "delete" or "wipe" is used changes in a buffer
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01001350 are lost without a warning. Also, these values may break autocommands
1351 that switch between buffers temporarily.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001352 This option is used together with 'buftype' and 'swapfile' to specify
1353 special kinds of buffers. See |special-buffers|.
1354
1355 *'buflisted'* *'bl'* *'nobuflisted'* *'nobl'* *E85*
1356'buflisted' 'bl' boolean (default: on)
1357 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001358 When this option is set, the buffer shows up in the buffer list. If
1359 it is reset it is not used for ":bnext", "ls", the Buffers menu, etc.
1360 This option is reset by Vim for buffers that are only used to remember
1361 a file name or marks. Vim sets it when starting to edit a buffer.
1362 But not when moving to a buffer with ":buffer".
1363
1364 *'buftype'* *'bt'* *E382*
1365'buftype' 'bt' string (default: "")
1366 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001367 The value of this option specifies the type of a buffer:
1368 <empty> normal buffer
1369 nofile buffer which is not related to a file and will not be
1370 written
1371 nowrite buffer which will not be written
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001372 acwrite buffer which will always be written with BufWriteCmd
Bram Moolenaarb5b75622018-03-09 22:22:21 +01001373 autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001374 quickfix quickfix buffer, contains list of errors |:cwindow|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001375 or list of locations |:lwindow|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001376 help help buffer (you are not supposed to set this
1377 manually)
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02001378 terminal buffer for a |terminal| (you are not supposed to set
1379 this manually)
Bram Moolenaarf2732452018-06-03 14:47:35 +02001380 prompt buffer where only the last line can be edited, meant
1381 to be used by a plugin, see |prompt-buffer|
1382 {only when compiled with the |+channel| feature}
Bram Moolenaar4d784b22019-05-25 19:51:39 +02001383 popup buffer used in a popup window, see |popup|.
1384 {only when compiled with the |+textprop| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001385
1386 This option is used together with 'bufhidden' and 'swapfile' to
1387 specify special kinds of buffers. See |special-buffers|.
Bram Moolenaarebdf3c92020-02-15 21:41:42 +01001388 Also see |win_gettype()|, which returns the type of the window.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001389
1390 Be careful with changing this option, it can have many side effects!
1391
Bram Moolenaar280f1262006-01-30 00:14:18 +00001392 A "quickfix" buffer is only used for the error list and the location
1393 list. This value is set by the |:cwindow| and |:lwindow| commands and
1394 you are not supposed to change it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001395
1396 "nofile" and "nowrite" buffers are similar:
1397 both: The buffer is not to be written to disk, ":w" doesn't
1398 work (":w filename" does work though).
1399 both: The buffer is never considered to be |'modified'|.
1400 There is no warning when the changes will be lost, for
1401 example when you quit Vim.
1402 both: A swap file is only created when using too much memory
1403 (when 'swapfile' has been reset there is never a swap
1404 file).
1405 nofile only: The buffer name is fixed, it is not handled like a
1406 file name. It is not modified in response to a |:cd|
1407 command.
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01001408 both: When using ":e bufname" and already editing "bufname"
1409 the buffer is made empty and autocommands are
1410 triggered as usual for |:edit|.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001411 *E676*
1412 "acwrite" implies that the buffer name is not related to a file, like
1413 "nofile", but it will be written. Thus, in contrast to "nofile" and
1414 "nowrite", ":w" does work and a modified buffer can't be abandoned
1415 without saving. For writing there must be matching |BufWriteCmd|,
1416 |FileWriteCmd| or |FileAppendCmd| autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001417
1418 *'casemap'* *'cmp'*
1419'casemap' 'cmp' string (default: "internal,keepascii")
1420 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001421 Specifies details about changing the case of letters. It may contain
1422 these words, separated by a comma:
1423 internal Use internal case mapping functions, the current
1424 locale does not change the case mapping. This only
Bram Moolenaar6f16eb82005-08-23 21:02:42 +00001425 matters when 'encoding' is a Unicode encoding,
1426 "latin1" or "iso-8859-15". When "internal" is
1427 omitted, the towupper() and towlower() system library
1428 functions are used when available.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001429 keepascii For the ASCII characters (0x00 to 0x7f) use the US
1430 case mapping, the current locale is not effective.
1431 This probably only matters for Turkish.
1432
1433 *'cdpath'* *'cd'* *E344* *E346*
1434'cdpath' 'cd' string (default: equivalent to $CDPATH or ",,")
1435 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001436 {not available when compiled without the
1437 |+file_in_path| feature}
1438 This is a list of directories which will be searched when using the
Bram Moolenaar00aa0692019-04-27 20:37:57 +02001439 |:cd|, |:tcd| and |:lcd| commands, provided that the directory being
1440 searched for has a relative path, not an absolute part starting with
1441 "/", "./" or "../", the 'cdpath' option is not used then.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001442 The 'cdpath' option's value has the same form and semantics as
1443 |'path'|. Also see |file-searching|.
1444 The default value is taken from $CDPATH, with a "," prepended to look
1445 in the current directory first.
1446 If the default value taken from $CDPATH is not what you want, include
1447 a modified version of the following command in your vimrc file to
1448 override it: >
1449 :let &cdpath = ',' . substitute(substitute($CDPATH, '[, ]', '\\\0', 'g'), ':', ',', 'g')
1450< This option cannot be set from a |modeline| or in the |sandbox|, for
1451 security reasons.
1452 (parts of 'cdpath' can be passed to the shell to expand file names).
1453
1454 *'cedit'*
1455'cedit' string (Vi default: "", Vim default: CTRL-F)
1456 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001457 The key used in Command-line Mode to open the command-line window.
1458 The default is CTRL-F when 'compatible' is off.
1459 Only non-printable keys are allowed.
1460 The key can be specified as a single character, but it is difficult to
1461 type. The preferred way is to use the <> notation. Examples: >
Bram Moolenaare18dbe82016-07-02 21:42:23 +02001462 :exe "set cedit=\<C-Y>"
1463 :exe "set cedit=\<Esc>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001464< |Nvi| also has this option, but it only uses the first character.
1465 See |cmdwin|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001466 NOTE: This option is set to the Vim default value when 'compatible'
1467 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001468
1469 *'charconvert'* *'ccv'* *E202* *E214* *E513*
1470'charconvert' 'ccv' string (default "")
1471 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01001472 {only available when compiled with the |+eval| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001473 An expression that is used for character encoding conversion. It is
1474 evaluated when a file that is to be read or has been written has a
1475 different encoding from what is desired.
1476 'charconvert' is not used when the internal iconv() function is
1477 supported and is able to do the conversion. Using iconv() is
1478 preferred, because it is much faster.
1479 'charconvert' is not used when reading stdin |--|, because there is no
1480 file to convert from. You will have to save the text in a file first.
1481 The expression must return zero or an empty string for success,
1482 non-zero for failure.
1483 The possible encoding names encountered are in 'encoding'.
1484 Additionally, names given in 'fileencodings' and 'fileencoding' are
1485 used.
1486 Conversion between "latin1", "unicode", "ucs-2", "ucs-4" and "utf-8"
1487 is done internally by Vim, 'charconvert' is not used for this.
1488 'charconvert' is also used to convert the viminfo file, if the 'c'
1489 flag is present in 'viminfo'. Also used for Unicode conversion.
1490 Example: >
1491 set charconvert=CharConvert()
1492 fun CharConvert()
1493 system("recode "
1494 \ . v:charconvert_from . ".." . v:charconvert_to
1495 \ . " <" . v:fname_in . " >" v:fname_out)
1496 return v:shell_error
1497 endfun
1498< The related Vim variables are:
1499 v:charconvert_from name of the current encoding
1500 v:charconvert_to name of the desired encoding
1501 v:fname_in name of the input file
1502 v:fname_out name of the output file
1503 Note that v:fname_in and v:fname_out will never be the same.
1504 Note that v:charconvert_from and v:charconvert_to may be different
1505 from 'encoding'. Vim internally uses UTF-8 instead of UCS-2 or UCS-4.
1506 Encryption is not done by Vim when using 'charconvert'. If you want
1507 to encrypt the file after conversion, 'charconvert' should take care
1508 of this.
1509 This option cannot be set from a |modeline| or in the |sandbox|, for
1510 security reasons.
1511
1512 *'cindent'* *'cin'* *'nocindent'* *'nocin'*
1513'cindent' 'cin' boolean (default off)
1514 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001515 {not available when compiled without the |+cindent|
1516 feature}
Bram Moolenaar446cb832008-06-24 21:56:24 +00001517 Enables automatic C program indenting. See 'cinkeys' to set the keys
Bram Moolenaar071d4272004-06-13 20:20:40 +00001518 that trigger reindenting in insert mode and 'cinoptions' to set your
1519 preferred indent style.
1520 If 'indentexpr' is not empty, it overrules 'cindent'.
1521 If 'lisp' is not on and both 'indentexpr' and 'equalprg' are empty,
1522 the "=" operator indents using this algorithm rather than calling an
1523 external program.
1524 See |C-indenting|.
1525 When you don't like the way 'cindent' works, try the 'smartindent'
1526 option or 'indentexpr'.
1527 This option is not used when 'paste' is set.
1528 NOTE: This option is reset when 'compatible' is set.
1529
1530 *'cinkeys'* *'cink'*
Bram Moolenaarce655742019-01-31 14:12:57 +01001531'cinkeys' 'cink' string (default "0{,0},0),0],:,0#,!^F,o,O,e")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001532 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001533 {not available when compiled without the |+cindent|
1534 feature}
1535 A list of keys that, when typed in Insert mode, cause reindenting of
1536 the current line. Only used if 'cindent' is on and 'indentexpr' is
1537 empty.
1538 For the format of this option see |cinkeys-format|.
1539 See |C-indenting|.
1540
1541 *'cinoptions'* *'cino'*
1542'cinoptions' 'cino' string (default "")
1543 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001544 {not available when compiled without the |+cindent|
1545 feature}
1546 The 'cinoptions' affect the way 'cindent' reindents lines in a C
1547 program. See |cinoptions-values| for the values of this option, and
1548 |C-indenting| for info on C indenting in general.
1549
1550
1551 *'cinwords'* *'cinw'*
1552'cinwords' 'cinw' string (default "if,else,while,do,for,switch")
1553 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001554 {not available when compiled without both the
1555 |+cindent| and the |+smartindent| features}
1556 These keywords start an extra indent in the next line when
1557 'smartindent' or 'cindent' is set. For 'cindent' this is only done at
1558 an appropriate place (inside {}).
1559 Note that 'ignorecase' isn't used for 'cinwords'. If case doesn't
1560 matter, include the keyword both the uppercase and lowercase:
1561 "if,If,IF".
1562
1563 *'clipboard'* *'cb'*
1564'clipboard' 'cb' string (default "autoselect,exclude:cons\|linux"
1565 for X-windows, "" otherwise)
1566 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001567 {only in GUI versions or when the |+xterm_clipboard|
1568 feature is included}
1569 This option is a list of comma separated names.
1570 These names are recognized:
1571
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001572 *clipboard-unnamed*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001573 unnamed When included, Vim will use the clipboard register '*'
1574 for all yank, delete, change and put operations which
1575 would normally go to the unnamed register. When a
1576 register is explicitly specified, it will always be
1577 used regardless of whether "unnamed" is in 'clipboard'
1578 or not. The clipboard register can always be
1579 explicitly accessed using the "* notation. Also see
1580 |gui-clipboard|.
1581
Bram Moolenaar30b65812012-07-12 22:01:11 +02001582 *clipboard-unnamedplus*
Bram Moolenaar00154502013-02-13 16:15:55 +01001583 unnamedplus A variant of the "unnamed" flag which uses the
1584 clipboard register '+' (|quoteplus|) instead of
1585 register '*' for all yank, delete, change and put
1586 operations which would normally go to the unnamed
1587 register. When "unnamed" is also included to the
1588 option, yank operations (but not delete, change or
1589 put) will additionally copy the text into register
1590 '*'.
Bram Moolenaar81af9252010-12-10 20:35:50 +01001591 Only available with the |+X11| feature.
Bram Moolenaarbf9680e2010-12-02 21:43:16 +01001592 Availability can be checked with: >
1593 if has('unnamedplus')
1594<
Bram Moolenaar30b65812012-07-12 22:01:11 +02001595 *clipboard-autoselect*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001596 autoselect Works like the 'a' flag in 'guioptions': If present,
1597 then whenever Visual mode is started, or the Visual
1598 area extended, Vim tries to become the owner of the
1599 windowing system's global selection or put the
1600 selected text on the clipboard used by the selection
Bram Moolenaarba3ff532018-11-04 14:45:49 +01001601 register "*. See |'go-a'| and |quotestar| for details.
1602 When the GUI is active, the 'a' flag in 'guioptions'
1603 is used, when the GUI is not active, this "autoselect"
1604 flag is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001605 Also applies to the modeless selection.
1606
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001607 *clipboard-autoselectplus*
1608 autoselectplus Like "autoselect" but using the + register instead of
1609 the * register. Compare to the 'P' flag in
1610 'guioptions'.
1611
1612 *clipboard-autoselectml*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001613 autoselectml Like "autoselect", but for the modeless selection
1614 only. Compare to the 'A' flag in 'guioptions'.
1615
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001616 *clipboard-html*
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001617 html When the clipboard contains HTML, use this when
1618 pasting. When putting text on the clipboard, mark it
1619 as HTML. This works to copy rendered HTML from
1620 Firefox, paste it as raw HTML in Vim, select the HTML
1621 in Vim and paste it in a rich edit box in Firefox.
Bram Moolenaar20a825a2010-05-31 21:27:30 +02001622 You probably want to add this only temporarily,
1623 possibly use BufEnter autocommands.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001624 Only supported for GTK version 2 and later.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001625
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001626 *clipboard-exclude*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001627 exclude:{pattern}
1628 Defines a pattern that is matched against the name of
1629 the terminal 'term'. If there is a match, no
1630 connection will be made to the X server. This is
1631 useful in this situation:
1632 - Running Vim in a console.
1633 - $DISPLAY is set to start applications on another
1634 display.
1635 - You do not want to connect to the X server in the
1636 console, but do want this in a terminal emulator.
1637 To never connect to the X server use: >
1638 exclude:.*
1639< This has the same effect as using the |-X| argument.
1640 Note that when there is no connection to the X server
1641 the window title won't be restored and the clipboard
1642 cannot be accessed.
1643 The value of 'magic' is ignored, {pattern} is
1644 interpreted as if 'magic' was on.
1645 The rest of the option value will be used for
1646 {pattern}, this must be the last entry.
1647
1648 *'cmdheight'* *'ch'*
1649'cmdheight' 'ch' number (default 1)
1650 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001651 Number of screen lines to use for the command-line. Helps avoiding
1652 |hit-enter| prompts.
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00001653 The value of this option is stored with the tab page, so that each tab
1654 page can have a different value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001655
1656 *'cmdwinheight'* *'cwh'*
1657'cmdwinheight' 'cwh' number (default 7)
1658 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001659 Number of screen lines to use for the command-line window. |cmdwin|
1660
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001661 *'colorcolumn'* *'cc'*
1662'colorcolumn' 'cc' string (default "")
1663 local to window
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001664 {not available when compiled without the |+syntax|
1665 feature}
1666 'colorcolumn' is a comma separated list of screen columns that are
1667 highlighted with ColorColumn |hl-ColorColumn|. Useful to align
1668 text. Will make screen redrawing slower.
1669 The screen column can be an absolute number, or a number preceded with
1670 '+' or '-', which is added to or subtracted from 'textwidth'. >
1671
1672 :set cc=+1 " highlight column after 'textwidth'
1673 :set cc=+1,+2,+3 " highlight three columns after 'textwidth'
1674 :hi ColorColumn ctermbg=lightgrey guibg=lightgrey
1675<
1676 When 'textwidth' is zero then the items with '-' and '+' are not used.
1677 A maximum of 256 columns are highlighted.
1678
Bram Moolenaar071d4272004-06-13 20:20:40 +00001679 *'columns'* *'co'* *E594*
1680'columns' 'co' number (default 80 or terminal width)
1681 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001682 Number of columns of the screen. Normally this is set by the terminal
Bram Moolenaar7c626922005-02-07 22:01:03 +00001683 initialization and does not have to be set by hand. Also see
1684 |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001685 When Vim is running in the GUI or in a resizable window, setting this
1686 option will cause the window size to be changed. When you only want
1687 to use the size for the GUI, put the command in your |gvimrc| file.
1688 When you set this option and Vim is unable to change the physical
Bram Moolenaar02467872007-05-06 13:22:01 +00001689 number of columns of the display, the display may be messed up. For
1690 the GUI it is always possible and Vim limits the number of columns to
1691 what fits on the screen. You can use this command to get the widest
1692 window possible: >
1693 :set columns=9999
1694< Minimum value is 12, maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001695
1696 *'comments'* *'com'* *E524* *E525*
1697'comments' 'com' string (default
1698 "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-")
1699 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001700 A comma separated list of strings that can start a comment line. See
1701 |format-comments|. See |option-backslash| about using backslashes to
1702 insert a space.
1703
1704 *'commentstring'* *'cms'* *E537*
1705'commentstring' 'cms' string (default "/*%s*/")
1706 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001707 {not available when compiled without the |+folding|
1708 feature}
1709 A template for a comment. The "%s" in the value is replaced with the
1710 comment text. Currently only used to add markers for folding, see
1711 |fold-marker|.
1712
1713 *'compatible'* *'cp'* *'nocompatible'* *'nocp'*
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001714'compatible' 'cp' boolean (default on, off when a |vimrc| or |gvimrc|
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02001715 file is found, reset in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001716 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001717 This option has the effect of making Vim either more Vi-compatible, or
1718 make Vim behave in a more useful way.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001719
Bram Moolenaar071d4272004-06-13 20:20:40 +00001720 This is a special kind of option, because when it's set or reset,
Bram Moolenaar214641f2017-03-05 17:04:09 +01001721 other options are also changed as a side effect.
1722 NOTE: Setting or resetting this option can have a lot of unexpected
1723 effects: Mappings are interpreted in another way, undo behaves
1724 differently, etc. If you set this option in your vimrc file, you
1725 should probably put it at the very start.
1726
Bram Moolenaar071d4272004-06-13 20:20:40 +00001727 By default this option is on and the Vi defaults are used for the
1728 options. This default was chosen for those people who want to use Vim
1729 just like Vi, and don't even (want to) know about the 'compatible'
1730 option.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001731 When a |vimrc| or |gvimrc| file is found while Vim is starting up,
Bram Moolenaard042c562005-06-30 22:04:15 +00001732 this option is switched off, and all options that have not been
1733 modified will be set to the Vim defaults. Effectively, this means
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001734 that when a |vimrc| or |gvimrc| file exists, Vim will use the Vim
Bram Moolenaard042c562005-06-30 22:04:15 +00001735 defaults, otherwise it will use the Vi defaults. (Note: This doesn't
Bram Moolenaar02467872007-05-06 13:22:01 +00001736 happen for the system-wide vimrc or gvimrc file, nor for a file given
1737 with the |-u| argument). Also see |compatible-default| and
1738 |posix-compliance|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001739 You can also set this option with the "-C" argument, and reset it with
1740 "-N". See |-C| and |-N|.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001741 See 'cpoptions' for more fine tuning of Vi compatibility.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001742
Bram Moolenaar214641f2017-03-05 17:04:09 +01001743 When this option is set, numerous other options are set to make Vim as
1744 Vi-compatible as possible. When this option is unset, various options
1745 are set to make Vim more useful. The table below lists all the
1746 options affected.
1747 The {?} column indicates when the options are affected:
1748 + Means that the option is set to the value given in {set value} when
1749 'compatible' is set.
1750 & Means that the option is set to the value given in {set value} when
1751 'compatible' is set AND is set to its Vim default value when
1752 'compatible' is unset.
1753 - Means the option is NOT changed when setting 'compatible' but IS
1754 set to its Vim default when 'compatible' is unset.
1755 The {effect} column summarises the change when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001756
Bram Moolenaar036986f2017-03-16 17:41:02 +01001757 option ? set value effect ~
Bram Moolenaar214641f2017-03-05 17:04:09 +01001758
1759 'allowrevins' + off no CTRL-_ command
1760 'antialias' + off don't use antialiased fonts
1761 'arabic' + off reset arabic-related options
1762 'arabicshape' + on correct character shapes
1763 'backspace' + "" normal backspace
1764 'backup' + off no backup file
1765 'backupcopy' & Unix: "yes" backup file is a copy
1766 else: "auto" copy or rename backup file
1767 'balloonexpr' + "" text to show in evaluation balloon
1768 'breakindent' + off don't indent when wrapping lines
1769 'cedit' - {unchanged} {set vim default only on resetting 'cp'}
1770 'cindent' + off no C code indentation
1771 'compatible' - {unchanged} {set vim default only on resetting 'cp'}
1772 'copyindent' + off don't copy indent structure
1773 'cpoptions' & (all flags) Vi-compatible flags
1774 'cscopepathcomp'+ 0 don't show directories in tags list
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01001775 'cscoperelative'+ off don't use basename of path as prefix
Bram Moolenaar214641f2017-03-05 17:04:09 +01001776 'cscopetag' + off don't use cscope for ":tag"
Bram Moolenaar036986f2017-03-16 17:41:02 +01001777 'cscopetagorder'+ 0 see |cscopetagorder|
Bram Moolenaar214641f2017-03-05 17:04:09 +01001778 'cscopeverbose' + off see |cscopeverbose|
1779 'delcombine' + off unicode: delete whole char combination
1780 'digraph' + off no digraphs
1781 'esckeys' & off no <Esc>-keys in Insert mode
1782 'expandtab' + off tabs not expanded to spaces
1783 'fileformats' & "" no automatic file format detection,
Bram Moolenaar6f345a12019-12-17 21:27:18 +01001784 "dos,unix" except for MS-Windows
Bram Moolenaar214641f2017-03-05 17:04:09 +01001785 'formatexpr' + "" use 'formatprg' for auto-formatting
1786 'formatoptions' & "vt" Vi compatible formatting
1787 'gdefault' + off no default 'g' flag for ":s"
1788 'history' & 0 no commandline history
1789 'hkmap' + off no Hebrew keyboard mapping
1790 'hkmapp' + off no phonetic Hebrew keyboard mapping
1791 'hlsearch' + off no highlighting of search matches
1792 'incsearch' + off no incremental searching
1793 'indentexpr' + "" no indenting by expression
1794 'insertmode' + off do not start in Insert mode
1795 'iskeyword' & "@,48-57,_" keywords contain alphanumeric
Bram Moolenaar071d4272004-06-13 20:20:40 +00001796 characters and '_'
Bram Moolenaar214641f2017-03-05 17:04:09 +01001797 'joinspaces' + on insert 2 spaces after period
1798 'modeline' & off no modelines
1799 'more' & off no pauses in listings
1800 'mzquantum' - {unchanged} {set vim default only on resetting 'cp'}
1801 'numberwidth' & 8 min number of columns for line number
1802 'preserveindent'+ off don't preserve current indent structure
1803 when changing it
1804 'revins' + off no reverse insert
1805 'ruler' + off no ruler
1806 'scrolljump' + 1 no jump scroll
1807 'scrolloff' + 0 no scroll offset
1808 'shelltemp' - {unchanged} {set vim default only on resetting 'cp'}
1809 'shiftround' + off indent not rounded to shiftwidth
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02001810 'shortmess' & "S" no shortening of messages
Bram Moolenaar214641f2017-03-05 17:04:09 +01001811 'showcmd' & off command characters not shown
1812 'showmode' & off current mode not shown
1813 'sidescrolloff' + 0 cursor moves to edge of screen in scroll
1814 'smartcase' + off no automatic ignore case switch
1815 'smartindent' + off no smart indentation
1816 'smarttab' + off no smart tab size
1817 'softtabstop' + 0 tabs are always 'tabstop' positions
1818 'startofline' + on goto startofline with some commands
1819 'tagcase' & "followic" 'ignorecase' when searching tags file
1820 'tagrelative' & off tag file names are not relative
1821 'termguicolors' + off don't use highlight-(guifg|guibg)
1822 'textauto' & off no automatic textmode detection
1823 'textwidth' + 0 no automatic line wrap
1824 'tildeop' + off tilde is not an operator
1825 'ttimeout' + off no terminal timeout
1826 'undofile' + off don't use an undo file
Bram Moolenaar036986f2017-03-16 17:41:02 +01001827 'viminfo' - {unchanged} {set Vim default only on resetting 'cp'}
Bram Moolenaar214641f2017-03-05 17:04:09 +01001828 'virtualedit' + "" cursor can only be placed on characters
1829 'whichwrap' & "" left-right movements don't wrap
1830 'wildchar' & CTRL-E only when the current value is <Tab>
Bram Moolenaar071d4272004-06-13 20:20:40 +00001831 use CTRL-E for cmdline completion
Bram Moolenaar214641f2017-03-05 17:04:09 +01001832 'writebackup' + on or off depends on the |+writebackup| feature
Bram Moolenaar071d4272004-06-13 20:20:40 +00001833
1834 *'complete'* *'cpt'* *E535*
1835'complete' 'cpt' string (default: ".,w,b,u,t,i")
1836 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001837 This option specifies how keyword completion |ins-completion| works
1838 when CTRL-P or CTRL-N are used. It is also used for whole-line
1839 completion |i_CTRL-X_CTRL-L|. It indicates the type of completion
1840 and the places to scan. It is a comma separated list of flags:
Bram Moolenaar3848e002016-03-19 18:42:29 +01001841 . scan the current buffer ('wrapscan' is ignored)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001842 w scan buffers from other windows
1843 b scan other loaded buffers that are in the buffer list
1844 u scan the unloaded buffers that are in the buffer list
1845 U scan the buffers that are not in the buffer list
1846 k scan the files given with the 'dictionary' option
Bram Moolenaar0b238792006-03-02 22:49:12 +00001847 kspell use the currently active spell checking |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001848 k{dict} scan the file {dict}. Several "k" flags can be given,
1849 patterns are valid too. For example: >
1850 :set cpt=k/usr/dict/*,k~/spanish
1851< s scan the files given with the 'thesaurus' option
1852 s{tsr} scan the file {tsr}. Several "s" flags can be given, patterns
1853 are valid too.
1854 i scan current and included files
1855 d scan current and included files for defined name or macro
1856 |i_CTRL-X_CTRL-D|
1857 ] tag completion
1858 t same as "]"
1859
1860 Unloaded buffers are not loaded, thus their autocmds |:autocmd| are
1861 not executed, this may lead to unexpected completions from some files
1862 (gzipped files for example). Unloaded buffers are not scanned for
1863 whole-line completion.
1864
1865 The default is ".,w,b,u,t,i", which means to scan:
1866 1. the current buffer
1867 2. buffers in other windows
1868 3. other loaded buffers
1869 4. unloaded buffers
1870 5. tags
1871 6. included files
1872
1873 As you can see, CTRL-N and CTRL-P can be used to do any 'iskeyword'-
Bram Moolenaar582fd852005-03-28 20:58:01 +00001874 based expansion (e.g., dictionary |i_CTRL-X_CTRL-K|, included patterns
1875 |i_CTRL-X_CTRL-I|, tags |i_CTRL-X_CTRL-]| and normal expansions).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001876
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001877 *'completefunc'* *'cfu'*
1878'completefunc' 'cfu' string (default: empty)
1879 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02001880 {not available when compiled without the |+eval|
Bram Moolenaare2c453d2019-08-21 14:37:09 +02001881 feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00001882 This option specifies a function to be used for Insert mode completion
1883 with CTRL-X CTRL-U. |i_CTRL-X_CTRL-U|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001884 See |complete-functions| for an explanation of how the function is
1885 invoked and what it should return.
Bram Moolenaar166af9b2010-11-16 20:34:40 +01001886 This option cannot be set from a |modeline| or in the |sandbox|, for
1887 security reasons.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00001888
Bram Moolenaarac3150d2019-07-28 16:36:39 +02001889 *'completeslash'* *'csl'*
1890'completeslash' 'csl' string (default: "")
1891 local to buffer
Bram Moolenaar2e693a82019-10-16 22:35:02 +02001892 {only for MS-Windows}
Bram Moolenaarac3150d2019-07-28 16:36:39 +02001893 When this option is set it overrules 'shellslash' for completion:
1894 - When this option is set to "slash", a forward slash is used for path
1895 completion in insert mode. This is useful when editing HTML tag, or
Bram Moolenaar6f345a12019-12-17 21:27:18 +01001896 Makefile with 'noshellslash' on MS-Windows.
Bram Moolenaarac3150d2019-07-28 16:36:39 +02001897 - When this option is set to "backslash", backslash is used. This is
Bram Moolenaar6f345a12019-12-17 21:27:18 +01001898 useful when editing a batch file with 'shellslash' set on MS-Windows.
Bram Moolenaarac3150d2019-07-28 16:36:39 +02001899 - When this option is empty, same character is used as for
1900 'shellslash'.
1901 For Insert mode completion the buffer-local value is used. For
1902 command line completion the global value is used.
1903
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001904 *'completeopt'* *'cot'*
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001905'completeopt' 'cot' string (default: "menu,preview")
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001906 global
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001907 A comma separated list of options for Insert mode completion
1908 |ins-completion|. The supported values are:
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001909
1910 menu Use a popup menu to show the possible completions. The
1911 menu is only shown when there is more than one match and
1912 sufficient colors are available. |ins-completion-menu|
1913
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001914 menuone Use the popup menu also when there is only one match.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00001915 Useful when there is additional information about the
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001916 match, e.g., what file it comes from.
1917
Bram Moolenaarc1e37902006-04-18 21:55:01 +00001918 longest Only insert the longest common text of the matches. If
1919 the menu is displayed you can use CTRL-L to add more
1920 characters. Whether case is ignored depends on the kind
1921 of completion. For buffer text the 'ignorecase' option is
1922 used.
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001923
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001924 preview Show extra information about the currently selected
Bram Moolenaar02467872007-05-06 13:22:01 +00001925 completion in the preview window. Only works in
1926 combination with "menu" or "menuone".
1927
Bram Moolenaar576a4a62019-08-18 15:25:17 +02001928 popup Show extra information about the currently selected
1929 completion in a popup window. Only works in combination
1930 with "menu" or "menuone". Overrides "preview".
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02001931 See |'completepopup'| for specifying properties.
Bram Moolenaar2e693a82019-10-16 22:35:02 +02001932 {only works when compiled with the |+textprop| feature}
Bram Moolenaar576a4a62019-08-18 15:25:17 +02001933
Bram Moolenaardca7abe2019-10-20 18:17:57 +02001934 popuphidden
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01001935 Just like "popup" but initially hide the popup. Use a
Bram Moolenaardca7abe2019-10-20 18:17:57 +02001936 |CompleteChanged| autocommand to fetch the info and call
1937 |popup_show()| once the popup has been filled.
1938 See the example at |complete-popuphidden|.
1939 {only works when compiled with the |+textprop| feature}
1940
Bram Moolenaarb6be1e22015-07-10 18:18:40 +02001941 noinsert Do not insert any text for a match until the user selects
1942 a match from the menu. Only works in combination with
1943 "menu" or "menuone". No effect if "longest" is present.
1944
1945 noselect Do not select a match in the menu, force the user to
1946 select one from the menu. Only works in combination with
1947 "menu" or "menuone".
1948
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001949
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02001950 *'completepopup'* *'cpp'*
1951'completepopup' 'cpp' string (default empty)
1952 global
1953 {not available when compiled without the |+textprop|
1954 or |+quickfix| feature}
1955 When 'completeopt' contains "popup" then this option is used for the
Bram Moolenaar447bfba2020-07-18 16:07:16 +02001956 properties of the info popup when it is created. If an info popup
1957 window already exists it is closed, so that the option value is
1958 applied when it is created again.
1959 You can also use |popup_findinfo()| and then set properties for an
1960 existing info popup with |popup_setoptions()|. See |complete-popup|.
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02001961
1962
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001963 *'concealcursor'* *'cocu'*
1964'concealcursor' 'cocu' string (default: "")
1965 local to window
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001966 {not available when compiled without the |+conceal|
1967 feature}
1968 Sets the modes in which text in the cursor line can also be concealed.
1969 When the current mode is listed then concealing happens just like in
1970 other lines.
1971 n Normal mode
1972 v Visual mode
1973 i Insert mode
Bram Moolenaarca8c9862010-07-24 15:00:38 +02001974 c Command line editing, for 'incsearch'
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001975
Bram Moolenaare6dc5732010-07-24 23:52:26 +02001976 'v' applies to all lines in the Visual area, not only the cursor.
Bram Moolenaarca8c9862010-07-24 15:00:38 +02001977 A useful value is "nc". This is used in help files. So long as you
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001978 are moving around text is concealed, but when starting to insert text
1979 or selecting a Visual area the concealed text is displayed, so that
1980 you can see what you are doing.
Bram Moolenaarf70e3d62010-07-24 13:15:07 +02001981 Keep in mind that the cursor position is not always where it's
1982 displayed. E.g., when moving vertically it may change column.
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001983
1984
Bram Moolenaar95bafa22018-10-02 13:26:25 +02001985 *'conceallevel'* *'cole'*
1986'conceallevel' 'cole' number (default 0)
Bram Moolenaar860cae12010-06-05 23:22:07 +02001987 local to window
Bram Moolenaar860cae12010-06-05 23:22:07 +02001988 {not available when compiled without the |+conceal|
1989 feature}
Bram Moolenaar6df6f472010-07-18 18:04:50 +02001990 Determine how text with the "conceal" syntax attribute |:syn-conceal|
1991 is shown:
Bram Moolenaar860cae12010-06-05 23:22:07 +02001992
Bram Moolenaar6df6f472010-07-18 18:04:50 +02001993 Value Effect ~
Bram Moolenaar860cae12010-06-05 23:22:07 +02001994 0 Text is shown normally
Bram Moolenaar477db062010-07-28 18:17:41 +02001995 1 Each block of concealed text is replaced with one
1996 character. If the syntax item does not have a custom
1997 replacement character defined (see |:syn-cchar|) the
1998 character defined in 'listchars' is used (default is a
1999 space).
2000 It is highlighted with the "Conceal" highlight group.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002001 2 Concealed text is completely hidden unless it has a
2002 custom replacement character defined (see
Bram Moolenaar477db062010-07-28 18:17:41 +02002003 |:syn-cchar|).
Bram Moolenaara7781e02010-07-19 20:13:22 +02002004 3 Concealed text is completely hidden.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002005
Bram Moolenaara7781e02010-07-19 20:13:22 +02002006 Note: in the cursor line concealed text is not hidden, so that you can
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002007 edit and copy the text. This can be changed with the 'concealcursor'
2008 option.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002009
Bram Moolenaar071d4272004-06-13 20:20:40 +00002010 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
2011'confirm' 'cf' boolean (default off)
2012 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002013 When 'confirm' is on, certain operations that would normally
2014 fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
2015 instead raise a |dialog| asking if you wish to save the current
2016 file(s). You can still use a ! to unconditionally |abandon| a buffer.
2017 If 'confirm' is off you can still activate confirmation for one
2018 command only (this is most useful in mappings) with the |:confirm|
2019 command.
2020 Also see the |confirm()| function and the 'v' flag in 'guioptions'.
2021
2022 *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
2023'conskey' 'consk' boolean (default off)
2024 global
Bram Moolenaarf3913272016-02-25 00:00:01 +01002025 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002026
2027 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
2028'copyindent' 'ci' boolean (default off)
2029 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002030 Copy the structure of the existing lines indent when autoindenting a
2031 new line. Normally the new indent is reconstructed by a series of
2032 tabs followed by spaces as required (unless |'expandtab'| is enabled,
2033 in which case only spaces are used). Enabling this option makes the
2034 new line copy whatever characters were used for indenting on the
Bram Moolenaar446cb832008-06-24 21:56:24 +00002035 existing line. 'expandtab' has no effect on these characters, a Tab
2036 remains a Tab. If the new indent is greater than on the existing
Bram Moolenaar071d4272004-06-13 20:20:40 +00002037 line, the remaining space is filled in the normal manner.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002038 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002039 Also see 'preserveindent'.
2040
Bram Moolenaare0fa3742016-02-20 15:47:01 +01002041 *'cpoptions'* *'cpo'* *cpo*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002042'cpoptions' 'cpo' string (Vim default: "aABceFs",
2043 Vi default: all flags)
2044 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002045 A sequence of single character flags. When a character is present
Bram Moolenaar7cba6c02013-09-05 22:13:31 +02002046 this indicates Vi-compatible behavior. This is used for things where
2047 not being Vi-compatible is mostly or sometimes preferred.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002048 'cpoptions' stands for "compatible-options".
2049 Commas can be added for readability.
2050 To avoid problems with flags that are added in the future, use the
2051 "+=" and "-=" feature of ":set" |add-option-flags|.
2052 NOTE: This option is set to the Vi default value when 'compatible' is
2053 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002054 NOTE: This option is set to the POSIX default value at startup when
2055 the Vi default value would be used and the $VIM_POSIX environment
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002056 variable exists |posix|. This means Vim tries to behave like the
2057 POSIX specification.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002058
2059 contains behavior ~
2060 *cpo-a*
2061 a When included, a ":read" command with a file name
2062 argument will set the alternate file name for the
2063 current window.
2064 *cpo-A*
2065 A When included, a ":write" command with a file name
2066 argument will set the alternate file name for the
2067 current window.
2068 *cpo-b*
2069 b "\|" in a ":map" command is recognized as the end of
2070 the map command. The '\' is included in the mapping,
2071 the text after the '|' is interpreted as the next
2072 command. Use a CTRL-V instead of a backslash to
2073 include the '|' in the mapping. Applies to all
2074 mapping, abbreviation, menu and autocmd commands.
2075 See also |map_bar|.
2076 *cpo-B*
2077 B A backslash has no special meaning in mappings,
Bram Moolenaara9604e62018-07-21 05:56:22 +02002078 abbreviations, user commands and the "to" part of the
2079 menu commands. Remove this flag to be able to use a
2080 backslash like a CTRL-V. For example, the command
2081 ":map X \<Esc>" results in X being mapped to:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002082 'B' included: "\^[" (^[ is a real <Esc>)
2083 'B' excluded: "<Esc>" (5 characters)
2084 ('<' excluded in both cases)
2085 *cpo-c*
2086 c Searching continues at the end of any match at the
2087 cursor position, but not further than the start of the
2088 next line. When not present searching continues
2089 one character from the cursor position. With 'c'
2090 "abababababab" only gets three matches when repeating
2091 "/abab", without 'c' there are five matches.
2092 *cpo-C*
2093 C Do not concatenate sourced lines that start with a
2094 backslash. See |line-continuation|.
2095 *cpo-d*
2096 d Using "./" in the 'tags' option doesn't mean to use
2097 the tags file relative to the current file, but the
2098 tags file in the current directory.
2099 *cpo-D*
2100 D Can't use CTRL-K to enter a digraph after Normal mode
2101 commands with a character argument, like |r|, |f| and
2102 |t|.
2103 *cpo-e*
2104 e When executing a register with ":@r", always add a
2105 <CR> to the last line, also when the register is not
2106 linewise. If this flag is not present, the register
2107 is not linewise and the last line does not end in a
2108 <CR>, then the last line is put on the command-line
2109 and can be edited before hitting <CR>.
2110 *cpo-E*
2111 E It is an error when using "y", "d", "c", "g~", "gu" or
2112 "gU" on an Empty region. The operators only work when
Bram Moolenaar15142e22018-04-30 22:19:58 +02002113 at least one character is to be operated on. Example:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002114 This makes "y0" fail in the first column.
2115 *cpo-f*
2116 f When included, a ":read" command with a file name
2117 argument will set the file name for the current buffer,
2118 if the current buffer doesn't have a file name yet.
2119 *cpo-F*
2120 F When included, a ":write" command with a file name
2121 argument will set the file name for the current
2122 buffer, if the current buffer doesn't have a file name
Bram Moolenaarb3480382005-12-11 21:33:32 +00002123 yet. Also see |cpo-P|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002124 *cpo-g*
2125 g Goto line 1 when using ":edit" without argument.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002126 *cpo-H*
2127 H When using "I" on a line with only blanks, insert
2128 before the last blank. Without this flag insert after
2129 the last blank.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002130 *cpo-i*
2131 i When included, interrupting the reading of a file will
2132 leave it modified.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002133 *cpo-I*
2134 I When moving the cursor up or down just after inserting
2135 indent for 'autoindent', do not delete the indent.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002136 *cpo-j*
2137 j When joining lines, only add two spaces after a '.',
2138 not after '!' or '?'. Also see 'joinspaces'.
2139 *cpo-J*
2140 J A |sentence| has to be followed by two spaces after
Bram Moolenaar582fd852005-03-28 20:58:01 +00002141 the '.', '!' or '?'. A <Tab> is not recognized as
Bram Moolenaar071d4272004-06-13 20:20:40 +00002142 white space.
2143 *cpo-k*
2144 k Disable the recognition of raw key codes in
2145 mappings, abbreviations, and the "to" part of menu
2146 commands. For example, if <Key> sends ^[OA (where ^[
2147 is <Esc>), the command ":map X ^[OA" results in X
2148 being mapped to:
2149 'k' included: "^[OA" (3 characters)
2150 'k' excluded: "<Key>" (one key code)
2151 Also see the '<' flag below.
2152 *cpo-K*
2153 K Don't wait for a key code to complete when it is
2154 halfway a mapping. This breaks mapping <F1><F1> when
2155 only part of the second <F1> has been read. It
2156 enables cancelling the mapping by typing <F1><Esc>.
2157 *cpo-l*
2158 l Backslash in a [] range in a search pattern is taken
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002159 literally, only "\]", "\^", "\-" and "\\" are special.
2160 See |/[]|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002161 'l' included: "/[ \t]" finds <Space>, '\' and 't'
2162 'l' excluded: "/[ \t]" finds <Space> and <Tab>
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002163 Also see |cpo-\|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002164 *cpo-L*
2165 L When the 'list' option is set, 'wrapmargin',
2166 'textwidth', 'softtabstop' and Virtual Replace mode
2167 (see |gR|) count a <Tab> as two characters, instead of
2168 the normal behavior of a <Tab>.
2169 *cpo-m*
2170 m When included, a showmatch will always wait half a
2171 second. When not included, a showmatch will wait half
2172 a second or until a character is typed. |'showmatch'|
2173 *cpo-M*
2174 M When excluded, "%" matching will take backslashes into
2175 account. Thus in "( \( )" and "\( ( \)" the outer
2176 parenthesis match. When included "%" ignores
2177 backslashes, which is Vi compatible.
2178 *cpo-n*
Bram Moolenaar64486672010-05-16 15:46:46 +02002179 n When included, the column used for 'number' and
2180 'relativenumber' will also be used for text of wrapped
2181 lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002182 *cpo-o*
2183 o Line offset to search command is not remembered for
2184 next search.
2185 *cpo-O*
2186 O Don't complain if a file is being overwritten, even
2187 when it didn't exist when editing it. This is a
2188 protection against a file unexpectedly created by
2189 someone else. Vi didn't complain about this.
2190 *cpo-p*
2191 p Vi compatible Lisp indenting. When not present, a
2192 slightly better algorithm is used.
Bram Moolenaarb3480382005-12-11 21:33:32 +00002193 *cpo-P*
2194 P When included, a ":write" command that appends to a
2195 file will set the file name for the current buffer, if
2196 the current buffer doesn't have a file name yet and
2197 the 'F' flag is also included |cpo-F|.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002198 *cpo-q*
2199 q When joining multiple lines leave the cursor at the
2200 position where it would be when joining two lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002201 *cpo-r*
2202 r Redo ("." command) uses "/" to repeat a search
2203 command, instead of the actually used search string.
2204 *cpo-R*
2205 R Remove marks from filtered lines. Without this flag
2206 marks are kept like |:keepmarks| was used.
2207 *cpo-s*
2208 s Set buffer options when entering the buffer for the
2209 first time. This is like it is in Vim version 3.0.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002210 And it is the default. If not present the options are
Bram Moolenaar071d4272004-06-13 20:20:40 +00002211 set when the buffer is created.
2212 *cpo-S*
2213 S Set buffer options always when entering a buffer
2214 (except 'readonly', 'fileformat', 'filetype' and
2215 'syntax'). This is the (most) Vi compatible setting.
2216 The options are set to the values in the current
2217 buffer. When you change an option and go to another
2218 buffer, the value is copied. Effectively makes the
2219 buffer options global to all buffers.
2220
2221 's' 'S' copy buffer options
2222 no no when buffer created
2223 yes no when buffer first entered (default)
2224 X yes each time when buffer entered (vi comp.)
2225 *cpo-t*
2226 t Search pattern for the tag command is remembered for
2227 "n" command. Otherwise Vim only puts the pattern in
2228 the history for search pattern, but doesn't change the
2229 last used search pattern.
2230 *cpo-u*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002231 u Undo is Vi compatible. See |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002232 *cpo-v*
2233 v Backspaced characters remain visible on the screen in
2234 Insert mode. Without this flag the characters are
2235 erased from the screen right away. With this flag the
2236 screen newly typed text overwrites backspaced
2237 characters.
2238 *cpo-w*
2239 w When using "cw" on a blank character, only change one
2240 character and not all blanks until the start of the
2241 next word.
2242 *cpo-W*
2243 W Don't overwrite a readonly file. When omitted, ":w!"
2244 overwrites a readonly file, if possible.
2245 *cpo-x*
2246 x <Esc> on the command-line executes the command-line.
2247 The default in Vim is to abandon the command-line,
2248 because <Esc> normally aborts a command. |c_<Esc>|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002249 *cpo-X*
2250 X When using a count with "R" the replaced text is
2251 deleted only once. Also when repeating "R" with "."
2252 and a count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002253 *cpo-y*
Bram Moolenaard09091d2019-01-17 16:07:22 +01002254 y A yank command can be redone with ".". Think twice if
2255 you really want to use this, it may break some
2256 plugins, since most people expect "." to only repeat a
2257 change.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002258 *cpo-Z*
2259 Z When using "w!" while the 'readonly' option is set,
2260 don't reset 'readonly'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002261 *cpo-!*
2262 ! When redoing a filter command, use the last used
2263 external command, whatever it was. Otherwise the last
2264 used -filter- command is used.
2265 *cpo-$*
2266 $ When making a change to one line, don't redisplay the
2267 line, but put a '$' at the end of the changed text.
2268 The changed text will be overwritten when you type the
2269 new text. The line is redisplayed if you type any
2270 command that moves the cursor from the insertion
2271 point.
2272 *cpo-%*
2273 % Vi-compatible matching is done for the "%" command.
2274 Does not recognize "#if", "#endif", etc.
2275 Does not recognize "/*" and "*/".
2276 Parens inside single and double quotes are also
2277 counted, causing a string that contains a paren to
2278 disturb the matching. For example, in a line like
2279 "if (strcmp("foo(", s))" the first paren does not
2280 match the last one. When this flag is not included,
2281 parens inside single and double quotes are treated
2282 specially. When matching a paren outside of quotes,
2283 everything inside quotes is ignored. When matching a
2284 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002285 there is one). This works very well for C programs.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002286 This flag is also used for other features, such as
2287 C-indenting.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002288 *cpo--*
2289 - When included, a vertical movement command fails when
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002290 it would go above the first line or below the last
2291 line. Without it the cursor moves to the first or
2292 last line, unless it already was in that line.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002293 Applies to the commands "-", "k", CTRL-P, "+", "j",
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002294 CTRL-N, CTRL-J and ":1234".
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002295 *cpo-+*
2296 + When included, a ":write file" command will reset the
2297 'modified' flag of the buffer, even though the buffer
2298 itself may still be different from its file.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002299 *cpo-star*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002300 * Use ":*" in the same way as ":@". When not included,
2301 ":*" is an alias for ":'<,'>", select the Visual area.
2302 *cpo-<*
2303 < Disable the recognition of special key codes in |<>|
2304 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002305 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00002306 ":map X <Tab>" results in X being mapped to:
2307 '<' included: "<Tab>" (5 characters)
2308 '<' excluded: "^I" (^I is a real <Tab>)
2309 Also see the 'k' flag above.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002310 *cpo->*
2311 > When appending to a register, put a line break before
2312 the appended text.
Bram Moolenaar8b3e0332011-06-26 05:36:34 +02002313 *cpo-;*
2314 ; When using |,| or |;| to repeat the last |t| search
2315 and the cursor is right in front of the searched
2316 character, the cursor won't move. When not included,
2317 the cursor would skip over it and jump to the
Bram Moolenaarc8734422012-06-01 22:38:45 +02002318 following occurrence.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002319
2320 POSIX flags. These are not included in the Vi default value, except
2321 when $VIM_POSIX was set on startup. |posix|
2322
2323 contains behavior ~
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002324 *cpo-#*
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002325 # A count before "D", "o" and "O" has no effect.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002326 *cpo-&*
2327 & When ":preserve" was used keep the swap file when
2328 exiting normally while this buffer is still loaded.
2329 This flag is tested when exiting.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002330 *cpo-\*
2331 \ Backslash in a [] range in a search pattern is taken
2332 literally, only "\]" is special See |/[]|
Bram Moolenaar90915b52005-08-21 22:17:52 +00002333 '\' included: "/[ \-]" finds <Space>, '\' and '-'
2334 '\' excluded: "/[ \-]" finds <Space> and '-'
2335 Also see |cpo-l|.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002336 *cpo-/*
2337 / When "%" is used as the replacement string in a |:s|
2338 command, use the previous replacement string. |:s%|
2339 *cpo-{*
2340 { The |{| and |}| commands also stop at a "{" character
2341 at the start of a line.
2342 *cpo-.*
2343 . The ":chdir" and ":cd" commands fail if the current
2344 buffer is modified, unless ! is used. Vim doesn't
2345 need this, since it remembers the full path of an
2346 opened file.
2347 *cpo-bar*
2348 | The value of the $LINES and $COLUMNS environment
2349 variables overrule the terminal size values obtained
2350 with system specific functions.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002351
Bram Moolenaar071d4272004-06-13 20:20:40 +00002352
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002353 *'cryptmethod'* *'cm'*
Bram Moolenaara86187b2018-12-16 18:20:00 +01002354'cryptmethod' 'cm' string (default "blowfish2")
Bram Moolenaar49771f42010-07-20 17:32:38 +02002355 global or local to buffer |global-local|
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002356 Method used for encryption when the buffer is written to a file:
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002357 *pkzip*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002358 zip PkZip compatible method. A weak kind of encryption.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002359 Backwards compatible with Vim 7.2 and older.
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002360 *blowfish*
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002361 blowfish Blowfish method. Medium strong encryption but it has
2362 an implementation flaw. Requires Vim 7.3 or later,
2363 files can NOT be read by Vim 7.2 and older. This adds
2364 a "seed" to the file, every time you write the file
2365 the encrypted bytes will be different.
2366 *blowfish2*
2367 blowfish2 Blowfish method. Medium strong encryption. Requires
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01002368 Vim 7.4.401 or later, files can NOT be read by Vim 7.3
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002369 and older. This adds a "seed" to the file, every time
2370 you write the file the encrypted bytes will be
2371 different. The whole undo file is encrypted, not just
2372 the pieces of text.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002373
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01002374 You should use "blowfish2", also to re-encrypt older files.
2375
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002376 When reading an encrypted file 'cryptmethod' will be set automatically
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002377 to the detected method of the file being read. Thus if you write it
2378 without changing 'cryptmethod' the same method will be used.
2379 Changing 'cryptmethod' does not mark the file as modified, you have to
Bram Moolenaar49771f42010-07-20 17:32:38 +02002380 explicitly write it, you don't get a warning unless there are other
2381 modifications. Also see |:X|.
2382
2383 When setting the global value to an empty string, it will end up with
Bram Moolenaara86187b2018-12-16 18:20:00 +01002384 the value "blowfish2". When setting the local value to an empty
2385 string the buffer will use the global value.
Bram Moolenaar49771f42010-07-20 17:32:38 +02002386
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002387 When a new encryption method is added in a later version of Vim, and
2388 the current version does not recognize it, you will get *E821* .
Bram Moolenaar49771f42010-07-20 17:32:38 +02002389 You need to edit this file with the later version of Vim.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002390
2391
Bram Moolenaar071d4272004-06-13 20:20:40 +00002392 *'cscopepathcomp'* *'cspc'*
2393'cscopepathcomp' 'cspc' number (default 0)
2394 global
2395 {not available when compiled without the |+cscope|
2396 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002397 Determines how many components of the path to show in a list of tags.
2398 See |cscopepathcomp|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002399 NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002400
2401 *'cscopeprg'* *'csprg'*
2402'cscopeprg' 'csprg' string (default "cscope")
2403 global
2404 {not available when compiled without the |+cscope|
2405 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002406 Specifies the command to execute cscope. See |cscopeprg|.
2407 This option cannot be set from a |modeline| or in the |sandbox|, for
2408 security reasons.
2409
2410 *'cscopequickfix'* *'csqf'*
2411'cscopequickfix' 'csqf' string (default "")
2412 global
2413 {not available when compiled without the |+cscope|
2414 or |+quickfix| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002415 Specifies whether to use quickfix window to show cscope results.
2416 See |cscopequickfix|.
2417
Bram Moolenaarec7944a2013-06-12 21:29:15 +02002418 *'cscoperelative'* *'csre'* *'nocscoperelative'* *'nocsre'*
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002419'cscoperelative' 'csre' boolean (default off)
2420 global
2421 {not available when compiled without the |+cscope|
2422 feature}
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002423 In the absence of a prefix (-P) for cscope. setting this option enables
2424 to use the basename of cscope.out path as the prefix.
2425 See |cscoperelative|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002426 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002427
Bram Moolenaar071d4272004-06-13 20:20:40 +00002428 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
2429'cscopetag' 'cst' boolean (default off)
2430 global
2431 {not available when compiled without the |+cscope|
2432 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002433 Use cscope for tag commands. See |cscope-options|.
2434 NOTE: This option is reset when 'compatible' is set.
2435
2436 *'cscopetagorder'* *'csto'*
2437'cscopetagorder' 'csto' number (default 0)
2438 global
2439 {not available when compiled without the |+cscope|
2440 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002441 Determines the order in which ":cstag" performs a search. See
2442 |cscopetagorder|.
2443 NOTE: This option is set to 0 when 'compatible' is set.
2444
2445 *'cscopeverbose'* *'csverb'*
2446 *'nocscopeverbose'* *'nocsverb'*
2447'cscopeverbose' 'csverb' boolean (default off)
2448 global
2449 {not available when compiled without the |+cscope|
2450 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002451 Give messages when adding a cscope database. See |cscopeverbose|.
2452 NOTE: This option is reset when 'compatible' is set.
2453
Bram Moolenaar860cae12010-06-05 23:22:07 +02002454 *'cursorbind'* *'crb'* *'nocursorbind'* *'nocrb'*
2455'cursorbind' 'crb' boolean (default off)
2456 local to window
Bram Moolenaar860cae12010-06-05 23:22:07 +02002457 When this option is set, as the cursor in the current
2458 window moves other cursorbound windows (windows that also have
2459 this option set) move their cursors to the corresponding line and
2460 column. This option is useful for viewing the
2461 differences between two versions of a file (see 'diff'); in diff mode,
2462 inserted and deleted lines (though not characters within a line) are
Bram Moolenaar1a384422010-07-14 19:53:30 +02002463 taken into account.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002464
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002465
2466 *'cursorcolumn'* *'cuc'* *'nocursorcolumn'* *'nocuc'*
2467'cursorcolumn' 'cuc' boolean (default off)
2468 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02002469 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002470 feature}
2471 Highlight the screen column of the cursor with CursorColumn
2472 |hl-CursorColumn|. Useful to align text. Will make screen redrawing
2473 slower.
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00002474 If you only want the highlighting in the current window you can use
2475 these autocommands: >
2476 au WinLeave * set nocursorline nocursorcolumn
2477 au WinEnter * set cursorline cursorcolumn
2478<
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002479
2480 *'cursorline'* *'cul'* *'nocursorline'* *'nocul'*
2481'cursorline' 'cul' boolean (default off)
2482 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02002483 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002484 feature}
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002485 Highlight the text line of the cursor with CursorLine |hl-CursorLine|.
2486 Useful to easily spot the cursor. Will make screen redrawing slower.
Bram Moolenaare2f98b92006-03-29 21:18:24 +00002487 When Visual mode is active the highlighting isn't used to make it
Bram Moolenaar779b74b2006-04-10 14:55:34 +00002488 easier to see the selected text.
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002489
2490
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002491 *'cursorlineopt'* *'culopt'*
Bram Moolenaar017ba072019-09-14 21:01:23 +02002492'cursorlineopt' 'culopt' string (default: "number,line")
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002493 local to window
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002494 {not available when compiled without the |+syntax|
2495 feature}
Bram Moolenaar017ba072019-09-14 21:01:23 +02002496 Comma separated list of settings for how 'cursorline' is displayed.
2497 Valid values:
2498 "line" Highlight the text line of the cursor with
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002499 CursorLine |hl-CursorLine|.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002500 "screenline" Highlight only the screen line of the cursor with
2501 CursorLine |hl-CursorLine|.
2502 "number" Highlight the line number of the cursor with
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002503 CursorLineNr |hl-CursorLineNr|.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002504
2505 Special value:
2506 "both" Alias for the values "line,number".
2507
2508 "line" and "screenline" cannot be used together.
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002509
2510
Bram Moolenaar071d4272004-06-13 20:20:40 +00002511 *'debug'*
2512'debug' string (default "")
2513 global
Bram Moolenaar57657d82006-04-21 22:12:41 +00002514 These values can be used:
2515 msg Error messages that would otherwise be omitted will be given
2516 anyway.
2517 throw Error messages that would otherwise be omitted will be given
2518 anyway and also throw an exception and set |v:errmsg|.
2519 beep A message will be given when otherwise only a beep would be
2520 produced.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002521 The values can be combined, separated by a comma.
Bram Moolenaar57657d82006-04-21 22:12:41 +00002522 "msg" and "throw" are useful for debugging 'foldexpr', 'formatexpr' or
2523 'indentexpr'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002524
2525 *'define'* *'def'*
2526'define' 'def' string (default "^\s*#\s*define")
2527 global or local to buffer |global-local|
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002528 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002529 pattern, just like for the "/" command. This option is used for the
2530 commands like "[i" and "[d" |include-search|. The 'isident' option is
2531 used to recognize the defined name after the match:
2532 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2533 See |option-backslash| about inserting backslashes to include a space
2534 or backslash.
2535 The default value is for C programs. For C++ this value would be
2536 useful, to include const type declarations: >
2537 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
Bram Moolenaar63b74a82019-03-24 15:09:13 +01002538< You can also use "\ze" just before the name and continue the pattern
2539 to check what is following. E.g. for Javascript, if a function is
2540 defined with "func_name = function(args)": >
2541 ^\s*\ze\i\+\s*=\s*function(
2542< If the function is defined with "func_name : function() {...": >
2543 ^\s*\ze\i\+\s*[:]\s*(*function\s*(
Bram Moolenaar071d4272004-06-13 20:20:40 +00002544< When using the ":set" command, you need to double the backslashes!
Bram Moolenaar63b74a82019-03-24 15:09:13 +01002545 To avoid that use `:let` with a single quote string: >
2546 let &l:define = '^\s*\ze\k\+\s*=\s*function('
Bram Moolenaar911ead12019-04-21 00:03:35 +02002547<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002548
2549 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2550'delcombine' 'deco' boolean (default off)
2551 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002552 If editing Unicode and this option is set, backspace and Normal mode
2553 "x" delete each combining character on its own. When it is off (the
2554 default) the character along with its combining characters are
2555 deleted.
2556 Note: When 'delcombine' is set "xx" may work different from "2x"!
2557
2558 This is useful for Arabic, Hebrew and many other languages where one
2559 may have combining characters overtop of base characters, and want
2560 to remove only the combining ones.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002561 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002562
2563 *'dictionary'* *'dict'*
2564'dictionary' 'dict' string (default "")
2565 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002566 List of file names, separated by commas, that are used to lookup words
2567 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2568 contain a list of words. This can be one word per line, or several
2569 words per line, separated by non-keyword characters (white space is
2570 preferred). Maximum line length is 510 bytes.
Bram Moolenaar259f26a2018-05-15 22:25:40 +02002571
2572 When this option is empty or an entry "spell" is present, and spell
2573 checking is enabled, words in the word lists for the currently active
2574 'spelllang' are used. See |spell|.
2575
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002576 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002577 after a comma are ignored, otherwise spaces are included in the file
2578 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002579 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002580 Where to find a list of words?
2581 - On FreeBSD, there is the file "/usr/share/dict/words".
2582 - In the Simtel archive, look in the "msdos/linguist" directory.
2583 - In "miscfiles" of the GNU collection.
2584 The use of |:set+=| and |:set-=| is preferred when adding or removing
2585 directories from the list. This avoids problems when a future version
2586 uses another default.
2587 Backticks cannot be used in this option for security reasons.
2588
2589 *'diff'* *'nodiff'*
2590'diff' boolean (default off)
2591 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00002592 {not available when compiled without the |+diff|
2593 feature}
2594 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002595 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002596
2597 *'dex'* *'diffexpr'*
2598'diffexpr' 'dex' string (default "")
2599 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002600 {not available when compiled without the |+diff|
2601 feature}
Bram Moolenaare828b762018-09-10 17:51:58 +02002602 Expression which is evaluated to obtain a diff file (either ed-style
2603 or unified-style) from two versions of a file. See |diff-diffexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002604 This option cannot be set from a |modeline| or in the |sandbox|, for
2605 security reasons.
2606
2607 *'dip'* *'diffopt'*
Bram Moolenaarc8234772019-11-10 21:00:27 +01002608'diffopt' 'dip' string (default "internal,filler,closeoff")
Bram Moolenaar071d4272004-06-13 20:20:40 +00002609 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002610 {not available when compiled without the |+diff|
2611 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002612 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002613 All are optional. Items must be separated by a comma.
2614
2615 filler Show filler lines, to keep the text
2616 synchronized with a window that has inserted
2617 lines at the same position. Mostly useful
2618 when windows are side-by-side and 'scrollbind'
2619 is set.
2620
2621 context:{n} Use a context of {n} lines between a change
2622 and a fold that contains unchanged lines.
2623 When omitted a context of six lines is used.
Bram Moolenaarf6b40102019-02-22 15:24:03 +01002624 When using zero the context is actually one,
2625 since folds require a line in between, also
2626 for a deleted line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002627 See |fold-diff|.
2628
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002629 iblank Ignore changes where lines are all blank. Adds
2630 the "-B" flag to the "diff" command if
2631 'diffexpr' is empty. Check the documentation
2632 of the "diff" command for what this does
2633 exactly.
2634 NOTE: the diff windows will get out of sync,
2635 because no differences between blank lines are
2636 taken into account.
2637
Bram Moolenaar071d4272004-06-13 20:20:40 +00002638 icase Ignore changes in case of text. "a" and "A"
2639 are considered the same. Adds the "-i" flag
2640 to the "diff" command if 'diffexpr' is empty.
2641
2642 iwhite Ignore changes in amount of white space. Adds
2643 the "-b" flag to the "diff" command if
2644 'diffexpr' is empty. Check the documentation
2645 of the "diff" command for what this does
2646 exactly. It should ignore adding trailing
2647 white space, but not leading white space.
2648
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002649 iwhiteall Ignore all white space changes. Adds
2650 the "-w" flag to the "diff" command if
2651 'diffexpr' is empty. Check the documentation
2652 of the "diff" command for what this does
2653 exactly.
2654
2655 iwhiteeol Ignore white space changes at end of line.
2656 Adds the "-Z" flag to the "diff" command if
2657 'diffexpr' is empty. Check the documentation
2658 of the "diff" command for what this does
2659 exactly.
2660
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002661 horizontal Start diff mode with horizontal splits (unless
2662 explicitly specified otherwise).
2663
2664 vertical Start diff mode with vertical splits (unless
2665 explicitly specified otherwise).
2666
Bram Moolenaarc8234772019-11-10 21:00:27 +01002667 closeoff When a window is closed where 'diff' is set
2668 and there is only one window remaining in the
2669 same tab page with 'diff' set, execute
2670 `:diffoff` in that window. This undoes a
2671 `:diffsplit` command.
2672
Bram Moolenaar97ce4192017-12-01 20:35:58 +01002673 hiddenoff Do not use diff mode for a buffer when it
2674 becomes hidden.
2675
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002676 foldcolumn:{n} Set the 'foldcolumn' option to {n} when
2677 starting diff mode. Without this 2 is used.
2678
Bram Moolenaare828b762018-09-10 17:51:58 +02002679 internal Use the internal diff library. This is
2680 ignored when 'diffexpr' is set. *E960*
2681 When running out of memory when writing a
2682 buffer this item will be ignored for diffs
2683 involving that buffer. Set the 'verbose'
2684 option to see when this happens.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002685
Bram Moolenaare828b762018-09-10 17:51:58 +02002686 indent-heuristic
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01002687 Use the indent heuristic for the internal
2688 diff library.
Bram Moolenaare828b762018-09-10 17:51:58 +02002689
2690 algorithm:{text} Use the specified diff algorithm with the
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01002691 internal diff engine. Currently supported
Bram Moolenaare828b762018-09-10 17:51:58 +02002692 algorithms are:
2693 myers the default algorithm
2694 minimal spend extra time to generate the
2695 smallest possible diff
2696 patience patience diff algorithm
2697 histogram histogram diff algorithm
2698
2699 Examples: >
2700 :set diffopt=internal,filler,context:4
Bram Moolenaar071d4272004-06-13 20:20:40 +00002701 :set diffopt=
Bram Moolenaare828b762018-09-10 17:51:58 +02002702 :set diffopt=internal,filler,foldcolumn:3
2703 :set diffopt-=internal " do NOT use the internal diff parser
Bram Moolenaar071d4272004-06-13 20:20:40 +00002704<
2705 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
2706'digraph' 'dg' boolean (default off)
2707 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002708 {not available when compiled without the |+digraphs|
2709 feature}
2710 Enable the entering of digraphs in Insert mode with {char1} <BS>
2711 {char2}. See |digraphs|.
2712 NOTE: This option is reset when 'compatible' is set.
2713
2714 *'directory'* *'dir'*
2715'directory' 'dir' string (default for Amiga: ".,t:",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01002716 for Win32: ".,$TEMP,c:\tmp,c:\temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00002717 for Unix: ".,~/tmp,/var/tmp,/tmp")
2718 global
2719 List of directory names for the swap file, separated with commas.
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02002720 Recommended value: ".,~/vimswap//" - this will put the swap file next
2721 to the edited file if possible, and in your personal swap directory
2722 otherwise. Make sure "~/vimswap//" is only readable for you.
2723
2724 Possible items:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002725 - The swap file will be created in the first directory where this is
2726 possible.
2727 - Empty means that no swap file will be used (recovery is
Bram Moolenaar00e192b2019-10-19 17:01:28 +02002728 impossible!) and no |E303| error will be given.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002729 - A directory "." means to put the swap file in the same directory as
2730 the edited file. On Unix, a dot is prepended to the file name, so
2731 it doesn't show in a directory listing. On MS-Windows the "hidden"
2732 attribute is set and a dot prepended if possible.
Bram Moolenaar8024f932020-01-14 19:29:13 +01002733 - A directory starting with "./" (or ".\" for MS-Windows) means to put
2734 the swap file relative to where the edited file is. The leading "."
2735 is replaced with the path name of the edited file.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02002736 - For Unix and Win32, if a directory ends in two path separators "//",
2737 the swap file name will be built from the complete path to the file
2738 with all path separators substituted to percent '%' signs. This will
2739 ensure file name uniqueness in the preserve directory.
2740 On Win32, it is also possible to end with "\\". However, When a
2741 separating comma is following, you must use "//", since "\\" will
2742 include the comma in the file name. Therefore it is recommended to
2743 use '//', instead of '\\'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002744 - Spaces after the comma are ignored, other spaces are considered part
2745 of the directory name. To have a space at the start of a directory
2746 name, precede it with a backslash.
2747 - To include a comma in a directory name precede it with a backslash.
2748 - A directory name may end in an ':' or '/'.
2749 - Environment variables are expanded |:set_env|.
2750 - Careful with '\' characters, type one before a space, type two to
2751 get one in the option (see |option-backslash|), for example: >
2752 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
2753< - For backwards compatibility with Vim version 3.0 a '>' at the start
2754 of the option is removed.
2755 Using "." first in the list is recommended. This means that editing
2756 the same file twice will result in a warning. Using "/tmp" on Unix is
2757 discouraged: When the system crashes you lose the swap file.
2758 "/var/tmp" is often not cleared when rebooting, thus is a better
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02002759 choice than "/tmp". But others on the computer may be able to see the
2760 files, and it can contain a lot of files, your swap files get lost in
2761 the crowd. That is why a "tmp" directory in your home directory is
2762 tried first.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002763 The use of |:set+=| and |:set-=| is preferred when adding or removing
2764 directories from the list. This avoids problems when a future version
2765 uses another default.
2766 This option cannot be set from a |modeline| or in the |sandbox|, for
2767 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002768
2769 *'display'* *'dy'*
Bram Moolenaarbc8801c2016-08-02 21:04:33 +02002770'display' 'dy' string (default "", set to "truncate" in
2771 |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002772 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002773 Change the way text is displayed. This is comma separated list of
2774 flags:
2775 lastline When included, as much as possible of the last line
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02002776 in a window will be displayed. "@@@" is put in the
2777 last columns of the last screen line to indicate the
2778 rest of the line is not displayed.
2779 truncate Like "lastline", but "@@@" is displayed in the first
2780 column of the last screen line. Overrules "lastline".
Bram Moolenaar071d4272004-06-13 20:20:40 +00002781 uhex Show unprintable characters hexadecimal as <xx>
2782 instead of using ^C and ~C.
2783
Bram Moolenaard0796902016-09-16 20:02:31 +02002784 When neither "lastline" nor "truncate" is included, a last line that
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02002785 doesn't fit is replaced with "@" lines.
2786
Bram Moolenaar071d4272004-06-13 20:20:40 +00002787 *'eadirection'* *'ead'*
2788'eadirection' 'ead' string (default "both")
2789 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002790 Tells when the 'equalalways' option applies:
2791 ver vertically, width of windows is not affected
2792 hor horizontally, height of windows is not affected
2793 both width and height of windows is affected
2794
2795 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
2796'edcompatible' 'ed' boolean (default off)
2797 global
2798 Makes the 'g' and 'c' flags of the ":substitute" command to be
2799 toggled each time the flag is given. See |complex-change|. See
2800 also 'gdefault' option.
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +02002801 Switching this option on may break plugins!
Bram Moolenaar071d4272004-06-13 20:20:40 +00002802
Bram Moolenaar03413f42016-04-12 21:07:15 +02002803 *'emoji'* *'emo'* *'noemoji'* *'noemo'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01002804'emoji' 'emo' boolean (default: on)
2805 global
Bram Moolenaar3848e002016-03-19 18:42:29 +01002806 When on all Unicode emoji characters are considered to be full width.
2807
2808
Bram Moolenaar071d4272004-06-13 20:20:40 +00002809 *'encoding'* *'enc'* *E543*
2810'encoding' 'enc' string (default: "latin1" or value from $LANG)
2811 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002812 Sets the character encoding used inside Vim. It applies to text in
2813 the buffers, registers, Strings in expressions, text stored in the
2814 viminfo file, etc. It sets the kind of characters which Vim can work
2815 with. See |encoding-names| for the possible values.
2816
2817 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002818 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002819 It should normally be kept at its default value, or set when Vim
Bram Moolenaar02467872007-05-06 13:22:01 +00002820 starts up. See |multibyte|. To reload the menus see |:menutrans|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002821
Bram Moolenaar865242e2010-07-14 21:12:05 +02002822 This option cannot be set from a |modeline|. It would most likely
2823 corrupt the text.
2824
Bram Moolenaar3df01732017-02-17 22:47:16 +01002825 NOTE: For GTK+ 2 or later, it is highly recommended to set 'encoding'
2826 to "utf-8". Although care has been taken to allow different values of
Bram Moolenaar071d4272004-06-13 20:20:40 +00002827 'encoding', "utf-8" is the natural choice for the environment and
2828 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002829 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00002830 versions, and to avoid changing the encoding of newly created files
2831 without your knowledge (in case 'fileencodings' is empty).
2832
2833 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002834 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00002835 iconv() or as specified with 'charconvert'.
2836
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002837 If you need to know whether 'encoding' is a multi-byte encoding, you
2838 can use: >
2839 if has("multi_byte_encoding")
2840<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002841 Normally 'encoding' will be equal to your current locale. This will
2842 be the default if Vim recognizes your environment settings. If
2843 'encoding' is not set to the current locale, 'termencoding' must be
2844 set to convert typed and displayed text. See |encoding-table|.
2845
2846 When you set this option, it fires the |EncodingChanged| autocommand
2847 event so that you can set up fonts if necessary.
2848
2849 When the option is set, the value is converted to lowercase. Thus
2850 you can set it with uppercase values too. Underscores are translated
2851 to '-' signs.
2852 When the encoding is recognized, it is changed to the standard name.
2853 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
2854 "iso-8859-2" and "utf8" becomes "utf-8".
2855
2856 Note: "latin1" is also used when the encoding could not be detected.
2857 This only works when editing files in the same encoding! When the
2858 actual character set is not latin1, make sure 'fileencoding' and
2859 'fileencodings' are empty. When conversion is needed, switch to using
2860 utf-8.
2861
2862 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
2863 You don't notice this while editing, but it does matter for the
2864 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
2865 setting 'encoding' to one of these values instead of utf-8 only has
2866 effect for encoding used for files when 'fileencoding' is empty.
2867
Bram Moolenaar661b1822005-07-28 22:36:45 +00002868 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
2869 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002870
2871 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
2872'endofline' 'eol' boolean (default on)
2873 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002874 When writing a file and this option is off and the 'binary' option
Bram Moolenaar34d72d42015-07-17 14:18:08 +02002875 is on, or 'fixeol' option is off, no <EOL> will be written for the
2876 last line in the file. This option is automatically set or reset when
2877 starting to edit a new file, depending on whether file has an <EOL>
2878 for the last line in the file. Normally you don't have to set or
2879 reset this option.
2880 When 'binary' is off and 'fixeol' is on the value is not used when
2881 writing the file. When 'binary' is on or 'fixeol' is off it is used
2882 to remember the presence of a <EOL> for the last line in the file, so
2883 that when you write the file the situation from the original file can
2884 be kept. But you can change it if you want to.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002885
2886 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
2887'equalalways' 'ea' boolean (default on)
2888 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002889 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00002890 splitting or closing a window. This also happens the moment the
2891 option is switched on. When off, splitting a window will reduce the
2892 size of the current window and leave the other windows the same. When
2893 closing a window the extra lines are given to the window next to it
2894 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00002895 When mixing vertically and horizontally split windows, a minimal size
2896 is computed and some windows may be larger if there is room. The
2897 'eadirection' option tells in which direction the size is affected.
Bram Moolenaar67f71312007-08-12 14:55:56 +00002898 Changing the height and width of a window can be avoided by setting
2899 'winfixheight' and 'winfixwidth', respectively.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002900 If a window size is specified when creating a new window sizes are
2901 currently not equalized (it's complicated, but may be implemented in
2902 the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002903
2904 *'equalprg'* *'ep'*
2905'equalprg' 'ep' string (default "")
2906 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002907 External program to use for "=" command. When this option is empty
Bram Moolenaar446cb832008-06-24 21:56:24 +00002908 the internal formatting functions are used; either 'lisp', 'cindent'
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002909 or 'indentexpr'. When Vim was compiled without internal formatting,
2910 the "indent" program is used.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002911 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002912 about including spaces and backslashes.
2913 This option cannot be set from a |modeline| or in the |sandbox|, for
2914 security reasons.
2915
2916 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
2917'errorbells' 'eb' boolean (default off)
2918 global
2919 Ring the bell (beep or screen flash) for error messages. This only
2920 makes a difference for error messages, the bell will be used always
2921 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002922 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar165bc692015-07-21 17:53:25 +02002923 screen flash or do nothing. See 'belloff' to finetune when to ring the
2924 bell.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002925
2926 *'errorfile'* *'ef'*
2927'errorfile' 'ef' string (Amiga default: "AztecC.Err",
2928 others: "errors.err")
2929 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002930 {not available when compiled without the |+quickfix|
2931 feature}
2932 Name of the errorfile for the QuickFix mode (see |:cf|).
2933 When the "-q" command-line argument is used, 'errorfile' is set to the
2934 following argument. See |-q|.
2935 NOT used for the ":make" command. See 'makeef' for that.
2936 Environment variables are expanded |:set_env|.
2937 See |option-backslash| about including spaces and backslashes.
2938 This option cannot be set from a |modeline| or in the |sandbox|, for
2939 security reasons.
2940
2941 *'errorformat'* *'efm'*
2942'errorformat' 'efm' string (default is very long)
2943 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002944 {not available when compiled without the |+quickfix|
2945 feature}
2946 Scanf-like description of the format for the lines in the error file
2947 (see |errorformat|).
2948
2949 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
2950'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
2951 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002952 Function keys that start with an <Esc> are recognized in Insert
2953 mode. When this option is off, the cursor and function keys cannot be
2954 used in Insert mode if they start with an <Esc>. The advantage of
2955 this is that the single <Esc> is recognized immediately, instead of
2956 after one second. Instead of resetting this option, you might want to
2957 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
2958 when 'esckeys' is off, you can still map anything, but the cursor keys
2959 won't work by default.
2960 NOTE: This option is set to the Vi default value when 'compatible' is
2961 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaarc8234772019-11-10 21:00:27 +01002962 NOTE: when this option is off then the |modifyOtherKeys| functionality
2963 is disabled while in Insert mode to avoid ending Insert mode with any
2964 key that has a modifier.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002965
2966 *'eventignore'* *'ei'*
2967'eventignore' 'ei' string (default "")
2968 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002969 A list of autocommand event names, which are to be ignored.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00002970 When set to "all" or when "all" is one of the items, all autocommand
2971 events are ignored, autocommands will not be executed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002972 Otherwise this is a comma separated list of event names. Example: >
2973 :set ei=WinEnter,WinLeave
2974<
2975 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
2976'expandtab' 'et' boolean (default off)
2977 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002978 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002979 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002980 when 'autoindent' is on. To insert a real tab when 'expandtab' is
2981 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
Bram Moolenaarca635012015-09-25 20:34:21 +02002982 This option is reset when the 'paste' option is set and restored when
2983 the 'paste' option is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002984 NOTE: This option is reset when 'compatible' is set.
2985
2986 *'exrc'* *'ex'* *'noexrc'* *'noex'*
2987'exrc' 'ex' boolean (default off)
2988 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002989 Enables the reading of .vimrc, .exrc and .gvimrc in the current
Bram Moolenaar36f44c22016-08-28 18:17:20 +02002990 directory.
2991
2992 Setting this option is a potential security leak. E.g., consider
2993 unpacking a package or fetching files from github, a .vimrc in there
2994 might be a trojan horse. BETTER NOT SET THIS OPTION!
2995 Instead, define an autocommand in your .vimrc to set options for a
2996 matching directory.
2997
2998 If you do switch this option on you should also consider setting the
2999 'secure' option (see |initialization|).
3000 Also see |.vimrc| and |gui-init|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003001 This option cannot be set from a |modeline| or in the |sandbox|, for
3002 security reasons.
3003
3004 *'fileencoding'* *'fenc'* *E213*
3005'fileencoding' 'fenc' string (default: "")
3006 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003007 Sets the character encoding for the file of this buffer.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003008
Bram Moolenaar071d4272004-06-13 20:20:40 +00003009 When 'fileencoding' is different from 'encoding', conversion will be
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003010 done when writing the file. For reading see below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003011 When 'fileencoding' is empty, the same value as 'encoding' will be
3012 used (no conversion when reading or writing a file).
Bram Moolenaar214641f2017-03-05 17:04:09 +01003013 No error will be given when the value is set, only when it is used,
3014 only when writing a file.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003015 Conversion will also be done when 'encoding' and 'fileencoding' are
3016 both a Unicode encoding and 'fileencoding' is not utf-8. That's
3017 because internally Unicode is always stored as utf-8.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003018 WARNING: Conversion can cause loss of information! When
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003019 'encoding' is "utf-8" or another Unicode encoding, conversion
3020 is most likely done in a way that the reverse conversion
3021 results in the same text. When 'encoding' is not "utf-8" some
3022 characters may be lost!
Bram Moolenaar865242e2010-07-14 21:12:05 +02003023
Bram Moolenaar071d4272004-06-13 20:20:40 +00003024 See 'encoding' for the possible values. Additionally, values may be
3025 specified that can be handled by the converter, see
3026 |mbyte-conversion|.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003027
Bram Moolenaar071d4272004-06-13 20:20:40 +00003028 When reading a file 'fileencoding' will be set from 'fileencodings'.
3029 To read a file in a certain encoding it won't work by setting
Bram Moolenaar02467872007-05-06 13:22:01 +00003030 'fileencoding', use the |++enc| argument. One exception: when
3031 'fileencodings' is empty the value of 'fileencoding' is used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003032 For a new file the global value of 'fileencoding' is used.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003033
Bram Moolenaar071d4272004-06-13 20:20:40 +00003034 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
3035 When the option is set, the value is converted to lowercase. Thus
3036 you can set it with uppercase values too. '_' characters are
3037 replaced with '-'. If a name is recognized from the list for
3038 'encoding', it is replaced by the standard name. For example
3039 "ISO8859-2" becomes "iso-8859-2".
Bram Moolenaar865242e2010-07-14 21:12:05 +02003040
Bram Moolenaar071d4272004-06-13 20:20:40 +00003041 When this option is set, after starting to edit a file, the 'modified'
3042 option is set, because the file would be different when written.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003043
3044 Keep in mind that changing 'fenc' from a modeline happens
3045 AFTER the text has been read, thus it applies to when the file will be
3046 written. If you do set 'fenc' in a modeline, you might want to set
3047 'nomodified' to avoid not being able to ":q".
3048
Bram Moolenaar071d4272004-06-13 20:20:40 +00003049 This option can not be changed when 'modifiable' is off.
3050
3051 *'fe'*
3052 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003053 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003054 old short name was 'fe', which is no longer used.
3055
3056 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003057'fileencodings' 'fencs' string (default: "ucs-bom",
3058 "ucs-bom,utf-8,default,latin1" when
3059 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003060 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003061 This is a list of character encodings considered when starting to edit
3062 an existing file. When a file is read, Vim tries to use the first
3063 mentioned character encoding. If an error is detected, the next one
3064 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003065 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00003066 an empty string, which means the value of 'encoding' is used.
3067 WARNING: Conversion can cause loss of information! When
3068 'encoding' is "utf-8" (or one of the other Unicode variants)
3069 conversion is most likely done in a way that the reverse
3070 conversion results in the same text. When 'encoding' is not
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003071 "utf-8" some non-ASCII characters may be lost! You can use
3072 the |++bad| argument to specify what is done with characters
3073 that can't be converted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003074 For an empty file or a file with only ASCII characters most encodings
3075 will work and the first entry of 'fileencodings' will be used (except
3076 "ucs-bom", which requires the BOM to be present). If you prefer
3077 another encoding use an BufReadPost autocommand event to test if your
3078 preferred encoding is to be used. Example: >
3079 au BufReadPost * if search('\S', 'w') == 0 |
3080 \ set fenc=iso-2022-jp | endif
3081< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
3082 non-blank characters.
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003083 When the |++enc| argument is used then the value of 'fileencodings' is
3084 not used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003085 Note that 'fileencodings' is not used for a new file, the global value
3086 of 'fileencoding' is used instead. You can set it with: >
3087 :setglobal fenc=iso-8859-2
3088< This means that a non-existing file may get a different encoding than
3089 an empty file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003090 The special value "ucs-bom" can be used to check for a Unicode BOM
3091 (Byte Order Mark) at the start of the file. It must not be preceded
3092 by "utf-8" or another Unicode encoding for this to work properly.
3093 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
3094 because Vim cannot detect an error, thus the encoding is always
3095 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003096 The special value "default" can be used for the encoding from the
3097 environment. This is the default value for 'encoding'. It is useful
3098 when 'encoding' is set to "utf-8" and your environment uses a
3099 non-latin1 encoding, such as Russian.
Bram Moolenaarca003e12006-03-17 23:19:38 +00003100 When 'encoding' is "utf-8" and a file contains an illegal byte
3101 sequence it won't be recognized as UTF-8. You can use the |8g8|
3102 command to find the illegal byte sequence.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003103 WRONG VALUES: WHAT'S WRONG:
3104 latin1,utf-8 "latin1" will always be used
3105 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
3106 file
3107 cp1250,latin1 "cp1250" will always be used
3108 If 'fileencodings' is empty, 'fileencoding' is not modified.
3109 See 'fileencoding' for the possible values.
3110 Setting this option does not have an effect until the next time a file
3111 is read.
3112
3113 *'fileformat'* *'ff'*
Bram Moolenaar00590742019-02-15 21:06:09 +01003114'fileformat' 'ff' string (MS-Windows default: "dos",
3115 Unix, macOS default: "unix")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003116 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003117 This gives the <EOL> of the current buffer, which is used for
3118 reading/writing the buffer from/to a file:
3119 dos <CR> <NL>
3120 unix <NL>
3121 mac <CR>
3122 When "dos" is used, CTRL-Z at the end of a file is ignored.
3123 See |file-formats| and |file-read|.
3124 For the character encoding of the file see 'fileencoding'.
3125 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
Bram Moolenaarbf884932013-04-05 22:26:15 +02003126 works like it was set to "unix".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003127 This option is set automatically when starting to edit a file and
3128 'fileformats' is not empty and 'binary' is off.
3129 When this option is set, after starting to edit a file, the 'modified'
3130 option is set, because the file would be different when written.
3131 This option can not be changed when 'modifiable' is off.
3132 For backwards compatibility: When this option is set to "dos",
3133 'textmode' is set, otherwise 'textmode' is reset.
3134
3135 *'fileformats'* *'ffs'*
3136'fileformats' 'ffs' string (default:
Bram Moolenaar00590742019-02-15 21:06:09 +01003137 Vim+Vi MS-Windows: "dos,unix",
3138 Vim Unix, macOS: "unix,dos",
Bram Moolenaar071d4272004-06-13 20:20:40 +00003139 Vi Cygwin: "unix,dos",
3140 Vi others: "")
3141 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003142 This gives the end-of-line (<EOL>) formats that will be tried when
3143 starting to edit a new buffer and when reading a file into an existing
3144 buffer:
3145 - When empty, the format defined with 'fileformat' will be used
3146 always. It is not set automatically.
3147 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003148 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003149 'fileformats' name will be used when a file is read into an existing
3150 buffer, no matter what 'fileformat' for that buffer is set to.
3151 - When more than one name is present, separated by commas, automatic
3152 <EOL> detection will be done when reading a file. When starting to
3153 edit a file, a check is done for the <EOL>:
3154 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
3155 'fileformat' is set to "dos".
3156 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003157 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003158 preceding <CR>, "unix" is preferred over "dos".
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01003159 3. If 'fileformat' has not yet been set, and if a <CR> is found, and
3160 if 'fileformats' includes "mac", 'fileformat' is set to "mac".
Bram Moolenaar00659062010-09-21 22:34:02 +02003161 This means that "mac" is only chosen when:
3162 "unix" is not present or no <NL> is found in the file, and
3163 "dos" is not present or no <CR><NL> is found in the file.
3164 Except: if "unix" was chosen, but there is a <CR> before
3165 the first <NL>, and there appear to be more <CR>s than <NL>s in
Bram Moolenaar166af9b2010-11-16 20:34:40 +01003166 the first few lines, "mac" is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003167 4. If 'fileformat' is still not set, the first name from
3168 'fileformats' is used.
3169 When reading a file into an existing buffer, the same is done, but
3170 this happens like 'fileformat' has been set appropriately for that
3171 file only, the option is not changed.
3172 When 'binary' is set, the value of 'fileformats' is not used.
3173
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01003174 When Vim starts up with an empty buffer the first item is used. You
3175 can overrule this by setting 'fileformat' in your .vimrc.
Bram Moolenaar81af9252010-12-10 20:35:50 +01003176
Bram Moolenaar071d4272004-06-13 20:20:40 +00003177 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
3178 are ":source"ed and for vimrc files, automatic <EOL> detection may be
3179 done:
3180 - When 'fileformats' is empty, there is no automatic detection. Dos
3181 format will be used.
3182 - When 'fileformats' is set to one or more names, automatic detection
3183 is done. This is based on the first <NL> in the file: If there is a
3184 <CR> in front of it, Dos format is used, otherwise Unix format is
3185 used.
3186 Also see |file-formats|.
3187 For backwards compatibility: When this option is set to an empty
3188 string or one format (no comma is included), 'textauto' is reset,
3189 otherwise 'textauto' is set.
3190 NOTE: This option is set to the Vi default value when 'compatible' is
3191 set and to the Vim default value when 'compatible' is reset.
3192
Bram Moolenaarbf884932013-04-05 22:26:15 +02003193 *'fileignorecase'* *'fic'* *'nofileignorecase'* *'nofic'*
3194'fileignorecase' 'fic' boolean (default on for systems where case in file
3195 names is normally ignored)
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003196 global
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003197 When set case is ignored when using file names and directories.
3198 See 'wildignorecase' for only ignoring case when doing completion.
3199
Bram Moolenaar071d4272004-06-13 20:20:40 +00003200 *'filetype'* *'ft'*
3201'filetype' 'ft' string (default: "")
3202 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003203 When this option is set, the FileType autocommand event is triggered.
3204 All autocommands that match with the value of this option will be
3205 executed. Thus the value of 'filetype' is used in place of the file
3206 name.
3207 Otherwise this option does not always reflect the current file type.
3208 This option is normally set when the file type is detected. To enable
3209 this use the ":filetype on" command. |:filetype|
3210 Setting this option to a different value is most useful in a modeline,
3211 for a file for which the file type is not automatically recognized.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003212 Example, for in an IDL file:
3213 /* vim: set filetype=idl : */ ~
3214 |FileType| |filetypes|
3215 When a dot appears in the value then this separates two filetype
3216 names. Example:
3217 /* vim: set filetype=c.doxygen : */ ~
3218 This will use the "c" filetype first, then the "doxygen" filetype.
3219 This works both for filetype plugins and for syntax files. More than
3220 one dot may appear.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003221 This option is not copied to another buffer, independent of the 's' or
3222 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003223 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003224
3225 *'fillchars'* *'fcs'*
3226'fillchars' 'fcs' string (default "vert:|,fold:-")
3227 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02003228 {not available when compiled without the |+folding|
3229 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003230 Characters to fill the statuslines and vertical separators.
3231 It is a comma separated list of items:
3232
3233 item default Used for ~
3234 stl:c ' ' or '^' statusline of the current window
Bram Moolenaar38a55632016-02-15 22:07:32 +01003235 stlnc:c ' ' or '=' statusline of the non-current windows
Bram Moolenaar071d4272004-06-13 20:20:40 +00003236 vert:c '|' vertical separators |:vsplit|
3237 fold:c '-' filling 'foldtext'
3238 diff:c '-' deleted lines of the 'diff' option
3239
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003240 Any one that is omitted will fall back to the default. For "stl" and
Bram Moolenaar38a55632016-02-15 22:07:32 +01003241 "stlnc" the space will be used when there is highlighting, '^' or '='
Bram Moolenaar071d4272004-06-13 20:20:40 +00003242 otherwise.
3243
3244 Example: >
Bram Moolenaar38a55632016-02-15 22:07:32 +01003245 :set fillchars=stl:^,stlnc:=,vert:\|,fold:-,diff:-
Bram Moolenaar071d4272004-06-13 20:20:40 +00003246< This is similar to the default, except that these characters will also
3247 be used when there is highlighting.
3248
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003249 for "stl" and "stlnc" only single-byte values are supported.
3250
Bram Moolenaar071d4272004-06-13 20:20:40 +00003251 The highlighting used for these items:
3252 item highlight group ~
3253 stl:c StatusLine |hl-StatusLine|
3254 stlnc:c StatusLineNC |hl-StatusLineNC|
3255 vert:c VertSplit |hl-VertSplit|
3256 fold:c Folded |hl-Folded|
3257 diff:c DiffDelete |hl-DiffDelete|
3258
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003259 *'fixendofline'* *'fixeol'* *'nofixendofline'* *'nofixeol'*
3260'fixendofline' 'fixeol' boolean (default on)
3261 local to buffer
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003262 When writing a file and this option is on, <EOL> at the end of file
3263 will be restored if missing. Turn this option off if you want to
3264 preserve the situation from the original file.
3265 When the 'binary' option is set the value of this option doesn't
3266 matter.
3267 See the 'endofline' option.
3268
Bram Moolenaar071d4272004-06-13 20:20:40 +00003269 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
3270'fkmap' 'fk' boolean (default off) *E198*
3271 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003272 {only available when compiled with the |+rightleft|
3273 feature}
Bram Moolenaar14184a32019-02-16 15:10:30 +01003274 This option was for using Farsi, which has been removed. See
3275 |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003276
3277 *'foldclose'* *'fcl'*
3278'foldclose' 'fcl' string (default "")
3279 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003280 {not available when compiled without the |+folding|
3281 feature}
3282 When set to "all", a fold is closed when the cursor isn't in it and
3283 its level is higher than 'foldlevel'. Useful if you want folds to
3284 automatically close when moving out of them.
3285
3286 *'foldcolumn'* *'fdc'*
3287'foldcolumn' 'fdc' number (default 0)
3288 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003289 {not available when compiled without the |+folding|
3290 feature}
3291 When non-zero, a column with the specified width is shown at the side
3292 of the window which indicates open and closed folds. The maximum
3293 value is 12.
3294 See |folding|.
3295
3296 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
3297'foldenable' 'fen' boolean (default on)
3298 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003299 {not available when compiled without the |+folding|
3300 feature}
3301 When off, all folds are open. This option can be used to quickly
3302 switch between showing all text unfolded and viewing the text with
3303 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003304 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00003305 'foldenable' is off.
3306 This option is set by commands that create a new fold or close a fold.
3307 See |folding|.
3308
3309 *'foldexpr'* *'fde'*
3310'foldexpr' 'fde' string (default: "0")
3311 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003312 {not available when compiled without the |+folding|
Bram Moolenaardb84e452010-08-15 13:50:43 +02003313 or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003314 The expression used for when 'foldmethod' is "expr". It is evaluated
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003315 for each line to obtain its fold level. See |fold-expr|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003316
Bram Moolenaar30b65812012-07-12 22:01:11 +02003317 The expression will be evaluated in the |sandbox| if set from a
3318 modeline, see |sandbox-option|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003319 This option can't be set from a |modeline| when the 'diff' option is
Bram Moolenaar110289e2019-05-23 15:38:06 +02003320 on or the 'modelineexpr' option is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003321
3322 It is not allowed to change text or jump to another window while
3323 evaluating 'foldexpr' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003324
3325 *'foldignore'* *'fdi'*
3326'foldignore' 'fdi' string (default: "#")
3327 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003328 {not available when compiled without the |+folding|
3329 feature}
3330 Used only when 'foldmethod' is "indent". Lines starting with
3331 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003332 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003333 The default "#" works well for C programs. See |fold-indent|.
3334
3335 *'foldlevel'* *'fdl'*
3336'foldlevel' 'fdl' number (default: 0)
3337 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003338 {not available when compiled without the |+folding|
3339 feature}
3340 Sets the fold level: Folds with a higher level will be closed.
3341 Setting this option to zero will close all folds. Higher numbers will
3342 close fewer folds.
3343 This option is set by commands like |zm|, |zM| and |zR|.
3344 See |fold-foldlevel|.
3345
3346 *'foldlevelstart'* *'fdls'*
3347'foldlevelstart' 'fdls' number (default: -1)
3348 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003349 {not available when compiled without the |+folding|
3350 feature}
3351 Sets 'foldlevel' when starting to edit another buffer in a window.
3352 Useful to always start editing with all folds closed (value zero),
3353 some folds closed (one) or no folds closed (99).
3354 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003355 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00003356 ignores this option and closes all folds.
3357 It is also done before BufReadPre autocommands, to allow an autocmd to
3358 overrule the 'foldlevel' value for specific files.
3359 When the value is negative, it is not used.
3360
3361 *'foldmarker'* *'fmr'* *E536*
3362'foldmarker' 'fmr' string (default: "{{{,}}}")
3363 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003364 {not available when compiled without the |+folding|
3365 feature}
3366 The start and end marker used when 'foldmethod' is "marker". There
3367 must be one comma, which separates the start and end marker. The
3368 marker is a literal string (a regular expression would be too slow).
3369 See |fold-marker|.
3370
3371 *'foldmethod'* *'fdm'*
3372'foldmethod' 'fdm' string (default: "manual")
3373 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003374 {not available when compiled without the |+folding|
3375 feature}
3376 The kind of folding used for the current window. Possible values:
3377 |fold-manual| manual Folds are created manually.
3378 |fold-indent| indent Lines with equal indent form a fold.
3379 |fold-expr| expr 'foldexpr' gives the fold level of a line.
3380 |fold-marker| marker Markers are used to specify folds.
3381 |fold-syntax| syntax Syntax highlighting items specify folds.
3382 |fold-diff| diff Fold text that is not changed.
3383
3384 *'foldminlines'* *'fml'*
3385'foldminlines' 'fml' number (default: 1)
3386 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003387 {not available when compiled without the |+folding|
3388 feature}
Bram Moolenaar00654022011-02-25 14:42:19 +01003389 Sets the number of screen lines above which a fold can be displayed
3390 closed. Also for manually closed folds. With the default value of
3391 one a fold can only be closed if it takes up two or more screen lines.
3392 Set to zero to be able to close folds of just one screen line.
Bram Moolenaar446beb42011-05-10 17:18:44 +02003393 Note that this only has an effect on what is displayed. After using
Bram Moolenaar071d4272004-06-13 20:20:40 +00003394 "zc" to close a fold, which is displayed open because it's smaller
3395 than 'foldminlines', a following "zc" may close a containing fold.
3396
3397 *'foldnestmax'* *'fdn'*
3398'foldnestmax' 'fdn' number (default: 20)
3399 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003400 {not available when compiled without the |+folding|
3401 feature}
3402 Sets the maximum nesting of folds for the "indent" and "syntax"
3403 methods. This avoids that too many folds will be created. Using more
3404 than 20 doesn't work, because the internal limit is 20.
3405
3406 *'foldopen'* *'fdo'*
3407'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
3408 search,tag,undo")
3409 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003410 {not available when compiled without the |+folding|
3411 feature}
3412 Specifies for which type of commands folds will be opened, if the
3413 command moves the cursor into a closed fold. It is a comma separated
3414 list of items.
Bram Moolenaar05365702010-10-27 18:34:44 +02003415 NOTE: When the command is part of a mapping this option is not used.
3416 Add the |zv| command to the mapping to get the same effect.
3417 (rationale: the mapping may want to control opening folds itself)
3418
Bram Moolenaar071d4272004-06-13 20:20:40 +00003419 item commands ~
3420 all any
3421 block "(", "{", "[[", "[{", etc.
3422 hor horizontal movements: "l", "w", "fx", etc.
3423 insert any command in Insert mode
3424 jump far jumps: "G", "gg", etc.
3425 mark jumping to a mark: "'m", CTRL-O, etc.
3426 percent "%"
3427 quickfix ":cn", ":crew", ":make", etc.
3428 search search for a pattern: "/", "n", "*", "gd", etc.
3429 (not for a search pattern in a ":" command)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003430 Also for |[s| and |]s|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003431 tag jumping to a tag: ":ta", CTRL-T, etc.
3432 undo undo or redo: "u" and CTRL-R
Bram Moolenaar071d4272004-06-13 20:20:40 +00003433 When a movement command is used for an operator (e.g., "dl" or "y%")
3434 this option is not used. This means the operator will include the
3435 whole closed fold.
3436 Note that vertical movements are not here, because it would make it
3437 very difficult to move onto a closed fold.
3438 In insert mode the folds containing the cursor will always be open
3439 when text is inserted.
3440 To close folds you can re-apply 'foldlevel' with the |zx| command or
3441 set the 'foldclose' option to "all".
3442
3443 *'foldtext'* *'fdt'*
3444'foldtext' 'fdt' string (default: "foldtext()")
3445 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003446 {not available when compiled without the |+folding|
3447 feature}
3448 An expression which is used to specify the text displayed for a closed
3449 fold. See |fold-foldtext|.
3450
Bram Moolenaar30b65812012-07-12 22:01:11 +02003451 The expression will be evaluated in the |sandbox| if set from a
3452 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003453 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003454
3455 It is not allowed to change text or jump to another window while
3456 evaluating 'foldtext' |textlock|.
3457
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003458 *'formatexpr'* *'fex'*
3459'formatexpr' 'fex' string (default "")
3460 local to buffer
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003461 {not available when compiled without the |+eval|
3462 feature}
3463 Expression which is evaluated to format a range of lines for the |gq|
3464 operator or automatic formatting (see 'formatoptions'). When this
3465 option is empty 'formatprg' is used.
3466
3467 The |v:lnum| variable holds the first line to be formatted.
3468 The |v:count| variable holds the number of lines to be formatted.
3469 The |v:char| variable holds the character that is going to be
3470 inserted if the expression is being evaluated due to
3471 automatic formatting. This can be empty. Don't insert
3472 it yet!
3473
3474 Example: >
3475 :set formatexpr=mylang#Format()
3476< This will invoke the mylang#Format() function in the
3477 autoload/mylang.vim file in 'runtimepath'. |autoload|
3478
3479 The expression is also evaluated when 'textwidth' is set and adding
3480 text beyond that limit. This happens under the same conditions as
3481 when internal formatting is used. Make sure the cursor is kept in the
3482 same spot relative to the text then! The |mode()| function will
3483 return "i" or "R" in this situation.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01003484
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003485 When the expression evaluates to non-zero Vim will fall back to using
3486 the internal format mechanism.
3487
3488 The expression will be evaluated in the |sandbox| when set from a
3489 modeline, see |sandbox-option|. That stops the option from working,
3490 since changing the buffer text is not allowed.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003491 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaar036986f2017-03-16 17:41:02 +01003492 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003493
Bram Moolenaar86b68352004-12-27 21:59:20 +00003494 *'formatlistpat'* *'flp'*
3495'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
3496 local to buffer
Bram Moolenaar86b68352004-12-27 21:59:20 +00003497 A pattern that is used to recognize a list header. This is used for
3498 the "n" flag in 'formatoptions'.
3499 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00003500 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00003501 while still checking more characters. There must be a character
3502 following the pattern, when it matches the whole line it is handled
3503 like there is no match.
3504 The default recognizes a number, followed by an optional punctuation
3505 character and white space.
3506
Bram Moolenaar6c60f472019-04-28 16:00:35 +02003507 *'formatoptions'* *'fo'*
3508'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
3509 local to buffer
3510 This is a sequence of letters which describes how automatic
3511 formatting is to be done. See |fo-table|. When the 'paste' option is
3512 on, no formatting is done (like 'formatoptions' is empty). Commas can
3513 be inserted for readability.
3514 To avoid problems with flags that are added in the future, use the
3515 "+=" and "-=" feature of ":set" |add-option-flags|.
3516 NOTE: This option is set to the Vi default value when 'compatible' is
3517 set and to the Vim default value when 'compatible' is reset.
3518
Bram Moolenaar071d4272004-06-13 20:20:40 +00003519 *'formatprg'* *'fp'*
3520'formatprg' 'fp' string (default "")
Bram Moolenaar9be7c042017-01-14 14:28:30 +01003521 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003522 The name of an external program that will be used to format the lines
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003523 selected with the |gq| operator. The program must take the input on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003524 stdin and produce the output on stdout. The Unix program "fmt" is
Bram Moolenaara5792f52005-11-23 21:25:05 +00003525 such a program.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003526 If the 'formatexpr' option is not empty it will be used instead.
3527 Otherwise, if 'formatprg' option is an empty string, the internal
3528 format function will be used |C-indenting|.
Bram Moolenaara5792f52005-11-23 21:25:05 +00003529 Environment variables are expanded |:set_env|. See |option-backslash|
3530 about including spaces and backslashes.
Bram Moolenaar30b65812012-07-12 22:01:11 +02003531 This option cannot be set from a |modeline| or in the |sandbox|, for
3532 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003533
Bram Moolenaard94464e2015-11-02 15:28:18 +01003534 *'fsync'* *'fs'* *'nofsync'* *'nofs'*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003535'fsync' 'fs' boolean (default on)
3536 global
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003537 When on, the library function fsync() will be called after writing a
3538 file. This will flush a file to disk, ensuring that it is safely
3539 written even on filesystems which do metadata-only journaling. This
3540 will force the harddrive to spin up on Linux systems running in laptop
3541 mode, so it may be undesirable in some situations. Be warned that
3542 turning this off increases the chances of data loss after a crash. On
3543 systems without an fsync() implementation, this variable is always
3544 off.
3545 Also see 'swapsync' for controlling fsync() on swap files.
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003546 'fsync' also applies to |writefile()|, unless a flag is used to
3547 overrule it.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003548 This option cannot be set from a |modeline| or in the |sandbox|, for
3549 security reasons.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003550
Bram Moolenaar071d4272004-06-13 20:20:40 +00003551 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
3552'gdefault' 'gd' boolean (default off)
3553 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003554 When on, the ":substitute" flag 'g' is default on. This means that
3555 all matches in a line are substituted instead of one. When a 'g' flag
3556 is given to a ":substitute" command, this will toggle the substitution
3557 of all or one match. See |complex-change|.
3558
3559 command 'gdefault' on 'gdefault' off ~
3560 :s/// subst. all subst. one
3561 :s///g subst. one subst. all
3562 :s///gg subst. all subst. one
3563
3564 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar21020352017-06-13 17:21:04 +02003565 DEPRECATED: Setting this option may break plugins that are not aware
3566 of this option. Also, many users get confused that adding the /g flag
3567 has the opposite effect of that it normally does.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003568
3569 *'grepformat'* *'gfm'*
Bram Moolenaar6e932462014-09-09 18:48:09 +02003570'grepformat' 'gfm' string (default "%f:%l:%m,%f:%l%m,%f %l%m")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003571 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003572 Format to recognize for the ":grep" command output.
3573 This is a scanf-like string that uses the same format as the
3574 'errorformat' option: see |errorformat|.
3575
3576 *'grepprg'* *'gp'*
3577'grepprg' 'gp' string (default "grep -n ",
3578 Unix: "grep -n $* /dev/null",
3579 Win32: "findstr /n" or "grep -n",
3580 VMS: "SEARCH/NUMBERS ")
3581 global or local to buffer |global-local|
Bram Moolenaar582fd852005-03-28 20:58:01 +00003582 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003583 and '#' characters, which are expanded like when used in a command-
3584 line. The placeholder "$*" is allowed to specify where the arguments
3585 will be included. Environment variables are expanded |:set_env|. See
3586 |option-backslash| about including spaces and backslashes.
3587 When your "grep" accepts the "-H" argument, use this to make ":grep"
3588 also work well with a single file: >
3589 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00003590< Special value: When 'grepprg' is set to "internal" the |:grep| command
Bram Moolenaara6557602006-02-04 22:43:20 +00003591 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like
3592 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00003593 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00003594 apply equally to 'grepprg'.
3595 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
3596 otherwise it's "grep -n".
3597 This option cannot be set from a |modeline| or in the |sandbox|, for
3598 security reasons.
3599
3600 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
3601'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
3602 ve:ver35-Cursor,
3603 o:hor50-Cursor,
3604 i-ci:ver25-Cursor/lCursor,
3605 r-cr:hor20-Cursor/lCursor,
3606 sm:block-Cursor
3607 -blinkwait175-blinkoff150-blinkon175",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003608 for Win32 console:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003609 "n-v-c:block,o:hor50,i-ci:hor15,
3610 r-cr:hor30,sm:block")
3611 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003612 {only available when compiled with GUI enabled, and
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003613 for Win32 console}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003614 This option tells Vim what the cursor should look like in different
Bram Moolenaar8024f932020-01-14 19:29:13 +01003615 modes. It fully works in the GUI. In a Win32 console, only the
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003616 height of the cursor can be changed. This can be done by specifying a
3617 block cursor, or a percentage for a vertical or horizontal cursor.
Bram Moolenaar1e7813a2015-03-31 18:31:03 +02003618 For a console the 't_SI', 't_SR', and 't_EI' escape sequences are
3619 used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003620
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003621 The option is a comma separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003622 mode-list and an argument-list:
3623 mode-list:argument-list,mode-list:argument-list,..
3624 The mode-list is a dash separated list of these modes:
3625 n Normal mode
3626 v Visual mode
3627 ve Visual mode with 'selection' "exclusive" (same as 'v',
3628 if not specified)
3629 o Operator-pending mode
3630 i Insert mode
3631 r Replace mode
3632 c Command-line Normal (append) mode
3633 ci Command-line Insert mode
3634 cr Command-line Replace mode
3635 sm showmatch in Insert mode
3636 a all modes
3637 The argument-list is a dash separated list of these arguments:
3638 hor{N} horizontal bar, {N} percent of the character height
3639 ver{N} vertical bar, {N} percent of the character width
3640 block block cursor, fills the whole character
3641 [only one of the above three should be present]
3642 blinkwait{N} *cursor-blinking*
3643 blinkon{N}
3644 blinkoff{N}
3645 blink times for cursor: blinkwait is the delay before
3646 the cursor starts blinking, blinkon is the time that
3647 the cursor is shown and blinkoff is the time that the
3648 cursor is not shown. The times are in msec. When one
3649 of the numbers is zero, there is no blinking. The
3650 default is: "blinkwait700-blinkon400-blinkoff250".
3651 These numbers are used for a missing entry. This
3652 means that blinking is enabled by default. To switch
3653 blinking off you can use "blinkon0". The cursor only
3654 blinks when Vim is waiting for input, not while
3655 executing a command.
3656 To make the cursor blink in an xterm, see
3657 |xterm-blink|.
3658 {group-name}
3659 a highlight group name, that sets the color and font
3660 for the cursor
3661 {group-name}/{group-name}
3662 Two highlight group names, the first is used when
3663 no language mappings are used, the other when they
3664 are. |language-mapping|
3665
3666 Examples of parts:
3667 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
3668 block cursor with colors from the "nCursor"
3669 highlight group
3670 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
3671 In Insert and Command-line Insert mode, use a
3672 30% vertical bar cursor with colors from the
3673 "iCursor" highlight group. Blink a bit
3674 faster.
3675
3676 The 'a' mode is different. It will set the given argument-list for
3677 all modes. It does not reset anything to defaults. This can be used
3678 to do a common setting for all modes. For example, to switch off
3679 blinking: "a:blinkon0"
3680
3681 Examples of cursor highlighting: >
3682 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
3683 :highlight Cursor gui=NONE guifg=bg guibg=fg
3684<
3685 *'guifont'* *'gfn'*
Bram Moolenaar251e1912011-06-19 05:09:16 +02003686 *E235* *E596*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003687'guifont' 'gfn' string (default "")
3688 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003689 {only available when compiled with GUI enabled}
3690 This is a list of fonts which will be used for the GUI version of Vim.
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003691 In its simplest form the value is just one font name.
3692 See |gui-font| for the details.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003693
3694 *'guifontset'* *'gfs'*
3695 *E250* *E252* *E234* *E597* *E598*
3696'guifontset' 'gfs' string (default "")
3697 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003698 {only available when compiled with GUI enabled and
3699 with the |+xfontset| feature}
Bram Moolenaar3df01732017-02-17 22:47:16 +01003700 {not available in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003701 When not empty, specifies two (or more) fonts to be used. The first
3702 one for normal English, the second one for your special language. See
3703 |xfontset|.
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003704
Bram Moolenaar071d4272004-06-13 20:20:40 +00003705 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
3706'guifontwide' 'gfw' string (default "")
3707 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003708 {only available when compiled with GUI enabled}
3709 When not empty, specifies a comma-separated list of fonts to be used
3710 for double-width characters. The first font that can be loaded is
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003711 used. See |gui-fontwide|.
Bram Moolenaar0f272122013-01-23 18:37:40 +01003712
Bram Moolenaar071d4272004-06-13 20:20:40 +00003713 *'guiheadroom'* *'ghr'*
3714'guiheadroom' 'ghr' number (default 50)
3715 global
Bram Moolenaar110289e2019-05-23 15:38:06 +02003716 {only for GTK and X11 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003717 The number of pixels subtracted from the screen height when fitting
3718 the GUI window on the screen. Set this before the GUI is started,
3719 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003720 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00003721 lines will be left for window decorations and other items on the
3722 screen. Set it to a negative value to allow windows taller than the
3723 screen.
3724
3725 *'guioptions'* *'go'*
Bram Moolenaar2c64ca12018-10-19 16:22:31 +02003726'guioptions' 'go' string (default "egmrLtT" (MS-Windows,
3727 "t" is removed in |defaults.vim|),
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02003728 "aegimrLtT" (GTK, Motif and Athena),
3729 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00003730 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003731 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00003732 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003733 sequence of letters which describes what components and options of the
3734 GUI should be used.
3735 To avoid problems with flags that are added in the future, use the
3736 "+=" and "-=" feature of ":set" |add-option-flags|.
3737
Bram Moolenaar13568252018-03-16 20:46:58 +01003738 Valid characters are as follows:
3739 *'go-!'*
3740 '!' External commands are executed in a terminal window. Without
3741 this flag the MS-Windows GUI will open a console window to
3742 execute the command. The Unix GUI will simulate a dumb
3743 terminal to list the command output.
3744 The terminal window will be positioned at the bottom, and grow
3745 upwards as needed.
Bram Moolenaarba3ff532018-11-04 14:45:49 +01003746 *'go-a'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003747 'a' Autoselect: If present, then whenever VISUAL mode is started,
3748 or the Visual area extended, Vim tries to become the owner of
3749 the windowing system's global selection. This means that the
3750 Visually highlighted text is available for pasting into other
3751 applications as well as into Vim itself. When the Visual mode
3752 ends, possibly due to an operation on the text, or when an
3753 application wants to paste the selection, the highlighted text
3754 is automatically yanked into the "* selection register.
3755 Thus the selection is still available for pasting into other
3756 applications after the VISUAL mode has ended.
3757 If not present, then Vim won't become the owner of the
3758 windowing system's global selection unless explicitly told to
3759 by a yank or delete operation for the "* register.
3760 The same applies to the modeless selection.
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02003761 *'go-P'*
3762 'P' Like autoselect but using the "+ register instead of the "*
Bram Moolenaar3848e002016-03-19 18:42:29 +01003763 register.
Bram Moolenaar02467872007-05-06 13:22:01 +00003764 *'go-A'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003765 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003766 applies to the modeless selection.
3767
3768 'guioptions' autoselect Visual autoselect modeless ~
3769 "" - -
3770 "a" yes yes
3771 "A" - yes
3772 "aA" yes yes
3773
Bram Moolenaar02467872007-05-06 13:22:01 +00003774 *'go-c'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003775 'c' Use console dialogs instead of popup dialogs for simple
3776 choices.
Bram Moolenaar50bf7ce2019-09-15 13:17:00 +02003777 *'go-d'*
3778 'd' Use dark theme variant if available. Currently only works for
3779 GTK+ GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00003780 *'go-e'*
Bram Moolenaare224ffa2006-03-01 00:01:28 +00003781 'e' Add tab pages when indicated with 'showtabline'.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003782 'guitablabel' can be used to change the text in the labels.
3783 When 'e' is missing a non-GUI tab pages line may be used.
Bram Moolenaard68071d2006-05-02 22:08:30 +00003784 The GUI tabs are only supported on some systems, currently
Bram Moolenaarb3f74062020-02-26 16:16:53 +01003785 GTK, Motif, Mac OS/X, Haiku, and MS-Windows.
Bram Moolenaar02467872007-05-06 13:22:01 +00003786 *'go-f'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003787 'f' Foreground: Don't use fork() to detach the GUI from the shell
3788 where it was started. Use this for programs that wait for the
3789 editor to finish (e.g., an e-mail program). Alternatively you
3790 can use "gvim -f" or ":gui -f" to start the GUI in the
3791 foreground. |gui-fork|
3792 Note: Set this option in the vimrc file. The forking may have
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003793 happened already when the |gvimrc| file is read.
Bram Moolenaar02467872007-05-06 13:22:01 +00003794 *'go-i'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003795 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
3796 corner of the window. It's black&white on non-GTK, because of
3797 limitations of X11. For a color icon, see |X11-icon|.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003798 *'go-m'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003799 'm' Menu bar is present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003800 *'go-M'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003801 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00003802 that this flag must be added in the .vimrc file, before
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003803 switching on syntax or filetype recognition (when the |gvimrc|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003804 file is sourced the system menu has already been loaded; the
Bram Moolenaar01164a62017-11-02 22:58:42 +01003805 `:syntax on` and `:filetype on` commands load the menu too).
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003806 *'go-g'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003807 'g' Grey menu items: Make menu items that are not active grey. If
3808 'g' is not included inactive menu items are not shown at all.
3809 Exception: Athena will always use grey menu items.
Bram Moolenaar02467872007-05-06 13:22:01 +00003810 *'go-t'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003811 't' Include tearoff menu items. Currently only works for Win32,
3812 GTK+, and Motif 1.2 GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00003813 *'go-T'*
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00003814 'T' Include Toolbar. Currently only in Win32, GTK+, Motif, Photon
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00003815 and Athena GUIs.
Bram Moolenaar02467872007-05-06 13:22:01 +00003816 *'go-r'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003817 'r' Right-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003818 *'go-R'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003819 'R' Right-hand scrollbar is present when there is a vertically
3820 split window.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003821 *'go-l'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003822 'l' Left-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003823 *'go-L'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003824 'L' Left-hand scrollbar is present when there is a vertically
3825 split window.
Bram Moolenaar02467872007-05-06 13:22:01 +00003826 *'go-b'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003827 'b' Bottom (horizontal) scrollbar is present. Its size depends on
3828 the longest visible line, or on the cursor line if the 'h'
3829 flag is included. |gui-horiz-scroll|
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003830 *'go-h'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003831 'h' Limit horizontal scrollbar size to the length of the cursor
3832 line. Reduces computations. |gui-horiz-scroll|
3833
3834 And yes, you may even have scrollbars on the left AND the right if
3835 you really want to :-). See |gui-scrollbars| for more information.
3836
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003837 *'go-v'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003838 'v' Use a vertical button layout for dialogs. When not included,
3839 a horizontal layout is preferred, but when it doesn't fit a
3840 vertical layout is used anyway.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003841 *'go-p'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003842 'p' Use Pointer callbacks for X11 GUI. This is required for some
3843 window managers. If the cursor is not blinking or hollow at
3844 the right moment, try adding this flag. This must be done
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003845 before starting the GUI. Set it in your |gvimrc|. Adding or
Bram Moolenaar071d4272004-06-13 20:20:40 +00003846 removing it after the GUI has started has no effect.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003847 *'go-F'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003848 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar8ac44152017-11-09 18:33:29 +01003849 *'go-k'*
3850 'k' Keep the GUI window size when adding/removing a scrollbar, or
3851 toolbar, tabline, etc. Instead, the behavior is similar to
3852 when the window is maximized and will adjust 'lines' and
3853 'columns' to fit to the window. Without the 'k' flag Vim will
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003854 try to keep 'lines' and 'columns' the same when adding and
Bram Moolenaar8ac44152017-11-09 18:33:29 +01003855 removing GUI components.
Bram Moolenaar02467872007-05-06 13:22:01 +00003856
Bram Moolenaar071d4272004-06-13 20:20:40 +00003857 *'guipty'* *'noguipty'*
3858'guipty' boolean (default on)
3859 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003860 {only available when compiled with GUI enabled}
3861 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
3862 I/O to/from shell commands. See |gui-pty|.
3863
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003864 *'guitablabel'* *'gtl'*
3865'guitablabel' 'gtl' string (default empty)
3866 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02003867 {only available when compiled with GUI enabled}
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003868 When nonempty describes the text to use in a label of the GUI tab
Bram Moolenaard68071d2006-05-02 22:08:30 +00003869 pages line. When empty and when the result is empty Vim will use a
3870 default label. See |setting-guitablabel| for more info.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003871
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003872 The format of this option is like that of 'statusline'.
Bram Moolenaar57657d82006-04-21 22:12:41 +00003873 'guitabtooltip' is used for the tooltip, see below.
Bram Moolenaar51628222016-12-01 23:03:28 +01003874 The expression will be evaluated in the |sandbox| when set from a
3875 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003876 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003877
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003878 Only used when the GUI tab pages line is displayed. 'e' must be
3879 present in 'guioptions'. For the non-GUI tab pages line 'tabline' is
3880 used.
3881
Bram Moolenaar57657d82006-04-21 22:12:41 +00003882 *'guitabtooltip'* *'gtt'*
3883'guitabtooltip' 'gtt' string (default empty)
3884 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02003885 {only available when compiled with GUI enabled}
Bram Moolenaar57657d82006-04-21 22:12:41 +00003886 When nonempty describes the text to use in a tooltip for the GUI tab
3887 pages line. When empty Vim will use a default tooltip.
3888 This option is otherwise just like 'guitablabel' above.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003889 You can include a line break. Simplest method is to use |:let|: >
3890 :let &guitabtooltip = "line one\nline two"
3891<
Bram Moolenaar57657d82006-04-21 22:12:41 +00003892
Bram Moolenaar071d4272004-06-13 20:20:40 +00003893 *'helpfile'* *'hf'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003894'helpfile' 'hf' string (default (MS-Windows) "$VIMRUNTIME\doc\help.txt"
Bram Moolenaar071d4272004-06-13 20:20:40 +00003895 (others) "$VIMRUNTIME/doc/help.txt")
3896 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003897 Name of the main help file. All distributed help files should be
3898 placed together in one directory. Additionally, all "doc" directories
3899 in 'runtimepath' will be used.
3900 Environment variables are expanded |:set_env|. For example:
3901 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003902 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00003903 spaces and backslashes.
3904 This option cannot be set from a |modeline| or in the |sandbox|, for
3905 security reasons.
3906
3907 *'helpheight'* *'hh'*
3908'helpheight' 'hh' number (default 20)
3909 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003910 Minimal initial height of the help window when it is opened with the
3911 ":help" command. The initial height of the help window is half of the
3912 current window, or (when the 'ea' option is on) the same as other
3913 windows. When the height is less than 'helpheight', the height is
3914 set to 'helpheight'. Set to zero to disable.
3915
3916 *'helplang'* *'hlg'*
3917'helplang' 'hlg' string (default: messages language or empty)
3918 global
3919 {only available when compiled with the |+multi_lang|
3920 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003921 Comma separated list of languages. Vim will use the first language
3922 for which the desired help can be found. The English help will always
3923 be used as a last resort. You can add "en" to prefer English over
3924 another language, but that will only find tags that exist in that
3925 language and not in the English help.
3926 Example: >
3927 :set helplang=de,it
3928< This will first search German, then Italian and finally English help
3929 files.
3930 When using |CTRL-]| and ":help!" in a non-English help file Vim will
3931 try to find the tag in the current language before using this option.
3932 See |help-translated|.
3933
3934 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
3935'hidden' 'hid' boolean (default off)
3936 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003937 When off a buffer is unloaded when it is |abandon|ed. When on a
3938 buffer becomes hidden when it is |abandon|ed. If the buffer is still
3939 displayed in another window, it does not become hidden, of course.
3940 The commands that move through the buffer list sometimes make a buffer
3941 hidden although the 'hidden' option is off: When the buffer is
3942 modified, 'autowrite' is off or writing is not possible, and the '!'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003943 flag was used. See also |windows.txt|.
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00003944 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003945 This option is set for one command with ":hide {command}" |:hide|.
3946 WARNING: It's easy to forget that you have changes in hidden buffers.
3947 Think twice when using ":q!" or ":qa!".
3948
3949 *'highlight'* *'hl'*
3950'highlight' 'hl' string (default (as a single string):
Bram Moolenaar58b85342016-08-14 19:54:54 +02003951 "8:SpecialKey,~:EndOfBuffer,@:NonText,
3952 d:Directory,e:ErrorMsg,i:IncSearch,
3953 l:Search,m:MoreMsg,M:ModeMsg,n:LineNr,
Bram Moolenaarefae76a2019-10-27 22:54:58 +01003954 a:LineNrAbove,b:LineNrBelow,
Bram Moolenaar58b85342016-08-14 19:54:54 +02003955 N:CursorLineNr,r:Question,s:StatusLine,
3956 S:StatusLineNC,c:VertSplit,t:Title,
Bram Moolenaar9d87a372018-12-18 21:41:50 +01003957 v:Visual,V:VisualNOS,w:WarningMsg,
3958 W:WildMenu,f:Folded,F:FoldColumn,
3959 A:DiffAdd,C:DiffChange,D:DiffDelete,
3960 T:DiffText,>:SignColumn,-:Conceal,
Bram Moolenaarc8c88492018-12-27 23:59:26 +01003961 B:SpellBad,P:SpellCap,R:SpellRare,
Bram Moolenaar9d87a372018-12-18 21:41:50 +01003962 L:SpellLocal,+:Pmenu,=:PmenuSel,
Bram Moolenaar21020352017-06-13 17:21:04 +02003963 x:PmenuSbar,X:PmenuThumb,*:TabLine,
3964 #:TabLineSel,_:TabLineFill,!:CursorColumn,
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02003965 .:CursorLine,o:ColorColumn,q:QuickFixLine,
Bram Moolenaarc572da52017-08-27 16:52:01 +02003966 z:StatusLineTerm,Z:StatusLineTermNC")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003967 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003968 This option can be used to set highlighting mode for various
3969 occasions. It is a comma separated list of character pairs. The
3970 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003971 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003972 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
Bram Moolenaar58b85342016-08-14 19:54:54 +02003973 |hl-EndOfBuffer| ~ lines after the last line in the buffer
3974 |hl-NonText| @ '@' at the end of the window and
Bram Moolenaar071d4272004-06-13 20:20:40 +00003975 characters from 'showbreak'
3976 |hl-Directory| d directories in CTRL-D listing and other special
3977 things in listings
3978 |hl-ErrorMsg| e error messages
3979 h (obsolete, ignored)
3980 |hl-IncSearch| i 'incsearch' highlighting
3981 |hl-Search| l last search pattern highlighting (see 'hlsearch')
3982 |hl-MoreMsg| m |more-prompt|
3983 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
Bram Moolenaar64486672010-05-16 15:46:46 +02003984 |hl-LineNr| n line number for ":number" and ":#" commands, and
3985 when 'number' or 'relativenumber' option is set.
Bram Moolenaarefae76a2019-10-27 22:54:58 +01003986 |hl-LineNrAbove| a line number above the cursor for when the
3987 'relativenumber' option is set.
3988 |hl-LineNrBelow| b line number below the cursor for when the
3989 'relativenumber' option is set.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01003990 |hl-CursorLineNr| N like n for when 'cursorline' or 'relativenumber' is
3991 set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003992 |hl-Question| r |hit-enter| prompt and yes/no questions
3993 |hl-StatusLine| s status line of current window |status-line|
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01003994 |hl-StatusLineNC| S status lines of not-current windows
Bram Moolenaar071d4272004-06-13 20:20:40 +00003995 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
3996 |hl-VertSplit| c column used to separate vertically split windows
3997 |hl-Visual| v Visual mode
3998 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
3999 Selection" Only X11 Gui's |gui-x11| and
4000 |xterm-clipboard|.
4001 |hl-WarningMsg| w warning messages
4002 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
4003 |hl-Folded| f line used for closed folds
4004 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00004005 |hl-DiffAdd| A added line in diff mode
4006 |hl-DiffChange| C changed line in diff mode
4007 |hl-DiffDelete| D deleted line in diff mode
4008 |hl-DiffText| T inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00004009 |hl-SignColumn| > column used for |signs|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004010 |hl-Conceal| - the placeholders used for concealed characters
4011 (see 'conceallevel')
Bram Moolenaar217ad922005-03-20 22:37:15 +00004012 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02004013 |hl-SpellCap| P word that should start with capital |spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00004014 |hl-SpellRare| R rare word |spell|
4015 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004016 |hl-Pmenu| + popup menu normal line
4017 |hl-PmenuSel| = popup menu selected line
4018 |hl-PmenuSbar| x popup menu scrollbar
4019 |hl-PmenuThumb| X popup menu scrollbar thumb
Bram Moolenaar071d4272004-06-13 20:20:40 +00004020
4021 The display modes are:
4022 r reverse (termcap entry "mr" and "me")
4023 i italic (termcap entry "ZH" and "ZR")
4024 b bold (termcap entry "md" and "me")
4025 s standout (termcap entry "so" and "se")
4026 u underline (termcap entry "us" and "ue")
Bram Moolenaare2cc9702005-03-15 22:43:58 +00004027 c undercurl (termcap entry "Cs" and "Ce")
Bram Moolenaarcf4b00c2017-09-02 18:33:56 +02004028 t strikethrough (termcap entry "Ts" and "Te")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004029 n no highlighting
4030 - no highlighting
4031 : use a highlight group
4032 The default is used for occasions that are not included.
4033 If you want to change what the display modes do, see |dos-colors|
4034 for an example.
4035 When using the ':' display mode, this must be followed by the name of
4036 a highlight group. A highlight group can be used to define any type
4037 of highlighting, including using color. See |:highlight| on how to
4038 define one. The default uses a different group for each occasion.
4039 See |highlight-default| for the default highlight groups.
4040
Bram Moolenaar071d4272004-06-13 20:20:40 +00004041 *'history'* *'hi'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004042'history' 'hi' number (Vim default: 50, Vi default: 0,
4043 set to 200 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004044 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004045 A history of ":" commands, and a history of previous search patterns
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004046 is remembered. This option decides how many entries may be stored in
Bram Moolenaar071d4272004-06-13 20:20:40 +00004047 each of these histories (see |cmdline-editing|).
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004048 The maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004049 NOTE: This option is set to the Vi default value when 'compatible' is
4050 set and to the Vim default value when 'compatible' is reset.
4051
4052 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
4053'hkmap' 'hk' boolean (default off)
4054 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004055 {only available when compiled with the |+rightleft|
4056 feature}
4057 When on, the keyboard is mapped for the Hebrew character set.
4058 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
4059 toggle this option. See |rileft.txt|.
4060 NOTE: This option is reset when 'compatible' is set.
4061
4062 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
4063'hkmapp' 'hkp' boolean (default off)
4064 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004065 {only available when compiled with the |+rightleft|
4066 feature}
4067 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
4068 This is useful if you have a non-Hebrew keyboard.
4069 See |rileft.txt|.
4070 NOTE: This option is reset when 'compatible' is set.
4071
Bram Moolenaar036986f2017-03-16 17:41:02 +01004072 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
4073'hlsearch' 'hls' boolean (default off)
4074 global
Bram Moolenaar036986f2017-03-16 17:41:02 +01004075 {not available when compiled without the
4076 |+extra_search| feature}
4077 When there is a previous search pattern, highlight all its matches.
4078 The type of highlighting used can be set with the 'l' occasion in the
4079 'highlight' option. This uses the "Search" highlight group by
4080 default. Note that only the matching text is highlighted, any offsets
4081 are not applied.
4082 See also: 'incsearch' and |:match|.
4083 When you get bored looking at the highlighted matches, you can turn it
4084 off with |:nohlsearch|. This does not change the option value, as
4085 soon as you use a search command, the highlighting comes back.
4086 'redrawtime' specifies the maximum time spent on finding matches.
4087 When the search pattern can match an end-of-line, Vim will try to
4088 highlight all of the matched text. However, this depends on where the
4089 search starts. This will be the first line in the window or the first
4090 line below a closed fold. A match in a previous line which is not
4091 drawn may not continue in a newly drawn line.
4092 You can specify whether the highlight status is restored on startup
4093 with the 'h' flag in 'viminfo' |viminfo-h|.
4094 NOTE: This option is reset when 'compatible' is set.
4095
Bram Moolenaar071d4272004-06-13 20:20:40 +00004096 *'icon'* *'noicon'*
4097'icon' boolean (default off, on when title can be restored)
4098 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004099 {not available when compiled without the |+title|
4100 feature}
4101 When on, the icon text of the window will be set to the value of
4102 'iconstring' (if it is not empty), or to the name of the file
4103 currently being edited. Only the last part of the name is used.
4104 Overridden by the 'iconstring' option.
4105 Only works if the terminal supports setting window icons (currently
4106 only X11 GUI and terminals with a non-empty 't_IS' option - these are
4107 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
4108 builtin termcap).
4109 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00004110 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00004111 X11.
Bram Moolenaar3a991dd2014-10-02 01:41:41 +02004112 For MS-Windows the icon can be changed, see |windows-icon|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004113
4114 *'iconstring'*
4115'iconstring' string (default "")
4116 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004117 {not available when compiled without the |+title|
4118 feature}
4119 When this option is not empty, it will be used for the icon text of
4120 the window. This happens only when the 'icon' option is on.
4121 Only works if the terminal supports setting window icon text
4122 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
4123 Does not work for MS Windows.
4124 When Vim was compiled with HAVE_X11 defined, the original icon will be
4125 restored if possible |X11|.
4126 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004127 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004128 'titlestring' for example settings.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004129 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004130 {not available when compiled without the |+statusline| feature}
4131
4132 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
4133'ignorecase' 'ic' boolean (default off)
4134 global
4135 Ignore case in search patterns. Also used when searching in the tags
4136 file.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01004137 Also see 'smartcase' and 'tagcase'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004138 Can be overruled by using "\c" or "\C" in the pattern, see
4139 |/ignorecase|.
4140
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004141 *'imactivatefunc'* *'imaf'*
4142'imactivatefunc' 'imaf' string (default "")
4143 global
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004144 This option specifies a function that will be called to
Bram Moolenaar2877d332017-11-26 14:56:16 +01004145 activate or deactivate the Input Method.
Bram Moolenaaref8c6172020-07-01 15:12:44 +02004146 It is not used in the MS-Windows GUI version.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004147 The expression will be evaluated in the |sandbox| when set from a
4148 modeline, see |sandbox-option|.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004149
4150 Example: >
4151 function ImActivateFunc(active)
4152 if a:active
4153 ... do something
4154 else
4155 ... do something
4156 endif
4157 " return value is not used
4158 endfunction
4159 set imactivatefunc=ImActivateFunc
4160<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004161 *'imactivatekey'* *'imak'*
4162'imactivatekey' 'imak' string (default "")
4163 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004164 {only available when compiled with |+xim| and
Bram Moolenaar67c53842010-05-22 18:28:27 +02004165 |+GUI_GTK|} *E599*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004166 Specifies the key that your Input Method in X-Windows uses for
4167 activation. When this is specified correctly, vim can fully control
4168 IM with 'imcmdline', 'iminsert' and 'imsearch'.
4169 You can't use this option to change the activation key, the option
4170 tells Vim what the key is.
4171 Format:
4172 [MODIFIER_FLAG-]KEY_STRING
4173
4174 These characters can be used for MODIFIER_FLAG (case is ignored):
4175 S Shift key
4176 L Lock key
4177 C Control key
4178 1 Mod1 key
4179 2 Mod2 key
4180 3 Mod3 key
4181 4 Mod4 key
4182 5 Mod5 key
4183 Combinations are allowed, for example "S-C-space" or "SC-space" are
4184 both shift+ctrl+space.
4185 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
4186
4187 Example: >
4188 :set imactivatekey=S-space
4189< "S-space" means shift+space. This is the activation key for kinput2 +
4190 canna (Japanese), and ami (Korean).
4191
4192 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
4193'imcmdline' 'imc' boolean (default off)
4194 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004195 When set the Input Method is always on when starting to edit a command
4196 line, unless entering a search pattern (see 'imsearch' for that).
4197 Setting this option is useful when your input method allows entering
4198 English characters directly, e.g., when it's used to type accented
4199 characters with dead keys.
4200
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004201 *'imdisable'* *'imd'* *'noimdisable'* *'noimd'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004202'imdisable' 'imd' boolean (default off, on for some systems (SGI))
4203 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004204 When set the Input Method is never used. This is useful to disable
4205 the IM when it doesn't work properly.
4206 Currently this option is on by default for SGI/IRIX machines. This
4207 may change in later releases.
4208
4209 *'iminsert'* *'imi'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004210'iminsert' 'imi' number (default 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004211 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004212 Specifies whether :lmap or an Input Method (IM) is to be used in
4213 Insert mode. Valid values:
4214 0 :lmap is off and IM is off
4215 1 :lmap is ON and IM is off
4216 2 :lmap is off and IM is ON
Bram Moolenaar071d4272004-06-13 20:20:40 +00004217 To always reset the option to zero when leaving Insert mode with <Esc>
4218 this can be used: >
4219 :inoremap <ESC> <ESC>:set iminsert=0<CR>
4220< This makes :lmap and IM turn off automatically when leaving Insert
4221 mode.
4222 Note that this option changes when using CTRL-^ in Insert mode
4223 |i_CTRL-^|.
4224 The value is set to 1 when setting 'keymap' to a valid keymap name.
4225 It is also used for the argument of commands like "r" and "f".
4226 The value 0 may not work correctly with Athena and Motif with some XIM
4227 methods. Use 'imdisable' to disable XIM then.
4228
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004229 You can set 'imactivatefunc' and 'imstatusfunc' to handle IME/XIM
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004230 via external command if Vim is not compiled with the |+xim|,
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004231 |+multi_byte_ime| or |global-ime|.
4232
Bram Moolenaar071d4272004-06-13 20:20:40 +00004233 *'imsearch'* *'ims'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004234'imsearch' 'ims' number (default -1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004235 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004236 Specifies whether :lmap or an Input Method (IM) is to be used when
4237 entering a search pattern. Valid values:
4238 -1 the value of 'iminsert' is used, makes it look like
4239 'iminsert' is also used when typing a search pattern
4240 0 :lmap is off and IM is off
4241 1 :lmap is ON and IM is off
4242 2 :lmap is off and IM is ON
4243 Note that this option changes when using CTRL-^ in Command-line mode
4244 |c_CTRL-^|.
4245 The value is set to 1 when it is not -1 and setting the 'keymap'
4246 option to a valid keymap name.
4247 The value 0 may not work correctly with Athena and Motif with some XIM
4248 methods. Use 'imdisable' to disable XIM then.
4249
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004250 *'imstatusfunc'* *'imsf'*
4251'imstatusfunc' 'imsf' string (default "")
4252 global
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004253 This option specifies a function that is called to obtain the status
4254 of Input Method. It must return a positive number when IME is active.
Bram Moolenaaref8c6172020-07-01 15:12:44 +02004255 It is not used in the MS-Windows GUI version.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004256
4257 Example: >
4258 function ImStatusFunc()
4259 let is_active = ...do something
4260 return is_active ? 1 : 0
4261 endfunction
4262 set imstatusfunc=ImStatusFunc
4263<
4264 NOTE: This function is invoked very often. Keep it fast.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004265 The expression will be evaluated in the |sandbox| when set from a
4266 modeline, see |sandbox-option|.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004267
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004268 *'imstyle'* *'imst'*
4269'imstyle' 'imst' number (default 1)
4270 global
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004271 {only available when compiled with |+xim| and
4272 |+GUI_GTK|}
Bram Moolenaar37c64c72017-09-19 22:06:03 +02004273 This option specifies the input style of Input Method:
4274 0 use on-the-spot style
4275 1 over-the-spot style
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004276 See: |xim-input-style|
4277
Bram Moolenaar24a98a02017-09-27 22:23:55 +02004278 For a long time on-the-spot style had been used in the GTK version of
4279 vim, however, it is known that it causes troubles when using mappings,
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004280 |single-repeat|, etc. Therefore over-the-spot style becomes the
4281 default now. This should work fine for most people, however if you
4282 have any problem with it, try using on-the-spot style.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004283 The expression will be evaluated in the |sandbox| when set from a
4284 modeline, see |sandbox-option|.
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004285
Bram Moolenaar071d4272004-06-13 20:20:40 +00004286 *'include'* *'inc'*
4287'include' 'inc' string (default "^\s*#\s*include")
4288 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004289 {not available when compiled without the
4290 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004291 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00004292 pattern, just like for the "/" command (See |pattern|). The default
4293 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar1e015462005-09-25 22:16:38 +00004294 "]I", "[d", etc.
4295 Normally the 'isfname' option is used to recognize the file name that
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004296 comes after the matched pattern. But if "\zs" appears in the pattern
4297 then the text matched from "\zs" to the end, or until "\ze" if it
4298 appears, is used as the file name. Use this to include characters
4299 that are not in 'isfname', such as a space. You can then use
4300 'includeexpr' to process the matched text.
Bram Moolenaar1e015462005-09-25 22:16:38 +00004301 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004302
4303 *'includeexpr'* *'inex'*
4304'includeexpr' 'inex' string (default "")
4305 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004306 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004307 |+find_in_path| or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004308 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004309 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004310 :set includeexpr=substitute(v:fname,'\\.','/','g')
4311< The "v:fname" variable will be set to the file name that was detected.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004312
Bram Moolenaar071d4272004-06-13 20:20:40 +00004313 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004314 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004315 Also used for |<cfile>|.
4316
Bram Moolenaar30b65812012-07-12 22:01:11 +02004317 The expression will be evaluated in the |sandbox| when set from a
4318 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004319 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004320
4321 It is not allowed to change text or jump to another window while
4322 evaluating 'includeexpr' |textlock|.
4323
Bram Moolenaar071d4272004-06-13 20:20:40 +00004324 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004325'incsearch' 'is' boolean (default off, set in |defaults.vim| if the
4326 +reltime feature is supported)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004327 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004328 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004329 |+extra_search| features}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004330 While typing a search command, show where the pattern, as it was typed
4331 so far, matches. The matched string is highlighted. If the pattern
4332 is invalid or not found, nothing is shown. The screen will be updated
4333 often, this is only useful on fast terminals.
Bram Moolenaarfc65cab2018-08-28 22:58:02 +02004334 Also applies to the pattern in commands: >
4335 :global
4336 :lvimgrep
4337 :lvimgrepadd
4338 :smagic
4339 :snomagic
4340 :sort
4341 :substitute
4342 :vglobal
4343 :vimgrep
4344 :vimgrepadd
4345< Note that the match will be shown, but the cursor will return to its
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004346 original position when no match is found and when pressing <Esc>. You
4347 still need to finish the search command with <Enter> to move the
4348 cursor to the match.
Bram Moolenaardc083282016-10-11 08:57:33 +02004349 You can use the CTRL-G and CTRL-T keys to move to the next and
4350 previous match. |c_CTRL-G| |c_CTRL-T|
Bram Moolenaar91a4e822008-01-19 14:59:58 +00004351 When compiled with the |+reltime| feature Vim only searches for about
4352 half a second. With a complicated pattern and/or a lot of text the
4353 match may not be found. This is to avoid that Vim hangs while you
4354 are typing the pattern.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004355 The highlighting can be set with the 'i' flag in 'highlight'.
Bram Moolenaar2f058492017-11-30 20:27:52 +01004356 When 'hlsearch' is on, all matched strings are highlighted too while
4357 typing a search command. See also: 'hlsearch'.
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004358 If you don't want to turn 'hlsearch' on, but want to highlight all
4359 matches while searching, you can turn on and off 'hlsearch' with
4360 autocmd. Example: >
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004361 augroup vimrc-incsearch-highlight
4362 autocmd!
Bram Moolenaarf8f8b2e2017-11-02 19:08:48 +01004363 autocmd CmdlineEnter /,\? :set hlsearch
4364 autocmd CmdlineLeave /,\? :set nohlsearch
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004365 augroup END
4366<
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004367 CTRL-L can be used to add one character from after the current match
Bram Moolenaara9dc3752010-07-11 20:46:53 +02004368 to the command line. If 'ignorecase' and 'smartcase' are set and the
4369 command line has no uppercase characters, the added character is
4370 converted to lowercase.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004371 CTRL-R CTRL-W can be used to add the word at the end of the current
4372 match, excluding the characters that were already typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004373 NOTE: This option is reset when 'compatible' is set.
4374
4375 *'indentexpr'* *'inde'*
4376'indentexpr' 'inde' string (default "")
4377 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004378 {not available when compiled without the |+cindent|
4379 or |+eval| features}
4380 Expression which is evaluated to obtain the proper indent for a line.
4381 It is used when a new line is created, for the |=| operator and
4382 in Insert mode as specified with the 'indentkeys' option.
4383 When this option is not empty, it overrules the 'cindent' and
Bram Moolenaar20f90cf2011-05-19 12:22:51 +02004384 'smartindent' indenting. When 'lisp' is set, this option is
4385 overridden by the Lisp indentation algorithm.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004386 When 'paste' is set this option is not used for indenting.
4387 The expression is evaluated with |v:lnum| set to the line number for
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004388 which the indent is to be computed. The cursor is also in this line
Bram Moolenaar071d4272004-06-13 20:20:40 +00004389 when the expression is evaluated (but it may be moved around).
4390 The expression must return the number of spaces worth of indent. It
4391 can return "-1" to keep the current indent (this means 'autoindent' is
4392 used for the indent).
4393 Functions useful for computing the indent are |indent()|, |cindent()|
4394 and |lispindent()|.
4395 The evaluation of the expression must not have side effects! It must
4396 not change the text, jump to another window, etc. Afterwards the
4397 cursor position is always restored, thus the cursor may be moved.
4398 Normally this option would be set to call a function: >
4399 :set indentexpr=GetMyIndent()
4400< Error messages will be suppressed, unless the 'debug' option contains
4401 "msg".
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004402 See |indent-expression|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01004403 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004404
Bram Moolenaar30b65812012-07-12 22:01:11 +02004405 The expression will be evaluated in the |sandbox| when set from a
4406 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004407 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004408
4409 It is not allowed to change text or jump to another window while
4410 evaluating 'indentexpr' |textlock|.
4411
4412
Bram Moolenaar071d4272004-06-13 20:20:40 +00004413 *'indentkeys'* *'indk'*
Bram Moolenaarce655742019-01-31 14:12:57 +01004414'indentkeys' 'indk' string (default "0{,0},0),0],:,0#,!^F,o,O,e")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004415 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004416 {not available when compiled without the |+cindent|
4417 feature}
4418 A list of keys that, when typed in Insert mode, cause reindenting of
4419 the current line. Only happens if 'indentexpr' isn't empty.
4420 The format is identical to 'cinkeys', see |indentkeys-format|.
4421 See |C-indenting| and |indent-expression|.
4422
4423 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
4424'infercase' 'inf' boolean (default off)
4425 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004426 When doing keyword completion in insert mode |ins-completion|, and
Bram Moolenaar446cb832008-06-24 21:56:24 +00004427 'ignorecase' is also on, the case of the match is adjusted depending
4428 on the typed text. If the typed text contains a lowercase letter
4429 where the match has an upper case letter, the completed part is made
4430 lowercase. If the typed text has no lowercase letters and the match
4431 has a lowercase letter where the typed text has an uppercase letter,
4432 and there is a letter before it, the completed part is made uppercase.
4433 With 'noinfercase' the match is used as-is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004434
4435 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
4436'insertmode' 'im' boolean (default off)
4437 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004438 Makes Vim work in a way that Insert mode is the default mode. Useful
4439 if you want to use Vim as a modeless editor. Used for |evim|.
4440 These Insert mode commands will be useful:
4441 - Use the cursor keys to move around.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02004442 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|. When
Bram Moolenaar071d4272004-06-13 20:20:40 +00004443 this is a mapping, it is executed as if 'insertmode' was off.
4444 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004445 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00004446 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
4447 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004448
4449 These items change when 'insertmode' is set:
4450 - when starting to edit of a file, Vim goes to Insert mode.
4451 - <Esc> in Insert mode is a no-op and beeps.
4452 - <Esc> in Normal mode makes Vim go to Insert mode.
4453 - CTRL-L in Insert mode is a command, it is not inserted.
4454 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
4455 However, when <Esc> is used inside a mapping, it behaves like
4456 'insertmode' was not set. This was done to be able to use the same
4457 mappings with 'insertmode' set or not set.
4458 When executing commands with |:normal| 'insertmode' is not used.
4459
4460 NOTE: This option is reset when 'compatible' is set.
4461
4462 *'isfname'* *'isf'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004463'isfname' 'isf' string (default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004464 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
4465 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
4466 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
4467 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
4468 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
4469 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004470 The characters specified by this option are included in file names and
4471 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004472 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004473 Multi-byte characters 256 and above are always included, only the
4474 characters up to 255 are specified with this option.
4475 For UTF-8 the characters 0xa0 to 0xff are included as well.
Bram Moolenaar446cb832008-06-24 21:56:24 +00004476 Think twice before adding white space to this option. Although a
4477 space may appear inside a file name, the effect will be that Vim
4478 doesn't know where a file name starts or ends when doing completion.
4479 It most likely works better without a space in 'isfname'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004480
4481 Note that on systems using a backslash as path separator, Vim tries to
4482 do its best to make it work as you would expect. That is a bit
4483 tricky, since Vi originally used the backslash to escape special
4484 characters. Vim will not remove a backslash in front of a normal file
4485 name character on these systems, but it will on Unix and alikes. The
4486 '&' and '^' are not included by default, because these are special for
4487 cmd.exe.
4488
4489 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004490 Each part can be a single character number or a range. A range is two
4491 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004492 decimal number between 0 and 255 or the ASCII character itself (does
4493 not work for digits). Example:
4494 "_,-,128-140,#-43" (include '_' and '-' and the range
4495 128 to 140 and '#' to 43)
4496 If a part starts with '^', the following character number or range
4497 will be excluded from the option. The option is interpreted from left
4498 to right. Put the excluded character after the range where it is
4499 included. To include '^' itself use it as the last character of the
4500 option or the end of a range. Example:
4501 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
4502 If the character is '@', all characters where isalpha() returns TRUE
4503 are included. Normally these are the characters a to z and A to Z,
4504 plus accented characters. To include '@' itself use "@-@". Examples:
4505 "@,^a-z" All alphabetic characters, excluding lower
Bram Moolenaar446cb832008-06-24 21:56:24 +00004506 case ASCII letters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004507 "a-z,A-Z,@-@" All letters plus the '@' character.
4508 A comma can be included by using it where a character number is
4509 expected. Example:
4510 "48-57,,,_" Digits, comma and underscore.
4511 A comma can be excluded by prepending a '^'. Example:
4512 " -~,^,,9" All characters from space to '~', excluding
4513 comma, plus <Tab>.
4514 See |option-backslash| about including spaces and backslashes.
4515
4516 *'isident'* *'isi'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004517'isident' 'isi' string (default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004518 "@,48-57,_,128-167,224-235"
4519 otherwise: "@,48-57,_,192-255")
4520 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004521 The characters given by this option are included in identifiers.
4522 Identifiers are used in recognizing environment variables and after a
4523 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00004524 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004525 option. For '@' only characters up to 255 are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004526 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004527 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00004528 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
4529
4530 *'iskeyword'* *'isk'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004531'iskeyword' 'isk' string (Vim default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004532 "@,48-57,_,128-167,224-235"
4533 otherwise: "@,48-57,_,192-255"
4534 Vi default: "@,48-57,_")
4535 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004536 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004537 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004538 'isfname' for a description of the format of this option. For '@'
4539 characters above 255 check the "word" character class.
4540 For C programs you could use "a-z,A-Z,48-57,_,.,-,>".
Bram Moolenaar071d4272004-06-13 20:20:40 +00004541 For a help file it is set to all non-blank printable characters except
4542 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
4543 command).
4544 When the 'lisp' option is on the '-' character is always included.
Bram Moolenaarb8060fe2016-01-19 22:29:28 +01004545 This option also influences syntax highlighting, unless the syntax
4546 uses |:syn-iskeyword|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004547 NOTE: This option is set to the Vi default value when 'compatible' is
4548 set and to the Vim default value when 'compatible' is reset.
4549
4550 *'isprint'* *'isp'*
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02004551'isprint' 'isp' string (default for Win32 and macOS:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004552 "@,~-255"; otherwise: "@,161-255")
4553 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004554 The characters given by this option are displayed directly on the
4555 screen. It is also used for "\p" in a |pattern|. The characters from
4556 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
4557 even when they are not included in 'isprint' or excluded. See
4558 'isfname' for a description of the format of this option.
4559
4560 Non-printable characters are displayed with two characters:
4561 0 - 31 "^@" - "^_"
4562 32 - 126 always single characters
4563 127 "^?"
4564 128 - 159 "~@" - "~_"
4565 160 - 254 "| " - "|~"
4566 255 "~?"
4567 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
4568 displayed as <xx>, with the hexadecimal value of the byte.
4569 When 'display' contains "uhex" all unprintable characters are
4570 displayed as <xx>.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004571 The SpecialKey highlighting will be used for unprintable characters.
4572 |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004573
4574 Multi-byte characters 256 and above are always included, only the
4575 characters up to 255 are specified with this option. When a character
4576 is printable but it is not available in the current font, a
4577 replacement character will be shown.
4578 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
4579 There is no option to specify these characters.
4580
4581 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
4582'joinspaces' 'js' boolean (default on)
4583 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004584 Insert two spaces after a '.', '?' and '!' with a join command.
4585 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
4586 Otherwise only one space is inserted.
4587 NOTE: This option is set when 'compatible' is set.
4588
4589 *'key'*
4590'key' string (default "")
4591 local to buffer
Bram Moolenaar996343d2010-07-04 22:20:21 +02004592 {only available when compiled with the |+cryptv|
4593 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004594 The key that is used for encrypting and decrypting the current buffer.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02004595 See |encryption| and 'cryptmethod'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004596 Careful: Do not set the key value by hand, someone might see the typed
4597 key. Use the |:X| command. But you can make 'key' empty: >
4598 :set key=
4599< It is not possible to get the value of this option with ":set key" or
4600 "echo &key". This is to avoid showing it to someone who shouldn't
4601 know. It also means you cannot see it yourself once you have set it,
4602 be careful not to make a typing error!
Bram Moolenaard58e9292011-02-09 17:07:58 +01004603 You can use "&key" in an expression to detect whether encryption is
4604 enabled. When 'key' is set it returns "*****" (five stars).
Bram Moolenaar071d4272004-06-13 20:20:40 +00004605
4606 *'keymap'* *'kmp'* *E544*
4607'keymap' 'kmp' string (default "")
4608 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004609 {only available when compiled with the |+keymap|
4610 feature}
4611 Name of a keyboard mapping. See |mbyte-keymap|.
4612 Setting this option to a valid keymap name has the side effect of
4613 setting 'iminsert' to one, so that the keymap becomes effective.
4614 'imsearch' is also set to one, unless it was -1
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004615 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004616
4617 *'keymodel'* *'km'*
4618'keymodel' 'km' string (default "")
4619 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004620 List of comma separated words, which enable special things that keys
4621 can do. These values can be used:
4622 startsel Using a shifted special key starts selection (either
4623 Select mode or Visual mode, depending on "key" being
4624 present in 'selectmode').
4625 stopsel Using a not-shifted special key stops selection.
4626 Special keys in this context are the cursor keys, <End>, <Home>,
4627 <PageUp> and <PageDown>.
4628 The 'keymodel' option is set by the |:behave| command.
4629
4630 *'keywordprg'* *'kp'*
4631'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02004632 VMS: "help")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004633 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004634 Program to use for the |K| command. Environment variables are
4635 expanded |:set_env|. ":help" may be used to access the Vim internal
4636 help. (Note that previously setting the global option to the empty
4637 value did this, which is now deprecated.)
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02004638 When the first character is ":", the command is invoked as a Vim
4639 Ex command prefixed with [count].
4640 When "man", "man -s" or an Ex command is used, Vim will automatically
4641 translate a count for the "K" command and pass it as the first
4642 argument. For "man -s" the "-s" is removed when there is no count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004643 See |option-backslash| about including spaces and backslashes.
4644 Example: >
4645 :set keywordprg=man\ -s
4646< This option cannot be set from a |modeline| or in the |sandbox|, for
4647 security reasons.
4648
4649 *'langmap'* *'lmap'* *E357* *E358*
4650'langmap' 'lmap' string (default "")
4651 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004652 {only available when compiled with the |+langmap|
4653 feature}
4654 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004655 mode. When you are typing text in Insert mode the characters are
Bram Moolenaarfa735342016-01-03 22:14:44 +01004656 inserted directly. When in Normal mode the 'langmap' option takes
Bram Moolenaar071d4272004-06-13 20:20:40 +00004657 care of translating these special characters to the original meaning
4658 of the key. This means you don't have to change the keyboard mode to
4659 be able to execute Normal mode commands.
4660 This is the opposite of the 'keymap' option, where characters are
4661 mapped in Insert mode.
Bram Moolenaarb17893a2020-03-14 08:19:51 +01004662 Also consider setting 'langremap' to off, to prevent 'langmap' from
4663 applying to characters resulting from a mapping.
Bram Moolenaare968e362014-05-13 20:23:24 +02004664 This option cannot be set from a |modeline| or in the |sandbox|, for
4665 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004666
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00004667 Example (for Greek, in UTF-8): *greek* >
4668 :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 +00004669< Example (exchanges meaning of z and y for commands): >
4670 :set langmap=zy,yz,ZY,YZ
4671<
4672 The 'langmap' option is a list of parts, separated with commas. Each
4673 part can be in one of two forms:
4674 1. A list of pairs. Each pair is a "from" character immediately
4675 followed by the "to" character. Examples: "aA", "aAbBcC".
4676 2. A list of "from" characters, a semi-colon and a list of "to"
4677 characters. Example: "abc;ABC"
4678 Example: "aA,fgh;FGH,cCdDeE"
4679 Special characters need to be preceded with a backslash. These are
4680 ";", ',' and backslash itself.
4681
4682 This will allow you to activate vim actions without having to switch
4683 back and forth between the languages. Your language characters will
4684 be understood as normal vim English characters (according to the
4685 langmap mappings) in the following cases:
4686 o Normal/Visual mode (commands, buffer/register names, user mappings)
4687 o Insert/Replace Mode: Register names after CTRL-R
4688 o Insert/Replace Mode: Mappings
4689 Characters entered in Command-line mode will NOT be affected by
4690 this option. Note that this option can be changed at any time
4691 allowing to switch between mappings for different languages/encodings.
4692 Use a mapping to avoid having to type it each time!
4693
4694 *'langmenu'* *'lm'*
4695'langmenu' 'lm' string (default "")
4696 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004697 {only available when compiled with the |+menu| and
4698 |+multi_lang| features}
4699 Language to use for menu translation. Tells which file is loaded
4700 from the "lang" directory in 'runtimepath': >
4701 "lang/menu_" . &langmenu . ".vim"
4702< (without the spaces). For example, to always use the Dutch menus, no
4703 matter what $LANG is set to: >
4704 :set langmenu=nl_NL.ISO_8859-1
4705< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004706 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004707 If your $LANG is set to a non-English language but you do want to use
4708 the English menus: >
4709 :set langmenu=none
4710< This option must be set before loading menus, switching on filetype
4711 detection or syntax highlighting. Once the menus are defined setting
4712 this option has no effect. But you could do this: >
4713 :source $VIMRUNTIME/delmenu.vim
4714 :set langmenu=de_DE.ISO_8859-1
4715 :source $VIMRUNTIME/menu.vim
4716< Warning: This deletes all menus that you defined yourself!
4717
Bram Moolenaard94464e2015-11-02 15:28:18 +01004718 *'langnoremap'* *'lnr'* *'nolangnoremap'* *'nolnr'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004719'langnoremap' 'lnr' boolean (default off, set in |defaults.vim|)
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004720 global
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004721 {only available when compiled with the |+langmap|
4722 feature}
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004723 This is just like 'langremap' but with the value inverted. It only
4724 exists for backwards compatibility. When setting 'langremap' then
4725 'langnoremap' is set to the inverted value, and the other way around.
4726
4727 *'langremap'* *'lrm'* *'nolangremap'* *'nolrm'*
Bram Moolenaarb17893a2020-03-14 08:19:51 +01004728'langremap' 'lrm' boolean (default on, set to off in |defaults.vim|)
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004729 global
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004730 {only available when compiled with the |+langmap|
4731 feature}
4732 When off, setting 'langmap' does not apply to characters resulting from
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004733 a mapping. This basically means, if you noticed that setting
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004734 'langmap' disables some of your mappings, try resetting this option.
4735 This option defaults to on for backwards compatibility. Set it off if
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004736 that works for you to avoid mappings to break.
4737
Bram Moolenaar071d4272004-06-13 20:20:40 +00004738 *'laststatus'* *'ls'*
4739'laststatus' 'ls' number (default 1)
4740 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004741 The value of this option influences when the last window will have a
4742 status line:
4743 0: never
4744 1: only if there are at least two windows
4745 2: always
4746 The screen looks nicer with a status line if you have several
4747 windows, but it takes another screen line. |status-line|
4748
4749 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
4750'lazyredraw' 'lz' boolean (default off)
4751 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004752 When this option is set, the screen will not be redrawn while
4753 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004754 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00004755 update use |:redraw|.
4756
4757 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
4758'linebreak' 'lbr' boolean (default off)
4759 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02004760 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004761 feature}
Bram Moolenaar946e27a2014-06-25 18:50:27 +02004762 If on, Vim will wrap long lines at a character in 'breakat' rather
Bram Moolenaar071d4272004-06-13 20:20:40 +00004763 than at the last character that fits on the screen. Unlike
4764 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
Bram Moolenaar946e27a2014-06-25 18:50:27 +02004765 it only affects the way the file is displayed, not its contents.
4766 If 'breakindent' is set, line is visually indented. Then, the value
4767 of 'showbreak' is used to put in front of wrapped lines. This option
Bram Moolenaar86b17e92014-07-02 20:00:47 +02004768 is not used when the 'wrap' option is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004769 Note that <Tab> characters after an <EOL> are mostly not displayed
4770 with the right amount of white space.
4771
4772 *'lines'* *E593*
4773'lines' number (default 24 or terminal height)
4774 global
4775 Number of lines of the Vim window.
4776 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00004777 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004778 When Vim is running in the GUI or in a resizable window, setting this
4779 option will cause the window size to be changed. When you only want
4780 to use the size for the GUI, put the command in your |gvimrc| file.
4781 Vim limits the number of lines to what fits on the screen. You can
4782 use this command to get the tallest window possible: >
4783 :set lines=999
Bram Moolenaarf4d11452005-12-02 00:46:37 +00004784< Minimum value is 2, maximum value is 1000.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02004785 If you get fewer lines than expected, check the 'guiheadroom' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004786 When you set this option and Vim is unable to change the physical
4787 number of lines of the display, the display may be messed up.
4788
4789 *'linespace'* *'lsp'*
4790'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
4791 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004792 {only in the GUI}
4793 Number of pixel lines inserted between characters. Useful if the font
4794 uses the full character cell height, making lines touch each other.
4795 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004796 With some fonts there can be too much room between lines (to have
4797 space for ascents and descents). Then it makes sense to set
4798 'linespace' to a negative value. This may cause display problems
4799 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00004800
4801 *'lisp'* *'nolisp'*
4802'lisp' boolean (default off)
4803 local to buffer
4804 {not available when compiled without the |+lispindent|
4805 feature}
4806 Lisp mode: When <Enter> is typed in insert mode set the indent for
4807 the next line to Lisp standards (well, sort of). Also happens with
4808 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
4809 flag in 'cpoptions' changes the method of indenting: Vi compatible or
4810 better. Also see 'lispwords'.
4811 The '-' character is included in keyword characters. Redefines the
4812 "=" operator to use this same indentation algorithm rather than
4813 calling an external program if 'equalprg' is empty.
4814 This option is not used when 'paste' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004815
4816 *'lispwords'* *'lw'*
4817'lispwords' 'lw' string (default is very long)
Bram Moolenaaraf6c1312014-03-12 18:55:58 +01004818 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004819 {not available when compiled without the |+lispindent|
4820 feature}
4821 Comma separated list of words that influence the Lisp indenting.
4822 |'lisp'|
4823
4824 *'list'* *'nolist'*
4825'list' boolean (default off)
4826 local to window
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004827 List mode: Show tabs as CTRL-I is displayed, display $ after end of
4828 line. Useful to see the difference between tabs and spaces and for
4829 trailing blanks. Further changed by the 'listchars' option.
4830
4831 The cursor is displayed at the start of the space a Tab character
4832 occupies, not at the end as usual in Normal mode. To get this cursor
4833 position while displaying Tabs with spaces, use: >
Bram Moolenaardd007ed2013-07-09 15:44:17 +02004834 :set list lcs=tab:\ \
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004835<
4836 Note that list mode will also affect formatting (set with 'textwidth'
4837 or 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
Bram Moolenaar071d4272004-06-13 20:20:40 +00004838 changing the way tabs are displayed.
4839
4840 *'listchars'* *'lcs'*
4841'listchars' 'lcs' string (default "eol:$")
4842 global
Bram Moolenaarf9d5ca12010-08-01 16:13:51 +02004843 Strings to use in 'list' mode and for the |:list| command. It is a
4844 comma separated list of string settings.
Bram Moolenaar79278362015-04-21 18:33:48 +02004845 *lcs-eol*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004846 eol:c Character to show at the end of each line. When
4847 omitted, there is no extra character at the end of the
4848 line.
Bram Moolenaar79278362015-04-21 18:33:48 +02004849 *lcs-tab*
Bram Moolenaar83a52172019-01-16 22:41:54 +01004850 tab:xy[z] Two or three characters to be used to show a tab.
4851 The third character is optional.
4852
4853 tab:xy The 'x' is always used, then 'y' as many times as will
4854 fit. Thus "tab:>-" displays:
4855 >
4856 >-
4857 >--
4858 etc.
4859
4860 tab:xyz The 'z' is always used, then 'x' is prepended, and
4861 then 'y' is used as many times as will fit. Thus
4862 "tab:<->" displays:
4863 >
4864 <>
4865 <->
4866 <-->
4867 etc.
4868
4869 When "tab:" is omitted, a tab is shown as ^I.
Bram Moolenaar79278362015-04-21 18:33:48 +02004870 *lcs-space*
4871 space:c Character to show for a space. When omitted, spaces
4872 are left blank.
4873 *lcs-trail*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004874 trail:c Character to show for trailing spaces. When omitted,
Bram Moolenaar79278362015-04-21 18:33:48 +02004875 trailing spaces are blank. Overrides the "space"
4876 setting for trailing spaces.
4877 *lcs-extends*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004878 extends:c Character to show in the last column, when 'wrap' is
4879 off and the line continues beyond the right of the
4880 screen.
Bram Moolenaar79278362015-04-21 18:33:48 +02004881 *lcs-precedes*
Bram Moolenaarbffba7f2019-09-20 17:00:17 +02004882 precedes:c Character to show in the first visible column of the
4883 physical line, when there is text preceding the
4884 character visible in the first column.
Bram Moolenaar79278362015-04-21 18:33:48 +02004885 *lcs-conceal*
Bram Moolenaar860cae12010-06-05 23:22:07 +02004886 conceal:c Character to show in place of concealed text, when
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004887 'conceallevel' is set to 1.
Bram Moolenaar79278362015-04-21 18:33:48 +02004888 *lcs-nbsp*
Bram Moolenaar73284b92015-05-04 17:28:22 +02004889 nbsp:c Character to show for a non-breakable space character
4890 (0xA0 (160 decimal) and U+202F). Left blank when
4891 omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004892
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004893 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00004894 be used when 'encoding' is "utf-8", otherwise only printable
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004895 characters are allowed. All characters must be single width.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004896
4897 Examples: >
4898 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004899 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00004900 :set lcs=extends:>,precedes:<
4901< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaar79278362015-04-21 18:33:48 +02004902 "precedes". "SpecialKey" for "nbsp", "space", "tab" and "trail".
Bram Moolenaar02467872007-05-06 13:22:01 +00004903 |hl-NonText| |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004904
4905 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
4906'loadplugins' 'lpl' boolean (default on)
4907 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004908 When on the plugin scripts are loaded when starting up |load-plugins|.
4909 This option can be reset in your |vimrc| file to disable the loading
4910 of plugins.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02004911 Note that using the "-u NONE", "-u DEFAULTS" and "--noplugin" command
4912 line arguments reset this option. See |-u| and |--noplugin|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004913
Bram Moolenaard94464e2015-11-02 15:28:18 +01004914 *'luadll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01004915'luadll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01004916 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01004917 {only available when compiled with the |+lua/dyn|
4918 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01004919 Specifies the name of the Lua shared library. The default is
4920 DYNAMIC_LUA_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02004921 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01004922 This option cannot be set from a |modeline| or in the |sandbox|, for
4923 security reasons.
4924
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00004925 *'macatsui'* *'nomacatsui'*
4926'macatsui' boolean (default on)
4927 global
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02004928 {not supported}
4929 No longer supported, as the Mac OS X GUI code was removed.
Bram Moolenaar02467872007-05-06 13:22:01 +00004930
Bram Moolenaar071d4272004-06-13 20:20:40 +00004931 *'magic'* *'nomagic'*
4932'magic' boolean (default on)
4933 global
4934 Changes the special characters that can be used in search patterns.
4935 See |pattern|.
Bram Moolenaar64d8e252016-09-06 22:12:34 +02004936 WARNING: Switching this option off most likely breaks plugins! That
4937 is because many patterns assume it's on and will fail when it's off.
4938 Only switch it off when working with old Vi scripts. In any other
4939 situation write patterns that work when 'magic' is on. Include "\M"
4940 when you want to |/\M|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004941
4942 *'makeef'* *'mef'*
4943'makeef' 'mef' string (default: "")
4944 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004945 {not available when compiled without the |+quickfix|
4946 feature}
4947 Name of the errorfile for the |:make| command (see |:make_makeprg|)
4948 and the |:grep| command.
4949 When it is empty, an internally generated temp file will be used.
4950 When "##" is included, it is replaced by a number to make the name
4951 unique. This makes sure that the ":make" command doesn't overwrite an
4952 existing file.
4953 NOT used for the ":cf" command. See 'errorfile' for that.
4954 Environment variables are expanded |:set_env|.
4955 See |option-backslash| about including spaces and backslashes.
4956 This option cannot be set from a |modeline| or in the |sandbox|, for
4957 security reasons.
4958
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01004959 *'makeencoding'* *'menc'*
4960'makeencoding' 'menc' string (default "")
4961 global or local to buffer |global-local|
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01004962 Encoding used for reading the output of external commands. When empty,
4963 encoding is not converted.
4964 This is used for `:make`, `:lmake`, `:grep`, `:lgrep`, `:grepadd`,
4965 `:lgrepadd`, `:cfile`, `:cgetfile`, `:caddfile`, `:lfile`, `:lgetfile`,
4966 and `:laddfile`.
4967
4968 This would be mostly useful when you use MS-Windows and set 'encoding'
4969 to "utf-8". If |+iconv| is enabled and GNU libiconv is used, setting
4970 'makeencoding' to "char" has the same effect as setting to the system
4971 locale encoding. Example: >
4972 :set encoding=utf-8
4973 :set makeencoding=char " system locale is used
4974<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004975 *'makeprg'* *'mp'*
4976'makeprg' 'mp' string (default "make", VMS: "MMS")
4977 global or local to buffer |global-local|
Bram Moolenaar02467872007-05-06 13:22:01 +00004978 Program to use for the ":make" command. See |:make_makeprg|.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01004979 This option may contain '%' and '#' characters (see |:_%| and |:_#|),
4980 which are expanded to the current and alternate file name. Use |::S|
Bram Moolenaar26df0922014-02-23 23:39:13 +01004981 to escape file names in case they contain special characters.
Bram Moolenaar02467872007-05-06 13:22:01 +00004982 Environment variables are expanded |:set_env|. See |option-backslash|
4983 about including spaces and backslashes.
4984 Note that a '|' must be escaped twice: once for ":set" and once for
4985 the interpretation of a command. When you use a filter called
4986 "myfilter" do it like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004987 :set makeprg=gmake\ \\\|\ myfilter
4988< The placeholder "$*" can be given (even multiple times) to specify
4989 where the arguments will be included, for example: >
4990 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
4991< This option cannot be set from a |modeline| or in the |sandbox|, for
4992 security reasons.
4993
4994 *'matchpairs'* *'mps'*
4995'matchpairs' 'mps' string (default "(:),{:},[:]")
4996 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004997 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01004998 other.
4999 Only character pairs are allowed that are different, thus you cannot
5000 jump between two double quotes.
5001 The characters must be separated by a colon.
Bram Moolenaar02467872007-05-06 13:22:01 +00005002 The pairs must be separated by a comma. Example for including '<' and
5003 '>' (HTML): >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005004 :set mps+=<:>
5005
5006< A more exotic example, to jump between the '=' and ';' in an
5007 assignment, useful for languages like C and Java: >
5008 :au FileType c,cpp,java set mps+==:;
5009
5010< For a more advanced way of using "%", see the matchit.vim plugin in
Bram Moolenaar01164a62017-11-02 22:58:42 +01005011 the $VIMRUNTIME/pack/dist/opt/matchit directory. |add-local-help|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005012
5013 *'matchtime'* *'mat'*
5014'matchtime' 'mat' number (default 5)
5015 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005016 Tenths of a second to show the matching paren, when 'showmatch' is
5017 set. Note that this is not in milliseconds, like other options that
5018 set a time. This is to be compatible with Nvi.
5019
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005020 *'maxcombine'* *'mco'*
5021'maxcombine' 'mco' number (default 2)
5022 global
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005023 The maximum number of combining characters supported for displaying.
5024 Only used when 'encoding' is "utf-8".
5025 The default is OK for most languages. Hebrew may require 4.
5026 Maximum value is 6.
5027 Even when this option is set to 2 you can still edit text with more
5028 combining characters, you just can't see them. Use |g8| or |ga|.
5029 See |mbyte-combining|.
5030
Bram Moolenaar071d4272004-06-13 20:20:40 +00005031 *'maxfuncdepth'* *'mfd'*
5032'maxfuncdepth' 'mfd' number (default 100)
5033 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02005034 {not available when compiled without the |+eval|
Bram Moolenaar02467872007-05-06 13:22:01 +00005035 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005036 Maximum depth of function calls for user functions. This normally
5037 catches endless recursion. When using a recursive function with
5038 more depth, set 'maxfuncdepth' to a bigger number. But this will use
5039 more memory, there is the danger of failing when memory is exhausted.
Bram Moolenaarbc2eada2017-01-02 21:27:47 +01005040 Increasing this limit above 200 also changes the maximum for Ex
Bram Moolenaar0b0f0992018-05-22 21:41:30 +02005041 command recursion, see |E169|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005042 See also |:function|.
5043
5044 *'maxmapdepth'* *'mmd'* *E223*
5045'maxmapdepth' 'mmd' number (default 1000)
5046 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005047 Maximum number of times a mapping is done without resulting in a
5048 character to be used. This normally catches endless mappings, like
5049 ":map x y" with ":map y x". It still does not catch ":map g wg",
5050 because the 'w' is used before the next mapping is done. See also
5051 |key-mapping|.
5052
5053 *'maxmem'* *'mm'*
5054'maxmem' 'mm' number (default between 256 to 5120 (system
5055 dependent) or half the amount of memory
5056 available)
5057 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005058 Maximum amount of memory (in Kbyte) to use for one buffer. When this
5059 limit is reached allocating extra memory for a buffer will cause
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005060 other memory to be freed.
5061 The maximum usable value is about 2000000. Use this to work without a
5062 limit.
5063 The value is ignored when 'swapfile' is off.
5064 Also see 'maxmemtot'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005065
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005066 *'maxmempattern'* *'mmp'*
5067'maxmempattern' 'mmp' number (default 1000)
5068 global
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005069 Maximum amount of memory (in Kbyte) to use for pattern matching.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005070 The maximum value is about 2000000. Use this to work without a limit.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005071 *E363*
Bram Moolenaar02467872007-05-06 13:22:01 +00005072 When Vim runs into the limit it gives an error message and mostly
5073 behaves like CTRL-C was typed.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005074 Running into the limit often means that the pattern is very
5075 inefficient or too complex. This may already happen with the pattern
5076 "\(.\)*" on a very long line. ".*" works much better.
Bram Moolenaarfd358112018-07-07 23:21:31 +02005077 Might also happen on redraw, when syntax rules try to match a complex
5078 text structure.
5079 Vim may run out of memory before hitting the 'maxmempattern' limit, in
5080 which case you get an "Out of memory" error instead.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005081
Bram Moolenaar071d4272004-06-13 20:20:40 +00005082 *'maxmemtot'* *'mmt'*
5083'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
5084 dependent) or half the amount of memory
5085 available)
5086 global
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005087 Maximum amount of memory in Kbyte to use for all buffers together.
5088 The maximum usable value is about 2000000 (2 Gbyte). Use this to work
Bram Moolenaarfa735342016-01-03 22:14:44 +01005089 without a limit.
5090 On 64 bit machines higher values might work. But hey, do you really
5091 need more than 2 Gbyte for text editing? Keep in mind that text is
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005092 stored in the swap file, one can edit files > 2 Gbyte anyway. We do
Bram Moolenaarfa735342016-01-03 22:14:44 +01005093 need the memory to store undo info.
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005094 Buffers with 'swapfile' off still count to the total amount of memory
5095 used.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005096 Also see 'maxmem'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005097
5098 *'menuitems'* *'mis'*
5099'menuitems' 'mis' number (default 25)
5100 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005101 {not available when compiled without the |+menu|
5102 feature}
5103 Maximum number of items to use in a menu. Used for menus that are
5104 generated from a list of items, e.g., the Buffers menu. Changing this
5105 option has no direct effect, the menu must be refreshed first.
5106
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005107 *'mkspellmem'* *'msm'*
5108'mkspellmem' 'msm' string (default "460000,2000,500")
5109 global
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005110 {not available when compiled without the |+syntax|
5111 feature}
5112 Parameters for |:mkspell|. This tunes when to start compressing the
5113 word tree. Compression can be slow when there are many words, but
5114 it's needed to avoid running out of memory. The amount of memory used
5115 per word depends very much on how similar the words are, that's why
5116 this tuning is complicated.
5117
5118 There are three numbers, separated by commas:
5119 {start},{inc},{added}
5120
5121 For most languages the uncompressed word tree fits in memory. {start}
5122 gives the amount of memory in Kbyte that can be used before any
5123 compression is done. It should be a bit smaller than the amount of
5124 memory that is available to Vim.
5125
5126 When going over the {start} limit the {inc} number specifies the
5127 amount of memory in Kbyte that can be allocated before another
5128 compression is done. A low number means compression is done after
5129 less words are added, which is slow. A high number means more memory
5130 will be allocated.
5131
5132 After doing compression, {added} times 1024 words can be added before
5133 the {inc} limit is ignored and compression is done when any extra
5134 amount of memory is needed. A low number means there is a smaller
5135 chance of hitting the {inc} limit, less memory is used but it's
5136 slower.
5137
5138 The languages for which these numbers are important are Italian and
5139 Hungarian. The default works for when you have about 512 Mbyte. If
5140 you have 1 Gbyte you could use: >
5141 :set mkspellmem=900000,3000,800
5142< If you have less than 512 Mbyte |:mkspell| may fail for some
5143 languages, no matter what you set 'mkspellmem' to.
5144
Bram Moolenaar07607392019-05-26 19:20:43 +02005145 This option cannot be set from a |modeline| or in the |sandbox|.
5146
Bram Moolenaar071d4272004-06-13 20:20:40 +00005147 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
Bram Moolenaar8243a792007-05-01 17:05:03 +00005148'modeline' 'ml' boolean (Vim default: on (off for root),
5149 Vi default: off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005150 local to buffer
Bram Moolenaar110289e2019-05-23 15:38:06 +02005151 If 'modeline' is on 'modelines' gives the number of lines that is
5152 checked for set commands. If 'modeline' is off or 'modelines' is zero
5153 no lines are checked. See |modeline|.
5154
5155 *'modelineexpr'* *'mle'* *'nomodelineexpr'* *'nomle'*
5156'modelineexpr' 'mle' boolean (default: off)
5157 global
5158 When on allow some options that are an expression to be set in the
5159 modeline. Check the option for whether it is affected by
5160 'modelineexpr'. Also see |modeline|.
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02005161 This option cannot be set from a |modeline| or in the |sandbox|, for
5162 security reasons.
Bram Moolenaar110289e2019-05-23 15:38:06 +02005163
Bram Moolenaar071d4272004-06-13 20:20:40 +00005164 *'modelines'* *'mls'*
5165'modelines' 'mls' number (default 5)
5166 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005167 If 'modeline' is on 'modelines' gives the number of lines that is
5168 checked for set commands. If 'modeline' is off or 'modelines' is zero
5169 no lines are checked. See |modeline|.
5170 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
5171 set and to the Vim default value when 'compatible' is reset.
5172
5173 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
Bram Moolenaar110289e2019-05-23 15:38:06 +02005174 *E21*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005175'modifiable' 'ma' boolean (default on)
5176 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005177 When off the buffer contents cannot be changed. The 'fileformat' and
5178 'fileencoding' options also can't be changed.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01005179 Can be reset on startup with the |-M| command line argument.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005180
5181 *'modified'* *'mod'* *'nomodified'* *'nomod'*
5182'modified' 'mod' boolean (default off)
5183 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005184 When on, the buffer is considered to be modified. This option is set
5185 when:
5186 1. A change was made to the text since it was last written. Using the
5187 |undo| command to go back to the original text will reset the
5188 option. But undoing changes that were made before writing the
5189 buffer will set the option again, since the text is different from
5190 when it was written.
5191 2. 'fileformat' or 'fileencoding' is different from its original
5192 value. The original value is set when the buffer is read or
5193 written. A ":set nomodified" command also resets the original
5194 values to the current values and the 'modified' option will be
5195 reset.
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01005196 Similarly for 'eol' and 'bomb'.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02005197 This option is not set when a change is made to the buffer as the
5198 result of a BufNewFile, BufRead/BufReadPost, BufWritePost,
5199 FileAppendPost or VimLeave autocommand event. See |gzip-example| for
5200 an explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005201 When 'buftype' is "nowrite" or "nofile" this option may be set, but
5202 will be ignored.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01005203 Note that the text may actually be the same, e.g. 'modified' is set
5204 when using "rA" on an "A".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005205
5206 *'more'* *'nomore'*
5207'more' boolean (Vim default: on, Vi default: off)
5208 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005209 When on, listings pause when the whole screen is filled. You will get
5210 the |more-prompt|. When this option is off there are no pauses, the
5211 listing continues until finished.
5212 NOTE: This option is set to the Vi default value when 'compatible' is
5213 set and to the Vim default value when 'compatible' is reset.
5214
5215 *'mouse'* *E538*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005216'mouse' string (default "", "a" for GUI and Win32,
Bram Moolenaar5b418992019-10-27 18:50:25 +01005217 set to "a" or "nvi" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005218 global
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005219 Enable the use of the mouse. Works for most terminals (xterm, Win32
5220 |win32-mouse|, QNX pterm, *BSD console with sysmouse and Linux console
5221 with gpm). For using the mouse in the GUI, see |gui-mouse|. The
5222 mouse can be enabled for different modes:
Bram Moolenaar7f2e9d72017-11-11 20:58:53 +01005223 n Normal mode and Terminal modes
Bram Moolenaar071d4272004-06-13 20:20:40 +00005224 v Visual mode
5225 i Insert mode
5226 c Command-line mode
5227 h all previous modes when editing a help file
5228 a all previous modes
5229 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005230 Normally you would enable the mouse in all five modes with: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005231 :set mouse=a
Bram Moolenaar5b418992019-10-27 18:50:25 +01005232< If your terminal can't overrule the mouse events going to the
5233 application, use: >
5234 :set mouse=nvi
Bram Moolenaar65e0d772020-06-14 17:29:55 +02005235< Then you can press ":", select text for the system, and press Esc to go
Bram Moolenaar5b418992019-10-27 18:50:25 +01005236 back to Vim using the mouse events.
5237 In |defaults.vim| "nvi" is used if the 'term' option is not matching
5238 "xterm".
5239
5240 When the mouse is not enabled, the GUI will still use the mouse for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005241 modeless selection. This doesn't move the text cursor.
5242
5243 See |mouse-using|. Also see |'clipboard'|.
5244
5245 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005246 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005247 the mouse buttons can still be used by keeping the shift key pressed.
5248 Also see the 'clipboard' option.
5249
5250 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
5251'mousefocus' 'mousef' boolean (default off)
5252 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005253 {only works in the GUI}
5254 The window that the mouse pointer is on is automatically activated.
5255 When changing the window layout or window focus in another way, the
5256 mouse pointer is moved to the window with keyboard focus. Off is the
5257 default because it makes using the pull down menus a little goofy, as
5258 a pointer transit may activate a window unintentionally.
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01005259 MS-Windows: Also see 'scrollfocus' for what window is scrolled when
Bram Moolenaar1d9215b2020-01-25 13:27:42 +01005260 using the mouse scroll wheel.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005261
5262 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
5263'mousehide' 'mh' boolean (default on)
5264 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005265 {only works in the GUI}
5266 When on, the mouse pointer is hidden when characters are typed.
5267 The mouse pointer is restored when the mouse is moved.
5268
5269 *'mousemodel'* *'mousem'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005270'mousemodel' 'mousem' string (default "extend", "popup" for Win32)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005271 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005272 Sets the model to use for the mouse. The name mostly specifies what
5273 the right mouse button is used for:
5274 extend Right mouse button extends a selection. This works
5275 like in an xterm.
5276 popup Right mouse button pops up a menu. The shifted left
5277 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00005278 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005279 popup_setpos Like "popup", but the cursor will be moved to the
5280 position where the mouse was clicked, and thus the
5281 selected operation will act upon the clicked object.
5282 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00005283 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005284 course, that right clicking outside a selection will
5285 end Visual mode.
5286 Overview of what button does what for each model:
5287 mouse extend popup(_setpos) ~
5288 left click place cursor place cursor
5289 left drag start selection start selection
5290 shift-left search word extend selection
5291 right click extend selection popup menu (place cursor)
5292 right drag extend selection -
5293 middle click paste paste
5294
5295 In the "popup" model the right mouse button produces a pop-up menu.
5296 You need to define this first, see |popup-menu|.
5297
5298 Note that you can further refine the meaning of buttons with mappings.
5299 See |gui-mouse-mapping|. But mappings are NOT used for modeless
5300 selection (because that's handled in the GUI code directly).
5301
5302 The 'mousemodel' option is set by the |:behave| command.
5303
5304 *'mouseshape'* *'mouses'* *E547*
Bram Moolenaarf6b40102019-02-22 15:24:03 +01005305'mouseshape' 'mouses' string (default "i-r:beam,s:updown,sd:udsizing,
5306 vs:leftright,vd:lrsizing,m:no,
5307 ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005308 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005309 {only available when compiled with the |+mouseshape|
5310 feature}
5311 This option tells Vim what the mouse pointer should look like in
5312 different modes. The option is a comma separated list of parts, much
5313 like used for 'guicursor'. Each part consist of a mode/location-list
5314 and an argument-list:
5315 mode-list:shape,mode-list:shape,..
5316 The mode-list is a dash separated list of these modes/locations:
5317 In a normal window: ~
5318 n Normal mode
5319 v Visual mode
5320 ve Visual mode with 'selection' "exclusive" (same as 'v',
5321 if not specified)
5322 o Operator-pending mode
5323 i Insert mode
5324 r Replace mode
5325
5326 Others: ~
5327 c appending to the command-line
5328 ci inserting in the command-line
5329 cr replacing in the command-line
5330 m at the 'Hit ENTER' or 'More' prompts
5331 ml idem, but cursor in the last line
5332 e any mode, pointer below last window
5333 s any mode, pointer on a status line
5334 sd any mode, while dragging a status line
5335 vs any mode, pointer on a vertical separator line
5336 vd any mode, while dragging a vertical separator line
5337 a everywhere
5338
5339 The shape is one of the following:
5340 avail name looks like ~
5341 w x arrow Normal mouse pointer
5342 w x blank no pointer at all (use with care!)
5343 w x beam I-beam
5344 w x updown up-down sizing arrows
5345 w x leftright left-right sizing arrows
5346 w x busy The system's usual busy pointer
5347 w x no The system's usual 'no input' pointer
5348 x udsizing indicates up-down resizing
5349 x lrsizing indicates left-right resizing
5350 x crosshair like a big thin +
5351 x hand1 black hand
5352 x hand2 white hand
5353 x pencil what you write with
5354 x question big ?
5355 x rightup-arrow arrow pointing right-up
5356 w x up-arrow arrow pointing up
5357 x <number> any X11 pointer number (see X11/cursorfont.h)
5358
5359 The "avail" column contains a 'w' if the shape is available for Win32,
5360 x for X11.
5361 Any modes not specified or shapes not available use the normal mouse
5362 pointer.
5363
5364 Example: >
5365 :set mouseshape=s:udsizing,m:no
5366< will make the mouse turn to a sizing arrow over the status lines and
5367 indicate no input when the hit-enter prompt is displayed (since
5368 clicking the mouse has no effect in this state.)
5369
5370 *'mousetime'* *'mouset'*
5371'mousetime' 'mouset' number (default 500)
5372 global
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005373 Only for GUI, Win32 and Unix with xterm. Defines the maximum
Bram Moolenaar071d4272004-06-13 20:20:40 +00005374 time in msec between two mouse clicks for the second click to be
5375 recognized as a multi click.
5376
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005377 *'mzschemedll'*
5378'mzschemedll' string (default depends on the build)
5379 global
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005380 {only available when compiled with the |+mzscheme/dyn|
5381 feature}
5382 Specifies the name of the MzScheme shared library. The default is
5383 DYNAMIC_MZSCH_DLL which was specified at compile time.
5384 Environment variables are expanded |:set_env|.
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01005385 The value must be set in the |vimrc| script or earlier. In the
Bram Moolenaar01164a62017-11-02 22:58:42 +01005386 startup, before the |load-plugins| step.
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005387 This option cannot be set from a |modeline| or in the |sandbox|, for
5388 security reasons.
5389
5390 *'mzschemegcdll'*
5391'mzschemegcdll' string (default depends on the build)
5392 global
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005393 {only available when compiled with the |+mzscheme/dyn|
5394 feature}
5395 Specifies the name of the MzScheme GC shared library. The default is
5396 DYNAMIC_MZGC_DLL which was specified at compile time.
5397 The value can be equal to 'mzschemedll' if it includes the GC code.
5398 Environment variables are expanded |:set_env|.
5399 This option cannot be set from a |modeline| or in the |sandbox|, for
5400 security reasons.
5401
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005402 *'mzquantum'* *'mzq'*
5403'mzquantum' 'mzq' number (default 100)
5404 global
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005405 {not available when compiled without the |+mzscheme|
5406 feature}
5407 The number of milliseconds between polls for MzScheme threads.
5408 Negative or zero value means no thread scheduling.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005409 NOTE: This option is set to the Vim default value when 'compatible'
5410 is reset.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005411
Bram Moolenaar071d4272004-06-13 20:20:40 +00005412 *'nrformats'* *'nf'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02005413'nrformats' 'nf' string (default "bin,octal,hex",
5414 set to "bin,hex" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005415 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005416 This defines what bases Vim will consider for numbers when using the
5417 CTRL-A and CTRL-X commands for adding to and subtracting from a number
5418 respectively; see |CTRL-A| for more info on these commands.
Bram Moolenaar4770d092006-01-12 23:22:24 +00005419 alpha If included, single alphabetical characters will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005420 incremented or decremented. This is useful for a list with a
Bram Moolenaar3848e002016-03-19 18:42:29 +01005421 letter index a), b), etc. *octal-nrformats*
Bram Moolenaar4770d092006-01-12 23:22:24 +00005422 octal If included, numbers that start with a zero will be considered
Bram Moolenaar071d4272004-06-13 20:20:40 +00005423 to be octal. Example: Using CTRL-A on "007" results in "010".
Bram Moolenaar4770d092006-01-12 23:22:24 +00005424 hex If included, numbers starting with "0x" or "0X" will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005425 considered to be hexadecimal. Example: Using CTRL-X on
5426 "0x100" results in "0x0ff".
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005427 bin If included, numbers starting with "0b" or "0B" will be
5428 considered to be binary. Example: Using CTRL-X on
5429 "0b1000" subtracts one, resulting in "0b0111".
Bram Moolenaaraaad9952020-05-31 15:08:59 +02005430 unsigned If included, numbers are recognized as unsigned. Thus a
5431 leading dash or negative sign won't be considered as part of
5432 the number. Examples:
5433 Using CTRL-X on "2020" in "9-2020" results in "9-2019"
5434 (without "unsigned" it would become "9-2021").
5435 Using CTRL-A on "2020" in "9-2020" results in "9-2021"
5436 (without "unsigned" it would become "9-2019").
Bram Moolenaaracc22402020-06-07 21:07:18 +02005437 Using CTRL-X on "0" or CTRL-A on "18446744073709551615"
5438 (2^64 - 1) has no effect, overflow is prevented.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005439 Numbers which simply begin with a digit in the range 1-9 are always
5440 considered decimal. This also happens for numbers that are not
5441 recognized as octal or hex.
5442
5443 *'number'* *'nu'* *'nonumber'* *'nonu'*
5444'number' 'nu' boolean (default off)
5445 local to window
5446 Print the line number in front of each line. When the 'n' option is
5447 excluded from 'cpoptions' a wrapped line will not use the column of
5448 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005449 The 'numberwidth' option can be used to set the room used for the line
5450 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005451 When a long, wrapped line doesn't start with the first character, '-'
5452 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02005453 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
5454 the number.
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005455 *number_relativenumber*
5456 The 'relativenumber' option changes the displayed number to be
5457 relative to the cursor. Together with 'number' there are these
5458 four combinations (cursor in line 3):
5459
Bram Moolenaar3848e002016-03-19 18:42:29 +01005460 'nonu' 'nu' 'nonu' 'nu'
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005461 'nornu' 'nornu' 'rnu' 'rnu'
5462
5463 |apple | 1 apple | 2 apple | 2 apple
5464 |pear | 2 pear | 1 pear | 1 pear
5465 |nobody | 3 nobody | 0 nobody |3 nobody
5466 |there | 4 there | 1 there | 1 there
Bram Moolenaar071d4272004-06-13 20:20:40 +00005467
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005468 *'numberwidth'* *'nuw'*
5469'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
5470 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005471 {only available when compiled with the |+linebreak|
5472 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005473 Minimal number of columns to use for the line number. Only relevant
Bram Moolenaar64486672010-05-16 15:46:46 +02005474 when the 'number' or 'relativenumber' option is set or printing lines
5475 with a line number. Since one space is always between the number and
5476 the text, there is one less character for the number itself.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005477 The value is the minimum width. A bigger width is used when needed to
Bram Moolenaar64486672010-05-16 15:46:46 +02005478 fit the highest line number in the buffer respectively the number of
5479 rows in the window, depending on whether 'number' or 'relativenumber'
5480 is set. Thus with the Vim default of 4 there is room for a line number
5481 up to 999. When the buffer has 1000 lines five columns will be used.
Bram Moolenaarf8a07122019-07-01 22:06:07 +02005482 The minimum value is 1, the maximum value is 20.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005483 NOTE: This option is set to the Vi default value when 'compatible' is
5484 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005485
Bram Moolenaarf75a9632005-09-13 21:20:47 +00005486 *'omnifunc'* *'ofu'*
5487'omnifunc' 'ofu' string (default: empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00005488 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02005489 {not available when compiled without the |+eval|
Bram Moolenaare2c453d2019-08-21 14:37:09 +02005490 feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00005491 This option specifies a function to be used for Insert mode omni
5492 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
Bram Moolenaar280f1262006-01-30 00:14:18 +00005493 See |complete-functions| for an explanation of how the function is
5494 invoked and what it should return.
Bram Moolenaar043545e2006-10-10 16:44:07 +00005495 This option is usually set by a filetype plugin:
Bram Moolenaar9c102382006-05-03 21:26:49 +00005496 |:filetype-plugin-on|
Bram Moolenaar30b65812012-07-12 22:01:11 +02005497 This option cannot be set from a |modeline| or in the |sandbox|, for
5498 security reasons.
Bram Moolenaare344bea2005-09-01 20:46:49 +00005499
5500
Bram Moolenaar02467872007-05-06 13:22:01 +00005501 *'opendevice'* *'odev'* *'noopendevice'* *'noodev'*
Bram Moolenaar043545e2006-10-10 16:44:07 +00005502'opendevice' 'odev' boolean (default off)
5503 global
Bram Moolenaar6f345a12019-12-17 21:27:18 +01005504 {only for MS-Windows}
Bram Moolenaar043545e2006-10-10 16:44:07 +00005505 Enable reading and writing from devices. This may get Vim stuck on a
5506 device that can be opened but doesn't actually do the I/O. Therefore
5507 it is off by default.
5508 Note that on MS-Windows editing "aux.h", "lpt1.txt" and the like also
5509 result in editing a device.
5510
5511
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005512 *'operatorfunc'* *'opfunc'*
5513'operatorfunc' 'opfunc' string (default: empty)
5514 global
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005515 This option specifies a function to be called by the |g@| operator.
5516 See |:map-operator| for more info and an example.
5517
5518 This option cannot be set from a |modeline| or in the |sandbox|, for
5519 security reasons.
5520
5521
Bram Moolenaar251e1912011-06-19 05:09:16 +02005522 *'osfiletype'* *'oft'*
5523'osfiletype' 'oft' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005524 local to buffer
Bram Moolenaar251e1912011-06-19 05:09:16 +02005525 This option was supported on RISC OS, which has been removed.
5526
Bram Moolenaar071d4272004-06-13 20:20:40 +00005527
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005528 *'packpath'* *'pp'*
5529'packpath' 'pp' string (default: see 'runtimepath')
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005530 Directories used to find packages. See |packages|.
5531
5532
Bram Moolenaar071d4272004-06-13 20:20:40 +00005533 *'paragraphs'* *'para'*
Bram Moolenaar57e48462008-03-12 16:38:55 +00005534'paragraphs' 'para' string (default "IPLPPPQPP TPHPLIPpLpItpplpipbp")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005535 global
5536 Specifies the nroff macros that separate paragraphs. These are pairs
5537 of two letters (see |object-motions|).
5538
5539 *'paste'* *'nopaste'*
5540'paste' boolean (default off)
5541 global
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005542 Put Vim in Paste mode. This is useful if you want to cut or copy
5543 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005544 unexpected effects.
5545 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005546 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00005547 knows about pasting and will mostly do the right thing without 'paste'
5548 being set. The same is true for a terminal where Vim handles the
5549 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00005550 This option is reset when starting the GUI. Thus if you set it in
5551 your .vimrc it will work in a terminal, but not in the GUI. Setting
5552 'paste' in the GUI has side effects: e.g., the Paste toolbar button
5553 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005554 When the 'paste' option is switched on (also when it was already on):
5555 - mapping in Insert mode and Command-line mode is disabled
5556 - abbreviations are disabled
Bram Moolenaar071d4272004-06-13 20:20:40 +00005557 - 'autoindent' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02005558 - 'expandtab' is reset
5559 - 'formatoptions' is used like it is empty
Bram Moolenaar071d4272004-06-13 20:20:40 +00005560 - 'revins' is reset
5561 - 'ruler' is reset
5562 - 'showmatch' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02005563 - 'smartindent' is reset
5564 - 'smarttab' is reset
5565 - 'softtabstop' is set to 0
5566 - 'textwidth' is set to 0
5567 - 'wrapmargin' is set to 0
Bram Moolenaar071d4272004-06-13 20:20:40 +00005568 These options keep their value, but their effect is disabled:
Bram Moolenaar071d4272004-06-13 20:20:40 +00005569 - 'cindent'
Bram Moolenaarca635012015-09-25 20:34:21 +02005570 - 'indentexpr'
5571 - 'lisp'
Bram Moolenaar071d4272004-06-13 20:20:40 +00005572 NOTE: When you start editing another file while the 'paste' option is
5573 on, settings from the modelines or autocommands may change the
5574 settings again, causing trouble when pasting text. You might want to
5575 set the 'paste' option again.
5576 When the 'paste' option is reset the mentioned options are restored to
5577 the value before the moment 'paste' was switched from off to on.
5578 Resetting 'paste' before ever setting it does not have any effect.
5579 Since mapping doesn't work while 'paste' is active, you need to use
5580 the 'pastetoggle' option to toggle the 'paste' option with some key.
5581
5582 *'pastetoggle'* *'pt'*
5583'pastetoggle' 'pt' string (default "")
5584 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005585 When non-empty, specifies the key sequence that toggles the 'paste'
5586 option. This is like specifying a mapping: >
5587 :map {keys} :set invpaste<CR>
5588< Where {keys} is the value of 'pastetoggle'.
5589 The difference is that it will work even when 'paste' is set.
5590 'pastetoggle' works in Insert mode and Normal mode, but not in
5591 Command-line mode.
5592 Mappings are checked first, thus overrule 'pastetoggle'. However,
5593 when 'paste' is on mappings are ignored in Insert mode, thus you can do
5594 this: >
5595 :map <F10> :set paste<CR>
5596 :map <F11> :set nopaste<CR>
5597 :imap <F10> <C-O>:set paste<CR>
5598 :imap <F11> <nop>
5599 :set pastetoggle=<F11>
5600< This will make <F10> start paste mode and <F11> stop paste mode.
5601 Note that typing <F10> in paste mode inserts "<F10>", since in paste
5602 mode everything is inserted literally, except the 'pastetoggle' key
5603 sequence.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005604 When the value has several bytes 'ttimeoutlen' applies.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005605
5606 *'pex'* *'patchexpr'*
5607'patchexpr' 'pex' string (default "")
5608 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005609 {not available when compiled without the |+diff|
5610 feature}
5611 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005612 the resulting new version of the file. See |diff-patchexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005613
Bram Moolenaardbc28022014-07-26 13:40:44 +02005614 *'patchmode'* *'pm'* *E205* *E206*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005615'patchmode' 'pm' string (default "")
5616 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005617 When non-empty the oldest version of a file is kept. This can be used
5618 to keep the original version of a file if you are changing files in a
5619 source distribution. Only the first time that a file is written a
5620 copy of the original file will be kept. The name of the copy is the
5621 name of the original file with the string in the 'patchmode' option
5622 appended. This option should start with a dot. Use a string like
Bram Moolenaardf980db2017-12-24 13:22:00 +01005623 ".orig" or ".org". 'backupdir' must not be empty for this to work
5624 (Detail: The backup file is renamed to the patchmode file after the
5625 new file has been successfully written, that's why it must be possible
5626 to write a backup file). If there was no file to be backed up, an
5627 empty file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005628 When the 'backupskip' pattern matches, a patchmode file is not made.
5629 Using 'patchmode' for compressed files appends the extension at the
5630 end (e.g., "file.gz.orig"), thus the resulting name isn't always
5631 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005632 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005633
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01005634 *'path'* *'pa'* *E343* *E345* *E347* *E854*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005635'path' 'pa' string (default on Unix: ".,/usr/include,,"
Bram Moolenaar071d4272004-06-13 20:20:40 +00005636 other systems: ".,,")
5637 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005638 This is a list of directories which will be searched when using the
Bram Moolenaarc236c162008-07-13 17:41:49 +00005639 |gf|, [f, ]f, ^Wf, |:find|, |:sfind|, |:tabfind| and other commands,
5640 provided that the file being searched for has a relative path (not
5641 starting with "/", "./" or "../"). The directories in the 'path'
5642 option may be relative or absolute.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005643 - Use commas to separate directory names: >
5644 :set path=.,/usr/local/include,/usr/include
5645< - Spaces can also be used to separate directory names (for backwards
5646 compatibility with version 3.0). To have a space in a directory
5647 name, precede it with an extra backslash, and escape the space: >
5648 :set path=.,/dir/with\\\ space
5649< - To include a comma in a directory name precede it with an extra
5650 backslash: >
5651 :set path=.,/dir/with\\,comma
5652< - To search relative to the directory of the current file, use: >
5653 :set path=.
5654< - To search in the current directory use an empty string between two
5655 commas: >
5656 :set path=,,
5657< - A directory name may end in a ':' or '/'.
5658 - Environment variables are expanded |:set_env|.
5659 - When using |netrw.vim| URLs can be used. For example, adding
5660 "http://www.vim.org" will make ":find index.html" work.
Bram Moolenaarc236c162008-07-13 17:41:49 +00005661 - Search upwards and downwards in a directory tree using "*", "**" and
5662 ";". See |file-searching| for info and syntax.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005663 {not available when compiled without the |+path_extra| feature}
5664 - Careful with '\' characters, type two to get one in the option: >
5665 :set path=.,c:\\include
5666< Or just use '/' instead: >
5667 :set path=.,c:/include
5668< Don't forget "." or files won't even be found in the same directory as
5669 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005670 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00005671 it is something like 256 or 1024 characters.
5672 You can check if all the include files are found, using the value of
5673 'path', see |:checkpath|.
5674 The use of |:set+=| and |:set-=| is preferred when adding or removing
5675 directories from the list. This avoids problems when a future version
5676 uses another default. To remove the current directory use: >
5677 :set path-=
5678< To add the current directory use: >
5679 :set path+=
5680< To use an environment variable, you probably need to replace the
5681 separator. Here is an example to append $INCL, in which directory
5682 names are separated with a semi-colon: >
5683 :let &path = &path . "," . substitute($INCL, ';', ',', 'g')
5684< Replace the ';' with a ':' or whatever separator is used. Note that
5685 this doesn't work when $INCL contains a comma or white space.
5686
Bram Moolenaar37c64c72017-09-19 22:06:03 +02005687 *'perldll'*
5688'perldll' string (default depends on the build)
5689 global
Bram Moolenaar37c64c72017-09-19 22:06:03 +02005690 {only available when compiled with the |+perl/dyn|
5691 feature}
5692 Specifies the name of the Perl shared library. The default is
5693 DYNAMIC_PERL_DLL, which was specified at compile time.
5694 Environment variables are expanded |:set_env|.
5695 This option cannot be set from a |modeline| or in the |sandbox|, for
5696 security reasons.
5697
Bram Moolenaar071d4272004-06-13 20:20:40 +00005698 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
5699'preserveindent' 'pi' boolean (default off)
5700 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005701 When changing the indent of the current line, preserve as much of the
5702 indent structure as possible. Normally the indent is replaced by a
5703 series of tabs followed by spaces as required (unless |'expandtab'| is
5704 enabled, in which case only spaces are used). Enabling this option
5705 means the indent will preserve as many existing characters as possible
5706 for indenting, and only add additional tabs or spaces as required.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005707 'expandtab' does not apply to the preserved white space, a Tab remains
5708 a Tab.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005709 NOTE: When using ">>" multiple times the resulting indent is a mix of
5710 tabs and spaces. You might not like this.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005711 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005712 Also see 'copyindent'.
5713 Use |:retab| to clean up white space.
5714
5715 *'previewheight'* *'pvh'*
5716'previewheight' 'pvh' number (default 12)
5717 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02005718 {not available when compiled without the |+quickfix|
5719 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005720 Default height for a preview window. Used for |:ptag| and associated
Bram Moolenaar79648732019-07-18 21:43:07 +02005721 commands. Used for |CTRL-W_}| when no count is given. Not used when
5722 'previewpopup' is set.
5723
5724 *'previewpopup'* *'pvp'*
5725'previewpopup' 'pvp' string (default empty)
5726 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02005727 {not available when compiled without the |+textprop|
5728 or |+quickfix| feature}
Bram Moolenaar79648732019-07-18 21:43:07 +02005729 When not empty a popup window is used for commands that would open a
5730 preview window. See |preview-popup|.
Bram Moolenaar576a4a62019-08-18 15:25:17 +02005731 Not used for the insert completion info, add "popup" to
5732 'completeopt' for that.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005733
5734 *'previewwindow'* *'nopreviewwindow'*
5735 *'pvw'* *'nopvw'* *E590*
5736'previewwindow' 'pvw' boolean (default off)
5737 local to window
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02005738 {not available when compiled without the |+quickfix|
5739 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005740 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00005741 set. It's normally not set directly, but by using one of the commands
5742 |:ptag|, |:pedit|, etc.
5743
5744 *'printdevice'* *'pdev'*
5745'printdevice' 'pdev' string (default empty)
5746 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005747 {only available when compiled with the |+printer|
5748 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005749 The name of the printer to be used for |:hardcopy|.
5750 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005751 This option cannot be set from a |modeline| or in the |sandbox|, for
5752 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005753
Bram Moolenaar8299df92004-07-10 09:47:34 +00005754 *'printencoding'* *'penc'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005755'printencoding' 'penc' string (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005756 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005757 {only available when compiled with the |+printer|
5758 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005759 Sets the character encoding used when printing.
5760 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005761
5762 *'printexpr'* *'pexpr'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005763'printexpr' 'pexpr' string (default: see below)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005764 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005765 {only available when compiled with the |+printer|
5766 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005767 Expression used to print the PostScript produced with |:hardcopy|.
5768 See |pexpr-option|.
Bram Moolenaar51628222016-12-01 23:03:28 +01005769 This option cannot be set from a |modeline| or in the |sandbox|, for
5770 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005771
Bram Moolenaar8299df92004-07-10 09:47:34 +00005772 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005773'printfont' 'pfn' string (default "courier")
5774 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005775 {only available when compiled with the |+printer|
5776 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005777 The name of the font that will be used for |:hardcopy|.
5778 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005779
5780 *'printheader'* *'pheader'*
5781'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
5782 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005783 {only available when compiled with the |+printer|
5784 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005785 The format of the header produced in |:hardcopy| output.
5786 See |pheader-option|.
5787
5788 *'printmbcharset'* *'pmbcs'*
5789'printmbcharset' 'pmbcs' string (default "")
5790 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01005791 {only available when compiled with the |+printer|
5792 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005793 The CJK character set to be used for CJK output from |:hardcopy|.
5794 See |pmbcs-option|.
5795
5796 *'printmbfont'* *'pmbfn'*
5797'printmbfont' 'pmbfn' string (default "")
5798 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01005799 {only available when compiled with the |+printer|
5800 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005801 List of font names to be used for CJK output from |:hardcopy|.
5802 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005803
5804 *'printoptions'* *'popt'*
5805'printoptions' 'popt' string (default "")
5806 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005807 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005808 List of items that control the format of the output of |:hardcopy|.
5809 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005810
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005811 *'prompt'* *'noprompt'*
5812'prompt' boolean (default on)
5813 global
5814 When on a ":" prompt is used in Ex mode.
5815
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005816 *'pumheight'* *'ph'*
5817'pumheight' 'ph' number (default 0)
5818 global
Bram Moolenaar06a89a52006-04-29 22:01:03 +00005819 Determines the maximum number of items to show in the popup menu for
5820 Insert mode completion. When zero as much space as available is used.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005821 |ins-completion-menu|.
5822
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01005823 *'pumwidth'* *'pw'*
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005824'pumwidth' 'pw' number (default 15)
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01005825 global
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01005826 Determines the minimum width to use for the popup menu for Insert mode
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005827 completion. |ins-completion-menu|.
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01005828
Bram Moolenaard94464e2015-11-02 15:28:18 +01005829 *'pythondll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01005830'pythondll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01005831 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01005832 {only available when compiled with the |+python/dyn|
5833 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005834 Specifies the name of the Python 2.x shared library. The default is
5835 DYNAMIC_PYTHON_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005836 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01005837 This option cannot be set from a |modeline| or in the |sandbox|, for
5838 security reasons.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005839
Bram Moolenaar94073162018-01-31 21:49:05 +01005840 *'pythonhome'*
5841'pythonhome' string (default "")
5842 global
Bram Moolenaar94073162018-01-31 21:49:05 +01005843 {only available when compiled with the |+python/dyn|
5844 feature}
5845 Specifies the name of the Python 2.x home directory. When 'pythonhome'
5846 and the PYTHONHOME environment variable are not set, PYTHON_HOME,
5847 which was specified at compile time, will be used for the Python 2.x
5848 home directory.
5849 Environment variables are expanded |:set_env|.
5850 This option cannot be set from a |modeline| or in the |sandbox|, for
5851 security reasons.
5852
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005853 *'pythonthreedll'*
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005854'pythonthreedll' string (default depends on the build)
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005855 global
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005856 {only available when compiled with the |+python3/dyn|
5857 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005858 Specifies the name of the Python 3 shared library. The default is
5859 DYNAMIC_PYTHON3_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005860 Environment variables are expanded |:set_env|.
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005861 This option cannot be set from a |modeline| or in the |sandbox|, for
5862 security reasons.
5863
Bram Moolenaar94073162018-01-31 21:49:05 +01005864 *'pythonthreehome'*
5865'pythonthreehome' string (default "")
5866 global
Bram Moolenaar94073162018-01-31 21:49:05 +01005867 {only available when compiled with the |+python3/dyn|
5868 feature}
5869 Specifies the name of the Python 3 home directory. When
5870 'pythonthreehome' and the PYTHONHOME environment variable are not set,
5871 PYTHON3_HOME, which was specified at compile time, will be used for
5872 the Python 3 home directory.
5873 Environment variables are expanded |:set_env|.
5874 This option cannot be set from a |modeline| or in the |sandbox|, for
5875 security reasons.
5876
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01005877 *'pyxversion'* *'pyx'*
5878'pyxversion' 'pyx' number (default depends on the build)
5879 global
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01005880 {only available when compiled with the |+python| or
5881 the |+python3| feature}
5882 Specifies the python version used for pyx* functions and commands
5883 |python_x|. The default value is as follows:
5884
5885 Compiled with Default ~
5886 |+python| and |+python3| 0
5887 only |+python| 2
5888 only |+python3| 3
5889
5890 Available values are 0, 2 and 3.
5891 If 'pyxversion' is 0, it is set to 2 or 3 after the first execution of
5892 any python2/3 commands or functions. E.g. `:py` sets to 2, and `:py3`
5893 sets to 3. `:pyx` sets it to 3 if Python 3 is available, otherwise sets
5894 to 2 if Python 2 is available.
5895 See also: |has-pythonx|
5896
5897 If Vim is compiled with only |+python| or |+python3| setting
5898 'pyxversion' has no effect. The pyx* functions and commands are
5899 always the same as the compiled version.
5900
5901 This option cannot be set from a |modeline| or in the |sandbox|, for
5902 security reasons.
5903
Bram Moolenaar858ba062020-05-31 23:11:59 +02005904 *'quickfixtextfunc'* *'qftf'*
5905'quickfixtextfunc' 'qftf' string (default "")
5906 global
5907 {only available when compiled with the |+quickfix|
5908 feature}
5909 This option specifies a function to be used to get the text to display
5910 in the quickfix and location list windows. This can be used to
5911 customize the information displayed in the quickfix or location window
5912 for each entry in the corresponding quickfix or location list. See
5913 |quickfix-window-function| for an explanation of how to write the
Bram Moolenaard43906d2020-07-20 21:31:32 +02005914 function and an example. The value can be the name of a function or a
5915 lambda.
Bram Moolenaar858ba062020-05-31 23:11:59 +02005916
5917 This option cannot be set from a |modeline| or in the |sandbox|, for
5918 security reasons.
5919
Bram Moolenaar677ee682005-01-27 14:41:15 +00005920 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005921'quoteescape' 'qe' string (default "\")
5922 local to buffer
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005923 The characters that are used to escape quotes in a string. Used for
5924 objects like a', a" and a` |a'|.
5925 When one of the characters in this option is found inside a string,
5926 the following character will be skipped. The default value makes the
5927 text "foo\"bar\\" considered to be one string.
5928
Bram Moolenaar071d4272004-06-13 20:20:40 +00005929 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
5930'readonly' 'ro' boolean (default off)
5931 local to buffer
5932 If on, writes fail unless you use a '!'. Protects you from
5933 accidentally overwriting a file. Default on when Vim is started
5934 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005935 When using ":w!" the 'readonly' option is reset for the current
5936 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar6c60f472019-04-28 16:00:35 +02005937 When using the ":view" command the 'readonly' option is set for the
5938 newly edited buffer.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01005939 See 'modifiable' for disallowing changes to the buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005940
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005941 *'redrawtime'* *'rdt'*
5942'redrawtime' 'rdt' number (default 2000)
5943 global
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005944 {only available when compiled with the |+reltime|
5945 feature}
5946 The time in milliseconds for redrawing the display. This applies to
Bram Moolenaar15142e22018-04-30 22:19:58 +02005947 searching for patterns for 'hlsearch', |:match| highlighting and syntax
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02005948 highlighting.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005949 When redrawing takes more than this many milliseconds no further
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02005950 matches will be highlighted.
5951 For syntax highlighting the time applies per window. When over the
5952 limit syntax highlighting is disabled until |CTRL-L| is used.
5953 This is used to avoid that Vim hangs when using a very complicated
5954 pattern.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005955
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02005956 *'regexpengine'* *'re'*
Bram Moolenaare6ae6222013-05-21 21:01:10 +02005957'regexpengine' 're' number (default 0)
5958 global
Bram Moolenaare6ae6222013-05-21 21:01:10 +02005959 This selects the default regexp engine. |two-engines|
5960 The possible values are:
5961 0 automatic selection
5962 1 old engine
5963 2 NFA engine
5964 Note that when using the NFA engine and the pattern contains something
5965 that is not supported the pattern will not match. This is only useful
5966 for debugging the regexp engine.
Bram Moolenaarfda37292014-11-05 14:27:36 +01005967 Using automatic selection enables Vim to switch the engine, if the
5968 default engine becomes too costly. E.g., when the NFA engine uses too
5969 many states. This should prevent Vim from hanging on a combination of
5970 a complex pattern with long text.
Bram Moolenaare6ae6222013-05-21 21:01:10 +02005971
Bram Moolenaar64486672010-05-16 15:46:46 +02005972 *'relativenumber'* *'rnu'* *'norelativenumber'* *'nornu'*
5973'relativenumber' 'rnu' boolean (default off)
5974 local to window
Bram Moolenaar64486672010-05-16 15:46:46 +02005975 Show the line number relative to the line with the cursor in front of
Bram Moolenaar06b5d512010-05-22 15:37:44 +02005976 each line. Relative line numbers help you use the |count| you can
Bram Moolenaar64486672010-05-16 15:46:46 +02005977 precede some vertical motion commands (e.g. j k + -) with, without
5978 having to calculate it yourself. Especially useful in combination with
5979 other commands (e.g. y d c < > gq gw =).
5980 When the 'n' option is excluded from 'cpoptions' a wrapped
5981 line will not use the column of line numbers (this is the default when
5982 'compatible' isn't set).
5983 The 'numberwidth' option can be used to set the room used for the line
5984 number.
5985 When a long, wrapped line doesn't start with the first character, '-'
5986 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02005987 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
5988 the number.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01005989
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005990 The number in front of the cursor line also depends on the value of
5991 'number', see |number_relativenumber| for all combinations of the two
5992 options.
Bram Moolenaar64486672010-05-16 15:46:46 +02005993
Bram Moolenaar071d4272004-06-13 20:20:40 +00005994 *'remap'* *'noremap'*
5995'remap' boolean (default on)
5996 global
5997 Allows for mappings to work recursively. If you do not want this for
5998 a single entry, use the :noremap[!] command.
Bram Moolenaara3227e22006-03-08 21:32:40 +00005999 NOTE: To avoid portability problems with Vim scripts, always keep
6000 this option at the default "on". Only switch it off when working with
6001 old Vi scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006002
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006003 *'renderoptions'* *'rop'*
6004'renderoptions' 'rop' string (default: empty)
6005 global
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006006 {only available when compiled with GUI and DIRECTX on
6007 MS-Windows}
6008 Select a text renderer and set its options. The options depend on the
6009 renderer.
6010
6011 Syntax: >
6012 set rop=type:{renderer}(,{name}:{value})*
6013<
6014 Currently, only one optional renderer is available.
6015
6016 render behavior ~
6017 directx Vim will draw text using DirectX (DirectWrite). It makes
6018 drawn glyphs more beautiful than default GDI.
6019 It requires 'encoding' is "utf-8", and only works on
6020 MS-Windows Vista or newer version.
6021
6022 Options:
6023 name meaning type value ~
6024 gamma gamma float 1.0 - 2.2 (maybe)
6025 contrast enhancedContrast float (unknown)
6026 level clearTypeLevel float (unknown)
6027 geom pixelGeometry int 0 - 2 (see below)
6028 renmode renderingMode int 0 - 6 (see below)
6029 taamode textAntialiasMode int 0 - 3 (see below)
Bram Moolenaara338adc2018-01-31 20:51:47 +01006030 scrlines Scroll Lines int (deprecated)
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006031
Bram Moolenaar92467d32017-12-05 13:22:16 +01006032 See this URL for detail (except for scrlines):
6033 https://msdn.microsoft.com/en-us/library/dd368190.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006034
6035 For geom: structure of a device pixel.
6036 0 - DWRITE_PIXEL_GEOMETRY_FLAT
6037 1 - DWRITE_PIXEL_GEOMETRY_RGB
6038 2 - DWRITE_PIXEL_GEOMETRY_BGR
6039
6040 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006041 https://msdn.microsoft.com/en-us/library/dd368114.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006042
6043 For renmode: method of rendering glyphs.
6044 0 - DWRITE_RENDERING_MODE_DEFAULT
6045 1 - DWRITE_RENDERING_MODE_ALIASED
6046 2 - DWRITE_RENDERING_MODE_GDI_CLASSIC
6047 3 - DWRITE_RENDERING_MODE_GDI_NATURAL
6048 4 - DWRITE_RENDERING_MODE_NATURAL
6049 5 - DWRITE_RENDERING_MODE_NATURAL_SYMMETRIC
6050 6 - DWRITE_RENDERING_MODE_OUTLINE
6051
6052 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006053 https://msdn.microsoft.com/en-us/library/dd368118.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006054
6055 For taamode: antialiasing mode used for drawing text.
6056 0 - D2D1_TEXT_ANTIALIAS_MODE_DEFAULT
6057 1 - D2D1_TEXT_ANTIALIAS_MODE_CLEARTYPE
6058 2 - D2D1_TEXT_ANTIALIAS_MODE_GRAYSCALE
6059 3 - D2D1_TEXT_ANTIALIAS_MODE_ALIASED
6060
6061 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006062 https://msdn.microsoft.com/en-us/library/dd368170.aspx
6063
Bram Moolenaara338adc2018-01-31 20:51:47 +01006064 For scrlines:
6065 This was used for optimizing scrolling behavior, however this
6066 is now deprecated. If specified, it is simply ignored.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006067
6068 Example: >
6069 set encoding=utf-8
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006070 set gfn=Ricty_Diminished:h12
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006071 set rop=type:directx
6072<
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006073 If select a raster font (Courier, Terminal or FixedSys which
6074 have ".fon" extension in file name) to 'guifont', it will be
Bram Moolenaar92467d32017-12-05 13:22:16 +01006075 drawn by GDI as a fallback.
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006076
6077 NOTE: It is known that some fonts and options combination
6078 causes trouble on drawing glyphs.
6079
Bram Moolenaar92467d32017-12-05 13:22:16 +01006080 - 'renmode:5' and 'renmode:6' will not work with some
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006081 special made fonts (True-Type fonts which includes only
6082 bitmap glyphs).
6083 - 'taamode:3' will not work with some vector fonts.
6084
6085 NOTE: With this option, you can display colored emoji
6086 (emoticon) in Windows 8.1 or later. To display colored emoji,
6087 there are some conditions which you should notice.
6088
6089 - If your font includes non-colored emoji already, it will
6090 be used.
6091 - If your font doesn't have emoji, the system chooses an
6092 alternative symbol font. On Windows 10, "Segoe UI Emoji"
6093 will be used.
6094 - When this alternative font didn't have fixed width glyph,
6095 emoji might be rendered beyond the bounding box of drawing
6096 cell.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006097
6098 Other render types are currently not supported.
6099
Bram Moolenaar071d4272004-06-13 20:20:40 +00006100 *'report'*
6101'report' number (default 2)
6102 global
6103 Threshold for reporting number of lines changed. When the number of
6104 changed lines is more than 'report' a message will be given for most
6105 ":" commands. If you want it always, set 'report' to 0.
6106 For the ":substitute" command the number of substitutions is used
6107 instead of the number of lines.
6108
6109 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
6110'restorescreen' 'rs' boolean (default on)
6111 global
Bram Moolenaar8024f932020-01-14 19:29:13 +01006112 {only in MS-Windows console version}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006113 When set, the screen contents is restored when exiting Vim. This also
6114 happens when executing external commands.
6115
6116 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
6117 options in your .vimrc. To disable restoring:
6118 set t_ti= t_te=
6119 To enable restoring (for an xterm):
6120 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
6121 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
6122
6123 *'revins'* *'ri'* *'norevins'* *'nori'*
6124'revins' 'ri' boolean (default off)
6125 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006126 {only available when compiled with the |+rightleft|
6127 feature}
6128 Inserting characters in Insert mode will work backwards. See "typing
6129 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
6130 command in Insert mode, when 'allowrevins' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02006131 NOTE: This option is reset when 'compatible' is set.
6132 This option is reset when 'paste' is set and restored when 'paste' is
6133 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006134
6135 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
6136'rightleft' 'rl' boolean (default off)
6137 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006138 {only available when compiled with the |+rightleft|
6139 feature}
6140 When on, display orientation becomes right-to-left, i.e., characters
6141 that are stored in the file appear from the right to the left.
6142 Using this option, it is possible to edit files for languages that
6143 are written from the right to the left such as Hebrew and Arabic.
6144 This option is per window, so it is possible to edit mixed files
6145 simultaneously, or to view the same file in both ways (this is
6146 useful whenever you have a mixed text file with both right-to-left
6147 and left-to-right strings so that both sets are displayed properly
6148 in different windows). Also see |rileft.txt|.
6149
Bram Moolenaar607cc1e2010-07-18 18:47:44 +02006150 *'rightleftcmd'* *'rlc'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006151'rightleftcmd' 'rlc' string (default "search")
6152 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006153 {only available when compiled with the |+rightleft|
6154 feature}
6155 Each word in this option enables the command line editing to work in
6156 right-to-left mode for a group of commands:
6157
6158 search "/" and "?" commands
6159
6160 This is useful for languages such as Hebrew, Arabic and Farsi.
6161 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
6162
Bram Moolenaard94464e2015-11-02 15:28:18 +01006163 *'rubydll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01006164'rubydll' string (default: depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01006165 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01006166 {only available when compiled with the |+ruby/dyn|
6167 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006168 Specifies the name of the Ruby shared library. The default is
6169 DYNAMIC_RUBY_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006170 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01006171 This option cannot be set from a |modeline| or in the |sandbox|, for
6172 security reasons.
6173
Bram Moolenaar071d4272004-06-13 20:20:40 +00006174 *'ruler'* *'ru'* *'noruler'* *'noru'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02006175'ruler' 'ru' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006176 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006177 {not available when compiled without the
6178 |+cmdline_info| feature}
6179 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006180 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00006181 text in the file is shown on the far right:
6182 Top first line is visible
6183 Bot last line is visible
6184 All first and last line are visible
6185 45% relative position in the file
6186 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006187 Each window has its own ruler. If a window has a status line, the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006188 ruler is shown there. Otherwise it is shown in the last line of the
Bram Moolenaar582fd852005-03-28 20:58:01 +00006189 screen. If the statusline is given by 'statusline' (i.e. not empty),
Bram Moolenaar071d4272004-06-13 20:20:40 +00006190 this option takes precedence over 'ruler' and 'rulerformat'
6191 If the number of characters displayed is different from the number of
6192 bytes in the text (e.g., for a TAB or a multi-byte character), both
6193 the text column (byte number) and the screen column are shown,
6194 separated with a dash.
6195 For an empty line "0-1" is shown.
6196 For an empty buffer the line number will also be zero: "0,0-1".
Bram Moolenaarca635012015-09-25 20:34:21 +02006197 This option is reset when 'paste' is set and restored when 'paste' is
6198 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006199 If you don't want to see the ruler all the time but want to know where
6200 you are, use "g CTRL-G" |g_CTRL-G|.
6201 NOTE: This option is reset when 'compatible' is set.
6202
6203 *'rulerformat'* *'ruf'*
6204'rulerformat' 'ruf' string (default empty)
6205 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006206 {not available when compiled without the |+statusline|
6207 feature}
6208 When this option is not empty, it determines the content of the ruler
6209 string, as displayed for the 'ruler' option.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00006210 The format of this option is like that of 'statusline'.
Bram Moolenaar110289e2019-05-23 15:38:06 +02006211 This option cannot be set in a modeline when 'modelineexpr' is off.
6212
Bram Moolenaar071d4272004-06-13 20:20:40 +00006213 The default ruler width is 17 characters. To make the ruler 15
6214 characters wide, put "%15(" at the start and "%)" at the end.
6215 Example: >
6216 :set rulerformat=%15(%c%V\ %p%%%)
6217<
6218 *'runtimepath'* *'rtp'* *vimfiles*
6219'runtimepath' 'rtp' string (default:
6220 Unix: "$HOME/.vim,
6221 $VIM/vimfiles,
6222 $VIMRUNTIME,
6223 $VIM/vimfiles/after,
6224 $HOME/.vim/after"
6225 Amiga: "home:vimfiles,
6226 $VIM/vimfiles,
6227 $VIMRUNTIME,
6228 $VIM/vimfiles/after,
6229 home:vimfiles/after"
Bram Moolenaar6f345a12019-12-17 21:27:18 +01006230 PC: "$HOME/vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006231 $VIM/vimfiles,
6232 $VIMRUNTIME,
6233 $VIM/vimfiles/after,
6234 $HOME/vimfiles/after"
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02006235 macOS: "$VIM:vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006236 $VIMRUNTIME,
6237 $VIM:vimfiles:after"
Bram Moolenaarb3f74062020-02-26 16:16:53 +01006238 Haiku: "$BE_USER_SETTINGS/vim,
6239 $VIM/vimfiles,
6240 $VIMRUNTIME,
6241 $VIM/vimfiles/after,
6242 $BE_USER_SETTINGS/vim/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006243 VMS: "sys$login:vimfiles,
6244 $VIM/vimfiles,
6245 $VIMRUNTIME,
6246 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00006247 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006248 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006249 This is a list of directories which will be searched for runtime
6250 files:
6251 filetype.vim filetypes by file name |new-filetype|
6252 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006253 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006254 colors/ color scheme files |:colorscheme|
6255 compiler/ compiler files |:compiler|
6256 doc/ documentation |write-local-help|
6257 ftplugin/ filetype plugins |write-filetype-plugin|
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01006258 import/ files that are found by `:import`
Bram Moolenaar071d4272004-06-13 20:20:40 +00006259 indent/ indent scripts |indent-expression|
6260 keymap/ key mapping files |mbyte-keymap|
6261 lang/ menu translations |:menutrans|
6262 menu.vim GUI menus |menu.vim|
Bram Moolenaar26852122016-05-24 20:02:38 +02006263 pack/ packages |:packadd|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006264 plugin/ plugin scripts |write-plugin|
6265 print/ files for printing |postscript-print-encoding|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006266 spell/ spell checking files |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006267 syntax/ syntax files |mysyntaxfile|
6268 tutor/ files for vimtutor |tutor|
6269
6270 And any other file searched for with the |:runtime| command.
6271
6272 The defaults for most systems are setup to search five locations:
6273 1. In your home directory, for your personal preferences.
6274 2. In a system-wide Vim directory, for preferences from the system
6275 administrator.
6276 3. In $VIMRUNTIME, for files distributed with Vim.
6277 *after-directory*
6278 4. In the "after" directory in the system-wide Vim directory. This is
6279 for the system administrator to overrule or add to the distributed
6280 defaults (rarely needed)
6281 5. In the "after" directory in your home directory. This is for
6282 personal preferences to overrule or add to the distributed defaults
6283 or system-wide settings (rarely needed).
6284
Bram Moolenaard0796902016-09-16 20:02:31 +02006285 More entries are added when using |packages|. If it gets very long
6286 then `:set rtp` will be truncated, use `:echo &rtp` to see the full
6287 string.
Bram Moolenaar26852122016-05-24 20:02:38 +02006288
Bram Moolenaar071d4272004-06-13 20:20:40 +00006289 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
6290 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006291 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00006292 wildcards.
6293 See |:runtime|.
6294 Example: >
6295 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
6296< This will use the directory "~/vimruntime" first (containing your
6297 personal Vim runtime files), then "/mygroup/vim" (shared between a
6298 group of people) and finally "$VIMRUNTIME" (the distributed runtime
6299 files).
6300 You probably should always include $VIMRUNTIME somewhere, to use the
6301 distributed runtime files. You can put a directory before $VIMRUNTIME
6302 to find files which replace a distributed runtime files. You can put
6303 a directory after $VIMRUNTIME to find files which add to distributed
6304 runtime files.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006305 When Vim is started with |--clean| the home directory entries are not
6306 included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006307 This option cannot be set from a |modeline| or in the |sandbox|, for
6308 security reasons.
6309
6310 *'scroll'* *'scr'*
6311'scroll' 'scr' number (default: half the window height)
6312 local to window
6313 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
6314 set to half the number of lines in the window when the window size
6315 changes. If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006316 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar25c9c682019-05-05 18:13:34 +02006317 height with ":set scroll=0".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006318
6319 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
6320'scrollbind' 'scb' boolean (default off)
6321 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006322 See also |scroll-binding|. When this option is set, the current
6323 window scrolls as other scrollbind windows (windows that also have
6324 this option set) scroll. This option is useful for viewing the
6325 differences between two versions of a file, see 'diff'.
6326 See |'scrollopt'| for options that determine how this option should be
6327 interpreted.
6328 This option is mostly reset when splitting a window to edit another
6329 file. This means that ":split | edit file" results in two windows
6330 with scroll-binding, but ":split file" does not.
6331
Bram Moolenaarae20f342019-11-05 21:09:23 +01006332 *'scrollfocus'* *'scf'* *'noscrollfocus'* *'noscf'*
6333'scrollfocus' 'scf' boolean (default off)
6334 global
6335 {only for MS-Windows GUI}
6336 When using the scroll wheel and this option is set, the window under
6337 the mouse pointer is scrolled. With this option off the current
6338 window is scrolled.
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01006339 Systems other than MS-Windows always behave like this option is on.
Bram Moolenaarae20f342019-11-05 21:09:23 +01006340
Bram Moolenaar071d4272004-06-13 20:20:40 +00006341 *'scrolljump'* *'sj'*
6342'scrolljump' 'sj' number (default 1)
6343 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006344 Minimal number of lines to scroll when the cursor gets off the
6345 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
6346 CTRL-D). Useful if your terminal scrolls very slowly.
Bram Moolenaar1e015462005-09-25 22:16:38 +00006347 When set to a negative number from -1 to -100 this is used as the
6348 percentage of the window height. Thus -50 scrolls half the window
6349 height.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006350 NOTE: This option is set to 1 when 'compatible' is set.
6351
6352 *'scrolloff'* *'so'*
Bram Moolenaar50ba5262016-09-22 22:33:02 +02006353'scrolloff' 'so' number (default 0, set to 5 in |defaults.vim|)
Bram Moolenaar375e3392019-01-31 18:26:10 +01006354 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006355 Minimal number of screen lines to keep above and below the cursor.
6356 This will make some context visible around where you are working. If
6357 you set it to a very large value (999) the cursor line will always be
6358 in the middle of the window (except at the start or end of the file or
6359 when long lines wrap).
Bram Moolenaar375e3392019-01-31 18:26:10 +01006360 After using the local value, go back the global value with one of
6361 these two: >
6362 setlocal scrolloff<
6363 setlocal scrolloff=-1
6364< For scrolling horizontally see 'sidescrolloff'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006365 NOTE: This option is set to 0 when 'compatible' is set.
6366
6367 *'scrollopt'* *'sbo'*
6368'scrollopt' 'sbo' string (default "ver,jump")
6369 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006370 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006371 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
6372 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006373 The following words are available:
6374 ver Bind vertical scrolling for 'scrollbind' windows
6375 hor Bind horizontal scrolling for 'scrollbind' windows
6376 jump Applies to the offset between two windows for vertical
6377 scrolling. This offset is the difference in the first
6378 displayed line of the bound windows. When moving
6379 around in a window, another 'scrollbind' window may
6380 reach a position before the start or after the end of
6381 the buffer. The offset is not changed though, when
6382 moving back the 'scrollbind' window will try to scroll
6383 to the desired position when possible.
6384 When now making that window the current one, two
6385 things can be done with the relative offset:
6386 1. When "jump" is not included, the relative offset is
6387 adjusted for the scroll position in the new current
6388 window. When going back to the other window, the
Bram Moolenaar02467872007-05-06 13:22:01 +00006389 new relative offset will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006390 2. When "jump" is included, the other windows are
6391 scrolled to keep the same relative offset. When
6392 going back to the other window, it still uses the
6393 same relative offset.
6394 Also see |scroll-binding|.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006395 When 'diff' mode is active there always is vertical scroll binding,
6396 even when "ver" isn't there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006397
6398 *'sections'* *'sect'*
6399'sections' 'sect' string (default "SHNHH HUnhsh")
6400 global
6401 Specifies the nroff macros that separate sections. These are pairs of
6402 two letters (See |object-motions|). The default makes a section start
6403 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
6404
6405 *'secure'* *'nosecure'* *E523*
6406'secure' boolean (default off)
6407 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006408 When on, ":autocmd", shell and write commands are not allowed in
6409 ".vimrc" and ".exrc" in the current directory and map commands are
6410 displayed. Switch it off only if you know that you will not run into
6411 problems, or when the 'exrc' option is off. On Unix this option is
6412 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006413 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00006414 'secure' at the end of your ~/.vimrc then.
6415 This option cannot be set from a |modeline| or in the |sandbox|, for
6416 security reasons.
6417
6418 *'selection'* *'sel'*
6419'selection' 'sel' string (default "inclusive")
6420 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006421 This option defines the behavior of the selection. It is only used
6422 in Visual and Select mode.
6423 Possible values:
6424 value past line inclusive ~
6425 old no yes
6426 inclusive yes yes
6427 exclusive yes no
6428 "past line" means that the cursor is allowed to be positioned one
6429 character past the line.
6430 "inclusive" means that the last character of the selection is included
6431 in an operation. For example, when "x" is used to delete the
6432 selection.
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02006433 When "old" is used and 'virtualedit' allows the cursor to move past
6434 the end of line the line break still isn't included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006435 Note that when "exclusive" is used and selecting from the end
6436 backwards, you cannot include the last character of a line, when
6437 starting in Normal mode and 'virtualedit' empty.
6438
6439 The 'selection' option is set by the |:behave| command.
6440
6441 *'selectmode'* *'slm'*
6442'selectmode' 'slm' string (default "")
6443 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006444 This is a comma separated list of words, which specifies when to start
6445 Select mode instead of Visual mode, when a selection is started.
6446 Possible values:
6447 mouse when using the mouse
6448 key when using shifted special keys
6449 cmd when using "v", "V" or CTRL-V
6450 See |Select-mode|.
6451 The 'selectmode' option is set by the |:behave| command.
6452
6453 *'sessionoptions'* *'ssop'*
6454'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006455 help,options,tabpages,winsize,terminal")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006456 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02006457 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006458 feature}
6459 Changes the effect of the |:mksession| command. It is a comma
6460 separated list of words. Each word enables saving and restoring
6461 something:
6462 word save and restore ~
6463 blank empty windows
6464 buffers hidden and unloaded buffers, not just those in windows
6465 curdir the current directory
6466 folds manually created folds, opened/closed folds and local
6467 fold options
6468 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00006469 and contain at least one lowercase letter. Only
6470 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006471 help the help window
6472 localoptions options and mappings local to a window or buffer (not
6473 global values for local options)
6474 options all options and mappings (also global values for local
6475 options)
6476 resize size of the Vim window: 'lines' and 'columns'
6477 sesdir the directory in which the session file is located
6478 will become the current directory (useful with
6479 projects accessed over a network from different
6480 systems)
6481 slash backslashes in file names replaced with forward
6482 slashes
Bram Moolenaar18144c82006-04-12 21:52:12 +00006483 tabpages all tab pages; without this only the current tab page
6484 is restored, so that you can make a session for each
6485 tab page separately
Bram Moolenaard473c8c2018-08-11 18:00:22 +02006486 terminal include terminal windows where the command can be
6487 restored
Bram Moolenaar071d4272004-06-13 20:20:40 +00006488 unix with Unix end-of-line format (single <NL>), even when
6489 on Windows or DOS
6490 winpos position of the whole Vim window
6491 winsize window sizes
6492
6493 Don't include both "curdir" and "sesdir".
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006494 When neither "curdir" nor "sesdir" is included, file names are stored
6495 with absolute paths.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006496 "slash" and "unix" are useful on Windows when sharing session files
6497 with Unix. The Unix version of Vim cannot source dos format scripts,
6498 but the Windows version of Vim can source unix format scripts.
6499
6500 *'shell'* *'sh'* *E91*
Bram Moolenaar95a9dd12019-12-19 22:12:03 +01006501'shell' 'sh' string (default $SHELL or "sh", Win32: "cmd.exe")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006502 global
6503 Name of the shell to use for ! and :! commands. When changing the
6504 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
6505 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006506 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006507 See |option-backslash| about including spaces and backslashes.
6508 Environment variables are expanded |:set_env|.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006509
Bram Moolenaar1ff14ba2019-11-02 14:09:23 +01006510 If the name of the shell contains a space, you need to enclose it in
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01006511 quotes and escape the space. Example with quotes: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006512 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
6513< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006514 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006515 "-f" is not inside the quotes, because it is not part of the command
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006516 name. Vim automagically recognizes the backslashes that are path
Bram Moolenaar071d4272004-06-13 20:20:40 +00006517 separators.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006518 Example with escaped space (Vim will do this when initializing the
6519 option from $SHELL): >
6520 :set shell=/bin/with\\\ space/sh
Bram Moolenaard473c8c2018-08-11 18:00:22 +02006521< The resulting value of 'shell' is "/bin/with\ space/sh", two
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006522 backslashes are consumed by `:set`.
6523
Bram Moolenaar071d4272004-06-13 20:20:40 +00006524 Under MS-Windows, when the executable ends in ".com" it must be
6525 included. Thus setting the shell to "command.com" or "4dos.com"
6526 works, but "command" and "4dos" do not work for all commands (e.g.,
6527 filtering).
6528 For unknown reasons, when using "4dos.com" the current directory is
6529 changed to "C:\". To avoid this set 'shell' like this: >
6530 :set shell=command.com\ /c\ 4dos
6531< This option cannot be set from a |modeline| or in the |sandbox|, for
6532 security reasons.
6533
6534 *'shellcmdflag'* *'shcf'*
Bram Moolenaar5dc62522012-02-13 00:05:22 +01006535'shellcmdflag' 'shcf' string (default: "-c";
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006536 Win32, when 'shell' does not contain "sh"
6537 somewhere: "/c")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006538 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006539 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
Bram Moolenaar8024f932020-01-14 19:29:13 +01006540 "bash.exe -c ls" or "cmd.exe /c dir". For MS-Windows, the default is
6541 set according to the value of 'shell', to reduce the need to set this
6542 option by the user.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02006543 On Unix it can have more than one flag. Each white space separated
6544 part is passed as an argument to the shell command.
6545 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006546 Also see |dos-shell| for MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006547 This option cannot be set from a |modeline| or in the |sandbox|, for
6548 security reasons.
6549
6550 *'shellpipe'* *'sp'*
Bram Moolenaar8024f932020-01-14 19:29:13 +01006551'shellpipe' 'sp' string (default ">", ">%s 2>&1", "| tee", "|& tee" or
6552 "2>&1| tee")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006553 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006554 {not available when compiled without the |+quickfix|
6555 feature}
6556 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006557 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00006558 including spaces and backslashes.
6559 The name of the temporary file can be represented by "%s" if necessary
6560 (the file name is appended automatically if no %s appears in the value
6561 of this option).
Bram Moolenaar8024f932020-01-14 19:29:13 +01006562 For the Amiga the default is ">". For MS-Windows the default is
6563 ">%s 2>&1". The output is directly saved in a file and not echoed to
6564 the screen.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006565 For Unix the default it "| tee". The stdout of the compiler is saved
6566 in a file and echoed to the screen. If the 'shell' option is "csh" or
6567 "tcsh" after initializations, the default becomes "|& tee". If the
Bram Moolenaar96f45c02019-10-26 19:53:45 +02006568 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh", "zsh-beta",
6569 "bash" or "fish" the default becomes "2>&1| tee". This means that
6570 stderr is also included. Before using the 'shell' option a path is
6571 removed, thus "/bin/sh" uses "sh".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006572 The initialization of this option is done after reading the ".vimrc"
6573 and the other initializations, so that when the 'shell' option is set
6574 there, the 'shellpipe' option changes automatically, unless it was
6575 explicitly set before.
6576 When 'shellpipe' is set to an empty string, no redirection of the
6577 ":make" output will be done. This is useful if you use a 'makeprg'
6578 that writes to 'makeef' by itself. If you want no piping, but do
6579 want to include the 'makeef', set 'shellpipe' to a single space.
6580 Don't forget to precede the space with a backslash: ":set sp=\ ".
6581 In the future pipes may be used for filtering and this option will
6582 become obsolete (at least for Unix).
6583 This option cannot be set from a |modeline| or in the |sandbox|, for
6584 security reasons.
6585
6586 *'shellquote'* *'shq'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006587'shellquote' 'shq' string (default: ""; Win32, when 'shell'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006588 contains "sh" somewhere: "\"")
6589 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006590 Quoting character(s), put around the command passed to the shell, for
6591 the "!" and ":!" commands. The redirection is kept outside of the
6592 quoting. See 'shellxquote' to include the redirection. It's
6593 probably not useful to set both options.
6594 This is an empty string by default. Only known to be useful for
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006595 third-party shells on MS-Windows-like systems, such as the MKS Korn
6596 Shell or bash, where it should be "\"". The default is adjusted
6597 according the value of 'shell', to reduce the need to set this option
6598 by the user. See |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006599 This option cannot be set from a |modeline| or in the |sandbox|, for
6600 security reasons.
6601
6602 *'shellredir'* *'srr'*
6603'shellredir' 'srr' string (default ">", ">&" or ">%s 2>&1")
6604 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006605 String to be used to put the output of a filter command in a temporary
6606 file. See also |:!|. See |option-backslash| about including spaces
6607 and backslashes.
6608 The name of the temporary file can be represented by "%s" if necessary
6609 (the file name is appended automatically if no %s appears in the value
6610 of this option).
Bram Moolenaar96f45c02019-10-26 19:53:45 +02006611 The default is ">". For Unix, if the 'shell' option is "csh" or
6612 "tcsh" during initializations, the default becomes ">&". If the
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01006613 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh", "zsh-beta",
6614 "bash" or "fish", the default becomes ">%s 2>&1". This means that
6615 stderr is also included. For Win32, the Unix checks are done and
6616 additionally "cmd" is checked for, which makes the default ">%s 2>&1".
6617 Also, the same names with ".exe" appended are checked for.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006618 The initialization of this option is done after reading the ".vimrc"
6619 and the other initializations, so that when the 'shell' option is set
6620 there, the 'shellredir' option changes automatically unless it was
6621 explicitly set before.
6622 In the future pipes may be used for filtering and this option will
6623 become obsolete (at least for Unix).
6624 This option cannot be set from a |modeline| or in the |sandbox|, for
6625 security reasons.
6626
6627 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
6628'shellslash' 'ssl' boolean (default off)
6629 global
Bram Moolenaar6f345a12019-12-17 21:27:18 +01006630 {only for MS-Windows}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006631 When set, a forward slash is used when expanding file names. This is
Bram Moolenaar8024f932020-01-14 19:29:13 +01006632 useful when a Unix-like shell is used instead of cmd.exe. Backward
6633 slashes can still be typed, but they are changed to forward slashes by
6634 Vim.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006635 Note that setting or resetting this option has no effect for some
6636 existing file names, thus this option needs to be set before opening
6637 any file for best results. This might change in the future.
6638 'shellslash' only works when a backslash can be used as a path
6639 separator. To test if this is so use: >
6640 if exists('+shellslash')
Bram Moolenaarac3150d2019-07-28 16:36:39 +02006641< Also see 'completeslash'.
6642
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006643 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
6644'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
6645 global
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006646 When on, use temp files for shell commands. When off use a pipe.
6647 When using a pipe is not possible temp files are used anyway.
Bram Moolenaar97293012011-07-18 19:40:27 +02006648 Currently a pipe is only supported on Unix and MS-Windows 2K and
6649 later. You can check it with: >
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006650 :if has("filterpipe")
6651< The advantage of using a pipe is that nobody can read the temp file
6652 and the 'shell' command does not need to support redirection.
6653 The advantage of using a temp file is that the file type and encoding
6654 can be detected.
6655 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
6656 |FilterWritePost| autocommands event are not triggered when
6657 'shelltemp' is off.
Bram Moolenaar269f5952016-07-15 22:54:41 +02006658 The `system()` function does not respect this option and always uses
6659 temp files.
Bram Moolenaar036986f2017-03-16 17:41:02 +01006660 NOTE: This option is set to the Vim default value when 'compatible'
6661 is reset.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006662
Bram Moolenaar071d4272004-06-13 20:20:40 +00006663 *'shelltype'* *'st'*
6664'shelltype' 'st' number (default 0)
6665 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02006666 {only for the Amiga}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006667 On the Amiga this option influences the way how the commands work
6668 which use a shell.
6669 0 and 1: always use the shell
6670 2 and 3: use the shell only to filter lines
6671 4 and 5: use shell only for ':sh' command
6672 When not using the shell, the command is executed directly.
6673
6674 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
6675 1 and 3: use "shell cmd" to start external commands
6676
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006677 *'shellxescape'* *'sxe'*
6678'shellxescape' 'sxe' string (default: "";
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006679 for MS-Windows: "\"&|<>()@^")
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006680 global
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006681 When 'shellxquote' is set to "(" then the characters listed in this
6682 option will be escaped with a '^' character. This makes it possible
6683 to execute most external commands with cmd.exe.
6684
Bram Moolenaar071d4272004-06-13 20:20:40 +00006685 *'shellxquote'* *'sxq'*
6686'shellxquote' 'sxq' string (default: "";
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006687 for Win32, when 'shell' is cmd.exe: "("
6688 for Win32, when 'shell' contains "sh"
6689 somewhere: "\""
Bram Moolenaar071d4272004-06-13 20:20:40 +00006690 for Unix, when using system(): "\"")
6691 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006692 Quoting character(s), put around the command passed to the shell, for
6693 the "!" and ":!" commands. Includes the redirection. See
6694 'shellquote' to exclude the redirection. It's probably not useful
6695 to set both options.
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006696 When the value is '(' then ')' is appended. When the value is '"('
6697 then ')"' is appended.
6698 When the value is '(' then also see 'shellxescape'.
Bram Moolenaara64ba222012-02-12 23:23:31 +01006699 This is an empty string by default on most systems, but is known to be
6700 useful for on Win32 version, either for cmd.exe which automatically
6701 strips off the first and last quote on a command, or 3rd-party shells
6702 such as the MKS Korn Shell or bash, where it should be "\"". The
6703 default is adjusted according the value of 'shell', to reduce the need
6704 to set this option by the user. See |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006705 This option cannot be set from a |modeline| or in the |sandbox|, for
6706 security reasons.
6707
6708 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
6709'shiftround' 'sr' boolean (default off)
6710 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006711 Round indent to multiple of 'shiftwidth'. Applies to > and <
6712 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
6713 a multiple of 'shiftwidth' (this is Vi compatible).
6714 NOTE: This option is reset when 'compatible' is set.
6715
6716 *'shiftwidth'* *'sw'*
6717'shiftwidth' 'sw' number (default 8)
6718 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006719 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00006720 |'cindent'|, |>>|, |<<|, etc.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02006721 When zero the 'ts' value will be used. Use the |shiftwidth()|
6722 function to get the effective shiftwidth value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006723
6724 *'shortmess'* *'shm'*
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02006725'shortmess' 'shm' string (Vim default "filnxtToOS", Vi default: "S",
6726 POSIX default: "AS")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006727 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006728 This option helps to avoid all the |hit-enter| prompts caused by file
6729 messages, for example with CTRL-G, and to avoid some other messages.
6730 It is a list of flags:
6731 flag meaning when present ~
6732 f use "(3 of 5)" instead of "(file 3 of 5)"
6733 i use "[noeol]" instead of "[Incomplete last line]"
Bram Moolenaar3f40ce72020-07-05 14:10:13 +02006734 l use "999L, 888B" instead of "999 lines, 888 bytes"
Bram Moolenaar071d4272004-06-13 20:20:40 +00006735 m use "[+]" instead of "[Modified]"
6736 n use "[New]" instead of "[New File]"
6737 r use "[RO]" instead of "[readonly]"
6738 w use "[w]" instead of "written" for file write message
6739 and "[a]" instead of "appended" for ':w >> file' command
6740 x use "[dos]" instead of "[dos format]", "[unix]" instead of
6741 "[unix format]" and "[mac]" instead of "[mac format]".
6742 a all of the above abbreviations
6743
6744 o overwrite message for writing a file with subsequent message
6745 for reading a file (useful for ":wn" or when 'autowrite' on)
6746 O message for reading a file overwrites any previous message.
6747 Also for quickfix message (e.g., ":cn").
6748 s don't give "search hit BOTTOM, continuing at TOP" or "search
Bram Moolenaara6c27c42019-05-09 19:16:22 +02006749 hit TOP, continuing at BOTTOM" messages; when using the search
6750 count do not show "W" after the count message (see S below)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006751 t truncate file message at the start if it is too long to fit
6752 on the command-line, "<" will appear in the left most column.
6753 Ignored in Ex mode.
6754 T truncate other messages in the middle if they are too long to
Bram Moolenaar582fd852005-03-28 20:58:01 +00006755 fit on the command line. "..." will appear in the middle.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006756 Ignored in Ex mode.
6757 W don't give "written" or "[w]" when writing a file
6758 A don't give the "ATTENTION" message when an existing swap file
6759 is found.
6760 I don't give the intro message when starting Vim |:intro|.
Bram Moolenaarea389e92014-05-28 21:40:52 +02006761 c don't give |ins-completion-menu| messages. For example,
6762 "-- XXX completion (YYY)", "match 1 of 2", "The only match",
6763 "Pattern not found", "Back at original", etc.
Bram Moolenaar426dd022016-03-15 15:09:29 +01006764 q use "recording" instead of "recording @a"
6765 F don't give the file info when editing a file, like `:silent`
Bram Moolenaar110289e2019-05-23 15:38:06 +02006766 was used for the command; note that this also affects messages
6767 from autocommands
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02006768 S do not show search count message when searching, e.g.
6769 "[1/5]"
Bram Moolenaar071d4272004-06-13 20:20:40 +00006770
6771 This gives you the opportunity to avoid that a change between buffers
6772 requires you to hit <Enter>, but still gives as useful a message as
6773 possible for the space available. To get the whole message that you
6774 would have got with 'shm' empty, use ":file!"
6775 Useful values:
6776 shm= No abbreviation of message.
6777 shm=a Abbreviation, but no loss of information.
6778 shm=at Abbreviation, and truncate message when necessary.
6779
6780 NOTE: This option is set to the Vi default value when 'compatible' is
6781 set and to the Vim default value when 'compatible' is reset.
6782
6783 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
6784'shortname' 'sn' boolean (default off)
6785 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00006786 Filenames are assumed to be 8 characters plus one extension of 3
6787 characters. Multiple dots in file names are not allowed. When this
6788 option is on, dots in file names are replaced with underscores when
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006789 adding an extension (".~" or ".swp"). This option is useful
Bram Moolenaar071d4272004-06-13 20:20:40 +00006790 when editing files on an MS-DOS compatible filesystem, e.g., messydos
Bram Moolenaarade0d392020-01-21 22:33:58 +01006791 or crossdos.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006792
6793 *'showbreak'* *'sbr'* *E595*
6794'showbreak' 'sbr' string (default "")
Bram Moolenaaree857022019-11-09 23:26:40 +01006795 global or local to window |global-local|
Bram Moolenaardb84e452010-08-15 13:50:43 +02006796 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006797 feature}
6798 String to put at the start of lines that have been wrapped. Useful
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006799 values are "> " or "+++ ": >
6800 :set showbreak=>\
6801< Note the backslash to escape the trailing space. It's easier like
6802 this: >
Bram Moolenaar1a384422010-07-14 19:53:30 +02006803 :let &showbreak = '+++ '
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006804< Only printable single-cell characters are allowed, excluding <Tab> and
Bram Moolenaar071d4272004-06-13 20:20:40 +00006805 comma (in a future version the comma might be used to separate the
6806 part that is shown at the end and at the start of a line).
6807 The characters are highlighted according to the '@' flag in
6808 'highlight'.
6809 Note that tabs after the showbreak will be displayed differently.
6810 If you want the 'showbreak' to appear in between line numbers, add the
6811 "n" flag to 'cpoptions'.
Bram Moolenaaree857022019-11-09 23:26:40 +01006812 A window-local value overrules a global value. If the global value is
6813 set and you want no value in the current window use NONE: >
6814 :setlocal showbreak=NONE
6815<
Bram Moolenaar071d4272004-06-13 20:20:40 +00006816 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02006817'showcmd' 'sc' boolean (Vim default: on, off for Unix,
6818 Vi default: off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006819 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006820 {not available when compiled without the
6821 |+cmdline_info| feature}
Bram Moolenaar02467872007-05-06 13:22:01 +00006822 Show (partial) command in the last line of the screen. Set this
6823 option off if your terminal is slow.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006824 In Visual mode the size of the selected area is shown:
6825 - When selecting characters within a line, the number of characters.
Bram Moolenaarf91787c2010-07-17 12:47:16 +02006826 If the number of bytes is different it is also displayed: "2-6"
6827 means two characters and six bytes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006828 - When selecting more than one line, the number of lines.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006829 - When selecting a block, the size in screen characters:
6830 {lines}x{columns}.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006831 NOTE: This option is set to the Vi default value when 'compatible' is
6832 set and to the Vim default value when 'compatible' is reset.
6833
6834 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
6835'showfulltag' 'sft' boolean (default off)
6836 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006837 When completing a word in insert mode (see |ins-completion|) from the
6838 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006839 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00006840 matched a C function, you can see a template for what arguments are
6841 required (coding style permitting).
Bram Moolenaar446cb832008-06-24 21:56:24 +00006842 Note that this doesn't work well together with having "longest" in
6843 'completeopt', because the completion from the search pattern may not
6844 match the typed text.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006845
6846 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
6847'showmatch' 'sm' boolean (default off)
6848 global
6849 When a bracket is inserted, briefly jump to the matching one. The
6850 jump is only done if the match can be seen on the screen. The time to
6851 show the match can be set with 'matchtime'.
6852 A Beep is given if there is no match (no matter if the match can be
Bram Moolenaarca635012015-09-25 20:34:21 +02006853 seen or not).
6854 This option is reset when 'paste' is set and restored when 'paste' is
6855 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006856 When the 'm' flag is not included in 'cpoptions', typing a character
6857 will immediately move the cursor back to where it belongs.
6858 See the "sm" field in 'guicursor' for setting the cursor shape and
6859 blinking when showing the match.
6860 The 'matchpairs' option can be used to specify the characters to show
6861 matches for. 'rightleft' and 'revins' are used to look for opposite
6862 matches.
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006863 Also see the matchparen plugin for highlighting the match when moving
6864 around |pi_paren.txt|.
6865 Note: Use of the short form is rated PG.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006866
6867 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
6868'showmode' 'smd' boolean (Vim default: on, Vi default: off)
6869 global
6870 If in Insert, Replace or Visual mode put a message on the last line.
6871 Use the 'M' flag in 'highlight' to set the type of highlighting for
6872 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006873 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00006874 doesn't mean XIM is really active, especially when 'imactivatekey' is
6875 not set.
6876 NOTE: This option is set to the Vi default value when 'compatible' is
6877 set and to the Vim default value when 'compatible' is reset.
6878
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006879 *'showtabline'* *'stal'*
6880'showtabline' 'stal' number (default 1)
6881 global
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006882 The value of this option specifies when the line with tab page labels
6883 will be displayed:
6884 0: never
6885 1: only if there are at least two tab pages
6886 2: always
6887 This is both for the GUI and non-GUI implementation of the tab pages
6888 line.
6889 See |tab-page| for more information about tab pages.
6890
Bram Moolenaar071d4272004-06-13 20:20:40 +00006891 *'sidescroll'* *'ss'*
6892'sidescroll' 'ss' number (default 0)
6893 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006894 The minimal number of columns to scroll horizontally. Used only when
6895 the 'wrap' option is off and the cursor is moved off of the screen.
6896 When it is zero the cursor will be put in the middle of the screen.
6897 When using a slow terminal set it to a large number or 0. When using
6898 a fast terminal use a small number or 1. Not used for "zh" and "zl"
6899 commands.
6900
6901 *'sidescrolloff'* *'siso'*
6902'sidescrolloff' 'siso' number (default 0)
Bram Moolenaar375e3392019-01-31 18:26:10 +01006903 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006904 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00006905 right of the cursor if 'nowrap' is set. Setting this option to a
6906 value greater than 0 while having |'sidescroll'| also at a non-zero
6907 value makes some context visible in the line you are scrolling in
6908 horizontally (except at beginning of the line). Setting this option
6909 to a large value (like 999) has the effect of keeping the cursor
6910 horizontally centered in the window, as long as one does not come too
6911 close to the beginning of the line.
Bram Moolenaar375e3392019-01-31 18:26:10 +01006912 After using the local value, go back the global value with one of
6913 these two: >
6914 setlocal sidescrolloff<
6915 setlocal sidescrolloff=-1
6916< NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006917
6918 Example: Try this together with 'sidescroll' and 'listchars' as
6919 in the following example to never allow the cursor to move
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02006920 onto the "extends" character: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006921
6922 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
6923 :set sidescrolloff=1
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02006924<
6925 *'signcolumn'* *'scl'*
6926'signcolumn' 'scl' string (default "auto")
6927 local to window
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02006928 {not available when compiled without the |+signs|
6929 feature}
Bram Moolenaar09521312016-08-12 22:54:35 +02006930 Whether or not to draw the signcolumn. Valid values are:
6931 "auto" only when there is a sign to display
6932 "no" never
6933 "yes" always
Bram Moolenaar394c5d82019-06-17 21:48:05 +02006934 "number" display signs in the 'number' column. If the number
Bram Moolenaar6c1e1572019-06-22 02:13:00 +02006935 column is not present, then behaves like "auto".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006936
6937
6938 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
6939'smartcase' 'scs' boolean (default off)
6940 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006941 Override the 'ignorecase' option if the search pattern contains upper
6942 case characters. Only used when the search pattern is typed and
6943 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarc8734422012-06-01 22:38:45 +02006944 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00006945 "*" and "#" you can make 'smartcase' used by doing a "/" command,
6946 recalling the search pattern from history and hitting <Enter>.
6947 NOTE: This option is reset when 'compatible' is set.
6948
6949 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
6950'smartindent' 'si' boolean (default off)
6951 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00006952 {not available when compiled without the
6953 |+smartindent| feature}
6954 Do smart autoindenting when starting a new line. Works for C-like
6955 programs, but can also be used for other languages. 'cindent' does
6956 something like this, works better in most cases, but is more strict,
Bram Moolenaar81af9252010-12-10 20:35:50 +01006957 see |C-indenting|. When 'cindent' is on or 'indentexpr' is set,
Bram Moolenaar166af9b2010-11-16 20:34:40 +01006958 setting 'si' has no effect. 'indentexpr' is a more advanced
6959 alternative.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006960 Normally 'autoindent' should also be on when using 'smartindent'.
6961 An indent is automatically inserted:
6962 - After a line ending in '{'.
6963 - After a line starting with a keyword from 'cinwords'.
6964 - Before a line starting with '}' (only with the "O" command).
6965 When typing '}' as the first character in a new line, that line is
6966 given the same indent as the matching '{'.
6967 When typing '#' as the first character in a new line, the indent for
6968 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006969 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00006970 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
6971 When using the ">>" command, lines starting with '#' are not shifted
6972 right.
Bram Moolenaar036986f2017-03-16 17:41:02 +01006973 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02006974 This option is reset when 'paste' is set and restored when 'paste' is
6975 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006976
6977 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
6978'smarttab' 'sta' boolean (default off)
6979 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006980 When on, a <Tab> in front of a line inserts blanks according to
Bram Moolenaar280f1262006-01-30 00:14:18 +00006981 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A
6982 <BS> will delete a 'shiftwidth' worth of space at the start of the
6983 line.
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006984 When off, a <Tab> always inserts blanks according to 'tabstop' or
Bram Moolenaar280f1262006-01-30 00:14:18 +00006985 'softtabstop'. 'shiftwidth' is only used for shifting text left or
6986 right |shift-left-right|.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00006987 What gets inserted (a <Tab> or spaces) depends on the 'expandtab'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006988 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00006989 number of spaces is minimized by using <Tab>s.
Bram Moolenaarca635012015-09-25 20:34:21 +02006990 This option is reset when 'paste' is set and restored when 'paste' is
6991 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006992 NOTE: This option is reset when 'compatible' is set.
6993
6994 *'softtabstop'* *'sts'*
6995'softtabstop' 'sts' number (default 0)
6996 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00006997 Number of spaces that a <Tab> counts for while performing editing
6998 operations, like inserting a <Tab> or using <BS>. It "feels" like
6999 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
7000 used. This is useful to keep the 'ts' setting at its standard value
7001 of 8, while being able to edit like it is set to 'sts'. However,
7002 commands like "x" still work on the actual characters.
7003 When 'sts' is zero, this feature is off.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02007004 When 'sts' is negative, the value of 'shiftwidth' is used.
Bram Moolenaarca635012015-09-25 20:34:21 +02007005 'softtabstop' is set to 0 when the 'paste' option is set and restored
7006 when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007007 See also |ins-expandtab|. When 'expandtab' is not set, the number of
7008 spaces is minimized by using <Tab>s.
7009 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
7010 set.
7011 NOTE: This option is set to 0 when 'compatible' is set.
7012
Bram Moolenaar04958cb2018-06-23 19:23:02 +02007013 If Vim is compiled with the |+vartabs| feature then the value of
7014 'softtabstop' will be ignored if |'varsofttabstop'| is set to
7015 anything other than an empty string.
7016
Bram Moolenaar217ad922005-03-20 22:37:15 +00007017 *'spell'* *'nospell'*
7018'spell' boolean (default off)
7019 local to window
Bram Moolenaar217ad922005-03-20 22:37:15 +00007020 {not available when compiled without the |+syntax|
7021 feature}
7022 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007023 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007024
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007025 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00007026'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007027 local to buffer
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007028 {not available when compiled without the |+syntax|
7029 feature}
7030 Pattern to locate the end of a sentence. The following word will be
7031 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007032 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007033 When this check is not wanted make this option empty.
7034 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00007035 Be careful with special characters, see |option-backslash| about
7036 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007037 To set this option automatically depending on the language, see
7038 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007039
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007040 *'spellfile'* *'spf'*
7041'spellfile' 'spf' string (default empty)
7042 local to buffer
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007043 {not available when compiled without the |+syntax|
7044 feature}
7045 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00007046 commands. It must end in ".{encoding}.add". You need to include the
7047 path, otherwise the file is placed in the current directory.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007048 *E765*
7049 It may also be a comma separated list of names. A count before the
7050 |zg| and |zw| commands can be used to access each. This allows using
7051 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007052 When a word is added while this option is empty Vim will set it for
Bram Moolenaar910f66f2006-04-05 20:41:53 +00007053 you: Using the first directory in 'runtimepath' that is writable. If
7054 there is no "spell" directory yet it will be created. For the file
7055 name the first language name that appears in 'spelllang' is used,
Bram Moolenaar3b506942005-06-23 22:36:45 +00007056 ignoring the region.
7057 The resulting ".spl" file will be used for spell checking, it does not
7058 have to appear in 'spelllang'.
7059 Normally one file is used for all regions, but you can add the region
7060 name if you want to. However, it will then only be used when
7061 'spellfile' is set to it, for entries in 'spelllang' only files
7062 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00007063 This option cannot be set from a |modeline| or in the |sandbox|, for
7064 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007065
Bram Moolenaar217ad922005-03-20 22:37:15 +00007066 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007067'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00007068 local to buffer
Bram Moolenaar217ad922005-03-20 22:37:15 +00007069 {not available when compiled without the |+syntax|
7070 feature}
Bram Moolenaar3b506942005-06-23 22:36:45 +00007071 A comma separated list of word list names. When the 'spell' option is
7072 on spellchecking will be done for these languages. Example: >
7073 set spelllang=en_us,nl,medical
7074< This means US English, Dutch and medical words are recognized. Words
7075 that are not recognized will be highlighted.
Bram Moolenaar911ead12019-04-21 00:03:35 +02007076 The word list name must consist of alphanumeric characters, a dash or
7077 an underscore. It should not include a comma or dot. Using a dash is
Bram Moolenaar3b506942005-06-23 22:36:45 +00007078 recommended to separate the two letter language name from a
7079 specification. Thus "en-rare" is used for rare English words.
7080 A region name must come last and have the form "_xx", where "xx" is
7081 the two-letter, lower case region name. You can use more than one
7082 region by listing them: "en_us,en_ca" supports both US and Canadian
7083 English, but not words specific for Australia, New Zealand or Great
Bram Moolenaarfa735342016-01-03 22:14:44 +01007084 Britain. (Note: currently en_au and en_nz dictionaries are older than
7085 en_ca, en_gb and en_us).
Bram Moolenaarcc63c642013-11-12 04:44:01 +01007086 If the name "cjk" is included East Asian characters are excluded from
7087 spell checking. This is useful when editing text that also has Asian
7088 words.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007089 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007090 As a special case the name of a .spl file can be given as-is. The
7091 first "_xx" in the name is removed and used as the region name
7092 (_xx is an underscore, two letters and followed by a non-letter).
7093 This is mainly for testing purposes. You must make sure the correct
7094 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007095 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007096 idea to set 'spelllang' after setting 'encoding' to avoid loading the
7097 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00007098 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007099
Bram Moolenaar98692072006-02-04 00:57:42 +00007100 If the |spellfile.vim| plugin is active and you use a language name
7101 for which Vim cannot find the .spl file in 'runtimepath' the plugin
7102 will ask you if you want to download the file.
7103
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007104 After this option has been set successfully, Vim will source the files
7105 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
Bram Moolenaarb730f0c2018-11-25 03:56:26 +01007106 up to the first character that is not an ASCII letter or number and
7107 not a dash. Also see |set-spc-auto|.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007108
Bram Moolenaar362b44b2020-06-10 21:47:00 +02007109 *'spelloptions'* *'spo'*
7110'spelloptions' 'spo' string (default "")
7111 local to buffer
7112 {not available when compiled without the |+syntax|
7113 feature}
7114 A comma separated list of options for spell checking:
7115 camel When a word is CamelCased, assume "Cased" is a
7116 separate word: every upper-case character in a word
7117 that comes after a lower case character indicates the
7118 start of a new word.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007119
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007120 *'spellsuggest'* *'sps'*
7121'spellsuggest' 'sps' string (default "best")
7122 global
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007123 {not available when compiled without the |+syntax|
7124 feature}
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007125 Methods used for spelling suggestions. Both for the |z=| command and
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007126 the |spellsuggest()| function. This is a comma-separated list of
7127 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007128
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007129 best Internal method that works best for English. Finds
7130 changes like "fast" and uses a bit of sound-a-like
7131 scoring to improve the ordering.
7132
7133 double Internal method that uses two methods and mixes the
7134 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007135 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007136 word. That only works when the language specifies
7137 sound folding. Can be slow and doesn't always give
7138 better results.
7139
7140 fast Internal method that only checks for simple changes:
7141 character inserts/deletes/swaps. Works well for
7142 simple typing mistakes.
7143
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007144 {number} The maximum number of suggestions listed for |z=|.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007145 Not used for |spellsuggest()|. The number of
7146 suggestions is never more than the value of 'lines'
7147 minus two.
7148
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007149 file:{filename} Read file {filename}, which must have two columns,
7150 separated by a slash. The first column contains the
7151 bad word, the second column the suggested good word.
7152 Example:
7153 theribal/terrible ~
7154 Use this for common mistakes that do not appear at the
7155 top of the suggestion list with the internal methods.
7156 Lines without a slash are ignored, use this for
7157 comments.
Bram Moolenaarbcb98982014-05-01 14:08:19 +02007158 The word in the second column must be correct,
7159 otherwise it will not be used. Add the word to an
7160 ".add" file if it is currently flagged as a spelling
7161 mistake.
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007162 The file is used for all languages.
7163
7164 expr:{expr} Evaluate expression {expr}. Use a function to avoid
7165 trouble with spaces. |v:val| holds the badly spelled
7166 word. The expression must evaluate to a List of
7167 Lists, each with a suggestion and a score.
7168 Example:
Bram Moolenaar214641f2017-03-05 17:04:09 +01007169 [['the', 33], ['that', 44]] ~
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007170 Set 'verbose' and use |z=| to see the scores that the
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007171 internal methods use. A lower score is better.
7172 This may invoke |spellsuggest()| if you temporarily
7173 set 'spellsuggest' to exclude the "expr:" part.
7174 Errors are silently ignored, unless you set the
7175 'verbose' option to a non-zero value.
7176
7177 Only one of "best", "double" or "fast" may be used. The others may
7178 appear several times in any order. Example: >
7179 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
7180<
7181 This option cannot be set from a |modeline| or in the |sandbox|, for
7182 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007183
7184
Bram Moolenaar071d4272004-06-13 20:20:40 +00007185 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
7186'splitbelow' 'sb' boolean (default off)
7187 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007188 When on, splitting a window will put the new window below the current
7189 one. |:split|
7190
7191 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
7192'splitright' 'spr' boolean (default off)
7193 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007194 When on, splitting a window will put the new window right of the
7195 current one. |:vsplit|
7196
7197 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
7198'startofline' 'sol' boolean (default on)
7199 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007200 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00007201 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007202 (if possible). This applies to the commands: CTRL-D, CTRL-U, CTRL-B,
Bram Moolenaar843ee412004-06-30 16:16:41 +00007203 CTRL-F, "G", "H", "M", "L", gg, and to the commands "d", "<<" and ">>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007204 with a linewise operator, with "%" with a count and to buffer changing
7205 commands (CTRL-^, :bnext, :bNext, etc.). Also for an Ex command that
7206 only has a line number, e.g., ":25" or ":+".
7207 In case of buffer changing commands the cursor is placed at the column
7208 where it was the last time the buffer was edited.
7209 NOTE: This option is set when 'compatible' is set.
7210
Bram Moolenaar00654022011-02-25 14:42:19 +01007211 *'statusline'* *'stl'* *E540* *E542*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007212'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007213 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007214 {not available when compiled without the |+statusline|
7215 feature}
7216 When nonempty, this option determines the content of the status line.
7217 Also see |status-line|.
7218
7219 The option consists of printf style '%' items interspersed with
7220 normal text. Each status line item is of the form:
7221 %-0{minwid}.{maxwid}{item}
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01007222 All fields except the {item} are optional. A single percent sign can
Bram Moolenaar00654022011-02-25 14:42:19 +01007223 be given as "%%". Up to 80 items can be specified. *E541*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007224
Bram Moolenaar238a5642006-02-21 22:12:05 +00007225 When the option starts with "%!" then it is used as an expression,
7226 evaluated and the result is used as the option value. Example: >
7227 :set statusline=%!MyStatusLine()
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02007228< The *g:statusline_winid* variable will be set to the |window-ID| of the
7229 window that the status line belongs to.
7230 The result can contain %{} items that will be evaluated too.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02007231 Note that the "%!" expression is evaluated in the context of the
7232 current window and buffer, while %{} items are evaluated in the
7233 context of the window that the statusline belongs to.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007234
7235 When there is error while evaluating the option then it will be made
7236 empty to avoid further errors. Otherwise screen updating would loop.
7237
Bram Moolenaar071d4272004-06-13 20:20:40 +00007238 Note that the only effect of 'ruler' when this option is set (and
7239 'laststatus' is 2) is controlling the output of |CTRL-G|.
7240
7241 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00007242 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00007243 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007244 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007245 minwid Minimum width of the item, padding as set by '-' & '0'.
7246 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007247 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007248 on the left for text items. Numeric items will be
7249 shifted down to maxwid-2 digits followed by '>'number
7250 where number is the amount of missing digits, much like
7251 an exponential notation.
7252 item A one letter code as described below.
7253
7254 Following is a description of the possible statusline items. The
7255 second character in "item" is the type:
7256 N for number
7257 S for string
7258 F for flags as described below
7259 - not applicable
7260
7261 item meaning ~
Bram Moolenaar02467872007-05-06 13:22:01 +00007262 f S Path to the file in the buffer, as typed or relative to current
7263 directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007264 F S Full path to the file in the buffer.
7265 t S File name (tail) of file in the buffer.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007266 m F Modified flag, text is "[+]"; "[-]" if 'modifiable' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007267 M F Modified flag, text is ",+" or ",-".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007268 r F Readonly flag, text is "[RO]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007269 R F Readonly flag, text is ",RO".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007270 h F Help buffer flag, text is "[help]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007271 H F Help buffer flag, text is ",HLP".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007272 w F Preview window flag, text is "[Preview]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007273 W F Preview window flag, text is ",PRV".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007274 y F Type of file in the buffer, e.g., "[vim]". See 'filetype'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007275 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
Bram Moolenaar7fd73202010-07-25 16:58:46 +02007276 q S "[Quickfix List]", "[Location List]" or empty.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007277 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
7278 being used: "<keymap>"
7279 n N Buffer number.
Bram Moolenaar00654022011-02-25 14:42:19 +01007280 b N Value of character under cursor.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007281 B N As above, in hexadecimal.
7282 o N Byte number in file of byte under cursor, first byte is 1.
7283 Mnemonic: Offset from start of file (with one added)
7284 {not available when compiled without |+byte_offset| feature}
7285 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007286 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007287 l N Line number.
7288 L N Number of lines in buffer.
7289 c N Column number.
7290 v N Virtual column number.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007291 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007292 p N Percentage through file in lines as in |CTRL-G|.
7293 P S Percentage through file of displayed window. This is like the
Bram Moolenaar14b69452013-06-29 23:05:20 +02007294 percentage described for 'ruler'. Always 3 in length, unless
7295 translated.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007296 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00007297 Empty if the argument file count is zero or one.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007298 { NF Evaluate expression between '%{' and '}' and substitute result.
Bram Moolenaar6d150f72018-04-21 20:03:20 +02007299 Note that there is no '%' before the closing '}'. The
7300 expression cannot contain a '}' character, call a function to
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007301 work around that. See |stl-%{| below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007302 ( - Start of item group. Can be used for setting the width and
7303 alignment of a section. Must be followed by %) somewhere.
7304 ) - End of item group. No width fields allowed.
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007305 T N For 'tabline': start of tab page N label. Use %T after the last
7306 label. This information is used for mouse clicks.
7307 X N For 'tabline': start of close tab N label. Use %X after the
7308 label, e.g.: %3Xclose%X. Use %999X for a "close current tab"
7309 mark. This information is used for mouse clicks.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007310 < - Where to truncate line if too long. Default is at the start.
7311 No width fields allowed.
7312 = - Separation point between left and right aligned items.
7313 No width fields allowed.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007314 # - Set highlight group. The name must follow and then a # again.
7315 Thus use %#HLname# for highlight group HLname. The same
7316 highlighting is used, also for the statusline of non-current
7317 windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007318 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00007319 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007320 The difference between User{N} and StatusLine will be applied
7321 to StatusLineNC for the statusline of non-current windows.
7322 The number N must be between 1 and 9. See |hl-User1..9|
7323
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007324 When displaying a flag, Vim removes the leading comma, if any, when
7325 that flag comes right after plaintext. This will make a nice display
7326 when flags are used like in the examples below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007327
Bram Moolenaar582fd852005-03-28 20:58:01 +00007328 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00007329 not set) and a minwid is not set for the group, the whole group will
7330 become empty. This will make a group like the following disappear
7331 completely from the statusline when none of the flags are set. >
7332 :set statusline=...%(\ [%M%R%H]%)...
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02007333< Beware that an expression is evaluated each and every time the status
7334 line is displayed.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007335 *stl-%{* *g:actual_curbuf* *g:actual_curwin*
Bram Moolenaarade0d392020-01-21 22:33:58 +01007336 While evaluating %{} the current buffer and current window will be set
7337 temporarily to that of the window (and buffer) whose statusline is
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007338 currently being drawn. The expression will evaluate in this context.
7339 The variable "g:actual_curbuf" is set to the `bufnr()` number of the
7340 real current buffer and "g:actual_curwin" to the |window-ID| of the
7341 real current window. These values are strings.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007342
Bram Moolenaar30b65812012-07-12 22:01:11 +02007343 The 'statusline' option will be evaluated in the |sandbox| if set from
7344 a modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02007345 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007346
7347 It is not allowed to change text or jump to another window while
7348 evaluating 'statusline' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007349
7350 If the statusline is not updated when you want it (e.g., after setting
7351 a variable that's used in an expression), you can force an update by
7352 setting an option without changing its value. Example: >
7353 :let &ro = &ro
7354
7355< A result of all digits is regarded a number for display purposes.
7356 Otherwise the result is taken as flag text and applied to the rules
7357 described above.
7358
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00007359 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00007360 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
Bram Moolenaarc4da1132017-07-15 19:39:43 +02007361 edit your .vimrc or whatever with "vim --clean" to get it right.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007362
7363 Examples:
7364 Emulate standard status line with 'ruler' set >
7365 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
7366< Similar, but add ASCII value of char under the cursor (like "ga") >
7367 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
7368< Display byte count and byte value, modified flag in red. >
7369 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
7370 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
7371< Display a ,GZ flag if a compressed file is loaded >
7372 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
7373< In the |:autocmd|'s: >
7374 :let b:gzflag = 1
7375< And: >
7376 :unlet b:gzflag
7377< And define this function: >
7378 :function VarExists(var, val)
7379 : if exists(a:var) | return a:val | else | return '' | endif
7380 :endfunction
7381<
7382 *'suffixes'* *'su'*
7383'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
7384 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007385 Files with these suffixes get a lower priority when multiple files
7386 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007387 suffixes. Spaces after the comma are ignored. A dot is also seen as
7388 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007389 separator, precede it with a backslash (see |option-backslash| about
7390 including spaces and backslashes).
7391 See 'wildignore' for completely ignoring files.
7392 The use of |:set+=| and |:set-=| is preferred when adding or removing
7393 suffixes from the list. This avoids problems when a future version
7394 uses another default.
7395
7396 *'suffixesadd'* *'sua'*
7397'suffixesadd' 'sua' string (default "")
7398 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007399 {not available when compiled without the
7400 |+file_in_path| feature}
7401 Comma separated list of suffixes, which are used when searching for a
7402 file for the "gf", "[I", etc. commands. Example: >
7403 :set suffixesadd=.java
7404<
7405 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
7406'swapfile' 'swf' boolean (default on)
7407 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007408 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007409 swapfile is not wanted for a specific buffer. For example, with
7410 confidential information that even root must not be able to access.
7411 Careful: All text will be in memory:
7412 - Don't use this for big files.
7413 - Recovery will be impossible!
7414 A swapfile will only be present when |'updatecount'| is non-zero and
7415 'swapfile' is set.
7416 When 'swapfile' is reset, the swap file for the current buffer is
7417 immediately deleted. When 'swapfile' is set, and 'updatecount' is
7418 non-zero, a swap file is immediately created.
7419 Also see |swap-file| and |'swapsync'|.
Bram Moolenaar76f3b1a2014-03-27 22:30:07 +01007420 If you want to open a new buffer without creating a swap file for it,
7421 use the |:noswapfile| modifier.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01007422 See 'directory' for where the swap file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007423
7424 This option is used together with 'bufhidden' and 'buftype' to
7425 specify special kinds of buffers. See |special-buffers|.
7426
7427 *'swapsync'* *'sws'*
7428'swapsync' 'sws' string (default "fsync")
7429 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007430 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007431 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007432 When this option is empty parts of the swap file may be in memory and
7433 not written to disk. When the system crashes you may lose more work.
7434 On Unix the system does a sync now and then without Vim asking for it,
7435 so the disadvantage of setting this option off is small. On some
7436 systems the swap file will not be written at all. For a unix system
7437 setting it to "sync" will use the sync() call instead of the default
7438 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007439 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007440
7441 *'switchbuf'* *'swb'*
7442'switchbuf' 'swb' string (default "")
7443 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007444 This option controls the behavior when switching between buffers.
7445 Possible values (comma separated list):
7446 useopen If included, jump to the first open window that
7447 contains the specified buffer (if there is one).
7448 Otherwise: Do not examine other windows.
7449 This setting is checked with |quickfix| commands, when
7450 jumping to errors (":cc", ":cn", "cp", etc.). It is
7451 also used in all buffer related split commands, for
7452 example ":sbuffer", ":sbnext", or ":sbrewind".
Bram Moolenaar779b74b2006-04-10 14:55:34 +00007453 usetab Like "useopen", but also consider windows in other tab
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00007454 pages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007455 split If included, split the current window before loading
Bram Moolenaar15146672011-10-20 22:22:38 +02007456 a buffer for a |quickfix| command that display errors.
Bram Moolenaar63b74a82019-03-24 15:09:13 +01007457 Otherwise: do not split, use current window (when used
7458 in the quickfix window: the previously used window or
7459 split if there is no other window).
Bram Moolenaara594d772015-06-19 14:41:49 +02007460 vsplit Just like "split" but split vertically.
Bram Moolenaar446cb832008-06-24 21:56:24 +00007461 newtab Like "split", but open a new tab page. Overrules
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02007462 "split" when both are present.
Bram Moolenaar539aa6b2019-11-17 18:09:38 +01007463 uselast If included, jump to the previously used window when
7464 jumping to errors with |quickfix| commands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007465
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007466 *'synmaxcol'* *'smc'*
7467'synmaxcol' 'smc' number (default 3000)
7468 local to buffer
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007469 {not available when compiled without the |+syntax|
7470 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007471 Maximum column in which to search for syntax items. In long lines the
7472 text after this column is not highlighted and following lines may not
7473 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007474 This helps to avoid very slow redrawing for an XML file that is one
7475 long line.
7476 Set to zero to remove the limit.
7477
Bram Moolenaar071d4272004-06-13 20:20:40 +00007478 *'syntax'* *'syn'*
7479'syntax' 'syn' string (default empty)
7480 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007481 {not available when compiled without the |+syntax|
7482 feature}
7483 When this option is set, the syntax with this name is loaded, unless
7484 syntax highlighting has been switched off with ":syntax off".
7485 Otherwise this option does not always reflect the current syntax (the
7486 b:current_syntax variable does).
7487 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007488 not automatically recognized. Example, in an IDL file:
7489 /* vim: set syntax=idl : */ ~
7490 When a dot appears in the value then this separates two filetype
7491 names. Example:
7492 /* vim: set syntax=c.doxygen : */ ~
7493 This will use the "c" syntax first, then the "doxygen" syntax.
7494 Note that the second one must be prepared to be loaded as an addition,
7495 otherwise it will be skipped. More than one dot may appear.
7496 To switch off syntax highlighting for the current file, use: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007497 :set syntax=OFF
7498< To switch syntax highlighting on according to the current value of the
7499 'filetype' option: >
7500 :set syntax=ON
7501< What actually happens when setting the 'syntax' option is that the
7502 Syntax autocommand event is triggered with the value as argument.
7503 This option is not copied to another buffer, independent of the 's' or
7504 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007505 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007506
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007507 *'tabline'* *'tal'*
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007508'tabline' 'tal' string (default empty)
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007509 global
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007510 When nonempty, this option determines the content of the tab pages
7511 line at the top of the Vim window. When empty Vim will use a default
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007512 tab pages line. See |setting-tabline| for more info.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007513
7514 The tab pages line only appears as specified with the 'showtabline'
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00007515 option and only when there is no GUI tab line. When 'e' is in
7516 'guioptions' and the GUI supports a tab line 'guitablabel' is used
Bram Moolenaar7f036442010-08-15 15:24:20 +02007517 instead. Note that the two tab pages lines are very different.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007518
7519 The value is evaluated like with 'statusline'. You can use
7520 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007521 the text to be displayed. Use "%1T" for the first label, "%2T" for
7522 the second one, etc. Use "%X" items for closing labels.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007523
Bram Moolenaare12bab32019-01-08 22:02:56 +01007524 When changing something that is used in 'tabline' that does not
7525 trigger it to be updated, use |:redrawtabline|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02007526 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaare12bab32019-01-08 22:02:56 +01007527
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007528 Keep in mind that only one of the tab pages is the current one, others
7529 are invisible and you can't jump to their windows.
7530
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007531
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007532 *'tabpagemax'* *'tpm'*
7533'tabpagemax' 'tpm' number (default 10)
7534 global
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007535 Maximum number of tab pages to be opened by the |-p| command line
7536 argument or the ":tab all" command. |tabpage|
7537
7538
7539 *'tabstop'* *'ts'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007540'tabstop' 'ts' number (default 8)
7541 local to buffer
7542 Number of spaces that a <Tab> in the file counts for. Also see
7543 |:retab| command, and 'softtabstop' option.
7544
7545 Note: Setting 'tabstop' to any other value than 8 can make your file
7546 appear wrong in many places (e.g., when printing it).
7547
7548 There are four main ways to use tabs in Vim:
7549 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
7550 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007551 will use a mix of tabs and spaces, but typing <Tab> and <BS> will
Bram Moolenaar071d4272004-06-13 20:20:40 +00007552 behave like a tab appears every 4 (or 3) characters.
7553 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
7554 'expandtab'. This way you will always insert spaces. The
7555 formatting will never be messed up when 'tabstop' is changed.
7556 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007557 |modeline| to set these values when editing the file again. Only
Bram Moolenaar071d4272004-06-13 20:20:40 +00007558 works when using Vim to edit the file.
7559 4. Always set 'tabstop' and 'shiftwidth' to the same value, and
7560 'noexpandtab'. This should then work (for initial indents only)
7561 for any tabstop setting that people use. It might be nice to have
7562 tabs after the first non-blank inserted as spaces if you do this
7563 though. Otherwise aligned comments will be wrong when 'tabstop' is
7564 changed.
7565
Bram Moolenaar04958cb2018-06-23 19:23:02 +02007566 If Vim is compiled with the |+vartabs| feature then the value of
7567 'tabstop' will be ignored if |'vartabstop'| is set to anything other
7568 than an empty string.
7569
Bram Moolenaar071d4272004-06-13 20:20:40 +00007570 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
7571'tagbsearch' 'tbs' boolean (default on)
7572 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007573 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007574 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00007575 searching makes searching for a tag a LOT faster, but a linear search
7576 will find more tags if the tags file wasn't properly sorted.
7577 Vim normally assumes that your tags files are sorted, or indicate that
7578 they are not sorted. Only when this is not the case does the
7579 'tagbsearch' option need to be switched off.
7580
7581 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007582 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00007583 certain files, or retry all files with a linear search. When
7584 'tagbsearch' is off, only a linear search is done.
7585
7586 Linear searching is done anyway, for one file, when Vim finds a line
7587 at the start of the file indicating that it's not sorted: >
Bram Moolenaar446cb832008-06-24 21:56:24 +00007588 !_TAG_FILE_SORTED 0 /some comment/
Bram Moolenaar071d4272004-06-13 20:20:40 +00007589< [The whitespace before and after the '0' must be a single <Tab>]
7590
7591 When a binary search was done and no match was found in any of the
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007592 files listed in 'tags', and case is ignored or a pattern is used
Bram Moolenaar071d4272004-06-13 20:20:40 +00007593 instead of a normal tag name, a retry is done with a linear search.
7594 Tags in unsorted tags files, and matches with different case will only
7595 be found in the retry.
7596
Bram Moolenaard4755bb2004-09-02 19:12:26 +00007597 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007598 linear search can be avoided when case is ignored. Use a value of '2'
7599 in the "!_TAG_FILE_SORTED" line for this. A tag file can be case-fold
7600 sorted with the -f switch to "sort" in most unices, as in the command:
7601 "sort -f -o tags tags". For "Exuberant ctags" version 5.x or higher
7602 (at least 5.5) the --sort=foldcase switch can be used for this as
7603 well. Note that case must be folded to uppercase for this to work.
7604
7605 By default, tag searches are case-sensitive. Case is ignored when
7606 'ignorecase' is set and 'tagcase' is "followic", or when 'tagcase' is
7607 "ignore".
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007608 Also when 'tagcase' is "followscs" and 'smartcase' is set, or
7609 'tagcase' is "smart", and the pattern contains only lowercase
7610 characters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007611
7612 When 'tagbsearch' is off, tags searching is slower when a full match
7613 exists, but faster when no full match exists. Tags in unsorted tags
7614 files may only be found with 'tagbsearch' off.
7615 When the tags file is not sorted, or sorted in a wrong way (not on
7616 ASCII byte value), 'tagbsearch' should be off, or the line given above
7617 must be included in the tags file.
7618 This option doesn't affect commands that find all matching tags (e.g.,
7619 command-line completion and ":help").
Bram Moolenaar071d4272004-06-13 20:20:40 +00007620
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007621 *'tagcase'* *'tc'*
7622'tagcase' 'tc' string (default "followic")
7623 global or local to buffer |global-local|
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007624 This option specifies how case is handled when searching the tags
7625 file:
7626 followic Follow the 'ignorecase' option
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007627 followscs Follow the 'smartcase' and 'ignorecase' options
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007628 ignore Ignore case
7629 match Match case
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007630 smart Ignore case unless an upper case letter is used
Bram Moolenaar036986f2017-03-16 17:41:02 +01007631 NOTE: This option is set to the Vi default value when 'compatible' is
7632 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007633
Bram Moolenaar45e18cb2019-04-28 18:05:35 +02007634 *'tagfunc'* *'tfu'*
7635'tagfunc' 'tfu' string (default: empty)
7636 local to buffer
7637 {not available when compiled without the |+eval|
7638 feature}
7639 This option specifies a function to be used to perform tag searches.
7640 The function gets the tag pattern and should return a List of matching
7641 tags. See |tag-function| for an explanation of how to write the
7642 function and an example.
7643
Bram Moolenaar071d4272004-06-13 20:20:40 +00007644 *'taglength'* *'tl'*
7645'taglength' 'tl' number (default 0)
7646 global
7647 If non-zero, tags are significant up to this number of characters.
7648
7649 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
7650'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
7651 global
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00007652 If on and using a tags file in another directory, file names in that
7653 tags file are relative to the directory where the tags file is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007654 NOTE: This option is set to the Vi default value when 'compatible' is
7655 set and to the Vim default value when 'compatible' is reset.
7656
7657 *'tags'* *'tag'* *E433*
7658'tags' 'tag' string (default "./tags,tags", when compiled with
7659 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
7660 global or local to buffer |global-local|
7661 Filenames for the tag command, separated by spaces or commas. To
7662 include a space or comma in a file name, precede it with a backslash
7663 (see |option-backslash| about including spaces and backslashes).
7664 When a file name starts with "./", the '.' is replaced with the path
7665 of the current file. But only when the 'd' flag is not included in
7666 'cpoptions'. Environment variables are expanded |:set_env|. Also see
7667 |tags-option|.
7668 "*", "**" and other wildcards can be used to search for tags files in
Bram Moolenaare2b590e2010-08-08 18:29:48 +02007669 a directory tree. See |file-searching|. E.g., "/lib/**/tags" will
7670 find all files named "tags" below "/lib". The filename itself cannot
7671 contain wildcards, it is used as-is. E.g., "/lib/**/tags?" will find
7672 files called "tags?". {not available when compiled without the
7673 |+path_extra| feature}
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00007674 The |tagfiles()| function can be used to get a list of the file names
7675 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007676 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
7677 files are also supported. They are automatically recognized. The
7678 default value becomes "./tags,./TAGS,tags,TAGS", unless case
7679 differences are ignored (MS-Windows). |emacs-tags|
7680 The use of |:set+=| and |:set-=| is preferred when adding or removing
7681 file names from the list. This avoids problems when a future version
7682 uses another default.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007683
7684 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
7685'tagstack' 'tgst' boolean (default on)
7686 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007687 When on, the |tagstack| is used normally. When off, a ":tag" or
7688 ":tselect" command with an argument will not push the tag onto the
7689 tagstack. A following ":tag" without an argument, a ":pop" command or
7690 any other command that uses the tagstack will use the unmodified
7691 tagstack, but does change the pointer to the active entry.
7692 Resetting this option is useful when using a ":tag" command in a
7693 mapping which should not change the tagstack.
7694
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007695 *'tcldll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01007696'tcldll' string (default depends on the build)
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007697 global
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007698 {only available when compiled with the |+tcl/dyn|
7699 feature}
7700 Specifies the name of the Tcl shared library. The default is
7701 DYNAMIC_TCL_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02007702 Environment variables are expanded |:set_env|.
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007703 This option cannot be set from a |modeline| or in the |sandbox|, for
7704 security reasons.
7705
Bram Moolenaar071d4272004-06-13 20:20:40 +00007706 *'term'* *E529* *E530* *E531*
7707'term' string (default is $TERM, if that fails:
7708 in the GUI: "builtin_gui"
7709 on Amiga: "amiga"
Bram Moolenaarb3f74062020-02-26 16:16:53 +01007710 on Haiku: "xterm"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007711 on Mac: "mac-ansi"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007712 on Unix: "ansi"
7713 on VMS: "ansi"
7714 on Win 32: "win32")
7715 global
7716 Name of the terminal. Used for choosing the terminal control
7717 characters. Environment variables are expanded |:set_env|.
7718 For example: >
7719 :set term=$TERM
7720< See |termcap|.
7721
7722 *'termbidi'* *'tbidi'*
7723 *'notermbidi'* *'notbidi'*
7724'termbidi' 'tbidi' boolean (default off, on for "mlterm")
7725 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007726 {only available when compiled with the |+arabic|
7727 feature}
7728 The terminal is in charge of Bi-directionality of text (as specified
7729 by Unicode). The terminal is also expected to do the required shaping
7730 that some languages (such as Arabic) require.
7731 Setting this option implies that 'rightleft' will not be set when
7732 'arabic' is set and the value of 'arabicshape' will be ignored.
7733 Note that setting 'termbidi' has the immediate effect that
7734 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
7735 This option is reset when the GUI is started.
7736 For further details see |arabic.txt|.
7737
7738 *'termencoding'* *'tenc'*
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02007739'termencoding' 'tenc' string (default ""; with GTK+ GUI: "utf-8")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007740 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007741 Encoding used for the terminal. This specifies what character
7742 encoding the keyboard produces and the display will understand. For
Bram Moolenaar3848e002016-03-19 18:42:29 +01007743 the GUI it only applies to the keyboard ('encoding' is used for the
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02007744 display).
Bram Moolenaar4b7cdca2020-01-01 16:18:38 +01007745 *E617* *E950*
Bram Moolenaar3df01732017-02-17 22:47:16 +01007746 Note: This does not apply to the GTK+ GUI. After the GUI has been
Bram Moolenaar071d4272004-06-13 20:20:40 +00007747 successfully initialized, 'termencoding' is forcibly set to "utf-8".
7748 Any attempts to set a different value will be rejected, and an error
7749 message is shown.
Bram Moolenaarac360bf2015-09-01 20:31:20 +02007750 For the Win32 GUI and console versions 'termencoding' is not used,
Bram Moolenaar071d4272004-06-13 20:20:40 +00007751 because the Win32 system always passes Unicode characters.
7752 When empty, the same encoding is used as for the 'encoding' option.
7753 This is the normal value.
7754 Not all combinations for 'termencoding' and 'encoding' are valid. See
7755 |encoding-table|.
7756 The value for this option must be supported by internal conversions or
7757 iconv(). When this is not possible no conversion will be done and you
7758 will probably experience problems with non-ASCII characters.
7759 Example: You are working with the locale set to euc-jp (Japanese) and
7760 want to edit a UTF-8 file: >
7761 :let &termencoding = &encoding
7762 :set encoding=utf-8
7763< You need to do this when your system has no locale support for UTF-8.
7764
Bram Moolenaarcafafb32018-02-22 21:07:09 +01007765 *'termguicolors'* *'tgc'* *E954*
Bram Moolenaar61be73b2016-04-29 22:59:22 +02007766'termguicolors' 'tgc' boolean (default off)
7767 global
Bram Moolenaar61be73b2016-04-29 22:59:22 +02007768 {not available when compiled without the
7769 |+termguicolors| feature}
7770 When on, uses |highlight-guifg| and |highlight-guibg| attributes in
Bram Moolenaarcafafb32018-02-22 21:07:09 +01007771 the terminal (thus using 24-bit color).
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01007772
Bram Moolenaarcafafb32018-02-22 21:07:09 +01007773 Requires a ISO-8613-3 compatible terminal. If setting this option
7774 does not work (produces a colorless UI) reading |xterm-true-color|
7775 might help.
7776
7777 For Win32 console, Windows 10 version 1703 (Creators Update) or later
7778 is required. Use this check to find out: >
7779 if has('vcon')
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01007780< This requires Vim to be built with the |+vtp| feature.
7781
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +02007782 Note that the "cterm" attributes are still used, not the "gui" ones.
Bram Moolenaar036986f2017-03-16 17:41:02 +01007783 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar61be73b2016-04-29 22:59:22 +02007784
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02007785 *'termwinkey'* *'twk'*
7786'termwinkey' 'twk' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02007787 local to window
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007788 The key that starts a CTRL-W command in a terminal window. Other keys
Bram Moolenaar74675a62017-07-15 13:53:23 +02007789 are sent to the job running in the window.
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007790 The <> notation can be used, e.g.: >
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02007791 :set termwinkey=<C-L>
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007792< The string must be one key stroke but can be multiple bytes.
7793 When not set CTRL-W is used, so that CTRL-W : gets you to the command
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02007794 line. If 'termwinkey' is set to CTRL-L then CTRL-L : gets you to the
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007795 command line.
Bram Moolenaar74675a62017-07-15 13:53:23 +02007796
Bram Moolenaar6c60f472019-04-28 16:00:35 +02007797 *'termwinscroll'* *'twsl'*
7798'termwinscroll' 'twsl' number (default 10000)
7799 local to buffer
7800 {not available when compiled without the
7801 |+terminal| feature}
7802 Number of scrollback lines to keep. When going over this limit the
7803 first 10% of the scrollback lines are deleted. This is just to reduce
7804 the memory usage. See |Terminal-Normal|.
7805
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02007806 *'termwinsize'* *'tws'*
7807'termwinsize' 'tws' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02007808 local to window
Bram Moolenaar498c2562018-04-15 23:45:15 +02007809 Size of the |terminal| window. Format: {rows}x{columns} or
7810 {rows}*{columns}.
Bram Moolenaar74675a62017-07-15 13:53:23 +02007811 - When empty the terminal gets the size from the window.
Bram Moolenaar498c2562018-04-15 23:45:15 +02007812 - When set with a "x" (e.g., "24x80") the terminal size is not
7813 adjusted to the window size. If the window is smaller only the
7814 top-left part is displayed.
7815 - When set with a "*" (e.g., "10*50") the terminal size follows the
7816 window size, but will not be smaller than the specified rows and/or
7817 columns.
7818 - When rows is zero then use the height of the window.
7819 - When columns is zero then use the width of the window.
7820 - Using "0x0" or "0*0" is the same as empty.
7821
7822 Examples:
7823 "30x0" uses 30 rows and the current window width.
7824 "20*0" uses at least 20 rows and the current window width.
7825 "0*40" uses the current window height and at least 40 columns.
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02007826 Note that the command running in the terminal window may still change
7827 the size of the terminal. In that case the Vim window will be
7828 adjusted to that size, if possible.
Bram Moolenaar74675a62017-07-15 13:53:23 +02007829
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01007830 *'termwintype'* *'twt'*
7831'termwintype' 'twt' string (default "")
7832 global
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01007833 {only available when compiled with the |terminal|
7834 feature on MS-Windows}
7835 Specify the virtual console (pty) used when opening the terminal
7836 window.
7837
7838 Possible values are:
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01007839 "" use ConPTY if it is stable, winpty otherwise
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01007840 "winpty" use winpty, fail if not supported
7841 "conpty" use |ConPTY|, fail if not supported
7842
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01007843 |ConPTY| support depends on the platform. Windows 10 October 2018
7844 Update is the first version that supports ConPTY, however it is still
7845 considered unstable. ConPTY might become stable in the next release
7846 of Windows 10. winpty support needs to be installed. If neither is
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01007847 supported then you cannot open a terminal window.
7848
Bram Moolenaar071d4272004-06-13 20:20:40 +00007849 *'terse'* *'noterse'*
7850'terse' boolean (default off)
7851 global
7852 When set: Add 's' flag to 'shortmess' option (this makes the message
7853 for a search that hits the start or end of the file not being
7854 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
7855 shortens a lot of messages}
7856
7857 *'textauto'* *'ta'* *'notextauto'* *'nota'*
7858'textauto' 'ta' boolean (Vim default: on, Vi default: off)
7859 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007860 This option is obsolete. Use 'fileformats'.
7861 For backwards compatibility, when 'textauto' is set, 'fileformats' is
7862 set to the default value for the current system. When 'textauto' is
7863 reset, 'fileformats' is made empty.
7864 NOTE: This option is set to the Vi default value when 'compatible' is
7865 set and to the Vim default value when 'compatible' is reset.
7866
7867 *'textmode'* *'tx'* *'notextmode'* *'notx'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01007868'textmode' 'tx' boolean (Win32: default on,
Bram Moolenaar071d4272004-06-13 20:20:40 +00007869 others: default off)
7870 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007871 This option is obsolete. Use 'fileformat'.
7872 For backwards compatibility, when 'textmode' is set, 'fileformat' is
7873 set to "dos". When 'textmode' is reset, 'fileformat' is set to
7874 "unix".
7875
7876 *'textwidth'* *'tw'*
7877'textwidth' 'tw' number (default 0)
7878 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007879 Maximum width of text that is being inserted. A longer line will be
7880 broken after white space to get this width. A zero value disables
Bram Moolenaarca635012015-09-25 20:34:21 +02007881 this.
7882 'textwidth' is set to 0 when the 'paste' option is set and restored
7883 when 'paste' is reset.
7884 When 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00007885 'formatoptions' and |ins-textwidth|.
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00007886 When 'formatexpr' is set it will be used to break the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007887 NOTE: This option is set to 0 when 'compatible' is set.
7888
7889 *'thesaurus'* *'tsr'*
7890'thesaurus' 'tsr' string (default "")
7891 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007892 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01007893 for thesaurus completion commands |i_CTRL-X_CTRL-T|.
7894
7895 Each line in the file should contain words with similar meaning,
7896 separated by non-keyword characters (white space is preferred).
7897 Maximum line length is 510 bytes.
7898
Bram Moolenaard47d5222018-12-09 20:43:55 +01007899 An English word list was added to this github issue:
7900 https://github.com/vim/vim/issues/629#issuecomment-443293282
7901 Unpack thesaurus_pkg.zip, put the thesaurus.txt file somewhere, e.g.
7902 ~/.vim/thesaurus/english.txt, and the 'thesaurus' option to this file
7903 name.
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01007904
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007905 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00007906 after a comma are ignored, otherwise spaces are included in the file
7907 name. See |option-backslash| about using backslashes.
7908 The use of |:set+=| and |:set-=| is preferred when adding or removing
7909 directories from the list. This avoids problems when a future version
7910 uses another default.
7911 Backticks cannot be used in this option for security reasons.
7912
7913 *'tildeop'* *'top'* *'notildeop'* *'notop'*
7914'tildeop' 'top' boolean (default off)
7915 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007916 When on: The tilde command "~" behaves like an operator.
7917 NOTE: This option is reset when 'compatible' is set.
7918
7919 *'timeout'* *'to'* *'notimeout'* *'noto'*
7920'timeout' 'to' boolean (default on)
7921 global
7922 *'ttimeout'* *'nottimeout'*
Bram Moolenaar94237492017-04-23 18:40:21 +02007923'ttimeout' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007924 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007925 These two options together determine the behavior when part of a
7926 mapped key sequence or keyboard code has been received:
7927
7928 'timeout' 'ttimeout' action ~
7929 off off do not time out
7930 on on or off time out on :mappings and key codes
7931 off on time out on key codes
7932
7933 If both options are off, Vim will wait until either the complete
7934 mapping or key sequence has been received, or it is clear that there
7935 is no mapping or key sequence for the received characters. For
7936 example: if you have mapped "vl" and Vim has received 'v', the next
7937 character is needed to see if the 'v' is followed by an 'l'.
7938 When one of the options is on, Vim will wait for about 1 second for
7939 the next character to arrive. After that the already received
7940 characters are interpreted as single characters. The waiting time can
7941 be changed with the 'timeoutlen' option.
7942 On slow terminals or very busy systems timing out may cause
7943 malfunctioning cursor keys. If both options are off, Vim waits
7944 forever after an entered <Esc> if there are key codes that start
7945 with <Esc>. You will have to type <Esc> twice. If you do not have
7946 problems with key codes, but would like to have :mapped key
7947 sequences not timing out in 1 second, set the 'ttimeout' option and
7948 reset the 'timeout' option.
7949
7950 NOTE: 'ttimeout' is reset when 'compatible' is set.
7951
7952 *'timeoutlen'* *'tm'*
7953'timeoutlen' 'tm' number (default 1000)
7954 global
Bram Moolenaar25c9c682019-05-05 18:13:34 +02007955
Bram Moolenaar071d4272004-06-13 20:20:40 +00007956 *'ttimeoutlen'* *'ttm'*
Bram Moolenaar94237492017-04-23 18:40:21 +02007957'ttimeoutlen' 'ttm' number (default -1, set to 100 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007958 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007959 The time in milliseconds that is waited for a key code or mapped key
7960 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
7961 when part of a command has been typed.
7962 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
7963 different timeout value for key codes is desired set 'ttimeoutlen' to
7964 a non-negative number.
7965
7966 ttimeoutlen mapping delay key code delay ~
7967 < 0 'timeoutlen' 'timeoutlen'
7968 >= 0 'timeoutlen' 'ttimeoutlen'
7969
7970 The timeout only happens when the 'timeout' and 'ttimeout' options
7971 tell so. A useful setting would be >
7972 :set timeout timeoutlen=3000 ttimeoutlen=100
7973< (time out on mapping after three seconds, time out on key codes after
7974 a tenth of a second).
7975
7976 *'title'* *'notitle'*
7977'title' boolean (default off, on when title can be restored)
7978 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007979 {not available when compiled without the |+title|
7980 feature}
7981 When on, the title of the window will be set to the value of
7982 'titlestring' (if it is not empty), or to:
7983 filename [+=-] (path) - VIM
7984 Where:
7985 filename the name of the file being edited
7986 - indicates the file cannot be modified, 'ma' off
7987 + indicates the file was modified
7988 = indicates the file is read-only
7989 =+ indicates the file is read-only and modified
7990 (path) is the path of the file being edited
7991 - VIM the server name |v:servername| or "VIM"
7992 Only works if the terminal supports setting window titles
7993 (currently Amiga console, Win32 console, all GUI versions and
Bram Moolenaard1caa942020-04-10 22:10:56 +02007994 terminals with a non-empty 't_ts' option - these are Unix xterm and
Bram Moolenaar071d4272004-06-13 20:20:40 +00007995 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
7996 *X11*
7997 When Vim was compiled with HAVE_X11 defined, the original title will
7998 be restored if possible. The output of ":version" will include "+X11"
7999 when HAVE_X11 was defined, otherwise it will be "-X11". This also
8000 works for the icon name |'icon'|.
8001 But: When Vim was started with the |-X| argument, restoring the title
8002 will not work (except in the GUI).
8003 If the title cannot be restored, it is set to the value of 'titleold'.
8004 You might want to restore the title outside of Vim then.
8005 When using an xterm from a remote machine you can use this command:
8006 rsh machine_name xterm -display $DISPLAY &
8007 then the WINDOWID environment variable should be inherited and the
8008 title of the window should change back to what it should be after
8009 exiting Vim.
8010
8011 *'titlelen'*
8012'titlelen' number (default 85)
8013 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008014 {not available when compiled without the |+title|
8015 feature}
8016 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008017 title. When the title is longer, only the end of the path name is
8018 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008019 Using a percentage makes this adapt to the width of the window. But
8020 it won't work perfectly, because the actual number of characters
8021 available also depends on the font used and other things in the title
8022 bar. When 'titlelen' is zero the full path is used. Otherwise,
8023 values from 1 to 30000 percent can be used.
8024 'titlelen' is also used for the 'titlestring' option.
8025
8026 *'titleold'*
8027'titleold' string (default "Thanks for flying Vim")
8028 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008029 {only available when compiled with the |+title|
8030 feature}
8031 This option will be used for the window title when exiting Vim if the
8032 original title cannot be restored. Only happens if 'title' is on or
8033 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00008034 This option cannot be set from a |modeline| or in the |sandbox|, for
8035 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008036 *'titlestring'*
8037'titlestring' string (default "")
8038 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008039 {not available when compiled without the |+title|
8040 feature}
8041 When this option is not empty, it will be used for the title of the
8042 window. This happens only when the 'title' option is on.
8043 Only works if the terminal supports setting window titles (currently
8044 Amiga console, Win32 console, all GUI versions and terminals with a
8045 non-empty 't_ts' option).
8046 When Vim was compiled with HAVE_X11 defined, the original title will
Bram Moolenaar51628222016-12-01 23:03:28 +01008047 be restored if possible, see |X11|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008048
Bram Moolenaar071d4272004-06-13 20:20:40 +00008049 When this option contains printf-style '%' items, they will be
8050 expanded according to the rules used for 'statusline'.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008051 This option cannot be set in a modeline when 'modelineexpr' is off.
8052
Bram Moolenaar071d4272004-06-13 20:20:40 +00008053 Example: >
8054 :auto BufEnter * let &titlestring = hostname() . "/" . expand("%:p")
8055 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
8056< The value of 'titlelen' is used to align items in the middle or right
8057 of the available space.
8058 Some people prefer to have the file name first: >
8059 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
8060< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008061 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00008062 separating space only when needed.
8063 NOTE: Use of special characters in 'titlestring' may cause the display
8064 to be garbled (e.g., when it contains a CR or NL character).
8065 {not available when compiled without the |+statusline| feature}
8066
8067 *'toolbar'* *'tb'*
8068'toolbar' 'tb' string (default "icons,tooltips")
8069 global
8070 {only for |+GUI_GTK|, |+GUI_Athena|, |+GUI_Motif| and
8071 |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008072 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00008073 possible values are:
8074 icons Toolbar buttons are shown with icons.
8075 text Toolbar buttons shown with text.
8076 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008077 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008078 tooltips Tooltips are active for toolbar buttons.
8079 Tooltips refer to the popup help text which appears after the mouse
8080 cursor is placed over a toolbar button for a brief moment.
8081
8082 If you want the toolbar to be shown with icons as well as text, do the
8083 following: >
8084 :set tb=icons,text
8085< Motif and Athena cannot display icons and text at the same time. They
8086 will show icons if both are requested.
8087
8088 If none of the strings specified in 'toolbar' are valid or if
8089 'toolbar' is empty, this option is ignored. If you want to disable
8090 the toolbar, you need to set the 'guioptions' option. For example: >
8091 :set guioptions-=T
8092< Also see |gui-toolbar|.
8093
8094 *'toolbariconsize'* *'tbis'*
8095'toolbariconsize' 'tbis' string (default "small")
8096 global
Bram Moolenaar3df01732017-02-17 22:47:16 +01008097 {only in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008098 Controls the size of toolbar icons. The possible values are:
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008099 tiny Use tiny icons.
8100 small Use small icons (default).
8101 medium Use medium-sized icons.
8102 large Use large icons.
8103 huge Use even larger icons.
8104 giant Use very big icons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008105 The exact dimensions in pixels of the various icon sizes depend on
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008106 the current theme. Common dimensions are giant=48x48, huge=32x32,
8107 large=24x24, medium=24x24, small=20x20 and tiny=16x16.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008108
8109 If 'toolbariconsize' is empty, the global default size as determined
8110 by user preferences or the current theme is used.
8111
8112 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
8113'ttybuiltin' 'tbi' boolean (default on)
8114 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008115 When on, the builtin termcaps are searched before the external ones.
8116 When off the builtin termcaps are searched after the external ones.
8117 When this option is changed, you should set the 'term' option next for
8118 the change to take effect, for example: >
8119 :set notbi term=$TERM
8120< See also |termcap|.
8121 Rationale: The default for this option is "on", because the builtin
8122 termcap entries are generally better (many systems contain faulty
8123 xterm entries...).
8124
8125 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
8126'ttyfast' 'tf' boolean (default off, on when 'term' is xterm, hpterm,
8127 sun-cmd, screen, rxvt, dtterm or
8128 iris-ansi; also on when running Vim in
8129 a DOS console)
8130 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008131 Indicates a fast terminal connection. More characters will be sent to
8132 the screen for redrawing, instead of using insert/delete line
8133 commands. Improves smoothness of redrawing when there are multiple
8134 windows and the terminal does not support a scrolling region.
8135 Also enables the extra writing of characters at the end of each screen
8136 line for lines that wrap. This helps when using copy/paste with the
8137 mouse in an xterm and other terminals.
8138
8139 *'ttymouse'* *'ttym'*
8140'ttymouse' 'ttym' string (default depends on 'term')
8141 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008142 {only in Unix and VMS, doesn't work in the GUI; not
8143 available when compiled without |+mouse|}
8144 Name of the terminal type for which mouse codes are to be recognized.
Bram Moolenaar2c7a7632007-05-10 18:19:11 +00008145 Currently these strings are valid:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008146 *xterm-mouse*
8147 xterm xterm-like mouse handling. The mouse generates
8148 "<Esc>[Mscr", where "scr" is three bytes:
8149 "s" = button state
8150 "c" = column plus 33
8151 "r" = row plus 33
Bram Moolenaare968e362014-05-13 20:23:24 +02008152 This only works up to 223 columns! See "dec",
8153 "urxvt", and "sgr" for solutions.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008154 xterm2 Works like "xterm", but with the xterm reporting the
8155 mouse position while the mouse is dragged. This works
8156 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00008157 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00008158 work. See below for how Vim detects this
8159 automatically.
8160 *netterm-mouse*
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008161 netterm NetTerm mouse handling. A left mouse click generates
Bram Moolenaar071d4272004-06-13 20:20:40 +00008162 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008163 for the row and column. No other mouse events are
8164 supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008165 *dec-mouse*
8166 dec DEC terminal mouse handling. The mouse generates a
8167 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00008168 This is also available for an Xterm, if it was
8169 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00008170 *jsbterm-mouse*
8171 jsbterm JSB term mouse handling.
8172 *pterm-mouse*
8173 pterm QNX pterm mouse handling.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008174 *urxvt-mouse*
8175 urxvt Mouse handling for the urxvt (rxvt-unicode) terminal.
Bram Moolenaare968e362014-05-13 20:23:24 +02008176 The mouse works only if the terminal supports this
8177 encoding style, but it does not have 223 columns limit
8178 unlike "xterm" or "xterm2".
Bram Moolenaar9b451252012-08-15 17:43:31 +02008179 *sgr-mouse*
8180 sgr Mouse handling for the terminal that emits SGR-styled
Bram Moolenaare968e362014-05-13 20:23:24 +02008181 mouse reporting. The mouse works even in columns
8182 beyond 223. This option is backward compatible with
8183 "xterm2" because it can also decode "xterm2" style
8184 mouse codes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008185
8186 The mouse handling must be enabled at compile time |+mouse_xterm|
Bram Moolenaare968e362014-05-13 20:23:24 +02008187 |+mouse_dec| |+mouse_netterm| |+mouse_jsbterm| |+mouse_urxvt|
8188 |+mouse_sgr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008189 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
8190 recognized, if enabled at compile time. DEC terminal mouse codes
8191 are recognized if enabled at compile time, and 'ttymouse' is not
Bram Moolenaare968e362014-05-13 20:23:24 +02008192 "xterm", "xterm2", "urxvt" or "sgr" (because dec mouse codes conflict
8193 with them).
Bram Moolenaar071d4272004-06-13 20:20:40 +00008194 This option is automatically set to "xterm", when the 'term' option is
Bram Moolenaar45758762016-10-12 23:08:06 +02008195 set to a name that starts with "xterm", "mlterm", "screen", "tmux",
8196 "st" (full match only), "st-" or "stterm", and 'ttymouse' is not set
8197 already.
Bram Moolenaare968e362014-05-13 20:23:24 +02008198 Additionally, if vim is compiled with the |+termresponse| feature and
8199 |t_RV| is set to the escape sequence to request the xterm version
Bram Moolenaarf8a07122019-07-01 22:06:07 +02008200 number, more intelligent detection is done.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008201 The "xterm2" value will be set if the xterm version is reported to be
Bram Moolenaard47d5222018-12-09 20:43:55 +01008202 from 95 to 276. The "sgr" value will be set if Vim detects Mac
8203 Terminal.app, iTerm2 or mintty, and when the xterm version is 277 or
8204 higher.
Bram Moolenaare968e362014-05-13 20:23:24 +02008205 If you do not want 'ttymouse' to be set to "xterm2" or "sgr"
8206 automatically, set t_RV to an empty string: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008207 :set t_RV=
8208<
8209 *'ttyscroll'* *'tsl'*
8210'ttyscroll' 'tsl' number (default 999)
8211 global
8212 Maximum number of lines to scroll the screen. If there are more lines
8213 to scroll the window is redrawn. For terminals where scrolling is
8214 very slow and redrawing is not slow this can be set to a small number,
8215 e.g., 3, to speed up displaying.
8216
8217 *'ttytype'* *'tty'*
8218'ttytype' 'tty' string (default from $TERM)
8219 global
8220 Alias for 'term', see above.
8221
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008222 *'undodir'* *'udir'*
8223'undodir' 'udir' string (default ".")
8224 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008225 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008226 List of directory names for undo files, separated with commas.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008227 See |'backupdir'| for details of the format.
Bram Moolenaar6a244fe2010-05-24 22:02:24 +02008228 "." means using the directory of the file. The undo file name for
8229 "file.txt" is ".file.txt.un~".
8230 For other directories the file name is the full path of the edited
8231 file, with path separators replaced with "%".
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008232 When writing: The first directory that exists is used. "." always
8233 works, no directories after "." will be used for writing.
8234 When reading all entries are tried to find an undo file. The first
8235 undo file that exists is used. When it cannot be read an error is
8236 given, no further entry is used.
8237 See |undo-persistence|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008238 This option cannot be set from a |modeline| or in the |sandbox|, for
8239 security reasons.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008240
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02008241 *'undofile'* *'noundofile'* *'udf'* *'noudf'*
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008242'undofile' 'udf' boolean (default off)
8243 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02008244 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008245 When on, Vim automatically saves undo history to an undo file when
8246 writing a buffer to a file, and restores undo history from the same
8247 file on buffer read.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008248 The directory where the undo file is stored is specified by 'undodir'.
8249 For more information about this feature see |undo-persistence|.
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008250 The undo file is not read when 'undoreload' causes the buffer from
8251 before a reload to be saved for undo.
Bram Moolenaar97d62492012-11-15 21:28:22 +01008252 When 'undofile' is turned off the undo file is NOT deleted.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008253 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008254
Bram Moolenaar071d4272004-06-13 20:20:40 +00008255 *'undolevels'* *'ul'*
Bram Moolenaar8024f932020-01-14 19:29:13 +01008256'undolevels' 'ul' number (default 100, 1000 for Unix, VMS and Win32)
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008257 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008258 Maximum number of changes that can be undone. Since undo information
Bram Moolenaar5be4cee2019-09-27 19:34:08 +02008259 is kept in memory, higher numbers will cause more memory to be used.
8260 Nevertheless, a single change can already use a large amount of memory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008261 Set to 0 for Vi compatibility: One level of undo and "u" undoes
8262 itself: >
8263 set ul=0
8264< But you can also get Vi compatibility by including the 'u' flag in
8265 'cpoptions', and still be able to use CTRL-R to repeat undo.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008266 Also see |undo-two-ways|.
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008267 Set to -1 for no undo at all. You might want to do this only for the
8268 current buffer: >
8269 setlocal ul=-1
Bram Moolenaar071d4272004-06-13 20:20:40 +00008270< This helps when you run out of memory for a single change.
Bram Moolenaar32efaf62014-11-05 17:02:17 +01008271
8272 The local value is set to -123456 when the global value is to be used.
8273
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008274 Also see |clear-undo|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008275
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008276 *'undoreload'* *'ur'*
8277'undoreload' 'ur' number (default 10000)
8278 global
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008279 Save the whole buffer for undo when reloading it. This applies to the
8280 ":e!" command and reloading for when the buffer changed outside of
8281 Vim. |FileChangedShell|
Bram Moolenaar24a98a02017-09-27 22:23:55 +02008282 The save only happens when this option is negative or when the number
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008283 of lines is smaller than the value of this option.
8284 Set this option to zero to disable undo for a reload.
8285
8286 When saving undo for a reload, any undo file is not read.
8287
8288 Note that this causes the whole buffer to be stored in memory. Set
8289 this option to a lower value if you run out of memory.
8290
Bram Moolenaar071d4272004-06-13 20:20:40 +00008291 *'updatecount'* *'uc'*
8292'updatecount' 'uc' number (default: 200)
8293 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008294 After typing this many characters the swap file will be written to
8295 disk. When zero, no swap file will be created at all (see chapter on
8296 recovery |crash-recovery|). 'updatecount' is set to zero by starting
8297 Vim with the "-n" option, see |startup|. When editing in readonly
8298 mode this option will be initialized to 10000.
8299 The swapfile can be disabled per buffer with |'swapfile'|.
8300 When 'updatecount' is set from zero to non-zero, swap files are
8301 created for all buffers that have 'swapfile' set. When 'updatecount'
8302 is set to zero, existing swap files are not deleted.
8303 Also see |'swapsync'|.
8304 This option has no meaning in buffers where |'buftype'| is "nofile"
8305 or "nowrite".
8306
8307 *'updatetime'* *'ut'*
8308'updatetime' 'ut' number (default 4000)
8309 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008310 If this many milliseconds nothing is typed the swap file will be
8311 written to disk (see |crash-recovery|). Also used for the
8312 |CursorHold| autocommand event.
8313
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008314 *'varsofttabstop'* *'vsts'*
8315'varsofttabstop' 'vsts' string (default "")
8316 local to buffer
8317 {only available when compiled with the |+vartabs|
8318 feature}
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008319 A list of the number of spaces that a <Tab> counts for while editing,
8320 such as inserting a <Tab> or using <BS>. It "feels" like variable-
8321 width <Tab>s are being inserted, while in fact a mixture of spaces
8322 and <Tab>s is used. Tab widths are separated with commas, with the
8323 final value applying to all subsequent tabs.
8324
8325 For example, when editing assembly language files where statements
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02008326 start in the 9th column and comments in the 41st, it may be useful
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008327 to use the following: >
8328 :set varsofttabstop=8,32,8
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02008329< This will set soft tabstops with 8 and 8 + 32 spaces, and 8 more
8330 for every column thereafter.
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008331
8332 Note that the value of |'softtabstop'| will be ignored while
8333 'varsofttabstop' is set.
8334
8335 *'vartabstop'* *'vts'*
8336'vartabstop' 'vts' string (default "")
8337 local to buffer
8338 {only available when compiled with the |+vartabs|
8339 feature}
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008340 A list of the number of spaces that a <Tab> in the file counts for,
8341 separated by commas. Each value corresponds to one tab, with the
8342 final value applying to all subsequent tabs. For example: >
8343 :set vartabstop=4,20,10,8
8344< This will make the first tab 4 spaces wide, the second 20 spaces,
8345 the third 10 spaces, and all following tabs 8 spaces.
8346
8347 Note that the value of |'tabstop'| will be ignored while 'vartabstop'
8348 is set.
8349
Bram Moolenaar071d4272004-06-13 20:20:40 +00008350 *'verbose'* *'vbs'*
8351'verbose' 'vbs' number (default 0)
8352 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008353 When bigger than zero, Vim will give messages about what it is doing.
8354 Currently, these messages are given:
8355 >= 1 When the viminfo file is read or written.
8356 >= 2 When a file is ":source"'ed.
Bram Moolenaar647a5302020-05-03 17:01:24 +02008357 >= 4 Shell commands.
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008358 >= 5 Every searched tags file and include file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008359 >= 8 Files for which a group of autocommands is executed.
8360 >= 9 Every executed autocommand.
Bram Moolenaar647a5302020-05-03 17:01:24 +02008361 >= 11 Finding items in a path
Bram Moolenaar071d4272004-06-13 20:20:40 +00008362 >= 12 Every executed function.
8363 >= 13 When an exception is thrown, caught, finished, or discarded.
8364 >= 14 Anything pending in a ":finally" clause.
Bram Moolenaar823654b2020-05-29 23:03:09 +02008365 >= 15 Every executed Ex command from a script (truncated at 200
8366 characters).
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02008367 >= 16 Every executed Ex command.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008368
8369 This option can also be set with the "-V" argument. See |-V|.
8370 This option is also set by the |:verbose| command.
8371
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008372 When the 'verbosefile' option is set then the verbose messages are not
8373 displayed.
8374
8375 *'verbosefile'* *'vfile'*
8376'verbosefile' 'vfile' string (default empty)
8377 global
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008378 When not empty all messages are written in a file with this name.
8379 When the file exists messages are appended.
8380 Writing to the file ends when Vim exits or when 'verbosefile' is made
Bram Moolenaar80794b12010-06-13 05:20:42 +02008381 empty. Writes are buffered, thus may not show up for some time.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008382 Setting 'verbosefile' to a new value is like making it empty first.
8383 The difference with |:redir| is that verbose messages are not
8384 displayed when 'verbosefile' is set.
8385
Bram Moolenaar071d4272004-06-13 20:20:40 +00008386 *'viewdir'* *'vdir'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008387'viewdir' 'vdir' string (default for Amiga and Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008388 "$VIM/vimfiles/view",
8389 for Unix: "~/.vim/view",
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02008390 for macOS: "$VIM:vimfiles:view"
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01008391 for VMS: "sys$login:vimfiles/view")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008392 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008393 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008394 feature}
8395 Name of the directory where to store files for |:mkview|.
8396 This option cannot be set from a |modeline| or in the |sandbox|, for
8397 security reasons.
8398
8399 *'viewoptions'* *'vop'*
Bram Moolenaar13e90412017-11-11 18:16:48 +01008400'viewoptions' 'vop' string (default: "folds,options,cursor,curdir")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008401 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008402 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008403 feature}
8404 Changes the effect of the |:mkview| command. It is a comma separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008405 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008406 word save and restore ~
8407 cursor cursor position in file and in window
8408 folds manually created folds, opened/closed folds and local
8409 fold options
8410 options options and mappings local to a window or buffer (not
8411 global values for local options)
Bram Moolenaar6e932462014-09-09 18:48:09 +02008412 localoptions same as "options"
Bram Moolenaar071d4272004-06-13 20:20:40 +00008413 slash backslashes in file names replaced with forward
8414 slashes
8415 unix with Unix end-of-line format (single <NL>), even when
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008416 on MS-Windows
Bram Moolenaar13e90412017-11-11 18:16:48 +01008417 curdir the window-local directory, if set with `:lcd`
Bram Moolenaar071d4272004-06-13 20:20:40 +00008418
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008419 "slash" and "unix" are useful on MS-Windows when sharing view files
Bram Moolenaar071d4272004-06-13 20:20:40 +00008420 with Unix. The Unix version of Vim cannot source dos format scripts,
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008421 but the MS-Windows version of Vim can source unix format scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008422
8423 *'viminfo'* *'vi'* *E526* *E527* *E528*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008424'viminfo' 'vi' string (Vi default: "", Vim default for
8425 MS-Windows: '100,<50,s10,h,rA:,rB:,
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01008426 for Amiga: '100,<50,s10,h,rdf0:,rdf1:,rdf2:
8427 for others: '100,<50,s10,h)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008428 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008429 {not available when compiled without the |+viminfo|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008430 feature}
8431 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008432 when exiting Vim (see |viminfo-file|). Except when 'viminfofile' is
8433 "NONE".
8434 The string should be a comma separated list of parameters, each
8435 consisting of a single character identifying the particular parameter,
8436 followed by a number or string which specifies the value of that
8437 parameter. If a particular character is left out, then the default
8438 value is used for that parameter. The following is a list of the
8439 identifying characters and the effect of their value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008440 CHAR VALUE ~
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008441 *viminfo-!*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008442 ! When included, save and restore global variables that start
8443 with an uppercase letter, and don't contain a lowercase
8444 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar680eeca2010-10-20 17:44:42 +02008445 and "_K_L_M" are not. Nested List and Dict items may not be
Bram Moolenaar166af9b2010-11-16 20:34:40 +01008446 read back correctly, you end up with an empty item.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008447 *viminfo-quote*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008448 " Maximum number of lines saved for each register. Old name of
8449 the '<' item, with the disadvantage that you need to put a
8450 backslash before the ", otherwise it will be recognized as the
8451 start of a comment!
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008452 *viminfo-%*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008453 % When included, save and restore the buffer list. If Vim is
8454 started with a file name argument, the buffer list is not
8455 restored. If Vim is started without a file name argument, the
Bram Moolenaard042dc82015-11-24 19:18:36 +01008456 buffer list is restored from the viminfo file. Quickfix
8457 ('buftype'), unlisted ('buflisted'), unnamed and buffers on
8458 removable media (|viminfo-r|) are not saved.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00008459 When followed by a number, the number specifies the maximum
8460 number of buffers that are stored. Without a number all
8461 buffers are stored.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008462 *viminfo-'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008463 ' Maximum number of previously edited files for which the marks
8464 are remembered. This parameter must always be included when
8465 'viminfo' is non-empty.
8466 Including this item also means that the |jumplist| and the
8467 |changelist| are stored in the viminfo file.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008468 *viminfo-/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008469 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008470 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00008471 patterns are also saved. When not included, the value of
8472 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008473 *viminfo-:*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008474 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008475 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008476 *viminfo-<*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008477 < Maximum number of lines saved for each register. If zero then
8478 registers are not saved. When not included, all lines are
8479 saved. '"' is the old name for this item.
8480 Also see the 's' item below: limit specified in Kbyte.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008481 *viminfo-@*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008482 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008483 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008484 *viminfo-c*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008485 c When included, convert the text in the viminfo file from the
8486 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00008487 'encoding'. See |viminfo-encoding|.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008488 *viminfo-f*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008489 f Whether file marks need to be stored. If zero, file marks ('0
8490 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008491 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00008492 cursor position (when exiting or when doing ":wviminfo").
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008493 *viminfo-h*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008494 h Disable the effect of 'hlsearch' when loading the viminfo
8495 file. When not included, it depends on whether ":nohlsearch"
8496 has been used since the last search command.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008497 *viminfo-n*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008498 n Name of the viminfo file. The name must immediately follow
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008499 the 'n'. Must be at the end of the option! If the
8500 'viminfofile' option is set, that file name overrides the one
8501 given here with 'viminfo'. Environment variables are
Bram Moolenaar063b9d12016-07-09 20:21:48 +02008502 expanded when opening the file, not when setting the option.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008503 *viminfo-r*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008504 r Removable media. The argument is a string (up to the next
8505 ','). This parameter can be given several times. Each
8506 specifies the start of a path for which no marks will be
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01008507 stored. This is to avoid removable media. For MS-Windows you
Bram Moolenaar071d4272004-06-13 20:20:40 +00008508 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
8509 also use it for temp files, e.g., for Unix: "r/tmp". Case is
8510 ignored. Maximum length of each 'r' argument is 50
8511 characters.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008512 *viminfo-s*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008513 s Maximum size of an item in Kbyte. If zero then registers are
8514 not saved. Currently only applies to registers. The default
8515 "s10" will exclude registers with more than 10 Kbyte of text.
8516 Also see the '<' item above: line count limit.
8517
8518 Example: >
8519 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
8520<
8521 '50 Marks will be remembered for the last 50 files you
8522 edited.
8523 <1000 Contents of registers (up to 1000 lines each) will be
8524 remembered.
8525 s100 Registers with more than 100 Kbyte text are skipped.
8526 :0 Command-line history will not be saved.
8527 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
8528 no / Since '/' is not specified, the default will be used,
8529 that is, save all of the search history, and also the
8530 previous search and substitute patterns.
8531 no % The buffer list will not be saved nor read back.
8532 no h 'hlsearch' highlighting will be restored.
8533
8534 When setting 'viminfo' from an empty value you can use |:rviminfo| to
8535 load the contents of the file, this is not done automatically.
8536
8537 This option cannot be set from a |modeline| or in the |sandbox|, for
8538 security reasons.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008539 NOTE: This option is set to the Vim default value when 'compatible'
8540 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008541
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008542 *'viminfofile'* *'vif'*
8543'viminfofile' 'vif' string (default: "")
8544 global
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008545 {not available when compiled without the |+viminfo|
8546 feature}
8547 When non-empty, overrides the file name used for viminfo.
8548 When equal to "NONE" no viminfo file will be read or written.
8549 This option can be set with the |-i| command line flag. The |--clean|
8550 command line flag sets it to "NONE".
Bram Moolenaar110289e2019-05-23 15:38:06 +02008551 This option cannot be set from a |modeline| or in the |sandbox|, for
8552 security reasons.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008553
Bram Moolenaar071d4272004-06-13 20:20:40 +00008554 *'virtualedit'* *'ve'*
8555'virtualedit' 've' string (default "")
8556 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008557 A comma separated list of these words:
8558 block Allow virtual editing in Visual block mode.
8559 insert Allow virtual editing in Insert mode.
8560 all Allow virtual editing in all modes.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008561 onemore Allow the cursor to move just past the end of the line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008562
Bram Moolenaar071d4272004-06-13 20:20:40 +00008563 Virtual editing means that the cursor can be positioned where there is
Bram Moolenaarebcbd022007-05-12 14:28:25 +00008564 no actual character. This can be halfway into a tab or beyond the end
Bram Moolenaar071d4272004-06-13 20:20:40 +00008565 of the line. Useful for selecting a rectangle in Visual mode and
8566 editing a table.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008567 "onemore" is not the same, it will only allow moving the cursor just
8568 after the last character of the line. This makes some commands more
8569 consistent. Previously the cursor was always past the end of the line
8570 if the line was empty. But it is far from Vi compatible. It may also
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008571 break some plugins or Vim scripts. For example because |l| can move
8572 the cursor after the last character. Use with care!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02008573 Using the `$` command will move to the last character in the line, not
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008574 past it. This may actually move the cursor to the left!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02008575 The `g$` command will move to the end of the screen line.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008576 It doesn't make sense to combine "all" with "onemore", but you will
8577 not get a warning for it.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008578 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008579
8580 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
8581'visualbell' 'vb' boolean (default off)
8582 global
Bram Moolenaar74675a62017-07-15 13:53:23 +02008583 Use a visual bell instead of beeping. The terminal code to display the
Bram Moolenaar071d4272004-06-13 20:20:40 +00008584 visual bell is given with 't_vb'. When no beep or flash is wanted,
Bram Moolenaar74675a62017-07-15 13:53:23 +02008585 use: >
8586 :set vb t_vb=
8587< If you want a short flash, you can use this on many terminals: >
8588 :set vb t_vb=[?5h$<100>[?5l
8589< Here $<100> specifies the time, you can use a smaller or bigger value
8590 to get a shorter or longer flash.
8591
8592 Note: Vim will limit the bell to once per half a second. This avoids
8593 having to wait for the flashing to finish when there are lots of
8594 bells, e.g. on key repeat. This also happens without 'visualbell'
8595 set.
8596
Bram Moolenaar071d4272004-06-13 20:20:40 +00008597 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
8598 for 20 msec. If you want to use a different time, use "<Esc>|40f",
8599 where 40 is the time in msec.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008600
8601 Note: When the GUI starts, 't_vb' is reset to its default value. You
8602 might want to set it again in your |gvimrc|.
8603
Bram Moolenaar071d4272004-06-13 20:20:40 +00008604 Does not work on the Amiga, you always get a screen flash.
8605 Also see 'errorbells'.
8606
8607 *'warn'* *'nowarn'*
8608'warn' boolean (default on)
8609 global
8610 Give a warning message when a shell command is used while the buffer
8611 has been changed.
8612
8613 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
8614'weirdinvert' 'wiv' boolean (default off)
8615 global
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00008616 This option has the same effect as the 't_xs' terminal option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008617 It is provided for backwards compatibility with version 4.x.
8618 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
8619 vice versa. Has no effect when the GUI is running.
8620
8621 *'whichwrap'* *'ww'*
8622'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
8623 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008624 Allow specified keys that move the cursor left/right to move to the
8625 previous/next line when the cursor is on the first/last character in
8626 the line. Concatenate characters to allow this for these keys:
8627 char key mode ~
8628 b <BS> Normal and Visual
8629 s <Space> Normal and Visual
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008630 h "h" Normal and Visual (not recommended)
8631 l "l" Normal and Visual (not recommended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008632 < <Left> Normal and Visual
8633 > <Right> Normal and Visual
8634 ~ "~" Normal
8635 [ <Left> Insert and Replace
8636 ] <Right> Insert and Replace
8637 For example: >
8638 :set ww=<,>,[,]
8639< allows wrap only when cursor keys are used.
8640 When the movement keys are used in combination with a delete or change
8641 operator, the <EOL> also counts for a character. This makes "3h"
8642 different from "3dh" when the cursor crosses the end of a line. This
8643 is also true for "x" and "X", because they do the same as "dl" and
8644 "dh". If you use this, you may also want to use the mapping
8645 ":map <BS> X" to make backspace delete the character in front of the
8646 cursor.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00008647 When 'l' is included and it is used after an operator at the end of a
Bram Moolenaar589edb32019-09-20 14:38:13 +02008648 line (not an empty line) then it will not move to the next line. This
8649 makes "dl", "cl", "yl" etc. work normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008650 NOTE: This option is set to the Vi default value when 'compatible' is
8651 set and to the Vim default value when 'compatible' is reset.
8652
8653 *'wildchar'* *'wc'*
8654'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
8655 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008656 Character you have to type to start wildcard expansion in the
8657 command-line, as specified with 'wildmode'.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008658 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008659 The character is not recognized when used inside a macro. See
8660 'wildcharm' for that.
8661 Although 'wc' is a number option, you can set it to a special key: >
8662 :set wc=<Esc>
8663< NOTE: This option is set to the Vi default value when 'compatible' is
8664 set and to the Vim default value when 'compatible' is reset.
8665
8666 *'wildcharm'* *'wcm'*
8667'wildcharm' 'wcm' number (default: none (0))
8668 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008669 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00008670 recognized when used inside a macro. You can find "spare" command-line
8671 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00008672 you'll never actually type 'wildcharm', just use it in mappings that
8673 automatically invoke completion mode, e.g.: >
8674 :set wcm=<C-Z>
Bram Moolenaar446cb832008-06-24 21:56:24 +00008675 :cnoremap ss so $vim/sessions/*.vim<C-Z>
Bram Moolenaar071d4272004-06-13 20:20:40 +00008676< Then after typing :ss you can use CTRL-P & CTRL-N.
8677
8678 *'wildignore'* *'wig'*
8679'wildignore' 'wig' string (default "")
8680 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008681 {not available when compiled without the |+wildignore|
8682 feature}
8683 A list of file patterns. A file that matches with one of these
Bram Moolenaar30b65812012-07-12 22:01:11 +02008684 patterns is ignored when expanding |wildcards|, completing file or
8685 directory names, and influences the result of |expand()|, |glob()| and
8686 |globpath()| unless a flag is passed to disable this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008687 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
8688 Also see 'suffixes'.
8689 Example: >
8690 :set wildignore=*.o,*.obj
8691< The use of |:set+=| and |:set-=| is preferred when adding or removing
8692 a pattern from the list. This avoids problems when a future version
8693 uses another default.
8694
Bram Moolenaar94950a92010-12-02 16:01:29 +01008695
Bram Moolenaar81af9252010-12-10 20:35:50 +01008696 *'wildignorecase'* *'wic'* *'nowildignorecase'* *'nowic'*
Bram Moolenaar94950a92010-12-02 16:01:29 +01008697'wildignorecase' 'wic' boolean (default off)
8698 global
Bram Moolenaar94950a92010-12-02 16:01:29 +01008699 When set case is ignored when completing file names and directories.
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01008700 Has no effect when 'fileignorecase' is set.
Bram Moolenaar94950a92010-12-02 16:01:29 +01008701 Does not apply when the shell is used to expand wildcards, which
8702 happens when there are special characters.
8703
8704
Bram Moolenaar071d4272004-06-13 20:20:40 +00008705 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02008706'wildmenu' 'wmnu' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008707 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008708 {not available if compiled without the |+wildmenu|
8709 feature}
8710 When 'wildmenu' is on, command-line completion operates in an enhanced
8711 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
8712 the possible matches are shown just above the command line, with the
8713 first match highlighted (overwriting the status line, if there is
8714 one). Keys that show the previous/next match, such as <Tab> or
8715 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
8716 When 'wildmode' is used, "wildmenu" mode is used where "full" is
8717 specified. "longest" and "list" do not start "wildmenu" mode.
Bram Moolenaar26402cb2013-02-20 21:26:00 +01008718 You can check the current mode with |wildmenumode()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008719 If there are more matches than can fit in the line, a ">" is shown on
8720 the right and/or a "<" is shown on the left. The status line scrolls
8721 as needed.
8722 The "wildmenu" mode is abandoned when a key is hit that is not used
8723 for selecting a completion.
8724 While the "wildmenu" is active the following keys have special
8725 meanings:
8726
8727 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
8728 <Down> - in filename/menu name completion: move into a
8729 subdirectory or submenu.
8730 <CR> - in menu completion, when the cursor is just after a
8731 dot: move into a submenu.
8732 <Up> - in filename/menu name completion: move up into
8733 parent directory or parent menu.
8734
8735 This makes the menus accessible from the console |console-menus|.
8736
8737 If you prefer the <Left> and <Right> keys to move the cursor instead
8738 of selecting a different match, use this: >
8739 :cnoremap <Left> <Space><BS><Left>
8740 :cnoremap <Right> <Space><BS><Right>
8741<
8742 The "WildMenu" highlighting is used for displaying the current match
8743 |hl-WildMenu|.
8744
8745 *'wildmode'* *'wim'*
8746'wildmode' 'wim' string (Vim default: "full")
8747 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008748 Completion mode that is used for the character specified with
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008749 'wildchar'. It is a comma separated list of up to four parts. Each
Bram Moolenaar02467872007-05-06 13:22:01 +00008750 part specifies what to do for each consecutive use of 'wildchar'. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00008751 first part specifies the behavior for the first use of 'wildchar',
8752 The second part for the second use, etc.
8753 These are the possible values for each part:
8754 "" Complete only the first match.
8755 "full" Complete the next full match. After the last match,
8756 the original string is used and then the first match
8757 again.
8758 "longest" Complete till longest common string. If this doesn't
8759 result in a longer string, use the next part.
8760 "longest:full" Like "longest", but also start 'wildmenu' if it is
8761 enabled.
8762 "list" When more than one match, list all matches.
8763 "list:full" When more than one match, list all matches and
8764 complete first match.
8765 "list:longest" When more than one match, list all matches and
8766 complete till longest common string.
Bram Moolenaar52410572019-10-27 05:12:45 +01008767 "list:lastused" When more than one buffer matches, sort buffers
8768 by time last used (other than the current buffer).
Bram Moolenaar071d4272004-06-13 20:20:40 +00008769 When there is only a single match, it is fully completed in all cases.
8770
8771 Examples: >
8772 :set wildmode=full
Bram Moolenaar582fd852005-03-28 20:58:01 +00008773< Complete first full match, next match, etc. (the default) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008774 :set wildmode=longest,full
8775< Complete longest common string, then each full match >
8776 :set wildmode=list:full
8777< List all matches and complete each full match >
8778 :set wildmode=list,full
8779< List all matches without completing, then each full match >
8780 :set wildmode=longest,list
8781< Complete longest common string, then list alternatives.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008782 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008783
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00008784 *'wildoptions'* *'wop'*
8785'wildoptions' 'wop' string (default "")
8786 global
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00008787 {not available when compiled without the |+wildignore|
8788 feature}
8789 A list of words that change how command line completion is done.
8790 Currently only one word is allowed:
8791 tagfile When using CTRL-D to list matching tags, the kind of
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00008792 tag and the file of the tag is listed. Only one match
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00008793 is displayed per line. Often used tag kinds are:
8794 d #define
8795 f function
8796 Also see |cmdline-completion|.
8797
Bram Moolenaar071d4272004-06-13 20:20:40 +00008798 *'winaltkeys'* *'wak'*
8799'winaltkeys' 'wak' string (default "menu")
8800 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008801 {only used in Win32, Motif, GTK and Photon GUI}
8802 Some GUI versions allow the access to menu entries by using the ALT
8803 key in combination with a character that appears underlined in the
8804 menu. This conflicts with the use of the ALT key for mappings and
8805 entering special characters. This option tells what to do:
8806 no Don't use ALT keys for menus. ALT key combinations can be
8807 mapped, but there is no automatic handling. This can then be
8808 done with the |:simalt| command.
8809 yes ALT key handling is done by the windowing system. ALT key
8810 combinations cannot be mapped.
8811 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008812 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00008813 keys can be mapped.
8814 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
8815 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00008816 This option is not used for <F10>; on Win32 and with GTK <F10> will
8817 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008818
Bram Moolenaar4d784b22019-05-25 19:51:39 +02008819 *'wincolor'* *'wcr'*
8820'wincolor' 'wcr' string (default empty)
8821 local to window
8822 Highlight group name to use for this window instead of the Normal
8823 color |hl-Normal|.
8824
Bram Moolenaar4399ef42005-02-12 14:29:27 +00008825 *'window'* *'wi'*
8826'window' 'wi' number (default screen height - 1)
8827 global
8828 Window height. Do not confuse this with the height of the Vim window,
8829 use 'lines' for that.
Bram Moolenaar19a09a12005-03-04 23:39:37 +00008830 Used for |CTRL-F| and |CTRL-B| when there is only one window and the
8831 value is smaller than 'lines' minus one. The screen will scroll
8832 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00008833 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
8834 in a much smarter way, taking care of wrapping lines.
8835 When resizing the Vim window, the value is smaller than 1 or more than
8836 or equal to 'lines' it will be set to 'lines' minus 1.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00008837
Bram Moolenaar071d4272004-06-13 20:20:40 +00008838 *'winheight'* *'wh'* *E591*
8839'winheight' 'wh' number (default 1)
8840 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008841 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008842 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar446cb832008-06-24 21:56:24 +00008843 focus goes to a window that is smaller, its size is increased, at the
8844 cost of the height of other windows.
8845 Set 'winheight' to a small number for normal editing.
8846 Set it to 999 to make the current window fill most of the screen.
8847 Other windows will be only 'winminheight' high. This has the drawback
8848 that ":all" will create only two windows. To avoid "vim -o 1 2 3 4"
8849 to create only two windows, set the option after startup is done,
8850 using the |VimEnter| event: >
8851 au VimEnter * set winheight=999
8852< Minimum value is 1.
8853 The height is not adjusted after one of the commands that change the
Bram Moolenaar071d4272004-06-13 20:20:40 +00008854 height of the current window.
8855 'winheight' applies to the current window. Use 'winminheight' to set
8856 the minimal height for other windows.
8857
8858 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
8859'winfixheight' 'wfh' boolean (default off)
8860 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00008861 Keep the window height when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00008862 'equalalways' is set. Also for |CTRL-W_=|. Set by default for the
8863 |preview-window| and |quickfix-window|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008864 The height may be changed anyway when running out of room.
8865
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008866 *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'*
8867'winfixwidth' 'wfw' boolean (default off)
8868 local to window
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008869 Keep the window width when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00008870 'equalalways' is set. Also for |CTRL-W_=|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008871 The width may be changed anyway when running out of room.
8872
Bram Moolenaar071d4272004-06-13 20:20:40 +00008873 *'winminheight'* *'wmh'*
8874'winminheight' 'wmh' number (default 1)
8875 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008876 The minimal height of a window, when it's not the current window.
8877 This is a hard minimum, windows will never become smaller.
8878 When set to zero, windows may be "squashed" to zero lines (i.e. just a
8879 status bar) if necessary. They will return to at least one line when
8880 they become active (since the cursor has to have somewhere to go.)
8881 Use 'winheight' to set the minimal height of the current window.
8882 This option is only checked when making a window smaller. Don't use a
8883 large number, it will cause errors when opening more than a few
8884 windows. A value of 0 to 3 is reasonable.
8885
8886 *'winminwidth'* *'wmw'*
8887'winminwidth' 'wmw' number (default 1)
8888 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008889 The minimal width of a window, when it's not the current window.
8890 This is a hard minimum, windows will never become smaller.
8891 When set to zero, windows may be "squashed" to zero columns (i.e. just
8892 a vertical separator) if necessary. They will return to at least one
8893 line when they become active (since the cursor has to have somewhere
8894 to go.)
8895 Use 'winwidth' to set the minimal width of the current window.
8896 This option is only checked when making a window smaller. Don't use a
8897 large number, it will cause errors when opening more than a few
8898 windows. A value of 0 to 12 is reasonable.
8899
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02008900 *'winptydll'*
8901'winptydll' string (default "winpty32.dll" or "winpty64.dll")
8902 global
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02008903 {only available when compiled with the |terminal|
8904 feature on MS-Windows}
8905 Specifies the name of the winpty shared library, used for the
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02008906 |:terminal| command. The default depends on whether Vim was built as a
Bram Moolenaarc572da52017-08-27 16:52:01 +02008907 32-bit or 64-bit executable. If not found, "winpty.dll" is tried as
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02008908 a fallback.
8909 Environment variables are expanded |:set_env|.
8910 This option cannot be set from a |modeline| or in the |sandbox|, for
8911 security reasons.
8912
Bram Moolenaar071d4272004-06-13 20:20:40 +00008913 *'winwidth'* *'wiw'* *E592*
8914'winwidth' 'wiw' number (default 20)
8915 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008916 Minimal number of columns for the current window. This is not a hard
8917 minimum, Vim will use fewer columns if there is not enough room. If
8918 the current window is smaller, its size is increased, at the cost of
8919 the width of other windows. Set it to 999 to make the current window
8920 always fill the screen. Set it to a small number for normal editing.
8921 The width is not adjusted after one of the commands to change the
8922 width of the current window.
8923 'winwidth' applies to the current window. Use 'winminwidth' to set
8924 the minimal width for other windows.
8925
8926 *'wrap'* *'nowrap'*
8927'wrap' boolean (default on)
8928 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00008929 This option changes how text is displayed. It doesn't change the text
8930 in the buffer, see 'textwidth' for that.
8931 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008932 displaying continues on the next line. When off lines will not wrap
8933 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00008934 moved to a part that is not shown, the screen will scroll
8935 horizontally.
8936 The line will be broken in the middle of a word if necessary. See
8937 'linebreak' to get the break at a word boundary.
8938 To make scrolling horizontally a bit more useful, try this: >
8939 :set sidescroll=5
8940 :set listchars+=precedes:<,extends:>
8941< See 'sidescroll', 'listchars' and |wrap-off|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01008942 This option can't be set from a |modeline| when the 'diff' option is
8943 on.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008944
8945 *'wrapmargin'* *'wm'*
8946'wrapmargin' 'wm' number (default 0)
8947 local to buffer
8948 Number of characters from the right window border where wrapping
8949 starts. When typing text beyond this limit, an <EOL> will be inserted
8950 and inserting continues on the next line.
8951 Options that add a margin, such as 'number' and 'foldcolumn', cause
8952 the text width to be further reduced. This is Vi compatible.
8953 When 'textwidth' is non-zero, this option is not used.
Bram Moolenaarca635012015-09-25 20:34:21 +02008954 This option is set to 0 when 'paste' is set and restored when 'paste'
8955 is reset.
Bram Moolenaara6c27c42019-05-09 19:16:22 +02008956 See also 'formatoptions' and |ins-textwidth|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008957
8958 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
8959'wrapscan' 'ws' boolean (default on) *E384* *E385*
8960 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00008961 Searches wrap around the end of the file. Also applies to |]s| and
8962 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008963
8964 *'write'* *'nowrite'*
8965'write' boolean (default on)
8966 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008967 Allows writing files. When not set, writing a file is not allowed.
8968 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008969 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00008970 argument. Filtering text is still possible, even though this requires
8971 writing a temporary file.
8972
8973 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
8974'writeany' 'wa' boolean (default off)
8975 global
8976 Allows writing to any file with no need for "!" override.
8977
8978 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
8979'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
8980 otherwise)
8981 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008982 Make a backup before overwriting a file. The backup is removed after
8983 the file was successfully written, unless the 'backup' option is
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02008984 also on.
8985 WARNING: Switching this option off means that when Vim fails to write
8986 your buffer correctly and then, for whatever reason, Vim exits, you
8987 lose both the original file and what you were writing. Only reset
8988 this option if your file system is almost full and it makes the write
8989 fail (and make sure not to exit Vim until the write was successful).
8990 See |backup-table| for another explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008991 When the 'backupskip' pattern matches, a backup is not made anyway.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01008992 Depending on 'backupcopy' the backup is a new file or the original
8993 file renamed (and a new file is written).
Bram Moolenaar071d4272004-06-13 20:20:40 +00008994 NOTE: This option is set to the default value when 'compatible' is
8995 set.
8996
8997 *'writedelay'* *'wd'*
8998'writedelay' 'wd' number (default 0)
8999 global
Bram Moolenaar802a0d92016-06-26 16:17:58 +02009000 The number of milliseconds to wait for each character sent to the
Bram Moolenaar071d4272004-06-13 20:20:40 +00009001 screen. When non-zero, characters are sent to the terminal one by
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01009002 one. For debugging purposes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009003
Bram Moolenaar91f84f62018-07-29 15:07:52 +02009004 vim:tw=78:ts=8:noet:ft=help:norl: