blob: 4d26df86efbbeb1748b74d230f8c02af3f14b79d [file] [log] [blame]
Bram Moolenaar4072ba52020-12-23 13:56:35 +01001*options.txt* For Vim version 8.2. Last change: 2020 Dec 21
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 Moolenaar1c6737b2020-09-07 22:18:52 +0200704 contains a character that would be double width.
Bram Moolenaar08aac3c2020-08-28 21:04:24 +0200705
706 The values are overruled for characters specified with
707 |setcellwidths()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000708
709 There are a number of CJK fonts for which the width of glyphs for
710 those characters are solely based on how many octets they take in
711 legacy/traditional CJK encodings. In those encodings, Euro,
712 Registered sign, Greek/Cyrillic letters are represented by two octets,
Bram Moolenaar582fd852005-03-28 20:58:01 +0000713 therefore those fonts have "wide" glyphs for them. This is also
Bram Moolenaar071d4272004-06-13 20:20:40 +0000714 true of some line drawing characters used to make tables in text
Bram Moolenaar582fd852005-03-28 20:58:01 +0000715 file. Therefore, when a CJK font is used for GUI Vim or
Bram Moolenaar071d4272004-06-13 20:20:40 +0000716 Vim is running inside a terminal (emulators) that uses a CJK font
717 (or Vim is run inside an xterm invoked with "-cjkwidth" option.),
718 this option should be set to "double" to match the width perceived
719 by Vim with the width of glyphs in the font. Perhaps it also has
Bram Moolenaar8024f932020-01-14 19:29:13 +0100720 to be set to "double" under CJK MS-Windows when the system locale is
721 set to one of CJK locales. See Unicode Standard Annex #11
722 (http://www.unicode.org/reports/tr11).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000723
Bram Moolenaarac7bd632013-03-19 11:35:58 +0100724 Vim may set this option automatically at startup time when Vim is
725 compiled with the |+termresponse| feature and if |t_u7| is set to the
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200726 escape sequence to request cursor position report. The response can
727 be found in |v:termu7resp|.
Bram Moolenaarac7bd632013-03-19 11:35:58 +0100728
Bram Moolenaar071d4272004-06-13 20:20:40 +0000729 *'antialias'* *'anti'* *'noantialias'* *'noanti'*
730'antialias' 'anti' boolean (default: off)
731 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000732 {only available when compiled with GUI enabled
Bram Moolenaar3d1cde82020-08-15 18:55:18 +0200733 on macOS}
734 This option only has an effect in the GUI version of Vim on macOS
Bram Moolenaar071d4272004-06-13 20:20:40 +0000735 v10.2 or later. When on, Vim will use smooth ("antialiased") fonts,
736 which can be easier to read at certain sizes on certain displays.
737 Setting this option can sometimes cause problems if 'guifont' is set
738 to its default (empty string).
Bram Moolenaar036986f2017-03-16 17:41:02 +0100739 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000740
741 *'autochdir'* *'acd'* *'noautochdir'* *'noacd'*
742'autochdir' 'acd' boolean (default off)
743 global
Bram Moolenaar00a927d2010-05-14 23:24:24 +0200744 {only available when compiled with it, use
745 exists("+autochdir") to check}
Bram Moolenaard8c00872005-07-22 21:52:15 +0000746 When on, Vim will change the current working directory whenever you
747 open a file, switch buffers, delete a buffer or open/close a window.
748 It will change to the directory containing the file which was opened
749 or selected.
Bram Moolenaar910f66f2006-04-05 20:41:53 +0000750 Note: When this option is on some plugins may not work.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000751
752 *'arabic'* *'arab'* *'noarabic'* *'noarab'*
753'arabic' 'arab' boolean (default off)
754 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +0000755 {only available when compiled with the |+arabic|
756 feature}
757 This option can be set to start editing Arabic text.
758 Setting this option will:
759 - Set the 'rightleft' option, unless 'termbidi' is set.
760 - Set the 'arabicshape' option, unless 'termbidi' is set.
761 - Set the 'keymap' option to "arabic"; in Insert mode CTRL-^ toggles
762 between typing English and Arabic key mapping.
763 - Set the 'delcombine' option
764 Note that 'encoding' must be "utf-8" for working with Arabic text.
765
766 Resetting this option will:
767 - Reset the 'rightleft' option.
768 - Disable the use of 'keymap' (without changing its value).
769 Note that 'arabicshape' and 'delcombine' are not reset (it is a global
Bram Moolenaarc8734422012-06-01 22:38:45 +0200770 option).
Bram Moolenaar036986f2017-03-16 17:41:02 +0100771 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000772 Also see |arabic.txt|.
773
774 *'arabicshape'* *'arshape'*
775 *'noarabicshape'* *'noarshape'*
776'arabicshape' 'arshape' boolean (default on)
777 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000778 {only available when compiled with the |+arabic|
779 feature}
780 When on and 'termbidi' is off, the required visual character
781 corrections that need to take place for displaying the Arabic language
Bram Moolenaar3a0d8092012-10-21 03:02:54 +0200782 take effect. Shaping, in essence, gets enabled; the term is a broad
Bram Moolenaar071d4272004-06-13 20:20:40 +0000783 one which encompasses:
784 a) the changing/morphing of characters based on their location
785 within a word (initial, medial, final and stand-alone).
786 b) the enabling of the ability to compose characters
787 c) the enabling of the required combining of some characters
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100788 When disabled the display shows each character's true stand-alone
789 form.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000790 Arabic is a complex language which requires other settings, for
791 further details see |arabic.txt|.
Bram Moolenaar036986f2017-03-16 17:41:02 +0100792 NOTE: This option is set when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000793
794 *'autoindent'* *'ai'* *'noautoindent'* *'noai'*
795'autoindent' 'ai' boolean (default off)
796 local to buffer
797 Copy indent from current line when starting a new line (typing <CR>
798 in Insert mode or when using the "o" or "O" command). If you do not
799 type anything on the new line except <BS> or CTRL-D and then type
Bram Moolenaar02467872007-05-06 13:22:01 +0000800 <Esc>, CTRL-O or <CR>, the indent is deleted again. Moving the cursor
801 to another line has the same effect, unless the 'I' flag is included
802 in 'cpoptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000803 When autoindent is on, formatting (with the "gq" command or when you
804 reach 'textwidth' in Insert mode) uses the indentation of the first
805 line.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000806 When 'smartindent' or 'cindent' is on the indent is changed in
807 a different way.
Bram Moolenaarca635012015-09-25 20:34:21 +0200808 The 'autoindent' option is reset when the 'paste' option is set and
809 restored when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000810
811 *'autoread'* *'ar'* *'noautoread'* *'noar'*
812'autoread' 'ar' boolean (default off)
813 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000814 When a file has been detected to have been changed outside of Vim and
815 it has not been changed inside of Vim, automatically read it again.
Bram Moolenaarfd358112018-07-07 23:21:31 +0200816 When the file has been deleted this is not done, so you have the text
817 from before it was deleted. When it appears again then it is read.
818 |timestamp|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000819 If this option has a local value, use this command to switch back to
820 using the global value: >
821 :set autoread<
822<
823 *'autowrite'* *'aw'* *'noautowrite'* *'noaw'*
824'autowrite' 'aw' boolean (default off)
825 global
826 Write the contents of the file, if it has been modified, on each
827 :next, :rewind, :last, :first, :previous, :stop, :suspend, :tag, :!,
Bram Moolenaar14716812006-05-04 21:54:08 +0000828 :make, CTRL-] and CTRL-^ command; and when a :buffer, CTRL-O, CTRL-I,
Bram Moolenaar071d4272004-06-13 20:20:40 +0000829 '{A-Z0-9}, or `{A-Z0-9} command takes one to another file.
830 Note that for some commands the 'autowrite' option is not used, see
831 'autowriteall' for that.
Bram Moolenaar93a1df22018-09-10 11:51:50 +0200832 Some buffers will not be written, specifically when 'buftype' is
Bram Moolenaar20aac6c2018-09-02 21:07:30 +0200833 "nowrite", "nofile", "terminal" or "prompt".
Bram Moolenaar071d4272004-06-13 20:20:40 +0000834
835 *'autowriteall'* *'awa'* *'noautowriteall'* *'noawa'*
836'autowriteall' 'awa' boolean (default off)
837 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000838 Like 'autowrite', but also used for commands ":edit", ":enew", ":quit",
839 ":qall", ":exit", ":xit", ":recover" and closing the Vim window.
840 Setting this option also implies that Vim behaves like 'autowrite' has
841 been set.
842
843 *'background'* *'bg'*
Bram Moolenaar446beb42011-05-10 17:18:44 +0200844'background' 'bg' string (default "dark" or "light", see below)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000845 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000846 When set to "dark", Vim will try to use colors that look good on a
847 dark background. When set to "light", Vim will try to use colors that
848 look good on a light background. Any other value is illegal.
849 Vim tries to set the default value according to the terminal used.
850 This will not always be correct.
851 Setting this option does not change the background color, it tells Vim
852 what the background color looks like. For changing the background
853 color, see |:hi-normal|.
854
855 When 'background' is set Vim will adjust the default color groups for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000856 the new value. But the colors used for syntax highlighting will not
Bram Moolenaar446cb832008-06-24 21:56:24 +0000857 change. *g:colors_name*
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100858 When a color scheme is loaded (the "g:colors_name" variable is set)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000859 setting 'background' will cause the color scheme to be reloaded. If
860 the color scheme adjusts to the value of 'background' this will work.
861 However, if the color scheme sets 'background' itself the effect may
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100862 be undone. First delete the "g:colors_name" variable when needed.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000863
864 When setting 'background' to the default value with: >
865 :set background&
866< Vim will guess the value. In the GUI this should work correctly,
867 in other cases Vim might not be able to guess the right value.
Bram Moolenaar2e693a82019-10-16 22:35:02 +0200868 If the GUI supports a dark theme, you can use the "d" flag in
Bram Moolenaar50bf7ce2019-09-15 13:17:00 +0200869 'guioptions', see 'go-d'.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000870
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200871 When the |t_RB| option is set, Vim will use it to request the background
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +0200872 color from the terminal. If the returned RGB value is dark/light and
873 'background' is not dark/light, 'background' will be set and the
874 screen is redrawn. This may have side effects, make t_BG empty in
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200875 your .vimrc if you suspect this problem. The response to |t_RB| can
Bram Moolenaar01164a62017-11-02 22:58:42 +0100876 be found in |v:termrbgresp|.
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +0200877
Bram Moolenaar071d4272004-06-13 20:20:40 +0000878 When starting the GUI, the default value for 'background' will be
879 "light". When the value is not set in the .gvimrc, and Vim detects
880 that the background is actually quite dark, 'background' is set to
881 "dark". But this happens only AFTER the .gvimrc file has been read
882 (because the window needs to be opened to find the actual background
883 color). To get around this, force the GUI window to be opened by
884 putting a ":gui" command in the .gvimrc file, before where the value
885 of 'background' is used (e.g., before ":syntax on").
Bram Moolenaar446beb42011-05-10 17:18:44 +0200886
Bram Moolenaar6f345a12019-12-17 21:27:18 +0100887 For MS-Windows the default is "dark".
Bram Moolenaar446beb42011-05-10 17:18:44 +0200888 For other systems "dark" is used when 'term' is "linux",
889 "screen.linux", "cygwin" or "putty", or $COLORFGBG suggests a dark
890 background. Otherwise the default is "light".
891
Bram Moolenaarc572da52017-08-27 16:52:01 +0200892 The |:terminal| command and the |term_start()| function use the
893 'background' value to decide whether the terminal window will start
894 with a white or black background.
895
Bram Moolenaar071d4272004-06-13 20:20:40 +0000896 Normally this option would be set in the .vimrc file. Possibly
897 depending on the terminal name. Example: >
898 :if &term == "pcterm"
899 : set background=dark
900 :endif
901< When this option is set, the default settings for the highlight groups
902 will change. To use other settings, place ":highlight" commands AFTER
903 the setting of the 'background' option.
904 This option is also used in the "$VIMRUNTIME/syntax/syntax.vim" file
905 to select the colors for syntax highlighting. After changing this
906 option, you must load syntax.vim again to see the result. This can be
907 done with ":syntax on".
908
909 *'backspace'* *'bs'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +0200910'backspace' 'bs' string (default "", set to "indent,eol,start"
911 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000912 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000913 Influences the working of <BS>, <Del>, CTRL-W and CTRL-U in Insert
914 mode. This is a list of items, separated by commas. Each item allows
915 a way to backspace over something:
916 value effect ~
917 indent allow backspacing over autoindent
918 eol allow backspacing over line breaks (join lines)
919 start allow backspacing over the start of insert; CTRL-W and CTRL-U
920 stop once at the start of insert.
Bram Moolenaaraa0489e2020-04-17 19:41:21 +0200921 nostop like start, except CTRL-W and CTRL-U do not stop at the start of
922 insert.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000923
924 When the value is empty, Vi compatible backspacing is used.
925
926 For backwards compatibility with version 5.4 and earlier:
927 value effect ~
928 0 same as ":set backspace=" (Vi compatible)
929 1 same as ":set backspace=indent,eol"
930 2 same as ":set backspace=indent,eol,start"
Bram Moolenaaraa0489e2020-04-17 19:41:21 +0200931 3 same as ":set backspace=indent,eol,nostop"
Bram Moolenaar071d4272004-06-13 20:20:40 +0000932
933 See |:fixdel| if your <BS> or <Del> key does not do what you want.
934 NOTE: This option is set to "" when 'compatible' is set.
935
936 *'backup'* *'bk'* *'nobackup'* *'nobk'*
937'backup' 'bk' boolean (default off)
938 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000939 Make a backup before overwriting a file. Leave it around after the
940 file has been successfully written. If you do not want to keep the
941 backup file, but you do want a backup while the file is being
942 written, reset this option and set the 'writebackup' option (this is
943 the default). If you do not want a backup file at all reset both
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000944 options (use this if your file system is almost full). See the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000945 |backup-table| for more explanations.
946 When the 'backupskip' pattern matches, a backup is not made anyway.
947 When 'patchmode' is set, the backup may be renamed to become the
948 oldest version of a file.
949 NOTE: This option is reset when 'compatible' is set.
950
951 *'backupcopy'* *'bkc'*
952'backupcopy' 'bkc' string (Vi default for Unix: "yes", otherwise: "auto")
Bram Moolenaarb8ee25a2014-09-23 15:45:08 +0200953 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000954 When writing a file and a backup is made, this option tells how it's
955 done. This is a comma separated list of words.
956
957 The main values are:
958 "yes" make a copy of the file and overwrite the original one
959 "no" rename the file and write a new one
960 "auto" one of the previous, what works best
961
962 Extra values that can be combined with the ones above are:
963 "breaksymlink" always break symlinks when writing
964 "breakhardlink" always break hardlinks when writing
965
966 Making a copy and overwriting the original file:
967 - Takes extra time to copy the file.
968 + When the file has special attributes, is a (hard/symbolic) link or
969 has a resource fork, all this is preserved.
970 - When the file is a link the backup will have the name of the link,
971 not of the real file.
972
973 Renaming the file and writing a new one:
974 + It's fast.
975 - Sometimes not all attributes of the file can be copied to the new
976 file.
977 - When the file is a link the new file will not be a link.
978
979 The "auto" value is the middle way: When Vim sees that renaming file
980 is possible without side effects (the attributes can be passed on and
Bram Moolenaar02467872007-05-06 13:22:01 +0000981 the file is not a link) that is used. When problems are expected, a
982 copy will be made.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000983
984 The "breaksymlink" and "breakhardlink" values can be used in
985 combination with any of "yes", "no" and "auto". When included, they
986 force Vim to always break either symbolic or hard links by doing
987 exactly what the "no" option does, renaming the original file to
988 become the backup and writing a new file in its place. This can be
989 useful for example in source trees where all the files are symbolic or
990 hard links and any changes should stay in the local source tree, not
991 be propagated back to the original source.
992 *crontab*
993 One situation where "no" and "auto" will cause problems: A program
994 that opens a file, invokes Vim to edit that file, and then tests if
995 the open file was changed (through the file descriptor) will check the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000996 backup file instead of the newly created file. "crontab -e" is an
Bram Moolenaar071d4272004-06-13 20:20:40 +0000997 example.
998
999 When a copy is made, the original file is truncated and then filled
1000 with the new text. This means that protection bits, owner and
1001 symbolic links of the original file are unmodified. The backup file
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001002 however, is a new file, owned by the user who edited the file. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00001003 group of the backup is set to the group of the original file. If this
1004 fails, the protection bits for the group are made the same as for
1005 others.
1006
1007 When the file is renamed this is the other way around: The backup has
1008 the same attributes of the original file, and the newly written file
1009 is owned by the current user. When the file was a (hard/symbolic)
1010 link, the new file will not! That's why the "auto" value doesn't
1011 rename when the file is a link. The owner and group of the newly
1012 written file will be set to the same ones as the original file, but
1013 the system may refuse to do this. In that case the "auto" value will
1014 again not rename the file.
1015
Bram Moolenaar036986f2017-03-16 17:41:02 +01001016 NOTE: This option is set to the Vi default value when 'compatible' is
1017 set and to the Vim default value when 'compatible' is reset.
1018
Bram Moolenaar071d4272004-06-13 20:20:40 +00001019 *'backupdir'* *'bdir'*
1020'backupdir' 'bdir' string (default for Amiga: ".,t:",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01001021 for Win32: ".,$TEMP,c:/tmp,c:/temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001022 for Unix: ".,~/tmp,~/")
1023 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001024 List of directories for the backup file, separated with commas.
1025 - The backup file will be created in the first directory in the list
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001026 where this is possible. The directory must exist, Vim will not
1027 create it for you.
Bram Moolenaar3848e002016-03-19 18:42:29 +01001028 - Empty means that no backup file will be created ('patchmode' is
Bram Moolenaar071d4272004-06-13 20:20:40 +00001029 impossible!). Writing may fail because of this.
1030 - A directory "." means to put the backup file in the same directory
1031 as the edited file.
Bram Moolenaar8024f932020-01-14 19:29:13 +01001032 - A directory starting with "./" (or ".\" for MS-Windows) means to put
1033 the backup file relative to where the edited file is. The leading
1034 "." is replaced with the path name of the edited file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001035 ("." inside a directory name has no special meaning).
1036 - Spaces after the comma are ignored, other spaces are considered part
1037 of the directory name. To have a space at the start of a directory
1038 name, precede it with a backslash.
1039 - To include a comma in a directory name precede it with a backslash.
1040 - A directory name may end in an '/'.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02001041 - For Unix and Win32, if a directory ends in two path separators "//",
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01001042 the backup file name will be built from the complete path to the
1043 file with all path separators changed to percent '%' signs. This
1044 will ensure file name uniqueness in the backup directory.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02001045 On Win32, it is also possible to end with "\\". However, When a
1046 separating comma is following, you must use "//", since "\\" will
1047 include the comma in the file name. Therefore it is recommended to
1048 use '//', instead of '\\'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001049 - Environment variables are expanded |:set_env|.
1050 - Careful with '\' characters, type one before a space, type two to
1051 get one in the option (see |option-backslash|), for example: >
1052 :set bdir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
1053< - For backwards compatibility with Vim version 3.0 a '>' at the start
1054 of the option is removed.
1055 See also 'backup' and 'writebackup' options.
1056 If you want to hide your backup files on Unix, consider this value: >
1057 :set backupdir=./.backup,~/.backup,.,/tmp
1058< You must create a ".backup" directory in each directory and in your
1059 home directory for this to work properly.
1060 The use of |:set+=| and |:set-=| is preferred when adding or removing
1061 directories from the list. This avoids problems when a future version
1062 uses another default.
1063 This option cannot be set from a |modeline| or in the |sandbox|, for
1064 security reasons.
1065
1066 *'backupext'* *'bex'* *E589*
1067'backupext' 'bex' string (default "~", for VMS: "_")
1068 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001069 String which is appended to a file name to make the name of the
1070 backup file. The default is quite unusual, because this avoids
1071 accidentally overwriting existing files with a backup file. You might
1072 prefer using ".bak", but make sure that you don't have files with
1073 ".bak" that you want to keep.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001074 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001075
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001076 If you like to keep a lot of backups, you could use a BufWritePre
1077 autocommand to change 'backupext' just before writing the file to
1078 include a timestamp. >
1079 :au BufWritePre * let &bex = '-' . strftime("%Y%b%d%X") . '~'
1080< Use 'backupdir' to put the backup in a different directory.
1081
Bram Moolenaar071d4272004-06-13 20:20:40 +00001082 *'backupskip'* *'bsk'*
Bram Moolenaarb8e22a02018-04-12 21:37:34 +02001083'backupskip' 'bsk' string (default: "$TMPDIR/*,$TMP/*,$TEMP/*"
1084 Unix: "/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*"
1085 Mac: "/private/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001086 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001087 {not available when compiled without the |+wildignore|
1088 feature}
1089 A list of file patterns. When one of the patterns matches with the
1090 name of the file which is written, no backup file is created. Both
1091 the specified file name and the full path name of the file are used.
1092 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
1093 Watch out for special characters, see |option-backslash|.
1094 When $TMPDIR, $TMP or $TEMP is not defined, it is not used for the
Bram Moolenaar582fd852005-03-28 20:58:01 +00001095 default value. "/tmp/*" is only used for Unix.
Bram Moolenaar02467872007-05-06 13:22:01 +00001096
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02001097 WARNING: Not having a backup file means that when Vim fails to write
1098 your buffer correctly and then, for whatever reason, Vim exits, you
1099 lose both the original file and what you were writing. Only disable
1100 backups if you don't care about losing the file.
1101
Bram Moolenaar02467872007-05-06 13:22:01 +00001102 Note that environment variables are not expanded. If you want to use
1103 $HOME you must expand it explicitly, e.g.: >
Bram Moolenaar7c1c6db2016-04-03 22:08:05 +02001104 :let &backupskip = escape(expand('$HOME'), '\') . '/tmp/*'
Bram Moolenaar02467872007-05-06 13:22:01 +00001105
1106< Note that the default also makes sure that "crontab -e" works (when a
Bram Moolenaara5792f52005-11-23 21:25:05 +00001107 backup would be made by renaming the original file crontab won't see
1108 the newly created file). Also see 'backupcopy' and |crontab|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001109
1110 *'balloondelay'* *'bdlay'*
1111'balloondelay' 'bdlay' number (default: 600)
1112 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001113 {only available when compiled with the |+balloon_eval|
1114 feature}
1115 Delay in milliseconds before a balloon may pop up. See |balloon-eval|.
1116
1117 *'ballooneval'* *'beval'* *'noballooneval'* *'nobeval'*
1118'ballooneval' 'beval' boolean (default off)
1119 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001120 {only available when compiled with the |+balloon_eval|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001121 feature}
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001122 Switch on the |balloon-eval| functionality for the GUI.
1123
1124 *'balloonevalterm'* *'bevalterm'* *'noballoonevalterm'*
1125 *'nobevalterm'*
1126'balloonevalterm' 'bevalterm' boolean (default off)
1127 global
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001128 {only available when compiled with the
1129 |+balloon_eval_term| feature}
1130 Switch on the |balloon-eval| functionality for the terminal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001131
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001132 *'balloonexpr'* *'bexpr'*
1133'balloonexpr' 'bexpr' string (default "")
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00001134 global or local to buffer |global-local|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001135 {only available when compiled with the |+balloon_eval|
1136 feature}
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00001137 Expression for text to show in evaluation balloon. It is only used
Bram Moolenaara6c27c42019-05-09 19:16:22 +02001138 when 'ballooneval' or 'balloonevalterm' is on. These variables can be
1139 used:
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001140
1141 v:beval_bufnr number of the buffer in which balloon is going to show
1142 v:beval_winnr number of the window
Bram Moolenaar82af8712016-06-04 20:20:29 +02001143 v:beval_winid ID of the window
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001144 v:beval_lnum line number
1145 v:beval_col column number (byte index)
1146 v:beval_text word under or after the mouse pointer
1147
Bram Moolenaar54775062019-07-31 21:07:14 +02001148 Instead of showing a balloon, which is limited to plain text, consider
1149 using a popup window, see |popup_beval_example|. A popup window can
1150 use highlighting and show a border.
1151
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001152 The evaluation of the expression must not have side effects!
1153 Example: >
Bram Moolenaara6c27c42019-05-09 19:16:22 +02001154 function MyBalloonExpr()
Bram Moolenaar45360022005-07-21 21:08:21 +00001155 return 'Cursor is at line ' . v:beval_lnum .
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001156 \', column ' . v:beval_col .
1157 \ ' of file ' . bufname(v:beval_bufnr) .
1158 \ ' on word "' . v:beval_text . '"'
1159 endfunction
1160 set bexpr=MyBalloonExpr()
1161 set ballooneval
1162<
Bram Moolenaar396e8292019-07-13 23:04:31 +02001163 Also see |balloon_show()|, it can be used if the content of the balloon
1164 is to be fetched asynchronously. In that case evaluating
1165 'balloonexpr' should result in an empty string. If you get a balloon
1166 with only "0" you probably didn't return anything from your function.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001167
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001168 NOTE: The balloon is displayed only if the cursor is on a text
1169 character. If the result of evaluating 'balloonexpr' is not empty,
1170 Vim does not try to send a message to an external debugger (Netbeans
1171 or Sun Workshop).
1172
Bram Moolenaar30b65812012-07-12 22:01:11 +02001173 The expression will be evaluated in the |sandbox| when set from a
1174 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02001175 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001176
1177 It is not allowed to change text or jump to another window while
Bram Moolenaar396e8292019-07-13 23:04:31 +02001178 evaluating 'balloonexpr', see |textlock|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001179
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001180 To check whether line breaks in the balloon text work use this check: >
Bram Moolenaar45360022005-07-21 21:08:21 +00001181 if has("balloon_multiline")
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001182< When they are supported "\n" characters will start a new line. If the
1183 expression evaluates to a |List| this is equal to using each List item
1184 as a string and putting "\n" in between them.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001185 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001186
Bram Moolenaar165bc692015-07-21 17:53:25 +02001187 *'belloff'* *'bo'*
1188'belloff' 'bo' string (default "")
1189 global
Bram Moolenaar165bc692015-07-21 17:53:25 +02001190 Specifies for which events the bell will not be rung. It is a comma
1191 separated list of items. For each item that is present, the bell
1192 will be silenced. This is most useful to specify specific events in
1193 insert mode to be silenced.
1194
1195 item meaning when present ~
1196 all All events.
1197 backspace When hitting <BS> or <Del> and deleting results in an
1198 error.
1199 cursor Fail to move around using the cursor keys or
1200 <PageUp>/<PageDown> in |Insert-mode|.
1201 complete Error occurred when using |i_CTRL-X_CTRL-K| or
1202 |i_CTRL-X_CTRL-T|.
1203 copy Cannot copy char from insert mode using |i_CTRL-Y| or
1204 |i_CTRL-E|.
1205 ctrlg Unknown Char after <C-G> in Insert mode.
1206 error Other Error occurred (e.g. try to join last line)
1207 (mostly used in |Normal-mode| or |Cmdline-mode|).
1208 esc hitting <Esc> in |Normal-mode|.
1209 ex In |Visual-mode|, hitting |Q| results in an error.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01001210 hangul Ignored.
Bram Moolenaar165bc692015-07-21 17:53:25 +02001211 insertmode Pressing <Esc> in 'insertmode'.
1212 lang Calling the beep module for Lua/Mzscheme/TCL.
1213 mess No output available for |g<|.
1214 showmatch Error occurred for 'showmatch' function.
1215 operator Empty region error |cpo-E|.
1216 register Unknown register after <C-R> in |Insert-mode|.
1217 shell Bell from shell output |:!|.
1218 spell Error happened on spell suggest.
1219 wildmode More matches in |cmdline-completion| available
1220 (depends on the 'wildmode' setting).
1221
Bram Moolenaar036986f2017-03-16 17:41:02 +01001222 This is most useful to fine tune when in Insert mode the bell should
1223 be rung. For Normal mode and Ex commands, the bell is often rung to
Bram Moolenaar165bc692015-07-21 17:53:25 +02001224 indicate that an error occurred. It can be silenced by adding the
1225 "error" keyword.
1226
Bram Moolenaar071d4272004-06-13 20:20:40 +00001227 *'binary'* *'bin'* *'nobinary'* *'nobin'*
1228'binary' 'bin' boolean (default off)
1229 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001230 This option should be set before editing a binary file. You can also
1231 use the |-b| Vim argument. When this option is switched on a few
1232 options will be changed (also when it already was on):
1233 'textwidth' will be set to 0
1234 'wrapmargin' will be set to 0
1235 'modeline' will be off
1236 'expandtab' will be off
1237 Also, 'fileformat' and 'fileformats' options will not be used, the
1238 file is read and written like 'fileformat' was "unix" (a single <NL>
1239 separates lines).
1240 The 'fileencoding' and 'fileencodings' options will not be used, the
1241 file is read without conversion.
1242 NOTE: When you start editing a(nother) file while the 'bin' option is
1243 on, settings from autocommands may change the settings again (e.g.,
1244 'textwidth'), causing trouble when editing. You might want to set
1245 'bin' again when the file has been loaded.
1246 The previous values of these options are remembered and restored when
1247 'bin' is switched from on to off. Each buffer has its own set of
1248 saved option values.
1249 To edit a file with 'binary' set you can use the |++bin| argument.
1250 This avoids you have to do ":set bin", which would have effect for all
1251 files you edit.
1252 When writing a file the <EOL> for the last line is only written if
1253 there was one in the original file (normally Vim appends an <EOL> to
1254 the last line if there is none; this would make the file longer). See
1255 the 'endofline' option.
1256
1257 *'bioskey'* *'biosk'* *'nobioskey'* *'nobiosk'*
1258'bioskey' 'biosk' boolean (default on)
1259 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02001260 {only for MS-DOS}
Bram Moolenaarf3913272016-02-25 00:00:01 +01001261 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001262
1263 *'bomb'* *'nobomb'*
1264'bomb' boolean (default off)
1265 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001266 When writing a file and the following conditions are met, a BOM (Byte
1267 Order Mark) is prepended to the file:
1268 - this option is on
1269 - the 'binary' option is off
1270 - 'fileencoding' is "utf-8", "ucs-2", "ucs-4" or one of the little/big
1271 endian variants.
1272 Some applications use the BOM to recognize the encoding of the file.
1273 Often used for UCS-2 files on MS-Windows. For other applications it
1274 causes trouble, for example: "cat file1 file2" makes the BOM of file2
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001275 appear halfway the resulting file. Gcc doesn't accept a BOM.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001276 When Vim reads a file and 'fileencodings' starts with "ucs-bom", a
1277 check for the presence of the BOM is done and 'bomb' set accordingly.
1278 Unless 'binary' is set, it is removed from the first line, so that you
1279 don't see it when editing. When you don't change the options, the BOM
1280 will be restored when writing the file.
1281
1282 *'breakat'* *'brk'*
1283'breakat' 'brk' string (default " ^I!@*-+;:,./?")
1284 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02001285 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001286 feature}
1287 This option lets you choose which characters might cause a line
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00001288 break if 'linebreak' is on. Only works for ASCII and also for 8-bit
1289 characters when 'encoding' is an 8-bit encoding.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001290
Bram Moolenaar7c1c6db2016-04-03 22:08:05 +02001291 *'breakindent'* *'bri'* *'nobreakindent'* *'nobri'*
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001292'breakindent' 'bri' boolean (default off)
1293 local to window
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001294 {not available when compiled without the |+linebreak|
1295 feature}
1296 Every wrapped line will continue visually indented (same amount of
1297 space as the beginning of that line), thus preserving horizontal blocks
1298 of text.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001299 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001300
1301 *'breakindentopt'* *'briopt'*
1302'breakindentopt' 'briopt' string (default empty)
1303 local to window
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001304 {not available when compiled without the |+linebreak|
1305 feature}
1306 Settings for 'breakindent'. It can consist of the following optional
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001307 items and must be separated by a comma:
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001308 min:{n} Minimum text width that will be kept after
1309 applying 'breakindent', even if the resulting
1310 text should normally be narrower. This prevents
1311 text indented almost to the right window border
1312 occupying lot of vertical space when broken.
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001313 shift:{n} After applying 'breakindent', the wrapped line's
1314 beginning will be shifted by the given number of
1315 characters. It permits dynamic French paragraph
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001316 indentation (negative) or emphasizing the line
1317 continuation (positive).
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01001318 sbr Display the 'showbreak' value before applying the
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001319 additional indent.
1320 The default value for min is 20 and shift is 0.
1321
Bram Moolenaar071d4272004-06-13 20:20:40 +00001322 *'browsedir'* *'bsdir'*
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001323'browsedir' 'bsdir' string (default: "last")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001324 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02001325 {only for Motif, Athena, GTK, Mac and Win32 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001326 Which directory to use for the file browser:
Bram Moolenaar446cb832008-06-24 21:56:24 +00001327 last Use same directory as with last file browser, where a
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02001328 file was opened or saved.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001329 buffer Use the directory of the related buffer.
1330 current Use the current directory.
1331 {path} Use the specified directory
1332
1333 *'bufhidden'* *'bh'*
1334'bufhidden' 'bh' string (default: "")
1335 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001336 This option specifies what happens when a buffer is no longer
1337 displayed in a window:
1338 <empty> follow the global 'hidden' option
1339 hide hide the buffer (don't unload it), also when 'hidden'
1340 is not set
1341 unload unload the buffer, also when 'hidden' is set or using
1342 |:hide|
1343 delete delete the buffer from the buffer list, also when
1344 'hidden' is set or using |:hide|, like using
1345 |:bdelete|
1346 wipe wipe out the buffer from the buffer list, also when
1347 'hidden' is set or using |:hide|, like using
1348 |:bwipeout|
1349
Bram Moolenaara14de3d2005-01-07 21:48:26 +00001350 CAREFUL: when "unload", "delete" or "wipe" is used changes in a buffer
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01001351 are lost without a warning. Also, these values may break autocommands
1352 that switch between buffers temporarily.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001353 This option is used together with 'buftype' and 'swapfile' to specify
1354 special kinds of buffers. See |special-buffers|.
1355
1356 *'buflisted'* *'bl'* *'nobuflisted'* *'nobl'* *E85*
1357'buflisted' 'bl' boolean (default: on)
1358 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001359 When this option is set, the buffer shows up in the buffer list. If
1360 it is reset it is not used for ":bnext", "ls", the Buffers menu, etc.
1361 This option is reset by Vim for buffers that are only used to remember
1362 a file name or marks. Vim sets it when starting to edit a buffer.
1363 But not when moving to a buffer with ":buffer".
1364
1365 *'buftype'* *'bt'* *E382*
1366'buftype' 'bt' string (default: "")
1367 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001368 The value of this option specifies the type of a buffer:
1369 <empty> normal buffer
1370 nofile buffer which is not related to a file and will not be
1371 written
1372 nowrite buffer which will not be written
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001373 acwrite buffer which will always be written with BufWriteCmd
Bram Moolenaarb5b75622018-03-09 22:22:21 +01001374 autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001375 quickfix quickfix buffer, contains list of errors |:cwindow|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001376 or list of locations |:lwindow|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001377 help help buffer (you are not supposed to set this
1378 manually)
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02001379 terminal buffer for a |terminal| (you are not supposed to set
1380 this manually)
Bram Moolenaarf2732452018-06-03 14:47:35 +02001381 prompt buffer where only the last line can be edited, meant
1382 to be used by a plugin, see |prompt-buffer|
1383 {only when compiled with the |+channel| feature}
Bram Moolenaar4d784b22019-05-25 19:51:39 +02001384 popup buffer used in a popup window, see |popup|.
1385 {only when compiled with the |+textprop| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001386
1387 This option is used together with 'bufhidden' and 'swapfile' to
1388 specify special kinds of buffers. See |special-buffers|.
Bram Moolenaarebdf3c92020-02-15 21:41:42 +01001389 Also see |win_gettype()|, which returns the type of the window.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001390
1391 Be careful with changing this option, it can have many side effects!
1392
Bram Moolenaar280f1262006-01-30 00:14:18 +00001393 A "quickfix" buffer is only used for the error list and the location
1394 list. This value is set by the |:cwindow| and |:lwindow| commands and
1395 you are not supposed to change it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001396
1397 "nofile" and "nowrite" buffers are similar:
1398 both: The buffer is not to be written to disk, ":w" doesn't
1399 work (":w filename" does work though).
1400 both: The buffer is never considered to be |'modified'|.
1401 There is no warning when the changes will be lost, for
1402 example when you quit Vim.
1403 both: A swap file is only created when using too much memory
1404 (when 'swapfile' has been reset there is never a swap
1405 file).
1406 nofile only: The buffer name is fixed, it is not handled like a
1407 file name. It is not modified in response to a |:cd|
1408 command.
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01001409 both: When using ":e bufname" and already editing "bufname"
1410 the buffer is made empty and autocommands are
1411 triggered as usual for |:edit|.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001412 *E676*
1413 "acwrite" implies that the buffer name is not related to a file, like
1414 "nofile", but it will be written. Thus, in contrast to "nofile" and
1415 "nowrite", ":w" does work and a modified buffer can't be abandoned
1416 without saving. For writing there must be matching |BufWriteCmd|,
1417 |FileWriteCmd| or |FileAppendCmd| autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001418
1419 *'casemap'* *'cmp'*
1420'casemap' 'cmp' string (default: "internal,keepascii")
1421 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001422 Specifies details about changing the case of letters. It may contain
1423 these words, separated by a comma:
1424 internal Use internal case mapping functions, the current
1425 locale does not change the case mapping. This only
Bram Moolenaar6f16eb82005-08-23 21:02:42 +00001426 matters when 'encoding' is a Unicode encoding,
1427 "latin1" or "iso-8859-15". When "internal" is
1428 omitted, the towupper() and towlower() system library
1429 functions are used when available.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001430 keepascii For the ASCII characters (0x00 to 0x7f) use the US
1431 case mapping, the current locale is not effective.
1432 This probably only matters for Turkish.
1433
1434 *'cdpath'* *'cd'* *E344* *E346*
1435'cdpath' 'cd' string (default: equivalent to $CDPATH or ",,")
1436 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001437 {not available when compiled without the
1438 |+file_in_path| feature}
1439 This is a list of directories which will be searched when using the
Bram Moolenaar00aa0692019-04-27 20:37:57 +02001440 |:cd|, |:tcd| and |:lcd| commands, provided that the directory being
1441 searched for has a relative path, not an absolute part starting with
1442 "/", "./" or "../", the 'cdpath' option is not used then.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001443 The 'cdpath' option's value has the same form and semantics as
1444 |'path'|. Also see |file-searching|.
1445 The default value is taken from $CDPATH, with a "," prepended to look
1446 in the current directory first.
1447 If the default value taken from $CDPATH is not what you want, include
1448 a modified version of the following command in your vimrc file to
1449 override it: >
1450 :let &cdpath = ',' . substitute(substitute($CDPATH, '[, ]', '\\\0', 'g'), ':', ',', 'g')
1451< This option cannot be set from a |modeline| or in the |sandbox|, for
1452 security reasons.
1453 (parts of 'cdpath' can be passed to the shell to expand file names).
1454
1455 *'cedit'*
1456'cedit' string (Vi default: "", Vim default: CTRL-F)
1457 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001458 The key used in Command-line Mode to open the command-line window.
1459 The default is CTRL-F when 'compatible' is off.
1460 Only non-printable keys are allowed.
1461 The key can be specified as a single character, but it is difficult to
1462 type. The preferred way is to use the <> notation. Examples: >
Bram Moolenaare18dbe82016-07-02 21:42:23 +02001463 :exe "set cedit=\<C-Y>"
1464 :exe "set cedit=\<Esc>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001465< |Nvi| also has this option, but it only uses the first character.
1466 See |cmdwin|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001467 NOTE: This option is set to the Vim default value when 'compatible'
1468 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001469
1470 *'charconvert'* *'ccv'* *E202* *E214* *E513*
1471'charconvert' 'ccv' string (default "")
1472 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01001473 {only available when compiled with the |+eval| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001474 An expression that is used for character encoding conversion. It is
1475 evaluated when a file that is to be read or has been written has a
1476 different encoding from what is desired.
1477 'charconvert' is not used when the internal iconv() function is
1478 supported and is able to do the conversion. Using iconv() is
1479 preferred, because it is much faster.
1480 'charconvert' is not used when reading stdin |--|, because there is no
1481 file to convert from. You will have to save the text in a file first.
1482 The expression must return zero or an empty string for success,
1483 non-zero for failure.
1484 The possible encoding names encountered are in 'encoding'.
1485 Additionally, names given in 'fileencodings' and 'fileencoding' are
1486 used.
1487 Conversion between "latin1", "unicode", "ucs-2", "ucs-4" and "utf-8"
1488 is done internally by Vim, 'charconvert' is not used for this.
1489 'charconvert' is also used to convert the viminfo file, if the 'c'
1490 flag is present in 'viminfo'. Also used for Unicode conversion.
1491 Example: >
1492 set charconvert=CharConvert()
1493 fun CharConvert()
1494 system("recode "
1495 \ . v:charconvert_from . ".." . v:charconvert_to
1496 \ . " <" . v:fname_in . " >" v:fname_out)
1497 return v:shell_error
1498 endfun
1499< The related Vim variables are:
1500 v:charconvert_from name of the current encoding
1501 v:charconvert_to name of the desired encoding
1502 v:fname_in name of the input file
1503 v:fname_out name of the output file
1504 Note that v:fname_in and v:fname_out will never be the same.
1505 Note that v:charconvert_from and v:charconvert_to may be different
1506 from 'encoding'. Vim internally uses UTF-8 instead of UCS-2 or UCS-4.
1507 Encryption is not done by Vim when using 'charconvert'. If you want
1508 to encrypt the file after conversion, 'charconvert' should take care
1509 of this.
1510 This option cannot be set from a |modeline| or in the |sandbox|, for
1511 security reasons.
1512
1513 *'cindent'* *'cin'* *'nocindent'* *'nocin'*
1514'cindent' 'cin' boolean (default off)
1515 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001516 {not available when compiled without the |+cindent|
1517 feature}
Bram Moolenaar446cb832008-06-24 21:56:24 +00001518 Enables automatic C program indenting. See 'cinkeys' to set the keys
Bram Moolenaar071d4272004-06-13 20:20:40 +00001519 that trigger reindenting in insert mode and 'cinoptions' to set your
1520 preferred indent style.
1521 If 'indentexpr' is not empty, it overrules 'cindent'.
1522 If 'lisp' is not on and both 'indentexpr' and 'equalprg' are empty,
1523 the "=" operator indents using this algorithm rather than calling an
1524 external program.
1525 See |C-indenting|.
1526 When you don't like the way 'cindent' works, try the 'smartindent'
1527 option or 'indentexpr'.
1528 This option is not used when 'paste' is set.
1529 NOTE: This option is reset when 'compatible' is set.
1530
1531 *'cinkeys'* *'cink'*
Bram Moolenaarce655742019-01-31 14:12:57 +01001532'cinkeys' 'cink' string (default "0{,0},0),0],:,0#,!^F,o,O,e")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001533 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001534 {not available when compiled without the |+cindent|
1535 feature}
1536 A list of keys that, when typed in Insert mode, cause reindenting of
1537 the current line. Only used if 'cindent' is on and 'indentexpr' is
1538 empty.
1539 For the format of this option see |cinkeys-format|.
1540 See |C-indenting|.
1541
1542 *'cinoptions'* *'cino'*
1543'cinoptions' 'cino' string (default "")
1544 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001545 {not available when compiled without the |+cindent|
1546 feature}
1547 The 'cinoptions' affect the way 'cindent' reindents lines in a C
1548 program. See |cinoptions-values| for the values of this option, and
1549 |C-indenting| for info on C indenting in general.
1550
1551
1552 *'cinwords'* *'cinw'*
1553'cinwords' 'cinw' string (default "if,else,while,do,for,switch")
1554 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001555 {not available when compiled without both the
1556 |+cindent| and the |+smartindent| features}
1557 These keywords start an extra indent in the next line when
1558 'smartindent' or 'cindent' is set. For 'cindent' this is only done at
1559 an appropriate place (inside {}).
1560 Note that 'ignorecase' isn't used for 'cinwords'. If case doesn't
1561 matter, include the keyword both the uppercase and lowercase:
1562 "if,If,IF".
1563
1564 *'clipboard'* *'cb'*
1565'clipboard' 'cb' string (default "autoselect,exclude:cons\|linux"
1566 for X-windows, "" otherwise)
1567 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001568 {only in GUI versions or when the |+xterm_clipboard|
1569 feature is included}
1570 This option is a list of comma separated names.
1571 These names are recognized:
1572
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001573 *clipboard-unnamed*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001574 unnamed When included, Vim will use the clipboard register '*'
1575 for all yank, delete, change and put operations which
1576 would normally go to the unnamed register. When a
1577 register is explicitly specified, it will always be
1578 used regardless of whether "unnamed" is in 'clipboard'
1579 or not. The clipboard register can always be
1580 explicitly accessed using the "* notation. Also see
1581 |gui-clipboard|.
1582
Bram Moolenaar30b65812012-07-12 22:01:11 +02001583 *clipboard-unnamedplus*
Bram Moolenaar00154502013-02-13 16:15:55 +01001584 unnamedplus A variant of the "unnamed" flag which uses the
1585 clipboard register '+' (|quoteplus|) instead of
1586 register '*' for all yank, delete, change and put
1587 operations which would normally go to the unnamed
1588 register. When "unnamed" is also included to the
1589 option, yank operations (but not delete, change or
1590 put) will additionally copy the text into register
1591 '*'.
Bram Moolenaar81af9252010-12-10 20:35:50 +01001592 Only available with the |+X11| feature.
Bram Moolenaarbf9680e2010-12-02 21:43:16 +01001593 Availability can be checked with: >
1594 if has('unnamedplus')
1595<
Bram Moolenaar30b65812012-07-12 22:01:11 +02001596 *clipboard-autoselect*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001597 autoselect Works like the 'a' flag in 'guioptions': If present,
1598 then whenever Visual mode is started, or the Visual
1599 area extended, Vim tries to become the owner of the
1600 windowing system's global selection or put the
1601 selected text on the clipboard used by the selection
Bram Moolenaarba3ff532018-11-04 14:45:49 +01001602 register "*. See |'go-a'| and |quotestar| for details.
1603 When the GUI is active, the 'a' flag in 'guioptions'
1604 is used, when the GUI is not active, this "autoselect"
1605 flag is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001606 Also applies to the modeless selection.
1607
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001608 *clipboard-autoselectplus*
1609 autoselectplus Like "autoselect" but using the + register instead of
1610 the * register. Compare to the 'P' flag in
1611 'guioptions'.
1612
1613 *clipboard-autoselectml*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001614 autoselectml Like "autoselect", but for the modeless selection
1615 only. Compare to the 'A' flag in 'guioptions'.
1616
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001617 *clipboard-html*
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001618 html When the clipboard contains HTML, use this when
1619 pasting. When putting text on the clipboard, mark it
1620 as HTML. This works to copy rendered HTML from
1621 Firefox, paste it as raw HTML in Vim, select the HTML
1622 in Vim and paste it in a rich edit box in Firefox.
Bram Moolenaar20a825a2010-05-31 21:27:30 +02001623 You probably want to add this only temporarily,
1624 possibly use BufEnter autocommands.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001625 Only supported for GTK version 2 and later.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001626
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001627 *clipboard-exclude*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001628 exclude:{pattern}
1629 Defines a pattern that is matched against the name of
1630 the terminal 'term'. If there is a match, no
1631 connection will be made to the X server. This is
1632 useful in this situation:
1633 - Running Vim in a console.
1634 - $DISPLAY is set to start applications on another
1635 display.
1636 - You do not want to connect to the X server in the
1637 console, but do want this in a terminal emulator.
1638 To never connect to the X server use: >
1639 exclude:.*
1640< This has the same effect as using the |-X| argument.
1641 Note that when there is no connection to the X server
1642 the window title won't be restored and the clipboard
1643 cannot be accessed.
1644 The value of 'magic' is ignored, {pattern} is
1645 interpreted as if 'magic' was on.
1646 The rest of the option value will be used for
1647 {pattern}, this must be the last entry.
1648
1649 *'cmdheight'* *'ch'*
1650'cmdheight' 'ch' number (default 1)
1651 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001652 Number of screen lines to use for the command-line. Helps avoiding
1653 |hit-enter| prompts.
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00001654 The value of this option is stored with the tab page, so that each tab
1655 page can have a different value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001656
1657 *'cmdwinheight'* *'cwh'*
1658'cmdwinheight' 'cwh' number (default 7)
1659 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001660 Number of screen lines to use for the command-line window. |cmdwin|
1661
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001662 *'colorcolumn'* *'cc'*
1663'colorcolumn' 'cc' string (default "")
1664 local to window
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001665 {not available when compiled without the |+syntax|
1666 feature}
1667 'colorcolumn' is a comma separated list of screen columns that are
1668 highlighted with ColorColumn |hl-ColorColumn|. Useful to align
1669 text. Will make screen redrawing slower.
1670 The screen column can be an absolute number, or a number preceded with
1671 '+' or '-', which is added to or subtracted from 'textwidth'. >
1672
1673 :set cc=+1 " highlight column after 'textwidth'
1674 :set cc=+1,+2,+3 " highlight three columns after 'textwidth'
1675 :hi ColorColumn ctermbg=lightgrey guibg=lightgrey
1676<
1677 When 'textwidth' is zero then the items with '-' and '+' are not used.
1678 A maximum of 256 columns are highlighted.
1679
Bram Moolenaar071d4272004-06-13 20:20:40 +00001680 *'columns'* *'co'* *E594*
1681'columns' 'co' number (default 80 or terminal width)
1682 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001683 Number of columns of the screen. Normally this is set by the terminal
Bram Moolenaar7c626922005-02-07 22:01:03 +00001684 initialization and does not have to be set by hand. Also see
1685 |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001686 When Vim is running in the GUI or in a resizable window, setting this
1687 option will cause the window size to be changed. When you only want
1688 to use the size for the GUI, put the command in your |gvimrc| file.
1689 When you set this option and Vim is unable to change the physical
Bram Moolenaar02467872007-05-06 13:22:01 +00001690 number of columns of the display, the display may be messed up. For
1691 the GUI it is always possible and Vim limits the number of columns to
1692 what fits on the screen. You can use this command to get the widest
1693 window possible: >
1694 :set columns=9999
1695< Minimum value is 12, maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001696
1697 *'comments'* *'com'* *E524* *E525*
1698'comments' 'com' string (default
1699 "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-")
1700 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001701 A comma separated list of strings that can start a comment line. See
1702 |format-comments|. See |option-backslash| about using backslashes to
1703 insert a space.
1704
1705 *'commentstring'* *'cms'* *E537*
1706'commentstring' 'cms' string (default "/*%s*/")
1707 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001708 {not available when compiled without the |+folding|
1709 feature}
1710 A template for a comment. The "%s" in the value is replaced with the
1711 comment text. Currently only used to add markers for folding, see
1712 |fold-marker|.
1713
1714 *'compatible'* *'cp'* *'nocompatible'* *'nocp'*
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001715'compatible' 'cp' boolean (default on, off when a |vimrc| or |gvimrc|
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02001716 file is found, reset in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001717 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001718 This option has the effect of making Vim either more Vi-compatible, or
1719 make Vim behave in a more useful way.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001720
Bram Moolenaar071d4272004-06-13 20:20:40 +00001721 This is a special kind of option, because when it's set or reset,
Bram Moolenaar214641f2017-03-05 17:04:09 +01001722 other options are also changed as a side effect.
1723 NOTE: Setting or resetting this option can have a lot of unexpected
1724 effects: Mappings are interpreted in another way, undo behaves
1725 differently, etc. If you set this option in your vimrc file, you
1726 should probably put it at the very start.
1727
Bram Moolenaar071d4272004-06-13 20:20:40 +00001728 By default this option is on and the Vi defaults are used for the
1729 options. This default was chosen for those people who want to use Vim
1730 just like Vi, and don't even (want to) know about the 'compatible'
1731 option.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001732 When a |vimrc| or |gvimrc| file is found while Vim is starting up,
Bram Moolenaard042c562005-06-30 22:04:15 +00001733 this option is switched off, and all options that have not been
1734 modified will be set to the Vim defaults. Effectively, this means
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001735 that when a |vimrc| or |gvimrc| file exists, Vim will use the Vim
Bram Moolenaard042c562005-06-30 22:04:15 +00001736 defaults, otherwise it will use the Vi defaults. (Note: This doesn't
Bram Moolenaar02467872007-05-06 13:22:01 +00001737 happen for the system-wide vimrc or gvimrc file, nor for a file given
1738 with the |-u| argument). Also see |compatible-default| and
1739 |posix-compliance|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001740 You can also set this option with the "-C" argument, and reset it with
1741 "-N". See |-C| and |-N|.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001742 See 'cpoptions' for more fine tuning of Vi compatibility.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001743
Bram Moolenaar214641f2017-03-05 17:04:09 +01001744 When this option is set, numerous other options are set to make Vim as
1745 Vi-compatible as possible. When this option is unset, various options
1746 are set to make Vim more useful. The table below lists all the
1747 options affected.
1748 The {?} column indicates when the options are affected:
1749 + Means that the option is set to the value given in {set value} when
1750 'compatible' is set.
1751 & Means that the option is set to the value given in {set value} when
1752 'compatible' is set AND is set to its Vim default value when
1753 'compatible' is unset.
1754 - Means the option is NOT changed when setting 'compatible' but IS
1755 set to its Vim default when 'compatible' is unset.
1756 The {effect} column summarises the change when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001757
Bram Moolenaar036986f2017-03-16 17:41:02 +01001758 option ? set value effect ~
Bram Moolenaar214641f2017-03-05 17:04:09 +01001759
1760 'allowrevins' + off no CTRL-_ command
1761 'antialias' + off don't use antialiased fonts
1762 'arabic' + off reset arabic-related options
1763 'arabicshape' + on correct character shapes
1764 'backspace' + "" normal backspace
1765 'backup' + off no backup file
1766 'backupcopy' & Unix: "yes" backup file is a copy
1767 else: "auto" copy or rename backup file
1768 'balloonexpr' + "" text to show in evaluation balloon
1769 'breakindent' + off don't indent when wrapping lines
1770 'cedit' - {unchanged} {set vim default only on resetting 'cp'}
1771 'cindent' + off no C code indentation
1772 'compatible' - {unchanged} {set vim default only on resetting 'cp'}
1773 'copyindent' + off don't copy indent structure
1774 'cpoptions' & (all flags) Vi-compatible flags
1775 'cscopepathcomp'+ 0 don't show directories in tags list
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01001776 'cscoperelative'+ off don't use basename of path as prefix
Bram Moolenaar214641f2017-03-05 17:04:09 +01001777 'cscopetag' + off don't use cscope for ":tag"
Bram Moolenaar036986f2017-03-16 17:41:02 +01001778 'cscopetagorder'+ 0 see |cscopetagorder|
Bram Moolenaar214641f2017-03-05 17:04:09 +01001779 'cscopeverbose' + off see |cscopeverbose|
1780 'delcombine' + off unicode: delete whole char combination
1781 'digraph' + off no digraphs
1782 'esckeys' & off no <Esc>-keys in Insert mode
1783 'expandtab' + off tabs not expanded to spaces
1784 'fileformats' & "" no automatic file format detection,
Bram Moolenaar6f345a12019-12-17 21:27:18 +01001785 "dos,unix" except for MS-Windows
Bram Moolenaar214641f2017-03-05 17:04:09 +01001786 'formatexpr' + "" use 'formatprg' for auto-formatting
1787 'formatoptions' & "vt" Vi compatible formatting
1788 'gdefault' + off no default 'g' flag for ":s"
1789 'history' & 0 no commandline history
1790 'hkmap' + off no Hebrew keyboard mapping
1791 'hkmapp' + off no phonetic Hebrew keyboard mapping
1792 'hlsearch' + off no highlighting of search matches
1793 'incsearch' + off no incremental searching
1794 'indentexpr' + "" no indenting by expression
1795 'insertmode' + off do not start in Insert mode
1796 'iskeyword' & "@,48-57,_" keywords contain alphanumeric
Bram Moolenaar071d4272004-06-13 20:20:40 +00001797 characters and '_'
Bram Moolenaar214641f2017-03-05 17:04:09 +01001798 'joinspaces' + on insert 2 spaces after period
1799 'modeline' & off no modelines
1800 'more' & off no pauses in listings
1801 'mzquantum' - {unchanged} {set vim default only on resetting 'cp'}
1802 'numberwidth' & 8 min number of columns for line number
1803 'preserveindent'+ off don't preserve current indent structure
1804 when changing it
1805 'revins' + off no reverse insert
1806 'ruler' + off no ruler
1807 'scrolljump' + 1 no jump scroll
1808 'scrolloff' + 0 no scroll offset
1809 'shelltemp' - {unchanged} {set vim default only on resetting 'cp'}
1810 'shiftround' + off indent not rounded to shiftwidth
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02001811 'shortmess' & "S" no shortening of messages
Bram Moolenaar214641f2017-03-05 17:04:09 +01001812 'showcmd' & off command characters not shown
1813 'showmode' & off current mode not shown
1814 'sidescrolloff' + 0 cursor moves to edge of screen in scroll
1815 'smartcase' + off no automatic ignore case switch
1816 'smartindent' + off no smart indentation
1817 'smarttab' + off no smart tab size
1818 'softtabstop' + 0 tabs are always 'tabstop' positions
1819 'startofline' + on goto startofline with some commands
1820 'tagcase' & "followic" 'ignorecase' when searching tags file
1821 'tagrelative' & off tag file names are not relative
1822 'termguicolors' + off don't use highlight-(guifg|guibg)
1823 'textauto' & off no automatic textmode detection
1824 'textwidth' + 0 no automatic line wrap
1825 'tildeop' + off tilde is not an operator
1826 'ttimeout' + off no terminal timeout
1827 'undofile' + off don't use an undo file
Bram Moolenaar036986f2017-03-16 17:41:02 +01001828 'viminfo' - {unchanged} {set Vim default only on resetting 'cp'}
Bram Moolenaar214641f2017-03-05 17:04:09 +01001829 'virtualedit' + "" cursor can only be placed on characters
1830 'whichwrap' & "" left-right movements don't wrap
1831 'wildchar' & CTRL-E only when the current value is <Tab>
Bram Moolenaar071d4272004-06-13 20:20:40 +00001832 use CTRL-E for cmdline completion
Bram Moolenaar214641f2017-03-05 17:04:09 +01001833 'writebackup' + on or off depends on the |+writebackup| feature
Bram Moolenaar071d4272004-06-13 20:20:40 +00001834
1835 *'complete'* *'cpt'* *E535*
1836'complete' 'cpt' string (default: ".,w,b,u,t,i")
1837 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001838 This option specifies how keyword completion |ins-completion| works
1839 when CTRL-P or CTRL-N are used. It is also used for whole-line
1840 completion |i_CTRL-X_CTRL-L|. It indicates the type of completion
1841 and the places to scan. It is a comma separated list of flags:
Bram Moolenaar3848e002016-03-19 18:42:29 +01001842 . scan the current buffer ('wrapscan' is ignored)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001843 w scan buffers from other windows
1844 b scan other loaded buffers that are in the buffer list
1845 u scan the unloaded buffers that are in the buffer list
1846 U scan the buffers that are not in the buffer list
1847 k scan the files given with the 'dictionary' option
Bram Moolenaar0b238792006-03-02 22:49:12 +00001848 kspell use the currently active spell checking |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001849 k{dict} scan the file {dict}. Several "k" flags can be given,
1850 patterns are valid too. For example: >
1851 :set cpt=k/usr/dict/*,k~/spanish
1852< s scan the files given with the 'thesaurus' option
1853 s{tsr} scan the file {tsr}. Several "s" flags can be given, patterns
1854 are valid too.
1855 i scan current and included files
1856 d scan current and included files for defined name or macro
1857 |i_CTRL-X_CTRL-D|
1858 ] tag completion
1859 t same as "]"
1860
1861 Unloaded buffers are not loaded, thus their autocmds |:autocmd| are
1862 not executed, this may lead to unexpected completions from some files
1863 (gzipped files for example). Unloaded buffers are not scanned for
1864 whole-line completion.
1865
1866 The default is ".,w,b,u,t,i", which means to scan:
1867 1. the current buffer
1868 2. buffers in other windows
1869 3. other loaded buffers
1870 4. unloaded buffers
1871 5. tags
1872 6. included files
1873
1874 As you can see, CTRL-N and CTRL-P can be used to do any 'iskeyword'-
Bram Moolenaar582fd852005-03-28 20:58:01 +00001875 based expansion (e.g., dictionary |i_CTRL-X_CTRL-K|, included patterns
1876 |i_CTRL-X_CTRL-I|, tags |i_CTRL-X_CTRL-]| and normal expansions).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001877
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001878 *'completefunc'* *'cfu'*
1879'completefunc' 'cfu' string (default: empty)
1880 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02001881 {not available when compiled without the |+eval|
Bram Moolenaare2c453d2019-08-21 14:37:09 +02001882 feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00001883 This option specifies a function to be used for Insert mode completion
1884 with CTRL-X CTRL-U. |i_CTRL-X_CTRL-U|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001885 See |complete-functions| for an explanation of how the function is
1886 invoked and what it should return.
Bram Moolenaar166af9b2010-11-16 20:34:40 +01001887 This option cannot be set from a |modeline| or in the |sandbox|, for
1888 security reasons.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00001889
Bram Moolenaarac3150d2019-07-28 16:36:39 +02001890 *'completeslash'* *'csl'*
1891'completeslash' 'csl' string (default: "")
1892 local to buffer
Bram Moolenaar2e693a82019-10-16 22:35:02 +02001893 {only for MS-Windows}
Bram Moolenaarac3150d2019-07-28 16:36:39 +02001894 When this option is set it overrules 'shellslash' for completion:
1895 - When this option is set to "slash", a forward slash is used for path
1896 completion in insert mode. This is useful when editing HTML tag, or
Bram Moolenaar6f345a12019-12-17 21:27:18 +01001897 Makefile with 'noshellslash' on MS-Windows.
Bram Moolenaarac3150d2019-07-28 16:36:39 +02001898 - When this option is set to "backslash", backslash is used. This is
Bram Moolenaar6f345a12019-12-17 21:27:18 +01001899 useful when editing a batch file with 'shellslash' set on MS-Windows.
Bram Moolenaarac3150d2019-07-28 16:36:39 +02001900 - When this option is empty, same character is used as for
1901 'shellslash'.
1902 For Insert mode completion the buffer-local value is used. For
1903 command line completion the global value is used.
1904
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001905 *'completeopt'* *'cot'*
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001906'completeopt' 'cot' string (default: "menu,preview")
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001907 global
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001908 A comma separated list of options for Insert mode completion
1909 |ins-completion|. The supported values are:
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001910
1911 menu Use a popup menu to show the possible completions. The
1912 menu is only shown when there is more than one match and
1913 sufficient colors are available. |ins-completion-menu|
1914
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001915 menuone Use the popup menu also when there is only one match.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00001916 Useful when there is additional information about the
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001917 match, e.g., what file it comes from.
1918
Bram Moolenaarc1e37902006-04-18 21:55:01 +00001919 longest Only insert the longest common text of the matches. If
1920 the menu is displayed you can use CTRL-L to add more
1921 characters. Whether case is ignored depends on the kind
1922 of completion. For buffer text the 'ignorecase' option is
1923 used.
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001924
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001925 preview Show extra information about the currently selected
Bram Moolenaar02467872007-05-06 13:22:01 +00001926 completion in the preview window. Only works in
1927 combination with "menu" or "menuone".
1928
Bram Moolenaar576a4a62019-08-18 15:25:17 +02001929 popup Show extra information about the currently selected
1930 completion in a popup window. Only works in combination
1931 with "menu" or "menuone". Overrides "preview".
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02001932 See |'completepopup'| for specifying properties.
Bram Moolenaar2e693a82019-10-16 22:35:02 +02001933 {only works when compiled with the |+textprop| feature}
Bram Moolenaar576a4a62019-08-18 15:25:17 +02001934
Bram Moolenaardca7abe2019-10-20 18:17:57 +02001935 popuphidden
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01001936 Just like "popup" but initially hide the popup. Use a
Bram Moolenaardca7abe2019-10-20 18:17:57 +02001937 |CompleteChanged| autocommand to fetch the info and call
1938 |popup_show()| once the popup has been filled.
1939 See the example at |complete-popuphidden|.
1940 {only works when compiled with the |+textprop| feature}
1941
Bram Moolenaarb6be1e22015-07-10 18:18:40 +02001942 noinsert Do not insert any text for a match until the user selects
1943 a match from the menu. Only works in combination with
1944 "menu" or "menuone". No effect if "longest" is present.
1945
1946 noselect Do not select a match in the menu, force the user to
1947 select one from the menu. Only works in combination with
1948 "menu" or "menuone".
1949
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001950
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02001951 *'completepopup'* *'cpp'*
1952'completepopup' 'cpp' string (default empty)
1953 global
1954 {not available when compiled without the |+textprop|
1955 or |+quickfix| feature}
1956 When 'completeopt' contains "popup" then this option is used for the
Bram Moolenaar447bfba2020-07-18 16:07:16 +02001957 properties of the info popup when it is created. If an info popup
1958 window already exists it is closed, so that the option value is
1959 applied when it is created again.
1960 You can also use |popup_findinfo()| and then set properties for an
1961 existing info popup with |popup_setoptions()|. See |complete-popup|.
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02001962
1963
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001964 *'concealcursor'* *'cocu'*
1965'concealcursor' 'cocu' string (default: "")
1966 local to window
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001967 {not available when compiled without the |+conceal|
1968 feature}
1969 Sets the modes in which text in the cursor line can also be concealed.
1970 When the current mode is listed then concealing happens just like in
1971 other lines.
1972 n Normal mode
1973 v Visual mode
1974 i Insert mode
Bram Moolenaarca8c9862010-07-24 15:00:38 +02001975 c Command line editing, for 'incsearch'
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001976
Bram Moolenaare6dc5732010-07-24 23:52:26 +02001977 'v' applies to all lines in the Visual area, not only the cursor.
Bram Moolenaarca8c9862010-07-24 15:00:38 +02001978 A useful value is "nc". This is used in help files. So long as you
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001979 are moving around text is concealed, but when starting to insert text
1980 or selecting a Visual area the concealed text is displayed, so that
1981 you can see what you are doing.
Bram Moolenaarf70e3d62010-07-24 13:15:07 +02001982 Keep in mind that the cursor position is not always where it's
1983 displayed. E.g., when moving vertically it may change column.
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001984
1985
Bram Moolenaar95bafa22018-10-02 13:26:25 +02001986 *'conceallevel'* *'cole'*
1987'conceallevel' 'cole' number (default 0)
Bram Moolenaar860cae12010-06-05 23:22:07 +02001988 local to window
Bram Moolenaar860cae12010-06-05 23:22:07 +02001989 {not available when compiled without the |+conceal|
1990 feature}
Bram Moolenaar6df6f472010-07-18 18:04:50 +02001991 Determine how text with the "conceal" syntax attribute |:syn-conceal|
1992 is shown:
Bram Moolenaar860cae12010-06-05 23:22:07 +02001993
Bram Moolenaar6df6f472010-07-18 18:04:50 +02001994 Value Effect ~
Bram Moolenaar860cae12010-06-05 23:22:07 +02001995 0 Text is shown normally
Bram Moolenaar477db062010-07-28 18:17:41 +02001996 1 Each block of concealed text is replaced with one
1997 character. If the syntax item does not have a custom
1998 replacement character defined (see |:syn-cchar|) the
1999 character defined in 'listchars' is used (default is a
2000 space).
2001 It is highlighted with the "Conceal" highlight group.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002002 2 Concealed text is completely hidden unless it has a
2003 custom replacement character defined (see
Bram Moolenaar477db062010-07-28 18:17:41 +02002004 |:syn-cchar|).
Bram Moolenaara7781e02010-07-19 20:13:22 +02002005 3 Concealed text is completely hidden.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002006
Bram Moolenaara7781e02010-07-19 20:13:22 +02002007 Note: in the cursor line concealed text is not hidden, so that you can
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002008 edit and copy the text. This can be changed with the 'concealcursor'
2009 option.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002010
Bram Moolenaar071d4272004-06-13 20:20:40 +00002011 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
2012'confirm' 'cf' boolean (default off)
2013 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002014 When 'confirm' is on, certain operations that would normally
2015 fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
2016 instead raise a |dialog| asking if you wish to save the current
2017 file(s). You can still use a ! to unconditionally |abandon| a buffer.
2018 If 'confirm' is off you can still activate confirmation for one
2019 command only (this is most useful in mappings) with the |:confirm|
2020 command.
2021 Also see the |confirm()| function and the 'v' flag in 'guioptions'.
2022
2023 *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
2024'conskey' 'consk' boolean (default off)
2025 global
Bram Moolenaarf3913272016-02-25 00:00:01 +01002026 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002027
2028 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
2029'copyindent' 'ci' boolean (default off)
2030 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002031 Copy the structure of the existing lines indent when autoindenting a
2032 new line. Normally the new indent is reconstructed by a series of
2033 tabs followed by spaces as required (unless |'expandtab'| is enabled,
2034 in which case only spaces are used). Enabling this option makes the
2035 new line copy whatever characters were used for indenting on the
Bram Moolenaar446cb832008-06-24 21:56:24 +00002036 existing line. 'expandtab' has no effect on these characters, a Tab
2037 remains a Tab. If the new indent is greater than on the existing
Bram Moolenaar071d4272004-06-13 20:20:40 +00002038 line, the remaining space is filled in the normal manner.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002039 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002040 Also see 'preserveindent'.
2041
Bram Moolenaare0fa3742016-02-20 15:47:01 +01002042 *'cpoptions'* *'cpo'* *cpo*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002043'cpoptions' 'cpo' string (Vim default: "aABceFs",
2044 Vi default: all flags)
2045 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002046 A sequence of single character flags. When a character is present
Bram Moolenaar7cba6c02013-09-05 22:13:31 +02002047 this indicates Vi-compatible behavior. This is used for things where
2048 not being Vi-compatible is mostly or sometimes preferred.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002049 'cpoptions' stands for "compatible-options".
2050 Commas can be added for readability.
2051 To avoid problems with flags that are added in the future, use the
2052 "+=" and "-=" feature of ":set" |add-option-flags|.
2053 NOTE: This option is set to the Vi default value when 'compatible' is
2054 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002055 NOTE: This option is set to the POSIX default value at startup when
2056 the Vi default value would be used and the $VIM_POSIX environment
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002057 variable exists |posix|. This means Vim tries to behave like the
2058 POSIX specification.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002059
2060 contains behavior ~
2061 *cpo-a*
2062 a When included, a ":read" command with a file name
2063 argument will set the alternate file name for the
2064 current window.
2065 *cpo-A*
2066 A When included, a ":write" command with a file name
2067 argument will set the alternate file name for the
2068 current window.
2069 *cpo-b*
2070 b "\|" in a ":map" command is recognized as the end of
2071 the map command. The '\' is included in the mapping,
2072 the text after the '|' is interpreted as the next
2073 command. Use a CTRL-V instead of a backslash to
2074 include the '|' in the mapping. Applies to all
2075 mapping, abbreviation, menu and autocmd commands.
2076 See also |map_bar|.
2077 *cpo-B*
2078 B A backslash has no special meaning in mappings,
Bram Moolenaara9604e62018-07-21 05:56:22 +02002079 abbreviations, user commands and the "to" part of the
2080 menu commands. Remove this flag to be able to use a
2081 backslash like a CTRL-V. For example, the command
2082 ":map X \<Esc>" results in X being mapped to:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002083 'B' included: "\^[" (^[ is a real <Esc>)
2084 'B' excluded: "<Esc>" (5 characters)
2085 ('<' excluded in both cases)
2086 *cpo-c*
2087 c Searching continues at the end of any match at the
2088 cursor position, but not further than the start of the
2089 next line. When not present searching continues
2090 one character from the cursor position. With 'c'
2091 "abababababab" only gets three matches when repeating
2092 "/abab", without 'c' there are five matches.
2093 *cpo-C*
2094 C Do not concatenate sourced lines that start with a
2095 backslash. See |line-continuation|.
2096 *cpo-d*
2097 d Using "./" in the 'tags' option doesn't mean to use
2098 the tags file relative to the current file, but the
2099 tags file in the current directory.
2100 *cpo-D*
2101 D Can't use CTRL-K to enter a digraph after Normal mode
2102 commands with a character argument, like |r|, |f| and
2103 |t|.
2104 *cpo-e*
2105 e When executing a register with ":@r", always add a
2106 <CR> to the last line, also when the register is not
2107 linewise. If this flag is not present, the register
2108 is not linewise and the last line does not end in a
2109 <CR>, then the last line is put on the command-line
2110 and can be edited before hitting <CR>.
2111 *cpo-E*
2112 E It is an error when using "y", "d", "c", "g~", "gu" or
2113 "gU" on an Empty region. The operators only work when
Bram Moolenaar15142e22018-04-30 22:19:58 +02002114 at least one character is to be operated on. Example:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002115 This makes "y0" fail in the first column.
2116 *cpo-f*
2117 f When included, a ":read" command with a file name
2118 argument will set the file name for the current buffer,
2119 if the current buffer doesn't have a file name yet.
2120 *cpo-F*
2121 F When included, a ":write" command with a file name
2122 argument will set the file name for the current
2123 buffer, if the current buffer doesn't have a file name
Bram Moolenaarb3480382005-12-11 21:33:32 +00002124 yet. Also see |cpo-P|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002125 *cpo-g*
2126 g Goto line 1 when using ":edit" without argument.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002127 *cpo-H*
2128 H When using "I" on a line with only blanks, insert
2129 before the last blank. Without this flag insert after
2130 the last blank.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002131 *cpo-i*
2132 i When included, interrupting the reading of a file will
2133 leave it modified.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002134 *cpo-I*
2135 I When moving the cursor up or down just after inserting
2136 indent for 'autoindent', do not delete the indent.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002137 *cpo-j*
2138 j When joining lines, only add two spaces after a '.',
2139 not after '!' or '?'. Also see 'joinspaces'.
2140 *cpo-J*
2141 J A |sentence| has to be followed by two spaces after
Bram Moolenaar582fd852005-03-28 20:58:01 +00002142 the '.', '!' or '?'. A <Tab> is not recognized as
Bram Moolenaar071d4272004-06-13 20:20:40 +00002143 white space.
2144 *cpo-k*
2145 k Disable the recognition of raw key codes in
2146 mappings, abbreviations, and the "to" part of menu
2147 commands. For example, if <Key> sends ^[OA (where ^[
2148 is <Esc>), the command ":map X ^[OA" results in X
2149 being mapped to:
2150 'k' included: "^[OA" (3 characters)
2151 'k' excluded: "<Key>" (one key code)
2152 Also see the '<' flag below.
2153 *cpo-K*
2154 K Don't wait for a key code to complete when it is
2155 halfway a mapping. This breaks mapping <F1><F1> when
2156 only part of the second <F1> has been read. It
2157 enables cancelling the mapping by typing <F1><Esc>.
2158 *cpo-l*
2159 l Backslash in a [] range in a search pattern is taken
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002160 literally, only "\]", "\^", "\-" and "\\" are special.
2161 See |/[]|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002162 'l' included: "/[ \t]" finds <Space>, '\' and 't'
2163 'l' excluded: "/[ \t]" finds <Space> and <Tab>
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002164 Also see |cpo-\|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002165 *cpo-L*
2166 L When the 'list' option is set, 'wrapmargin',
2167 'textwidth', 'softtabstop' and Virtual Replace mode
2168 (see |gR|) count a <Tab> as two characters, instead of
2169 the normal behavior of a <Tab>.
2170 *cpo-m*
2171 m When included, a showmatch will always wait half a
2172 second. When not included, a showmatch will wait half
2173 a second or until a character is typed. |'showmatch'|
2174 *cpo-M*
2175 M When excluded, "%" matching will take backslashes into
2176 account. Thus in "( \( )" and "\( ( \)" the outer
2177 parenthesis match. When included "%" ignores
2178 backslashes, which is Vi compatible.
2179 *cpo-n*
Bram Moolenaar64486672010-05-16 15:46:46 +02002180 n When included, the column used for 'number' and
2181 'relativenumber' will also be used for text of wrapped
2182 lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002183 *cpo-o*
2184 o Line offset to search command is not remembered for
2185 next search.
2186 *cpo-O*
2187 O Don't complain if a file is being overwritten, even
2188 when it didn't exist when editing it. This is a
2189 protection against a file unexpectedly created by
2190 someone else. Vi didn't complain about this.
2191 *cpo-p*
2192 p Vi compatible Lisp indenting. When not present, a
2193 slightly better algorithm is used.
Bram Moolenaarb3480382005-12-11 21:33:32 +00002194 *cpo-P*
2195 P When included, a ":write" command that appends to a
2196 file will set the file name for the current buffer, if
2197 the current buffer doesn't have a file name yet and
2198 the 'F' flag is also included |cpo-F|.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002199 *cpo-q*
2200 q When joining multiple lines leave the cursor at the
2201 position where it would be when joining two lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002202 *cpo-r*
2203 r Redo ("." command) uses "/" to repeat a search
2204 command, instead of the actually used search string.
2205 *cpo-R*
2206 R Remove marks from filtered lines. Without this flag
2207 marks are kept like |:keepmarks| was used.
2208 *cpo-s*
2209 s Set buffer options when entering the buffer for the
2210 first time. This is like it is in Vim version 3.0.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002211 And it is the default. If not present the options are
Bram Moolenaar071d4272004-06-13 20:20:40 +00002212 set when the buffer is created.
2213 *cpo-S*
2214 S Set buffer options always when entering a buffer
2215 (except 'readonly', 'fileformat', 'filetype' and
2216 'syntax'). This is the (most) Vi compatible setting.
2217 The options are set to the values in the current
2218 buffer. When you change an option and go to another
2219 buffer, the value is copied. Effectively makes the
2220 buffer options global to all buffers.
2221
2222 's' 'S' copy buffer options
2223 no no when buffer created
2224 yes no when buffer first entered (default)
2225 X yes each time when buffer entered (vi comp.)
2226 *cpo-t*
2227 t Search pattern for the tag command is remembered for
2228 "n" command. Otherwise Vim only puts the pattern in
2229 the history for search pattern, but doesn't change the
2230 last used search pattern.
2231 *cpo-u*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002232 u Undo is Vi compatible. See |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002233 *cpo-v*
2234 v Backspaced characters remain visible on the screen in
2235 Insert mode. Without this flag the characters are
2236 erased from the screen right away. With this flag the
2237 screen newly typed text overwrites backspaced
2238 characters.
2239 *cpo-w*
2240 w When using "cw" on a blank character, only change one
2241 character and not all blanks until the start of the
2242 next word.
2243 *cpo-W*
2244 W Don't overwrite a readonly file. When omitted, ":w!"
2245 overwrites a readonly file, if possible.
2246 *cpo-x*
2247 x <Esc> on the command-line executes the command-line.
2248 The default in Vim is to abandon the command-line,
2249 because <Esc> normally aborts a command. |c_<Esc>|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002250 *cpo-X*
2251 X When using a count with "R" the replaced text is
2252 deleted only once. Also when repeating "R" with "."
2253 and a count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002254 *cpo-y*
Bram Moolenaard09091d2019-01-17 16:07:22 +01002255 y A yank command can be redone with ".". Think twice if
2256 you really want to use this, it may break some
2257 plugins, since most people expect "." to only repeat a
2258 change.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002259 *cpo-Z*
2260 Z When using "w!" while the 'readonly' option is set,
2261 don't reset 'readonly'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002262 *cpo-!*
2263 ! When redoing a filter command, use the last used
2264 external command, whatever it was. Otherwise the last
2265 used -filter- command is used.
2266 *cpo-$*
2267 $ When making a change to one line, don't redisplay the
2268 line, but put a '$' at the end of the changed text.
2269 The changed text will be overwritten when you type the
2270 new text. The line is redisplayed if you type any
2271 command that moves the cursor from the insertion
2272 point.
2273 *cpo-%*
2274 % Vi-compatible matching is done for the "%" command.
2275 Does not recognize "#if", "#endif", etc.
2276 Does not recognize "/*" and "*/".
2277 Parens inside single and double quotes are also
2278 counted, causing a string that contains a paren to
2279 disturb the matching. For example, in a line like
2280 "if (strcmp("foo(", s))" the first paren does not
2281 match the last one. When this flag is not included,
2282 parens inside single and double quotes are treated
2283 specially. When matching a paren outside of quotes,
2284 everything inside quotes is ignored. When matching a
2285 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002286 there is one). This works very well for C programs.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002287 This flag is also used for other features, such as
2288 C-indenting.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002289 *cpo--*
2290 - When included, a vertical movement command fails when
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002291 it would go above the first line or below the last
2292 line. Without it the cursor moves to the first or
2293 last line, unless it already was in that line.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002294 Applies to the commands "-", "k", CTRL-P, "+", "j",
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002295 CTRL-N, CTRL-J and ":1234".
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002296 *cpo-+*
2297 + When included, a ":write file" command will reset the
2298 'modified' flag of the buffer, even though the buffer
2299 itself may still be different from its file.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002300 *cpo-star*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002301 * Use ":*" in the same way as ":@". When not included,
2302 ":*" is an alias for ":'<,'>", select the Visual area.
2303 *cpo-<*
2304 < Disable the recognition of special key codes in |<>|
2305 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002306 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00002307 ":map X <Tab>" results in X being mapped to:
2308 '<' included: "<Tab>" (5 characters)
2309 '<' excluded: "^I" (^I is a real <Tab>)
2310 Also see the 'k' flag above.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002311 *cpo->*
2312 > When appending to a register, put a line break before
2313 the appended text.
Bram Moolenaar8b3e0332011-06-26 05:36:34 +02002314 *cpo-;*
2315 ; When using |,| or |;| to repeat the last |t| search
2316 and the cursor is right in front of the searched
2317 character, the cursor won't move. When not included,
2318 the cursor would skip over it and jump to the
Bram Moolenaarc8734422012-06-01 22:38:45 +02002319 following occurrence.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002320
2321 POSIX flags. These are not included in the Vi default value, except
2322 when $VIM_POSIX was set on startup. |posix|
2323
2324 contains behavior ~
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002325 *cpo-#*
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002326 # A count before "D", "o" and "O" has no effect.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002327 *cpo-&*
2328 & When ":preserve" was used keep the swap file when
2329 exiting normally while this buffer is still loaded.
2330 This flag is tested when exiting.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002331 *cpo-\*
2332 \ Backslash in a [] range in a search pattern is taken
2333 literally, only "\]" is special See |/[]|
Bram Moolenaar90915b52005-08-21 22:17:52 +00002334 '\' included: "/[ \-]" finds <Space>, '\' and '-'
2335 '\' excluded: "/[ \-]" finds <Space> and '-'
2336 Also see |cpo-l|.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002337 *cpo-/*
2338 / When "%" is used as the replacement string in a |:s|
2339 command, use the previous replacement string. |:s%|
2340 *cpo-{*
2341 { The |{| and |}| commands also stop at a "{" character
2342 at the start of a line.
2343 *cpo-.*
2344 . The ":chdir" and ":cd" commands fail if the current
2345 buffer is modified, unless ! is used. Vim doesn't
2346 need this, since it remembers the full path of an
2347 opened file.
2348 *cpo-bar*
2349 | The value of the $LINES and $COLUMNS environment
2350 variables overrule the terminal size values obtained
2351 with system specific functions.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002352
Bram Moolenaar071d4272004-06-13 20:20:40 +00002353
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002354 *'cryptmethod'* *'cm'*
Bram Moolenaara86187b2018-12-16 18:20:00 +01002355'cryptmethod' 'cm' string (default "blowfish2")
Bram Moolenaar49771f42010-07-20 17:32:38 +02002356 global or local to buffer |global-local|
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002357 Method used for encryption when the buffer is written to a file:
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002358 *pkzip*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002359 zip PkZip compatible method. A weak kind of encryption.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002360 Backwards compatible with Vim 7.2 and older.
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002361 *blowfish*
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002362 blowfish Blowfish method. Medium strong encryption but it has
2363 an implementation flaw. Requires Vim 7.3 or later,
2364 files can NOT be read by Vim 7.2 and older. This adds
2365 a "seed" to the file, every time you write the file
2366 the encrypted bytes will be different.
2367 *blowfish2*
2368 blowfish2 Blowfish method. Medium strong encryption. Requires
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01002369 Vim 7.4.401 or later, files can NOT be read by Vim 7.3
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002370 and older. This adds a "seed" to the file, every time
2371 you write the file the encrypted bytes will be
2372 different. The whole undo file is encrypted, not just
2373 the pieces of text.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002374
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01002375 You should use "blowfish2", also to re-encrypt older files.
2376
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002377 When reading an encrypted file 'cryptmethod' will be set automatically
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002378 to the detected method of the file being read. Thus if you write it
2379 without changing 'cryptmethod' the same method will be used.
2380 Changing 'cryptmethod' does not mark the file as modified, you have to
Bram Moolenaar49771f42010-07-20 17:32:38 +02002381 explicitly write it, you don't get a warning unless there are other
2382 modifications. Also see |:X|.
2383
2384 When setting the global value to an empty string, it will end up with
Bram Moolenaara86187b2018-12-16 18:20:00 +01002385 the value "blowfish2". When setting the local value to an empty
2386 string the buffer will use the global value.
Bram Moolenaar49771f42010-07-20 17:32:38 +02002387
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002388 When a new encryption method is added in a later version of Vim, and
2389 the current version does not recognize it, you will get *E821* .
Bram Moolenaar49771f42010-07-20 17:32:38 +02002390 You need to edit this file with the later version of Vim.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002391
2392
Bram Moolenaar071d4272004-06-13 20:20:40 +00002393 *'cscopepathcomp'* *'cspc'*
2394'cscopepathcomp' 'cspc' number (default 0)
2395 global
2396 {not available when compiled without the |+cscope|
2397 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002398 Determines how many components of the path to show in a list of tags.
2399 See |cscopepathcomp|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002400 NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002401
2402 *'cscopeprg'* *'csprg'*
2403'cscopeprg' 'csprg' string (default "cscope")
2404 global
2405 {not available when compiled without the |+cscope|
2406 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002407 Specifies the command to execute cscope. See |cscopeprg|.
2408 This option cannot be set from a |modeline| or in the |sandbox|, for
2409 security reasons.
2410
2411 *'cscopequickfix'* *'csqf'*
2412'cscopequickfix' 'csqf' string (default "")
2413 global
2414 {not available when compiled without the |+cscope|
2415 or |+quickfix| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002416 Specifies whether to use quickfix window to show cscope results.
2417 See |cscopequickfix|.
2418
Bram Moolenaarec7944a2013-06-12 21:29:15 +02002419 *'cscoperelative'* *'csre'* *'nocscoperelative'* *'nocsre'*
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002420'cscoperelative' 'csre' boolean (default off)
2421 global
2422 {not available when compiled without the |+cscope|
2423 feature}
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002424 In the absence of a prefix (-P) for cscope. setting this option enables
2425 to use the basename of cscope.out path as the prefix.
2426 See |cscoperelative|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002427 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002428
Bram Moolenaar071d4272004-06-13 20:20:40 +00002429 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
2430'cscopetag' 'cst' boolean (default off)
2431 global
2432 {not available when compiled without the |+cscope|
2433 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002434 Use cscope for tag commands. See |cscope-options|.
2435 NOTE: This option is reset when 'compatible' is set.
2436
2437 *'cscopetagorder'* *'csto'*
2438'cscopetagorder' 'csto' number (default 0)
2439 global
2440 {not available when compiled without the |+cscope|
2441 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002442 Determines the order in which ":cstag" performs a search. See
2443 |cscopetagorder|.
2444 NOTE: This option is set to 0 when 'compatible' is set.
2445
2446 *'cscopeverbose'* *'csverb'*
2447 *'nocscopeverbose'* *'nocsverb'*
2448'cscopeverbose' 'csverb' boolean (default off)
2449 global
2450 {not available when compiled without the |+cscope|
2451 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002452 Give messages when adding a cscope database. See |cscopeverbose|.
2453 NOTE: This option is reset when 'compatible' is set.
2454
Bram Moolenaar860cae12010-06-05 23:22:07 +02002455 *'cursorbind'* *'crb'* *'nocursorbind'* *'nocrb'*
2456'cursorbind' 'crb' boolean (default off)
2457 local to window
Bram Moolenaar860cae12010-06-05 23:22:07 +02002458 When this option is set, as the cursor in the current
2459 window moves other cursorbound windows (windows that also have
2460 this option set) move their cursors to the corresponding line and
2461 column. This option is useful for viewing the
2462 differences between two versions of a file (see 'diff'); in diff mode,
2463 inserted and deleted lines (though not characters within a line) are
Bram Moolenaar1a384422010-07-14 19:53:30 +02002464 taken into account.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002465
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002466
2467 *'cursorcolumn'* *'cuc'* *'nocursorcolumn'* *'nocuc'*
2468'cursorcolumn' 'cuc' boolean (default off)
2469 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02002470 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002471 feature}
2472 Highlight the screen column of the cursor with CursorColumn
2473 |hl-CursorColumn|. Useful to align text. Will make screen redrawing
2474 slower.
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00002475 If you only want the highlighting in the current window you can use
2476 these autocommands: >
2477 au WinLeave * set nocursorline nocursorcolumn
2478 au WinEnter * set cursorline cursorcolumn
2479<
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002480
2481 *'cursorline'* *'cul'* *'nocursorline'* *'nocul'*
2482'cursorline' 'cul' boolean (default off)
2483 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02002484 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002485 feature}
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002486 Highlight the text line of the cursor with CursorLine |hl-CursorLine|.
2487 Useful to easily spot the cursor. Will make screen redrawing slower.
Bram Moolenaare2f98b92006-03-29 21:18:24 +00002488 When Visual mode is active the highlighting isn't used to make it
Bram Moolenaar779b74b2006-04-10 14:55:34 +00002489 easier to see the selected text.
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002490
2491
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002492 *'cursorlineopt'* *'culopt'*
Bram Moolenaar017ba072019-09-14 21:01:23 +02002493'cursorlineopt' 'culopt' string (default: "number,line")
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002494 local to window
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002495 {not available when compiled without the |+syntax|
2496 feature}
Bram Moolenaar017ba072019-09-14 21:01:23 +02002497 Comma separated list of settings for how 'cursorline' is displayed.
2498 Valid values:
2499 "line" Highlight the text line of the cursor with
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002500 CursorLine |hl-CursorLine|.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002501 "screenline" Highlight only the screen line of the cursor with
2502 CursorLine |hl-CursorLine|.
2503 "number" Highlight the line number of the cursor with
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002504 CursorLineNr |hl-CursorLineNr|.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002505
2506 Special value:
2507 "both" Alias for the values "line,number".
2508
2509 "line" and "screenline" cannot be used together.
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002510
2511
Bram Moolenaar071d4272004-06-13 20:20:40 +00002512 *'debug'*
2513'debug' string (default "")
2514 global
Bram Moolenaar57657d82006-04-21 22:12:41 +00002515 These values can be used:
2516 msg Error messages that would otherwise be omitted will be given
2517 anyway.
2518 throw Error messages that would otherwise be omitted will be given
2519 anyway and also throw an exception and set |v:errmsg|.
2520 beep A message will be given when otherwise only a beep would be
2521 produced.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002522 The values can be combined, separated by a comma.
Bram Moolenaar57657d82006-04-21 22:12:41 +00002523 "msg" and "throw" are useful for debugging 'foldexpr', 'formatexpr' or
2524 'indentexpr'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002525
2526 *'define'* *'def'*
2527'define' 'def' string (default "^\s*#\s*define")
2528 global or local to buffer |global-local|
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002529 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002530 pattern, just like for the "/" command. This option is used for the
2531 commands like "[i" and "[d" |include-search|. The 'isident' option is
2532 used to recognize the defined name after the match:
2533 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2534 See |option-backslash| about inserting backslashes to include a space
2535 or backslash.
2536 The default value is for C programs. For C++ this value would be
2537 useful, to include const type declarations: >
2538 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
Bram Moolenaar63b74a82019-03-24 15:09:13 +01002539< You can also use "\ze" just before the name and continue the pattern
2540 to check what is following. E.g. for Javascript, if a function is
2541 defined with "func_name = function(args)": >
2542 ^\s*\ze\i\+\s*=\s*function(
2543< If the function is defined with "func_name : function() {...": >
2544 ^\s*\ze\i\+\s*[:]\s*(*function\s*(
Bram Moolenaar071d4272004-06-13 20:20:40 +00002545< When using the ":set" command, you need to double the backslashes!
Bram Moolenaar63b74a82019-03-24 15:09:13 +01002546 To avoid that use `:let` with a single quote string: >
2547 let &l:define = '^\s*\ze\k\+\s*=\s*function('
Bram Moolenaar911ead12019-04-21 00:03:35 +02002548<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002549
2550 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2551'delcombine' 'deco' boolean (default off)
2552 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002553 If editing Unicode and this option is set, backspace and Normal mode
2554 "x" delete each combining character on its own. When it is off (the
2555 default) the character along with its combining characters are
2556 deleted.
Bram Moolenaar4f4d51a2020-10-11 13:57:40 +02002557 Note: When 'delcombine' is set "xx" may work differently from "2x"!
Bram Moolenaar071d4272004-06-13 20:20:40 +00002558
2559 This is useful for Arabic, Hebrew and many other languages where one
2560 may have combining characters overtop of base characters, and want
2561 to remove only the combining ones.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002562 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002563
2564 *'dictionary'* *'dict'*
2565'dictionary' 'dict' string (default "")
2566 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002567 List of file names, separated by commas, that are used to lookup words
2568 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2569 contain a list of words. This can be one word per line, or several
2570 words per line, separated by non-keyword characters (white space is
2571 preferred). Maximum line length is 510 bytes.
Bram Moolenaar259f26a2018-05-15 22:25:40 +02002572
2573 When this option is empty or an entry "spell" is present, and spell
2574 checking is enabled, words in the word lists for the currently active
2575 'spelllang' are used. See |spell|.
2576
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002577 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002578 after a comma are ignored, otherwise spaces are included in the file
2579 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002580 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002581 Where to find a list of words?
2582 - On FreeBSD, there is the file "/usr/share/dict/words".
2583 - In the Simtel archive, look in the "msdos/linguist" directory.
2584 - In "miscfiles" of the GNU collection.
2585 The use of |:set+=| and |:set-=| is preferred when adding or removing
2586 directories from the list. This avoids problems when a future version
2587 uses another default.
2588 Backticks cannot be used in this option for security reasons.
2589
2590 *'diff'* *'nodiff'*
2591'diff' boolean (default off)
2592 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00002593 {not available when compiled without the |+diff|
2594 feature}
2595 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002596 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002597
2598 *'dex'* *'diffexpr'*
2599'diffexpr' 'dex' string (default "")
2600 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002601 {not available when compiled without the |+diff|
2602 feature}
Bram Moolenaare828b762018-09-10 17:51:58 +02002603 Expression which is evaluated to obtain a diff file (either ed-style
2604 or unified-style) from two versions of a file. See |diff-diffexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002605 This option cannot be set from a |modeline| or in the |sandbox|, for
2606 security reasons.
2607
2608 *'dip'* *'diffopt'*
Bram Moolenaarc8234772019-11-10 21:00:27 +01002609'diffopt' 'dip' string (default "internal,filler,closeoff")
Bram Moolenaar071d4272004-06-13 20:20:40 +00002610 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002611 {not available when compiled without the |+diff|
2612 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002613 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002614 All are optional. Items must be separated by a comma.
2615
2616 filler Show filler lines, to keep the text
2617 synchronized with a window that has inserted
2618 lines at the same position. Mostly useful
2619 when windows are side-by-side and 'scrollbind'
2620 is set.
2621
2622 context:{n} Use a context of {n} lines between a change
2623 and a fold that contains unchanged lines.
2624 When omitted a context of six lines is used.
Bram Moolenaarf6b40102019-02-22 15:24:03 +01002625 When using zero the context is actually one,
2626 since folds require a line in between, also
2627 for a deleted line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002628 See |fold-diff|.
2629
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002630 iblank Ignore changes where lines are all blank. Adds
2631 the "-B" flag to the "diff" command if
2632 'diffexpr' is empty. Check the documentation
2633 of the "diff" command for what this does
2634 exactly.
2635 NOTE: the diff windows will get out of sync,
2636 because no differences between blank lines are
2637 taken into account.
2638
Bram Moolenaar071d4272004-06-13 20:20:40 +00002639 icase Ignore changes in case of text. "a" and "A"
2640 are considered the same. Adds the "-i" flag
2641 to the "diff" command if 'diffexpr' is empty.
2642
2643 iwhite Ignore changes in amount of white space. Adds
2644 the "-b" flag to the "diff" command if
2645 'diffexpr' is empty. Check the documentation
2646 of the "diff" command for what this does
2647 exactly. It should ignore adding trailing
2648 white space, but not leading white space.
2649
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002650 iwhiteall Ignore all white space changes. Adds
2651 the "-w" flag to the "diff" command if
2652 'diffexpr' is empty. Check the documentation
2653 of the "diff" command for what this does
2654 exactly.
2655
2656 iwhiteeol Ignore white space changes at end of line.
2657 Adds the "-Z" flag to the "diff" command if
2658 'diffexpr' is empty. Check the documentation
2659 of the "diff" command for what this does
2660 exactly.
2661
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002662 horizontal Start diff mode with horizontal splits (unless
2663 explicitly specified otherwise).
2664
2665 vertical Start diff mode with vertical splits (unless
2666 explicitly specified otherwise).
2667
Bram Moolenaarc8234772019-11-10 21:00:27 +01002668 closeoff When a window is closed where 'diff' is set
2669 and there is only one window remaining in the
2670 same tab page with 'diff' set, execute
2671 `:diffoff` in that window. This undoes a
2672 `:diffsplit` command.
2673
Bram Moolenaar97ce4192017-12-01 20:35:58 +01002674 hiddenoff Do not use diff mode for a buffer when it
2675 becomes hidden.
2676
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002677 foldcolumn:{n} Set the 'foldcolumn' option to {n} when
2678 starting diff mode. Without this 2 is used.
2679
Bram Moolenaare828b762018-09-10 17:51:58 +02002680 internal Use the internal diff library. This is
2681 ignored when 'diffexpr' is set. *E960*
2682 When running out of memory when writing a
2683 buffer this item will be ignored for diffs
2684 involving that buffer. Set the 'verbose'
2685 option to see when this happens.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002686
Bram Moolenaare828b762018-09-10 17:51:58 +02002687 indent-heuristic
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01002688 Use the indent heuristic for the internal
2689 diff library.
Bram Moolenaare828b762018-09-10 17:51:58 +02002690
2691 algorithm:{text} Use the specified diff algorithm with the
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01002692 internal diff engine. Currently supported
Bram Moolenaare828b762018-09-10 17:51:58 +02002693 algorithms are:
2694 myers the default algorithm
2695 minimal spend extra time to generate the
2696 smallest possible diff
2697 patience patience diff algorithm
2698 histogram histogram diff algorithm
2699
2700 Examples: >
2701 :set diffopt=internal,filler,context:4
Bram Moolenaar071d4272004-06-13 20:20:40 +00002702 :set diffopt=
Bram Moolenaare828b762018-09-10 17:51:58 +02002703 :set diffopt=internal,filler,foldcolumn:3
2704 :set diffopt-=internal " do NOT use the internal diff parser
Bram Moolenaar071d4272004-06-13 20:20:40 +00002705<
2706 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
2707'digraph' 'dg' boolean (default off)
2708 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002709 {not available when compiled without the |+digraphs|
2710 feature}
2711 Enable the entering of digraphs in Insert mode with {char1} <BS>
2712 {char2}. See |digraphs|.
2713 NOTE: This option is reset when 'compatible' is set.
2714
2715 *'directory'* *'dir'*
2716'directory' 'dir' string (default for Amiga: ".,t:",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01002717 for Win32: ".,$TEMP,c:\tmp,c:\temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00002718 for Unix: ".,~/tmp,/var/tmp,/tmp")
2719 global
2720 List of directory names for the swap file, separated with commas.
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02002721 Recommended value: ".,~/vimswap//" - this will put the swap file next
2722 to the edited file if possible, and in your personal swap directory
2723 otherwise. Make sure "~/vimswap//" is only readable for you.
2724
2725 Possible items:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002726 - The swap file will be created in the first directory where this is
2727 possible.
2728 - Empty means that no swap file will be used (recovery is
Bram Moolenaar00e192b2019-10-19 17:01:28 +02002729 impossible!) and no |E303| error will be given.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002730 - A directory "." means to put the swap file in the same directory as
2731 the edited file. On Unix, a dot is prepended to the file name, so
2732 it doesn't show in a directory listing. On MS-Windows the "hidden"
2733 attribute is set and a dot prepended if possible.
Bram Moolenaar8024f932020-01-14 19:29:13 +01002734 - A directory starting with "./" (or ".\" for MS-Windows) means to put
2735 the swap file relative to where the edited file is. The leading "."
2736 is replaced with the path name of the edited file.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02002737 - For Unix and Win32, if a directory ends in two path separators "//",
2738 the swap file name will be built from the complete path to the file
Bram Moolenaar207f0092020-08-30 17:20:20 +02002739 with all path separators replaced by percent '%' signs (including
2740 the colon following the drive letter on Win32). This will ensure
2741 file name uniqueness in the preserve directory.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02002742 On Win32, it is also possible to end with "\\". However, When a
2743 separating comma is following, you must use "//", since "\\" will
2744 include the comma in the file name. Therefore it is recommended to
2745 use '//', instead of '\\'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002746 - Spaces after the comma are ignored, other spaces are considered part
2747 of the directory name. To have a space at the start of a directory
2748 name, precede it with a backslash.
2749 - To include a comma in a directory name precede it with a backslash.
2750 - A directory name may end in an ':' or '/'.
2751 - Environment variables are expanded |:set_env|.
2752 - Careful with '\' characters, type one before a space, type two to
2753 get one in the option (see |option-backslash|), for example: >
2754 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
2755< - For backwards compatibility with Vim version 3.0 a '>' at the start
2756 of the option is removed.
2757 Using "." first in the list is recommended. This means that editing
2758 the same file twice will result in a warning. Using "/tmp" on Unix is
2759 discouraged: When the system crashes you lose the swap file.
2760 "/var/tmp" is often not cleared when rebooting, thus is a better
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02002761 choice than "/tmp". But others on the computer may be able to see the
2762 files, and it can contain a lot of files, your swap files get lost in
2763 the crowd. That is why a "tmp" directory in your home directory is
2764 tried first.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002765 The use of |:set+=| and |:set-=| is preferred when adding or removing
2766 directories from the list. This avoids problems when a future version
2767 uses another default.
2768 This option cannot be set from a |modeline| or in the |sandbox|, for
2769 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002770
2771 *'display'* *'dy'*
Bram Moolenaarbc8801c2016-08-02 21:04:33 +02002772'display' 'dy' string (default "", set to "truncate" in
2773 |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002774 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002775 Change the way text is displayed. This is comma separated list of
2776 flags:
2777 lastline When included, as much as possible of the last line
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02002778 in a window will be displayed. "@@@" is put in the
2779 last columns of the last screen line to indicate the
2780 rest of the line is not displayed.
2781 truncate Like "lastline", but "@@@" is displayed in the first
2782 column of the last screen line. Overrules "lastline".
Bram Moolenaar071d4272004-06-13 20:20:40 +00002783 uhex Show unprintable characters hexadecimal as <xx>
2784 instead of using ^C and ~C.
2785
Bram Moolenaard0796902016-09-16 20:02:31 +02002786 When neither "lastline" nor "truncate" is included, a last line that
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02002787 doesn't fit is replaced with "@" lines.
2788
Bram Moolenaar071d4272004-06-13 20:20:40 +00002789 *'eadirection'* *'ead'*
2790'eadirection' 'ead' string (default "both")
2791 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002792 Tells when the 'equalalways' option applies:
2793 ver vertically, width of windows is not affected
2794 hor horizontally, height of windows is not affected
2795 both width and height of windows is affected
2796
2797 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
2798'edcompatible' 'ed' boolean (default off)
2799 global
2800 Makes the 'g' and 'c' flags of the ":substitute" command to be
2801 toggled each time the flag is given. See |complex-change|. See
2802 also 'gdefault' option.
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +02002803 Switching this option on may break plugins!
Bram Moolenaar4072ba52020-12-23 13:56:35 +01002804 This option is not used in |Vim9| script.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002805
Bram Moolenaar03413f42016-04-12 21:07:15 +02002806 *'emoji'* *'emo'* *'noemoji'* *'noemo'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01002807'emoji' 'emo' boolean (default: on)
2808 global
Bram Moolenaar3848e002016-03-19 18:42:29 +01002809 When on all Unicode emoji characters are considered to be full width.
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02002810 This excludes "text emoji" characters, which are normally displayed as
2811 single width. Unfortunately there is no good specification for this
2812 and it has been determined on trial-and-error basis. Use the
2813 |setcellwidths()| function to change the behavior.
Bram Moolenaar3848e002016-03-19 18:42:29 +01002814
Bram Moolenaar071d4272004-06-13 20:20:40 +00002815 *'encoding'* *'enc'* *E543*
2816'encoding' 'enc' string (default: "latin1" or value from $LANG)
2817 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002818 Sets the character encoding used inside Vim. It applies to text in
2819 the buffers, registers, Strings in expressions, text stored in the
2820 viminfo file, etc. It sets the kind of characters which Vim can work
2821 with. See |encoding-names| for the possible values.
2822
2823 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002824 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002825 It should normally be kept at its default value, or set when Vim
Bram Moolenaar02467872007-05-06 13:22:01 +00002826 starts up. See |multibyte|. To reload the menus see |:menutrans|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002827
Bram Moolenaar865242e2010-07-14 21:12:05 +02002828 This option cannot be set from a |modeline|. It would most likely
2829 corrupt the text.
2830
Bram Moolenaar3df01732017-02-17 22:47:16 +01002831 NOTE: For GTK+ 2 or later, it is highly recommended to set 'encoding'
2832 to "utf-8". Although care has been taken to allow different values of
Bram Moolenaar071d4272004-06-13 20:20:40 +00002833 'encoding', "utf-8" is the natural choice for the environment and
2834 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002835 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00002836 versions, and to avoid changing the encoding of newly created files
2837 without your knowledge (in case 'fileencodings' is empty).
2838
2839 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002840 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00002841 iconv() or as specified with 'charconvert'.
2842
Bram Moolenaar207f0092020-08-30 17:20:20 +02002843 If you need to know whether 'encoding' is a multibyte encoding, you
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002844 can use: >
2845 if has("multi_byte_encoding")
2846<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002847 Normally 'encoding' will be equal to your current locale. This will
2848 be the default if Vim recognizes your environment settings. If
2849 'encoding' is not set to the current locale, 'termencoding' must be
2850 set to convert typed and displayed text. See |encoding-table|.
2851
2852 When you set this option, it fires the |EncodingChanged| autocommand
2853 event so that you can set up fonts if necessary.
2854
2855 When the option is set, the value is converted to lowercase. Thus
2856 you can set it with uppercase values too. Underscores are translated
2857 to '-' signs.
2858 When the encoding is recognized, it is changed to the standard name.
2859 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
2860 "iso-8859-2" and "utf8" becomes "utf-8".
2861
2862 Note: "latin1" is also used when the encoding could not be detected.
2863 This only works when editing files in the same encoding! When the
2864 actual character set is not latin1, make sure 'fileencoding' and
2865 'fileencodings' are empty. When conversion is needed, switch to using
2866 utf-8.
2867
2868 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
2869 You don't notice this while editing, but it does matter for the
2870 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
2871 setting 'encoding' to one of these values instead of utf-8 only has
2872 effect for encoding used for files when 'fileencoding' is empty.
2873
Bram Moolenaar661b1822005-07-28 22:36:45 +00002874 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
2875 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002876
2877 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
2878'endofline' 'eol' boolean (default on)
2879 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002880 When writing a file and this option is off and the 'binary' option
Bram Moolenaar34d72d42015-07-17 14:18:08 +02002881 is on, or 'fixeol' option is off, no <EOL> will be written for the
2882 last line in the file. This option is automatically set or reset when
2883 starting to edit a new file, depending on whether file has an <EOL>
2884 for the last line in the file. Normally you don't have to set or
2885 reset this option.
2886 When 'binary' is off and 'fixeol' is on the value is not used when
2887 writing the file. When 'binary' is on or 'fixeol' is off it is used
2888 to remember the presence of a <EOL> for the last line in the file, so
2889 that when you write the file the situation from the original file can
2890 be kept. But you can change it if you want to.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002891
2892 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
2893'equalalways' 'ea' boolean (default on)
2894 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002895 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00002896 splitting or closing a window. This also happens the moment the
2897 option is switched on. When off, splitting a window will reduce the
2898 size of the current window and leave the other windows the same. When
2899 closing a window the extra lines are given to the window next to it
2900 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00002901 When mixing vertically and horizontally split windows, a minimal size
2902 is computed and some windows may be larger if there is room. The
2903 'eadirection' option tells in which direction the size is affected.
Bram Moolenaar67f71312007-08-12 14:55:56 +00002904 Changing the height and width of a window can be avoided by setting
2905 'winfixheight' and 'winfixwidth', respectively.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002906 If a window size is specified when creating a new window sizes are
2907 currently not equalized (it's complicated, but may be implemented in
2908 the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002909
2910 *'equalprg'* *'ep'*
2911'equalprg' 'ep' string (default "")
2912 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002913 External program to use for "=" command. When this option is empty
Bram Moolenaar446cb832008-06-24 21:56:24 +00002914 the internal formatting functions are used; either 'lisp', 'cindent'
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002915 or 'indentexpr'. When Vim was compiled without internal formatting,
2916 the "indent" program is used.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002917 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002918 about including spaces and backslashes.
2919 This option cannot be set from a |modeline| or in the |sandbox|, for
2920 security reasons.
2921
2922 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
2923'errorbells' 'eb' boolean (default off)
2924 global
2925 Ring the bell (beep or screen flash) for error messages. This only
2926 makes a difference for error messages, the bell will be used always
2927 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002928 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar165bc692015-07-21 17:53:25 +02002929 screen flash or do nothing. See 'belloff' to finetune when to ring the
2930 bell.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002931
2932 *'errorfile'* *'ef'*
2933'errorfile' 'ef' string (Amiga default: "AztecC.Err",
2934 others: "errors.err")
2935 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002936 {not available when compiled without the |+quickfix|
2937 feature}
2938 Name of the errorfile for the QuickFix mode (see |:cf|).
2939 When the "-q" command-line argument is used, 'errorfile' is set to the
2940 following argument. See |-q|.
2941 NOT used for the ":make" command. See 'makeef' for that.
2942 Environment variables are expanded |:set_env|.
2943 See |option-backslash| about including spaces and backslashes.
2944 This option cannot be set from a |modeline| or in the |sandbox|, for
2945 security reasons.
2946
2947 *'errorformat'* *'efm'*
2948'errorformat' 'efm' string (default is very long)
2949 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002950 {not available when compiled without the |+quickfix|
2951 feature}
2952 Scanf-like description of the format for the lines in the error file
2953 (see |errorformat|).
2954
2955 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
2956'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
2957 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002958 Function keys that start with an <Esc> are recognized in Insert
2959 mode. When this option is off, the cursor and function keys cannot be
2960 used in Insert mode if they start with an <Esc>. The advantage of
2961 this is that the single <Esc> is recognized immediately, instead of
2962 after one second. Instead of resetting this option, you might want to
2963 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
2964 when 'esckeys' is off, you can still map anything, but the cursor keys
2965 won't work by default.
2966 NOTE: This option is set to the Vi default value when 'compatible' is
2967 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaarc8234772019-11-10 21:00:27 +01002968 NOTE: when this option is off then the |modifyOtherKeys| functionality
2969 is disabled while in Insert mode to avoid ending Insert mode with any
2970 key that has a modifier.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002971
2972 *'eventignore'* *'ei'*
2973'eventignore' 'ei' string (default "")
2974 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002975 A list of autocommand event names, which are to be ignored.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00002976 When set to "all" or when "all" is one of the items, all autocommand
2977 events are ignored, autocommands will not be executed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002978 Otherwise this is a comma separated list of event names. Example: >
2979 :set ei=WinEnter,WinLeave
2980<
2981 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
2982'expandtab' 'et' boolean (default off)
2983 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002984 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002985 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002986 when 'autoindent' is on. To insert a real tab when 'expandtab' is
2987 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
Bram Moolenaarca635012015-09-25 20:34:21 +02002988 This option is reset when the 'paste' option is set and restored when
2989 the 'paste' option is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002990 NOTE: This option is reset when 'compatible' is set.
2991
2992 *'exrc'* *'ex'* *'noexrc'* *'noex'*
2993'exrc' 'ex' boolean (default off)
2994 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002995 Enables the reading of .vimrc, .exrc and .gvimrc in the current
Bram Moolenaar36f44c22016-08-28 18:17:20 +02002996 directory.
2997
2998 Setting this option is a potential security leak. E.g., consider
2999 unpacking a package or fetching files from github, a .vimrc in there
3000 might be a trojan horse. BETTER NOT SET THIS OPTION!
3001 Instead, define an autocommand in your .vimrc to set options for a
3002 matching directory.
3003
3004 If you do switch this option on you should also consider setting the
3005 'secure' option (see |initialization|).
3006 Also see |.vimrc| and |gui-init|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003007 This option cannot be set from a |modeline| or in the |sandbox|, for
3008 security reasons.
3009
3010 *'fileencoding'* *'fenc'* *E213*
3011'fileencoding' 'fenc' string (default: "")
3012 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003013 Sets the character encoding for the file of this buffer.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003014
Bram Moolenaar071d4272004-06-13 20:20:40 +00003015 When 'fileencoding' is different from 'encoding', conversion will be
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003016 done when writing the file. For reading see below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003017 When 'fileencoding' is empty, the same value as 'encoding' will be
3018 used (no conversion when reading or writing a file).
Bram Moolenaar214641f2017-03-05 17:04:09 +01003019 No error will be given when the value is set, only when it is used,
3020 only when writing a file.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003021 Conversion will also be done when 'encoding' and 'fileencoding' are
3022 both a Unicode encoding and 'fileencoding' is not utf-8. That's
3023 because internally Unicode is always stored as utf-8.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003024 WARNING: Conversion can cause loss of information! When
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003025 'encoding' is "utf-8" or another Unicode encoding, conversion
3026 is most likely done in a way that the reverse conversion
3027 results in the same text. When 'encoding' is not "utf-8" some
3028 characters may be lost!
Bram Moolenaar865242e2010-07-14 21:12:05 +02003029
Bram Moolenaar071d4272004-06-13 20:20:40 +00003030 See 'encoding' for the possible values. Additionally, values may be
3031 specified that can be handled by the converter, see
3032 |mbyte-conversion|.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003033
Bram Moolenaar071d4272004-06-13 20:20:40 +00003034 When reading a file 'fileencoding' will be set from 'fileencodings'.
3035 To read a file in a certain encoding it won't work by setting
Bram Moolenaar02467872007-05-06 13:22:01 +00003036 'fileencoding', use the |++enc| argument. One exception: when
3037 'fileencodings' is empty the value of 'fileencoding' is used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003038 For a new file the global value of 'fileencoding' is used.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003039
Bram Moolenaar071d4272004-06-13 20:20:40 +00003040 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
3041 When the option is set, the value is converted to lowercase. Thus
3042 you can set it with uppercase values too. '_' characters are
3043 replaced with '-'. If a name is recognized from the list for
3044 'encoding', it is replaced by the standard name. For example
3045 "ISO8859-2" becomes "iso-8859-2".
Bram Moolenaar865242e2010-07-14 21:12:05 +02003046
Bram Moolenaar071d4272004-06-13 20:20:40 +00003047 When this option is set, after starting to edit a file, the 'modified'
3048 option is set, because the file would be different when written.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003049
3050 Keep in mind that changing 'fenc' from a modeline happens
3051 AFTER the text has been read, thus it applies to when the file will be
3052 written. If you do set 'fenc' in a modeline, you might want to set
3053 'nomodified' to avoid not being able to ":q".
3054
Bram Moolenaar071d4272004-06-13 20:20:40 +00003055 This option can not be changed when 'modifiable' is off.
3056
3057 *'fe'*
3058 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003059 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003060 old short name was 'fe', which is no longer used.
3061
3062 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003063'fileencodings' 'fencs' string (default: "ucs-bom",
3064 "ucs-bom,utf-8,default,latin1" when
3065 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003066 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003067 This is a list of character encodings considered when starting to edit
3068 an existing file. When a file is read, Vim tries to use the first
3069 mentioned character encoding. If an error is detected, the next one
3070 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003071 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00003072 an empty string, which means the value of 'encoding' is used.
3073 WARNING: Conversion can cause loss of information! When
3074 'encoding' is "utf-8" (or one of the other Unicode variants)
3075 conversion is most likely done in a way that the reverse
3076 conversion results in the same text. When 'encoding' is not
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003077 "utf-8" some non-ASCII characters may be lost! You can use
3078 the |++bad| argument to specify what is done with characters
3079 that can't be converted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003080 For an empty file or a file with only ASCII characters most encodings
3081 will work and the first entry of 'fileencodings' will be used (except
3082 "ucs-bom", which requires the BOM to be present). If you prefer
3083 another encoding use an BufReadPost autocommand event to test if your
3084 preferred encoding is to be used. Example: >
3085 au BufReadPost * if search('\S', 'w') == 0 |
3086 \ set fenc=iso-2022-jp | endif
3087< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
3088 non-blank characters.
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003089 When the |++enc| argument is used then the value of 'fileencodings' is
3090 not used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003091 Note that 'fileencodings' is not used for a new file, the global value
3092 of 'fileencoding' is used instead. You can set it with: >
3093 :setglobal fenc=iso-8859-2
3094< This means that a non-existing file may get a different encoding than
3095 an empty file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003096 The special value "ucs-bom" can be used to check for a Unicode BOM
3097 (Byte Order Mark) at the start of the file. It must not be preceded
3098 by "utf-8" or another Unicode encoding for this to work properly.
3099 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
3100 because Vim cannot detect an error, thus the encoding is always
3101 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003102 The special value "default" can be used for the encoding from the
3103 environment. This is the default value for 'encoding'. It is useful
3104 when 'encoding' is set to "utf-8" and your environment uses a
3105 non-latin1 encoding, such as Russian.
Bram Moolenaarca003e12006-03-17 23:19:38 +00003106 When 'encoding' is "utf-8" and a file contains an illegal byte
3107 sequence it won't be recognized as UTF-8. You can use the |8g8|
3108 command to find the illegal byte sequence.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003109 WRONG VALUES: WHAT'S WRONG:
3110 latin1,utf-8 "latin1" will always be used
3111 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
3112 file
3113 cp1250,latin1 "cp1250" will always be used
3114 If 'fileencodings' is empty, 'fileencoding' is not modified.
3115 See 'fileencoding' for the possible values.
3116 Setting this option does not have an effect until the next time a file
3117 is read.
3118
3119 *'fileformat'* *'ff'*
Bram Moolenaar00590742019-02-15 21:06:09 +01003120'fileformat' 'ff' string (MS-Windows default: "dos",
3121 Unix, macOS default: "unix")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003122 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003123 This gives the <EOL> of the current buffer, which is used for
3124 reading/writing the buffer from/to a file:
Bram Moolenaar4072ba52020-12-23 13:56:35 +01003125 dos <CR><NL>
Bram Moolenaar071d4272004-06-13 20:20:40 +00003126 unix <NL>
3127 mac <CR>
3128 When "dos" is used, CTRL-Z at the end of a file is ignored.
3129 See |file-formats| and |file-read|.
3130 For the character encoding of the file see 'fileencoding'.
3131 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
Bram Moolenaarbf884932013-04-05 22:26:15 +02003132 works like it was set to "unix".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003133 This option is set automatically when starting to edit a file and
3134 'fileformats' is not empty and 'binary' is off.
3135 When this option is set, after starting to edit a file, the 'modified'
3136 option is set, because the file would be different when written.
3137 This option can not be changed when 'modifiable' is off.
3138 For backwards compatibility: When this option is set to "dos",
3139 'textmode' is set, otherwise 'textmode' is reset.
3140
3141 *'fileformats'* *'ffs'*
3142'fileformats' 'ffs' string (default:
Bram Moolenaar00590742019-02-15 21:06:09 +01003143 Vim+Vi MS-Windows: "dos,unix",
3144 Vim Unix, macOS: "unix,dos",
Bram Moolenaar071d4272004-06-13 20:20:40 +00003145 Vi Cygwin: "unix,dos",
3146 Vi others: "")
3147 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003148 This gives the end-of-line (<EOL>) formats that will be tried when
3149 starting to edit a new buffer and when reading a file into an existing
3150 buffer:
3151 - When empty, the format defined with 'fileformat' will be used
3152 always. It is not set automatically.
3153 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003154 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003155 'fileformats' name will be used when a file is read into an existing
3156 buffer, no matter what 'fileformat' for that buffer is set to.
3157 - When more than one name is present, separated by commas, automatic
3158 <EOL> detection will be done when reading a file. When starting to
3159 edit a file, a check is done for the <EOL>:
3160 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
3161 'fileformat' is set to "dos".
3162 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003163 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003164 preceding <CR>, "unix" is preferred over "dos".
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01003165 3. If 'fileformat' has not yet been set, and if a <CR> is found, and
3166 if 'fileformats' includes "mac", 'fileformat' is set to "mac".
Bram Moolenaar00659062010-09-21 22:34:02 +02003167 This means that "mac" is only chosen when:
3168 "unix" is not present or no <NL> is found in the file, and
3169 "dos" is not present or no <CR><NL> is found in the file.
3170 Except: if "unix" was chosen, but there is a <CR> before
3171 the first <NL>, and there appear to be more <CR>s than <NL>s in
Bram Moolenaar166af9b2010-11-16 20:34:40 +01003172 the first few lines, "mac" is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003173 4. If 'fileformat' is still not set, the first name from
3174 'fileformats' is used.
3175 When reading a file into an existing buffer, the same is done, but
3176 this happens like 'fileformat' has been set appropriately for that
3177 file only, the option is not changed.
3178 When 'binary' is set, the value of 'fileformats' is not used.
3179
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01003180 When Vim starts up with an empty buffer the first item is used. You
3181 can overrule this by setting 'fileformat' in your .vimrc.
Bram Moolenaar81af9252010-12-10 20:35:50 +01003182
Bram Moolenaar071d4272004-06-13 20:20:40 +00003183 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
3184 are ":source"ed and for vimrc files, automatic <EOL> detection may be
3185 done:
3186 - When 'fileformats' is empty, there is no automatic detection. Dos
3187 format will be used.
3188 - When 'fileformats' is set to one or more names, automatic detection
3189 is done. This is based on the first <NL> in the file: If there is a
3190 <CR> in front of it, Dos format is used, otherwise Unix format is
3191 used.
3192 Also see |file-formats|.
3193 For backwards compatibility: When this option is set to an empty
3194 string or one format (no comma is included), 'textauto' is reset,
3195 otherwise 'textauto' is set.
3196 NOTE: This option is set to the Vi default value when 'compatible' is
3197 set and to the Vim default value when 'compatible' is reset.
3198
Bram Moolenaarbf884932013-04-05 22:26:15 +02003199 *'fileignorecase'* *'fic'* *'nofileignorecase'* *'nofic'*
3200'fileignorecase' 'fic' boolean (default on for systems where case in file
3201 names is normally ignored)
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003202 global
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003203 When set case is ignored when using file names and directories.
3204 See 'wildignorecase' for only ignoring case when doing completion.
3205
Bram Moolenaar071d4272004-06-13 20:20:40 +00003206 *'filetype'* *'ft'*
3207'filetype' 'ft' string (default: "")
3208 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003209 When this option is set, the FileType autocommand event is triggered.
3210 All autocommands that match with the value of this option will be
3211 executed. Thus the value of 'filetype' is used in place of the file
3212 name.
3213 Otherwise this option does not always reflect the current file type.
3214 This option is normally set when the file type is detected. To enable
3215 this use the ":filetype on" command. |:filetype|
3216 Setting this option to a different value is most useful in a modeline,
3217 for a file for which the file type is not automatically recognized.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003218 Example, for in an IDL file:
3219 /* vim: set filetype=idl : */ ~
3220 |FileType| |filetypes|
3221 When a dot appears in the value then this separates two filetype
3222 names. Example:
3223 /* vim: set filetype=c.doxygen : */ ~
3224 This will use the "c" filetype first, then the "doxygen" filetype.
3225 This works both for filetype plugins and for syntax files. More than
3226 one dot may appear.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003227 This option is not copied to another buffer, independent of the 's' or
3228 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003229 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003230
3231 *'fillchars'* *'fcs'*
3232'fillchars' 'fcs' string (default "vert:|,fold:-")
3233 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02003234 {not available when compiled without the |+folding|
3235 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003236 Characters to fill the statuslines and vertical separators.
3237 It is a comma separated list of items:
3238
3239 item default Used for ~
3240 stl:c ' ' or '^' statusline of the current window
Bram Moolenaar38a55632016-02-15 22:07:32 +01003241 stlnc:c ' ' or '=' statusline of the non-current windows
Bram Moolenaar071d4272004-06-13 20:20:40 +00003242 vert:c '|' vertical separators |:vsplit|
3243 fold:c '-' filling 'foldtext'
3244 diff:c '-' deleted lines of the 'diff' option
3245
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003246 Any one that is omitted will fall back to the default. For "stl" and
Bram Moolenaar38a55632016-02-15 22:07:32 +01003247 "stlnc" the space will be used when there is highlighting, '^' or '='
Bram Moolenaar071d4272004-06-13 20:20:40 +00003248 otherwise.
3249
3250 Example: >
Bram Moolenaar38a55632016-02-15 22:07:32 +01003251 :set fillchars=stl:^,stlnc:=,vert:\|,fold:-,diff:-
Bram Moolenaar071d4272004-06-13 20:20:40 +00003252< This is similar to the default, except that these characters will also
3253 be used when there is highlighting.
3254
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003255 for "stl" and "stlnc" only single-byte values are supported.
3256
Bram Moolenaar071d4272004-06-13 20:20:40 +00003257 The highlighting used for these items:
3258 item highlight group ~
3259 stl:c StatusLine |hl-StatusLine|
3260 stlnc:c StatusLineNC |hl-StatusLineNC|
3261 vert:c VertSplit |hl-VertSplit|
3262 fold:c Folded |hl-Folded|
3263 diff:c DiffDelete |hl-DiffDelete|
3264
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003265 *'fixendofline'* *'fixeol'* *'nofixendofline'* *'nofixeol'*
3266'fixendofline' 'fixeol' boolean (default on)
3267 local to buffer
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003268 When writing a file and this option is on, <EOL> at the end of file
3269 will be restored if missing. Turn this option off if you want to
3270 preserve the situation from the original file.
3271 When the 'binary' option is set the value of this option doesn't
3272 matter.
3273 See the 'endofline' option.
3274
Bram Moolenaar071d4272004-06-13 20:20:40 +00003275 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
3276'fkmap' 'fk' boolean (default off) *E198*
3277 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003278 {only available when compiled with the |+rightleft|
3279 feature}
Bram Moolenaar14184a32019-02-16 15:10:30 +01003280 This option was for using Farsi, which has been removed. See
3281 |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003282
3283 *'foldclose'* *'fcl'*
3284'foldclose' 'fcl' string (default "")
3285 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003286 {not available when compiled without the |+folding|
3287 feature}
3288 When set to "all", a fold is closed when the cursor isn't in it and
3289 its level is higher than 'foldlevel'. Useful if you want folds to
3290 automatically close when moving out of them.
3291
3292 *'foldcolumn'* *'fdc'*
3293'foldcolumn' 'fdc' number (default 0)
3294 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003295 {not available when compiled without the |+folding|
3296 feature}
3297 When non-zero, a column with the specified width is shown at the side
3298 of the window which indicates open and closed folds. The maximum
3299 value is 12.
3300 See |folding|.
3301
3302 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
3303'foldenable' 'fen' boolean (default on)
3304 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003305 {not available when compiled without the |+folding|
3306 feature}
3307 When off, all folds are open. This option can be used to quickly
3308 switch between showing all text unfolded and viewing the text with
3309 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003310 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00003311 'foldenable' is off.
3312 This option is set by commands that create a new fold or close a fold.
3313 See |folding|.
3314
3315 *'foldexpr'* *'fde'*
3316'foldexpr' 'fde' string (default: "0")
3317 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003318 {not available when compiled without the |+folding|
Bram Moolenaardb84e452010-08-15 13:50:43 +02003319 or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003320 The expression used for when 'foldmethod' is "expr". It is evaluated
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003321 for each line to obtain its fold level. See |fold-expr|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003322
Bram Moolenaar30b65812012-07-12 22:01:11 +02003323 The expression will be evaluated in the |sandbox| if set from a
3324 modeline, see |sandbox-option|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003325 This option can't be set from a |modeline| when the 'diff' option is
Bram Moolenaar110289e2019-05-23 15:38:06 +02003326 on or the 'modelineexpr' option is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003327
3328 It is not allowed to change text or jump to another window while
3329 evaluating 'foldexpr' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003330
3331 *'foldignore'* *'fdi'*
3332'foldignore' 'fdi' string (default: "#")
3333 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003334 {not available when compiled without the |+folding|
3335 feature}
3336 Used only when 'foldmethod' is "indent". Lines starting with
3337 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003338 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003339 The default "#" works well for C programs. See |fold-indent|.
3340
3341 *'foldlevel'* *'fdl'*
3342'foldlevel' 'fdl' number (default: 0)
3343 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003344 {not available when compiled without the |+folding|
3345 feature}
3346 Sets the fold level: Folds with a higher level will be closed.
3347 Setting this option to zero will close all folds. Higher numbers will
3348 close fewer folds.
3349 This option is set by commands like |zm|, |zM| and |zR|.
3350 See |fold-foldlevel|.
3351
3352 *'foldlevelstart'* *'fdls'*
3353'foldlevelstart' 'fdls' number (default: -1)
3354 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003355 {not available when compiled without the |+folding|
3356 feature}
3357 Sets 'foldlevel' when starting to edit another buffer in a window.
3358 Useful to always start editing with all folds closed (value zero),
3359 some folds closed (one) or no folds closed (99).
3360 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003361 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00003362 ignores this option and closes all folds.
3363 It is also done before BufReadPre autocommands, to allow an autocmd to
3364 overrule the 'foldlevel' value for specific files.
3365 When the value is negative, it is not used.
3366
3367 *'foldmarker'* *'fmr'* *E536*
3368'foldmarker' 'fmr' string (default: "{{{,}}}")
3369 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003370 {not available when compiled without the |+folding|
3371 feature}
3372 The start and end marker used when 'foldmethod' is "marker". There
3373 must be one comma, which separates the start and end marker. The
3374 marker is a literal string (a regular expression would be too slow).
3375 See |fold-marker|.
3376
3377 *'foldmethod'* *'fdm'*
3378'foldmethod' 'fdm' string (default: "manual")
3379 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003380 {not available when compiled without the |+folding|
3381 feature}
3382 The kind of folding used for the current window. Possible values:
3383 |fold-manual| manual Folds are created manually.
3384 |fold-indent| indent Lines with equal indent form a fold.
3385 |fold-expr| expr 'foldexpr' gives the fold level of a line.
3386 |fold-marker| marker Markers are used to specify folds.
3387 |fold-syntax| syntax Syntax highlighting items specify folds.
3388 |fold-diff| diff Fold text that is not changed.
3389
3390 *'foldminlines'* *'fml'*
3391'foldminlines' 'fml' number (default: 1)
3392 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003393 {not available when compiled without the |+folding|
3394 feature}
Bram Moolenaar00654022011-02-25 14:42:19 +01003395 Sets the number of screen lines above which a fold can be displayed
3396 closed. Also for manually closed folds. With the default value of
3397 one a fold can only be closed if it takes up two or more screen lines.
3398 Set to zero to be able to close folds of just one screen line.
Bram Moolenaar446beb42011-05-10 17:18:44 +02003399 Note that this only has an effect on what is displayed. After using
Bram Moolenaar071d4272004-06-13 20:20:40 +00003400 "zc" to close a fold, which is displayed open because it's smaller
3401 than 'foldminlines', a following "zc" may close a containing fold.
3402
3403 *'foldnestmax'* *'fdn'*
3404'foldnestmax' 'fdn' number (default: 20)
3405 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003406 {not available when compiled without the |+folding|
3407 feature}
3408 Sets the maximum nesting of folds for the "indent" and "syntax"
3409 methods. This avoids that too many folds will be created. Using more
3410 than 20 doesn't work, because the internal limit is 20.
3411
3412 *'foldopen'* *'fdo'*
3413'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
3414 search,tag,undo")
3415 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003416 {not available when compiled without the |+folding|
3417 feature}
3418 Specifies for which type of commands folds will be opened, if the
3419 command moves the cursor into a closed fold. It is a comma separated
3420 list of items.
Bram Moolenaar05365702010-10-27 18:34:44 +02003421 NOTE: When the command is part of a mapping this option is not used.
3422 Add the |zv| command to the mapping to get the same effect.
3423 (rationale: the mapping may want to control opening folds itself)
3424
Bram Moolenaar071d4272004-06-13 20:20:40 +00003425 item commands ~
3426 all any
3427 block "(", "{", "[[", "[{", etc.
3428 hor horizontal movements: "l", "w", "fx", etc.
3429 insert any command in Insert mode
3430 jump far jumps: "G", "gg", etc.
3431 mark jumping to a mark: "'m", CTRL-O, etc.
3432 percent "%"
3433 quickfix ":cn", ":crew", ":make", etc.
3434 search search for a pattern: "/", "n", "*", "gd", etc.
3435 (not for a search pattern in a ":" command)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003436 Also for |[s| and |]s|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003437 tag jumping to a tag: ":ta", CTRL-T, etc.
3438 undo undo or redo: "u" and CTRL-R
Bram Moolenaar071d4272004-06-13 20:20:40 +00003439 When a movement command is used for an operator (e.g., "dl" or "y%")
3440 this option is not used. This means the operator will include the
3441 whole closed fold.
3442 Note that vertical movements are not here, because it would make it
3443 very difficult to move onto a closed fold.
3444 In insert mode the folds containing the cursor will always be open
3445 when text is inserted.
3446 To close folds you can re-apply 'foldlevel' with the |zx| command or
3447 set the 'foldclose' option to "all".
3448
3449 *'foldtext'* *'fdt'*
3450'foldtext' 'fdt' string (default: "foldtext()")
3451 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003452 {not available when compiled without the |+folding|
3453 feature}
3454 An expression which is used to specify the text displayed for a closed
3455 fold. See |fold-foldtext|.
3456
Bram Moolenaar30b65812012-07-12 22:01:11 +02003457 The expression will be evaluated in the |sandbox| if set from a
3458 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003459 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003460
3461 It is not allowed to change text or jump to another window while
3462 evaluating 'foldtext' |textlock|.
3463
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003464 *'formatexpr'* *'fex'*
3465'formatexpr' 'fex' string (default "")
3466 local to buffer
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003467 {not available when compiled without the |+eval|
3468 feature}
3469 Expression which is evaluated to format a range of lines for the |gq|
3470 operator or automatic formatting (see 'formatoptions'). When this
3471 option is empty 'formatprg' is used.
3472
3473 The |v:lnum| variable holds the first line to be formatted.
3474 The |v:count| variable holds the number of lines to be formatted.
3475 The |v:char| variable holds the character that is going to be
3476 inserted if the expression is being evaluated due to
3477 automatic formatting. This can be empty. Don't insert
3478 it yet!
3479
3480 Example: >
3481 :set formatexpr=mylang#Format()
3482< This will invoke the mylang#Format() function in the
3483 autoload/mylang.vim file in 'runtimepath'. |autoload|
3484
3485 The expression is also evaluated when 'textwidth' is set and adding
3486 text beyond that limit. This happens under the same conditions as
3487 when internal formatting is used. Make sure the cursor is kept in the
3488 same spot relative to the text then! The |mode()| function will
3489 return "i" or "R" in this situation.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01003490
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003491 When the expression evaluates to non-zero Vim will fall back to using
3492 the internal format mechanism.
3493
3494 The expression will be evaluated in the |sandbox| when set from a
3495 modeline, see |sandbox-option|. That stops the option from working,
3496 since changing the buffer text is not allowed.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003497 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaar036986f2017-03-16 17:41:02 +01003498 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003499
Bram Moolenaar86b68352004-12-27 21:59:20 +00003500 *'formatlistpat'* *'flp'*
3501'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
3502 local to buffer
Bram Moolenaar86b68352004-12-27 21:59:20 +00003503 A pattern that is used to recognize a list header. This is used for
3504 the "n" flag in 'formatoptions'.
3505 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00003506 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00003507 while still checking more characters. There must be a character
3508 following the pattern, when it matches the whole line it is handled
3509 like there is no match.
3510 The default recognizes a number, followed by an optional punctuation
3511 character and white space.
3512
Bram Moolenaar6c60f472019-04-28 16:00:35 +02003513 *'formatoptions'* *'fo'*
3514'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
3515 local to buffer
3516 This is a sequence of letters which describes how automatic
3517 formatting is to be done. See |fo-table|. When the 'paste' option is
3518 on, no formatting is done (like 'formatoptions' is empty). Commas can
3519 be inserted for readability.
3520 To avoid problems with flags that are added in the future, use the
3521 "+=" and "-=" feature of ":set" |add-option-flags|.
3522 NOTE: This option is set to the Vi default value when 'compatible' is
3523 set and to the Vim default value when 'compatible' is reset.
3524
Bram Moolenaar071d4272004-06-13 20:20:40 +00003525 *'formatprg'* *'fp'*
3526'formatprg' 'fp' string (default "")
Bram Moolenaar9be7c042017-01-14 14:28:30 +01003527 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003528 The name of an external program that will be used to format the lines
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003529 selected with the |gq| operator. The program must take the input on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003530 stdin and produce the output on stdout. The Unix program "fmt" is
Bram Moolenaara5792f52005-11-23 21:25:05 +00003531 such a program.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003532 If the 'formatexpr' option is not empty it will be used instead.
3533 Otherwise, if 'formatprg' option is an empty string, the internal
3534 format function will be used |C-indenting|.
Bram Moolenaara5792f52005-11-23 21:25:05 +00003535 Environment variables are expanded |:set_env|. See |option-backslash|
3536 about including spaces and backslashes.
Bram Moolenaar30b65812012-07-12 22:01:11 +02003537 This option cannot be set from a |modeline| or in the |sandbox|, for
3538 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003539
Bram Moolenaard94464e2015-11-02 15:28:18 +01003540 *'fsync'* *'fs'* *'nofsync'* *'nofs'*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003541'fsync' 'fs' boolean (default on)
3542 global
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003543 When on, the library function fsync() will be called after writing a
3544 file. This will flush a file to disk, ensuring that it is safely
3545 written even on filesystems which do metadata-only journaling. This
3546 will force the harddrive to spin up on Linux systems running in laptop
3547 mode, so it may be undesirable in some situations. Be warned that
3548 turning this off increases the chances of data loss after a crash. On
3549 systems without an fsync() implementation, this variable is always
3550 off.
3551 Also see 'swapsync' for controlling fsync() on swap files.
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003552 'fsync' also applies to |writefile()|, unless a flag is used to
3553 overrule it.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003554 This option cannot be set from a |modeline| or in the |sandbox|, for
3555 security reasons.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003556
Bram Moolenaar071d4272004-06-13 20:20:40 +00003557 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
3558'gdefault' 'gd' boolean (default off)
3559 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003560 When on, the ":substitute" flag 'g' is default on. This means that
3561 all matches in a line are substituted instead of one. When a 'g' flag
3562 is given to a ":substitute" command, this will toggle the substitution
3563 of all or one match. See |complex-change|.
3564
3565 command 'gdefault' on 'gdefault' off ~
3566 :s/// subst. all subst. one
3567 :s///g subst. one subst. all
3568 :s///gg subst. all subst. one
3569
3570 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar21020352017-06-13 17:21:04 +02003571 DEPRECATED: Setting this option may break plugins that are not aware
3572 of this option. Also, many users get confused that adding the /g flag
3573 has the opposite effect of that it normally does.
Bram Moolenaar4072ba52020-12-23 13:56:35 +01003574 This option is not used in |Vim9| script.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003575
3576 *'grepformat'* *'gfm'*
Bram Moolenaar6e932462014-09-09 18:48:09 +02003577'grepformat' 'gfm' string (default "%f:%l:%m,%f:%l%m,%f %l%m")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003578 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003579 Format to recognize for the ":grep" command output.
3580 This is a scanf-like string that uses the same format as the
3581 'errorformat' option: see |errorformat|.
3582
3583 *'grepprg'* *'gp'*
3584'grepprg' 'gp' string (default "grep -n ",
3585 Unix: "grep -n $* /dev/null",
3586 Win32: "findstr /n" or "grep -n",
3587 VMS: "SEARCH/NUMBERS ")
3588 global or local to buffer |global-local|
Bram Moolenaar582fd852005-03-28 20:58:01 +00003589 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003590 and '#' characters, which are expanded like when used in a command-
3591 line. The placeholder "$*" is allowed to specify where the arguments
3592 will be included. Environment variables are expanded |:set_env|. See
3593 |option-backslash| about including spaces and backslashes.
3594 When your "grep" accepts the "-H" argument, use this to make ":grep"
3595 also work well with a single file: >
3596 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00003597< Special value: When 'grepprg' is set to "internal" the |:grep| command
Bram Moolenaara6557602006-02-04 22:43:20 +00003598 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like
3599 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00003600 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00003601 apply equally to 'grepprg'.
3602 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
3603 otherwise it's "grep -n".
3604 This option cannot be set from a |modeline| or in the |sandbox|, for
3605 security reasons.
3606
3607 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
3608'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
3609 ve:ver35-Cursor,
3610 o:hor50-Cursor,
3611 i-ci:ver25-Cursor/lCursor,
3612 r-cr:hor20-Cursor/lCursor,
3613 sm:block-Cursor
3614 -blinkwait175-blinkoff150-blinkon175",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003615 for Win32 console:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003616 "n-v-c:block,o:hor50,i-ci:hor15,
3617 r-cr:hor30,sm:block")
3618 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003619 {only available when compiled with GUI enabled, and
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003620 for Win32 console}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003621 This option tells Vim what the cursor should look like in different
Bram Moolenaar8024f932020-01-14 19:29:13 +01003622 modes. It fully works in the GUI. In a Win32 console, only the
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003623 height of the cursor can be changed. This can be done by specifying a
3624 block cursor, or a percentage for a vertical or horizontal cursor.
Bram Moolenaar1e7813a2015-03-31 18:31:03 +02003625 For a console the 't_SI', 't_SR', and 't_EI' escape sequences are
3626 used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003627
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003628 The option is a comma separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003629 mode-list and an argument-list:
3630 mode-list:argument-list,mode-list:argument-list,..
3631 The mode-list is a dash separated list of these modes:
3632 n Normal mode
3633 v Visual mode
3634 ve Visual mode with 'selection' "exclusive" (same as 'v',
3635 if not specified)
3636 o Operator-pending mode
3637 i Insert mode
3638 r Replace mode
3639 c Command-line Normal (append) mode
3640 ci Command-line Insert mode
3641 cr Command-line Replace mode
3642 sm showmatch in Insert mode
3643 a all modes
3644 The argument-list is a dash separated list of these arguments:
3645 hor{N} horizontal bar, {N} percent of the character height
3646 ver{N} vertical bar, {N} percent of the character width
3647 block block cursor, fills the whole character
3648 [only one of the above three should be present]
3649 blinkwait{N} *cursor-blinking*
3650 blinkon{N}
3651 blinkoff{N}
3652 blink times for cursor: blinkwait is the delay before
3653 the cursor starts blinking, blinkon is the time that
3654 the cursor is shown and blinkoff is the time that the
3655 cursor is not shown. The times are in msec. When one
3656 of the numbers is zero, there is no blinking. The
3657 default is: "blinkwait700-blinkon400-blinkoff250".
3658 These numbers are used for a missing entry. This
3659 means that blinking is enabled by default. To switch
3660 blinking off you can use "blinkon0". The cursor only
3661 blinks when Vim is waiting for input, not while
3662 executing a command.
3663 To make the cursor blink in an xterm, see
3664 |xterm-blink|.
3665 {group-name}
3666 a highlight group name, that sets the color and font
3667 for the cursor
3668 {group-name}/{group-name}
3669 Two highlight group names, the first is used when
3670 no language mappings are used, the other when they
3671 are. |language-mapping|
3672
3673 Examples of parts:
3674 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
3675 block cursor with colors from the "nCursor"
3676 highlight group
3677 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
3678 In Insert and Command-line Insert mode, use a
3679 30% vertical bar cursor with colors from the
3680 "iCursor" highlight group. Blink a bit
3681 faster.
3682
3683 The 'a' mode is different. It will set the given argument-list for
3684 all modes. It does not reset anything to defaults. This can be used
3685 to do a common setting for all modes. For example, to switch off
3686 blinking: "a:blinkon0"
3687
3688 Examples of cursor highlighting: >
3689 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
3690 :highlight Cursor gui=NONE guifg=bg guibg=fg
3691<
3692 *'guifont'* *'gfn'*
Bram Moolenaar251e1912011-06-19 05:09:16 +02003693 *E235* *E596*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003694'guifont' 'gfn' string (default "")
3695 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003696 {only available when compiled with GUI enabled}
3697 This is a list of fonts which will be used for the GUI version of Vim.
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003698 In its simplest form the value is just one font name.
3699 See |gui-font| for the details.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003700
3701 *'guifontset'* *'gfs'*
3702 *E250* *E252* *E234* *E597* *E598*
3703'guifontset' 'gfs' string (default "")
3704 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003705 {only available when compiled with GUI enabled and
3706 with the |+xfontset| feature}
Bram Moolenaar3df01732017-02-17 22:47:16 +01003707 {not available in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003708 When not empty, specifies two (or more) fonts to be used. The first
3709 one for normal English, the second one for your special language. See
3710 |xfontset|.
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003711
Bram Moolenaar071d4272004-06-13 20:20:40 +00003712 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
3713'guifontwide' 'gfw' string (default "")
3714 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003715 {only available when compiled with GUI enabled}
3716 When not empty, specifies a comma-separated list of fonts to be used
3717 for double-width characters. The first font that can be loaded is
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003718 used. See |gui-fontwide|.
Bram Moolenaar0f272122013-01-23 18:37:40 +01003719
Bram Moolenaar071d4272004-06-13 20:20:40 +00003720 *'guiheadroom'* *'ghr'*
3721'guiheadroom' 'ghr' number (default 50)
3722 global
Bram Moolenaar110289e2019-05-23 15:38:06 +02003723 {only for GTK and X11 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003724 The number of pixels subtracted from the screen height when fitting
3725 the GUI window on the screen. Set this before the GUI is started,
3726 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003727 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00003728 lines will be left for window decorations and other items on the
3729 screen. Set it to a negative value to allow windows taller than the
3730 screen.
3731
3732 *'guioptions'* *'go'*
Bram Moolenaar2c64ca12018-10-19 16:22:31 +02003733'guioptions' 'go' string (default "egmrLtT" (MS-Windows,
3734 "t" is removed in |defaults.vim|),
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02003735 "aegimrLtT" (GTK, Motif and Athena),
3736 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00003737 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003738 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00003739 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003740 sequence of letters which describes what components and options of the
3741 GUI should be used.
3742 To avoid problems with flags that are added in the future, use the
3743 "+=" and "-=" feature of ":set" |add-option-flags|.
3744
Bram Moolenaar13568252018-03-16 20:46:58 +01003745 Valid characters are as follows:
3746 *'go-!'*
3747 '!' External commands are executed in a terminal window. Without
3748 this flag the MS-Windows GUI will open a console window to
3749 execute the command. The Unix GUI will simulate a dumb
3750 terminal to list the command output.
3751 The terminal window will be positioned at the bottom, and grow
3752 upwards as needed.
Bram Moolenaarba3ff532018-11-04 14:45:49 +01003753 *'go-a'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003754 'a' Autoselect: If present, then whenever VISUAL mode is started,
3755 or the Visual area extended, Vim tries to become the owner of
3756 the windowing system's global selection. This means that the
3757 Visually highlighted text is available for pasting into other
3758 applications as well as into Vim itself. When the Visual mode
3759 ends, possibly due to an operation on the text, or when an
3760 application wants to paste the selection, the highlighted text
3761 is automatically yanked into the "* selection register.
3762 Thus the selection is still available for pasting into other
3763 applications after the VISUAL mode has ended.
3764 If not present, then Vim won't become the owner of the
3765 windowing system's global selection unless explicitly told to
3766 by a yank or delete operation for the "* register.
3767 The same applies to the modeless selection.
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02003768 *'go-P'*
3769 'P' Like autoselect but using the "+ register instead of the "*
Bram Moolenaar3848e002016-03-19 18:42:29 +01003770 register.
Bram Moolenaar02467872007-05-06 13:22:01 +00003771 *'go-A'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003772 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003773 applies to the modeless selection.
3774
3775 'guioptions' autoselect Visual autoselect modeless ~
3776 "" - -
3777 "a" yes yes
3778 "A" - yes
3779 "aA" yes yes
3780
Bram Moolenaar02467872007-05-06 13:22:01 +00003781 *'go-c'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003782 'c' Use console dialogs instead of popup dialogs for simple
3783 choices.
Bram Moolenaar50bf7ce2019-09-15 13:17:00 +02003784 *'go-d'*
3785 'd' Use dark theme variant if available. Currently only works for
3786 GTK+ GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00003787 *'go-e'*
Bram Moolenaare224ffa2006-03-01 00:01:28 +00003788 'e' Add tab pages when indicated with 'showtabline'.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003789 'guitablabel' can be used to change the text in the labels.
3790 When 'e' is missing a non-GUI tab pages line may be used.
Bram Moolenaard68071d2006-05-02 22:08:30 +00003791 The GUI tabs are only supported on some systems, currently
Bram Moolenaarb3f74062020-02-26 16:16:53 +01003792 GTK, Motif, Mac OS/X, Haiku, and MS-Windows.
Bram Moolenaar02467872007-05-06 13:22:01 +00003793 *'go-f'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003794 'f' Foreground: Don't use fork() to detach the GUI from the shell
3795 where it was started. Use this for programs that wait for the
3796 editor to finish (e.g., an e-mail program). Alternatively you
3797 can use "gvim -f" or ":gui -f" to start the GUI in the
3798 foreground. |gui-fork|
3799 Note: Set this option in the vimrc file. The forking may have
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003800 happened already when the |gvimrc| file is read.
Bram Moolenaar02467872007-05-06 13:22:01 +00003801 *'go-i'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003802 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
3803 corner of the window. It's black&white on non-GTK, because of
3804 limitations of X11. For a color icon, see |X11-icon|.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003805 *'go-m'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003806 'm' Menu bar is present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003807 *'go-M'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003808 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00003809 that this flag must be added in the .vimrc file, before
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003810 switching on syntax or filetype recognition (when the |gvimrc|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003811 file is sourced the system menu has already been loaded; the
Bram Moolenaar01164a62017-11-02 22:58:42 +01003812 `:syntax on` and `:filetype on` commands load the menu too).
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003813 *'go-g'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003814 'g' Grey menu items: Make menu items that are not active grey. If
3815 'g' is not included inactive menu items are not shown at all.
3816 Exception: Athena will always use grey menu items.
Bram Moolenaar02467872007-05-06 13:22:01 +00003817 *'go-t'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003818 't' Include tearoff menu items. Currently only works for Win32,
3819 GTK+, and Motif 1.2 GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00003820 *'go-T'*
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00003821 'T' Include Toolbar. Currently only in Win32, GTK+, Motif, Photon
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00003822 and Athena GUIs.
Bram Moolenaar02467872007-05-06 13:22:01 +00003823 *'go-r'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003824 'r' Right-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003825 *'go-R'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003826 'R' Right-hand scrollbar is present when there is a vertically
3827 split window.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003828 *'go-l'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003829 'l' Left-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003830 *'go-L'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003831 'L' Left-hand scrollbar is present when there is a vertically
3832 split window.
Bram Moolenaar02467872007-05-06 13:22:01 +00003833 *'go-b'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003834 'b' Bottom (horizontal) scrollbar is present. Its size depends on
3835 the longest visible line, or on the cursor line if the 'h'
3836 flag is included. |gui-horiz-scroll|
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003837 *'go-h'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003838 'h' Limit horizontal scrollbar size to the length of the cursor
3839 line. Reduces computations. |gui-horiz-scroll|
3840
3841 And yes, you may even have scrollbars on the left AND the right if
3842 you really want to :-). See |gui-scrollbars| for more information.
3843
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003844 *'go-v'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003845 'v' Use a vertical button layout for dialogs. When not included,
3846 a horizontal layout is preferred, but when it doesn't fit a
3847 vertical layout is used anyway.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003848 *'go-p'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003849 'p' Use Pointer callbacks for X11 GUI. This is required for some
3850 window managers. If the cursor is not blinking or hollow at
3851 the right moment, try adding this flag. This must be done
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003852 before starting the GUI. Set it in your |gvimrc|. Adding or
Bram Moolenaar071d4272004-06-13 20:20:40 +00003853 removing it after the GUI has started has no effect.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003854 *'go-F'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003855 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar8ac44152017-11-09 18:33:29 +01003856 *'go-k'*
3857 'k' Keep the GUI window size when adding/removing a scrollbar, or
3858 toolbar, tabline, etc. Instead, the behavior is similar to
3859 when the window is maximized and will adjust 'lines' and
3860 'columns' to fit to the window. Without the 'k' flag Vim will
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003861 try to keep 'lines' and 'columns' the same when adding and
Bram Moolenaar8ac44152017-11-09 18:33:29 +01003862 removing GUI components.
Bram Moolenaar02467872007-05-06 13:22:01 +00003863
Bram Moolenaar071d4272004-06-13 20:20:40 +00003864 *'guipty'* *'noguipty'*
3865'guipty' boolean (default on)
3866 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003867 {only available when compiled with GUI enabled}
3868 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
3869 I/O to/from shell commands. See |gui-pty|.
3870
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003871 *'guitablabel'* *'gtl'*
3872'guitablabel' 'gtl' string (default empty)
3873 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02003874 {only available when compiled with GUI enabled}
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003875 When nonempty describes the text to use in a label of the GUI tab
Bram Moolenaard68071d2006-05-02 22:08:30 +00003876 pages line. When empty and when the result is empty Vim will use a
3877 default label. See |setting-guitablabel| for more info.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003878
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003879 The format of this option is like that of 'statusline'.
Bram Moolenaar57657d82006-04-21 22:12:41 +00003880 'guitabtooltip' is used for the tooltip, see below.
Bram Moolenaar51628222016-12-01 23:03:28 +01003881 The expression will be evaluated in the |sandbox| when set from a
3882 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003883 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003884
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003885 Only used when the GUI tab pages line is displayed. 'e' must be
3886 present in 'guioptions'. For the non-GUI tab pages line 'tabline' is
3887 used.
3888
Bram Moolenaar57657d82006-04-21 22:12:41 +00003889 *'guitabtooltip'* *'gtt'*
3890'guitabtooltip' 'gtt' string (default empty)
3891 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02003892 {only available when compiled with GUI enabled}
Bram Moolenaar57657d82006-04-21 22:12:41 +00003893 When nonempty describes the text to use in a tooltip for the GUI tab
3894 pages line. When empty Vim will use a default tooltip.
3895 This option is otherwise just like 'guitablabel' above.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003896 You can include a line break. Simplest method is to use |:let|: >
3897 :let &guitabtooltip = "line one\nline two"
3898<
Bram Moolenaar57657d82006-04-21 22:12:41 +00003899
Bram Moolenaar071d4272004-06-13 20:20:40 +00003900 *'helpfile'* *'hf'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003901'helpfile' 'hf' string (default (MS-Windows) "$VIMRUNTIME\doc\help.txt"
Bram Moolenaar071d4272004-06-13 20:20:40 +00003902 (others) "$VIMRUNTIME/doc/help.txt")
3903 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003904 Name of the main help file. All distributed help files should be
3905 placed together in one directory. Additionally, all "doc" directories
3906 in 'runtimepath' will be used.
3907 Environment variables are expanded |:set_env|. For example:
3908 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003909 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00003910 spaces and backslashes.
3911 This option cannot be set from a |modeline| or in the |sandbox|, for
3912 security reasons.
3913
3914 *'helpheight'* *'hh'*
3915'helpheight' 'hh' number (default 20)
3916 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003917 Minimal initial height of the help window when it is opened with the
3918 ":help" command. The initial height of the help window is half of the
3919 current window, or (when the 'ea' option is on) the same as other
3920 windows. When the height is less than 'helpheight', the height is
3921 set to 'helpheight'. Set to zero to disable.
3922
3923 *'helplang'* *'hlg'*
3924'helplang' 'hlg' string (default: messages language or empty)
3925 global
3926 {only available when compiled with the |+multi_lang|
3927 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003928 Comma separated list of languages. Vim will use the first language
3929 for which the desired help can be found. The English help will always
3930 be used as a last resort. You can add "en" to prefer English over
3931 another language, but that will only find tags that exist in that
3932 language and not in the English help.
3933 Example: >
3934 :set helplang=de,it
3935< This will first search German, then Italian and finally English help
3936 files.
3937 When using |CTRL-]| and ":help!" in a non-English help file Vim will
3938 try to find the tag in the current language before using this option.
3939 See |help-translated|.
3940
3941 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
3942'hidden' 'hid' boolean (default off)
3943 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003944 When off a buffer is unloaded when it is |abandon|ed. When on a
3945 buffer becomes hidden when it is |abandon|ed. If the buffer is still
3946 displayed in another window, it does not become hidden, of course.
3947 The commands that move through the buffer list sometimes make a buffer
3948 hidden although the 'hidden' option is off: When the buffer is
3949 modified, 'autowrite' is off or writing is not possible, and the '!'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003950 flag was used. See also |windows.txt|.
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00003951 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003952 This option is set for one command with ":hide {command}" |:hide|.
3953 WARNING: It's easy to forget that you have changes in hidden buffers.
3954 Think twice when using ":q!" or ":qa!".
3955
3956 *'highlight'* *'hl'*
3957'highlight' 'hl' string (default (as a single string):
Bram Moolenaar58b85342016-08-14 19:54:54 +02003958 "8:SpecialKey,~:EndOfBuffer,@:NonText,
3959 d:Directory,e:ErrorMsg,i:IncSearch,
3960 l:Search,m:MoreMsg,M:ModeMsg,n:LineNr,
Bram Moolenaarefae76a2019-10-27 22:54:58 +01003961 a:LineNrAbove,b:LineNrBelow,
Bram Moolenaar58b85342016-08-14 19:54:54 +02003962 N:CursorLineNr,r:Question,s:StatusLine,
3963 S:StatusLineNC,c:VertSplit,t:Title,
Bram Moolenaar9d87a372018-12-18 21:41:50 +01003964 v:Visual,V:VisualNOS,w:WarningMsg,
3965 W:WildMenu,f:Folded,F:FoldColumn,
3966 A:DiffAdd,C:DiffChange,D:DiffDelete,
3967 T:DiffText,>:SignColumn,-:Conceal,
Bram Moolenaarc8c88492018-12-27 23:59:26 +01003968 B:SpellBad,P:SpellCap,R:SpellRare,
Bram Moolenaar9d87a372018-12-18 21:41:50 +01003969 L:SpellLocal,+:Pmenu,=:PmenuSel,
Bram Moolenaar21020352017-06-13 17:21:04 +02003970 x:PmenuSbar,X:PmenuThumb,*:TabLine,
3971 #:TabLineSel,_:TabLineFill,!:CursorColumn,
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02003972 .:CursorLine,o:ColorColumn,q:QuickFixLine,
Bram Moolenaarc572da52017-08-27 16:52:01 +02003973 z:StatusLineTerm,Z:StatusLineTermNC")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003974 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003975 This option can be used to set highlighting mode for various
3976 occasions. It is a comma separated list of character pairs. The
3977 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003978 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003979 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
Bram Moolenaar58b85342016-08-14 19:54:54 +02003980 |hl-EndOfBuffer| ~ lines after the last line in the buffer
3981 |hl-NonText| @ '@' at the end of the window and
Bram Moolenaar071d4272004-06-13 20:20:40 +00003982 characters from 'showbreak'
3983 |hl-Directory| d directories in CTRL-D listing and other special
3984 things in listings
3985 |hl-ErrorMsg| e error messages
3986 h (obsolete, ignored)
3987 |hl-IncSearch| i 'incsearch' highlighting
3988 |hl-Search| l last search pattern highlighting (see 'hlsearch')
3989 |hl-MoreMsg| m |more-prompt|
3990 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
Bram Moolenaar64486672010-05-16 15:46:46 +02003991 |hl-LineNr| n line number for ":number" and ":#" commands, and
3992 when 'number' or 'relativenumber' option is set.
Bram Moolenaarefae76a2019-10-27 22:54:58 +01003993 |hl-LineNrAbove| a line number above the cursor for when the
3994 'relativenumber' option is set.
3995 |hl-LineNrBelow| b line number below the cursor for when the
3996 'relativenumber' option is set.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01003997 |hl-CursorLineNr| N like n for when 'cursorline' or 'relativenumber' is
3998 set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003999 |hl-Question| r |hit-enter| prompt and yes/no questions
4000 |hl-StatusLine| s status line of current window |status-line|
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01004001 |hl-StatusLineNC| S status lines of not-current windows
Bram Moolenaar071d4272004-06-13 20:20:40 +00004002 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
4003 |hl-VertSplit| c column used to separate vertically split windows
4004 |hl-Visual| v Visual mode
4005 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
4006 Selection" Only X11 Gui's |gui-x11| and
4007 |xterm-clipboard|.
4008 |hl-WarningMsg| w warning messages
4009 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
4010 |hl-Folded| f line used for closed folds
4011 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00004012 |hl-DiffAdd| A added line in diff mode
4013 |hl-DiffChange| C changed line in diff mode
4014 |hl-DiffDelete| D deleted line in diff mode
4015 |hl-DiffText| T inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00004016 |hl-SignColumn| > column used for |signs|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004017 |hl-Conceal| - the placeholders used for concealed characters
4018 (see 'conceallevel')
Bram Moolenaar217ad922005-03-20 22:37:15 +00004019 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02004020 |hl-SpellCap| P word that should start with capital |spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00004021 |hl-SpellRare| R rare word |spell|
4022 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004023 |hl-Pmenu| + popup menu normal line
4024 |hl-PmenuSel| = popup menu selected line
4025 |hl-PmenuSbar| x popup menu scrollbar
4026 |hl-PmenuThumb| X popup menu scrollbar thumb
Bram Moolenaar071d4272004-06-13 20:20:40 +00004027
4028 The display modes are:
4029 r reverse (termcap entry "mr" and "me")
4030 i italic (termcap entry "ZH" and "ZR")
4031 b bold (termcap entry "md" and "me")
4032 s standout (termcap entry "so" and "se")
4033 u underline (termcap entry "us" and "ue")
Bram Moolenaare2cc9702005-03-15 22:43:58 +00004034 c undercurl (termcap entry "Cs" and "Ce")
Bram Moolenaarcf4b00c2017-09-02 18:33:56 +02004035 t strikethrough (termcap entry "Ts" and "Te")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004036 n no highlighting
4037 - no highlighting
4038 : use a highlight group
4039 The default is used for occasions that are not included.
4040 If you want to change what the display modes do, see |dos-colors|
4041 for an example.
4042 When using the ':' display mode, this must be followed by the name of
4043 a highlight group. A highlight group can be used to define any type
4044 of highlighting, including using color. See |:highlight| on how to
4045 define one. The default uses a different group for each occasion.
4046 See |highlight-default| for the default highlight groups.
4047
Bram Moolenaar071d4272004-06-13 20:20:40 +00004048 *'history'* *'hi'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004049'history' 'hi' number (Vim default: 50, Vi default: 0,
4050 set to 200 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004051 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004052 A history of ":" commands, and a history of previous search patterns
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004053 is remembered. This option decides how many entries may be stored in
Bram Moolenaar071d4272004-06-13 20:20:40 +00004054 each of these histories (see |cmdline-editing|).
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004055 The maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004056 NOTE: This option is set to the Vi default value when 'compatible' is
4057 set and to the Vim default value when 'compatible' is reset.
4058
4059 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
4060'hkmap' 'hk' boolean (default off)
4061 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004062 {only available when compiled with the |+rightleft|
4063 feature}
4064 When on, the keyboard is mapped for the Hebrew character set.
4065 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
4066 toggle this option. See |rileft.txt|.
4067 NOTE: This option is reset when 'compatible' is set.
4068
4069 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
4070'hkmapp' 'hkp' boolean (default off)
4071 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004072 {only available when compiled with the |+rightleft|
4073 feature}
4074 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
4075 This is useful if you have a non-Hebrew keyboard.
4076 See |rileft.txt|.
4077 NOTE: This option is reset when 'compatible' is set.
4078
Bram Moolenaar036986f2017-03-16 17:41:02 +01004079 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
4080'hlsearch' 'hls' boolean (default off)
4081 global
Bram Moolenaar036986f2017-03-16 17:41:02 +01004082 {not available when compiled without the
4083 |+extra_search| feature}
4084 When there is a previous search pattern, highlight all its matches.
4085 The type of highlighting used can be set with the 'l' occasion in the
4086 'highlight' option. This uses the "Search" highlight group by
4087 default. Note that only the matching text is highlighted, any offsets
4088 are not applied.
4089 See also: 'incsearch' and |:match|.
4090 When you get bored looking at the highlighted matches, you can turn it
4091 off with |:nohlsearch|. This does not change the option value, as
4092 soon as you use a search command, the highlighting comes back.
4093 'redrawtime' specifies the maximum time spent on finding matches.
4094 When the search pattern can match an end-of-line, Vim will try to
4095 highlight all of the matched text. However, this depends on where the
4096 search starts. This will be the first line in the window or the first
4097 line below a closed fold. A match in a previous line which is not
4098 drawn may not continue in a newly drawn line.
4099 You can specify whether the highlight status is restored on startup
4100 with the 'h' flag in 'viminfo' |viminfo-h|.
4101 NOTE: This option is reset when 'compatible' is set.
4102
Bram Moolenaar071d4272004-06-13 20:20:40 +00004103 *'icon'* *'noicon'*
4104'icon' boolean (default off, on when title can be restored)
4105 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004106 {not available when compiled without the |+title|
4107 feature}
4108 When on, the icon text of the window will be set to the value of
4109 'iconstring' (if it is not empty), or to the name of the file
4110 currently being edited. Only the last part of the name is used.
4111 Overridden by the 'iconstring' option.
4112 Only works if the terminal supports setting window icons (currently
4113 only X11 GUI and terminals with a non-empty 't_IS' option - these are
4114 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
4115 builtin termcap).
4116 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00004117 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00004118 X11.
Bram Moolenaar3a991dd2014-10-02 01:41:41 +02004119 For MS-Windows the icon can be changed, see |windows-icon|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004120
4121 *'iconstring'*
4122'iconstring' string (default "")
4123 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004124 {not available when compiled without the |+title|
4125 feature}
4126 When this option is not empty, it will be used for the icon text of
4127 the window. This happens only when the 'icon' option is on.
4128 Only works if the terminal supports setting window icon text
4129 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
4130 Does not work for MS Windows.
4131 When Vim was compiled with HAVE_X11 defined, the original icon will be
4132 restored if possible |X11|.
4133 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004134 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004135 'titlestring' for example settings.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004136 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004137 {not available when compiled without the |+statusline| feature}
4138
4139 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
4140'ignorecase' 'ic' boolean (default off)
4141 global
4142 Ignore case in search patterns. Also used when searching in the tags
4143 file.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01004144 Also see 'smartcase' and 'tagcase'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004145 Can be overruled by using "\c" or "\C" in the pattern, see
4146 |/ignorecase|.
4147
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004148 *'imactivatefunc'* *'imaf'*
4149'imactivatefunc' 'imaf' string (default "")
4150 global
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004151 This option specifies a function that will be called to
Bram Moolenaar2877d332017-11-26 14:56:16 +01004152 activate or deactivate the Input Method.
Bram Moolenaaref8c6172020-07-01 15:12:44 +02004153 It is not used in the MS-Windows GUI version.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004154 The expression will be evaluated in the |sandbox| when set from a
4155 modeline, see |sandbox-option|.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004156
4157 Example: >
4158 function ImActivateFunc(active)
4159 if a:active
4160 ... do something
4161 else
4162 ... do something
4163 endif
4164 " return value is not used
4165 endfunction
4166 set imactivatefunc=ImActivateFunc
4167<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004168 *'imactivatekey'* *'imak'*
4169'imactivatekey' 'imak' string (default "")
4170 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004171 {only available when compiled with |+xim| and
Bram Moolenaar67c53842010-05-22 18:28:27 +02004172 |+GUI_GTK|} *E599*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004173 Specifies the key that your Input Method in X-Windows uses for
4174 activation. When this is specified correctly, vim can fully control
4175 IM with 'imcmdline', 'iminsert' and 'imsearch'.
4176 You can't use this option to change the activation key, the option
4177 tells Vim what the key is.
4178 Format:
4179 [MODIFIER_FLAG-]KEY_STRING
4180
4181 These characters can be used for MODIFIER_FLAG (case is ignored):
4182 S Shift key
4183 L Lock key
4184 C Control key
4185 1 Mod1 key
4186 2 Mod2 key
4187 3 Mod3 key
4188 4 Mod4 key
4189 5 Mod5 key
4190 Combinations are allowed, for example "S-C-space" or "SC-space" are
4191 both shift+ctrl+space.
4192 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
4193
4194 Example: >
4195 :set imactivatekey=S-space
4196< "S-space" means shift+space. This is the activation key for kinput2 +
4197 canna (Japanese), and ami (Korean).
4198
4199 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
4200'imcmdline' 'imc' boolean (default off)
4201 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004202 When set the Input Method is always on when starting to edit a command
4203 line, unless entering a search pattern (see 'imsearch' for that).
4204 Setting this option is useful when your input method allows entering
4205 English characters directly, e.g., when it's used to type accented
4206 characters with dead keys.
4207
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004208 *'imdisable'* *'imd'* *'noimdisable'* *'noimd'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004209'imdisable' 'imd' boolean (default off, on for some systems (SGI))
4210 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004211 When set the Input Method is never used. This is useful to disable
4212 the IM when it doesn't work properly.
4213 Currently this option is on by default for SGI/IRIX machines. This
4214 may change in later releases.
4215
4216 *'iminsert'* *'imi'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004217'iminsert' 'imi' number (default 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004218 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004219 Specifies whether :lmap or an Input Method (IM) is to be used in
4220 Insert mode. Valid values:
4221 0 :lmap is off and IM is off
4222 1 :lmap is ON and IM is off
4223 2 :lmap is off and IM is ON
Bram Moolenaar071d4272004-06-13 20:20:40 +00004224 To always reset the option to zero when leaving Insert mode with <Esc>
4225 this can be used: >
4226 :inoremap <ESC> <ESC>:set iminsert=0<CR>
4227< This makes :lmap and IM turn off automatically when leaving Insert
4228 mode.
4229 Note that this option changes when using CTRL-^ in Insert mode
4230 |i_CTRL-^|.
4231 The value is set to 1 when setting 'keymap' to a valid keymap name.
4232 It is also used for the argument of commands like "r" and "f".
4233 The value 0 may not work correctly with Athena and Motif with some XIM
4234 methods. Use 'imdisable' to disable XIM then.
4235
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004236 You can set 'imactivatefunc' and 'imstatusfunc' to handle IME/XIM
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004237 via external command if Vim is not compiled with the |+xim|,
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004238 |+multi_byte_ime| or |global-ime|.
4239
Bram Moolenaar071d4272004-06-13 20:20:40 +00004240 *'imsearch'* *'ims'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004241'imsearch' 'ims' number (default -1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004242 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004243 Specifies whether :lmap or an Input Method (IM) is to be used when
4244 entering a search pattern. Valid values:
4245 -1 the value of 'iminsert' is used, makes it look like
4246 'iminsert' is also used when typing a search pattern
4247 0 :lmap is off and IM is off
4248 1 :lmap is ON and IM is off
4249 2 :lmap is off and IM is ON
4250 Note that this option changes when using CTRL-^ in Command-line mode
4251 |c_CTRL-^|.
4252 The value is set to 1 when it is not -1 and setting the 'keymap'
4253 option to a valid keymap name.
4254 The value 0 may not work correctly with Athena and Motif with some XIM
4255 methods. Use 'imdisable' to disable XIM then.
4256
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004257 *'imstatusfunc'* *'imsf'*
4258'imstatusfunc' 'imsf' string (default "")
4259 global
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004260 This option specifies a function that is called to obtain the status
4261 of Input Method. It must return a positive number when IME is active.
Bram Moolenaaref8c6172020-07-01 15:12:44 +02004262 It is not used in the MS-Windows GUI version.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004263
4264 Example: >
4265 function ImStatusFunc()
4266 let is_active = ...do something
4267 return is_active ? 1 : 0
4268 endfunction
4269 set imstatusfunc=ImStatusFunc
4270<
4271 NOTE: This function is invoked very often. Keep it fast.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004272 The expression will be evaluated in the |sandbox| when set from a
4273 modeline, see |sandbox-option|.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004274
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004275 *'imstyle'* *'imst'*
4276'imstyle' 'imst' number (default 1)
4277 global
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004278 {only available when compiled with |+xim| and
4279 |+GUI_GTK|}
Bram Moolenaar37c64c72017-09-19 22:06:03 +02004280 This option specifies the input style of Input Method:
4281 0 use on-the-spot style
4282 1 over-the-spot style
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004283 See: |xim-input-style|
4284
Bram Moolenaar24a98a02017-09-27 22:23:55 +02004285 For a long time on-the-spot style had been used in the GTK version of
4286 vim, however, it is known that it causes troubles when using mappings,
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004287 |single-repeat|, etc. Therefore over-the-spot style becomes the
4288 default now. This should work fine for most people, however if you
4289 have any problem with it, try using on-the-spot style.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004290 The expression will be evaluated in the |sandbox| when set from a
4291 modeline, see |sandbox-option|.
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004292
Bram Moolenaar071d4272004-06-13 20:20:40 +00004293 *'include'* *'inc'*
4294'include' 'inc' string (default "^\s*#\s*include")
4295 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004296 {not available when compiled without the
4297 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004298 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00004299 pattern, just like for the "/" command (See |pattern|). The default
4300 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar1e015462005-09-25 22:16:38 +00004301 "]I", "[d", etc.
4302 Normally the 'isfname' option is used to recognize the file name that
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004303 comes after the matched pattern. But if "\zs" appears in the pattern
4304 then the text matched from "\zs" to the end, or until "\ze" if it
4305 appears, is used as the file name. Use this to include characters
4306 that are not in 'isfname', such as a space. You can then use
4307 'includeexpr' to process the matched text.
Bram Moolenaar1e015462005-09-25 22:16:38 +00004308 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004309
4310 *'includeexpr'* *'inex'*
4311'includeexpr' 'inex' string (default "")
4312 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004313 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004314 |+find_in_path| or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004315 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004316 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004317 :set includeexpr=substitute(v:fname,'\\.','/','g')
4318< The "v:fname" variable will be set to the file name that was detected.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004319
Bram Moolenaar071d4272004-06-13 20:20:40 +00004320 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004321 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004322 Also used for |<cfile>|.
4323
Bram Moolenaar30b65812012-07-12 22:01:11 +02004324 The expression will be evaluated in the |sandbox| when set from a
4325 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004326 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004327
4328 It is not allowed to change text or jump to another window while
4329 evaluating 'includeexpr' |textlock|.
4330
Bram Moolenaar071d4272004-06-13 20:20:40 +00004331 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004332'incsearch' 'is' boolean (default off, set in |defaults.vim| if the
4333 +reltime feature is supported)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004334 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004335 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004336 |+extra_search| features}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004337 While typing a search command, show where the pattern, as it was typed
4338 so far, matches. The matched string is highlighted. If the pattern
4339 is invalid or not found, nothing is shown. The screen will be updated
4340 often, this is only useful on fast terminals.
Bram Moolenaarfc65cab2018-08-28 22:58:02 +02004341 Also applies to the pattern in commands: >
4342 :global
4343 :lvimgrep
4344 :lvimgrepadd
4345 :smagic
4346 :snomagic
4347 :sort
4348 :substitute
4349 :vglobal
4350 :vimgrep
4351 :vimgrepadd
4352< Note that the match will be shown, but the cursor will return to its
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004353 original position when no match is found and when pressing <Esc>. You
4354 still need to finish the search command with <Enter> to move the
4355 cursor to the match.
Bram Moolenaardc083282016-10-11 08:57:33 +02004356 You can use the CTRL-G and CTRL-T keys to move to the next and
4357 previous match. |c_CTRL-G| |c_CTRL-T|
Bram Moolenaar91a4e822008-01-19 14:59:58 +00004358 When compiled with the |+reltime| feature Vim only searches for about
4359 half a second. With a complicated pattern and/or a lot of text the
4360 match may not be found. This is to avoid that Vim hangs while you
4361 are typing the pattern.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004362 The highlighting can be set with the 'i' flag in 'highlight'.
Bram Moolenaar2f058492017-11-30 20:27:52 +01004363 When 'hlsearch' is on, all matched strings are highlighted too while
4364 typing a search command. See also: 'hlsearch'.
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004365 If you don't want to turn 'hlsearch' on, but want to highlight all
4366 matches while searching, you can turn on and off 'hlsearch' with
4367 autocmd. Example: >
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004368 augroup vimrc-incsearch-highlight
4369 autocmd!
Bram Moolenaarf8f8b2e2017-11-02 19:08:48 +01004370 autocmd CmdlineEnter /,\? :set hlsearch
4371 autocmd CmdlineLeave /,\? :set nohlsearch
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004372 augroup END
4373<
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004374 CTRL-L can be used to add one character from after the current match
Bram Moolenaara9dc3752010-07-11 20:46:53 +02004375 to the command line. If 'ignorecase' and 'smartcase' are set and the
4376 command line has no uppercase characters, the added character is
4377 converted to lowercase.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004378 CTRL-R CTRL-W can be used to add the word at the end of the current
4379 match, excluding the characters that were already typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004380 NOTE: This option is reset when 'compatible' is set.
4381
4382 *'indentexpr'* *'inde'*
4383'indentexpr' 'inde' string (default "")
4384 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004385 {not available when compiled without the |+cindent|
4386 or |+eval| features}
4387 Expression which is evaluated to obtain the proper indent for a line.
4388 It is used when a new line is created, for the |=| operator and
4389 in Insert mode as specified with the 'indentkeys' option.
4390 When this option is not empty, it overrules the 'cindent' and
Bram Moolenaar20f90cf2011-05-19 12:22:51 +02004391 'smartindent' indenting. When 'lisp' is set, this option is
4392 overridden by the Lisp indentation algorithm.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004393 When 'paste' is set this option is not used for indenting.
4394 The expression is evaluated with |v:lnum| set to the line number for
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004395 which the indent is to be computed. The cursor is also in this line
Bram Moolenaar071d4272004-06-13 20:20:40 +00004396 when the expression is evaluated (but it may be moved around).
4397 The expression must return the number of spaces worth of indent. It
4398 can return "-1" to keep the current indent (this means 'autoindent' is
4399 used for the indent).
4400 Functions useful for computing the indent are |indent()|, |cindent()|
4401 and |lispindent()|.
4402 The evaluation of the expression must not have side effects! It must
4403 not change the text, jump to another window, etc. Afterwards the
4404 cursor position is always restored, thus the cursor may be moved.
4405 Normally this option would be set to call a function: >
4406 :set indentexpr=GetMyIndent()
4407< Error messages will be suppressed, unless the 'debug' option contains
4408 "msg".
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004409 See |indent-expression|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01004410 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004411
Bram Moolenaar30b65812012-07-12 22:01:11 +02004412 The expression will be evaluated in the |sandbox| when set from a
4413 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004414 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004415
4416 It is not allowed to change text or jump to another window while
4417 evaluating 'indentexpr' |textlock|.
4418
4419
Bram Moolenaar071d4272004-06-13 20:20:40 +00004420 *'indentkeys'* *'indk'*
Bram Moolenaarce655742019-01-31 14:12:57 +01004421'indentkeys' 'indk' string (default "0{,0},0),0],:,0#,!^F,o,O,e")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004422 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004423 {not available when compiled without the |+cindent|
4424 feature}
4425 A list of keys that, when typed in Insert mode, cause reindenting of
4426 the current line. Only happens if 'indentexpr' isn't empty.
4427 The format is identical to 'cinkeys', see |indentkeys-format|.
4428 See |C-indenting| and |indent-expression|.
4429
4430 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
4431'infercase' 'inf' boolean (default off)
4432 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004433 When doing keyword completion in insert mode |ins-completion|, and
Bram Moolenaar446cb832008-06-24 21:56:24 +00004434 'ignorecase' is also on, the case of the match is adjusted depending
4435 on the typed text. If the typed text contains a lowercase letter
4436 where the match has an upper case letter, the completed part is made
4437 lowercase. If the typed text has no lowercase letters and the match
4438 has a lowercase letter where the typed text has an uppercase letter,
4439 and there is a letter before it, the completed part is made uppercase.
4440 With 'noinfercase' the match is used as-is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004441
4442 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
4443'insertmode' 'im' boolean (default off)
4444 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004445 Makes Vim work in a way that Insert mode is the default mode. Useful
4446 if you want to use Vim as a modeless editor. Used for |evim|.
4447 These Insert mode commands will be useful:
4448 - Use the cursor keys to move around.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02004449 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|. When
Bram Moolenaar071d4272004-06-13 20:20:40 +00004450 this is a mapping, it is executed as if 'insertmode' was off.
4451 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004452 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00004453 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
4454 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004455
4456 These items change when 'insertmode' is set:
4457 - when starting to edit of a file, Vim goes to Insert mode.
4458 - <Esc> in Insert mode is a no-op and beeps.
4459 - <Esc> in Normal mode makes Vim go to Insert mode.
4460 - CTRL-L in Insert mode is a command, it is not inserted.
4461 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
4462 However, when <Esc> is used inside a mapping, it behaves like
4463 'insertmode' was not set. This was done to be able to use the same
4464 mappings with 'insertmode' set or not set.
4465 When executing commands with |:normal| 'insertmode' is not used.
4466
4467 NOTE: This option is reset when 'compatible' is set.
4468
4469 *'isfname'* *'isf'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004470'isfname' 'isf' string (default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004471 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
4472 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
4473 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
4474 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
4475 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
4476 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004477 The characters specified by this option are included in file names and
4478 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004479 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004480 Multi-byte characters 256 and above are always included, only the
4481 characters up to 255 are specified with this option.
4482 For UTF-8 the characters 0xa0 to 0xff are included as well.
Bram Moolenaar446cb832008-06-24 21:56:24 +00004483 Think twice before adding white space to this option. Although a
4484 space may appear inside a file name, the effect will be that Vim
4485 doesn't know where a file name starts or ends when doing completion.
4486 It most likely works better without a space in 'isfname'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004487
4488 Note that on systems using a backslash as path separator, Vim tries to
4489 do its best to make it work as you would expect. That is a bit
4490 tricky, since Vi originally used the backslash to escape special
4491 characters. Vim will not remove a backslash in front of a normal file
4492 name character on these systems, but it will on Unix and alikes. The
4493 '&' and '^' are not included by default, because these are special for
4494 cmd.exe.
4495
4496 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004497 Each part can be a single character number or a range. A range is two
4498 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004499 decimal number between 0 and 255 or the ASCII character itself (does
4500 not work for digits). Example:
4501 "_,-,128-140,#-43" (include '_' and '-' and the range
4502 128 to 140 and '#' to 43)
4503 If a part starts with '^', the following character number or range
4504 will be excluded from the option. The option is interpreted from left
4505 to right. Put the excluded character after the range where it is
4506 included. To include '^' itself use it as the last character of the
4507 option or the end of a range. Example:
4508 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
4509 If the character is '@', all characters where isalpha() returns TRUE
4510 are included. Normally these are the characters a to z and A to Z,
4511 plus accented characters. To include '@' itself use "@-@". Examples:
4512 "@,^a-z" All alphabetic characters, excluding lower
Bram Moolenaar446cb832008-06-24 21:56:24 +00004513 case ASCII letters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004514 "a-z,A-Z,@-@" All letters plus the '@' character.
4515 A comma can be included by using it where a character number is
4516 expected. Example:
4517 "48-57,,,_" Digits, comma and underscore.
4518 A comma can be excluded by prepending a '^'. Example:
4519 " -~,^,,9" All characters from space to '~', excluding
4520 comma, plus <Tab>.
4521 See |option-backslash| about including spaces and backslashes.
4522
4523 *'isident'* *'isi'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004524'isident' 'isi' string (default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004525 "@,48-57,_,128-167,224-235"
4526 otherwise: "@,48-57,_,192-255")
4527 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004528 The characters given by this option are included in identifiers.
4529 Identifiers are used in recognizing environment variables and after a
4530 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00004531 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004532 option. For '@' only characters up to 255 are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004533 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004534 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00004535 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
4536
4537 *'iskeyword'* *'isk'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004538'iskeyword' 'isk' string (Vim default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004539 "@,48-57,_,128-167,224-235"
4540 otherwise: "@,48-57,_,192-255"
4541 Vi default: "@,48-57,_")
4542 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004543 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004544 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004545 'isfname' for a description of the format of this option. For '@'
4546 characters above 255 check the "word" character class.
4547 For C programs you could use "a-z,A-Z,48-57,_,.,-,>".
Bram Moolenaar071d4272004-06-13 20:20:40 +00004548 For a help file it is set to all non-blank printable characters except
4549 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
4550 command).
4551 When the 'lisp' option is on the '-' character is always included.
Bram Moolenaarb8060fe2016-01-19 22:29:28 +01004552 This option also influences syntax highlighting, unless the syntax
4553 uses |:syn-iskeyword|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004554 NOTE: This option is set to the Vi default value when 'compatible' is
4555 set and to the Vim default value when 'compatible' is reset.
4556
4557 *'isprint'* *'isp'*
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02004558'isprint' 'isp' string (default for Win32 and macOS:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004559 "@,~-255"; otherwise: "@,161-255")
4560 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004561 The characters given by this option are displayed directly on the
4562 screen. It is also used for "\p" in a |pattern|. The characters from
4563 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
4564 even when they are not included in 'isprint' or excluded. See
4565 'isfname' for a description of the format of this option.
4566
4567 Non-printable characters are displayed with two characters:
4568 0 - 31 "^@" - "^_"
4569 32 - 126 always single characters
4570 127 "^?"
4571 128 - 159 "~@" - "~_"
4572 160 - 254 "| " - "|~"
4573 255 "~?"
4574 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
4575 displayed as <xx>, with the hexadecimal value of the byte.
4576 When 'display' contains "uhex" all unprintable characters are
4577 displayed as <xx>.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004578 The SpecialKey highlighting will be used for unprintable characters.
4579 |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004580
4581 Multi-byte characters 256 and above are always included, only the
4582 characters up to 255 are specified with this option. When a character
4583 is printable but it is not available in the current font, a
4584 replacement character will be shown.
4585 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
4586 There is no option to specify these characters.
4587
4588 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
4589'joinspaces' 'js' boolean (default on)
4590 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004591 Insert two spaces after a '.', '?' and '!' with a join command.
4592 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
4593 Otherwise only one space is inserted.
4594 NOTE: This option is set when 'compatible' is set.
4595
4596 *'key'*
4597'key' string (default "")
4598 local to buffer
Bram Moolenaar996343d2010-07-04 22:20:21 +02004599 {only available when compiled with the |+cryptv|
4600 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004601 The key that is used for encrypting and decrypting the current buffer.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02004602 See |encryption| and 'cryptmethod'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004603 Careful: Do not set the key value by hand, someone might see the typed
4604 key. Use the |:X| command. But you can make 'key' empty: >
4605 :set key=
4606< It is not possible to get the value of this option with ":set key" or
4607 "echo &key". This is to avoid showing it to someone who shouldn't
4608 know. It also means you cannot see it yourself once you have set it,
4609 be careful not to make a typing error!
Bram Moolenaard58e9292011-02-09 17:07:58 +01004610 You can use "&key" in an expression to detect whether encryption is
4611 enabled. When 'key' is set it returns "*****" (five stars).
Bram Moolenaar071d4272004-06-13 20:20:40 +00004612
4613 *'keymap'* *'kmp'* *E544*
4614'keymap' 'kmp' string (default "")
4615 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004616 {only available when compiled with the |+keymap|
4617 feature}
4618 Name of a keyboard mapping. See |mbyte-keymap|.
4619 Setting this option to a valid keymap name has the side effect of
4620 setting 'iminsert' to one, so that the keymap becomes effective.
4621 'imsearch' is also set to one, unless it was -1
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004622 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004623
4624 *'keymodel'* *'km'*
4625'keymodel' 'km' string (default "")
4626 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004627 List of comma separated words, which enable special things that keys
4628 can do. These values can be used:
4629 startsel Using a shifted special key starts selection (either
4630 Select mode or Visual mode, depending on "key" being
4631 present in 'selectmode').
4632 stopsel Using a not-shifted special key stops selection.
4633 Special keys in this context are the cursor keys, <End>, <Home>,
4634 <PageUp> and <PageDown>.
4635 The 'keymodel' option is set by the |:behave| command.
4636
4637 *'keywordprg'* *'kp'*
4638'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02004639 VMS: "help")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004640 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004641 Program to use for the |K| command. Environment variables are
4642 expanded |:set_env|. ":help" may be used to access the Vim internal
4643 help. (Note that previously setting the global option to the empty
4644 value did this, which is now deprecated.)
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02004645 When the first character is ":", the command is invoked as a Vim
4646 Ex command prefixed with [count].
4647 When "man", "man -s" or an Ex command is used, Vim will automatically
4648 translate a count for the "K" command and pass it as the first
4649 argument. For "man -s" the "-s" is removed when there is no count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004650 See |option-backslash| about including spaces and backslashes.
4651 Example: >
4652 :set keywordprg=man\ -s
4653< This option cannot be set from a |modeline| or in the |sandbox|, for
4654 security reasons.
4655
4656 *'langmap'* *'lmap'* *E357* *E358*
4657'langmap' 'lmap' string (default "")
4658 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004659 {only available when compiled with the |+langmap|
4660 feature}
4661 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004662 mode. When you are typing text in Insert mode the characters are
Bram Moolenaarfa735342016-01-03 22:14:44 +01004663 inserted directly. When in Normal mode the 'langmap' option takes
Bram Moolenaar071d4272004-06-13 20:20:40 +00004664 care of translating these special characters to the original meaning
4665 of the key. This means you don't have to change the keyboard mode to
4666 be able to execute Normal mode commands.
4667 This is the opposite of the 'keymap' option, where characters are
4668 mapped in Insert mode.
Bram Moolenaarb17893a2020-03-14 08:19:51 +01004669 Also consider setting 'langremap' to off, to prevent 'langmap' from
4670 applying to characters resulting from a mapping.
Bram Moolenaare968e362014-05-13 20:23:24 +02004671 This option cannot be set from a |modeline| or in the |sandbox|, for
4672 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004673
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00004674 Example (for Greek, in UTF-8): *greek* >
4675 :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 +00004676< Example (exchanges meaning of z and y for commands): >
4677 :set langmap=zy,yz,ZY,YZ
4678<
4679 The 'langmap' option is a list of parts, separated with commas. Each
4680 part can be in one of two forms:
4681 1. A list of pairs. Each pair is a "from" character immediately
4682 followed by the "to" character. Examples: "aA", "aAbBcC".
4683 2. A list of "from" characters, a semi-colon and a list of "to"
4684 characters. Example: "abc;ABC"
4685 Example: "aA,fgh;FGH,cCdDeE"
4686 Special characters need to be preceded with a backslash. These are
Bram Moolenaar4f4d51a2020-10-11 13:57:40 +02004687 ";", ',', '"', '|' and backslash itself.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004688
4689 This will allow you to activate vim actions without having to switch
4690 back and forth between the languages. Your language characters will
4691 be understood as normal vim English characters (according to the
4692 langmap mappings) in the following cases:
4693 o Normal/Visual mode (commands, buffer/register names, user mappings)
4694 o Insert/Replace Mode: Register names after CTRL-R
4695 o Insert/Replace Mode: Mappings
4696 Characters entered in Command-line mode will NOT be affected by
4697 this option. Note that this option can be changed at any time
4698 allowing to switch between mappings for different languages/encodings.
4699 Use a mapping to avoid having to type it each time!
4700
4701 *'langmenu'* *'lm'*
4702'langmenu' 'lm' string (default "")
4703 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004704 {only available when compiled with the |+menu| and
4705 |+multi_lang| features}
4706 Language to use for menu translation. Tells which file is loaded
4707 from the "lang" directory in 'runtimepath': >
4708 "lang/menu_" . &langmenu . ".vim"
4709< (without the spaces). For example, to always use the Dutch menus, no
4710 matter what $LANG is set to: >
4711 :set langmenu=nl_NL.ISO_8859-1
4712< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004713 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004714 If your $LANG is set to a non-English language but you do want to use
4715 the English menus: >
4716 :set langmenu=none
4717< This option must be set before loading menus, switching on filetype
4718 detection or syntax highlighting. Once the menus are defined setting
4719 this option has no effect. But you could do this: >
4720 :source $VIMRUNTIME/delmenu.vim
4721 :set langmenu=de_DE.ISO_8859-1
4722 :source $VIMRUNTIME/menu.vim
4723< Warning: This deletes all menus that you defined yourself!
4724
Bram Moolenaard94464e2015-11-02 15:28:18 +01004725 *'langnoremap'* *'lnr'* *'nolangnoremap'* *'nolnr'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004726'langnoremap' 'lnr' boolean (default off, set in |defaults.vim|)
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004727 global
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004728 {only available when compiled with the |+langmap|
4729 feature}
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004730 This is just like 'langremap' but with the value inverted. It only
4731 exists for backwards compatibility. When setting 'langremap' then
4732 'langnoremap' is set to the inverted value, and the other way around.
4733
4734 *'langremap'* *'lrm'* *'nolangremap'* *'nolrm'*
Bram Moolenaarb17893a2020-03-14 08:19:51 +01004735'langremap' 'lrm' boolean (default on, set to off in |defaults.vim|)
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004736 global
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004737 {only available when compiled with the |+langmap|
4738 feature}
4739 When off, setting 'langmap' does not apply to characters resulting from
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004740 a mapping. This basically means, if you noticed that setting
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004741 'langmap' disables some of your mappings, try resetting this option.
4742 This option defaults to on for backwards compatibility. Set it off if
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004743 that works for you to avoid mappings to break.
4744
Bram Moolenaar071d4272004-06-13 20:20:40 +00004745 *'laststatus'* *'ls'*
4746'laststatus' 'ls' number (default 1)
4747 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004748 The value of this option influences when the last window will have a
4749 status line:
4750 0: never
4751 1: only if there are at least two windows
4752 2: always
4753 The screen looks nicer with a status line if you have several
4754 windows, but it takes another screen line. |status-line|
4755
4756 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
4757'lazyredraw' 'lz' boolean (default off)
4758 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004759 When this option is set, the screen will not be redrawn while
4760 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004761 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00004762 update use |:redraw|.
4763
4764 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
4765'linebreak' 'lbr' boolean (default off)
4766 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02004767 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004768 feature}
Bram Moolenaar946e27a2014-06-25 18:50:27 +02004769 If on, Vim will wrap long lines at a character in 'breakat' rather
Bram Moolenaar071d4272004-06-13 20:20:40 +00004770 than at the last character that fits on the screen. Unlike
4771 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
Bram Moolenaar946e27a2014-06-25 18:50:27 +02004772 it only affects the way the file is displayed, not its contents.
4773 If 'breakindent' is set, line is visually indented. Then, the value
4774 of 'showbreak' is used to put in front of wrapped lines. This option
Bram Moolenaar86b17e92014-07-02 20:00:47 +02004775 is not used when the 'wrap' option is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004776 Note that <Tab> characters after an <EOL> are mostly not displayed
4777 with the right amount of white space.
4778
4779 *'lines'* *E593*
4780'lines' number (default 24 or terminal height)
4781 global
4782 Number of lines of the Vim window.
4783 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00004784 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004785 When Vim is running in the GUI or in a resizable window, setting this
4786 option will cause the window size to be changed. When you only want
4787 to use the size for the GUI, put the command in your |gvimrc| file.
4788 Vim limits the number of lines to what fits on the screen. You can
4789 use this command to get the tallest window possible: >
4790 :set lines=999
Bram Moolenaarf4d11452005-12-02 00:46:37 +00004791< Minimum value is 2, maximum value is 1000.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02004792 If you get fewer lines than expected, check the 'guiheadroom' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004793 When you set this option and Vim is unable to change the physical
4794 number of lines of the display, the display may be messed up.
4795
4796 *'linespace'* *'lsp'*
4797'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
4798 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004799 {only in the GUI}
4800 Number of pixel lines inserted between characters. Useful if the font
4801 uses the full character cell height, making lines touch each other.
4802 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004803 With some fonts there can be too much room between lines (to have
4804 space for ascents and descents). Then it makes sense to set
4805 'linespace' to a negative value. This may cause display problems
4806 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00004807
4808 *'lisp'* *'nolisp'*
4809'lisp' boolean (default off)
4810 local to buffer
4811 {not available when compiled without the |+lispindent|
4812 feature}
4813 Lisp mode: When <Enter> is typed in insert mode set the indent for
4814 the next line to Lisp standards (well, sort of). Also happens with
4815 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
4816 flag in 'cpoptions' changes the method of indenting: Vi compatible or
4817 better. Also see 'lispwords'.
4818 The '-' character is included in keyword characters. Redefines the
4819 "=" operator to use this same indentation algorithm rather than
4820 calling an external program if 'equalprg' is empty.
4821 This option is not used when 'paste' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004822
4823 *'lispwords'* *'lw'*
4824'lispwords' 'lw' string (default is very long)
Bram Moolenaaraf6c1312014-03-12 18:55:58 +01004825 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004826 {not available when compiled without the |+lispindent|
4827 feature}
4828 Comma separated list of words that influence the Lisp indenting.
4829 |'lisp'|
4830
4831 *'list'* *'nolist'*
4832'list' boolean (default off)
4833 local to window
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004834 List mode: Show tabs as CTRL-I is displayed, display $ after end of
4835 line. Useful to see the difference between tabs and spaces and for
4836 trailing blanks. Further changed by the 'listchars' option.
4837
4838 The cursor is displayed at the start of the space a Tab character
4839 occupies, not at the end as usual in Normal mode. To get this cursor
4840 position while displaying Tabs with spaces, use: >
Bram Moolenaardd007ed2013-07-09 15:44:17 +02004841 :set list lcs=tab:\ \
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004842<
4843 Note that list mode will also affect formatting (set with 'textwidth'
4844 or 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
Bram Moolenaar071d4272004-06-13 20:20:40 +00004845 changing the way tabs are displayed.
4846
4847 *'listchars'* *'lcs'*
4848'listchars' 'lcs' string (default "eol:$")
4849 global
Bram Moolenaarf9d5ca12010-08-01 16:13:51 +02004850 Strings to use in 'list' mode and for the |:list| command. It is a
4851 comma separated list of string settings.
Bram Moolenaar79278362015-04-21 18:33:48 +02004852 *lcs-eol*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004853 eol:c Character to show at the end of each line. When
4854 omitted, there is no extra character at the end of the
4855 line.
Bram Moolenaar79278362015-04-21 18:33:48 +02004856 *lcs-tab*
Bram Moolenaar83a52172019-01-16 22:41:54 +01004857 tab:xy[z] Two or three characters to be used to show a tab.
4858 The third character is optional.
4859
4860 tab:xy The 'x' is always used, then 'y' as many times as will
4861 fit. Thus "tab:>-" displays:
4862 >
4863 >-
4864 >--
4865 etc.
4866
4867 tab:xyz The 'z' is always used, then 'x' is prepended, and
4868 then 'y' is used as many times as will fit. Thus
4869 "tab:<->" displays:
4870 >
4871 <>
4872 <->
4873 <-->
4874 etc.
4875
4876 When "tab:" is omitted, a tab is shown as ^I.
Bram Moolenaar79278362015-04-21 18:33:48 +02004877 *lcs-space*
4878 space:c Character to show for a space. When omitted, spaces
4879 are left blank.
4880 *lcs-trail*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004881 trail:c Character to show for trailing spaces. When omitted,
Bram Moolenaar79278362015-04-21 18:33:48 +02004882 trailing spaces are blank. Overrides the "space"
4883 setting for trailing spaces.
4884 *lcs-extends*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004885 extends:c Character to show in the last column, when 'wrap' is
4886 off and the line continues beyond the right of the
4887 screen.
Bram Moolenaar79278362015-04-21 18:33:48 +02004888 *lcs-precedes*
Bram Moolenaarbffba7f2019-09-20 17:00:17 +02004889 precedes:c Character to show in the first visible column of the
4890 physical line, when there is text preceding the
4891 character visible in the first column.
Bram Moolenaar79278362015-04-21 18:33:48 +02004892 *lcs-conceal*
Bram Moolenaar860cae12010-06-05 23:22:07 +02004893 conceal:c Character to show in place of concealed text, when
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004894 'conceallevel' is set to 1.
Bram Moolenaar79278362015-04-21 18:33:48 +02004895 *lcs-nbsp*
Bram Moolenaar73284b92015-05-04 17:28:22 +02004896 nbsp:c Character to show for a non-breakable space character
4897 (0xA0 (160 decimal) and U+202F). Left blank when
4898 omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004899
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004900 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00004901 be used when 'encoding' is "utf-8", otherwise only printable
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004902 characters are allowed. All characters must be single width.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004903
4904 Examples: >
4905 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004906 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00004907 :set lcs=extends:>,precedes:<
4908< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaar79278362015-04-21 18:33:48 +02004909 "precedes". "SpecialKey" for "nbsp", "space", "tab" and "trail".
Bram Moolenaar02467872007-05-06 13:22:01 +00004910 |hl-NonText| |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004911
4912 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
4913'loadplugins' 'lpl' boolean (default on)
4914 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004915 When on the plugin scripts are loaded when starting up |load-plugins|.
4916 This option can be reset in your |vimrc| file to disable the loading
4917 of plugins.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02004918 Note that using the "-u NONE", "-u DEFAULTS" and "--noplugin" command
4919 line arguments reset this option. See |-u| and |--noplugin|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004920
Bram Moolenaard94464e2015-11-02 15:28:18 +01004921 *'luadll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01004922'luadll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01004923 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01004924 {only available when compiled with the |+lua/dyn|
4925 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01004926 Specifies the name of the Lua shared library. The default is
4927 DYNAMIC_LUA_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02004928 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01004929 This option cannot be set from a |modeline| or in the |sandbox|, for
4930 security reasons.
4931
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00004932 *'macatsui'* *'nomacatsui'*
4933'macatsui' boolean (default on)
4934 global
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02004935 {not supported}
4936 No longer supported, as the Mac OS X GUI code was removed.
Bram Moolenaar02467872007-05-06 13:22:01 +00004937
Bram Moolenaar071d4272004-06-13 20:20:40 +00004938 *'magic'* *'nomagic'*
4939'magic' boolean (default on)
4940 global
4941 Changes the special characters that can be used in search patterns.
4942 See |pattern|.
Bram Moolenaar64d8e252016-09-06 22:12:34 +02004943 WARNING: Switching this option off most likely breaks plugins! That
4944 is because many patterns assume it's on and will fail when it's off.
4945 Only switch it off when working with old Vi scripts. In any other
4946 situation write patterns that work when 'magic' is on. Include "\M"
4947 when you want to |/\M|.
Bram Moolenaar4072ba52020-12-23 13:56:35 +01004948 In |Vim9| script the value of 'magic' is ignored, patterns behave like
4949 it is always set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004950
4951 *'makeef'* *'mef'*
4952'makeef' 'mef' string (default: "")
4953 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004954 {not available when compiled without the |+quickfix|
4955 feature}
4956 Name of the errorfile for the |:make| command (see |:make_makeprg|)
4957 and the |:grep| command.
4958 When it is empty, an internally generated temp file will be used.
4959 When "##" is included, it is replaced by a number to make the name
4960 unique. This makes sure that the ":make" command doesn't overwrite an
4961 existing file.
4962 NOT used for the ":cf" command. See 'errorfile' for that.
4963 Environment variables are expanded |:set_env|.
4964 See |option-backslash| about including spaces and backslashes.
4965 This option cannot be set from a |modeline| or in the |sandbox|, for
4966 security reasons.
4967
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01004968 *'makeencoding'* *'menc'*
4969'makeencoding' 'menc' string (default "")
4970 global or local to buffer |global-local|
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01004971 Encoding used for reading the output of external commands. When empty,
4972 encoding is not converted.
4973 This is used for `:make`, `:lmake`, `:grep`, `:lgrep`, `:grepadd`,
4974 `:lgrepadd`, `:cfile`, `:cgetfile`, `:caddfile`, `:lfile`, `:lgetfile`,
4975 and `:laddfile`.
4976
4977 This would be mostly useful when you use MS-Windows and set 'encoding'
4978 to "utf-8". If |+iconv| is enabled and GNU libiconv is used, setting
4979 'makeencoding' to "char" has the same effect as setting to the system
4980 locale encoding. Example: >
4981 :set encoding=utf-8
4982 :set makeencoding=char " system locale is used
4983<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004984 *'makeprg'* *'mp'*
4985'makeprg' 'mp' string (default "make", VMS: "MMS")
4986 global or local to buffer |global-local|
Bram Moolenaar02467872007-05-06 13:22:01 +00004987 Program to use for the ":make" command. See |:make_makeprg|.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01004988 This option may contain '%' and '#' characters (see |:_%| and |:_#|),
4989 which are expanded to the current and alternate file name. Use |::S|
Bram Moolenaar26df0922014-02-23 23:39:13 +01004990 to escape file names in case they contain special characters.
Bram Moolenaar02467872007-05-06 13:22:01 +00004991 Environment variables are expanded |:set_env|. See |option-backslash|
4992 about including spaces and backslashes.
4993 Note that a '|' must be escaped twice: once for ":set" and once for
4994 the interpretation of a command. When you use a filter called
4995 "myfilter" do it like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004996 :set makeprg=gmake\ \\\|\ myfilter
4997< The placeholder "$*" can be given (even multiple times) to specify
4998 where the arguments will be included, for example: >
4999 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
5000< This option cannot be set from a |modeline| or in the |sandbox|, for
5001 security reasons.
5002
5003 *'matchpairs'* *'mps'*
5004'matchpairs' 'mps' string (default "(:),{:},[:]")
5005 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005006 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01005007 other.
5008 Only character pairs are allowed that are different, thus you cannot
5009 jump between two double quotes.
5010 The characters must be separated by a colon.
Bram Moolenaar02467872007-05-06 13:22:01 +00005011 The pairs must be separated by a comma. Example for including '<' and
5012 '>' (HTML): >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005013 :set mps+=<:>
5014
5015< A more exotic example, to jump between the '=' and ';' in an
5016 assignment, useful for languages like C and Java: >
5017 :au FileType c,cpp,java set mps+==:;
5018
5019< For a more advanced way of using "%", see the matchit.vim plugin in
Bram Moolenaar01164a62017-11-02 22:58:42 +01005020 the $VIMRUNTIME/pack/dist/opt/matchit directory. |add-local-help|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005021
5022 *'matchtime'* *'mat'*
5023'matchtime' 'mat' number (default 5)
5024 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005025 Tenths of a second to show the matching paren, when 'showmatch' is
5026 set. Note that this is not in milliseconds, like other options that
5027 set a time. This is to be compatible with Nvi.
5028
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005029 *'maxcombine'* *'mco'*
5030'maxcombine' 'mco' number (default 2)
5031 global
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005032 The maximum number of combining characters supported for displaying.
5033 Only used when 'encoding' is "utf-8".
5034 The default is OK for most languages. Hebrew may require 4.
5035 Maximum value is 6.
5036 Even when this option is set to 2 you can still edit text with more
5037 combining characters, you just can't see them. Use |g8| or |ga|.
5038 See |mbyte-combining|.
5039
Bram Moolenaar071d4272004-06-13 20:20:40 +00005040 *'maxfuncdepth'* *'mfd'*
5041'maxfuncdepth' 'mfd' number (default 100)
5042 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02005043 {not available when compiled without the |+eval|
Bram Moolenaar02467872007-05-06 13:22:01 +00005044 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005045 Maximum depth of function calls for user functions. This normally
5046 catches endless recursion. When using a recursive function with
5047 more depth, set 'maxfuncdepth' to a bigger number. But this will use
5048 more memory, there is the danger of failing when memory is exhausted.
Bram Moolenaarbc2eada2017-01-02 21:27:47 +01005049 Increasing this limit above 200 also changes the maximum for Ex
Bram Moolenaar0b0f0992018-05-22 21:41:30 +02005050 command recursion, see |E169|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005051 See also |:function|.
5052
5053 *'maxmapdepth'* *'mmd'* *E223*
5054'maxmapdepth' 'mmd' number (default 1000)
5055 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005056 Maximum number of times a mapping is done without resulting in a
5057 character to be used. This normally catches endless mappings, like
5058 ":map x y" with ":map y x". It still does not catch ":map g wg",
5059 because the 'w' is used before the next mapping is done. See also
5060 |key-mapping|.
5061
5062 *'maxmem'* *'mm'*
5063'maxmem' 'mm' number (default between 256 to 5120 (system
5064 dependent) or half the amount of memory
5065 available)
5066 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005067 Maximum amount of memory (in Kbyte) to use for one buffer. When this
5068 limit is reached allocating extra memory for a buffer will cause
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005069 other memory to be freed.
5070 The maximum usable value is about 2000000. Use this to work without a
5071 limit.
5072 The value is ignored when 'swapfile' is off.
5073 Also see 'maxmemtot'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005074
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005075 *'maxmempattern'* *'mmp'*
5076'maxmempattern' 'mmp' number (default 1000)
5077 global
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005078 Maximum amount of memory (in Kbyte) to use for pattern matching.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005079 The maximum value is about 2000000. Use this to work without a limit.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005080 *E363*
Bram Moolenaar02467872007-05-06 13:22:01 +00005081 When Vim runs into the limit it gives an error message and mostly
5082 behaves like CTRL-C was typed.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005083 Running into the limit often means that the pattern is very
5084 inefficient or too complex. This may already happen with the pattern
5085 "\(.\)*" on a very long line. ".*" works much better.
Bram Moolenaarfd358112018-07-07 23:21:31 +02005086 Might also happen on redraw, when syntax rules try to match a complex
5087 text structure.
5088 Vim may run out of memory before hitting the 'maxmempattern' limit, in
5089 which case you get an "Out of memory" error instead.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005090
Bram Moolenaar071d4272004-06-13 20:20:40 +00005091 *'maxmemtot'* *'mmt'*
5092'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
5093 dependent) or half the amount of memory
5094 available)
5095 global
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005096 Maximum amount of memory in Kbyte to use for all buffers together.
5097 The maximum usable value is about 2000000 (2 Gbyte). Use this to work
Bram Moolenaarfa735342016-01-03 22:14:44 +01005098 without a limit.
5099 On 64 bit machines higher values might work. But hey, do you really
5100 need more than 2 Gbyte for text editing? Keep in mind that text is
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005101 stored in the swap file, one can edit files > 2 Gbyte anyway. We do
Bram Moolenaarfa735342016-01-03 22:14:44 +01005102 need the memory to store undo info.
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005103 Buffers with 'swapfile' off still count to the total amount of memory
5104 used.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005105 Also see 'maxmem'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005106
5107 *'menuitems'* *'mis'*
5108'menuitems' 'mis' number (default 25)
5109 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005110 {not available when compiled without the |+menu|
5111 feature}
5112 Maximum number of items to use in a menu. Used for menus that are
5113 generated from a list of items, e.g., the Buffers menu. Changing this
5114 option has no direct effect, the menu must be refreshed first.
5115
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005116 *'mkspellmem'* *'msm'*
5117'mkspellmem' 'msm' string (default "460000,2000,500")
5118 global
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005119 {not available when compiled without the |+syntax|
5120 feature}
5121 Parameters for |:mkspell|. This tunes when to start compressing the
5122 word tree. Compression can be slow when there are many words, but
5123 it's needed to avoid running out of memory. The amount of memory used
5124 per word depends very much on how similar the words are, that's why
5125 this tuning is complicated.
5126
5127 There are three numbers, separated by commas:
5128 {start},{inc},{added}
5129
5130 For most languages the uncompressed word tree fits in memory. {start}
5131 gives the amount of memory in Kbyte that can be used before any
5132 compression is done. It should be a bit smaller than the amount of
5133 memory that is available to Vim.
5134
5135 When going over the {start} limit the {inc} number specifies the
5136 amount of memory in Kbyte that can be allocated before another
5137 compression is done. A low number means compression is done after
5138 less words are added, which is slow. A high number means more memory
5139 will be allocated.
5140
5141 After doing compression, {added} times 1024 words can be added before
5142 the {inc} limit is ignored and compression is done when any extra
5143 amount of memory is needed. A low number means there is a smaller
5144 chance of hitting the {inc} limit, less memory is used but it's
5145 slower.
5146
5147 The languages for which these numbers are important are Italian and
5148 Hungarian. The default works for when you have about 512 Mbyte. If
5149 you have 1 Gbyte you could use: >
5150 :set mkspellmem=900000,3000,800
5151< If you have less than 512 Mbyte |:mkspell| may fail for some
5152 languages, no matter what you set 'mkspellmem' to.
5153
Bram Moolenaar07607392019-05-26 19:20:43 +02005154 This option cannot be set from a |modeline| or in the |sandbox|.
5155
Bram Moolenaar071d4272004-06-13 20:20:40 +00005156 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
Bram Moolenaar8243a792007-05-01 17:05:03 +00005157'modeline' 'ml' boolean (Vim default: on (off for root),
5158 Vi default: off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005159 local to buffer
Bram Moolenaar110289e2019-05-23 15:38:06 +02005160 If 'modeline' is on 'modelines' gives the number of lines that is
5161 checked for set commands. If 'modeline' is off or 'modelines' is zero
5162 no lines are checked. See |modeline|.
5163
5164 *'modelineexpr'* *'mle'* *'nomodelineexpr'* *'nomle'*
5165'modelineexpr' 'mle' boolean (default: off)
5166 global
5167 When on allow some options that are an expression to be set in the
5168 modeline. Check the option for whether it is affected by
5169 'modelineexpr'. Also see |modeline|.
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02005170 This option cannot be set from a |modeline| or in the |sandbox|, for
5171 security reasons.
Bram Moolenaar110289e2019-05-23 15:38:06 +02005172
Bram Moolenaar071d4272004-06-13 20:20:40 +00005173 *'modelines'* *'mls'*
5174'modelines' 'mls' number (default 5)
5175 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005176 If 'modeline' is on 'modelines' gives the number of lines that is
5177 checked for set commands. If 'modeline' is off or 'modelines' is zero
5178 no lines are checked. See |modeline|.
5179 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
5180 set and to the Vim default value when 'compatible' is reset.
5181
5182 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
Bram Moolenaar110289e2019-05-23 15:38:06 +02005183 *E21*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005184'modifiable' 'ma' boolean (default on)
5185 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005186 When off the buffer contents cannot be changed. The 'fileformat' and
5187 'fileencoding' options also can't be changed.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01005188 Can be reset on startup with the |-M| command line argument.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005189
5190 *'modified'* *'mod'* *'nomodified'* *'nomod'*
5191'modified' 'mod' boolean (default off)
5192 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005193 When on, the buffer is considered to be modified. This option is set
5194 when:
5195 1. A change was made to the text since it was last written. Using the
5196 |undo| command to go back to the original text will reset the
5197 option. But undoing changes that were made before writing the
5198 buffer will set the option again, since the text is different from
5199 when it was written.
5200 2. 'fileformat' or 'fileencoding' is different from its original
5201 value. The original value is set when the buffer is read or
5202 written. A ":set nomodified" command also resets the original
5203 values to the current values and the 'modified' option will be
5204 reset.
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01005205 Similarly for 'eol' and 'bomb'.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02005206 This option is not set when a change is made to the buffer as the
5207 result of a BufNewFile, BufRead/BufReadPost, BufWritePost,
5208 FileAppendPost or VimLeave autocommand event. See |gzip-example| for
5209 an explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005210 When 'buftype' is "nowrite" or "nofile" this option may be set, but
5211 will be ignored.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01005212 Note that the text may actually be the same, e.g. 'modified' is set
5213 when using "rA" on an "A".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005214
5215 *'more'* *'nomore'*
5216'more' boolean (Vim default: on, Vi default: off)
5217 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005218 When on, listings pause when the whole screen is filled. You will get
5219 the |more-prompt|. When this option is off there are no pauses, the
5220 listing continues until finished.
5221 NOTE: This option is set to the Vi default value when 'compatible' is
5222 set and to the Vim default value when 'compatible' is reset.
5223
5224 *'mouse'* *E538*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005225'mouse' string (default "", "a" for GUI and Win32,
Bram Moolenaar5b418992019-10-27 18:50:25 +01005226 set to "a" or "nvi" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005227 global
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005228 Enable the use of the mouse. Works for most terminals (xterm, Win32
5229 |win32-mouse|, QNX pterm, *BSD console with sysmouse and Linux console
5230 with gpm). For using the mouse in the GUI, see |gui-mouse|. The
5231 mouse can be enabled for different modes:
Bram Moolenaar7f2e9d72017-11-11 20:58:53 +01005232 n Normal mode and Terminal modes
Bram Moolenaar071d4272004-06-13 20:20:40 +00005233 v Visual mode
5234 i Insert mode
5235 c Command-line mode
5236 h all previous modes when editing a help file
5237 a all previous modes
5238 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005239 Normally you would enable the mouse in all five modes with: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005240 :set mouse=a
Bram Moolenaar5b418992019-10-27 18:50:25 +01005241< If your terminal can't overrule the mouse events going to the
5242 application, use: >
5243 :set mouse=nvi
Bram Moolenaar65e0d772020-06-14 17:29:55 +02005244< Then you can press ":", select text for the system, and press Esc to go
Bram Moolenaar5b418992019-10-27 18:50:25 +01005245 back to Vim using the mouse events.
5246 In |defaults.vim| "nvi" is used if the 'term' option is not matching
5247 "xterm".
5248
5249 When the mouse is not enabled, the GUI will still use the mouse for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005250 modeless selection. This doesn't move the text cursor.
5251
5252 See |mouse-using|. Also see |'clipboard'|.
5253
5254 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005255 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005256 the mouse buttons can still be used by keeping the shift key pressed.
5257 Also see the 'clipboard' option.
5258
5259 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
5260'mousefocus' 'mousef' boolean (default off)
5261 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005262 {only works in the GUI}
5263 The window that the mouse pointer is on is automatically activated.
5264 When changing the window layout or window focus in another way, the
5265 mouse pointer is moved to the window with keyboard focus. Off is the
5266 default because it makes using the pull down menus a little goofy, as
5267 a pointer transit may activate a window unintentionally.
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01005268 MS-Windows: Also see 'scrollfocus' for what window is scrolled when
Bram Moolenaar1d9215b2020-01-25 13:27:42 +01005269 using the mouse scroll wheel.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005270
5271 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
5272'mousehide' 'mh' boolean (default on)
5273 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005274 {only works in the GUI}
5275 When on, the mouse pointer is hidden when characters are typed.
5276 The mouse pointer is restored when the mouse is moved.
5277
5278 *'mousemodel'* *'mousem'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005279'mousemodel' 'mousem' string (default "extend", "popup" for Win32)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005280 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005281 Sets the model to use for the mouse. The name mostly specifies what
5282 the right mouse button is used for:
5283 extend Right mouse button extends a selection. This works
5284 like in an xterm.
5285 popup Right mouse button pops up a menu. The shifted left
5286 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00005287 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005288 popup_setpos Like "popup", but the cursor will be moved to the
5289 position where the mouse was clicked, and thus the
5290 selected operation will act upon the clicked object.
5291 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00005292 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005293 course, that right clicking outside a selection will
5294 end Visual mode.
5295 Overview of what button does what for each model:
5296 mouse extend popup(_setpos) ~
5297 left click place cursor place cursor
5298 left drag start selection start selection
5299 shift-left search word extend selection
5300 right click extend selection popup menu (place cursor)
5301 right drag extend selection -
5302 middle click paste paste
5303
5304 In the "popup" model the right mouse button produces a pop-up menu.
5305 You need to define this first, see |popup-menu|.
5306
5307 Note that you can further refine the meaning of buttons with mappings.
5308 See |gui-mouse-mapping|. But mappings are NOT used for modeless
5309 selection (because that's handled in the GUI code directly).
5310
5311 The 'mousemodel' option is set by the |:behave| command.
5312
5313 *'mouseshape'* *'mouses'* *E547*
Bram Moolenaarf6b40102019-02-22 15:24:03 +01005314'mouseshape' 'mouses' string (default "i-r:beam,s:updown,sd:udsizing,
5315 vs:leftright,vd:lrsizing,m:no,
5316 ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005317 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005318 {only available when compiled with the |+mouseshape|
5319 feature}
5320 This option tells Vim what the mouse pointer should look like in
5321 different modes. The option is a comma separated list of parts, much
5322 like used for 'guicursor'. Each part consist of a mode/location-list
5323 and an argument-list:
5324 mode-list:shape,mode-list:shape,..
5325 The mode-list is a dash separated list of these modes/locations:
5326 In a normal window: ~
5327 n Normal mode
5328 v Visual mode
5329 ve Visual mode with 'selection' "exclusive" (same as 'v',
5330 if not specified)
5331 o Operator-pending mode
5332 i Insert mode
5333 r Replace mode
5334
5335 Others: ~
5336 c appending to the command-line
5337 ci inserting in the command-line
5338 cr replacing in the command-line
5339 m at the 'Hit ENTER' or 'More' prompts
5340 ml idem, but cursor in the last line
5341 e any mode, pointer below last window
5342 s any mode, pointer on a status line
5343 sd any mode, while dragging a status line
5344 vs any mode, pointer on a vertical separator line
5345 vd any mode, while dragging a vertical separator line
5346 a everywhere
5347
5348 The shape is one of the following:
5349 avail name looks like ~
5350 w x arrow Normal mouse pointer
5351 w x blank no pointer at all (use with care!)
5352 w x beam I-beam
5353 w x updown up-down sizing arrows
5354 w x leftright left-right sizing arrows
5355 w x busy The system's usual busy pointer
5356 w x no The system's usual 'no input' pointer
5357 x udsizing indicates up-down resizing
5358 x lrsizing indicates left-right resizing
5359 x crosshair like a big thin +
5360 x hand1 black hand
5361 x hand2 white hand
5362 x pencil what you write with
5363 x question big ?
5364 x rightup-arrow arrow pointing right-up
5365 w x up-arrow arrow pointing up
5366 x <number> any X11 pointer number (see X11/cursorfont.h)
5367
5368 The "avail" column contains a 'w' if the shape is available for Win32,
5369 x for X11.
5370 Any modes not specified or shapes not available use the normal mouse
5371 pointer.
5372
5373 Example: >
5374 :set mouseshape=s:udsizing,m:no
5375< will make the mouse turn to a sizing arrow over the status lines and
5376 indicate no input when the hit-enter prompt is displayed (since
5377 clicking the mouse has no effect in this state.)
5378
5379 *'mousetime'* *'mouset'*
5380'mousetime' 'mouset' number (default 500)
5381 global
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005382 Only for GUI, Win32 and Unix with xterm. Defines the maximum
Bram Moolenaar071d4272004-06-13 20:20:40 +00005383 time in msec between two mouse clicks for the second click to be
5384 recognized as a multi click.
5385
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005386 *'mzschemedll'*
5387'mzschemedll' string (default depends on the build)
5388 global
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005389 {only available when compiled with the |+mzscheme/dyn|
5390 feature}
5391 Specifies the name of the MzScheme shared library. The default is
5392 DYNAMIC_MZSCH_DLL which was specified at compile time.
5393 Environment variables are expanded |:set_env|.
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01005394 The value must be set in the |vimrc| script or earlier. In the
Bram Moolenaar01164a62017-11-02 22:58:42 +01005395 startup, before the |load-plugins| step.
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005396 This option cannot be set from a |modeline| or in the |sandbox|, for
5397 security reasons.
5398
5399 *'mzschemegcdll'*
5400'mzschemegcdll' string (default depends on the build)
5401 global
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005402 {only available when compiled with the |+mzscheme/dyn|
5403 feature}
5404 Specifies the name of the MzScheme GC shared library. The default is
5405 DYNAMIC_MZGC_DLL which was specified at compile time.
5406 The value can be equal to 'mzschemedll' if it includes the GC code.
5407 Environment variables are expanded |:set_env|.
5408 This option cannot be set from a |modeline| or in the |sandbox|, for
5409 security reasons.
5410
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005411 *'mzquantum'* *'mzq'*
5412'mzquantum' 'mzq' number (default 100)
5413 global
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005414 {not available when compiled without the |+mzscheme|
5415 feature}
5416 The number of milliseconds between polls for MzScheme threads.
5417 Negative or zero value means no thread scheduling.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005418 NOTE: This option is set to the Vim default value when 'compatible'
5419 is reset.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005420
Bram Moolenaar071d4272004-06-13 20:20:40 +00005421 *'nrformats'* *'nf'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02005422'nrformats' 'nf' string (default "bin,octal,hex",
5423 set to "bin,hex" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005424 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005425 This defines what bases Vim will consider for numbers when using the
5426 CTRL-A and CTRL-X commands for adding to and subtracting from a number
5427 respectively; see |CTRL-A| for more info on these commands.
Bram Moolenaar4770d092006-01-12 23:22:24 +00005428 alpha If included, single alphabetical characters will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005429 incremented or decremented. This is useful for a list with a
Bram Moolenaar3848e002016-03-19 18:42:29 +01005430 letter index a), b), etc. *octal-nrformats*
Bram Moolenaar4770d092006-01-12 23:22:24 +00005431 octal If included, numbers that start with a zero will be considered
Bram Moolenaar071d4272004-06-13 20:20:40 +00005432 to be octal. Example: Using CTRL-A on "007" results in "010".
Bram Moolenaar4770d092006-01-12 23:22:24 +00005433 hex If included, numbers starting with "0x" or "0X" will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005434 considered to be hexadecimal. Example: Using CTRL-X on
5435 "0x100" results in "0x0ff".
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005436 bin If included, numbers starting with "0b" or "0B" will be
5437 considered to be binary. Example: Using CTRL-X on
5438 "0b1000" subtracts one, resulting in "0b0111".
Bram Moolenaaraaad9952020-05-31 15:08:59 +02005439 unsigned If included, numbers are recognized as unsigned. Thus a
5440 leading dash or negative sign won't be considered as part of
5441 the number. Examples:
5442 Using CTRL-X on "2020" in "9-2020" results in "9-2019"
5443 (without "unsigned" it would become "9-2021").
5444 Using CTRL-A on "2020" in "9-2020" results in "9-2021"
5445 (without "unsigned" it would become "9-2019").
Bram Moolenaaracc22402020-06-07 21:07:18 +02005446 Using CTRL-X on "0" or CTRL-A on "18446744073709551615"
5447 (2^64 - 1) has no effect, overflow is prevented.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005448 Numbers which simply begin with a digit in the range 1-9 are always
5449 considered decimal. This also happens for numbers that are not
5450 recognized as octal or hex.
5451
5452 *'number'* *'nu'* *'nonumber'* *'nonu'*
5453'number' 'nu' boolean (default off)
5454 local to window
5455 Print the line number in front of each line. When the 'n' option is
5456 excluded from 'cpoptions' a wrapped line will not use the column of
5457 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005458 The 'numberwidth' option can be used to set the room used for the line
5459 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005460 When a long, wrapped line doesn't start with the first character, '-'
5461 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02005462 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
5463 the number.
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005464 *number_relativenumber*
5465 The 'relativenumber' option changes the displayed number to be
5466 relative to the cursor. Together with 'number' there are these
5467 four combinations (cursor in line 3):
5468
Bram Moolenaar3848e002016-03-19 18:42:29 +01005469 'nonu' 'nu' 'nonu' 'nu'
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005470 'nornu' 'nornu' 'rnu' 'rnu'
5471
5472 |apple | 1 apple | 2 apple | 2 apple
5473 |pear | 2 pear | 1 pear | 1 pear
5474 |nobody | 3 nobody | 0 nobody |3 nobody
5475 |there | 4 there | 1 there | 1 there
Bram Moolenaar071d4272004-06-13 20:20:40 +00005476
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005477 *'numberwidth'* *'nuw'*
5478'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
5479 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005480 {only available when compiled with the |+linebreak|
5481 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005482 Minimal number of columns to use for the line number. Only relevant
Bram Moolenaar64486672010-05-16 15:46:46 +02005483 when the 'number' or 'relativenumber' option is set or printing lines
5484 with a line number. Since one space is always between the number and
5485 the text, there is one less character for the number itself.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005486 The value is the minimum width. A bigger width is used when needed to
Bram Moolenaar64486672010-05-16 15:46:46 +02005487 fit the highest line number in the buffer respectively the number of
5488 rows in the window, depending on whether 'number' or 'relativenumber'
5489 is set. Thus with the Vim default of 4 there is room for a line number
5490 up to 999. When the buffer has 1000 lines five columns will be used.
Bram Moolenaarf8a07122019-07-01 22:06:07 +02005491 The minimum value is 1, the maximum value is 20.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005492 NOTE: This option is set to the Vi default value when 'compatible' is
5493 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005494
Bram Moolenaarf75a9632005-09-13 21:20:47 +00005495 *'omnifunc'* *'ofu'*
5496'omnifunc' 'ofu' string (default: empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00005497 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02005498 {not available when compiled without the |+eval|
Bram Moolenaare2c453d2019-08-21 14:37:09 +02005499 feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00005500 This option specifies a function to be used for Insert mode omni
5501 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
Bram Moolenaar280f1262006-01-30 00:14:18 +00005502 See |complete-functions| for an explanation of how the function is
5503 invoked and what it should return.
Bram Moolenaar043545e2006-10-10 16:44:07 +00005504 This option is usually set by a filetype plugin:
Bram Moolenaar9c102382006-05-03 21:26:49 +00005505 |:filetype-plugin-on|
Bram Moolenaar30b65812012-07-12 22:01:11 +02005506 This option cannot be set from a |modeline| or in the |sandbox|, for
5507 security reasons.
Bram Moolenaare344bea2005-09-01 20:46:49 +00005508
5509
Bram Moolenaar02467872007-05-06 13:22:01 +00005510 *'opendevice'* *'odev'* *'noopendevice'* *'noodev'*
Bram Moolenaar043545e2006-10-10 16:44:07 +00005511'opendevice' 'odev' boolean (default off)
5512 global
Bram Moolenaar6f345a12019-12-17 21:27:18 +01005513 {only for MS-Windows}
Bram Moolenaar043545e2006-10-10 16:44:07 +00005514 Enable reading and writing from devices. This may get Vim stuck on a
5515 device that can be opened but doesn't actually do the I/O. Therefore
5516 it is off by default.
5517 Note that on MS-Windows editing "aux.h", "lpt1.txt" and the like also
5518 result in editing a device.
5519
5520
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005521 *'operatorfunc'* *'opfunc'*
5522'operatorfunc' 'opfunc' string (default: empty)
5523 global
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005524 This option specifies a function to be called by the |g@| operator.
5525 See |:map-operator| for more info and an example.
5526
5527 This option cannot be set from a |modeline| or in the |sandbox|, for
5528 security reasons.
5529
5530
Bram Moolenaar251e1912011-06-19 05:09:16 +02005531 *'osfiletype'* *'oft'*
5532'osfiletype' 'oft' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005533 local to buffer
Bram Moolenaar251e1912011-06-19 05:09:16 +02005534 This option was supported on RISC OS, which has been removed.
5535
Bram Moolenaar071d4272004-06-13 20:20:40 +00005536
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005537 *'packpath'* *'pp'*
5538'packpath' 'pp' string (default: see 'runtimepath')
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005539 Directories used to find packages. See |packages|.
5540
5541
Bram Moolenaar071d4272004-06-13 20:20:40 +00005542 *'paragraphs'* *'para'*
Bram Moolenaar57e48462008-03-12 16:38:55 +00005543'paragraphs' 'para' string (default "IPLPPPQPP TPHPLIPpLpItpplpipbp")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005544 global
5545 Specifies the nroff macros that separate paragraphs. These are pairs
5546 of two letters (see |object-motions|).
5547
5548 *'paste'* *'nopaste'*
5549'paste' boolean (default off)
5550 global
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005551 Put Vim in Paste mode. This is useful if you want to cut or copy
5552 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005553 unexpected effects.
5554 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005555 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00005556 knows about pasting and will mostly do the right thing without 'paste'
5557 being set. The same is true for a terminal where Vim handles the
5558 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00005559 This option is reset when starting the GUI. Thus if you set it in
5560 your .vimrc it will work in a terminal, but not in the GUI. Setting
5561 'paste' in the GUI has side effects: e.g., the Paste toolbar button
5562 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005563 When the 'paste' option is switched on (also when it was already on):
5564 - mapping in Insert mode and Command-line mode is disabled
5565 - abbreviations are disabled
Bram Moolenaar071d4272004-06-13 20:20:40 +00005566 - 'autoindent' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02005567 - 'expandtab' is reset
5568 - 'formatoptions' is used like it is empty
Bram Moolenaar071d4272004-06-13 20:20:40 +00005569 - 'revins' is reset
5570 - 'ruler' is reset
5571 - 'showmatch' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02005572 - 'smartindent' is reset
5573 - 'smarttab' is reset
5574 - 'softtabstop' is set to 0
5575 - 'textwidth' is set to 0
5576 - 'wrapmargin' is set to 0
Bram Moolenaar071d4272004-06-13 20:20:40 +00005577 These options keep their value, but their effect is disabled:
Bram Moolenaar071d4272004-06-13 20:20:40 +00005578 - 'cindent'
Bram Moolenaarca635012015-09-25 20:34:21 +02005579 - 'indentexpr'
5580 - 'lisp'
Bram Moolenaar071d4272004-06-13 20:20:40 +00005581 NOTE: When you start editing another file while the 'paste' option is
5582 on, settings from the modelines or autocommands may change the
5583 settings again, causing trouble when pasting text. You might want to
5584 set the 'paste' option again.
5585 When the 'paste' option is reset the mentioned options are restored to
5586 the value before the moment 'paste' was switched from off to on.
5587 Resetting 'paste' before ever setting it does not have any effect.
5588 Since mapping doesn't work while 'paste' is active, you need to use
5589 the 'pastetoggle' option to toggle the 'paste' option with some key.
5590
5591 *'pastetoggle'* *'pt'*
5592'pastetoggle' 'pt' string (default "")
5593 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005594 When non-empty, specifies the key sequence that toggles the 'paste'
5595 option. This is like specifying a mapping: >
5596 :map {keys} :set invpaste<CR>
5597< Where {keys} is the value of 'pastetoggle'.
5598 The difference is that it will work even when 'paste' is set.
5599 'pastetoggle' works in Insert mode and Normal mode, but not in
5600 Command-line mode.
5601 Mappings are checked first, thus overrule 'pastetoggle'. However,
5602 when 'paste' is on mappings are ignored in Insert mode, thus you can do
5603 this: >
5604 :map <F10> :set paste<CR>
5605 :map <F11> :set nopaste<CR>
5606 :imap <F10> <C-O>:set paste<CR>
5607 :imap <F11> <nop>
5608 :set pastetoggle=<F11>
5609< This will make <F10> start paste mode and <F11> stop paste mode.
5610 Note that typing <F10> in paste mode inserts "<F10>", since in paste
5611 mode everything is inserted literally, except the 'pastetoggle' key
5612 sequence.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005613 When the value has several bytes 'ttimeoutlen' applies.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005614
5615 *'pex'* *'patchexpr'*
5616'patchexpr' 'pex' string (default "")
5617 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005618 {not available when compiled without the |+diff|
5619 feature}
5620 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005621 the resulting new version of the file. See |diff-patchexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005622
Bram Moolenaardbc28022014-07-26 13:40:44 +02005623 *'patchmode'* *'pm'* *E205* *E206*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005624'patchmode' 'pm' string (default "")
5625 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005626 When non-empty the oldest version of a file is kept. This can be used
5627 to keep the original version of a file if you are changing files in a
5628 source distribution. Only the first time that a file is written a
5629 copy of the original file will be kept. The name of the copy is the
5630 name of the original file with the string in the 'patchmode' option
5631 appended. This option should start with a dot. Use a string like
Bram Moolenaardf980db2017-12-24 13:22:00 +01005632 ".orig" or ".org". 'backupdir' must not be empty for this to work
5633 (Detail: The backup file is renamed to the patchmode file after the
5634 new file has been successfully written, that's why it must be possible
5635 to write a backup file). If there was no file to be backed up, an
5636 empty file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005637 When the 'backupskip' pattern matches, a patchmode file is not made.
5638 Using 'patchmode' for compressed files appends the extension at the
5639 end (e.g., "file.gz.orig"), thus the resulting name isn't always
5640 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005641 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005642
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01005643 *'path'* *'pa'* *E343* *E345* *E347* *E854*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005644'path' 'pa' string (default on Unix: ".,/usr/include,,"
Bram Moolenaar071d4272004-06-13 20:20:40 +00005645 other systems: ".,,")
5646 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005647 This is a list of directories which will be searched when using the
Bram Moolenaarc236c162008-07-13 17:41:49 +00005648 |gf|, [f, ]f, ^Wf, |:find|, |:sfind|, |:tabfind| and other commands,
5649 provided that the file being searched for has a relative path (not
5650 starting with "/", "./" or "../"). The directories in the 'path'
5651 option may be relative or absolute.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005652 - Use commas to separate directory names: >
5653 :set path=.,/usr/local/include,/usr/include
5654< - Spaces can also be used to separate directory names (for backwards
5655 compatibility with version 3.0). To have a space in a directory
5656 name, precede it with an extra backslash, and escape the space: >
5657 :set path=.,/dir/with\\\ space
5658< - To include a comma in a directory name precede it with an extra
5659 backslash: >
5660 :set path=.,/dir/with\\,comma
5661< - To search relative to the directory of the current file, use: >
5662 :set path=.
5663< - To search in the current directory use an empty string between two
5664 commas: >
5665 :set path=,,
5666< - A directory name may end in a ':' or '/'.
5667 - Environment variables are expanded |:set_env|.
5668 - When using |netrw.vim| URLs can be used. For example, adding
5669 "http://www.vim.org" will make ":find index.html" work.
Bram Moolenaarc236c162008-07-13 17:41:49 +00005670 - Search upwards and downwards in a directory tree using "*", "**" and
5671 ";". See |file-searching| for info and syntax.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005672 {not available when compiled without the |+path_extra| feature}
5673 - Careful with '\' characters, type two to get one in the option: >
5674 :set path=.,c:\\include
5675< Or just use '/' instead: >
5676 :set path=.,c:/include
5677< Don't forget "." or files won't even be found in the same directory as
5678 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005679 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00005680 it is something like 256 or 1024 characters.
5681 You can check if all the include files are found, using the value of
5682 'path', see |:checkpath|.
5683 The use of |:set+=| and |:set-=| is preferred when adding or removing
5684 directories from the list. This avoids problems when a future version
5685 uses another default. To remove the current directory use: >
5686 :set path-=
5687< To add the current directory use: >
5688 :set path+=
5689< To use an environment variable, you probably need to replace the
5690 separator. Here is an example to append $INCL, in which directory
5691 names are separated with a semi-colon: >
5692 :let &path = &path . "," . substitute($INCL, ';', ',', 'g')
5693< Replace the ';' with a ':' or whatever separator is used. Note that
5694 this doesn't work when $INCL contains a comma or white space.
5695
Bram Moolenaar37c64c72017-09-19 22:06:03 +02005696 *'perldll'*
5697'perldll' string (default depends on the build)
5698 global
Bram Moolenaar37c64c72017-09-19 22:06:03 +02005699 {only available when compiled with the |+perl/dyn|
5700 feature}
5701 Specifies the name of the Perl shared library. The default is
5702 DYNAMIC_PERL_DLL, which was specified at compile time.
5703 Environment variables are expanded |:set_env|.
5704 This option cannot be set from a |modeline| or in the |sandbox|, for
5705 security reasons.
5706
Bram Moolenaar071d4272004-06-13 20:20:40 +00005707 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
5708'preserveindent' 'pi' boolean (default off)
5709 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005710 When changing the indent of the current line, preserve as much of the
5711 indent structure as possible. Normally the indent is replaced by a
5712 series of tabs followed by spaces as required (unless |'expandtab'| is
5713 enabled, in which case only spaces are used). Enabling this option
5714 means the indent will preserve as many existing characters as possible
5715 for indenting, and only add additional tabs or spaces as required.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005716 'expandtab' does not apply to the preserved white space, a Tab remains
5717 a Tab.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005718 NOTE: When using ">>" multiple times the resulting indent is a mix of
5719 tabs and spaces. You might not like this.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005720 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005721 Also see 'copyindent'.
5722 Use |:retab| to clean up white space.
5723
5724 *'previewheight'* *'pvh'*
5725'previewheight' 'pvh' number (default 12)
5726 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02005727 {not available when compiled without the |+quickfix|
5728 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005729 Default height for a preview window. Used for |:ptag| and associated
Bram Moolenaar79648732019-07-18 21:43:07 +02005730 commands. Used for |CTRL-W_}| when no count is given. Not used when
5731 'previewpopup' is set.
5732
5733 *'previewpopup'* *'pvp'*
5734'previewpopup' 'pvp' string (default empty)
5735 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02005736 {not available when compiled without the |+textprop|
5737 or |+quickfix| feature}
Bram Moolenaar79648732019-07-18 21:43:07 +02005738 When not empty a popup window is used for commands that would open a
5739 preview window. See |preview-popup|.
Bram Moolenaar576a4a62019-08-18 15:25:17 +02005740 Not used for the insert completion info, add "popup" to
5741 'completeopt' for that.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005742
5743 *'previewwindow'* *'nopreviewwindow'*
5744 *'pvw'* *'nopvw'* *E590*
5745'previewwindow' 'pvw' boolean (default off)
5746 local to window
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02005747 {not available when compiled without the |+quickfix|
5748 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005749 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00005750 set. It's normally not set directly, but by using one of the commands
5751 |:ptag|, |:pedit|, etc.
5752
5753 *'printdevice'* *'pdev'*
5754'printdevice' 'pdev' string (default empty)
5755 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005756 {only available when compiled with the |+printer|
5757 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005758 The name of the printer to be used for |:hardcopy|.
5759 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005760 This option cannot be set from a |modeline| or in the |sandbox|, for
5761 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005762
Bram Moolenaar8299df92004-07-10 09:47:34 +00005763 *'printencoding'* *'penc'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005764'printencoding' 'penc' string (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005765 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005766 {only available when compiled with the |+printer|
5767 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005768 Sets the character encoding used when printing.
5769 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005770
5771 *'printexpr'* *'pexpr'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005772'printexpr' 'pexpr' string (default: see below)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005773 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005774 {only available when compiled with the |+printer|
5775 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005776 Expression used to print the PostScript produced with |:hardcopy|.
5777 See |pexpr-option|.
Bram Moolenaar51628222016-12-01 23:03:28 +01005778 This option cannot be set from a |modeline| or in the |sandbox|, for
5779 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005780
Bram Moolenaar8299df92004-07-10 09:47:34 +00005781 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005782'printfont' 'pfn' string (default "courier")
5783 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005784 {only available when compiled with the |+printer|
5785 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005786 The name of the font that will be used for |:hardcopy|.
5787 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005788
5789 *'printheader'* *'pheader'*
5790'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
5791 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005792 {only available when compiled with the |+printer|
5793 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005794 The format of the header produced in |:hardcopy| output.
5795 See |pheader-option|.
5796
5797 *'printmbcharset'* *'pmbcs'*
5798'printmbcharset' 'pmbcs' string (default "")
5799 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01005800 {only available when compiled with the |+printer|
5801 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005802 The CJK character set to be used for CJK output from |:hardcopy|.
5803 See |pmbcs-option|.
5804
5805 *'printmbfont'* *'pmbfn'*
5806'printmbfont' 'pmbfn' string (default "")
5807 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01005808 {only available when compiled with the |+printer|
5809 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005810 List of font names to be used for CJK output from |:hardcopy|.
5811 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005812
5813 *'printoptions'* *'popt'*
5814'printoptions' 'popt' string (default "")
5815 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005816 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005817 List of items that control the format of the output of |:hardcopy|.
5818 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005819
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005820 *'prompt'* *'noprompt'*
5821'prompt' boolean (default on)
5822 global
5823 When on a ":" prompt is used in Ex mode.
5824
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005825 *'pumheight'* *'ph'*
5826'pumheight' 'ph' number (default 0)
5827 global
Bram Moolenaar06a89a52006-04-29 22:01:03 +00005828 Determines the maximum number of items to show in the popup menu for
5829 Insert mode completion. When zero as much space as available is used.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005830 |ins-completion-menu|.
5831
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01005832 *'pumwidth'* *'pw'*
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005833'pumwidth' 'pw' number (default 15)
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01005834 global
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01005835 Determines the minimum width to use for the popup menu for Insert mode
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005836 completion. |ins-completion-menu|.
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01005837
Bram Moolenaard94464e2015-11-02 15:28:18 +01005838 *'pythondll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01005839'pythondll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01005840 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01005841 {only available when compiled with the |+python/dyn|
5842 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005843 Specifies the name of the Python 2.x shared library. The default is
5844 DYNAMIC_PYTHON_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005845 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01005846 This option cannot be set from a |modeline| or in the |sandbox|, for
5847 security reasons.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005848
Bram Moolenaar94073162018-01-31 21:49:05 +01005849 *'pythonhome'*
5850'pythonhome' string (default "")
5851 global
Bram Moolenaar94073162018-01-31 21:49:05 +01005852 {only available when compiled with the |+python/dyn|
5853 feature}
5854 Specifies the name of the Python 2.x home directory. When 'pythonhome'
5855 and the PYTHONHOME environment variable are not set, PYTHON_HOME,
5856 which was specified at compile time, will be used for the Python 2.x
5857 home directory.
5858 Environment variables are expanded |:set_env|.
5859 This option cannot be set from a |modeline| or in the |sandbox|, for
5860 security reasons.
5861
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005862 *'pythonthreedll'*
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005863'pythonthreedll' string (default depends on the build)
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005864 global
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005865 {only available when compiled with the |+python3/dyn|
5866 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005867 Specifies the name of the Python 3 shared library. The default is
5868 DYNAMIC_PYTHON3_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005869 Environment variables are expanded |:set_env|.
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005870 This option cannot be set from a |modeline| or in the |sandbox|, for
5871 security reasons.
5872
Bram Moolenaar94073162018-01-31 21:49:05 +01005873 *'pythonthreehome'*
5874'pythonthreehome' string (default "")
5875 global
Bram Moolenaar94073162018-01-31 21:49:05 +01005876 {only available when compiled with the |+python3/dyn|
5877 feature}
5878 Specifies the name of the Python 3 home directory. When
5879 'pythonthreehome' and the PYTHONHOME environment variable are not set,
5880 PYTHON3_HOME, which was specified at compile time, will be used for
5881 the Python 3 home directory.
5882 Environment variables are expanded |:set_env|.
5883 This option cannot be set from a |modeline| or in the |sandbox|, for
5884 security reasons.
5885
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01005886 *'pyxversion'* *'pyx'*
5887'pyxversion' 'pyx' number (default depends on the build)
5888 global
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01005889 {only available when compiled with the |+python| or
5890 the |+python3| feature}
5891 Specifies the python version used for pyx* functions and commands
5892 |python_x|. The default value is as follows:
5893
5894 Compiled with Default ~
5895 |+python| and |+python3| 0
5896 only |+python| 2
5897 only |+python3| 3
5898
5899 Available values are 0, 2 and 3.
5900 If 'pyxversion' is 0, it is set to 2 or 3 after the first execution of
5901 any python2/3 commands or functions. E.g. `:py` sets to 2, and `:py3`
5902 sets to 3. `:pyx` sets it to 3 if Python 3 is available, otherwise sets
5903 to 2 if Python 2 is available.
5904 See also: |has-pythonx|
5905
5906 If Vim is compiled with only |+python| or |+python3| setting
5907 'pyxversion' has no effect. The pyx* functions and commands are
5908 always the same as the compiled version.
5909
5910 This option cannot be set from a |modeline| or in the |sandbox|, for
5911 security reasons.
5912
Bram Moolenaar858ba062020-05-31 23:11:59 +02005913 *'quickfixtextfunc'* *'qftf'*
5914'quickfixtextfunc' 'qftf' string (default "")
5915 global
5916 {only available when compiled with the |+quickfix|
5917 feature}
5918 This option specifies a function to be used to get the text to display
5919 in the quickfix and location list windows. This can be used to
5920 customize the information displayed in the quickfix or location window
5921 for each entry in the corresponding quickfix or location list. See
5922 |quickfix-window-function| for an explanation of how to write the
Bram Moolenaard43906d2020-07-20 21:31:32 +02005923 function and an example. The value can be the name of a function or a
5924 lambda.
Bram Moolenaar858ba062020-05-31 23:11:59 +02005925
5926 This option cannot be set from a |modeline| or in the |sandbox|, for
5927 security reasons.
5928
Bram Moolenaar677ee682005-01-27 14:41:15 +00005929 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005930'quoteescape' 'qe' string (default "\")
5931 local to buffer
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005932 The characters that are used to escape quotes in a string. Used for
5933 objects like a', a" and a` |a'|.
5934 When one of the characters in this option is found inside a string,
5935 the following character will be skipped. The default value makes the
5936 text "foo\"bar\\" considered to be one string.
5937
Bram Moolenaar071d4272004-06-13 20:20:40 +00005938 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
5939'readonly' 'ro' boolean (default off)
5940 local to buffer
5941 If on, writes fail unless you use a '!'. Protects you from
5942 accidentally overwriting a file. Default on when Vim is started
5943 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005944 When using ":w!" the 'readonly' option is reset for the current
5945 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar6c60f472019-04-28 16:00:35 +02005946 When using the ":view" command the 'readonly' option is set for the
5947 newly edited buffer.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01005948 See 'modifiable' for disallowing changes to the buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005949
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005950 *'redrawtime'* *'rdt'*
5951'redrawtime' 'rdt' number (default 2000)
5952 global
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005953 {only available when compiled with the |+reltime|
5954 feature}
5955 The time in milliseconds for redrawing the display. This applies to
Bram Moolenaar15142e22018-04-30 22:19:58 +02005956 searching for patterns for 'hlsearch', |:match| highlighting and syntax
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02005957 highlighting.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005958 When redrawing takes more than this many milliseconds no further
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02005959 matches will be highlighted.
5960 For syntax highlighting the time applies per window. When over the
5961 limit syntax highlighting is disabled until |CTRL-L| is used.
5962 This is used to avoid that Vim hangs when using a very complicated
5963 pattern.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005964
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02005965 *'regexpengine'* *'re'*
Bram Moolenaare6ae6222013-05-21 21:01:10 +02005966'regexpengine' 're' number (default 0)
5967 global
Bram Moolenaare6ae6222013-05-21 21:01:10 +02005968 This selects the default regexp engine. |two-engines|
5969 The possible values are:
5970 0 automatic selection
5971 1 old engine
5972 2 NFA engine
5973 Note that when using the NFA engine and the pattern contains something
5974 that is not supported the pattern will not match. This is only useful
5975 for debugging the regexp engine.
Bram Moolenaarfda37292014-11-05 14:27:36 +01005976 Using automatic selection enables Vim to switch the engine, if the
5977 default engine becomes too costly. E.g., when the NFA engine uses too
5978 many states. This should prevent Vim from hanging on a combination of
5979 a complex pattern with long text.
Bram Moolenaare6ae6222013-05-21 21:01:10 +02005980
Bram Moolenaar64486672010-05-16 15:46:46 +02005981 *'relativenumber'* *'rnu'* *'norelativenumber'* *'nornu'*
5982'relativenumber' 'rnu' boolean (default off)
5983 local to window
Bram Moolenaar64486672010-05-16 15:46:46 +02005984 Show the line number relative to the line with the cursor in front of
Bram Moolenaar06b5d512010-05-22 15:37:44 +02005985 each line. Relative line numbers help you use the |count| you can
Bram Moolenaar64486672010-05-16 15:46:46 +02005986 precede some vertical motion commands (e.g. j k + -) with, without
5987 having to calculate it yourself. Especially useful in combination with
5988 other commands (e.g. y d c < > gq gw =).
5989 When the 'n' option is excluded from 'cpoptions' a wrapped
5990 line will not use the column of line numbers (this is the default when
5991 'compatible' isn't set).
5992 The 'numberwidth' option can be used to set the room used for the line
5993 number.
5994 When a long, wrapped line doesn't start with the first character, '-'
5995 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02005996 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
5997 the number.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01005998
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005999 The number in front of the cursor line also depends on the value of
6000 'number', see |number_relativenumber| for all combinations of the two
6001 options.
Bram Moolenaar64486672010-05-16 15:46:46 +02006002
Bram Moolenaar071d4272004-06-13 20:20:40 +00006003 *'remap'* *'noremap'*
6004'remap' boolean (default on)
6005 global
6006 Allows for mappings to work recursively. If you do not want this for
6007 a single entry, use the :noremap[!] command.
Bram Moolenaara3227e22006-03-08 21:32:40 +00006008 NOTE: To avoid portability problems with Vim scripts, always keep
6009 this option at the default "on". Only switch it off when working with
6010 old Vi scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006011
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006012 *'renderoptions'* *'rop'*
6013'renderoptions' 'rop' string (default: empty)
6014 global
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006015 {only available when compiled with GUI and DIRECTX on
6016 MS-Windows}
6017 Select a text renderer and set its options. The options depend on the
6018 renderer.
6019
6020 Syntax: >
6021 set rop=type:{renderer}(,{name}:{value})*
6022<
6023 Currently, only one optional renderer is available.
6024
6025 render behavior ~
6026 directx Vim will draw text using DirectX (DirectWrite). It makes
6027 drawn glyphs more beautiful than default GDI.
6028 It requires 'encoding' is "utf-8", and only works on
6029 MS-Windows Vista or newer version.
6030
6031 Options:
6032 name meaning type value ~
6033 gamma gamma float 1.0 - 2.2 (maybe)
6034 contrast enhancedContrast float (unknown)
6035 level clearTypeLevel float (unknown)
6036 geom pixelGeometry int 0 - 2 (see below)
6037 renmode renderingMode int 0 - 6 (see below)
6038 taamode textAntialiasMode int 0 - 3 (see below)
Bram Moolenaara338adc2018-01-31 20:51:47 +01006039 scrlines Scroll Lines int (deprecated)
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006040
Bram Moolenaar92467d32017-12-05 13:22:16 +01006041 See this URL for detail (except for scrlines):
6042 https://msdn.microsoft.com/en-us/library/dd368190.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006043
6044 For geom: structure of a device pixel.
6045 0 - DWRITE_PIXEL_GEOMETRY_FLAT
6046 1 - DWRITE_PIXEL_GEOMETRY_RGB
6047 2 - DWRITE_PIXEL_GEOMETRY_BGR
6048
6049 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006050 https://msdn.microsoft.com/en-us/library/dd368114.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006051
6052 For renmode: method of rendering glyphs.
6053 0 - DWRITE_RENDERING_MODE_DEFAULT
6054 1 - DWRITE_RENDERING_MODE_ALIASED
6055 2 - DWRITE_RENDERING_MODE_GDI_CLASSIC
6056 3 - DWRITE_RENDERING_MODE_GDI_NATURAL
6057 4 - DWRITE_RENDERING_MODE_NATURAL
6058 5 - DWRITE_RENDERING_MODE_NATURAL_SYMMETRIC
6059 6 - DWRITE_RENDERING_MODE_OUTLINE
6060
6061 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006062 https://msdn.microsoft.com/en-us/library/dd368118.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006063
6064 For taamode: antialiasing mode used for drawing text.
6065 0 - D2D1_TEXT_ANTIALIAS_MODE_DEFAULT
6066 1 - D2D1_TEXT_ANTIALIAS_MODE_CLEARTYPE
6067 2 - D2D1_TEXT_ANTIALIAS_MODE_GRAYSCALE
6068 3 - D2D1_TEXT_ANTIALIAS_MODE_ALIASED
6069
6070 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006071 https://msdn.microsoft.com/en-us/library/dd368170.aspx
6072
Bram Moolenaara338adc2018-01-31 20:51:47 +01006073 For scrlines:
6074 This was used for optimizing scrolling behavior, however this
6075 is now deprecated. If specified, it is simply ignored.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006076
6077 Example: >
6078 set encoding=utf-8
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006079 set gfn=Ricty_Diminished:h12
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006080 set rop=type:directx
6081<
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006082 If select a raster font (Courier, Terminal or FixedSys which
6083 have ".fon" extension in file name) to 'guifont', it will be
Bram Moolenaar92467d32017-12-05 13:22:16 +01006084 drawn by GDI as a fallback.
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006085
6086 NOTE: It is known that some fonts and options combination
6087 causes trouble on drawing glyphs.
6088
Bram Moolenaar92467d32017-12-05 13:22:16 +01006089 - 'renmode:5' and 'renmode:6' will not work with some
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006090 special made fonts (True-Type fonts which includes only
6091 bitmap glyphs).
6092 - 'taamode:3' will not work with some vector fonts.
6093
6094 NOTE: With this option, you can display colored emoji
6095 (emoticon) in Windows 8.1 or later. To display colored emoji,
6096 there are some conditions which you should notice.
6097
6098 - If your font includes non-colored emoji already, it will
6099 be used.
6100 - If your font doesn't have emoji, the system chooses an
6101 alternative symbol font. On Windows 10, "Segoe UI Emoji"
6102 will be used.
6103 - When this alternative font didn't have fixed width glyph,
6104 emoji might be rendered beyond the bounding box of drawing
6105 cell.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006106
6107 Other render types are currently not supported.
6108
Bram Moolenaar071d4272004-06-13 20:20:40 +00006109 *'report'*
6110'report' number (default 2)
6111 global
6112 Threshold for reporting number of lines changed. When the number of
6113 changed lines is more than 'report' a message will be given for most
6114 ":" commands. If you want it always, set 'report' to 0.
6115 For the ":substitute" command the number of substitutions is used
6116 instead of the number of lines.
6117
6118 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
6119'restorescreen' 'rs' boolean (default on)
6120 global
Bram Moolenaar8024f932020-01-14 19:29:13 +01006121 {only in MS-Windows console version}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006122 When set, the screen contents is restored when exiting Vim. This also
6123 happens when executing external commands.
6124
6125 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
6126 options in your .vimrc. To disable restoring:
6127 set t_ti= t_te=
6128 To enable restoring (for an xterm):
6129 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
6130 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
6131
6132 *'revins'* *'ri'* *'norevins'* *'nori'*
6133'revins' 'ri' boolean (default off)
6134 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006135 {only available when compiled with the |+rightleft|
6136 feature}
6137 Inserting characters in Insert mode will work backwards. See "typing
6138 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
6139 command in Insert mode, when 'allowrevins' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02006140 NOTE: This option is reset when 'compatible' is set.
6141 This option is reset when 'paste' is set and restored when 'paste' is
6142 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006143
6144 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
6145'rightleft' 'rl' boolean (default off)
6146 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006147 {only available when compiled with the |+rightleft|
6148 feature}
6149 When on, display orientation becomes right-to-left, i.e., characters
6150 that are stored in the file appear from the right to the left.
6151 Using this option, it is possible to edit files for languages that
6152 are written from the right to the left such as Hebrew and Arabic.
6153 This option is per window, so it is possible to edit mixed files
6154 simultaneously, or to view the same file in both ways (this is
6155 useful whenever you have a mixed text file with both right-to-left
6156 and left-to-right strings so that both sets are displayed properly
6157 in different windows). Also see |rileft.txt|.
6158
Bram Moolenaar607cc1e2010-07-18 18:47:44 +02006159 *'rightleftcmd'* *'rlc'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006160'rightleftcmd' 'rlc' string (default "search")
6161 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006162 {only available when compiled with the |+rightleft|
6163 feature}
6164 Each word in this option enables the command line editing to work in
6165 right-to-left mode for a group of commands:
6166
6167 search "/" and "?" commands
6168
6169 This is useful for languages such as Hebrew, Arabic and Farsi.
6170 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
6171
Bram Moolenaard94464e2015-11-02 15:28:18 +01006172 *'rubydll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01006173'rubydll' string (default: depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01006174 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01006175 {only available when compiled with the |+ruby/dyn|
6176 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006177 Specifies the name of the Ruby shared library. The default is
6178 DYNAMIC_RUBY_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006179 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01006180 This option cannot be set from a |modeline| or in the |sandbox|, for
6181 security reasons.
6182
Bram Moolenaar071d4272004-06-13 20:20:40 +00006183 *'ruler'* *'ru'* *'noruler'* *'noru'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02006184'ruler' 'ru' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006185 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006186 {not available when compiled without the
6187 |+cmdline_info| feature}
6188 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006189 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00006190 text in the file is shown on the far right:
6191 Top first line is visible
6192 Bot last line is visible
6193 All first and last line are visible
6194 45% relative position in the file
6195 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006196 Each window has its own ruler. If a window has a status line, the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006197 ruler is shown there. Otherwise it is shown in the last line of the
Bram Moolenaar582fd852005-03-28 20:58:01 +00006198 screen. If the statusline is given by 'statusline' (i.e. not empty),
Bram Moolenaar071d4272004-06-13 20:20:40 +00006199 this option takes precedence over 'ruler' and 'rulerformat'
6200 If the number of characters displayed is different from the number of
Bram Moolenaar207f0092020-08-30 17:20:20 +02006201 bytes in the text (e.g., for a TAB or a multibyte character), both
Bram Moolenaar071d4272004-06-13 20:20:40 +00006202 the text column (byte number) and the screen column are shown,
6203 separated with a dash.
6204 For an empty line "0-1" is shown.
6205 For an empty buffer the line number will also be zero: "0,0-1".
Bram Moolenaarca635012015-09-25 20:34:21 +02006206 This option is reset when 'paste' is set and restored when 'paste' is
6207 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006208 If you don't want to see the ruler all the time but want to know where
6209 you are, use "g CTRL-G" |g_CTRL-G|.
6210 NOTE: This option is reset when 'compatible' is set.
6211
6212 *'rulerformat'* *'ruf'*
6213'rulerformat' 'ruf' string (default empty)
6214 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006215 {not available when compiled without the |+statusline|
6216 feature}
6217 When this option is not empty, it determines the content of the ruler
6218 string, as displayed for the 'ruler' option.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00006219 The format of this option is like that of 'statusline'.
Bram Moolenaar110289e2019-05-23 15:38:06 +02006220 This option cannot be set in a modeline when 'modelineexpr' is off.
6221
Bram Moolenaar071d4272004-06-13 20:20:40 +00006222 The default ruler width is 17 characters. To make the ruler 15
6223 characters wide, put "%15(" at the start and "%)" at the end.
6224 Example: >
6225 :set rulerformat=%15(%c%V\ %p%%%)
6226<
6227 *'runtimepath'* *'rtp'* *vimfiles*
6228'runtimepath' 'rtp' string (default:
6229 Unix: "$HOME/.vim,
6230 $VIM/vimfiles,
6231 $VIMRUNTIME,
6232 $VIM/vimfiles/after,
6233 $HOME/.vim/after"
6234 Amiga: "home:vimfiles,
6235 $VIM/vimfiles,
6236 $VIMRUNTIME,
6237 $VIM/vimfiles/after,
6238 home:vimfiles/after"
Bram Moolenaar6f345a12019-12-17 21:27:18 +01006239 PC: "$HOME/vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006240 $VIM/vimfiles,
6241 $VIMRUNTIME,
6242 $VIM/vimfiles/after,
6243 $HOME/vimfiles/after"
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02006244 macOS: "$VIM:vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006245 $VIMRUNTIME,
6246 $VIM:vimfiles:after"
Bram Moolenaarb3f74062020-02-26 16:16:53 +01006247 Haiku: "$BE_USER_SETTINGS/vim,
6248 $VIM/vimfiles,
6249 $VIMRUNTIME,
6250 $VIM/vimfiles/after,
6251 $BE_USER_SETTINGS/vim/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006252 VMS: "sys$login:vimfiles,
6253 $VIM/vimfiles,
6254 $VIMRUNTIME,
6255 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00006256 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006257 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006258 This is a list of directories which will be searched for runtime
6259 files:
6260 filetype.vim filetypes by file name |new-filetype|
6261 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006262 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006263 colors/ color scheme files |:colorscheme|
6264 compiler/ compiler files |:compiler|
6265 doc/ documentation |write-local-help|
6266 ftplugin/ filetype plugins |write-filetype-plugin|
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01006267 import/ files that are found by `:import`
Bram Moolenaar071d4272004-06-13 20:20:40 +00006268 indent/ indent scripts |indent-expression|
6269 keymap/ key mapping files |mbyte-keymap|
6270 lang/ menu translations |:menutrans|
6271 menu.vim GUI menus |menu.vim|
Bram Moolenaar26852122016-05-24 20:02:38 +02006272 pack/ packages |:packadd|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006273 plugin/ plugin scripts |write-plugin|
6274 print/ files for printing |postscript-print-encoding|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006275 spell/ spell checking files |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006276 syntax/ syntax files |mysyntaxfile|
6277 tutor/ files for vimtutor |tutor|
6278
6279 And any other file searched for with the |:runtime| command.
6280
6281 The defaults for most systems are setup to search five locations:
6282 1. In your home directory, for your personal preferences.
6283 2. In a system-wide Vim directory, for preferences from the system
6284 administrator.
6285 3. In $VIMRUNTIME, for files distributed with Vim.
6286 *after-directory*
6287 4. In the "after" directory in the system-wide Vim directory. This is
6288 for the system administrator to overrule or add to the distributed
6289 defaults (rarely needed)
6290 5. In the "after" directory in your home directory. This is for
6291 personal preferences to overrule or add to the distributed defaults
6292 or system-wide settings (rarely needed).
6293
Bram Moolenaard0796902016-09-16 20:02:31 +02006294 More entries are added when using |packages|. If it gets very long
6295 then `:set rtp` will be truncated, use `:echo &rtp` to see the full
6296 string.
Bram Moolenaar26852122016-05-24 20:02:38 +02006297
Bram Moolenaar071d4272004-06-13 20:20:40 +00006298 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
6299 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006300 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00006301 wildcards.
6302 See |:runtime|.
6303 Example: >
6304 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
6305< This will use the directory "~/vimruntime" first (containing your
6306 personal Vim runtime files), then "/mygroup/vim" (shared between a
6307 group of people) and finally "$VIMRUNTIME" (the distributed runtime
6308 files).
6309 You probably should always include $VIMRUNTIME somewhere, to use the
6310 distributed runtime files. You can put a directory before $VIMRUNTIME
6311 to find files which replace a distributed runtime files. You can put
6312 a directory after $VIMRUNTIME to find files which add to distributed
6313 runtime files.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006314 When Vim is started with |--clean| the home directory entries are not
6315 included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006316 This option cannot be set from a |modeline| or in the |sandbox|, for
6317 security reasons.
6318
6319 *'scroll'* *'scr'*
6320'scroll' 'scr' number (default: half the window height)
6321 local to window
6322 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
6323 set to half the number of lines in the window when the window size
Bram Moolenaar74667062020-12-28 15:41:41 +01006324 changes. This may happen when enabling the |status-line| or
6325 'tabline' option after setting the 'scroll' option.
6326 If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006327 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar25c9c682019-05-05 18:13:34 +02006328 height with ":set scroll=0".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006329
6330 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
6331'scrollbind' 'scb' boolean (default off)
6332 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006333 See also |scroll-binding|. When this option is set, the current
6334 window scrolls as other scrollbind windows (windows that also have
6335 this option set) scroll. This option is useful for viewing the
6336 differences between two versions of a file, see 'diff'.
6337 See |'scrollopt'| for options that determine how this option should be
6338 interpreted.
6339 This option is mostly reset when splitting a window to edit another
6340 file. This means that ":split | edit file" results in two windows
6341 with scroll-binding, but ":split file" does not.
6342
Bram Moolenaarae20f342019-11-05 21:09:23 +01006343 *'scrollfocus'* *'scf'* *'noscrollfocus'* *'noscf'*
6344'scrollfocus' 'scf' boolean (default off)
6345 global
6346 {only for MS-Windows GUI}
6347 When using the scroll wheel and this option is set, the window under
6348 the mouse pointer is scrolled. With this option off the current
6349 window is scrolled.
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01006350 Systems other than MS-Windows always behave like this option is on.
Bram Moolenaarae20f342019-11-05 21:09:23 +01006351
Bram Moolenaar071d4272004-06-13 20:20:40 +00006352 *'scrolljump'* *'sj'*
6353'scrolljump' 'sj' number (default 1)
6354 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006355 Minimal number of lines to scroll when the cursor gets off the
6356 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
6357 CTRL-D). Useful if your terminal scrolls very slowly.
Bram Moolenaar1e015462005-09-25 22:16:38 +00006358 When set to a negative number from -1 to -100 this is used as the
6359 percentage of the window height. Thus -50 scrolls half the window
6360 height.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006361 NOTE: This option is set to 1 when 'compatible' is set.
6362
6363 *'scrolloff'* *'so'*
Bram Moolenaar50ba5262016-09-22 22:33:02 +02006364'scrolloff' 'so' number (default 0, set to 5 in |defaults.vim|)
Bram Moolenaar375e3392019-01-31 18:26:10 +01006365 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006366 Minimal number of screen lines to keep above and below the cursor.
6367 This will make some context visible around where you are working. If
6368 you set it to a very large value (999) the cursor line will always be
6369 in the middle of the window (except at the start or end of the file or
6370 when long lines wrap).
Bram Moolenaar375e3392019-01-31 18:26:10 +01006371 After using the local value, go back the global value with one of
6372 these two: >
6373 setlocal scrolloff<
6374 setlocal scrolloff=-1
6375< For scrolling horizontally see 'sidescrolloff'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006376 NOTE: This option is set to 0 when 'compatible' is set.
6377
6378 *'scrollopt'* *'sbo'*
6379'scrollopt' 'sbo' string (default "ver,jump")
6380 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006381 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006382 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
6383 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006384 The following words are available:
6385 ver Bind vertical scrolling for 'scrollbind' windows
6386 hor Bind horizontal scrolling for 'scrollbind' windows
6387 jump Applies to the offset between two windows for vertical
6388 scrolling. This offset is the difference in the first
6389 displayed line of the bound windows. When moving
6390 around in a window, another 'scrollbind' window may
6391 reach a position before the start or after the end of
6392 the buffer. The offset is not changed though, when
6393 moving back the 'scrollbind' window will try to scroll
6394 to the desired position when possible.
6395 When now making that window the current one, two
6396 things can be done with the relative offset:
6397 1. When "jump" is not included, the relative offset is
6398 adjusted for the scroll position in the new current
6399 window. When going back to the other window, the
Bram Moolenaar02467872007-05-06 13:22:01 +00006400 new relative offset will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006401 2. When "jump" is included, the other windows are
6402 scrolled to keep the same relative offset. When
6403 going back to the other window, it still uses the
6404 same relative offset.
6405 Also see |scroll-binding|.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006406 When 'diff' mode is active there always is vertical scroll binding,
6407 even when "ver" isn't there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006408
6409 *'sections'* *'sect'*
6410'sections' 'sect' string (default "SHNHH HUnhsh")
6411 global
6412 Specifies the nroff macros that separate sections. These are pairs of
6413 two letters (See |object-motions|). The default makes a section start
6414 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
6415
6416 *'secure'* *'nosecure'* *E523*
6417'secure' boolean (default off)
6418 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006419 When on, ":autocmd", shell and write commands are not allowed in
6420 ".vimrc" and ".exrc" in the current directory and map commands are
6421 displayed. Switch it off only if you know that you will not run into
6422 problems, or when the 'exrc' option is off. On Unix this option is
6423 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006424 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00006425 'secure' at the end of your ~/.vimrc then.
6426 This option cannot be set from a |modeline| or in the |sandbox|, for
6427 security reasons.
6428
6429 *'selection'* *'sel'*
6430'selection' 'sel' string (default "inclusive")
6431 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006432 This option defines the behavior of the selection. It is only used
6433 in Visual and Select mode.
6434 Possible values:
6435 value past line inclusive ~
6436 old no yes
6437 inclusive yes yes
6438 exclusive yes no
6439 "past line" means that the cursor is allowed to be positioned one
6440 character past the line.
6441 "inclusive" means that the last character of the selection is included
6442 in an operation. For example, when "x" is used to delete the
6443 selection.
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02006444 When "old" is used and 'virtualedit' allows the cursor to move past
6445 the end of line the line break still isn't included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006446 Note that when "exclusive" is used and selecting from the end
6447 backwards, you cannot include the last character of a line, when
6448 starting in Normal mode and 'virtualedit' empty.
6449
6450 The 'selection' option is set by the |:behave| command.
6451
6452 *'selectmode'* *'slm'*
6453'selectmode' 'slm' string (default "")
6454 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006455 This is a comma separated list of words, which specifies when to start
6456 Select mode instead of Visual mode, when a selection is started.
6457 Possible values:
6458 mouse when using the mouse
6459 key when using shifted special keys
6460 cmd when using "v", "V" or CTRL-V
6461 See |Select-mode|.
6462 The 'selectmode' option is set by the |:behave| command.
6463
6464 *'sessionoptions'* *'ssop'*
6465'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006466 help,options,tabpages,winsize,terminal")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006467 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02006468 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006469 feature}
6470 Changes the effect of the |:mksession| command. It is a comma
6471 separated list of words. Each word enables saving and restoring
6472 something:
6473 word save and restore ~
6474 blank empty windows
6475 buffers hidden and unloaded buffers, not just those in windows
6476 curdir the current directory
6477 folds manually created folds, opened/closed folds and local
6478 fold options
6479 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00006480 and contain at least one lowercase letter. Only
6481 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006482 help the help window
6483 localoptions options and mappings local to a window or buffer (not
6484 global values for local options)
6485 options all options and mappings (also global values for local
6486 options)
6487 resize size of the Vim window: 'lines' and 'columns'
6488 sesdir the directory in which the session file is located
6489 will become the current directory (useful with
6490 projects accessed over a network from different
6491 systems)
6492 slash backslashes in file names replaced with forward
6493 slashes
Bram Moolenaar18144c82006-04-12 21:52:12 +00006494 tabpages all tab pages; without this only the current tab page
6495 is restored, so that you can make a session for each
6496 tab page separately
Bram Moolenaard473c8c2018-08-11 18:00:22 +02006497 terminal include terminal windows where the command can be
6498 restored
Bram Moolenaar071d4272004-06-13 20:20:40 +00006499 unix with Unix end-of-line format (single <NL>), even when
6500 on Windows or DOS
6501 winpos position of the whole Vim window
6502 winsize window sizes
6503
6504 Don't include both "curdir" and "sesdir".
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006505 When neither "curdir" nor "sesdir" is included, file names are stored
6506 with absolute paths.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006507 "slash" and "unix" are useful on Windows when sharing session files
6508 with Unix. The Unix version of Vim cannot source dos format scripts,
6509 but the Windows version of Vim can source unix format scripts.
6510
6511 *'shell'* *'sh'* *E91*
Bram Moolenaar95a9dd12019-12-19 22:12:03 +01006512'shell' 'sh' string (default $SHELL or "sh", Win32: "cmd.exe")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006513 global
6514 Name of the shell to use for ! and :! commands. When changing the
6515 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
6516 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006517 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006518 See |option-backslash| about including spaces and backslashes.
6519 Environment variables are expanded |:set_env|.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006520
Bram Moolenaar1ff14ba2019-11-02 14:09:23 +01006521 If the name of the shell contains a space, you need to enclose it in
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01006522 quotes and escape the space. Example with quotes: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006523 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
6524< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006525 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006526 "-f" is not inside the quotes, because it is not part of the command
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006527 name. Vim automagically recognizes the backslashes that are path
Bram Moolenaar071d4272004-06-13 20:20:40 +00006528 separators.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006529 Example with escaped space (Vim will do this when initializing the
6530 option from $SHELL): >
6531 :set shell=/bin/with\\\ space/sh
Bram Moolenaard473c8c2018-08-11 18:00:22 +02006532< The resulting value of 'shell' is "/bin/with\ space/sh", two
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006533 backslashes are consumed by `:set`.
6534
Bram Moolenaar071d4272004-06-13 20:20:40 +00006535 Under MS-Windows, when the executable ends in ".com" it must be
6536 included. Thus setting the shell to "command.com" or "4dos.com"
6537 works, but "command" and "4dos" do not work for all commands (e.g.,
6538 filtering).
6539 For unknown reasons, when using "4dos.com" the current directory is
6540 changed to "C:\". To avoid this set 'shell' like this: >
6541 :set shell=command.com\ /c\ 4dos
6542< This option cannot be set from a |modeline| or in the |sandbox|, for
6543 security reasons.
6544
6545 *'shellcmdflag'* *'shcf'*
Bram Moolenaar5dc62522012-02-13 00:05:22 +01006546'shellcmdflag' 'shcf' string (default: "-c";
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006547 Win32, when 'shell' does not contain "sh"
6548 somewhere: "/c")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006549 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006550 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
Bram Moolenaar8024f932020-01-14 19:29:13 +01006551 "bash.exe -c ls" or "cmd.exe /c dir". For MS-Windows, the default is
6552 set according to the value of 'shell', to reduce the need to set this
6553 option by the user.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02006554 On Unix it can have more than one flag. Each white space separated
6555 part is passed as an argument to the shell command.
6556 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006557 Also see |dos-shell| for MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006558 This option cannot be set from a |modeline| or in the |sandbox|, for
6559 security reasons.
6560
6561 *'shellpipe'* *'sp'*
Bram Moolenaar8024f932020-01-14 19:29:13 +01006562'shellpipe' 'sp' string (default ">", ">%s 2>&1", "| tee", "|& tee" or
6563 "2>&1| tee")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006564 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006565 {not available when compiled without the |+quickfix|
6566 feature}
6567 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006568 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00006569 including spaces and backslashes.
6570 The name of the temporary file can be represented by "%s" if necessary
6571 (the file name is appended automatically if no %s appears in the value
6572 of this option).
Bram Moolenaar8024f932020-01-14 19:29:13 +01006573 For the Amiga the default is ">". For MS-Windows the default is
6574 ">%s 2>&1". The output is directly saved in a file and not echoed to
6575 the screen.
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02006576 For Unix the default is "| tee". The stdout of the compiler is saved
Bram Moolenaar071d4272004-06-13 20:20:40 +00006577 in a file and echoed to the screen. If the 'shell' option is "csh" or
6578 "tcsh" after initializations, the default becomes "|& tee". If the
Bram Moolenaar96f45c02019-10-26 19:53:45 +02006579 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh", "zsh-beta",
6580 "bash" or "fish" the default becomes "2>&1| tee". This means that
6581 stderr is also included. Before using the 'shell' option a path is
6582 removed, thus "/bin/sh" uses "sh".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006583 The initialization of this option is done after reading the ".vimrc"
6584 and the other initializations, so that when the 'shell' option is set
6585 there, the 'shellpipe' option changes automatically, unless it was
6586 explicitly set before.
6587 When 'shellpipe' is set to an empty string, no redirection of the
6588 ":make" output will be done. This is useful if you use a 'makeprg'
6589 that writes to 'makeef' by itself. If you want no piping, but do
6590 want to include the 'makeef', set 'shellpipe' to a single space.
6591 Don't forget to precede the space with a backslash: ":set sp=\ ".
6592 In the future pipes may be used for filtering and this option will
6593 become obsolete (at least for Unix).
6594 This option cannot be set from a |modeline| or in the |sandbox|, for
6595 security reasons.
6596
6597 *'shellquote'* *'shq'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006598'shellquote' 'shq' string (default: ""; Win32, when 'shell'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006599 contains "sh" somewhere: "\"")
6600 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006601 Quoting character(s), put around the command passed to the shell, for
6602 the "!" and ":!" commands. The redirection is kept outside of the
6603 quoting. See 'shellxquote' to include the redirection. It's
6604 probably not useful to set both options.
6605 This is an empty string by default. Only known to be useful for
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006606 third-party shells on MS-Windows-like systems, such as the MKS Korn
6607 Shell or bash, where it should be "\"". The default is adjusted
6608 according the value of 'shell', to reduce the need to set this option
6609 by the user. See |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006610 This option cannot be set from a |modeline| or in the |sandbox|, for
6611 security reasons.
6612
6613 *'shellredir'* *'srr'*
6614'shellredir' 'srr' string (default ">", ">&" or ">%s 2>&1")
6615 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006616 String to be used to put the output of a filter command in a temporary
6617 file. See also |:!|. See |option-backslash| about including spaces
6618 and backslashes.
6619 The name of the temporary file can be represented by "%s" if necessary
6620 (the file name is appended automatically if no %s appears in the value
6621 of this option).
Bram Moolenaar96f45c02019-10-26 19:53:45 +02006622 The default is ">". For Unix, if the 'shell' option is "csh" or
6623 "tcsh" during initializations, the default becomes ">&". If the
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01006624 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh", "zsh-beta",
6625 "bash" or "fish", the default becomes ">%s 2>&1". This means that
6626 stderr is also included. For Win32, the Unix checks are done and
6627 additionally "cmd" is checked for, which makes the default ">%s 2>&1".
6628 Also, the same names with ".exe" appended are checked for.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006629 The initialization of this option is done after reading the ".vimrc"
6630 and the other initializations, so that when the 'shell' option is set
6631 there, the 'shellredir' option changes automatically unless it was
6632 explicitly set before.
6633 In the future pipes may be used for filtering and this option will
6634 become obsolete (at least for Unix).
6635 This option cannot be set from a |modeline| or in the |sandbox|, for
6636 security reasons.
6637
6638 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
6639'shellslash' 'ssl' boolean (default off)
6640 global
Bram Moolenaar6f345a12019-12-17 21:27:18 +01006641 {only for MS-Windows}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006642 When set, a forward slash is used when expanding file names. This is
Bram Moolenaar8024f932020-01-14 19:29:13 +01006643 useful when a Unix-like shell is used instead of cmd.exe. Backward
6644 slashes can still be typed, but they are changed to forward slashes by
6645 Vim.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006646 Note that setting or resetting this option has no effect for some
6647 existing file names, thus this option needs to be set before opening
6648 any file for best results. This might change in the future.
6649 'shellslash' only works when a backslash can be used as a path
6650 separator. To test if this is so use: >
6651 if exists('+shellslash')
Bram Moolenaarac3150d2019-07-28 16:36:39 +02006652< Also see 'completeslash'.
6653
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006654 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
6655'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
6656 global
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006657 When on, use temp files for shell commands. When off use a pipe.
6658 When using a pipe is not possible temp files are used anyway.
Bram Moolenaar97293012011-07-18 19:40:27 +02006659 Currently a pipe is only supported on Unix and MS-Windows 2K and
6660 later. You can check it with: >
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006661 :if has("filterpipe")
6662< The advantage of using a pipe is that nobody can read the temp file
6663 and the 'shell' command does not need to support redirection.
6664 The advantage of using a temp file is that the file type and encoding
6665 can be detected.
6666 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
6667 |FilterWritePost| autocommands event are not triggered when
6668 'shelltemp' is off.
Bram Moolenaar269f5952016-07-15 22:54:41 +02006669 The `system()` function does not respect this option and always uses
6670 temp files.
Bram Moolenaar036986f2017-03-16 17:41:02 +01006671 NOTE: This option is set to the Vim default value when 'compatible'
6672 is reset.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006673
Bram Moolenaar071d4272004-06-13 20:20:40 +00006674 *'shelltype'* *'st'*
6675'shelltype' 'st' number (default 0)
6676 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02006677 {only for the Amiga}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006678 On the Amiga this option influences the way how the commands work
6679 which use a shell.
6680 0 and 1: always use the shell
6681 2 and 3: use the shell only to filter lines
6682 4 and 5: use shell only for ':sh' command
6683 When not using the shell, the command is executed directly.
6684
6685 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
6686 1 and 3: use "shell cmd" to start external commands
6687
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006688 *'shellxescape'* *'sxe'*
6689'shellxescape' 'sxe' string (default: "";
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006690 for MS-Windows: "\"&|<>()@^")
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006691 global
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006692 When 'shellxquote' is set to "(" then the characters listed in this
6693 option will be escaped with a '^' character. This makes it possible
6694 to execute most external commands with cmd.exe.
6695
Bram Moolenaar071d4272004-06-13 20:20:40 +00006696 *'shellxquote'* *'sxq'*
6697'shellxquote' 'sxq' string (default: "";
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006698 for Win32, when 'shell' is cmd.exe: "("
6699 for Win32, when 'shell' contains "sh"
6700 somewhere: "\""
Bram Moolenaar071d4272004-06-13 20:20:40 +00006701 for Unix, when using system(): "\"")
6702 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006703 Quoting character(s), put around the command passed to the shell, for
6704 the "!" and ":!" commands. Includes the redirection. See
6705 'shellquote' to exclude the redirection. It's probably not useful
6706 to set both options.
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006707 When the value is '(' then ')' is appended. When the value is '"('
6708 then ')"' is appended.
6709 When the value is '(' then also see 'shellxescape'.
Bram Moolenaara64ba222012-02-12 23:23:31 +01006710 This is an empty string by default on most systems, but is known to be
6711 useful for on Win32 version, either for cmd.exe which automatically
6712 strips off the first and last quote on a command, or 3rd-party shells
6713 such as the MKS Korn Shell or bash, where it should be "\"". The
6714 default is adjusted according the value of 'shell', to reduce the need
6715 to set this option by the user. See |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006716 This option cannot be set from a |modeline| or in the |sandbox|, for
6717 security reasons.
6718
6719 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
6720'shiftround' 'sr' boolean (default off)
6721 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006722 Round indent to multiple of 'shiftwidth'. Applies to > and <
6723 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
6724 a multiple of 'shiftwidth' (this is Vi compatible).
6725 NOTE: This option is reset when 'compatible' is set.
6726
6727 *'shiftwidth'* *'sw'*
6728'shiftwidth' 'sw' number (default 8)
6729 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006730 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00006731 |'cindent'|, |>>|, |<<|, etc.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02006732 When zero the 'ts' value will be used. Use the |shiftwidth()|
6733 function to get the effective shiftwidth value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006734
6735 *'shortmess'* *'shm'*
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02006736'shortmess' 'shm' string (Vim default "filnxtToOS", Vi default: "S",
6737 POSIX default: "AS")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006738 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006739 This option helps to avoid all the |hit-enter| prompts caused by file
6740 messages, for example with CTRL-G, and to avoid some other messages.
6741 It is a list of flags:
6742 flag meaning when present ~
6743 f use "(3 of 5)" instead of "(file 3 of 5)"
6744 i use "[noeol]" instead of "[Incomplete last line]"
Bram Moolenaar3f40ce72020-07-05 14:10:13 +02006745 l use "999L, 888B" instead of "999 lines, 888 bytes"
Bram Moolenaar071d4272004-06-13 20:20:40 +00006746 m use "[+]" instead of "[Modified]"
6747 n use "[New]" instead of "[New File]"
6748 r use "[RO]" instead of "[readonly]"
6749 w use "[w]" instead of "written" for file write message
6750 and "[a]" instead of "appended" for ':w >> file' command
6751 x use "[dos]" instead of "[dos format]", "[unix]" instead of
6752 "[unix format]" and "[mac]" instead of "[mac format]".
6753 a all of the above abbreviations
6754
6755 o overwrite message for writing a file with subsequent message
6756 for reading a file (useful for ":wn" or when 'autowrite' on)
6757 O message for reading a file overwrites any previous message.
6758 Also for quickfix message (e.g., ":cn").
6759 s don't give "search hit BOTTOM, continuing at TOP" or "search
Bram Moolenaara6c27c42019-05-09 19:16:22 +02006760 hit TOP, continuing at BOTTOM" messages; when using the search
6761 count do not show "W" after the count message (see S below)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006762 t truncate file message at the start if it is too long to fit
6763 on the command-line, "<" will appear in the left most column.
6764 Ignored in Ex mode.
6765 T truncate other messages in the middle if they are too long to
Bram Moolenaar582fd852005-03-28 20:58:01 +00006766 fit on the command line. "..." will appear in the middle.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006767 Ignored in Ex mode.
6768 W don't give "written" or "[w]" when writing a file
6769 A don't give the "ATTENTION" message when an existing swap file
6770 is found.
6771 I don't give the intro message when starting Vim |:intro|.
Bram Moolenaarea389e92014-05-28 21:40:52 +02006772 c don't give |ins-completion-menu| messages. For example,
6773 "-- XXX completion (YYY)", "match 1 of 2", "The only match",
6774 "Pattern not found", "Back at original", etc.
Bram Moolenaar426dd022016-03-15 15:09:29 +01006775 q use "recording" instead of "recording @a"
6776 F don't give the file info when editing a file, like `:silent`
Bram Moolenaar110289e2019-05-23 15:38:06 +02006777 was used for the command; note that this also affects messages
6778 from autocommands
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02006779 S do not show search count message when searching, e.g.
6780 "[1/5]"
Bram Moolenaar071d4272004-06-13 20:20:40 +00006781
6782 This gives you the opportunity to avoid that a change between buffers
6783 requires you to hit <Enter>, but still gives as useful a message as
6784 possible for the space available. To get the whole message that you
6785 would have got with 'shm' empty, use ":file!"
6786 Useful values:
6787 shm= No abbreviation of message.
6788 shm=a Abbreviation, but no loss of information.
6789 shm=at Abbreviation, and truncate message when necessary.
6790
6791 NOTE: This option is set to the Vi default value when 'compatible' is
6792 set and to the Vim default value when 'compatible' is reset.
6793
6794 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
6795'shortname' 'sn' boolean (default off)
6796 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00006797 Filenames are assumed to be 8 characters plus one extension of 3
6798 characters. Multiple dots in file names are not allowed. When this
6799 option is on, dots in file names are replaced with underscores when
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006800 adding an extension (".~" or ".swp"). This option is useful
Bram Moolenaar071d4272004-06-13 20:20:40 +00006801 when editing files on an MS-DOS compatible filesystem, e.g., messydos
Bram Moolenaarade0d392020-01-21 22:33:58 +01006802 or crossdos.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006803
6804 *'showbreak'* *'sbr'* *E595*
6805'showbreak' 'sbr' string (default "")
Bram Moolenaaree857022019-11-09 23:26:40 +01006806 global or local to window |global-local|
Bram Moolenaardb84e452010-08-15 13:50:43 +02006807 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006808 feature}
6809 String to put at the start of lines that have been wrapped. Useful
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006810 values are "> " or "+++ ": >
6811 :set showbreak=>\
6812< Note the backslash to escape the trailing space. It's easier like
6813 this: >
Bram Moolenaar1a384422010-07-14 19:53:30 +02006814 :let &showbreak = '+++ '
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006815< Only printable single-cell characters are allowed, excluding <Tab> and
Bram Moolenaar071d4272004-06-13 20:20:40 +00006816 comma (in a future version the comma might be used to separate the
6817 part that is shown at the end and at the start of a line).
6818 The characters are highlighted according to the '@' flag in
6819 'highlight'.
6820 Note that tabs after the showbreak will be displayed differently.
6821 If you want the 'showbreak' to appear in between line numbers, add the
6822 "n" flag to 'cpoptions'.
Bram Moolenaaree857022019-11-09 23:26:40 +01006823 A window-local value overrules a global value. If the global value is
6824 set and you want no value in the current window use NONE: >
6825 :setlocal showbreak=NONE
6826<
Bram Moolenaar071d4272004-06-13 20:20:40 +00006827 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02006828'showcmd' 'sc' boolean (Vim default: on, off for Unix,
6829 Vi default: off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006830 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006831 {not available when compiled without the
6832 |+cmdline_info| feature}
Bram Moolenaar02467872007-05-06 13:22:01 +00006833 Show (partial) command in the last line of the screen. Set this
6834 option off if your terminal is slow.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006835 In Visual mode the size of the selected area is shown:
6836 - When selecting characters within a line, the number of characters.
Bram Moolenaarf91787c2010-07-17 12:47:16 +02006837 If the number of bytes is different it is also displayed: "2-6"
6838 means two characters and six bytes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006839 - When selecting more than one line, the number of lines.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006840 - When selecting a block, the size in screen characters:
6841 {lines}x{columns}.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006842 NOTE: This option is set to the Vi default value when 'compatible' is
6843 set and to the Vim default value when 'compatible' is reset.
6844
6845 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
6846'showfulltag' 'sft' boolean (default off)
6847 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006848 When completing a word in insert mode (see |ins-completion|) from the
6849 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006850 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00006851 matched a C function, you can see a template for what arguments are
6852 required (coding style permitting).
Bram Moolenaar446cb832008-06-24 21:56:24 +00006853 Note that this doesn't work well together with having "longest" in
6854 'completeopt', because the completion from the search pattern may not
6855 match the typed text.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006856
6857 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
6858'showmatch' 'sm' boolean (default off)
6859 global
6860 When a bracket is inserted, briefly jump to the matching one. The
6861 jump is only done if the match can be seen on the screen. The time to
6862 show the match can be set with 'matchtime'.
6863 A Beep is given if there is no match (no matter if the match can be
Bram Moolenaarca635012015-09-25 20:34:21 +02006864 seen or not).
6865 This option is reset when 'paste' is set and restored when 'paste' is
6866 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006867 When the 'm' flag is not included in 'cpoptions', typing a character
6868 will immediately move the cursor back to where it belongs.
6869 See the "sm" field in 'guicursor' for setting the cursor shape and
6870 blinking when showing the match.
6871 The 'matchpairs' option can be used to specify the characters to show
6872 matches for. 'rightleft' and 'revins' are used to look for opposite
6873 matches.
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006874 Also see the matchparen plugin for highlighting the match when moving
6875 around |pi_paren.txt|.
6876 Note: Use of the short form is rated PG.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006877
6878 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
6879'showmode' 'smd' boolean (Vim default: on, Vi default: off)
6880 global
6881 If in Insert, Replace or Visual mode put a message on the last line.
6882 Use the 'M' flag in 'highlight' to set the type of highlighting for
6883 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006884 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00006885 doesn't mean XIM is really active, especially when 'imactivatekey' is
6886 not set.
6887 NOTE: This option is set to the Vi default value when 'compatible' is
6888 set and to the Vim default value when 'compatible' is reset.
6889
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006890 *'showtabline'* *'stal'*
6891'showtabline' 'stal' number (default 1)
6892 global
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006893 The value of this option specifies when the line with tab page labels
6894 will be displayed:
6895 0: never
6896 1: only if there are at least two tab pages
6897 2: always
6898 This is both for the GUI and non-GUI implementation of the tab pages
6899 line.
6900 See |tab-page| for more information about tab pages.
6901
Bram Moolenaar071d4272004-06-13 20:20:40 +00006902 *'sidescroll'* *'ss'*
6903'sidescroll' 'ss' number (default 0)
6904 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006905 The minimal number of columns to scroll horizontally. Used only when
6906 the 'wrap' option is off and the cursor is moved off of the screen.
6907 When it is zero the cursor will be put in the middle of the screen.
6908 When using a slow terminal set it to a large number or 0. When using
6909 a fast terminal use a small number or 1. Not used for "zh" and "zl"
6910 commands.
6911
6912 *'sidescrolloff'* *'siso'*
6913'sidescrolloff' 'siso' number (default 0)
Bram Moolenaar375e3392019-01-31 18:26:10 +01006914 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006915 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00006916 right of the cursor if 'nowrap' is set. Setting this option to a
6917 value greater than 0 while having |'sidescroll'| also at a non-zero
6918 value makes some context visible in the line you are scrolling in
6919 horizontally (except at beginning of the line). Setting this option
6920 to a large value (like 999) has the effect of keeping the cursor
6921 horizontally centered in the window, as long as one does not come too
6922 close to the beginning of the line.
Bram Moolenaar375e3392019-01-31 18:26:10 +01006923 After using the local value, go back the global value with one of
6924 these two: >
6925 setlocal sidescrolloff<
6926 setlocal sidescrolloff=-1
6927< NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006928
6929 Example: Try this together with 'sidescroll' and 'listchars' as
6930 in the following example to never allow the cursor to move
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02006931 onto the "extends" character: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006932
6933 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
6934 :set sidescrolloff=1
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02006935<
6936 *'signcolumn'* *'scl'*
6937'signcolumn' 'scl' string (default "auto")
6938 local to window
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02006939 {not available when compiled without the |+signs|
6940 feature}
Bram Moolenaar09521312016-08-12 22:54:35 +02006941 Whether or not to draw the signcolumn. Valid values are:
6942 "auto" only when there is a sign to display
6943 "no" never
6944 "yes" always
Bram Moolenaar394c5d82019-06-17 21:48:05 +02006945 "number" display signs in the 'number' column. If the number
Bram Moolenaar6c1e1572019-06-22 02:13:00 +02006946 column is not present, then behaves like "auto".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006947
6948
6949 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
6950'smartcase' 'scs' boolean (default off)
6951 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006952 Override the 'ignorecase' option if the search pattern contains upper
6953 case characters. Only used when the search pattern is typed and
6954 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarc8734422012-06-01 22:38:45 +02006955 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00006956 "*" and "#" you can make 'smartcase' used by doing a "/" command,
6957 recalling the search pattern from history and hitting <Enter>.
6958 NOTE: This option is reset when 'compatible' is set.
6959
6960 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
6961'smartindent' 'si' boolean (default off)
6962 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00006963 {not available when compiled without the
6964 |+smartindent| feature}
6965 Do smart autoindenting when starting a new line. Works for C-like
6966 programs, but can also be used for other languages. 'cindent' does
6967 something like this, works better in most cases, but is more strict,
Bram Moolenaar81af9252010-12-10 20:35:50 +01006968 see |C-indenting|. When 'cindent' is on or 'indentexpr' is set,
Bram Moolenaar166af9b2010-11-16 20:34:40 +01006969 setting 'si' has no effect. 'indentexpr' is a more advanced
6970 alternative.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006971 Normally 'autoindent' should also be on when using 'smartindent'.
6972 An indent is automatically inserted:
6973 - After a line ending in '{'.
6974 - After a line starting with a keyword from 'cinwords'.
6975 - Before a line starting with '}' (only with the "O" command).
6976 When typing '}' as the first character in a new line, that line is
6977 given the same indent as the matching '{'.
6978 When typing '#' as the first character in a new line, the indent for
6979 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006980 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00006981 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
6982 When using the ">>" command, lines starting with '#' are not shifted
6983 right.
Bram Moolenaar036986f2017-03-16 17:41:02 +01006984 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02006985 This option is reset when 'paste' is set and restored when 'paste' is
6986 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006987
6988 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
6989'smarttab' 'sta' boolean (default off)
6990 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006991 When on, a <Tab> in front of a line inserts blanks according to
Bram Moolenaar280f1262006-01-30 00:14:18 +00006992 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A
6993 <BS> will delete a 'shiftwidth' worth of space at the start of the
6994 line.
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006995 When off, a <Tab> always inserts blanks according to 'tabstop' or
Bram Moolenaar280f1262006-01-30 00:14:18 +00006996 'softtabstop'. 'shiftwidth' is only used for shifting text left or
6997 right |shift-left-right|.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00006998 What gets inserted (a <Tab> or spaces) depends on the 'expandtab'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006999 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00007000 number of spaces is minimized by using <Tab>s.
Bram Moolenaarca635012015-09-25 20:34:21 +02007001 This option is reset when 'paste' is set and restored when 'paste' is
7002 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007003 NOTE: This option is reset when 'compatible' is set.
7004
7005 *'softtabstop'* *'sts'*
7006'softtabstop' 'sts' number (default 0)
7007 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007008 Number of spaces that a <Tab> counts for while performing editing
7009 operations, like inserting a <Tab> or using <BS>. It "feels" like
7010 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
7011 used. This is useful to keep the 'ts' setting at its standard value
7012 of 8, while being able to edit like it is set to 'sts'. However,
7013 commands like "x" still work on the actual characters.
7014 When 'sts' is zero, this feature is off.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02007015 When 'sts' is negative, the value of 'shiftwidth' is used.
Bram Moolenaarca635012015-09-25 20:34:21 +02007016 'softtabstop' is set to 0 when the 'paste' option is set and restored
7017 when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007018 See also |ins-expandtab|. When 'expandtab' is not set, the number of
7019 spaces is minimized by using <Tab>s.
7020 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
7021 set.
7022 NOTE: This option is set to 0 when 'compatible' is set.
7023
Bram Moolenaar04958cb2018-06-23 19:23:02 +02007024 If Vim is compiled with the |+vartabs| feature then the value of
7025 'softtabstop' will be ignored if |'varsofttabstop'| is set to
7026 anything other than an empty string.
7027
Bram Moolenaar217ad922005-03-20 22:37:15 +00007028 *'spell'* *'nospell'*
7029'spell' boolean (default off)
7030 local to window
Bram Moolenaar217ad922005-03-20 22:37:15 +00007031 {not available when compiled without the |+syntax|
7032 feature}
7033 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007034 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007035
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007036 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00007037'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007038 local to buffer
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007039 {not available when compiled without the |+syntax|
7040 feature}
7041 Pattern to locate the end of a sentence. The following word will be
7042 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007043 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007044 When this check is not wanted make this option empty.
7045 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00007046 Be careful with special characters, see |option-backslash| about
7047 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007048 To set this option automatically depending on the language, see
7049 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007050
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007051 *'spellfile'* *'spf'*
7052'spellfile' 'spf' string (default empty)
7053 local to buffer
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007054 {not available when compiled without the |+syntax|
7055 feature}
7056 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00007057 commands. It must end in ".{encoding}.add". You need to include the
7058 path, otherwise the file is placed in the current directory.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007059 *E765*
7060 It may also be a comma separated list of names. A count before the
7061 |zg| and |zw| commands can be used to access each. This allows using
7062 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007063 When a word is added while this option is empty Vim will set it for
Bram Moolenaar910f66f2006-04-05 20:41:53 +00007064 you: Using the first directory in 'runtimepath' that is writable. If
7065 there is no "spell" directory yet it will be created. For the file
7066 name the first language name that appears in 'spelllang' is used,
Bram Moolenaar3b506942005-06-23 22:36:45 +00007067 ignoring the region.
7068 The resulting ".spl" file will be used for spell checking, it does not
7069 have to appear in 'spelllang'.
7070 Normally one file is used for all regions, but you can add the region
7071 name if you want to. However, it will then only be used when
7072 'spellfile' is set to it, for entries in 'spelllang' only files
7073 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00007074 This option cannot be set from a |modeline| or in the |sandbox|, for
7075 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007076
Bram Moolenaar217ad922005-03-20 22:37:15 +00007077 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007078'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00007079 local to buffer
Bram Moolenaar217ad922005-03-20 22:37:15 +00007080 {not available when compiled without the |+syntax|
7081 feature}
Bram Moolenaar3b506942005-06-23 22:36:45 +00007082 A comma separated list of word list names. When the 'spell' option is
7083 on spellchecking will be done for these languages. Example: >
7084 set spelllang=en_us,nl,medical
7085< This means US English, Dutch and medical words are recognized. Words
7086 that are not recognized will be highlighted.
Bram Moolenaar911ead12019-04-21 00:03:35 +02007087 The word list name must consist of alphanumeric characters, a dash or
7088 an underscore. It should not include a comma or dot. Using a dash is
Bram Moolenaar3b506942005-06-23 22:36:45 +00007089 recommended to separate the two letter language name from a
7090 specification. Thus "en-rare" is used for rare English words.
7091 A region name must come last and have the form "_xx", where "xx" is
7092 the two-letter, lower case region name. You can use more than one
7093 region by listing them: "en_us,en_ca" supports both US and Canadian
7094 English, but not words specific for Australia, New Zealand or Great
Bram Moolenaarfa735342016-01-03 22:14:44 +01007095 Britain. (Note: currently en_au and en_nz dictionaries are older than
7096 en_ca, en_gb and en_us).
Bram Moolenaarcc63c642013-11-12 04:44:01 +01007097 If the name "cjk" is included East Asian characters are excluded from
7098 spell checking. This is useful when editing text that also has Asian
7099 words.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007100 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007101 As a special case the name of a .spl file can be given as-is. The
7102 first "_xx" in the name is removed and used as the region name
7103 (_xx is an underscore, two letters and followed by a non-letter).
7104 This is mainly for testing purposes. You must make sure the correct
7105 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007106 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007107 idea to set 'spelllang' after setting 'encoding' to avoid loading the
7108 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00007109 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007110
Bram Moolenaar98692072006-02-04 00:57:42 +00007111 If the |spellfile.vim| plugin is active and you use a language name
7112 for which Vim cannot find the .spl file in 'runtimepath' the plugin
7113 will ask you if you want to download the file.
7114
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007115 After this option has been set successfully, Vim will source the files
7116 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
Bram Moolenaarb730f0c2018-11-25 03:56:26 +01007117 up to the first character that is not an ASCII letter or number and
7118 not a dash. Also see |set-spc-auto|.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007119
Bram Moolenaar362b44b2020-06-10 21:47:00 +02007120 *'spelloptions'* *'spo'*
7121'spelloptions' 'spo' string (default "")
7122 local to buffer
7123 {not available when compiled without the |+syntax|
7124 feature}
7125 A comma separated list of options for spell checking:
7126 camel When a word is CamelCased, assume "Cased" is a
7127 separate word: every upper-case character in a word
7128 that comes after a lower case character indicates the
7129 start of a new word.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007130
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007131 *'spellsuggest'* *'sps'*
7132'spellsuggest' 'sps' string (default "best")
7133 global
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007134 {not available when compiled without the |+syntax|
7135 feature}
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007136 Methods used for spelling suggestions. Both for the |z=| command and
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007137 the |spellsuggest()| function. This is a comma-separated list of
7138 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007139
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007140 best Internal method that works best for English. Finds
7141 changes like "fast" and uses a bit of sound-a-like
7142 scoring to improve the ordering.
7143
7144 double Internal method that uses two methods and mixes the
7145 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007146 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007147 word. That only works when the language specifies
7148 sound folding. Can be slow and doesn't always give
7149 better results.
7150
7151 fast Internal method that only checks for simple changes:
7152 character inserts/deletes/swaps. Works well for
7153 simple typing mistakes.
7154
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007155 {number} The maximum number of suggestions listed for |z=|.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007156 Not used for |spellsuggest()|. The number of
7157 suggestions is never more than the value of 'lines'
7158 minus two.
7159
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007160 file:{filename} Read file {filename}, which must have two columns,
7161 separated by a slash. The first column contains the
7162 bad word, the second column the suggested good word.
7163 Example:
7164 theribal/terrible ~
7165 Use this for common mistakes that do not appear at the
7166 top of the suggestion list with the internal methods.
7167 Lines without a slash are ignored, use this for
7168 comments.
Bram Moolenaarbcb98982014-05-01 14:08:19 +02007169 The word in the second column must be correct,
7170 otherwise it will not be used. Add the word to an
7171 ".add" file if it is currently flagged as a spelling
7172 mistake.
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007173 The file is used for all languages.
7174
7175 expr:{expr} Evaluate expression {expr}. Use a function to avoid
7176 trouble with spaces. |v:val| holds the badly spelled
7177 word. The expression must evaluate to a List of
7178 Lists, each with a suggestion and a score.
7179 Example:
Bram Moolenaar214641f2017-03-05 17:04:09 +01007180 [['the', 33], ['that', 44]] ~
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007181 Set 'verbose' and use |z=| to see the scores that the
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007182 internal methods use. A lower score is better.
7183 This may invoke |spellsuggest()| if you temporarily
7184 set 'spellsuggest' to exclude the "expr:" part.
7185 Errors are silently ignored, unless you set the
7186 'verbose' option to a non-zero value.
7187
7188 Only one of "best", "double" or "fast" may be used. The others may
7189 appear several times in any order. Example: >
7190 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
7191<
7192 This option cannot be set from a |modeline| or in the |sandbox|, for
7193 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007194
7195
Bram Moolenaar071d4272004-06-13 20:20:40 +00007196 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
7197'splitbelow' 'sb' boolean (default off)
7198 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007199 When on, splitting a window will put the new window below the current
7200 one. |:split|
7201
7202 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
7203'splitright' 'spr' boolean (default off)
7204 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007205 When on, splitting a window will put the new window right of the
7206 current one. |:vsplit|
7207
7208 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
7209'startofline' 'sol' boolean (default on)
7210 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007211 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00007212 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007213 (if possible). This applies to the commands: CTRL-D, CTRL-U, CTRL-B,
Bram Moolenaar843ee412004-06-30 16:16:41 +00007214 CTRL-F, "G", "H", "M", "L", gg, and to the commands "d", "<<" and ">>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007215 with a linewise operator, with "%" with a count and to buffer changing
7216 commands (CTRL-^, :bnext, :bNext, etc.). Also for an Ex command that
7217 only has a line number, e.g., ":25" or ":+".
7218 In case of buffer changing commands the cursor is placed at the column
7219 where it was the last time the buffer was edited.
7220 NOTE: This option is set when 'compatible' is set.
7221
Bram Moolenaar00654022011-02-25 14:42:19 +01007222 *'statusline'* *'stl'* *E540* *E542*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007223'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007224 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007225 {not available when compiled without the |+statusline|
7226 feature}
7227 When nonempty, this option determines the content of the status line.
7228 Also see |status-line|.
7229
7230 The option consists of printf style '%' items interspersed with
7231 normal text. Each status line item is of the form:
7232 %-0{minwid}.{maxwid}{item}
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01007233 All fields except the {item} are optional. A single percent sign can
Bram Moolenaar8133cc62020-10-26 21:05:27 +01007234 be given as "%%".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007235
Bram Moolenaar238a5642006-02-21 22:12:05 +00007236 When the option starts with "%!" then it is used as an expression,
7237 evaluated and the result is used as the option value. Example: >
7238 :set statusline=%!MyStatusLine()
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02007239< The *g:statusline_winid* variable will be set to the |window-ID| of the
7240 window that the status line belongs to.
7241 The result can contain %{} items that will be evaluated too.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02007242 Note that the "%!" expression is evaluated in the context of the
7243 current window and buffer, while %{} items are evaluated in the
7244 context of the window that the statusline belongs to.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007245
7246 When there is error while evaluating the option then it will be made
7247 empty to avoid further errors. Otherwise screen updating would loop.
7248
Bram Moolenaar071d4272004-06-13 20:20:40 +00007249 Note that the only effect of 'ruler' when this option is set (and
7250 'laststatus' is 2) is controlling the output of |CTRL-G|.
7251
7252 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00007253 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00007254 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007255 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007256 minwid Minimum width of the item, padding as set by '-' & '0'.
7257 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007258 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007259 on the left for text items. Numeric items will be
7260 shifted down to maxwid-2 digits followed by '>'number
7261 where number is the amount of missing digits, much like
7262 an exponential notation.
7263 item A one letter code as described below.
7264
7265 Following is a description of the possible statusline items. The
7266 second character in "item" is the type:
7267 N for number
7268 S for string
7269 F for flags as described below
7270 - not applicable
7271
7272 item meaning ~
Bram Moolenaar02467872007-05-06 13:22:01 +00007273 f S Path to the file in the buffer, as typed or relative to current
7274 directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007275 F S Full path to the file in the buffer.
7276 t S File name (tail) of file in the buffer.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007277 m F Modified flag, text is "[+]"; "[-]" if 'modifiable' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007278 M F Modified flag, text is ",+" or ",-".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007279 r F Readonly flag, text is "[RO]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007280 R F Readonly flag, text is ",RO".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007281 h F Help buffer flag, text is "[help]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007282 H F Help buffer flag, text is ",HLP".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007283 w F Preview window flag, text is "[Preview]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007284 W F Preview window flag, text is ",PRV".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007285 y F Type of file in the buffer, e.g., "[vim]". See 'filetype'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007286 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
Bram Moolenaar7fd73202010-07-25 16:58:46 +02007287 q S "[Quickfix List]", "[Location List]" or empty.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007288 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
7289 being used: "<keymap>"
7290 n N Buffer number.
Bram Moolenaar00654022011-02-25 14:42:19 +01007291 b N Value of character under cursor.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007292 B N As above, in hexadecimal.
7293 o N Byte number in file of byte under cursor, first byte is 1.
7294 Mnemonic: Offset from start of file (with one added)
7295 {not available when compiled without |+byte_offset| feature}
7296 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007297 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007298 l N Line number.
7299 L N Number of lines in buffer.
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02007300 c N Column number (byte index).
7301 v N Virtual column number (screen column).
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007302 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007303 p N Percentage through file in lines as in |CTRL-G|.
7304 P S Percentage through file of displayed window. This is like the
Bram Moolenaar14b69452013-06-29 23:05:20 +02007305 percentage described for 'ruler'. Always 3 in length, unless
7306 translated.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007307 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00007308 Empty if the argument file count is zero or one.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007309 { NF Evaluate expression between '%{' and '}' and substitute result.
Bram Moolenaar6d150f72018-04-21 20:03:20 +02007310 Note that there is no '%' before the closing '}'. The
7311 expression cannot contain a '}' character, call a function to
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007312 work around that. See |stl-%{| below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007313 ( - Start of item group. Can be used for setting the width and
7314 alignment of a section. Must be followed by %) somewhere.
7315 ) - End of item group. No width fields allowed.
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007316 T N For 'tabline': start of tab page N label. Use %T after the last
7317 label. This information is used for mouse clicks.
7318 X N For 'tabline': start of close tab N label. Use %X after the
7319 label, e.g.: %3Xclose%X. Use %999X for a "close current tab"
7320 mark. This information is used for mouse clicks.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007321 < - Where to truncate line if too long. Default is at the start.
7322 No width fields allowed.
7323 = - Separation point between left and right aligned items.
7324 No width fields allowed.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007325 # - Set highlight group. The name must follow and then a # again.
7326 Thus use %#HLname# for highlight group HLname. The same
7327 highlighting is used, also for the statusline of non-current
7328 windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007329 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00007330 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007331 The difference between User{N} and StatusLine will be applied
7332 to StatusLineNC for the statusline of non-current windows.
7333 The number N must be between 1 and 9. See |hl-User1..9|
7334
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007335 When displaying a flag, Vim removes the leading comma, if any, when
7336 that flag comes right after plaintext. This will make a nice display
7337 when flags are used like in the examples below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007338
Bram Moolenaar582fd852005-03-28 20:58:01 +00007339 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00007340 not set) and a minwid is not set for the group, the whole group will
7341 become empty. This will make a group like the following disappear
7342 completely from the statusline when none of the flags are set. >
7343 :set statusline=...%(\ [%M%R%H]%)...
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02007344< Beware that an expression is evaluated each and every time the status
7345 line is displayed.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007346 *stl-%{* *g:actual_curbuf* *g:actual_curwin*
Bram Moolenaarade0d392020-01-21 22:33:58 +01007347 While evaluating %{} the current buffer and current window will be set
7348 temporarily to that of the window (and buffer) whose statusline is
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007349 currently being drawn. The expression will evaluate in this context.
7350 The variable "g:actual_curbuf" is set to the `bufnr()` number of the
7351 real current buffer and "g:actual_curwin" to the |window-ID| of the
7352 real current window. These values are strings.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007353
Bram Moolenaar30b65812012-07-12 22:01:11 +02007354 The 'statusline' option will be evaluated in the |sandbox| if set from
7355 a modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02007356 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007357
7358 It is not allowed to change text or jump to another window while
7359 evaluating 'statusline' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007360
7361 If the statusline is not updated when you want it (e.g., after setting
7362 a variable that's used in an expression), you can force an update by
7363 setting an option without changing its value. Example: >
7364 :let &ro = &ro
7365
7366< A result of all digits is regarded a number for display purposes.
7367 Otherwise the result is taken as flag text and applied to the rules
7368 described above.
7369
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00007370 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00007371 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
Bram Moolenaarc4da1132017-07-15 19:39:43 +02007372 edit your .vimrc or whatever with "vim --clean" to get it right.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007373
7374 Examples:
7375 Emulate standard status line with 'ruler' set >
7376 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
7377< Similar, but add ASCII value of char under the cursor (like "ga") >
7378 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
7379< Display byte count and byte value, modified flag in red. >
7380 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
7381 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
7382< Display a ,GZ flag if a compressed file is loaded >
7383 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
7384< In the |:autocmd|'s: >
7385 :let b:gzflag = 1
7386< And: >
7387 :unlet b:gzflag
7388< And define this function: >
7389 :function VarExists(var, val)
7390 : if exists(a:var) | return a:val | else | return '' | endif
7391 :endfunction
7392<
7393 *'suffixes'* *'su'*
7394'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
7395 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007396 Files with these suffixes get a lower priority when multiple files
7397 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007398 suffixes. Spaces after the comma are ignored. A dot is also seen as
7399 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007400 separator, precede it with a backslash (see |option-backslash| about
7401 including spaces and backslashes).
7402 See 'wildignore' for completely ignoring files.
7403 The use of |:set+=| and |:set-=| is preferred when adding or removing
7404 suffixes from the list. This avoids problems when a future version
7405 uses another default.
7406
7407 *'suffixesadd'* *'sua'*
7408'suffixesadd' 'sua' string (default "")
7409 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007410 {not available when compiled without the
7411 |+file_in_path| feature}
7412 Comma separated list of suffixes, which are used when searching for a
7413 file for the "gf", "[I", etc. commands. Example: >
7414 :set suffixesadd=.java
7415<
7416 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
7417'swapfile' 'swf' boolean (default on)
7418 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007419 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007420 swapfile is not wanted for a specific buffer. For example, with
7421 confidential information that even root must not be able to access.
7422 Careful: All text will be in memory:
7423 - Don't use this for big files.
7424 - Recovery will be impossible!
7425 A swapfile will only be present when |'updatecount'| is non-zero and
7426 'swapfile' is set.
7427 When 'swapfile' is reset, the swap file for the current buffer is
7428 immediately deleted. When 'swapfile' is set, and 'updatecount' is
7429 non-zero, a swap file is immediately created.
7430 Also see |swap-file| and |'swapsync'|.
Bram Moolenaar76f3b1a2014-03-27 22:30:07 +01007431 If you want to open a new buffer without creating a swap file for it,
7432 use the |:noswapfile| modifier.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01007433 See 'directory' for where the swap file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007434
7435 This option is used together with 'bufhidden' and 'buftype' to
7436 specify special kinds of buffers. See |special-buffers|.
7437
7438 *'swapsync'* *'sws'*
7439'swapsync' 'sws' string (default "fsync")
7440 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007441 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007442 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007443 When this option is empty parts of the swap file may be in memory and
7444 not written to disk. When the system crashes you may lose more work.
7445 On Unix the system does a sync now and then without Vim asking for it,
7446 so the disadvantage of setting this option off is small. On some
7447 systems the swap file will not be written at all. For a unix system
7448 setting it to "sync" will use the sync() call instead of the default
7449 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007450 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007451
7452 *'switchbuf'* *'swb'*
7453'switchbuf' 'swb' string (default "")
7454 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007455 This option controls the behavior when switching between buffers.
7456 Possible values (comma separated list):
7457 useopen If included, jump to the first open window that
7458 contains the specified buffer (if there is one).
7459 Otherwise: Do not examine other windows.
7460 This setting is checked with |quickfix| commands, when
7461 jumping to errors (":cc", ":cn", "cp", etc.). It is
7462 also used in all buffer related split commands, for
7463 example ":sbuffer", ":sbnext", or ":sbrewind".
Bram Moolenaar779b74b2006-04-10 14:55:34 +00007464 usetab Like "useopen", but also consider windows in other tab
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00007465 pages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007466 split If included, split the current window before loading
Bram Moolenaar15146672011-10-20 22:22:38 +02007467 a buffer for a |quickfix| command that display errors.
Bram Moolenaar63b74a82019-03-24 15:09:13 +01007468 Otherwise: do not split, use current window (when used
7469 in the quickfix window: the previously used window or
7470 split if there is no other window).
Bram Moolenaara594d772015-06-19 14:41:49 +02007471 vsplit Just like "split" but split vertically.
Bram Moolenaar446cb832008-06-24 21:56:24 +00007472 newtab Like "split", but open a new tab page. Overrules
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02007473 "split" when both are present.
Bram Moolenaar539aa6b2019-11-17 18:09:38 +01007474 uselast If included, jump to the previously used window when
7475 jumping to errors with |quickfix| commands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007476
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007477 *'synmaxcol'* *'smc'*
7478'synmaxcol' 'smc' number (default 3000)
7479 local to buffer
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007480 {not available when compiled without the |+syntax|
7481 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007482 Maximum column in which to search for syntax items. In long lines the
7483 text after this column is not highlighted and following lines may not
7484 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007485 This helps to avoid very slow redrawing for an XML file that is one
7486 long line.
7487 Set to zero to remove the limit.
7488
Bram Moolenaar071d4272004-06-13 20:20:40 +00007489 *'syntax'* *'syn'*
7490'syntax' 'syn' string (default empty)
7491 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007492 {not available when compiled without the |+syntax|
7493 feature}
7494 When this option is set, the syntax with this name is loaded, unless
7495 syntax highlighting has been switched off with ":syntax off".
7496 Otherwise this option does not always reflect the current syntax (the
7497 b:current_syntax variable does).
7498 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007499 not automatically recognized. Example, in an IDL file:
7500 /* vim: set syntax=idl : */ ~
7501 When a dot appears in the value then this separates two filetype
7502 names. Example:
7503 /* vim: set syntax=c.doxygen : */ ~
7504 This will use the "c" syntax first, then the "doxygen" syntax.
7505 Note that the second one must be prepared to be loaded as an addition,
7506 otherwise it will be skipped. More than one dot may appear.
7507 To switch off syntax highlighting for the current file, use: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007508 :set syntax=OFF
7509< To switch syntax highlighting on according to the current value of the
7510 'filetype' option: >
7511 :set syntax=ON
7512< What actually happens when setting the 'syntax' option is that the
7513 Syntax autocommand event is triggered with the value as argument.
7514 This option is not copied to another buffer, independent of the 's' or
7515 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007516 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007517
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007518 *'tabline'* *'tal'*
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007519'tabline' 'tal' string (default empty)
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007520 global
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007521 When nonempty, this option determines the content of the tab pages
7522 line at the top of the Vim window. When empty Vim will use a default
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007523 tab pages line. See |setting-tabline| for more info.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007524
7525 The tab pages line only appears as specified with the 'showtabline'
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00007526 option and only when there is no GUI tab line. When 'e' is in
7527 'guioptions' and the GUI supports a tab line 'guitablabel' is used
Bram Moolenaar7f036442010-08-15 15:24:20 +02007528 instead. Note that the two tab pages lines are very different.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007529
7530 The value is evaluated like with 'statusline'. You can use
7531 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007532 the text to be displayed. Use "%1T" for the first label, "%2T" for
7533 the second one, etc. Use "%X" items for closing labels.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007534
Bram Moolenaare12bab32019-01-08 22:02:56 +01007535 When changing something that is used in 'tabline' that does not
7536 trigger it to be updated, use |:redrawtabline|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02007537 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaare12bab32019-01-08 22:02:56 +01007538
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007539 Keep in mind that only one of the tab pages is the current one, others
7540 are invisible and you can't jump to their windows.
7541
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007542
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007543 *'tabpagemax'* *'tpm'*
7544'tabpagemax' 'tpm' number (default 10)
7545 global
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007546 Maximum number of tab pages to be opened by the |-p| command line
7547 argument or the ":tab all" command. |tabpage|
7548
7549
7550 *'tabstop'* *'ts'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007551'tabstop' 'ts' number (default 8)
7552 local to buffer
7553 Number of spaces that a <Tab> in the file counts for. Also see
7554 |:retab| command, and 'softtabstop' option.
7555
7556 Note: Setting 'tabstop' to any other value than 8 can make your file
7557 appear wrong in many places (e.g., when printing it).
7558
7559 There are four main ways to use tabs in Vim:
7560 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
7561 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007562 will use a mix of tabs and spaces, but typing <Tab> and <BS> will
Bram Moolenaar071d4272004-06-13 20:20:40 +00007563 behave like a tab appears every 4 (or 3) characters.
7564 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
7565 'expandtab'. This way you will always insert spaces. The
7566 formatting will never be messed up when 'tabstop' is changed.
7567 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007568 |modeline| to set these values when editing the file again. Only
Bram Moolenaar071d4272004-06-13 20:20:40 +00007569 works when using Vim to edit the file.
7570 4. Always set 'tabstop' and 'shiftwidth' to the same value, and
7571 'noexpandtab'. This should then work (for initial indents only)
7572 for any tabstop setting that people use. It might be nice to have
7573 tabs after the first non-blank inserted as spaces if you do this
7574 though. Otherwise aligned comments will be wrong when 'tabstop' is
7575 changed.
7576
Bram Moolenaar04958cb2018-06-23 19:23:02 +02007577 If Vim is compiled with the |+vartabs| feature then the value of
7578 'tabstop' will be ignored if |'vartabstop'| is set to anything other
7579 than an empty string.
7580
Bram Moolenaar071d4272004-06-13 20:20:40 +00007581 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
7582'tagbsearch' 'tbs' boolean (default on)
7583 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007584 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007585 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00007586 searching makes searching for a tag a LOT faster, but a linear search
7587 will find more tags if the tags file wasn't properly sorted.
7588 Vim normally assumes that your tags files are sorted, or indicate that
7589 they are not sorted. Only when this is not the case does the
7590 'tagbsearch' option need to be switched off.
7591
7592 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007593 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00007594 certain files, or retry all files with a linear search. When
7595 'tagbsearch' is off, only a linear search is done.
7596
7597 Linear searching is done anyway, for one file, when Vim finds a line
7598 at the start of the file indicating that it's not sorted: >
Bram Moolenaar446cb832008-06-24 21:56:24 +00007599 !_TAG_FILE_SORTED 0 /some comment/
Bram Moolenaar071d4272004-06-13 20:20:40 +00007600< [The whitespace before and after the '0' must be a single <Tab>]
7601
7602 When a binary search was done and no match was found in any of the
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007603 files listed in 'tags', and case is ignored or a pattern is used
Bram Moolenaar071d4272004-06-13 20:20:40 +00007604 instead of a normal tag name, a retry is done with a linear search.
7605 Tags in unsorted tags files, and matches with different case will only
7606 be found in the retry.
7607
Bram Moolenaard4755bb2004-09-02 19:12:26 +00007608 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007609 linear search can be avoided when case is ignored. Use a value of '2'
7610 in the "!_TAG_FILE_SORTED" line for this. A tag file can be case-fold
7611 sorted with the -f switch to "sort" in most unices, as in the command:
7612 "sort -f -o tags tags". For "Exuberant ctags" version 5.x or higher
7613 (at least 5.5) the --sort=foldcase switch can be used for this as
7614 well. Note that case must be folded to uppercase for this to work.
7615
7616 By default, tag searches are case-sensitive. Case is ignored when
7617 'ignorecase' is set and 'tagcase' is "followic", or when 'tagcase' is
7618 "ignore".
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007619 Also when 'tagcase' is "followscs" and 'smartcase' is set, or
7620 'tagcase' is "smart", and the pattern contains only lowercase
7621 characters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007622
7623 When 'tagbsearch' is off, tags searching is slower when a full match
7624 exists, but faster when no full match exists. Tags in unsorted tags
7625 files may only be found with 'tagbsearch' off.
7626 When the tags file is not sorted, or sorted in a wrong way (not on
7627 ASCII byte value), 'tagbsearch' should be off, or the line given above
7628 must be included in the tags file.
7629 This option doesn't affect commands that find all matching tags (e.g.,
7630 command-line completion and ":help").
Bram Moolenaar071d4272004-06-13 20:20:40 +00007631
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007632 *'tagcase'* *'tc'*
7633'tagcase' 'tc' string (default "followic")
7634 global or local to buffer |global-local|
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007635 This option specifies how case is handled when searching the tags
7636 file:
7637 followic Follow the 'ignorecase' option
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007638 followscs Follow the 'smartcase' and 'ignorecase' options
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007639 ignore Ignore case
7640 match Match case
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007641 smart Ignore case unless an upper case letter is used
Bram Moolenaar036986f2017-03-16 17:41:02 +01007642 NOTE: This option is set to the Vi default value when 'compatible' is
7643 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007644
Bram Moolenaar45e18cb2019-04-28 18:05:35 +02007645 *'tagfunc'* *'tfu'*
7646'tagfunc' 'tfu' string (default: empty)
7647 local to buffer
7648 {not available when compiled without the |+eval|
7649 feature}
7650 This option specifies a function to be used to perform tag searches.
7651 The function gets the tag pattern and should return a List of matching
7652 tags. See |tag-function| for an explanation of how to write the
7653 function and an example.
7654
Bram Moolenaar071d4272004-06-13 20:20:40 +00007655 *'taglength'* *'tl'*
7656'taglength' 'tl' number (default 0)
7657 global
7658 If non-zero, tags are significant up to this number of characters.
7659
7660 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
7661'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
7662 global
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00007663 If on and using a tags file in another directory, file names in that
7664 tags file are relative to the directory where the tags file is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007665 NOTE: This option is set to the Vi default value when 'compatible' is
7666 set and to the Vim default value when 'compatible' is reset.
7667
7668 *'tags'* *'tag'* *E433*
7669'tags' 'tag' string (default "./tags,tags", when compiled with
7670 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
7671 global or local to buffer |global-local|
7672 Filenames for the tag command, separated by spaces or commas. To
7673 include a space or comma in a file name, precede it with a backslash
7674 (see |option-backslash| about including spaces and backslashes).
7675 When a file name starts with "./", the '.' is replaced with the path
7676 of the current file. But only when the 'd' flag is not included in
7677 'cpoptions'. Environment variables are expanded |:set_env|. Also see
7678 |tags-option|.
7679 "*", "**" and other wildcards can be used to search for tags files in
Bram Moolenaare2b590e2010-08-08 18:29:48 +02007680 a directory tree. See |file-searching|. E.g., "/lib/**/tags" will
7681 find all files named "tags" below "/lib". The filename itself cannot
7682 contain wildcards, it is used as-is. E.g., "/lib/**/tags?" will find
7683 files called "tags?". {not available when compiled without the
7684 |+path_extra| feature}
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00007685 The |tagfiles()| function can be used to get a list of the file names
7686 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007687 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
7688 files are also supported. They are automatically recognized. The
7689 default value becomes "./tags,./TAGS,tags,TAGS", unless case
7690 differences are ignored (MS-Windows). |emacs-tags|
7691 The use of |:set+=| and |:set-=| is preferred when adding or removing
7692 file names from the list. This avoids problems when a future version
7693 uses another default.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007694
7695 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
7696'tagstack' 'tgst' boolean (default on)
7697 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007698 When on, the |tagstack| is used normally. When off, a ":tag" or
7699 ":tselect" command with an argument will not push the tag onto the
7700 tagstack. A following ":tag" without an argument, a ":pop" command or
7701 any other command that uses the tagstack will use the unmodified
7702 tagstack, but does change the pointer to the active entry.
7703 Resetting this option is useful when using a ":tag" command in a
7704 mapping which should not change the tagstack.
7705
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007706 *'tcldll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01007707'tcldll' string (default depends on the build)
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007708 global
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007709 {only available when compiled with the |+tcl/dyn|
7710 feature}
7711 Specifies the name of the Tcl shared library. The default is
7712 DYNAMIC_TCL_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02007713 Environment variables are expanded |:set_env|.
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007714 This option cannot be set from a |modeline| or in the |sandbox|, for
7715 security reasons.
7716
Bram Moolenaar071d4272004-06-13 20:20:40 +00007717 *'term'* *E529* *E530* *E531*
7718'term' string (default is $TERM, if that fails:
7719 in the GUI: "builtin_gui"
7720 on Amiga: "amiga"
Bram Moolenaarb3f74062020-02-26 16:16:53 +01007721 on Haiku: "xterm"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007722 on Mac: "mac-ansi"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007723 on Unix: "ansi"
7724 on VMS: "ansi"
7725 on Win 32: "win32")
7726 global
7727 Name of the terminal. Used for choosing the terminal control
7728 characters. Environment variables are expanded |:set_env|.
7729 For example: >
7730 :set term=$TERM
7731< See |termcap|.
7732
7733 *'termbidi'* *'tbidi'*
7734 *'notermbidi'* *'notbidi'*
7735'termbidi' 'tbidi' boolean (default off, on for "mlterm")
7736 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007737 {only available when compiled with the |+arabic|
7738 feature}
7739 The terminal is in charge of Bi-directionality of text (as specified
7740 by Unicode). The terminal is also expected to do the required shaping
7741 that some languages (such as Arabic) require.
7742 Setting this option implies that 'rightleft' will not be set when
7743 'arabic' is set and the value of 'arabicshape' will be ignored.
7744 Note that setting 'termbidi' has the immediate effect that
7745 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
7746 This option is reset when the GUI is started.
7747 For further details see |arabic.txt|.
7748
7749 *'termencoding'* *'tenc'*
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02007750'termencoding' 'tenc' string (default ""; with GTK+ GUI: "utf-8")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007751 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007752 Encoding used for the terminal. This specifies what character
7753 encoding the keyboard produces and the display will understand. For
Bram Moolenaar3848e002016-03-19 18:42:29 +01007754 the GUI it only applies to the keyboard ('encoding' is used for the
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02007755 display).
Bram Moolenaar4b7cdca2020-01-01 16:18:38 +01007756 *E617* *E950*
Bram Moolenaar3df01732017-02-17 22:47:16 +01007757 Note: This does not apply to the GTK+ GUI. After the GUI has been
Bram Moolenaar071d4272004-06-13 20:20:40 +00007758 successfully initialized, 'termencoding' is forcibly set to "utf-8".
7759 Any attempts to set a different value will be rejected, and an error
7760 message is shown.
Bram Moolenaarac360bf2015-09-01 20:31:20 +02007761 For the Win32 GUI and console versions 'termencoding' is not used,
Bram Moolenaar071d4272004-06-13 20:20:40 +00007762 because the Win32 system always passes Unicode characters.
7763 When empty, the same encoding is used as for the 'encoding' option.
7764 This is the normal value.
7765 Not all combinations for 'termencoding' and 'encoding' are valid. See
7766 |encoding-table|.
7767 The value for this option must be supported by internal conversions or
7768 iconv(). When this is not possible no conversion will be done and you
7769 will probably experience problems with non-ASCII characters.
7770 Example: You are working with the locale set to euc-jp (Japanese) and
7771 want to edit a UTF-8 file: >
7772 :let &termencoding = &encoding
7773 :set encoding=utf-8
7774< You need to do this when your system has no locale support for UTF-8.
7775
Bram Moolenaarcafafb32018-02-22 21:07:09 +01007776 *'termguicolors'* *'tgc'* *E954*
Bram Moolenaar61be73b2016-04-29 22:59:22 +02007777'termguicolors' 'tgc' boolean (default off)
7778 global
Bram Moolenaar61be73b2016-04-29 22:59:22 +02007779 {not available when compiled without the
7780 |+termguicolors| feature}
7781 When on, uses |highlight-guifg| and |highlight-guibg| attributes in
Bram Moolenaarcafafb32018-02-22 21:07:09 +01007782 the terminal (thus using 24-bit color).
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01007783
Bram Moolenaarcafafb32018-02-22 21:07:09 +01007784 Requires a ISO-8613-3 compatible terminal. If setting this option
7785 does not work (produces a colorless UI) reading |xterm-true-color|
7786 might help.
7787
7788 For Win32 console, Windows 10 version 1703 (Creators Update) or later
7789 is required. Use this check to find out: >
7790 if has('vcon')
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01007791< This requires Vim to be built with the |+vtp| feature.
7792
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +02007793 Note that the "cterm" attributes are still used, not the "gui" ones.
Bram Moolenaar036986f2017-03-16 17:41:02 +01007794 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar61be73b2016-04-29 22:59:22 +02007795
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02007796 *'termwinkey'* *'twk'*
7797'termwinkey' 'twk' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02007798 local to window
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007799 The key that starts a CTRL-W command in a terminal window. Other keys
Bram Moolenaar74675a62017-07-15 13:53:23 +02007800 are sent to the job running in the window.
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007801 The <> notation can be used, e.g.: >
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02007802 :set termwinkey=<C-L>
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007803< The string must be one key stroke but can be multiple bytes.
7804 When not set CTRL-W is used, so that CTRL-W : gets you to the command
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02007805 line. If 'termwinkey' is set to CTRL-L then CTRL-L : gets you to the
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007806 command line.
Bram Moolenaar74675a62017-07-15 13:53:23 +02007807
Bram Moolenaar6c60f472019-04-28 16:00:35 +02007808 *'termwinscroll'* *'twsl'*
7809'termwinscroll' 'twsl' number (default 10000)
7810 local to buffer
7811 {not available when compiled without the
7812 |+terminal| feature}
7813 Number of scrollback lines to keep. When going over this limit the
7814 first 10% of the scrollback lines are deleted. This is just to reduce
7815 the memory usage. See |Terminal-Normal|.
7816
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02007817 *'termwinsize'* *'tws'*
7818'termwinsize' 'tws' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02007819 local to window
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02007820 Size used when opening the |terminal| window. Format:
7821 {rows}x{columns} or {rows}*{columns}.
Bram Moolenaar74675a62017-07-15 13:53:23 +02007822 - When empty the terminal gets the size from the window.
Bram Moolenaar498c2562018-04-15 23:45:15 +02007823 - When set with a "x" (e.g., "24x80") the terminal size is not
7824 adjusted to the window size. If the window is smaller only the
7825 top-left part is displayed.
7826 - When set with a "*" (e.g., "10*50") the terminal size follows the
7827 window size, but will not be smaller than the specified rows and/or
7828 columns.
7829 - When rows is zero then use the height of the window.
7830 - When columns is zero then use the width of the window.
7831 - Using "0x0" or "0*0" is the same as empty.
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02007832 - Can be overruled in the |term_start()| options with "term_rows" and
7833 "term_cols".
Bram Moolenaar498c2562018-04-15 23:45:15 +02007834
7835 Examples:
7836 "30x0" uses 30 rows and the current window width.
7837 "20*0" uses at least 20 rows and the current window width.
7838 "0*40" uses the current window height and at least 40 columns.
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02007839 Note that the command running in the terminal window may still change
7840 the size of the terminal. In that case the Vim window will be
7841 adjusted to that size, if possible.
Bram Moolenaar74675a62017-07-15 13:53:23 +02007842
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01007843 *'termwintype'* *'twt'*
7844'termwintype' 'twt' string (default "")
7845 global
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01007846 {only available when compiled with the |terminal|
7847 feature on MS-Windows}
7848 Specify the virtual console (pty) used when opening the terminal
7849 window.
7850
7851 Possible values are:
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01007852 "" use ConPTY if it is stable, winpty otherwise
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01007853 "winpty" use winpty, fail if not supported
7854 "conpty" use |ConPTY|, fail if not supported
7855
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01007856 |ConPTY| support depends on the platform. Windows 10 October 2018
7857 Update is the first version that supports ConPTY, however it is still
7858 considered unstable. ConPTY might become stable in the next release
7859 of Windows 10. winpty support needs to be installed. If neither is
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01007860 supported then you cannot open a terminal window.
7861
Bram Moolenaar071d4272004-06-13 20:20:40 +00007862 *'terse'* *'noterse'*
7863'terse' boolean (default off)
7864 global
7865 When set: Add 's' flag to 'shortmess' option (this makes the message
7866 for a search that hits the start or end of the file not being
7867 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
7868 shortens a lot of messages}
7869
7870 *'textauto'* *'ta'* *'notextauto'* *'nota'*
7871'textauto' 'ta' boolean (Vim default: on, Vi default: off)
7872 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007873 This option is obsolete. Use 'fileformats'.
7874 For backwards compatibility, when 'textauto' is set, 'fileformats' is
7875 set to the default value for the current system. When 'textauto' is
7876 reset, 'fileformats' is made empty.
7877 NOTE: This option is set to the Vi default value when 'compatible' is
7878 set and to the Vim default value when 'compatible' is reset.
7879
7880 *'textmode'* *'tx'* *'notextmode'* *'notx'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01007881'textmode' 'tx' boolean (Win32: default on,
Bram Moolenaar071d4272004-06-13 20:20:40 +00007882 others: default off)
7883 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007884 This option is obsolete. Use 'fileformat'.
7885 For backwards compatibility, when 'textmode' is set, 'fileformat' is
7886 set to "dos". When 'textmode' is reset, 'fileformat' is set to
7887 "unix".
7888
7889 *'textwidth'* *'tw'*
7890'textwidth' 'tw' number (default 0)
7891 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007892 Maximum width of text that is being inserted. A longer line will be
7893 broken after white space to get this width. A zero value disables
Bram Moolenaarca635012015-09-25 20:34:21 +02007894 this.
7895 'textwidth' is set to 0 when the 'paste' option is set and restored
7896 when 'paste' is reset.
7897 When 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00007898 'formatoptions' and |ins-textwidth|.
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00007899 When 'formatexpr' is set it will be used to break the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007900 NOTE: This option is set to 0 when 'compatible' is set.
7901
7902 *'thesaurus'* *'tsr'*
7903'thesaurus' 'tsr' string (default "")
7904 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007905 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01007906 for thesaurus completion commands |i_CTRL-X_CTRL-T|.
7907
7908 Each line in the file should contain words with similar meaning,
7909 separated by non-keyword characters (white space is preferred).
7910 Maximum line length is 510 bytes.
7911
Bram Moolenaard47d5222018-12-09 20:43:55 +01007912 An English word list was added to this github issue:
7913 https://github.com/vim/vim/issues/629#issuecomment-443293282
7914 Unpack thesaurus_pkg.zip, put the thesaurus.txt file somewhere, e.g.
7915 ~/.vim/thesaurus/english.txt, and the 'thesaurus' option to this file
7916 name.
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01007917
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007918 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00007919 after a comma are ignored, otherwise spaces are included in the file
7920 name. See |option-backslash| about using backslashes.
7921 The use of |:set+=| and |:set-=| is preferred when adding or removing
7922 directories from the list. This avoids problems when a future version
7923 uses another default.
7924 Backticks cannot be used in this option for security reasons.
7925
7926 *'tildeop'* *'top'* *'notildeop'* *'notop'*
7927'tildeop' 'top' boolean (default off)
7928 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007929 When on: The tilde command "~" behaves like an operator.
7930 NOTE: This option is reset when 'compatible' is set.
7931
7932 *'timeout'* *'to'* *'notimeout'* *'noto'*
7933'timeout' 'to' boolean (default on)
7934 global
7935 *'ttimeout'* *'nottimeout'*
Bram Moolenaar94237492017-04-23 18:40:21 +02007936'ttimeout' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007937 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007938 These two options together determine the behavior when part of a
7939 mapped key sequence or keyboard code has been received:
7940
7941 'timeout' 'ttimeout' action ~
7942 off off do not time out
7943 on on or off time out on :mappings and key codes
7944 off on time out on key codes
7945
7946 If both options are off, Vim will wait until either the complete
7947 mapping or key sequence has been received, or it is clear that there
7948 is no mapping or key sequence for the received characters. For
7949 example: if you have mapped "vl" and Vim has received 'v', the next
7950 character is needed to see if the 'v' is followed by an 'l'.
7951 When one of the options is on, Vim will wait for about 1 second for
7952 the next character to arrive. After that the already received
7953 characters are interpreted as single characters. The waiting time can
7954 be changed with the 'timeoutlen' option.
7955 On slow terminals or very busy systems timing out may cause
7956 malfunctioning cursor keys. If both options are off, Vim waits
7957 forever after an entered <Esc> if there are key codes that start
7958 with <Esc>. You will have to type <Esc> twice. If you do not have
7959 problems with key codes, but would like to have :mapped key
7960 sequences not timing out in 1 second, set the 'ttimeout' option and
7961 reset the 'timeout' option.
7962
7963 NOTE: 'ttimeout' is reset when 'compatible' is set.
7964
7965 *'timeoutlen'* *'tm'*
7966'timeoutlen' 'tm' number (default 1000)
7967 global
Bram Moolenaar25c9c682019-05-05 18:13:34 +02007968
Bram Moolenaar071d4272004-06-13 20:20:40 +00007969 *'ttimeoutlen'* *'ttm'*
Bram Moolenaar94237492017-04-23 18:40:21 +02007970'ttimeoutlen' 'ttm' number (default -1, set to 100 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007971 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007972 The time in milliseconds that is waited for a key code or mapped key
7973 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
7974 when part of a command has been typed.
7975 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
7976 different timeout value for key codes is desired set 'ttimeoutlen' to
7977 a non-negative number.
7978
7979 ttimeoutlen mapping delay key code delay ~
7980 < 0 'timeoutlen' 'timeoutlen'
7981 >= 0 'timeoutlen' 'ttimeoutlen'
7982
7983 The timeout only happens when the 'timeout' and 'ttimeout' options
7984 tell so. A useful setting would be >
7985 :set timeout timeoutlen=3000 ttimeoutlen=100
7986< (time out on mapping after three seconds, time out on key codes after
7987 a tenth of a second).
7988
7989 *'title'* *'notitle'*
7990'title' boolean (default off, on when title can be restored)
7991 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007992 {not available when compiled without the |+title|
7993 feature}
7994 When on, the title of the window will be set to the value of
7995 'titlestring' (if it is not empty), or to:
7996 filename [+=-] (path) - VIM
7997 Where:
7998 filename the name of the file being edited
7999 - indicates the file cannot be modified, 'ma' off
8000 + indicates the file was modified
8001 = indicates the file is read-only
8002 =+ indicates the file is read-only and modified
8003 (path) is the path of the file being edited
8004 - VIM the server name |v:servername| or "VIM"
8005 Only works if the terminal supports setting window titles
8006 (currently Amiga console, Win32 console, all GUI versions and
Bram Moolenaard1caa942020-04-10 22:10:56 +02008007 terminals with a non-empty 't_ts' option - these are Unix xterm and
Bram Moolenaar071d4272004-06-13 20:20:40 +00008008 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
8009 *X11*
8010 When Vim was compiled with HAVE_X11 defined, the original title will
8011 be restored if possible. The output of ":version" will include "+X11"
8012 when HAVE_X11 was defined, otherwise it will be "-X11". This also
8013 works for the icon name |'icon'|.
8014 But: When Vim was started with the |-X| argument, restoring the title
8015 will not work (except in the GUI).
8016 If the title cannot be restored, it is set to the value of 'titleold'.
8017 You might want to restore the title outside of Vim then.
8018 When using an xterm from a remote machine you can use this command:
8019 rsh machine_name xterm -display $DISPLAY &
8020 then the WINDOWID environment variable should be inherited and the
8021 title of the window should change back to what it should be after
8022 exiting Vim.
8023
8024 *'titlelen'*
8025'titlelen' number (default 85)
8026 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008027 {not available when compiled without the |+title|
8028 feature}
8029 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008030 title. When the title is longer, only the end of the path name is
8031 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008032 Using a percentage makes this adapt to the width of the window. But
8033 it won't work perfectly, because the actual number of characters
8034 available also depends on the font used and other things in the title
8035 bar. When 'titlelen' is zero the full path is used. Otherwise,
8036 values from 1 to 30000 percent can be used.
8037 'titlelen' is also used for the 'titlestring' option.
8038
8039 *'titleold'*
8040'titleold' string (default "Thanks for flying Vim")
8041 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008042 {only available when compiled with the |+title|
8043 feature}
8044 This option will be used for the window title when exiting Vim if the
8045 original title cannot be restored. Only happens if 'title' is on or
8046 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00008047 This option cannot be set from a |modeline| or in the |sandbox|, for
8048 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008049 *'titlestring'*
8050'titlestring' string (default "")
8051 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008052 {not available when compiled without the |+title|
8053 feature}
8054 When this option is not empty, it will be used for the title of the
8055 window. This happens only when the 'title' option is on.
8056 Only works if the terminal supports setting window titles (currently
8057 Amiga console, Win32 console, all GUI versions and terminals with a
8058 non-empty 't_ts' option).
8059 When Vim was compiled with HAVE_X11 defined, the original title will
Bram Moolenaar51628222016-12-01 23:03:28 +01008060 be restored if possible, see |X11|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008061
Bram Moolenaar071d4272004-06-13 20:20:40 +00008062 When this option contains printf-style '%' items, they will be
8063 expanded according to the rules used for 'statusline'.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008064 This option cannot be set in a modeline when 'modelineexpr' is off.
8065
Bram Moolenaar071d4272004-06-13 20:20:40 +00008066 Example: >
8067 :auto BufEnter * let &titlestring = hostname() . "/" . expand("%:p")
8068 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
8069< The value of 'titlelen' is used to align items in the middle or right
8070 of the available space.
8071 Some people prefer to have the file name first: >
8072 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
8073< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008074 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00008075 separating space only when needed.
8076 NOTE: Use of special characters in 'titlestring' may cause the display
8077 to be garbled (e.g., when it contains a CR or NL character).
8078 {not available when compiled without the |+statusline| feature}
8079
8080 *'toolbar'* *'tb'*
8081'toolbar' 'tb' string (default "icons,tooltips")
8082 global
8083 {only for |+GUI_GTK|, |+GUI_Athena|, |+GUI_Motif| and
8084 |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008085 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00008086 possible values are:
8087 icons Toolbar buttons are shown with icons.
8088 text Toolbar buttons shown with text.
8089 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008090 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008091 tooltips Tooltips are active for toolbar buttons.
8092 Tooltips refer to the popup help text which appears after the mouse
8093 cursor is placed over a toolbar button for a brief moment.
8094
8095 If you want the toolbar to be shown with icons as well as text, do the
8096 following: >
8097 :set tb=icons,text
8098< Motif and Athena cannot display icons and text at the same time. They
8099 will show icons if both are requested.
8100
8101 If none of the strings specified in 'toolbar' are valid or if
8102 'toolbar' is empty, this option is ignored. If you want to disable
8103 the toolbar, you need to set the 'guioptions' option. For example: >
8104 :set guioptions-=T
8105< Also see |gui-toolbar|.
8106
8107 *'toolbariconsize'* *'tbis'*
8108'toolbariconsize' 'tbis' string (default "small")
8109 global
Bram Moolenaar3df01732017-02-17 22:47:16 +01008110 {only in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008111 Controls the size of toolbar icons. The possible values are:
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008112 tiny Use tiny icons.
8113 small Use small icons (default).
8114 medium Use medium-sized icons.
8115 large Use large icons.
8116 huge Use even larger icons.
8117 giant Use very big icons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008118 The exact dimensions in pixels of the various icon sizes depend on
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008119 the current theme. Common dimensions are giant=48x48, huge=32x32,
8120 large=24x24, medium=24x24, small=20x20 and tiny=16x16.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008121
8122 If 'toolbariconsize' is empty, the global default size as determined
8123 by user preferences or the current theme is used.
8124
8125 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
8126'ttybuiltin' 'tbi' boolean (default on)
8127 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008128 When on, the builtin termcaps are searched before the external ones.
8129 When off the builtin termcaps are searched after the external ones.
8130 When this option is changed, you should set the 'term' option next for
8131 the change to take effect, for example: >
8132 :set notbi term=$TERM
8133< See also |termcap|.
8134 Rationale: The default for this option is "on", because the builtin
8135 termcap entries are generally better (many systems contain faulty
8136 xterm entries...).
8137
8138 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
8139'ttyfast' 'tf' boolean (default off, on when 'term' is xterm, hpterm,
8140 sun-cmd, screen, rxvt, dtterm or
8141 iris-ansi; also on when running Vim in
8142 a DOS console)
8143 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008144 Indicates a fast terminal connection. More characters will be sent to
8145 the screen for redrawing, instead of using insert/delete line
8146 commands. Improves smoothness of redrawing when there are multiple
8147 windows and the terminal does not support a scrolling region.
8148 Also enables the extra writing of characters at the end of each screen
8149 line for lines that wrap. This helps when using copy/paste with the
8150 mouse in an xterm and other terminals.
8151
8152 *'ttymouse'* *'ttym'*
8153'ttymouse' 'ttym' string (default depends on 'term')
8154 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008155 {only in Unix and VMS, doesn't work in the GUI; not
8156 available when compiled without |+mouse|}
8157 Name of the terminal type for which mouse codes are to be recognized.
Bram Moolenaar2c7a7632007-05-10 18:19:11 +00008158 Currently these strings are valid:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008159 *xterm-mouse*
8160 xterm xterm-like mouse handling. The mouse generates
8161 "<Esc>[Mscr", where "scr" is three bytes:
8162 "s" = button state
8163 "c" = column plus 33
8164 "r" = row plus 33
Bram Moolenaare968e362014-05-13 20:23:24 +02008165 This only works up to 223 columns! See "dec",
8166 "urxvt", and "sgr" for solutions.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008167 xterm2 Works like "xterm", but with the xterm reporting the
8168 mouse position while the mouse is dragged. This works
8169 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00008170 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00008171 work. See below for how Vim detects this
8172 automatically.
8173 *netterm-mouse*
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008174 netterm NetTerm mouse handling. A left mouse click generates
Bram Moolenaar071d4272004-06-13 20:20:40 +00008175 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008176 for the row and column. No other mouse events are
8177 supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008178 *dec-mouse*
8179 dec DEC terminal mouse handling. The mouse generates a
8180 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00008181 This is also available for an Xterm, if it was
8182 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00008183 *jsbterm-mouse*
8184 jsbterm JSB term mouse handling.
8185 *pterm-mouse*
8186 pterm QNX pterm mouse handling.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008187 *urxvt-mouse*
8188 urxvt Mouse handling for the urxvt (rxvt-unicode) terminal.
Bram Moolenaare968e362014-05-13 20:23:24 +02008189 The mouse works only if the terminal supports this
8190 encoding style, but it does not have 223 columns limit
8191 unlike "xterm" or "xterm2".
Bram Moolenaar9b451252012-08-15 17:43:31 +02008192 *sgr-mouse*
8193 sgr Mouse handling for the terminal that emits SGR-styled
Bram Moolenaare968e362014-05-13 20:23:24 +02008194 mouse reporting. The mouse works even in columns
8195 beyond 223. This option is backward compatible with
8196 "xterm2" because it can also decode "xterm2" style
8197 mouse codes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008198
8199 The mouse handling must be enabled at compile time |+mouse_xterm|
Bram Moolenaare968e362014-05-13 20:23:24 +02008200 |+mouse_dec| |+mouse_netterm| |+mouse_jsbterm| |+mouse_urxvt|
8201 |+mouse_sgr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008202 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
8203 recognized, if enabled at compile time. DEC terminal mouse codes
8204 are recognized if enabled at compile time, and 'ttymouse' is not
Bram Moolenaare968e362014-05-13 20:23:24 +02008205 "xterm", "xterm2", "urxvt" or "sgr" (because dec mouse codes conflict
8206 with them).
Bram Moolenaar071d4272004-06-13 20:20:40 +00008207 This option is automatically set to "xterm", when the 'term' option is
Bram Moolenaar45758762016-10-12 23:08:06 +02008208 set to a name that starts with "xterm", "mlterm", "screen", "tmux",
8209 "st" (full match only), "st-" or "stterm", and 'ttymouse' is not set
8210 already.
Bram Moolenaare968e362014-05-13 20:23:24 +02008211 Additionally, if vim is compiled with the |+termresponse| feature and
8212 |t_RV| is set to the escape sequence to request the xterm version
Bram Moolenaarf8a07122019-07-01 22:06:07 +02008213 number, more intelligent detection is done.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008214 The "xterm2" value will be set if the xterm version is reported to be
Bram Moolenaard47d5222018-12-09 20:43:55 +01008215 from 95 to 276. The "sgr" value will be set if Vim detects Mac
8216 Terminal.app, iTerm2 or mintty, and when the xterm version is 277 or
8217 higher.
Bram Moolenaare968e362014-05-13 20:23:24 +02008218 If you do not want 'ttymouse' to be set to "xterm2" or "sgr"
8219 automatically, set t_RV to an empty string: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008220 :set t_RV=
8221<
8222 *'ttyscroll'* *'tsl'*
8223'ttyscroll' 'tsl' number (default 999)
8224 global
8225 Maximum number of lines to scroll the screen. If there are more lines
8226 to scroll the window is redrawn. For terminals where scrolling is
8227 very slow and redrawing is not slow this can be set to a small number,
8228 e.g., 3, to speed up displaying.
8229
8230 *'ttytype'* *'tty'*
8231'ttytype' 'tty' string (default from $TERM)
8232 global
8233 Alias for 'term', see above.
8234
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008235 *'undodir'* *'udir'*
8236'undodir' 'udir' string (default ".")
8237 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008238 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008239 List of directory names for undo files, separated with commas.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008240 See |'backupdir'| for details of the format.
Bram Moolenaar6a244fe2010-05-24 22:02:24 +02008241 "." means using the directory of the file. The undo file name for
8242 "file.txt" is ".file.txt.un~".
8243 For other directories the file name is the full path of the edited
8244 file, with path separators replaced with "%".
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008245 When writing: The first directory that exists is used. "." always
8246 works, no directories after "." will be used for writing.
8247 When reading all entries are tried to find an undo file. The first
8248 undo file that exists is used. When it cannot be read an error is
8249 given, no further entry is used.
8250 See |undo-persistence|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008251 This option cannot be set from a |modeline| or in the |sandbox|, for
8252 security reasons.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008253
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02008254 *'undofile'* *'noundofile'* *'udf'* *'noudf'*
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008255'undofile' 'udf' boolean (default off)
8256 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02008257 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008258 When on, Vim automatically saves undo history to an undo file when
8259 writing a buffer to a file, and restores undo history from the same
8260 file on buffer read.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008261 The directory where the undo file is stored is specified by 'undodir'.
8262 For more information about this feature see |undo-persistence|.
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008263 The undo file is not read when 'undoreload' causes the buffer from
8264 before a reload to be saved for undo.
Bram Moolenaar97d62492012-11-15 21:28:22 +01008265 When 'undofile' is turned off the undo file is NOT deleted.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008266 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008267
Bram Moolenaar071d4272004-06-13 20:20:40 +00008268 *'undolevels'* *'ul'*
Bram Moolenaar8024f932020-01-14 19:29:13 +01008269'undolevels' 'ul' number (default 100, 1000 for Unix, VMS and Win32)
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008270 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008271 Maximum number of changes that can be undone. Since undo information
Bram Moolenaar5be4cee2019-09-27 19:34:08 +02008272 is kept in memory, higher numbers will cause more memory to be used.
8273 Nevertheless, a single change can already use a large amount of memory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008274 Set to 0 for Vi compatibility: One level of undo and "u" undoes
8275 itself: >
8276 set ul=0
8277< But you can also get Vi compatibility by including the 'u' flag in
8278 'cpoptions', and still be able to use CTRL-R to repeat undo.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008279 Also see |undo-two-ways|.
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008280 Set to -1 for no undo at all. You might want to do this only for the
8281 current buffer: >
8282 setlocal ul=-1
Bram Moolenaar071d4272004-06-13 20:20:40 +00008283< This helps when you run out of memory for a single change.
Bram Moolenaar32efaf62014-11-05 17:02:17 +01008284
8285 The local value is set to -123456 when the global value is to be used.
8286
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008287 Also see |clear-undo|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008288
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008289 *'undoreload'* *'ur'*
8290'undoreload' 'ur' number (default 10000)
8291 global
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008292 Save the whole buffer for undo when reloading it. This applies to the
8293 ":e!" command and reloading for when the buffer changed outside of
8294 Vim. |FileChangedShell|
Bram Moolenaar24a98a02017-09-27 22:23:55 +02008295 The save only happens when this option is negative or when the number
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008296 of lines is smaller than the value of this option.
8297 Set this option to zero to disable undo for a reload.
8298
8299 When saving undo for a reload, any undo file is not read.
8300
8301 Note that this causes the whole buffer to be stored in memory. Set
8302 this option to a lower value if you run out of memory.
8303
Bram Moolenaar071d4272004-06-13 20:20:40 +00008304 *'updatecount'* *'uc'*
8305'updatecount' 'uc' number (default: 200)
8306 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008307 After typing this many characters the swap file will be written to
8308 disk. When zero, no swap file will be created at all (see chapter on
8309 recovery |crash-recovery|). 'updatecount' is set to zero by starting
8310 Vim with the "-n" option, see |startup|. When editing in readonly
8311 mode this option will be initialized to 10000.
8312 The swapfile can be disabled per buffer with |'swapfile'|.
8313 When 'updatecount' is set from zero to non-zero, swap files are
8314 created for all buffers that have 'swapfile' set. When 'updatecount'
8315 is set to zero, existing swap files are not deleted.
8316 Also see |'swapsync'|.
8317 This option has no meaning in buffers where |'buftype'| is "nofile"
8318 or "nowrite".
8319
8320 *'updatetime'* *'ut'*
8321'updatetime' 'ut' number (default 4000)
8322 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008323 If this many milliseconds nothing is typed the swap file will be
8324 written to disk (see |crash-recovery|). Also used for the
8325 |CursorHold| autocommand event.
8326
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008327 *'varsofttabstop'* *'vsts'*
8328'varsofttabstop' 'vsts' string (default "")
8329 local to buffer
8330 {only available when compiled with the |+vartabs|
8331 feature}
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008332 A list of the number of spaces that a <Tab> counts for while editing,
8333 such as inserting a <Tab> or using <BS>. It "feels" like variable-
8334 width <Tab>s are being inserted, while in fact a mixture of spaces
8335 and <Tab>s is used. Tab widths are separated with commas, with the
8336 final value applying to all subsequent tabs.
8337
8338 For example, when editing assembly language files where statements
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02008339 start in the 9th column and comments in the 41st, it may be useful
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008340 to use the following: >
8341 :set varsofttabstop=8,32,8
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02008342< This will set soft tabstops with 8 and 8 + 32 spaces, and 8 more
8343 for every column thereafter.
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008344
8345 Note that the value of |'softtabstop'| will be ignored while
8346 'varsofttabstop' is set.
8347
8348 *'vartabstop'* *'vts'*
8349'vartabstop' 'vts' string (default "")
8350 local to buffer
8351 {only available when compiled with the |+vartabs|
8352 feature}
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008353 A list of the number of spaces that a <Tab> in the file counts for,
8354 separated by commas. Each value corresponds to one tab, with the
8355 final value applying to all subsequent tabs. For example: >
8356 :set vartabstop=4,20,10,8
8357< This will make the first tab 4 spaces wide, the second 20 spaces,
8358 the third 10 spaces, and all following tabs 8 spaces.
8359
8360 Note that the value of |'tabstop'| will be ignored while 'vartabstop'
8361 is set.
8362
Bram Moolenaar071d4272004-06-13 20:20:40 +00008363 *'verbose'* *'vbs'*
8364'verbose' 'vbs' number (default 0)
8365 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008366 When bigger than zero, Vim will give messages about what it is doing.
8367 Currently, these messages are given:
8368 >= 1 When the viminfo file is read or written.
8369 >= 2 When a file is ":source"'ed.
Bram Moolenaar647a5302020-05-03 17:01:24 +02008370 >= 4 Shell commands.
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008371 >= 5 Every searched tags file and include file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008372 >= 8 Files for which a group of autocommands is executed.
8373 >= 9 Every executed autocommand.
Bram Moolenaar647a5302020-05-03 17:01:24 +02008374 >= 11 Finding items in a path
Bram Moolenaar071d4272004-06-13 20:20:40 +00008375 >= 12 Every executed function.
8376 >= 13 When an exception is thrown, caught, finished, or discarded.
8377 >= 14 Anything pending in a ":finally" clause.
Bram Moolenaar823654b2020-05-29 23:03:09 +02008378 >= 15 Every executed Ex command from a script (truncated at 200
8379 characters).
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02008380 >= 16 Every executed Ex command.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008381
8382 This option can also be set with the "-V" argument. See |-V|.
8383 This option is also set by the |:verbose| command.
8384
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008385 When the 'verbosefile' option is set then the verbose messages are not
8386 displayed.
8387
8388 *'verbosefile'* *'vfile'*
8389'verbosefile' 'vfile' string (default empty)
8390 global
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008391 When not empty all messages are written in a file with this name.
8392 When the file exists messages are appended.
8393 Writing to the file ends when Vim exits or when 'verbosefile' is made
Bram Moolenaar80794b12010-06-13 05:20:42 +02008394 empty. Writes are buffered, thus may not show up for some time.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008395 Setting 'verbosefile' to a new value is like making it empty first.
8396 The difference with |:redir| is that verbose messages are not
8397 displayed when 'verbosefile' is set.
8398
Bram Moolenaar071d4272004-06-13 20:20:40 +00008399 *'viewdir'* *'vdir'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008400'viewdir' 'vdir' string (default for Amiga and Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008401 "$VIM/vimfiles/view",
8402 for Unix: "~/.vim/view",
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02008403 for macOS: "$VIM:vimfiles:view"
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01008404 for VMS: "sys$login:vimfiles/view")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008405 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008406 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008407 feature}
8408 Name of the directory where to store files for |:mkview|.
8409 This option cannot be set from a |modeline| or in the |sandbox|, for
8410 security reasons.
8411
8412 *'viewoptions'* *'vop'*
Bram Moolenaar13e90412017-11-11 18:16:48 +01008413'viewoptions' 'vop' string (default: "folds,options,cursor,curdir")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008414 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008415 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008416 feature}
8417 Changes the effect of the |:mkview| command. It is a comma separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008418 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008419 word save and restore ~
8420 cursor cursor position in file and in window
8421 folds manually created folds, opened/closed folds and local
8422 fold options
8423 options options and mappings local to a window or buffer (not
8424 global values for local options)
Bram Moolenaar6e932462014-09-09 18:48:09 +02008425 localoptions same as "options"
Bram Moolenaar071d4272004-06-13 20:20:40 +00008426 slash backslashes in file names replaced with forward
8427 slashes
8428 unix with Unix end-of-line format (single <NL>), even when
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008429 on MS-Windows
Bram Moolenaar13e90412017-11-11 18:16:48 +01008430 curdir the window-local directory, if set with `:lcd`
Bram Moolenaar071d4272004-06-13 20:20:40 +00008431
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008432 "slash" and "unix" are useful on MS-Windows when sharing view files
Bram Moolenaar071d4272004-06-13 20:20:40 +00008433 with Unix. The Unix version of Vim cannot source dos format scripts,
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008434 but the MS-Windows version of Vim can source unix format scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008435
8436 *'viminfo'* *'vi'* *E526* *E527* *E528*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008437'viminfo' 'vi' string (Vi default: "", Vim default for
8438 MS-Windows: '100,<50,s10,h,rA:,rB:,
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01008439 for Amiga: '100,<50,s10,h,rdf0:,rdf1:,rdf2:
8440 for others: '100,<50,s10,h)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008441 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008442 {not available when compiled without the |+viminfo|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008443 feature}
8444 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008445 when exiting Vim (see |viminfo-file|). Except when 'viminfofile' is
8446 "NONE".
8447 The string should be a comma separated list of parameters, each
8448 consisting of a single character identifying the particular parameter,
8449 followed by a number or string which specifies the value of that
8450 parameter. If a particular character is left out, then the default
8451 value is used for that parameter. The following is a list of the
8452 identifying characters and the effect of their value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008453 CHAR VALUE ~
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008454 *viminfo-!*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008455 ! When included, save and restore global variables that start
8456 with an uppercase letter, and don't contain a lowercase
8457 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar680eeca2010-10-20 17:44:42 +02008458 and "_K_L_M" are not. Nested List and Dict items may not be
Bram Moolenaar166af9b2010-11-16 20:34:40 +01008459 read back correctly, you end up with an empty item.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008460 *viminfo-quote*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008461 " Maximum number of lines saved for each register. Old name of
8462 the '<' item, with the disadvantage that you need to put a
8463 backslash before the ", otherwise it will be recognized as the
8464 start of a comment!
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008465 *viminfo-%*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008466 % When included, save and restore the buffer list. If Vim is
8467 started with a file name argument, the buffer list is not
8468 restored. If Vim is started without a file name argument, the
Bram Moolenaard042dc82015-11-24 19:18:36 +01008469 buffer list is restored from the viminfo file. Quickfix
8470 ('buftype'), unlisted ('buflisted'), unnamed and buffers on
8471 removable media (|viminfo-r|) are not saved.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00008472 When followed by a number, the number specifies the maximum
8473 number of buffers that are stored. Without a number all
8474 buffers are stored.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008475 *viminfo-'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008476 ' Maximum number of previously edited files for which the marks
8477 are remembered. This parameter must always be included when
8478 'viminfo' is non-empty.
8479 Including this item also means that the |jumplist| and the
8480 |changelist| are stored in the viminfo file.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008481 *viminfo-/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008482 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008483 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00008484 patterns are also saved. When not included, the value of
8485 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008486 *viminfo-:*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008487 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008488 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008489 *viminfo-<*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008490 < Maximum number of lines saved for each register. If zero then
8491 registers are not saved. When not included, all lines are
8492 saved. '"' is the old name for this item.
8493 Also see the 's' item below: limit specified in Kbyte.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008494 *viminfo-@*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008495 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008496 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008497 *viminfo-c*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008498 c When included, convert the text in the viminfo file from the
8499 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00008500 'encoding'. See |viminfo-encoding|.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008501 *viminfo-f*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008502 f Whether file marks need to be stored. If zero, file marks ('0
8503 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008504 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00008505 cursor position (when exiting or when doing ":wviminfo").
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008506 *viminfo-h*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008507 h Disable the effect of 'hlsearch' when loading the viminfo
8508 file. When not included, it depends on whether ":nohlsearch"
8509 has been used since the last search command.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008510 *viminfo-n*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008511 n Name of the viminfo file. The name must immediately follow
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008512 the 'n'. Must be at the end of the option! If the
8513 'viminfofile' option is set, that file name overrides the one
8514 given here with 'viminfo'. Environment variables are
Bram Moolenaar063b9d12016-07-09 20:21:48 +02008515 expanded when opening the file, not when setting the option.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008516 *viminfo-r*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008517 r Removable media. The argument is a string (up to the next
8518 ','). This parameter can be given several times. Each
8519 specifies the start of a path for which no marks will be
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01008520 stored. This is to avoid removable media. For MS-Windows you
Bram Moolenaar071d4272004-06-13 20:20:40 +00008521 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
8522 also use it for temp files, e.g., for Unix: "r/tmp". Case is
8523 ignored. Maximum length of each 'r' argument is 50
8524 characters.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008525 *viminfo-s*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008526 s Maximum size of an item in Kbyte. If zero then registers are
8527 not saved. Currently only applies to registers. The default
8528 "s10" will exclude registers with more than 10 Kbyte of text.
8529 Also see the '<' item above: line count limit.
8530
8531 Example: >
8532 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
8533<
8534 '50 Marks will be remembered for the last 50 files you
8535 edited.
8536 <1000 Contents of registers (up to 1000 lines each) will be
8537 remembered.
8538 s100 Registers with more than 100 Kbyte text are skipped.
8539 :0 Command-line history will not be saved.
8540 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
8541 no / Since '/' is not specified, the default will be used,
8542 that is, save all of the search history, and also the
8543 previous search and substitute patterns.
8544 no % The buffer list will not be saved nor read back.
8545 no h 'hlsearch' highlighting will be restored.
8546
8547 When setting 'viminfo' from an empty value you can use |:rviminfo| to
8548 load the contents of the file, this is not done automatically.
8549
8550 This option cannot be set from a |modeline| or in the |sandbox|, for
8551 security reasons.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008552 NOTE: This option is set to the Vim default value when 'compatible'
8553 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008554
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008555 *'viminfofile'* *'vif'*
8556'viminfofile' 'vif' string (default: "")
8557 global
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008558 {not available when compiled without the |+viminfo|
8559 feature}
8560 When non-empty, overrides the file name used for viminfo.
8561 When equal to "NONE" no viminfo file will be read or written.
8562 This option can be set with the |-i| command line flag. The |--clean|
8563 command line flag sets it to "NONE".
Bram Moolenaar110289e2019-05-23 15:38:06 +02008564 This option cannot be set from a |modeline| or in the |sandbox|, for
8565 security reasons.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008566
Bram Moolenaar071d4272004-06-13 20:20:40 +00008567 *'virtualedit'* *'ve'*
8568'virtualedit' 've' string (default "")
8569 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008570 A comma separated list of these words:
8571 block Allow virtual editing in Visual block mode.
8572 insert Allow virtual editing in Insert mode.
8573 all Allow virtual editing in all modes.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008574 onemore Allow the cursor to move just past the end of the line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008575
Bram Moolenaar071d4272004-06-13 20:20:40 +00008576 Virtual editing means that the cursor can be positioned where there is
Bram Moolenaarebcbd022007-05-12 14:28:25 +00008577 no actual character. This can be halfway into a tab or beyond the end
Bram Moolenaar071d4272004-06-13 20:20:40 +00008578 of the line. Useful for selecting a rectangle in Visual mode and
8579 editing a table.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008580 "onemore" is not the same, it will only allow moving the cursor just
8581 after the last character of the line. This makes some commands more
8582 consistent. Previously the cursor was always past the end of the line
8583 if the line was empty. But it is far from Vi compatible. It may also
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008584 break some plugins or Vim scripts. For example because |l| can move
8585 the cursor after the last character. Use with care!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02008586 Using the `$` command will move to the last character in the line, not
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008587 past it. This may actually move the cursor to the left!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02008588 The `g$` command will move to the end of the screen line.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008589 It doesn't make sense to combine "all" with "onemore", but you will
8590 not get a warning for it.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008591 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008592
8593 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
8594'visualbell' 'vb' boolean (default off)
8595 global
Bram Moolenaar74675a62017-07-15 13:53:23 +02008596 Use a visual bell instead of beeping. The terminal code to display the
Bram Moolenaar071d4272004-06-13 20:20:40 +00008597 visual bell is given with 't_vb'. When no beep or flash is wanted,
Bram Moolenaar74675a62017-07-15 13:53:23 +02008598 use: >
8599 :set vb t_vb=
8600< If you want a short flash, you can use this on many terminals: >
8601 :set vb t_vb=[?5h$<100>[?5l
8602< Here $<100> specifies the time, you can use a smaller or bigger value
8603 to get a shorter or longer flash.
8604
8605 Note: Vim will limit the bell to once per half a second. This avoids
8606 having to wait for the flashing to finish when there are lots of
8607 bells, e.g. on key repeat. This also happens without 'visualbell'
8608 set.
8609
Bram Moolenaar071d4272004-06-13 20:20:40 +00008610 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
8611 for 20 msec. If you want to use a different time, use "<Esc>|40f",
8612 where 40 is the time in msec.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008613
8614 Note: When the GUI starts, 't_vb' is reset to its default value. You
8615 might want to set it again in your |gvimrc|.
8616
Bram Moolenaar071d4272004-06-13 20:20:40 +00008617 Does not work on the Amiga, you always get a screen flash.
8618 Also see 'errorbells'.
8619
8620 *'warn'* *'nowarn'*
8621'warn' boolean (default on)
8622 global
8623 Give a warning message when a shell command is used while the buffer
8624 has been changed.
8625
8626 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
8627'weirdinvert' 'wiv' boolean (default off)
8628 global
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00008629 This option has the same effect as the 't_xs' terminal option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008630 It is provided for backwards compatibility with version 4.x.
8631 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
8632 vice versa. Has no effect when the GUI is running.
8633
8634 *'whichwrap'* *'ww'*
8635'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
8636 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008637 Allow specified keys that move the cursor left/right to move to the
8638 previous/next line when the cursor is on the first/last character in
8639 the line. Concatenate characters to allow this for these keys:
8640 char key mode ~
8641 b <BS> Normal and Visual
8642 s <Space> Normal and Visual
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008643 h "h" Normal and Visual (not recommended)
8644 l "l" Normal and Visual (not recommended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008645 < <Left> Normal and Visual
8646 > <Right> Normal and Visual
8647 ~ "~" Normal
8648 [ <Left> Insert and Replace
8649 ] <Right> Insert and Replace
8650 For example: >
8651 :set ww=<,>,[,]
8652< allows wrap only when cursor keys are used.
8653 When the movement keys are used in combination with a delete or change
8654 operator, the <EOL> also counts for a character. This makes "3h"
8655 different from "3dh" when the cursor crosses the end of a line. This
8656 is also true for "x" and "X", because they do the same as "dl" and
8657 "dh". If you use this, you may also want to use the mapping
8658 ":map <BS> X" to make backspace delete the character in front of the
8659 cursor.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00008660 When 'l' is included and it is used after an operator at the end of a
Bram Moolenaar589edb32019-09-20 14:38:13 +02008661 line (not an empty line) then it will not move to the next line. This
8662 makes "dl", "cl", "yl" etc. work normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008663 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 *'wildchar'* *'wc'*
8667'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
8668 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008669 Character you have to type to start wildcard expansion in the
8670 command-line, as specified with 'wildmode'.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008671 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008672 The character is not recognized when used inside a macro. See
8673 'wildcharm' for that.
8674 Although 'wc' is a number option, you can set it to a special key: >
8675 :set wc=<Esc>
8676< NOTE: This option is set to the Vi default value when 'compatible' is
8677 set and to the Vim default value when 'compatible' is reset.
8678
8679 *'wildcharm'* *'wcm'*
8680'wildcharm' 'wcm' number (default: none (0))
8681 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008682 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00008683 recognized when used inside a macro. You can find "spare" command-line
8684 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00008685 you'll never actually type 'wildcharm', just use it in mappings that
8686 automatically invoke completion mode, e.g.: >
8687 :set wcm=<C-Z>
Bram Moolenaar446cb832008-06-24 21:56:24 +00008688 :cnoremap ss so $vim/sessions/*.vim<C-Z>
Bram Moolenaar071d4272004-06-13 20:20:40 +00008689< Then after typing :ss you can use CTRL-P & CTRL-N.
8690
8691 *'wildignore'* *'wig'*
8692'wildignore' 'wig' string (default "")
8693 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008694 {not available when compiled without the |+wildignore|
8695 feature}
8696 A list of file patterns. A file that matches with one of these
Bram Moolenaar30b65812012-07-12 22:01:11 +02008697 patterns is ignored when expanding |wildcards|, completing file or
8698 directory names, and influences the result of |expand()|, |glob()| and
8699 |globpath()| unless a flag is passed to disable this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008700 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
8701 Also see 'suffixes'.
8702 Example: >
8703 :set wildignore=*.o,*.obj
8704< The use of |:set+=| and |:set-=| is preferred when adding or removing
8705 a pattern from the list. This avoids problems when a future version
8706 uses another default.
8707
Bram Moolenaar94950a92010-12-02 16:01:29 +01008708
Bram Moolenaar81af9252010-12-10 20:35:50 +01008709 *'wildignorecase'* *'wic'* *'nowildignorecase'* *'nowic'*
Bram Moolenaar94950a92010-12-02 16:01:29 +01008710'wildignorecase' 'wic' boolean (default off)
8711 global
Bram Moolenaar94950a92010-12-02 16:01:29 +01008712 When set case is ignored when completing file names and directories.
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01008713 Has no effect when 'fileignorecase' is set.
Bram Moolenaar94950a92010-12-02 16:01:29 +01008714 Does not apply when the shell is used to expand wildcards, which
8715 happens when there are special characters.
8716
8717
Bram Moolenaar071d4272004-06-13 20:20:40 +00008718 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02008719'wildmenu' 'wmnu' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008720 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008721 {not available if compiled without the |+wildmenu|
8722 feature}
8723 When 'wildmenu' is on, command-line completion operates in an enhanced
8724 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
8725 the possible matches are shown just above the command line, with the
8726 first match highlighted (overwriting the status line, if there is
8727 one). Keys that show the previous/next match, such as <Tab> or
8728 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
8729 When 'wildmode' is used, "wildmenu" mode is used where "full" is
8730 specified. "longest" and "list" do not start "wildmenu" mode.
Bram Moolenaar26402cb2013-02-20 21:26:00 +01008731 You can check the current mode with |wildmenumode()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008732 If there are more matches than can fit in the line, a ">" is shown on
8733 the right and/or a "<" is shown on the left. The status line scrolls
8734 as needed.
8735 The "wildmenu" mode is abandoned when a key is hit that is not used
8736 for selecting a completion.
8737 While the "wildmenu" is active the following keys have special
8738 meanings:
8739
8740 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
8741 <Down> - in filename/menu name completion: move into a
8742 subdirectory or submenu.
8743 <CR> - in menu completion, when the cursor is just after a
8744 dot: move into a submenu.
8745 <Up> - in filename/menu name completion: move up into
8746 parent directory or parent menu.
8747
8748 This makes the menus accessible from the console |console-menus|.
8749
8750 If you prefer the <Left> and <Right> keys to move the cursor instead
8751 of selecting a different match, use this: >
8752 :cnoremap <Left> <Space><BS><Left>
8753 :cnoremap <Right> <Space><BS><Right>
8754<
8755 The "WildMenu" highlighting is used for displaying the current match
8756 |hl-WildMenu|.
8757
8758 *'wildmode'* *'wim'*
8759'wildmode' 'wim' string (Vim default: "full")
8760 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008761 Completion mode that is used for the character specified with
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008762 'wildchar'. It is a comma separated list of up to four parts. Each
Bram Moolenaar02467872007-05-06 13:22:01 +00008763 part specifies what to do for each consecutive use of 'wildchar'. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00008764 first part specifies the behavior for the first use of 'wildchar',
8765 The second part for the second use, etc.
8766 These are the possible values for each part:
8767 "" Complete only the first match.
8768 "full" Complete the next full match. After the last match,
8769 the original string is used and then the first match
8770 again.
8771 "longest" Complete till longest common string. If this doesn't
8772 result in a longer string, use the next part.
8773 "longest:full" Like "longest", but also start 'wildmenu' if it is
8774 enabled.
8775 "list" When more than one match, list all matches.
8776 "list:full" When more than one match, list all matches and
8777 complete first match.
8778 "list:longest" When more than one match, list all matches and
8779 complete till longest common string.
Bram Moolenaar52410572019-10-27 05:12:45 +01008780 "list:lastused" When more than one buffer matches, sort buffers
8781 by time last used (other than the current buffer).
Bram Moolenaar071d4272004-06-13 20:20:40 +00008782 When there is only a single match, it is fully completed in all cases.
8783
8784 Examples: >
8785 :set wildmode=full
Bram Moolenaar582fd852005-03-28 20:58:01 +00008786< Complete first full match, next match, etc. (the default) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008787 :set wildmode=longest,full
8788< Complete longest common string, then each full match >
8789 :set wildmode=list:full
8790< List all matches and complete each full match >
8791 :set wildmode=list,full
8792< List all matches without completing, then each full match >
8793 :set wildmode=longest,list
8794< Complete longest common string, then list alternatives.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008795 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008796
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00008797 *'wildoptions'* *'wop'*
8798'wildoptions' 'wop' string (default "")
8799 global
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00008800 {not available when compiled without the |+wildignore|
8801 feature}
8802 A list of words that change how command line completion is done.
8803 Currently only one word is allowed:
8804 tagfile When using CTRL-D to list matching tags, the kind of
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00008805 tag and the file of the tag is listed. Only one match
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00008806 is displayed per line. Often used tag kinds are:
8807 d #define
8808 f function
8809 Also see |cmdline-completion|.
8810
Bram Moolenaar071d4272004-06-13 20:20:40 +00008811 *'winaltkeys'* *'wak'*
8812'winaltkeys' 'wak' string (default "menu")
8813 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008814 {only used in Win32, Motif, GTK and Photon GUI}
8815 Some GUI versions allow the access to menu entries by using the ALT
8816 key in combination with a character that appears underlined in the
8817 menu. This conflicts with the use of the ALT key for mappings and
8818 entering special characters. This option tells what to do:
8819 no Don't use ALT keys for menus. ALT key combinations can be
8820 mapped, but there is no automatic handling. This can then be
8821 done with the |:simalt| command.
8822 yes ALT key handling is done by the windowing system. ALT key
8823 combinations cannot be mapped.
8824 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008825 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00008826 keys can be mapped.
8827 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
8828 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00008829 This option is not used for <F10>; on Win32 and with GTK <F10> will
8830 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008831
Bram Moolenaar4d784b22019-05-25 19:51:39 +02008832 *'wincolor'* *'wcr'*
8833'wincolor' 'wcr' string (default empty)
8834 local to window
8835 Highlight group name to use for this window instead of the Normal
8836 color |hl-Normal|.
8837
Bram Moolenaar4399ef42005-02-12 14:29:27 +00008838 *'window'* *'wi'*
8839'window' 'wi' number (default screen height - 1)
8840 global
8841 Window height. Do not confuse this with the height of the Vim window,
8842 use 'lines' for that.
Bram Moolenaar19a09a12005-03-04 23:39:37 +00008843 Used for |CTRL-F| and |CTRL-B| when there is only one window and the
8844 value is smaller than 'lines' minus one. The screen will scroll
8845 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00008846 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
8847 in a much smarter way, taking care of wrapping lines.
8848 When resizing the Vim window, the value is smaller than 1 or more than
8849 or equal to 'lines' it will be set to 'lines' minus 1.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00008850
Bram Moolenaar071d4272004-06-13 20:20:40 +00008851 *'winheight'* *'wh'* *E591*
8852'winheight' 'wh' number (default 1)
8853 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008854 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008855 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar446cb832008-06-24 21:56:24 +00008856 focus goes to a window that is smaller, its size is increased, at the
8857 cost of the height of other windows.
8858 Set 'winheight' to a small number for normal editing.
8859 Set it to 999 to make the current window fill most of the screen.
8860 Other windows will be only 'winminheight' high. This has the drawback
8861 that ":all" will create only two windows. To avoid "vim -o 1 2 3 4"
8862 to create only two windows, set the option after startup is done,
8863 using the |VimEnter| event: >
8864 au VimEnter * set winheight=999
8865< Minimum value is 1.
8866 The height is not adjusted after one of the commands that change the
Bram Moolenaar071d4272004-06-13 20:20:40 +00008867 height of the current window.
8868 'winheight' applies to the current window. Use 'winminheight' to set
8869 the minimal height for other windows.
8870
8871 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
8872'winfixheight' 'wfh' boolean (default off)
8873 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00008874 Keep the window height when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00008875 'equalalways' is set. Also for |CTRL-W_=|. Set by default for the
8876 |preview-window| and |quickfix-window|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008877 The height may be changed anyway when running out of room.
8878
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008879 *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'*
8880'winfixwidth' 'wfw' boolean (default off)
8881 local to window
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008882 Keep the window width when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00008883 'equalalways' is set. Also for |CTRL-W_=|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008884 The width may be changed anyway when running out of room.
8885
Bram Moolenaar071d4272004-06-13 20:20:40 +00008886 *'winminheight'* *'wmh'*
8887'winminheight' 'wmh' number (default 1)
8888 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008889 The minimal height 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 lines (i.e. just a
8892 status bar) if necessary. They will return to at least one line when
8893 they become active (since the cursor has to have somewhere to go.)
8894 Use 'winheight' to set the minimal height of the current window.
8895 This option is only checked when making a window smaller. Don't use a
8896 large number, it will cause errors when opening more than a few
8897 windows. A value of 0 to 3 is reasonable.
8898
8899 *'winminwidth'* *'wmw'*
8900'winminwidth' 'wmw' number (default 1)
8901 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008902 The minimal width of a window, when it's not the current window.
8903 This is a hard minimum, windows will never become smaller.
8904 When set to zero, windows may be "squashed" to zero columns (i.e. just
8905 a vertical separator) if necessary. They will return to at least one
8906 line when they become active (since the cursor has to have somewhere
8907 to go.)
8908 Use 'winwidth' to set the minimal width of the current window.
8909 This option is only checked when making a window smaller. Don't use a
8910 large number, it will cause errors when opening more than a few
8911 windows. A value of 0 to 12 is reasonable.
8912
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02008913 *'winptydll'*
8914'winptydll' string (default "winpty32.dll" or "winpty64.dll")
8915 global
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02008916 {only available when compiled with the |terminal|
8917 feature on MS-Windows}
8918 Specifies the name of the winpty shared library, used for the
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02008919 |:terminal| command. The default depends on whether Vim was built as a
Bram Moolenaarc572da52017-08-27 16:52:01 +02008920 32-bit or 64-bit executable. If not found, "winpty.dll" is tried as
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02008921 a fallback.
8922 Environment variables are expanded |:set_env|.
8923 This option cannot be set from a |modeline| or in the |sandbox|, for
8924 security reasons.
8925
Bram Moolenaar071d4272004-06-13 20:20:40 +00008926 *'winwidth'* *'wiw'* *E592*
8927'winwidth' 'wiw' number (default 20)
8928 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008929 Minimal number of columns for the current window. This is not a hard
8930 minimum, Vim will use fewer columns if there is not enough room. If
8931 the current window is smaller, its size is increased, at the cost of
8932 the width of other windows. Set it to 999 to make the current window
8933 always fill the screen. Set it to a small number for normal editing.
8934 The width is not adjusted after one of the commands to change the
8935 width of the current window.
8936 'winwidth' applies to the current window. Use 'winminwidth' to set
8937 the minimal width for other windows.
8938
8939 *'wrap'* *'nowrap'*
8940'wrap' boolean (default on)
8941 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00008942 This option changes how text is displayed. It doesn't change the text
8943 in the buffer, see 'textwidth' for that.
8944 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008945 displaying continues on the next line. When off lines will not wrap
8946 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00008947 moved to a part that is not shown, the screen will scroll
8948 horizontally.
8949 The line will be broken in the middle of a word if necessary. See
8950 'linebreak' to get the break at a word boundary.
8951 To make scrolling horizontally a bit more useful, try this: >
8952 :set sidescroll=5
8953 :set listchars+=precedes:<,extends:>
8954< See 'sidescroll', 'listchars' and |wrap-off|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01008955 This option can't be set from a |modeline| when the 'diff' option is
8956 on.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008957
8958 *'wrapmargin'* *'wm'*
8959'wrapmargin' 'wm' number (default 0)
8960 local to buffer
8961 Number of characters from the right window border where wrapping
8962 starts. When typing text beyond this limit, an <EOL> will be inserted
8963 and inserting continues on the next line.
8964 Options that add a margin, such as 'number' and 'foldcolumn', cause
8965 the text width to be further reduced. This is Vi compatible.
8966 When 'textwidth' is non-zero, this option is not used.
Bram Moolenaarca635012015-09-25 20:34:21 +02008967 This option is set to 0 when 'paste' is set and restored when 'paste'
8968 is reset.
Bram Moolenaara6c27c42019-05-09 19:16:22 +02008969 See also 'formatoptions' and |ins-textwidth|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008970
8971 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
8972'wrapscan' 'ws' boolean (default on) *E384* *E385*
8973 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00008974 Searches wrap around the end of the file. Also applies to |]s| and
8975 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008976
8977 *'write'* *'nowrite'*
8978'write' boolean (default on)
8979 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008980 Allows writing files. When not set, writing a file is not allowed.
8981 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008982 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00008983 argument. Filtering text is still possible, even though this requires
8984 writing a temporary file.
8985
8986 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
8987'writeany' 'wa' boolean (default off)
8988 global
8989 Allows writing to any file with no need for "!" override.
8990
8991 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
8992'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
8993 otherwise)
8994 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008995 Make a backup before overwriting a file. The backup is removed after
8996 the file was successfully written, unless the 'backup' option is
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02008997 also on.
8998 WARNING: Switching this option off means that when Vim fails to write
8999 your buffer correctly and then, for whatever reason, Vim exits, you
9000 lose both the original file and what you were writing. Only reset
9001 this option if your file system is almost full and it makes the write
9002 fail (and make sure not to exit Vim until the write was successful).
9003 See |backup-table| for another explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009004 When the 'backupskip' pattern matches, a backup is not made anyway.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01009005 Depending on 'backupcopy' the backup is a new file or the original
9006 file renamed (and a new file is written).
Bram Moolenaar071d4272004-06-13 20:20:40 +00009007 NOTE: This option is set to the default value when 'compatible' is
9008 set.
9009
9010 *'writedelay'* *'wd'*
9011'writedelay' 'wd' number (default 0)
9012 global
Bram Moolenaar802a0d92016-06-26 16:17:58 +02009013 The number of milliseconds to wait for each character sent to the
Bram Moolenaar071d4272004-06-13 20:20:40 +00009014 screen. When non-zero, characters are sent to the terminal one by
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01009015 one. For debugging purposes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009016
Bram Moolenaar91f84f62018-07-29 15:07:52 +02009017 vim:tw=78:ts=8:noet:ft=help:norl: