blob: ee5ee26b451a8cfa249a2919401f60968a66a440 [file] [log] [blame]
Bram Moolenaar942db232021-02-13 18:14:48 +01001*options.txt* For Vim version 8.2. Last change: 2021 Feb 13
Bram Moolenaar071d4272004-06-13 20:20:40 +00002
3
4 VIM REFERENCE MANUAL by Bram Moolenaar
5
6
7Options *options*
8
91. Setting options |set-option|
102. Automatically setting options |auto-setting|
113. Options summary |option-summary|
12
Bram Moolenaar2ec618c2016-10-01 14:47:05 +020013For an overview of options see quickref.txt |option-list|.
Bram Moolenaar071d4272004-06-13 20:20:40 +000014
15Vim has a number of internal variables and switches which can be set to
16achieve special effects. These options come in three forms:
17 boolean can only be on or off *boolean* *toggle*
18 number has a numeric value
19 string has a string value
20
21==============================================================================
Bram Moolenaarf75a9632005-09-13 21:20:47 +0000221. Setting options *set-option* *E764*
Bram Moolenaar071d4272004-06-13 20:20:40 +000023
24 *:se* *:set*
Bram Moolenaar6b915c02020-01-18 15:53:19 +010025:se[t][!] Show all options that differ from their default value.
26 When [!] is present every option is on a separate
27 line.
Bram Moolenaar071d4272004-06-13 20:20:40 +000028
Bram Moolenaar6b915c02020-01-18 15:53:19 +010029:se[t][!] all Show all but terminal options.
30 When [!] is present every option is on a separate
31 line.
Bram Moolenaar071d4272004-06-13 20:20:40 +000032
33:se[t] termcap Show all terminal options. Note that in the GUI the
34 key codes are not shown, because they are generated
35 internally and can't be changed. Changing the terminal
36 codes in the GUI is not useful either...
37
38 *E518* *E519*
39:se[t] {option}? Show value of {option}.
40
41:se[t] {option} Toggle option: set, switch it on.
42 Number option: show value.
43 String option: show value.
44
45:se[t] no{option} Toggle option: Reset, switch it off.
46
Bram Moolenaar00a927d2010-05-14 23:24:24 +020047 *:set-!* *:set-inv*
Bram Moolenaar071d4272004-06-13 20:20:40 +000048:se[t] {option}! or
Bram Moolenaar6c60f472019-04-28 16:00:35 +020049:se[t] inv{option} Toggle option: Invert value.
Bram Moolenaar071d4272004-06-13 20:20:40 +000050
51 *:set-default* *:set-&* *:set-&vi* *:set-&vim*
52:se[t] {option}& Reset option to its default value. May depend on the
Bram Moolenaar6c60f472019-04-28 16:00:35 +020053 current value of 'compatible'.
54:se[t] {option}&vi Reset option to its Vi default value.
55:se[t] {option}&vim Reset option to its Vim default value.
Bram Moolenaar071d4272004-06-13 20:20:40 +000056
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +010057:se[t] all& Set all options to their default value. The values of
Bram Moolenaar88774fd2015-08-25 19:52:04 +020058 these options are not changed:
59 all terminal options, starting with t_
60 'columns'
61 'cryptmethod'
62 'encoding'
63 'key'
64 'lines'
65 'term'
66 'ttymouse'
67 'ttytype'
68 Warning: This may have a lot of side effects.
Bram Moolenaar071d4272004-06-13 20:20:40 +000069
70 *:set-args* *E487* *E521*
71:se[t] {option}={value} or
72:se[t] {option}:{value}
73 Set string or number option to {value}.
74 For numeric options the value can be given in decimal,
Bram Moolenaar3848e002016-03-19 18:42:29 +010075 hex (preceded with 0x) or octal (preceded with '0').
Bram Moolenaar071d4272004-06-13 20:20:40 +000076 The old value can be inserted by typing 'wildchar' (by
77 default this is a <Tab> or CTRL-E if 'compatible' is
78 set). See |cmdline-completion|.
79 White space between {option} and '=' is allowed and
80 will be ignored. White space between '=' and {value}
81 is not allowed.
82 See |option-backslash| for using white space and
83 backslashes in {value}.
84
85:se[t] {option}+={value} *:set+=*
86 Add the {value} to a number option, or append the
87 {value} to a string option. When the option is a
88 comma separated list, a comma is added, unless the
89 value was empty.
90 If the option is a list of flags, superfluous flags
Bram Moolenaara5792f52005-11-23 21:25:05 +000091 are removed. When adding a flag that was already
92 present the option value doesn't change.
Bram Moolenaar899dddf2006-03-26 21:06:50 +000093 Also see |:set-args| above.
Bram Moolenaar071d4272004-06-13 20:20:40 +000094
95:se[t] {option}^={value} *:set^=*
96 Multiply the {value} to a number option, or prepend
97 the {value} to a string option. When the option is a
98 comma separated list, a comma is added, unless the
99 value was empty.
100 Also see |:set-args| above.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000101
102:se[t] {option}-={value} *:set-=*
103 Subtract the {value} from a number option, or remove
104 the {value} from a string option, if it is there.
105 If the {value} is not found in a string option, there
106 is no error or warning. When the option is a comma
107 separated list, a comma is deleted, unless the option
108 becomes empty.
109 When the option is a list of flags, {value} must be
110 exactly as they appear in the option. Remove flags
111 one by one to avoid problems.
112 Also see |:set-args| above.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000113
114The {option} arguments to ":set" may be repeated. For example: >
115 :set ai nosi sw=3 ts=3
116If you make an error in one of the arguments, an error message will be given
117and the following arguments will be ignored.
118
119 *:set-verbose*
120When 'verbose' is non-zero, displaying an option value will also tell where it
121was last set. Example: >
122 :verbose set shiftwidth cindent?
Bram Moolenaar95bafa22018-10-02 13:26:25 +0200123< shiftwidth=4 ~
124 Last set from modeline line 1 ~
125 cindent ~
126 Last set from /usr/local/share/vim/vim60/ftplugin/c.vim line 30 ~
Bram Moolenaar446cb832008-06-24 21:56:24 +0000127This is only done when specific option values are requested, not for ":verbose
128set all" or ":verbose set" without an argument.
129When the option was set by hand there is no "Last set" message.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000130When the option was set while executing a function, user command or
131autocommand, the script in which it was defined is reported.
132Note that an option may also have been set as a side effect of setting
133'compatible'.
Bram Moolenaar446cb832008-06-24 21:56:24 +0000134A few special texts:
Bram Moolenaar95bafa22018-10-02 13:26:25 +0200135 Last set from modeline line 1 ~
Bram Moolenaar446cb832008-06-24 21:56:24 +0000136 Option was set in a |modeline|.
137 Last set from --cmd argument ~
138 Option was set with command line argument |--cmd| or +.
139 Last set from -c argument ~
140 Option was set with command line argument |-c|, +, |-S| or
141 |-q|.
142 Last set from environment variable ~
143 Option was set from an environment variable, $VIMINIT,
144 $GVIMINIT or $EXINIT.
145 Last set from error handler ~
146 Option was cleared when evaluating it resulted in an error.
147
Bram Moolenaardb84e452010-08-15 13:50:43 +0200148{not available when compiled without the |+eval| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000149
150 *:set-termcap* *E522*
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +0000151For {option} the form "t_xx" may be used to set a terminal option. This will
Bram Moolenaar071d4272004-06-13 20:20:40 +0000152override the value from the termcap. You can then use it in a mapping. If
153the "xx" part contains special characters, use the <t_xx> form: >
154 :set <t_#4>=^[Ot
155This can also be used to translate a special code for a normal key. For
156example, if Alt-b produces <Esc>b, use this: >
157 :set <M-b>=^[b
158(the ^[ is a real <Esc> here, use CTRL-V <Esc> to enter it)
159The advantage over a mapping is that it works in all situations.
160
Bram Moolenaar0b2f94d2011-03-22 14:35:05 +0100161You can define any key codes, e.g.: >
162 :set t_xy=^[foo;
163There is no warning for using a name that isn't recognized. You can map these
164codes as you like: >
165 :map <t_xy> something
166< *E846*
167When a key code is not set, it's like it does not exist. Trying to get its
168value will result in an error: >
169 :set t_kb=
170 :set t_kb
171 E846: Key code not set: t_kb
172
Bram Moolenaar293ee4d2004-12-09 21:34:53 +0000173The t_xx options cannot be set from a |modeline| or in the |sandbox|, for
174security reasons.
175
Bram Moolenaar071d4272004-06-13 20:20:40 +0000176The listing from ":set" looks different from Vi. Long string options are put
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000177at the end of the list. The number of options is quite large. The output of
Bram Moolenaar071d4272004-06-13 20:20:40 +0000178"set all" probably does not fit on the screen, causing Vim to give the
179|more-prompt|.
180
181 *option-backslash*
182To include white space in a string option value it has to be preceded with a
183backslash. To include a backslash you have to use two. Effectively this
184means that the number of backslashes in an option value is halved (rounded
185down).
186A few examples: >
187 :set tags=tags\ /usr/tags results in "tags /usr/tags"
188 :set tags=tags\\,file results in "tags\,file"
189 :set tags=tags\\\ file results in "tags\ file"
190
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000191The "|" character separates a ":set" command from a following command. To
192include the "|" in the option value, use "\|" instead. This example sets the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000193'titlestring' option to "hi|there": >
194 :set titlestring=hi\|there
195This sets the 'titlestring' option to "hi" and 'iconstring' to "there": >
196 :set titlestring=hi|set iconstring=there
197
Bram Moolenaar7df351e2006-01-23 22:30:28 +0000198Similarly, the double quote character starts a comment. To include the '"' in
199the option value, use '\"' instead. This example sets the 'titlestring'
200option to 'hi "there"': >
201 :set titlestring=hi\ \"there\"
202
Bram Moolenaar5666fcd2019-12-26 14:35:26 +0100203For Win32 backslashes in file names are mostly not removed. More precise: For
204options that expect a file name (those where environment variables are
205expanded) a backslash before a normal file name character is not removed. But
206a backslash before a special character (space, backslash, comma, etc.) is used
207like explained above.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000208There is one special situation, when the value starts with "\\": >
209 :set dir=\\machine\path results in "\\machine\path"
210 :set dir=\\\\machine\\path results in "\\machine\path"
211 :set dir=\\path\\file results in "\\path\file" (wrong!)
212For the first one the start is kept, but for the second one the backslashes
213are halved. This makes sure it works both when you expect backslashes to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000214halved and when you expect the backslashes to be kept. The third gives a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000215result which is probably not what you want. Avoid it.
216
217 *add-option-flags* *remove-option-flags*
218 *E539* *E550* *E551* *E552*
219Some options are a list of flags. When you want to add a flag to such an
220option, without changing the existing ones, you can do it like this: >
221 :set guioptions+=a
222Remove a flag from an option like this: >
223 :set guioptions-=a
224This removes the 'a' flag from 'guioptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000225Note that you should add or remove one flag at a time. If 'guioptions' has
Bram Moolenaar071d4272004-06-13 20:20:40 +0000226the value "ab", using "set guioptions-=ba" won't work, because the string "ba"
227doesn't appear.
228
229 *:set_env* *expand-env* *expand-environment-var*
Bram Moolenaard4755bb2004-09-02 19:12:26 +0000230Environment variables in specific string options will be expanded. If the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000231environment variable exists the '$' and the following environment variable
232name is replaced with its value. If it does not exist the '$' and the name
233are not modified. Any non-id character (not a letter, digit or '_') may
234follow the environment variable name. That character and what follows is
235appended to the value of the environment variable. Examples: >
236 :set term=$TERM.new
237 :set path=/usr/$INCLUDE,$HOME/include,.
238When adding or removing a string from an option with ":set opt-=val" or ":set
239opt+=val" the expansion is done before the adding or removing.
240
241
242Handling of local options *local-options*
243
244Some of the options only apply to a window or buffer. Each window or buffer
Bram Moolenaar51628222016-12-01 23:03:28 +0100245has its own copy of this option, thus each can have its own value. This
Bram Moolenaar071d4272004-06-13 20:20:40 +0000246allows you to set 'list' in one window but not in another. And set
247'shiftwidth' to 3 in one buffer and 4 in another.
248
249The following explains what happens to these local options in specific
250situations. You don't really need to know all of this, since Vim mostly uses
251the option values you would expect. Unfortunately, doing what the user
252expects is a bit complicated...
253
254When splitting a window, the local options are copied to the new window. Thus
255right after the split the contents of the two windows look the same.
256
257When editing a new buffer, its local option values must be initialized. Since
258the local options of the current buffer might be specifically for that buffer,
259these are not used. Instead, for each buffer-local option there also is a
260global value, which is used for new buffers. With ":set" both the local and
261global value is changed. With "setlocal" only the local value is changed,
262thus this value is not used when editing a new buffer.
263
Bram Moolenaar95ec9d62016-08-12 18:29:59 +0200264When editing a buffer that has been edited before, the options from the window
265that was last closed are used again. If this buffer has been edited in this
266window, the values from back then are used. Otherwise the values from the
267last closed window where the buffer was edited last are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000268
269It's possible to set a local window option specifically for a type of buffer.
270When you edit another buffer in the same window, you don't want to keep
271using these local window options. Therefore Vim keeps a global value of the
272local window options, which is used when editing another buffer. Each window
273has its own copy of these values. Thus these are local to the window, but
274global to all buffers in the window. With this you can do: >
275 :e one
276 :set list
277 :e two
278Now the 'list' option will also be set in "two", since with the ":set list"
279command you have also set the global value. >
280 :set nolist
281 :e one
282 :setlocal list
283 :e two
284Now the 'list' option is not set, because ":set nolist" resets the global
285value, ":setlocal list" only changes the local value and ":e two" gets the
286global value. Note that if you do this next: >
287 :e one
Bram Moolenaar531da592013-05-06 05:58:55 +0200288You will get back the 'list' value as it was the last time you edited "one".
289The options local to a window are remembered for each buffer. This also
290happens when the buffer is not loaded, but they are lost when the buffer is
291wiped out |:bwipe|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000292
293 *:setl* *:setlocal*
Bram Moolenaar6b915c02020-01-18 15:53:19 +0100294:setl[ocal][!] ... Like ":set" but set only the value local to the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000295 current buffer or window. Not all options have a
296 local value. If the option does not have a local
297 value the global value is set.
Bram Moolenaarc3301872010-07-25 20:53:06 +0200298 With the "all" argument: display local values for all
299 local options.
300 Without argument: Display local values for all local
301 options which are different from the default.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000302 When displaying a specific local option, show the
Bram Moolenaar446cb832008-06-24 21:56:24 +0000303 local value. For a global/local boolean option, when
304 the global value is being used, "--" is displayed
305 before the option name.
306 For a global option the global value is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000307 shown (but that might change in the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000308
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000309:setl[ocal] {option}< Set the local value of {option} to its global value by
310 copying the value.
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000311
Bram Moolenaar6be7f872012-01-20 21:08:56 +0100312:se[t] {option}< For |global-local| options: Remove the local value of
313 {option}, so that the global value will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000314
315 *:setg* *:setglobal*
Bram Moolenaar6b915c02020-01-18 15:53:19 +0100316:setg[lobal][!] ... Like ":set" but set only the global value for a local
Bram Moolenaar071d4272004-06-13 20:20:40 +0000317 option without changing the local value.
318 When displaying an option, the global value is shown.
Bram Moolenaarc3301872010-07-25 20:53:06 +0200319 With the "all" argument: display global values for all
320 local options.
321 Without argument: display global values for all local
322 options which are different from the default.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000323
324For buffer-local and window-local options:
325 Command global value local value ~
326 :set option=value set set
327 :setlocal option=value - set
328:setglobal option=value set -
329 :set option? - display
330 :setlocal option? - display
331:setglobal option? display -
332
333
334Global options with a local value *global-local*
335
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +0000336Options are global when you mostly use one value for all buffers and windows.
337For some global options it's useful to sometimes have a different local value.
338You can set the local value with ":setlocal". That buffer or window will then
339use the local value, while other buffers and windows continue using the global
340value.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000341
342For example, you have two windows, both on C source code. They use the global
343'makeprg' option. If you do this in one of the two windows: >
344 :set makeprg=gmake
345then the other window will switch to the same value. There is no need to set
346the 'makeprg' option in the other C source window too.
347However, if you start editing a Perl file in a new window, you want to use
Bram Moolenaar02467872007-05-06 13:22:01 +0000348another 'makeprg' for it, without changing the value used for the C source
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000349files. You use this command: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000350 :setlocal makeprg=perlmake
351You can switch back to using the global value by making the local value empty: >
352 :setlocal makeprg=
Bram Moolenaar314dd792019-02-03 15:27:20 +0100353This only works for a string option. For a number or boolean option you need
354to use the "<" flag, like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000355 :setlocal autoread<
Bram Moolenaar314dd792019-02-03 15:27:20 +0100356Note that for non-boolean and non-number options using "<" copies the global
357value to the local value, it doesn't switch back to using the global value
358(that matters when the global value changes later). You can also use: >
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000359 :set path<
360This will make the local value of 'path' empty, so that the global value is
361used. Thus it does the same as: >
362 :setlocal path=
Bram Moolenaar071d4272004-06-13 20:20:40 +0000363Note: In the future more global options can be made global-local. Using
364":setlocal" on a global option might work differently then.
365
366
367Setting the filetype
368
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200369:setf[iletype] [FALLBACK] {filetype} *:setf* *:setfiletype*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000370 Set the 'filetype' option to {filetype}, but only if
371 not done yet in a sequence of (nested) autocommands.
372 This is short for: >
373 :if !did_filetype()
374 : setlocal filetype={filetype}
375 :endif
376< This command is used in a filetype.vim file to avoid
377 setting the 'filetype' option twice, causing different
378 settings and syntax files to be loaded.
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200379
380 When the optional FALLBACK argument is present, a
381 later :setfiletype command will override the
Bram Moolenaar26967612019-03-17 17:13:16 +0100382 'filetype'. This is to be used for filetype
383 detections that are just a guess. |did_filetype()|
384 will return false after this command.
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200385
Bram Moolenaard58e9292011-02-09 17:07:58 +0100386 *option-window* *optwin*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000387:bro[wse] se[t] *:set-browse* *:browse-set* *:opt* *:options*
388:opt[ions] Open a window for viewing and setting all options.
389 Options are grouped by function.
390 Offers short help for each option. Hit <CR> on the
391 short help to open a help window with more help for
392 the option.
393 Modify the value of the option and hit <CR> on the
394 "set" line to set the new value. For window and
395 buffer specific options, the last accessed window is
396 used to set the option value in, unless this is a help
397 window, in which case the window below help window is
398 used (skipping the option-window).
Bram Moolenaarb5b75622018-03-09 22:22:21 +0100399 {not available when compiled without the |+eval|
400 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000401
402 *$HOME*
403Using "~" is like using "$HOME", but it is only recognized at the start of an
404option and after a space or comma.
405
406On Unix systems "~user" can be used too. It is replaced by the home directory
407of user "user". Example: >
408 :set path=~mool/include,/usr/include,.
409
410On Unix systems the form "${HOME}" can be used too. The name between {} can
411contain non-id characters then. Note that if you want to use this for the
412"gf" command, you need to add the '{' and '}' characters to 'isfname'.
413
414NOTE: expanding environment variables and "~/" is only done with the ":set"
415command, not when assigning a value to an option with ":let".
416
Bram Moolenaarc572da52017-08-27 16:52:01 +0200417 *$HOME-windows*
418On MS-Windows, if $HOME is not defined as an environment variable, then
419at runtime Vim will set it to the expansion of $HOMEDRIVE$HOMEPATH.
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200420If $HOMEDRIVE is not set then $USERPROFILE is used.
421
422This expanded value is not exported to the environment, this matters when
423running an external command: >
424 :echo system('set | findstr ^HOME=')
425and >
426 :echo luaeval('os.getenv("HOME")')
427should echo nothing (an empty string) despite exists('$HOME') being true.
428When setting $HOME to a non-empty string it will be exported to the
429subprocesses.
Bram Moolenaarc572da52017-08-27 16:52:01 +0200430
Bram Moolenaar071d4272004-06-13 20:20:40 +0000431
432Note the maximum length of an expanded option is limited. How much depends on
433the system, mostly it is something like 256 or 1024 characters.
434
435 *:fix* *:fixdel*
436:fix[del] Set the value of 't_kD':
437 't_kb' is 't_kD' becomes ~
438 CTRL-? CTRL-H
439 not CTRL-? CTRL-?
440
Bram Moolenaar82be4842021-01-11 19:40:15 +0100441 (CTRL-? is 0o177 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.
Bram Moolenaar942db232021-02-13 18:14:48 +01001571 Note: if one of the items is "exclude:", then you can't add an item
1572 after that. Therefore do append an item with += but use ^= to
1573 prepend, e.g.: >
1574 set clipboard^=unnamed
1575< These names are recognized:
Bram Moolenaar071d4272004-06-13 20:20:40 +00001576
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001577 *clipboard-unnamed*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001578 unnamed When included, Vim will use the clipboard register '*'
1579 for all yank, delete, change and put operations which
1580 would normally go to the unnamed register. When a
1581 register is explicitly specified, it will always be
1582 used regardless of whether "unnamed" is in 'clipboard'
1583 or not. The clipboard register can always be
1584 explicitly accessed using the "* notation. Also see
1585 |gui-clipboard|.
1586
Bram Moolenaar30b65812012-07-12 22:01:11 +02001587 *clipboard-unnamedplus*
Bram Moolenaar00154502013-02-13 16:15:55 +01001588 unnamedplus A variant of the "unnamed" flag which uses the
1589 clipboard register '+' (|quoteplus|) instead of
1590 register '*' for all yank, delete, change and put
1591 operations which would normally go to the unnamed
1592 register. When "unnamed" is also included to the
1593 option, yank operations (but not delete, change or
1594 put) will additionally copy the text into register
1595 '*'.
Bram Moolenaar81af9252010-12-10 20:35:50 +01001596 Only available with the |+X11| feature.
Bram Moolenaarbf9680e2010-12-02 21:43:16 +01001597 Availability can be checked with: >
1598 if has('unnamedplus')
1599<
Bram Moolenaar30b65812012-07-12 22:01:11 +02001600 *clipboard-autoselect*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001601 autoselect Works like the 'a' flag in 'guioptions': If present,
1602 then whenever Visual mode is started, or the Visual
1603 area extended, Vim tries to become the owner of the
1604 windowing system's global selection or put the
1605 selected text on the clipboard used by the selection
Bram Moolenaarba3ff532018-11-04 14:45:49 +01001606 register "*. See |'go-a'| and |quotestar| for details.
1607 When the GUI is active, the 'a' flag in 'guioptions'
1608 is used, when the GUI is not active, this "autoselect"
1609 flag is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001610 Also applies to the modeless selection.
1611
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001612 *clipboard-autoselectplus*
1613 autoselectplus Like "autoselect" but using the + register instead of
1614 the * register. Compare to the 'P' flag in
1615 'guioptions'.
1616
1617 *clipboard-autoselectml*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001618 autoselectml Like "autoselect", but for the modeless selection
1619 only. Compare to the 'A' flag in 'guioptions'.
1620
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001621 *clipboard-html*
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001622 html When the clipboard contains HTML, use this when
1623 pasting. When putting text on the clipboard, mark it
1624 as HTML. This works to copy rendered HTML from
1625 Firefox, paste it as raw HTML in Vim, select the HTML
1626 in Vim and paste it in a rich edit box in Firefox.
Bram Moolenaar20a825a2010-05-31 21:27:30 +02001627 You probably want to add this only temporarily,
1628 possibly use BufEnter autocommands.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001629 Only supported for GTK version 2 and later.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001630
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001631 *clipboard-exclude*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001632 exclude:{pattern}
1633 Defines a pattern that is matched against the name of
1634 the terminal 'term'. If there is a match, no
1635 connection will be made to the X server. This is
1636 useful in this situation:
1637 - Running Vim in a console.
1638 - $DISPLAY is set to start applications on another
1639 display.
1640 - You do not want to connect to the X server in the
1641 console, but do want this in a terminal emulator.
1642 To never connect to the X server use: >
1643 exclude:.*
1644< This has the same effect as using the |-X| argument.
1645 Note that when there is no connection to the X server
1646 the window title won't be restored and the clipboard
1647 cannot be accessed.
1648 The value of 'magic' is ignored, {pattern} is
1649 interpreted as if 'magic' was on.
1650 The rest of the option value will be used for
1651 {pattern}, this must be the last entry.
1652
1653 *'cmdheight'* *'ch'*
1654'cmdheight' 'ch' number (default 1)
1655 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001656 Number of screen lines to use for the command-line. Helps avoiding
1657 |hit-enter| prompts.
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00001658 The value of this option is stored with the tab page, so that each tab
1659 page can have a different value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001660
1661 *'cmdwinheight'* *'cwh'*
1662'cmdwinheight' 'cwh' number (default 7)
1663 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001664 Number of screen lines to use for the command-line window. |cmdwin|
1665
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001666 *'colorcolumn'* *'cc'*
1667'colorcolumn' 'cc' string (default "")
1668 local to window
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001669 {not available when compiled without the |+syntax|
1670 feature}
1671 'colorcolumn' is a comma separated list of screen columns that are
1672 highlighted with ColorColumn |hl-ColorColumn|. Useful to align
1673 text. Will make screen redrawing slower.
1674 The screen column can be an absolute number, or a number preceded with
1675 '+' or '-', which is added to or subtracted from 'textwidth'. >
1676
1677 :set cc=+1 " highlight column after 'textwidth'
1678 :set cc=+1,+2,+3 " highlight three columns after 'textwidth'
1679 :hi ColorColumn ctermbg=lightgrey guibg=lightgrey
1680<
1681 When 'textwidth' is zero then the items with '-' and '+' are not used.
1682 A maximum of 256 columns are highlighted.
1683
Bram Moolenaar071d4272004-06-13 20:20:40 +00001684 *'columns'* *'co'* *E594*
1685'columns' 'co' number (default 80 or terminal width)
1686 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001687 Number of columns of the screen. Normally this is set by the terminal
Bram Moolenaar7c626922005-02-07 22:01:03 +00001688 initialization and does not have to be set by hand. Also see
1689 |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001690 When Vim is running in the GUI or in a resizable window, setting this
1691 option will cause the window size to be changed. When you only want
1692 to use the size for the GUI, put the command in your |gvimrc| file.
1693 When you set this option and Vim is unable to change the physical
Bram Moolenaar02467872007-05-06 13:22:01 +00001694 number of columns of the display, the display may be messed up. For
1695 the GUI it is always possible and Vim limits the number of columns to
1696 what fits on the screen. You can use this command to get the widest
1697 window possible: >
1698 :set columns=9999
1699< Minimum value is 12, maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001700
1701 *'comments'* *'com'* *E524* *E525*
1702'comments' 'com' string (default
1703 "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-")
1704 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001705 A comma separated list of strings that can start a comment line. See
1706 |format-comments|. See |option-backslash| about using backslashes to
1707 insert a space.
1708
1709 *'commentstring'* *'cms'* *E537*
1710'commentstring' 'cms' string (default "/*%s*/")
1711 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001712 {not available when compiled without the |+folding|
1713 feature}
1714 A template for a comment. The "%s" in the value is replaced with the
1715 comment text. Currently only used to add markers for folding, see
1716 |fold-marker|.
1717
1718 *'compatible'* *'cp'* *'nocompatible'* *'nocp'*
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001719'compatible' 'cp' boolean (default on, off when a |vimrc| or |gvimrc|
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02001720 file is found, reset in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001721 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001722 This option has the effect of making Vim either more Vi-compatible, or
1723 make Vim behave in a more useful way.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001724
Bram Moolenaar071d4272004-06-13 20:20:40 +00001725 This is a special kind of option, because when it's set or reset,
Bram Moolenaar214641f2017-03-05 17:04:09 +01001726 other options are also changed as a side effect.
1727 NOTE: Setting or resetting this option can have a lot of unexpected
1728 effects: Mappings are interpreted in another way, undo behaves
1729 differently, etc. If you set this option in your vimrc file, you
1730 should probably put it at the very start.
1731
Bram Moolenaar071d4272004-06-13 20:20:40 +00001732 By default this option is on and the Vi defaults are used for the
1733 options. This default was chosen for those people who want to use Vim
1734 just like Vi, and don't even (want to) know about the 'compatible'
1735 option.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001736 When a |vimrc| or |gvimrc| file is found while Vim is starting up,
Bram Moolenaard042c562005-06-30 22:04:15 +00001737 this option is switched off, and all options that have not been
1738 modified will be set to the Vim defaults. Effectively, this means
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001739 that when a |vimrc| or |gvimrc| file exists, Vim will use the Vim
Bram Moolenaard042c562005-06-30 22:04:15 +00001740 defaults, otherwise it will use the Vi defaults. (Note: This doesn't
Bram Moolenaar02467872007-05-06 13:22:01 +00001741 happen for the system-wide vimrc or gvimrc file, nor for a file given
1742 with the |-u| argument). Also see |compatible-default| and
1743 |posix-compliance|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001744 You can also set this option with the "-C" argument, and reset it with
1745 "-N". See |-C| and |-N|.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001746 See 'cpoptions' for more fine tuning of Vi compatibility.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001747
Bram Moolenaar214641f2017-03-05 17:04:09 +01001748 When this option is set, numerous other options are set to make Vim as
1749 Vi-compatible as possible. When this option is unset, various options
1750 are set to make Vim more useful. The table below lists all the
1751 options affected.
1752 The {?} column indicates when the options are affected:
1753 + Means that the option is set to the value given in {set value} when
1754 'compatible' is set.
1755 & Means that the option is set to the value given in {set value} when
1756 'compatible' is set AND is set to its Vim default value when
1757 'compatible' is unset.
1758 - Means the option is NOT changed when setting 'compatible' but IS
1759 set to its Vim default when 'compatible' is unset.
1760 The {effect} column summarises the change when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001761
Bram Moolenaar036986f2017-03-16 17:41:02 +01001762 option ? set value effect ~
Bram Moolenaar214641f2017-03-05 17:04:09 +01001763
1764 'allowrevins' + off no CTRL-_ command
1765 'antialias' + off don't use antialiased fonts
1766 'arabic' + off reset arabic-related options
1767 'arabicshape' + on correct character shapes
1768 'backspace' + "" normal backspace
1769 'backup' + off no backup file
1770 'backupcopy' & Unix: "yes" backup file is a copy
1771 else: "auto" copy or rename backup file
1772 'balloonexpr' + "" text to show in evaluation balloon
1773 'breakindent' + off don't indent when wrapping lines
1774 'cedit' - {unchanged} {set vim default only on resetting 'cp'}
1775 'cindent' + off no C code indentation
1776 'compatible' - {unchanged} {set vim default only on resetting 'cp'}
1777 'copyindent' + off don't copy indent structure
1778 'cpoptions' & (all flags) Vi-compatible flags
1779 'cscopepathcomp'+ 0 don't show directories in tags list
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01001780 'cscoperelative'+ off don't use basename of path as prefix
Bram Moolenaar214641f2017-03-05 17:04:09 +01001781 'cscopetag' + off don't use cscope for ":tag"
Bram Moolenaar036986f2017-03-16 17:41:02 +01001782 'cscopetagorder'+ 0 see |cscopetagorder|
Bram Moolenaar214641f2017-03-05 17:04:09 +01001783 'cscopeverbose' + off see |cscopeverbose|
1784 'delcombine' + off unicode: delete whole char combination
1785 'digraph' + off no digraphs
1786 'esckeys' & off no <Esc>-keys in Insert mode
1787 'expandtab' + off tabs not expanded to spaces
1788 'fileformats' & "" no automatic file format detection,
Bram Moolenaar6f345a12019-12-17 21:27:18 +01001789 "dos,unix" except for MS-Windows
Bram Moolenaar214641f2017-03-05 17:04:09 +01001790 'formatexpr' + "" use 'formatprg' for auto-formatting
1791 'formatoptions' & "vt" Vi compatible formatting
1792 'gdefault' + off no default 'g' flag for ":s"
1793 'history' & 0 no commandline history
1794 'hkmap' + off no Hebrew keyboard mapping
1795 'hkmapp' + off no phonetic Hebrew keyboard mapping
1796 'hlsearch' + off no highlighting of search matches
1797 'incsearch' + off no incremental searching
1798 'indentexpr' + "" no indenting by expression
1799 'insertmode' + off do not start in Insert mode
1800 'iskeyword' & "@,48-57,_" keywords contain alphanumeric
Bram Moolenaar071d4272004-06-13 20:20:40 +00001801 characters and '_'
Bram Moolenaar214641f2017-03-05 17:04:09 +01001802 'joinspaces' + on insert 2 spaces after period
1803 'modeline' & off no modelines
1804 'more' & off no pauses in listings
1805 'mzquantum' - {unchanged} {set vim default only on resetting 'cp'}
1806 'numberwidth' & 8 min number of columns for line number
1807 'preserveindent'+ off don't preserve current indent structure
1808 when changing it
1809 'revins' + off no reverse insert
1810 'ruler' + off no ruler
1811 'scrolljump' + 1 no jump scroll
1812 'scrolloff' + 0 no scroll offset
1813 'shelltemp' - {unchanged} {set vim default only on resetting 'cp'}
1814 'shiftround' + off indent not rounded to shiftwidth
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02001815 'shortmess' & "S" no shortening of messages
Bram Moolenaar214641f2017-03-05 17:04:09 +01001816 'showcmd' & off command characters not shown
1817 'showmode' & off current mode not shown
1818 'sidescrolloff' + 0 cursor moves to edge of screen in scroll
1819 'smartcase' + off no automatic ignore case switch
1820 'smartindent' + off no smart indentation
1821 'smarttab' + off no smart tab size
1822 'softtabstop' + 0 tabs are always 'tabstop' positions
1823 'startofline' + on goto startofline with some commands
1824 'tagcase' & "followic" 'ignorecase' when searching tags file
1825 'tagrelative' & off tag file names are not relative
1826 'termguicolors' + off don't use highlight-(guifg|guibg)
1827 'textauto' & off no automatic textmode detection
1828 'textwidth' + 0 no automatic line wrap
1829 'tildeop' + off tilde is not an operator
1830 'ttimeout' + off no terminal timeout
1831 'undofile' + off don't use an undo file
Bram Moolenaar036986f2017-03-16 17:41:02 +01001832 'viminfo' - {unchanged} {set Vim default only on resetting 'cp'}
Bram Moolenaar214641f2017-03-05 17:04:09 +01001833 'virtualedit' + "" cursor can only be placed on characters
1834 'whichwrap' & "" left-right movements don't wrap
1835 'wildchar' & CTRL-E only when the current value is <Tab>
Bram Moolenaar071d4272004-06-13 20:20:40 +00001836 use CTRL-E for cmdline completion
Bram Moolenaar214641f2017-03-05 17:04:09 +01001837 'writebackup' + on or off depends on the |+writebackup| feature
Bram Moolenaar071d4272004-06-13 20:20:40 +00001838
1839 *'complete'* *'cpt'* *E535*
1840'complete' 'cpt' string (default: ".,w,b,u,t,i")
1841 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001842 This option specifies how keyword completion |ins-completion| works
1843 when CTRL-P or CTRL-N are used. It is also used for whole-line
1844 completion |i_CTRL-X_CTRL-L|. It indicates the type of completion
1845 and the places to scan. It is a comma separated list of flags:
Bram Moolenaar3848e002016-03-19 18:42:29 +01001846 . scan the current buffer ('wrapscan' is ignored)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001847 w scan buffers from other windows
1848 b scan other loaded buffers that are in the buffer list
1849 u scan the unloaded buffers that are in the buffer list
1850 U scan the buffers that are not in the buffer list
1851 k scan the files given with the 'dictionary' option
Bram Moolenaar0b238792006-03-02 22:49:12 +00001852 kspell use the currently active spell checking |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001853 k{dict} scan the file {dict}. Several "k" flags can be given,
1854 patterns are valid too. For example: >
1855 :set cpt=k/usr/dict/*,k~/spanish
1856< s scan the files given with the 'thesaurus' option
1857 s{tsr} scan the file {tsr}. Several "s" flags can be given, patterns
1858 are valid too.
1859 i scan current and included files
1860 d scan current and included files for defined name or macro
1861 |i_CTRL-X_CTRL-D|
1862 ] tag completion
1863 t same as "]"
1864
1865 Unloaded buffers are not loaded, thus their autocmds |:autocmd| are
1866 not executed, this may lead to unexpected completions from some files
1867 (gzipped files for example). Unloaded buffers are not scanned for
1868 whole-line completion.
1869
1870 The default is ".,w,b,u,t,i", which means to scan:
1871 1. the current buffer
1872 2. buffers in other windows
1873 3. other loaded buffers
1874 4. unloaded buffers
1875 5. tags
1876 6. included files
1877
1878 As you can see, CTRL-N and CTRL-P can be used to do any 'iskeyword'-
Bram Moolenaar582fd852005-03-28 20:58:01 +00001879 based expansion (e.g., dictionary |i_CTRL-X_CTRL-K|, included patterns
1880 |i_CTRL-X_CTRL-I|, tags |i_CTRL-X_CTRL-]| and normal expansions).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001881
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001882 *'completefunc'* *'cfu'*
1883'completefunc' 'cfu' string (default: empty)
1884 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02001885 {not available when compiled without the |+eval|
Bram Moolenaare2c453d2019-08-21 14:37:09 +02001886 feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00001887 This option specifies a function to be used for Insert mode completion
1888 with CTRL-X CTRL-U. |i_CTRL-X_CTRL-U|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001889 See |complete-functions| for an explanation of how the function is
1890 invoked and what it should return.
Bram Moolenaar166af9b2010-11-16 20:34:40 +01001891 This option cannot be set from a |modeline| or in the |sandbox|, for
1892 security reasons.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00001893
Bram Moolenaarac3150d2019-07-28 16:36:39 +02001894 *'completeslash'* *'csl'*
1895'completeslash' 'csl' string (default: "")
1896 local to buffer
Bram Moolenaar2e693a82019-10-16 22:35:02 +02001897 {only for MS-Windows}
Bram Moolenaarac3150d2019-07-28 16:36:39 +02001898 When this option is set it overrules 'shellslash' for completion:
1899 - When this option is set to "slash", a forward slash is used for path
1900 completion in insert mode. This is useful when editing HTML tag, or
Bram Moolenaar6f345a12019-12-17 21:27:18 +01001901 Makefile with 'noshellslash' on MS-Windows.
Bram Moolenaarac3150d2019-07-28 16:36:39 +02001902 - When this option is set to "backslash", backslash is used. This is
Bram Moolenaar6f345a12019-12-17 21:27:18 +01001903 useful when editing a batch file with 'shellslash' set on MS-Windows.
Bram Moolenaarac3150d2019-07-28 16:36:39 +02001904 - When this option is empty, same character is used as for
1905 'shellslash'.
1906 For Insert mode completion the buffer-local value is used. For
1907 command line completion the global value is used.
1908
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001909 *'completeopt'* *'cot'*
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001910'completeopt' 'cot' string (default: "menu,preview")
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001911 global
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001912 A comma separated list of options for Insert mode completion
1913 |ins-completion|. The supported values are:
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001914
1915 menu Use a popup menu to show the possible completions. The
1916 menu is only shown when there is more than one match and
1917 sufficient colors are available. |ins-completion-menu|
1918
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001919 menuone Use the popup menu also when there is only one match.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00001920 Useful when there is additional information about the
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001921 match, e.g., what file it comes from.
1922
Bram Moolenaarc1e37902006-04-18 21:55:01 +00001923 longest Only insert the longest common text of the matches. If
1924 the menu is displayed you can use CTRL-L to add more
1925 characters. Whether case is ignored depends on the kind
1926 of completion. For buffer text the 'ignorecase' option is
1927 used.
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001928
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001929 preview Show extra information about the currently selected
Bram Moolenaar02467872007-05-06 13:22:01 +00001930 completion in the preview window. Only works in
1931 combination with "menu" or "menuone".
1932
Bram Moolenaar576a4a62019-08-18 15:25:17 +02001933 popup Show extra information about the currently selected
1934 completion in a popup window. Only works in combination
1935 with "menu" or "menuone". Overrides "preview".
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02001936 See |'completepopup'| for specifying properties.
Bram Moolenaar2e693a82019-10-16 22:35:02 +02001937 {only works when compiled with the |+textprop| feature}
Bram Moolenaar576a4a62019-08-18 15:25:17 +02001938
Bram Moolenaardca7abe2019-10-20 18:17:57 +02001939 popuphidden
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01001940 Just like "popup" but initially hide the popup. Use a
Bram Moolenaardca7abe2019-10-20 18:17:57 +02001941 |CompleteChanged| autocommand to fetch the info and call
1942 |popup_show()| once the popup has been filled.
1943 See the example at |complete-popuphidden|.
1944 {only works when compiled with the |+textprop| feature}
1945
Bram Moolenaarb6be1e22015-07-10 18:18:40 +02001946 noinsert Do not insert any text for a match until the user selects
1947 a match from the menu. Only works in combination with
1948 "menu" or "menuone". No effect if "longest" is present.
1949
1950 noselect Do not select a match in the menu, force the user to
1951 select one from the menu. Only works in combination with
1952 "menu" or "menuone".
1953
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001954
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02001955 *'completepopup'* *'cpp'*
1956'completepopup' 'cpp' string (default empty)
1957 global
1958 {not available when compiled without the |+textprop|
1959 or |+quickfix| feature}
1960 When 'completeopt' contains "popup" then this option is used for the
Bram Moolenaar447bfba2020-07-18 16:07:16 +02001961 properties of the info popup when it is created. If an info popup
1962 window already exists it is closed, so that the option value is
1963 applied when it is created again.
1964 You can also use |popup_findinfo()| and then set properties for an
1965 existing info popup with |popup_setoptions()|. See |complete-popup|.
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02001966
1967
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001968 *'concealcursor'* *'cocu'*
1969'concealcursor' 'cocu' string (default: "")
1970 local to window
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001971 {not available when compiled without the |+conceal|
1972 feature}
1973 Sets the modes in which text in the cursor line can also be concealed.
1974 When the current mode is listed then concealing happens just like in
1975 other lines.
1976 n Normal mode
1977 v Visual mode
1978 i Insert mode
Bram Moolenaarca8c9862010-07-24 15:00:38 +02001979 c Command line editing, for 'incsearch'
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001980
Bram Moolenaare6dc5732010-07-24 23:52:26 +02001981 'v' applies to all lines in the Visual area, not only the cursor.
Bram Moolenaarca8c9862010-07-24 15:00:38 +02001982 A useful value is "nc". This is used in help files. So long as you
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001983 are moving around text is concealed, but when starting to insert text
1984 or selecting a Visual area the concealed text is displayed, so that
1985 you can see what you are doing.
Bram Moolenaarf70e3d62010-07-24 13:15:07 +02001986 Keep in mind that the cursor position is not always where it's
1987 displayed. E.g., when moving vertically it may change column.
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001988
1989
Bram Moolenaar95bafa22018-10-02 13:26:25 +02001990 *'conceallevel'* *'cole'*
1991'conceallevel' 'cole' number (default 0)
Bram Moolenaar860cae12010-06-05 23:22:07 +02001992 local to window
Bram Moolenaar860cae12010-06-05 23:22:07 +02001993 {not available when compiled without the |+conceal|
1994 feature}
Bram Moolenaar6df6f472010-07-18 18:04:50 +02001995 Determine how text with the "conceal" syntax attribute |:syn-conceal|
1996 is shown:
Bram Moolenaar860cae12010-06-05 23:22:07 +02001997
Bram Moolenaar6df6f472010-07-18 18:04:50 +02001998 Value Effect ~
Bram Moolenaar860cae12010-06-05 23:22:07 +02001999 0 Text is shown normally
Bram Moolenaar477db062010-07-28 18:17:41 +02002000 1 Each block of concealed text is replaced with one
2001 character. If the syntax item does not have a custom
2002 replacement character defined (see |:syn-cchar|) the
2003 character defined in 'listchars' is used (default is a
2004 space).
2005 It is highlighted with the "Conceal" highlight group.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002006 2 Concealed text is completely hidden unless it has a
2007 custom replacement character defined (see
Bram Moolenaar477db062010-07-28 18:17:41 +02002008 |:syn-cchar|).
Bram Moolenaara7781e02010-07-19 20:13:22 +02002009 3 Concealed text is completely hidden.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002010
Bram Moolenaara7781e02010-07-19 20:13:22 +02002011 Note: in the cursor line concealed text is not hidden, so that you can
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002012 edit and copy the text. This can be changed with the 'concealcursor'
2013 option.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002014
Bram Moolenaar071d4272004-06-13 20:20:40 +00002015 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
2016'confirm' 'cf' boolean (default off)
2017 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002018 When 'confirm' is on, certain operations that would normally
2019 fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
2020 instead raise a |dialog| asking if you wish to save the current
2021 file(s). You can still use a ! to unconditionally |abandon| a buffer.
2022 If 'confirm' is off you can still activate confirmation for one
2023 command only (this is most useful in mappings) with the |:confirm|
2024 command.
2025 Also see the |confirm()| function and the 'v' flag in 'guioptions'.
2026
2027 *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
2028'conskey' 'consk' boolean (default off)
2029 global
Bram Moolenaarf3913272016-02-25 00:00:01 +01002030 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002031
2032 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
2033'copyindent' 'ci' boolean (default off)
2034 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002035 Copy the structure of the existing lines indent when autoindenting a
2036 new line. Normally the new indent is reconstructed by a series of
2037 tabs followed by spaces as required (unless |'expandtab'| is enabled,
2038 in which case only spaces are used). Enabling this option makes the
2039 new line copy whatever characters were used for indenting on the
Bram Moolenaar446cb832008-06-24 21:56:24 +00002040 existing line. 'expandtab' has no effect on these characters, a Tab
2041 remains a Tab. If the new indent is greater than on the existing
Bram Moolenaar071d4272004-06-13 20:20:40 +00002042 line, the remaining space is filled in the normal manner.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002043 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002044 Also see 'preserveindent'.
2045
Bram Moolenaare0fa3742016-02-20 15:47:01 +01002046 *'cpoptions'* *'cpo'* *cpo*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002047'cpoptions' 'cpo' string (Vim default: "aABceFs",
2048 Vi default: all flags)
2049 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002050 A sequence of single character flags. When a character is present
Bram Moolenaar7cba6c02013-09-05 22:13:31 +02002051 this indicates Vi-compatible behavior. This is used for things where
2052 not being Vi-compatible is mostly or sometimes preferred.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002053 'cpoptions' stands for "compatible-options".
2054 Commas can be added for readability.
2055 To avoid problems with flags that are added in the future, use the
2056 "+=" and "-=" feature of ":set" |add-option-flags|.
2057 NOTE: This option is set to the Vi default value when 'compatible' is
2058 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002059 NOTE: This option is set to the POSIX default value at startup when
2060 the Vi default value would be used and the $VIM_POSIX environment
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002061 variable exists |posix|. This means Vim tries to behave like the
2062 POSIX specification.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002063
2064 contains behavior ~
2065 *cpo-a*
2066 a When included, a ":read" command with a file name
2067 argument will set the alternate file name for the
2068 current window.
2069 *cpo-A*
2070 A When included, a ":write" command with a file name
2071 argument will set the alternate file name for the
2072 current window.
2073 *cpo-b*
2074 b "\|" in a ":map" command is recognized as the end of
2075 the map command. The '\' is included in the mapping,
2076 the text after the '|' is interpreted as the next
2077 command. Use a CTRL-V instead of a backslash to
2078 include the '|' in the mapping. Applies to all
2079 mapping, abbreviation, menu and autocmd commands.
2080 See also |map_bar|.
2081 *cpo-B*
2082 B A backslash has no special meaning in mappings,
Bram Moolenaara9604e62018-07-21 05:56:22 +02002083 abbreviations, user commands and the "to" part of the
2084 menu commands. Remove this flag to be able to use a
2085 backslash like a CTRL-V. For example, the command
2086 ":map X \<Esc>" results in X being mapped to:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002087 'B' included: "\^[" (^[ is a real <Esc>)
2088 'B' excluded: "<Esc>" (5 characters)
2089 ('<' excluded in both cases)
2090 *cpo-c*
2091 c Searching continues at the end of any match at the
2092 cursor position, but not further than the start of the
2093 next line. When not present searching continues
2094 one character from the cursor position. With 'c'
2095 "abababababab" only gets three matches when repeating
2096 "/abab", without 'c' there are five matches.
2097 *cpo-C*
2098 C Do not concatenate sourced lines that start with a
2099 backslash. See |line-continuation|.
2100 *cpo-d*
2101 d Using "./" in the 'tags' option doesn't mean to use
2102 the tags file relative to the current file, but the
2103 tags file in the current directory.
2104 *cpo-D*
2105 D Can't use CTRL-K to enter a digraph after Normal mode
2106 commands with a character argument, like |r|, |f| and
2107 |t|.
2108 *cpo-e*
2109 e When executing a register with ":@r", always add a
2110 <CR> to the last line, also when the register is not
2111 linewise. If this flag is not present, the register
2112 is not linewise and the last line does not end in a
2113 <CR>, then the last line is put on the command-line
2114 and can be edited before hitting <CR>.
2115 *cpo-E*
2116 E It is an error when using "y", "d", "c", "g~", "gu" or
2117 "gU" on an Empty region. The operators only work when
Bram Moolenaar15142e22018-04-30 22:19:58 +02002118 at least one character is to be operated on. Example:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002119 This makes "y0" fail in the first column.
2120 *cpo-f*
2121 f When included, a ":read" command with a file name
2122 argument will set the file name for the current buffer,
2123 if the current buffer doesn't have a file name yet.
2124 *cpo-F*
2125 F When included, a ":write" command with a file name
2126 argument will set the file name for the current
2127 buffer, if the current buffer doesn't have a file name
Bram Moolenaarb3480382005-12-11 21:33:32 +00002128 yet. Also see |cpo-P|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002129 *cpo-g*
2130 g Goto line 1 when using ":edit" without argument.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002131 *cpo-H*
2132 H When using "I" on a line with only blanks, insert
2133 before the last blank. Without this flag insert after
2134 the last blank.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002135 *cpo-i*
2136 i When included, interrupting the reading of a file will
2137 leave it modified.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002138 *cpo-I*
2139 I When moving the cursor up or down just after inserting
2140 indent for 'autoindent', do not delete the indent.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002141 *cpo-j*
2142 j When joining lines, only add two spaces after a '.',
2143 not after '!' or '?'. Also see 'joinspaces'.
2144 *cpo-J*
2145 J A |sentence| has to be followed by two spaces after
Bram Moolenaar582fd852005-03-28 20:58:01 +00002146 the '.', '!' or '?'. A <Tab> is not recognized as
Bram Moolenaar071d4272004-06-13 20:20:40 +00002147 white space.
2148 *cpo-k*
2149 k Disable the recognition of raw key codes in
2150 mappings, abbreviations, and the "to" part of menu
2151 commands. For example, if <Key> sends ^[OA (where ^[
2152 is <Esc>), the command ":map X ^[OA" results in X
2153 being mapped to:
2154 'k' included: "^[OA" (3 characters)
2155 'k' excluded: "<Key>" (one key code)
2156 Also see the '<' flag below.
2157 *cpo-K*
2158 K Don't wait for a key code to complete when it is
2159 halfway a mapping. This breaks mapping <F1><F1> when
2160 only part of the second <F1> has been read. It
2161 enables cancelling the mapping by typing <F1><Esc>.
2162 *cpo-l*
2163 l Backslash in a [] range in a search pattern is taken
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002164 literally, only "\]", "\^", "\-" and "\\" are special.
2165 See |/[]|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002166 'l' included: "/[ \t]" finds <Space>, '\' and 't'
2167 'l' excluded: "/[ \t]" finds <Space> and <Tab>
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002168 Also see |cpo-\|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002169 *cpo-L*
2170 L When the 'list' option is set, 'wrapmargin',
2171 'textwidth', 'softtabstop' and Virtual Replace mode
2172 (see |gR|) count a <Tab> as two characters, instead of
2173 the normal behavior of a <Tab>.
2174 *cpo-m*
2175 m When included, a showmatch will always wait half a
2176 second. When not included, a showmatch will wait half
2177 a second or until a character is typed. |'showmatch'|
2178 *cpo-M*
2179 M When excluded, "%" matching will take backslashes into
2180 account. Thus in "( \( )" and "\( ( \)" the outer
2181 parenthesis match. When included "%" ignores
2182 backslashes, which is Vi compatible.
2183 *cpo-n*
Bram Moolenaar64486672010-05-16 15:46:46 +02002184 n When included, the column used for 'number' and
2185 'relativenumber' will also be used for text of wrapped
2186 lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002187 *cpo-o*
2188 o Line offset to search command is not remembered for
2189 next search.
2190 *cpo-O*
2191 O Don't complain if a file is being overwritten, even
2192 when it didn't exist when editing it. This is a
2193 protection against a file unexpectedly created by
2194 someone else. Vi didn't complain about this.
2195 *cpo-p*
2196 p Vi compatible Lisp indenting. When not present, a
2197 slightly better algorithm is used.
Bram Moolenaarb3480382005-12-11 21:33:32 +00002198 *cpo-P*
2199 P When included, a ":write" command that appends to a
2200 file will set the file name for the current buffer, if
2201 the current buffer doesn't have a file name yet and
2202 the 'F' flag is also included |cpo-F|.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002203 *cpo-q*
2204 q When joining multiple lines leave the cursor at the
2205 position where it would be when joining two lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002206 *cpo-r*
2207 r Redo ("." command) uses "/" to repeat a search
2208 command, instead of the actually used search string.
2209 *cpo-R*
2210 R Remove marks from filtered lines. Without this flag
2211 marks are kept like |:keepmarks| was used.
2212 *cpo-s*
2213 s Set buffer options when entering the buffer for the
2214 first time. This is like it is in Vim version 3.0.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002215 And it is the default. If not present the options are
Bram Moolenaar071d4272004-06-13 20:20:40 +00002216 set when the buffer is created.
2217 *cpo-S*
2218 S Set buffer options always when entering a buffer
2219 (except 'readonly', 'fileformat', 'filetype' and
2220 'syntax'). This is the (most) Vi compatible setting.
2221 The options are set to the values in the current
2222 buffer. When you change an option and go to another
2223 buffer, the value is copied. Effectively makes the
2224 buffer options global to all buffers.
2225
2226 's' 'S' copy buffer options
2227 no no when buffer created
2228 yes no when buffer first entered (default)
2229 X yes each time when buffer entered (vi comp.)
2230 *cpo-t*
2231 t Search pattern for the tag command is remembered for
2232 "n" command. Otherwise Vim only puts the pattern in
2233 the history for search pattern, but doesn't change the
2234 last used search pattern.
2235 *cpo-u*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002236 u Undo is Vi compatible. See |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002237 *cpo-v*
2238 v Backspaced characters remain visible on the screen in
2239 Insert mode. Without this flag the characters are
2240 erased from the screen right away. With this flag the
2241 screen newly typed text overwrites backspaced
2242 characters.
2243 *cpo-w*
2244 w When using "cw" on a blank character, only change one
2245 character and not all blanks until the start of the
2246 next word.
2247 *cpo-W*
2248 W Don't overwrite a readonly file. When omitted, ":w!"
2249 overwrites a readonly file, if possible.
2250 *cpo-x*
2251 x <Esc> on the command-line executes the command-line.
2252 The default in Vim is to abandon the command-line,
2253 because <Esc> normally aborts a command. |c_<Esc>|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002254 *cpo-X*
2255 X When using a count with "R" the replaced text is
2256 deleted only once. Also when repeating "R" with "."
2257 and a count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002258 *cpo-y*
Bram Moolenaard09091d2019-01-17 16:07:22 +01002259 y A yank command can be redone with ".". Think twice if
2260 you really want to use this, it may break some
2261 plugins, since most people expect "." to only repeat a
2262 change.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002263 *cpo-Z*
2264 Z When using "w!" while the 'readonly' option is set,
2265 don't reset 'readonly'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002266 *cpo-!*
2267 ! When redoing a filter command, use the last used
2268 external command, whatever it was. Otherwise the last
2269 used -filter- command is used.
2270 *cpo-$*
2271 $ When making a change to one line, don't redisplay the
2272 line, but put a '$' at the end of the changed text.
2273 The changed text will be overwritten when you type the
2274 new text. The line is redisplayed if you type any
2275 command that moves the cursor from the insertion
2276 point.
2277 *cpo-%*
2278 % Vi-compatible matching is done for the "%" command.
2279 Does not recognize "#if", "#endif", etc.
2280 Does not recognize "/*" and "*/".
2281 Parens inside single and double quotes are also
2282 counted, causing a string that contains a paren to
2283 disturb the matching. For example, in a line like
2284 "if (strcmp("foo(", s))" the first paren does not
2285 match the last one. When this flag is not included,
2286 parens inside single and double quotes are treated
2287 specially. When matching a paren outside of quotes,
2288 everything inside quotes is ignored. When matching a
2289 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002290 there is one). This works very well for C programs.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002291 This flag is also used for other features, such as
2292 C-indenting.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002293 *cpo--*
2294 - When included, a vertical movement command fails when
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002295 it would go above the first line or below the last
2296 line. Without it the cursor moves to the first or
2297 last line, unless it already was in that line.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002298 Applies to the commands "-", "k", CTRL-P, "+", "j",
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002299 CTRL-N, CTRL-J and ":1234".
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002300 *cpo-+*
2301 + When included, a ":write file" command will reset the
2302 'modified' flag of the buffer, even though the buffer
2303 itself may still be different from its file.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002304 *cpo-star*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002305 * Use ":*" in the same way as ":@". When not included,
2306 ":*" is an alias for ":'<,'>", select the Visual area.
2307 *cpo-<*
2308 < Disable the recognition of special key codes in |<>|
2309 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002310 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00002311 ":map X <Tab>" results in X being mapped to:
2312 '<' included: "<Tab>" (5 characters)
2313 '<' excluded: "^I" (^I is a real <Tab>)
2314 Also see the 'k' flag above.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002315 *cpo->*
2316 > When appending to a register, put a line break before
2317 the appended text.
Bram Moolenaar8b3e0332011-06-26 05:36:34 +02002318 *cpo-;*
2319 ; When using |,| or |;| to repeat the last |t| search
2320 and the cursor is right in front of the searched
2321 character, the cursor won't move. When not included,
2322 the cursor would skip over it and jump to the
Bram Moolenaarc8734422012-06-01 22:38:45 +02002323 following occurrence.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002324
2325 POSIX flags. These are not included in the Vi default value, except
2326 when $VIM_POSIX was set on startup. |posix|
2327
2328 contains behavior ~
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002329 *cpo-#*
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002330 # A count before "D", "o" and "O" has no effect.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002331 *cpo-&*
2332 & When ":preserve" was used keep the swap file when
2333 exiting normally while this buffer is still loaded.
2334 This flag is tested when exiting.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002335 *cpo-\*
2336 \ Backslash in a [] range in a search pattern is taken
2337 literally, only "\]" is special See |/[]|
Bram Moolenaar90915b52005-08-21 22:17:52 +00002338 '\' included: "/[ \-]" finds <Space>, '\' and '-'
2339 '\' excluded: "/[ \-]" finds <Space> and '-'
2340 Also see |cpo-l|.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002341 *cpo-/*
2342 / When "%" is used as the replacement string in a |:s|
2343 command, use the previous replacement string. |:s%|
2344 *cpo-{*
2345 { The |{| and |}| commands also stop at a "{" character
2346 at the start of a line.
2347 *cpo-.*
2348 . The ":chdir" and ":cd" commands fail if the current
2349 buffer is modified, unless ! is used. Vim doesn't
2350 need this, since it remembers the full path of an
2351 opened file.
2352 *cpo-bar*
2353 | The value of the $LINES and $COLUMNS environment
2354 variables overrule the terminal size values obtained
2355 with system specific functions.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002356
Bram Moolenaar071d4272004-06-13 20:20:40 +00002357
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002358 *'cryptmethod'* *'cm'*
Bram Moolenaara86187b2018-12-16 18:20:00 +01002359'cryptmethod' 'cm' string (default "blowfish2")
Bram Moolenaar49771f42010-07-20 17:32:38 +02002360 global or local to buffer |global-local|
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002361 Method used for encryption when the buffer is written to a file:
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002362 *pkzip*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002363 zip PkZip compatible method. A weak kind of encryption.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002364 Backwards compatible with Vim 7.2 and older.
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002365 *blowfish*
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002366 blowfish Blowfish method. Medium strong encryption but it has
2367 an implementation flaw. Requires Vim 7.3 or later,
2368 files can NOT be read by Vim 7.2 and older. This adds
2369 a "seed" to the file, every time you write the file
2370 the encrypted bytes will be different.
2371 *blowfish2*
2372 blowfish2 Blowfish method. Medium strong encryption. Requires
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01002373 Vim 7.4.401 or later, files can NOT be read by Vim 7.3
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002374 and older. This adds a "seed" to the file, every time
2375 you write the file the encrypted bytes will be
2376 different. The whole undo file is encrypted, not just
2377 the pieces of text.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002378
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01002379 You should use "blowfish2", also to re-encrypt older files.
2380
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002381 When reading an encrypted file 'cryptmethod' will be set automatically
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002382 to the detected method of the file being read. Thus if you write it
2383 without changing 'cryptmethod' the same method will be used.
2384 Changing 'cryptmethod' does not mark the file as modified, you have to
Bram Moolenaar49771f42010-07-20 17:32:38 +02002385 explicitly write it, you don't get a warning unless there are other
2386 modifications. Also see |:X|.
2387
2388 When setting the global value to an empty string, it will end up with
Bram Moolenaara86187b2018-12-16 18:20:00 +01002389 the value "blowfish2". When setting the local value to an empty
2390 string the buffer will use the global value.
Bram Moolenaar49771f42010-07-20 17:32:38 +02002391
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002392 When a new encryption method is added in a later version of Vim, and
2393 the current version does not recognize it, you will get *E821* .
Bram Moolenaar49771f42010-07-20 17:32:38 +02002394 You need to edit this file with the later version of Vim.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002395
2396
Bram Moolenaar071d4272004-06-13 20:20:40 +00002397 *'cscopepathcomp'* *'cspc'*
2398'cscopepathcomp' 'cspc' number (default 0)
2399 global
2400 {not available when compiled without the |+cscope|
2401 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002402 Determines how many components of the path to show in a list of tags.
2403 See |cscopepathcomp|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002404 NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002405
2406 *'cscopeprg'* *'csprg'*
2407'cscopeprg' 'csprg' string (default "cscope")
2408 global
2409 {not available when compiled without the |+cscope|
2410 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002411 Specifies the command to execute cscope. See |cscopeprg|.
2412 This option cannot be set from a |modeline| or in the |sandbox|, for
2413 security reasons.
2414
2415 *'cscopequickfix'* *'csqf'*
2416'cscopequickfix' 'csqf' string (default "")
2417 global
2418 {not available when compiled without the |+cscope|
2419 or |+quickfix| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002420 Specifies whether to use quickfix window to show cscope results.
2421 See |cscopequickfix|.
2422
Bram Moolenaarec7944a2013-06-12 21:29:15 +02002423 *'cscoperelative'* *'csre'* *'nocscoperelative'* *'nocsre'*
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002424'cscoperelative' 'csre' boolean (default off)
2425 global
2426 {not available when compiled without the |+cscope|
2427 feature}
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002428 In the absence of a prefix (-P) for cscope. setting this option enables
2429 to use the basename of cscope.out path as the prefix.
2430 See |cscoperelative|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002431 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002432
Bram Moolenaar071d4272004-06-13 20:20:40 +00002433 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
2434'cscopetag' 'cst' boolean (default off)
2435 global
2436 {not available when compiled without the |+cscope|
2437 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002438 Use cscope for tag commands. See |cscope-options|.
2439 NOTE: This option is reset when 'compatible' is set.
2440
2441 *'cscopetagorder'* *'csto'*
2442'cscopetagorder' 'csto' number (default 0)
2443 global
2444 {not available when compiled without the |+cscope|
2445 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002446 Determines the order in which ":cstag" performs a search. See
2447 |cscopetagorder|.
2448 NOTE: This option is set to 0 when 'compatible' is set.
2449
2450 *'cscopeverbose'* *'csverb'*
2451 *'nocscopeverbose'* *'nocsverb'*
2452'cscopeverbose' 'csverb' boolean (default off)
2453 global
2454 {not available when compiled without the |+cscope|
2455 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002456 Give messages when adding a cscope database. See |cscopeverbose|.
2457 NOTE: This option is reset when 'compatible' is set.
2458
Bram Moolenaar860cae12010-06-05 23:22:07 +02002459 *'cursorbind'* *'crb'* *'nocursorbind'* *'nocrb'*
2460'cursorbind' 'crb' boolean (default off)
2461 local to window
Bram Moolenaar860cae12010-06-05 23:22:07 +02002462 When this option is set, as the cursor in the current
2463 window moves other cursorbound windows (windows that also have
2464 this option set) move their cursors to the corresponding line and
2465 column. This option is useful for viewing the
2466 differences between two versions of a file (see 'diff'); in diff mode,
2467 inserted and deleted lines (though not characters within a line) are
Bram Moolenaar1a384422010-07-14 19:53:30 +02002468 taken into account.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002469
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002470
2471 *'cursorcolumn'* *'cuc'* *'nocursorcolumn'* *'nocuc'*
2472'cursorcolumn' 'cuc' boolean (default off)
2473 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02002474 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002475 feature}
2476 Highlight the screen column of the cursor with CursorColumn
2477 |hl-CursorColumn|. Useful to align text. Will make screen redrawing
2478 slower.
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00002479 If you only want the highlighting in the current window you can use
2480 these autocommands: >
2481 au WinLeave * set nocursorline nocursorcolumn
2482 au WinEnter * set cursorline cursorcolumn
2483<
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002484
2485 *'cursorline'* *'cul'* *'nocursorline'* *'nocul'*
2486'cursorline' 'cul' boolean (default off)
2487 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02002488 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002489 feature}
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002490 Highlight the text line of the cursor with CursorLine |hl-CursorLine|.
2491 Useful to easily spot the cursor. Will make screen redrawing slower.
Bram Moolenaare2f98b92006-03-29 21:18:24 +00002492 When Visual mode is active the highlighting isn't used to make it
Bram Moolenaar779b74b2006-04-10 14:55:34 +00002493 easier to see the selected text.
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002494
2495
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002496 *'cursorlineopt'* *'culopt'*
Bram Moolenaar017ba072019-09-14 21:01:23 +02002497'cursorlineopt' 'culopt' string (default: "number,line")
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002498 local to window
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002499 {not available when compiled without the |+syntax|
2500 feature}
Bram Moolenaar017ba072019-09-14 21:01:23 +02002501 Comma separated list of settings for how 'cursorline' is displayed.
2502 Valid values:
2503 "line" Highlight the text line of the cursor with
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002504 CursorLine |hl-CursorLine|.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002505 "screenline" Highlight only the screen line of the cursor with
2506 CursorLine |hl-CursorLine|.
2507 "number" Highlight the line number of the cursor with
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002508 CursorLineNr |hl-CursorLineNr|.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002509
2510 Special value:
2511 "both" Alias for the values "line,number".
2512
2513 "line" and "screenline" cannot be used together.
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002514
2515
Bram Moolenaar071d4272004-06-13 20:20:40 +00002516 *'debug'*
2517'debug' string (default "")
2518 global
Bram Moolenaar57657d82006-04-21 22:12:41 +00002519 These values can be used:
2520 msg Error messages that would otherwise be omitted will be given
2521 anyway.
2522 throw Error messages that would otherwise be omitted will be given
2523 anyway and also throw an exception and set |v:errmsg|.
2524 beep A message will be given when otherwise only a beep would be
2525 produced.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002526 The values can be combined, separated by a comma.
Bram Moolenaar57657d82006-04-21 22:12:41 +00002527 "msg" and "throw" are useful for debugging 'foldexpr', 'formatexpr' or
2528 'indentexpr'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002529
2530 *'define'* *'def'*
2531'define' 'def' string (default "^\s*#\s*define")
2532 global or local to buffer |global-local|
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002533 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002534 pattern, just like for the "/" command. This option is used for the
2535 commands like "[i" and "[d" |include-search|. The 'isident' option is
2536 used to recognize the defined name after the match:
2537 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2538 See |option-backslash| about inserting backslashes to include a space
2539 or backslash.
2540 The default value is for C programs. For C++ this value would be
2541 useful, to include const type declarations: >
2542 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
Bram Moolenaar63b74a82019-03-24 15:09:13 +01002543< You can also use "\ze" just before the name and continue the pattern
2544 to check what is following. E.g. for Javascript, if a function is
2545 defined with "func_name = function(args)": >
2546 ^\s*\ze\i\+\s*=\s*function(
2547< If the function is defined with "func_name : function() {...": >
2548 ^\s*\ze\i\+\s*[:]\s*(*function\s*(
Bram Moolenaar071d4272004-06-13 20:20:40 +00002549< When using the ":set" command, you need to double the backslashes!
Bram Moolenaar63b74a82019-03-24 15:09:13 +01002550 To avoid that use `:let` with a single quote string: >
2551 let &l:define = '^\s*\ze\k\+\s*=\s*function('
Bram Moolenaar911ead12019-04-21 00:03:35 +02002552<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002553
2554 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2555'delcombine' 'deco' boolean (default off)
2556 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002557 If editing Unicode and this option is set, backspace and Normal mode
2558 "x" delete each combining character on its own. When it is off (the
2559 default) the character along with its combining characters are
2560 deleted.
Bram Moolenaar4f4d51a2020-10-11 13:57:40 +02002561 Note: When 'delcombine' is set "xx" may work differently from "2x"!
Bram Moolenaar071d4272004-06-13 20:20:40 +00002562
2563 This is useful for Arabic, Hebrew and many other languages where one
2564 may have combining characters overtop of base characters, and want
2565 to remove only the combining ones.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002566 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002567
2568 *'dictionary'* *'dict'*
2569'dictionary' 'dict' string (default "")
2570 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002571 List of file names, separated by commas, that are used to lookup words
2572 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2573 contain a list of words. This can be one word per line, or several
2574 words per line, separated by non-keyword characters (white space is
2575 preferred). Maximum line length is 510 bytes.
Bram Moolenaar259f26a2018-05-15 22:25:40 +02002576
2577 When this option is empty or an entry "spell" is present, and spell
2578 checking is enabled, words in the word lists for the currently active
2579 'spelllang' are used. See |spell|.
2580
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002581 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002582 after a comma are ignored, otherwise spaces are included in the file
2583 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002584 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002585 Where to find a list of words?
2586 - On FreeBSD, there is the file "/usr/share/dict/words".
2587 - In the Simtel archive, look in the "msdos/linguist" directory.
2588 - In "miscfiles" of the GNU collection.
2589 The use of |:set+=| and |:set-=| is preferred when adding or removing
2590 directories from the list. This avoids problems when a future version
2591 uses another default.
2592 Backticks cannot be used in this option for security reasons.
2593
2594 *'diff'* *'nodiff'*
2595'diff' boolean (default off)
2596 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00002597 {not available when compiled without the |+diff|
2598 feature}
2599 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002600 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002601
2602 *'dex'* *'diffexpr'*
2603'diffexpr' 'dex' string (default "")
2604 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002605 {not available when compiled without the |+diff|
2606 feature}
Bram Moolenaare828b762018-09-10 17:51:58 +02002607 Expression which is evaluated to obtain a diff file (either ed-style
2608 or unified-style) from two versions of a file. See |diff-diffexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002609 This option cannot be set from a |modeline| or in the |sandbox|, for
2610 security reasons.
2611
2612 *'dip'* *'diffopt'*
Bram Moolenaarc8234772019-11-10 21:00:27 +01002613'diffopt' 'dip' string (default "internal,filler,closeoff")
Bram Moolenaar071d4272004-06-13 20:20:40 +00002614 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002615 {not available when compiled without the |+diff|
2616 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002617 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002618 All are optional. Items must be separated by a comma.
2619
2620 filler Show filler lines, to keep the text
2621 synchronized with a window that has inserted
2622 lines at the same position. Mostly useful
2623 when windows are side-by-side and 'scrollbind'
2624 is set.
2625
2626 context:{n} Use a context of {n} lines between a change
2627 and a fold that contains unchanged lines.
2628 When omitted a context of six lines is used.
Bram Moolenaarf6b40102019-02-22 15:24:03 +01002629 When using zero the context is actually one,
2630 since folds require a line in between, also
2631 for a deleted line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002632 See |fold-diff|.
2633
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002634 iblank Ignore changes where lines are all blank. Adds
2635 the "-B" flag to the "diff" command if
2636 'diffexpr' is empty. Check the documentation
2637 of the "diff" command for what this does
2638 exactly.
2639 NOTE: the diff windows will get out of sync,
2640 because no differences between blank lines are
2641 taken into account.
2642
Bram Moolenaar071d4272004-06-13 20:20:40 +00002643 icase Ignore changes in case of text. "a" and "A"
2644 are considered the same. Adds the "-i" flag
2645 to the "diff" command if 'diffexpr' is empty.
2646
2647 iwhite Ignore changes in amount of white space. Adds
2648 the "-b" flag to the "diff" command if
2649 'diffexpr' is empty. Check the documentation
2650 of the "diff" command for what this does
2651 exactly. It should ignore adding trailing
2652 white space, but not leading white space.
2653
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002654 iwhiteall Ignore all white space changes. Adds
2655 the "-w" flag to the "diff" command if
2656 'diffexpr' is empty. Check the documentation
2657 of the "diff" command for what this does
2658 exactly.
2659
2660 iwhiteeol Ignore white space changes at end of line.
2661 Adds the "-Z" flag to the "diff" command if
2662 'diffexpr' is empty. Check the documentation
2663 of the "diff" command for what this does
2664 exactly.
2665
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002666 horizontal Start diff mode with horizontal splits (unless
2667 explicitly specified otherwise).
2668
2669 vertical Start diff mode with vertical splits (unless
2670 explicitly specified otherwise).
2671
Bram Moolenaarc8234772019-11-10 21:00:27 +01002672 closeoff When a window is closed where 'diff' is set
2673 and there is only one window remaining in the
2674 same tab page with 'diff' set, execute
2675 `:diffoff` in that window. This undoes a
2676 `:diffsplit` command.
2677
Bram Moolenaar97ce4192017-12-01 20:35:58 +01002678 hiddenoff Do not use diff mode for a buffer when it
2679 becomes hidden.
2680
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002681 foldcolumn:{n} Set the 'foldcolumn' option to {n} when
2682 starting diff mode. Without this 2 is used.
2683
Bram Moolenaar4223d432021-02-10 13:18:17 +01002684 followwrap Follow the 'wrap' option and leave as it is.
2685
Bram Moolenaare828b762018-09-10 17:51:58 +02002686 internal Use the internal diff library. This is
2687 ignored when 'diffexpr' is set. *E960*
2688 When running out of memory when writing a
2689 buffer this item will be ignored for diffs
2690 involving that buffer. Set the 'verbose'
2691 option to see when this happens.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002692
Bram Moolenaare828b762018-09-10 17:51:58 +02002693 indent-heuristic
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01002694 Use the indent heuristic for the internal
2695 diff library.
Bram Moolenaare828b762018-09-10 17:51:58 +02002696
2697 algorithm:{text} Use the specified diff algorithm with the
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01002698 internal diff engine. Currently supported
Bram Moolenaare828b762018-09-10 17:51:58 +02002699 algorithms are:
2700 myers the default algorithm
2701 minimal spend extra time to generate the
2702 smallest possible diff
2703 patience patience diff algorithm
2704 histogram histogram diff algorithm
2705
2706 Examples: >
2707 :set diffopt=internal,filler,context:4
Bram Moolenaar071d4272004-06-13 20:20:40 +00002708 :set diffopt=
Bram Moolenaare828b762018-09-10 17:51:58 +02002709 :set diffopt=internal,filler,foldcolumn:3
2710 :set diffopt-=internal " do NOT use the internal diff parser
Bram Moolenaar071d4272004-06-13 20:20:40 +00002711<
2712 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
2713'digraph' 'dg' boolean (default off)
2714 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002715 {not available when compiled without the |+digraphs|
2716 feature}
2717 Enable the entering of digraphs in Insert mode with {char1} <BS>
2718 {char2}. See |digraphs|.
2719 NOTE: This option is reset when 'compatible' is set.
2720
2721 *'directory'* *'dir'*
2722'directory' 'dir' string (default for Amiga: ".,t:",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01002723 for Win32: ".,$TEMP,c:\tmp,c:\temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00002724 for Unix: ".,~/tmp,/var/tmp,/tmp")
2725 global
2726 List of directory names for the swap file, separated with commas.
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02002727 Recommended value: ".,~/vimswap//" - this will put the swap file next
2728 to the edited file if possible, and in your personal swap directory
2729 otherwise. Make sure "~/vimswap//" is only readable for you.
2730
2731 Possible items:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002732 - The swap file will be created in the first directory where this is
2733 possible.
2734 - Empty means that no swap file will be used (recovery is
Bram Moolenaar00e192b2019-10-19 17:01:28 +02002735 impossible!) and no |E303| error will be given.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002736 - A directory "." means to put the swap file in the same directory as
2737 the edited file. On Unix, a dot is prepended to the file name, so
2738 it doesn't show in a directory listing. On MS-Windows the "hidden"
2739 attribute is set and a dot prepended if possible.
Bram Moolenaar8024f932020-01-14 19:29:13 +01002740 - A directory starting with "./" (or ".\" for MS-Windows) means to put
2741 the swap file relative to where the edited file is. The leading "."
2742 is replaced with the path name of the edited file.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02002743 - For Unix and Win32, if a directory ends in two path separators "//",
2744 the swap file name will be built from the complete path to the file
Bram Moolenaar207f0092020-08-30 17:20:20 +02002745 with all path separators replaced by percent '%' signs (including
2746 the colon following the drive letter on Win32). This will ensure
2747 file name uniqueness in the preserve directory.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02002748 On Win32, it is also possible to end with "\\". However, When a
2749 separating comma is following, you must use "//", since "\\" will
2750 include the comma in the file name. Therefore it is recommended to
2751 use '//', instead of '\\'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002752 - Spaces after the comma are ignored, other spaces are considered part
2753 of the directory name. To have a space at the start of a directory
2754 name, precede it with a backslash.
2755 - To include a comma in a directory name precede it with a backslash.
2756 - A directory name may end in an ':' or '/'.
2757 - Environment variables are expanded |:set_env|.
2758 - Careful with '\' characters, type one before a space, type two to
2759 get one in the option (see |option-backslash|), for example: >
2760 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
2761< - For backwards compatibility with Vim version 3.0 a '>' at the start
2762 of the option is removed.
2763 Using "." first in the list is recommended. This means that editing
2764 the same file twice will result in a warning. Using "/tmp" on Unix is
2765 discouraged: When the system crashes you lose the swap file.
2766 "/var/tmp" is often not cleared when rebooting, thus is a better
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02002767 choice than "/tmp". But others on the computer may be able to see the
2768 files, and it can contain a lot of files, your swap files get lost in
2769 the crowd. That is why a "tmp" directory in your home directory is
2770 tried first.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002771 The use of |:set+=| and |:set-=| is preferred when adding or removing
2772 directories from the list. This avoids problems when a future version
2773 uses another default.
2774 This option cannot be set from a |modeline| or in the |sandbox|, for
2775 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002776
2777 *'display'* *'dy'*
Bram Moolenaarbc8801c2016-08-02 21:04:33 +02002778'display' 'dy' string (default "", set to "truncate" in
2779 |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002780 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002781 Change the way text is displayed. This is comma separated list of
2782 flags:
2783 lastline When included, as much as possible of the last line
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02002784 in a window will be displayed. "@@@" is put in the
2785 last columns of the last screen line to indicate the
2786 rest of the line is not displayed.
2787 truncate Like "lastline", but "@@@" is displayed in the first
2788 column of the last screen line. Overrules "lastline".
Bram Moolenaar071d4272004-06-13 20:20:40 +00002789 uhex Show unprintable characters hexadecimal as <xx>
2790 instead of using ^C and ~C.
2791
Bram Moolenaard0796902016-09-16 20:02:31 +02002792 When neither "lastline" nor "truncate" is included, a last line that
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02002793 doesn't fit is replaced with "@" lines.
2794
Bram Moolenaar071d4272004-06-13 20:20:40 +00002795 *'eadirection'* *'ead'*
2796'eadirection' 'ead' string (default "both")
2797 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002798 Tells when the 'equalalways' option applies:
2799 ver vertically, width of windows is not affected
2800 hor horizontally, height of windows is not affected
2801 both width and height of windows is affected
2802
2803 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
2804'edcompatible' 'ed' boolean (default off)
2805 global
2806 Makes the 'g' and 'c' flags of the ":substitute" command to be
2807 toggled each time the flag is given. See |complex-change|. See
2808 also 'gdefault' option.
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +02002809 Switching this option on may break plugins!
Bram Moolenaar4072ba52020-12-23 13:56:35 +01002810 This option is not used in |Vim9| script.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002811
Bram Moolenaar03413f42016-04-12 21:07:15 +02002812 *'emoji'* *'emo'* *'noemoji'* *'noemo'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01002813'emoji' 'emo' boolean (default: on)
2814 global
Bram Moolenaar3848e002016-03-19 18:42:29 +01002815 When on all Unicode emoji characters are considered to be full width.
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02002816 This excludes "text emoji" characters, which are normally displayed as
2817 single width. Unfortunately there is no good specification for this
2818 and it has been determined on trial-and-error basis. Use the
2819 |setcellwidths()| function to change the behavior.
Bram Moolenaar3848e002016-03-19 18:42:29 +01002820
Bram Moolenaar071d4272004-06-13 20:20:40 +00002821 *'encoding'* *'enc'* *E543*
2822'encoding' 'enc' string (default: "latin1" or value from $LANG)
2823 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002824 Sets the character encoding used inside Vim. It applies to text in
2825 the buffers, registers, Strings in expressions, text stored in the
2826 viminfo file, etc. It sets the kind of characters which Vim can work
2827 with. See |encoding-names| for the possible values.
2828
2829 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002830 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002831 It should normally be kept at its default value, or set when Vim
Bram Moolenaar02467872007-05-06 13:22:01 +00002832 starts up. See |multibyte|. To reload the menus see |:menutrans|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002833
Bram Moolenaar865242e2010-07-14 21:12:05 +02002834 This option cannot be set from a |modeline|. It would most likely
2835 corrupt the text.
2836
Bram Moolenaar3df01732017-02-17 22:47:16 +01002837 NOTE: For GTK+ 2 or later, it is highly recommended to set 'encoding'
2838 to "utf-8". Although care has been taken to allow different values of
Bram Moolenaar071d4272004-06-13 20:20:40 +00002839 'encoding', "utf-8" is the natural choice for the environment and
2840 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002841 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00002842 versions, and to avoid changing the encoding of newly created files
2843 without your knowledge (in case 'fileencodings' is empty).
2844
2845 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002846 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00002847 iconv() or as specified with 'charconvert'.
2848
Bram Moolenaar207f0092020-08-30 17:20:20 +02002849 If you need to know whether 'encoding' is a multibyte encoding, you
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002850 can use: >
2851 if has("multi_byte_encoding")
2852<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002853 Normally 'encoding' will be equal to your current locale. This will
2854 be the default if Vim recognizes your environment settings. If
2855 'encoding' is not set to the current locale, 'termencoding' must be
2856 set to convert typed and displayed text. See |encoding-table|.
2857
2858 When you set this option, it fires the |EncodingChanged| autocommand
2859 event so that you can set up fonts if necessary.
2860
2861 When the option is set, the value is converted to lowercase. Thus
2862 you can set it with uppercase values too. Underscores are translated
2863 to '-' signs.
2864 When the encoding is recognized, it is changed to the standard name.
2865 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
2866 "iso-8859-2" and "utf8" becomes "utf-8".
2867
2868 Note: "latin1" is also used when the encoding could not be detected.
2869 This only works when editing files in the same encoding! When the
2870 actual character set is not latin1, make sure 'fileencoding' and
2871 'fileencodings' are empty. When conversion is needed, switch to using
2872 utf-8.
2873
2874 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
2875 You don't notice this while editing, but it does matter for the
2876 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
2877 setting 'encoding' to one of these values instead of utf-8 only has
2878 effect for encoding used for files when 'fileencoding' is empty.
2879
Bram Moolenaar661b1822005-07-28 22:36:45 +00002880 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
2881 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002882
2883 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
2884'endofline' 'eol' boolean (default on)
2885 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002886 When writing a file and this option is off and the 'binary' option
Bram Moolenaar34d72d42015-07-17 14:18:08 +02002887 is on, or 'fixeol' option is off, no <EOL> will be written for the
2888 last line in the file. This option is automatically set or reset when
2889 starting to edit a new file, depending on whether file has an <EOL>
2890 for the last line in the file. Normally you don't have to set or
2891 reset this option.
2892 When 'binary' is off and 'fixeol' is on the value is not used when
2893 writing the file. When 'binary' is on or 'fixeol' is off it is used
2894 to remember the presence of a <EOL> for the last line in the file, so
2895 that when you write the file the situation from the original file can
2896 be kept. But you can change it if you want to.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002897
2898 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
2899'equalalways' 'ea' boolean (default on)
2900 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002901 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00002902 splitting or closing a window. This also happens the moment the
2903 option is switched on. When off, splitting a window will reduce the
2904 size of the current window and leave the other windows the same. When
2905 closing a window the extra lines are given to the window next to it
2906 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00002907 When mixing vertically and horizontally split windows, a minimal size
2908 is computed and some windows may be larger if there is room. The
2909 'eadirection' option tells in which direction the size is affected.
Bram Moolenaar67f71312007-08-12 14:55:56 +00002910 Changing the height and width of a window can be avoided by setting
2911 'winfixheight' and 'winfixwidth', respectively.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002912 If a window size is specified when creating a new window sizes are
2913 currently not equalized (it's complicated, but may be implemented in
2914 the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002915
2916 *'equalprg'* *'ep'*
2917'equalprg' 'ep' string (default "")
2918 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002919 External program to use for "=" command. When this option is empty
Bram Moolenaar446cb832008-06-24 21:56:24 +00002920 the internal formatting functions are used; either 'lisp', 'cindent'
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002921 or 'indentexpr'. When Vim was compiled without internal formatting,
2922 the "indent" program is used.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002923 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002924 about including spaces and backslashes.
2925 This option cannot be set from a |modeline| or in the |sandbox|, for
2926 security reasons.
2927
2928 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
2929'errorbells' 'eb' boolean (default off)
2930 global
2931 Ring the bell (beep or screen flash) for error messages. This only
2932 makes a difference for error messages, the bell will be used always
2933 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002934 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar165bc692015-07-21 17:53:25 +02002935 screen flash or do nothing. See 'belloff' to finetune when to ring the
2936 bell.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002937
2938 *'errorfile'* *'ef'*
2939'errorfile' 'ef' string (Amiga default: "AztecC.Err",
2940 others: "errors.err")
2941 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002942 {not available when compiled without the |+quickfix|
2943 feature}
2944 Name of the errorfile for the QuickFix mode (see |:cf|).
2945 When the "-q" command-line argument is used, 'errorfile' is set to the
2946 following argument. See |-q|.
2947 NOT used for the ":make" command. See 'makeef' for that.
2948 Environment variables are expanded |:set_env|.
2949 See |option-backslash| about including spaces and backslashes.
2950 This option cannot be set from a |modeline| or in the |sandbox|, for
2951 security reasons.
2952
2953 *'errorformat'* *'efm'*
2954'errorformat' 'efm' string (default is very long)
2955 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002956 {not available when compiled without the |+quickfix|
2957 feature}
2958 Scanf-like description of the format for the lines in the error file
2959 (see |errorformat|).
2960
2961 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
2962'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
2963 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002964 Function keys that start with an <Esc> are recognized in Insert
2965 mode. When this option is off, the cursor and function keys cannot be
2966 used in Insert mode if they start with an <Esc>. The advantage of
2967 this is that the single <Esc> is recognized immediately, instead of
2968 after one second. Instead of resetting this option, you might want to
2969 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
2970 when 'esckeys' is off, you can still map anything, but the cursor keys
2971 won't work by default.
2972 NOTE: This option is set to the Vi default value when 'compatible' is
2973 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaarc8234772019-11-10 21:00:27 +01002974 NOTE: when this option is off then the |modifyOtherKeys| functionality
2975 is disabled while in Insert mode to avoid ending Insert mode with any
2976 key that has a modifier.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002977
2978 *'eventignore'* *'ei'*
2979'eventignore' 'ei' string (default "")
2980 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002981 A list of autocommand event names, which are to be ignored.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00002982 When set to "all" or when "all" is one of the items, all autocommand
2983 events are ignored, autocommands will not be executed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002984 Otherwise this is a comma separated list of event names. Example: >
2985 :set ei=WinEnter,WinLeave
2986<
2987 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
2988'expandtab' 'et' boolean (default off)
2989 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002990 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002991 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002992 when 'autoindent' is on. To insert a real tab when 'expandtab' is
2993 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
Bram Moolenaarca635012015-09-25 20:34:21 +02002994 This option is reset when the 'paste' option is set and restored when
2995 the 'paste' option is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002996 NOTE: This option is reset when 'compatible' is set.
2997
2998 *'exrc'* *'ex'* *'noexrc'* *'noex'*
2999'exrc' 'ex' boolean (default off)
3000 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003001 Enables the reading of .vimrc, .exrc and .gvimrc in the current
Bram Moolenaar36f44c22016-08-28 18:17:20 +02003002 directory.
3003
3004 Setting this option is a potential security leak. E.g., consider
3005 unpacking a package or fetching files from github, a .vimrc in there
3006 might be a trojan horse. BETTER NOT SET THIS OPTION!
3007 Instead, define an autocommand in your .vimrc to set options for a
3008 matching directory.
3009
3010 If you do switch this option on you should also consider setting the
3011 'secure' option (see |initialization|).
3012 Also see |.vimrc| and |gui-init|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003013 This option cannot be set from a |modeline| or in the |sandbox|, for
3014 security reasons.
3015
3016 *'fileencoding'* *'fenc'* *E213*
3017'fileencoding' 'fenc' string (default: "")
3018 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003019 Sets the character encoding for the file of this buffer.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003020
Bram Moolenaar071d4272004-06-13 20:20:40 +00003021 When 'fileencoding' is different from 'encoding', conversion will be
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003022 done when writing the file. For reading see below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003023 When 'fileencoding' is empty, the same value as 'encoding' will be
3024 used (no conversion when reading or writing a file).
Bram Moolenaar214641f2017-03-05 17:04:09 +01003025 No error will be given when the value is set, only when it is used,
3026 only when writing a file.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003027 Conversion will also be done when 'encoding' and 'fileencoding' are
3028 both a Unicode encoding and 'fileencoding' is not utf-8. That's
3029 because internally Unicode is always stored as utf-8.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003030 WARNING: Conversion can cause loss of information! When
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003031 'encoding' is "utf-8" or another Unicode encoding, conversion
3032 is most likely done in a way that the reverse conversion
3033 results in the same text. When 'encoding' is not "utf-8" some
3034 characters may be lost!
Bram Moolenaar865242e2010-07-14 21:12:05 +02003035
Bram Moolenaar071d4272004-06-13 20:20:40 +00003036 See 'encoding' for the possible values. Additionally, values may be
3037 specified that can be handled by the converter, see
3038 |mbyte-conversion|.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003039
Bram Moolenaar071d4272004-06-13 20:20:40 +00003040 When reading a file 'fileencoding' will be set from 'fileencodings'.
3041 To read a file in a certain encoding it won't work by setting
Bram Moolenaar02467872007-05-06 13:22:01 +00003042 'fileencoding', use the |++enc| argument. One exception: when
3043 'fileencodings' is empty the value of 'fileencoding' is used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003044 For a new file the global value of 'fileencoding' is used.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003045
Bram Moolenaar071d4272004-06-13 20:20:40 +00003046 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
3047 When the option is set, the value is converted to lowercase. Thus
3048 you can set it with uppercase values too. '_' characters are
3049 replaced with '-'. If a name is recognized from the list for
3050 'encoding', it is replaced by the standard name. For example
3051 "ISO8859-2" becomes "iso-8859-2".
Bram Moolenaar865242e2010-07-14 21:12:05 +02003052
Bram Moolenaar071d4272004-06-13 20:20:40 +00003053 When this option is set, after starting to edit a file, the 'modified'
3054 option is set, because the file would be different when written.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003055
3056 Keep in mind that changing 'fenc' from a modeline happens
3057 AFTER the text has been read, thus it applies to when the file will be
3058 written. If you do set 'fenc' in a modeline, you might want to set
3059 'nomodified' to avoid not being able to ":q".
3060
Bram Moolenaar071d4272004-06-13 20:20:40 +00003061 This option can not be changed when 'modifiable' is off.
3062
3063 *'fe'*
3064 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003065 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003066 old short name was 'fe', which is no longer used.
3067
3068 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003069'fileencodings' 'fencs' string (default: "ucs-bom",
3070 "ucs-bom,utf-8,default,latin1" when
3071 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003072 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003073 This is a list of character encodings considered when starting to edit
3074 an existing file. When a file is read, Vim tries to use the first
3075 mentioned character encoding. If an error is detected, the next one
3076 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003077 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00003078 an empty string, which means the value of 'encoding' is used.
3079 WARNING: Conversion can cause loss of information! When
3080 'encoding' is "utf-8" (or one of the other Unicode variants)
3081 conversion is most likely done in a way that the reverse
3082 conversion results in the same text. When 'encoding' is not
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003083 "utf-8" some non-ASCII characters may be lost! You can use
3084 the |++bad| argument to specify what is done with characters
3085 that can't be converted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003086 For an empty file or a file with only ASCII characters most encodings
3087 will work and the first entry of 'fileencodings' will be used (except
3088 "ucs-bom", which requires the BOM to be present). If you prefer
3089 another encoding use an BufReadPost autocommand event to test if your
3090 preferred encoding is to be used. Example: >
3091 au BufReadPost * if search('\S', 'w') == 0 |
3092 \ set fenc=iso-2022-jp | endif
3093< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
3094 non-blank characters.
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003095 When the |++enc| argument is used then the value of 'fileencodings' is
3096 not used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003097 Note that 'fileencodings' is not used for a new file, the global value
3098 of 'fileencoding' is used instead. You can set it with: >
3099 :setglobal fenc=iso-8859-2
3100< This means that a non-existing file may get a different encoding than
3101 an empty file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003102 The special value "ucs-bom" can be used to check for a Unicode BOM
3103 (Byte Order Mark) at the start of the file. It must not be preceded
3104 by "utf-8" or another Unicode encoding for this to work properly.
3105 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
3106 because Vim cannot detect an error, thus the encoding is always
3107 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003108 The special value "default" can be used for the encoding from the
3109 environment. This is the default value for 'encoding'. It is useful
3110 when 'encoding' is set to "utf-8" and your environment uses a
3111 non-latin1 encoding, such as Russian.
Bram Moolenaarca003e12006-03-17 23:19:38 +00003112 When 'encoding' is "utf-8" and a file contains an illegal byte
3113 sequence it won't be recognized as UTF-8. You can use the |8g8|
3114 command to find the illegal byte sequence.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003115 WRONG VALUES: WHAT'S WRONG:
3116 latin1,utf-8 "latin1" will always be used
3117 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
3118 file
3119 cp1250,latin1 "cp1250" will always be used
3120 If 'fileencodings' is empty, 'fileencoding' is not modified.
3121 See 'fileencoding' for the possible values.
3122 Setting this option does not have an effect until the next time a file
3123 is read.
3124
3125 *'fileformat'* *'ff'*
Bram Moolenaar00590742019-02-15 21:06:09 +01003126'fileformat' 'ff' string (MS-Windows default: "dos",
3127 Unix, macOS default: "unix")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003128 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003129 This gives the <EOL> of the current buffer, which is used for
3130 reading/writing the buffer from/to a file:
Bram Moolenaar4072ba52020-12-23 13:56:35 +01003131 dos <CR><NL>
Bram Moolenaar071d4272004-06-13 20:20:40 +00003132 unix <NL>
3133 mac <CR>
3134 When "dos" is used, CTRL-Z at the end of a file is ignored.
3135 See |file-formats| and |file-read|.
3136 For the character encoding of the file see 'fileencoding'.
3137 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
Bram Moolenaarbf884932013-04-05 22:26:15 +02003138 works like it was set to "unix".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003139 This option is set automatically when starting to edit a file and
3140 'fileformats' is not empty and 'binary' is off.
3141 When this option is set, after starting to edit a file, the 'modified'
3142 option is set, because the file would be different when written.
3143 This option can not be changed when 'modifiable' is off.
3144 For backwards compatibility: When this option is set to "dos",
3145 'textmode' is set, otherwise 'textmode' is reset.
3146
3147 *'fileformats'* *'ffs'*
3148'fileformats' 'ffs' string (default:
Bram Moolenaar00590742019-02-15 21:06:09 +01003149 Vim+Vi MS-Windows: "dos,unix",
3150 Vim Unix, macOS: "unix,dos",
Bram Moolenaar071d4272004-06-13 20:20:40 +00003151 Vi Cygwin: "unix,dos",
3152 Vi others: "")
3153 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003154 This gives the end-of-line (<EOL>) formats that will be tried when
3155 starting to edit a new buffer and when reading a file into an existing
3156 buffer:
3157 - When empty, the format defined with 'fileformat' will be used
3158 always. It is not set automatically.
3159 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003160 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003161 'fileformats' name will be used when a file is read into an existing
3162 buffer, no matter what 'fileformat' for that buffer is set to.
3163 - When more than one name is present, separated by commas, automatic
3164 <EOL> detection will be done when reading a file. When starting to
3165 edit a file, a check is done for the <EOL>:
3166 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
3167 'fileformat' is set to "dos".
3168 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003169 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003170 preceding <CR>, "unix" is preferred over "dos".
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01003171 3. If 'fileformat' has not yet been set, and if a <CR> is found, and
3172 if 'fileformats' includes "mac", 'fileformat' is set to "mac".
Bram Moolenaar00659062010-09-21 22:34:02 +02003173 This means that "mac" is only chosen when:
3174 "unix" is not present or no <NL> is found in the file, and
3175 "dos" is not present or no <CR><NL> is found in the file.
3176 Except: if "unix" was chosen, but there is a <CR> before
3177 the first <NL>, and there appear to be more <CR>s than <NL>s in
Bram Moolenaar166af9b2010-11-16 20:34:40 +01003178 the first few lines, "mac" is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003179 4. If 'fileformat' is still not set, the first name from
3180 'fileformats' is used.
3181 When reading a file into an existing buffer, the same is done, but
3182 this happens like 'fileformat' has been set appropriately for that
3183 file only, the option is not changed.
3184 When 'binary' is set, the value of 'fileformats' is not used.
3185
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01003186 When Vim starts up with an empty buffer the first item is used. You
3187 can overrule this by setting 'fileformat' in your .vimrc.
Bram Moolenaar81af9252010-12-10 20:35:50 +01003188
Bram Moolenaar071d4272004-06-13 20:20:40 +00003189 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
3190 are ":source"ed and for vimrc files, automatic <EOL> detection may be
3191 done:
3192 - When 'fileformats' is empty, there is no automatic detection. Dos
3193 format will be used.
3194 - When 'fileformats' is set to one or more names, automatic detection
3195 is done. This is based on the first <NL> in the file: If there is a
3196 <CR> in front of it, Dos format is used, otherwise Unix format is
3197 used.
3198 Also see |file-formats|.
3199 For backwards compatibility: When this option is set to an empty
3200 string or one format (no comma is included), 'textauto' is reset,
3201 otherwise 'textauto' is set.
3202 NOTE: This option is set to the Vi default value when 'compatible' is
3203 set and to the Vim default value when 'compatible' is reset.
3204
Bram Moolenaarbf884932013-04-05 22:26:15 +02003205 *'fileignorecase'* *'fic'* *'nofileignorecase'* *'nofic'*
3206'fileignorecase' 'fic' boolean (default on for systems where case in file
3207 names is normally ignored)
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003208 global
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003209 When set case is ignored when using file names and directories.
3210 See 'wildignorecase' for only ignoring case when doing completion.
3211
Bram Moolenaar071d4272004-06-13 20:20:40 +00003212 *'filetype'* *'ft'*
3213'filetype' 'ft' string (default: "")
3214 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003215 When this option is set, the FileType autocommand event is triggered.
3216 All autocommands that match with the value of this option will be
3217 executed. Thus the value of 'filetype' is used in place of the file
3218 name.
3219 Otherwise this option does not always reflect the current file type.
3220 This option is normally set when the file type is detected. To enable
3221 this use the ":filetype on" command. |:filetype|
3222 Setting this option to a different value is most useful in a modeline,
3223 for a file for which the file type is not automatically recognized.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003224 Example, for in an IDL file:
3225 /* vim: set filetype=idl : */ ~
3226 |FileType| |filetypes|
3227 When a dot appears in the value then this separates two filetype
3228 names. Example:
3229 /* vim: set filetype=c.doxygen : */ ~
3230 This will use the "c" filetype first, then the "doxygen" filetype.
3231 This works both for filetype plugins and for syntax files. More than
3232 one dot may appear.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003233 This option is not copied to another buffer, independent of the 's' or
3234 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003235 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003236
3237 *'fillchars'* *'fcs'*
3238'fillchars' 'fcs' string (default "vert:|,fold:-")
3239 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02003240 {not available when compiled without the |+folding|
3241 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003242 Characters to fill the statuslines and vertical separators.
3243 It is a comma separated list of items:
3244
3245 item default Used for ~
3246 stl:c ' ' or '^' statusline of the current window
Bram Moolenaar38a55632016-02-15 22:07:32 +01003247 stlnc:c ' ' or '=' statusline of the non-current windows
Bram Moolenaar071d4272004-06-13 20:20:40 +00003248 vert:c '|' vertical separators |:vsplit|
3249 fold:c '-' filling 'foldtext'
3250 diff:c '-' deleted lines of the 'diff' option
3251
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003252 Any one that is omitted will fall back to the default. For "stl" and
Bram Moolenaar38a55632016-02-15 22:07:32 +01003253 "stlnc" the space will be used when there is highlighting, '^' or '='
Bram Moolenaar071d4272004-06-13 20:20:40 +00003254 otherwise.
3255
3256 Example: >
Bram Moolenaar38a55632016-02-15 22:07:32 +01003257 :set fillchars=stl:^,stlnc:=,vert:\|,fold:-,diff:-
Bram Moolenaar071d4272004-06-13 20:20:40 +00003258< This is similar to the default, except that these characters will also
3259 be used when there is highlighting.
3260
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003261 for "stl" and "stlnc" only single-byte values are supported.
3262
Bram Moolenaar071d4272004-06-13 20:20:40 +00003263 The highlighting used for these items:
3264 item highlight group ~
3265 stl:c StatusLine |hl-StatusLine|
3266 stlnc:c StatusLineNC |hl-StatusLineNC|
3267 vert:c VertSplit |hl-VertSplit|
3268 fold:c Folded |hl-Folded|
3269 diff:c DiffDelete |hl-DiffDelete|
3270
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003271 *'fixendofline'* *'fixeol'* *'nofixendofline'* *'nofixeol'*
3272'fixendofline' 'fixeol' boolean (default on)
3273 local to buffer
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003274 When writing a file and this option is on, <EOL> at the end of file
3275 will be restored if missing. Turn this option off if you want to
3276 preserve the situation from the original file.
3277 When the 'binary' option is set the value of this option doesn't
3278 matter.
3279 See the 'endofline' option.
3280
Bram Moolenaar071d4272004-06-13 20:20:40 +00003281 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
Bram Moolenaar98a29d02021-01-18 19:55:44 +01003282'fkmap' 'fk' boolean (default off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003283 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003284 {only available when compiled with the |+rightleft|
3285 feature}
Bram Moolenaar14184a32019-02-16 15:10:30 +01003286 This option was for using Farsi, which has been removed. See
3287 |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003288
3289 *'foldclose'* *'fcl'*
3290'foldclose' 'fcl' string (default "")
3291 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003292 {not available when compiled without the |+folding|
3293 feature}
3294 When set to "all", a fold is closed when the cursor isn't in it and
3295 its level is higher than 'foldlevel'. Useful if you want folds to
3296 automatically close when moving out of them.
3297
3298 *'foldcolumn'* *'fdc'*
3299'foldcolumn' 'fdc' number (default 0)
3300 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003301 {not available when compiled without the |+folding|
3302 feature}
3303 When non-zero, a column with the specified width is shown at the side
3304 of the window which indicates open and closed folds. The maximum
3305 value is 12.
3306 See |folding|.
3307
3308 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
3309'foldenable' 'fen' boolean (default on)
3310 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003311 {not available when compiled without the |+folding|
3312 feature}
3313 When off, all folds are open. This option can be used to quickly
3314 switch between showing all text unfolded and viewing the text with
3315 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003316 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00003317 'foldenable' is off.
3318 This option is set by commands that create a new fold or close a fold.
3319 See |folding|.
3320
3321 *'foldexpr'* *'fde'*
3322'foldexpr' 'fde' string (default: "0")
3323 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003324 {not available when compiled without the |+folding|
Bram Moolenaardb84e452010-08-15 13:50:43 +02003325 or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003326 The expression used for when 'foldmethod' is "expr". It is evaluated
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003327 for each line to obtain its fold level. See |fold-expr|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003328
Bram Moolenaar30b65812012-07-12 22:01:11 +02003329 The expression will be evaluated in the |sandbox| if set from a
3330 modeline, see |sandbox-option|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003331 This option can't be set from a |modeline| when the 'diff' option is
Bram Moolenaar110289e2019-05-23 15:38:06 +02003332 on or the 'modelineexpr' option is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003333
3334 It is not allowed to change text or jump to another window while
3335 evaluating 'foldexpr' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003336
3337 *'foldignore'* *'fdi'*
3338'foldignore' 'fdi' string (default: "#")
3339 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003340 {not available when compiled without the |+folding|
3341 feature}
3342 Used only when 'foldmethod' is "indent". Lines starting with
3343 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003344 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003345 The default "#" works well for C programs. See |fold-indent|.
3346
3347 *'foldlevel'* *'fdl'*
3348'foldlevel' 'fdl' number (default: 0)
3349 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003350 {not available when compiled without the |+folding|
3351 feature}
3352 Sets the fold level: Folds with a higher level will be closed.
3353 Setting this option to zero will close all folds. Higher numbers will
3354 close fewer folds.
3355 This option is set by commands like |zm|, |zM| and |zR|.
3356 See |fold-foldlevel|.
3357
3358 *'foldlevelstart'* *'fdls'*
3359'foldlevelstart' 'fdls' number (default: -1)
3360 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003361 {not available when compiled without the |+folding|
3362 feature}
3363 Sets 'foldlevel' when starting to edit another buffer in a window.
3364 Useful to always start editing with all folds closed (value zero),
3365 some folds closed (one) or no folds closed (99).
3366 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003367 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00003368 ignores this option and closes all folds.
3369 It is also done before BufReadPre autocommands, to allow an autocmd to
3370 overrule the 'foldlevel' value for specific files.
3371 When the value is negative, it is not used.
3372
3373 *'foldmarker'* *'fmr'* *E536*
3374'foldmarker' 'fmr' string (default: "{{{,}}}")
3375 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003376 {not available when compiled without the |+folding|
3377 feature}
3378 The start and end marker used when 'foldmethod' is "marker". There
3379 must be one comma, which separates the start and end marker. The
3380 marker is a literal string (a regular expression would be too slow).
3381 See |fold-marker|.
3382
3383 *'foldmethod'* *'fdm'*
3384'foldmethod' 'fdm' string (default: "manual")
3385 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003386 {not available when compiled without the |+folding|
3387 feature}
3388 The kind of folding used for the current window. Possible values:
3389 |fold-manual| manual Folds are created manually.
3390 |fold-indent| indent Lines with equal indent form a fold.
3391 |fold-expr| expr 'foldexpr' gives the fold level of a line.
3392 |fold-marker| marker Markers are used to specify folds.
3393 |fold-syntax| syntax Syntax highlighting items specify folds.
3394 |fold-diff| diff Fold text that is not changed.
3395
3396 *'foldminlines'* *'fml'*
3397'foldminlines' 'fml' number (default: 1)
3398 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003399 {not available when compiled without the |+folding|
3400 feature}
Bram Moolenaar00654022011-02-25 14:42:19 +01003401 Sets the number of screen lines above which a fold can be displayed
3402 closed. Also for manually closed folds. With the default value of
3403 one a fold can only be closed if it takes up two or more screen lines.
3404 Set to zero to be able to close folds of just one screen line.
Bram Moolenaar446beb42011-05-10 17:18:44 +02003405 Note that this only has an effect on what is displayed. After using
Bram Moolenaar071d4272004-06-13 20:20:40 +00003406 "zc" to close a fold, which is displayed open because it's smaller
3407 than 'foldminlines', a following "zc" may close a containing fold.
3408
3409 *'foldnestmax'* *'fdn'*
3410'foldnestmax' 'fdn' number (default: 20)
3411 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003412 {not available when compiled without the |+folding|
3413 feature}
3414 Sets the maximum nesting of folds for the "indent" and "syntax"
3415 methods. This avoids that too many folds will be created. Using more
3416 than 20 doesn't work, because the internal limit is 20.
3417
3418 *'foldopen'* *'fdo'*
3419'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
3420 search,tag,undo")
3421 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003422 {not available when compiled without the |+folding|
3423 feature}
3424 Specifies for which type of commands folds will be opened, if the
3425 command moves the cursor into a closed fold. It is a comma separated
3426 list of items.
Bram Moolenaar05365702010-10-27 18:34:44 +02003427 NOTE: When the command is part of a mapping this option is not used.
3428 Add the |zv| command to the mapping to get the same effect.
3429 (rationale: the mapping may want to control opening folds itself)
3430
Bram Moolenaar071d4272004-06-13 20:20:40 +00003431 item commands ~
3432 all any
3433 block "(", "{", "[[", "[{", etc.
3434 hor horizontal movements: "l", "w", "fx", etc.
3435 insert any command in Insert mode
3436 jump far jumps: "G", "gg", etc.
3437 mark jumping to a mark: "'m", CTRL-O, etc.
3438 percent "%"
3439 quickfix ":cn", ":crew", ":make", etc.
3440 search search for a pattern: "/", "n", "*", "gd", etc.
3441 (not for a search pattern in a ":" command)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003442 Also for |[s| and |]s|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003443 tag jumping to a tag: ":ta", CTRL-T, etc.
3444 undo undo or redo: "u" and CTRL-R
Bram Moolenaar071d4272004-06-13 20:20:40 +00003445 When a movement command is used for an operator (e.g., "dl" or "y%")
3446 this option is not used. This means the operator will include the
3447 whole closed fold.
3448 Note that vertical movements are not here, because it would make it
3449 very difficult to move onto a closed fold.
3450 In insert mode the folds containing the cursor will always be open
3451 when text is inserted.
3452 To close folds you can re-apply 'foldlevel' with the |zx| command or
3453 set the 'foldclose' option to "all".
3454
3455 *'foldtext'* *'fdt'*
3456'foldtext' 'fdt' string (default: "foldtext()")
3457 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003458 {not available when compiled without the |+folding|
3459 feature}
3460 An expression which is used to specify the text displayed for a closed
3461 fold. See |fold-foldtext|.
3462
Bram Moolenaar30b65812012-07-12 22:01:11 +02003463 The expression will be evaluated in the |sandbox| if set from a
3464 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003465 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003466
3467 It is not allowed to change text or jump to another window while
3468 evaluating 'foldtext' |textlock|.
3469
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003470 *'formatexpr'* *'fex'*
3471'formatexpr' 'fex' string (default "")
3472 local to buffer
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003473 {not available when compiled without the |+eval|
3474 feature}
3475 Expression which is evaluated to format a range of lines for the |gq|
3476 operator or automatic formatting (see 'formatoptions'). When this
3477 option is empty 'formatprg' is used.
3478
3479 The |v:lnum| variable holds the first line to be formatted.
3480 The |v:count| variable holds the number of lines to be formatted.
3481 The |v:char| variable holds the character that is going to be
3482 inserted if the expression is being evaluated due to
3483 automatic formatting. This can be empty. Don't insert
3484 it yet!
3485
3486 Example: >
3487 :set formatexpr=mylang#Format()
3488< This will invoke the mylang#Format() function in the
3489 autoload/mylang.vim file in 'runtimepath'. |autoload|
3490
3491 The expression is also evaluated when 'textwidth' is set and adding
3492 text beyond that limit. This happens under the same conditions as
3493 when internal formatting is used. Make sure the cursor is kept in the
3494 same spot relative to the text then! The |mode()| function will
3495 return "i" or "R" in this situation.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01003496
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003497 When the expression evaluates to non-zero Vim will fall back to using
3498 the internal format mechanism.
3499
3500 The expression will be evaluated in the |sandbox| when set from a
3501 modeline, see |sandbox-option|. That stops the option from working,
3502 since changing the buffer text is not allowed.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003503 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaar036986f2017-03-16 17:41:02 +01003504 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003505
Bram Moolenaar86b68352004-12-27 21:59:20 +00003506 *'formatlistpat'* *'flp'*
3507'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
3508 local to buffer
Bram Moolenaar86b68352004-12-27 21:59:20 +00003509 A pattern that is used to recognize a list header. This is used for
3510 the "n" flag in 'formatoptions'.
3511 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00003512 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00003513 while still checking more characters. There must be a character
3514 following the pattern, when it matches the whole line it is handled
3515 like there is no match.
3516 The default recognizes a number, followed by an optional punctuation
3517 character and white space.
3518
Bram Moolenaar6c60f472019-04-28 16:00:35 +02003519 *'formatoptions'* *'fo'*
3520'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
3521 local to buffer
3522 This is a sequence of letters which describes how automatic
3523 formatting is to be done. See |fo-table|. When the 'paste' option is
3524 on, no formatting is done (like 'formatoptions' is empty). Commas can
3525 be inserted for readability.
3526 To avoid problems with flags that are added in the future, use the
3527 "+=" and "-=" feature of ":set" |add-option-flags|.
3528 NOTE: This option is set to the Vi default value when 'compatible' is
3529 set and to the Vim default value when 'compatible' is reset.
3530
Bram Moolenaar071d4272004-06-13 20:20:40 +00003531 *'formatprg'* *'fp'*
3532'formatprg' 'fp' string (default "")
Bram Moolenaar9be7c042017-01-14 14:28:30 +01003533 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003534 The name of an external program that will be used to format the lines
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003535 selected with the |gq| operator. The program must take the input on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003536 stdin and produce the output on stdout. The Unix program "fmt" is
Bram Moolenaara5792f52005-11-23 21:25:05 +00003537 such a program.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003538 If the 'formatexpr' option is not empty it will be used instead.
3539 Otherwise, if 'formatprg' option is an empty string, the internal
3540 format function will be used |C-indenting|.
Bram Moolenaara5792f52005-11-23 21:25:05 +00003541 Environment variables are expanded |:set_env|. See |option-backslash|
3542 about including spaces and backslashes.
Bram Moolenaar30b65812012-07-12 22:01:11 +02003543 This option cannot be set from a |modeline| or in the |sandbox|, for
3544 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003545
Bram Moolenaard94464e2015-11-02 15:28:18 +01003546 *'fsync'* *'fs'* *'nofsync'* *'nofs'*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003547'fsync' 'fs' boolean (default on)
3548 global
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003549 When on, the library function fsync() will be called after writing a
3550 file. This will flush a file to disk, ensuring that it is safely
3551 written even on filesystems which do metadata-only journaling. This
3552 will force the harddrive to spin up on Linux systems running in laptop
3553 mode, so it may be undesirable in some situations. Be warned that
3554 turning this off increases the chances of data loss after a crash. On
3555 systems without an fsync() implementation, this variable is always
3556 off.
3557 Also see 'swapsync' for controlling fsync() on swap files.
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003558 'fsync' also applies to |writefile()|, unless a flag is used to
3559 overrule it.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003560 This option cannot be set from a |modeline| or in the |sandbox|, for
3561 security reasons.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003562
Bram Moolenaar071d4272004-06-13 20:20:40 +00003563 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
3564'gdefault' 'gd' boolean (default off)
3565 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003566 When on, the ":substitute" flag 'g' is default on. This means that
3567 all matches in a line are substituted instead of one. When a 'g' flag
3568 is given to a ":substitute" command, this will toggle the substitution
3569 of all or one match. See |complex-change|.
3570
3571 command 'gdefault' on 'gdefault' off ~
3572 :s/// subst. all subst. one
3573 :s///g subst. one subst. all
3574 :s///gg subst. all subst. one
3575
3576 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar21020352017-06-13 17:21:04 +02003577 DEPRECATED: Setting this option may break plugins that are not aware
3578 of this option. Also, many users get confused that adding the /g flag
3579 has the opposite effect of that it normally does.
Bram Moolenaar4072ba52020-12-23 13:56:35 +01003580 This option is not used in |Vim9| script.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003581
3582 *'grepformat'* *'gfm'*
Bram Moolenaar6e932462014-09-09 18:48:09 +02003583'grepformat' 'gfm' string (default "%f:%l:%m,%f:%l%m,%f %l%m")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003584 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003585 Format to recognize for the ":grep" command output.
3586 This is a scanf-like string that uses the same format as the
3587 'errorformat' option: see |errorformat|.
3588
3589 *'grepprg'* *'gp'*
3590'grepprg' 'gp' string (default "grep -n ",
3591 Unix: "grep -n $* /dev/null",
3592 Win32: "findstr /n" or "grep -n",
3593 VMS: "SEARCH/NUMBERS ")
3594 global or local to buffer |global-local|
Bram Moolenaar582fd852005-03-28 20:58:01 +00003595 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003596 and '#' characters, which are expanded like when used in a command-
3597 line. The placeholder "$*" is allowed to specify where the arguments
3598 will be included. Environment variables are expanded |:set_env|. See
3599 |option-backslash| about including spaces and backslashes.
3600 When your "grep" accepts the "-H" argument, use this to make ":grep"
3601 also work well with a single file: >
3602 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00003603< Special value: When 'grepprg' is set to "internal" the |:grep| command
Bram Moolenaara6557602006-02-04 22:43:20 +00003604 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like
3605 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00003606 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00003607 apply equally to 'grepprg'.
3608 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
3609 otherwise it's "grep -n".
3610 This option cannot be set from a |modeline| or in the |sandbox|, for
3611 security reasons.
3612
3613 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
3614'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
3615 ve:ver35-Cursor,
3616 o:hor50-Cursor,
3617 i-ci:ver25-Cursor/lCursor,
3618 r-cr:hor20-Cursor/lCursor,
3619 sm:block-Cursor
3620 -blinkwait175-blinkoff150-blinkon175",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003621 for Win32 console:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003622 "n-v-c:block,o:hor50,i-ci:hor15,
3623 r-cr:hor30,sm:block")
3624 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003625 {only available when compiled with GUI enabled, and
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003626 for Win32 console}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003627 This option tells Vim what the cursor should look like in different
Bram Moolenaar8024f932020-01-14 19:29:13 +01003628 modes. It fully works in the GUI. In a Win32 console, only the
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003629 height of the cursor can be changed. This can be done by specifying a
3630 block cursor, or a percentage for a vertical or horizontal cursor.
Bram Moolenaar1e7813a2015-03-31 18:31:03 +02003631 For a console the 't_SI', 't_SR', and 't_EI' escape sequences are
3632 used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003633
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003634 The option is a comma separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003635 mode-list and an argument-list:
3636 mode-list:argument-list,mode-list:argument-list,..
3637 The mode-list is a dash separated list of these modes:
3638 n Normal mode
3639 v Visual mode
3640 ve Visual mode with 'selection' "exclusive" (same as 'v',
3641 if not specified)
3642 o Operator-pending mode
3643 i Insert mode
3644 r Replace mode
3645 c Command-line Normal (append) mode
3646 ci Command-line Insert mode
3647 cr Command-line Replace mode
3648 sm showmatch in Insert mode
3649 a all modes
3650 The argument-list is a dash separated list of these arguments:
3651 hor{N} horizontal bar, {N} percent of the character height
3652 ver{N} vertical bar, {N} percent of the character width
3653 block block cursor, fills the whole character
3654 [only one of the above three should be present]
3655 blinkwait{N} *cursor-blinking*
3656 blinkon{N}
3657 blinkoff{N}
3658 blink times for cursor: blinkwait is the delay before
3659 the cursor starts blinking, blinkon is the time that
3660 the cursor is shown and blinkoff is the time that the
3661 cursor is not shown. The times are in msec. When one
3662 of the numbers is zero, there is no blinking. The
3663 default is: "blinkwait700-blinkon400-blinkoff250".
3664 These numbers are used for a missing entry. This
3665 means that blinking is enabled by default. To switch
3666 blinking off you can use "blinkon0". The cursor only
3667 blinks when Vim is waiting for input, not while
3668 executing a command.
3669 To make the cursor blink in an xterm, see
3670 |xterm-blink|.
3671 {group-name}
3672 a highlight group name, that sets the color and font
3673 for the cursor
3674 {group-name}/{group-name}
3675 Two highlight group names, the first is used when
3676 no language mappings are used, the other when they
3677 are. |language-mapping|
3678
3679 Examples of parts:
3680 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
3681 block cursor with colors from the "nCursor"
3682 highlight group
3683 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
3684 In Insert and Command-line Insert mode, use a
3685 30% vertical bar cursor with colors from the
3686 "iCursor" highlight group. Blink a bit
3687 faster.
3688
3689 The 'a' mode is different. It will set the given argument-list for
3690 all modes. It does not reset anything to defaults. This can be used
3691 to do a common setting for all modes. For example, to switch off
3692 blinking: "a:blinkon0"
3693
3694 Examples of cursor highlighting: >
3695 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
3696 :highlight Cursor gui=NONE guifg=bg guibg=fg
3697<
3698 *'guifont'* *'gfn'*
Bram Moolenaar251e1912011-06-19 05:09:16 +02003699 *E235* *E596*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003700'guifont' 'gfn' string (default "")
3701 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003702 {only available when compiled with GUI enabled}
3703 This is a list of fonts which will be used for the GUI version of Vim.
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003704 In its simplest form the value is just one font name.
3705 See |gui-font| for the details.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003706
3707 *'guifontset'* *'gfs'*
3708 *E250* *E252* *E234* *E597* *E598*
3709'guifontset' 'gfs' string (default "")
3710 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003711 {only available when compiled with GUI enabled and
3712 with the |+xfontset| feature}
Bram Moolenaar3df01732017-02-17 22:47:16 +01003713 {not available in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003714 When not empty, specifies two (or more) fonts to be used. The first
3715 one for normal English, the second one for your special language. See
3716 |xfontset|.
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003717
Bram Moolenaar071d4272004-06-13 20:20:40 +00003718 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
3719'guifontwide' 'gfw' string (default "")
3720 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003721 {only available when compiled with GUI enabled}
3722 When not empty, specifies a comma-separated list of fonts to be used
3723 for double-width characters. The first font that can be loaded is
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003724 used. See |gui-fontwide|.
Bram Moolenaar0f272122013-01-23 18:37:40 +01003725
Bram Moolenaar071d4272004-06-13 20:20:40 +00003726 *'guiheadroom'* *'ghr'*
3727'guiheadroom' 'ghr' number (default 50)
3728 global
Bram Moolenaar110289e2019-05-23 15:38:06 +02003729 {only for GTK and X11 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003730 The number of pixels subtracted from the screen height when fitting
3731 the GUI window on the screen. Set this before the GUI is started,
3732 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003733 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00003734 lines will be left for window decorations and other items on the
3735 screen. Set it to a negative value to allow windows taller than the
3736 screen.
3737
3738 *'guioptions'* *'go'*
Bram Moolenaar2c64ca12018-10-19 16:22:31 +02003739'guioptions' 'go' string (default "egmrLtT" (MS-Windows,
3740 "t" is removed in |defaults.vim|),
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02003741 "aegimrLtT" (GTK, Motif and Athena),
3742 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00003743 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003744 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00003745 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003746 sequence of letters which describes what components and options of the
3747 GUI should be used.
3748 To avoid problems with flags that are added in the future, use the
3749 "+=" and "-=" feature of ":set" |add-option-flags|.
3750
Bram Moolenaar13568252018-03-16 20:46:58 +01003751 Valid characters are as follows:
3752 *'go-!'*
3753 '!' External commands are executed in a terminal window. Without
3754 this flag the MS-Windows GUI will open a console window to
3755 execute the command. The Unix GUI will simulate a dumb
3756 terminal to list the command output.
3757 The terminal window will be positioned at the bottom, and grow
3758 upwards as needed.
Bram Moolenaarba3ff532018-11-04 14:45:49 +01003759 *'go-a'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003760 'a' Autoselect: If present, then whenever VISUAL mode is started,
3761 or the Visual area extended, Vim tries to become the owner of
3762 the windowing system's global selection. This means that the
3763 Visually highlighted text is available for pasting into other
3764 applications as well as into Vim itself. When the Visual mode
3765 ends, possibly due to an operation on the text, or when an
3766 application wants to paste the selection, the highlighted text
3767 is automatically yanked into the "* selection register.
3768 Thus the selection is still available for pasting into other
3769 applications after the VISUAL mode has ended.
3770 If not present, then Vim won't become the owner of the
3771 windowing system's global selection unless explicitly told to
3772 by a yank or delete operation for the "* register.
3773 The same applies to the modeless selection.
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02003774 *'go-P'*
3775 'P' Like autoselect but using the "+ register instead of the "*
Bram Moolenaar3848e002016-03-19 18:42:29 +01003776 register.
Bram Moolenaar02467872007-05-06 13:22:01 +00003777 *'go-A'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003778 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003779 applies to the modeless selection.
3780
3781 'guioptions' autoselect Visual autoselect modeless ~
3782 "" - -
3783 "a" yes yes
3784 "A" - yes
3785 "aA" yes yes
3786
Bram Moolenaar02467872007-05-06 13:22:01 +00003787 *'go-c'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003788 'c' Use console dialogs instead of popup dialogs for simple
3789 choices.
Bram Moolenaar50bf7ce2019-09-15 13:17:00 +02003790 *'go-d'*
3791 'd' Use dark theme variant if available. Currently only works for
3792 GTK+ GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00003793 *'go-e'*
Bram Moolenaare224ffa2006-03-01 00:01:28 +00003794 'e' Add tab pages when indicated with 'showtabline'.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003795 'guitablabel' can be used to change the text in the labels.
3796 When 'e' is missing a non-GUI tab pages line may be used.
Bram Moolenaard68071d2006-05-02 22:08:30 +00003797 The GUI tabs are only supported on some systems, currently
Bram Moolenaarb3f74062020-02-26 16:16:53 +01003798 GTK, Motif, Mac OS/X, Haiku, and MS-Windows.
Bram Moolenaar02467872007-05-06 13:22:01 +00003799 *'go-f'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003800 'f' Foreground: Don't use fork() to detach the GUI from the shell
3801 where it was started. Use this for programs that wait for the
3802 editor to finish (e.g., an e-mail program). Alternatively you
3803 can use "gvim -f" or ":gui -f" to start the GUI in the
3804 foreground. |gui-fork|
3805 Note: Set this option in the vimrc file. The forking may have
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003806 happened already when the |gvimrc| file is read.
Bram Moolenaar02467872007-05-06 13:22:01 +00003807 *'go-i'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003808 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
3809 corner of the window. It's black&white on non-GTK, because of
3810 limitations of X11. For a color icon, see |X11-icon|.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003811 *'go-m'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003812 'm' Menu bar is present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003813 *'go-M'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003814 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00003815 that this flag must be added in the .vimrc file, before
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003816 switching on syntax or filetype recognition (when the |gvimrc|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003817 file is sourced the system menu has already been loaded; the
Bram Moolenaar01164a62017-11-02 22:58:42 +01003818 `:syntax on` and `:filetype on` commands load the menu too).
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003819 *'go-g'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003820 'g' Grey menu items: Make menu items that are not active grey. If
3821 'g' is not included inactive menu items are not shown at all.
3822 Exception: Athena will always use grey menu items.
Bram Moolenaar02467872007-05-06 13:22:01 +00003823 *'go-t'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003824 't' Include tearoff menu items. Currently only works for Win32,
3825 GTK+, and Motif 1.2 GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00003826 *'go-T'*
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00003827 'T' Include Toolbar. Currently only in Win32, GTK+, Motif, Photon
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00003828 and Athena GUIs.
Bram Moolenaar02467872007-05-06 13:22:01 +00003829 *'go-r'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003830 'r' Right-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003831 *'go-R'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003832 'R' Right-hand scrollbar is present when there is a vertically
3833 split window.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003834 *'go-l'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003835 'l' Left-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003836 *'go-L'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003837 'L' Left-hand scrollbar is present when there is a vertically
3838 split window.
Bram Moolenaar02467872007-05-06 13:22:01 +00003839 *'go-b'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003840 'b' Bottom (horizontal) scrollbar is present. Its size depends on
3841 the longest visible line, or on the cursor line if the 'h'
3842 flag is included. |gui-horiz-scroll|
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003843 *'go-h'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003844 'h' Limit horizontal scrollbar size to the length of the cursor
3845 line. Reduces computations. |gui-horiz-scroll|
3846
3847 And yes, you may even have scrollbars on the left AND the right if
3848 you really want to :-). See |gui-scrollbars| for more information.
3849
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003850 *'go-v'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003851 'v' Use a vertical button layout for dialogs. When not included,
3852 a horizontal layout is preferred, but when it doesn't fit a
3853 vertical layout is used anyway.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003854 *'go-p'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003855 'p' Use Pointer callbacks for X11 GUI. This is required for some
3856 window managers. If the cursor is not blinking or hollow at
3857 the right moment, try adding this flag. This must be done
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003858 before starting the GUI. Set it in your |gvimrc|. Adding or
Bram Moolenaar071d4272004-06-13 20:20:40 +00003859 removing it after the GUI has started has no effect.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003860 *'go-F'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003861 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar8ac44152017-11-09 18:33:29 +01003862 *'go-k'*
3863 'k' Keep the GUI window size when adding/removing a scrollbar, or
3864 toolbar, tabline, etc. Instead, the behavior is similar to
3865 when the window is maximized and will adjust 'lines' and
3866 'columns' to fit to the window. Without the 'k' flag Vim will
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003867 try to keep 'lines' and 'columns' the same when adding and
Bram Moolenaar8ac44152017-11-09 18:33:29 +01003868 removing GUI components.
Bram Moolenaar02467872007-05-06 13:22:01 +00003869
Bram Moolenaar071d4272004-06-13 20:20:40 +00003870 *'guipty'* *'noguipty'*
3871'guipty' boolean (default on)
3872 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003873 {only available when compiled with GUI enabled}
3874 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
3875 I/O to/from shell commands. See |gui-pty|.
3876
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003877 *'guitablabel'* *'gtl'*
3878'guitablabel' 'gtl' string (default empty)
3879 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02003880 {only available when compiled with GUI enabled}
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003881 When nonempty describes the text to use in a label of the GUI tab
Bram Moolenaard68071d2006-05-02 22:08:30 +00003882 pages line. When empty and when the result is empty Vim will use a
3883 default label. See |setting-guitablabel| for more info.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003884
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003885 The format of this option is like that of 'statusline'.
Bram Moolenaar57657d82006-04-21 22:12:41 +00003886 'guitabtooltip' is used for the tooltip, see below.
Bram Moolenaar51628222016-12-01 23:03:28 +01003887 The expression will be evaluated in the |sandbox| when set from a
3888 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003889 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003890
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003891 Only used when the GUI tab pages line is displayed. 'e' must be
3892 present in 'guioptions'. For the non-GUI tab pages line 'tabline' is
3893 used.
3894
Bram Moolenaar57657d82006-04-21 22:12:41 +00003895 *'guitabtooltip'* *'gtt'*
3896'guitabtooltip' 'gtt' string (default empty)
3897 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02003898 {only available when compiled with GUI enabled}
Bram Moolenaar57657d82006-04-21 22:12:41 +00003899 When nonempty describes the text to use in a tooltip for the GUI tab
3900 pages line. When empty Vim will use a default tooltip.
3901 This option is otherwise just like 'guitablabel' above.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003902 You can include a line break. Simplest method is to use |:let|: >
3903 :let &guitabtooltip = "line one\nline two"
3904<
Bram Moolenaar57657d82006-04-21 22:12:41 +00003905
Bram Moolenaar071d4272004-06-13 20:20:40 +00003906 *'helpfile'* *'hf'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003907'helpfile' 'hf' string (default (MS-Windows) "$VIMRUNTIME\doc\help.txt"
Bram Moolenaar071d4272004-06-13 20:20:40 +00003908 (others) "$VIMRUNTIME/doc/help.txt")
3909 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003910 Name of the main help file. All distributed help files should be
3911 placed together in one directory. Additionally, all "doc" directories
3912 in 'runtimepath' will be used.
3913 Environment variables are expanded |:set_env|. For example:
3914 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003915 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00003916 spaces and backslashes.
3917 This option cannot be set from a |modeline| or in the |sandbox|, for
3918 security reasons.
3919
3920 *'helpheight'* *'hh'*
3921'helpheight' 'hh' number (default 20)
3922 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003923 Minimal initial height of the help window when it is opened with the
3924 ":help" command. The initial height of the help window is half of the
3925 current window, or (when the 'ea' option is on) the same as other
3926 windows. When the height is less than 'helpheight', the height is
3927 set to 'helpheight'. Set to zero to disable.
3928
3929 *'helplang'* *'hlg'*
3930'helplang' 'hlg' string (default: messages language or empty)
3931 global
3932 {only available when compiled with the |+multi_lang|
3933 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003934 Comma separated list of languages. Vim will use the first language
3935 for which the desired help can be found. The English help will always
3936 be used as a last resort. You can add "en" to prefer English over
3937 another language, but that will only find tags that exist in that
3938 language and not in the English help.
3939 Example: >
3940 :set helplang=de,it
3941< This will first search German, then Italian and finally English help
3942 files.
3943 When using |CTRL-]| and ":help!" in a non-English help file Vim will
3944 try to find the tag in the current language before using this option.
3945 See |help-translated|.
3946
3947 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
3948'hidden' 'hid' boolean (default off)
3949 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003950 When off a buffer is unloaded when it is |abandon|ed. When on a
3951 buffer becomes hidden when it is |abandon|ed. If the buffer is still
3952 displayed in another window, it does not become hidden, of course.
3953 The commands that move through the buffer list sometimes make a buffer
3954 hidden although the 'hidden' option is off: When the buffer is
3955 modified, 'autowrite' is off or writing is not possible, and the '!'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003956 flag was used. See also |windows.txt|.
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00003957 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003958 This option is set for one command with ":hide {command}" |:hide|.
3959 WARNING: It's easy to forget that you have changes in hidden buffers.
3960 Think twice when using ":q!" or ":qa!".
3961
3962 *'highlight'* *'hl'*
3963'highlight' 'hl' string (default (as a single string):
Bram Moolenaar58b85342016-08-14 19:54:54 +02003964 "8:SpecialKey,~:EndOfBuffer,@:NonText,
3965 d:Directory,e:ErrorMsg,i:IncSearch,
3966 l:Search,m:MoreMsg,M:ModeMsg,n:LineNr,
Bram Moolenaarefae76a2019-10-27 22:54:58 +01003967 a:LineNrAbove,b:LineNrBelow,
Bram Moolenaar58b85342016-08-14 19:54:54 +02003968 N:CursorLineNr,r:Question,s:StatusLine,
3969 S:StatusLineNC,c:VertSplit,t:Title,
Bram Moolenaar9d87a372018-12-18 21:41:50 +01003970 v:Visual,V:VisualNOS,w:WarningMsg,
3971 W:WildMenu,f:Folded,F:FoldColumn,
3972 A:DiffAdd,C:DiffChange,D:DiffDelete,
3973 T:DiffText,>:SignColumn,-:Conceal,
Bram Moolenaarc8c88492018-12-27 23:59:26 +01003974 B:SpellBad,P:SpellCap,R:SpellRare,
Bram Moolenaar9d87a372018-12-18 21:41:50 +01003975 L:SpellLocal,+:Pmenu,=:PmenuSel,
Bram Moolenaar21020352017-06-13 17:21:04 +02003976 x:PmenuSbar,X:PmenuThumb,*:TabLine,
3977 #:TabLineSel,_:TabLineFill,!:CursorColumn,
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02003978 .:CursorLine,o:ColorColumn,q:QuickFixLine,
Bram Moolenaarc572da52017-08-27 16:52:01 +02003979 z:StatusLineTerm,Z:StatusLineTermNC")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003980 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003981 This option can be used to set highlighting mode for various
3982 occasions. It is a comma separated list of character pairs. The
3983 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003984 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003985 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
Bram Moolenaar58b85342016-08-14 19:54:54 +02003986 |hl-EndOfBuffer| ~ lines after the last line in the buffer
3987 |hl-NonText| @ '@' at the end of the window and
Bram Moolenaar071d4272004-06-13 20:20:40 +00003988 characters from 'showbreak'
3989 |hl-Directory| d directories in CTRL-D listing and other special
3990 things in listings
3991 |hl-ErrorMsg| e error messages
3992 h (obsolete, ignored)
3993 |hl-IncSearch| i 'incsearch' highlighting
3994 |hl-Search| l last search pattern highlighting (see 'hlsearch')
3995 |hl-MoreMsg| m |more-prompt|
3996 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
Bram Moolenaar64486672010-05-16 15:46:46 +02003997 |hl-LineNr| n line number for ":number" and ":#" commands, and
3998 when 'number' or 'relativenumber' option is set.
Bram Moolenaarefae76a2019-10-27 22:54:58 +01003999 |hl-LineNrAbove| a line number above the cursor for when the
4000 'relativenumber' option is set.
4001 |hl-LineNrBelow| b line number below the cursor for when the
4002 'relativenumber' option is set.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01004003 |hl-CursorLineNr| N like n for when 'cursorline' or 'relativenumber' is
4004 set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004005 |hl-Question| r |hit-enter| prompt and yes/no questions
4006 |hl-StatusLine| s status line of current window |status-line|
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01004007 |hl-StatusLineNC| S status lines of not-current windows
Bram Moolenaar071d4272004-06-13 20:20:40 +00004008 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
4009 |hl-VertSplit| c column used to separate vertically split windows
4010 |hl-Visual| v Visual mode
4011 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
4012 Selection" Only X11 Gui's |gui-x11| and
4013 |xterm-clipboard|.
4014 |hl-WarningMsg| w warning messages
4015 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
4016 |hl-Folded| f line used for closed folds
4017 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00004018 |hl-DiffAdd| A added line in diff mode
4019 |hl-DiffChange| C changed line in diff mode
4020 |hl-DiffDelete| D deleted line in diff mode
4021 |hl-DiffText| T inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00004022 |hl-SignColumn| > column used for |signs|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004023 |hl-Conceal| - the placeholders used for concealed characters
4024 (see 'conceallevel')
Bram Moolenaar217ad922005-03-20 22:37:15 +00004025 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02004026 |hl-SpellCap| P word that should start with capital |spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00004027 |hl-SpellRare| R rare word |spell|
4028 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004029 |hl-Pmenu| + popup menu normal line
4030 |hl-PmenuSel| = popup menu selected line
4031 |hl-PmenuSbar| x popup menu scrollbar
4032 |hl-PmenuThumb| X popup menu scrollbar thumb
Bram Moolenaar071d4272004-06-13 20:20:40 +00004033
4034 The display modes are:
4035 r reverse (termcap entry "mr" and "me")
4036 i italic (termcap entry "ZH" and "ZR")
4037 b bold (termcap entry "md" and "me")
4038 s standout (termcap entry "so" and "se")
4039 u underline (termcap entry "us" and "ue")
Bram Moolenaare2cc9702005-03-15 22:43:58 +00004040 c undercurl (termcap entry "Cs" and "Ce")
Bram Moolenaarcf4b00c2017-09-02 18:33:56 +02004041 t strikethrough (termcap entry "Ts" and "Te")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004042 n no highlighting
4043 - no highlighting
4044 : use a highlight group
4045 The default is used for occasions that are not included.
4046 If you want to change what the display modes do, see |dos-colors|
4047 for an example.
4048 When using the ':' display mode, this must be followed by the name of
4049 a highlight group. A highlight group can be used to define any type
4050 of highlighting, including using color. See |:highlight| on how to
4051 define one. The default uses a different group for each occasion.
4052 See |highlight-default| for the default highlight groups.
4053
Bram Moolenaar071d4272004-06-13 20:20:40 +00004054 *'history'* *'hi'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004055'history' 'hi' number (Vim default: 50, Vi default: 0,
4056 set to 200 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004057 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004058 A history of ":" commands, and a history of previous search patterns
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004059 is remembered. This option decides how many entries may be stored in
Bram Moolenaar071d4272004-06-13 20:20:40 +00004060 each of these histories (see |cmdline-editing|).
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004061 The maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004062 NOTE: This option is set to the Vi default value when 'compatible' is
4063 set and to the Vim default value when 'compatible' is reset.
4064
4065 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
4066'hkmap' 'hk' boolean (default off)
4067 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004068 {only available when compiled with the |+rightleft|
4069 feature}
4070 When on, the keyboard is mapped for the Hebrew character set.
4071 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
4072 toggle this option. See |rileft.txt|.
4073 NOTE: This option is reset when 'compatible' is set.
4074
4075 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
4076'hkmapp' 'hkp' boolean (default off)
4077 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004078 {only available when compiled with the |+rightleft|
4079 feature}
4080 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
4081 This is useful if you have a non-Hebrew keyboard.
4082 See |rileft.txt|.
4083 NOTE: This option is reset when 'compatible' is set.
4084
Bram Moolenaar036986f2017-03-16 17:41:02 +01004085 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
4086'hlsearch' 'hls' boolean (default off)
4087 global
Bram Moolenaar036986f2017-03-16 17:41:02 +01004088 {not available when compiled without the
4089 |+extra_search| feature}
4090 When there is a previous search pattern, highlight all its matches.
4091 The type of highlighting used can be set with the 'l' occasion in the
4092 'highlight' option. This uses the "Search" highlight group by
4093 default. Note that only the matching text is highlighted, any offsets
4094 are not applied.
4095 See also: 'incsearch' and |:match|.
4096 When you get bored looking at the highlighted matches, you can turn it
4097 off with |:nohlsearch|. This does not change the option value, as
4098 soon as you use a search command, the highlighting comes back.
4099 'redrawtime' specifies the maximum time spent on finding matches.
4100 When the search pattern can match an end-of-line, Vim will try to
4101 highlight all of the matched text. However, this depends on where the
4102 search starts. This will be the first line in the window or the first
4103 line below a closed fold. A match in a previous line which is not
4104 drawn may not continue in a newly drawn line.
4105 You can specify whether the highlight status is restored on startup
4106 with the 'h' flag in 'viminfo' |viminfo-h|.
4107 NOTE: This option is reset when 'compatible' is set.
4108
Bram Moolenaar071d4272004-06-13 20:20:40 +00004109 *'icon'* *'noicon'*
4110'icon' boolean (default off, on when title can be restored)
4111 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004112 {not available when compiled without the |+title|
4113 feature}
4114 When on, the icon text of the window will be set to the value of
4115 'iconstring' (if it is not empty), or to the name of the file
4116 currently being edited. Only the last part of the name is used.
4117 Overridden by the 'iconstring' option.
4118 Only works if the terminal supports setting window icons (currently
4119 only X11 GUI and terminals with a non-empty 't_IS' option - these are
4120 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
4121 builtin termcap).
4122 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00004123 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00004124 X11.
Bram Moolenaar3a991dd2014-10-02 01:41:41 +02004125 For MS-Windows the icon can be changed, see |windows-icon|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004126
4127 *'iconstring'*
4128'iconstring' string (default "")
4129 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004130 {not available when compiled without the |+title|
4131 feature}
4132 When this option is not empty, it will be used for the icon text of
4133 the window. This happens only when the 'icon' option is on.
4134 Only works if the terminal supports setting window icon text
4135 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
4136 Does not work for MS Windows.
4137 When Vim was compiled with HAVE_X11 defined, the original icon will be
4138 restored if possible |X11|.
4139 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004140 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004141 'titlestring' for example settings.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004142 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004143 {not available when compiled without the |+statusline| feature}
4144
4145 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
4146'ignorecase' 'ic' boolean (default off)
4147 global
4148 Ignore case in search patterns. Also used when searching in the tags
4149 file.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01004150 Also see 'smartcase' and 'tagcase'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004151 Can be overruled by using "\c" or "\C" in the pattern, see
4152 |/ignorecase|.
4153
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004154 *'imactivatefunc'* *'imaf'*
4155'imactivatefunc' 'imaf' string (default "")
4156 global
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004157 This option specifies a function that will be called to
Bram Moolenaar2877d332017-11-26 14:56:16 +01004158 activate or deactivate the Input Method.
Bram Moolenaaref8c6172020-07-01 15:12:44 +02004159 It is not used in the MS-Windows GUI version.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004160 The expression will be evaluated in the |sandbox| when set from a
4161 modeline, see |sandbox-option|.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004162
4163 Example: >
4164 function ImActivateFunc(active)
4165 if a:active
4166 ... do something
4167 else
4168 ... do something
4169 endif
4170 " return value is not used
4171 endfunction
4172 set imactivatefunc=ImActivateFunc
4173<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004174 *'imactivatekey'* *'imak'*
4175'imactivatekey' 'imak' string (default "")
4176 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004177 {only available when compiled with |+xim| and
Bram Moolenaar67c53842010-05-22 18:28:27 +02004178 |+GUI_GTK|} *E599*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004179 Specifies the key that your Input Method in X-Windows uses for
4180 activation. When this is specified correctly, vim can fully control
4181 IM with 'imcmdline', 'iminsert' and 'imsearch'.
4182 You can't use this option to change the activation key, the option
4183 tells Vim what the key is.
4184 Format:
4185 [MODIFIER_FLAG-]KEY_STRING
4186
4187 These characters can be used for MODIFIER_FLAG (case is ignored):
4188 S Shift key
4189 L Lock key
4190 C Control key
4191 1 Mod1 key
4192 2 Mod2 key
4193 3 Mod3 key
4194 4 Mod4 key
4195 5 Mod5 key
4196 Combinations are allowed, for example "S-C-space" or "SC-space" are
4197 both shift+ctrl+space.
4198 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
4199
4200 Example: >
4201 :set imactivatekey=S-space
4202< "S-space" means shift+space. This is the activation key for kinput2 +
4203 canna (Japanese), and ami (Korean).
4204
4205 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
4206'imcmdline' 'imc' boolean (default off)
4207 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004208 When set the Input Method is always on when starting to edit a command
4209 line, unless entering a search pattern (see 'imsearch' for that).
4210 Setting this option is useful when your input method allows entering
4211 English characters directly, e.g., when it's used to type accented
4212 characters with dead keys.
4213
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004214 *'imdisable'* *'imd'* *'noimdisable'* *'noimd'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004215'imdisable' 'imd' boolean (default off, on for some systems (SGI))
4216 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004217 When set the Input Method is never used. This is useful to disable
4218 the IM when it doesn't work properly.
4219 Currently this option is on by default for SGI/IRIX machines. This
4220 may change in later releases.
4221
4222 *'iminsert'* *'imi'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004223'iminsert' 'imi' number (default 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004224 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004225 Specifies whether :lmap or an Input Method (IM) is to be used in
4226 Insert mode. Valid values:
4227 0 :lmap is off and IM is off
4228 1 :lmap is ON and IM is off
4229 2 :lmap is off and IM is ON
Bram Moolenaar071d4272004-06-13 20:20:40 +00004230 To always reset the option to zero when leaving Insert mode with <Esc>
4231 this can be used: >
4232 :inoremap <ESC> <ESC>:set iminsert=0<CR>
4233< This makes :lmap and IM turn off automatically when leaving Insert
4234 mode.
4235 Note that this option changes when using CTRL-^ in Insert mode
4236 |i_CTRL-^|.
4237 The value is set to 1 when setting 'keymap' to a valid keymap name.
4238 It is also used for the argument of commands like "r" and "f".
4239 The value 0 may not work correctly with Athena and Motif with some XIM
4240 methods. Use 'imdisable' to disable XIM then.
4241
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004242 You can set 'imactivatefunc' and 'imstatusfunc' to handle IME/XIM
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004243 via external command if Vim is not compiled with the |+xim|,
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004244 |+multi_byte_ime| or |global-ime|.
4245
Bram Moolenaar071d4272004-06-13 20:20:40 +00004246 *'imsearch'* *'ims'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004247'imsearch' 'ims' number (default -1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004248 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004249 Specifies whether :lmap or an Input Method (IM) is to be used when
4250 entering a search pattern. Valid values:
4251 -1 the value of 'iminsert' is used, makes it look like
4252 'iminsert' is also used when typing a search pattern
4253 0 :lmap is off and IM is off
4254 1 :lmap is ON and IM is off
4255 2 :lmap is off and IM is ON
4256 Note that this option changes when using CTRL-^ in Command-line mode
4257 |c_CTRL-^|.
4258 The value is set to 1 when it is not -1 and setting the 'keymap'
4259 option to a valid keymap name.
4260 The value 0 may not work correctly with Athena and Motif with some XIM
4261 methods. Use 'imdisable' to disable XIM then.
4262
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004263 *'imstatusfunc'* *'imsf'*
4264'imstatusfunc' 'imsf' string (default "")
4265 global
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004266 This option specifies a function that is called to obtain the status
4267 of Input Method. It must return a positive number when IME is active.
Bram Moolenaaref8c6172020-07-01 15:12:44 +02004268 It is not used in the MS-Windows GUI version.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004269
4270 Example: >
4271 function ImStatusFunc()
4272 let is_active = ...do something
4273 return is_active ? 1 : 0
4274 endfunction
4275 set imstatusfunc=ImStatusFunc
4276<
4277 NOTE: This function is invoked very often. Keep it fast.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004278 The expression will be evaluated in the |sandbox| when set from a
4279 modeline, see |sandbox-option|.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004280
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004281 *'imstyle'* *'imst'*
4282'imstyle' 'imst' number (default 1)
4283 global
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004284 {only available when compiled with |+xim| and
4285 |+GUI_GTK|}
Bram Moolenaar37c64c72017-09-19 22:06:03 +02004286 This option specifies the input style of Input Method:
4287 0 use on-the-spot style
4288 1 over-the-spot style
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004289 See: |xim-input-style|
4290
Bram Moolenaar24a98a02017-09-27 22:23:55 +02004291 For a long time on-the-spot style had been used in the GTK version of
4292 vim, however, it is known that it causes troubles when using mappings,
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004293 |single-repeat|, etc. Therefore over-the-spot style becomes the
4294 default now. This should work fine for most people, however if you
4295 have any problem with it, try using on-the-spot style.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004296 The expression will be evaluated in the |sandbox| when set from a
4297 modeline, see |sandbox-option|.
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004298
Bram Moolenaar071d4272004-06-13 20:20:40 +00004299 *'include'* *'inc'*
4300'include' 'inc' string (default "^\s*#\s*include")
4301 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004302 {not available when compiled without the
4303 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004304 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00004305 pattern, just like for the "/" command (See |pattern|). The default
4306 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar1e015462005-09-25 22:16:38 +00004307 "]I", "[d", etc.
4308 Normally the 'isfname' option is used to recognize the file name that
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004309 comes after the matched pattern. But if "\zs" appears in the pattern
4310 then the text matched from "\zs" to the end, or until "\ze" if it
4311 appears, is used as the file name. Use this to include characters
4312 that are not in 'isfname', such as a space. You can then use
4313 'includeexpr' to process the matched text.
Bram Moolenaar1e015462005-09-25 22:16:38 +00004314 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004315
4316 *'includeexpr'* *'inex'*
4317'includeexpr' 'inex' string (default "")
4318 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004319 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004320 |+find_in_path| or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004321 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004322 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004323 :set includeexpr=substitute(v:fname,'\\.','/','g')
4324< The "v:fname" variable will be set to the file name that was detected.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004325
Bram Moolenaar071d4272004-06-13 20:20:40 +00004326 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004327 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004328 Also used for |<cfile>|.
4329
Bram Moolenaar30b65812012-07-12 22:01:11 +02004330 The expression will be evaluated in the |sandbox| when set from a
4331 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004332 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004333
4334 It is not allowed to change text or jump to another window while
4335 evaluating 'includeexpr' |textlock|.
4336
Bram Moolenaar071d4272004-06-13 20:20:40 +00004337 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004338'incsearch' 'is' boolean (default off, set in |defaults.vim| if the
4339 +reltime feature is supported)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004340 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004341 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004342 |+extra_search| features}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004343 While typing a search command, show where the pattern, as it was typed
4344 so far, matches. The matched string is highlighted. If the pattern
4345 is invalid or not found, nothing is shown. The screen will be updated
4346 often, this is only useful on fast terminals.
Bram Moolenaarfc65cab2018-08-28 22:58:02 +02004347 Also applies to the pattern in commands: >
4348 :global
4349 :lvimgrep
4350 :lvimgrepadd
4351 :smagic
4352 :snomagic
4353 :sort
4354 :substitute
4355 :vglobal
4356 :vimgrep
4357 :vimgrepadd
4358< Note that the match will be shown, but the cursor will return to its
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004359 original position when no match is found and when pressing <Esc>. You
4360 still need to finish the search command with <Enter> to move the
4361 cursor to the match.
Bram Moolenaardc083282016-10-11 08:57:33 +02004362 You can use the CTRL-G and CTRL-T keys to move to the next and
4363 previous match. |c_CTRL-G| |c_CTRL-T|
Bram Moolenaar91a4e822008-01-19 14:59:58 +00004364 When compiled with the |+reltime| feature Vim only searches for about
4365 half a second. With a complicated pattern and/or a lot of text the
4366 match may not be found. This is to avoid that Vim hangs while you
4367 are typing the pattern.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004368 The highlighting can be set with the 'i' flag in 'highlight'.
Bram Moolenaar2f058492017-11-30 20:27:52 +01004369 When 'hlsearch' is on, all matched strings are highlighted too while
4370 typing a search command. See also: 'hlsearch'.
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004371 If you don't want to turn 'hlsearch' on, but want to highlight all
4372 matches while searching, you can turn on and off 'hlsearch' with
4373 autocmd. Example: >
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004374 augroup vimrc-incsearch-highlight
4375 autocmd!
Bram Moolenaarf8f8b2e2017-11-02 19:08:48 +01004376 autocmd CmdlineEnter /,\? :set hlsearch
4377 autocmd CmdlineLeave /,\? :set nohlsearch
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004378 augroup END
4379<
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004380 CTRL-L can be used to add one character from after the current match
Bram Moolenaara9dc3752010-07-11 20:46:53 +02004381 to the command line. If 'ignorecase' and 'smartcase' are set and the
4382 command line has no uppercase characters, the added character is
4383 converted to lowercase.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004384 CTRL-R CTRL-W can be used to add the word at the end of the current
4385 match, excluding the characters that were already typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004386 NOTE: This option is reset when 'compatible' is set.
4387
4388 *'indentexpr'* *'inde'*
4389'indentexpr' 'inde' string (default "")
4390 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004391 {not available when compiled without the |+cindent|
4392 or |+eval| features}
4393 Expression which is evaluated to obtain the proper indent for a line.
4394 It is used when a new line is created, for the |=| operator and
4395 in Insert mode as specified with the 'indentkeys' option.
4396 When this option is not empty, it overrules the 'cindent' and
Bram Moolenaar20f90cf2011-05-19 12:22:51 +02004397 'smartindent' indenting. When 'lisp' is set, this option is
4398 overridden by the Lisp indentation algorithm.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004399 When 'paste' is set this option is not used for indenting.
4400 The expression is evaluated with |v:lnum| set to the line number for
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004401 which the indent is to be computed. The cursor is also in this line
Bram Moolenaar071d4272004-06-13 20:20:40 +00004402 when the expression is evaluated (but it may be moved around).
4403 The expression must return the number of spaces worth of indent. It
4404 can return "-1" to keep the current indent (this means 'autoindent' is
4405 used for the indent).
4406 Functions useful for computing the indent are |indent()|, |cindent()|
4407 and |lispindent()|.
4408 The evaluation of the expression must not have side effects! It must
4409 not change the text, jump to another window, etc. Afterwards the
4410 cursor position is always restored, thus the cursor may be moved.
4411 Normally this option would be set to call a function: >
4412 :set indentexpr=GetMyIndent()
4413< Error messages will be suppressed, unless the 'debug' option contains
4414 "msg".
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004415 See |indent-expression|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01004416 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004417
Bram Moolenaar30b65812012-07-12 22:01:11 +02004418 The expression will be evaluated in the |sandbox| when set from a
4419 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004420 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004421
4422 It is not allowed to change text or jump to another window while
4423 evaluating 'indentexpr' |textlock|.
4424
4425
Bram Moolenaar071d4272004-06-13 20:20:40 +00004426 *'indentkeys'* *'indk'*
Bram Moolenaarce655742019-01-31 14:12:57 +01004427'indentkeys' 'indk' string (default "0{,0},0),0],:,0#,!^F,o,O,e")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004428 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004429 {not available when compiled without the |+cindent|
4430 feature}
4431 A list of keys that, when typed in Insert mode, cause reindenting of
4432 the current line. Only happens if 'indentexpr' isn't empty.
4433 The format is identical to 'cinkeys', see |indentkeys-format|.
4434 See |C-indenting| and |indent-expression|.
4435
4436 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
4437'infercase' 'inf' boolean (default off)
4438 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004439 When doing keyword completion in insert mode |ins-completion|, and
Bram Moolenaar446cb832008-06-24 21:56:24 +00004440 'ignorecase' is also on, the case of the match is adjusted depending
4441 on the typed text. If the typed text contains a lowercase letter
4442 where the match has an upper case letter, the completed part is made
4443 lowercase. If the typed text has no lowercase letters and the match
4444 has a lowercase letter where the typed text has an uppercase letter,
4445 and there is a letter before it, the completed part is made uppercase.
4446 With 'noinfercase' the match is used as-is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004447
4448 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
4449'insertmode' 'im' boolean (default off)
4450 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004451 Makes Vim work in a way that Insert mode is the default mode. Useful
4452 if you want to use Vim as a modeless editor. Used for |evim|.
4453 These Insert mode commands will be useful:
4454 - Use the cursor keys to move around.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02004455 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|. When
Bram Moolenaar071d4272004-06-13 20:20:40 +00004456 this is a mapping, it is executed as if 'insertmode' was off.
4457 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004458 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00004459 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
4460 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004461
4462 These items change when 'insertmode' is set:
4463 - when starting to edit of a file, Vim goes to Insert mode.
4464 - <Esc> in Insert mode is a no-op and beeps.
4465 - <Esc> in Normal mode makes Vim go to Insert mode.
4466 - CTRL-L in Insert mode is a command, it is not inserted.
4467 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
4468 However, when <Esc> is used inside a mapping, it behaves like
4469 'insertmode' was not set. This was done to be able to use the same
4470 mappings with 'insertmode' set or not set.
4471 When executing commands with |:normal| 'insertmode' is not used.
4472
4473 NOTE: This option is reset when 'compatible' is set.
4474
4475 *'isfname'* *'isf'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004476'isfname' 'isf' string (default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004477 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
4478 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
4479 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
4480 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
4481 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
4482 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004483 The characters specified by this option are included in file names and
4484 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004485 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004486 Multi-byte characters 256 and above are always included, only the
4487 characters up to 255 are specified with this option.
4488 For UTF-8 the characters 0xa0 to 0xff are included as well.
Bram Moolenaar446cb832008-06-24 21:56:24 +00004489 Think twice before adding white space to this option. Although a
4490 space may appear inside a file name, the effect will be that Vim
4491 doesn't know where a file name starts or ends when doing completion.
4492 It most likely works better without a space in 'isfname'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004493
4494 Note that on systems using a backslash as path separator, Vim tries to
4495 do its best to make it work as you would expect. That is a bit
4496 tricky, since Vi originally used the backslash to escape special
4497 characters. Vim will not remove a backslash in front of a normal file
4498 name character on these systems, but it will on Unix and alikes. The
4499 '&' and '^' are not included by default, because these are special for
4500 cmd.exe.
4501
4502 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004503 Each part can be a single character number or a range. A range is two
4504 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004505 decimal number between 0 and 255 or the ASCII character itself (does
4506 not work for digits). Example:
4507 "_,-,128-140,#-43" (include '_' and '-' and the range
4508 128 to 140 and '#' to 43)
4509 If a part starts with '^', the following character number or range
4510 will be excluded from the option. The option is interpreted from left
4511 to right. Put the excluded character after the range where it is
4512 included. To include '^' itself use it as the last character of the
4513 option or the end of a range. Example:
4514 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
4515 If the character is '@', all characters where isalpha() returns TRUE
4516 are included. Normally these are the characters a to z and A to Z,
4517 plus accented characters. To include '@' itself use "@-@". Examples:
4518 "@,^a-z" All alphabetic characters, excluding lower
Bram Moolenaar446cb832008-06-24 21:56:24 +00004519 case ASCII letters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004520 "a-z,A-Z,@-@" All letters plus the '@' character.
4521 A comma can be included by using it where a character number is
4522 expected. Example:
4523 "48-57,,,_" Digits, comma and underscore.
4524 A comma can be excluded by prepending a '^'. Example:
4525 " -~,^,,9" All characters from space to '~', excluding
4526 comma, plus <Tab>.
4527 See |option-backslash| about including spaces and backslashes.
4528
4529 *'isident'* *'isi'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004530'isident' 'isi' string (default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004531 "@,48-57,_,128-167,224-235"
4532 otherwise: "@,48-57,_,192-255")
4533 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004534 The characters given by this option are included in identifiers.
4535 Identifiers are used in recognizing environment variables and after a
4536 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00004537 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004538 option. For '@' only characters up to 255 are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004539 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004540 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00004541 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
4542
4543 *'iskeyword'* *'isk'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004544'iskeyword' 'isk' string (Vim default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004545 "@,48-57,_,128-167,224-235"
4546 otherwise: "@,48-57,_,192-255"
4547 Vi default: "@,48-57,_")
4548 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004549 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004550 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004551 'isfname' for a description of the format of this option. For '@'
4552 characters above 255 check the "word" character class.
4553 For C programs you could use "a-z,A-Z,48-57,_,.,-,>".
Bram Moolenaar071d4272004-06-13 20:20:40 +00004554 For a help file it is set to all non-blank printable characters except
4555 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
4556 command).
4557 When the 'lisp' option is on the '-' character is always included.
Bram Moolenaarb8060fe2016-01-19 22:29:28 +01004558 This option also influences syntax highlighting, unless the syntax
4559 uses |:syn-iskeyword|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004560 NOTE: This option is set to the Vi default value when 'compatible' is
4561 set and to the Vim default value when 'compatible' is reset.
4562
4563 *'isprint'* *'isp'*
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02004564'isprint' 'isp' string (default for Win32 and macOS:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004565 "@,~-255"; otherwise: "@,161-255")
4566 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004567 The characters given by this option are displayed directly on the
4568 screen. It is also used for "\p" in a |pattern|. The characters from
4569 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
4570 even when they are not included in 'isprint' or excluded. See
4571 'isfname' for a description of the format of this option.
4572
4573 Non-printable characters are displayed with two characters:
4574 0 - 31 "^@" - "^_"
4575 32 - 126 always single characters
4576 127 "^?"
4577 128 - 159 "~@" - "~_"
4578 160 - 254 "| " - "|~"
4579 255 "~?"
4580 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
4581 displayed as <xx>, with the hexadecimal value of the byte.
4582 When 'display' contains "uhex" all unprintable characters are
4583 displayed as <xx>.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004584 The SpecialKey highlighting will be used for unprintable characters.
4585 |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004586
4587 Multi-byte characters 256 and above are always included, only the
4588 characters up to 255 are specified with this option. When a character
4589 is printable but it is not available in the current font, a
4590 replacement character will be shown.
4591 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
4592 There is no option to specify these characters.
4593
4594 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
4595'joinspaces' 'js' boolean (default on)
4596 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004597 Insert two spaces after a '.', '?' and '!' with a join command.
4598 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
4599 Otherwise only one space is inserted.
4600 NOTE: This option is set when 'compatible' is set.
4601
4602 *'key'*
4603'key' string (default "")
4604 local to buffer
Bram Moolenaar996343d2010-07-04 22:20:21 +02004605 {only available when compiled with the |+cryptv|
4606 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004607 The key that is used for encrypting and decrypting the current buffer.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02004608 See |encryption| and 'cryptmethod'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004609 Careful: Do not set the key value by hand, someone might see the typed
4610 key. Use the |:X| command. But you can make 'key' empty: >
4611 :set key=
4612< It is not possible to get the value of this option with ":set key" or
4613 "echo &key". This is to avoid showing it to someone who shouldn't
4614 know. It also means you cannot see it yourself once you have set it,
4615 be careful not to make a typing error!
Bram Moolenaard58e9292011-02-09 17:07:58 +01004616 You can use "&key" in an expression to detect whether encryption is
4617 enabled. When 'key' is set it returns "*****" (five stars).
Bram Moolenaar071d4272004-06-13 20:20:40 +00004618
4619 *'keymap'* *'kmp'* *E544*
4620'keymap' 'kmp' string (default "")
4621 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004622 {only available when compiled with the |+keymap|
4623 feature}
4624 Name of a keyboard mapping. See |mbyte-keymap|.
4625 Setting this option to a valid keymap name has the side effect of
4626 setting 'iminsert' to one, so that the keymap becomes effective.
4627 'imsearch' is also set to one, unless it was -1
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004628 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004629
4630 *'keymodel'* *'km'*
4631'keymodel' 'km' string (default "")
4632 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004633 List of comma separated words, which enable special things that keys
4634 can do. These values can be used:
4635 startsel Using a shifted special key starts selection (either
4636 Select mode or Visual mode, depending on "key" being
4637 present in 'selectmode').
4638 stopsel Using a not-shifted special key stops selection.
4639 Special keys in this context are the cursor keys, <End>, <Home>,
4640 <PageUp> and <PageDown>.
4641 The 'keymodel' option is set by the |:behave| command.
4642
4643 *'keywordprg'* *'kp'*
4644'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02004645 VMS: "help")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004646 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004647 Program to use for the |K| command. Environment variables are
4648 expanded |:set_env|. ":help" may be used to access the Vim internal
4649 help. (Note that previously setting the global option to the empty
4650 value did this, which is now deprecated.)
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02004651 When the first character is ":", the command is invoked as a Vim
4652 Ex command prefixed with [count].
4653 When "man", "man -s" or an Ex command is used, Vim will automatically
4654 translate a count for the "K" command and pass it as the first
4655 argument. For "man -s" the "-s" is removed when there is no count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004656 See |option-backslash| about including spaces and backslashes.
4657 Example: >
4658 :set keywordprg=man\ -s
4659< This option cannot be set from a |modeline| or in the |sandbox|, for
4660 security reasons.
4661
4662 *'langmap'* *'lmap'* *E357* *E358*
4663'langmap' 'lmap' string (default "")
4664 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004665 {only available when compiled with the |+langmap|
4666 feature}
4667 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004668 mode. When you are typing text in Insert mode the characters are
Bram Moolenaarfa735342016-01-03 22:14:44 +01004669 inserted directly. When in Normal mode the 'langmap' option takes
Bram Moolenaar071d4272004-06-13 20:20:40 +00004670 care of translating these special characters to the original meaning
4671 of the key. This means you don't have to change the keyboard mode to
4672 be able to execute Normal mode commands.
4673 This is the opposite of the 'keymap' option, where characters are
4674 mapped in Insert mode.
Bram Moolenaarb17893a2020-03-14 08:19:51 +01004675 Also consider setting 'langremap' to off, to prevent 'langmap' from
4676 applying to characters resulting from a mapping.
Bram Moolenaare968e362014-05-13 20:23:24 +02004677 This option cannot be set from a |modeline| or in the |sandbox|, for
4678 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004679
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00004680 Example (for Greek, in UTF-8): *greek* >
4681 :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 +00004682< Example (exchanges meaning of z and y for commands): >
4683 :set langmap=zy,yz,ZY,YZ
4684<
4685 The 'langmap' option is a list of parts, separated with commas. Each
4686 part can be in one of two forms:
4687 1. A list of pairs. Each pair is a "from" character immediately
4688 followed by the "to" character. Examples: "aA", "aAbBcC".
4689 2. A list of "from" characters, a semi-colon and a list of "to"
4690 characters. Example: "abc;ABC"
4691 Example: "aA,fgh;FGH,cCdDeE"
4692 Special characters need to be preceded with a backslash. These are
Bram Moolenaar4f4d51a2020-10-11 13:57:40 +02004693 ";", ',', '"', '|' and backslash itself.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004694
4695 This will allow you to activate vim actions without having to switch
4696 back and forth between the languages. Your language characters will
4697 be understood as normal vim English characters (according to the
4698 langmap mappings) in the following cases:
4699 o Normal/Visual mode (commands, buffer/register names, user mappings)
4700 o Insert/Replace Mode: Register names after CTRL-R
4701 o Insert/Replace Mode: Mappings
4702 Characters entered in Command-line mode will NOT be affected by
4703 this option. Note that this option can be changed at any time
4704 allowing to switch between mappings for different languages/encodings.
4705 Use a mapping to avoid having to type it each time!
4706
4707 *'langmenu'* *'lm'*
4708'langmenu' 'lm' string (default "")
4709 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004710 {only available when compiled with the |+menu| and
4711 |+multi_lang| features}
4712 Language to use for menu translation. Tells which file is loaded
4713 from the "lang" directory in 'runtimepath': >
4714 "lang/menu_" . &langmenu . ".vim"
4715< (without the spaces). For example, to always use the Dutch menus, no
4716 matter what $LANG is set to: >
4717 :set langmenu=nl_NL.ISO_8859-1
4718< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004719 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004720 If your $LANG is set to a non-English language but you do want to use
4721 the English menus: >
4722 :set langmenu=none
4723< This option must be set before loading menus, switching on filetype
4724 detection or syntax highlighting. Once the menus are defined setting
4725 this option has no effect. But you could do this: >
4726 :source $VIMRUNTIME/delmenu.vim
4727 :set langmenu=de_DE.ISO_8859-1
4728 :source $VIMRUNTIME/menu.vim
4729< Warning: This deletes all menus that you defined yourself!
4730
Bram Moolenaard94464e2015-11-02 15:28:18 +01004731 *'langnoremap'* *'lnr'* *'nolangnoremap'* *'nolnr'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004732'langnoremap' 'lnr' boolean (default off, set in |defaults.vim|)
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004733 global
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004734 {only available when compiled with the |+langmap|
4735 feature}
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004736 This is just like 'langremap' but with the value inverted. It only
4737 exists for backwards compatibility. When setting 'langremap' then
4738 'langnoremap' is set to the inverted value, and the other way around.
4739
4740 *'langremap'* *'lrm'* *'nolangremap'* *'nolrm'*
Bram Moolenaarb17893a2020-03-14 08:19:51 +01004741'langremap' 'lrm' boolean (default on, set to off in |defaults.vim|)
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004742 global
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004743 {only available when compiled with the |+langmap|
4744 feature}
4745 When off, setting 'langmap' does not apply to characters resulting from
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004746 a mapping. This basically means, if you noticed that setting
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004747 'langmap' disables some of your mappings, try resetting this option.
4748 This option defaults to on for backwards compatibility. Set it off if
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004749 that works for you to avoid mappings to break.
4750
Bram Moolenaar071d4272004-06-13 20:20:40 +00004751 *'laststatus'* *'ls'*
4752'laststatus' 'ls' number (default 1)
4753 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004754 The value of this option influences when the last window will have a
4755 status line:
4756 0: never
4757 1: only if there are at least two windows
4758 2: always
4759 The screen looks nicer with a status line if you have several
4760 windows, but it takes another screen line. |status-line|
4761
4762 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
4763'lazyredraw' 'lz' boolean (default off)
4764 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004765 When this option is set, the screen will not be redrawn while
4766 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004767 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00004768 update use |:redraw|.
4769
4770 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
4771'linebreak' 'lbr' boolean (default off)
4772 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02004773 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004774 feature}
Bram Moolenaar946e27a2014-06-25 18:50:27 +02004775 If on, Vim will wrap long lines at a character in 'breakat' rather
Bram Moolenaar071d4272004-06-13 20:20:40 +00004776 than at the last character that fits on the screen. Unlike
4777 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
Bram Moolenaar946e27a2014-06-25 18:50:27 +02004778 it only affects the way the file is displayed, not its contents.
4779 If 'breakindent' is set, line is visually indented. Then, the value
4780 of 'showbreak' is used to put in front of wrapped lines. This option
Bram Moolenaar86b17e92014-07-02 20:00:47 +02004781 is not used when the 'wrap' option is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004782 Note that <Tab> characters after an <EOL> are mostly not displayed
4783 with the right amount of white space.
4784
4785 *'lines'* *E593*
4786'lines' number (default 24 or terminal height)
4787 global
4788 Number of lines of the Vim window.
4789 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00004790 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004791 When Vim is running in the GUI or in a resizable window, setting this
4792 option will cause the window size to be changed. When you only want
4793 to use the size for the GUI, put the command in your |gvimrc| file.
4794 Vim limits the number of lines to what fits on the screen. You can
4795 use this command to get the tallest window possible: >
4796 :set lines=999
Bram Moolenaarf4d11452005-12-02 00:46:37 +00004797< Minimum value is 2, maximum value is 1000.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02004798 If you get fewer lines than expected, check the 'guiheadroom' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004799 When you set this option and Vim is unable to change the physical
4800 number of lines of the display, the display may be messed up.
4801
4802 *'linespace'* *'lsp'*
4803'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
4804 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004805 {only in the GUI}
4806 Number of pixel lines inserted between characters. Useful if the font
4807 uses the full character cell height, making lines touch each other.
4808 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004809 With some fonts there can be too much room between lines (to have
4810 space for ascents and descents). Then it makes sense to set
4811 'linespace' to a negative value. This may cause display problems
4812 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00004813
4814 *'lisp'* *'nolisp'*
4815'lisp' boolean (default off)
4816 local to buffer
4817 {not available when compiled without the |+lispindent|
4818 feature}
4819 Lisp mode: When <Enter> is typed in insert mode set the indent for
4820 the next line to Lisp standards (well, sort of). Also happens with
4821 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
4822 flag in 'cpoptions' changes the method of indenting: Vi compatible or
4823 better. Also see 'lispwords'.
4824 The '-' character is included in keyword characters. Redefines the
4825 "=" operator to use this same indentation algorithm rather than
4826 calling an external program if 'equalprg' is empty.
4827 This option is not used when 'paste' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004828
4829 *'lispwords'* *'lw'*
4830'lispwords' 'lw' string (default is very long)
Bram Moolenaaraf6c1312014-03-12 18:55:58 +01004831 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004832 {not available when compiled without the |+lispindent|
4833 feature}
4834 Comma separated list of words that influence the Lisp indenting.
4835 |'lisp'|
4836
4837 *'list'* *'nolist'*
4838'list' boolean (default off)
4839 local to window
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004840 List mode: Show tabs as CTRL-I is displayed, display $ after end of
4841 line. Useful to see the difference between tabs and spaces and for
4842 trailing blanks. Further changed by the 'listchars' option.
4843
4844 The cursor is displayed at the start of the space a Tab character
4845 occupies, not at the end as usual in Normal mode. To get this cursor
4846 position while displaying Tabs with spaces, use: >
Bram Moolenaardd007ed2013-07-09 15:44:17 +02004847 :set list lcs=tab:\ \
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004848<
4849 Note that list mode will also affect formatting (set with 'textwidth'
4850 or 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
Bram Moolenaar071d4272004-06-13 20:20:40 +00004851 changing the way tabs are displayed.
4852
4853 *'listchars'* *'lcs'*
4854'listchars' 'lcs' string (default "eol:$")
4855 global
Bram Moolenaarf9d5ca12010-08-01 16:13:51 +02004856 Strings to use in 'list' mode and for the |:list| command. It is a
4857 comma separated list of string settings.
Bram Moolenaar79278362015-04-21 18:33:48 +02004858 *lcs-eol*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004859 eol:c Character to show at the end of each line. When
4860 omitted, there is no extra character at the end of the
4861 line.
Bram Moolenaar79278362015-04-21 18:33:48 +02004862 *lcs-tab*
Bram Moolenaar83a52172019-01-16 22:41:54 +01004863 tab:xy[z] Two or three characters to be used to show a tab.
4864 The third character is optional.
4865
4866 tab:xy The 'x' is always used, then 'y' as many times as will
4867 fit. Thus "tab:>-" displays:
4868 >
4869 >-
4870 >--
4871 etc.
4872
4873 tab:xyz The 'z' is always used, then 'x' is prepended, and
4874 then 'y' is used as many times as will fit. Thus
4875 "tab:<->" displays:
4876 >
4877 <>
4878 <->
4879 <-->
4880 etc.
4881
4882 When "tab:" is omitted, a tab is shown as ^I.
Bram Moolenaar79278362015-04-21 18:33:48 +02004883 *lcs-space*
4884 space:c Character to show for a space. When omitted, spaces
4885 are left blank.
Bram Moolenaar91478ae2021-02-03 15:58:13 +01004886 *lcs-lead*
4887 lead:c Character to show for leading spaces. When omitted,
4888 leading spaces are blank. Overrides the "space"
Bram Moolenaar942db232021-02-13 18:14:48 +01004889 setting for leading spaces. You can combine it with
4890 "tab:", for example: >
4891 :set listchars+=tab:>-,lead:.
4892< *lcs-trail*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004893 trail:c Character to show for trailing spaces. When omitted,
Bram Moolenaar79278362015-04-21 18:33:48 +02004894 trailing spaces are blank. Overrides the "space"
4895 setting for trailing spaces.
4896 *lcs-extends*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004897 extends:c Character to show in the last column, when 'wrap' is
4898 off and the line continues beyond the right of the
4899 screen.
Bram Moolenaar79278362015-04-21 18:33:48 +02004900 *lcs-precedes*
Bram Moolenaarbffba7f2019-09-20 17:00:17 +02004901 precedes:c Character to show in the first visible column of the
4902 physical line, when there is text preceding the
4903 character visible in the first column.
Bram Moolenaar79278362015-04-21 18:33:48 +02004904 *lcs-conceal*
Bram Moolenaar860cae12010-06-05 23:22:07 +02004905 conceal:c Character to show in place of concealed text, when
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004906 'conceallevel' is set to 1.
Bram Moolenaar79278362015-04-21 18:33:48 +02004907 *lcs-nbsp*
Bram Moolenaar73284b92015-05-04 17:28:22 +02004908 nbsp:c Character to show for a non-breakable space character
4909 (0xA0 (160 decimal) and U+202F). Left blank when
4910 omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004911
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004912 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00004913 be used when 'encoding' is "utf-8", otherwise only printable
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004914 characters are allowed. All characters must be single width.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004915
4916 Examples: >
4917 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004918 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00004919 :set lcs=extends:>,precedes:<
4920< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaar79278362015-04-21 18:33:48 +02004921 "precedes". "SpecialKey" for "nbsp", "space", "tab" and "trail".
Bram Moolenaar02467872007-05-06 13:22:01 +00004922 |hl-NonText| |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004923
4924 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
4925'loadplugins' 'lpl' boolean (default on)
4926 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004927 When on the plugin scripts are loaded when starting up |load-plugins|.
4928 This option can be reset in your |vimrc| file to disable the loading
4929 of plugins.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02004930 Note that using the "-u NONE", "-u DEFAULTS" and "--noplugin" command
4931 line arguments reset this option. See |-u| and |--noplugin|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004932
Bram Moolenaard94464e2015-11-02 15:28:18 +01004933 *'luadll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01004934'luadll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01004935 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01004936 {only available when compiled with the |+lua/dyn|
4937 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01004938 Specifies the name of the Lua shared library. The default is
4939 DYNAMIC_LUA_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02004940 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01004941 This option cannot be set from a |modeline| or in the |sandbox|, for
4942 security reasons.
4943
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00004944 *'macatsui'* *'nomacatsui'*
4945'macatsui' boolean (default on)
4946 global
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02004947 {not supported}
4948 No longer supported, as the Mac OS X GUI code was removed.
Bram Moolenaar02467872007-05-06 13:22:01 +00004949
Bram Moolenaar071d4272004-06-13 20:20:40 +00004950 *'magic'* *'nomagic'*
4951'magic' boolean (default on)
4952 global
4953 Changes the special characters that can be used in search patterns.
4954 See |pattern|.
Bram Moolenaar64d8e252016-09-06 22:12:34 +02004955 WARNING: Switching this option off most likely breaks plugins! That
4956 is because many patterns assume it's on and will fail when it's off.
4957 Only switch it off when working with old Vi scripts. In any other
4958 situation write patterns that work when 'magic' is on. Include "\M"
4959 when you want to |/\M|.
Bram Moolenaar4072ba52020-12-23 13:56:35 +01004960 In |Vim9| script the value of 'magic' is ignored, patterns behave like
4961 it is always set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004962
4963 *'makeef'* *'mef'*
4964'makeef' 'mef' string (default: "")
4965 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004966 {not available when compiled without the |+quickfix|
4967 feature}
4968 Name of the errorfile for the |:make| command (see |:make_makeprg|)
4969 and the |:grep| command.
4970 When it is empty, an internally generated temp file will be used.
4971 When "##" is included, it is replaced by a number to make the name
4972 unique. This makes sure that the ":make" command doesn't overwrite an
4973 existing file.
4974 NOT used for the ":cf" command. See 'errorfile' for that.
4975 Environment variables are expanded |:set_env|.
4976 See |option-backslash| about including spaces and backslashes.
4977 This option cannot be set from a |modeline| or in the |sandbox|, for
4978 security reasons.
4979
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01004980 *'makeencoding'* *'menc'*
4981'makeencoding' 'menc' string (default "")
4982 global or local to buffer |global-local|
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01004983 Encoding used for reading the output of external commands. When empty,
4984 encoding is not converted.
4985 This is used for `:make`, `:lmake`, `:grep`, `:lgrep`, `:grepadd`,
4986 `:lgrepadd`, `:cfile`, `:cgetfile`, `:caddfile`, `:lfile`, `:lgetfile`,
4987 and `:laddfile`.
4988
4989 This would be mostly useful when you use MS-Windows and set 'encoding'
4990 to "utf-8". If |+iconv| is enabled and GNU libiconv is used, setting
4991 'makeencoding' to "char" has the same effect as setting to the system
4992 locale encoding. Example: >
4993 :set encoding=utf-8
4994 :set makeencoding=char " system locale is used
4995<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004996 *'makeprg'* *'mp'*
4997'makeprg' 'mp' string (default "make", VMS: "MMS")
4998 global or local to buffer |global-local|
Bram Moolenaar02467872007-05-06 13:22:01 +00004999 Program to use for the ":make" command. See |:make_makeprg|.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01005000 This option may contain '%' and '#' characters (see |:_%| and |:_#|),
5001 which are expanded to the current and alternate file name. Use |::S|
Bram Moolenaar26df0922014-02-23 23:39:13 +01005002 to escape file names in case they contain special characters.
Bram Moolenaar02467872007-05-06 13:22:01 +00005003 Environment variables are expanded |:set_env|. See |option-backslash|
5004 about including spaces and backslashes.
5005 Note that a '|' must be escaped twice: once for ":set" and once for
5006 the interpretation of a command. When you use a filter called
5007 "myfilter" do it like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005008 :set makeprg=gmake\ \\\|\ myfilter
5009< The placeholder "$*" can be given (even multiple times) to specify
5010 where the arguments will be included, for example: >
5011 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
5012< This option cannot be set from a |modeline| or in the |sandbox|, for
5013 security reasons.
5014
5015 *'matchpairs'* *'mps'*
5016'matchpairs' 'mps' string (default "(:),{:},[:]")
5017 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005018 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01005019 other.
5020 Only character pairs are allowed that are different, thus you cannot
5021 jump between two double quotes.
5022 The characters must be separated by a colon.
Bram Moolenaar02467872007-05-06 13:22:01 +00005023 The pairs must be separated by a comma. Example for including '<' and
5024 '>' (HTML): >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005025 :set mps+=<:>
5026
5027< A more exotic example, to jump between the '=' and ';' in an
5028 assignment, useful for languages like C and Java: >
5029 :au FileType c,cpp,java set mps+==:;
5030
5031< For a more advanced way of using "%", see the matchit.vim plugin in
Bram Moolenaar01164a62017-11-02 22:58:42 +01005032 the $VIMRUNTIME/pack/dist/opt/matchit directory. |add-local-help|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005033
5034 *'matchtime'* *'mat'*
5035'matchtime' 'mat' number (default 5)
5036 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005037 Tenths of a second to show the matching paren, when 'showmatch' is
5038 set. Note that this is not in milliseconds, like other options that
5039 set a time. This is to be compatible with Nvi.
5040
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005041 *'maxcombine'* *'mco'*
5042'maxcombine' 'mco' number (default 2)
5043 global
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005044 The maximum number of combining characters supported for displaying.
5045 Only used when 'encoding' is "utf-8".
5046 The default is OK for most languages. Hebrew may require 4.
5047 Maximum value is 6.
5048 Even when this option is set to 2 you can still edit text with more
5049 combining characters, you just can't see them. Use |g8| or |ga|.
5050 See |mbyte-combining|.
5051
Bram Moolenaar071d4272004-06-13 20:20:40 +00005052 *'maxfuncdepth'* *'mfd'*
5053'maxfuncdepth' 'mfd' number (default 100)
5054 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02005055 {not available when compiled without the |+eval|
Bram Moolenaar02467872007-05-06 13:22:01 +00005056 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005057 Maximum depth of function calls for user functions. This normally
5058 catches endless recursion. When using a recursive function with
5059 more depth, set 'maxfuncdepth' to a bigger number. But this will use
5060 more memory, there is the danger of failing when memory is exhausted.
Bram Moolenaarbc2eada2017-01-02 21:27:47 +01005061 Increasing this limit above 200 also changes the maximum for Ex
Bram Moolenaar0b0f0992018-05-22 21:41:30 +02005062 command recursion, see |E169|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005063 See also |:function|.
5064
5065 *'maxmapdepth'* *'mmd'* *E223*
5066'maxmapdepth' 'mmd' number (default 1000)
5067 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005068 Maximum number of times a mapping is done without resulting in a
5069 character to be used. This normally catches endless mappings, like
5070 ":map x y" with ":map y x". It still does not catch ":map g wg",
5071 because the 'w' is used before the next mapping is done. See also
5072 |key-mapping|.
5073
5074 *'maxmem'* *'mm'*
5075'maxmem' 'mm' number (default between 256 to 5120 (system
5076 dependent) or half the amount of memory
5077 available)
5078 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005079 Maximum amount of memory (in Kbyte) to use for one buffer. When this
5080 limit is reached allocating extra memory for a buffer will cause
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005081 other memory to be freed.
5082 The maximum usable value is about 2000000. Use this to work without a
5083 limit.
5084 The value is ignored when 'swapfile' is off.
5085 Also see 'maxmemtot'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005086
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005087 *'maxmempattern'* *'mmp'*
5088'maxmempattern' 'mmp' number (default 1000)
5089 global
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005090 Maximum amount of memory (in Kbyte) to use for pattern matching.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005091 The maximum value is about 2000000. Use this to work without a limit.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005092 *E363*
Bram Moolenaar02467872007-05-06 13:22:01 +00005093 When Vim runs into the limit it gives an error message and mostly
5094 behaves like CTRL-C was typed.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005095 Running into the limit often means that the pattern is very
5096 inefficient or too complex. This may already happen with the pattern
5097 "\(.\)*" on a very long line. ".*" works much better.
Bram Moolenaarfd358112018-07-07 23:21:31 +02005098 Might also happen on redraw, when syntax rules try to match a complex
5099 text structure.
5100 Vim may run out of memory before hitting the 'maxmempattern' limit, in
5101 which case you get an "Out of memory" error instead.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005102
Bram Moolenaar071d4272004-06-13 20:20:40 +00005103 *'maxmemtot'* *'mmt'*
5104'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
5105 dependent) or half the amount of memory
5106 available)
5107 global
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005108 Maximum amount of memory in Kbyte to use for all buffers together.
5109 The maximum usable value is about 2000000 (2 Gbyte). Use this to work
Bram Moolenaarfa735342016-01-03 22:14:44 +01005110 without a limit.
5111 On 64 bit machines higher values might work. But hey, do you really
5112 need more than 2 Gbyte for text editing? Keep in mind that text is
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005113 stored in the swap file, one can edit files > 2 Gbyte anyway. We do
Bram Moolenaarfa735342016-01-03 22:14:44 +01005114 need the memory to store undo info.
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005115 Buffers with 'swapfile' off still count to the total amount of memory
5116 used.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005117 Also see 'maxmem'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005118
5119 *'menuitems'* *'mis'*
5120'menuitems' 'mis' number (default 25)
5121 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005122 {not available when compiled without the |+menu|
5123 feature}
5124 Maximum number of items to use in a menu. Used for menus that are
5125 generated from a list of items, e.g., the Buffers menu. Changing this
5126 option has no direct effect, the menu must be refreshed first.
5127
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005128 *'mkspellmem'* *'msm'*
5129'mkspellmem' 'msm' string (default "460000,2000,500")
5130 global
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005131 {not available when compiled without the |+syntax|
5132 feature}
5133 Parameters for |:mkspell|. This tunes when to start compressing the
5134 word tree. Compression can be slow when there are many words, but
5135 it's needed to avoid running out of memory. The amount of memory used
5136 per word depends very much on how similar the words are, that's why
5137 this tuning is complicated.
5138
5139 There are three numbers, separated by commas:
5140 {start},{inc},{added}
5141
5142 For most languages the uncompressed word tree fits in memory. {start}
5143 gives the amount of memory in Kbyte that can be used before any
5144 compression is done. It should be a bit smaller than the amount of
5145 memory that is available to Vim.
5146
5147 When going over the {start} limit the {inc} number specifies the
5148 amount of memory in Kbyte that can be allocated before another
5149 compression is done. A low number means compression is done after
5150 less words are added, which is slow. A high number means more memory
5151 will be allocated.
5152
5153 After doing compression, {added} times 1024 words can be added before
5154 the {inc} limit is ignored and compression is done when any extra
5155 amount of memory is needed. A low number means there is a smaller
5156 chance of hitting the {inc} limit, less memory is used but it's
5157 slower.
5158
5159 The languages for which these numbers are important are Italian and
5160 Hungarian. The default works for when you have about 512 Mbyte. If
5161 you have 1 Gbyte you could use: >
5162 :set mkspellmem=900000,3000,800
5163< If you have less than 512 Mbyte |:mkspell| may fail for some
5164 languages, no matter what you set 'mkspellmem' to.
5165
Bram Moolenaar07607392019-05-26 19:20:43 +02005166 This option cannot be set from a |modeline| or in the |sandbox|.
5167
Bram Moolenaar071d4272004-06-13 20:20:40 +00005168 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
Bram Moolenaar8243a792007-05-01 17:05:03 +00005169'modeline' 'ml' boolean (Vim default: on (off for root),
5170 Vi default: off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005171 local to buffer
Bram Moolenaar110289e2019-05-23 15:38:06 +02005172 If 'modeline' is on 'modelines' gives the number of lines that is
5173 checked for set commands. If 'modeline' is off or 'modelines' is zero
5174 no lines are checked. See |modeline|.
5175
5176 *'modelineexpr'* *'mle'* *'nomodelineexpr'* *'nomle'*
5177'modelineexpr' 'mle' boolean (default: off)
5178 global
5179 When on allow some options that are an expression to be set in the
5180 modeline. Check the option for whether it is affected by
5181 'modelineexpr'. Also see |modeline|.
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02005182 This option cannot be set from a |modeline| or in the |sandbox|, for
5183 security reasons.
Bram Moolenaar110289e2019-05-23 15:38:06 +02005184
Bram Moolenaar071d4272004-06-13 20:20:40 +00005185 *'modelines'* *'mls'*
5186'modelines' 'mls' number (default 5)
5187 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005188 If 'modeline' is on 'modelines' gives the number of lines that is
5189 checked for set commands. If 'modeline' is off or 'modelines' is zero
5190 no lines are checked. See |modeline|.
5191 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
5192 set and to the Vim default value when 'compatible' is reset.
5193
5194 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
Bram Moolenaar110289e2019-05-23 15:38:06 +02005195 *E21*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005196'modifiable' 'ma' boolean (default on)
5197 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005198 When off the buffer contents cannot be changed. The 'fileformat' and
5199 'fileencoding' options also can't be changed.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01005200 Can be reset on startup with the |-M| command line argument.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005201
5202 *'modified'* *'mod'* *'nomodified'* *'nomod'*
5203'modified' 'mod' boolean (default off)
5204 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005205 When on, the buffer is considered to be modified. This option is set
5206 when:
5207 1. A change was made to the text since it was last written. Using the
5208 |undo| command to go back to the original text will reset the
5209 option. But undoing changes that were made before writing the
5210 buffer will set the option again, since the text is different from
5211 when it was written.
5212 2. 'fileformat' or 'fileencoding' is different from its original
5213 value. The original value is set when the buffer is read or
5214 written. A ":set nomodified" command also resets the original
5215 values to the current values and the 'modified' option will be
5216 reset.
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01005217 Similarly for 'eol' and 'bomb'.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02005218 This option is not set when a change is made to the buffer as the
5219 result of a BufNewFile, BufRead/BufReadPost, BufWritePost,
5220 FileAppendPost or VimLeave autocommand event. See |gzip-example| for
5221 an explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005222 When 'buftype' is "nowrite" or "nofile" this option may be set, but
5223 will be ignored.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01005224 Note that the text may actually be the same, e.g. 'modified' is set
5225 when using "rA" on an "A".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005226
5227 *'more'* *'nomore'*
5228'more' boolean (Vim default: on, Vi default: off)
5229 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005230 When on, listings pause when the whole screen is filled. You will get
5231 the |more-prompt|. When this option is off there are no pauses, the
5232 listing continues until finished.
5233 NOTE: This option is set to the Vi default value when 'compatible' is
5234 set and to the Vim default value when 'compatible' is reset.
5235
Bram Moolenaar98a29d02021-01-18 19:55:44 +01005236 *'mouse'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005237'mouse' string (default "", "a" for GUI and Win32,
Bram Moolenaar5b418992019-10-27 18:50:25 +01005238 set to "a" or "nvi" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005239 global
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005240 Enable the use of the mouse. Works for most terminals (xterm, Win32
5241 |win32-mouse|, QNX pterm, *BSD console with sysmouse and Linux console
5242 with gpm). For using the mouse in the GUI, see |gui-mouse|. The
5243 mouse can be enabled for different modes:
Bram Moolenaar7f2e9d72017-11-11 20:58:53 +01005244 n Normal mode and Terminal modes
Bram Moolenaar071d4272004-06-13 20:20:40 +00005245 v Visual mode
5246 i Insert mode
5247 c Command-line mode
5248 h all previous modes when editing a help file
5249 a all previous modes
5250 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005251 Normally you would enable the mouse in all five modes with: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005252 :set mouse=a
Bram Moolenaar5b418992019-10-27 18:50:25 +01005253< If your terminal can't overrule the mouse events going to the
5254 application, use: >
5255 :set mouse=nvi
Bram Moolenaar65e0d772020-06-14 17:29:55 +02005256< Then you can press ":", select text for the system, and press Esc to go
Bram Moolenaar5b418992019-10-27 18:50:25 +01005257 back to Vim using the mouse events.
5258 In |defaults.vim| "nvi" is used if the 'term' option is not matching
5259 "xterm".
5260
5261 When the mouse is not enabled, the GUI will still use the mouse for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005262 modeless selection. This doesn't move the text cursor.
5263
5264 See |mouse-using|. Also see |'clipboard'|.
5265
5266 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005267 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005268 the mouse buttons can still be used by keeping the shift key pressed.
5269 Also see the 'clipboard' option.
5270
5271 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
5272'mousefocus' 'mousef' boolean (default off)
5273 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005274 {only works in the GUI}
5275 The window that the mouse pointer is on is automatically activated.
5276 When changing the window layout or window focus in another way, the
5277 mouse pointer is moved to the window with keyboard focus. Off is the
5278 default because it makes using the pull down menus a little goofy, as
5279 a pointer transit may activate a window unintentionally.
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01005280 MS-Windows: Also see 'scrollfocus' for what window is scrolled when
Bram Moolenaar1d9215b2020-01-25 13:27:42 +01005281 using the mouse scroll wheel.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005282
5283 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
5284'mousehide' 'mh' boolean (default on)
5285 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005286 {only works in the GUI}
5287 When on, the mouse pointer is hidden when characters are typed.
5288 The mouse pointer is restored when the mouse is moved.
5289
5290 *'mousemodel'* *'mousem'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005291'mousemodel' 'mousem' string (default "extend", "popup" for Win32)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005292 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005293 Sets the model to use for the mouse. The name mostly specifies what
5294 the right mouse button is used for:
5295 extend Right mouse button extends a selection. This works
5296 like in an xterm.
5297 popup Right mouse button pops up a menu. The shifted left
5298 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00005299 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005300 popup_setpos Like "popup", but the cursor will be moved to the
5301 position where the mouse was clicked, and thus the
5302 selected operation will act upon the clicked object.
5303 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00005304 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005305 course, that right clicking outside a selection will
5306 end Visual mode.
5307 Overview of what button does what for each model:
5308 mouse extend popup(_setpos) ~
5309 left click place cursor place cursor
5310 left drag start selection start selection
5311 shift-left search word extend selection
5312 right click extend selection popup menu (place cursor)
5313 right drag extend selection -
5314 middle click paste paste
5315
5316 In the "popup" model the right mouse button produces a pop-up menu.
5317 You need to define this first, see |popup-menu|.
5318
5319 Note that you can further refine the meaning of buttons with mappings.
5320 See |gui-mouse-mapping|. But mappings are NOT used for modeless
5321 selection (because that's handled in the GUI code directly).
5322
5323 The 'mousemodel' option is set by the |:behave| command.
5324
5325 *'mouseshape'* *'mouses'* *E547*
Bram Moolenaarf6b40102019-02-22 15:24:03 +01005326'mouseshape' 'mouses' string (default "i-r:beam,s:updown,sd:udsizing,
5327 vs:leftright,vd:lrsizing,m:no,
5328 ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005329 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005330 {only available when compiled with the |+mouseshape|
5331 feature}
5332 This option tells Vim what the mouse pointer should look like in
5333 different modes. The option is a comma separated list of parts, much
5334 like used for 'guicursor'. Each part consist of a mode/location-list
5335 and an argument-list:
5336 mode-list:shape,mode-list:shape,..
5337 The mode-list is a dash separated list of these modes/locations:
5338 In a normal window: ~
5339 n Normal mode
5340 v Visual mode
5341 ve Visual mode with 'selection' "exclusive" (same as 'v',
5342 if not specified)
5343 o Operator-pending mode
5344 i Insert mode
5345 r Replace mode
5346
5347 Others: ~
5348 c appending to the command-line
5349 ci inserting in the command-line
5350 cr replacing in the command-line
5351 m at the 'Hit ENTER' or 'More' prompts
5352 ml idem, but cursor in the last line
5353 e any mode, pointer below last window
5354 s any mode, pointer on a status line
5355 sd any mode, while dragging a status line
5356 vs any mode, pointer on a vertical separator line
5357 vd any mode, while dragging a vertical separator line
5358 a everywhere
5359
5360 The shape is one of the following:
5361 avail name looks like ~
5362 w x arrow Normal mouse pointer
5363 w x blank no pointer at all (use with care!)
5364 w x beam I-beam
5365 w x updown up-down sizing arrows
5366 w x leftright left-right sizing arrows
5367 w x busy The system's usual busy pointer
5368 w x no The system's usual 'no input' pointer
5369 x udsizing indicates up-down resizing
5370 x lrsizing indicates left-right resizing
5371 x crosshair like a big thin +
5372 x hand1 black hand
5373 x hand2 white hand
5374 x pencil what you write with
5375 x question big ?
5376 x rightup-arrow arrow pointing right-up
5377 w x up-arrow arrow pointing up
5378 x <number> any X11 pointer number (see X11/cursorfont.h)
5379
5380 The "avail" column contains a 'w' if the shape is available for Win32,
5381 x for X11.
5382 Any modes not specified or shapes not available use the normal mouse
5383 pointer.
5384
5385 Example: >
5386 :set mouseshape=s:udsizing,m:no
5387< will make the mouse turn to a sizing arrow over the status lines and
5388 indicate no input when the hit-enter prompt is displayed (since
5389 clicking the mouse has no effect in this state.)
5390
5391 *'mousetime'* *'mouset'*
5392'mousetime' 'mouset' number (default 500)
5393 global
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005394 Only for GUI, Win32 and Unix with xterm. Defines the maximum
Bram Moolenaar071d4272004-06-13 20:20:40 +00005395 time in msec between two mouse clicks for the second click to be
5396 recognized as a multi click.
5397
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005398 *'mzschemedll'*
5399'mzschemedll' string (default depends on the build)
5400 global
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005401 {only available when compiled with the |+mzscheme/dyn|
5402 feature}
5403 Specifies the name of the MzScheme shared library. The default is
5404 DYNAMIC_MZSCH_DLL which was specified at compile time.
5405 Environment variables are expanded |:set_env|.
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01005406 The value must be set in the |vimrc| script or earlier. In the
Bram Moolenaar01164a62017-11-02 22:58:42 +01005407 startup, before the |load-plugins| step.
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005408 This option cannot be set from a |modeline| or in the |sandbox|, for
5409 security reasons.
5410
5411 *'mzschemegcdll'*
5412'mzschemegcdll' string (default depends on the build)
5413 global
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005414 {only available when compiled with the |+mzscheme/dyn|
5415 feature}
5416 Specifies the name of the MzScheme GC shared library. The default is
5417 DYNAMIC_MZGC_DLL which was specified at compile time.
5418 The value can be equal to 'mzschemedll' if it includes the GC code.
5419 Environment variables are expanded |:set_env|.
5420 This option cannot be set from a |modeline| or in the |sandbox|, for
5421 security reasons.
5422
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005423 *'mzquantum'* *'mzq'*
5424'mzquantum' 'mzq' number (default 100)
5425 global
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005426 {not available when compiled without the |+mzscheme|
5427 feature}
5428 The number of milliseconds between polls for MzScheme threads.
5429 Negative or zero value means no thread scheduling.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005430 NOTE: This option is set to the Vim default value when 'compatible'
5431 is reset.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005432
Bram Moolenaar071d4272004-06-13 20:20:40 +00005433 *'nrformats'* *'nf'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02005434'nrformats' 'nf' string (default "bin,octal,hex",
5435 set to "bin,hex" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005436 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005437 This defines what bases Vim will consider for numbers when using the
5438 CTRL-A and CTRL-X commands for adding to and subtracting from a number
5439 respectively; see |CTRL-A| for more info on these commands.
Bram Moolenaar4770d092006-01-12 23:22:24 +00005440 alpha If included, single alphabetical characters will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005441 incremented or decremented. This is useful for a list with a
Bram Moolenaar3848e002016-03-19 18:42:29 +01005442 letter index a), b), etc. *octal-nrformats*
Bram Moolenaar4770d092006-01-12 23:22:24 +00005443 octal If included, numbers that start with a zero will be considered
Bram Moolenaar071d4272004-06-13 20:20:40 +00005444 to be octal. Example: Using CTRL-A on "007" results in "010".
Bram Moolenaar4770d092006-01-12 23:22:24 +00005445 hex If included, numbers starting with "0x" or "0X" will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005446 considered to be hexadecimal. Example: Using CTRL-X on
5447 "0x100" results in "0x0ff".
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005448 bin If included, numbers starting with "0b" or "0B" will be
5449 considered to be binary. Example: Using CTRL-X on
5450 "0b1000" subtracts one, resulting in "0b0111".
Bram Moolenaaraaad9952020-05-31 15:08:59 +02005451 unsigned If included, numbers are recognized as unsigned. Thus a
5452 leading dash or negative sign won't be considered as part of
5453 the number. Examples:
5454 Using CTRL-X on "2020" in "9-2020" results in "9-2019"
5455 (without "unsigned" it would become "9-2021").
5456 Using CTRL-A on "2020" in "9-2020" results in "9-2021"
5457 (without "unsigned" it would become "9-2019").
Bram Moolenaaracc22402020-06-07 21:07:18 +02005458 Using CTRL-X on "0" or CTRL-A on "18446744073709551615"
5459 (2^64 - 1) has no effect, overflow is prevented.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005460 Numbers which simply begin with a digit in the range 1-9 are always
5461 considered decimal. This also happens for numbers that are not
5462 recognized as octal or hex.
5463
5464 *'number'* *'nu'* *'nonumber'* *'nonu'*
5465'number' 'nu' boolean (default off)
5466 local to window
5467 Print the line number in front of each line. When the 'n' option is
5468 excluded from 'cpoptions' a wrapped line will not use the column of
5469 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005470 The 'numberwidth' option can be used to set the room used for the line
5471 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005472 When a long, wrapped line doesn't start with the first character, '-'
5473 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02005474 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
5475 the number.
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005476 *number_relativenumber*
5477 The 'relativenumber' option changes the displayed number to be
5478 relative to the cursor. Together with 'number' there are these
5479 four combinations (cursor in line 3):
5480
Bram Moolenaar3848e002016-03-19 18:42:29 +01005481 'nonu' 'nu' 'nonu' 'nu'
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005482 'nornu' 'nornu' 'rnu' 'rnu'
5483
5484 |apple | 1 apple | 2 apple | 2 apple
5485 |pear | 2 pear | 1 pear | 1 pear
5486 |nobody | 3 nobody | 0 nobody |3 nobody
5487 |there | 4 there | 1 there | 1 there
Bram Moolenaar071d4272004-06-13 20:20:40 +00005488
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005489 *'numberwidth'* *'nuw'*
5490'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
5491 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005492 {only available when compiled with the |+linebreak|
5493 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005494 Minimal number of columns to use for the line number. Only relevant
Bram Moolenaar64486672010-05-16 15:46:46 +02005495 when the 'number' or 'relativenumber' option is set or printing lines
5496 with a line number. Since one space is always between the number and
5497 the text, there is one less character for the number itself.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005498 The value is the minimum width. A bigger width is used when needed to
Bram Moolenaar64486672010-05-16 15:46:46 +02005499 fit the highest line number in the buffer respectively the number of
5500 rows in the window, depending on whether 'number' or 'relativenumber'
5501 is set. Thus with the Vim default of 4 there is room for a line number
5502 up to 999. When the buffer has 1000 lines five columns will be used.
Bram Moolenaarf8a07122019-07-01 22:06:07 +02005503 The minimum value is 1, the maximum value is 20.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005504 NOTE: This option is set to the Vi default value when 'compatible' is
5505 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005506
Bram Moolenaarf75a9632005-09-13 21:20:47 +00005507 *'omnifunc'* *'ofu'*
5508'omnifunc' 'ofu' string (default: empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00005509 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02005510 {not available when compiled without the |+eval|
Bram Moolenaare2c453d2019-08-21 14:37:09 +02005511 feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00005512 This option specifies a function to be used for Insert mode omni
5513 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
Bram Moolenaar280f1262006-01-30 00:14:18 +00005514 See |complete-functions| for an explanation of how the function is
5515 invoked and what it should return.
Bram Moolenaar043545e2006-10-10 16:44:07 +00005516 This option is usually set by a filetype plugin:
Bram Moolenaar9c102382006-05-03 21:26:49 +00005517 |:filetype-plugin-on|
Bram Moolenaar30b65812012-07-12 22:01:11 +02005518 This option cannot be set from a |modeline| or in the |sandbox|, for
5519 security reasons.
Bram Moolenaare344bea2005-09-01 20:46:49 +00005520
5521
Bram Moolenaar02467872007-05-06 13:22:01 +00005522 *'opendevice'* *'odev'* *'noopendevice'* *'noodev'*
Bram Moolenaar043545e2006-10-10 16:44:07 +00005523'opendevice' 'odev' boolean (default off)
5524 global
Bram Moolenaar6f345a12019-12-17 21:27:18 +01005525 {only for MS-Windows}
Bram Moolenaar043545e2006-10-10 16:44:07 +00005526 Enable reading and writing from devices. This may get Vim stuck on a
5527 device that can be opened but doesn't actually do the I/O. Therefore
5528 it is off by default.
5529 Note that on MS-Windows editing "aux.h", "lpt1.txt" and the like also
5530 result in editing a device.
5531
5532
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005533 *'operatorfunc'* *'opfunc'*
5534'operatorfunc' 'opfunc' string (default: empty)
5535 global
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005536 This option specifies a function to be called by the |g@| operator.
5537 See |:map-operator| for more info and an example.
5538
5539 This option cannot be set from a |modeline| or in the |sandbox|, for
5540 security reasons.
5541
5542
Bram Moolenaar251e1912011-06-19 05:09:16 +02005543 *'osfiletype'* *'oft'*
5544'osfiletype' 'oft' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005545 local to buffer
Bram Moolenaar251e1912011-06-19 05:09:16 +02005546 This option was supported on RISC OS, which has been removed.
5547
Bram Moolenaar071d4272004-06-13 20:20:40 +00005548
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005549 *'packpath'* *'pp'*
5550'packpath' 'pp' string (default: see 'runtimepath')
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005551 Directories used to find packages. See |packages|.
5552
5553
Bram Moolenaar071d4272004-06-13 20:20:40 +00005554 *'paragraphs'* *'para'*
Bram Moolenaar57e48462008-03-12 16:38:55 +00005555'paragraphs' 'para' string (default "IPLPPPQPP TPHPLIPpLpItpplpipbp")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005556 global
5557 Specifies the nroff macros that separate paragraphs. These are pairs
5558 of two letters (see |object-motions|).
5559
5560 *'paste'* *'nopaste'*
5561'paste' boolean (default off)
5562 global
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005563 Put Vim in Paste mode. This is useful if you want to cut or copy
5564 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005565 unexpected effects.
5566 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005567 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00005568 knows about pasting and will mostly do the right thing without 'paste'
5569 being set. The same is true for a terminal where Vim handles the
5570 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00005571 This option is reset when starting the GUI. Thus if you set it in
5572 your .vimrc it will work in a terminal, but not in the GUI. Setting
5573 'paste' in the GUI has side effects: e.g., the Paste toolbar button
5574 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005575 When the 'paste' option is switched on (also when it was already on):
5576 - mapping in Insert mode and Command-line mode is disabled
5577 - abbreviations are disabled
Bram Moolenaar071d4272004-06-13 20:20:40 +00005578 - 'autoindent' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02005579 - 'expandtab' is reset
5580 - 'formatoptions' is used like it is empty
Bram Moolenaar071d4272004-06-13 20:20:40 +00005581 - 'revins' is reset
5582 - 'ruler' is reset
5583 - 'showmatch' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02005584 - 'smartindent' is reset
5585 - 'smarttab' is reset
5586 - 'softtabstop' is set to 0
5587 - 'textwidth' is set to 0
5588 - 'wrapmargin' is set to 0
Bram Moolenaar071d4272004-06-13 20:20:40 +00005589 These options keep their value, but their effect is disabled:
Bram Moolenaar071d4272004-06-13 20:20:40 +00005590 - 'cindent'
Bram Moolenaarca635012015-09-25 20:34:21 +02005591 - 'indentexpr'
5592 - 'lisp'
Bram Moolenaar071d4272004-06-13 20:20:40 +00005593 NOTE: When you start editing another file while the 'paste' option is
5594 on, settings from the modelines or autocommands may change the
5595 settings again, causing trouble when pasting text. You might want to
5596 set the 'paste' option again.
5597 When the 'paste' option is reset the mentioned options are restored to
5598 the value before the moment 'paste' was switched from off to on.
5599 Resetting 'paste' before ever setting it does not have any effect.
5600 Since mapping doesn't work while 'paste' is active, you need to use
5601 the 'pastetoggle' option to toggle the 'paste' option with some key.
5602
5603 *'pastetoggle'* *'pt'*
5604'pastetoggle' 'pt' string (default "")
5605 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005606 When non-empty, specifies the key sequence that toggles the 'paste'
5607 option. This is like specifying a mapping: >
5608 :map {keys} :set invpaste<CR>
5609< Where {keys} is the value of 'pastetoggle'.
5610 The difference is that it will work even when 'paste' is set.
5611 'pastetoggle' works in Insert mode and Normal mode, but not in
5612 Command-line mode.
5613 Mappings are checked first, thus overrule 'pastetoggle'. However,
5614 when 'paste' is on mappings are ignored in Insert mode, thus you can do
5615 this: >
5616 :map <F10> :set paste<CR>
5617 :map <F11> :set nopaste<CR>
5618 :imap <F10> <C-O>:set paste<CR>
5619 :imap <F11> <nop>
5620 :set pastetoggle=<F11>
5621< This will make <F10> start paste mode and <F11> stop paste mode.
5622 Note that typing <F10> in paste mode inserts "<F10>", since in paste
5623 mode everything is inserted literally, except the 'pastetoggle' key
5624 sequence.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005625 When the value has several bytes 'ttimeoutlen' applies.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005626
5627 *'pex'* *'patchexpr'*
5628'patchexpr' 'pex' string (default "")
5629 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005630 {not available when compiled without the |+diff|
5631 feature}
5632 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005633 the resulting new version of the file. See |diff-patchexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005634
Bram Moolenaardbc28022014-07-26 13:40:44 +02005635 *'patchmode'* *'pm'* *E205* *E206*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005636'patchmode' 'pm' string (default "")
5637 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005638 When non-empty the oldest version of a file is kept. This can be used
5639 to keep the original version of a file if you are changing files in a
5640 source distribution. Only the first time that a file is written a
5641 copy of the original file will be kept. The name of the copy is the
5642 name of the original file with the string in the 'patchmode' option
5643 appended. This option should start with a dot. Use a string like
Bram Moolenaardf980db2017-12-24 13:22:00 +01005644 ".orig" or ".org". 'backupdir' must not be empty for this to work
5645 (Detail: The backup file is renamed to the patchmode file after the
5646 new file has been successfully written, that's why it must be possible
5647 to write a backup file). If there was no file to be backed up, an
5648 empty file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005649 When the 'backupskip' pattern matches, a patchmode file is not made.
5650 Using 'patchmode' for compressed files appends the extension at the
5651 end (e.g., "file.gz.orig"), thus the resulting name isn't always
5652 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005653 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005654
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01005655 *'path'* *'pa'* *E343* *E345* *E347* *E854*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005656'path' 'pa' string (default on Unix: ".,/usr/include,,"
Bram Moolenaar071d4272004-06-13 20:20:40 +00005657 other systems: ".,,")
5658 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005659 This is a list of directories which will be searched when using the
Bram Moolenaarc236c162008-07-13 17:41:49 +00005660 |gf|, [f, ]f, ^Wf, |:find|, |:sfind|, |:tabfind| and other commands,
5661 provided that the file being searched for has a relative path (not
5662 starting with "/", "./" or "../"). The directories in the 'path'
5663 option may be relative or absolute.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005664 - Use commas to separate directory names: >
5665 :set path=.,/usr/local/include,/usr/include
5666< - Spaces can also be used to separate directory names (for backwards
5667 compatibility with version 3.0). To have a space in a directory
5668 name, precede it with an extra backslash, and escape the space: >
5669 :set path=.,/dir/with\\\ space
5670< - To include a comma in a directory name precede it with an extra
5671 backslash: >
5672 :set path=.,/dir/with\\,comma
5673< - To search relative to the directory of the current file, use: >
5674 :set path=.
5675< - To search in the current directory use an empty string between two
5676 commas: >
5677 :set path=,,
5678< - A directory name may end in a ':' or '/'.
5679 - Environment variables are expanded |:set_env|.
5680 - When using |netrw.vim| URLs can be used. For example, adding
5681 "http://www.vim.org" will make ":find index.html" work.
Bram Moolenaarc236c162008-07-13 17:41:49 +00005682 - Search upwards and downwards in a directory tree using "*", "**" and
5683 ";". See |file-searching| for info and syntax.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005684 {not available when compiled without the |+path_extra| feature}
5685 - Careful with '\' characters, type two to get one in the option: >
5686 :set path=.,c:\\include
5687< Or just use '/' instead: >
5688 :set path=.,c:/include
5689< Don't forget "." or files won't even be found in the same directory as
5690 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005691 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00005692 it is something like 256 or 1024 characters.
5693 You can check if all the include files are found, using the value of
5694 'path', see |:checkpath|.
5695 The use of |:set+=| and |:set-=| is preferred when adding or removing
5696 directories from the list. This avoids problems when a future version
5697 uses another default. To remove the current directory use: >
5698 :set path-=
5699< To add the current directory use: >
5700 :set path+=
5701< To use an environment variable, you probably need to replace the
5702 separator. Here is an example to append $INCL, in which directory
5703 names are separated with a semi-colon: >
5704 :let &path = &path . "," . substitute($INCL, ';', ',', 'g')
5705< Replace the ';' with a ':' or whatever separator is used. Note that
5706 this doesn't work when $INCL contains a comma or white space.
5707
Bram Moolenaar37c64c72017-09-19 22:06:03 +02005708 *'perldll'*
5709'perldll' string (default depends on the build)
5710 global
Bram Moolenaar37c64c72017-09-19 22:06:03 +02005711 {only available when compiled with the |+perl/dyn|
5712 feature}
5713 Specifies the name of the Perl shared library. The default is
5714 DYNAMIC_PERL_DLL, which was specified at compile time.
5715 Environment variables are expanded |:set_env|.
5716 This option cannot be set from a |modeline| or in the |sandbox|, for
5717 security reasons.
5718
Bram Moolenaar071d4272004-06-13 20:20:40 +00005719 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
5720'preserveindent' 'pi' boolean (default off)
5721 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005722 When changing the indent of the current line, preserve as much of the
5723 indent structure as possible. Normally the indent is replaced by a
5724 series of tabs followed by spaces as required (unless |'expandtab'| is
5725 enabled, in which case only spaces are used). Enabling this option
5726 means the indent will preserve as many existing characters as possible
5727 for indenting, and only add additional tabs or spaces as required.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005728 'expandtab' does not apply to the preserved white space, a Tab remains
5729 a Tab.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005730 NOTE: When using ">>" multiple times the resulting indent is a mix of
5731 tabs and spaces. You might not like this.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005732 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005733 Also see 'copyindent'.
5734 Use |:retab| to clean up white space.
5735
5736 *'previewheight'* *'pvh'*
5737'previewheight' 'pvh' number (default 12)
5738 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02005739 {not available when compiled without the |+quickfix|
5740 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005741 Default height for a preview window. Used for |:ptag| and associated
Bram Moolenaar79648732019-07-18 21:43:07 +02005742 commands. Used for |CTRL-W_}| when no count is given. Not used when
5743 'previewpopup' is set.
5744
5745 *'previewpopup'* *'pvp'*
5746'previewpopup' 'pvp' string (default empty)
5747 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02005748 {not available when compiled without the |+textprop|
5749 or |+quickfix| feature}
Bram Moolenaar79648732019-07-18 21:43:07 +02005750 When not empty a popup window is used for commands that would open a
5751 preview window. See |preview-popup|.
Bram Moolenaar576a4a62019-08-18 15:25:17 +02005752 Not used for the insert completion info, add "popup" to
5753 'completeopt' for that.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005754
5755 *'previewwindow'* *'nopreviewwindow'*
5756 *'pvw'* *'nopvw'* *E590*
5757'previewwindow' 'pvw' boolean (default off)
5758 local to window
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02005759 {not available when compiled without the |+quickfix|
5760 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005761 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00005762 set. It's normally not set directly, but by using one of the commands
5763 |:ptag|, |:pedit|, etc.
5764
5765 *'printdevice'* *'pdev'*
5766'printdevice' 'pdev' string (default empty)
5767 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005768 {only available when compiled with the |+printer|
5769 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005770 The name of the printer to be used for |:hardcopy|.
5771 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005772 This option cannot be set from a |modeline| or in the |sandbox|, for
5773 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005774
Bram Moolenaar8299df92004-07-10 09:47:34 +00005775 *'printencoding'* *'penc'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005776'printencoding' 'penc' string (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005777 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005778 {only available when compiled with the |+printer|
5779 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005780 Sets the character encoding used when printing.
5781 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005782
5783 *'printexpr'* *'pexpr'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005784'printexpr' 'pexpr' string (default: see below)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005785 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005786 {only available when compiled with the |+printer|
5787 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005788 Expression used to print the PostScript produced with |:hardcopy|.
5789 See |pexpr-option|.
Bram Moolenaar51628222016-12-01 23:03:28 +01005790 This option cannot be set from a |modeline| or in the |sandbox|, for
5791 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005792
Bram Moolenaar8299df92004-07-10 09:47:34 +00005793 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005794'printfont' 'pfn' string (default "courier")
5795 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005796 {only available when compiled with the |+printer|
5797 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005798 The name of the font that will be used for |:hardcopy|.
5799 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005800
5801 *'printheader'* *'pheader'*
5802'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
5803 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005804 {only available when compiled with the |+printer|
5805 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005806 The format of the header produced in |:hardcopy| output.
5807 See |pheader-option|.
5808
5809 *'printmbcharset'* *'pmbcs'*
5810'printmbcharset' 'pmbcs' string (default "")
5811 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01005812 {only available when compiled with the |+printer|
5813 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005814 The CJK character set to be used for CJK output from |:hardcopy|.
5815 See |pmbcs-option|.
5816
5817 *'printmbfont'* *'pmbfn'*
5818'printmbfont' 'pmbfn' string (default "")
5819 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01005820 {only available when compiled with the |+printer|
5821 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005822 List of font names to be used for CJK output from |:hardcopy|.
5823 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005824
5825 *'printoptions'* *'popt'*
5826'printoptions' 'popt' string (default "")
5827 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005828 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005829 List of items that control the format of the output of |:hardcopy|.
5830 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005831
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005832 *'prompt'* *'noprompt'*
5833'prompt' boolean (default on)
5834 global
5835 When on a ":" prompt is used in Ex mode.
5836
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005837 *'pumheight'* *'ph'*
5838'pumheight' 'ph' number (default 0)
5839 global
Bram Moolenaar06a89a52006-04-29 22:01:03 +00005840 Determines the maximum number of items to show in the popup menu for
5841 Insert mode completion. When zero as much space as available is used.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005842 |ins-completion-menu|.
5843
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01005844 *'pumwidth'* *'pw'*
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005845'pumwidth' 'pw' number (default 15)
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01005846 global
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01005847 Determines the minimum width to use for the popup menu for Insert mode
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005848 completion. |ins-completion-menu|.
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01005849
Bram Moolenaard94464e2015-11-02 15:28:18 +01005850 *'pythondll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01005851'pythondll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01005852 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01005853 {only available when compiled with the |+python/dyn|
5854 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005855 Specifies the name of the Python 2.x shared library. The default is
5856 DYNAMIC_PYTHON_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005857 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01005858 This option cannot be set from a |modeline| or in the |sandbox|, for
5859 security reasons.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005860
Bram Moolenaar94073162018-01-31 21:49:05 +01005861 *'pythonhome'*
5862'pythonhome' string (default "")
5863 global
Bram Moolenaar94073162018-01-31 21:49:05 +01005864 {only available when compiled with the |+python/dyn|
5865 feature}
5866 Specifies the name of the Python 2.x home directory. When 'pythonhome'
5867 and the PYTHONHOME environment variable are not set, PYTHON_HOME,
5868 which was specified at compile time, will be used for the Python 2.x
5869 home directory.
5870 Environment variables are expanded |:set_env|.
5871 This option cannot be set from a |modeline| or in the |sandbox|, for
5872 security reasons.
5873
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005874 *'pythonthreedll'*
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005875'pythonthreedll' string (default depends on the build)
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005876 global
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005877 {only available when compiled with the |+python3/dyn|
5878 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005879 Specifies the name of the Python 3 shared library. The default is
5880 DYNAMIC_PYTHON3_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005881 Environment variables are expanded |:set_env|.
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005882 This option cannot be set from a |modeline| or in the |sandbox|, for
5883 security reasons.
5884
Bram Moolenaar94073162018-01-31 21:49:05 +01005885 *'pythonthreehome'*
5886'pythonthreehome' string (default "")
5887 global
Bram Moolenaar94073162018-01-31 21:49:05 +01005888 {only available when compiled with the |+python3/dyn|
5889 feature}
5890 Specifies the name of the Python 3 home directory. When
5891 'pythonthreehome' and the PYTHONHOME environment variable are not set,
5892 PYTHON3_HOME, which was specified at compile time, will be used for
5893 the Python 3 home directory.
5894 Environment variables are expanded |:set_env|.
5895 This option cannot be set from a |modeline| or in the |sandbox|, for
5896 security reasons.
5897
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01005898 *'pyxversion'* *'pyx'*
5899'pyxversion' 'pyx' number (default depends on the build)
5900 global
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01005901 {only available when compiled with the |+python| or
5902 the |+python3| feature}
5903 Specifies the python version used for pyx* functions and commands
5904 |python_x|. The default value is as follows:
5905
5906 Compiled with Default ~
5907 |+python| and |+python3| 0
5908 only |+python| 2
5909 only |+python3| 3
5910
5911 Available values are 0, 2 and 3.
5912 If 'pyxversion' is 0, it is set to 2 or 3 after the first execution of
5913 any python2/3 commands or functions. E.g. `:py` sets to 2, and `:py3`
5914 sets to 3. `:pyx` sets it to 3 if Python 3 is available, otherwise sets
5915 to 2 if Python 2 is available.
5916 See also: |has-pythonx|
5917
5918 If Vim is compiled with only |+python| or |+python3| setting
5919 'pyxversion' has no effect. The pyx* functions and commands are
5920 always the same as the compiled version.
5921
5922 This option cannot be set from a |modeline| or in the |sandbox|, for
5923 security reasons.
5924
Bram Moolenaar858ba062020-05-31 23:11:59 +02005925 *'quickfixtextfunc'* *'qftf'*
5926'quickfixtextfunc' 'qftf' string (default "")
5927 global
5928 {only available when compiled with the |+quickfix|
5929 feature}
5930 This option specifies a function to be used to get the text to display
5931 in the quickfix and location list windows. This can be used to
5932 customize the information displayed in the quickfix or location window
5933 for each entry in the corresponding quickfix or location list. See
5934 |quickfix-window-function| for an explanation of how to write the
Bram Moolenaard43906d2020-07-20 21:31:32 +02005935 function and an example. The value can be the name of a function or a
5936 lambda.
Bram Moolenaar858ba062020-05-31 23:11:59 +02005937
5938 This option cannot be set from a |modeline| or in the |sandbox|, for
5939 security reasons.
5940
Bram Moolenaar677ee682005-01-27 14:41:15 +00005941 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005942'quoteescape' 'qe' string (default "\")
5943 local to buffer
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005944 The characters that are used to escape quotes in a string. Used for
5945 objects like a', a" and a` |a'|.
5946 When one of the characters in this option is found inside a string,
5947 the following character will be skipped. The default value makes the
5948 text "foo\"bar\\" considered to be one string.
5949
Bram Moolenaar071d4272004-06-13 20:20:40 +00005950 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
5951'readonly' 'ro' boolean (default off)
5952 local to buffer
5953 If on, writes fail unless you use a '!'. Protects you from
5954 accidentally overwriting a file. Default on when Vim is started
5955 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005956 When using ":w!" the 'readonly' option is reset for the current
5957 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar6c60f472019-04-28 16:00:35 +02005958 When using the ":view" command the 'readonly' option is set for the
5959 newly edited buffer.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01005960 See 'modifiable' for disallowing changes to the buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005961
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005962 *'redrawtime'* *'rdt'*
5963'redrawtime' 'rdt' number (default 2000)
5964 global
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005965 {only available when compiled with the |+reltime|
5966 feature}
5967 The time in milliseconds for redrawing the display. This applies to
Bram Moolenaar15142e22018-04-30 22:19:58 +02005968 searching for patterns for 'hlsearch', |:match| highlighting and syntax
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02005969 highlighting.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005970 When redrawing takes more than this many milliseconds no further
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02005971 matches will be highlighted.
5972 For syntax highlighting the time applies per window. When over the
5973 limit syntax highlighting is disabled until |CTRL-L| is used.
5974 This is used to avoid that Vim hangs when using a very complicated
5975 pattern.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005976
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02005977 *'regexpengine'* *'re'*
Bram Moolenaare6ae6222013-05-21 21:01:10 +02005978'regexpengine' 're' number (default 0)
5979 global
Bram Moolenaare6ae6222013-05-21 21:01:10 +02005980 This selects the default regexp engine. |two-engines|
5981 The possible values are:
5982 0 automatic selection
5983 1 old engine
5984 2 NFA engine
5985 Note that when using the NFA engine and the pattern contains something
5986 that is not supported the pattern will not match. This is only useful
5987 for debugging the regexp engine.
Bram Moolenaarfda37292014-11-05 14:27:36 +01005988 Using automatic selection enables Vim to switch the engine, if the
5989 default engine becomes too costly. E.g., when the NFA engine uses too
5990 many states. This should prevent Vim from hanging on a combination of
5991 a complex pattern with long text.
Bram Moolenaare6ae6222013-05-21 21:01:10 +02005992
Bram Moolenaar64486672010-05-16 15:46:46 +02005993 *'relativenumber'* *'rnu'* *'norelativenumber'* *'nornu'*
5994'relativenumber' 'rnu' boolean (default off)
5995 local to window
Bram Moolenaar64486672010-05-16 15:46:46 +02005996 Show the line number relative to the line with the cursor in front of
Bram Moolenaar06b5d512010-05-22 15:37:44 +02005997 each line. Relative line numbers help you use the |count| you can
Bram Moolenaar64486672010-05-16 15:46:46 +02005998 precede some vertical motion commands (e.g. j k + -) with, without
5999 having to calculate it yourself. Especially useful in combination with
6000 other commands (e.g. y d c < > gq gw =).
6001 When the 'n' option is excluded from 'cpoptions' a wrapped
6002 line will not use the column of line numbers (this is the default when
6003 'compatible' isn't set).
6004 The 'numberwidth' option can be used to set the room used for the line
6005 number.
6006 When a long, wrapped line doesn't start with the first character, '-'
6007 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02006008 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
6009 the number.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01006010
Bram Moolenaar203d04d2013-06-06 21:36:40 +02006011 The number in front of the cursor line also depends on the value of
6012 'number', see |number_relativenumber| for all combinations of the two
6013 options.
Bram Moolenaar64486672010-05-16 15:46:46 +02006014
Bram Moolenaar071d4272004-06-13 20:20:40 +00006015 *'remap'* *'noremap'*
6016'remap' boolean (default on)
6017 global
6018 Allows for mappings to work recursively. If you do not want this for
6019 a single entry, use the :noremap[!] command.
Bram Moolenaara3227e22006-03-08 21:32:40 +00006020 NOTE: To avoid portability problems with Vim scripts, always keep
6021 this option at the default "on". Only switch it off when working with
6022 old Vi scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006023
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006024 *'renderoptions'* *'rop'*
6025'renderoptions' 'rop' string (default: empty)
6026 global
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006027 {only available when compiled with GUI and DIRECTX on
6028 MS-Windows}
6029 Select a text renderer and set its options. The options depend on the
6030 renderer.
6031
6032 Syntax: >
6033 set rop=type:{renderer}(,{name}:{value})*
6034<
6035 Currently, only one optional renderer is available.
6036
6037 render behavior ~
6038 directx Vim will draw text using DirectX (DirectWrite). It makes
6039 drawn glyphs more beautiful than default GDI.
6040 It requires 'encoding' is "utf-8", and only works on
6041 MS-Windows Vista or newer version.
6042
6043 Options:
6044 name meaning type value ~
6045 gamma gamma float 1.0 - 2.2 (maybe)
6046 contrast enhancedContrast float (unknown)
6047 level clearTypeLevel float (unknown)
6048 geom pixelGeometry int 0 - 2 (see below)
6049 renmode renderingMode int 0 - 6 (see below)
6050 taamode textAntialiasMode int 0 - 3 (see below)
Bram Moolenaara338adc2018-01-31 20:51:47 +01006051 scrlines Scroll Lines int (deprecated)
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006052
Bram Moolenaar92467d32017-12-05 13:22:16 +01006053 See this URL for detail (except for scrlines):
6054 https://msdn.microsoft.com/en-us/library/dd368190.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006055
6056 For geom: structure of a device pixel.
6057 0 - DWRITE_PIXEL_GEOMETRY_FLAT
6058 1 - DWRITE_PIXEL_GEOMETRY_RGB
6059 2 - DWRITE_PIXEL_GEOMETRY_BGR
6060
6061 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006062 https://msdn.microsoft.com/en-us/library/dd368114.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006063
6064 For renmode: method of rendering glyphs.
6065 0 - DWRITE_RENDERING_MODE_DEFAULT
6066 1 - DWRITE_RENDERING_MODE_ALIASED
6067 2 - DWRITE_RENDERING_MODE_GDI_CLASSIC
6068 3 - DWRITE_RENDERING_MODE_GDI_NATURAL
6069 4 - DWRITE_RENDERING_MODE_NATURAL
6070 5 - DWRITE_RENDERING_MODE_NATURAL_SYMMETRIC
6071 6 - DWRITE_RENDERING_MODE_OUTLINE
6072
6073 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006074 https://msdn.microsoft.com/en-us/library/dd368118.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006075
6076 For taamode: antialiasing mode used for drawing text.
6077 0 - D2D1_TEXT_ANTIALIAS_MODE_DEFAULT
6078 1 - D2D1_TEXT_ANTIALIAS_MODE_CLEARTYPE
6079 2 - D2D1_TEXT_ANTIALIAS_MODE_GRAYSCALE
6080 3 - D2D1_TEXT_ANTIALIAS_MODE_ALIASED
6081
6082 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006083 https://msdn.microsoft.com/en-us/library/dd368170.aspx
6084
Bram Moolenaara338adc2018-01-31 20:51:47 +01006085 For scrlines:
6086 This was used for optimizing scrolling behavior, however this
6087 is now deprecated. If specified, it is simply ignored.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006088
6089 Example: >
6090 set encoding=utf-8
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006091 set gfn=Ricty_Diminished:h12
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006092 set rop=type:directx
6093<
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006094 If select a raster font (Courier, Terminal or FixedSys which
6095 have ".fon" extension in file name) to 'guifont', it will be
Bram Moolenaar92467d32017-12-05 13:22:16 +01006096 drawn by GDI as a fallback.
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006097
6098 NOTE: It is known that some fonts and options combination
6099 causes trouble on drawing glyphs.
6100
Bram Moolenaar92467d32017-12-05 13:22:16 +01006101 - 'renmode:5' and 'renmode:6' will not work with some
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006102 special made fonts (True-Type fonts which includes only
6103 bitmap glyphs).
6104 - 'taamode:3' will not work with some vector fonts.
6105
6106 NOTE: With this option, you can display colored emoji
6107 (emoticon) in Windows 8.1 or later. To display colored emoji,
6108 there are some conditions which you should notice.
6109
6110 - If your font includes non-colored emoji already, it will
6111 be used.
6112 - If your font doesn't have emoji, the system chooses an
6113 alternative symbol font. On Windows 10, "Segoe UI Emoji"
6114 will be used.
6115 - When this alternative font didn't have fixed width glyph,
6116 emoji might be rendered beyond the bounding box of drawing
6117 cell.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006118
6119 Other render types are currently not supported.
6120
Bram Moolenaar071d4272004-06-13 20:20:40 +00006121 *'report'*
6122'report' number (default 2)
6123 global
6124 Threshold for reporting number of lines changed. When the number of
6125 changed lines is more than 'report' a message will be given for most
6126 ":" commands. If you want it always, set 'report' to 0.
6127 For the ":substitute" command the number of substitutions is used
6128 instead of the number of lines.
6129
6130 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
6131'restorescreen' 'rs' boolean (default on)
6132 global
Bram Moolenaar8024f932020-01-14 19:29:13 +01006133 {only in MS-Windows console version}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006134 When set, the screen contents is restored when exiting Vim. This also
6135 happens when executing external commands.
6136
6137 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
6138 options in your .vimrc. To disable restoring:
6139 set t_ti= t_te=
6140 To enable restoring (for an xterm):
6141 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
6142 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
6143
6144 *'revins'* *'ri'* *'norevins'* *'nori'*
6145'revins' 'ri' boolean (default off)
6146 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006147 {only available when compiled with the |+rightleft|
6148 feature}
6149 Inserting characters in Insert mode will work backwards. See "typing
6150 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
6151 command in Insert mode, when 'allowrevins' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02006152 NOTE: This option is reset when 'compatible' is set.
6153 This option is reset when 'paste' is set and restored when 'paste' is
6154 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006155
6156 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
6157'rightleft' 'rl' boolean (default off)
6158 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006159 {only available when compiled with the |+rightleft|
6160 feature}
6161 When on, display orientation becomes right-to-left, i.e., characters
6162 that are stored in the file appear from the right to the left.
6163 Using this option, it is possible to edit files for languages that
6164 are written from the right to the left such as Hebrew and Arabic.
6165 This option is per window, so it is possible to edit mixed files
6166 simultaneously, or to view the same file in both ways (this is
6167 useful whenever you have a mixed text file with both right-to-left
6168 and left-to-right strings so that both sets are displayed properly
6169 in different windows). Also see |rileft.txt|.
6170
Bram Moolenaar607cc1e2010-07-18 18:47:44 +02006171 *'rightleftcmd'* *'rlc'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006172'rightleftcmd' 'rlc' string (default "search")
6173 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006174 {only available when compiled with the |+rightleft|
6175 feature}
6176 Each word in this option enables the command line editing to work in
6177 right-to-left mode for a group of commands:
6178
6179 search "/" and "?" commands
6180
6181 This is useful for languages such as Hebrew, Arabic and Farsi.
6182 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
6183
Bram Moolenaard94464e2015-11-02 15:28:18 +01006184 *'rubydll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01006185'rubydll' string (default: depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01006186 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01006187 {only available when compiled with the |+ruby/dyn|
6188 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006189 Specifies the name of the Ruby shared library. The default is
6190 DYNAMIC_RUBY_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006191 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01006192 This option cannot be set from a |modeline| or in the |sandbox|, for
6193 security reasons.
6194
Bram Moolenaar071d4272004-06-13 20:20:40 +00006195 *'ruler'* *'ru'* *'noruler'* *'noru'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02006196'ruler' 'ru' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006197 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006198 {not available when compiled without the
6199 |+cmdline_info| feature}
6200 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006201 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00006202 text in the file is shown on the far right:
6203 Top first line is visible
6204 Bot last line is visible
6205 All first and last line are visible
6206 45% relative position in the file
6207 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006208 Each window has its own ruler. If a window has a status line, the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006209 ruler is shown there. Otherwise it is shown in the last line of the
Bram Moolenaar582fd852005-03-28 20:58:01 +00006210 screen. If the statusline is given by 'statusline' (i.e. not empty),
Bram Moolenaar071d4272004-06-13 20:20:40 +00006211 this option takes precedence over 'ruler' and 'rulerformat'
6212 If the number of characters displayed is different from the number of
Bram Moolenaar207f0092020-08-30 17:20:20 +02006213 bytes in the text (e.g., for a TAB or a multibyte character), both
Bram Moolenaar071d4272004-06-13 20:20:40 +00006214 the text column (byte number) and the screen column are shown,
6215 separated with a dash.
6216 For an empty line "0-1" is shown.
6217 For an empty buffer the line number will also be zero: "0,0-1".
Bram Moolenaarca635012015-09-25 20:34:21 +02006218 This option is reset when 'paste' is set and restored when 'paste' is
6219 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006220 If you don't want to see the ruler all the time but want to know where
6221 you are, use "g CTRL-G" |g_CTRL-G|.
6222 NOTE: This option is reset when 'compatible' is set.
6223
6224 *'rulerformat'* *'ruf'*
6225'rulerformat' 'ruf' string (default empty)
6226 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006227 {not available when compiled without the |+statusline|
6228 feature}
6229 When this option is not empty, it determines the content of the ruler
6230 string, as displayed for the 'ruler' option.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00006231 The format of this option is like that of 'statusline'.
Bram Moolenaar110289e2019-05-23 15:38:06 +02006232 This option cannot be set in a modeline when 'modelineexpr' is off.
6233
Bram Moolenaar071d4272004-06-13 20:20:40 +00006234 The default ruler width is 17 characters. To make the ruler 15
6235 characters wide, put "%15(" at the start and "%)" at the end.
6236 Example: >
6237 :set rulerformat=%15(%c%V\ %p%%%)
6238<
6239 *'runtimepath'* *'rtp'* *vimfiles*
6240'runtimepath' 'rtp' string (default:
Bram Moolenaar942db232021-02-13 18:14:48 +01006241 Unix: "$HOME/.vim,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006242 $VIM/vimfiles,
6243 $VIMRUNTIME,
6244 $VIM/vimfiles/after,
6245 $HOME/.vim/after"
6246 Amiga: "home:vimfiles,
6247 $VIM/vimfiles,
6248 $VIMRUNTIME,
6249 $VIM/vimfiles/after,
6250 home:vimfiles/after"
Bram Moolenaar942db232021-02-13 18:14:48 +01006251 MS-Windows: "$HOME/vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006252 $VIM/vimfiles,
6253 $VIMRUNTIME,
6254 $VIM/vimfiles/after,
6255 $HOME/vimfiles/after"
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02006256 macOS: "$VIM:vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006257 $VIMRUNTIME,
6258 $VIM:vimfiles:after"
Bram Moolenaarb3f74062020-02-26 16:16:53 +01006259 Haiku: "$BE_USER_SETTINGS/vim,
6260 $VIM/vimfiles,
6261 $VIMRUNTIME,
6262 $VIM/vimfiles/after,
Bram Moolenaar942db232021-02-13 18:14:48 +01006263 $BE_USER_SETTINGS/vim/after"
6264 VMS: "sys$login:vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006265 $VIM/vimfiles,
6266 $VIMRUNTIME,
6267 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00006268 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006269 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006270 This is a list of directories which will be searched for runtime
6271 files:
6272 filetype.vim filetypes by file name |new-filetype|
6273 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006274 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006275 colors/ color scheme files |:colorscheme|
6276 compiler/ compiler files |:compiler|
6277 doc/ documentation |write-local-help|
6278 ftplugin/ filetype plugins |write-filetype-plugin|
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01006279 import/ files that are found by `:import`
Bram Moolenaar071d4272004-06-13 20:20:40 +00006280 indent/ indent scripts |indent-expression|
6281 keymap/ key mapping files |mbyte-keymap|
6282 lang/ menu translations |:menutrans|
6283 menu.vim GUI menus |menu.vim|
Bram Moolenaar26852122016-05-24 20:02:38 +02006284 pack/ packages |:packadd|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006285 plugin/ plugin scripts |write-plugin|
6286 print/ files for printing |postscript-print-encoding|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006287 spell/ spell checking files |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006288 syntax/ syntax files |mysyntaxfile|
6289 tutor/ files for vimtutor |tutor|
6290
6291 And any other file searched for with the |:runtime| command.
6292
6293 The defaults for most systems are setup to search five locations:
6294 1. In your home directory, for your personal preferences.
6295 2. In a system-wide Vim directory, for preferences from the system
6296 administrator.
6297 3. In $VIMRUNTIME, for files distributed with Vim.
6298 *after-directory*
6299 4. In the "after" directory in the system-wide Vim directory. This is
6300 for the system administrator to overrule or add to the distributed
6301 defaults (rarely needed)
6302 5. In the "after" directory in your home directory. This is for
6303 personal preferences to overrule or add to the distributed defaults
6304 or system-wide settings (rarely needed).
6305
Bram Moolenaard0796902016-09-16 20:02:31 +02006306 More entries are added when using |packages|. If it gets very long
6307 then `:set rtp` will be truncated, use `:echo &rtp` to see the full
6308 string.
Bram Moolenaar26852122016-05-24 20:02:38 +02006309
Bram Moolenaar071d4272004-06-13 20:20:40 +00006310 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
6311 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006312 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00006313 wildcards.
6314 See |:runtime|.
6315 Example: >
6316 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
6317< This will use the directory "~/vimruntime" first (containing your
6318 personal Vim runtime files), then "/mygroup/vim" (shared between a
6319 group of people) and finally "$VIMRUNTIME" (the distributed runtime
6320 files).
6321 You probably should always include $VIMRUNTIME somewhere, to use the
6322 distributed runtime files. You can put a directory before $VIMRUNTIME
6323 to find files which replace a distributed runtime files. You can put
6324 a directory after $VIMRUNTIME to find files which add to distributed
6325 runtime files.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006326 When Vim is started with |--clean| the home directory entries are not
6327 included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006328 This option cannot be set from a |modeline| or in the |sandbox|, for
6329 security reasons.
6330
6331 *'scroll'* *'scr'*
6332'scroll' 'scr' number (default: half the window height)
6333 local to window
6334 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
6335 set to half the number of lines in the window when the window size
Bram Moolenaar74667062020-12-28 15:41:41 +01006336 changes. This may happen when enabling the |status-line| or
6337 'tabline' option after setting the 'scroll' option.
6338 If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006339 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar25c9c682019-05-05 18:13:34 +02006340 height with ":set scroll=0".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006341
6342 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
6343'scrollbind' 'scb' boolean (default off)
6344 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006345 See also |scroll-binding|. When this option is set, the current
6346 window scrolls as other scrollbind windows (windows that also have
6347 this option set) scroll. This option is useful for viewing the
6348 differences between two versions of a file, see 'diff'.
6349 See |'scrollopt'| for options that determine how this option should be
6350 interpreted.
6351 This option is mostly reset when splitting a window to edit another
6352 file. This means that ":split | edit file" results in two windows
6353 with scroll-binding, but ":split file" does not.
6354
Bram Moolenaarae20f342019-11-05 21:09:23 +01006355 *'scrollfocus'* *'scf'* *'noscrollfocus'* *'noscf'*
6356'scrollfocus' 'scf' boolean (default off)
6357 global
6358 {only for MS-Windows GUI}
6359 When using the scroll wheel and this option is set, the window under
6360 the mouse pointer is scrolled. With this option off the current
6361 window is scrolled.
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01006362 Systems other than MS-Windows always behave like this option is on.
Bram Moolenaarae20f342019-11-05 21:09:23 +01006363
Bram Moolenaar071d4272004-06-13 20:20:40 +00006364 *'scrolljump'* *'sj'*
6365'scrolljump' 'sj' number (default 1)
6366 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006367 Minimal number of lines to scroll when the cursor gets off the
6368 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
6369 CTRL-D). Useful if your terminal scrolls very slowly.
Bram Moolenaar1e015462005-09-25 22:16:38 +00006370 When set to a negative number from -1 to -100 this is used as the
6371 percentage of the window height. Thus -50 scrolls half the window
6372 height.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006373 NOTE: This option is set to 1 when 'compatible' is set.
6374
6375 *'scrolloff'* *'so'*
Bram Moolenaar50ba5262016-09-22 22:33:02 +02006376'scrolloff' 'so' number (default 0, set to 5 in |defaults.vim|)
Bram Moolenaar375e3392019-01-31 18:26:10 +01006377 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006378 Minimal number of screen lines to keep above and below the cursor.
6379 This will make some context visible around where you are working. If
6380 you set it to a very large value (999) the cursor line will always be
6381 in the middle of the window (except at the start or end of the file or
6382 when long lines wrap).
Bram Moolenaar375e3392019-01-31 18:26:10 +01006383 After using the local value, go back the global value with one of
6384 these two: >
6385 setlocal scrolloff<
6386 setlocal scrolloff=-1
6387< For scrolling horizontally see 'sidescrolloff'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006388 NOTE: This option is set to 0 when 'compatible' is set.
6389
6390 *'scrollopt'* *'sbo'*
6391'scrollopt' 'sbo' string (default "ver,jump")
6392 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006393 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006394 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
6395 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006396 The following words are available:
6397 ver Bind vertical scrolling for 'scrollbind' windows
6398 hor Bind horizontal scrolling for 'scrollbind' windows
6399 jump Applies to the offset between two windows for vertical
6400 scrolling. This offset is the difference in the first
6401 displayed line of the bound windows. When moving
6402 around in a window, another 'scrollbind' window may
6403 reach a position before the start or after the end of
6404 the buffer. The offset is not changed though, when
6405 moving back the 'scrollbind' window will try to scroll
6406 to the desired position when possible.
6407 When now making that window the current one, two
6408 things can be done with the relative offset:
6409 1. When "jump" is not included, the relative offset is
6410 adjusted for the scroll position in the new current
6411 window. When going back to the other window, the
Bram Moolenaar02467872007-05-06 13:22:01 +00006412 new relative offset will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006413 2. When "jump" is included, the other windows are
6414 scrolled to keep the same relative offset. When
6415 going back to the other window, it still uses the
6416 same relative offset.
6417 Also see |scroll-binding|.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006418 When 'diff' mode is active there always is vertical scroll binding,
6419 even when "ver" isn't there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006420
6421 *'sections'* *'sect'*
6422'sections' 'sect' string (default "SHNHH HUnhsh")
6423 global
6424 Specifies the nroff macros that separate sections. These are pairs of
6425 two letters (See |object-motions|). The default makes a section start
6426 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
6427
6428 *'secure'* *'nosecure'* *E523*
6429'secure' boolean (default off)
6430 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006431 When on, ":autocmd", shell and write commands are not allowed in
6432 ".vimrc" and ".exrc" in the current directory and map commands are
6433 displayed. Switch it off only if you know that you will not run into
6434 problems, or when the 'exrc' option is off. On Unix this option is
6435 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006436 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00006437 'secure' at the end of your ~/.vimrc then.
6438 This option cannot be set from a |modeline| or in the |sandbox|, for
6439 security reasons.
6440
6441 *'selection'* *'sel'*
6442'selection' 'sel' string (default "inclusive")
6443 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006444 This option defines the behavior of the selection. It is only used
6445 in Visual and Select mode.
6446 Possible values:
6447 value past line inclusive ~
6448 old no yes
6449 inclusive yes yes
6450 exclusive yes no
6451 "past line" means that the cursor is allowed to be positioned one
6452 character past the line.
6453 "inclusive" means that the last character of the selection is included
6454 in an operation. For example, when "x" is used to delete the
6455 selection.
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02006456 When "old" is used and 'virtualedit' allows the cursor to move past
6457 the end of line the line break still isn't included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006458 Note that when "exclusive" is used and selecting from the end
6459 backwards, you cannot include the last character of a line, when
6460 starting in Normal mode and 'virtualedit' empty.
6461
6462 The 'selection' option is set by the |:behave| command.
6463
6464 *'selectmode'* *'slm'*
6465'selectmode' 'slm' string (default "")
6466 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006467 This is a comma separated list of words, which specifies when to start
6468 Select mode instead of Visual mode, when a selection is started.
6469 Possible values:
6470 mouse when using the mouse
6471 key when using shifted special keys
6472 cmd when using "v", "V" or CTRL-V
6473 See |Select-mode|.
6474 The 'selectmode' option is set by the |:behave| command.
6475
6476 *'sessionoptions'* *'ssop'*
6477'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006478 help,options,tabpages,winsize,terminal")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006479 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02006480 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006481 feature}
6482 Changes the effect of the |:mksession| command. It is a comma
6483 separated list of words. Each word enables saving and restoring
6484 something:
6485 word save and restore ~
6486 blank empty windows
6487 buffers hidden and unloaded buffers, not just those in windows
6488 curdir the current directory
6489 folds manually created folds, opened/closed folds and local
6490 fold options
6491 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00006492 and contain at least one lowercase letter. Only
6493 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006494 help the help window
6495 localoptions options and mappings local to a window or buffer (not
6496 global values for local options)
6497 options all options and mappings (also global values for local
6498 options)
6499 resize size of the Vim window: 'lines' and 'columns'
6500 sesdir the directory in which the session file is located
6501 will become the current directory (useful with
6502 projects accessed over a network from different
6503 systems)
6504 slash backslashes in file names replaced with forward
6505 slashes
Bram Moolenaar18144c82006-04-12 21:52:12 +00006506 tabpages all tab pages; without this only the current tab page
6507 is restored, so that you can make a session for each
6508 tab page separately
Bram Moolenaard473c8c2018-08-11 18:00:22 +02006509 terminal include terminal windows where the command can be
6510 restored
Bram Moolenaar071d4272004-06-13 20:20:40 +00006511 unix with Unix end-of-line format (single <NL>), even when
6512 on Windows or DOS
6513 winpos position of the whole Vim window
6514 winsize window sizes
6515
6516 Don't include both "curdir" and "sesdir".
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006517 When neither "curdir" nor "sesdir" is included, file names are stored
6518 with absolute paths.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006519 "slash" and "unix" are useful on Windows when sharing session files
6520 with Unix. The Unix version of Vim cannot source dos format scripts,
6521 but the Windows version of Vim can source unix format scripts.
6522
6523 *'shell'* *'sh'* *E91*
Bram Moolenaar95a9dd12019-12-19 22:12:03 +01006524'shell' 'sh' string (default $SHELL or "sh", Win32: "cmd.exe")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006525 global
6526 Name of the shell to use for ! and :! commands. When changing the
6527 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
6528 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006529 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006530 See |option-backslash| about including spaces and backslashes.
6531 Environment variables are expanded |:set_env|.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006532
Bram Moolenaar1ff14ba2019-11-02 14:09:23 +01006533 If the name of the shell contains a space, you need to enclose it in
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01006534 quotes and escape the space. Example with quotes: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006535 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
6536< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006537 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006538 "-f" is not inside the quotes, because it is not part of the command
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006539 name. Vim automagically recognizes the backslashes that are path
Bram Moolenaar071d4272004-06-13 20:20:40 +00006540 separators.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006541 Example with escaped space (Vim will do this when initializing the
6542 option from $SHELL): >
6543 :set shell=/bin/with\\\ space/sh
Bram Moolenaard473c8c2018-08-11 18:00:22 +02006544< The resulting value of 'shell' is "/bin/with\ space/sh", two
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006545 backslashes are consumed by `:set`.
6546
Bram Moolenaar071d4272004-06-13 20:20:40 +00006547 Under MS-Windows, when the executable ends in ".com" it must be
6548 included. Thus setting the shell to "command.com" or "4dos.com"
6549 works, but "command" and "4dos" do not work for all commands (e.g.,
6550 filtering).
6551 For unknown reasons, when using "4dos.com" the current directory is
6552 changed to "C:\". To avoid this set 'shell' like this: >
6553 :set shell=command.com\ /c\ 4dos
6554< This option cannot be set from a |modeline| or in the |sandbox|, for
6555 security reasons.
6556
6557 *'shellcmdflag'* *'shcf'*
Bram Moolenaar5dc62522012-02-13 00:05:22 +01006558'shellcmdflag' 'shcf' string (default: "-c";
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006559 Win32, when 'shell' does not contain "sh"
6560 somewhere: "/c")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006561 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006562 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
Bram Moolenaar8024f932020-01-14 19:29:13 +01006563 "bash.exe -c ls" or "cmd.exe /c dir". For MS-Windows, the default is
6564 set according to the value of 'shell', to reduce the need to set this
6565 option by the user.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02006566 On Unix it can have more than one flag. Each white space separated
6567 part is passed as an argument to the shell command.
6568 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006569 Also see |dos-shell| for MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006570 This option cannot be set from a |modeline| or in the |sandbox|, for
6571 security reasons.
6572
6573 *'shellpipe'* *'sp'*
Bram Moolenaar8024f932020-01-14 19:29:13 +01006574'shellpipe' 'sp' string (default ">", ">%s 2>&1", "| tee", "|& tee" or
6575 "2>&1| tee")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006576 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006577 {not available when compiled without the |+quickfix|
6578 feature}
6579 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006580 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00006581 including spaces and backslashes.
6582 The name of the temporary file can be represented by "%s" if necessary
6583 (the file name is appended automatically if no %s appears in the value
6584 of this option).
Bram Moolenaar8024f932020-01-14 19:29:13 +01006585 For the Amiga the default is ">". For MS-Windows the default is
6586 ">%s 2>&1". The output is directly saved in a file and not echoed to
6587 the screen.
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02006588 For Unix the default is "| tee". The stdout of the compiler is saved
Bram Moolenaar071d4272004-06-13 20:20:40 +00006589 in a file and echoed to the screen. If the 'shell' option is "csh" or
6590 "tcsh" after initializations, the default becomes "|& tee". If the
Bram Moolenaar96f45c02019-10-26 19:53:45 +02006591 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh", "zsh-beta",
6592 "bash" or "fish" the default becomes "2>&1| tee". This means that
6593 stderr is also included. Before using the 'shell' option a path is
6594 removed, thus "/bin/sh" uses "sh".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006595 The initialization of this option is done after reading the ".vimrc"
6596 and the other initializations, so that when the 'shell' option is set
6597 there, the 'shellpipe' option changes automatically, unless it was
6598 explicitly set before.
6599 When 'shellpipe' is set to an empty string, no redirection of the
6600 ":make" output will be done. This is useful if you use a 'makeprg'
6601 that writes to 'makeef' by itself. If you want no piping, but do
6602 want to include the 'makeef', set 'shellpipe' to a single space.
6603 Don't forget to precede the space with a backslash: ":set sp=\ ".
6604 In the future pipes may be used for filtering and this option will
6605 become obsolete (at least for Unix).
6606 This option cannot be set from a |modeline| or in the |sandbox|, for
6607 security reasons.
6608
6609 *'shellquote'* *'shq'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006610'shellquote' 'shq' string (default: ""; Win32, when 'shell'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006611 contains "sh" somewhere: "\"")
6612 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006613 Quoting character(s), put around the command passed to the shell, for
6614 the "!" and ":!" commands. The redirection is kept outside of the
6615 quoting. See 'shellxquote' to include the redirection. It's
6616 probably not useful to set both options.
6617 This is an empty string by default. Only known to be useful for
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006618 third-party shells on MS-Windows-like systems, such as the MKS Korn
6619 Shell or bash, where it should be "\"". The default is adjusted
6620 according the value of 'shell', to reduce the need to set this option
6621 by the user. See |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006622 This option cannot be set from a |modeline| or in the |sandbox|, for
6623 security reasons.
6624
6625 *'shellredir'* *'srr'*
6626'shellredir' 'srr' string (default ">", ">&" or ">%s 2>&1")
6627 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006628 String to be used to put the output of a filter command in a temporary
6629 file. See also |:!|. See |option-backslash| about including spaces
6630 and backslashes.
6631 The name of the temporary file can be represented by "%s" if necessary
6632 (the file name is appended automatically if no %s appears in the value
6633 of this option).
Bram Moolenaar96f45c02019-10-26 19:53:45 +02006634 The default is ">". For Unix, if the 'shell' option is "csh" or
6635 "tcsh" during initializations, the default becomes ">&". If the
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01006636 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh", "zsh-beta",
6637 "bash" or "fish", the default becomes ">%s 2>&1". This means that
6638 stderr is also included. For Win32, the Unix checks are done and
6639 additionally "cmd" is checked for, which makes the default ">%s 2>&1".
6640 Also, the same names with ".exe" appended are checked for.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006641 The initialization of this option is done after reading the ".vimrc"
6642 and the other initializations, so that when the 'shell' option is set
6643 there, the 'shellredir' option changes automatically unless it was
6644 explicitly set before.
6645 In the future pipes may be used for filtering and this option will
6646 become obsolete (at least for Unix).
6647 This option cannot be set from a |modeline| or in the |sandbox|, for
6648 security reasons.
6649
6650 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
6651'shellslash' 'ssl' boolean (default off)
6652 global
Bram Moolenaar6f345a12019-12-17 21:27:18 +01006653 {only for MS-Windows}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006654 When set, a forward slash is used when expanding file names. This is
Bram Moolenaar8024f932020-01-14 19:29:13 +01006655 useful when a Unix-like shell is used instead of cmd.exe. Backward
6656 slashes can still be typed, but they are changed to forward slashes by
6657 Vim.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006658 Note that setting or resetting this option has no effect for some
6659 existing file names, thus this option needs to be set before opening
6660 any file for best results. This might change in the future.
6661 'shellslash' only works when a backslash can be used as a path
6662 separator. To test if this is so use: >
6663 if exists('+shellslash')
Bram Moolenaarac3150d2019-07-28 16:36:39 +02006664< Also see 'completeslash'.
6665
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006666 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
6667'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
6668 global
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006669 When on, use temp files for shell commands. When off use a pipe.
6670 When using a pipe is not possible temp files are used anyway.
Bram Moolenaar97293012011-07-18 19:40:27 +02006671 Currently a pipe is only supported on Unix and MS-Windows 2K and
6672 later. You can check it with: >
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006673 :if has("filterpipe")
6674< The advantage of using a pipe is that nobody can read the temp file
6675 and the 'shell' command does not need to support redirection.
6676 The advantage of using a temp file is that the file type and encoding
6677 can be detected.
6678 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
6679 |FilterWritePost| autocommands event are not triggered when
6680 'shelltemp' is off.
Bram Moolenaar269f5952016-07-15 22:54:41 +02006681 The `system()` function does not respect this option and always uses
6682 temp files.
Bram Moolenaar036986f2017-03-16 17:41:02 +01006683 NOTE: This option is set to the Vim default value when 'compatible'
6684 is reset.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006685
Bram Moolenaar071d4272004-06-13 20:20:40 +00006686 *'shelltype'* *'st'*
6687'shelltype' 'st' number (default 0)
6688 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02006689 {only for the Amiga}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006690 On the Amiga this option influences the way how the commands work
6691 which use a shell.
6692 0 and 1: always use the shell
6693 2 and 3: use the shell only to filter lines
6694 4 and 5: use shell only for ':sh' command
6695 When not using the shell, the command is executed directly.
6696
6697 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
6698 1 and 3: use "shell cmd" to start external commands
6699
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006700 *'shellxescape'* *'sxe'*
6701'shellxescape' 'sxe' string (default: "";
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006702 for MS-Windows: "\"&|<>()@^")
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006703 global
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006704 When 'shellxquote' is set to "(" then the characters listed in this
6705 option will be escaped with a '^' character. This makes it possible
6706 to execute most external commands with cmd.exe.
6707
Bram Moolenaar071d4272004-06-13 20:20:40 +00006708 *'shellxquote'* *'sxq'*
6709'shellxquote' 'sxq' string (default: "";
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006710 for Win32, when 'shell' is cmd.exe: "("
6711 for Win32, when 'shell' contains "sh"
6712 somewhere: "\""
Bram Moolenaar071d4272004-06-13 20:20:40 +00006713 for Unix, when using system(): "\"")
6714 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006715 Quoting character(s), put around the command passed to the shell, for
6716 the "!" and ":!" commands. Includes the redirection. See
6717 'shellquote' to exclude the redirection. It's probably not useful
6718 to set both options.
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006719 When the value is '(' then ')' is appended. When the value is '"('
6720 then ')"' is appended.
6721 When the value is '(' then also see 'shellxescape'.
Bram Moolenaara64ba222012-02-12 23:23:31 +01006722 This is an empty string by default on most systems, but is known to be
6723 useful for on Win32 version, either for cmd.exe which automatically
6724 strips off the first and last quote on a command, or 3rd-party shells
6725 such as the MKS Korn Shell or bash, where it should be "\"". The
6726 default is adjusted according the value of 'shell', to reduce the need
6727 to set this option by the user. See |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006728 This option cannot be set from a |modeline| or in the |sandbox|, for
6729 security reasons.
6730
6731 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
6732'shiftround' 'sr' boolean (default off)
6733 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006734 Round indent to multiple of 'shiftwidth'. Applies to > and <
6735 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
6736 a multiple of 'shiftwidth' (this is Vi compatible).
6737 NOTE: This option is reset when 'compatible' is set.
6738
6739 *'shiftwidth'* *'sw'*
6740'shiftwidth' 'sw' number (default 8)
6741 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006742 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00006743 |'cindent'|, |>>|, |<<|, etc.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02006744 When zero the 'ts' value will be used. Use the |shiftwidth()|
6745 function to get the effective shiftwidth value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006746
6747 *'shortmess'* *'shm'*
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02006748'shortmess' 'shm' string (Vim default "filnxtToOS", Vi default: "S",
6749 POSIX default: "AS")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006750 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006751 This option helps to avoid all the |hit-enter| prompts caused by file
6752 messages, for example with CTRL-G, and to avoid some other messages.
6753 It is a list of flags:
6754 flag meaning when present ~
6755 f use "(3 of 5)" instead of "(file 3 of 5)"
6756 i use "[noeol]" instead of "[Incomplete last line]"
Bram Moolenaar3f40ce72020-07-05 14:10:13 +02006757 l use "999L, 888B" instead of "999 lines, 888 bytes"
Bram Moolenaar071d4272004-06-13 20:20:40 +00006758 m use "[+]" instead of "[Modified]"
6759 n use "[New]" instead of "[New File]"
6760 r use "[RO]" instead of "[readonly]"
6761 w use "[w]" instead of "written" for file write message
6762 and "[a]" instead of "appended" for ':w >> file' command
6763 x use "[dos]" instead of "[dos format]", "[unix]" instead of
6764 "[unix format]" and "[mac]" instead of "[mac format]".
6765 a all of the above abbreviations
6766
6767 o overwrite message for writing a file with subsequent message
6768 for reading a file (useful for ":wn" or when 'autowrite' on)
6769 O message for reading a file overwrites any previous message.
6770 Also for quickfix message (e.g., ":cn").
6771 s don't give "search hit BOTTOM, continuing at TOP" or "search
Bram Moolenaara6c27c42019-05-09 19:16:22 +02006772 hit TOP, continuing at BOTTOM" messages; when using the search
6773 count do not show "W" after the count message (see S below)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006774 t truncate file message at the start if it is too long to fit
6775 on the command-line, "<" will appear in the left most column.
6776 Ignored in Ex mode.
6777 T truncate other messages in the middle if they are too long to
Bram Moolenaar582fd852005-03-28 20:58:01 +00006778 fit on the command line. "..." will appear in the middle.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006779 Ignored in Ex mode.
6780 W don't give "written" or "[w]" when writing a file
6781 A don't give the "ATTENTION" message when an existing swap file
6782 is found.
6783 I don't give the intro message when starting Vim |:intro|.
Bram Moolenaarea389e92014-05-28 21:40:52 +02006784 c don't give |ins-completion-menu| messages. For example,
6785 "-- XXX completion (YYY)", "match 1 of 2", "The only match",
6786 "Pattern not found", "Back at original", etc.
Bram Moolenaar426dd022016-03-15 15:09:29 +01006787 q use "recording" instead of "recording @a"
6788 F don't give the file info when editing a file, like `:silent`
Bram Moolenaar110289e2019-05-23 15:38:06 +02006789 was used for the command; note that this also affects messages
6790 from autocommands
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02006791 S do not show search count message when searching, e.g.
6792 "[1/5]"
Bram Moolenaar071d4272004-06-13 20:20:40 +00006793
6794 This gives you the opportunity to avoid that a change between buffers
6795 requires you to hit <Enter>, but still gives as useful a message as
6796 possible for the space available. To get the whole message that you
6797 would have got with 'shm' empty, use ":file!"
6798 Useful values:
6799 shm= No abbreviation of message.
6800 shm=a Abbreviation, but no loss of information.
6801 shm=at Abbreviation, and truncate message when necessary.
6802
6803 NOTE: This option is set to the Vi default value when 'compatible' is
6804 set and to the Vim default value when 'compatible' is reset.
6805
6806 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
6807'shortname' 'sn' boolean (default off)
6808 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00006809 Filenames are assumed to be 8 characters plus one extension of 3
6810 characters. Multiple dots in file names are not allowed. When this
6811 option is on, dots in file names are replaced with underscores when
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006812 adding an extension (".~" or ".swp"). This option is useful
Bram Moolenaar071d4272004-06-13 20:20:40 +00006813 when editing files on an MS-DOS compatible filesystem, e.g., messydos
Bram Moolenaarade0d392020-01-21 22:33:58 +01006814 or crossdos.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006815
6816 *'showbreak'* *'sbr'* *E595*
6817'showbreak' 'sbr' string (default "")
Bram Moolenaaree857022019-11-09 23:26:40 +01006818 global or local to window |global-local|
Bram Moolenaardb84e452010-08-15 13:50:43 +02006819 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006820 feature}
6821 String to put at the start of lines that have been wrapped. Useful
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006822 values are "> " or "+++ ": >
6823 :set showbreak=>\
6824< Note the backslash to escape the trailing space. It's easier like
6825 this: >
Bram Moolenaar1a384422010-07-14 19:53:30 +02006826 :let &showbreak = '+++ '
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006827< Only printable single-cell characters are allowed, excluding <Tab> and
Bram Moolenaar071d4272004-06-13 20:20:40 +00006828 comma (in a future version the comma might be used to separate the
6829 part that is shown at the end and at the start of a line).
6830 The characters are highlighted according to the '@' flag in
6831 'highlight'.
6832 Note that tabs after the showbreak will be displayed differently.
6833 If you want the 'showbreak' to appear in between line numbers, add the
6834 "n" flag to 'cpoptions'.
Bram Moolenaaree857022019-11-09 23:26:40 +01006835 A window-local value overrules a global value. If the global value is
6836 set and you want no value in the current window use NONE: >
6837 :setlocal showbreak=NONE
6838<
Bram Moolenaar071d4272004-06-13 20:20:40 +00006839 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02006840'showcmd' 'sc' boolean (Vim default: on, off for Unix,
6841 Vi default: off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006842 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006843 {not available when compiled without the
6844 |+cmdline_info| feature}
Bram Moolenaar02467872007-05-06 13:22:01 +00006845 Show (partial) command in the last line of the screen. Set this
6846 option off if your terminal is slow.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006847 In Visual mode the size of the selected area is shown:
6848 - When selecting characters within a line, the number of characters.
Bram Moolenaarf91787c2010-07-17 12:47:16 +02006849 If the number of bytes is different it is also displayed: "2-6"
6850 means two characters and six bytes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006851 - When selecting more than one line, the number of lines.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006852 - When selecting a block, the size in screen characters:
6853 {lines}x{columns}.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006854 NOTE: This option is set to the Vi default value when 'compatible' is
6855 set and to the Vim default value when 'compatible' is reset.
6856
6857 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
6858'showfulltag' 'sft' boolean (default off)
6859 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006860 When completing a word in insert mode (see |ins-completion|) from the
6861 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006862 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00006863 matched a C function, you can see a template for what arguments are
6864 required (coding style permitting).
Bram Moolenaar446cb832008-06-24 21:56:24 +00006865 Note that this doesn't work well together with having "longest" in
6866 'completeopt', because the completion from the search pattern may not
6867 match the typed text.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006868
6869 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
6870'showmatch' 'sm' boolean (default off)
6871 global
6872 When a bracket is inserted, briefly jump to the matching one. The
6873 jump is only done if the match can be seen on the screen. The time to
6874 show the match can be set with 'matchtime'.
6875 A Beep is given if there is no match (no matter if the match can be
Bram Moolenaarca635012015-09-25 20:34:21 +02006876 seen or not).
6877 This option is reset when 'paste' is set and restored when 'paste' is
6878 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006879 When the 'm' flag is not included in 'cpoptions', typing a character
6880 will immediately move the cursor back to where it belongs.
6881 See the "sm" field in 'guicursor' for setting the cursor shape and
6882 blinking when showing the match.
6883 The 'matchpairs' option can be used to specify the characters to show
6884 matches for. 'rightleft' and 'revins' are used to look for opposite
6885 matches.
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006886 Also see the matchparen plugin for highlighting the match when moving
6887 around |pi_paren.txt|.
6888 Note: Use of the short form is rated PG.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006889
6890 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
6891'showmode' 'smd' boolean (Vim default: on, Vi default: off)
6892 global
6893 If in Insert, Replace or Visual mode put a message on the last line.
6894 Use the 'M' flag in 'highlight' to set the type of highlighting for
6895 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006896 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00006897 doesn't mean XIM is really active, especially when 'imactivatekey' is
6898 not set.
6899 NOTE: This option is set to the Vi default value when 'compatible' is
6900 set and to the Vim default value when 'compatible' is reset.
6901
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006902 *'showtabline'* *'stal'*
6903'showtabline' 'stal' number (default 1)
6904 global
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006905 The value of this option specifies when the line with tab page labels
6906 will be displayed:
6907 0: never
6908 1: only if there are at least two tab pages
6909 2: always
6910 This is both for the GUI and non-GUI implementation of the tab pages
6911 line.
6912 See |tab-page| for more information about tab pages.
6913
Bram Moolenaar071d4272004-06-13 20:20:40 +00006914 *'sidescroll'* *'ss'*
6915'sidescroll' 'ss' number (default 0)
6916 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006917 The minimal number of columns to scroll horizontally. Used only when
6918 the 'wrap' option is off and the cursor is moved off of the screen.
6919 When it is zero the cursor will be put in the middle of the screen.
6920 When using a slow terminal set it to a large number or 0. When using
6921 a fast terminal use a small number or 1. Not used for "zh" and "zl"
6922 commands.
6923
6924 *'sidescrolloff'* *'siso'*
6925'sidescrolloff' 'siso' number (default 0)
Bram Moolenaar375e3392019-01-31 18:26:10 +01006926 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006927 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00006928 right of the cursor if 'nowrap' is set. Setting this option to a
6929 value greater than 0 while having |'sidescroll'| also at a non-zero
6930 value makes some context visible in the line you are scrolling in
6931 horizontally (except at beginning of the line). Setting this option
6932 to a large value (like 999) has the effect of keeping the cursor
6933 horizontally centered in the window, as long as one does not come too
6934 close to the beginning of the line.
Bram Moolenaar375e3392019-01-31 18:26:10 +01006935 After using the local value, go back the global value with one of
6936 these two: >
6937 setlocal sidescrolloff<
6938 setlocal sidescrolloff=-1
6939< NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006940
6941 Example: Try this together with 'sidescroll' and 'listchars' as
6942 in the following example to never allow the cursor to move
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02006943 onto the "extends" character: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006944
6945 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
6946 :set sidescrolloff=1
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02006947<
6948 *'signcolumn'* *'scl'*
6949'signcolumn' 'scl' string (default "auto")
6950 local to window
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02006951 {not available when compiled without the |+signs|
6952 feature}
Bram Moolenaar09521312016-08-12 22:54:35 +02006953 Whether or not to draw the signcolumn. Valid values are:
6954 "auto" only when there is a sign to display
6955 "no" never
6956 "yes" always
Bram Moolenaar394c5d82019-06-17 21:48:05 +02006957 "number" display signs in the 'number' column. If the number
Bram Moolenaar6c1e1572019-06-22 02:13:00 +02006958 column is not present, then behaves like "auto".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006959
6960
6961 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
6962'smartcase' 'scs' boolean (default off)
6963 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006964 Override the 'ignorecase' option if the search pattern contains upper
6965 case characters. Only used when the search pattern is typed and
6966 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarc8734422012-06-01 22:38:45 +02006967 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00006968 "*" and "#" you can make 'smartcase' used by doing a "/" command,
6969 recalling the search pattern from history and hitting <Enter>.
6970 NOTE: This option is reset when 'compatible' is set.
6971
6972 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
6973'smartindent' 'si' boolean (default off)
6974 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00006975 {not available when compiled without the
6976 |+smartindent| feature}
6977 Do smart autoindenting when starting a new line. Works for C-like
6978 programs, but can also be used for other languages. 'cindent' does
6979 something like this, works better in most cases, but is more strict,
Bram Moolenaar81af9252010-12-10 20:35:50 +01006980 see |C-indenting|. When 'cindent' is on or 'indentexpr' is set,
Bram Moolenaar166af9b2010-11-16 20:34:40 +01006981 setting 'si' has no effect. 'indentexpr' is a more advanced
6982 alternative.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006983 Normally 'autoindent' should also be on when using 'smartindent'.
6984 An indent is automatically inserted:
6985 - After a line ending in '{'.
6986 - After a line starting with a keyword from 'cinwords'.
6987 - Before a line starting with '}' (only with the "O" command).
6988 When typing '}' as the first character in a new line, that line is
6989 given the same indent as the matching '{'.
6990 When typing '#' as the first character in a new line, the indent for
6991 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006992 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00006993 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
6994 When using the ">>" command, lines starting with '#' are not shifted
6995 right.
Bram Moolenaar036986f2017-03-16 17:41:02 +01006996 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02006997 This option is reset when 'paste' is set and restored when 'paste' is
6998 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006999
7000 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
7001'smarttab' 'sta' boolean (default off)
7002 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007003 When on, a <Tab> in front of a line inserts blanks according to
Bram Moolenaar280f1262006-01-30 00:14:18 +00007004 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A
7005 <BS> will delete a 'shiftwidth' worth of space at the start of the
7006 line.
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00007007 When off, a <Tab> always inserts blanks according to 'tabstop' or
Bram Moolenaar280f1262006-01-30 00:14:18 +00007008 'softtabstop'. 'shiftwidth' is only used for shifting text left or
7009 right |shift-left-right|.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007010 What gets inserted (a <Tab> or spaces) depends on the 'expandtab'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007011 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00007012 number of spaces is minimized by using <Tab>s.
Bram Moolenaarca635012015-09-25 20:34:21 +02007013 This option is reset when 'paste' is set and restored when 'paste' is
7014 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007015 NOTE: This option is reset when 'compatible' is set.
7016
7017 *'softtabstop'* *'sts'*
7018'softtabstop' 'sts' number (default 0)
7019 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007020 Number of spaces that a <Tab> counts for while performing editing
7021 operations, like inserting a <Tab> or using <BS>. It "feels" like
7022 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
7023 used. This is useful to keep the 'ts' setting at its standard value
7024 of 8, while being able to edit like it is set to 'sts'. However,
7025 commands like "x" still work on the actual characters.
7026 When 'sts' is zero, this feature is off.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02007027 When 'sts' is negative, the value of 'shiftwidth' is used.
Bram Moolenaarca635012015-09-25 20:34:21 +02007028 'softtabstop' is set to 0 when the 'paste' option is set and restored
7029 when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007030 See also |ins-expandtab|. When 'expandtab' is not set, the number of
7031 spaces is minimized by using <Tab>s.
7032 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
7033 set.
7034 NOTE: This option is set to 0 when 'compatible' is set.
7035
Bram Moolenaar04958cb2018-06-23 19:23:02 +02007036 If Vim is compiled with the |+vartabs| feature then the value of
7037 'softtabstop' will be ignored if |'varsofttabstop'| is set to
7038 anything other than an empty string.
7039
Bram Moolenaar217ad922005-03-20 22:37:15 +00007040 *'spell'* *'nospell'*
7041'spell' boolean (default off)
7042 local to window
Bram Moolenaar217ad922005-03-20 22:37:15 +00007043 {not available when compiled without the |+syntax|
7044 feature}
7045 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007046 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007047
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007048 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00007049'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007050 local to buffer
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007051 {not available when compiled without the |+syntax|
7052 feature}
7053 Pattern to locate the end of a sentence. The following word will be
7054 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007055 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007056 When this check is not wanted make this option empty.
7057 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00007058 Be careful with special characters, see |option-backslash| about
7059 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007060 To set this option automatically depending on the language, see
7061 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007062
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007063 *'spellfile'* *'spf'*
7064'spellfile' 'spf' string (default empty)
7065 local to buffer
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007066 {not available when compiled without the |+syntax|
7067 feature}
7068 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00007069 commands. It must end in ".{encoding}.add". You need to include the
7070 path, otherwise the file is placed in the current directory.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007071 *E765*
7072 It may also be a comma separated list of names. A count before the
7073 |zg| and |zw| commands can be used to access each. This allows using
7074 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007075 When a word is added while this option is empty Vim will set it for
Bram Moolenaar910f66f2006-04-05 20:41:53 +00007076 you: Using the first directory in 'runtimepath' that is writable. If
7077 there is no "spell" directory yet it will be created. For the file
7078 name the first language name that appears in 'spelllang' is used,
Bram Moolenaar3b506942005-06-23 22:36:45 +00007079 ignoring the region.
7080 The resulting ".spl" file will be used for spell checking, it does not
7081 have to appear in 'spelllang'.
7082 Normally one file is used for all regions, but you can add the region
7083 name if you want to. However, it will then only be used when
7084 'spellfile' is set to it, for entries in 'spelllang' only files
7085 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00007086 This option cannot be set from a |modeline| or in the |sandbox|, for
7087 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007088
Bram Moolenaar217ad922005-03-20 22:37:15 +00007089 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007090'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00007091 local to buffer
Bram Moolenaar217ad922005-03-20 22:37:15 +00007092 {not available when compiled without the |+syntax|
7093 feature}
Bram Moolenaar3b506942005-06-23 22:36:45 +00007094 A comma separated list of word list names. When the 'spell' option is
7095 on spellchecking will be done for these languages. Example: >
7096 set spelllang=en_us,nl,medical
7097< This means US English, Dutch and medical words are recognized. Words
7098 that are not recognized will be highlighted.
Bram Moolenaar911ead12019-04-21 00:03:35 +02007099 The word list name must consist of alphanumeric characters, a dash or
7100 an underscore. It should not include a comma or dot. Using a dash is
Bram Moolenaar3b506942005-06-23 22:36:45 +00007101 recommended to separate the two letter language name from a
7102 specification. Thus "en-rare" is used for rare English words.
7103 A region name must come last and have the form "_xx", where "xx" is
7104 the two-letter, lower case region name. You can use more than one
7105 region by listing them: "en_us,en_ca" supports both US and Canadian
7106 English, but not words specific for Australia, New Zealand or Great
Bram Moolenaarfa735342016-01-03 22:14:44 +01007107 Britain. (Note: currently en_au and en_nz dictionaries are older than
7108 en_ca, en_gb and en_us).
Bram Moolenaarcc63c642013-11-12 04:44:01 +01007109 If the name "cjk" is included East Asian characters are excluded from
7110 spell checking. This is useful when editing text that also has Asian
7111 words.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007112 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007113 As a special case the name of a .spl file can be given as-is. The
7114 first "_xx" in the name is removed and used as the region name
7115 (_xx is an underscore, two letters and followed by a non-letter).
7116 This is mainly for testing purposes. You must make sure the correct
7117 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007118 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007119 idea to set 'spelllang' after setting 'encoding' to avoid loading the
7120 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00007121 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007122
Bram Moolenaar98692072006-02-04 00:57:42 +00007123 If the |spellfile.vim| plugin is active and you use a language name
7124 for which Vim cannot find the .spl file in 'runtimepath' the plugin
7125 will ask you if you want to download the file.
7126
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007127 After this option has been set successfully, Vim will source the files
7128 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
Bram Moolenaarb730f0c2018-11-25 03:56:26 +01007129 up to the first character that is not an ASCII letter or number and
7130 not a dash. Also see |set-spc-auto|.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007131
Bram Moolenaar362b44b2020-06-10 21:47:00 +02007132 *'spelloptions'* *'spo'*
7133'spelloptions' 'spo' string (default "")
7134 local to buffer
7135 {not available when compiled without the |+syntax|
7136 feature}
7137 A comma separated list of options for spell checking:
7138 camel When a word is CamelCased, assume "Cased" is a
7139 separate word: every upper-case character in a word
7140 that comes after a lower case character indicates the
7141 start of a new word.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007142
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007143 *'spellsuggest'* *'sps'*
7144'spellsuggest' 'sps' string (default "best")
7145 global
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007146 {not available when compiled without the |+syntax|
7147 feature}
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007148 Methods used for spelling suggestions. Both for the |z=| command and
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007149 the |spellsuggest()| function. This is a comma-separated list of
7150 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007151
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007152 best Internal method that works best for English. Finds
7153 changes like "fast" and uses a bit of sound-a-like
7154 scoring to improve the ordering.
7155
7156 double Internal method that uses two methods and mixes the
7157 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007158 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007159 word. That only works when the language specifies
7160 sound folding. Can be slow and doesn't always give
7161 better results.
7162
7163 fast Internal method that only checks for simple changes:
7164 character inserts/deletes/swaps. Works well for
7165 simple typing mistakes.
7166
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007167 {number} The maximum number of suggestions listed for |z=|.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007168 Not used for |spellsuggest()|. The number of
7169 suggestions is never more than the value of 'lines'
7170 minus two.
7171
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007172 file:{filename} Read file {filename}, which must have two columns,
7173 separated by a slash. The first column contains the
7174 bad word, the second column the suggested good word.
7175 Example:
7176 theribal/terrible ~
7177 Use this for common mistakes that do not appear at the
7178 top of the suggestion list with the internal methods.
7179 Lines without a slash are ignored, use this for
7180 comments.
Bram Moolenaarbcb98982014-05-01 14:08:19 +02007181 The word in the second column must be correct,
7182 otherwise it will not be used. Add the word to an
7183 ".add" file if it is currently flagged as a spelling
7184 mistake.
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007185 The file is used for all languages.
7186
7187 expr:{expr} Evaluate expression {expr}. Use a function to avoid
7188 trouble with spaces. |v:val| holds the badly spelled
7189 word. The expression must evaluate to a List of
7190 Lists, each with a suggestion and a score.
7191 Example:
Bram Moolenaar214641f2017-03-05 17:04:09 +01007192 [['the', 33], ['that', 44]] ~
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007193 Set 'verbose' and use |z=| to see the scores that the
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007194 internal methods use. A lower score is better.
7195 This may invoke |spellsuggest()| if you temporarily
7196 set 'spellsuggest' to exclude the "expr:" part.
7197 Errors are silently ignored, unless you set the
7198 'verbose' option to a non-zero value.
7199
7200 Only one of "best", "double" or "fast" may be used. The others may
7201 appear several times in any order. Example: >
7202 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
7203<
7204 This option cannot be set from a |modeline| or in the |sandbox|, for
7205 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007206
7207
Bram Moolenaar071d4272004-06-13 20:20:40 +00007208 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
7209'splitbelow' 'sb' boolean (default off)
7210 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007211 When on, splitting a window will put the new window below the current
7212 one. |:split|
7213
7214 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
7215'splitright' 'spr' boolean (default off)
7216 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007217 When on, splitting a window will put the new window right of the
7218 current one. |:vsplit|
7219
7220 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
7221'startofline' 'sol' boolean (default on)
7222 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007223 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00007224 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007225 (if possible). This applies to the commands: CTRL-D, CTRL-U, CTRL-B,
Bram Moolenaar843ee412004-06-30 16:16:41 +00007226 CTRL-F, "G", "H", "M", "L", gg, and to the commands "d", "<<" and ">>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007227 with a linewise operator, with "%" with a count and to buffer changing
7228 commands (CTRL-^, :bnext, :bNext, etc.). Also for an Ex command that
7229 only has a line number, e.g., ":25" or ":+".
7230 In case of buffer changing commands the cursor is placed at the column
7231 where it was the last time the buffer was edited.
7232 NOTE: This option is set when 'compatible' is set.
7233
Bram Moolenaar00654022011-02-25 14:42:19 +01007234 *'statusline'* *'stl'* *E540* *E542*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007235'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007236 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007237 {not available when compiled without the |+statusline|
7238 feature}
7239 When nonempty, this option determines the content of the status line.
7240 Also see |status-line|.
7241
7242 The option consists of printf style '%' items interspersed with
7243 normal text. Each status line item is of the form:
7244 %-0{minwid}.{maxwid}{item}
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01007245 All fields except the {item} are optional. A single percent sign can
Bram Moolenaar8133cc62020-10-26 21:05:27 +01007246 be given as "%%".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007247
Bram Moolenaar238a5642006-02-21 22:12:05 +00007248 When the option starts with "%!" then it is used as an expression,
7249 evaluated and the result is used as the option value. Example: >
7250 :set statusline=%!MyStatusLine()
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02007251< The *g:statusline_winid* variable will be set to the |window-ID| of the
7252 window that the status line belongs to.
7253 The result can contain %{} items that will be evaluated too.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02007254 Note that the "%!" expression is evaluated in the context of the
7255 current window and buffer, while %{} items are evaluated in the
7256 context of the window that the statusline belongs to.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007257
7258 When there is error while evaluating the option then it will be made
7259 empty to avoid further errors. Otherwise screen updating would loop.
7260
Bram Moolenaar071d4272004-06-13 20:20:40 +00007261 Note that the only effect of 'ruler' when this option is set (and
7262 'laststatus' is 2) is controlling the output of |CTRL-G|.
7263
7264 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00007265 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00007266 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007267 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007268 minwid Minimum width of the item, padding as set by '-' & '0'.
7269 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007270 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007271 on the left for text items. Numeric items will be
7272 shifted down to maxwid-2 digits followed by '>'number
7273 where number is the amount of missing digits, much like
7274 an exponential notation.
7275 item A one letter code as described below.
7276
7277 Following is a description of the possible statusline items. The
7278 second character in "item" is the type:
7279 N for number
7280 S for string
7281 F for flags as described below
7282 - not applicable
7283
7284 item meaning ~
Bram Moolenaar02467872007-05-06 13:22:01 +00007285 f S Path to the file in the buffer, as typed or relative to current
7286 directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007287 F S Full path to the file in the buffer.
7288 t S File name (tail) of file in the buffer.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007289 m F Modified flag, text is "[+]"; "[-]" if 'modifiable' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007290 M F Modified flag, text is ",+" or ",-".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007291 r F Readonly flag, text is "[RO]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007292 R F Readonly flag, text is ",RO".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007293 h F Help buffer flag, text is "[help]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007294 H F Help buffer flag, text is ",HLP".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007295 w F Preview window flag, text is "[Preview]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007296 W F Preview window flag, text is ",PRV".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007297 y F Type of file in the buffer, e.g., "[vim]". See 'filetype'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007298 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
Bram Moolenaar7fd73202010-07-25 16:58:46 +02007299 q S "[Quickfix List]", "[Location List]" or empty.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007300 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
7301 being used: "<keymap>"
7302 n N Buffer number.
Bram Moolenaar00654022011-02-25 14:42:19 +01007303 b N Value of character under cursor.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007304 B N As above, in hexadecimal.
7305 o N Byte number in file of byte under cursor, first byte is 1.
7306 Mnemonic: Offset from start of file (with one added)
7307 {not available when compiled without |+byte_offset| feature}
7308 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007309 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007310 l N Line number.
7311 L N Number of lines in buffer.
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02007312 c N Column number (byte index).
7313 v N Virtual column number (screen column).
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007314 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007315 p N Percentage through file in lines as in |CTRL-G|.
7316 P S Percentage through file of displayed window. This is like the
Bram Moolenaar14b69452013-06-29 23:05:20 +02007317 percentage described for 'ruler'. Always 3 in length, unless
7318 translated.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007319 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00007320 Empty if the argument file count is zero or one.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007321 { NF Evaluate expression between '%{' and '}' and substitute result.
Bram Moolenaar6d150f72018-04-21 20:03:20 +02007322 Note that there is no '%' before the closing '}'. The
7323 expression cannot contain a '}' character, call a function to
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007324 work around that. See |stl-%{| below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007325 ( - Start of item group. Can be used for setting the width and
7326 alignment of a section. Must be followed by %) somewhere.
7327 ) - End of item group. No width fields allowed.
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007328 T N For 'tabline': start of tab page N label. Use %T after the last
7329 label. This information is used for mouse clicks.
7330 X N For 'tabline': start of close tab N label. Use %X after the
7331 label, e.g.: %3Xclose%X. Use %999X for a "close current tab"
7332 mark. This information is used for mouse clicks.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007333 < - Where to truncate line if too long. Default is at the start.
7334 No width fields allowed.
7335 = - Separation point between left and right aligned items.
7336 No width fields allowed.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007337 # - Set highlight group. The name must follow and then a # again.
7338 Thus use %#HLname# for highlight group HLname. The same
7339 highlighting is used, also for the statusline of non-current
7340 windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007341 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00007342 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007343 The difference between User{N} and StatusLine will be applied
7344 to StatusLineNC for the statusline of non-current windows.
7345 The number N must be between 1 and 9. See |hl-User1..9|
7346
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007347 When displaying a flag, Vim removes the leading comma, if any, when
7348 that flag comes right after plaintext. This will make a nice display
7349 when flags are used like in the examples below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007350
Bram Moolenaar582fd852005-03-28 20:58:01 +00007351 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00007352 not set) and a minwid is not set for the group, the whole group will
7353 become empty. This will make a group like the following disappear
7354 completely from the statusline when none of the flags are set. >
7355 :set statusline=...%(\ [%M%R%H]%)...
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02007356< Beware that an expression is evaluated each and every time the status
7357 line is displayed.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007358 *stl-%{* *g:actual_curbuf* *g:actual_curwin*
Bram Moolenaarade0d392020-01-21 22:33:58 +01007359 While evaluating %{} the current buffer and current window will be set
7360 temporarily to that of the window (and buffer) whose statusline is
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007361 currently being drawn. The expression will evaluate in this context.
7362 The variable "g:actual_curbuf" is set to the `bufnr()` number of the
7363 real current buffer and "g:actual_curwin" to the |window-ID| of the
7364 real current window. These values are strings.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007365
Bram Moolenaar30b65812012-07-12 22:01:11 +02007366 The 'statusline' option will be evaluated in the |sandbox| if set from
7367 a modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02007368 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007369
7370 It is not allowed to change text or jump to another window while
7371 evaluating 'statusline' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007372
7373 If the statusline is not updated when you want it (e.g., after setting
7374 a variable that's used in an expression), you can force an update by
7375 setting an option without changing its value. Example: >
7376 :let &ro = &ro
7377
7378< A result of all digits is regarded a number for display purposes.
7379 Otherwise the result is taken as flag text and applied to the rules
7380 described above.
7381
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00007382 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00007383 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
Bram Moolenaarc4da1132017-07-15 19:39:43 +02007384 edit your .vimrc or whatever with "vim --clean" to get it right.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007385
7386 Examples:
7387 Emulate standard status line with 'ruler' set >
7388 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
7389< Similar, but add ASCII value of char under the cursor (like "ga") >
7390 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
7391< Display byte count and byte value, modified flag in red. >
7392 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
7393 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
7394< Display a ,GZ flag if a compressed file is loaded >
7395 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
7396< In the |:autocmd|'s: >
7397 :let b:gzflag = 1
7398< And: >
7399 :unlet b:gzflag
7400< And define this function: >
7401 :function VarExists(var, val)
7402 : if exists(a:var) | return a:val | else | return '' | endif
7403 :endfunction
7404<
7405 *'suffixes'* *'su'*
7406'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
7407 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007408 Files with these suffixes get a lower priority when multiple files
7409 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007410 suffixes. Spaces after the comma are ignored. A dot is also seen as
7411 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007412 separator, precede it with a backslash (see |option-backslash| about
7413 including spaces and backslashes).
7414 See 'wildignore' for completely ignoring files.
7415 The use of |:set+=| and |:set-=| is preferred when adding or removing
7416 suffixes from the list. This avoids problems when a future version
7417 uses another default.
7418
7419 *'suffixesadd'* *'sua'*
7420'suffixesadd' 'sua' string (default "")
7421 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007422 {not available when compiled without the
7423 |+file_in_path| feature}
7424 Comma separated list of suffixes, which are used when searching for a
7425 file for the "gf", "[I", etc. commands. Example: >
7426 :set suffixesadd=.java
7427<
7428 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
7429'swapfile' 'swf' boolean (default on)
7430 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007431 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007432 swapfile is not wanted for a specific buffer. For example, with
7433 confidential information that even root must not be able to access.
7434 Careful: All text will be in memory:
7435 - Don't use this for big files.
7436 - Recovery will be impossible!
7437 A swapfile will only be present when |'updatecount'| is non-zero and
7438 'swapfile' is set.
7439 When 'swapfile' is reset, the swap file for the current buffer is
7440 immediately deleted. When 'swapfile' is set, and 'updatecount' is
7441 non-zero, a swap file is immediately created.
7442 Also see |swap-file| and |'swapsync'|.
Bram Moolenaar76f3b1a2014-03-27 22:30:07 +01007443 If you want to open a new buffer without creating a swap file for it,
7444 use the |:noswapfile| modifier.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01007445 See 'directory' for where the swap file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007446
7447 This option is used together with 'bufhidden' and 'buftype' to
7448 specify special kinds of buffers. See |special-buffers|.
7449
7450 *'swapsync'* *'sws'*
7451'swapsync' 'sws' string (default "fsync")
7452 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007453 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007454 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007455 When this option is empty parts of the swap file may be in memory and
7456 not written to disk. When the system crashes you may lose more work.
7457 On Unix the system does a sync now and then without Vim asking for it,
7458 so the disadvantage of setting this option off is small. On some
7459 systems the swap file will not be written at all. For a unix system
7460 setting it to "sync" will use the sync() call instead of the default
7461 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007462 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007463
7464 *'switchbuf'* *'swb'*
7465'switchbuf' 'swb' string (default "")
7466 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007467 This option controls the behavior when switching between buffers.
7468 Possible values (comma separated list):
7469 useopen If included, jump to the first open window that
7470 contains the specified buffer (if there is one).
7471 Otherwise: Do not examine other windows.
7472 This setting is checked with |quickfix| commands, when
7473 jumping to errors (":cc", ":cn", "cp", etc.). It is
7474 also used in all buffer related split commands, for
7475 example ":sbuffer", ":sbnext", or ":sbrewind".
Bram Moolenaar779b74b2006-04-10 14:55:34 +00007476 usetab Like "useopen", but also consider windows in other tab
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00007477 pages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007478 split If included, split the current window before loading
Bram Moolenaar15146672011-10-20 22:22:38 +02007479 a buffer for a |quickfix| command that display errors.
Bram Moolenaar63b74a82019-03-24 15:09:13 +01007480 Otherwise: do not split, use current window (when used
7481 in the quickfix window: the previously used window or
7482 split if there is no other window).
Bram Moolenaara594d772015-06-19 14:41:49 +02007483 vsplit Just like "split" but split vertically.
Bram Moolenaar446cb832008-06-24 21:56:24 +00007484 newtab Like "split", but open a new tab page. Overrules
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02007485 "split" when both are present.
Bram Moolenaar539aa6b2019-11-17 18:09:38 +01007486 uselast If included, jump to the previously used window when
7487 jumping to errors with |quickfix| commands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007488
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007489 *'synmaxcol'* *'smc'*
7490'synmaxcol' 'smc' number (default 3000)
7491 local to buffer
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007492 {not available when compiled without the |+syntax|
7493 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007494 Maximum column in which to search for syntax items. In long lines the
7495 text after this column is not highlighted and following lines may not
7496 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007497 This helps to avoid very slow redrawing for an XML file that is one
7498 long line.
7499 Set to zero to remove the limit.
7500
Bram Moolenaar071d4272004-06-13 20:20:40 +00007501 *'syntax'* *'syn'*
7502'syntax' 'syn' string (default empty)
7503 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007504 {not available when compiled without the |+syntax|
7505 feature}
7506 When this option is set, the syntax with this name is loaded, unless
7507 syntax highlighting has been switched off with ":syntax off".
7508 Otherwise this option does not always reflect the current syntax (the
7509 b:current_syntax variable does).
7510 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007511 not automatically recognized. Example, in an IDL file:
7512 /* vim: set syntax=idl : */ ~
7513 When a dot appears in the value then this separates two filetype
7514 names. Example:
7515 /* vim: set syntax=c.doxygen : */ ~
7516 This will use the "c" syntax first, then the "doxygen" syntax.
7517 Note that the second one must be prepared to be loaded as an addition,
7518 otherwise it will be skipped. More than one dot may appear.
7519 To switch off syntax highlighting for the current file, use: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007520 :set syntax=OFF
7521< To switch syntax highlighting on according to the current value of the
7522 'filetype' option: >
7523 :set syntax=ON
7524< What actually happens when setting the 'syntax' option is that the
7525 Syntax autocommand event is triggered with the value as argument.
7526 This option is not copied to another buffer, independent of the 's' or
7527 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007528 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007529
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007530 *'tabline'* *'tal'*
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007531'tabline' 'tal' string (default empty)
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007532 global
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007533 When nonempty, this option determines the content of the tab pages
7534 line at the top of the Vim window. When empty Vim will use a default
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007535 tab pages line. See |setting-tabline| for more info.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007536
7537 The tab pages line only appears as specified with the 'showtabline'
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00007538 option and only when there is no GUI tab line. When 'e' is in
7539 'guioptions' and the GUI supports a tab line 'guitablabel' is used
Bram Moolenaar7f036442010-08-15 15:24:20 +02007540 instead. Note that the two tab pages lines are very different.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007541
7542 The value is evaluated like with 'statusline'. You can use
7543 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007544 the text to be displayed. Use "%1T" for the first label, "%2T" for
7545 the second one, etc. Use "%X" items for closing labels.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007546
Bram Moolenaare12bab32019-01-08 22:02:56 +01007547 When changing something that is used in 'tabline' that does not
7548 trigger it to be updated, use |:redrawtabline|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02007549 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaare12bab32019-01-08 22:02:56 +01007550
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007551 Keep in mind that only one of the tab pages is the current one, others
7552 are invisible and you can't jump to their windows.
7553
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007554
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007555 *'tabpagemax'* *'tpm'*
7556'tabpagemax' 'tpm' number (default 10)
7557 global
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007558 Maximum number of tab pages to be opened by the |-p| command line
7559 argument or the ":tab all" command. |tabpage|
7560
7561
7562 *'tabstop'* *'ts'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007563'tabstop' 'ts' number (default 8)
7564 local to buffer
7565 Number of spaces that a <Tab> in the file counts for. Also see
7566 |:retab| command, and 'softtabstop' option.
7567
7568 Note: Setting 'tabstop' to any other value than 8 can make your file
7569 appear wrong in many places (e.g., when printing it).
7570
7571 There are four main ways to use tabs in Vim:
7572 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
7573 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007574 will use a mix of tabs and spaces, but typing <Tab> and <BS> will
Bram Moolenaar071d4272004-06-13 20:20:40 +00007575 behave like a tab appears every 4 (or 3) characters.
7576 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
7577 'expandtab'. This way you will always insert spaces. The
7578 formatting will never be messed up when 'tabstop' is changed.
7579 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007580 |modeline| to set these values when editing the file again. Only
Bram Moolenaar071d4272004-06-13 20:20:40 +00007581 works when using Vim to edit the file.
7582 4. Always set 'tabstop' and 'shiftwidth' to the same value, and
7583 'noexpandtab'. This should then work (for initial indents only)
7584 for any tabstop setting that people use. It might be nice to have
7585 tabs after the first non-blank inserted as spaces if you do this
7586 though. Otherwise aligned comments will be wrong when 'tabstop' is
7587 changed.
7588
Bram Moolenaar04958cb2018-06-23 19:23:02 +02007589 If Vim is compiled with the |+vartabs| feature then the value of
7590 'tabstop' will be ignored if |'vartabstop'| is set to anything other
7591 than an empty string.
7592
Bram Moolenaar071d4272004-06-13 20:20:40 +00007593 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
7594'tagbsearch' 'tbs' boolean (default on)
7595 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007596 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007597 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00007598 searching makes searching for a tag a LOT faster, but a linear search
7599 will find more tags if the tags file wasn't properly sorted.
7600 Vim normally assumes that your tags files are sorted, or indicate that
7601 they are not sorted. Only when this is not the case does the
7602 'tagbsearch' option need to be switched off.
7603
7604 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007605 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00007606 certain files, or retry all files with a linear search. When
7607 'tagbsearch' is off, only a linear search is done.
7608
7609 Linear searching is done anyway, for one file, when Vim finds a line
7610 at the start of the file indicating that it's not sorted: >
Bram Moolenaar446cb832008-06-24 21:56:24 +00007611 !_TAG_FILE_SORTED 0 /some comment/
Bram Moolenaar071d4272004-06-13 20:20:40 +00007612< [The whitespace before and after the '0' must be a single <Tab>]
7613
7614 When a binary search was done and no match was found in any of the
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007615 files listed in 'tags', and case is ignored or a pattern is used
Bram Moolenaar071d4272004-06-13 20:20:40 +00007616 instead of a normal tag name, a retry is done with a linear search.
7617 Tags in unsorted tags files, and matches with different case will only
7618 be found in the retry.
7619
Bram Moolenaard4755bb2004-09-02 19:12:26 +00007620 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007621 linear search can be avoided when case is ignored. Use a value of '2'
7622 in the "!_TAG_FILE_SORTED" line for this. A tag file can be case-fold
7623 sorted with the -f switch to "sort" in most unices, as in the command:
7624 "sort -f -o tags tags". For "Exuberant ctags" version 5.x or higher
7625 (at least 5.5) the --sort=foldcase switch can be used for this as
7626 well. Note that case must be folded to uppercase for this to work.
7627
7628 By default, tag searches are case-sensitive. Case is ignored when
7629 'ignorecase' is set and 'tagcase' is "followic", or when 'tagcase' is
7630 "ignore".
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007631 Also when 'tagcase' is "followscs" and 'smartcase' is set, or
7632 'tagcase' is "smart", and the pattern contains only lowercase
7633 characters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007634
7635 When 'tagbsearch' is off, tags searching is slower when a full match
7636 exists, but faster when no full match exists. Tags in unsorted tags
7637 files may only be found with 'tagbsearch' off.
7638 When the tags file is not sorted, or sorted in a wrong way (not on
7639 ASCII byte value), 'tagbsearch' should be off, or the line given above
7640 must be included in the tags file.
7641 This option doesn't affect commands that find all matching tags (e.g.,
7642 command-line completion and ":help").
Bram Moolenaar071d4272004-06-13 20:20:40 +00007643
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007644 *'tagcase'* *'tc'*
7645'tagcase' 'tc' string (default "followic")
7646 global or local to buffer |global-local|
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007647 This option specifies how case is handled when searching the tags
7648 file:
7649 followic Follow the 'ignorecase' option
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007650 followscs Follow the 'smartcase' and 'ignorecase' options
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007651 ignore Ignore case
7652 match Match case
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007653 smart Ignore case unless an upper case letter is used
Bram Moolenaar036986f2017-03-16 17:41:02 +01007654 NOTE: This option is set to the Vi default value when 'compatible' is
7655 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007656
Bram Moolenaar45e18cb2019-04-28 18:05:35 +02007657 *'tagfunc'* *'tfu'*
7658'tagfunc' 'tfu' string (default: empty)
7659 local to buffer
7660 {not available when compiled without the |+eval|
7661 feature}
7662 This option specifies a function to be used to perform tag searches.
7663 The function gets the tag pattern and should return a List of matching
7664 tags. See |tag-function| for an explanation of how to write the
7665 function and an example.
7666
Bram Moolenaar071d4272004-06-13 20:20:40 +00007667 *'taglength'* *'tl'*
7668'taglength' 'tl' number (default 0)
7669 global
7670 If non-zero, tags are significant up to this number of characters.
7671
7672 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
7673'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
7674 global
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00007675 If on and using a tags file in another directory, file names in that
7676 tags file are relative to the directory where the tags file is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007677 NOTE: This option is set to the Vi default value when 'compatible' is
7678 set and to the Vim default value when 'compatible' is reset.
7679
7680 *'tags'* *'tag'* *E433*
7681'tags' 'tag' string (default "./tags,tags", when compiled with
7682 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
7683 global or local to buffer |global-local|
7684 Filenames for the tag command, separated by spaces or commas. To
7685 include a space or comma in a file name, precede it with a backslash
7686 (see |option-backslash| about including spaces and backslashes).
7687 When a file name starts with "./", the '.' is replaced with the path
7688 of the current file. But only when the 'd' flag is not included in
7689 'cpoptions'. Environment variables are expanded |:set_env|. Also see
7690 |tags-option|.
7691 "*", "**" and other wildcards can be used to search for tags files in
Bram Moolenaare2b590e2010-08-08 18:29:48 +02007692 a directory tree. See |file-searching|. E.g., "/lib/**/tags" will
7693 find all files named "tags" below "/lib". The filename itself cannot
7694 contain wildcards, it is used as-is. E.g., "/lib/**/tags?" will find
7695 files called "tags?". {not available when compiled without the
7696 |+path_extra| feature}
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00007697 The |tagfiles()| function can be used to get a list of the file names
7698 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007699 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
7700 files are also supported. They are automatically recognized. The
7701 default value becomes "./tags,./TAGS,tags,TAGS", unless case
7702 differences are ignored (MS-Windows). |emacs-tags|
7703 The use of |:set+=| and |:set-=| is preferred when adding or removing
7704 file names from the list. This avoids problems when a future version
7705 uses another default.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007706
7707 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
7708'tagstack' 'tgst' boolean (default on)
7709 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007710 When on, the |tagstack| is used normally. When off, a ":tag" or
7711 ":tselect" command with an argument will not push the tag onto the
7712 tagstack. A following ":tag" without an argument, a ":pop" command or
7713 any other command that uses the tagstack will use the unmodified
7714 tagstack, but does change the pointer to the active entry.
7715 Resetting this option is useful when using a ":tag" command in a
7716 mapping which should not change the tagstack.
7717
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007718 *'tcldll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01007719'tcldll' string (default depends on the build)
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007720 global
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007721 {only available when compiled with the |+tcl/dyn|
7722 feature}
7723 Specifies the name of the Tcl shared library. The default is
7724 DYNAMIC_TCL_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02007725 Environment variables are expanded |:set_env|.
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007726 This option cannot be set from a |modeline| or in the |sandbox|, for
7727 security reasons.
7728
Bram Moolenaar071d4272004-06-13 20:20:40 +00007729 *'term'* *E529* *E530* *E531*
7730'term' string (default is $TERM, if that fails:
7731 in the GUI: "builtin_gui"
7732 on Amiga: "amiga"
Bram Moolenaarb3f74062020-02-26 16:16:53 +01007733 on Haiku: "xterm"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007734 on Mac: "mac-ansi"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007735 on Unix: "ansi"
7736 on VMS: "ansi"
7737 on Win 32: "win32")
7738 global
7739 Name of the terminal. Used for choosing the terminal control
7740 characters. Environment variables are expanded |:set_env|.
7741 For example: >
7742 :set term=$TERM
7743< See |termcap|.
7744
7745 *'termbidi'* *'tbidi'*
7746 *'notermbidi'* *'notbidi'*
7747'termbidi' 'tbidi' boolean (default off, on for "mlterm")
7748 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007749 {only available when compiled with the |+arabic|
7750 feature}
7751 The terminal is in charge of Bi-directionality of text (as specified
7752 by Unicode). The terminal is also expected to do the required shaping
7753 that some languages (such as Arabic) require.
7754 Setting this option implies that 'rightleft' will not be set when
7755 'arabic' is set and the value of 'arabicshape' will be ignored.
7756 Note that setting 'termbidi' has the immediate effect that
7757 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
7758 This option is reset when the GUI is started.
7759 For further details see |arabic.txt|.
7760
7761 *'termencoding'* *'tenc'*
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02007762'termencoding' 'tenc' string (default ""; with GTK+ GUI: "utf-8")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007763 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007764 Encoding used for the terminal. This specifies what character
7765 encoding the keyboard produces and the display will understand. For
Bram Moolenaar3848e002016-03-19 18:42:29 +01007766 the GUI it only applies to the keyboard ('encoding' is used for the
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02007767 display).
Bram Moolenaar4b7cdca2020-01-01 16:18:38 +01007768 *E617* *E950*
Bram Moolenaar3df01732017-02-17 22:47:16 +01007769 Note: This does not apply to the GTK+ GUI. After the GUI has been
Bram Moolenaar071d4272004-06-13 20:20:40 +00007770 successfully initialized, 'termencoding' is forcibly set to "utf-8".
7771 Any attempts to set a different value will be rejected, and an error
7772 message is shown.
Bram Moolenaarac360bf2015-09-01 20:31:20 +02007773 For the Win32 GUI and console versions 'termencoding' is not used,
Bram Moolenaar071d4272004-06-13 20:20:40 +00007774 because the Win32 system always passes Unicode characters.
7775 When empty, the same encoding is used as for the 'encoding' option.
7776 This is the normal value.
7777 Not all combinations for 'termencoding' and 'encoding' are valid. See
7778 |encoding-table|.
7779 The value for this option must be supported by internal conversions or
7780 iconv(). When this is not possible no conversion will be done and you
7781 will probably experience problems with non-ASCII characters.
7782 Example: You are working with the locale set to euc-jp (Japanese) and
7783 want to edit a UTF-8 file: >
7784 :let &termencoding = &encoding
7785 :set encoding=utf-8
7786< You need to do this when your system has no locale support for UTF-8.
7787
Bram Moolenaarcafafb32018-02-22 21:07:09 +01007788 *'termguicolors'* *'tgc'* *E954*
Bram Moolenaar61be73b2016-04-29 22:59:22 +02007789'termguicolors' 'tgc' boolean (default off)
7790 global
Bram Moolenaar61be73b2016-04-29 22:59:22 +02007791 {not available when compiled without the
7792 |+termguicolors| feature}
7793 When on, uses |highlight-guifg| and |highlight-guibg| attributes in
Bram Moolenaarcafafb32018-02-22 21:07:09 +01007794 the terminal (thus using 24-bit color).
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01007795
Bram Moolenaarcafafb32018-02-22 21:07:09 +01007796 Requires a ISO-8613-3 compatible terminal. If setting this option
7797 does not work (produces a colorless UI) reading |xterm-true-color|
7798 might help.
7799
7800 For Win32 console, Windows 10 version 1703 (Creators Update) or later
7801 is required. Use this check to find out: >
7802 if has('vcon')
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01007803< This requires Vim to be built with the |+vtp| feature.
7804
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +02007805 Note that the "cterm" attributes are still used, not the "gui" ones.
Bram Moolenaar036986f2017-03-16 17:41:02 +01007806 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar61be73b2016-04-29 22:59:22 +02007807
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02007808 *'termwinkey'* *'twk'*
7809'termwinkey' 'twk' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02007810 local to window
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007811 The key that starts a CTRL-W command in a terminal window. Other keys
Bram Moolenaar74675a62017-07-15 13:53:23 +02007812 are sent to the job running in the window.
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007813 The <> notation can be used, e.g.: >
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02007814 :set termwinkey=<C-L>
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007815< The string must be one key stroke but can be multiple bytes.
7816 When not set CTRL-W is used, so that CTRL-W : gets you to the command
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02007817 line. If 'termwinkey' is set to CTRL-L then CTRL-L : gets you to the
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007818 command line.
Bram Moolenaar74675a62017-07-15 13:53:23 +02007819
Bram Moolenaar6c60f472019-04-28 16:00:35 +02007820 *'termwinscroll'* *'twsl'*
7821'termwinscroll' 'twsl' number (default 10000)
7822 local to buffer
7823 {not available when compiled without the
7824 |+terminal| feature}
7825 Number of scrollback lines to keep. When going over this limit the
7826 first 10% of the scrollback lines are deleted. This is just to reduce
7827 the memory usage. See |Terminal-Normal|.
7828
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02007829 *'termwinsize'* *'tws'*
7830'termwinsize' 'tws' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02007831 local to window
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02007832 Size used when opening the |terminal| window. Format:
7833 {rows}x{columns} or {rows}*{columns}.
Bram Moolenaar74675a62017-07-15 13:53:23 +02007834 - When empty the terminal gets the size from the window.
Bram Moolenaar498c2562018-04-15 23:45:15 +02007835 - When set with a "x" (e.g., "24x80") the terminal size is not
7836 adjusted to the window size. If the window is smaller only the
7837 top-left part is displayed.
7838 - When set with a "*" (e.g., "10*50") the terminal size follows the
7839 window size, but will not be smaller than the specified rows and/or
7840 columns.
7841 - When rows is zero then use the height of the window.
7842 - When columns is zero then use the width of the window.
7843 - Using "0x0" or "0*0" is the same as empty.
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02007844 - Can be overruled in the |term_start()| options with "term_rows" and
7845 "term_cols".
Bram Moolenaar498c2562018-04-15 23:45:15 +02007846
7847 Examples:
7848 "30x0" uses 30 rows and the current window width.
7849 "20*0" uses at least 20 rows and the current window width.
7850 "0*40" uses the current window height and at least 40 columns.
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02007851 Note that the command running in the terminal window may still change
7852 the size of the terminal. In that case the Vim window will be
7853 adjusted to that size, if possible.
Bram Moolenaar74675a62017-07-15 13:53:23 +02007854
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01007855 *'termwintype'* *'twt'*
7856'termwintype' 'twt' string (default "")
7857 global
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01007858 {only available when compiled with the |terminal|
7859 feature on MS-Windows}
7860 Specify the virtual console (pty) used when opening the terminal
7861 window.
7862
7863 Possible values are:
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01007864 "" use ConPTY if it is stable, winpty otherwise
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01007865 "winpty" use winpty, fail if not supported
7866 "conpty" use |ConPTY|, fail if not supported
7867
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01007868 |ConPTY| support depends on the platform. Windows 10 October 2018
7869 Update is the first version that supports ConPTY, however it is still
7870 considered unstable. ConPTY might become stable in the next release
7871 of Windows 10. winpty support needs to be installed. If neither is
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01007872 supported then you cannot open a terminal window.
7873
Bram Moolenaar071d4272004-06-13 20:20:40 +00007874 *'terse'* *'noterse'*
7875'terse' boolean (default off)
7876 global
7877 When set: Add 's' flag to 'shortmess' option (this makes the message
7878 for a search that hits the start or end of the file not being
7879 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
7880 shortens a lot of messages}
7881
7882 *'textauto'* *'ta'* *'notextauto'* *'nota'*
7883'textauto' 'ta' boolean (Vim default: on, Vi default: off)
7884 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007885 This option is obsolete. Use 'fileformats'.
7886 For backwards compatibility, when 'textauto' is set, 'fileformats' is
7887 set to the default value for the current system. When 'textauto' is
7888 reset, 'fileformats' is made empty.
7889 NOTE: This option is set to the Vi default value when 'compatible' is
7890 set and to the Vim default value when 'compatible' is reset.
7891
7892 *'textmode'* *'tx'* *'notextmode'* *'notx'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01007893'textmode' 'tx' boolean (Win32: default on,
Bram Moolenaar071d4272004-06-13 20:20:40 +00007894 others: default off)
7895 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007896 This option is obsolete. Use 'fileformat'.
7897 For backwards compatibility, when 'textmode' is set, 'fileformat' is
7898 set to "dos". When 'textmode' is reset, 'fileformat' is set to
7899 "unix".
7900
7901 *'textwidth'* *'tw'*
7902'textwidth' 'tw' number (default 0)
7903 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007904 Maximum width of text that is being inserted. A longer line will be
7905 broken after white space to get this width. A zero value disables
Bram Moolenaarca635012015-09-25 20:34:21 +02007906 this.
7907 'textwidth' is set to 0 when the 'paste' option is set and restored
7908 when 'paste' is reset.
7909 When 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00007910 'formatoptions' and |ins-textwidth|.
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00007911 When 'formatexpr' is set it will be used to break the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007912 NOTE: This option is set to 0 when 'compatible' is set.
7913
7914 *'thesaurus'* *'tsr'*
7915'thesaurus' 'tsr' string (default "")
7916 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007917 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01007918 for thesaurus completion commands |i_CTRL-X_CTRL-T|.
7919
7920 Each line in the file should contain words with similar meaning,
7921 separated by non-keyword characters (white space is preferred).
7922 Maximum line length is 510 bytes.
7923
Bram Moolenaard47d5222018-12-09 20:43:55 +01007924 An English word list was added to this github issue:
7925 https://github.com/vim/vim/issues/629#issuecomment-443293282
7926 Unpack thesaurus_pkg.zip, put the thesaurus.txt file somewhere, e.g.
7927 ~/.vim/thesaurus/english.txt, and the 'thesaurus' option to this file
7928 name.
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01007929
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007930 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00007931 after a comma are ignored, otherwise spaces are included in the file
7932 name. See |option-backslash| about using backslashes.
7933 The use of |:set+=| and |:set-=| is preferred when adding or removing
7934 directories from the list. This avoids problems when a future version
7935 uses another default.
7936 Backticks cannot be used in this option for security reasons.
7937
7938 *'tildeop'* *'top'* *'notildeop'* *'notop'*
7939'tildeop' 'top' boolean (default off)
7940 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007941 When on: The tilde command "~" behaves like an operator.
7942 NOTE: This option is reset when 'compatible' is set.
7943
7944 *'timeout'* *'to'* *'notimeout'* *'noto'*
7945'timeout' 'to' boolean (default on)
7946 global
7947 *'ttimeout'* *'nottimeout'*
Bram Moolenaar94237492017-04-23 18:40:21 +02007948'ttimeout' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007949 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007950 These two options together determine the behavior when part of a
7951 mapped key sequence or keyboard code has been received:
7952
7953 'timeout' 'ttimeout' action ~
7954 off off do not time out
7955 on on or off time out on :mappings and key codes
7956 off on time out on key codes
7957
7958 If both options are off, Vim will wait until either the complete
7959 mapping or key sequence has been received, or it is clear that there
7960 is no mapping or key sequence for the received characters. For
7961 example: if you have mapped "vl" and Vim has received 'v', the next
7962 character is needed to see if the 'v' is followed by an 'l'.
7963 When one of the options is on, Vim will wait for about 1 second for
7964 the next character to arrive. After that the already received
7965 characters are interpreted as single characters. The waiting time can
7966 be changed with the 'timeoutlen' option.
7967 On slow terminals or very busy systems timing out may cause
7968 malfunctioning cursor keys. If both options are off, Vim waits
7969 forever after an entered <Esc> if there are key codes that start
7970 with <Esc>. You will have to type <Esc> twice. If you do not have
7971 problems with key codes, but would like to have :mapped key
7972 sequences not timing out in 1 second, set the 'ttimeout' option and
7973 reset the 'timeout' option.
7974
7975 NOTE: 'ttimeout' is reset when 'compatible' is set.
7976
7977 *'timeoutlen'* *'tm'*
7978'timeoutlen' 'tm' number (default 1000)
7979 global
Bram Moolenaar25c9c682019-05-05 18:13:34 +02007980
Bram Moolenaar071d4272004-06-13 20:20:40 +00007981 *'ttimeoutlen'* *'ttm'*
Bram Moolenaar94237492017-04-23 18:40:21 +02007982'ttimeoutlen' 'ttm' number (default -1, set to 100 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007983 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007984 The time in milliseconds that is waited for a key code or mapped key
7985 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
7986 when part of a command has been typed.
7987 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
7988 different timeout value for key codes is desired set 'ttimeoutlen' to
7989 a non-negative number.
7990
7991 ttimeoutlen mapping delay key code delay ~
7992 < 0 'timeoutlen' 'timeoutlen'
7993 >= 0 'timeoutlen' 'ttimeoutlen'
7994
7995 The timeout only happens when the 'timeout' and 'ttimeout' options
7996 tell so. A useful setting would be >
7997 :set timeout timeoutlen=3000 ttimeoutlen=100
7998< (time out on mapping after three seconds, time out on key codes after
7999 a tenth of a second).
8000
8001 *'title'* *'notitle'*
8002'title' boolean (default off, on when title can be restored)
8003 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008004 {not available when compiled without the |+title|
8005 feature}
8006 When on, the title of the window will be set to the value of
8007 'titlestring' (if it is not empty), or to:
8008 filename [+=-] (path) - VIM
8009 Where:
8010 filename the name of the file being edited
8011 - indicates the file cannot be modified, 'ma' off
8012 + indicates the file was modified
8013 = indicates the file is read-only
8014 =+ indicates the file is read-only and modified
8015 (path) is the path of the file being edited
8016 - VIM the server name |v:servername| or "VIM"
8017 Only works if the terminal supports setting window titles
8018 (currently Amiga console, Win32 console, all GUI versions and
Bram Moolenaard1caa942020-04-10 22:10:56 +02008019 terminals with a non-empty 't_ts' option - these are Unix xterm and
Bram Moolenaar071d4272004-06-13 20:20:40 +00008020 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
8021 *X11*
8022 When Vim was compiled with HAVE_X11 defined, the original title will
8023 be restored if possible. The output of ":version" will include "+X11"
8024 when HAVE_X11 was defined, otherwise it will be "-X11". This also
8025 works for the icon name |'icon'|.
8026 But: When Vim was started with the |-X| argument, restoring the title
8027 will not work (except in the GUI).
8028 If the title cannot be restored, it is set to the value of 'titleold'.
8029 You might want to restore the title outside of Vim then.
8030 When using an xterm from a remote machine you can use this command:
8031 rsh machine_name xterm -display $DISPLAY &
8032 then the WINDOWID environment variable should be inherited and the
8033 title of the window should change back to what it should be after
8034 exiting Vim.
8035
8036 *'titlelen'*
8037'titlelen' number (default 85)
8038 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008039 {not available when compiled without the |+title|
8040 feature}
8041 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008042 title. When the title is longer, only the end of the path name is
8043 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008044 Using a percentage makes this adapt to the width of the window. But
8045 it won't work perfectly, because the actual number of characters
8046 available also depends on the font used and other things in the title
8047 bar. When 'titlelen' is zero the full path is used. Otherwise,
8048 values from 1 to 30000 percent can be used.
8049 'titlelen' is also used for the 'titlestring' option.
8050
8051 *'titleold'*
8052'titleold' string (default "Thanks for flying Vim")
8053 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008054 {only available when compiled with the |+title|
8055 feature}
8056 This option will be used for the window title when exiting Vim if the
8057 original title cannot be restored. Only happens if 'title' is on or
8058 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00008059 This option cannot be set from a |modeline| or in the |sandbox|, for
8060 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008061 *'titlestring'*
8062'titlestring' string (default "")
8063 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008064 {not available when compiled without the |+title|
8065 feature}
8066 When this option is not empty, it will be used for the title of the
8067 window. This happens only when the 'title' option is on.
8068 Only works if the terminal supports setting window titles (currently
8069 Amiga console, Win32 console, all GUI versions and terminals with a
8070 non-empty 't_ts' option).
8071 When Vim was compiled with HAVE_X11 defined, the original title will
Bram Moolenaar51628222016-12-01 23:03:28 +01008072 be restored if possible, see |X11|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008073
Bram Moolenaar071d4272004-06-13 20:20:40 +00008074 When this option contains printf-style '%' items, they will be
8075 expanded according to the rules used for 'statusline'.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008076 This option cannot be set in a modeline when 'modelineexpr' is off.
8077
Bram Moolenaar071d4272004-06-13 20:20:40 +00008078 Example: >
8079 :auto BufEnter * let &titlestring = hostname() . "/" . expand("%:p")
8080 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
8081< The value of 'titlelen' is used to align items in the middle or right
8082 of the available space.
8083 Some people prefer to have the file name first: >
8084 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
8085< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008086 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00008087 separating space only when needed.
8088 NOTE: Use of special characters in 'titlestring' may cause the display
8089 to be garbled (e.g., when it contains a CR or NL character).
8090 {not available when compiled without the |+statusline| feature}
8091
8092 *'toolbar'* *'tb'*
8093'toolbar' 'tb' string (default "icons,tooltips")
8094 global
8095 {only for |+GUI_GTK|, |+GUI_Athena|, |+GUI_Motif| and
8096 |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008097 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00008098 possible values are:
8099 icons Toolbar buttons are shown with icons.
8100 text Toolbar buttons shown with text.
8101 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008102 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008103 tooltips Tooltips are active for toolbar buttons.
8104 Tooltips refer to the popup help text which appears after the mouse
8105 cursor is placed over a toolbar button for a brief moment.
8106
8107 If you want the toolbar to be shown with icons as well as text, do the
8108 following: >
8109 :set tb=icons,text
8110< Motif and Athena cannot display icons and text at the same time. They
8111 will show icons if both are requested.
8112
8113 If none of the strings specified in 'toolbar' are valid or if
8114 'toolbar' is empty, this option is ignored. If you want to disable
8115 the toolbar, you need to set the 'guioptions' option. For example: >
8116 :set guioptions-=T
8117< Also see |gui-toolbar|.
8118
8119 *'toolbariconsize'* *'tbis'*
8120'toolbariconsize' 'tbis' string (default "small")
8121 global
Bram Moolenaar3df01732017-02-17 22:47:16 +01008122 {only in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008123 Controls the size of toolbar icons. The possible values are:
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008124 tiny Use tiny icons.
8125 small Use small icons (default).
8126 medium Use medium-sized icons.
8127 large Use large icons.
8128 huge Use even larger icons.
8129 giant Use very big icons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008130 The exact dimensions in pixels of the various icon sizes depend on
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008131 the current theme. Common dimensions are giant=48x48, huge=32x32,
8132 large=24x24, medium=24x24, small=20x20 and tiny=16x16.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008133
8134 If 'toolbariconsize' is empty, the global default size as determined
8135 by user preferences or the current theme is used.
8136
8137 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
8138'ttybuiltin' 'tbi' boolean (default on)
8139 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008140 When on, the builtin termcaps are searched before the external ones.
8141 When off the builtin termcaps are searched after the external ones.
8142 When this option is changed, you should set the 'term' option next for
8143 the change to take effect, for example: >
8144 :set notbi term=$TERM
8145< See also |termcap|.
8146 Rationale: The default for this option is "on", because the builtin
8147 termcap entries are generally better (many systems contain faulty
8148 xterm entries...).
8149
8150 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
8151'ttyfast' 'tf' boolean (default off, on when 'term' is xterm, hpterm,
8152 sun-cmd, screen, rxvt, dtterm or
8153 iris-ansi; also on when running Vim in
8154 a DOS console)
8155 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008156 Indicates a fast terminal connection. More characters will be sent to
8157 the screen for redrawing, instead of using insert/delete line
8158 commands. Improves smoothness of redrawing when there are multiple
8159 windows and the terminal does not support a scrolling region.
8160 Also enables the extra writing of characters at the end of each screen
8161 line for lines that wrap. This helps when using copy/paste with the
8162 mouse in an xterm and other terminals.
8163
8164 *'ttymouse'* *'ttym'*
8165'ttymouse' 'ttym' string (default depends on 'term')
8166 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008167 {only in Unix and VMS, doesn't work in the GUI; not
8168 available when compiled without |+mouse|}
8169 Name of the terminal type for which mouse codes are to be recognized.
Bram Moolenaar2c7a7632007-05-10 18:19:11 +00008170 Currently these strings are valid:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008171 *xterm-mouse*
8172 xterm xterm-like mouse handling. The mouse generates
8173 "<Esc>[Mscr", where "scr" is three bytes:
8174 "s" = button state
8175 "c" = column plus 33
8176 "r" = row plus 33
Bram Moolenaare968e362014-05-13 20:23:24 +02008177 This only works up to 223 columns! See "dec",
8178 "urxvt", and "sgr" for solutions.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008179 xterm2 Works like "xterm", but with the xterm reporting the
8180 mouse position while the mouse is dragged. This works
8181 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00008182 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00008183 work. See below for how Vim detects this
8184 automatically.
8185 *netterm-mouse*
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008186 netterm NetTerm mouse handling. A left mouse click generates
Bram Moolenaar071d4272004-06-13 20:20:40 +00008187 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008188 for the row and column. No other mouse events are
8189 supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008190 *dec-mouse*
8191 dec DEC terminal mouse handling. The mouse generates a
8192 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00008193 This is also available for an Xterm, if it was
8194 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00008195 *jsbterm-mouse*
8196 jsbterm JSB term mouse handling.
8197 *pterm-mouse*
8198 pterm QNX pterm mouse handling.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008199 *urxvt-mouse*
8200 urxvt Mouse handling for the urxvt (rxvt-unicode) terminal.
Bram Moolenaare968e362014-05-13 20:23:24 +02008201 The mouse works only if the terminal supports this
8202 encoding style, but it does not have 223 columns limit
8203 unlike "xterm" or "xterm2".
Bram Moolenaar9b451252012-08-15 17:43:31 +02008204 *sgr-mouse*
8205 sgr Mouse handling for the terminal that emits SGR-styled
Bram Moolenaare968e362014-05-13 20:23:24 +02008206 mouse reporting. The mouse works even in columns
8207 beyond 223. This option is backward compatible with
8208 "xterm2" because it can also decode "xterm2" style
8209 mouse codes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008210
8211 The mouse handling must be enabled at compile time |+mouse_xterm|
Bram Moolenaare968e362014-05-13 20:23:24 +02008212 |+mouse_dec| |+mouse_netterm| |+mouse_jsbterm| |+mouse_urxvt|
8213 |+mouse_sgr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008214 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
8215 recognized, if enabled at compile time. DEC terminal mouse codes
8216 are recognized if enabled at compile time, and 'ttymouse' is not
Bram Moolenaare968e362014-05-13 20:23:24 +02008217 "xterm", "xterm2", "urxvt" or "sgr" (because dec mouse codes conflict
8218 with them).
Bram Moolenaar071d4272004-06-13 20:20:40 +00008219 This option is automatically set to "xterm", when the 'term' option is
Bram Moolenaar45758762016-10-12 23:08:06 +02008220 set to a name that starts with "xterm", "mlterm", "screen", "tmux",
8221 "st" (full match only), "st-" or "stterm", and 'ttymouse' is not set
8222 already.
Bram Moolenaare968e362014-05-13 20:23:24 +02008223 Additionally, if vim is compiled with the |+termresponse| feature and
8224 |t_RV| is set to the escape sequence to request the xterm version
Bram Moolenaarf8a07122019-07-01 22:06:07 +02008225 number, more intelligent detection is done.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008226 The "xterm2" value will be set if the xterm version is reported to be
Bram Moolenaard47d5222018-12-09 20:43:55 +01008227 from 95 to 276. The "sgr" value will be set if Vim detects Mac
8228 Terminal.app, iTerm2 or mintty, and when the xterm version is 277 or
8229 higher.
Bram Moolenaare968e362014-05-13 20:23:24 +02008230 If you do not want 'ttymouse' to be set to "xterm2" or "sgr"
8231 automatically, set t_RV to an empty string: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008232 :set t_RV=
8233<
8234 *'ttyscroll'* *'tsl'*
8235'ttyscroll' 'tsl' number (default 999)
8236 global
8237 Maximum number of lines to scroll the screen. If there are more lines
8238 to scroll the window is redrawn. For terminals where scrolling is
8239 very slow and redrawing is not slow this can be set to a small number,
8240 e.g., 3, to speed up displaying.
8241
8242 *'ttytype'* *'tty'*
8243'ttytype' 'tty' string (default from $TERM)
8244 global
8245 Alias for 'term', see above.
8246
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008247 *'undodir'* *'udir'*
8248'undodir' 'udir' string (default ".")
8249 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008250 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008251 List of directory names for undo files, separated with commas.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008252 See |'backupdir'| for details of the format.
Bram Moolenaar6a244fe2010-05-24 22:02:24 +02008253 "." means using the directory of the file. The undo file name for
8254 "file.txt" is ".file.txt.un~".
8255 For other directories the file name is the full path of the edited
8256 file, with path separators replaced with "%".
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008257 When writing: The first directory that exists is used. "." always
8258 works, no directories after "." will be used for writing.
8259 When reading all entries are tried to find an undo file. The first
8260 undo file that exists is used. When it cannot be read an error is
8261 given, no further entry is used.
8262 See |undo-persistence|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008263 This option cannot be set from a |modeline| or in the |sandbox|, for
8264 security reasons.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008265
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02008266 *'undofile'* *'noundofile'* *'udf'* *'noudf'*
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008267'undofile' 'udf' boolean (default off)
8268 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02008269 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008270 When on, Vim automatically saves undo history to an undo file when
8271 writing a buffer to a file, and restores undo history from the same
8272 file on buffer read.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008273 The directory where the undo file is stored is specified by 'undodir'.
8274 For more information about this feature see |undo-persistence|.
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008275 The undo file is not read when 'undoreload' causes the buffer from
8276 before a reload to be saved for undo.
Bram Moolenaar97d62492012-11-15 21:28:22 +01008277 When 'undofile' is turned off the undo file is NOT deleted.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008278 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008279
Bram Moolenaar071d4272004-06-13 20:20:40 +00008280 *'undolevels'* *'ul'*
Bram Moolenaar8024f932020-01-14 19:29:13 +01008281'undolevels' 'ul' number (default 100, 1000 for Unix, VMS and Win32)
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008282 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008283 Maximum number of changes that can be undone. Since undo information
Bram Moolenaar5be4cee2019-09-27 19:34:08 +02008284 is kept in memory, higher numbers will cause more memory to be used.
8285 Nevertheless, a single change can already use a large amount of memory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008286 Set to 0 for Vi compatibility: One level of undo and "u" undoes
8287 itself: >
8288 set ul=0
8289< But you can also get Vi compatibility by including the 'u' flag in
8290 'cpoptions', and still be able to use CTRL-R to repeat undo.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008291 Also see |undo-two-ways|.
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008292 Set to -1 for no undo at all. You might want to do this only for the
8293 current buffer: >
8294 setlocal ul=-1
Bram Moolenaar071d4272004-06-13 20:20:40 +00008295< This helps when you run out of memory for a single change.
Bram Moolenaar32efaf62014-11-05 17:02:17 +01008296
8297 The local value is set to -123456 when the global value is to be used.
8298
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008299 Also see |clear-undo|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008300
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008301 *'undoreload'* *'ur'*
8302'undoreload' 'ur' number (default 10000)
8303 global
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008304 Save the whole buffer for undo when reloading it. This applies to the
8305 ":e!" command and reloading for when the buffer changed outside of
8306 Vim. |FileChangedShell|
Bram Moolenaar24a98a02017-09-27 22:23:55 +02008307 The save only happens when this option is negative or when the number
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008308 of lines is smaller than the value of this option.
8309 Set this option to zero to disable undo for a reload.
8310
8311 When saving undo for a reload, any undo file is not read.
8312
8313 Note that this causes the whole buffer to be stored in memory. Set
8314 this option to a lower value if you run out of memory.
8315
Bram Moolenaar071d4272004-06-13 20:20:40 +00008316 *'updatecount'* *'uc'*
8317'updatecount' 'uc' number (default: 200)
8318 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008319 After typing this many characters the swap file will be written to
8320 disk. When zero, no swap file will be created at all (see chapter on
8321 recovery |crash-recovery|). 'updatecount' is set to zero by starting
8322 Vim with the "-n" option, see |startup|. When editing in readonly
8323 mode this option will be initialized to 10000.
8324 The swapfile can be disabled per buffer with |'swapfile'|.
8325 When 'updatecount' is set from zero to non-zero, swap files are
8326 created for all buffers that have 'swapfile' set. When 'updatecount'
8327 is set to zero, existing swap files are not deleted.
8328 Also see |'swapsync'|.
8329 This option has no meaning in buffers where |'buftype'| is "nofile"
8330 or "nowrite".
8331
8332 *'updatetime'* *'ut'*
8333'updatetime' 'ut' number (default 4000)
8334 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008335 If this many milliseconds nothing is typed the swap file will be
8336 written to disk (see |crash-recovery|). Also used for the
8337 |CursorHold| autocommand event.
8338
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008339 *'varsofttabstop'* *'vsts'*
8340'varsofttabstop' 'vsts' string (default "")
8341 local to buffer
8342 {only available when compiled with the |+vartabs|
8343 feature}
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008344 A list of the number of spaces that a <Tab> counts for while editing,
8345 such as inserting a <Tab> or using <BS>. It "feels" like variable-
8346 width <Tab>s are being inserted, while in fact a mixture of spaces
8347 and <Tab>s is used. Tab widths are separated with commas, with the
8348 final value applying to all subsequent tabs.
8349
8350 For example, when editing assembly language files where statements
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02008351 start in the 9th column and comments in the 41st, it may be useful
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008352 to use the following: >
8353 :set varsofttabstop=8,32,8
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02008354< This will set soft tabstops with 8 and 8 + 32 spaces, and 8 more
8355 for every column thereafter.
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008356
8357 Note that the value of |'softtabstop'| will be ignored while
8358 'varsofttabstop' is set.
8359
8360 *'vartabstop'* *'vts'*
8361'vartabstop' 'vts' string (default "")
8362 local to buffer
8363 {only available when compiled with the |+vartabs|
8364 feature}
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008365 A list of the number of spaces that a <Tab> in the file counts for,
8366 separated by commas. Each value corresponds to one tab, with the
8367 final value applying to all subsequent tabs. For example: >
8368 :set vartabstop=4,20,10,8
8369< This will make the first tab 4 spaces wide, the second 20 spaces,
8370 the third 10 spaces, and all following tabs 8 spaces.
8371
8372 Note that the value of |'tabstop'| will be ignored while 'vartabstop'
8373 is set.
8374
Bram Moolenaar071d4272004-06-13 20:20:40 +00008375 *'verbose'* *'vbs'*
8376'verbose' 'vbs' number (default 0)
8377 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008378 When bigger than zero, Vim will give messages about what it is doing.
8379 Currently, these messages are given:
8380 >= 1 When the viminfo file is read or written.
8381 >= 2 When a file is ":source"'ed.
Bram Moolenaar647a5302020-05-03 17:01:24 +02008382 >= 4 Shell commands.
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008383 >= 5 Every searched tags file and include file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008384 >= 8 Files for which a group of autocommands is executed.
8385 >= 9 Every executed autocommand.
Bram Moolenaar647a5302020-05-03 17:01:24 +02008386 >= 11 Finding items in a path
Bram Moolenaar071d4272004-06-13 20:20:40 +00008387 >= 12 Every executed function.
8388 >= 13 When an exception is thrown, caught, finished, or discarded.
8389 >= 14 Anything pending in a ":finally" clause.
Bram Moolenaar823654b2020-05-29 23:03:09 +02008390 >= 15 Every executed Ex command from a script (truncated at 200
8391 characters).
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02008392 >= 16 Every executed Ex command.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008393
8394 This option can also be set with the "-V" argument. See |-V|.
8395 This option is also set by the |:verbose| command.
8396
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008397 When the 'verbosefile' option is set then the verbose messages are not
8398 displayed.
8399
8400 *'verbosefile'* *'vfile'*
8401'verbosefile' 'vfile' string (default empty)
8402 global
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008403 When not empty all messages are written in a file with this name.
8404 When the file exists messages are appended.
8405 Writing to the file ends when Vim exits or when 'verbosefile' is made
Bram Moolenaar80794b12010-06-13 05:20:42 +02008406 empty. Writes are buffered, thus may not show up for some time.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008407 Setting 'verbosefile' to a new value is like making it empty first.
8408 The difference with |:redir| is that verbose messages are not
8409 displayed when 'verbosefile' is set.
8410
Bram Moolenaar071d4272004-06-13 20:20:40 +00008411 *'viewdir'* *'vdir'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008412'viewdir' 'vdir' string (default for Amiga and Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008413 "$VIM/vimfiles/view",
8414 for Unix: "~/.vim/view",
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02008415 for macOS: "$VIM:vimfiles:view"
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01008416 for VMS: "sys$login:vimfiles/view")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008417 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008418 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008419 feature}
8420 Name of the directory where to store files for |:mkview|.
8421 This option cannot be set from a |modeline| or in the |sandbox|, for
8422 security reasons.
8423
8424 *'viewoptions'* *'vop'*
Bram Moolenaar13e90412017-11-11 18:16:48 +01008425'viewoptions' 'vop' string (default: "folds,options,cursor,curdir")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008426 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008427 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008428 feature}
8429 Changes the effect of the |:mkview| command. It is a comma separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008430 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008431 word save and restore ~
8432 cursor cursor position in file and in window
8433 folds manually created folds, opened/closed folds and local
8434 fold options
8435 options options and mappings local to a window or buffer (not
8436 global values for local options)
Bram Moolenaar6e932462014-09-09 18:48:09 +02008437 localoptions same as "options"
Bram Moolenaar071d4272004-06-13 20:20:40 +00008438 slash backslashes in file names replaced with forward
8439 slashes
8440 unix with Unix end-of-line format (single <NL>), even when
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008441 on MS-Windows
Bram Moolenaar13e90412017-11-11 18:16:48 +01008442 curdir the window-local directory, if set with `:lcd`
Bram Moolenaar071d4272004-06-13 20:20:40 +00008443
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008444 "slash" and "unix" are useful on MS-Windows when sharing view files
Bram Moolenaar071d4272004-06-13 20:20:40 +00008445 with Unix. The Unix version of Vim cannot source dos format scripts,
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008446 but the MS-Windows version of Vim can source unix format scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008447
8448 *'viminfo'* *'vi'* *E526* *E527* *E528*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008449'viminfo' 'vi' string (Vi default: "", Vim default for
8450 MS-Windows: '100,<50,s10,h,rA:,rB:,
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01008451 for Amiga: '100,<50,s10,h,rdf0:,rdf1:,rdf2:
8452 for others: '100,<50,s10,h)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008453 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008454 {not available when compiled without the |+viminfo|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008455 feature}
8456 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008457 when exiting Vim (see |viminfo-file|). Except when 'viminfofile' is
8458 "NONE".
8459 The string should be a comma separated list of parameters, each
8460 consisting of a single character identifying the particular parameter,
8461 followed by a number or string which specifies the value of that
8462 parameter. If a particular character is left out, then the default
8463 value is used for that parameter. The following is a list of the
8464 identifying characters and the effect of their value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008465 CHAR VALUE ~
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008466 *viminfo-!*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008467 ! When included, save and restore global variables that start
8468 with an uppercase letter, and don't contain a lowercase
8469 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar680eeca2010-10-20 17:44:42 +02008470 and "_K_L_M" are not. Nested List and Dict items may not be
Bram Moolenaar166af9b2010-11-16 20:34:40 +01008471 read back correctly, you end up with an empty item.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008472 *viminfo-quote*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008473 " Maximum number of lines saved for each register. Old name of
8474 the '<' item, with the disadvantage that you need to put a
8475 backslash before the ", otherwise it will be recognized as the
8476 start of a comment!
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008477 *viminfo-%*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008478 % When included, save and restore the buffer list. If Vim is
8479 started with a file name argument, the buffer list is not
8480 restored. If Vim is started without a file name argument, the
Bram Moolenaard042dc82015-11-24 19:18:36 +01008481 buffer list is restored from the viminfo file. Quickfix
8482 ('buftype'), unlisted ('buflisted'), unnamed and buffers on
8483 removable media (|viminfo-r|) are not saved.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00008484 When followed by a number, the number specifies the maximum
8485 number of buffers that are stored. Without a number all
8486 buffers are stored.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008487 *viminfo-'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008488 ' Maximum number of previously edited files for which the marks
8489 are remembered. This parameter must always be included when
8490 'viminfo' is non-empty.
8491 Including this item also means that the |jumplist| and the
8492 |changelist| are stored in the viminfo file.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008493 *viminfo-/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008494 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008495 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00008496 patterns are also saved. When not included, the value of
8497 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008498 *viminfo-:*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008499 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008500 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008501 *viminfo-<*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008502 < Maximum number of lines saved for each register. If zero then
8503 registers are not saved. When not included, all lines are
8504 saved. '"' is the old name for this item.
8505 Also see the 's' item below: limit specified in Kbyte.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008506 *viminfo-@*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008507 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008508 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008509 *viminfo-c*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008510 c When included, convert the text in the viminfo file from the
8511 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00008512 'encoding'. See |viminfo-encoding|.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008513 *viminfo-f*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008514 f Whether file marks need to be stored. If zero, file marks ('0
8515 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008516 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00008517 cursor position (when exiting or when doing ":wviminfo").
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008518 *viminfo-h*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008519 h Disable the effect of 'hlsearch' when loading the viminfo
8520 file. When not included, it depends on whether ":nohlsearch"
8521 has been used since the last search command.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008522 *viminfo-n*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008523 n Name of the viminfo file. The name must immediately follow
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008524 the 'n'. Must be at the end of the option! If the
8525 'viminfofile' option is set, that file name overrides the one
8526 given here with 'viminfo'. Environment variables are
Bram Moolenaar063b9d12016-07-09 20:21:48 +02008527 expanded when opening the file, not when setting the option.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008528 *viminfo-r*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008529 r Removable media. The argument is a string (up to the next
8530 ','). This parameter can be given several times. Each
8531 specifies the start of a path for which no marks will be
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01008532 stored. This is to avoid removable media. For MS-Windows you
Bram Moolenaar071d4272004-06-13 20:20:40 +00008533 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
8534 also use it for temp files, e.g., for Unix: "r/tmp". Case is
8535 ignored. Maximum length of each 'r' argument is 50
8536 characters.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008537 *viminfo-s*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008538 s Maximum size of an item in Kbyte. If zero then registers are
8539 not saved. Currently only applies to registers. The default
8540 "s10" will exclude registers with more than 10 Kbyte of text.
8541 Also see the '<' item above: line count limit.
8542
8543 Example: >
8544 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
8545<
8546 '50 Marks will be remembered for the last 50 files you
8547 edited.
8548 <1000 Contents of registers (up to 1000 lines each) will be
8549 remembered.
8550 s100 Registers with more than 100 Kbyte text are skipped.
8551 :0 Command-line history will not be saved.
8552 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
8553 no / Since '/' is not specified, the default will be used,
8554 that is, save all of the search history, and also the
8555 previous search and substitute patterns.
8556 no % The buffer list will not be saved nor read back.
8557 no h 'hlsearch' highlighting will be restored.
8558
8559 When setting 'viminfo' from an empty value you can use |:rviminfo| to
8560 load the contents of the file, this is not done automatically.
8561
8562 This option cannot be set from a |modeline| or in the |sandbox|, for
8563 security reasons.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008564 NOTE: This option is set to the Vim default value when 'compatible'
8565 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008566
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008567 *'viminfofile'* *'vif'*
8568'viminfofile' 'vif' string (default: "")
8569 global
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008570 {not available when compiled without the |+viminfo|
8571 feature}
8572 When non-empty, overrides the file name used for viminfo.
8573 When equal to "NONE" no viminfo file will be read or written.
8574 This option can be set with the |-i| command line flag. The |--clean|
8575 command line flag sets it to "NONE".
Bram Moolenaar110289e2019-05-23 15:38:06 +02008576 This option cannot be set from a |modeline| or in the |sandbox|, for
8577 security reasons.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008578
Bram Moolenaar071d4272004-06-13 20:20:40 +00008579 *'virtualedit'* *'ve'*
8580'virtualedit' 've' string (default "")
8581 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008582 A comma separated list of these words:
8583 block Allow virtual editing in Visual block mode.
8584 insert Allow virtual editing in Insert mode.
8585 all Allow virtual editing in all modes.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008586 onemore Allow the cursor to move just past the end of the line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008587
Bram Moolenaar071d4272004-06-13 20:20:40 +00008588 Virtual editing means that the cursor can be positioned where there is
Bram Moolenaarebcbd022007-05-12 14:28:25 +00008589 no actual character. This can be halfway into a tab or beyond the end
Bram Moolenaar071d4272004-06-13 20:20:40 +00008590 of the line. Useful for selecting a rectangle in Visual mode and
8591 editing a table.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008592 "onemore" is not the same, it will only allow moving the cursor just
8593 after the last character of the line. This makes some commands more
8594 consistent. Previously the cursor was always past the end of the line
8595 if the line was empty. But it is far from Vi compatible. It may also
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008596 break some plugins or Vim scripts. For example because |l| can move
8597 the cursor after the last character. Use with care!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02008598 Using the `$` command will move to the last character in the line, not
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008599 past it. This may actually move the cursor to the left!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02008600 The `g$` command will move to the end of the screen line.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008601 It doesn't make sense to combine "all" with "onemore", but you will
8602 not get a warning for it.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008603 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008604
8605 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
8606'visualbell' 'vb' boolean (default off)
8607 global
Bram Moolenaar74675a62017-07-15 13:53:23 +02008608 Use a visual bell instead of beeping. The terminal code to display the
Bram Moolenaar071d4272004-06-13 20:20:40 +00008609 visual bell is given with 't_vb'. When no beep or flash is wanted,
Bram Moolenaar74675a62017-07-15 13:53:23 +02008610 use: >
8611 :set vb t_vb=
8612< If you want a short flash, you can use this on many terminals: >
8613 :set vb t_vb=[?5h$<100>[?5l
8614< Here $<100> specifies the time, you can use a smaller or bigger value
8615 to get a shorter or longer flash.
8616
8617 Note: Vim will limit the bell to once per half a second. This avoids
8618 having to wait for the flashing to finish when there are lots of
8619 bells, e.g. on key repeat. This also happens without 'visualbell'
8620 set.
8621
Bram Moolenaar071d4272004-06-13 20:20:40 +00008622 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
8623 for 20 msec. If you want to use a different time, use "<Esc>|40f",
8624 where 40 is the time in msec.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008625
8626 Note: When the GUI starts, 't_vb' is reset to its default value. You
8627 might want to set it again in your |gvimrc|.
8628
Bram Moolenaar071d4272004-06-13 20:20:40 +00008629 Does not work on the Amiga, you always get a screen flash.
8630 Also see 'errorbells'.
8631
8632 *'warn'* *'nowarn'*
8633'warn' boolean (default on)
8634 global
8635 Give a warning message when a shell command is used while the buffer
8636 has been changed.
8637
8638 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
8639'weirdinvert' 'wiv' boolean (default off)
8640 global
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00008641 This option has the same effect as the 't_xs' terminal option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008642 It is provided for backwards compatibility with version 4.x.
8643 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
8644 vice versa. Has no effect when the GUI is running.
8645
8646 *'whichwrap'* *'ww'*
8647'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
8648 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008649 Allow specified keys that move the cursor left/right to move to the
8650 previous/next line when the cursor is on the first/last character in
8651 the line. Concatenate characters to allow this for these keys:
8652 char key mode ~
8653 b <BS> Normal and Visual
8654 s <Space> Normal and Visual
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008655 h "h" Normal and Visual (not recommended)
8656 l "l" Normal and Visual (not recommended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008657 < <Left> Normal and Visual
8658 > <Right> Normal and Visual
8659 ~ "~" Normal
8660 [ <Left> Insert and Replace
8661 ] <Right> Insert and Replace
8662 For example: >
8663 :set ww=<,>,[,]
8664< allows wrap only when cursor keys are used.
8665 When the movement keys are used in combination with a delete or change
8666 operator, the <EOL> also counts for a character. This makes "3h"
8667 different from "3dh" when the cursor crosses the end of a line. This
8668 is also true for "x" and "X", because they do the same as "dl" and
8669 "dh". If you use this, you may also want to use the mapping
8670 ":map <BS> X" to make backspace delete the character in front of the
8671 cursor.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00008672 When 'l' is included and it is used after an operator at the end of a
Bram Moolenaar589edb32019-09-20 14:38:13 +02008673 line (not an empty line) then it will not move to the next line. This
8674 makes "dl", "cl", "yl" etc. work normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008675 NOTE: This option is set to the Vi default value when 'compatible' is
8676 set and to the Vim default value when 'compatible' is reset.
8677
8678 *'wildchar'* *'wc'*
8679'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
8680 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008681 Character you have to type to start wildcard expansion in the
8682 command-line, as specified with 'wildmode'.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008683 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008684 The character is not recognized when used inside a macro. See
8685 'wildcharm' for that.
8686 Although 'wc' is a number option, you can set it to a special key: >
8687 :set wc=<Esc>
8688< NOTE: This option is set to the Vi default value when 'compatible' is
8689 set and to the Vim default value when 'compatible' is reset.
8690
8691 *'wildcharm'* *'wcm'*
8692'wildcharm' 'wcm' number (default: none (0))
8693 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008694 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00008695 recognized when used inside a macro. You can find "spare" command-line
8696 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00008697 you'll never actually type 'wildcharm', just use it in mappings that
8698 automatically invoke completion mode, e.g.: >
8699 :set wcm=<C-Z>
Bram Moolenaar446cb832008-06-24 21:56:24 +00008700 :cnoremap ss so $vim/sessions/*.vim<C-Z>
Bram Moolenaar071d4272004-06-13 20:20:40 +00008701< Then after typing :ss you can use CTRL-P & CTRL-N.
8702
8703 *'wildignore'* *'wig'*
8704'wildignore' 'wig' string (default "")
8705 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008706 {not available when compiled without the |+wildignore|
8707 feature}
8708 A list of file patterns. A file that matches with one of these
Bram Moolenaar30b65812012-07-12 22:01:11 +02008709 patterns is ignored when expanding |wildcards|, completing file or
8710 directory names, and influences the result of |expand()|, |glob()| and
8711 |globpath()| unless a flag is passed to disable this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008712 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
8713 Also see 'suffixes'.
8714 Example: >
8715 :set wildignore=*.o,*.obj
8716< The use of |:set+=| and |:set-=| is preferred when adding or removing
8717 a pattern from the list. This avoids problems when a future version
8718 uses another default.
8719
Bram Moolenaar94950a92010-12-02 16:01:29 +01008720
Bram Moolenaar81af9252010-12-10 20:35:50 +01008721 *'wildignorecase'* *'wic'* *'nowildignorecase'* *'nowic'*
Bram Moolenaar94950a92010-12-02 16:01:29 +01008722'wildignorecase' 'wic' boolean (default off)
8723 global
Bram Moolenaar94950a92010-12-02 16:01:29 +01008724 When set case is ignored when completing file names and directories.
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01008725 Has no effect when 'fileignorecase' is set.
Bram Moolenaar94950a92010-12-02 16:01:29 +01008726 Does not apply when the shell is used to expand wildcards, which
8727 happens when there are special characters.
8728
8729
Bram Moolenaar071d4272004-06-13 20:20:40 +00008730 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02008731'wildmenu' 'wmnu' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008732 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008733 {not available if compiled without the |+wildmenu|
8734 feature}
8735 When 'wildmenu' is on, command-line completion operates in an enhanced
8736 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
8737 the possible matches are shown just above the command line, with the
8738 first match highlighted (overwriting the status line, if there is
8739 one). Keys that show the previous/next match, such as <Tab> or
8740 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
8741 When 'wildmode' is used, "wildmenu" mode is used where "full" is
8742 specified. "longest" and "list" do not start "wildmenu" mode.
Bram Moolenaar26402cb2013-02-20 21:26:00 +01008743 You can check the current mode with |wildmenumode()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008744 If there are more matches than can fit in the line, a ">" is shown on
8745 the right and/or a "<" is shown on the left. The status line scrolls
8746 as needed.
8747 The "wildmenu" mode is abandoned when a key is hit that is not used
8748 for selecting a completion.
8749 While the "wildmenu" is active the following keys have special
8750 meanings:
8751
8752 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
8753 <Down> - in filename/menu name completion: move into a
8754 subdirectory or submenu.
8755 <CR> - in menu completion, when the cursor is just after a
8756 dot: move into a submenu.
8757 <Up> - in filename/menu name completion: move up into
8758 parent directory or parent menu.
8759
8760 This makes the menus accessible from the console |console-menus|.
8761
8762 If you prefer the <Left> and <Right> keys to move the cursor instead
8763 of selecting a different match, use this: >
8764 :cnoremap <Left> <Space><BS><Left>
8765 :cnoremap <Right> <Space><BS><Right>
8766<
8767 The "WildMenu" highlighting is used for displaying the current match
8768 |hl-WildMenu|.
8769
8770 *'wildmode'* *'wim'*
8771'wildmode' 'wim' string (Vim default: "full")
8772 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008773 Completion mode that is used for the character specified with
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008774 'wildchar'. It is a comma separated list of up to four parts. Each
Bram Moolenaar02467872007-05-06 13:22:01 +00008775 part specifies what to do for each consecutive use of 'wildchar'. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00008776 first part specifies the behavior for the first use of 'wildchar',
8777 The second part for the second use, etc.
8778 These are the possible values for each part:
8779 "" Complete only the first match.
8780 "full" Complete the next full match. After the last match,
8781 the original string is used and then the first match
8782 again.
8783 "longest" Complete till longest common string. If this doesn't
8784 result in a longer string, use the next part.
8785 "longest:full" Like "longest", but also start 'wildmenu' if it is
8786 enabled.
8787 "list" When more than one match, list all matches.
8788 "list:full" When more than one match, list all matches and
8789 complete first match.
8790 "list:longest" When more than one match, list all matches and
8791 complete till longest common string.
Bram Moolenaar52410572019-10-27 05:12:45 +01008792 "list:lastused" When more than one buffer matches, sort buffers
8793 by time last used (other than the current buffer).
Bram Moolenaar071d4272004-06-13 20:20:40 +00008794 When there is only a single match, it is fully completed in all cases.
8795
8796 Examples: >
8797 :set wildmode=full
Bram Moolenaar582fd852005-03-28 20:58:01 +00008798< Complete first full match, next match, etc. (the default) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008799 :set wildmode=longest,full
8800< Complete longest common string, then each full match >
8801 :set wildmode=list:full
8802< List all matches and complete each full match >
8803 :set wildmode=list,full
8804< List all matches without completing, then each full match >
8805 :set wildmode=longest,list
8806< Complete longest common string, then list alternatives.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008807 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008808
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00008809 *'wildoptions'* *'wop'*
8810'wildoptions' 'wop' string (default "")
8811 global
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00008812 {not available when compiled without the |+wildignore|
8813 feature}
8814 A list of words that change how command line completion is done.
8815 Currently only one word is allowed:
8816 tagfile When using CTRL-D to list matching tags, the kind of
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00008817 tag and the file of the tag is listed. Only one match
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00008818 is displayed per line. Often used tag kinds are:
8819 d #define
8820 f function
8821 Also see |cmdline-completion|.
8822
Bram Moolenaar071d4272004-06-13 20:20:40 +00008823 *'winaltkeys'* *'wak'*
8824'winaltkeys' 'wak' string (default "menu")
8825 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008826 {only used in Win32, Motif, GTK and Photon GUI}
8827 Some GUI versions allow the access to menu entries by using the ALT
8828 key in combination with a character that appears underlined in the
8829 menu. This conflicts with the use of the ALT key for mappings and
8830 entering special characters. This option tells what to do:
8831 no Don't use ALT keys for menus. ALT key combinations can be
8832 mapped, but there is no automatic handling. This can then be
8833 done with the |:simalt| command.
8834 yes ALT key handling is done by the windowing system. ALT key
8835 combinations cannot be mapped.
8836 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008837 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00008838 keys can be mapped.
8839 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
8840 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00008841 This option is not used for <F10>; on Win32 and with GTK <F10> will
8842 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008843
Bram Moolenaar4d784b22019-05-25 19:51:39 +02008844 *'wincolor'* *'wcr'*
8845'wincolor' 'wcr' string (default empty)
8846 local to window
8847 Highlight group name to use for this window instead of the Normal
8848 color |hl-Normal|.
8849
Bram Moolenaar4399ef42005-02-12 14:29:27 +00008850 *'window'* *'wi'*
8851'window' 'wi' number (default screen height - 1)
8852 global
8853 Window height. Do not confuse this with the height of the Vim window,
8854 use 'lines' for that.
Bram Moolenaar19a09a12005-03-04 23:39:37 +00008855 Used for |CTRL-F| and |CTRL-B| when there is only one window and the
8856 value is smaller than 'lines' minus one. The screen will scroll
8857 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00008858 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
8859 in a much smarter way, taking care of wrapping lines.
8860 When resizing the Vim window, the value is smaller than 1 or more than
8861 or equal to 'lines' it will be set to 'lines' minus 1.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00008862
Bram Moolenaar071d4272004-06-13 20:20:40 +00008863 *'winheight'* *'wh'* *E591*
8864'winheight' 'wh' number (default 1)
8865 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008866 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008867 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar446cb832008-06-24 21:56:24 +00008868 focus goes to a window that is smaller, its size is increased, at the
8869 cost of the height of other windows.
8870 Set 'winheight' to a small number for normal editing.
8871 Set it to 999 to make the current window fill most of the screen.
8872 Other windows will be only 'winminheight' high. This has the drawback
8873 that ":all" will create only two windows. To avoid "vim -o 1 2 3 4"
8874 to create only two windows, set the option after startup is done,
8875 using the |VimEnter| event: >
8876 au VimEnter * set winheight=999
8877< Minimum value is 1.
8878 The height is not adjusted after one of the commands that change the
Bram Moolenaar071d4272004-06-13 20:20:40 +00008879 height of the current window.
8880 'winheight' applies to the current window. Use 'winminheight' to set
8881 the minimal height for other windows.
8882
8883 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
8884'winfixheight' 'wfh' boolean (default off)
8885 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00008886 Keep the window height when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00008887 'equalalways' is set. Also for |CTRL-W_=|. Set by default for the
8888 |preview-window| and |quickfix-window|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008889 The height may be changed anyway when running out of room.
8890
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008891 *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'*
8892'winfixwidth' 'wfw' boolean (default off)
8893 local to window
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008894 Keep the window width when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00008895 'equalalways' is set. Also for |CTRL-W_=|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008896 The width may be changed anyway when running out of room.
8897
Bram Moolenaar071d4272004-06-13 20:20:40 +00008898 *'winminheight'* *'wmh'*
8899'winminheight' 'wmh' number (default 1)
8900 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008901 The minimal height of a window, when it's not the current window.
8902 This is a hard minimum, windows will never become smaller.
8903 When set to zero, windows may be "squashed" to zero lines (i.e. just a
8904 status bar) if necessary. They will return to at least one line when
8905 they become active (since the cursor has to have somewhere to go.)
8906 Use 'winheight' to set the minimal height of the current window.
8907 This option is only checked when making a window smaller. Don't use a
8908 large number, it will cause errors when opening more than a few
8909 windows. A value of 0 to 3 is reasonable.
8910
8911 *'winminwidth'* *'wmw'*
8912'winminwidth' 'wmw' number (default 1)
8913 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008914 The minimal width of a window, when it's not the current window.
8915 This is a hard minimum, windows will never become smaller.
8916 When set to zero, windows may be "squashed" to zero columns (i.e. just
8917 a vertical separator) if necessary. They will return to at least one
8918 line when they become active (since the cursor has to have somewhere
8919 to go.)
8920 Use 'winwidth' to set the minimal width of the current window.
8921 This option is only checked when making a window smaller. Don't use a
8922 large number, it will cause errors when opening more than a few
8923 windows. A value of 0 to 12 is reasonable.
8924
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02008925 *'winptydll'*
8926'winptydll' string (default "winpty32.dll" or "winpty64.dll")
8927 global
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02008928 {only available when compiled with the |terminal|
8929 feature on MS-Windows}
8930 Specifies the name of the winpty shared library, used for the
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02008931 |:terminal| command. The default depends on whether Vim was built as a
Bram Moolenaarc572da52017-08-27 16:52:01 +02008932 32-bit or 64-bit executable. If not found, "winpty.dll" is tried as
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02008933 a fallback.
8934 Environment variables are expanded |:set_env|.
8935 This option cannot be set from a |modeline| or in the |sandbox|, for
8936 security reasons.
8937
Bram Moolenaar071d4272004-06-13 20:20:40 +00008938 *'winwidth'* *'wiw'* *E592*
8939'winwidth' 'wiw' number (default 20)
8940 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008941 Minimal number of columns for the current window. This is not a hard
8942 minimum, Vim will use fewer columns if there is not enough room. If
8943 the current window is smaller, its size is increased, at the cost of
8944 the width of other windows. Set it to 999 to make the current window
8945 always fill the screen. Set it to a small number for normal editing.
8946 The width is not adjusted after one of the commands to change the
8947 width of the current window.
8948 'winwidth' applies to the current window. Use 'winminwidth' to set
8949 the minimal width for other windows.
8950
8951 *'wrap'* *'nowrap'*
8952'wrap' boolean (default on)
8953 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00008954 This option changes how text is displayed. It doesn't change the text
8955 in the buffer, see 'textwidth' for that.
8956 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008957 displaying continues on the next line. When off lines will not wrap
8958 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00008959 moved to a part that is not shown, the screen will scroll
8960 horizontally.
8961 The line will be broken in the middle of a word if necessary. See
8962 'linebreak' to get the break at a word boundary.
8963 To make scrolling horizontally a bit more useful, try this: >
8964 :set sidescroll=5
8965 :set listchars+=precedes:<,extends:>
8966< See 'sidescroll', 'listchars' and |wrap-off|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01008967 This option can't be set from a |modeline| when the 'diff' option is
8968 on.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008969
8970 *'wrapmargin'* *'wm'*
8971'wrapmargin' 'wm' number (default 0)
8972 local to buffer
8973 Number of characters from the right window border where wrapping
8974 starts. When typing text beyond this limit, an <EOL> will be inserted
8975 and inserting continues on the next line.
8976 Options that add a margin, such as 'number' and 'foldcolumn', cause
8977 the text width to be further reduced. This is Vi compatible.
8978 When 'textwidth' is non-zero, this option is not used.
Bram Moolenaarca635012015-09-25 20:34:21 +02008979 This option is set to 0 when 'paste' is set and restored when 'paste'
8980 is reset.
Bram Moolenaara6c27c42019-05-09 19:16:22 +02008981 See also 'formatoptions' and |ins-textwidth|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008982
8983 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
8984'wrapscan' 'ws' boolean (default on) *E384* *E385*
8985 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00008986 Searches wrap around the end of the file. Also applies to |]s| and
8987 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008988
8989 *'write'* *'nowrite'*
8990'write' boolean (default on)
8991 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008992 Allows writing files. When not set, writing a file is not allowed.
8993 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008994 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00008995 argument. Filtering text is still possible, even though this requires
8996 writing a temporary file.
8997
8998 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
8999'writeany' 'wa' boolean (default off)
9000 global
9001 Allows writing to any file with no need for "!" override.
9002
9003 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
9004'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
9005 otherwise)
9006 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009007 Make a backup before overwriting a file. The backup is removed after
9008 the file was successfully written, unless the 'backup' option is
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02009009 also on.
9010 WARNING: Switching this option off means that when Vim fails to write
9011 your buffer correctly and then, for whatever reason, Vim exits, you
9012 lose both the original file and what you were writing. Only reset
9013 this option if your file system is almost full and it makes the write
9014 fail (and make sure not to exit Vim until the write was successful).
9015 See |backup-table| for another explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009016 When the 'backupskip' pattern matches, a backup is not made anyway.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01009017 Depending on 'backupcopy' the backup is a new file or the original
9018 file renamed (and a new file is written).
Bram Moolenaar071d4272004-06-13 20:20:40 +00009019 NOTE: This option is set to the default value when 'compatible' is
9020 set.
9021
9022 *'writedelay'* *'wd'*
9023'writedelay' 'wd' number (default 0)
9024 global
Bram Moolenaar802a0d92016-06-26 16:17:58 +02009025 The number of milliseconds to wait for each character sent to the
Bram Moolenaar071d4272004-06-13 20:20:40 +00009026 screen. When non-zero, characters are sent to the terminal one by
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01009027 one. For debugging purposes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009028
Bram Moolenaar91f84f62018-07-29 15:07:52 +02009029 vim:tw=78:ts=8:noet:ft=help:norl: