blob: 80bb235ae135452369042d5c333c249e5785f2fb [file] [log] [blame]
Bram Moolenaar56994d22021-04-17 16:31:09 +02001*options.txt* For Vim version 8.2. Last change: 2021 Apr 16
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
Bram Moolenaar8b9abfd2021-03-29 20:49:05 +0200752 *'autoshelldir'* *'asd'* *'noautoshelldir'* *'noasd'*
753'autoshelldir' 'asd' boolean (default off)
754 global
755 When on, Vim will change the current working directory whenever you
756 change the directory of the shell running in a terminal window. You
757 need proper setting-up, so whenever the shell's pwd changes an OSC 7
758 escape sequence will be emitted. For example, on Linux, you can source
759 /etc/profile.d/vte.sh in your shell profile if you use bash or zsh.
760
Bram Moolenaar071d4272004-06-13 20:20:40 +0000761 *'arabic'* *'arab'* *'noarabic'* *'noarab'*
762'arabic' 'arab' boolean (default off)
763 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +0000764 {only available when compiled with the |+arabic|
765 feature}
766 This option can be set to start editing Arabic text.
767 Setting this option will:
768 - Set the 'rightleft' option, unless 'termbidi' is set.
769 - Set the 'arabicshape' option, unless 'termbidi' is set.
770 - Set the 'keymap' option to "arabic"; in Insert mode CTRL-^ toggles
771 between typing English and Arabic key mapping.
772 - Set the 'delcombine' option
773 Note that 'encoding' must be "utf-8" for working with Arabic text.
774
775 Resetting this option will:
776 - Reset the 'rightleft' option.
777 - Disable the use of 'keymap' (without changing its value).
778 Note that 'arabicshape' and 'delcombine' are not reset (it is a global
Bram Moolenaarc8734422012-06-01 22:38:45 +0200779 option).
Bram Moolenaar036986f2017-03-16 17:41:02 +0100780 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000781 Also see |arabic.txt|.
782
783 *'arabicshape'* *'arshape'*
784 *'noarabicshape'* *'noarshape'*
785'arabicshape' 'arshape' boolean (default on)
786 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000787 {only available when compiled with the |+arabic|
788 feature}
789 When on and 'termbidi' is off, the required visual character
790 corrections that need to take place for displaying the Arabic language
Bram Moolenaar3a0d8092012-10-21 03:02:54 +0200791 take effect. Shaping, in essence, gets enabled; the term is a broad
Bram Moolenaar071d4272004-06-13 20:20:40 +0000792 one which encompasses:
793 a) the changing/morphing of characters based on their location
794 within a word (initial, medial, final and stand-alone).
795 b) the enabling of the ability to compose characters
796 c) the enabling of the required combining of some characters
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100797 When disabled the display shows each character's true stand-alone
798 form.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000799 Arabic is a complex language which requires other settings, for
800 further details see |arabic.txt|.
Bram Moolenaar036986f2017-03-16 17:41:02 +0100801 NOTE: This option is set when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000802
803 *'autoindent'* *'ai'* *'noautoindent'* *'noai'*
804'autoindent' 'ai' boolean (default off)
805 local to buffer
806 Copy indent from current line when starting a new line (typing <CR>
807 in Insert mode or when using the "o" or "O" command). If you do not
808 type anything on the new line except <BS> or CTRL-D and then type
Bram Moolenaar02467872007-05-06 13:22:01 +0000809 <Esc>, CTRL-O or <CR>, the indent is deleted again. Moving the cursor
810 to another line has the same effect, unless the 'I' flag is included
811 in 'cpoptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000812 When autoindent is on, formatting (with the "gq" command or when you
813 reach 'textwidth' in Insert mode) uses the indentation of the first
814 line.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000815 When 'smartindent' or 'cindent' is on the indent is changed in
816 a different way.
Bram Moolenaarca635012015-09-25 20:34:21 +0200817 The 'autoindent' option is reset when the 'paste' option is set and
818 restored when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000819
820 *'autoread'* *'ar'* *'noautoread'* *'noar'*
821'autoread' 'ar' boolean (default off)
822 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000823 When a file has been detected to have been changed outside of Vim and
824 it has not been changed inside of Vim, automatically read it again.
Bram Moolenaarfd358112018-07-07 23:21:31 +0200825 When the file has been deleted this is not done, so you have the text
826 from before it was deleted. When it appears again then it is read.
827 |timestamp|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000828 If this option has a local value, use this command to switch back to
829 using the global value: >
830 :set autoread<
831<
832 *'autowrite'* *'aw'* *'noautowrite'* *'noaw'*
833'autowrite' 'aw' boolean (default off)
834 global
835 Write the contents of the file, if it has been modified, on each
836 :next, :rewind, :last, :first, :previous, :stop, :suspend, :tag, :!,
Bram Moolenaar14716812006-05-04 21:54:08 +0000837 :make, CTRL-] and CTRL-^ command; and when a :buffer, CTRL-O, CTRL-I,
Bram Moolenaar071d4272004-06-13 20:20:40 +0000838 '{A-Z0-9}, or `{A-Z0-9} command takes one to another file.
839 Note that for some commands the 'autowrite' option is not used, see
840 'autowriteall' for that.
Bram Moolenaar93a1df22018-09-10 11:51:50 +0200841 Some buffers will not be written, specifically when 'buftype' is
Bram Moolenaar20aac6c2018-09-02 21:07:30 +0200842 "nowrite", "nofile", "terminal" or "prompt".
Bram Moolenaar071d4272004-06-13 20:20:40 +0000843
844 *'autowriteall'* *'awa'* *'noautowriteall'* *'noawa'*
845'autowriteall' 'awa' boolean (default off)
846 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000847 Like 'autowrite', but also used for commands ":edit", ":enew", ":quit",
848 ":qall", ":exit", ":xit", ":recover" and closing the Vim window.
849 Setting this option also implies that Vim behaves like 'autowrite' has
850 been set.
851
852 *'background'* *'bg'*
Bram Moolenaar446beb42011-05-10 17:18:44 +0200853'background' 'bg' string (default "dark" or "light", see below)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000854 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000855 When set to "dark", Vim will try to use colors that look good on a
856 dark background. When set to "light", Vim will try to use colors that
857 look good on a light background. Any other value is illegal.
858 Vim tries to set the default value according to the terminal used.
859 This will not always be correct.
860 Setting this option does not change the background color, it tells Vim
861 what the background color looks like. For changing the background
862 color, see |:hi-normal|.
863
864 When 'background' is set Vim will adjust the default color groups for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000865 the new value. But the colors used for syntax highlighting will not
Bram Moolenaar446cb832008-06-24 21:56:24 +0000866 change. *g:colors_name*
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100867 When a color scheme is loaded (the "g:colors_name" variable is set)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000868 setting 'background' will cause the color scheme to be reloaded. If
869 the color scheme adjusts to the value of 'background' this will work.
870 However, if the color scheme sets 'background' itself the effect may
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100871 be undone. First delete the "g:colors_name" variable when needed.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000872
873 When setting 'background' to the default value with: >
874 :set background&
875< Vim will guess the value. In the GUI this should work correctly,
876 in other cases Vim might not be able to guess the right value.
Bram Moolenaar2e693a82019-10-16 22:35:02 +0200877 If the GUI supports a dark theme, you can use the "d" flag in
Bram Moolenaar50bf7ce2019-09-15 13:17:00 +0200878 'guioptions', see 'go-d'.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000879
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200880 When the |t_RB| option is set, Vim will use it to request the background
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +0200881 color from the terminal. If the returned RGB value is dark/light and
882 'background' is not dark/light, 'background' will be set and the
883 screen is redrawn. This may have side effects, make t_BG empty in
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200884 your .vimrc if you suspect this problem. The response to |t_RB| can
Bram Moolenaar01164a62017-11-02 22:58:42 +0100885 be found in |v:termrbgresp|.
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +0200886
Bram Moolenaar071d4272004-06-13 20:20:40 +0000887 When starting the GUI, the default value for 'background' will be
888 "light". When the value is not set in the .gvimrc, and Vim detects
889 that the background is actually quite dark, 'background' is set to
890 "dark". But this happens only AFTER the .gvimrc file has been read
891 (because the window needs to be opened to find the actual background
892 color). To get around this, force the GUI window to be opened by
893 putting a ":gui" command in the .gvimrc file, before where the value
894 of 'background' is used (e.g., before ":syntax on").
Bram Moolenaar446beb42011-05-10 17:18:44 +0200895
Bram Moolenaar6f345a12019-12-17 21:27:18 +0100896 For MS-Windows the default is "dark".
Bram Moolenaar446beb42011-05-10 17:18:44 +0200897 For other systems "dark" is used when 'term' is "linux",
898 "screen.linux", "cygwin" or "putty", or $COLORFGBG suggests a dark
899 background. Otherwise the default is "light".
900
Bram Moolenaarc572da52017-08-27 16:52:01 +0200901 The |:terminal| command and the |term_start()| function use the
902 'background' value to decide whether the terminal window will start
903 with a white or black background.
904
Bram Moolenaar071d4272004-06-13 20:20:40 +0000905 Normally this option would be set in the .vimrc file. Possibly
906 depending on the terminal name. Example: >
907 :if &term == "pcterm"
908 : set background=dark
909 :endif
910< When this option is set, the default settings for the highlight groups
911 will change. To use other settings, place ":highlight" commands AFTER
912 the setting of the 'background' option.
913 This option is also used in the "$VIMRUNTIME/syntax/syntax.vim" file
914 to select the colors for syntax highlighting. After changing this
915 option, you must load syntax.vim again to see the result. This can be
916 done with ":syntax on".
917
918 *'backspace'* *'bs'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +0200919'backspace' 'bs' string (default "", set to "indent,eol,start"
920 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000921 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000922 Influences the working of <BS>, <Del>, CTRL-W and CTRL-U in Insert
923 mode. This is a list of items, separated by commas. Each item allows
924 a way to backspace over something:
925 value effect ~
926 indent allow backspacing over autoindent
927 eol allow backspacing over line breaks (join lines)
928 start allow backspacing over the start of insert; CTRL-W and CTRL-U
929 stop once at the start of insert.
Bram Moolenaaraa0489e2020-04-17 19:41:21 +0200930 nostop like start, except CTRL-W and CTRL-U do not stop at the start of
931 insert.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000932
933 When the value is empty, Vi compatible backspacing is used.
934
935 For backwards compatibility with version 5.4 and earlier:
936 value effect ~
937 0 same as ":set backspace=" (Vi compatible)
938 1 same as ":set backspace=indent,eol"
939 2 same as ":set backspace=indent,eol,start"
Bram Moolenaaraa0489e2020-04-17 19:41:21 +0200940 3 same as ":set backspace=indent,eol,nostop"
Bram Moolenaar071d4272004-06-13 20:20:40 +0000941
942 See |:fixdel| if your <BS> or <Del> key does not do what you want.
943 NOTE: This option is set to "" when 'compatible' is set.
944
945 *'backup'* *'bk'* *'nobackup'* *'nobk'*
946'backup' 'bk' boolean (default off)
947 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000948 Make a backup before overwriting a file. Leave it around after the
949 file has been successfully written. If you do not want to keep the
950 backup file, but you do want a backup while the file is being
951 written, reset this option and set the 'writebackup' option (this is
952 the default). If you do not want a backup file at all reset both
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000953 options (use this if your file system is almost full). See the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000954 |backup-table| for more explanations.
955 When the 'backupskip' pattern matches, a backup is not made anyway.
956 When 'patchmode' is set, the backup may be renamed to become the
957 oldest version of a file.
958 NOTE: This option is reset when 'compatible' is set.
959
960 *'backupcopy'* *'bkc'*
961'backupcopy' 'bkc' string (Vi default for Unix: "yes", otherwise: "auto")
Bram Moolenaarb8ee25a2014-09-23 15:45:08 +0200962 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000963 When writing a file and a backup is made, this option tells how it's
964 done. This is a comma separated list of words.
965
966 The main values are:
967 "yes" make a copy of the file and overwrite the original one
968 "no" rename the file and write a new one
969 "auto" one of the previous, what works best
970
971 Extra values that can be combined with the ones above are:
972 "breaksymlink" always break symlinks when writing
973 "breakhardlink" always break hardlinks when writing
974
975 Making a copy and overwriting the original file:
976 - Takes extra time to copy the file.
977 + When the file has special attributes, is a (hard/symbolic) link or
978 has a resource fork, all this is preserved.
979 - When the file is a link the backup will have the name of the link,
980 not of the real file.
981
982 Renaming the file and writing a new one:
983 + It's fast.
984 - Sometimes not all attributes of the file can be copied to the new
985 file.
986 - When the file is a link the new file will not be a link.
987
988 The "auto" value is the middle way: When Vim sees that renaming file
989 is possible without side effects (the attributes can be passed on and
Bram Moolenaar02467872007-05-06 13:22:01 +0000990 the file is not a link) that is used. When problems are expected, a
991 copy will be made.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000992
993 The "breaksymlink" and "breakhardlink" values can be used in
994 combination with any of "yes", "no" and "auto". When included, they
995 force Vim to always break either symbolic or hard links by doing
996 exactly what the "no" option does, renaming the original file to
997 become the backup and writing a new file in its place. This can be
998 useful for example in source trees where all the files are symbolic or
999 hard links and any changes should stay in the local source tree, not
1000 be propagated back to the original source.
1001 *crontab*
1002 One situation where "no" and "auto" will cause problems: A program
1003 that opens a file, invokes Vim to edit that file, and then tests if
1004 the open file was changed (through the file descriptor) will check the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001005 backup file instead of the newly created file. "crontab -e" is an
Bram Moolenaar071d4272004-06-13 20:20:40 +00001006 example.
1007
1008 When a copy is made, the original file is truncated and then filled
1009 with the new text. This means that protection bits, owner and
1010 symbolic links of the original file are unmodified. The backup file
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001011 however, is a new file, owned by the user who edited the file. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00001012 group of the backup is set to the group of the original file. If this
1013 fails, the protection bits for the group are made the same as for
1014 others.
1015
1016 When the file is renamed this is the other way around: The backup has
1017 the same attributes of the original file, and the newly written file
1018 is owned by the current user. When the file was a (hard/symbolic)
1019 link, the new file will not! That's why the "auto" value doesn't
1020 rename when the file is a link. The owner and group of the newly
1021 written file will be set to the same ones as the original file, but
1022 the system may refuse to do this. In that case the "auto" value will
1023 again not rename the file.
1024
Bram Moolenaar036986f2017-03-16 17:41:02 +01001025 NOTE: This option is set to the Vi default value when 'compatible' is
1026 set and to the Vim default value when 'compatible' is reset.
1027
Bram Moolenaar071d4272004-06-13 20:20:40 +00001028 *'backupdir'* *'bdir'*
1029'backupdir' 'bdir' string (default for Amiga: ".,t:",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01001030 for Win32: ".,$TEMP,c:/tmp,c:/temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001031 for Unix: ".,~/tmp,~/")
1032 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001033 List of directories for the backup file, separated with commas.
1034 - The backup file will be created in the first directory in the list
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001035 where this is possible. The directory must exist, Vim will not
1036 create it for you.
Bram Moolenaar3848e002016-03-19 18:42:29 +01001037 - Empty means that no backup file will be created ('patchmode' is
Bram Moolenaar071d4272004-06-13 20:20:40 +00001038 impossible!). Writing may fail because of this.
1039 - A directory "." means to put the backup file in the same directory
1040 as the edited file.
Bram Moolenaar8024f932020-01-14 19:29:13 +01001041 - A directory starting with "./" (or ".\" for MS-Windows) means to put
1042 the backup file relative to where the edited file is. The leading
1043 "." is replaced with the path name of the edited file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001044 ("." inside a directory name has no special meaning).
1045 - Spaces after the comma are ignored, other spaces are considered part
1046 of the directory name. To have a space at the start of a directory
1047 name, precede it with a backslash.
1048 - To include a comma in a directory name precede it with a backslash.
1049 - A directory name may end in an '/'.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02001050 - For Unix and Win32, if a directory ends in two path separators "//",
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01001051 the backup file name will be built from the complete path to the
1052 file with all path separators changed to percent '%' signs. This
1053 will ensure file name uniqueness in the backup directory.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02001054 On Win32, it is also possible to end with "\\". However, When a
1055 separating comma is following, you must use "//", since "\\" will
1056 include the comma in the file name. Therefore it is recommended to
1057 use '//', instead of '\\'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001058 - Environment variables are expanded |:set_env|.
1059 - Careful with '\' characters, type one before a space, type two to
1060 get one in the option (see |option-backslash|), for example: >
1061 :set bdir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
1062< - For backwards compatibility with Vim version 3.0 a '>' at the start
1063 of the option is removed.
1064 See also 'backup' and 'writebackup' options.
1065 If you want to hide your backup files on Unix, consider this value: >
1066 :set backupdir=./.backup,~/.backup,.,/tmp
1067< You must create a ".backup" directory in each directory and in your
1068 home directory for this to work properly.
1069 The use of |:set+=| and |:set-=| is preferred when adding or removing
1070 directories from the list. This avoids problems when a future version
1071 uses another default.
1072 This option cannot be set from a |modeline| or in the |sandbox|, for
1073 security reasons.
1074
1075 *'backupext'* *'bex'* *E589*
1076'backupext' 'bex' string (default "~", for VMS: "_")
1077 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001078 String which is appended to a file name to make the name of the
1079 backup file. The default is quite unusual, because this avoids
1080 accidentally overwriting existing files with a backup file. You might
1081 prefer using ".bak", but make sure that you don't have files with
1082 ".bak" that you want to keep.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001083 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001084
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001085 If you like to keep a lot of backups, you could use a BufWritePre
1086 autocommand to change 'backupext' just before writing the file to
1087 include a timestamp. >
1088 :au BufWritePre * let &bex = '-' . strftime("%Y%b%d%X") . '~'
1089< Use 'backupdir' to put the backup in a different directory.
1090
Bram Moolenaar071d4272004-06-13 20:20:40 +00001091 *'backupskip'* *'bsk'*
Bram Moolenaarb8e22a02018-04-12 21:37:34 +02001092'backupskip' 'bsk' string (default: "$TMPDIR/*,$TMP/*,$TEMP/*"
1093 Unix: "/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*"
1094 Mac: "/private/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001095 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001096 {not available when compiled without the |+wildignore|
1097 feature}
1098 A list of file patterns. When one of the patterns matches with the
1099 name of the file which is written, no backup file is created. Both
1100 the specified file name and the full path name of the file are used.
1101 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
1102 Watch out for special characters, see |option-backslash|.
1103 When $TMPDIR, $TMP or $TEMP is not defined, it is not used for the
Bram Moolenaar582fd852005-03-28 20:58:01 +00001104 default value. "/tmp/*" is only used for Unix.
Bram Moolenaar02467872007-05-06 13:22:01 +00001105
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02001106 WARNING: Not having a backup file means that when Vim fails to write
1107 your buffer correctly and then, for whatever reason, Vim exits, you
1108 lose both the original file and what you were writing. Only disable
1109 backups if you don't care about losing the file.
1110
Bram Moolenaar02467872007-05-06 13:22:01 +00001111 Note that environment variables are not expanded. If you want to use
1112 $HOME you must expand it explicitly, e.g.: >
Bram Moolenaar7c1c6db2016-04-03 22:08:05 +02001113 :let &backupskip = escape(expand('$HOME'), '\') . '/tmp/*'
Bram Moolenaar02467872007-05-06 13:22:01 +00001114
1115< Note that the default also makes sure that "crontab -e" works (when a
Bram Moolenaara5792f52005-11-23 21:25:05 +00001116 backup would be made by renaming the original file crontab won't see
1117 the newly created file). Also see 'backupcopy' and |crontab|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001118
1119 *'balloondelay'* *'bdlay'*
1120'balloondelay' 'bdlay' number (default: 600)
1121 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001122 {only available when compiled with the |+balloon_eval|
1123 feature}
1124 Delay in milliseconds before a balloon may pop up. See |balloon-eval|.
1125
1126 *'ballooneval'* *'beval'* *'noballooneval'* *'nobeval'*
1127'ballooneval' 'beval' boolean (default off)
1128 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001129 {only available when compiled with the |+balloon_eval|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001130 feature}
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001131 Switch on the |balloon-eval| functionality for the GUI.
1132
1133 *'balloonevalterm'* *'bevalterm'* *'noballoonevalterm'*
1134 *'nobevalterm'*
1135'balloonevalterm' 'bevalterm' boolean (default off)
1136 global
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001137 {only available when compiled with the
1138 |+balloon_eval_term| feature}
1139 Switch on the |balloon-eval| functionality for the terminal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001140
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001141 *'balloonexpr'* *'bexpr'*
1142'balloonexpr' 'bexpr' string (default "")
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00001143 global or local to buffer |global-local|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001144 {only available when compiled with the |+balloon_eval|
1145 feature}
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00001146 Expression for text to show in evaluation balloon. It is only used
Bram Moolenaara6c27c42019-05-09 19:16:22 +02001147 when 'ballooneval' or 'balloonevalterm' is on. These variables can be
1148 used:
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001149
1150 v:beval_bufnr number of the buffer in which balloon is going to show
1151 v:beval_winnr number of the window
Bram Moolenaar82af8712016-06-04 20:20:29 +02001152 v:beval_winid ID of the window
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001153 v:beval_lnum line number
1154 v:beval_col column number (byte index)
1155 v:beval_text word under or after the mouse pointer
1156
Bram Moolenaar54775062019-07-31 21:07:14 +02001157 Instead of showing a balloon, which is limited to plain text, consider
1158 using a popup window, see |popup_beval_example|. A popup window can
1159 use highlighting and show a border.
1160
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001161 The evaluation of the expression must not have side effects!
1162 Example: >
Bram Moolenaara6c27c42019-05-09 19:16:22 +02001163 function MyBalloonExpr()
Bram Moolenaar45360022005-07-21 21:08:21 +00001164 return 'Cursor is at line ' . v:beval_lnum .
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001165 \', column ' . v:beval_col .
1166 \ ' of file ' . bufname(v:beval_bufnr) .
1167 \ ' on word "' . v:beval_text . '"'
1168 endfunction
1169 set bexpr=MyBalloonExpr()
1170 set ballooneval
1171<
Bram Moolenaar396e8292019-07-13 23:04:31 +02001172 Also see |balloon_show()|, it can be used if the content of the balloon
1173 is to be fetched asynchronously. In that case evaluating
1174 'balloonexpr' should result in an empty string. If you get a balloon
1175 with only "0" you probably didn't return anything from your function.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001176
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001177 NOTE: The balloon is displayed only if the cursor is on a text
1178 character. If the result of evaluating 'balloonexpr' is not empty,
1179 Vim does not try to send a message to an external debugger (Netbeans
1180 or Sun Workshop).
1181
Bram Moolenaar30b65812012-07-12 22:01:11 +02001182 The expression will be evaluated in the |sandbox| when set from a
1183 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02001184 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001185
1186 It is not allowed to change text or jump to another window while
Bram Moolenaar396e8292019-07-13 23:04:31 +02001187 evaluating 'balloonexpr', see |textlock|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001188
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001189 To check whether line breaks in the balloon text work use this check: >
Bram Moolenaar45360022005-07-21 21:08:21 +00001190 if has("balloon_multiline")
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001191< When they are supported "\n" characters will start a new line. If the
1192 expression evaluates to a |List| this is equal to using each List item
1193 as a string and putting "\n" in between them.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001194 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001195
Bram Moolenaar165bc692015-07-21 17:53:25 +02001196 *'belloff'* *'bo'*
1197'belloff' 'bo' string (default "")
1198 global
Bram Moolenaar165bc692015-07-21 17:53:25 +02001199 Specifies for which events the bell will not be rung. It is a comma
1200 separated list of items. For each item that is present, the bell
1201 will be silenced. This is most useful to specify specific events in
1202 insert mode to be silenced.
1203
1204 item meaning when present ~
1205 all All events.
1206 backspace When hitting <BS> or <Del> and deleting results in an
1207 error.
1208 cursor Fail to move around using the cursor keys or
1209 <PageUp>/<PageDown> in |Insert-mode|.
1210 complete Error occurred when using |i_CTRL-X_CTRL-K| or
1211 |i_CTRL-X_CTRL-T|.
1212 copy Cannot copy char from insert mode using |i_CTRL-Y| or
1213 |i_CTRL-E|.
1214 ctrlg Unknown Char after <C-G> in Insert mode.
1215 error Other Error occurred (e.g. try to join last line)
1216 (mostly used in |Normal-mode| or |Cmdline-mode|).
1217 esc hitting <Esc> in |Normal-mode|.
1218 ex In |Visual-mode|, hitting |Q| results in an error.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01001219 hangul Ignored.
Bram Moolenaar165bc692015-07-21 17:53:25 +02001220 insertmode Pressing <Esc> in 'insertmode'.
1221 lang Calling the beep module for Lua/Mzscheme/TCL.
1222 mess No output available for |g<|.
1223 showmatch Error occurred for 'showmatch' function.
1224 operator Empty region error |cpo-E|.
1225 register Unknown register after <C-R> in |Insert-mode|.
1226 shell Bell from shell output |:!|.
1227 spell Error happened on spell suggest.
1228 wildmode More matches in |cmdline-completion| available
1229 (depends on the 'wildmode' setting).
1230
Bram Moolenaar036986f2017-03-16 17:41:02 +01001231 This is most useful to fine tune when in Insert mode the bell should
1232 be rung. For Normal mode and Ex commands, the bell is often rung to
Bram Moolenaar165bc692015-07-21 17:53:25 +02001233 indicate that an error occurred. It can be silenced by adding the
1234 "error" keyword.
1235
Bram Moolenaar071d4272004-06-13 20:20:40 +00001236 *'binary'* *'bin'* *'nobinary'* *'nobin'*
1237'binary' 'bin' boolean (default off)
1238 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001239 This option should be set before editing a binary file. You can also
1240 use the |-b| Vim argument. When this option is switched on a few
1241 options will be changed (also when it already was on):
1242 'textwidth' will be set to 0
1243 'wrapmargin' will be set to 0
1244 'modeline' will be off
1245 'expandtab' will be off
1246 Also, 'fileformat' and 'fileformats' options will not be used, the
1247 file is read and written like 'fileformat' was "unix" (a single <NL>
1248 separates lines).
1249 The 'fileencoding' and 'fileencodings' options will not be used, the
1250 file is read without conversion.
1251 NOTE: When you start editing a(nother) file while the 'bin' option is
1252 on, settings from autocommands may change the settings again (e.g.,
1253 'textwidth'), causing trouble when editing. You might want to set
1254 'bin' again when the file has been loaded.
1255 The previous values of these options are remembered and restored when
1256 'bin' is switched from on to off. Each buffer has its own set of
1257 saved option values.
1258 To edit a file with 'binary' set you can use the |++bin| argument.
1259 This avoids you have to do ":set bin", which would have effect for all
1260 files you edit.
1261 When writing a file the <EOL> for the last line is only written if
1262 there was one in the original file (normally Vim appends an <EOL> to
1263 the last line if there is none; this would make the file longer). See
1264 the 'endofline' option.
1265
1266 *'bioskey'* *'biosk'* *'nobioskey'* *'nobiosk'*
1267'bioskey' 'biosk' boolean (default on)
1268 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02001269 {only for MS-DOS}
Bram Moolenaarf3913272016-02-25 00:00:01 +01001270 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001271
1272 *'bomb'* *'nobomb'*
1273'bomb' boolean (default off)
1274 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001275 When writing a file and the following conditions are met, a BOM (Byte
1276 Order Mark) is prepended to the file:
1277 - this option is on
1278 - the 'binary' option is off
1279 - 'fileencoding' is "utf-8", "ucs-2", "ucs-4" or one of the little/big
1280 endian variants.
1281 Some applications use the BOM to recognize the encoding of the file.
1282 Often used for UCS-2 files on MS-Windows. For other applications it
1283 causes trouble, for example: "cat file1 file2" makes the BOM of file2
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001284 appear halfway the resulting file. Gcc doesn't accept a BOM.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001285 When Vim reads a file and 'fileencodings' starts with "ucs-bom", a
1286 check for the presence of the BOM is done and 'bomb' set accordingly.
1287 Unless 'binary' is set, it is removed from the first line, so that you
1288 don't see it when editing. When you don't change the options, the BOM
1289 will be restored when writing the file.
1290
1291 *'breakat'* *'brk'*
1292'breakat' 'brk' string (default " ^I!@*-+;:,./?")
1293 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02001294 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001295 feature}
1296 This option lets you choose which characters might cause a line
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00001297 break if 'linebreak' is on. Only works for ASCII and also for 8-bit
1298 characters when 'encoding' is an 8-bit encoding.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001299
Bram Moolenaar7c1c6db2016-04-03 22:08:05 +02001300 *'breakindent'* *'bri'* *'nobreakindent'* *'nobri'*
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001301'breakindent' 'bri' boolean (default off)
1302 local to window
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001303 {not available when compiled without the |+linebreak|
1304 feature}
1305 Every wrapped line will continue visually indented (same amount of
1306 space as the beginning of that line), thus preserving horizontal blocks
1307 of text.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001308 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001309
1310 *'breakindentopt'* *'briopt'*
1311'breakindentopt' 'briopt' string (default empty)
1312 local to window
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001313 {not available when compiled without the |+linebreak|
1314 feature}
1315 Settings for 'breakindent'. It can consist of the following optional
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001316 items and must be separated by a comma:
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001317 min:{n} Minimum text width that will be kept after
1318 applying 'breakindent', even if the resulting
1319 text should normally be narrower. This prevents
1320 text indented almost to the right window border
1321 occupying lot of vertical space when broken.
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001322 shift:{n} After applying 'breakindent', the wrapped line's
1323 beginning will be shifted by the given number of
1324 characters. It permits dynamic French paragraph
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001325 indentation (negative) or emphasizing the line
1326 continuation (positive).
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01001327 sbr Display the 'showbreak' value before applying the
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001328 additional indent.
1329 The default value for min is 20 and shift is 0.
1330
Bram Moolenaar071d4272004-06-13 20:20:40 +00001331 *'browsedir'* *'bsdir'*
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001332'browsedir' 'bsdir' string (default: "last")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001333 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02001334 {only for Motif, Athena, GTK, Mac and Win32 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001335 Which directory to use for the file browser:
Bram Moolenaar446cb832008-06-24 21:56:24 +00001336 last Use same directory as with last file browser, where a
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02001337 file was opened or saved.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001338 buffer Use the directory of the related buffer.
1339 current Use the current directory.
1340 {path} Use the specified directory
1341
1342 *'bufhidden'* *'bh'*
1343'bufhidden' 'bh' string (default: "")
1344 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001345 This option specifies what happens when a buffer is no longer
1346 displayed in a window:
1347 <empty> follow the global 'hidden' option
1348 hide hide the buffer (don't unload it), also when 'hidden'
1349 is not set
1350 unload unload the buffer, also when 'hidden' is set or using
1351 |:hide|
1352 delete delete the buffer from the buffer list, also when
1353 'hidden' is set or using |:hide|, like using
1354 |:bdelete|
1355 wipe wipe out the buffer from the buffer list, also when
1356 'hidden' is set or using |:hide|, like using
1357 |:bwipeout|
1358
Bram Moolenaara14de3d2005-01-07 21:48:26 +00001359 CAREFUL: when "unload", "delete" or "wipe" is used changes in a buffer
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01001360 are lost without a warning. Also, these values may break autocommands
1361 that switch between buffers temporarily.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001362 This option is used together with 'buftype' and 'swapfile' to specify
1363 special kinds of buffers. See |special-buffers|.
1364
1365 *'buflisted'* *'bl'* *'nobuflisted'* *'nobl'* *E85*
1366'buflisted' 'bl' boolean (default: on)
1367 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001368 When this option is set, the buffer shows up in the buffer list. If
1369 it is reset it is not used for ":bnext", "ls", the Buffers menu, etc.
1370 This option is reset by Vim for buffers that are only used to remember
1371 a file name or marks. Vim sets it when starting to edit a buffer.
1372 But not when moving to a buffer with ":buffer".
1373
1374 *'buftype'* *'bt'* *E382*
1375'buftype' 'bt' string (default: "")
1376 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001377 The value of this option specifies the type of a buffer:
1378 <empty> normal buffer
1379 nofile buffer which is not related to a file and will not be
1380 written
1381 nowrite buffer which will not be written
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001382 acwrite buffer which will always be written with BufWriteCmd
Bram Moolenaarb5b75622018-03-09 22:22:21 +01001383 autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001384 quickfix quickfix buffer, contains list of errors |:cwindow|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001385 or list of locations |:lwindow|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001386 help help buffer (you are not supposed to set this
1387 manually)
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02001388 terminal buffer for a |terminal| (you are not supposed to set
1389 this manually)
Bram Moolenaarf2732452018-06-03 14:47:35 +02001390 prompt buffer where only the last line can be edited, meant
1391 to be used by a plugin, see |prompt-buffer|
1392 {only when compiled with the |+channel| feature}
Bram Moolenaar4d784b22019-05-25 19:51:39 +02001393 popup buffer used in a popup window, see |popup|.
1394 {only when compiled with the |+textprop| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001395
1396 This option is used together with 'bufhidden' and 'swapfile' to
1397 specify special kinds of buffers. See |special-buffers|.
Bram Moolenaarebdf3c92020-02-15 21:41:42 +01001398 Also see |win_gettype()|, which returns the type of the window.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001399
1400 Be careful with changing this option, it can have many side effects!
1401
Bram Moolenaar280f1262006-01-30 00:14:18 +00001402 A "quickfix" buffer is only used for the error list and the location
1403 list. This value is set by the |:cwindow| and |:lwindow| commands and
1404 you are not supposed to change it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001405
1406 "nofile" and "nowrite" buffers are similar:
1407 both: The buffer is not to be written to disk, ":w" doesn't
1408 work (":w filename" does work though).
1409 both: The buffer is never considered to be |'modified'|.
1410 There is no warning when the changes will be lost, for
1411 example when you quit Vim.
1412 both: A swap file is only created when using too much memory
1413 (when 'swapfile' has been reset there is never a swap
1414 file).
1415 nofile only: The buffer name is fixed, it is not handled like a
1416 file name. It is not modified in response to a |:cd|
1417 command.
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01001418 both: When using ":e bufname" and already editing "bufname"
1419 the buffer is made empty and autocommands are
1420 triggered as usual for |:edit|.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001421 *E676*
1422 "acwrite" implies that the buffer name is not related to a file, like
1423 "nofile", but it will be written. Thus, in contrast to "nofile" and
1424 "nowrite", ":w" does work and a modified buffer can't be abandoned
1425 without saving. For writing there must be matching |BufWriteCmd|,
1426 |FileWriteCmd| or |FileAppendCmd| autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001427
1428 *'casemap'* *'cmp'*
1429'casemap' 'cmp' string (default: "internal,keepascii")
1430 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001431 Specifies details about changing the case of letters. It may contain
1432 these words, separated by a comma:
1433 internal Use internal case mapping functions, the current
1434 locale does not change the case mapping. This only
Bram Moolenaar6f16eb82005-08-23 21:02:42 +00001435 matters when 'encoding' is a Unicode encoding,
1436 "latin1" or "iso-8859-15". When "internal" is
1437 omitted, the towupper() and towlower() system library
1438 functions are used when available.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001439 keepascii For the ASCII characters (0x00 to 0x7f) use the US
1440 case mapping, the current locale is not effective.
1441 This probably only matters for Turkish.
1442
1443 *'cdpath'* *'cd'* *E344* *E346*
1444'cdpath' 'cd' string (default: equivalent to $CDPATH or ",,")
1445 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001446 {not available when compiled without the
1447 |+file_in_path| feature}
1448 This is a list of directories which will be searched when using the
Bram Moolenaar00aa0692019-04-27 20:37:57 +02001449 |:cd|, |:tcd| and |:lcd| commands, provided that the directory being
1450 searched for has a relative path, not an absolute part starting with
1451 "/", "./" or "../", the 'cdpath' option is not used then.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001452 The 'cdpath' option's value has the same form and semantics as
1453 |'path'|. Also see |file-searching|.
1454 The default value is taken from $CDPATH, with a "," prepended to look
1455 in the current directory first.
1456 If the default value taken from $CDPATH is not what you want, include
1457 a modified version of the following command in your vimrc file to
1458 override it: >
1459 :let &cdpath = ',' . substitute(substitute($CDPATH, '[, ]', '\\\0', 'g'), ':', ',', 'g')
1460< This option cannot be set from a |modeline| or in the |sandbox|, for
1461 security reasons.
1462 (parts of 'cdpath' can be passed to the shell to expand file names).
1463
1464 *'cedit'*
1465'cedit' string (Vi default: "", Vim default: CTRL-F)
1466 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001467 The key used in Command-line Mode to open the command-line window.
1468 The default is CTRL-F when 'compatible' is off.
1469 Only non-printable keys are allowed.
1470 The key can be specified as a single character, but it is difficult to
1471 type. The preferred way is to use the <> notation. Examples: >
Bram Moolenaare18dbe82016-07-02 21:42:23 +02001472 :exe "set cedit=\<C-Y>"
1473 :exe "set cedit=\<Esc>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001474< |Nvi| also has this option, but it only uses the first character.
1475 See |cmdwin|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001476 NOTE: This option is set to the Vim default value when 'compatible'
1477 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001478
1479 *'charconvert'* *'ccv'* *E202* *E214* *E513*
1480'charconvert' 'ccv' string (default "")
1481 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01001482 {only available when compiled with the |+eval| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001483 An expression that is used for character encoding conversion. It is
1484 evaluated when a file that is to be read or has been written has a
1485 different encoding from what is desired.
1486 'charconvert' is not used when the internal iconv() function is
1487 supported and is able to do the conversion. Using iconv() is
1488 preferred, because it is much faster.
1489 'charconvert' is not used when reading stdin |--|, because there is no
1490 file to convert from. You will have to save the text in a file first.
1491 The expression must return zero or an empty string for success,
1492 non-zero for failure.
1493 The possible encoding names encountered are in 'encoding'.
1494 Additionally, names given in 'fileencodings' and 'fileencoding' are
1495 used.
1496 Conversion between "latin1", "unicode", "ucs-2", "ucs-4" and "utf-8"
1497 is done internally by Vim, 'charconvert' is not used for this.
1498 'charconvert' is also used to convert the viminfo file, if the 'c'
1499 flag is present in 'viminfo'. Also used for Unicode conversion.
1500 Example: >
1501 set charconvert=CharConvert()
1502 fun CharConvert()
1503 system("recode "
1504 \ . v:charconvert_from . ".." . v:charconvert_to
1505 \ . " <" . v:fname_in . " >" v:fname_out)
1506 return v:shell_error
1507 endfun
1508< The related Vim variables are:
1509 v:charconvert_from name of the current encoding
1510 v:charconvert_to name of the desired encoding
1511 v:fname_in name of the input file
1512 v:fname_out name of the output file
1513 Note that v:fname_in and v:fname_out will never be the same.
1514 Note that v:charconvert_from and v:charconvert_to may be different
1515 from 'encoding'. Vim internally uses UTF-8 instead of UCS-2 or UCS-4.
1516 Encryption is not done by Vim when using 'charconvert'. If you want
1517 to encrypt the file after conversion, 'charconvert' should take care
1518 of this.
1519 This option cannot be set from a |modeline| or in the |sandbox|, for
1520 security reasons.
1521
1522 *'cindent'* *'cin'* *'nocindent'* *'nocin'*
1523'cindent' 'cin' boolean (default off)
1524 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001525 {not available when compiled without the |+cindent|
1526 feature}
Bram Moolenaar446cb832008-06-24 21:56:24 +00001527 Enables automatic C program indenting. See 'cinkeys' to set the keys
Bram Moolenaar071d4272004-06-13 20:20:40 +00001528 that trigger reindenting in insert mode and 'cinoptions' to set your
1529 preferred indent style.
1530 If 'indentexpr' is not empty, it overrules 'cindent'.
1531 If 'lisp' is not on and both 'indentexpr' and 'equalprg' are empty,
1532 the "=" operator indents using this algorithm rather than calling an
1533 external program.
1534 See |C-indenting|.
1535 When you don't like the way 'cindent' works, try the 'smartindent'
1536 option or 'indentexpr'.
1537 This option is not used when 'paste' is set.
1538 NOTE: This option is reset when 'compatible' is set.
1539
1540 *'cinkeys'* *'cink'*
Bram Moolenaarce655742019-01-31 14:12:57 +01001541'cinkeys' 'cink' string (default "0{,0},0),0],:,0#,!^F,o,O,e")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001542 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001543 {not available when compiled without the |+cindent|
1544 feature}
1545 A list of keys that, when typed in Insert mode, cause reindenting of
1546 the current line. Only used if 'cindent' is on and 'indentexpr' is
1547 empty.
1548 For the format of this option see |cinkeys-format|.
1549 See |C-indenting|.
1550
1551 *'cinoptions'* *'cino'*
1552'cinoptions' 'cino' string (default "")
1553 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001554 {not available when compiled without the |+cindent|
1555 feature}
1556 The 'cinoptions' affect the way 'cindent' reindents lines in a C
1557 program. See |cinoptions-values| for the values of this option, and
1558 |C-indenting| for info on C indenting in general.
1559
1560
1561 *'cinwords'* *'cinw'*
1562'cinwords' 'cinw' string (default "if,else,while,do,for,switch")
1563 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001564 {not available when compiled without both the
1565 |+cindent| and the |+smartindent| features}
1566 These keywords start an extra indent in the next line when
1567 'smartindent' or 'cindent' is set. For 'cindent' this is only done at
1568 an appropriate place (inside {}).
1569 Note that 'ignorecase' isn't used for 'cinwords'. If case doesn't
1570 matter, include the keyword both the uppercase and lowercase:
1571 "if,If,IF".
1572
1573 *'clipboard'* *'cb'*
1574'clipboard' 'cb' string (default "autoselect,exclude:cons\|linux"
1575 for X-windows, "" otherwise)
1576 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001577 {only in GUI versions or when the |+xterm_clipboard|
1578 feature is included}
1579 This option is a list of comma separated names.
Bram Moolenaar942db232021-02-13 18:14:48 +01001580 Note: if one of the items is "exclude:", then you can't add an item
1581 after that. Therefore do append an item with += but use ^= to
1582 prepend, e.g.: >
1583 set clipboard^=unnamed
1584< These names are recognized:
Bram Moolenaar071d4272004-06-13 20:20:40 +00001585
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001586 *clipboard-unnamed*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001587 unnamed When included, Vim will use the clipboard register '*'
1588 for all yank, delete, change and put operations which
1589 would normally go to the unnamed register. When a
1590 register is explicitly specified, it will always be
1591 used regardless of whether "unnamed" is in 'clipboard'
1592 or not. The clipboard register can always be
1593 explicitly accessed using the "* notation. Also see
1594 |gui-clipboard|.
1595
Bram Moolenaar30b65812012-07-12 22:01:11 +02001596 *clipboard-unnamedplus*
Bram Moolenaar00154502013-02-13 16:15:55 +01001597 unnamedplus A variant of the "unnamed" flag which uses the
1598 clipboard register '+' (|quoteplus|) instead of
1599 register '*' for all yank, delete, change and put
1600 operations which would normally go to the unnamed
1601 register. When "unnamed" is also included to the
1602 option, yank operations (but not delete, change or
1603 put) will additionally copy the text into register
1604 '*'.
Bram Moolenaar81af9252010-12-10 20:35:50 +01001605 Only available with the |+X11| feature.
Bram Moolenaarbf9680e2010-12-02 21:43:16 +01001606 Availability can be checked with: >
1607 if has('unnamedplus')
1608<
Bram Moolenaar30b65812012-07-12 22:01:11 +02001609 *clipboard-autoselect*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001610 autoselect Works like the 'a' flag in 'guioptions': If present,
1611 then whenever Visual mode is started, or the Visual
1612 area extended, Vim tries to become the owner of the
1613 windowing system's global selection or put the
1614 selected text on the clipboard used by the selection
Bram Moolenaarba3ff532018-11-04 14:45:49 +01001615 register "*. See |'go-a'| and |quotestar| for details.
1616 When the GUI is active, the 'a' flag in 'guioptions'
1617 is used, when the GUI is not active, this "autoselect"
1618 flag is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001619 Also applies to the modeless selection.
1620
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001621 *clipboard-autoselectplus*
1622 autoselectplus Like "autoselect" but using the + register instead of
1623 the * register. Compare to the 'P' flag in
1624 'guioptions'.
1625
1626 *clipboard-autoselectml*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001627 autoselectml Like "autoselect", but for the modeless selection
1628 only. Compare to the 'A' flag in 'guioptions'.
1629
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001630 *clipboard-html*
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001631 html When the clipboard contains HTML, use this when
1632 pasting. When putting text on the clipboard, mark it
1633 as HTML. This works to copy rendered HTML from
1634 Firefox, paste it as raw HTML in Vim, select the HTML
1635 in Vim and paste it in a rich edit box in Firefox.
Bram Moolenaar20a825a2010-05-31 21:27:30 +02001636 You probably want to add this only temporarily,
1637 possibly use BufEnter autocommands.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001638 Only supported for GTK version 2 and later.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001639
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001640 *clipboard-exclude*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001641 exclude:{pattern}
1642 Defines a pattern that is matched against the name of
1643 the terminal 'term'. If there is a match, no
1644 connection will be made to the X server. This is
1645 useful in this situation:
1646 - Running Vim in a console.
1647 - $DISPLAY is set to start applications on another
1648 display.
1649 - You do not want to connect to the X server in the
1650 console, but do want this in a terminal emulator.
1651 To never connect to the X server use: >
1652 exclude:.*
1653< This has the same effect as using the |-X| argument.
1654 Note that when there is no connection to the X server
1655 the window title won't be restored and the clipboard
1656 cannot be accessed.
1657 The value of 'magic' is ignored, {pattern} is
1658 interpreted as if 'magic' was on.
1659 The rest of the option value will be used for
1660 {pattern}, this must be the last entry.
1661
1662 *'cmdheight'* *'ch'*
1663'cmdheight' 'ch' number (default 1)
1664 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001665 Number of screen lines to use for the command-line. Helps avoiding
1666 |hit-enter| prompts.
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00001667 The value of this option is stored with the tab page, so that each tab
1668 page can have a different value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001669
1670 *'cmdwinheight'* *'cwh'*
1671'cmdwinheight' 'cwh' number (default 7)
1672 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001673 Number of screen lines to use for the command-line window. |cmdwin|
1674
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001675 *'colorcolumn'* *'cc'*
1676'colorcolumn' 'cc' string (default "")
1677 local to window
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001678 {not available when compiled without the |+syntax|
1679 feature}
1680 'colorcolumn' is a comma separated list of screen columns that are
1681 highlighted with ColorColumn |hl-ColorColumn|. Useful to align
1682 text. Will make screen redrawing slower.
1683 The screen column can be an absolute number, or a number preceded with
1684 '+' or '-', which is added to or subtracted from 'textwidth'. >
1685
1686 :set cc=+1 " highlight column after 'textwidth'
1687 :set cc=+1,+2,+3 " highlight three columns after 'textwidth'
1688 :hi ColorColumn ctermbg=lightgrey guibg=lightgrey
1689<
1690 When 'textwidth' is zero then the items with '-' and '+' are not used.
1691 A maximum of 256 columns are highlighted.
1692
Bram Moolenaar071d4272004-06-13 20:20:40 +00001693 *'columns'* *'co'* *E594*
1694'columns' 'co' number (default 80 or terminal width)
1695 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001696 Number of columns of the screen. Normally this is set by the terminal
Bram Moolenaar7c626922005-02-07 22:01:03 +00001697 initialization and does not have to be set by hand. Also see
1698 |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001699 When Vim is running in the GUI or in a resizable window, setting this
1700 option will cause the window size to be changed. When you only want
1701 to use the size for the GUI, put the command in your |gvimrc| file.
1702 When you set this option and Vim is unable to change the physical
Bram Moolenaar02467872007-05-06 13:22:01 +00001703 number of columns of the display, the display may be messed up. For
1704 the GUI it is always possible and Vim limits the number of columns to
1705 what fits on the screen. You can use this command to get the widest
1706 window possible: >
1707 :set columns=9999
1708< Minimum value is 12, maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001709
1710 *'comments'* *'com'* *E524* *E525*
1711'comments' 'com' string (default
1712 "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-")
1713 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001714 A comma separated list of strings that can start a comment line. See
1715 |format-comments|. See |option-backslash| about using backslashes to
1716 insert a space.
1717
1718 *'commentstring'* *'cms'* *E537*
1719'commentstring' 'cms' string (default "/*%s*/")
1720 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001721 {not available when compiled without the |+folding|
1722 feature}
1723 A template for a comment. The "%s" in the value is replaced with the
1724 comment text. Currently only used to add markers for folding, see
1725 |fold-marker|.
1726
1727 *'compatible'* *'cp'* *'nocompatible'* *'nocp'*
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001728'compatible' 'cp' boolean (default on, off when a |vimrc| or |gvimrc|
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02001729 file is found, reset in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001730 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001731 This option has the effect of making Vim either more Vi-compatible, or
1732 make Vim behave in a more useful way.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001733
Bram Moolenaar071d4272004-06-13 20:20:40 +00001734 This is a special kind of option, because when it's set or reset,
Bram Moolenaar214641f2017-03-05 17:04:09 +01001735 other options are also changed as a side effect.
1736 NOTE: Setting or resetting this option can have a lot of unexpected
1737 effects: Mappings are interpreted in another way, undo behaves
1738 differently, etc. If you set this option in your vimrc file, you
1739 should probably put it at the very start.
1740
Bram Moolenaar071d4272004-06-13 20:20:40 +00001741 By default this option is on and the Vi defaults are used for the
1742 options. This default was chosen for those people who want to use Vim
1743 just like Vi, and don't even (want to) know about the 'compatible'
1744 option.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001745 When a |vimrc| or |gvimrc| file is found while Vim is starting up,
Bram Moolenaard042c562005-06-30 22:04:15 +00001746 this option is switched off, and all options that have not been
1747 modified will be set to the Vim defaults. Effectively, this means
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001748 that when a |vimrc| or |gvimrc| file exists, Vim will use the Vim
Bram Moolenaard042c562005-06-30 22:04:15 +00001749 defaults, otherwise it will use the Vi defaults. (Note: This doesn't
Bram Moolenaar02467872007-05-06 13:22:01 +00001750 happen for the system-wide vimrc or gvimrc file, nor for a file given
1751 with the |-u| argument). Also see |compatible-default| and
1752 |posix-compliance|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001753 You can also set this option with the "-C" argument, and reset it with
1754 "-N". See |-C| and |-N|.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001755 See 'cpoptions' for more fine tuning of Vi compatibility.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001756
Bram Moolenaar214641f2017-03-05 17:04:09 +01001757 When this option is set, numerous other options are set to make Vim as
1758 Vi-compatible as possible. When this option is unset, various options
1759 are set to make Vim more useful. The table below lists all the
1760 options affected.
1761 The {?} column indicates when the options are affected:
1762 + Means that the option is set to the value given in {set value} when
1763 'compatible' is set.
1764 & Means that the option is set to the value given in {set value} when
1765 'compatible' is set AND is set to its Vim default value when
1766 'compatible' is unset.
1767 - Means the option is NOT changed when setting 'compatible' but IS
1768 set to its Vim default when 'compatible' is unset.
1769 The {effect} column summarises the change when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001770
Bram Moolenaar036986f2017-03-16 17:41:02 +01001771 option ? set value effect ~
Bram Moolenaar214641f2017-03-05 17:04:09 +01001772
1773 'allowrevins' + off no CTRL-_ command
1774 'antialias' + off don't use antialiased fonts
1775 'arabic' + off reset arabic-related options
1776 'arabicshape' + on correct character shapes
1777 'backspace' + "" normal backspace
1778 'backup' + off no backup file
1779 'backupcopy' & Unix: "yes" backup file is a copy
1780 else: "auto" copy or rename backup file
1781 'balloonexpr' + "" text to show in evaluation balloon
1782 'breakindent' + off don't indent when wrapping lines
1783 'cedit' - {unchanged} {set vim default only on resetting 'cp'}
1784 'cindent' + off no C code indentation
1785 'compatible' - {unchanged} {set vim default only on resetting 'cp'}
1786 'copyindent' + off don't copy indent structure
1787 'cpoptions' & (all flags) Vi-compatible flags
1788 'cscopepathcomp'+ 0 don't show directories in tags list
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01001789 'cscoperelative'+ off don't use basename of path as prefix
Bram Moolenaar214641f2017-03-05 17:04:09 +01001790 'cscopetag' + off don't use cscope for ":tag"
Bram Moolenaar036986f2017-03-16 17:41:02 +01001791 'cscopetagorder'+ 0 see |cscopetagorder|
Bram Moolenaar214641f2017-03-05 17:04:09 +01001792 'cscopeverbose' + off see |cscopeverbose|
1793 'delcombine' + off unicode: delete whole char combination
1794 'digraph' + off no digraphs
1795 'esckeys' & off no <Esc>-keys in Insert mode
1796 'expandtab' + off tabs not expanded to spaces
1797 'fileformats' & "" no automatic file format detection,
Bram Moolenaar6f345a12019-12-17 21:27:18 +01001798 "dos,unix" except for MS-Windows
Bram Moolenaar214641f2017-03-05 17:04:09 +01001799 'formatexpr' + "" use 'formatprg' for auto-formatting
1800 'formatoptions' & "vt" Vi compatible formatting
1801 'gdefault' + off no default 'g' flag for ":s"
1802 'history' & 0 no commandline history
1803 'hkmap' + off no Hebrew keyboard mapping
1804 'hkmapp' + off no phonetic Hebrew keyboard mapping
1805 'hlsearch' + off no highlighting of search matches
1806 'incsearch' + off no incremental searching
1807 'indentexpr' + "" no indenting by expression
1808 'insertmode' + off do not start in Insert mode
1809 'iskeyword' & "@,48-57,_" keywords contain alphanumeric
Bram Moolenaar071d4272004-06-13 20:20:40 +00001810 characters and '_'
Bram Moolenaar214641f2017-03-05 17:04:09 +01001811 'joinspaces' + on insert 2 spaces after period
1812 'modeline' & off no modelines
1813 'more' & off no pauses in listings
1814 'mzquantum' - {unchanged} {set vim default only on resetting 'cp'}
1815 'numberwidth' & 8 min number of columns for line number
1816 'preserveindent'+ off don't preserve current indent structure
1817 when changing it
1818 'revins' + off no reverse insert
1819 'ruler' + off no ruler
1820 'scrolljump' + 1 no jump scroll
1821 'scrolloff' + 0 no scroll offset
1822 'shelltemp' - {unchanged} {set vim default only on resetting 'cp'}
1823 'shiftround' + off indent not rounded to shiftwidth
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02001824 'shortmess' & "S" no shortening of messages
Bram Moolenaar214641f2017-03-05 17:04:09 +01001825 'showcmd' & off command characters not shown
1826 'showmode' & off current mode not shown
1827 'sidescrolloff' + 0 cursor moves to edge of screen in scroll
1828 'smartcase' + off no automatic ignore case switch
1829 'smartindent' + off no smart indentation
1830 'smarttab' + off no smart tab size
1831 'softtabstop' + 0 tabs are always 'tabstop' positions
1832 'startofline' + on goto startofline with some commands
1833 'tagcase' & "followic" 'ignorecase' when searching tags file
1834 'tagrelative' & off tag file names are not relative
1835 'termguicolors' + off don't use highlight-(guifg|guibg)
1836 'textauto' & off no automatic textmode detection
1837 'textwidth' + 0 no automatic line wrap
1838 'tildeop' + off tilde is not an operator
1839 'ttimeout' + off no terminal timeout
1840 'undofile' + off don't use an undo file
Bram Moolenaar036986f2017-03-16 17:41:02 +01001841 'viminfo' - {unchanged} {set Vim default only on resetting 'cp'}
Bram Moolenaar214641f2017-03-05 17:04:09 +01001842 'virtualedit' + "" cursor can only be placed on characters
1843 'whichwrap' & "" left-right movements don't wrap
1844 'wildchar' & CTRL-E only when the current value is <Tab>
Bram Moolenaar071d4272004-06-13 20:20:40 +00001845 use CTRL-E for cmdline completion
Bram Moolenaar214641f2017-03-05 17:04:09 +01001846 'writebackup' + on or off depends on the |+writebackup| feature
Bram Moolenaar071d4272004-06-13 20:20:40 +00001847
1848 *'complete'* *'cpt'* *E535*
1849'complete' 'cpt' string (default: ".,w,b,u,t,i")
1850 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001851 This option specifies how keyword completion |ins-completion| works
1852 when CTRL-P or CTRL-N are used. It is also used for whole-line
1853 completion |i_CTRL-X_CTRL-L|. It indicates the type of completion
1854 and the places to scan. It is a comma separated list of flags:
Bram Moolenaar3848e002016-03-19 18:42:29 +01001855 . scan the current buffer ('wrapscan' is ignored)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001856 w scan buffers from other windows
1857 b scan other loaded buffers that are in the buffer list
1858 u scan the unloaded buffers that are in the buffer list
1859 U scan the buffers that are not in the buffer list
1860 k scan the files given with the 'dictionary' option
Bram Moolenaar0b238792006-03-02 22:49:12 +00001861 kspell use the currently active spell checking |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001862 k{dict} scan the file {dict}. Several "k" flags can be given,
1863 patterns are valid too. For example: >
1864 :set cpt=k/usr/dict/*,k~/spanish
1865< s scan the files given with the 'thesaurus' option
1866 s{tsr} scan the file {tsr}. Several "s" flags can be given, patterns
1867 are valid too.
1868 i scan current and included files
1869 d scan current and included files for defined name or macro
1870 |i_CTRL-X_CTRL-D|
1871 ] tag completion
1872 t same as "]"
1873
1874 Unloaded buffers are not loaded, thus their autocmds |:autocmd| are
1875 not executed, this may lead to unexpected completions from some files
1876 (gzipped files for example). Unloaded buffers are not scanned for
1877 whole-line completion.
1878
1879 The default is ".,w,b,u,t,i", which means to scan:
1880 1. the current buffer
1881 2. buffers in other windows
1882 3. other loaded buffers
1883 4. unloaded buffers
1884 5. tags
1885 6. included files
1886
1887 As you can see, CTRL-N and CTRL-P can be used to do any 'iskeyword'-
Bram Moolenaar582fd852005-03-28 20:58:01 +00001888 based expansion (e.g., dictionary |i_CTRL-X_CTRL-K|, included patterns
1889 |i_CTRL-X_CTRL-I|, tags |i_CTRL-X_CTRL-]| and normal expansions).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001890
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001891 *'completefunc'* *'cfu'*
1892'completefunc' 'cfu' string (default: empty)
1893 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02001894 {not available when compiled without the |+eval|
Bram Moolenaare2c453d2019-08-21 14:37:09 +02001895 feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00001896 This option specifies a function to be used for Insert mode completion
1897 with CTRL-X CTRL-U. |i_CTRL-X_CTRL-U|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001898 See |complete-functions| for an explanation of how the function is
1899 invoked and what it should return.
Bram Moolenaar166af9b2010-11-16 20:34:40 +01001900 This option cannot be set from a |modeline| or in the |sandbox|, for
1901 security reasons.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00001902
Bram Moolenaarac3150d2019-07-28 16:36:39 +02001903 *'completeslash'* *'csl'*
1904'completeslash' 'csl' string (default: "")
1905 local to buffer
Bram Moolenaar2e693a82019-10-16 22:35:02 +02001906 {only for MS-Windows}
Bram Moolenaarac3150d2019-07-28 16:36:39 +02001907 When this option is set it overrules 'shellslash' for completion:
1908 - When this option is set to "slash", a forward slash is used for path
1909 completion in insert mode. This is useful when editing HTML tag, or
Bram Moolenaar6f345a12019-12-17 21:27:18 +01001910 Makefile with 'noshellslash' on MS-Windows.
Bram Moolenaarac3150d2019-07-28 16:36:39 +02001911 - When this option is set to "backslash", backslash is used. This is
Bram Moolenaar6f345a12019-12-17 21:27:18 +01001912 useful when editing a batch file with 'shellslash' set on MS-Windows.
Bram Moolenaarac3150d2019-07-28 16:36:39 +02001913 - When this option is empty, same character is used as for
1914 'shellslash'.
1915 For Insert mode completion the buffer-local value is used. For
1916 command line completion the global value is used.
1917
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001918 *'completeopt'* *'cot'*
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001919'completeopt' 'cot' string (default: "menu,preview")
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001920 global
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001921 A comma separated list of options for Insert mode completion
1922 |ins-completion|. The supported values are:
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001923
1924 menu Use a popup menu to show the possible completions. The
1925 menu is only shown when there is more than one match and
1926 sufficient colors are available. |ins-completion-menu|
1927
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001928 menuone Use the popup menu also when there is only one match.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00001929 Useful when there is additional information about the
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001930 match, e.g., what file it comes from.
1931
Bram Moolenaarc1e37902006-04-18 21:55:01 +00001932 longest Only insert the longest common text of the matches. If
1933 the menu is displayed you can use CTRL-L to add more
1934 characters. Whether case is ignored depends on the kind
1935 of completion. For buffer text the 'ignorecase' option is
1936 used.
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001937
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001938 preview Show extra information about the currently selected
Bram Moolenaar02467872007-05-06 13:22:01 +00001939 completion in the preview window. Only works in
1940 combination with "menu" or "menuone".
1941
Bram Moolenaar576a4a62019-08-18 15:25:17 +02001942 popup Show extra information about the currently selected
1943 completion in a popup window. Only works in combination
1944 with "menu" or "menuone". Overrides "preview".
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02001945 See |'completepopup'| for specifying properties.
Bram Moolenaar2e693a82019-10-16 22:35:02 +02001946 {only works when compiled with the |+textprop| feature}
Bram Moolenaar576a4a62019-08-18 15:25:17 +02001947
Bram Moolenaardca7abe2019-10-20 18:17:57 +02001948 popuphidden
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01001949 Just like "popup" but initially hide the popup. Use a
Bram Moolenaardca7abe2019-10-20 18:17:57 +02001950 |CompleteChanged| autocommand to fetch the info and call
1951 |popup_show()| once the popup has been filled.
1952 See the example at |complete-popuphidden|.
1953 {only works when compiled with the |+textprop| feature}
1954
Bram Moolenaarb6be1e22015-07-10 18:18:40 +02001955 noinsert Do not insert any text for a match until the user selects
1956 a match from the menu. Only works in combination with
1957 "menu" or "menuone". No effect if "longest" is present.
1958
1959 noselect Do not select a match in the menu, force the user to
1960 select one from the menu. Only works in combination with
1961 "menu" or "menuone".
1962
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001963
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02001964 *'completepopup'* *'cpp'*
1965'completepopup' 'cpp' string (default empty)
1966 global
1967 {not available when compiled without the |+textprop|
1968 or |+quickfix| feature}
1969 When 'completeopt' contains "popup" then this option is used for the
Bram Moolenaar447bfba2020-07-18 16:07:16 +02001970 properties of the info popup when it is created. If an info popup
1971 window already exists it is closed, so that the option value is
1972 applied when it is created again.
1973 You can also use |popup_findinfo()| and then set properties for an
1974 existing info popup with |popup_setoptions()|. See |complete-popup|.
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02001975
1976
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001977 *'concealcursor'* *'cocu'*
1978'concealcursor' 'cocu' string (default: "")
1979 local to window
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001980 {not available when compiled without the |+conceal|
1981 feature}
1982 Sets the modes in which text in the cursor line can also be concealed.
1983 When the current mode is listed then concealing happens just like in
1984 other lines.
1985 n Normal mode
1986 v Visual mode
1987 i Insert mode
Bram Moolenaarca8c9862010-07-24 15:00:38 +02001988 c Command line editing, for 'incsearch'
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001989
Bram Moolenaare6dc5732010-07-24 23:52:26 +02001990 'v' applies to all lines in the Visual area, not only the cursor.
Bram Moolenaarca8c9862010-07-24 15:00:38 +02001991 A useful value is "nc". This is used in help files. So long as you
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001992 are moving around text is concealed, but when starting to insert text
1993 or selecting a Visual area the concealed text is displayed, so that
1994 you can see what you are doing.
Bram Moolenaarf70e3d62010-07-24 13:15:07 +02001995 Keep in mind that the cursor position is not always where it's
1996 displayed. E.g., when moving vertically it may change column.
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001997
1998
Bram Moolenaar95bafa22018-10-02 13:26:25 +02001999 *'conceallevel'* *'cole'*
2000'conceallevel' 'cole' number (default 0)
Bram Moolenaar860cae12010-06-05 23:22:07 +02002001 local to window
Bram Moolenaar860cae12010-06-05 23:22:07 +02002002 {not available when compiled without the |+conceal|
2003 feature}
Bram Moolenaar6df6f472010-07-18 18:04:50 +02002004 Determine how text with the "conceal" syntax attribute |:syn-conceal|
2005 is shown:
Bram Moolenaar860cae12010-06-05 23:22:07 +02002006
Bram Moolenaar6df6f472010-07-18 18:04:50 +02002007 Value Effect ~
Bram Moolenaar860cae12010-06-05 23:22:07 +02002008 0 Text is shown normally
Bram Moolenaar477db062010-07-28 18:17:41 +02002009 1 Each block of concealed text is replaced with one
2010 character. If the syntax item does not have a custom
2011 replacement character defined (see |:syn-cchar|) the
2012 character defined in 'listchars' is used (default is a
2013 space).
2014 It is highlighted with the "Conceal" highlight group.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002015 2 Concealed text is completely hidden unless it has a
2016 custom replacement character defined (see
Bram Moolenaar477db062010-07-28 18:17:41 +02002017 |:syn-cchar|).
Bram Moolenaara7781e02010-07-19 20:13:22 +02002018 3 Concealed text is completely hidden.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002019
Bram Moolenaara7781e02010-07-19 20:13:22 +02002020 Note: in the cursor line concealed text is not hidden, so that you can
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002021 edit and copy the text. This can be changed with the 'concealcursor'
2022 option.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002023
Bram Moolenaar071d4272004-06-13 20:20:40 +00002024 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
2025'confirm' 'cf' boolean (default off)
2026 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002027 When 'confirm' is on, certain operations that would normally
2028 fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
2029 instead raise a |dialog| asking if you wish to save the current
2030 file(s). You can still use a ! to unconditionally |abandon| a buffer.
2031 If 'confirm' is off you can still activate confirmation for one
2032 command only (this is most useful in mappings) with the |:confirm|
2033 command.
2034 Also see the |confirm()| function and the 'v' flag in 'guioptions'.
2035
2036 *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
2037'conskey' 'consk' boolean (default off)
2038 global
Bram Moolenaarf3913272016-02-25 00:00:01 +01002039 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002040
2041 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
2042'copyindent' 'ci' boolean (default off)
2043 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002044 Copy the structure of the existing lines indent when autoindenting a
2045 new line. Normally the new indent is reconstructed by a series of
2046 tabs followed by spaces as required (unless |'expandtab'| is enabled,
2047 in which case only spaces are used). Enabling this option makes the
2048 new line copy whatever characters were used for indenting on the
Bram Moolenaar446cb832008-06-24 21:56:24 +00002049 existing line. 'expandtab' has no effect on these characters, a Tab
2050 remains a Tab. If the new indent is greater than on the existing
Bram Moolenaar071d4272004-06-13 20:20:40 +00002051 line, the remaining space is filled in the normal manner.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002052 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002053 Also see 'preserveindent'.
2054
Bram Moolenaare0fa3742016-02-20 15:47:01 +01002055 *'cpoptions'* *'cpo'* *cpo*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002056'cpoptions' 'cpo' string (Vim default: "aABceFs",
2057 Vi default: all flags)
2058 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002059 A sequence of single character flags. When a character is present
Bram Moolenaar7cba6c02013-09-05 22:13:31 +02002060 this indicates Vi-compatible behavior. This is used for things where
2061 not being Vi-compatible is mostly or sometimes preferred.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002062 'cpoptions' stands for "compatible-options".
2063 Commas can be added for readability.
2064 To avoid problems with flags that are added in the future, use the
2065 "+=" and "-=" feature of ":set" |add-option-flags|.
2066 NOTE: This option is set to the Vi default value when 'compatible' is
2067 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002068 NOTE: This option is set to the POSIX default value at startup when
2069 the Vi default value would be used and the $VIM_POSIX environment
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002070 variable exists |posix|. This means Vim tries to behave like the
2071 POSIX specification.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002072
2073 contains behavior ~
2074 *cpo-a*
2075 a When included, a ":read" command with a file name
2076 argument will set the alternate file name for the
2077 current window.
2078 *cpo-A*
2079 A When included, a ":write" command with a file name
2080 argument will set the alternate file name for the
2081 current window.
2082 *cpo-b*
2083 b "\|" in a ":map" command is recognized as the end of
2084 the map command. The '\' is included in the mapping,
2085 the text after the '|' is interpreted as the next
2086 command. Use a CTRL-V instead of a backslash to
2087 include the '|' in the mapping. Applies to all
2088 mapping, abbreviation, menu and autocmd commands.
2089 See also |map_bar|.
2090 *cpo-B*
2091 B A backslash has no special meaning in mappings,
Bram Moolenaara9604e62018-07-21 05:56:22 +02002092 abbreviations, user commands and the "to" part of the
2093 menu commands. Remove this flag to be able to use a
2094 backslash like a CTRL-V. For example, the command
2095 ":map X \<Esc>" results in X being mapped to:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002096 'B' included: "\^[" (^[ is a real <Esc>)
2097 'B' excluded: "<Esc>" (5 characters)
2098 ('<' excluded in both cases)
2099 *cpo-c*
2100 c Searching continues at the end of any match at the
2101 cursor position, but not further than the start of the
2102 next line. When not present searching continues
2103 one character from the cursor position. With 'c'
2104 "abababababab" only gets three matches when repeating
2105 "/abab", without 'c' there are five matches.
2106 *cpo-C*
2107 C Do not concatenate sourced lines that start with a
2108 backslash. See |line-continuation|.
2109 *cpo-d*
2110 d Using "./" in the 'tags' option doesn't mean to use
2111 the tags file relative to the current file, but the
2112 tags file in the current directory.
2113 *cpo-D*
2114 D Can't use CTRL-K to enter a digraph after Normal mode
2115 commands with a character argument, like |r|, |f| and
2116 |t|.
2117 *cpo-e*
2118 e When executing a register with ":@r", always add a
2119 <CR> to the last line, also when the register is not
2120 linewise. If this flag is not present, the register
2121 is not linewise and the last line does not end in a
2122 <CR>, then the last line is put on the command-line
2123 and can be edited before hitting <CR>.
2124 *cpo-E*
2125 E It is an error when using "y", "d", "c", "g~", "gu" or
2126 "gU" on an Empty region. The operators only work when
Bram Moolenaar15142e22018-04-30 22:19:58 +02002127 at least one character is to be operated on. Example:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002128 This makes "y0" fail in the first column.
2129 *cpo-f*
2130 f When included, a ":read" command with a file name
2131 argument will set the file name for the current buffer,
2132 if the current buffer doesn't have a file name yet.
2133 *cpo-F*
2134 F When included, a ":write" command with a file name
2135 argument will set the file name for the current
2136 buffer, if the current buffer doesn't have a file name
Bram Moolenaarb3480382005-12-11 21:33:32 +00002137 yet. Also see |cpo-P|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002138 *cpo-g*
2139 g Goto line 1 when using ":edit" without argument.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002140 *cpo-H*
2141 H When using "I" on a line with only blanks, insert
2142 before the last blank. Without this flag insert after
2143 the last blank.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002144 *cpo-i*
2145 i When included, interrupting the reading of a file will
2146 leave it modified.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002147 *cpo-I*
2148 I When moving the cursor up or down just after inserting
2149 indent for 'autoindent', do not delete the indent.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002150 *cpo-j*
2151 j When joining lines, only add two spaces after a '.',
2152 not after '!' or '?'. Also see 'joinspaces'.
2153 *cpo-J*
2154 J A |sentence| has to be followed by two spaces after
Bram Moolenaar582fd852005-03-28 20:58:01 +00002155 the '.', '!' or '?'. A <Tab> is not recognized as
Bram Moolenaar071d4272004-06-13 20:20:40 +00002156 white space.
2157 *cpo-k*
2158 k Disable the recognition of raw key codes in
2159 mappings, abbreviations, and the "to" part of menu
2160 commands. For example, if <Key> sends ^[OA (where ^[
2161 is <Esc>), the command ":map X ^[OA" results in X
2162 being mapped to:
2163 'k' included: "^[OA" (3 characters)
2164 'k' excluded: "<Key>" (one key code)
2165 Also see the '<' flag below.
2166 *cpo-K*
2167 K Don't wait for a key code to complete when it is
2168 halfway a mapping. This breaks mapping <F1><F1> when
2169 only part of the second <F1> has been read. It
2170 enables cancelling the mapping by typing <F1><Esc>.
2171 *cpo-l*
2172 l Backslash in a [] range in a search pattern is taken
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002173 literally, only "\]", "\^", "\-" and "\\" are special.
2174 See |/[]|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002175 'l' included: "/[ \t]" finds <Space>, '\' and 't'
2176 'l' excluded: "/[ \t]" finds <Space> and <Tab>
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002177 Also see |cpo-\|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002178 *cpo-L*
2179 L When the 'list' option is set, 'wrapmargin',
2180 'textwidth', 'softtabstop' and Virtual Replace mode
2181 (see |gR|) count a <Tab> as two characters, instead of
2182 the normal behavior of a <Tab>.
2183 *cpo-m*
2184 m When included, a showmatch will always wait half a
2185 second. When not included, a showmatch will wait half
2186 a second or until a character is typed. |'showmatch'|
2187 *cpo-M*
2188 M When excluded, "%" matching will take backslashes into
2189 account. Thus in "( \( )" and "\( ( \)" the outer
2190 parenthesis match. When included "%" ignores
2191 backslashes, which is Vi compatible.
2192 *cpo-n*
Bram Moolenaar64486672010-05-16 15:46:46 +02002193 n When included, the column used for 'number' and
2194 'relativenumber' will also be used for text of wrapped
2195 lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002196 *cpo-o*
2197 o Line offset to search command is not remembered for
2198 next search.
2199 *cpo-O*
2200 O Don't complain if a file is being overwritten, even
2201 when it didn't exist when editing it. This is a
2202 protection against a file unexpectedly created by
2203 someone else. Vi didn't complain about this.
2204 *cpo-p*
2205 p Vi compatible Lisp indenting. When not present, a
2206 slightly better algorithm is used.
Bram Moolenaarb3480382005-12-11 21:33:32 +00002207 *cpo-P*
2208 P When included, a ":write" command that appends to a
2209 file will set the file name for the current buffer, if
2210 the current buffer doesn't have a file name yet and
2211 the 'F' flag is also included |cpo-F|.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002212 *cpo-q*
2213 q When joining multiple lines leave the cursor at the
2214 position where it would be when joining two lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002215 *cpo-r*
2216 r Redo ("." command) uses "/" to repeat a search
2217 command, instead of the actually used search string.
2218 *cpo-R*
2219 R Remove marks from filtered lines. Without this flag
2220 marks are kept like |:keepmarks| was used.
2221 *cpo-s*
2222 s Set buffer options when entering the buffer for the
2223 first time. This is like it is in Vim version 3.0.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002224 And it is the default. If not present the options are
Bram Moolenaar071d4272004-06-13 20:20:40 +00002225 set when the buffer is created.
2226 *cpo-S*
2227 S Set buffer options always when entering a buffer
2228 (except 'readonly', 'fileformat', 'filetype' and
2229 'syntax'). This is the (most) Vi compatible setting.
2230 The options are set to the values in the current
2231 buffer. When you change an option and go to another
2232 buffer, the value is copied. Effectively makes the
2233 buffer options global to all buffers.
2234
2235 's' 'S' copy buffer options
2236 no no when buffer created
2237 yes no when buffer first entered (default)
2238 X yes each time when buffer entered (vi comp.)
2239 *cpo-t*
2240 t Search pattern for the tag command is remembered for
2241 "n" command. Otherwise Vim only puts the pattern in
2242 the history for search pattern, but doesn't change the
2243 last used search pattern.
2244 *cpo-u*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002245 u Undo is Vi compatible. See |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002246 *cpo-v*
2247 v Backspaced characters remain visible on the screen in
2248 Insert mode. Without this flag the characters are
2249 erased from the screen right away. With this flag the
2250 screen newly typed text overwrites backspaced
2251 characters.
2252 *cpo-w*
2253 w When using "cw" on a blank character, only change one
2254 character and not all blanks until the start of the
2255 next word.
2256 *cpo-W*
2257 W Don't overwrite a readonly file. When omitted, ":w!"
2258 overwrites a readonly file, if possible.
2259 *cpo-x*
2260 x <Esc> on the command-line executes the command-line.
2261 The default in Vim is to abandon the command-line,
2262 because <Esc> normally aborts a command. |c_<Esc>|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002263 *cpo-X*
2264 X When using a count with "R" the replaced text is
2265 deleted only once. Also when repeating "R" with "."
2266 and a count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002267 *cpo-y*
Bram Moolenaard09091d2019-01-17 16:07:22 +01002268 y A yank command can be redone with ".". Think twice if
2269 you really want to use this, it may break some
2270 plugins, since most people expect "." to only repeat a
2271 change.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002272 *cpo-Z*
2273 Z When using "w!" while the 'readonly' option is set,
2274 don't reset 'readonly'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002275 *cpo-!*
2276 ! When redoing a filter command, use the last used
2277 external command, whatever it was. Otherwise the last
2278 used -filter- command is used.
2279 *cpo-$*
2280 $ When making a change to one line, don't redisplay the
2281 line, but put a '$' at the end of the changed text.
2282 The changed text will be overwritten when you type the
2283 new text. The line is redisplayed if you type any
2284 command that moves the cursor from the insertion
2285 point.
2286 *cpo-%*
2287 % Vi-compatible matching is done for the "%" command.
2288 Does not recognize "#if", "#endif", etc.
2289 Does not recognize "/*" and "*/".
2290 Parens inside single and double quotes are also
2291 counted, causing a string that contains a paren to
2292 disturb the matching. For example, in a line like
2293 "if (strcmp("foo(", s))" the first paren does not
2294 match the last one. When this flag is not included,
2295 parens inside single and double quotes are treated
2296 specially. When matching a paren outside of quotes,
2297 everything inside quotes is ignored. When matching a
2298 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002299 there is one). This works very well for C programs.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002300 This flag is also used for other features, such as
2301 C-indenting.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002302 *cpo--*
2303 - When included, a vertical movement command fails when
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002304 it would go above the first line or below the last
2305 line. Without it the cursor moves to the first or
2306 last line, unless it already was in that line.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002307 Applies to the commands "-", "k", CTRL-P, "+", "j",
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002308 CTRL-N, CTRL-J and ":1234".
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002309 *cpo-+*
2310 + When included, a ":write file" command will reset the
2311 'modified' flag of the buffer, even though the buffer
2312 itself may still be different from its file.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002313 *cpo-star*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002314 * Use ":*" in the same way as ":@". When not included,
2315 ":*" is an alias for ":'<,'>", select the Visual area.
2316 *cpo-<*
2317 < Disable the recognition of special key codes in |<>|
2318 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002319 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00002320 ":map X <Tab>" results in X being mapped to:
2321 '<' included: "<Tab>" (5 characters)
2322 '<' excluded: "^I" (^I is a real <Tab>)
2323 Also see the 'k' flag above.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002324 *cpo->*
2325 > When appending to a register, put a line break before
2326 the appended text.
Bram Moolenaar8b3e0332011-06-26 05:36:34 +02002327 *cpo-;*
2328 ; When using |,| or |;| to repeat the last |t| search
2329 and the cursor is right in front of the searched
2330 character, the cursor won't move. When not included,
2331 the cursor would skip over it and jump to the
Bram Moolenaarc8734422012-06-01 22:38:45 +02002332 following occurrence.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002333
2334 POSIX flags. These are not included in the Vi default value, except
2335 when $VIM_POSIX was set on startup. |posix|
2336
2337 contains behavior ~
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002338 *cpo-#*
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002339 # A count before "D", "o" and "O" has no effect.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002340 *cpo-&*
2341 & When ":preserve" was used keep the swap file when
2342 exiting normally while this buffer is still loaded.
2343 This flag is tested when exiting.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002344 *cpo-\*
2345 \ Backslash in a [] range in a search pattern is taken
2346 literally, only "\]" is special See |/[]|
Bram Moolenaar90915b52005-08-21 22:17:52 +00002347 '\' included: "/[ \-]" finds <Space>, '\' and '-'
2348 '\' excluded: "/[ \-]" finds <Space> and '-'
2349 Also see |cpo-l|.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002350 *cpo-/*
2351 / When "%" is used as the replacement string in a |:s|
2352 command, use the previous replacement string. |:s%|
2353 *cpo-{*
2354 { The |{| and |}| commands also stop at a "{" character
2355 at the start of a line.
2356 *cpo-.*
2357 . The ":chdir" and ":cd" commands fail if the current
2358 buffer is modified, unless ! is used. Vim doesn't
2359 need this, since it remembers the full path of an
2360 opened file.
2361 *cpo-bar*
2362 | The value of the $LINES and $COLUMNS environment
2363 variables overrule the terminal size values obtained
2364 with system specific functions.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002365
Bram Moolenaar071d4272004-06-13 20:20:40 +00002366
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002367 *'cryptmethod'* *'cm'*
Bram Moolenaara86187b2018-12-16 18:20:00 +01002368'cryptmethod' 'cm' string (default "blowfish2")
Bram Moolenaar49771f42010-07-20 17:32:38 +02002369 global or local to buffer |global-local|
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002370 Method used for encryption when the buffer is written to a file:
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002371 *pkzip*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002372 zip PkZip compatible method. A weak kind of encryption.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002373 Backwards compatible with Vim 7.2 and older.
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002374 *blowfish*
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002375 blowfish Blowfish method. Medium strong encryption but it has
2376 an implementation flaw. Requires Vim 7.3 or later,
2377 files can NOT be read by Vim 7.2 and older. This adds
2378 a "seed" to the file, every time you write the file
2379 the encrypted bytes will be different.
2380 *blowfish2*
2381 blowfish2 Blowfish method. Medium strong encryption. Requires
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01002382 Vim 7.4.401 or later, files can NOT be read by Vim 7.3
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002383 and older. This adds a "seed" to the file, every time
2384 you write the file the encrypted bytes will be
2385 different. The whole undo file is encrypted, not just
2386 the pieces of text.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002387
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01002388 You should use "blowfish2", also to re-encrypt older files.
2389
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002390 When reading an encrypted file 'cryptmethod' will be set automatically
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002391 to the detected method of the file being read. Thus if you write it
2392 without changing 'cryptmethod' the same method will be used.
2393 Changing 'cryptmethod' does not mark the file as modified, you have to
Bram Moolenaar49771f42010-07-20 17:32:38 +02002394 explicitly write it, you don't get a warning unless there are other
2395 modifications. Also see |:X|.
2396
2397 When setting the global value to an empty string, it will end up with
Bram Moolenaara86187b2018-12-16 18:20:00 +01002398 the value "blowfish2". When setting the local value to an empty
2399 string the buffer will use the global value.
Bram Moolenaar49771f42010-07-20 17:32:38 +02002400
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002401 When a new encryption method is added in a later version of Vim, and
2402 the current version does not recognize it, you will get *E821* .
Bram Moolenaar49771f42010-07-20 17:32:38 +02002403 You need to edit this file with the later version of Vim.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002404
2405
Bram Moolenaar071d4272004-06-13 20:20:40 +00002406 *'cscopepathcomp'* *'cspc'*
2407'cscopepathcomp' 'cspc' number (default 0)
2408 global
2409 {not available when compiled without the |+cscope|
2410 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002411 Determines how many components of the path to show in a list of tags.
2412 See |cscopepathcomp|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002413 NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002414
2415 *'cscopeprg'* *'csprg'*
2416'cscopeprg' 'csprg' string (default "cscope")
2417 global
2418 {not available when compiled without the |+cscope|
2419 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002420 Specifies the command to execute cscope. See |cscopeprg|.
2421 This option cannot be set from a |modeline| or in the |sandbox|, for
2422 security reasons.
2423
2424 *'cscopequickfix'* *'csqf'*
2425'cscopequickfix' 'csqf' string (default "")
2426 global
2427 {not available when compiled without the |+cscope|
2428 or |+quickfix| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002429 Specifies whether to use quickfix window to show cscope results.
2430 See |cscopequickfix|.
2431
Bram Moolenaarec7944a2013-06-12 21:29:15 +02002432 *'cscoperelative'* *'csre'* *'nocscoperelative'* *'nocsre'*
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002433'cscoperelative' 'csre' boolean (default off)
2434 global
2435 {not available when compiled without the |+cscope|
2436 feature}
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002437 In the absence of a prefix (-P) for cscope. setting this option enables
2438 to use the basename of cscope.out path as the prefix.
2439 See |cscoperelative|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002440 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002441
Bram Moolenaar071d4272004-06-13 20:20:40 +00002442 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
2443'cscopetag' 'cst' boolean (default off)
2444 global
2445 {not available when compiled without the |+cscope|
2446 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002447 Use cscope for tag commands. See |cscope-options|.
2448 NOTE: This option is reset when 'compatible' is set.
2449
2450 *'cscopetagorder'* *'csto'*
2451'cscopetagorder' 'csto' number (default 0)
2452 global
2453 {not available when compiled without the |+cscope|
2454 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002455 Determines the order in which ":cstag" performs a search. See
2456 |cscopetagorder|.
2457 NOTE: This option is set to 0 when 'compatible' is set.
2458
2459 *'cscopeverbose'* *'csverb'*
2460 *'nocscopeverbose'* *'nocsverb'*
2461'cscopeverbose' 'csverb' boolean (default off)
2462 global
2463 {not available when compiled without the |+cscope|
2464 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002465 Give messages when adding a cscope database. See |cscopeverbose|.
2466 NOTE: This option is reset when 'compatible' is set.
2467
Bram Moolenaar860cae12010-06-05 23:22:07 +02002468 *'cursorbind'* *'crb'* *'nocursorbind'* *'nocrb'*
2469'cursorbind' 'crb' boolean (default off)
2470 local to window
Bram Moolenaar860cae12010-06-05 23:22:07 +02002471 When this option is set, as the cursor in the current
2472 window moves other cursorbound windows (windows that also have
2473 this option set) move their cursors to the corresponding line and
2474 column. This option is useful for viewing the
2475 differences between two versions of a file (see 'diff'); in diff mode,
2476 inserted and deleted lines (though not characters within a line) are
Bram Moolenaar1a384422010-07-14 19:53:30 +02002477 taken into account.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002478
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002479
2480 *'cursorcolumn'* *'cuc'* *'nocursorcolumn'* *'nocuc'*
2481'cursorcolumn' 'cuc' boolean (default off)
2482 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02002483 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002484 feature}
2485 Highlight the screen column of the cursor with CursorColumn
2486 |hl-CursorColumn|. Useful to align text. Will make screen redrawing
2487 slower.
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00002488 If you only want the highlighting in the current window you can use
2489 these autocommands: >
2490 au WinLeave * set nocursorline nocursorcolumn
2491 au WinEnter * set cursorline cursorcolumn
2492<
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002493
2494 *'cursorline'* *'cul'* *'nocursorline'* *'nocul'*
2495'cursorline' 'cul' boolean (default off)
2496 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02002497 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002498 feature}
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002499 Highlight the text line of the cursor with CursorLine |hl-CursorLine|.
2500 Useful to easily spot the cursor. Will make screen redrawing slower.
Bram Moolenaare2f98b92006-03-29 21:18:24 +00002501 When Visual mode is active the highlighting isn't used to make it
Bram Moolenaar779b74b2006-04-10 14:55:34 +00002502 easier to see the selected text.
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002503
2504
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002505 *'cursorlineopt'* *'culopt'*
Bram Moolenaar017ba072019-09-14 21:01:23 +02002506'cursorlineopt' 'culopt' string (default: "number,line")
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002507 local to window
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002508 {not available when compiled without the |+syntax|
2509 feature}
Bram Moolenaar017ba072019-09-14 21:01:23 +02002510 Comma separated list of settings for how 'cursorline' is displayed.
2511 Valid values:
2512 "line" Highlight the text line of the cursor with
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002513 CursorLine |hl-CursorLine|.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002514 "screenline" Highlight only the screen line of the cursor with
2515 CursorLine |hl-CursorLine|.
2516 "number" Highlight the line number of the cursor with
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002517 CursorLineNr |hl-CursorLineNr|.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002518
2519 Special value:
2520 "both" Alias for the values "line,number".
2521
2522 "line" and "screenline" cannot be used together.
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002523
2524
Bram Moolenaar071d4272004-06-13 20:20:40 +00002525 *'debug'*
2526'debug' string (default "")
2527 global
Bram Moolenaar57657d82006-04-21 22:12:41 +00002528 These values can be used:
2529 msg Error messages that would otherwise be omitted will be given
2530 anyway.
2531 throw Error messages that would otherwise be omitted will be given
2532 anyway and also throw an exception and set |v:errmsg|.
2533 beep A message will be given when otherwise only a beep would be
2534 produced.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002535 The values can be combined, separated by a comma.
Bram Moolenaar57657d82006-04-21 22:12:41 +00002536 "msg" and "throw" are useful for debugging 'foldexpr', 'formatexpr' or
2537 'indentexpr'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002538
2539 *'define'* *'def'*
2540'define' 'def' string (default "^\s*#\s*define")
2541 global or local to buffer |global-local|
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002542 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002543 pattern, just like for the "/" command. This option is used for the
2544 commands like "[i" and "[d" |include-search|. The 'isident' option is
2545 used to recognize the defined name after the match:
2546 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2547 See |option-backslash| about inserting backslashes to include a space
2548 or backslash.
2549 The default value is for C programs. For C++ this value would be
2550 useful, to include const type declarations: >
2551 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
Bram Moolenaar63b74a82019-03-24 15:09:13 +01002552< You can also use "\ze" just before the name and continue the pattern
2553 to check what is following. E.g. for Javascript, if a function is
2554 defined with "func_name = function(args)": >
2555 ^\s*\ze\i\+\s*=\s*function(
2556< If the function is defined with "func_name : function() {...": >
2557 ^\s*\ze\i\+\s*[:]\s*(*function\s*(
Bram Moolenaar071d4272004-06-13 20:20:40 +00002558< When using the ":set" command, you need to double the backslashes!
Bram Moolenaar63b74a82019-03-24 15:09:13 +01002559 To avoid that use `:let` with a single quote string: >
2560 let &l:define = '^\s*\ze\k\+\s*=\s*function('
Bram Moolenaar911ead12019-04-21 00:03:35 +02002561<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002562
2563 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2564'delcombine' 'deco' boolean (default off)
2565 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002566 If editing Unicode and this option is set, backspace and Normal mode
2567 "x" delete each combining character on its own. When it is off (the
2568 default) the character along with its combining characters are
2569 deleted.
Bram Moolenaar4f4d51a2020-10-11 13:57:40 +02002570 Note: When 'delcombine' is set "xx" may work differently from "2x"!
Bram Moolenaar071d4272004-06-13 20:20:40 +00002571
2572 This is useful for Arabic, Hebrew and many other languages where one
2573 may have combining characters overtop of base characters, and want
2574 to remove only the combining ones.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002575 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002576
2577 *'dictionary'* *'dict'*
2578'dictionary' 'dict' string (default "")
2579 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002580 List of file names, separated by commas, that are used to lookup words
2581 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2582 contain a list of words. This can be one word per line, or several
2583 words per line, separated by non-keyword characters (white space is
2584 preferred). Maximum line length is 510 bytes.
Bram Moolenaar259f26a2018-05-15 22:25:40 +02002585
2586 When this option is empty or an entry "spell" is present, and spell
2587 checking is enabled, words in the word lists for the currently active
2588 'spelllang' are used. See |spell|.
2589
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002590 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002591 after a comma are ignored, otherwise spaces are included in the file
2592 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002593 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002594 Where to find a list of words?
2595 - On FreeBSD, there is the file "/usr/share/dict/words".
2596 - In the Simtel archive, look in the "msdos/linguist" directory.
2597 - In "miscfiles" of the GNU collection.
2598 The use of |:set+=| and |:set-=| is preferred when adding or removing
2599 directories from the list. This avoids problems when a future version
2600 uses another default.
2601 Backticks cannot be used in this option for security reasons.
2602
2603 *'diff'* *'nodiff'*
2604'diff' boolean (default off)
2605 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00002606 {not available when compiled without the |+diff|
2607 feature}
2608 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002609 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002610
2611 *'dex'* *'diffexpr'*
2612'diffexpr' 'dex' string (default "")
2613 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002614 {not available when compiled without the |+diff|
2615 feature}
Bram Moolenaare828b762018-09-10 17:51:58 +02002616 Expression which is evaluated to obtain a diff file (either ed-style
2617 or unified-style) from two versions of a file. See |diff-diffexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002618 This option cannot be set from a |modeline| or in the |sandbox|, for
2619 security reasons.
2620
2621 *'dip'* *'diffopt'*
Bram Moolenaarc8234772019-11-10 21:00:27 +01002622'diffopt' 'dip' string (default "internal,filler,closeoff")
Bram Moolenaar071d4272004-06-13 20:20:40 +00002623 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002624 {not available when compiled without the |+diff|
2625 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002626 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002627 All are optional. Items must be separated by a comma.
2628
2629 filler Show filler lines, to keep the text
2630 synchronized with a window that has inserted
2631 lines at the same position. Mostly useful
2632 when windows are side-by-side and 'scrollbind'
2633 is set.
2634
2635 context:{n} Use a context of {n} lines between a change
2636 and a fold that contains unchanged lines.
2637 When omitted a context of six lines is used.
Bram Moolenaarf6b40102019-02-22 15:24:03 +01002638 When using zero the context is actually one,
2639 since folds require a line in between, also
2640 for a deleted line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002641 See |fold-diff|.
2642
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002643 iblank Ignore changes where lines are all blank. Adds
2644 the "-B" flag to the "diff" command if
2645 'diffexpr' is empty. Check the documentation
2646 of the "diff" command for what this does
2647 exactly.
2648 NOTE: the diff windows will get out of sync,
2649 because no differences between blank lines are
2650 taken into account.
2651
Bram Moolenaar071d4272004-06-13 20:20:40 +00002652 icase Ignore changes in case of text. "a" and "A"
2653 are considered the same. Adds the "-i" flag
2654 to the "diff" command if 'diffexpr' is empty.
2655
2656 iwhite Ignore changes in amount of white space. Adds
2657 the "-b" flag to the "diff" command if
2658 'diffexpr' is empty. Check the documentation
2659 of the "diff" command for what this does
2660 exactly. It should ignore adding trailing
2661 white space, but not leading white space.
2662
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002663 iwhiteall Ignore all white space changes. Adds
2664 the "-w" flag to the "diff" command if
2665 'diffexpr' is empty. Check the documentation
2666 of the "diff" command for what this does
2667 exactly.
2668
2669 iwhiteeol Ignore white space changes at end of line.
2670 Adds the "-Z" flag to the "diff" command if
2671 'diffexpr' is empty. Check the documentation
2672 of the "diff" command for what this does
2673 exactly.
2674
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002675 horizontal Start diff mode with horizontal splits (unless
2676 explicitly specified otherwise).
2677
2678 vertical Start diff mode with vertical splits (unless
2679 explicitly specified otherwise).
2680
Bram Moolenaarc8234772019-11-10 21:00:27 +01002681 closeoff When a window is closed where 'diff' is set
2682 and there is only one window remaining in the
2683 same tab page with 'diff' set, execute
2684 `:diffoff` in that window. This undoes a
2685 `:diffsplit` command.
2686
Bram Moolenaar97ce4192017-12-01 20:35:58 +01002687 hiddenoff Do not use diff mode for a buffer when it
2688 becomes hidden.
2689
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002690 foldcolumn:{n} Set the 'foldcolumn' option to {n} when
2691 starting diff mode. Without this 2 is used.
2692
Bram Moolenaar4223d432021-02-10 13:18:17 +01002693 followwrap Follow the 'wrap' option and leave as it is.
2694
Bram Moolenaare828b762018-09-10 17:51:58 +02002695 internal Use the internal diff library. This is
2696 ignored when 'diffexpr' is set. *E960*
2697 When running out of memory when writing a
2698 buffer this item will be ignored for diffs
2699 involving that buffer. Set the 'verbose'
2700 option to see when this happens.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002701
Bram Moolenaare828b762018-09-10 17:51:58 +02002702 indent-heuristic
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01002703 Use the indent heuristic for the internal
2704 diff library.
Bram Moolenaare828b762018-09-10 17:51:58 +02002705
2706 algorithm:{text} Use the specified diff algorithm with the
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01002707 internal diff engine. Currently supported
Bram Moolenaare828b762018-09-10 17:51:58 +02002708 algorithms are:
2709 myers the default algorithm
2710 minimal spend extra time to generate the
2711 smallest possible diff
2712 patience patience diff algorithm
2713 histogram histogram diff algorithm
2714
2715 Examples: >
2716 :set diffopt=internal,filler,context:4
Bram Moolenaar071d4272004-06-13 20:20:40 +00002717 :set diffopt=
Bram Moolenaare828b762018-09-10 17:51:58 +02002718 :set diffopt=internal,filler,foldcolumn:3
2719 :set diffopt-=internal " do NOT use the internal diff parser
Bram Moolenaar071d4272004-06-13 20:20:40 +00002720<
2721 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
2722'digraph' 'dg' boolean (default off)
2723 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002724 {not available when compiled without the |+digraphs|
2725 feature}
2726 Enable the entering of digraphs in Insert mode with {char1} <BS>
2727 {char2}. See |digraphs|.
2728 NOTE: This option is reset when 'compatible' is set.
2729
2730 *'directory'* *'dir'*
2731'directory' 'dir' string (default for Amiga: ".,t:",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01002732 for Win32: ".,$TEMP,c:\tmp,c:\temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00002733 for Unix: ".,~/tmp,/var/tmp,/tmp")
2734 global
2735 List of directory names for the swap file, separated with commas.
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02002736 Recommended value: ".,~/vimswap//" - this will put the swap file next
2737 to the edited file if possible, and in your personal swap directory
2738 otherwise. Make sure "~/vimswap//" is only readable for you.
2739
2740 Possible items:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002741 - The swap file will be created in the first directory where this is
2742 possible.
2743 - Empty means that no swap file will be used (recovery is
Bram Moolenaar00e192b2019-10-19 17:01:28 +02002744 impossible!) and no |E303| error will be given.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002745 - A directory "." means to put the swap file in the same directory as
2746 the edited file. On Unix, a dot is prepended to the file name, so
2747 it doesn't show in a directory listing. On MS-Windows the "hidden"
2748 attribute is set and a dot prepended if possible.
Bram Moolenaar8024f932020-01-14 19:29:13 +01002749 - A directory starting with "./" (or ".\" for MS-Windows) means to put
2750 the swap file relative to where the edited file is. The leading "."
2751 is replaced with the path name of the edited file.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02002752 - For Unix and Win32, if a directory ends in two path separators "//",
2753 the swap file name will be built from the complete path to the file
Bram Moolenaar207f0092020-08-30 17:20:20 +02002754 with all path separators replaced by percent '%' signs (including
2755 the colon following the drive letter on Win32). This will ensure
2756 file name uniqueness in the preserve directory.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02002757 On Win32, it is also possible to end with "\\". However, When a
2758 separating comma is following, you must use "//", since "\\" will
2759 include the comma in the file name. Therefore it is recommended to
2760 use '//', instead of '\\'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002761 - Spaces after the comma are ignored, other spaces are considered part
2762 of the directory name. To have a space at the start of a directory
2763 name, precede it with a backslash.
2764 - To include a comma in a directory name precede it with a backslash.
2765 - A directory name may end in an ':' or '/'.
2766 - Environment variables are expanded |:set_env|.
2767 - Careful with '\' characters, type one before a space, type two to
2768 get one in the option (see |option-backslash|), for example: >
2769 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
2770< - For backwards compatibility with Vim version 3.0 a '>' at the start
2771 of the option is removed.
2772 Using "." first in the list is recommended. This means that editing
2773 the same file twice will result in a warning. Using "/tmp" on Unix is
2774 discouraged: When the system crashes you lose the swap file.
2775 "/var/tmp" is often not cleared when rebooting, thus is a better
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02002776 choice than "/tmp". But others on the computer may be able to see the
2777 files, and it can contain a lot of files, your swap files get lost in
2778 the crowd. That is why a "tmp" directory in your home directory is
2779 tried first.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002780 The use of |:set+=| and |:set-=| is preferred when adding or removing
2781 directories from the list. This avoids problems when a future version
2782 uses another default.
2783 This option cannot be set from a |modeline| or in the |sandbox|, for
2784 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002785
2786 *'display'* *'dy'*
Bram Moolenaarbc8801c2016-08-02 21:04:33 +02002787'display' 'dy' string (default "", set to "truncate" in
2788 |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002789 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002790 Change the way text is displayed. This is comma separated list of
2791 flags:
2792 lastline When included, as much as possible of the last line
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02002793 in a window will be displayed. "@@@" is put in the
2794 last columns of the last screen line to indicate the
2795 rest of the line is not displayed.
2796 truncate Like "lastline", but "@@@" is displayed in the first
2797 column of the last screen line. Overrules "lastline".
Bram Moolenaar071d4272004-06-13 20:20:40 +00002798 uhex Show unprintable characters hexadecimal as <xx>
2799 instead of using ^C and ~C.
2800
Bram Moolenaard0796902016-09-16 20:02:31 +02002801 When neither "lastline" nor "truncate" is included, a last line that
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02002802 doesn't fit is replaced with "@" lines.
2803
Bram Moolenaar071d4272004-06-13 20:20:40 +00002804 *'eadirection'* *'ead'*
2805'eadirection' 'ead' string (default "both")
2806 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002807 Tells when the 'equalalways' option applies:
2808 ver vertically, width of windows is not affected
2809 hor horizontally, height of windows is not affected
2810 both width and height of windows is affected
2811
2812 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
2813'edcompatible' 'ed' boolean (default off)
2814 global
2815 Makes the 'g' and 'c' flags of the ":substitute" command to be
2816 toggled each time the flag is given. See |complex-change|. See
2817 also 'gdefault' option.
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +02002818 Switching this option on may break plugins!
Bram Moolenaar4072ba52020-12-23 13:56:35 +01002819 This option is not used in |Vim9| script.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002820
Bram Moolenaar03413f42016-04-12 21:07:15 +02002821 *'emoji'* *'emo'* *'noemoji'* *'noemo'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01002822'emoji' 'emo' boolean (default: on)
2823 global
Bram Moolenaar3848e002016-03-19 18:42:29 +01002824 When on all Unicode emoji characters are considered to be full width.
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02002825 This excludes "text emoji" characters, which are normally displayed as
2826 single width. Unfortunately there is no good specification for this
2827 and it has been determined on trial-and-error basis. Use the
2828 |setcellwidths()| function to change the behavior.
Bram Moolenaar3848e002016-03-19 18:42:29 +01002829
Bram Moolenaar071d4272004-06-13 20:20:40 +00002830 *'encoding'* *'enc'* *E543*
2831'encoding' 'enc' string (default: "latin1" or value from $LANG)
2832 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002833 Sets the character encoding used inside Vim. It applies to text in
2834 the buffers, registers, Strings in expressions, text stored in the
2835 viminfo file, etc. It sets the kind of characters which Vim can work
2836 with. See |encoding-names| for the possible values.
2837
2838 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002839 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002840 It should normally be kept at its default value, or set when Vim
Bram Moolenaar02467872007-05-06 13:22:01 +00002841 starts up. See |multibyte|. To reload the menus see |:menutrans|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002842
Bram Moolenaar865242e2010-07-14 21:12:05 +02002843 This option cannot be set from a |modeline|. It would most likely
2844 corrupt the text.
2845
Bram Moolenaar3df01732017-02-17 22:47:16 +01002846 NOTE: For GTK+ 2 or later, it is highly recommended to set 'encoding'
2847 to "utf-8". Although care has been taken to allow different values of
Bram Moolenaar071d4272004-06-13 20:20:40 +00002848 'encoding', "utf-8" is the natural choice for the environment and
2849 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002850 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00002851 versions, and to avoid changing the encoding of newly created files
2852 without your knowledge (in case 'fileencodings' is empty).
2853
2854 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002855 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00002856 iconv() or as specified with 'charconvert'.
2857
Bram Moolenaar207f0092020-08-30 17:20:20 +02002858 If you need to know whether 'encoding' is a multibyte encoding, you
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002859 can use: >
2860 if has("multi_byte_encoding")
2861<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002862 Normally 'encoding' will be equal to your current locale. This will
2863 be the default if Vim recognizes your environment settings. If
2864 'encoding' is not set to the current locale, 'termencoding' must be
2865 set to convert typed and displayed text. See |encoding-table|.
2866
2867 When you set this option, it fires the |EncodingChanged| autocommand
2868 event so that you can set up fonts if necessary.
2869
2870 When the option is set, the value is converted to lowercase. Thus
2871 you can set it with uppercase values too. Underscores are translated
2872 to '-' signs.
2873 When the encoding is recognized, it is changed to the standard name.
2874 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
2875 "iso-8859-2" and "utf8" becomes "utf-8".
2876
2877 Note: "latin1" is also used when the encoding could not be detected.
2878 This only works when editing files in the same encoding! When the
2879 actual character set is not latin1, make sure 'fileencoding' and
2880 'fileencodings' are empty. When conversion is needed, switch to using
2881 utf-8.
2882
2883 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
2884 You don't notice this while editing, but it does matter for the
2885 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
2886 setting 'encoding' to one of these values instead of utf-8 only has
2887 effect for encoding used for files when 'fileencoding' is empty.
2888
Bram Moolenaar661b1822005-07-28 22:36:45 +00002889 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
2890 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002891
2892 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
2893'endofline' 'eol' boolean (default on)
2894 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002895 When writing a file and this option is off and the 'binary' option
Bram Moolenaar34d72d42015-07-17 14:18:08 +02002896 is on, or 'fixeol' option is off, no <EOL> will be written for the
2897 last line in the file. This option is automatically set or reset when
2898 starting to edit a new file, depending on whether file has an <EOL>
2899 for the last line in the file. Normally you don't have to set or
2900 reset this option.
2901 When 'binary' is off and 'fixeol' is on the value is not used when
2902 writing the file. When 'binary' is on or 'fixeol' is off it is used
2903 to remember the presence of a <EOL> for the last line in the file, so
2904 that when you write the file the situation from the original file can
2905 be kept. But you can change it if you want to.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002906
2907 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
2908'equalalways' 'ea' boolean (default on)
2909 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002910 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00002911 splitting or closing a window. This also happens the moment the
2912 option is switched on. When off, splitting a window will reduce the
2913 size of the current window and leave the other windows the same. When
2914 closing a window the extra lines are given to the window next to it
2915 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00002916 When mixing vertically and horizontally split windows, a minimal size
2917 is computed and some windows may be larger if there is room. The
2918 'eadirection' option tells in which direction the size is affected.
Bram Moolenaar67f71312007-08-12 14:55:56 +00002919 Changing the height and width of a window can be avoided by setting
2920 'winfixheight' and 'winfixwidth', respectively.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002921 If a window size is specified when creating a new window sizes are
2922 currently not equalized (it's complicated, but may be implemented in
2923 the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002924
2925 *'equalprg'* *'ep'*
2926'equalprg' 'ep' string (default "")
2927 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002928 External program to use for "=" command. When this option is empty
Bram Moolenaar446cb832008-06-24 21:56:24 +00002929 the internal formatting functions are used; either 'lisp', 'cindent'
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002930 or 'indentexpr'. When Vim was compiled without internal formatting,
2931 the "indent" program is used.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002932 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002933 about including spaces and backslashes.
2934 This option cannot be set from a |modeline| or in the |sandbox|, for
2935 security reasons.
2936
2937 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
2938'errorbells' 'eb' boolean (default off)
2939 global
2940 Ring the bell (beep or screen flash) for error messages. This only
2941 makes a difference for error messages, the bell will be used always
2942 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002943 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar165bc692015-07-21 17:53:25 +02002944 screen flash or do nothing. See 'belloff' to finetune when to ring the
2945 bell.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002946
2947 *'errorfile'* *'ef'*
2948'errorfile' 'ef' string (Amiga default: "AztecC.Err",
2949 others: "errors.err")
2950 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002951 {not available when compiled without the |+quickfix|
2952 feature}
2953 Name of the errorfile for the QuickFix mode (see |:cf|).
2954 When the "-q" command-line argument is used, 'errorfile' is set to the
2955 following argument. See |-q|.
2956 NOT used for the ":make" command. See 'makeef' for that.
2957 Environment variables are expanded |:set_env|.
2958 See |option-backslash| about including spaces and backslashes.
2959 This option cannot be set from a |modeline| or in the |sandbox|, for
2960 security reasons.
2961
2962 *'errorformat'* *'efm'*
2963'errorformat' 'efm' string (default is very long)
2964 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002965 {not available when compiled without the |+quickfix|
2966 feature}
2967 Scanf-like description of the format for the lines in the error file
2968 (see |errorformat|).
2969
2970 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
2971'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
2972 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002973 Function keys that start with an <Esc> are recognized in Insert
2974 mode. When this option is off, the cursor and function keys cannot be
2975 used in Insert mode if they start with an <Esc>. The advantage of
2976 this is that the single <Esc> is recognized immediately, instead of
2977 after one second. Instead of resetting this option, you might want to
2978 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
2979 when 'esckeys' is off, you can still map anything, but the cursor keys
2980 won't work by default.
2981 NOTE: This option is set to the Vi default value when 'compatible' is
2982 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaarc8234772019-11-10 21:00:27 +01002983 NOTE: when this option is off then the |modifyOtherKeys| functionality
2984 is disabled while in Insert mode to avoid ending Insert mode with any
2985 key that has a modifier.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002986
2987 *'eventignore'* *'ei'*
2988'eventignore' 'ei' string (default "")
2989 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002990 A list of autocommand event names, which are to be ignored.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00002991 When set to "all" or when "all" is one of the items, all autocommand
2992 events are ignored, autocommands will not be executed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002993 Otherwise this is a comma separated list of event names. Example: >
2994 :set ei=WinEnter,WinLeave
2995<
2996 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
2997'expandtab' 'et' boolean (default off)
2998 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002999 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003000 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00003001 when 'autoindent' is on. To insert a real tab when 'expandtab' is
3002 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
Bram Moolenaarca635012015-09-25 20:34:21 +02003003 This option is reset when the 'paste' option is set and restored when
3004 the 'paste' option is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003005 NOTE: This option is reset when 'compatible' is set.
3006
3007 *'exrc'* *'ex'* *'noexrc'* *'noex'*
3008'exrc' 'ex' boolean (default off)
3009 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003010 Enables the reading of .vimrc, .exrc and .gvimrc in the current
Bram Moolenaar36f44c22016-08-28 18:17:20 +02003011 directory.
3012
3013 Setting this option is a potential security leak. E.g., consider
3014 unpacking a package or fetching files from github, a .vimrc in there
3015 might be a trojan horse. BETTER NOT SET THIS OPTION!
3016 Instead, define an autocommand in your .vimrc to set options for a
3017 matching directory.
3018
3019 If you do switch this option on you should also consider setting the
3020 'secure' option (see |initialization|).
3021 Also see |.vimrc| and |gui-init|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003022 This option cannot be set from a |modeline| or in the |sandbox|, for
3023 security reasons.
3024
3025 *'fileencoding'* *'fenc'* *E213*
3026'fileencoding' 'fenc' string (default: "")
3027 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003028 Sets the character encoding for the file of this buffer.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003029
Bram Moolenaar071d4272004-06-13 20:20:40 +00003030 When 'fileencoding' is different from 'encoding', conversion will be
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003031 done when writing the file. For reading see below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003032 When 'fileencoding' is empty, the same value as 'encoding' will be
3033 used (no conversion when reading or writing a file).
Bram Moolenaar214641f2017-03-05 17:04:09 +01003034 No error will be given when the value is set, only when it is used,
3035 only when writing a file.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003036 Conversion will also be done when 'encoding' and 'fileencoding' are
3037 both a Unicode encoding and 'fileencoding' is not utf-8. That's
3038 because internally Unicode is always stored as utf-8.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003039 WARNING: Conversion can cause loss of information! When
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003040 'encoding' is "utf-8" or another Unicode encoding, conversion
3041 is most likely done in a way that the reverse conversion
3042 results in the same text. When 'encoding' is not "utf-8" some
3043 characters may be lost!
Bram Moolenaar865242e2010-07-14 21:12:05 +02003044
Bram Moolenaar071d4272004-06-13 20:20:40 +00003045 See 'encoding' for the possible values. Additionally, values may be
3046 specified that can be handled by the converter, see
3047 |mbyte-conversion|.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003048
Bram Moolenaar071d4272004-06-13 20:20:40 +00003049 When reading a file 'fileencoding' will be set from 'fileencodings'.
3050 To read a file in a certain encoding it won't work by setting
Bram Moolenaar02467872007-05-06 13:22:01 +00003051 'fileencoding', use the |++enc| argument. One exception: when
3052 'fileencodings' is empty the value of 'fileencoding' is used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003053 For a new file the global value of 'fileencoding' is used.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003054
Bram Moolenaar071d4272004-06-13 20:20:40 +00003055 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
3056 When the option is set, the value is converted to lowercase. Thus
3057 you can set it with uppercase values too. '_' characters are
3058 replaced with '-'. If a name is recognized from the list for
3059 'encoding', it is replaced by the standard name. For example
3060 "ISO8859-2" becomes "iso-8859-2".
Bram Moolenaar865242e2010-07-14 21:12:05 +02003061
Bram Moolenaar071d4272004-06-13 20:20:40 +00003062 When this option is set, after starting to edit a file, the 'modified'
3063 option is set, because the file would be different when written.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003064
3065 Keep in mind that changing 'fenc' from a modeline happens
3066 AFTER the text has been read, thus it applies to when the file will be
3067 written. If you do set 'fenc' in a modeline, you might want to set
3068 'nomodified' to avoid not being able to ":q".
3069
Bram Moolenaar071d4272004-06-13 20:20:40 +00003070 This option can not be changed when 'modifiable' is off.
3071
3072 *'fe'*
3073 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003074 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003075 old short name was 'fe', which is no longer used.
3076
3077 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003078'fileencodings' 'fencs' string (default: "ucs-bom",
3079 "ucs-bom,utf-8,default,latin1" when
3080 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003081 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003082 This is a list of character encodings considered when starting to edit
3083 an existing file. When a file is read, Vim tries to use the first
3084 mentioned character encoding. If an error is detected, the next one
3085 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003086 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00003087 an empty string, which means the value of 'encoding' is used.
3088 WARNING: Conversion can cause loss of information! When
3089 'encoding' is "utf-8" (or one of the other Unicode variants)
3090 conversion is most likely done in a way that the reverse
3091 conversion results in the same text. When 'encoding' is not
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003092 "utf-8" some non-ASCII characters may be lost! You can use
3093 the |++bad| argument to specify what is done with characters
3094 that can't be converted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003095 For an empty file or a file with only ASCII characters most encodings
3096 will work and the first entry of 'fileencodings' will be used (except
3097 "ucs-bom", which requires the BOM to be present). If you prefer
3098 another encoding use an BufReadPost autocommand event to test if your
3099 preferred encoding is to be used. Example: >
3100 au BufReadPost * if search('\S', 'w') == 0 |
3101 \ set fenc=iso-2022-jp | endif
3102< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
3103 non-blank characters.
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003104 When the |++enc| argument is used then the value of 'fileencodings' is
3105 not used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003106 Note that 'fileencodings' is not used for a new file, the global value
3107 of 'fileencoding' is used instead. You can set it with: >
3108 :setglobal fenc=iso-8859-2
3109< This means that a non-existing file may get a different encoding than
3110 an empty file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003111 The special value "ucs-bom" can be used to check for a Unicode BOM
3112 (Byte Order Mark) at the start of the file. It must not be preceded
3113 by "utf-8" or another Unicode encoding for this to work properly.
3114 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
3115 because Vim cannot detect an error, thus the encoding is always
3116 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003117 The special value "default" can be used for the encoding from the
3118 environment. This is the default value for 'encoding'. It is useful
3119 when 'encoding' is set to "utf-8" and your environment uses a
3120 non-latin1 encoding, such as Russian.
Bram Moolenaarca003e12006-03-17 23:19:38 +00003121 When 'encoding' is "utf-8" and a file contains an illegal byte
3122 sequence it won't be recognized as UTF-8. You can use the |8g8|
3123 command to find the illegal byte sequence.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003124 WRONG VALUES: WHAT'S WRONG:
3125 latin1,utf-8 "latin1" will always be used
3126 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
3127 file
3128 cp1250,latin1 "cp1250" will always be used
3129 If 'fileencodings' is empty, 'fileencoding' is not modified.
3130 See 'fileencoding' for the possible values.
3131 Setting this option does not have an effect until the next time a file
3132 is read.
3133
3134 *'fileformat'* *'ff'*
Bram Moolenaar00590742019-02-15 21:06:09 +01003135'fileformat' 'ff' string (MS-Windows default: "dos",
3136 Unix, macOS default: "unix")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003137 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003138 This gives the <EOL> of the current buffer, which is used for
3139 reading/writing the buffer from/to a file:
Bram Moolenaar4072ba52020-12-23 13:56:35 +01003140 dos <CR><NL>
Bram Moolenaar071d4272004-06-13 20:20:40 +00003141 unix <NL>
3142 mac <CR>
3143 When "dos" is used, CTRL-Z at the end of a file is ignored.
3144 See |file-formats| and |file-read|.
3145 For the character encoding of the file see 'fileencoding'.
3146 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
Bram Moolenaarbf884932013-04-05 22:26:15 +02003147 works like it was set to "unix".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003148 This option is set automatically when starting to edit a file and
3149 'fileformats' is not empty and 'binary' is off.
3150 When this option is set, after starting to edit a file, the 'modified'
3151 option is set, because the file would be different when written.
3152 This option can not be changed when 'modifiable' is off.
3153 For backwards compatibility: When this option is set to "dos",
3154 'textmode' is set, otherwise 'textmode' is reset.
3155
3156 *'fileformats'* *'ffs'*
3157'fileformats' 'ffs' string (default:
Bram Moolenaar00590742019-02-15 21:06:09 +01003158 Vim+Vi MS-Windows: "dos,unix",
3159 Vim Unix, macOS: "unix,dos",
Bram Moolenaar071d4272004-06-13 20:20:40 +00003160 Vi Cygwin: "unix,dos",
3161 Vi others: "")
3162 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003163 This gives the end-of-line (<EOL>) formats that will be tried when
3164 starting to edit a new buffer and when reading a file into an existing
3165 buffer:
3166 - When empty, the format defined with 'fileformat' will be used
3167 always. It is not set automatically.
3168 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003169 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003170 'fileformats' name will be used when a file is read into an existing
3171 buffer, no matter what 'fileformat' for that buffer is set to.
3172 - When more than one name is present, separated by commas, automatic
3173 <EOL> detection will be done when reading a file. When starting to
3174 edit a file, a check is done for the <EOL>:
3175 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
3176 'fileformat' is set to "dos".
3177 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003178 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003179 preceding <CR>, "unix" is preferred over "dos".
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01003180 3. If 'fileformat' has not yet been set, and if a <CR> is found, and
3181 if 'fileformats' includes "mac", 'fileformat' is set to "mac".
Bram Moolenaar00659062010-09-21 22:34:02 +02003182 This means that "mac" is only chosen when:
3183 "unix" is not present or no <NL> is found in the file, and
3184 "dos" is not present or no <CR><NL> is found in the file.
3185 Except: if "unix" was chosen, but there is a <CR> before
3186 the first <NL>, and there appear to be more <CR>s than <NL>s in
Bram Moolenaar166af9b2010-11-16 20:34:40 +01003187 the first few lines, "mac" is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003188 4. If 'fileformat' is still not set, the first name from
3189 'fileformats' is used.
3190 When reading a file into an existing buffer, the same is done, but
3191 this happens like 'fileformat' has been set appropriately for that
3192 file only, the option is not changed.
3193 When 'binary' is set, the value of 'fileformats' is not used.
3194
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01003195 When Vim starts up with an empty buffer the first item is used. You
3196 can overrule this by setting 'fileformat' in your .vimrc.
Bram Moolenaar81af9252010-12-10 20:35:50 +01003197
Bram Moolenaar071d4272004-06-13 20:20:40 +00003198 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
3199 are ":source"ed and for vimrc files, automatic <EOL> detection may be
3200 done:
3201 - When 'fileformats' is empty, there is no automatic detection. Dos
3202 format will be used.
3203 - When 'fileformats' is set to one or more names, automatic detection
3204 is done. This is based on the first <NL> in the file: If there is a
3205 <CR> in front of it, Dos format is used, otherwise Unix format is
3206 used.
3207 Also see |file-formats|.
3208 For backwards compatibility: When this option is set to an empty
3209 string or one format (no comma is included), 'textauto' is reset,
3210 otherwise 'textauto' is set.
3211 NOTE: This option is set to the Vi default value when 'compatible' is
3212 set and to the Vim default value when 'compatible' is reset.
3213
Bram Moolenaarbf884932013-04-05 22:26:15 +02003214 *'fileignorecase'* *'fic'* *'nofileignorecase'* *'nofic'*
3215'fileignorecase' 'fic' boolean (default on for systems where case in file
3216 names is normally ignored)
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003217 global
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003218 When set case is ignored when using file names and directories.
3219 See 'wildignorecase' for only ignoring case when doing completion.
3220
Bram Moolenaar071d4272004-06-13 20:20:40 +00003221 *'filetype'* *'ft'*
3222'filetype' 'ft' string (default: "")
3223 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003224 When this option is set, the FileType autocommand event is triggered.
3225 All autocommands that match with the value of this option will be
3226 executed. Thus the value of 'filetype' is used in place of the file
3227 name.
3228 Otherwise this option does not always reflect the current file type.
3229 This option is normally set when the file type is detected. To enable
3230 this use the ":filetype on" command. |:filetype|
3231 Setting this option to a different value is most useful in a modeline,
3232 for a file for which the file type is not automatically recognized.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003233 Example, for in an IDL file:
3234 /* vim: set filetype=idl : */ ~
3235 |FileType| |filetypes|
3236 When a dot appears in the value then this separates two filetype
3237 names. Example:
3238 /* vim: set filetype=c.doxygen : */ ~
3239 This will use the "c" filetype first, then the "doxygen" filetype.
3240 This works both for filetype plugins and for syntax files. More than
3241 one dot may appear.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003242 This option is not copied to another buffer, independent of the 's' or
3243 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003244 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003245
3246 *'fillchars'* *'fcs'*
Bram Moolenaara98f8a22021-02-13 18:24:23 +01003247'fillchars' 'fcs' string (default "vert:|,fold:-,eob:~")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003248 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02003249 {not available when compiled without the |+folding|
3250 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003251 Characters to fill the statuslines and vertical separators.
3252 It is a comma separated list of items:
3253
3254 item default Used for ~
3255 stl:c ' ' or '^' statusline of the current window
Bram Moolenaar38a55632016-02-15 22:07:32 +01003256 stlnc:c ' ' or '=' statusline of the non-current windows
Bram Moolenaar071d4272004-06-13 20:20:40 +00003257 vert:c '|' vertical separators |:vsplit|
3258 fold:c '-' filling 'foldtext'
Bram Moolenaar3aca5a62021-02-17 13:14:07 +01003259 foldopen:c '-' mark the beginning of a fold
3260 foldclose:c '+' show a closed fold
3261 foldsep:c '|' open fold middle character
Bram Moolenaar071d4272004-06-13 20:20:40 +00003262 diff:c '-' deleted lines of the 'diff' option
Bram Moolenaara98f8a22021-02-13 18:24:23 +01003263 eob:c '~' empty lines below the end of a buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003264
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003265 Any one that is omitted will fall back to the default. For "stl" and
Bram Moolenaar38a55632016-02-15 22:07:32 +01003266 "stlnc" the space will be used when there is highlighting, '^' or '='
Bram Moolenaar071d4272004-06-13 20:20:40 +00003267 otherwise.
3268
3269 Example: >
Bram Moolenaar38a55632016-02-15 22:07:32 +01003270 :set fillchars=stl:^,stlnc:=,vert:\|,fold:-,diff:-
Bram Moolenaar071d4272004-06-13 20:20:40 +00003271< This is similar to the default, except that these characters will also
3272 be used when there is highlighting.
3273
Bram Moolenaar008bff92021-03-04 21:55:58 +01003274 For "stl" and "stlnc" single-byte and multibyte characters are
3275 supported. But double-width characters are not supported.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003276
Bram Moolenaar071d4272004-06-13 20:20:40 +00003277 The highlighting used for these items:
3278 item highlight group ~
3279 stl:c StatusLine |hl-StatusLine|
3280 stlnc:c StatusLineNC |hl-StatusLineNC|
3281 vert:c VertSplit |hl-VertSplit|
3282 fold:c Folded |hl-Folded|
3283 diff:c DiffDelete |hl-DiffDelete|
Bram Moolenaara98f8a22021-02-13 18:24:23 +01003284 eob:c EndOfBuffer |hl-EndOfBuffer|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003285
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003286 *'fixendofline'* *'fixeol'* *'nofixendofline'* *'nofixeol'*
3287'fixendofline' 'fixeol' boolean (default on)
3288 local to buffer
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003289 When writing a file and this option is on, <EOL> at the end of file
3290 will be restored if missing. Turn this option off if you want to
3291 preserve the situation from the original file.
3292 When the 'binary' option is set the value of this option doesn't
3293 matter.
3294 See the 'endofline' option.
3295
Bram Moolenaar071d4272004-06-13 20:20:40 +00003296 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
Bram Moolenaar98a29d02021-01-18 19:55:44 +01003297'fkmap' 'fk' boolean (default off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003298 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003299 {only available when compiled with the |+rightleft|
3300 feature}
Bram Moolenaar14184a32019-02-16 15:10:30 +01003301 This option was for using Farsi, which has been removed. See
3302 |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003303
3304 *'foldclose'* *'fcl'*
3305'foldclose' 'fcl' string (default "")
3306 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003307 {not available when compiled without the |+folding|
3308 feature}
3309 When set to "all", a fold is closed when the cursor isn't in it and
3310 its level is higher than 'foldlevel'. Useful if you want folds to
3311 automatically close when moving out of them.
3312
3313 *'foldcolumn'* *'fdc'*
3314'foldcolumn' 'fdc' number (default 0)
3315 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003316 {not available when compiled without the |+folding|
3317 feature}
3318 When non-zero, a column with the specified width is shown at the side
3319 of the window which indicates open and closed folds. The maximum
3320 value is 12.
3321 See |folding|.
3322
3323 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
3324'foldenable' 'fen' boolean (default on)
3325 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003326 {not available when compiled without the |+folding|
3327 feature}
3328 When off, all folds are open. This option can be used to quickly
3329 switch between showing all text unfolded and viewing the text with
3330 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003331 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00003332 'foldenable' is off.
3333 This option is set by commands that create a new fold or close a fold.
3334 See |folding|.
3335
3336 *'foldexpr'* *'fde'*
3337'foldexpr' 'fde' string (default: "0")
3338 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003339 {not available when compiled without the |+folding|
Bram Moolenaardb84e452010-08-15 13:50:43 +02003340 or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003341 The expression used for when 'foldmethod' is "expr". It is evaluated
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003342 for each line to obtain its fold level. See |fold-expr|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003343
Bram Moolenaar30b65812012-07-12 22:01:11 +02003344 The expression will be evaluated in the |sandbox| if set from a
3345 modeline, see |sandbox-option|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003346 This option can't be set from a |modeline| when the 'diff' option is
Bram Moolenaar110289e2019-05-23 15:38:06 +02003347 on or the 'modelineexpr' option is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003348
3349 It is not allowed to change text or jump to another window while
3350 evaluating 'foldexpr' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003351
3352 *'foldignore'* *'fdi'*
3353'foldignore' 'fdi' string (default: "#")
3354 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003355 {not available when compiled without the |+folding|
3356 feature}
3357 Used only when 'foldmethod' is "indent". Lines starting with
3358 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003359 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003360 The default "#" works well for C programs. See |fold-indent|.
3361
3362 *'foldlevel'* *'fdl'*
3363'foldlevel' 'fdl' number (default: 0)
3364 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003365 {not available when compiled without the |+folding|
3366 feature}
3367 Sets the fold level: Folds with a higher level will be closed.
3368 Setting this option to zero will close all folds. Higher numbers will
3369 close fewer folds.
3370 This option is set by commands like |zm|, |zM| and |zR|.
3371 See |fold-foldlevel|.
3372
3373 *'foldlevelstart'* *'fdls'*
3374'foldlevelstart' 'fdls' number (default: -1)
3375 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003376 {not available when compiled without the |+folding|
3377 feature}
3378 Sets 'foldlevel' when starting to edit another buffer in a window.
3379 Useful to always start editing with all folds closed (value zero),
3380 some folds closed (one) or no folds closed (99).
3381 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003382 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00003383 ignores this option and closes all folds.
3384 It is also done before BufReadPre autocommands, to allow an autocmd to
3385 overrule the 'foldlevel' value for specific files.
3386 When the value is negative, it is not used.
3387
3388 *'foldmarker'* *'fmr'* *E536*
3389'foldmarker' 'fmr' string (default: "{{{,}}}")
3390 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003391 {not available when compiled without the |+folding|
3392 feature}
3393 The start and end marker used when 'foldmethod' is "marker". There
3394 must be one comma, which separates the start and end marker. The
3395 marker is a literal string (a regular expression would be too slow).
3396 See |fold-marker|.
3397
3398 *'foldmethod'* *'fdm'*
3399'foldmethod' 'fdm' string (default: "manual")
3400 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003401 {not available when compiled without the |+folding|
3402 feature}
3403 The kind of folding used for the current window. Possible values:
3404 |fold-manual| manual Folds are created manually.
3405 |fold-indent| indent Lines with equal indent form a fold.
3406 |fold-expr| expr 'foldexpr' gives the fold level of a line.
3407 |fold-marker| marker Markers are used to specify folds.
3408 |fold-syntax| syntax Syntax highlighting items specify folds.
3409 |fold-diff| diff Fold text that is not changed.
3410
3411 *'foldminlines'* *'fml'*
3412'foldminlines' 'fml' number (default: 1)
3413 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003414 {not available when compiled without the |+folding|
3415 feature}
Bram Moolenaar00654022011-02-25 14:42:19 +01003416 Sets the number of screen lines above which a fold can be displayed
3417 closed. Also for manually closed folds. With the default value of
3418 one a fold can only be closed if it takes up two or more screen lines.
3419 Set to zero to be able to close folds of just one screen line.
Bram Moolenaar446beb42011-05-10 17:18:44 +02003420 Note that this only has an effect on what is displayed. After using
Bram Moolenaar071d4272004-06-13 20:20:40 +00003421 "zc" to close a fold, which is displayed open because it's smaller
3422 than 'foldminlines', a following "zc" may close a containing fold.
3423
3424 *'foldnestmax'* *'fdn'*
3425'foldnestmax' 'fdn' number (default: 20)
3426 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003427 {not available when compiled without the |+folding|
3428 feature}
3429 Sets the maximum nesting of folds for the "indent" and "syntax"
3430 methods. This avoids that too many folds will be created. Using more
3431 than 20 doesn't work, because the internal limit is 20.
3432
3433 *'foldopen'* *'fdo'*
3434'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
3435 search,tag,undo")
3436 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003437 {not available when compiled without the |+folding|
3438 feature}
3439 Specifies for which type of commands folds will be opened, if the
3440 command moves the cursor into a closed fold. It is a comma separated
3441 list of items.
Bram Moolenaar05365702010-10-27 18:34:44 +02003442 NOTE: When the command is part of a mapping this option is not used.
3443 Add the |zv| command to the mapping to get the same effect.
3444 (rationale: the mapping may want to control opening folds itself)
3445
Bram Moolenaar071d4272004-06-13 20:20:40 +00003446 item commands ~
3447 all any
3448 block "(", "{", "[[", "[{", etc.
3449 hor horizontal movements: "l", "w", "fx", etc.
3450 insert any command in Insert mode
3451 jump far jumps: "G", "gg", etc.
3452 mark jumping to a mark: "'m", CTRL-O, etc.
3453 percent "%"
3454 quickfix ":cn", ":crew", ":make", etc.
3455 search search for a pattern: "/", "n", "*", "gd", etc.
3456 (not for a search pattern in a ":" command)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003457 Also for |[s| and |]s|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003458 tag jumping to a tag: ":ta", CTRL-T, etc.
3459 undo undo or redo: "u" and CTRL-R
Bram Moolenaar071d4272004-06-13 20:20:40 +00003460 When a movement command is used for an operator (e.g., "dl" or "y%")
3461 this option is not used. This means the operator will include the
3462 whole closed fold.
3463 Note that vertical movements are not here, because it would make it
3464 very difficult to move onto a closed fold.
3465 In insert mode the folds containing the cursor will always be open
3466 when text is inserted.
3467 To close folds you can re-apply 'foldlevel' with the |zx| command or
3468 set the 'foldclose' option to "all".
3469
3470 *'foldtext'* *'fdt'*
3471'foldtext' 'fdt' string (default: "foldtext()")
3472 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003473 {not available when compiled without the |+folding|
3474 feature}
3475 An expression which is used to specify the text displayed for a closed
3476 fold. See |fold-foldtext|.
3477
Bram Moolenaar30b65812012-07-12 22:01:11 +02003478 The expression will be evaluated in the |sandbox| if set from a
3479 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003480 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003481
3482 It is not allowed to change text or jump to another window while
3483 evaluating 'foldtext' |textlock|.
3484
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003485 *'formatexpr'* *'fex'*
3486'formatexpr' 'fex' string (default "")
3487 local to buffer
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003488 {not available when compiled without the |+eval|
3489 feature}
3490 Expression which is evaluated to format a range of lines for the |gq|
3491 operator or automatic formatting (see 'formatoptions'). When this
3492 option is empty 'formatprg' is used.
3493
3494 The |v:lnum| variable holds the first line to be formatted.
3495 The |v:count| variable holds the number of lines to be formatted.
3496 The |v:char| variable holds the character that is going to be
3497 inserted if the expression is being evaluated due to
3498 automatic formatting. This can be empty. Don't insert
3499 it yet!
3500
3501 Example: >
3502 :set formatexpr=mylang#Format()
3503< This will invoke the mylang#Format() function in the
3504 autoload/mylang.vim file in 'runtimepath'. |autoload|
3505
3506 The expression is also evaluated when 'textwidth' is set and adding
3507 text beyond that limit. This happens under the same conditions as
3508 when internal formatting is used. Make sure the cursor is kept in the
3509 same spot relative to the text then! The |mode()| function will
3510 return "i" or "R" in this situation.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01003511
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003512 When the expression evaluates to non-zero Vim will fall back to using
3513 the internal format mechanism.
3514
3515 The expression will be evaluated in the |sandbox| when set from a
3516 modeline, see |sandbox-option|. That stops the option from working,
3517 since changing the buffer text is not allowed.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003518 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaar036986f2017-03-16 17:41:02 +01003519 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003520
Bram Moolenaar86b68352004-12-27 21:59:20 +00003521 *'formatlistpat'* *'flp'*
3522'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
3523 local to buffer
Bram Moolenaar86b68352004-12-27 21:59:20 +00003524 A pattern that is used to recognize a list header. This is used for
3525 the "n" flag in 'formatoptions'.
3526 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00003527 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00003528 while still checking more characters. There must be a character
3529 following the pattern, when it matches the whole line it is handled
3530 like there is no match.
3531 The default recognizes a number, followed by an optional punctuation
3532 character and white space.
3533
Bram Moolenaar6c60f472019-04-28 16:00:35 +02003534 *'formatoptions'* *'fo'*
3535'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
3536 local to buffer
3537 This is a sequence of letters which describes how automatic
3538 formatting is to be done. See |fo-table|. When the 'paste' option is
3539 on, no formatting is done (like 'formatoptions' is empty). Commas can
3540 be inserted for readability.
3541 To avoid problems with flags that are added in the future, use the
3542 "+=" and "-=" feature of ":set" |add-option-flags|.
3543 NOTE: This option is set to the Vi default value when 'compatible' is
3544 set and to the Vim default value when 'compatible' is reset.
3545
Bram Moolenaar071d4272004-06-13 20:20:40 +00003546 *'formatprg'* *'fp'*
3547'formatprg' 'fp' string (default "")
Bram Moolenaar9be7c042017-01-14 14:28:30 +01003548 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003549 The name of an external program that will be used to format the lines
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003550 selected with the |gq| operator. The program must take the input on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003551 stdin and produce the output on stdout. The Unix program "fmt" is
Bram Moolenaara5792f52005-11-23 21:25:05 +00003552 such a program.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003553 If the 'formatexpr' option is not empty it will be used instead.
3554 Otherwise, if 'formatprg' option is an empty string, the internal
3555 format function will be used |C-indenting|.
Bram Moolenaara5792f52005-11-23 21:25:05 +00003556 Environment variables are expanded |:set_env|. See |option-backslash|
3557 about including spaces and backslashes.
Bram Moolenaar30b65812012-07-12 22:01:11 +02003558 This option cannot be set from a |modeline| or in the |sandbox|, for
3559 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003560
Bram Moolenaard94464e2015-11-02 15:28:18 +01003561 *'fsync'* *'fs'* *'nofsync'* *'nofs'*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003562'fsync' 'fs' boolean (default on)
3563 global
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003564 When on, the library function fsync() will be called after writing a
3565 file. This will flush a file to disk, ensuring that it is safely
3566 written even on filesystems which do metadata-only journaling. This
3567 will force the harddrive to spin up on Linux systems running in laptop
3568 mode, so it may be undesirable in some situations. Be warned that
3569 turning this off increases the chances of data loss after a crash. On
3570 systems without an fsync() implementation, this variable is always
3571 off.
3572 Also see 'swapsync' for controlling fsync() on swap files.
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003573 'fsync' also applies to |writefile()|, unless a flag is used to
3574 overrule it.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003575 This option cannot be set from a |modeline| or in the |sandbox|, for
3576 security reasons.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003577
Bram Moolenaar071d4272004-06-13 20:20:40 +00003578 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
3579'gdefault' 'gd' boolean (default off)
3580 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003581 When on, the ":substitute" flag 'g' is default on. This means that
3582 all matches in a line are substituted instead of one. When a 'g' flag
3583 is given to a ":substitute" command, this will toggle the substitution
3584 of all or one match. See |complex-change|.
3585
3586 command 'gdefault' on 'gdefault' off ~
3587 :s/// subst. all subst. one
3588 :s///g subst. one subst. all
3589 :s///gg subst. all subst. one
3590
3591 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar21020352017-06-13 17:21:04 +02003592 DEPRECATED: Setting this option may break plugins that are not aware
3593 of this option. Also, many users get confused that adding the /g flag
3594 has the opposite effect of that it normally does.
Bram Moolenaar4072ba52020-12-23 13:56:35 +01003595 This option is not used in |Vim9| script.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003596
3597 *'grepformat'* *'gfm'*
Bram Moolenaar6e932462014-09-09 18:48:09 +02003598'grepformat' 'gfm' string (default "%f:%l:%m,%f:%l%m,%f %l%m")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003599 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003600 Format to recognize for the ":grep" command output.
3601 This is a scanf-like string that uses the same format as the
3602 'errorformat' option: see |errorformat|.
3603
3604 *'grepprg'* *'gp'*
3605'grepprg' 'gp' string (default "grep -n ",
3606 Unix: "grep -n $* /dev/null",
3607 Win32: "findstr /n" or "grep -n",
3608 VMS: "SEARCH/NUMBERS ")
3609 global or local to buffer |global-local|
Bram Moolenaar582fd852005-03-28 20:58:01 +00003610 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003611 and '#' characters, which are expanded like when used in a command-
3612 line. The placeholder "$*" is allowed to specify where the arguments
3613 will be included. Environment variables are expanded |:set_env|. See
3614 |option-backslash| about including spaces and backslashes.
3615 When your "grep" accepts the "-H" argument, use this to make ":grep"
3616 also work well with a single file: >
3617 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00003618< Special value: When 'grepprg' is set to "internal" the |:grep| command
Bram Moolenaara6557602006-02-04 22:43:20 +00003619 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like
3620 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00003621 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00003622 apply equally to 'grepprg'.
3623 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
3624 otherwise it's "grep -n".
3625 This option cannot be set from a |modeline| or in the |sandbox|, for
3626 security reasons.
3627
3628 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
3629'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
3630 ve:ver35-Cursor,
3631 o:hor50-Cursor,
3632 i-ci:ver25-Cursor/lCursor,
3633 r-cr:hor20-Cursor/lCursor,
3634 sm:block-Cursor
3635 -blinkwait175-blinkoff150-blinkon175",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003636 for Win32 console:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003637 "n-v-c:block,o:hor50,i-ci:hor15,
3638 r-cr:hor30,sm:block")
3639 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003640 {only available when compiled with GUI enabled, and
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003641 for Win32 console}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003642 This option tells Vim what the cursor should look like in different
Bram Moolenaar8024f932020-01-14 19:29:13 +01003643 modes. It fully works in the GUI. In a Win32 console, only the
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003644 height of the cursor can be changed. This can be done by specifying a
3645 block cursor, or a percentage for a vertical or horizontal cursor.
Bram Moolenaar1e7813a2015-03-31 18:31:03 +02003646 For a console the 't_SI', 't_SR', and 't_EI' escape sequences are
3647 used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003648
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003649 The option is a comma separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003650 mode-list and an argument-list:
3651 mode-list:argument-list,mode-list:argument-list,..
3652 The mode-list is a dash separated list of these modes:
3653 n Normal mode
3654 v Visual mode
3655 ve Visual mode with 'selection' "exclusive" (same as 'v',
3656 if not specified)
3657 o Operator-pending mode
3658 i Insert mode
3659 r Replace mode
3660 c Command-line Normal (append) mode
3661 ci Command-line Insert mode
3662 cr Command-line Replace mode
3663 sm showmatch in Insert mode
3664 a all modes
3665 The argument-list is a dash separated list of these arguments:
3666 hor{N} horizontal bar, {N} percent of the character height
3667 ver{N} vertical bar, {N} percent of the character width
3668 block block cursor, fills the whole character
3669 [only one of the above three should be present]
3670 blinkwait{N} *cursor-blinking*
3671 blinkon{N}
3672 blinkoff{N}
3673 blink times for cursor: blinkwait is the delay before
3674 the cursor starts blinking, blinkon is the time that
3675 the cursor is shown and blinkoff is the time that the
3676 cursor is not shown. The times are in msec. When one
3677 of the numbers is zero, there is no blinking. The
3678 default is: "blinkwait700-blinkon400-blinkoff250".
3679 These numbers are used for a missing entry. This
3680 means that blinking is enabled by default. To switch
3681 blinking off you can use "blinkon0". The cursor only
3682 blinks when Vim is waiting for input, not while
3683 executing a command.
3684 To make the cursor blink in an xterm, see
3685 |xterm-blink|.
3686 {group-name}
3687 a highlight group name, that sets the color and font
3688 for the cursor
3689 {group-name}/{group-name}
3690 Two highlight group names, the first is used when
3691 no language mappings are used, the other when they
3692 are. |language-mapping|
3693
3694 Examples of parts:
3695 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
3696 block cursor with colors from the "nCursor"
3697 highlight group
3698 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
3699 In Insert and Command-line Insert mode, use a
3700 30% vertical bar cursor with colors from the
3701 "iCursor" highlight group. Blink a bit
3702 faster.
3703
3704 The 'a' mode is different. It will set the given argument-list for
3705 all modes. It does not reset anything to defaults. This can be used
3706 to do a common setting for all modes. For example, to switch off
3707 blinking: "a:blinkon0"
3708
3709 Examples of cursor highlighting: >
3710 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
3711 :highlight Cursor gui=NONE guifg=bg guibg=fg
3712<
3713 *'guifont'* *'gfn'*
Bram Moolenaar251e1912011-06-19 05:09:16 +02003714 *E235* *E596*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003715'guifont' 'gfn' string (default "")
3716 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003717 {only available when compiled with GUI enabled}
3718 This is a list of fonts which will be used for the GUI version of Vim.
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003719 In its simplest form the value is just one font name.
3720 See |gui-font| for the details.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003721
3722 *'guifontset'* *'gfs'*
3723 *E250* *E252* *E234* *E597* *E598*
3724'guifontset' 'gfs' string (default "")
3725 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003726 {only available when compiled with GUI enabled and
3727 with the |+xfontset| feature}
Bram Moolenaar3df01732017-02-17 22:47:16 +01003728 {not available in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003729 When not empty, specifies two (or more) fonts to be used. The first
3730 one for normal English, the second one for your special language. See
3731 |xfontset|.
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003732
Bram Moolenaar071d4272004-06-13 20:20:40 +00003733 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
3734'guifontwide' 'gfw' string (default "")
3735 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003736 {only available when compiled with GUI enabled}
3737 When not empty, specifies a comma-separated list of fonts to be used
3738 for double-width characters. The first font that can be loaded is
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003739 used. See |gui-fontwide|.
Bram Moolenaar0f272122013-01-23 18:37:40 +01003740
Bram Moolenaar071d4272004-06-13 20:20:40 +00003741 *'guiheadroom'* *'ghr'*
3742'guiheadroom' 'ghr' number (default 50)
3743 global
Bram Moolenaar110289e2019-05-23 15:38:06 +02003744 {only for GTK and X11 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003745 The number of pixels subtracted from the screen height when fitting
3746 the GUI window on the screen. Set this before the GUI is started,
3747 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003748 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00003749 lines will be left for window decorations and other items on the
3750 screen. Set it to a negative value to allow windows taller than the
3751 screen.
3752
3753 *'guioptions'* *'go'*
Bram Moolenaar2c64ca12018-10-19 16:22:31 +02003754'guioptions' 'go' string (default "egmrLtT" (MS-Windows,
3755 "t" is removed in |defaults.vim|),
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02003756 "aegimrLtT" (GTK, Motif and Athena),
3757 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00003758 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003759 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00003760 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003761 sequence of letters which describes what components and options of the
3762 GUI should be used.
3763 To avoid problems with flags that are added in the future, use the
3764 "+=" and "-=" feature of ":set" |add-option-flags|.
3765
Bram Moolenaar13568252018-03-16 20:46:58 +01003766 Valid characters are as follows:
3767 *'go-!'*
3768 '!' External commands are executed in a terminal window. Without
3769 this flag the MS-Windows GUI will open a console window to
3770 execute the command. The Unix GUI will simulate a dumb
3771 terminal to list the command output.
3772 The terminal window will be positioned at the bottom, and grow
3773 upwards as needed.
Bram Moolenaarba3ff532018-11-04 14:45:49 +01003774 *'go-a'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003775 'a' Autoselect: If present, then whenever VISUAL mode is started,
3776 or the Visual area extended, Vim tries to become the owner of
3777 the windowing system's global selection. This means that the
3778 Visually highlighted text is available for pasting into other
3779 applications as well as into Vim itself. When the Visual mode
3780 ends, possibly due to an operation on the text, or when an
3781 application wants to paste the selection, the highlighted text
3782 is automatically yanked into the "* selection register.
3783 Thus the selection is still available for pasting into other
3784 applications after the VISUAL mode has ended.
3785 If not present, then Vim won't become the owner of the
3786 windowing system's global selection unless explicitly told to
3787 by a yank or delete operation for the "* register.
3788 The same applies to the modeless selection.
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02003789 *'go-P'*
3790 'P' Like autoselect but using the "+ register instead of the "*
Bram Moolenaar3848e002016-03-19 18:42:29 +01003791 register.
Bram Moolenaar02467872007-05-06 13:22:01 +00003792 *'go-A'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003793 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003794 applies to the modeless selection.
3795
3796 'guioptions' autoselect Visual autoselect modeless ~
3797 "" - -
3798 "a" yes yes
3799 "A" - yes
3800 "aA" yes yes
3801
Bram Moolenaar02467872007-05-06 13:22:01 +00003802 *'go-c'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003803 'c' Use console dialogs instead of popup dialogs for simple
3804 choices.
Bram Moolenaar50bf7ce2019-09-15 13:17:00 +02003805 *'go-d'*
3806 'd' Use dark theme variant if available. Currently only works for
3807 GTK+ GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00003808 *'go-e'*
Bram Moolenaare224ffa2006-03-01 00:01:28 +00003809 'e' Add tab pages when indicated with 'showtabline'.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003810 'guitablabel' can be used to change the text in the labels.
3811 When 'e' is missing a non-GUI tab pages line may be used.
Bram Moolenaard68071d2006-05-02 22:08:30 +00003812 The GUI tabs are only supported on some systems, currently
Bram Moolenaarb3f74062020-02-26 16:16:53 +01003813 GTK, Motif, Mac OS/X, Haiku, and MS-Windows.
Bram Moolenaar02467872007-05-06 13:22:01 +00003814 *'go-f'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003815 'f' Foreground: Don't use fork() to detach the GUI from the shell
3816 where it was started. Use this for programs that wait for the
3817 editor to finish (e.g., an e-mail program). Alternatively you
3818 can use "gvim -f" or ":gui -f" to start the GUI in the
3819 foreground. |gui-fork|
3820 Note: Set this option in the vimrc file. The forking may have
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003821 happened already when the |gvimrc| file is read.
Bram Moolenaar02467872007-05-06 13:22:01 +00003822 *'go-i'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003823 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
3824 corner of the window. It's black&white on non-GTK, because of
3825 limitations of X11. For a color icon, see |X11-icon|.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003826 *'go-m'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003827 'm' Menu bar is present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003828 *'go-M'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003829 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00003830 that this flag must be added in the .vimrc file, before
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003831 switching on syntax or filetype recognition (when the |gvimrc|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003832 file is sourced the system menu has already been loaded; the
Bram Moolenaar01164a62017-11-02 22:58:42 +01003833 `:syntax on` and `:filetype on` commands load the menu too).
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003834 *'go-g'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003835 'g' Grey menu items: Make menu items that are not active grey. If
3836 'g' is not included inactive menu items are not shown at all.
3837 Exception: Athena will always use grey menu items.
Bram Moolenaar02467872007-05-06 13:22:01 +00003838 *'go-t'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003839 't' Include tearoff menu items. Currently only works for Win32,
3840 GTK+, and Motif 1.2 GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00003841 *'go-T'*
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00003842 'T' Include Toolbar. Currently only in Win32, GTK+, Motif, Photon
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00003843 and Athena GUIs.
Bram Moolenaar02467872007-05-06 13:22:01 +00003844 *'go-r'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003845 'r' Right-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003846 *'go-R'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003847 'R' Right-hand scrollbar is present when there is a vertically
3848 split window.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003849 *'go-l'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003850 'l' Left-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003851 *'go-L'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003852 'L' Left-hand scrollbar is present when there is a vertically
3853 split window.
Bram Moolenaar02467872007-05-06 13:22:01 +00003854 *'go-b'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003855 'b' Bottom (horizontal) scrollbar is present. Its size depends on
3856 the longest visible line, or on the cursor line if the 'h'
3857 flag is included. |gui-horiz-scroll|
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003858 *'go-h'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003859 'h' Limit horizontal scrollbar size to the length of the cursor
3860 line. Reduces computations. |gui-horiz-scroll|
3861
3862 And yes, you may even have scrollbars on the left AND the right if
3863 you really want to :-). See |gui-scrollbars| for more information.
3864
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003865 *'go-v'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003866 'v' Use a vertical button layout for dialogs. When not included,
3867 a horizontal layout is preferred, but when it doesn't fit a
Bram Moolenaardad44732021-03-31 20:07:33 +02003868 vertical layout is used anyway. Not supported in GTK 3.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003869 *'go-p'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003870 'p' Use Pointer callbacks for X11 GUI. This is required for some
3871 window managers. If the cursor is not blinking or hollow at
3872 the right moment, try adding this flag. This must be done
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003873 before starting the GUI. Set it in your |gvimrc|. Adding or
Bram Moolenaar071d4272004-06-13 20:20:40 +00003874 removing it after the GUI has started has no effect.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003875 *'go-F'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003876 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar8ac44152017-11-09 18:33:29 +01003877 *'go-k'*
3878 'k' Keep the GUI window size when adding/removing a scrollbar, or
3879 toolbar, tabline, etc. Instead, the behavior is similar to
3880 when the window is maximized and will adjust 'lines' and
3881 'columns' to fit to the window. Without the 'k' flag Vim will
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003882 try to keep 'lines' and 'columns' the same when adding and
Bram Moolenaar8ac44152017-11-09 18:33:29 +01003883 removing GUI components.
Bram Moolenaar02467872007-05-06 13:22:01 +00003884
Bram Moolenaar071d4272004-06-13 20:20:40 +00003885 *'guipty'* *'noguipty'*
3886'guipty' boolean (default on)
3887 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003888 {only available when compiled with GUI enabled}
3889 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
3890 I/O to/from shell commands. See |gui-pty|.
3891
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003892 *'guitablabel'* *'gtl'*
3893'guitablabel' 'gtl' string (default empty)
3894 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02003895 {only available when compiled with GUI enabled}
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003896 When nonempty describes the text to use in a label of the GUI tab
Bram Moolenaard68071d2006-05-02 22:08:30 +00003897 pages line. When empty and when the result is empty Vim will use a
3898 default label. See |setting-guitablabel| for more info.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003899
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003900 The format of this option is like that of 'statusline'.
Bram Moolenaar57657d82006-04-21 22:12:41 +00003901 'guitabtooltip' is used for the tooltip, see below.
Bram Moolenaar51628222016-12-01 23:03:28 +01003902 The expression will be evaluated in the |sandbox| when set from a
3903 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003904 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003905
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003906 Only used when the GUI tab pages line is displayed. 'e' must be
3907 present in 'guioptions'. For the non-GUI tab pages line 'tabline' is
3908 used.
3909
Bram Moolenaar57657d82006-04-21 22:12:41 +00003910 *'guitabtooltip'* *'gtt'*
3911'guitabtooltip' 'gtt' string (default empty)
3912 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02003913 {only available when compiled with GUI enabled}
Bram Moolenaar57657d82006-04-21 22:12:41 +00003914 When nonempty describes the text to use in a tooltip for the GUI tab
3915 pages line. When empty Vim will use a default tooltip.
3916 This option is otherwise just like 'guitablabel' above.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003917 You can include a line break. Simplest method is to use |:let|: >
3918 :let &guitabtooltip = "line one\nline two"
3919<
Bram Moolenaar57657d82006-04-21 22:12:41 +00003920
Bram Moolenaar071d4272004-06-13 20:20:40 +00003921 *'helpfile'* *'hf'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003922'helpfile' 'hf' string (default (MS-Windows) "$VIMRUNTIME\doc\help.txt"
Bram Moolenaar071d4272004-06-13 20:20:40 +00003923 (others) "$VIMRUNTIME/doc/help.txt")
3924 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003925 Name of the main help file. All distributed help files should be
3926 placed together in one directory. Additionally, all "doc" directories
3927 in 'runtimepath' will be used.
3928 Environment variables are expanded |:set_env|. For example:
3929 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003930 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00003931 spaces and backslashes.
3932 This option cannot be set from a |modeline| or in the |sandbox|, for
3933 security reasons.
3934
3935 *'helpheight'* *'hh'*
3936'helpheight' 'hh' number (default 20)
3937 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003938 Minimal initial height of the help window when it is opened with the
3939 ":help" command. The initial height of the help window is half of the
3940 current window, or (when the 'ea' option is on) the same as other
3941 windows. When the height is less than 'helpheight', the height is
3942 set to 'helpheight'. Set to zero to disable.
3943
3944 *'helplang'* *'hlg'*
3945'helplang' 'hlg' string (default: messages language or empty)
3946 global
3947 {only available when compiled with the |+multi_lang|
3948 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003949 Comma separated list of languages. Vim will use the first language
3950 for which the desired help can be found. The English help will always
3951 be used as a last resort. You can add "en" to prefer English over
3952 another language, but that will only find tags that exist in that
3953 language and not in the English help.
3954 Example: >
3955 :set helplang=de,it
3956< This will first search German, then Italian and finally English help
3957 files.
3958 When using |CTRL-]| and ":help!" in a non-English help file Vim will
3959 try to find the tag in the current language before using this option.
3960 See |help-translated|.
3961
3962 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
3963'hidden' 'hid' boolean (default off)
3964 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003965 When off a buffer is unloaded when it is |abandon|ed. When on a
3966 buffer becomes hidden when it is |abandon|ed. If the buffer is still
3967 displayed in another window, it does not become hidden, of course.
3968 The commands that move through the buffer list sometimes make a buffer
3969 hidden although the 'hidden' option is off: When the buffer is
3970 modified, 'autowrite' is off or writing is not possible, and the '!'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003971 flag was used. See also |windows.txt|.
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00003972 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003973 This option is set for one command with ":hide {command}" |:hide|.
3974 WARNING: It's easy to forget that you have changes in hidden buffers.
3975 Think twice when using ":q!" or ":qa!".
3976
3977 *'highlight'* *'hl'*
3978'highlight' 'hl' string (default (as a single string):
Bram Moolenaar58b85342016-08-14 19:54:54 +02003979 "8:SpecialKey,~:EndOfBuffer,@:NonText,
3980 d:Directory,e:ErrorMsg,i:IncSearch,
3981 l:Search,m:MoreMsg,M:ModeMsg,n:LineNr,
Bram Moolenaarefae76a2019-10-27 22:54:58 +01003982 a:LineNrAbove,b:LineNrBelow,
Bram Moolenaar58b85342016-08-14 19:54:54 +02003983 N:CursorLineNr,r:Question,s:StatusLine,
3984 S:StatusLineNC,c:VertSplit,t:Title,
Bram Moolenaar9d87a372018-12-18 21:41:50 +01003985 v:Visual,V:VisualNOS,w:WarningMsg,
3986 W:WildMenu,f:Folded,F:FoldColumn,
3987 A:DiffAdd,C:DiffChange,D:DiffDelete,
3988 T:DiffText,>:SignColumn,-:Conceal,
Bram Moolenaarc8c88492018-12-27 23:59:26 +01003989 B:SpellBad,P:SpellCap,R:SpellRare,
Bram Moolenaar9d87a372018-12-18 21:41:50 +01003990 L:SpellLocal,+:Pmenu,=:PmenuSel,
Bram Moolenaar21020352017-06-13 17:21:04 +02003991 x:PmenuSbar,X:PmenuThumb,*:TabLine,
3992 #:TabLineSel,_:TabLineFill,!:CursorColumn,
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02003993 .:CursorLine,o:ColorColumn,q:QuickFixLine,
Bram Moolenaarc572da52017-08-27 16:52:01 +02003994 z:StatusLineTerm,Z:StatusLineTermNC")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003995 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003996 This option can be used to set highlighting mode for various
3997 occasions. It is a comma separated list of character pairs. The
3998 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003999 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004000 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
Bram Moolenaar58b85342016-08-14 19:54:54 +02004001 |hl-EndOfBuffer| ~ lines after the last line in the buffer
4002 |hl-NonText| @ '@' at the end of the window and
Bram Moolenaar071d4272004-06-13 20:20:40 +00004003 characters from 'showbreak'
4004 |hl-Directory| d directories in CTRL-D listing and other special
4005 things in listings
4006 |hl-ErrorMsg| e error messages
4007 h (obsolete, ignored)
4008 |hl-IncSearch| i 'incsearch' highlighting
4009 |hl-Search| l last search pattern highlighting (see 'hlsearch')
4010 |hl-MoreMsg| m |more-prompt|
4011 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
Bram Moolenaar64486672010-05-16 15:46:46 +02004012 |hl-LineNr| n line number for ":number" and ":#" commands, and
4013 when 'number' or 'relativenumber' option is set.
Bram Moolenaarefae76a2019-10-27 22:54:58 +01004014 |hl-LineNrAbove| a line number above the cursor for when the
4015 'relativenumber' option is set.
4016 |hl-LineNrBelow| b line number below the cursor for when the
4017 'relativenumber' option is set.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01004018 |hl-CursorLineNr| N like n for when 'cursorline' or 'relativenumber' is
4019 set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004020 |hl-Question| r |hit-enter| prompt and yes/no questions
4021 |hl-StatusLine| s status line of current window |status-line|
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01004022 |hl-StatusLineNC| S status lines of not-current windows
Bram Moolenaar071d4272004-06-13 20:20:40 +00004023 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
4024 |hl-VertSplit| c column used to separate vertically split windows
4025 |hl-Visual| v Visual mode
4026 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
4027 Selection" Only X11 Gui's |gui-x11| and
4028 |xterm-clipboard|.
4029 |hl-WarningMsg| w warning messages
4030 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
4031 |hl-Folded| f line used for closed folds
4032 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00004033 |hl-DiffAdd| A added line in diff mode
4034 |hl-DiffChange| C changed line in diff mode
4035 |hl-DiffDelete| D deleted line in diff mode
4036 |hl-DiffText| T inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00004037 |hl-SignColumn| > column used for |signs|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004038 |hl-Conceal| - the placeholders used for concealed characters
4039 (see 'conceallevel')
Bram Moolenaar217ad922005-03-20 22:37:15 +00004040 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02004041 |hl-SpellCap| P word that should start with capital |spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00004042 |hl-SpellRare| R rare word |spell|
4043 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004044 |hl-Pmenu| + popup menu normal line
4045 |hl-PmenuSel| = popup menu selected line
4046 |hl-PmenuSbar| x popup menu scrollbar
4047 |hl-PmenuThumb| X popup menu scrollbar thumb
Bram Moolenaar071d4272004-06-13 20:20:40 +00004048
4049 The display modes are:
4050 r reverse (termcap entry "mr" and "me")
4051 i italic (termcap entry "ZH" and "ZR")
4052 b bold (termcap entry "md" and "me")
4053 s standout (termcap entry "so" and "se")
4054 u underline (termcap entry "us" and "ue")
Bram Moolenaare2cc9702005-03-15 22:43:58 +00004055 c undercurl (termcap entry "Cs" and "Ce")
Bram Moolenaarcf4b00c2017-09-02 18:33:56 +02004056 t strikethrough (termcap entry "Ts" and "Te")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004057 n no highlighting
4058 - no highlighting
4059 : use a highlight group
4060 The default is used for occasions that are not included.
4061 If you want to change what the display modes do, see |dos-colors|
4062 for an example.
4063 When using the ':' display mode, this must be followed by the name of
4064 a highlight group. A highlight group can be used to define any type
4065 of highlighting, including using color. See |:highlight| on how to
4066 define one. The default uses a different group for each occasion.
4067 See |highlight-default| for the default highlight groups.
4068
Bram Moolenaar071d4272004-06-13 20:20:40 +00004069 *'history'* *'hi'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004070'history' 'hi' number (Vim default: 50, Vi default: 0,
4071 set to 200 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004072 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004073 A history of ":" commands, and a history of previous search patterns
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004074 is remembered. This option decides how many entries may be stored in
Bram Moolenaar071d4272004-06-13 20:20:40 +00004075 each of these histories (see |cmdline-editing|).
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004076 The maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004077 NOTE: This option is set to the Vi default value when 'compatible' is
4078 set and to the Vim default value when 'compatible' is reset.
4079
4080 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
4081'hkmap' 'hk' boolean (default off)
4082 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004083 {only available when compiled with the |+rightleft|
4084 feature}
4085 When on, the keyboard is mapped for the Hebrew character set.
4086 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
4087 toggle this option. See |rileft.txt|.
4088 NOTE: This option is reset when 'compatible' is set.
4089
4090 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
4091'hkmapp' 'hkp' boolean (default off)
4092 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004093 {only available when compiled with the |+rightleft|
4094 feature}
4095 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
4096 This is useful if you have a non-Hebrew keyboard.
4097 See |rileft.txt|.
4098 NOTE: This option is reset when 'compatible' is set.
4099
Bram Moolenaar036986f2017-03-16 17:41:02 +01004100 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
4101'hlsearch' 'hls' boolean (default off)
4102 global
Bram Moolenaar036986f2017-03-16 17:41:02 +01004103 {not available when compiled without the
4104 |+extra_search| feature}
4105 When there is a previous search pattern, highlight all its matches.
4106 The type of highlighting used can be set with the 'l' occasion in the
4107 'highlight' option. This uses the "Search" highlight group by
4108 default. Note that only the matching text is highlighted, any offsets
4109 are not applied.
4110 See also: 'incsearch' and |:match|.
4111 When you get bored looking at the highlighted matches, you can turn it
4112 off with |:nohlsearch|. This does not change the option value, as
4113 soon as you use a search command, the highlighting comes back.
4114 'redrawtime' specifies the maximum time spent on finding matches.
4115 When the search pattern can match an end-of-line, Vim will try to
4116 highlight all of the matched text. However, this depends on where the
4117 search starts. This will be the first line in the window or the first
4118 line below a closed fold. A match in a previous line which is not
4119 drawn may not continue in a newly drawn line.
4120 You can specify whether the highlight status is restored on startup
4121 with the 'h' flag in 'viminfo' |viminfo-h|.
4122 NOTE: This option is reset when 'compatible' is set.
4123
Bram Moolenaar071d4272004-06-13 20:20:40 +00004124 *'icon'* *'noicon'*
4125'icon' boolean (default off, on when title can be restored)
4126 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004127 {not available when compiled without the |+title|
4128 feature}
4129 When on, the icon text of the window will be set to the value of
4130 'iconstring' (if it is not empty), or to the name of the file
4131 currently being edited. Only the last part of the name is used.
4132 Overridden by the 'iconstring' option.
4133 Only works if the terminal supports setting window icons (currently
4134 only X11 GUI and terminals with a non-empty 't_IS' option - these are
4135 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
4136 builtin termcap).
4137 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00004138 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00004139 X11.
Bram Moolenaar3a991dd2014-10-02 01:41:41 +02004140 For MS-Windows the icon can be changed, see |windows-icon|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004141
4142 *'iconstring'*
4143'iconstring' string (default "")
4144 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004145 {not available when compiled without the |+title|
4146 feature}
4147 When this option is not empty, it will be used for the icon text of
4148 the window. This happens only when the 'icon' option is on.
4149 Only works if the terminal supports setting window icon text
4150 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02004151 Does not work for MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004152 When Vim was compiled with HAVE_X11 defined, the original icon will be
4153 restored if possible |X11|.
4154 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004155 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004156 'titlestring' for example settings.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004157 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004158 {not available when compiled without the |+statusline| feature}
4159
4160 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
4161'ignorecase' 'ic' boolean (default off)
4162 global
4163 Ignore case in search patterns. Also used when searching in the tags
4164 file.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01004165 Also see 'smartcase' and 'tagcase'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004166 Can be overruled by using "\c" or "\C" in the pattern, see
4167 |/ignorecase|.
4168
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004169 *'imactivatefunc'* *'imaf'*
4170'imactivatefunc' 'imaf' string (default "")
4171 global
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004172 This option specifies a function that will be called to
Bram Moolenaar2877d332017-11-26 14:56:16 +01004173 activate or deactivate the Input Method.
Bram Moolenaaref8c6172020-07-01 15:12:44 +02004174 It is not used in the MS-Windows GUI version.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004175 The expression will be evaluated in the |sandbox| when set from a
4176 modeline, see |sandbox-option|.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004177
4178 Example: >
4179 function ImActivateFunc(active)
4180 if a:active
4181 ... do something
4182 else
4183 ... do something
4184 endif
4185 " return value is not used
4186 endfunction
4187 set imactivatefunc=ImActivateFunc
4188<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004189 *'imactivatekey'* *'imak'*
4190'imactivatekey' 'imak' string (default "")
4191 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004192 {only available when compiled with |+xim| and
Bram Moolenaar67c53842010-05-22 18:28:27 +02004193 |+GUI_GTK|} *E599*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004194 Specifies the key that your Input Method in X-Windows uses for
4195 activation. When this is specified correctly, vim can fully control
4196 IM with 'imcmdline', 'iminsert' and 'imsearch'.
4197 You can't use this option to change the activation key, the option
4198 tells Vim what the key is.
4199 Format:
4200 [MODIFIER_FLAG-]KEY_STRING
4201
4202 These characters can be used for MODIFIER_FLAG (case is ignored):
4203 S Shift key
4204 L Lock key
4205 C Control key
4206 1 Mod1 key
4207 2 Mod2 key
4208 3 Mod3 key
4209 4 Mod4 key
4210 5 Mod5 key
4211 Combinations are allowed, for example "S-C-space" or "SC-space" are
4212 both shift+ctrl+space.
4213 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
4214
4215 Example: >
4216 :set imactivatekey=S-space
4217< "S-space" means shift+space. This is the activation key for kinput2 +
4218 canna (Japanese), and ami (Korean).
4219
4220 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
4221'imcmdline' 'imc' boolean (default off)
4222 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004223 When set the Input Method is always on when starting to edit a command
4224 line, unless entering a search pattern (see 'imsearch' for that).
4225 Setting this option is useful when your input method allows entering
4226 English characters directly, e.g., when it's used to type accented
4227 characters with dead keys.
4228
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004229 *'imdisable'* *'imd'* *'noimdisable'* *'noimd'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004230'imdisable' 'imd' boolean (default off, on for some systems (SGI))
4231 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004232 When set the Input Method is never used. This is useful to disable
4233 the IM when it doesn't work properly.
4234 Currently this option is on by default for SGI/IRIX machines. This
4235 may change in later releases.
4236
4237 *'iminsert'* *'imi'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004238'iminsert' 'imi' number (default 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004239 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004240 Specifies whether :lmap or an Input Method (IM) is to be used in
4241 Insert mode. Valid values:
4242 0 :lmap is off and IM is off
4243 1 :lmap is ON and IM is off
4244 2 :lmap is off and IM is ON
Bram Moolenaar071d4272004-06-13 20:20:40 +00004245 To always reset the option to zero when leaving Insert mode with <Esc>
4246 this can be used: >
4247 :inoremap <ESC> <ESC>:set iminsert=0<CR>
4248< This makes :lmap and IM turn off automatically when leaving Insert
4249 mode.
4250 Note that this option changes when using CTRL-^ in Insert mode
4251 |i_CTRL-^|.
4252 The value is set to 1 when setting 'keymap' to a valid keymap name.
4253 It is also used for the argument of commands like "r" and "f".
4254 The value 0 may not work correctly with Athena and Motif with some XIM
4255 methods. Use 'imdisable' to disable XIM then.
4256
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004257 You can set 'imactivatefunc' and 'imstatusfunc' to handle IME/XIM
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004258 via external command if Vim is not compiled with the |+xim|,
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004259 |+multi_byte_ime| or |global-ime|.
4260
Bram Moolenaar071d4272004-06-13 20:20:40 +00004261 *'imsearch'* *'ims'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004262'imsearch' 'ims' number (default -1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004263 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004264 Specifies whether :lmap or an Input Method (IM) is to be used when
4265 entering a search pattern. Valid values:
4266 -1 the value of 'iminsert' is used, makes it look like
4267 'iminsert' is also used when typing a search pattern
4268 0 :lmap is off and IM is off
4269 1 :lmap is ON and IM is off
4270 2 :lmap is off and IM is ON
4271 Note that this option changes when using CTRL-^ in Command-line mode
4272 |c_CTRL-^|.
4273 The value is set to 1 when it is not -1 and setting the 'keymap'
4274 option to a valid keymap name.
4275 The value 0 may not work correctly with Athena and Motif with some XIM
4276 methods. Use 'imdisable' to disable XIM then.
4277
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004278 *'imstatusfunc'* *'imsf'*
4279'imstatusfunc' 'imsf' string (default "")
4280 global
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004281 This option specifies a function that is called to obtain the status
4282 of Input Method. It must return a positive number when IME is active.
Bram Moolenaaref8c6172020-07-01 15:12:44 +02004283 It is not used in the MS-Windows GUI version.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004284
4285 Example: >
4286 function ImStatusFunc()
4287 let is_active = ...do something
4288 return is_active ? 1 : 0
4289 endfunction
4290 set imstatusfunc=ImStatusFunc
4291<
4292 NOTE: This function is invoked very often. Keep it fast.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004293 The expression will be evaluated in the |sandbox| when set from a
4294 modeline, see |sandbox-option|.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004295
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004296 *'imstyle'* *'imst'*
4297'imstyle' 'imst' number (default 1)
4298 global
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004299 {only available when compiled with |+xim| and
4300 |+GUI_GTK|}
Bram Moolenaar37c64c72017-09-19 22:06:03 +02004301 This option specifies the input style of Input Method:
4302 0 use on-the-spot style
4303 1 over-the-spot style
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004304 See: |xim-input-style|
4305
Bram Moolenaar24a98a02017-09-27 22:23:55 +02004306 For a long time on-the-spot style had been used in the GTK version of
4307 vim, however, it is known that it causes troubles when using mappings,
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004308 |single-repeat|, etc. Therefore over-the-spot style becomes the
4309 default now. This should work fine for most people, however if you
4310 have any problem with it, try using on-the-spot style.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004311 The expression will be evaluated in the |sandbox| when set from a
4312 modeline, see |sandbox-option|.
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004313
Bram Moolenaar071d4272004-06-13 20:20:40 +00004314 *'include'* *'inc'*
4315'include' 'inc' string (default "^\s*#\s*include")
4316 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004317 {not available when compiled without the
4318 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004319 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00004320 pattern, just like for the "/" command (See |pattern|). The default
4321 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar1e015462005-09-25 22:16:38 +00004322 "]I", "[d", etc.
4323 Normally the 'isfname' option is used to recognize the file name that
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004324 comes after the matched pattern. But if "\zs" appears in the pattern
4325 then the text matched from "\zs" to the end, or until "\ze" if it
4326 appears, is used as the file name. Use this to include characters
4327 that are not in 'isfname', such as a space. You can then use
4328 'includeexpr' to process the matched text.
Bram Moolenaar1e015462005-09-25 22:16:38 +00004329 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004330
4331 *'includeexpr'* *'inex'*
4332'includeexpr' 'inex' string (default "")
4333 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004334 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004335 |+find_in_path| or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004336 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004337 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004338 :set includeexpr=substitute(v:fname,'\\.','/','g')
4339< The "v:fname" variable will be set to the file name that was detected.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004340
Bram Moolenaar071d4272004-06-13 20:20:40 +00004341 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004342 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004343 Also used for |<cfile>|.
4344
Bram Moolenaar30b65812012-07-12 22:01:11 +02004345 The expression will be evaluated in the |sandbox| when set from a
4346 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004347 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004348
4349 It is not allowed to change text or jump to another window while
4350 evaluating 'includeexpr' |textlock|.
4351
Bram Moolenaar071d4272004-06-13 20:20:40 +00004352 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004353'incsearch' 'is' boolean (default off, set in |defaults.vim| if the
4354 +reltime feature is supported)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004355 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004356 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004357 |+extra_search| features}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004358 While typing a search command, show where the pattern, as it was typed
4359 so far, matches. The matched string is highlighted. If the pattern
4360 is invalid or not found, nothing is shown. The screen will be updated
4361 often, this is only useful on fast terminals.
Bram Moolenaarfc65cab2018-08-28 22:58:02 +02004362 Also applies to the pattern in commands: >
4363 :global
4364 :lvimgrep
4365 :lvimgrepadd
4366 :smagic
4367 :snomagic
4368 :sort
4369 :substitute
4370 :vglobal
4371 :vimgrep
4372 :vimgrepadd
4373< Note that the match will be shown, but the cursor will return to its
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004374 original position when no match is found and when pressing <Esc>. You
4375 still need to finish the search command with <Enter> to move the
4376 cursor to the match.
Bram Moolenaardc083282016-10-11 08:57:33 +02004377 You can use the CTRL-G and CTRL-T keys to move to the next and
4378 previous match. |c_CTRL-G| |c_CTRL-T|
Bram Moolenaar91a4e822008-01-19 14:59:58 +00004379 When compiled with the |+reltime| feature Vim only searches for about
4380 half a second. With a complicated pattern and/or a lot of text the
4381 match may not be found. This is to avoid that Vim hangs while you
4382 are typing the pattern.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004383 The highlighting can be set with the 'i' flag in 'highlight'.
Bram Moolenaar2f058492017-11-30 20:27:52 +01004384 When 'hlsearch' is on, all matched strings are highlighted too while
4385 typing a search command. See also: 'hlsearch'.
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004386 If you don't want to turn 'hlsearch' on, but want to highlight all
4387 matches while searching, you can turn on and off 'hlsearch' with
4388 autocmd. Example: >
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004389 augroup vimrc-incsearch-highlight
4390 autocmd!
Bram Moolenaarf8f8b2e2017-11-02 19:08:48 +01004391 autocmd CmdlineEnter /,\? :set hlsearch
4392 autocmd CmdlineLeave /,\? :set nohlsearch
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004393 augroup END
4394<
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004395 CTRL-L can be used to add one character from after the current match
Bram Moolenaara9dc3752010-07-11 20:46:53 +02004396 to the command line. If 'ignorecase' and 'smartcase' are set and the
4397 command line has no uppercase characters, the added character is
4398 converted to lowercase.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004399 CTRL-R CTRL-W can be used to add the word at the end of the current
4400 match, excluding the characters that were already typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004401 NOTE: This option is reset when 'compatible' is set.
4402
4403 *'indentexpr'* *'inde'*
4404'indentexpr' 'inde' string (default "")
4405 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004406 {not available when compiled without the |+cindent|
4407 or |+eval| features}
4408 Expression which is evaluated to obtain the proper indent for a line.
4409 It is used when a new line is created, for the |=| operator and
4410 in Insert mode as specified with the 'indentkeys' option.
4411 When this option is not empty, it overrules the 'cindent' and
Bram Moolenaar20f90cf2011-05-19 12:22:51 +02004412 'smartindent' indenting. When 'lisp' is set, this option is
4413 overridden by the Lisp indentation algorithm.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004414 When 'paste' is set this option is not used for indenting.
4415 The expression is evaluated with |v:lnum| set to the line number for
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004416 which the indent is to be computed. The cursor is also in this line
Bram Moolenaar071d4272004-06-13 20:20:40 +00004417 when the expression is evaluated (but it may be moved around).
4418 The expression must return the number of spaces worth of indent. It
4419 can return "-1" to keep the current indent (this means 'autoindent' is
4420 used for the indent).
4421 Functions useful for computing the indent are |indent()|, |cindent()|
4422 and |lispindent()|.
4423 The evaluation of the expression must not have side effects! It must
4424 not change the text, jump to another window, etc. Afterwards the
4425 cursor position is always restored, thus the cursor may be moved.
4426 Normally this option would be set to call a function: >
4427 :set indentexpr=GetMyIndent()
4428< Error messages will be suppressed, unless the 'debug' option contains
4429 "msg".
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004430 See |indent-expression|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01004431 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004432
Bram Moolenaar30b65812012-07-12 22:01:11 +02004433 The expression will be evaluated in the |sandbox| when set from a
4434 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004435 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004436
4437 It is not allowed to change text or jump to another window while
4438 evaluating 'indentexpr' |textlock|.
4439
4440
Bram Moolenaar071d4272004-06-13 20:20:40 +00004441 *'indentkeys'* *'indk'*
Bram Moolenaarce655742019-01-31 14:12:57 +01004442'indentkeys' 'indk' string (default "0{,0},0),0],:,0#,!^F,o,O,e")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004443 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004444 {not available when compiled without the |+cindent|
4445 feature}
4446 A list of keys that, when typed in Insert mode, cause reindenting of
4447 the current line. Only happens if 'indentexpr' isn't empty.
4448 The format is identical to 'cinkeys', see |indentkeys-format|.
4449 See |C-indenting| and |indent-expression|.
4450
4451 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
4452'infercase' 'inf' boolean (default off)
4453 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004454 When doing keyword completion in insert mode |ins-completion|, and
Bram Moolenaar446cb832008-06-24 21:56:24 +00004455 'ignorecase' is also on, the case of the match is adjusted depending
4456 on the typed text. If the typed text contains a lowercase letter
4457 where the match has an upper case letter, the completed part is made
4458 lowercase. If the typed text has no lowercase letters and the match
4459 has a lowercase letter where the typed text has an uppercase letter,
4460 and there is a letter before it, the completed part is made uppercase.
4461 With 'noinfercase' the match is used as-is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004462
4463 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
4464'insertmode' 'im' boolean (default off)
4465 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004466 Makes Vim work in a way that Insert mode is the default mode. Useful
4467 if you want to use Vim as a modeless editor. Used for |evim|.
4468 These Insert mode commands will be useful:
4469 - Use the cursor keys to move around.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02004470 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|. When
Bram Moolenaar071d4272004-06-13 20:20:40 +00004471 this is a mapping, it is executed as if 'insertmode' was off.
4472 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004473 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00004474 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
4475 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004476
4477 These items change when 'insertmode' is set:
4478 - when starting to edit of a file, Vim goes to Insert mode.
4479 - <Esc> in Insert mode is a no-op and beeps.
4480 - <Esc> in Normal mode makes Vim go to Insert mode.
4481 - CTRL-L in Insert mode is a command, it is not inserted.
4482 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
4483 However, when <Esc> is used inside a mapping, it behaves like
4484 'insertmode' was not set. This was done to be able to use the same
4485 mappings with 'insertmode' set or not set.
4486 When executing commands with |:normal| 'insertmode' is not used.
4487
4488 NOTE: This option is reset when 'compatible' is set.
4489
4490 *'isfname'* *'isf'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004491'isfname' 'isf' string (default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004492 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
4493 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
4494 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
4495 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
4496 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
4497 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004498 The characters specified by this option are included in file names and
4499 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004500 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004501 Multi-byte characters 256 and above are always included, only the
4502 characters up to 255 are specified with this option.
4503 For UTF-8 the characters 0xa0 to 0xff are included as well.
Bram Moolenaar446cb832008-06-24 21:56:24 +00004504 Think twice before adding white space to this option. Although a
4505 space may appear inside a file name, the effect will be that Vim
4506 doesn't know where a file name starts or ends when doing completion.
4507 It most likely works better without a space in 'isfname'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004508
4509 Note that on systems using a backslash as path separator, Vim tries to
4510 do its best to make it work as you would expect. That is a bit
4511 tricky, since Vi originally used the backslash to escape special
4512 characters. Vim will not remove a backslash in front of a normal file
4513 name character on these systems, but it will on Unix and alikes. The
4514 '&' and '^' are not included by default, because these are special for
4515 cmd.exe.
4516
4517 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004518 Each part can be a single character number or a range. A range is two
4519 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004520 decimal number between 0 and 255 or the ASCII character itself (does
4521 not work for digits). Example:
4522 "_,-,128-140,#-43" (include '_' and '-' and the range
4523 128 to 140 and '#' to 43)
4524 If a part starts with '^', the following character number or range
4525 will be excluded from the option. The option is interpreted from left
4526 to right. Put the excluded character after the range where it is
4527 included. To include '^' itself use it as the last character of the
4528 option or the end of a range. Example:
4529 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
4530 If the character is '@', all characters where isalpha() returns TRUE
4531 are included. Normally these are the characters a to z and A to Z,
4532 plus accented characters. To include '@' itself use "@-@". Examples:
4533 "@,^a-z" All alphabetic characters, excluding lower
Bram Moolenaar446cb832008-06-24 21:56:24 +00004534 case ASCII letters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004535 "a-z,A-Z,@-@" All letters plus the '@' character.
4536 A comma can be included by using it where a character number is
4537 expected. Example:
4538 "48-57,,,_" Digits, comma and underscore.
4539 A comma can be excluded by prepending a '^'. Example:
4540 " -~,^,,9" All characters from space to '~', excluding
4541 comma, plus <Tab>.
4542 See |option-backslash| about including spaces and backslashes.
4543
4544 *'isident'* *'isi'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004545'isident' 'isi' string (default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004546 "@,48-57,_,128-167,224-235"
4547 otherwise: "@,48-57,_,192-255")
4548 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004549 The characters given by this option are included in identifiers.
4550 Identifiers are used in recognizing environment variables and after a
4551 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00004552 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004553 option. For '@' only characters up to 255 are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004554 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004555 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00004556 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
4557
4558 *'iskeyword'* *'isk'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004559'iskeyword' 'isk' string (Vim default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004560 "@,48-57,_,128-167,224-235"
4561 otherwise: "@,48-57,_,192-255"
4562 Vi default: "@,48-57,_")
4563 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004564 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004565 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004566 'isfname' for a description of the format of this option. For '@'
4567 characters above 255 check the "word" character class.
4568 For C programs you could use "a-z,A-Z,48-57,_,.,-,>".
Bram Moolenaar071d4272004-06-13 20:20:40 +00004569 For a help file it is set to all non-blank printable characters except
4570 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
4571 command).
4572 When the 'lisp' option is on the '-' character is always included.
Bram Moolenaarb8060fe2016-01-19 22:29:28 +01004573 This option also influences syntax highlighting, unless the syntax
4574 uses |:syn-iskeyword|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004575 NOTE: This option is set to the Vi default value when 'compatible' is
4576 set and to the Vim default value when 'compatible' is reset.
4577
4578 *'isprint'* *'isp'*
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02004579'isprint' 'isp' string (default for Win32 and macOS:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004580 "@,~-255"; otherwise: "@,161-255")
4581 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004582 The characters given by this option are displayed directly on the
4583 screen. It is also used for "\p" in a |pattern|. The characters from
4584 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
4585 even when they are not included in 'isprint' or excluded. See
4586 'isfname' for a description of the format of this option.
4587
4588 Non-printable characters are displayed with two characters:
4589 0 - 31 "^@" - "^_"
4590 32 - 126 always single characters
4591 127 "^?"
4592 128 - 159 "~@" - "~_"
4593 160 - 254 "| " - "|~"
4594 255 "~?"
4595 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
4596 displayed as <xx>, with the hexadecimal value of the byte.
4597 When 'display' contains "uhex" all unprintable characters are
4598 displayed as <xx>.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004599 The SpecialKey highlighting will be used for unprintable characters.
4600 |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004601
4602 Multi-byte characters 256 and above are always included, only the
4603 characters up to 255 are specified with this option. When a character
4604 is printable but it is not available in the current font, a
4605 replacement character will be shown.
4606 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
4607 There is no option to specify these characters.
4608
4609 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
4610'joinspaces' 'js' boolean (default on)
4611 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004612 Insert two spaces after a '.', '?' and '!' with a join command.
4613 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
4614 Otherwise only one space is inserted.
4615 NOTE: This option is set when 'compatible' is set.
4616
4617 *'key'*
4618'key' string (default "")
4619 local to buffer
Bram Moolenaar996343d2010-07-04 22:20:21 +02004620 {only available when compiled with the |+cryptv|
4621 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004622 The key that is used for encrypting and decrypting the current buffer.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02004623 See |encryption| and 'cryptmethod'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004624 Careful: Do not set the key value by hand, someone might see the typed
4625 key. Use the |:X| command. But you can make 'key' empty: >
4626 :set key=
4627< It is not possible to get the value of this option with ":set key" or
4628 "echo &key". This is to avoid showing it to someone who shouldn't
4629 know. It also means you cannot see it yourself once you have set it,
4630 be careful not to make a typing error!
Bram Moolenaard58e9292011-02-09 17:07:58 +01004631 You can use "&key" in an expression to detect whether encryption is
4632 enabled. When 'key' is set it returns "*****" (five stars).
Bram Moolenaar071d4272004-06-13 20:20:40 +00004633
4634 *'keymap'* *'kmp'* *E544*
4635'keymap' 'kmp' string (default "")
4636 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004637 {only available when compiled with the |+keymap|
4638 feature}
4639 Name of a keyboard mapping. See |mbyte-keymap|.
4640 Setting this option to a valid keymap name has the side effect of
4641 setting 'iminsert' to one, so that the keymap becomes effective.
4642 'imsearch' is also set to one, unless it was -1
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004643 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004644
4645 *'keymodel'* *'km'*
4646'keymodel' 'km' string (default "")
4647 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004648 List of comma separated words, which enable special things that keys
4649 can do. These values can be used:
4650 startsel Using a shifted special key starts selection (either
4651 Select mode or Visual mode, depending on "key" being
4652 present in 'selectmode').
4653 stopsel Using a not-shifted special key stops selection.
4654 Special keys in this context are the cursor keys, <End>, <Home>,
4655 <PageUp> and <PageDown>.
4656 The 'keymodel' option is set by the |:behave| command.
4657
4658 *'keywordprg'* *'kp'*
4659'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02004660 VMS: "help")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004661 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004662 Program to use for the |K| command. Environment variables are
4663 expanded |:set_env|. ":help" may be used to access the Vim internal
4664 help. (Note that previously setting the global option to the empty
4665 value did this, which is now deprecated.)
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02004666 When the first character is ":", the command is invoked as a Vim
4667 Ex command prefixed with [count].
4668 When "man", "man -s" or an Ex command is used, Vim will automatically
4669 translate a count for the "K" command and pass it as the first
4670 argument. For "man -s" the "-s" is removed when there is no count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004671 See |option-backslash| about including spaces and backslashes.
4672 Example: >
4673 :set keywordprg=man\ -s
4674< This option cannot be set from a |modeline| or in the |sandbox|, for
4675 security reasons.
4676
4677 *'langmap'* *'lmap'* *E357* *E358*
4678'langmap' 'lmap' string (default "")
4679 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004680 {only available when compiled with the |+langmap|
4681 feature}
4682 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004683 mode. When you are typing text in Insert mode the characters are
Bram Moolenaarfa735342016-01-03 22:14:44 +01004684 inserted directly. When in Normal mode the 'langmap' option takes
Bram Moolenaar071d4272004-06-13 20:20:40 +00004685 care of translating these special characters to the original meaning
4686 of the key. This means you don't have to change the keyboard mode to
4687 be able to execute Normal mode commands.
4688 This is the opposite of the 'keymap' option, where characters are
4689 mapped in Insert mode.
Bram Moolenaarb17893a2020-03-14 08:19:51 +01004690 Also consider setting 'langremap' to off, to prevent 'langmap' from
4691 applying to characters resulting from a mapping.
Bram Moolenaare968e362014-05-13 20:23:24 +02004692 This option cannot be set from a |modeline| or in the |sandbox|, for
4693 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004694
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00004695 Example (for Greek, in UTF-8): *greek* >
4696 :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 +00004697< Example (exchanges meaning of z and y for commands): >
4698 :set langmap=zy,yz,ZY,YZ
4699<
4700 The 'langmap' option is a list of parts, separated with commas. Each
4701 part can be in one of two forms:
4702 1. A list of pairs. Each pair is a "from" character immediately
4703 followed by the "to" character. Examples: "aA", "aAbBcC".
4704 2. A list of "from" characters, a semi-colon and a list of "to"
4705 characters. Example: "abc;ABC"
4706 Example: "aA,fgh;FGH,cCdDeE"
4707 Special characters need to be preceded with a backslash. These are
Bram Moolenaar4f4d51a2020-10-11 13:57:40 +02004708 ";", ',', '"', '|' and backslash itself.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004709
4710 This will allow you to activate vim actions without having to switch
4711 back and forth between the languages. Your language characters will
4712 be understood as normal vim English characters (according to the
4713 langmap mappings) in the following cases:
4714 o Normal/Visual mode (commands, buffer/register names, user mappings)
4715 o Insert/Replace Mode: Register names after CTRL-R
4716 o Insert/Replace Mode: Mappings
4717 Characters entered in Command-line mode will NOT be affected by
4718 this option. Note that this option can be changed at any time
4719 allowing to switch between mappings for different languages/encodings.
4720 Use a mapping to avoid having to type it each time!
4721
4722 *'langmenu'* *'lm'*
4723'langmenu' 'lm' string (default "")
4724 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004725 {only available when compiled with the |+menu| and
4726 |+multi_lang| features}
4727 Language to use for menu translation. Tells which file is loaded
4728 from the "lang" directory in 'runtimepath': >
4729 "lang/menu_" . &langmenu . ".vim"
4730< (without the spaces). For example, to always use the Dutch menus, no
4731 matter what $LANG is set to: >
4732 :set langmenu=nl_NL.ISO_8859-1
4733< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004734 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004735 If your $LANG is set to a non-English language but you do want to use
4736 the English menus: >
4737 :set langmenu=none
4738< This option must be set before loading menus, switching on filetype
4739 detection or syntax highlighting. Once the menus are defined setting
4740 this option has no effect. But you could do this: >
4741 :source $VIMRUNTIME/delmenu.vim
4742 :set langmenu=de_DE.ISO_8859-1
4743 :source $VIMRUNTIME/menu.vim
4744< Warning: This deletes all menus that you defined yourself!
4745
Bram Moolenaard94464e2015-11-02 15:28:18 +01004746 *'langnoremap'* *'lnr'* *'nolangnoremap'* *'nolnr'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004747'langnoremap' 'lnr' boolean (default off, set in |defaults.vim|)
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004748 global
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004749 {only available when compiled with the |+langmap|
4750 feature}
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004751 This is just like 'langremap' but with the value inverted. It only
4752 exists for backwards compatibility. When setting 'langremap' then
4753 'langnoremap' is set to the inverted value, and the other way around.
4754
4755 *'langremap'* *'lrm'* *'nolangremap'* *'nolrm'*
Bram Moolenaarb17893a2020-03-14 08:19:51 +01004756'langremap' 'lrm' boolean (default on, set to off in |defaults.vim|)
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004757 global
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004758 {only available when compiled with the |+langmap|
4759 feature}
4760 When off, setting 'langmap' does not apply to characters resulting from
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004761 a mapping. This basically means, if you noticed that setting
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004762 'langmap' disables some of your mappings, try resetting this option.
4763 This option defaults to on for backwards compatibility. Set it off if
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004764 that works for you to avoid mappings to break.
4765
Bram Moolenaar071d4272004-06-13 20:20:40 +00004766 *'laststatus'* *'ls'*
4767'laststatus' 'ls' number (default 1)
4768 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004769 The value of this option influences when the last window will have a
4770 status line:
4771 0: never
4772 1: only if there are at least two windows
4773 2: always
4774 The screen looks nicer with a status line if you have several
4775 windows, but it takes another screen line. |status-line|
4776
4777 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
4778'lazyredraw' 'lz' boolean (default off)
4779 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004780 When this option is set, the screen will not be redrawn while
4781 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004782 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00004783 update use |:redraw|.
4784
4785 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
4786'linebreak' 'lbr' boolean (default off)
4787 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02004788 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004789 feature}
Bram Moolenaar946e27a2014-06-25 18:50:27 +02004790 If on, Vim will wrap long lines at a character in 'breakat' rather
Bram Moolenaar071d4272004-06-13 20:20:40 +00004791 than at the last character that fits on the screen. Unlike
4792 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
Bram Moolenaar946e27a2014-06-25 18:50:27 +02004793 it only affects the way the file is displayed, not its contents.
4794 If 'breakindent' is set, line is visually indented. Then, the value
4795 of 'showbreak' is used to put in front of wrapped lines. This option
Bram Moolenaar86b17e92014-07-02 20:00:47 +02004796 is not used when the 'wrap' option is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004797 Note that <Tab> characters after an <EOL> are mostly not displayed
4798 with the right amount of white space.
4799
4800 *'lines'* *E593*
4801'lines' number (default 24 or terminal height)
4802 global
4803 Number of lines of the Vim window.
4804 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00004805 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004806 When Vim is running in the GUI or in a resizable window, setting this
4807 option will cause the window size to be changed. When you only want
4808 to use the size for the GUI, put the command in your |gvimrc| file.
4809 Vim limits the number of lines to what fits on the screen. You can
4810 use this command to get the tallest window possible: >
4811 :set lines=999
Bram Moolenaarf4d11452005-12-02 00:46:37 +00004812< Minimum value is 2, maximum value is 1000.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02004813 If you get fewer lines than expected, check the 'guiheadroom' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004814 When you set this option and Vim is unable to change the physical
4815 number of lines of the display, the display may be messed up.
4816
4817 *'linespace'* *'lsp'*
4818'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
4819 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004820 {only in the GUI}
4821 Number of pixel lines inserted between characters. Useful if the font
4822 uses the full character cell height, making lines touch each other.
4823 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004824 With some fonts there can be too much room between lines (to have
4825 space for ascents and descents). Then it makes sense to set
4826 'linespace' to a negative value. This may cause display problems
4827 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00004828
4829 *'lisp'* *'nolisp'*
4830'lisp' boolean (default off)
4831 local to buffer
4832 {not available when compiled without the |+lispindent|
4833 feature}
4834 Lisp mode: When <Enter> is typed in insert mode set the indent for
4835 the next line to Lisp standards (well, sort of). Also happens with
4836 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
4837 flag in 'cpoptions' changes the method of indenting: Vi compatible or
4838 better. Also see 'lispwords'.
4839 The '-' character is included in keyword characters. Redefines the
4840 "=" operator to use this same indentation algorithm rather than
4841 calling an external program if 'equalprg' is empty.
4842 This option is not used when 'paste' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004843
4844 *'lispwords'* *'lw'*
4845'lispwords' 'lw' string (default is very long)
Bram Moolenaaraf6c1312014-03-12 18:55:58 +01004846 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004847 {not available when compiled without the |+lispindent|
4848 feature}
4849 Comma separated list of words that influence the Lisp indenting.
4850 |'lisp'|
4851
4852 *'list'* *'nolist'*
4853'list' boolean (default off)
4854 local to window
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004855 List mode: Show tabs as CTRL-I is displayed, display $ after end of
4856 line. Useful to see the difference between tabs and spaces and for
4857 trailing blanks. Further changed by the 'listchars' option.
4858
4859 The cursor is displayed at the start of the space a Tab character
4860 occupies, not at the end as usual in Normal mode. To get this cursor
4861 position while displaying Tabs with spaces, use: >
Bram Moolenaardd007ed2013-07-09 15:44:17 +02004862 :set list lcs=tab:\ \
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004863<
4864 Note that list mode will also affect formatting (set with 'textwidth'
4865 or 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
Bram Moolenaar071d4272004-06-13 20:20:40 +00004866 changing the way tabs are displayed.
4867
4868 *'listchars'* *'lcs'*
4869'listchars' 'lcs' string (default "eol:$")
Bram Moolenaareed9d462021-02-15 20:38:25 +01004870 global or local to window |global-local|
Bram Moolenaarf9d5ca12010-08-01 16:13:51 +02004871 Strings to use in 'list' mode and for the |:list| command. It is a
4872 comma separated list of string settings.
Bram Moolenaar79278362015-04-21 18:33:48 +02004873 *lcs-eol*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004874 eol:c Character to show at the end of each line. When
4875 omitted, there is no extra character at the end of the
4876 line.
Bram Moolenaar79278362015-04-21 18:33:48 +02004877 *lcs-tab*
Bram Moolenaar83a52172019-01-16 22:41:54 +01004878 tab:xy[z] Two or three characters to be used to show a tab.
4879 The third character is optional.
4880
4881 tab:xy The 'x' is always used, then 'y' as many times as will
4882 fit. Thus "tab:>-" displays:
4883 >
4884 >-
4885 >--
4886 etc.
4887
4888 tab:xyz The 'z' is always used, then 'x' is prepended, and
4889 then 'y' is used as many times as will fit. Thus
4890 "tab:<->" displays:
4891 >
4892 <>
4893 <->
4894 <-->
4895 etc.
4896
4897 When "tab:" is omitted, a tab is shown as ^I.
Bram Moolenaar79278362015-04-21 18:33:48 +02004898 *lcs-space*
4899 space:c Character to show for a space. When omitted, spaces
4900 are left blank.
Bram Moolenaar91478ae2021-02-03 15:58:13 +01004901 *lcs-lead*
4902 lead:c Character to show for leading spaces. When omitted,
4903 leading spaces are blank. Overrides the "space"
Bram Moolenaar942db232021-02-13 18:14:48 +01004904 setting for leading spaces. You can combine it with
4905 "tab:", for example: >
4906 :set listchars+=tab:>-,lead:.
4907< *lcs-trail*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004908 trail:c Character to show for trailing spaces. When omitted,
Bram Moolenaar79278362015-04-21 18:33:48 +02004909 trailing spaces are blank. Overrides the "space"
4910 setting for trailing spaces.
4911 *lcs-extends*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004912 extends:c Character to show in the last column, when 'wrap' is
4913 off and the line continues beyond the right of the
4914 screen.
Bram Moolenaar79278362015-04-21 18:33:48 +02004915 *lcs-precedes*
Bram Moolenaarbffba7f2019-09-20 17:00:17 +02004916 precedes:c Character to show in the first visible column of the
4917 physical line, when there is text preceding the
4918 character visible in the first column.
Bram Moolenaar79278362015-04-21 18:33:48 +02004919 *lcs-conceal*
Bram Moolenaar860cae12010-06-05 23:22:07 +02004920 conceal:c Character to show in place of concealed text, when
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004921 'conceallevel' is set to 1.
Bram Moolenaar79278362015-04-21 18:33:48 +02004922 *lcs-nbsp*
Bram Moolenaar73284b92015-05-04 17:28:22 +02004923 nbsp:c Character to show for a non-breakable space character
4924 (0xA0 (160 decimal) and U+202F). Left blank when
4925 omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004926
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004927 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00004928 be used when 'encoding' is "utf-8", otherwise only printable
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004929 characters are allowed. All characters must be single width.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004930
4931 Examples: >
4932 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004933 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00004934 :set lcs=extends:>,precedes:<
4935< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaar79278362015-04-21 18:33:48 +02004936 "precedes". "SpecialKey" for "nbsp", "space", "tab" and "trail".
Bram Moolenaar02467872007-05-06 13:22:01 +00004937 |hl-NonText| |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004938
4939 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
4940'loadplugins' 'lpl' boolean (default on)
4941 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004942 When on the plugin scripts are loaded when starting up |load-plugins|.
4943 This option can be reset in your |vimrc| file to disable the loading
4944 of plugins.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02004945 Note that using the "-u NONE", "-u DEFAULTS" and "--noplugin" command
4946 line arguments reset this option. See |-u| and |--noplugin|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004947
Bram Moolenaard94464e2015-11-02 15:28:18 +01004948 *'luadll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01004949'luadll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01004950 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01004951 {only available when compiled with the |+lua/dyn|
4952 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01004953 Specifies the name of the Lua shared library. The default is
4954 DYNAMIC_LUA_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02004955 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01004956 This option cannot be set from a |modeline| or in the |sandbox|, for
4957 security reasons.
4958
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00004959 *'macatsui'* *'nomacatsui'*
4960'macatsui' boolean (default on)
4961 global
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02004962 {not supported}
4963 No longer supported, as the Mac OS X GUI code was removed.
Bram Moolenaar02467872007-05-06 13:22:01 +00004964
Bram Moolenaar071d4272004-06-13 20:20:40 +00004965 *'magic'* *'nomagic'*
4966'magic' boolean (default on)
4967 global
4968 Changes the special characters that can be used in search patterns.
4969 See |pattern|.
Bram Moolenaar64d8e252016-09-06 22:12:34 +02004970 WARNING: Switching this option off most likely breaks plugins! That
4971 is because many patterns assume it's on and will fail when it's off.
4972 Only switch it off when working with old Vi scripts. In any other
4973 situation write patterns that work when 'magic' is on. Include "\M"
4974 when you want to |/\M|.
Bram Moolenaar4072ba52020-12-23 13:56:35 +01004975 In |Vim9| script the value of 'magic' is ignored, patterns behave like
4976 it is always set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004977
4978 *'makeef'* *'mef'*
4979'makeef' 'mef' string (default: "")
4980 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004981 {not available when compiled without the |+quickfix|
4982 feature}
4983 Name of the errorfile for the |:make| command (see |:make_makeprg|)
4984 and the |:grep| command.
4985 When it is empty, an internally generated temp file will be used.
4986 When "##" is included, it is replaced by a number to make the name
4987 unique. This makes sure that the ":make" command doesn't overwrite an
4988 existing file.
4989 NOT used for the ":cf" command. See 'errorfile' for that.
4990 Environment variables are expanded |:set_env|.
4991 See |option-backslash| about including spaces and backslashes.
4992 This option cannot be set from a |modeline| or in the |sandbox|, for
4993 security reasons.
4994
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01004995 *'makeencoding'* *'menc'*
4996'makeencoding' 'menc' string (default "")
4997 global or local to buffer |global-local|
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01004998 Encoding used for reading the output of external commands. When empty,
4999 encoding is not converted.
5000 This is used for `:make`, `:lmake`, `:grep`, `:lgrep`, `:grepadd`,
5001 `:lgrepadd`, `:cfile`, `:cgetfile`, `:caddfile`, `:lfile`, `:lgetfile`,
5002 and `:laddfile`.
5003
5004 This would be mostly useful when you use MS-Windows and set 'encoding'
5005 to "utf-8". If |+iconv| is enabled and GNU libiconv is used, setting
5006 'makeencoding' to "char" has the same effect as setting to the system
5007 locale encoding. Example: >
5008 :set encoding=utf-8
5009 :set makeencoding=char " system locale is used
5010<
Bram Moolenaar071d4272004-06-13 20:20:40 +00005011 *'makeprg'* *'mp'*
5012'makeprg' 'mp' string (default "make", VMS: "MMS")
5013 global or local to buffer |global-local|
Bram Moolenaar02467872007-05-06 13:22:01 +00005014 Program to use for the ":make" command. See |:make_makeprg|.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01005015 This option may contain '%' and '#' characters (see |:_%| and |:_#|),
5016 which are expanded to the current and alternate file name. Use |::S|
Bram Moolenaar26df0922014-02-23 23:39:13 +01005017 to escape file names in case they contain special characters.
Bram Moolenaar02467872007-05-06 13:22:01 +00005018 Environment variables are expanded |:set_env|. See |option-backslash|
5019 about including spaces and backslashes.
5020 Note that a '|' must be escaped twice: once for ":set" and once for
5021 the interpretation of a command. When you use a filter called
5022 "myfilter" do it like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005023 :set makeprg=gmake\ \\\|\ myfilter
5024< The placeholder "$*" can be given (even multiple times) to specify
5025 where the arguments will be included, for example: >
5026 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
5027< This option cannot be set from a |modeline| or in the |sandbox|, for
5028 security reasons.
5029
5030 *'matchpairs'* *'mps'*
5031'matchpairs' 'mps' string (default "(:),{:},[:]")
5032 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005033 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01005034 other.
5035 Only character pairs are allowed that are different, thus you cannot
5036 jump between two double quotes.
5037 The characters must be separated by a colon.
Bram Moolenaar02467872007-05-06 13:22:01 +00005038 The pairs must be separated by a comma. Example for including '<' and
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02005039 '>' (for HTML): >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005040 :set mps+=<:>
5041
5042< A more exotic example, to jump between the '=' and ';' in an
5043 assignment, useful for languages like C and Java: >
5044 :au FileType c,cpp,java set mps+==:;
5045
5046< For a more advanced way of using "%", see the matchit.vim plugin in
Bram Moolenaar01164a62017-11-02 22:58:42 +01005047 the $VIMRUNTIME/pack/dist/opt/matchit directory. |add-local-help|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005048
5049 *'matchtime'* *'mat'*
5050'matchtime' 'mat' number (default 5)
5051 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005052 Tenths of a second to show the matching paren, when 'showmatch' is
5053 set. Note that this is not in milliseconds, like other options that
5054 set a time. This is to be compatible with Nvi.
5055
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005056 *'maxcombine'* *'mco'*
5057'maxcombine' 'mco' number (default 2)
5058 global
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005059 The maximum number of combining characters supported for displaying.
5060 Only used when 'encoding' is "utf-8".
5061 The default is OK for most languages. Hebrew may require 4.
5062 Maximum value is 6.
5063 Even when this option is set to 2 you can still edit text with more
5064 combining characters, you just can't see them. Use |g8| or |ga|.
5065 See |mbyte-combining|.
5066
Bram Moolenaar071d4272004-06-13 20:20:40 +00005067 *'maxfuncdepth'* *'mfd'*
5068'maxfuncdepth' 'mfd' number (default 100)
5069 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02005070 {not available when compiled without the |+eval|
Bram Moolenaar02467872007-05-06 13:22:01 +00005071 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005072 Maximum depth of function calls for user functions. This normally
5073 catches endless recursion. When using a recursive function with
5074 more depth, set 'maxfuncdepth' to a bigger number. But this will use
5075 more memory, there is the danger of failing when memory is exhausted.
Bram Moolenaarbc2eada2017-01-02 21:27:47 +01005076 Increasing this limit above 200 also changes the maximum for Ex
Bram Moolenaar0b0f0992018-05-22 21:41:30 +02005077 command recursion, see |E169|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005078 See also |:function|.
5079
5080 *'maxmapdepth'* *'mmd'* *E223*
5081'maxmapdepth' 'mmd' number (default 1000)
5082 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005083 Maximum number of times a mapping is done without resulting in a
5084 character to be used. This normally catches endless mappings, like
5085 ":map x y" with ":map y x". It still does not catch ":map g wg",
5086 because the 'w' is used before the next mapping is done. See also
5087 |key-mapping|.
5088
5089 *'maxmem'* *'mm'*
5090'maxmem' 'mm' number (default between 256 to 5120 (system
5091 dependent) or half the amount of memory
5092 available)
5093 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005094 Maximum amount of memory (in Kbyte) to use for one buffer. When this
5095 limit is reached allocating extra memory for a buffer will cause
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005096 other memory to be freed.
5097 The maximum usable value is about 2000000. Use this to work without a
5098 limit.
5099 The value is ignored when 'swapfile' is off.
5100 Also see 'maxmemtot'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005101
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005102 *'maxmempattern'* *'mmp'*
5103'maxmempattern' 'mmp' number (default 1000)
5104 global
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005105 Maximum amount of memory (in Kbyte) to use for pattern matching.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005106 The maximum value is about 2000000. Use this to work without a limit.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005107 *E363*
Bram Moolenaar02467872007-05-06 13:22:01 +00005108 When Vim runs into the limit it gives an error message and mostly
5109 behaves like CTRL-C was typed.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005110 Running into the limit often means that the pattern is very
5111 inefficient or too complex. This may already happen with the pattern
5112 "\(.\)*" on a very long line. ".*" works much better.
Bram Moolenaarfd358112018-07-07 23:21:31 +02005113 Might also happen on redraw, when syntax rules try to match a complex
5114 text structure.
5115 Vim may run out of memory before hitting the 'maxmempattern' limit, in
5116 which case you get an "Out of memory" error instead.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005117
Bram Moolenaar071d4272004-06-13 20:20:40 +00005118 *'maxmemtot'* *'mmt'*
5119'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
5120 dependent) or half the amount of memory
5121 available)
5122 global
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005123 Maximum amount of memory in Kbyte to use for all buffers together.
5124 The maximum usable value is about 2000000 (2 Gbyte). Use this to work
Bram Moolenaarfa735342016-01-03 22:14:44 +01005125 without a limit.
5126 On 64 bit machines higher values might work. But hey, do you really
5127 need more than 2 Gbyte for text editing? Keep in mind that text is
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005128 stored in the swap file, one can edit files > 2 Gbyte anyway. We do
Bram Moolenaarfa735342016-01-03 22:14:44 +01005129 need the memory to store undo info.
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005130 Buffers with 'swapfile' off still count to the total amount of memory
5131 used.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005132 Also see 'maxmem'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005133
5134 *'menuitems'* *'mis'*
5135'menuitems' 'mis' number (default 25)
5136 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005137 {not available when compiled without the |+menu|
5138 feature}
5139 Maximum number of items to use in a menu. Used for menus that are
5140 generated from a list of items, e.g., the Buffers menu. Changing this
5141 option has no direct effect, the menu must be refreshed first.
5142
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005143 *'mkspellmem'* *'msm'*
5144'mkspellmem' 'msm' string (default "460000,2000,500")
5145 global
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005146 {not available when compiled without the |+syntax|
5147 feature}
5148 Parameters for |:mkspell|. This tunes when to start compressing the
5149 word tree. Compression can be slow when there are many words, but
5150 it's needed to avoid running out of memory. The amount of memory used
5151 per word depends very much on how similar the words are, that's why
5152 this tuning is complicated.
5153
5154 There are three numbers, separated by commas:
5155 {start},{inc},{added}
5156
5157 For most languages the uncompressed word tree fits in memory. {start}
5158 gives the amount of memory in Kbyte that can be used before any
5159 compression is done. It should be a bit smaller than the amount of
5160 memory that is available to Vim.
5161
5162 When going over the {start} limit the {inc} number specifies the
5163 amount of memory in Kbyte that can be allocated before another
5164 compression is done. A low number means compression is done after
5165 less words are added, which is slow. A high number means more memory
5166 will be allocated.
5167
5168 After doing compression, {added} times 1024 words can be added before
5169 the {inc} limit is ignored and compression is done when any extra
5170 amount of memory is needed. A low number means there is a smaller
5171 chance of hitting the {inc} limit, less memory is used but it's
5172 slower.
5173
5174 The languages for which these numbers are important are Italian and
5175 Hungarian. The default works for when you have about 512 Mbyte. If
5176 you have 1 Gbyte you could use: >
5177 :set mkspellmem=900000,3000,800
5178< If you have less than 512 Mbyte |:mkspell| may fail for some
5179 languages, no matter what you set 'mkspellmem' to.
5180
Bram Moolenaar07607392019-05-26 19:20:43 +02005181 This option cannot be set from a |modeline| or in the |sandbox|.
5182
Bram Moolenaar071d4272004-06-13 20:20:40 +00005183 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
Bram Moolenaar8243a792007-05-01 17:05:03 +00005184'modeline' 'ml' boolean (Vim default: on (off for root),
5185 Vi default: off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005186 local to buffer
Bram Moolenaar110289e2019-05-23 15:38:06 +02005187 If 'modeline' is on 'modelines' gives the number of lines that is
5188 checked for set commands. If 'modeline' is off or 'modelines' is zero
5189 no lines are checked. See |modeline|.
5190
5191 *'modelineexpr'* *'mle'* *'nomodelineexpr'* *'nomle'*
5192'modelineexpr' 'mle' boolean (default: off)
5193 global
5194 When on allow some options that are an expression to be set in the
5195 modeline. Check the option for whether it is affected by
5196 'modelineexpr'. Also see |modeline|.
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02005197 This option cannot be set from a |modeline| or in the |sandbox|, for
5198 security reasons.
Bram Moolenaar110289e2019-05-23 15:38:06 +02005199
Bram Moolenaar071d4272004-06-13 20:20:40 +00005200 *'modelines'* *'mls'*
5201'modelines' 'mls' number (default 5)
5202 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005203 If 'modeline' is on 'modelines' gives the number of lines that is
5204 checked for set commands. If 'modeline' is off or 'modelines' is zero
5205 no lines are checked. See |modeline|.
5206 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
5207 set and to the Vim default value when 'compatible' is reset.
5208
5209 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
Bram Moolenaar110289e2019-05-23 15:38:06 +02005210 *E21*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005211'modifiable' 'ma' boolean (default on)
5212 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005213 When off the buffer contents cannot be changed. The 'fileformat' and
5214 'fileencoding' options also can't be changed.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01005215 Can be reset on startup with the |-M| command line argument.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005216
5217 *'modified'* *'mod'* *'nomodified'* *'nomod'*
5218'modified' 'mod' boolean (default off)
5219 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005220 When on, the buffer is considered to be modified. This option is set
5221 when:
5222 1. A change was made to the text since it was last written. Using the
5223 |undo| command to go back to the original text will reset the
5224 option. But undoing changes that were made before writing the
5225 buffer will set the option again, since the text is different from
5226 when it was written.
5227 2. 'fileformat' or 'fileencoding' is different from its original
5228 value. The original value is set when the buffer is read or
5229 written. A ":set nomodified" command also resets the original
5230 values to the current values and the 'modified' option will be
5231 reset.
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01005232 Similarly for 'eol' and 'bomb'.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02005233 This option is not set when a change is made to the buffer as the
5234 result of a BufNewFile, BufRead/BufReadPost, BufWritePost,
5235 FileAppendPost or VimLeave autocommand event. See |gzip-example| for
5236 an explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005237 When 'buftype' is "nowrite" or "nofile" this option may be set, but
5238 will be ignored.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01005239 Note that the text may actually be the same, e.g. 'modified' is set
5240 when using "rA" on an "A".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005241
5242 *'more'* *'nomore'*
5243'more' boolean (Vim default: on, Vi default: off)
5244 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005245 When on, listings pause when the whole screen is filled. You will get
5246 the |more-prompt|. When this option is off there are no pauses, the
5247 listing continues until finished.
5248 NOTE: This option is set to the Vi default value when 'compatible' is
5249 set and to the Vim default value when 'compatible' is reset.
5250
Bram Moolenaar98a29d02021-01-18 19:55:44 +01005251 *'mouse'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005252'mouse' string (default "", "a" for GUI and Win32,
Bram Moolenaar5b418992019-10-27 18:50:25 +01005253 set to "a" or "nvi" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005254 global
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005255 Enable the use of the mouse. Works for most terminals (xterm, Win32
5256 |win32-mouse|, QNX pterm, *BSD console with sysmouse and Linux console
5257 with gpm). For using the mouse in the GUI, see |gui-mouse|. The
5258 mouse can be enabled for different modes:
Bram Moolenaar7f2e9d72017-11-11 20:58:53 +01005259 n Normal mode and Terminal modes
Bram Moolenaar071d4272004-06-13 20:20:40 +00005260 v Visual mode
5261 i Insert mode
5262 c Command-line mode
5263 h all previous modes when editing a help file
5264 a all previous modes
5265 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005266 Normally you would enable the mouse in all five modes with: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005267 :set mouse=a
Bram Moolenaar5b418992019-10-27 18:50:25 +01005268< If your terminal can't overrule the mouse events going to the
5269 application, use: >
5270 :set mouse=nvi
Bram Moolenaar65e0d772020-06-14 17:29:55 +02005271< Then you can press ":", select text for the system, and press Esc to go
Bram Moolenaar5b418992019-10-27 18:50:25 +01005272 back to Vim using the mouse events.
5273 In |defaults.vim| "nvi" is used if the 'term' option is not matching
5274 "xterm".
5275
5276 When the mouse is not enabled, the GUI will still use the mouse for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005277 modeless selection. This doesn't move the text cursor.
5278
5279 See |mouse-using|. Also see |'clipboard'|.
5280
5281 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005282 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005283 the mouse buttons can still be used by keeping the shift key pressed.
5284 Also see the 'clipboard' option.
5285
5286 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
5287'mousefocus' 'mousef' boolean (default off)
5288 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005289 {only works in the GUI}
5290 The window that the mouse pointer is on is automatically activated.
5291 When changing the window layout or window focus in another way, the
5292 mouse pointer is moved to the window with keyboard focus. Off is the
5293 default because it makes using the pull down menus a little goofy, as
5294 a pointer transit may activate a window unintentionally.
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01005295 MS-Windows: Also see 'scrollfocus' for what window is scrolled when
Bram Moolenaar1d9215b2020-01-25 13:27:42 +01005296 using the mouse scroll wheel.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005297
5298 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
5299'mousehide' 'mh' boolean (default on)
5300 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005301 {only works in the GUI}
5302 When on, the mouse pointer is hidden when characters are typed.
5303 The mouse pointer is restored when the mouse is moved.
5304
5305 *'mousemodel'* *'mousem'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005306'mousemodel' 'mousem' string (default "extend", "popup" for Win32)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005307 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005308 Sets the model to use for the mouse. The name mostly specifies what
5309 the right mouse button is used for:
5310 extend Right mouse button extends a selection. This works
5311 like in an xterm.
5312 popup Right mouse button pops up a menu. The shifted left
5313 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00005314 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005315 popup_setpos Like "popup", but the cursor will be moved to the
5316 position where the mouse was clicked, and thus the
5317 selected operation will act upon the clicked object.
5318 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00005319 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005320 course, that right clicking outside a selection will
5321 end Visual mode.
5322 Overview of what button does what for each model:
5323 mouse extend popup(_setpos) ~
5324 left click place cursor place cursor
5325 left drag start selection start selection
5326 shift-left search word extend selection
5327 right click extend selection popup menu (place cursor)
5328 right drag extend selection -
5329 middle click paste paste
5330
5331 In the "popup" model the right mouse button produces a pop-up menu.
5332 You need to define this first, see |popup-menu|.
5333
5334 Note that you can further refine the meaning of buttons with mappings.
5335 See |gui-mouse-mapping|. But mappings are NOT used for modeless
5336 selection (because that's handled in the GUI code directly).
5337
5338 The 'mousemodel' option is set by the |:behave| command.
5339
5340 *'mouseshape'* *'mouses'* *E547*
Bram Moolenaarf6b40102019-02-22 15:24:03 +01005341'mouseshape' 'mouses' string (default "i-r:beam,s:updown,sd:udsizing,
5342 vs:leftright,vd:lrsizing,m:no,
5343 ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005344 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005345 {only available when compiled with the |+mouseshape|
5346 feature}
5347 This option tells Vim what the mouse pointer should look like in
5348 different modes. The option is a comma separated list of parts, much
5349 like used for 'guicursor'. Each part consist of a mode/location-list
5350 and an argument-list:
5351 mode-list:shape,mode-list:shape,..
5352 The mode-list is a dash separated list of these modes/locations:
5353 In a normal window: ~
5354 n Normal mode
5355 v Visual mode
5356 ve Visual mode with 'selection' "exclusive" (same as 'v',
5357 if not specified)
5358 o Operator-pending mode
5359 i Insert mode
5360 r Replace mode
5361
5362 Others: ~
5363 c appending to the command-line
5364 ci inserting in the command-line
5365 cr replacing in the command-line
5366 m at the 'Hit ENTER' or 'More' prompts
5367 ml idem, but cursor in the last line
5368 e any mode, pointer below last window
5369 s any mode, pointer on a status line
5370 sd any mode, while dragging a status line
5371 vs any mode, pointer on a vertical separator line
5372 vd any mode, while dragging a vertical separator line
5373 a everywhere
5374
5375 The shape is one of the following:
5376 avail name looks like ~
5377 w x arrow Normal mouse pointer
5378 w x blank no pointer at all (use with care!)
5379 w x beam I-beam
5380 w x updown up-down sizing arrows
5381 w x leftright left-right sizing arrows
5382 w x busy The system's usual busy pointer
5383 w x no The system's usual 'no input' pointer
5384 x udsizing indicates up-down resizing
5385 x lrsizing indicates left-right resizing
5386 x crosshair like a big thin +
5387 x hand1 black hand
5388 x hand2 white hand
5389 x pencil what you write with
5390 x question big ?
5391 x rightup-arrow arrow pointing right-up
5392 w x up-arrow arrow pointing up
5393 x <number> any X11 pointer number (see X11/cursorfont.h)
5394
5395 The "avail" column contains a 'w' if the shape is available for Win32,
5396 x for X11.
5397 Any modes not specified or shapes not available use the normal mouse
5398 pointer.
5399
5400 Example: >
5401 :set mouseshape=s:udsizing,m:no
5402< will make the mouse turn to a sizing arrow over the status lines and
5403 indicate no input when the hit-enter prompt is displayed (since
5404 clicking the mouse has no effect in this state.)
5405
5406 *'mousetime'* *'mouset'*
5407'mousetime' 'mouset' number (default 500)
5408 global
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005409 Only for GUI, Win32 and Unix with xterm. Defines the maximum
Bram Moolenaar071d4272004-06-13 20:20:40 +00005410 time in msec between two mouse clicks for the second click to be
5411 recognized as a multi click.
5412
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005413 *'mzschemedll'*
5414'mzschemedll' string (default depends on the build)
5415 global
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005416 {only available when compiled with the |+mzscheme/dyn|
5417 feature}
5418 Specifies the name of the MzScheme shared library. The default is
5419 DYNAMIC_MZSCH_DLL which was specified at compile time.
5420 Environment variables are expanded |:set_env|.
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01005421 The value must be set in the |vimrc| script or earlier. In the
Bram Moolenaar01164a62017-11-02 22:58:42 +01005422 startup, before the |load-plugins| step.
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005423 This option cannot be set from a |modeline| or in the |sandbox|, for
5424 security reasons.
5425
5426 *'mzschemegcdll'*
5427'mzschemegcdll' string (default depends on the build)
5428 global
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005429 {only available when compiled with the |+mzscheme/dyn|
5430 feature}
5431 Specifies the name of the MzScheme GC shared library. The default is
5432 DYNAMIC_MZGC_DLL which was specified at compile time.
5433 The value can be equal to 'mzschemedll' if it includes the GC code.
5434 Environment variables are expanded |:set_env|.
5435 This option cannot be set from a |modeline| or in the |sandbox|, for
5436 security reasons.
5437
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005438 *'mzquantum'* *'mzq'*
5439'mzquantum' 'mzq' number (default 100)
5440 global
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005441 {not available when compiled without the |+mzscheme|
5442 feature}
5443 The number of milliseconds between polls for MzScheme threads.
5444 Negative or zero value means no thread scheduling.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005445 NOTE: This option is set to the Vim default value when 'compatible'
5446 is reset.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005447
Bram Moolenaar071d4272004-06-13 20:20:40 +00005448 *'nrformats'* *'nf'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02005449'nrformats' 'nf' string (default "bin,octal,hex",
5450 set to "bin,hex" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005451 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005452 This defines what bases Vim will consider for numbers when using the
5453 CTRL-A and CTRL-X commands for adding to and subtracting from a number
5454 respectively; see |CTRL-A| for more info on these commands.
Bram Moolenaar4770d092006-01-12 23:22:24 +00005455 alpha If included, single alphabetical characters will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005456 incremented or decremented. This is useful for a list with a
Bram Moolenaar3848e002016-03-19 18:42:29 +01005457 letter index a), b), etc. *octal-nrformats*
Bram Moolenaar4770d092006-01-12 23:22:24 +00005458 octal If included, numbers that start with a zero will be considered
Bram Moolenaar071d4272004-06-13 20:20:40 +00005459 to be octal. Example: Using CTRL-A on "007" results in "010".
Bram Moolenaar4770d092006-01-12 23:22:24 +00005460 hex If included, numbers starting with "0x" or "0X" will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005461 considered to be hexadecimal. Example: Using CTRL-X on
5462 "0x100" results in "0x0ff".
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005463 bin If included, numbers starting with "0b" or "0B" will be
5464 considered to be binary. Example: Using CTRL-X on
5465 "0b1000" subtracts one, resulting in "0b0111".
Bram Moolenaaraaad9952020-05-31 15:08:59 +02005466 unsigned If included, numbers are recognized as unsigned. Thus a
5467 leading dash or negative sign won't be considered as part of
5468 the number. Examples:
5469 Using CTRL-X on "2020" in "9-2020" results in "9-2019"
5470 (without "unsigned" it would become "9-2021").
5471 Using CTRL-A on "2020" in "9-2020" results in "9-2021"
5472 (without "unsigned" it would become "9-2019").
Bram Moolenaaracc22402020-06-07 21:07:18 +02005473 Using CTRL-X on "0" or CTRL-A on "18446744073709551615"
5474 (2^64 - 1) has no effect, overflow is prevented.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005475 Numbers which simply begin with a digit in the range 1-9 are always
5476 considered decimal. This also happens for numbers that are not
5477 recognized as octal or hex.
5478
5479 *'number'* *'nu'* *'nonumber'* *'nonu'*
5480'number' 'nu' boolean (default off)
5481 local to window
5482 Print the line number in front of each line. When the 'n' option is
5483 excluded from 'cpoptions' a wrapped line will not use the column of
5484 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005485 The 'numberwidth' option can be used to set the room used for the line
5486 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005487 When a long, wrapped line doesn't start with the first character, '-'
5488 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02005489 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
5490 the number.
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005491 *number_relativenumber*
5492 The 'relativenumber' option changes the displayed number to be
5493 relative to the cursor. Together with 'number' there are these
5494 four combinations (cursor in line 3):
5495
Bram Moolenaar3848e002016-03-19 18:42:29 +01005496 'nonu' 'nu' 'nonu' 'nu'
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005497 'nornu' 'nornu' 'rnu' 'rnu'
5498
5499 |apple | 1 apple | 2 apple | 2 apple
5500 |pear | 2 pear | 1 pear | 1 pear
5501 |nobody | 3 nobody | 0 nobody |3 nobody
5502 |there | 4 there | 1 there | 1 there
Bram Moolenaar071d4272004-06-13 20:20:40 +00005503
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005504 *'numberwidth'* *'nuw'*
5505'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
5506 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005507 {only available when compiled with the |+linebreak|
5508 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005509 Minimal number of columns to use for the line number. Only relevant
Bram Moolenaar64486672010-05-16 15:46:46 +02005510 when the 'number' or 'relativenumber' option is set or printing lines
5511 with a line number. Since one space is always between the number and
5512 the text, there is one less character for the number itself.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005513 The value is the minimum width. A bigger width is used when needed to
Bram Moolenaar64486672010-05-16 15:46:46 +02005514 fit the highest line number in the buffer respectively the number of
5515 rows in the window, depending on whether 'number' or 'relativenumber'
5516 is set. Thus with the Vim default of 4 there is room for a line number
5517 up to 999. When the buffer has 1000 lines five columns will be used.
Bram Moolenaarf8a07122019-07-01 22:06:07 +02005518 The minimum value is 1, the maximum value is 20.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005519 NOTE: This option is set to the Vi default value when 'compatible' is
5520 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005521
Bram Moolenaarf75a9632005-09-13 21:20:47 +00005522 *'omnifunc'* *'ofu'*
5523'omnifunc' 'ofu' string (default: empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00005524 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02005525 {not available when compiled without the |+eval|
Bram Moolenaare2c453d2019-08-21 14:37:09 +02005526 feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00005527 This option specifies a function to be used for Insert mode omni
5528 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
Bram Moolenaar280f1262006-01-30 00:14:18 +00005529 See |complete-functions| for an explanation of how the function is
5530 invoked and what it should return.
Bram Moolenaar043545e2006-10-10 16:44:07 +00005531 This option is usually set by a filetype plugin:
Bram Moolenaar9c102382006-05-03 21:26:49 +00005532 |:filetype-plugin-on|
Bram Moolenaar30b65812012-07-12 22:01:11 +02005533 This option cannot be set from a |modeline| or in the |sandbox|, for
5534 security reasons.
Bram Moolenaare344bea2005-09-01 20:46:49 +00005535
5536
Bram Moolenaar02467872007-05-06 13:22:01 +00005537 *'opendevice'* *'odev'* *'noopendevice'* *'noodev'*
Bram Moolenaar043545e2006-10-10 16:44:07 +00005538'opendevice' 'odev' boolean (default off)
5539 global
Bram Moolenaar6f345a12019-12-17 21:27:18 +01005540 {only for MS-Windows}
Bram Moolenaar043545e2006-10-10 16:44:07 +00005541 Enable reading and writing from devices. This may get Vim stuck on a
5542 device that can be opened but doesn't actually do the I/O. Therefore
5543 it is off by default.
5544 Note that on MS-Windows editing "aux.h", "lpt1.txt" and the like also
5545 result in editing a device.
5546
5547
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005548 *'operatorfunc'* *'opfunc'*
5549'operatorfunc' 'opfunc' string (default: empty)
5550 global
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005551 This option specifies a function to be called by the |g@| operator.
5552 See |:map-operator| for more info and an example.
5553
5554 This option cannot be set from a |modeline| or in the |sandbox|, for
5555 security reasons.
5556
5557
Bram Moolenaar251e1912011-06-19 05:09:16 +02005558 *'osfiletype'* *'oft'*
5559'osfiletype' 'oft' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005560 local to buffer
Bram Moolenaar251e1912011-06-19 05:09:16 +02005561 This option was supported on RISC OS, which has been removed.
5562
Bram Moolenaar071d4272004-06-13 20:20:40 +00005563
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005564 *'packpath'* *'pp'*
5565'packpath' 'pp' string (default: see 'runtimepath')
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005566 Directories used to find packages. See |packages|.
5567
5568
Bram Moolenaar071d4272004-06-13 20:20:40 +00005569 *'paragraphs'* *'para'*
Bram Moolenaar57e48462008-03-12 16:38:55 +00005570'paragraphs' 'para' string (default "IPLPPPQPP TPHPLIPpLpItpplpipbp")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005571 global
5572 Specifies the nroff macros that separate paragraphs. These are pairs
5573 of two letters (see |object-motions|).
5574
5575 *'paste'* *'nopaste'*
5576'paste' boolean (default off)
5577 global
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005578 Put Vim in Paste mode. This is useful if you want to cut or copy
5579 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005580 unexpected effects.
5581 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005582 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00005583 knows about pasting and will mostly do the right thing without 'paste'
5584 being set. The same is true for a terminal where Vim handles the
5585 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00005586 This option is reset when starting the GUI. Thus if you set it in
5587 your .vimrc it will work in a terminal, but not in the GUI. Setting
5588 'paste' in the GUI has side effects: e.g., the Paste toolbar button
5589 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005590 When the 'paste' option is switched on (also when it was already on):
5591 - mapping in Insert mode and Command-line mode is disabled
5592 - abbreviations are disabled
Bram Moolenaar071d4272004-06-13 20:20:40 +00005593 - 'autoindent' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02005594 - 'expandtab' is reset
5595 - 'formatoptions' is used like it is empty
Bram Moolenaar071d4272004-06-13 20:20:40 +00005596 - 'revins' is reset
5597 - 'ruler' is reset
5598 - 'showmatch' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02005599 - 'smartindent' is reset
5600 - 'smarttab' is reset
5601 - 'softtabstop' is set to 0
5602 - 'textwidth' is set to 0
5603 - 'wrapmargin' is set to 0
Bram Moolenaar071d4272004-06-13 20:20:40 +00005604 These options keep their value, but their effect is disabled:
Bram Moolenaar071d4272004-06-13 20:20:40 +00005605 - 'cindent'
Bram Moolenaarca635012015-09-25 20:34:21 +02005606 - 'indentexpr'
5607 - 'lisp'
Bram Moolenaar071d4272004-06-13 20:20:40 +00005608 NOTE: When you start editing another file while the 'paste' option is
5609 on, settings from the modelines or autocommands may change the
5610 settings again, causing trouble when pasting text. You might want to
5611 set the 'paste' option again.
5612 When the 'paste' option is reset the mentioned options are restored to
5613 the value before the moment 'paste' was switched from off to on.
5614 Resetting 'paste' before ever setting it does not have any effect.
5615 Since mapping doesn't work while 'paste' is active, you need to use
5616 the 'pastetoggle' option to toggle the 'paste' option with some key.
5617
5618 *'pastetoggle'* *'pt'*
5619'pastetoggle' 'pt' string (default "")
5620 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005621 When non-empty, specifies the key sequence that toggles the 'paste'
5622 option. This is like specifying a mapping: >
5623 :map {keys} :set invpaste<CR>
5624< Where {keys} is the value of 'pastetoggle'.
5625 The difference is that it will work even when 'paste' is set.
5626 'pastetoggle' works in Insert mode and Normal mode, but not in
5627 Command-line mode.
5628 Mappings are checked first, thus overrule 'pastetoggle'. However,
5629 when 'paste' is on mappings are ignored in Insert mode, thus you can do
5630 this: >
5631 :map <F10> :set paste<CR>
5632 :map <F11> :set nopaste<CR>
5633 :imap <F10> <C-O>:set paste<CR>
5634 :imap <F11> <nop>
5635 :set pastetoggle=<F11>
5636< This will make <F10> start paste mode and <F11> stop paste mode.
5637 Note that typing <F10> in paste mode inserts "<F10>", since in paste
5638 mode everything is inserted literally, except the 'pastetoggle' key
5639 sequence.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005640 When the value has several bytes 'ttimeoutlen' applies.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005641
5642 *'pex'* *'patchexpr'*
5643'patchexpr' 'pex' string (default "")
5644 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005645 {not available when compiled without the |+diff|
5646 feature}
5647 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005648 the resulting new version of the file. See |diff-patchexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005649
Bram Moolenaardbc28022014-07-26 13:40:44 +02005650 *'patchmode'* *'pm'* *E205* *E206*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005651'patchmode' 'pm' string (default "")
5652 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005653 When non-empty the oldest version of a file is kept. This can be used
5654 to keep the original version of a file if you are changing files in a
5655 source distribution. Only the first time that a file is written a
5656 copy of the original file will be kept. The name of the copy is the
5657 name of the original file with the string in the 'patchmode' option
5658 appended. This option should start with a dot. Use a string like
Bram Moolenaardf980db2017-12-24 13:22:00 +01005659 ".orig" or ".org". 'backupdir' must not be empty for this to work
5660 (Detail: The backup file is renamed to the patchmode file after the
5661 new file has been successfully written, that's why it must be possible
5662 to write a backup file). If there was no file to be backed up, an
5663 empty file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005664 When the 'backupskip' pattern matches, a patchmode file is not made.
5665 Using 'patchmode' for compressed files appends the extension at the
5666 end (e.g., "file.gz.orig"), thus the resulting name isn't always
5667 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005668 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005669
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01005670 *'path'* *'pa'* *E343* *E345* *E347* *E854*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005671'path' 'pa' string (default on Unix: ".,/usr/include,,"
Bram Moolenaar071d4272004-06-13 20:20:40 +00005672 other systems: ".,,")
5673 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005674 This is a list of directories which will be searched when using the
Bram Moolenaarc236c162008-07-13 17:41:49 +00005675 |gf|, [f, ]f, ^Wf, |:find|, |:sfind|, |:tabfind| and other commands,
5676 provided that the file being searched for has a relative path (not
5677 starting with "/", "./" or "../"). The directories in the 'path'
5678 option may be relative or absolute.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005679 - Use commas to separate directory names: >
5680 :set path=.,/usr/local/include,/usr/include
5681< - Spaces can also be used to separate directory names (for backwards
5682 compatibility with version 3.0). To have a space in a directory
5683 name, precede it with an extra backslash, and escape the space: >
5684 :set path=.,/dir/with\\\ space
5685< - To include a comma in a directory name precede it with an extra
5686 backslash: >
5687 :set path=.,/dir/with\\,comma
5688< - To search relative to the directory of the current file, use: >
5689 :set path=.
5690< - To search in the current directory use an empty string between two
5691 commas: >
5692 :set path=,,
5693< - A directory name may end in a ':' or '/'.
5694 - Environment variables are expanded |:set_env|.
5695 - When using |netrw.vim| URLs can be used. For example, adding
5696 "http://www.vim.org" will make ":find index.html" work.
Bram Moolenaarc236c162008-07-13 17:41:49 +00005697 - Search upwards and downwards in a directory tree using "*", "**" and
5698 ";". See |file-searching| for info and syntax.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005699 {not available when compiled without the |+path_extra| feature}
5700 - Careful with '\' characters, type two to get one in the option: >
5701 :set path=.,c:\\include
5702< Or just use '/' instead: >
5703 :set path=.,c:/include
5704< Don't forget "." or files won't even be found in the same directory as
5705 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005706 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00005707 it is something like 256 or 1024 characters.
5708 You can check if all the include files are found, using the value of
5709 'path', see |:checkpath|.
5710 The use of |:set+=| and |:set-=| is preferred when adding or removing
5711 directories from the list. This avoids problems when a future version
5712 uses another default. To remove the current directory use: >
5713 :set path-=
5714< To add the current directory use: >
5715 :set path+=
5716< To use an environment variable, you probably need to replace the
5717 separator. Here is an example to append $INCL, in which directory
5718 names are separated with a semi-colon: >
5719 :let &path = &path . "," . substitute($INCL, ';', ',', 'g')
5720< Replace the ';' with a ':' or whatever separator is used. Note that
5721 this doesn't work when $INCL contains a comma or white space.
5722
Bram Moolenaar37c64c72017-09-19 22:06:03 +02005723 *'perldll'*
5724'perldll' string (default depends on the build)
5725 global
Bram Moolenaar37c64c72017-09-19 22:06:03 +02005726 {only available when compiled with the |+perl/dyn|
5727 feature}
5728 Specifies the name of the Perl shared library. The default is
5729 DYNAMIC_PERL_DLL, which was specified at compile time.
5730 Environment variables are expanded |:set_env|.
5731 This option cannot be set from a |modeline| or in the |sandbox|, for
5732 security reasons.
5733
Bram Moolenaar071d4272004-06-13 20:20:40 +00005734 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
5735'preserveindent' 'pi' boolean (default off)
5736 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005737 When changing the indent of the current line, preserve as much of the
5738 indent structure as possible. Normally the indent is replaced by a
5739 series of tabs followed by spaces as required (unless |'expandtab'| is
5740 enabled, in which case only spaces are used). Enabling this option
5741 means the indent will preserve as many existing characters as possible
5742 for indenting, and only add additional tabs or spaces as required.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005743 'expandtab' does not apply to the preserved white space, a Tab remains
5744 a Tab.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005745 NOTE: When using ">>" multiple times the resulting indent is a mix of
5746 tabs and spaces. You might not like this.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005747 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005748 Also see 'copyindent'.
5749 Use |:retab| to clean up white space.
5750
5751 *'previewheight'* *'pvh'*
5752'previewheight' 'pvh' number (default 12)
5753 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02005754 {not available when compiled without the |+quickfix|
5755 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005756 Default height for a preview window. Used for |:ptag| and associated
Bram Moolenaar79648732019-07-18 21:43:07 +02005757 commands. Used for |CTRL-W_}| when no count is given. Not used when
5758 'previewpopup' is set.
5759
5760 *'previewpopup'* *'pvp'*
5761'previewpopup' 'pvp' string (default empty)
5762 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02005763 {not available when compiled without the |+textprop|
5764 or |+quickfix| feature}
Bram Moolenaar79648732019-07-18 21:43:07 +02005765 When not empty a popup window is used for commands that would open a
5766 preview window. See |preview-popup|.
Bram Moolenaar576a4a62019-08-18 15:25:17 +02005767 Not used for the insert completion info, add "popup" to
5768 'completeopt' for that.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005769
5770 *'previewwindow'* *'nopreviewwindow'*
5771 *'pvw'* *'nopvw'* *E590*
5772'previewwindow' 'pvw' boolean (default off)
5773 local to window
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02005774 {not available when compiled without the |+quickfix|
5775 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005776 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00005777 set. It's normally not set directly, but by using one of the commands
5778 |:ptag|, |:pedit|, etc.
5779
5780 *'printdevice'* *'pdev'*
5781'printdevice' 'pdev' string (default empty)
5782 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005783 {only available when compiled with the |+printer|
5784 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005785 The name of the printer to be used for |:hardcopy|.
5786 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005787 This option cannot be set from a |modeline| or in the |sandbox|, for
5788 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005789
Bram Moolenaar8299df92004-07-10 09:47:34 +00005790 *'printencoding'* *'penc'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005791'printencoding' 'penc' string (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005792 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005793 {only available when compiled with the |+printer|
5794 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005795 Sets the character encoding used when printing.
5796 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005797
5798 *'printexpr'* *'pexpr'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005799'printexpr' 'pexpr' string (default: see below)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005800 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005801 {only available when compiled with the |+printer|
5802 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005803 Expression used to print the PostScript produced with |:hardcopy|.
5804 See |pexpr-option|.
Bram Moolenaar51628222016-12-01 23:03:28 +01005805 This option cannot be set from a |modeline| or in the |sandbox|, for
5806 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005807
Bram Moolenaar8299df92004-07-10 09:47:34 +00005808 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005809'printfont' 'pfn' string (default "courier")
5810 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005811 {only available when compiled with the |+printer|
5812 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005813 The name of the font that will be used for |:hardcopy|.
5814 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005815
5816 *'printheader'* *'pheader'*
5817'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
5818 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005819 {only available when compiled with the |+printer|
5820 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005821 The format of the header produced in |:hardcopy| output.
5822 See |pheader-option|.
5823
5824 *'printmbcharset'* *'pmbcs'*
5825'printmbcharset' 'pmbcs' string (default "")
5826 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01005827 {only available when compiled with the |+printer|
5828 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005829 The CJK character set to be used for CJK output from |:hardcopy|.
5830 See |pmbcs-option|.
5831
5832 *'printmbfont'* *'pmbfn'*
5833'printmbfont' 'pmbfn' string (default "")
5834 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01005835 {only available when compiled with the |+printer|
5836 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005837 List of font names to be used for CJK output from |:hardcopy|.
5838 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005839
5840 *'printoptions'* *'popt'*
5841'printoptions' 'popt' string (default "")
5842 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005843 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005844 List of items that control the format of the output of |:hardcopy|.
5845 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005846
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005847 *'prompt'* *'noprompt'*
5848'prompt' boolean (default on)
5849 global
5850 When on a ":" prompt is used in Ex mode.
5851
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005852 *'pumheight'* *'ph'*
5853'pumheight' 'ph' number (default 0)
5854 global
Bram Moolenaar06a89a52006-04-29 22:01:03 +00005855 Determines the maximum number of items to show in the popup menu for
5856 Insert mode completion. When zero as much space as available is used.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005857 |ins-completion-menu|.
5858
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01005859 *'pumwidth'* *'pw'*
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005860'pumwidth' 'pw' number (default 15)
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01005861 global
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01005862 Determines the minimum width to use for the popup menu for Insert mode
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005863 completion. |ins-completion-menu|.
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01005864
Bram Moolenaard94464e2015-11-02 15:28:18 +01005865 *'pythondll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01005866'pythondll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01005867 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01005868 {only available when compiled with the |+python/dyn|
5869 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005870 Specifies the name of the Python 2.x shared library. The default is
5871 DYNAMIC_PYTHON_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005872 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01005873 This option cannot be set from a |modeline| or in the |sandbox|, for
5874 security reasons.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005875
Bram Moolenaar94073162018-01-31 21:49:05 +01005876 *'pythonhome'*
5877'pythonhome' string (default "")
5878 global
Bram Moolenaar94073162018-01-31 21:49:05 +01005879 {only available when compiled with the |+python/dyn|
5880 feature}
5881 Specifies the name of the Python 2.x home directory. When 'pythonhome'
5882 and the PYTHONHOME environment variable are not set, PYTHON_HOME,
5883 which was specified at compile time, will be used for the Python 2.x
5884 home directory.
5885 Environment variables are expanded |:set_env|.
5886 This option cannot be set from a |modeline| or in the |sandbox|, for
5887 security reasons.
5888
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005889 *'pythonthreedll'*
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005890'pythonthreedll' string (default depends on the build)
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005891 global
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005892 {only available when compiled with the |+python3/dyn|
5893 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005894 Specifies the name of the Python 3 shared library. The default is
5895 DYNAMIC_PYTHON3_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005896 Environment variables are expanded |:set_env|.
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005897 This option cannot be set from a |modeline| or in the |sandbox|, for
5898 security reasons.
5899
Bram Moolenaar94073162018-01-31 21:49:05 +01005900 *'pythonthreehome'*
5901'pythonthreehome' string (default "")
5902 global
Bram Moolenaar94073162018-01-31 21:49:05 +01005903 {only available when compiled with the |+python3/dyn|
5904 feature}
5905 Specifies the name of the Python 3 home directory. When
5906 'pythonthreehome' and the PYTHONHOME environment variable are not set,
5907 PYTHON3_HOME, which was specified at compile time, will be used for
5908 the Python 3 home directory.
5909 Environment variables are expanded |:set_env|.
5910 This option cannot be set from a |modeline| or in the |sandbox|, for
5911 security reasons.
5912
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01005913 *'pyxversion'* *'pyx'*
5914'pyxversion' 'pyx' number (default depends on the build)
5915 global
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01005916 {only available when compiled with the |+python| or
5917 the |+python3| feature}
5918 Specifies the python version used for pyx* functions and commands
5919 |python_x|. The default value is as follows:
5920
5921 Compiled with Default ~
5922 |+python| and |+python3| 0
5923 only |+python| 2
5924 only |+python3| 3
5925
5926 Available values are 0, 2 and 3.
5927 If 'pyxversion' is 0, it is set to 2 or 3 after the first execution of
5928 any python2/3 commands or functions. E.g. `:py` sets to 2, and `:py3`
5929 sets to 3. `:pyx` sets it to 3 if Python 3 is available, otherwise sets
5930 to 2 if Python 2 is available.
5931 See also: |has-pythonx|
5932
5933 If Vim is compiled with only |+python| or |+python3| setting
5934 'pyxversion' has no effect. The pyx* functions and commands are
5935 always the same as the compiled version.
5936
5937 This option cannot be set from a |modeline| or in the |sandbox|, for
5938 security reasons.
5939
Bram Moolenaar858ba062020-05-31 23:11:59 +02005940 *'quickfixtextfunc'* *'qftf'*
5941'quickfixtextfunc' 'qftf' string (default "")
5942 global
5943 {only available when compiled with the |+quickfix|
5944 feature}
5945 This option specifies a function to be used to get the text to display
5946 in the quickfix and location list windows. This can be used to
5947 customize the information displayed in the quickfix or location window
5948 for each entry in the corresponding quickfix or location list. See
5949 |quickfix-window-function| for an explanation of how to write the
Bram Moolenaard43906d2020-07-20 21:31:32 +02005950 function and an example. The value can be the name of a function or a
5951 lambda.
Bram Moolenaar858ba062020-05-31 23:11:59 +02005952
5953 This option cannot be set from a |modeline| or in the |sandbox|, for
5954 security reasons.
5955
Bram Moolenaar677ee682005-01-27 14:41:15 +00005956 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005957'quoteescape' 'qe' string (default "\")
5958 local to buffer
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005959 The characters that are used to escape quotes in a string. Used for
5960 objects like a', a" and a` |a'|.
5961 When one of the characters in this option is found inside a string,
5962 the following character will be skipped. The default value makes the
5963 text "foo\"bar\\" considered to be one string.
5964
Bram Moolenaar071d4272004-06-13 20:20:40 +00005965 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
5966'readonly' 'ro' boolean (default off)
5967 local to buffer
5968 If on, writes fail unless you use a '!'. Protects you from
5969 accidentally overwriting a file. Default on when Vim is started
5970 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005971 When using ":w!" the 'readonly' option is reset for the current
5972 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar6c60f472019-04-28 16:00:35 +02005973 When using the ":view" command the 'readonly' option is set for the
5974 newly edited buffer.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01005975 See 'modifiable' for disallowing changes to the buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005976
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005977 *'redrawtime'* *'rdt'*
5978'redrawtime' 'rdt' number (default 2000)
5979 global
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005980 {only available when compiled with the |+reltime|
5981 feature}
5982 The time in milliseconds for redrawing the display. This applies to
Bram Moolenaar15142e22018-04-30 22:19:58 +02005983 searching for patterns for 'hlsearch', |:match| highlighting and syntax
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02005984 highlighting.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005985 When redrawing takes more than this many milliseconds no further
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02005986 matches will be highlighted.
5987 For syntax highlighting the time applies per window. When over the
5988 limit syntax highlighting is disabled until |CTRL-L| is used.
5989 This is used to avoid that Vim hangs when using a very complicated
5990 pattern.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005991
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02005992 *'regexpengine'* *'re'*
Bram Moolenaare6ae6222013-05-21 21:01:10 +02005993'regexpengine' 're' number (default 0)
5994 global
Bram Moolenaare6ae6222013-05-21 21:01:10 +02005995 This selects the default regexp engine. |two-engines|
5996 The possible values are:
5997 0 automatic selection
5998 1 old engine
5999 2 NFA engine
6000 Note that when using the NFA engine and the pattern contains something
6001 that is not supported the pattern will not match. This is only useful
6002 for debugging the regexp engine.
Bram Moolenaarfda37292014-11-05 14:27:36 +01006003 Using automatic selection enables Vim to switch the engine, if the
6004 default engine becomes too costly. E.g., when the NFA engine uses too
6005 many states. This should prevent Vim from hanging on a combination of
6006 a complex pattern with long text.
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006007
Bram Moolenaar64486672010-05-16 15:46:46 +02006008 *'relativenumber'* *'rnu'* *'norelativenumber'* *'nornu'*
6009'relativenumber' 'rnu' boolean (default off)
6010 local to window
Bram Moolenaar64486672010-05-16 15:46:46 +02006011 Show the line number relative to the line with the cursor in front of
Bram Moolenaar06b5d512010-05-22 15:37:44 +02006012 each line. Relative line numbers help you use the |count| you can
Bram Moolenaar64486672010-05-16 15:46:46 +02006013 precede some vertical motion commands (e.g. j k + -) with, without
6014 having to calculate it yourself. Especially useful in combination with
6015 other commands (e.g. y d c < > gq gw =).
6016 When the 'n' option is excluded from 'cpoptions' a wrapped
6017 line will not use the column of line numbers (this is the default when
6018 'compatible' isn't set).
6019 The 'numberwidth' option can be used to set the room used for the line
6020 number.
6021 When a long, wrapped line doesn't start with the first character, '-'
6022 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02006023 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
6024 the number.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01006025
Bram Moolenaar203d04d2013-06-06 21:36:40 +02006026 The number in front of the cursor line also depends on the value of
6027 'number', see |number_relativenumber| for all combinations of the two
6028 options.
Bram Moolenaar64486672010-05-16 15:46:46 +02006029
Bram Moolenaar071d4272004-06-13 20:20:40 +00006030 *'remap'* *'noremap'*
6031'remap' boolean (default on)
6032 global
6033 Allows for mappings to work recursively. If you do not want this for
6034 a single entry, use the :noremap[!] command.
Bram Moolenaara3227e22006-03-08 21:32:40 +00006035 NOTE: To avoid portability problems with Vim scripts, always keep
6036 this option at the default "on". Only switch it off when working with
6037 old Vi scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006038
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006039 *'renderoptions'* *'rop'*
6040'renderoptions' 'rop' string (default: empty)
6041 global
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006042 {only available when compiled with GUI and DIRECTX on
6043 MS-Windows}
6044 Select a text renderer and set its options. The options depend on the
6045 renderer.
6046
6047 Syntax: >
6048 set rop=type:{renderer}(,{name}:{value})*
6049<
6050 Currently, only one optional renderer is available.
6051
6052 render behavior ~
6053 directx Vim will draw text using DirectX (DirectWrite). It makes
6054 drawn glyphs more beautiful than default GDI.
6055 It requires 'encoding' is "utf-8", and only works on
6056 MS-Windows Vista or newer version.
6057
6058 Options:
6059 name meaning type value ~
6060 gamma gamma float 1.0 - 2.2 (maybe)
6061 contrast enhancedContrast float (unknown)
6062 level clearTypeLevel float (unknown)
6063 geom pixelGeometry int 0 - 2 (see below)
6064 renmode renderingMode int 0 - 6 (see below)
6065 taamode textAntialiasMode int 0 - 3 (see below)
Bram Moolenaara338adc2018-01-31 20:51:47 +01006066 scrlines Scroll Lines int (deprecated)
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006067
Bram Moolenaar92467d32017-12-05 13:22:16 +01006068 See this URL for detail (except for scrlines):
6069 https://msdn.microsoft.com/en-us/library/dd368190.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006070
6071 For geom: structure of a device pixel.
6072 0 - DWRITE_PIXEL_GEOMETRY_FLAT
6073 1 - DWRITE_PIXEL_GEOMETRY_RGB
6074 2 - DWRITE_PIXEL_GEOMETRY_BGR
6075
6076 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006077 https://msdn.microsoft.com/en-us/library/dd368114.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006078
6079 For renmode: method of rendering glyphs.
6080 0 - DWRITE_RENDERING_MODE_DEFAULT
6081 1 - DWRITE_RENDERING_MODE_ALIASED
6082 2 - DWRITE_RENDERING_MODE_GDI_CLASSIC
6083 3 - DWRITE_RENDERING_MODE_GDI_NATURAL
6084 4 - DWRITE_RENDERING_MODE_NATURAL
6085 5 - DWRITE_RENDERING_MODE_NATURAL_SYMMETRIC
6086 6 - DWRITE_RENDERING_MODE_OUTLINE
6087
6088 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006089 https://msdn.microsoft.com/en-us/library/dd368118.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006090
6091 For taamode: antialiasing mode used for drawing text.
6092 0 - D2D1_TEXT_ANTIALIAS_MODE_DEFAULT
6093 1 - D2D1_TEXT_ANTIALIAS_MODE_CLEARTYPE
6094 2 - D2D1_TEXT_ANTIALIAS_MODE_GRAYSCALE
6095 3 - D2D1_TEXT_ANTIALIAS_MODE_ALIASED
6096
6097 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006098 https://msdn.microsoft.com/en-us/library/dd368170.aspx
6099
Bram Moolenaara338adc2018-01-31 20:51:47 +01006100 For scrlines:
6101 This was used for optimizing scrolling behavior, however this
6102 is now deprecated. If specified, it is simply ignored.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006103
6104 Example: >
6105 set encoding=utf-8
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006106 set gfn=Ricty_Diminished:h12
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006107 set rop=type:directx
6108<
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006109 If select a raster font (Courier, Terminal or FixedSys which
6110 have ".fon" extension in file name) to 'guifont', it will be
Bram Moolenaar92467d32017-12-05 13:22:16 +01006111 drawn by GDI as a fallback.
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006112
6113 NOTE: It is known that some fonts and options combination
6114 causes trouble on drawing glyphs.
6115
Bram Moolenaar92467d32017-12-05 13:22:16 +01006116 - 'renmode:5' and 'renmode:6' will not work with some
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006117 special made fonts (True-Type fonts which includes only
6118 bitmap glyphs).
6119 - 'taamode:3' will not work with some vector fonts.
6120
6121 NOTE: With this option, you can display colored emoji
6122 (emoticon) in Windows 8.1 or later. To display colored emoji,
6123 there are some conditions which you should notice.
6124
6125 - If your font includes non-colored emoji already, it will
6126 be used.
6127 - If your font doesn't have emoji, the system chooses an
6128 alternative symbol font. On Windows 10, "Segoe UI Emoji"
6129 will be used.
6130 - When this alternative font didn't have fixed width glyph,
6131 emoji might be rendered beyond the bounding box of drawing
6132 cell.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006133
6134 Other render types are currently not supported.
6135
Bram Moolenaar071d4272004-06-13 20:20:40 +00006136 *'report'*
6137'report' number (default 2)
6138 global
6139 Threshold for reporting number of lines changed. When the number of
6140 changed lines is more than 'report' a message will be given for most
6141 ":" commands. If you want it always, set 'report' to 0.
6142 For the ":substitute" command the number of substitutions is used
6143 instead of the number of lines.
6144
6145 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
6146'restorescreen' 'rs' boolean (default on)
6147 global
Bram Moolenaar8024f932020-01-14 19:29:13 +01006148 {only in MS-Windows console version}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006149 When set, the screen contents is restored when exiting Vim. This also
6150 happens when executing external commands.
6151
6152 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
6153 options in your .vimrc. To disable restoring:
6154 set t_ti= t_te=
6155 To enable restoring (for an xterm):
6156 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
6157 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
6158
6159 *'revins'* *'ri'* *'norevins'* *'nori'*
6160'revins' 'ri' boolean (default off)
6161 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006162 {only available when compiled with the |+rightleft|
6163 feature}
6164 Inserting characters in Insert mode will work backwards. See "typing
6165 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
6166 command in Insert mode, when 'allowrevins' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02006167 NOTE: This option is reset when 'compatible' is set.
6168 This option is reset when 'paste' is set and restored when 'paste' is
6169 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006170
6171 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
6172'rightleft' 'rl' boolean (default off)
6173 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006174 {only available when compiled with the |+rightleft|
6175 feature}
6176 When on, display orientation becomes right-to-left, i.e., characters
6177 that are stored in the file appear from the right to the left.
6178 Using this option, it is possible to edit files for languages that
6179 are written from the right to the left such as Hebrew and Arabic.
6180 This option is per window, so it is possible to edit mixed files
6181 simultaneously, or to view the same file in both ways (this is
6182 useful whenever you have a mixed text file with both right-to-left
6183 and left-to-right strings so that both sets are displayed properly
6184 in different windows). Also see |rileft.txt|.
6185
Bram Moolenaar607cc1e2010-07-18 18:47:44 +02006186 *'rightleftcmd'* *'rlc'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006187'rightleftcmd' 'rlc' string (default "search")
6188 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006189 {only available when compiled with the |+rightleft|
6190 feature}
6191 Each word in this option enables the command line editing to work in
6192 right-to-left mode for a group of commands:
6193
6194 search "/" and "?" commands
6195
6196 This is useful for languages such as Hebrew, Arabic and Farsi.
6197 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
6198
Bram Moolenaard94464e2015-11-02 15:28:18 +01006199 *'rubydll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01006200'rubydll' string (default: depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01006201 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01006202 {only available when compiled with the |+ruby/dyn|
6203 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006204 Specifies the name of the Ruby shared library. The default is
6205 DYNAMIC_RUBY_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006206 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01006207 This option cannot be set from a |modeline| or in the |sandbox|, for
6208 security reasons.
6209
Bram Moolenaar071d4272004-06-13 20:20:40 +00006210 *'ruler'* *'ru'* *'noruler'* *'noru'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02006211'ruler' 'ru' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006212 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006213 {not available when compiled without the
6214 |+cmdline_info| feature}
6215 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006216 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00006217 text in the file is shown on the far right:
6218 Top first line is visible
6219 Bot last line is visible
6220 All first and last line are visible
6221 45% relative position in the file
6222 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006223 Each window has its own ruler. If a window has a status line, the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006224 ruler is shown there. Otherwise it is shown in the last line of the
Bram Moolenaar582fd852005-03-28 20:58:01 +00006225 screen. If the statusline is given by 'statusline' (i.e. not empty),
Bram Moolenaar071d4272004-06-13 20:20:40 +00006226 this option takes precedence over 'ruler' and 'rulerformat'
6227 If the number of characters displayed is different from the number of
Bram Moolenaar207f0092020-08-30 17:20:20 +02006228 bytes in the text (e.g., for a TAB or a multibyte character), both
Bram Moolenaar071d4272004-06-13 20:20:40 +00006229 the text column (byte number) and the screen column are shown,
6230 separated with a dash.
6231 For an empty line "0-1" is shown.
6232 For an empty buffer the line number will also be zero: "0,0-1".
Bram Moolenaarca635012015-09-25 20:34:21 +02006233 This option is reset when 'paste' is set and restored when 'paste' is
6234 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006235 If you don't want to see the ruler all the time but want to know where
6236 you are, use "g CTRL-G" |g_CTRL-G|.
6237 NOTE: This option is reset when 'compatible' is set.
6238
6239 *'rulerformat'* *'ruf'*
6240'rulerformat' 'ruf' string (default empty)
6241 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006242 {not available when compiled without the |+statusline|
6243 feature}
6244 When this option is not empty, it determines the content of the ruler
6245 string, as displayed for the 'ruler' option.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00006246 The format of this option is like that of 'statusline'.
Bram Moolenaar110289e2019-05-23 15:38:06 +02006247 This option cannot be set in a modeline when 'modelineexpr' is off.
6248
Bram Moolenaar071d4272004-06-13 20:20:40 +00006249 The default ruler width is 17 characters. To make the ruler 15
6250 characters wide, put "%15(" at the start and "%)" at the end.
6251 Example: >
6252 :set rulerformat=%15(%c%V\ %p%%%)
6253<
6254 *'runtimepath'* *'rtp'* *vimfiles*
6255'runtimepath' 'rtp' string (default:
Bram Moolenaar942db232021-02-13 18:14:48 +01006256 Unix: "$HOME/.vim,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006257 $VIM/vimfiles,
6258 $VIMRUNTIME,
6259 $VIM/vimfiles/after,
6260 $HOME/.vim/after"
6261 Amiga: "home:vimfiles,
6262 $VIM/vimfiles,
6263 $VIMRUNTIME,
6264 $VIM/vimfiles/after,
6265 home:vimfiles/after"
Bram Moolenaar942db232021-02-13 18:14:48 +01006266 MS-Windows: "$HOME/vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006267 $VIM/vimfiles,
6268 $VIMRUNTIME,
6269 $VIM/vimfiles/after,
6270 $HOME/vimfiles/after"
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02006271 macOS: "$VIM:vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006272 $VIMRUNTIME,
6273 $VIM:vimfiles:after"
Bram Moolenaarb3f74062020-02-26 16:16:53 +01006274 Haiku: "$BE_USER_SETTINGS/vim,
6275 $VIM/vimfiles,
6276 $VIMRUNTIME,
6277 $VIM/vimfiles/after,
Bram Moolenaar942db232021-02-13 18:14:48 +01006278 $BE_USER_SETTINGS/vim/after"
6279 VMS: "sys$login:vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006280 $VIM/vimfiles,
6281 $VIMRUNTIME,
6282 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00006283 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006284 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006285 This is a list of directories which will be searched for runtime
6286 files:
6287 filetype.vim filetypes by file name |new-filetype|
6288 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006289 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006290 colors/ color scheme files |:colorscheme|
6291 compiler/ compiler files |:compiler|
6292 doc/ documentation |write-local-help|
6293 ftplugin/ filetype plugins |write-filetype-plugin|
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01006294 import/ files that are found by `:import`
Bram Moolenaar071d4272004-06-13 20:20:40 +00006295 indent/ indent scripts |indent-expression|
6296 keymap/ key mapping files |mbyte-keymap|
6297 lang/ menu translations |:menutrans|
6298 menu.vim GUI menus |menu.vim|
Bram Moolenaar26852122016-05-24 20:02:38 +02006299 pack/ packages |:packadd|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006300 plugin/ plugin scripts |write-plugin|
6301 print/ files for printing |postscript-print-encoding|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006302 spell/ spell checking files |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006303 syntax/ syntax files |mysyntaxfile|
6304 tutor/ files for vimtutor |tutor|
6305
6306 And any other file searched for with the |:runtime| command.
6307
6308 The defaults for most systems are setup to search five locations:
6309 1. In your home directory, for your personal preferences.
6310 2. In a system-wide Vim directory, for preferences from the system
6311 administrator.
6312 3. In $VIMRUNTIME, for files distributed with Vim.
6313 *after-directory*
6314 4. In the "after" directory in the system-wide Vim directory. This is
6315 for the system administrator to overrule or add to the distributed
6316 defaults (rarely needed)
6317 5. In the "after" directory in your home directory. This is for
6318 personal preferences to overrule or add to the distributed defaults
6319 or system-wide settings (rarely needed).
6320
Bram Moolenaard0796902016-09-16 20:02:31 +02006321 More entries are added when using |packages|. If it gets very long
6322 then `:set rtp` will be truncated, use `:echo &rtp` to see the full
6323 string.
Bram Moolenaar26852122016-05-24 20:02:38 +02006324
Bram Moolenaar071d4272004-06-13 20:20:40 +00006325 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
6326 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006327 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00006328 wildcards.
6329 See |:runtime|.
6330 Example: >
6331 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
6332< This will use the directory "~/vimruntime" first (containing your
6333 personal Vim runtime files), then "/mygroup/vim" (shared between a
6334 group of people) and finally "$VIMRUNTIME" (the distributed runtime
6335 files).
6336 You probably should always include $VIMRUNTIME somewhere, to use the
6337 distributed runtime files. You can put a directory before $VIMRUNTIME
6338 to find files which replace a distributed runtime files. You can put
6339 a directory after $VIMRUNTIME to find files which add to distributed
6340 runtime files.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006341 When Vim is started with |--clean| the home directory entries are not
6342 included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006343 This option cannot be set from a |modeline| or in the |sandbox|, for
6344 security reasons.
6345
6346 *'scroll'* *'scr'*
6347'scroll' 'scr' number (default: half the window height)
6348 local to window
6349 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
6350 set to half the number of lines in the window when the window size
Bram Moolenaar74667062020-12-28 15:41:41 +01006351 changes. This may happen when enabling the |status-line| or
6352 'tabline' option after setting the 'scroll' option.
6353 If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006354 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar25c9c682019-05-05 18:13:34 +02006355 height with ":set scroll=0".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006356
6357 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
6358'scrollbind' 'scb' boolean (default off)
6359 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006360 See also |scroll-binding|. When this option is set, the current
6361 window scrolls as other scrollbind windows (windows that also have
6362 this option set) scroll. This option is useful for viewing the
6363 differences between two versions of a file, see 'diff'.
6364 See |'scrollopt'| for options that determine how this option should be
6365 interpreted.
6366 This option is mostly reset when splitting a window to edit another
6367 file. This means that ":split | edit file" results in two windows
6368 with scroll-binding, but ":split file" does not.
6369
Bram Moolenaarae20f342019-11-05 21:09:23 +01006370 *'scrollfocus'* *'scf'* *'noscrollfocus'* *'noscf'*
6371'scrollfocus' 'scf' boolean (default off)
6372 global
6373 {only for MS-Windows GUI}
6374 When using the scroll wheel and this option is set, the window under
6375 the mouse pointer is scrolled. With this option off the current
6376 window is scrolled.
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01006377 Systems other than MS-Windows always behave like this option is on.
Bram Moolenaarae20f342019-11-05 21:09:23 +01006378
Bram Moolenaar071d4272004-06-13 20:20:40 +00006379 *'scrolljump'* *'sj'*
6380'scrolljump' 'sj' number (default 1)
6381 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006382 Minimal number of lines to scroll when the cursor gets off the
6383 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
6384 CTRL-D). Useful if your terminal scrolls very slowly.
Bram Moolenaar1e015462005-09-25 22:16:38 +00006385 When set to a negative number from -1 to -100 this is used as the
6386 percentage of the window height. Thus -50 scrolls half the window
6387 height.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006388 NOTE: This option is set to 1 when 'compatible' is set.
6389
6390 *'scrolloff'* *'so'*
Bram Moolenaar50ba5262016-09-22 22:33:02 +02006391'scrolloff' 'so' number (default 0, set to 5 in |defaults.vim|)
Bram Moolenaar375e3392019-01-31 18:26:10 +01006392 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006393 Minimal number of screen lines to keep above and below the cursor.
6394 This will make some context visible around where you are working. If
6395 you set it to a very large value (999) the cursor line will always be
6396 in the middle of the window (except at the start or end of the file or
6397 when long lines wrap).
Bram Moolenaar375e3392019-01-31 18:26:10 +01006398 After using the local value, go back the global value with one of
6399 these two: >
6400 setlocal scrolloff<
6401 setlocal scrolloff=-1
6402< For scrolling horizontally see 'sidescrolloff'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006403 NOTE: This option is set to 0 when 'compatible' is set.
6404
6405 *'scrollopt'* *'sbo'*
6406'scrollopt' 'sbo' string (default "ver,jump")
6407 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006408 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006409 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
6410 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006411 The following words are available:
6412 ver Bind vertical scrolling for 'scrollbind' windows
6413 hor Bind horizontal scrolling for 'scrollbind' windows
6414 jump Applies to the offset between two windows for vertical
6415 scrolling. This offset is the difference in the first
6416 displayed line of the bound windows. When moving
6417 around in a window, another 'scrollbind' window may
6418 reach a position before the start or after the end of
6419 the buffer. The offset is not changed though, when
6420 moving back the 'scrollbind' window will try to scroll
6421 to the desired position when possible.
6422 When now making that window the current one, two
6423 things can be done with the relative offset:
6424 1. When "jump" is not included, the relative offset is
6425 adjusted for the scroll position in the new current
6426 window. When going back to the other window, the
Bram Moolenaar02467872007-05-06 13:22:01 +00006427 new relative offset will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006428 2. When "jump" is included, the other windows are
6429 scrolled to keep the same relative offset. When
6430 going back to the other window, it still uses the
6431 same relative offset.
6432 Also see |scroll-binding|.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006433 When 'diff' mode is active there always is vertical scroll binding,
6434 even when "ver" isn't there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006435
6436 *'sections'* *'sect'*
6437'sections' 'sect' string (default "SHNHH HUnhsh")
6438 global
6439 Specifies the nroff macros that separate sections. These are pairs of
6440 two letters (See |object-motions|). The default makes a section start
6441 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
6442
6443 *'secure'* *'nosecure'* *E523*
6444'secure' boolean (default off)
6445 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006446 When on, ":autocmd", shell and write commands are not allowed in
6447 ".vimrc" and ".exrc" in the current directory and map commands are
6448 displayed. Switch it off only if you know that you will not run into
6449 problems, or when the 'exrc' option is off. On Unix this option is
6450 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006451 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00006452 'secure' at the end of your ~/.vimrc then.
6453 This option cannot be set from a |modeline| or in the |sandbox|, for
6454 security reasons.
6455
6456 *'selection'* *'sel'*
6457'selection' 'sel' string (default "inclusive")
6458 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006459 This option defines the behavior of the selection. It is only used
6460 in Visual and Select mode.
6461 Possible values:
6462 value past line inclusive ~
6463 old no yes
6464 inclusive yes yes
6465 exclusive yes no
6466 "past line" means that the cursor is allowed to be positioned one
6467 character past the line.
6468 "inclusive" means that the last character of the selection is included
6469 in an operation. For example, when "x" is used to delete the
6470 selection.
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02006471 When "old" is used and 'virtualedit' allows the cursor to move past
6472 the end of line the line break still isn't included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006473 Note that when "exclusive" is used and selecting from the end
6474 backwards, you cannot include the last character of a line, when
6475 starting in Normal mode and 'virtualedit' empty.
6476
6477 The 'selection' option is set by the |:behave| command.
6478
6479 *'selectmode'* *'slm'*
6480'selectmode' 'slm' string (default "")
6481 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006482 This is a comma separated list of words, which specifies when to start
6483 Select mode instead of Visual mode, when a selection is started.
6484 Possible values:
6485 mouse when using the mouse
6486 key when using shifted special keys
6487 cmd when using "v", "V" or CTRL-V
6488 See |Select-mode|.
6489 The 'selectmode' option is set by the |:behave| command.
6490
6491 *'sessionoptions'* *'ssop'*
6492'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006493 help,options,tabpages,winsize,terminal")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006494 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02006495 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006496 feature}
6497 Changes the effect of the |:mksession| command. It is a comma
6498 separated list of words. Each word enables saving and restoring
6499 something:
6500 word save and restore ~
6501 blank empty windows
6502 buffers hidden and unloaded buffers, not just those in windows
6503 curdir the current directory
6504 folds manually created folds, opened/closed folds and local
6505 fold options
6506 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00006507 and contain at least one lowercase letter. Only
6508 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006509 help the help window
6510 localoptions options and mappings local to a window or buffer (not
6511 global values for local options)
6512 options all options and mappings (also global values for local
6513 options)
Bram Moolenaar635bd602021-04-16 19:58:22 +02006514 skiprtp exclude 'runtimepath' from the options
Bram Moolenaar071d4272004-06-13 20:20:40 +00006515 resize size of the Vim window: 'lines' and 'columns'
6516 sesdir the directory in which the session file is located
6517 will become the current directory (useful with
6518 projects accessed over a network from different
6519 systems)
6520 slash backslashes in file names replaced with forward
6521 slashes
Bram Moolenaar18144c82006-04-12 21:52:12 +00006522 tabpages all tab pages; without this only the current tab page
6523 is restored, so that you can make a session for each
6524 tab page separately
Bram Moolenaard473c8c2018-08-11 18:00:22 +02006525 terminal include terminal windows where the command can be
6526 restored
Bram Moolenaar071d4272004-06-13 20:20:40 +00006527 unix with Unix end-of-line format (single <NL>), even when
6528 on Windows or DOS
6529 winpos position of the whole Vim window
6530 winsize window sizes
6531
6532 Don't include both "curdir" and "sesdir".
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006533 When neither "curdir" nor "sesdir" is included, file names are stored
6534 with absolute paths.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006535 "slash" and "unix" are useful on Windows when sharing session files
6536 with Unix. The Unix version of Vim cannot source dos format scripts,
6537 but the Windows version of Vim can source unix format scripts.
6538
6539 *'shell'* *'sh'* *E91*
Bram Moolenaar95a9dd12019-12-19 22:12:03 +01006540'shell' 'sh' string (default $SHELL or "sh", Win32: "cmd.exe")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006541 global
6542 Name of the shell to use for ! and :! commands. When changing the
6543 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
6544 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006545 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006546 See |option-backslash| about including spaces and backslashes.
6547 Environment variables are expanded |:set_env|.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006548
Bram Moolenaar1ff14ba2019-11-02 14:09:23 +01006549 If the name of the shell contains a space, you need to enclose it in
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01006550 quotes and escape the space. Example with quotes: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006551 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
6552< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006553 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006554 "-f" is not inside the quotes, because it is not part of the command
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006555 name. Vim automagically recognizes the backslashes that are path
Bram Moolenaar071d4272004-06-13 20:20:40 +00006556 separators.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006557 Example with escaped space (Vim will do this when initializing the
6558 option from $SHELL): >
6559 :set shell=/bin/with\\\ space/sh
Bram Moolenaard473c8c2018-08-11 18:00:22 +02006560< The resulting value of 'shell' is "/bin/with\ space/sh", two
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006561 backslashes are consumed by `:set`.
6562
Bram Moolenaar071d4272004-06-13 20:20:40 +00006563 Under MS-Windows, when the executable ends in ".com" it must be
6564 included. Thus setting the shell to "command.com" or "4dos.com"
6565 works, but "command" and "4dos" do not work for all commands (e.g.,
6566 filtering).
6567 For unknown reasons, when using "4dos.com" the current directory is
6568 changed to "C:\". To avoid this set 'shell' like this: >
6569 :set shell=command.com\ /c\ 4dos
6570< This option cannot be set from a |modeline| or in the |sandbox|, for
6571 security reasons.
6572
6573 *'shellcmdflag'* *'shcf'*
Bram Moolenaar5dc62522012-02-13 00:05:22 +01006574'shellcmdflag' 'shcf' string (default: "-c";
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006575 Win32, when 'shell' does not contain "sh"
6576 somewhere: "/c")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006577 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006578 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
Bram Moolenaar8024f932020-01-14 19:29:13 +01006579 "bash.exe -c ls" or "cmd.exe /c dir". For MS-Windows, the default is
6580 set according to the value of 'shell', to reduce the need to set this
6581 option by the user.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02006582 On Unix it can have more than one flag. Each white space separated
6583 part is passed as an argument to the shell command.
6584 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006585 Also see |dos-shell| for MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006586 This option cannot be set from a |modeline| or in the |sandbox|, for
6587 security reasons.
6588
6589 *'shellpipe'* *'sp'*
Bram Moolenaar8024f932020-01-14 19:29:13 +01006590'shellpipe' 'sp' string (default ">", ">%s 2>&1", "| tee", "|& tee" or
6591 "2>&1| tee")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006592 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006593 {not available when compiled without the |+quickfix|
6594 feature}
6595 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006596 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00006597 including spaces and backslashes.
6598 The name of the temporary file can be represented by "%s" if necessary
6599 (the file name is appended automatically if no %s appears in the value
6600 of this option).
Bram Moolenaar8024f932020-01-14 19:29:13 +01006601 For the Amiga the default is ">". For MS-Windows the default is
6602 ">%s 2>&1". The output is directly saved in a file and not echoed to
6603 the screen.
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02006604 For Unix the default is "| tee". The stdout of the compiler is saved
Bram Moolenaar071d4272004-06-13 20:20:40 +00006605 in a file and echoed to the screen. If the 'shell' option is "csh" or
6606 "tcsh" after initializations, the default becomes "|& tee". If the
Bram Moolenaar96f45c02019-10-26 19:53:45 +02006607 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh", "zsh-beta",
6608 "bash" or "fish" the default becomes "2>&1| tee". This means that
6609 stderr is also included. Before using the 'shell' option a path is
6610 removed, thus "/bin/sh" uses "sh".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006611 The initialization of this option is done after reading the ".vimrc"
6612 and the other initializations, so that when the 'shell' option is set
6613 there, the 'shellpipe' option changes automatically, unless it was
6614 explicitly set before.
6615 When 'shellpipe' is set to an empty string, no redirection of the
6616 ":make" output will be done. This is useful if you use a 'makeprg'
6617 that writes to 'makeef' by itself. If you want no piping, but do
6618 want to include the 'makeef', set 'shellpipe' to a single space.
6619 Don't forget to precede the space with a backslash: ":set sp=\ ".
6620 In the future pipes may be used for filtering and this option will
6621 become obsolete (at least for Unix).
6622 This option cannot be set from a |modeline| or in the |sandbox|, for
6623 security reasons.
6624
6625 *'shellquote'* *'shq'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006626'shellquote' 'shq' string (default: ""; Win32, when 'shell'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006627 contains "sh" somewhere: "\"")
6628 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006629 Quoting character(s), put around the command passed to the shell, for
6630 the "!" and ":!" commands. The redirection is kept outside of the
6631 quoting. See 'shellxquote' to include the redirection. It's
6632 probably not useful to set both options.
6633 This is an empty string by default. Only known to be useful for
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006634 third-party shells on MS-Windows-like systems, such as the MKS Korn
6635 Shell or bash, where it should be "\"". The default is adjusted
6636 according the value of 'shell', to reduce the need to set this option
6637 by the user. See |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006638 This option cannot be set from a |modeline| or in the |sandbox|, for
6639 security reasons.
6640
6641 *'shellredir'* *'srr'*
6642'shellredir' 'srr' string (default ">", ">&" or ">%s 2>&1")
6643 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006644 String to be used to put the output of a filter command in a temporary
6645 file. See also |:!|. See |option-backslash| about including spaces
6646 and backslashes.
6647 The name of the temporary file can be represented by "%s" if necessary
6648 (the file name is appended automatically if no %s appears in the value
6649 of this option).
Bram Moolenaar96f45c02019-10-26 19:53:45 +02006650 The default is ">". For Unix, if the 'shell' option is "csh" or
6651 "tcsh" during initializations, the default becomes ">&". If the
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01006652 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh", "zsh-beta",
6653 "bash" or "fish", the default becomes ">%s 2>&1". This means that
6654 stderr is also included. For Win32, the Unix checks are done and
6655 additionally "cmd" is checked for, which makes the default ">%s 2>&1".
6656 Also, the same names with ".exe" appended are checked for.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006657 The initialization of this option is done after reading the ".vimrc"
6658 and the other initializations, so that when the 'shell' option is set
6659 there, the 'shellredir' option changes automatically unless it was
6660 explicitly set before.
6661 In the future pipes may be used for filtering and this option will
6662 become obsolete (at least for Unix).
6663 This option cannot be set from a |modeline| or in the |sandbox|, for
6664 security reasons.
6665
6666 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
6667'shellslash' 'ssl' boolean (default off)
6668 global
Bram Moolenaar6f345a12019-12-17 21:27:18 +01006669 {only for MS-Windows}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006670 When set, a forward slash is used when expanding file names. This is
Bram Moolenaar8024f932020-01-14 19:29:13 +01006671 useful when a Unix-like shell is used instead of cmd.exe. Backward
6672 slashes can still be typed, but they are changed to forward slashes by
6673 Vim.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006674 Note that setting or resetting this option has no effect for some
6675 existing file names, thus this option needs to be set before opening
6676 any file for best results. This might change in the future.
6677 'shellslash' only works when a backslash can be used as a path
6678 separator. To test if this is so use: >
6679 if exists('+shellslash')
Bram Moolenaarac3150d2019-07-28 16:36:39 +02006680< Also see 'completeslash'.
6681
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006682 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
6683'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
6684 global
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006685 When on, use temp files for shell commands. When off use a pipe.
6686 When using a pipe is not possible temp files are used anyway.
Bram Moolenaar97293012011-07-18 19:40:27 +02006687 Currently a pipe is only supported on Unix and MS-Windows 2K and
6688 later. You can check it with: >
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006689 :if has("filterpipe")
6690< The advantage of using a pipe is that nobody can read the temp file
6691 and the 'shell' command does not need to support redirection.
6692 The advantage of using a temp file is that the file type and encoding
6693 can be detected.
6694 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
6695 |FilterWritePost| autocommands event are not triggered when
6696 'shelltemp' is off.
Bram Moolenaar269f5952016-07-15 22:54:41 +02006697 The `system()` function does not respect this option and always uses
6698 temp files.
Bram Moolenaar036986f2017-03-16 17:41:02 +01006699 NOTE: This option is set to the Vim default value when 'compatible'
6700 is reset.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006701
Bram Moolenaar071d4272004-06-13 20:20:40 +00006702 *'shelltype'* *'st'*
6703'shelltype' 'st' number (default 0)
6704 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02006705 {only for the Amiga}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006706 On the Amiga this option influences the way how the commands work
6707 which use a shell.
6708 0 and 1: always use the shell
6709 2 and 3: use the shell only to filter lines
6710 4 and 5: use shell only for ':sh' command
6711 When not using the shell, the command is executed directly.
6712
6713 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
6714 1 and 3: use "shell cmd" to start external commands
6715
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006716 *'shellxescape'* *'sxe'*
6717'shellxescape' 'sxe' string (default: "";
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006718 for MS-Windows: "\"&|<>()@^")
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006719 global
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006720 When 'shellxquote' is set to "(" then the characters listed in this
6721 option will be escaped with a '^' character. This makes it possible
6722 to execute most external commands with cmd.exe.
6723
Bram Moolenaar071d4272004-06-13 20:20:40 +00006724 *'shellxquote'* *'sxq'*
6725'shellxquote' 'sxq' string (default: "";
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006726 for Win32, when 'shell' is cmd.exe: "("
6727 for Win32, when 'shell' contains "sh"
6728 somewhere: "\""
Bram Moolenaar071d4272004-06-13 20:20:40 +00006729 for Unix, when using system(): "\"")
6730 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006731 Quoting character(s), put around the command passed to the shell, for
6732 the "!" and ":!" commands. Includes the redirection. See
6733 'shellquote' to exclude the redirection. It's probably not useful
6734 to set both options.
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006735 When the value is '(' then ')' is appended. When the value is '"('
6736 then ')"' is appended.
6737 When the value is '(' then also see 'shellxescape'.
Bram Moolenaara64ba222012-02-12 23:23:31 +01006738 This is an empty string by default on most systems, but is known to be
6739 useful for on Win32 version, either for cmd.exe which automatically
6740 strips off the first and last quote on a command, or 3rd-party shells
6741 such as the MKS Korn Shell or bash, where it should be "\"". The
6742 default is adjusted according the value of 'shell', to reduce the need
6743 to set this option by the user. See |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006744 This option cannot be set from a |modeline| or in the |sandbox|, for
6745 security reasons.
6746
6747 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
6748'shiftround' 'sr' boolean (default off)
6749 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006750 Round indent to multiple of 'shiftwidth'. Applies to > and <
6751 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
6752 a multiple of 'shiftwidth' (this is Vi compatible).
6753 NOTE: This option is reset when 'compatible' is set.
6754
6755 *'shiftwidth'* *'sw'*
6756'shiftwidth' 'sw' number (default 8)
6757 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006758 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00006759 |'cindent'|, |>>|, |<<|, etc.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02006760 When zero the 'ts' value will be used. Use the |shiftwidth()|
6761 function to get the effective shiftwidth value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006762
6763 *'shortmess'* *'shm'*
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02006764'shortmess' 'shm' string (Vim default "filnxtToOS", Vi default: "S",
6765 POSIX default: "AS")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006766 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006767 This option helps to avoid all the |hit-enter| prompts caused by file
6768 messages, for example with CTRL-G, and to avoid some other messages.
6769 It is a list of flags:
6770 flag meaning when present ~
6771 f use "(3 of 5)" instead of "(file 3 of 5)"
6772 i use "[noeol]" instead of "[Incomplete last line]"
Bram Moolenaar3f40ce72020-07-05 14:10:13 +02006773 l use "999L, 888B" instead of "999 lines, 888 bytes"
Bram Moolenaar071d4272004-06-13 20:20:40 +00006774 m use "[+]" instead of "[Modified]"
6775 n use "[New]" instead of "[New File]"
6776 r use "[RO]" instead of "[readonly]"
6777 w use "[w]" instead of "written" for file write message
6778 and "[a]" instead of "appended" for ':w >> file' command
6779 x use "[dos]" instead of "[dos format]", "[unix]" instead of
6780 "[unix format]" and "[mac]" instead of "[mac format]".
6781 a all of the above abbreviations
6782
6783 o overwrite message for writing a file with subsequent message
6784 for reading a file (useful for ":wn" or when 'autowrite' on)
6785 O message for reading a file overwrites any previous message.
6786 Also for quickfix message (e.g., ":cn").
6787 s don't give "search hit BOTTOM, continuing at TOP" or "search
Bram Moolenaara6c27c42019-05-09 19:16:22 +02006788 hit TOP, continuing at BOTTOM" messages; when using the search
6789 count do not show "W" after the count message (see S below)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006790 t truncate file message at the start if it is too long to fit
6791 on the command-line, "<" will appear in the left most column.
6792 Ignored in Ex mode.
6793 T truncate other messages in the middle if they are too long to
Bram Moolenaar582fd852005-03-28 20:58:01 +00006794 fit on the command line. "..." will appear in the middle.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006795 Ignored in Ex mode.
6796 W don't give "written" or "[w]" when writing a file
6797 A don't give the "ATTENTION" message when an existing swap file
6798 is found.
6799 I don't give the intro message when starting Vim |:intro|.
Bram Moolenaarea389e92014-05-28 21:40:52 +02006800 c don't give |ins-completion-menu| messages. For example,
6801 "-- XXX completion (YYY)", "match 1 of 2", "The only match",
6802 "Pattern not found", "Back at original", etc.
Bram Moolenaar426dd022016-03-15 15:09:29 +01006803 q use "recording" instead of "recording @a"
6804 F don't give the file info when editing a file, like `:silent`
Bram Moolenaar110289e2019-05-23 15:38:06 +02006805 was used for the command; note that this also affects messages
6806 from autocommands
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02006807 S do not show search count message when searching, e.g.
6808 "[1/5]"
Bram Moolenaar071d4272004-06-13 20:20:40 +00006809
6810 This gives you the opportunity to avoid that a change between buffers
6811 requires you to hit <Enter>, but still gives as useful a message as
6812 possible for the space available. To get the whole message that you
6813 would have got with 'shm' empty, use ":file!"
6814 Useful values:
6815 shm= No abbreviation of message.
6816 shm=a Abbreviation, but no loss of information.
6817 shm=at Abbreviation, and truncate message when necessary.
6818
6819 NOTE: This option is set to the Vi default value when 'compatible' is
6820 set and to the Vim default value when 'compatible' is reset.
6821
6822 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
6823'shortname' 'sn' boolean (default off)
6824 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00006825 Filenames are assumed to be 8 characters plus one extension of 3
6826 characters. Multiple dots in file names are not allowed. When this
6827 option is on, dots in file names are replaced with underscores when
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006828 adding an extension (".~" or ".swp"). This option is useful
Bram Moolenaar071d4272004-06-13 20:20:40 +00006829 when editing files on an MS-DOS compatible filesystem, e.g., messydos
Bram Moolenaarade0d392020-01-21 22:33:58 +01006830 or crossdos.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006831
6832 *'showbreak'* *'sbr'* *E595*
6833'showbreak' 'sbr' string (default "")
Bram Moolenaaree857022019-11-09 23:26:40 +01006834 global or local to window |global-local|
Bram Moolenaardb84e452010-08-15 13:50:43 +02006835 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006836 feature}
6837 String to put at the start of lines that have been wrapped. Useful
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006838 values are "> " or "+++ ": >
6839 :set showbreak=>\
6840< Note the backslash to escape the trailing space. It's easier like
6841 this: >
Bram Moolenaar1a384422010-07-14 19:53:30 +02006842 :let &showbreak = '+++ '
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006843< Only printable single-cell characters are allowed, excluding <Tab> and
Bram Moolenaar071d4272004-06-13 20:20:40 +00006844 comma (in a future version the comma might be used to separate the
6845 part that is shown at the end and at the start of a line).
6846 The characters are highlighted according to the '@' flag in
6847 'highlight'.
6848 Note that tabs after the showbreak will be displayed differently.
6849 If you want the 'showbreak' to appear in between line numbers, add the
6850 "n" flag to 'cpoptions'.
Bram Moolenaaree857022019-11-09 23:26:40 +01006851 A window-local value overrules a global value. If the global value is
6852 set and you want no value in the current window use NONE: >
6853 :setlocal showbreak=NONE
6854<
Bram Moolenaar071d4272004-06-13 20:20:40 +00006855 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02006856'showcmd' 'sc' boolean (Vim default: on, off for Unix,
6857 Vi default: off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006858 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006859 {not available when compiled without the
6860 |+cmdline_info| feature}
Bram Moolenaar02467872007-05-06 13:22:01 +00006861 Show (partial) command in the last line of the screen. Set this
6862 option off if your terminal is slow.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006863 In Visual mode the size of the selected area is shown:
6864 - When selecting characters within a line, the number of characters.
Bram Moolenaarf91787c2010-07-17 12:47:16 +02006865 If the number of bytes is different it is also displayed: "2-6"
6866 means two characters and six bytes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006867 - When selecting more than one line, the number of lines.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006868 - When selecting a block, the size in screen characters:
6869 {lines}x{columns}.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006870 NOTE: This option is set to the Vi default value when 'compatible' is
6871 set and to the Vim default value when 'compatible' is reset.
6872
6873 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
6874'showfulltag' 'sft' boolean (default off)
6875 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006876 When completing a word in insert mode (see |ins-completion|) from the
6877 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006878 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00006879 matched a C function, you can see a template for what arguments are
6880 required (coding style permitting).
Bram Moolenaar446cb832008-06-24 21:56:24 +00006881 Note that this doesn't work well together with having "longest" in
6882 'completeopt', because the completion from the search pattern may not
6883 match the typed text.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006884
6885 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
6886'showmatch' 'sm' boolean (default off)
6887 global
6888 When a bracket is inserted, briefly jump to the matching one. The
6889 jump is only done if the match can be seen on the screen. The time to
6890 show the match can be set with 'matchtime'.
6891 A Beep is given if there is no match (no matter if the match can be
Bram Moolenaarca635012015-09-25 20:34:21 +02006892 seen or not).
6893 This option is reset when 'paste' is set and restored when 'paste' is
6894 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006895 When the 'm' flag is not included in 'cpoptions', typing a character
6896 will immediately move the cursor back to where it belongs.
6897 See the "sm" field in 'guicursor' for setting the cursor shape and
6898 blinking when showing the match.
6899 The 'matchpairs' option can be used to specify the characters to show
6900 matches for. 'rightleft' and 'revins' are used to look for opposite
6901 matches.
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006902 Also see the matchparen plugin for highlighting the match when moving
6903 around |pi_paren.txt|.
6904 Note: Use of the short form is rated PG.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006905
6906 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
6907'showmode' 'smd' boolean (Vim default: on, Vi default: off)
6908 global
6909 If in Insert, Replace or Visual mode put a message on the last line.
6910 Use the 'M' flag in 'highlight' to set the type of highlighting for
6911 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006912 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00006913 doesn't mean XIM is really active, especially when 'imactivatekey' is
6914 not set.
6915 NOTE: This option is set to the Vi default value when 'compatible' is
6916 set and to the Vim default value when 'compatible' is reset.
6917
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006918 *'showtabline'* *'stal'*
6919'showtabline' 'stal' number (default 1)
6920 global
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006921 The value of this option specifies when the line with tab page labels
6922 will be displayed:
6923 0: never
6924 1: only if there are at least two tab pages
6925 2: always
6926 This is both for the GUI and non-GUI implementation of the tab pages
6927 line.
6928 See |tab-page| for more information about tab pages.
6929
Bram Moolenaar071d4272004-06-13 20:20:40 +00006930 *'sidescroll'* *'ss'*
6931'sidescroll' 'ss' number (default 0)
6932 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006933 The minimal number of columns to scroll horizontally. Used only when
6934 the 'wrap' option is off and the cursor is moved off of the screen.
6935 When it is zero the cursor will be put in the middle of the screen.
6936 When using a slow terminal set it to a large number or 0. When using
6937 a fast terminal use a small number or 1. Not used for "zh" and "zl"
6938 commands.
6939
6940 *'sidescrolloff'* *'siso'*
6941'sidescrolloff' 'siso' number (default 0)
Bram Moolenaar375e3392019-01-31 18:26:10 +01006942 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006943 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00006944 right of the cursor if 'nowrap' is set. Setting this option to a
6945 value greater than 0 while having |'sidescroll'| also at a non-zero
6946 value makes some context visible in the line you are scrolling in
6947 horizontally (except at beginning of the line). Setting this option
6948 to a large value (like 999) has the effect of keeping the cursor
6949 horizontally centered in the window, as long as one does not come too
6950 close to the beginning of the line.
Bram Moolenaar375e3392019-01-31 18:26:10 +01006951 After using the local value, go back the global value with one of
6952 these two: >
6953 setlocal sidescrolloff<
6954 setlocal sidescrolloff=-1
6955< NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006956
6957 Example: Try this together with 'sidescroll' and 'listchars' as
6958 in the following example to never allow the cursor to move
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02006959 onto the "extends" character: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006960
6961 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
6962 :set sidescrolloff=1
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02006963<
6964 *'signcolumn'* *'scl'*
6965'signcolumn' 'scl' string (default "auto")
6966 local to window
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02006967 {not available when compiled without the |+signs|
6968 feature}
Bram Moolenaar09521312016-08-12 22:54:35 +02006969 Whether or not to draw the signcolumn. Valid values are:
6970 "auto" only when there is a sign to display
6971 "no" never
6972 "yes" always
Bram Moolenaar394c5d82019-06-17 21:48:05 +02006973 "number" display signs in the 'number' column. If the number
Bram Moolenaar6c1e1572019-06-22 02:13:00 +02006974 column is not present, then behaves like "auto".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006975
6976
6977 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
6978'smartcase' 'scs' boolean (default off)
6979 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006980 Override the 'ignorecase' option if the search pattern contains upper
6981 case characters. Only used when the search pattern is typed and
6982 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarc8734422012-06-01 22:38:45 +02006983 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00006984 "*" and "#" you can make 'smartcase' used by doing a "/" command,
6985 recalling the search pattern from history and hitting <Enter>.
6986 NOTE: This option is reset when 'compatible' is set.
6987
6988 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
6989'smartindent' 'si' boolean (default off)
6990 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00006991 {not available when compiled without the
6992 |+smartindent| feature}
6993 Do smart autoindenting when starting a new line. Works for C-like
6994 programs, but can also be used for other languages. 'cindent' does
6995 something like this, works better in most cases, but is more strict,
Bram Moolenaar81af9252010-12-10 20:35:50 +01006996 see |C-indenting|. When 'cindent' is on or 'indentexpr' is set,
Bram Moolenaar166af9b2010-11-16 20:34:40 +01006997 setting 'si' has no effect. 'indentexpr' is a more advanced
6998 alternative.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006999 Normally 'autoindent' should also be on when using 'smartindent'.
7000 An indent is automatically inserted:
7001 - After a line ending in '{'.
7002 - After a line starting with a keyword from 'cinwords'.
7003 - Before a line starting with '}' (only with the "O" command).
7004 When typing '}' as the first character in a new line, that line is
7005 given the same indent as the matching '{'.
7006 When typing '#' as the first character in a new line, the indent for
7007 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007008 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00007009 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
7010 When using the ">>" command, lines starting with '#' are not shifted
7011 right.
Bram Moolenaar036986f2017-03-16 17:41:02 +01007012 NOTE: This option is reset when 'compatible' is set.
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
7016 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
7017'smarttab' 'sta' boolean (default off)
7018 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007019 When on, a <Tab> in front of a line inserts blanks according to
Bram Moolenaar280f1262006-01-30 00:14:18 +00007020 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A
7021 <BS> will delete a 'shiftwidth' worth of space at the start of the
7022 line.
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00007023 When off, a <Tab> always inserts blanks according to 'tabstop' or
Bram Moolenaar280f1262006-01-30 00:14:18 +00007024 'softtabstop'. 'shiftwidth' is only used for shifting text left or
7025 right |shift-left-right|.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007026 What gets inserted (a <Tab> or spaces) depends on the 'expandtab'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007027 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00007028 number of spaces is minimized by using <Tab>s.
Bram Moolenaarca635012015-09-25 20:34:21 +02007029 This option is reset when 'paste' is set and restored when 'paste' is
7030 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007031 NOTE: This option is reset when 'compatible' is set.
7032
7033 *'softtabstop'* *'sts'*
7034'softtabstop' 'sts' number (default 0)
7035 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007036 Number of spaces that a <Tab> counts for while performing editing
7037 operations, like inserting a <Tab> or using <BS>. It "feels" like
7038 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
7039 used. This is useful to keep the 'ts' setting at its standard value
7040 of 8, while being able to edit like it is set to 'sts'. However,
7041 commands like "x" still work on the actual characters.
7042 When 'sts' is zero, this feature is off.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02007043 When 'sts' is negative, the value of 'shiftwidth' is used.
Bram Moolenaarca635012015-09-25 20:34:21 +02007044 'softtabstop' is set to 0 when the 'paste' option is set and restored
7045 when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007046 See also |ins-expandtab|. When 'expandtab' is not set, the number of
7047 spaces is minimized by using <Tab>s.
7048 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
7049 set.
7050 NOTE: This option is set to 0 when 'compatible' is set.
7051
Bram Moolenaar04958cb2018-06-23 19:23:02 +02007052 If Vim is compiled with the |+vartabs| feature then the value of
7053 'softtabstop' will be ignored if |'varsofttabstop'| is set to
7054 anything other than an empty string.
7055
Bram Moolenaar217ad922005-03-20 22:37:15 +00007056 *'spell'* *'nospell'*
7057'spell' boolean (default off)
7058 local to window
Bram Moolenaar217ad922005-03-20 22:37:15 +00007059 {not available when compiled without the |+syntax|
7060 feature}
7061 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007062 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007063
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007064 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00007065'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007066 local to buffer
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007067 {not available when compiled without the |+syntax|
7068 feature}
7069 Pattern to locate the end of a sentence. The following word will be
7070 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007071 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007072 When this check is not wanted make this option empty.
7073 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00007074 Be careful with special characters, see |option-backslash| about
7075 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007076 To set this option automatically depending on the language, see
7077 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007078
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007079 *'spellfile'* *'spf'*
7080'spellfile' 'spf' string (default empty)
7081 local to buffer
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007082 {not available when compiled without the |+syntax|
7083 feature}
7084 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00007085 commands. It must end in ".{encoding}.add". You need to include the
7086 path, otherwise the file is placed in the current directory.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007087 *E765*
7088 It may also be a comma separated list of names. A count before the
7089 |zg| and |zw| commands can be used to access each. This allows using
7090 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007091 When a word is added while this option is empty Vim will set it for
Bram Moolenaar910f66f2006-04-05 20:41:53 +00007092 you: Using the first directory in 'runtimepath' that is writable. If
7093 there is no "spell" directory yet it will be created. For the file
7094 name the first language name that appears in 'spelllang' is used,
Bram Moolenaar3b506942005-06-23 22:36:45 +00007095 ignoring the region.
7096 The resulting ".spl" file will be used for spell checking, it does not
7097 have to appear in 'spelllang'.
7098 Normally one file is used for all regions, but you can add the region
7099 name if you want to. However, it will then only be used when
7100 'spellfile' is set to it, for entries in 'spelllang' only files
7101 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00007102 This option cannot be set from a |modeline| or in the |sandbox|, for
7103 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007104
Bram Moolenaar217ad922005-03-20 22:37:15 +00007105 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007106'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00007107 local to buffer
Bram Moolenaar217ad922005-03-20 22:37:15 +00007108 {not available when compiled without the |+syntax|
7109 feature}
Bram Moolenaar3b506942005-06-23 22:36:45 +00007110 A comma separated list of word list names. When the 'spell' option is
7111 on spellchecking will be done for these languages. Example: >
7112 set spelllang=en_us,nl,medical
7113< This means US English, Dutch and medical words are recognized. Words
7114 that are not recognized will be highlighted.
Bram Moolenaar911ead12019-04-21 00:03:35 +02007115 The word list name must consist of alphanumeric characters, a dash or
7116 an underscore. It should not include a comma or dot. Using a dash is
Bram Moolenaar3b506942005-06-23 22:36:45 +00007117 recommended to separate the two letter language name from a
7118 specification. Thus "en-rare" is used for rare English words.
7119 A region name must come last and have the form "_xx", where "xx" is
7120 the two-letter, lower case region name. You can use more than one
7121 region by listing them: "en_us,en_ca" supports both US and Canadian
7122 English, but not words specific for Australia, New Zealand or Great
Bram Moolenaarfa735342016-01-03 22:14:44 +01007123 Britain. (Note: currently en_au and en_nz dictionaries are older than
7124 en_ca, en_gb and en_us).
Bram Moolenaarcc63c642013-11-12 04:44:01 +01007125 If the name "cjk" is included East Asian characters are excluded from
7126 spell checking. This is useful when editing text that also has Asian
7127 words.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007128 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007129 As a special case the name of a .spl file can be given as-is. The
7130 first "_xx" in the name is removed and used as the region name
7131 (_xx is an underscore, two letters and followed by a non-letter).
7132 This is mainly for testing purposes. You must make sure the correct
7133 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007134 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007135 idea to set 'spelllang' after setting 'encoding' to avoid loading the
7136 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00007137 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007138
Bram Moolenaar98692072006-02-04 00:57:42 +00007139 If the |spellfile.vim| plugin is active and you use a language name
7140 for which Vim cannot find the .spl file in 'runtimepath' the plugin
7141 will ask you if you want to download the file.
7142
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007143 After this option has been set successfully, Vim will source the files
7144 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
Bram Moolenaarb730f0c2018-11-25 03:56:26 +01007145 up to the first character that is not an ASCII letter or number and
7146 not a dash. Also see |set-spc-auto|.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007147
Bram Moolenaar362b44b2020-06-10 21:47:00 +02007148 *'spelloptions'* *'spo'*
7149'spelloptions' 'spo' string (default "")
7150 local to buffer
7151 {not available when compiled without the |+syntax|
7152 feature}
7153 A comma separated list of options for spell checking:
7154 camel When a word is CamelCased, assume "Cased" is a
7155 separate word: every upper-case character in a word
7156 that comes after a lower case character indicates the
7157 start of a new word.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007158
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007159 *'spellsuggest'* *'sps'*
7160'spellsuggest' 'sps' string (default "best")
7161 global
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007162 {not available when compiled without the |+syntax|
7163 feature}
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007164 Methods used for spelling suggestions. Both for the |z=| command and
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007165 the |spellsuggest()| function. This is a comma-separated list of
7166 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007167
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007168 best Internal method that works best for English. Finds
7169 changes like "fast" and uses a bit of sound-a-like
7170 scoring to improve the ordering.
7171
7172 double Internal method that uses two methods and mixes the
7173 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007174 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007175 word. That only works when the language specifies
7176 sound folding. Can be slow and doesn't always give
7177 better results.
7178
7179 fast Internal method that only checks for simple changes:
7180 character inserts/deletes/swaps. Works well for
7181 simple typing mistakes.
7182
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007183 {number} The maximum number of suggestions listed for |z=|.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007184 Not used for |spellsuggest()|. The number of
7185 suggestions is never more than the value of 'lines'
7186 minus two.
7187
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007188 file:{filename} Read file {filename}, which must have two columns,
7189 separated by a slash. The first column contains the
7190 bad word, the second column the suggested good word.
7191 Example:
7192 theribal/terrible ~
7193 Use this for common mistakes that do not appear at the
7194 top of the suggestion list with the internal methods.
7195 Lines without a slash are ignored, use this for
7196 comments.
Bram Moolenaarbcb98982014-05-01 14:08:19 +02007197 The word in the second column must be correct,
7198 otherwise it will not be used. Add the word to an
7199 ".add" file if it is currently flagged as a spelling
7200 mistake.
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007201 The file is used for all languages.
7202
7203 expr:{expr} Evaluate expression {expr}. Use a function to avoid
7204 trouble with spaces. |v:val| holds the badly spelled
7205 word. The expression must evaluate to a List of
7206 Lists, each with a suggestion and a score.
7207 Example:
Bram Moolenaar214641f2017-03-05 17:04:09 +01007208 [['the', 33], ['that', 44]] ~
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007209 Set 'verbose' and use |z=| to see the scores that the
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007210 internal methods use. A lower score is better.
7211 This may invoke |spellsuggest()| if you temporarily
7212 set 'spellsuggest' to exclude the "expr:" part.
7213 Errors are silently ignored, unless you set the
7214 'verbose' option to a non-zero value.
7215
7216 Only one of "best", "double" or "fast" may be used. The others may
7217 appear several times in any order. Example: >
7218 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
7219<
7220 This option cannot be set from a |modeline| or in the |sandbox|, for
7221 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007222
7223
Bram Moolenaar071d4272004-06-13 20:20:40 +00007224 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
7225'splitbelow' 'sb' boolean (default off)
7226 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007227 When on, splitting a window will put the new window below the current
7228 one. |:split|
7229
7230 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
7231'splitright' 'spr' boolean (default off)
7232 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007233 When on, splitting a window will put the new window right of the
7234 current one. |:vsplit|
7235
7236 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
7237'startofline' 'sol' boolean (default on)
7238 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007239 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00007240 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007241 (if possible). This applies to the commands: CTRL-D, CTRL-U, CTRL-B,
Bram Moolenaar843ee412004-06-30 16:16:41 +00007242 CTRL-F, "G", "H", "M", "L", gg, and to the commands "d", "<<" and ">>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007243 with a linewise operator, with "%" with a count and to buffer changing
7244 commands (CTRL-^, :bnext, :bNext, etc.). Also for an Ex command that
7245 only has a line number, e.g., ":25" or ":+".
7246 In case of buffer changing commands the cursor is placed at the column
7247 where it was the last time the buffer was edited.
7248 NOTE: This option is set when 'compatible' is set.
7249
Bram Moolenaar00654022011-02-25 14:42:19 +01007250 *'statusline'* *'stl'* *E540* *E542*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007251'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007252 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007253 {not available when compiled without the |+statusline|
7254 feature}
7255 When nonempty, this option determines the content of the status line.
7256 Also see |status-line|.
7257
7258 The option consists of printf style '%' items interspersed with
7259 normal text. Each status line item is of the form:
7260 %-0{minwid}.{maxwid}{item}
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01007261 All fields except the {item} are optional. A single percent sign can
Bram Moolenaar8133cc62020-10-26 21:05:27 +01007262 be given as "%%".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007263
Bram Moolenaar238a5642006-02-21 22:12:05 +00007264 When the option starts with "%!" then it is used as an expression,
7265 evaluated and the result is used as the option value. Example: >
7266 :set statusline=%!MyStatusLine()
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02007267< The *g:statusline_winid* variable will be set to the |window-ID| of the
7268 window that the status line belongs to.
7269 The result can contain %{} items that will be evaluated too.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02007270 Note that the "%!" expression is evaluated in the context of the
7271 current window and buffer, while %{} items are evaluated in the
7272 context of the window that the statusline belongs to.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007273
7274 When there is error while evaluating the option then it will be made
7275 empty to avoid further errors. Otherwise screen updating would loop.
7276
Bram Moolenaar071d4272004-06-13 20:20:40 +00007277 Note that the only effect of 'ruler' when this option is set (and
7278 'laststatus' is 2) is controlling the output of |CTRL-G|.
7279
7280 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00007281 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00007282 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007283 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007284 minwid Minimum width of the item, padding as set by '-' & '0'.
7285 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007286 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007287 on the left for text items. Numeric items will be
7288 shifted down to maxwid-2 digits followed by '>'number
7289 where number is the amount of missing digits, much like
7290 an exponential notation.
7291 item A one letter code as described below.
7292
7293 Following is a description of the possible statusline items. The
7294 second character in "item" is the type:
7295 N for number
7296 S for string
7297 F for flags as described below
7298 - not applicable
7299
7300 item meaning ~
Bram Moolenaar02467872007-05-06 13:22:01 +00007301 f S Path to the file in the buffer, as typed or relative to current
7302 directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007303 F S Full path to the file in the buffer.
7304 t S File name (tail) of file in the buffer.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007305 m F Modified flag, text is "[+]"; "[-]" if 'modifiable' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007306 M F Modified flag, text is ",+" or ",-".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007307 r F Readonly flag, text is "[RO]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007308 R F Readonly flag, text is ",RO".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007309 h F Help buffer flag, text is "[help]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007310 H F Help buffer flag, text is ",HLP".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007311 w F Preview window flag, text is "[Preview]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007312 W F Preview window flag, text is ",PRV".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007313 y F Type of file in the buffer, e.g., "[vim]". See 'filetype'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007314 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
Bram Moolenaar7fd73202010-07-25 16:58:46 +02007315 q S "[Quickfix List]", "[Location List]" or empty.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007316 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
7317 being used: "<keymap>"
7318 n N Buffer number.
Bram Moolenaar00654022011-02-25 14:42:19 +01007319 b N Value of character under cursor.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007320 B N As above, in hexadecimal.
7321 o N Byte number in file of byte under cursor, first byte is 1.
7322 Mnemonic: Offset from start of file (with one added)
7323 {not available when compiled without |+byte_offset| feature}
7324 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007325 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007326 l N Line number.
7327 L N Number of lines in buffer.
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02007328 c N Column number (byte index).
7329 v N Virtual column number (screen column).
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007330 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007331 p N Percentage through file in lines as in |CTRL-G|.
7332 P S Percentage through file of displayed window. This is like the
Bram Moolenaar14b69452013-06-29 23:05:20 +02007333 percentage described for 'ruler'. Always 3 in length, unless
7334 translated.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007335 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00007336 Empty if the argument file count is zero or one.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007337 { NF Evaluate expression between '%{' and '}' and substitute result.
Bram Moolenaar6d150f72018-04-21 20:03:20 +02007338 Note that there is no '%' before the closing '}'. The
7339 expression cannot contain a '}' character, call a function to
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007340 work around that. See |stl-%{| below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007341 ( - Start of item group. Can be used for setting the width and
7342 alignment of a section. Must be followed by %) somewhere.
7343 ) - End of item group. No width fields allowed.
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007344 T N For 'tabline': start of tab page N label. Use %T after the last
7345 label. This information is used for mouse clicks.
7346 X N For 'tabline': start of close tab N label. Use %X after the
7347 label, e.g.: %3Xclose%X. Use %999X for a "close current tab"
7348 mark. This information is used for mouse clicks.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007349 < - Where to truncate line if too long. Default is at the start.
7350 No width fields allowed.
7351 = - Separation point between left and right aligned items.
7352 No width fields allowed.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007353 # - Set highlight group. The name must follow and then a # again.
7354 Thus use %#HLname# for highlight group HLname. The same
7355 highlighting is used, also for the statusline of non-current
7356 windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007357 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00007358 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007359 The difference between User{N} and StatusLine will be applied
7360 to StatusLineNC for the statusline of non-current windows.
7361 The number N must be between 1 and 9. See |hl-User1..9|
7362
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007363 When displaying a flag, Vim removes the leading comma, if any, when
7364 that flag comes right after plaintext. This will make a nice display
7365 when flags are used like in the examples below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007366
Bram Moolenaar582fd852005-03-28 20:58:01 +00007367 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00007368 not set) and a minwid is not set for the group, the whole group will
7369 become empty. This will make a group like the following disappear
7370 completely from the statusline when none of the flags are set. >
7371 :set statusline=...%(\ [%M%R%H]%)...
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02007372< Beware that an expression is evaluated each and every time the status
7373 line is displayed.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007374 *stl-%{* *g:actual_curbuf* *g:actual_curwin*
Bram Moolenaarade0d392020-01-21 22:33:58 +01007375 While evaluating %{} the current buffer and current window will be set
7376 temporarily to that of the window (and buffer) whose statusline is
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007377 currently being drawn. The expression will evaluate in this context.
7378 The variable "g:actual_curbuf" is set to the `bufnr()` number of the
7379 real current buffer and "g:actual_curwin" to the |window-ID| of the
7380 real current window. These values are strings.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007381
Bram Moolenaar30b65812012-07-12 22:01:11 +02007382 The 'statusline' option will be evaluated in the |sandbox| if set from
7383 a modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02007384 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007385
7386 It is not allowed to change text or jump to another window while
7387 evaluating 'statusline' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007388
7389 If the statusline is not updated when you want it (e.g., after setting
7390 a variable that's used in an expression), you can force an update by
7391 setting an option without changing its value. Example: >
7392 :let &ro = &ro
7393
7394< A result of all digits is regarded a number for display purposes.
7395 Otherwise the result is taken as flag text and applied to the rules
7396 described above.
7397
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00007398 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00007399 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
Bram Moolenaarc4da1132017-07-15 19:39:43 +02007400 edit your .vimrc or whatever with "vim --clean" to get it right.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007401
7402 Examples:
7403 Emulate standard status line with 'ruler' set >
7404 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
7405< Similar, but add ASCII value of char under the cursor (like "ga") >
7406 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
7407< Display byte count and byte value, modified flag in red. >
7408 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
7409 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
7410< Display a ,GZ flag if a compressed file is loaded >
7411 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
7412< In the |:autocmd|'s: >
7413 :let b:gzflag = 1
7414< And: >
7415 :unlet b:gzflag
7416< And define this function: >
7417 :function VarExists(var, val)
7418 : if exists(a:var) | return a:val | else | return '' | endif
7419 :endfunction
7420<
7421 *'suffixes'* *'su'*
7422'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
7423 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007424 Files with these suffixes get a lower priority when multiple files
7425 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007426 suffixes. Spaces after the comma are ignored. A dot is also seen as
7427 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007428 separator, precede it with a backslash (see |option-backslash| about
7429 including spaces and backslashes).
7430 See 'wildignore' for completely ignoring files.
7431 The use of |:set+=| and |:set-=| is preferred when adding or removing
7432 suffixes from the list. This avoids problems when a future version
7433 uses another default.
7434
7435 *'suffixesadd'* *'sua'*
7436'suffixesadd' 'sua' string (default "")
7437 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007438 {not available when compiled without the
7439 |+file_in_path| feature}
7440 Comma separated list of suffixes, which are used when searching for a
7441 file for the "gf", "[I", etc. commands. Example: >
7442 :set suffixesadd=.java
7443<
7444 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
7445'swapfile' 'swf' boolean (default on)
7446 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007447 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007448 swapfile is not wanted for a specific buffer. For example, with
7449 confidential information that even root must not be able to access.
7450 Careful: All text will be in memory:
7451 - Don't use this for big files.
7452 - Recovery will be impossible!
7453 A swapfile will only be present when |'updatecount'| is non-zero and
7454 'swapfile' is set.
7455 When 'swapfile' is reset, the swap file for the current buffer is
7456 immediately deleted. When 'swapfile' is set, and 'updatecount' is
7457 non-zero, a swap file is immediately created.
7458 Also see |swap-file| and |'swapsync'|.
Bram Moolenaar76f3b1a2014-03-27 22:30:07 +01007459 If you want to open a new buffer without creating a swap file for it,
7460 use the |:noswapfile| modifier.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01007461 See 'directory' for where the swap file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007462
7463 This option is used together with 'bufhidden' and 'buftype' to
7464 specify special kinds of buffers. See |special-buffers|.
7465
7466 *'swapsync'* *'sws'*
7467'swapsync' 'sws' string (default "fsync")
7468 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007469 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007470 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007471 When this option is empty parts of the swap file may be in memory and
7472 not written to disk. When the system crashes you may lose more work.
7473 On Unix the system does a sync now and then without Vim asking for it,
7474 so the disadvantage of setting this option off is small. On some
7475 systems the swap file will not be written at all. For a unix system
7476 setting it to "sync" will use the sync() call instead of the default
7477 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007478 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007479
7480 *'switchbuf'* *'swb'*
7481'switchbuf' 'swb' string (default "")
7482 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007483 This option controls the behavior when switching between buffers.
7484 Possible values (comma separated list):
7485 useopen If included, jump to the first open window that
7486 contains the specified buffer (if there is one).
7487 Otherwise: Do not examine other windows.
7488 This setting is checked with |quickfix| commands, when
7489 jumping to errors (":cc", ":cn", "cp", etc.). It is
7490 also used in all buffer related split commands, for
7491 example ":sbuffer", ":sbnext", or ":sbrewind".
Bram Moolenaar779b74b2006-04-10 14:55:34 +00007492 usetab Like "useopen", but also consider windows in other tab
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00007493 pages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007494 split If included, split the current window before loading
Bram Moolenaar15146672011-10-20 22:22:38 +02007495 a buffer for a |quickfix| command that display errors.
Bram Moolenaar63b74a82019-03-24 15:09:13 +01007496 Otherwise: do not split, use current window (when used
7497 in the quickfix window: the previously used window or
7498 split if there is no other window).
Bram Moolenaara594d772015-06-19 14:41:49 +02007499 vsplit Just like "split" but split vertically.
Bram Moolenaar446cb832008-06-24 21:56:24 +00007500 newtab Like "split", but open a new tab page. Overrules
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02007501 "split" when both are present.
Bram Moolenaar539aa6b2019-11-17 18:09:38 +01007502 uselast If included, jump to the previously used window when
7503 jumping to errors with |quickfix| commands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007504
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007505 *'synmaxcol'* *'smc'*
7506'synmaxcol' 'smc' number (default 3000)
7507 local to buffer
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007508 {not available when compiled without the |+syntax|
7509 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007510 Maximum column in which to search for syntax items. In long lines the
7511 text after this column is not highlighted and following lines may not
7512 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007513 This helps to avoid very slow redrawing for an XML file that is one
7514 long line.
7515 Set to zero to remove the limit.
7516
Bram Moolenaar071d4272004-06-13 20:20:40 +00007517 *'syntax'* *'syn'*
7518'syntax' 'syn' string (default empty)
7519 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007520 {not available when compiled without the |+syntax|
7521 feature}
7522 When this option is set, the syntax with this name is loaded, unless
7523 syntax highlighting has been switched off with ":syntax off".
7524 Otherwise this option does not always reflect the current syntax (the
7525 b:current_syntax variable does).
7526 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007527 not automatically recognized. Example, in an IDL file:
7528 /* vim: set syntax=idl : */ ~
7529 When a dot appears in the value then this separates two filetype
7530 names. Example:
7531 /* vim: set syntax=c.doxygen : */ ~
7532 This will use the "c" syntax first, then the "doxygen" syntax.
7533 Note that the second one must be prepared to be loaded as an addition,
7534 otherwise it will be skipped. More than one dot may appear.
7535 To switch off syntax highlighting for the current file, use: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007536 :set syntax=OFF
7537< To switch syntax highlighting on according to the current value of the
7538 'filetype' option: >
7539 :set syntax=ON
7540< What actually happens when setting the 'syntax' option is that the
7541 Syntax autocommand event is triggered with the value as argument.
7542 This option is not copied to another buffer, independent of the 's' or
7543 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007544 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007545
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007546 *'tabline'* *'tal'*
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007547'tabline' 'tal' string (default empty)
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007548 global
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007549 When nonempty, this option determines the content of the tab pages
7550 line at the top of the Vim window. When empty Vim will use a default
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007551 tab pages line. See |setting-tabline| for more info.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007552
7553 The tab pages line only appears as specified with the 'showtabline'
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00007554 option and only when there is no GUI tab line. When 'e' is in
7555 'guioptions' and the GUI supports a tab line 'guitablabel' is used
Bram Moolenaar7f036442010-08-15 15:24:20 +02007556 instead. Note that the two tab pages lines are very different.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007557
7558 The value is evaluated like with 'statusline'. You can use
7559 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007560 the text to be displayed. Use "%1T" for the first label, "%2T" for
7561 the second one, etc. Use "%X" items for closing labels.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007562
Bram Moolenaare12bab32019-01-08 22:02:56 +01007563 When changing something that is used in 'tabline' that does not
7564 trigger it to be updated, use |:redrawtabline|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02007565 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaare12bab32019-01-08 22:02:56 +01007566
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007567 Keep in mind that only one of the tab pages is the current one, others
7568 are invisible and you can't jump to their windows.
7569
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007570
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007571 *'tabpagemax'* *'tpm'*
7572'tabpagemax' 'tpm' number (default 10)
7573 global
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007574 Maximum number of tab pages to be opened by the |-p| command line
7575 argument or the ":tab all" command. |tabpage|
7576
7577
7578 *'tabstop'* *'ts'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007579'tabstop' 'ts' number (default 8)
7580 local to buffer
7581 Number of spaces that a <Tab> in the file counts for. Also see
7582 |:retab| command, and 'softtabstop' option.
7583
7584 Note: Setting 'tabstop' to any other value than 8 can make your file
7585 appear wrong in many places (e.g., when printing it).
7586
7587 There are four main ways to use tabs in Vim:
7588 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
7589 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007590 will use a mix of tabs and spaces, but typing <Tab> and <BS> will
Bram Moolenaar071d4272004-06-13 20:20:40 +00007591 behave like a tab appears every 4 (or 3) characters.
7592 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
7593 'expandtab'. This way you will always insert spaces. The
7594 formatting will never be messed up when 'tabstop' is changed.
7595 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007596 |modeline| to set these values when editing the file again. Only
Bram Moolenaar071d4272004-06-13 20:20:40 +00007597 works when using Vim to edit the file.
7598 4. Always set 'tabstop' and 'shiftwidth' to the same value, and
7599 'noexpandtab'. This should then work (for initial indents only)
7600 for any tabstop setting that people use. It might be nice to have
7601 tabs after the first non-blank inserted as spaces if you do this
7602 though. Otherwise aligned comments will be wrong when 'tabstop' is
7603 changed.
7604
Bram Moolenaar04958cb2018-06-23 19:23:02 +02007605 If Vim is compiled with the |+vartabs| feature then the value of
7606 'tabstop' will be ignored if |'vartabstop'| is set to anything other
7607 than an empty string.
7608
Bram Moolenaar071d4272004-06-13 20:20:40 +00007609 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
7610'tagbsearch' 'tbs' boolean (default on)
7611 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007612 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007613 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00007614 searching makes searching for a tag a LOT faster, but a linear search
7615 will find more tags if the tags file wasn't properly sorted.
7616 Vim normally assumes that your tags files are sorted, or indicate that
7617 they are not sorted. Only when this is not the case does the
7618 'tagbsearch' option need to be switched off.
7619
7620 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007621 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00007622 certain files, or retry all files with a linear search. When
7623 'tagbsearch' is off, only a linear search is done.
7624
7625 Linear searching is done anyway, for one file, when Vim finds a line
7626 at the start of the file indicating that it's not sorted: >
Bram Moolenaar446cb832008-06-24 21:56:24 +00007627 !_TAG_FILE_SORTED 0 /some comment/
Bram Moolenaar071d4272004-06-13 20:20:40 +00007628< [The whitespace before and after the '0' must be a single <Tab>]
7629
7630 When a binary search was done and no match was found in any of the
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007631 files listed in 'tags', and case is ignored or a pattern is used
Bram Moolenaar071d4272004-06-13 20:20:40 +00007632 instead of a normal tag name, a retry is done with a linear search.
7633 Tags in unsorted tags files, and matches with different case will only
7634 be found in the retry.
7635
Bram Moolenaard4755bb2004-09-02 19:12:26 +00007636 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007637 linear search can be avoided when case is ignored. Use a value of '2'
7638 in the "!_TAG_FILE_SORTED" line for this. A tag file can be case-fold
7639 sorted with the -f switch to "sort" in most unices, as in the command:
7640 "sort -f -o tags tags". For "Exuberant ctags" version 5.x or higher
7641 (at least 5.5) the --sort=foldcase switch can be used for this as
7642 well. Note that case must be folded to uppercase for this to work.
7643
7644 By default, tag searches are case-sensitive. Case is ignored when
7645 'ignorecase' is set and 'tagcase' is "followic", or when 'tagcase' is
7646 "ignore".
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007647 Also when 'tagcase' is "followscs" and 'smartcase' is set, or
7648 'tagcase' is "smart", and the pattern contains only lowercase
7649 characters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007650
7651 When 'tagbsearch' is off, tags searching is slower when a full match
7652 exists, but faster when no full match exists. Tags in unsorted tags
7653 files may only be found with 'tagbsearch' off.
7654 When the tags file is not sorted, or sorted in a wrong way (not on
7655 ASCII byte value), 'tagbsearch' should be off, or the line given above
7656 must be included in the tags file.
7657 This option doesn't affect commands that find all matching tags (e.g.,
7658 command-line completion and ":help").
Bram Moolenaar071d4272004-06-13 20:20:40 +00007659
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007660 *'tagcase'* *'tc'*
7661'tagcase' 'tc' string (default "followic")
7662 global or local to buffer |global-local|
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007663 This option specifies how case is handled when searching the tags
7664 file:
7665 followic Follow the 'ignorecase' option
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007666 followscs Follow the 'smartcase' and 'ignorecase' options
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007667 ignore Ignore case
7668 match Match case
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007669 smart Ignore case unless an upper case letter is used
Bram Moolenaar036986f2017-03-16 17:41:02 +01007670 NOTE: This option is set to the Vi default value when 'compatible' is
7671 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007672
Bram Moolenaar45e18cb2019-04-28 18:05:35 +02007673 *'tagfunc'* *'tfu'*
7674'tagfunc' 'tfu' string (default: empty)
7675 local to buffer
7676 {not available when compiled without the |+eval|
7677 feature}
7678 This option specifies a function to be used to perform tag searches.
7679 The function gets the tag pattern and should return a List of matching
7680 tags. See |tag-function| for an explanation of how to write the
7681 function and an example.
7682
Bram Moolenaar071d4272004-06-13 20:20:40 +00007683 *'taglength'* *'tl'*
7684'taglength' 'tl' number (default 0)
7685 global
7686 If non-zero, tags are significant up to this number of characters.
7687
7688 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
7689'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
7690 global
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00007691 If on and using a tags file in another directory, file names in that
7692 tags file are relative to the directory where the tags file is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007693 NOTE: This option is set to the Vi default value when 'compatible' is
7694 set and to the Vim default value when 'compatible' is reset.
7695
7696 *'tags'* *'tag'* *E433*
7697'tags' 'tag' string (default "./tags,tags", when compiled with
7698 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
7699 global or local to buffer |global-local|
7700 Filenames for the tag command, separated by spaces or commas. To
7701 include a space or comma in a file name, precede it with a backslash
7702 (see |option-backslash| about including spaces and backslashes).
7703 When a file name starts with "./", the '.' is replaced with the path
7704 of the current file. But only when the 'd' flag is not included in
7705 'cpoptions'. Environment variables are expanded |:set_env|. Also see
7706 |tags-option|.
7707 "*", "**" and other wildcards can be used to search for tags files in
Bram Moolenaare2b590e2010-08-08 18:29:48 +02007708 a directory tree. See |file-searching|. E.g., "/lib/**/tags" will
7709 find all files named "tags" below "/lib". The filename itself cannot
7710 contain wildcards, it is used as-is. E.g., "/lib/**/tags?" will find
7711 files called "tags?". {not available when compiled without the
7712 |+path_extra| feature}
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00007713 The |tagfiles()| function can be used to get a list of the file names
7714 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007715 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
7716 files are also supported. They are automatically recognized. The
7717 default value becomes "./tags,./TAGS,tags,TAGS", unless case
7718 differences are ignored (MS-Windows). |emacs-tags|
7719 The use of |:set+=| and |:set-=| is preferred when adding or removing
7720 file names from the list. This avoids problems when a future version
7721 uses another default.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007722
7723 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
7724'tagstack' 'tgst' boolean (default on)
7725 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007726 When on, the |tagstack| is used normally. When off, a ":tag" or
7727 ":tselect" command with an argument will not push the tag onto the
7728 tagstack. A following ":tag" without an argument, a ":pop" command or
7729 any other command that uses the tagstack will use the unmodified
7730 tagstack, but does change the pointer to the active entry.
7731 Resetting this option is useful when using a ":tag" command in a
7732 mapping which should not change the tagstack.
7733
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007734 *'tcldll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01007735'tcldll' string (default depends on the build)
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007736 global
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007737 {only available when compiled with the |+tcl/dyn|
7738 feature}
7739 Specifies the name of the Tcl shared library. The default is
7740 DYNAMIC_TCL_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02007741 Environment variables are expanded |:set_env|.
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007742 This option cannot be set from a |modeline| or in the |sandbox|, for
7743 security reasons.
7744
Bram Moolenaar071d4272004-06-13 20:20:40 +00007745 *'term'* *E529* *E530* *E531*
7746'term' string (default is $TERM, if that fails:
7747 in the GUI: "builtin_gui"
7748 on Amiga: "amiga"
Bram Moolenaarb3f74062020-02-26 16:16:53 +01007749 on Haiku: "xterm"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007750 on Mac: "mac-ansi"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007751 on Unix: "ansi"
7752 on VMS: "ansi"
7753 on Win 32: "win32")
7754 global
7755 Name of the terminal. Used for choosing the terminal control
7756 characters. Environment variables are expanded |:set_env|.
7757 For example: >
7758 :set term=$TERM
7759< See |termcap|.
7760
7761 *'termbidi'* *'tbidi'*
7762 *'notermbidi'* *'notbidi'*
7763'termbidi' 'tbidi' boolean (default off, on for "mlterm")
7764 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007765 {only available when compiled with the |+arabic|
7766 feature}
7767 The terminal is in charge of Bi-directionality of text (as specified
7768 by Unicode). The terminal is also expected to do the required shaping
7769 that some languages (such as Arabic) require.
7770 Setting this option implies that 'rightleft' will not be set when
7771 'arabic' is set and the value of 'arabicshape' will be ignored.
7772 Note that setting 'termbidi' has the immediate effect that
7773 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
7774 This option is reset when the GUI is started.
7775 For further details see |arabic.txt|.
7776
7777 *'termencoding'* *'tenc'*
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02007778'termencoding' 'tenc' string (default ""; with GTK+ GUI: "utf-8")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007779 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007780 Encoding used for the terminal. This specifies what character
7781 encoding the keyboard produces and the display will understand. For
Bram Moolenaar3848e002016-03-19 18:42:29 +01007782 the GUI it only applies to the keyboard ('encoding' is used for the
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02007783 display).
Bram Moolenaar4b7cdca2020-01-01 16:18:38 +01007784 *E617* *E950*
Bram Moolenaar3df01732017-02-17 22:47:16 +01007785 Note: This does not apply to the GTK+ GUI. After the GUI has been
Bram Moolenaar071d4272004-06-13 20:20:40 +00007786 successfully initialized, 'termencoding' is forcibly set to "utf-8".
7787 Any attempts to set a different value will be rejected, and an error
7788 message is shown.
Bram Moolenaarac360bf2015-09-01 20:31:20 +02007789 For the Win32 GUI and console versions 'termencoding' is not used,
Bram Moolenaar071d4272004-06-13 20:20:40 +00007790 because the Win32 system always passes Unicode characters.
7791 When empty, the same encoding is used as for the 'encoding' option.
7792 This is the normal value.
7793 Not all combinations for 'termencoding' and 'encoding' are valid. See
7794 |encoding-table|.
7795 The value for this option must be supported by internal conversions or
7796 iconv(). When this is not possible no conversion will be done and you
7797 will probably experience problems with non-ASCII characters.
7798 Example: You are working with the locale set to euc-jp (Japanese) and
7799 want to edit a UTF-8 file: >
7800 :let &termencoding = &encoding
7801 :set encoding=utf-8
7802< You need to do this when your system has no locale support for UTF-8.
7803
Bram Moolenaarcafafb32018-02-22 21:07:09 +01007804 *'termguicolors'* *'tgc'* *E954*
Bram Moolenaar61be73b2016-04-29 22:59:22 +02007805'termguicolors' 'tgc' boolean (default off)
7806 global
Bram Moolenaar61be73b2016-04-29 22:59:22 +02007807 {not available when compiled without the
7808 |+termguicolors| feature}
7809 When on, uses |highlight-guifg| and |highlight-guibg| attributes in
Bram Moolenaarcafafb32018-02-22 21:07:09 +01007810 the terminal (thus using 24-bit color).
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01007811
Bram Moolenaarcafafb32018-02-22 21:07:09 +01007812 Requires a ISO-8613-3 compatible terminal. If setting this option
7813 does not work (produces a colorless UI) reading |xterm-true-color|
7814 might help.
7815
7816 For Win32 console, Windows 10 version 1703 (Creators Update) or later
7817 is required. Use this check to find out: >
7818 if has('vcon')
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01007819< This requires Vim to be built with the |+vtp| feature.
7820
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +02007821 Note that the "cterm" attributes are still used, not the "gui" ones.
Bram Moolenaar036986f2017-03-16 17:41:02 +01007822 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar61be73b2016-04-29 22:59:22 +02007823
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02007824 *'termwinkey'* *'twk'*
7825'termwinkey' 'twk' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02007826 local to window
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007827 The key that starts a CTRL-W command in a terminal window. Other keys
Bram Moolenaar74675a62017-07-15 13:53:23 +02007828 are sent to the job running in the window.
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007829 The <> notation can be used, e.g.: >
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02007830 :set termwinkey=<C-L>
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007831< The string must be one key stroke but can be multiple bytes.
7832 When not set CTRL-W is used, so that CTRL-W : gets you to the command
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02007833 line. If 'termwinkey' is set to CTRL-L then CTRL-L : gets you to the
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007834 command line.
Bram Moolenaar74675a62017-07-15 13:53:23 +02007835
Bram Moolenaar6c60f472019-04-28 16:00:35 +02007836 *'termwinscroll'* *'twsl'*
7837'termwinscroll' 'twsl' number (default 10000)
7838 local to buffer
7839 {not available when compiled without the
7840 |+terminal| feature}
7841 Number of scrollback lines to keep. When going over this limit the
7842 first 10% of the scrollback lines are deleted. This is just to reduce
7843 the memory usage. See |Terminal-Normal|.
7844
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02007845 *'termwinsize'* *'tws'*
7846'termwinsize' 'tws' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02007847 local to window
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02007848 Size used when opening the |terminal| window. Format:
7849 {rows}x{columns} or {rows}*{columns}.
Bram Moolenaar74675a62017-07-15 13:53:23 +02007850 - When empty the terminal gets the size from the window.
Bram Moolenaar498c2562018-04-15 23:45:15 +02007851 - When set with a "x" (e.g., "24x80") the terminal size is not
7852 adjusted to the window size. If the window is smaller only the
7853 top-left part is displayed.
7854 - When set with a "*" (e.g., "10*50") the terminal size follows the
7855 window size, but will not be smaller than the specified rows and/or
7856 columns.
7857 - When rows is zero then use the height of the window.
7858 - When columns is zero then use the width of the window.
7859 - Using "0x0" or "0*0" is the same as empty.
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02007860 - Can be overruled in the |term_start()| options with "term_rows" and
7861 "term_cols".
Bram Moolenaar498c2562018-04-15 23:45:15 +02007862
7863 Examples:
7864 "30x0" uses 30 rows and the current window width.
7865 "20*0" uses at least 20 rows and the current window width.
7866 "0*40" uses the current window height and at least 40 columns.
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02007867 Note that the command running in the terminal window may still change
7868 the size of the terminal. In that case the Vim window will be
7869 adjusted to that size, if possible.
Bram Moolenaar74675a62017-07-15 13:53:23 +02007870
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01007871 *'termwintype'* *'twt'*
7872'termwintype' 'twt' string (default "")
7873 global
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01007874 {only available when compiled with the |terminal|
7875 feature on MS-Windows}
7876 Specify the virtual console (pty) used when opening the terminal
7877 window.
7878
7879 Possible values are:
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01007880 "" use ConPTY if it is stable, winpty otherwise
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01007881 "winpty" use winpty, fail if not supported
7882 "conpty" use |ConPTY|, fail if not supported
7883
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01007884 |ConPTY| support depends on the platform. Windows 10 October 2018
7885 Update is the first version that supports ConPTY, however it is still
7886 considered unstable. ConPTY might become stable in the next release
7887 of Windows 10. winpty support needs to be installed. If neither is
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01007888 supported then you cannot open a terminal window.
7889
Bram Moolenaar071d4272004-06-13 20:20:40 +00007890 *'terse'* *'noterse'*
7891'terse' boolean (default off)
7892 global
7893 When set: Add 's' flag to 'shortmess' option (this makes the message
7894 for a search that hits the start or end of the file not being
7895 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
7896 shortens a lot of messages}
7897
7898 *'textauto'* *'ta'* *'notextauto'* *'nota'*
7899'textauto' 'ta' boolean (Vim default: on, Vi default: off)
7900 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007901 This option is obsolete. Use 'fileformats'.
7902 For backwards compatibility, when 'textauto' is set, 'fileformats' is
7903 set to the default value for the current system. When 'textauto' is
7904 reset, 'fileformats' is made empty.
7905 NOTE: This option is set to the Vi default value when 'compatible' is
7906 set and to the Vim default value when 'compatible' is reset.
7907
7908 *'textmode'* *'tx'* *'notextmode'* *'notx'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01007909'textmode' 'tx' boolean (Win32: default on,
Bram Moolenaar071d4272004-06-13 20:20:40 +00007910 others: default off)
7911 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007912 This option is obsolete. Use 'fileformat'.
7913 For backwards compatibility, when 'textmode' is set, 'fileformat' is
7914 set to "dos". When 'textmode' is reset, 'fileformat' is set to
7915 "unix".
7916
7917 *'textwidth'* *'tw'*
7918'textwidth' 'tw' number (default 0)
7919 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007920 Maximum width of text that is being inserted. A longer line will be
7921 broken after white space to get this width. A zero value disables
Bram Moolenaarca635012015-09-25 20:34:21 +02007922 this.
7923 'textwidth' is set to 0 when the 'paste' option is set and restored
7924 when 'paste' is reset.
7925 When 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00007926 'formatoptions' and |ins-textwidth|.
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00007927 When 'formatexpr' is set it will be used to break the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007928 NOTE: This option is set to 0 when 'compatible' is set.
7929
7930 *'thesaurus'* *'tsr'*
7931'thesaurus' 'tsr' string (default "")
7932 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007933 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01007934 for thesaurus completion commands |i_CTRL-X_CTRL-T|.
7935
7936 Each line in the file should contain words with similar meaning,
7937 separated by non-keyword characters (white space is preferred).
7938 Maximum line length is 510 bytes.
7939
Bram Moolenaard47d5222018-12-09 20:43:55 +01007940 An English word list was added to this github issue:
7941 https://github.com/vim/vim/issues/629#issuecomment-443293282
7942 Unpack thesaurus_pkg.zip, put the thesaurus.txt file somewhere, e.g.
7943 ~/.vim/thesaurus/english.txt, and the 'thesaurus' option to this file
7944 name.
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01007945
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007946 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00007947 after a comma are ignored, otherwise spaces are included in the file
7948 name. See |option-backslash| about using backslashes.
7949 The use of |:set+=| and |:set-=| is preferred when adding or removing
7950 directories from the list. This avoids problems when a future version
7951 uses another default.
7952 Backticks cannot be used in this option for security reasons.
7953
7954 *'tildeop'* *'top'* *'notildeop'* *'notop'*
7955'tildeop' 'top' boolean (default off)
7956 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007957 When on: The tilde command "~" behaves like an operator.
7958 NOTE: This option is reset when 'compatible' is set.
7959
7960 *'timeout'* *'to'* *'notimeout'* *'noto'*
7961'timeout' 'to' boolean (default on)
7962 global
7963 *'ttimeout'* *'nottimeout'*
Bram Moolenaar94237492017-04-23 18:40:21 +02007964'ttimeout' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007965 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007966 These two options together determine the behavior when part of a
7967 mapped key sequence or keyboard code has been received:
7968
7969 'timeout' 'ttimeout' action ~
7970 off off do not time out
7971 on on or off time out on :mappings and key codes
7972 off on time out on key codes
7973
7974 If both options are off, Vim will wait until either the complete
7975 mapping or key sequence has been received, or it is clear that there
7976 is no mapping or key sequence for the received characters. For
7977 example: if you have mapped "vl" and Vim has received 'v', the next
7978 character is needed to see if the 'v' is followed by an 'l'.
7979 When one of the options is on, Vim will wait for about 1 second for
7980 the next character to arrive. After that the already received
7981 characters are interpreted as single characters. The waiting time can
7982 be changed with the 'timeoutlen' option.
7983 On slow terminals or very busy systems timing out may cause
7984 malfunctioning cursor keys. If both options are off, Vim waits
7985 forever after an entered <Esc> if there are key codes that start
7986 with <Esc>. You will have to type <Esc> twice. If you do not have
7987 problems with key codes, but would like to have :mapped key
7988 sequences not timing out in 1 second, set the 'ttimeout' option and
7989 reset the 'timeout' option.
7990
7991 NOTE: 'ttimeout' is reset when 'compatible' is set.
7992
7993 *'timeoutlen'* *'tm'*
7994'timeoutlen' 'tm' number (default 1000)
7995 global
Bram Moolenaar25c9c682019-05-05 18:13:34 +02007996
Bram Moolenaar071d4272004-06-13 20:20:40 +00007997 *'ttimeoutlen'* *'ttm'*
Bram Moolenaar94237492017-04-23 18:40:21 +02007998'ttimeoutlen' 'ttm' number (default -1, set to 100 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007999 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008000 The time in milliseconds that is waited for a key code or mapped key
8001 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
8002 when part of a command has been typed.
8003 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
8004 different timeout value for key codes is desired set 'ttimeoutlen' to
8005 a non-negative number.
8006
8007 ttimeoutlen mapping delay key code delay ~
8008 < 0 'timeoutlen' 'timeoutlen'
8009 >= 0 'timeoutlen' 'ttimeoutlen'
8010
8011 The timeout only happens when the 'timeout' and 'ttimeout' options
8012 tell so. A useful setting would be >
8013 :set timeout timeoutlen=3000 ttimeoutlen=100
8014< (time out on mapping after three seconds, time out on key codes after
8015 a tenth of a second).
8016
8017 *'title'* *'notitle'*
8018'title' boolean (default off, on when title can be restored)
8019 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008020 {not available when compiled without the |+title|
8021 feature}
8022 When on, the title of the window will be set to the value of
8023 'titlestring' (if it is not empty), or to:
8024 filename [+=-] (path) - VIM
8025 Where:
8026 filename the name of the file being edited
8027 - indicates the file cannot be modified, 'ma' off
8028 + indicates the file was modified
8029 = indicates the file is read-only
8030 =+ indicates the file is read-only and modified
8031 (path) is the path of the file being edited
8032 - VIM the server name |v:servername| or "VIM"
8033 Only works if the terminal supports setting window titles
8034 (currently Amiga console, Win32 console, all GUI versions and
Bram Moolenaard1caa942020-04-10 22:10:56 +02008035 terminals with a non-empty 't_ts' option - these are Unix xterm and
Bram Moolenaar071d4272004-06-13 20:20:40 +00008036 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
8037 *X11*
8038 When Vim was compiled with HAVE_X11 defined, the original title will
8039 be restored if possible. The output of ":version" will include "+X11"
8040 when HAVE_X11 was defined, otherwise it will be "-X11". This also
8041 works for the icon name |'icon'|.
8042 But: When Vim was started with the |-X| argument, restoring the title
8043 will not work (except in the GUI).
8044 If the title cannot be restored, it is set to the value of 'titleold'.
8045 You might want to restore the title outside of Vim then.
8046 When using an xterm from a remote machine you can use this command:
8047 rsh machine_name xterm -display $DISPLAY &
8048 then the WINDOWID environment variable should be inherited and the
8049 title of the window should change back to what it should be after
8050 exiting Vim.
8051
8052 *'titlelen'*
8053'titlelen' number (default 85)
8054 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008055 {not available when compiled without the |+title|
8056 feature}
8057 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008058 title. When the title is longer, only the end of the path name is
8059 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008060 Using a percentage makes this adapt to the width of the window. But
8061 it won't work perfectly, because the actual number of characters
8062 available also depends on the font used and other things in the title
8063 bar. When 'titlelen' is zero the full path is used. Otherwise,
8064 values from 1 to 30000 percent can be used.
8065 'titlelen' is also used for the 'titlestring' option.
8066
8067 *'titleold'*
8068'titleold' string (default "Thanks for flying Vim")
8069 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008070 {only available when compiled with the |+title|
8071 feature}
8072 This option will be used for the window title when exiting Vim if the
8073 original title cannot be restored. Only happens if 'title' is on or
8074 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00008075 This option cannot be set from a |modeline| or in the |sandbox|, for
8076 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008077 *'titlestring'*
8078'titlestring' string (default "")
8079 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008080 {not available when compiled without the |+title|
8081 feature}
8082 When this option is not empty, it will be used for the title of the
8083 window. This happens only when the 'title' option is on.
8084 Only works if the terminal supports setting window titles (currently
8085 Amiga console, Win32 console, all GUI versions and terminals with a
8086 non-empty 't_ts' option).
8087 When Vim was compiled with HAVE_X11 defined, the original title will
Bram Moolenaar51628222016-12-01 23:03:28 +01008088 be restored if possible, see |X11|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008089
Bram Moolenaar071d4272004-06-13 20:20:40 +00008090 When this option contains printf-style '%' items, they will be
8091 expanded according to the rules used for 'statusline'.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008092 This option cannot be set in a modeline when 'modelineexpr' is off.
8093
Bram Moolenaar071d4272004-06-13 20:20:40 +00008094 Example: >
8095 :auto BufEnter * let &titlestring = hostname() . "/" . expand("%:p")
8096 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
8097< The value of 'titlelen' is used to align items in the middle or right
8098 of the available space.
8099 Some people prefer to have the file name first: >
8100 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
8101< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008102 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00008103 separating space only when needed.
8104 NOTE: Use of special characters in 'titlestring' may cause the display
8105 to be garbled (e.g., when it contains a CR or NL character).
8106 {not available when compiled without the |+statusline| feature}
8107
8108 *'toolbar'* *'tb'*
8109'toolbar' 'tb' string (default "icons,tooltips")
8110 global
8111 {only for |+GUI_GTK|, |+GUI_Athena|, |+GUI_Motif| and
8112 |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008113 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00008114 possible values are:
8115 icons Toolbar buttons are shown with icons.
8116 text Toolbar buttons shown with text.
8117 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008118 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008119 tooltips Tooltips are active for toolbar buttons.
8120 Tooltips refer to the popup help text which appears after the mouse
8121 cursor is placed over a toolbar button for a brief moment.
8122
8123 If you want the toolbar to be shown with icons as well as text, do the
8124 following: >
8125 :set tb=icons,text
8126< Motif and Athena cannot display icons and text at the same time. They
8127 will show icons if both are requested.
8128
8129 If none of the strings specified in 'toolbar' are valid or if
8130 'toolbar' is empty, this option is ignored. If you want to disable
8131 the toolbar, you need to set the 'guioptions' option. For example: >
8132 :set guioptions-=T
8133< Also see |gui-toolbar|.
8134
8135 *'toolbariconsize'* *'tbis'*
8136'toolbariconsize' 'tbis' string (default "small")
8137 global
Bram Moolenaar3df01732017-02-17 22:47:16 +01008138 {only in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008139 Controls the size of toolbar icons. The possible values are:
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008140 tiny Use tiny icons.
8141 small Use small icons (default).
8142 medium Use medium-sized icons.
8143 large Use large icons.
8144 huge Use even larger icons.
8145 giant Use very big icons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008146 The exact dimensions in pixels of the various icon sizes depend on
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008147 the current theme. Common dimensions are giant=48x48, huge=32x32,
8148 large=24x24, medium=24x24, small=20x20 and tiny=16x16.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008149
8150 If 'toolbariconsize' is empty, the global default size as determined
8151 by user preferences or the current theme is used.
8152
8153 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
8154'ttybuiltin' 'tbi' boolean (default on)
8155 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008156 When on, the builtin termcaps are searched before the external ones.
8157 When off the builtin termcaps are searched after the external ones.
8158 When this option is changed, you should set the 'term' option next for
8159 the change to take effect, for example: >
8160 :set notbi term=$TERM
8161< See also |termcap|.
8162 Rationale: The default for this option is "on", because the builtin
8163 termcap entries are generally better (many systems contain faulty
8164 xterm entries...).
8165
8166 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
8167'ttyfast' 'tf' boolean (default off, on when 'term' is xterm, hpterm,
8168 sun-cmd, screen, rxvt, dtterm or
8169 iris-ansi; also on when running Vim in
8170 a DOS console)
8171 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008172 Indicates a fast terminal connection. More characters will be sent to
8173 the screen for redrawing, instead of using insert/delete line
8174 commands. Improves smoothness of redrawing when there are multiple
8175 windows and the terminal does not support a scrolling region.
8176 Also enables the extra writing of characters at the end of each screen
8177 line for lines that wrap. This helps when using copy/paste with the
8178 mouse in an xterm and other terminals.
8179
8180 *'ttymouse'* *'ttym'*
8181'ttymouse' 'ttym' string (default depends on 'term')
8182 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008183 {only in Unix and VMS, doesn't work in the GUI; not
8184 available when compiled without |+mouse|}
8185 Name of the terminal type for which mouse codes are to be recognized.
Bram Moolenaar2c7a7632007-05-10 18:19:11 +00008186 Currently these strings are valid:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008187 *xterm-mouse*
8188 xterm xterm-like mouse handling. The mouse generates
8189 "<Esc>[Mscr", where "scr" is three bytes:
8190 "s" = button state
8191 "c" = column plus 33
8192 "r" = row plus 33
Bram Moolenaare968e362014-05-13 20:23:24 +02008193 This only works up to 223 columns! See "dec",
8194 "urxvt", and "sgr" for solutions.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008195 xterm2 Works like "xterm", but with the xterm reporting the
8196 mouse position while the mouse is dragged. This works
8197 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00008198 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00008199 work. See below for how Vim detects this
8200 automatically.
8201 *netterm-mouse*
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008202 netterm NetTerm mouse handling. A left mouse click generates
Bram Moolenaar071d4272004-06-13 20:20:40 +00008203 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008204 for the row and column. No other mouse events are
8205 supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008206 *dec-mouse*
8207 dec DEC terminal mouse handling. The mouse generates a
8208 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00008209 This is also available for an Xterm, if it was
8210 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00008211 *jsbterm-mouse*
8212 jsbterm JSB term mouse handling.
8213 *pterm-mouse*
8214 pterm QNX pterm mouse handling.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008215 *urxvt-mouse*
8216 urxvt Mouse handling for the urxvt (rxvt-unicode) terminal.
Bram Moolenaare968e362014-05-13 20:23:24 +02008217 The mouse works only if the terminal supports this
8218 encoding style, but it does not have 223 columns limit
8219 unlike "xterm" or "xterm2".
Bram Moolenaar9b451252012-08-15 17:43:31 +02008220 *sgr-mouse*
8221 sgr Mouse handling for the terminal that emits SGR-styled
Bram Moolenaare968e362014-05-13 20:23:24 +02008222 mouse reporting. The mouse works even in columns
8223 beyond 223. This option is backward compatible with
8224 "xterm2" because it can also decode "xterm2" style
8225 mouse codes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008226
8227 The mouse handling must be enabled at compile time |+mouse_xterm|
Bram Moolenaare968e362014-05-13 20:23:24 +02008228 |+mouse_dec| |+mouse_netterm| |+mouse_jsbterm| |+mouse_urxvt|
8229 |+mouse_sgr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008230 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
8231 recognized, if enabled at compile time. DEC terminal mouse codes
8232 are recognized if enabled at compile time, and 'ttymouse' is not
Bram Moolenaare968e362014-05-13 20:23:24 +02008233 "xterm", "xterm2", "urxvt" or "sgr" (because dec mouse codes conflict
8234 with them).
Bram Moolenaar071d4272004-06-13 20:20:40 +00008235 This option is automatically set to "xterm", when the 'term' option is
Bram Moolenaar45758762016-10-12 23:08:06 +02008236 set to a name that starts with "xterm", "mlterm", "screen", "tmux",
8237 "st" (full match only), "st-" or "stterm", and 'ttymouse' is not set
8238 already.
Bram Moolenaare968e362014-05-13 20:23:24 +02008239 Additionally, if vim is compiled with the |+termresponse| feature and
8240 |t_RV| is set to the escape sequence to request the xterm version
Bram Moolenaarf8a07122019-07-01 22:06:07 +02008241 number, more intelligent detection is done.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008242 The "xterm2" value will be set if the xterm version is reported to be
Bram Moolenaard47d5222018-12-09 20:43:55 +01008243 from 95 to 276. The "sgr" value will be set if Vim detects Mac
8244 Terminal.app, iTerm2 or mintty, and when the xterm version is 277 or
8245 higher.
Bram Moolenaare968e362014-05-13 20:23:24 +02008246 If you do not want 'ttymouse' to be set to "xterm2" or "sgr"
8247 automatically, set t_RV to an empty string: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008248 :set t_RV=
8249<
8250 *'ttyscroll'* *'tsl'*
8251'ttyscroll' 'tsl' number (default 999)
8252 global
8253 Maximum number of lines to scroll the screen. If there are more lines
8254 to scroll the window is redrawn. For terminals where scrolling is
8255 very slow and redrawing is not slow this can be set to a small number,
8256 e.g., 3, to speed up displaying.
8257
8258 *'ttytype'* *'tty'*
8259'ttytype' 'tty' string (default from $TERM)
8260 global
8261 Alias for 'term', see above.
8262
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008263 *'undodir'* *'udir'*
8264'undodir' 'udir' string (default ".")
8265 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008266 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008267 List of directory names for undo files, separated with commas.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008268 See |'backupdir'| for details of the format.
Bram Moolenaar6a244fe2010-05-24 22:02:24 +02008269 "." means using the directory of the file. The undo file name for
8270 "file.txt" is ".file.txt.un~".
8271 For other directories the file name is the full path of the edited
8272 file, with path separators replaced with "%".
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008273 When writing: The first directory that exists is used. "." always
8274 works, no directories after "." will be used for writing.
8275 When reading all entries are tried to find an undo file. The first
8276 undo file that exists is used. When it cannot be read an error is
8277 given, no further entry is used.
8278 See |undo-persistence|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008279 This option cannot be set from a |modeline| or in the |sandbox|, for
8280 security reasons.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008281
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02008282 *'undofile'* *'noundofile'* *'udf'* *'noudf'*
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008283'undofile' 'udf' boolean (default off)
8284 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02008285 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008286 When on, Vim automatically saves undo history to an undo file when
8287 writing a buffer to a file, and restores undo history from the same
8288 file on buffer read.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008289 The directory where the undo file is stored is specified by 'undodir'.
8290 For more information about this feature see |undo-persistence|.
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008291 The undo file is not read when 'undoreload' causes the buffer from
8292 before a reload to be saved for undo.
Bram Moolenaar97d62492012-11-15 21:28:22 +01008293 When 'undofile' is turned off the undo file is NOT deleted.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008294 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008295
Bram Moolenaar071d4272004-06-13 20:20:40 +00008296 *'undolevels'* *'ul'*
Bram Moolenaar8024f932020-01-14 19:29:13 +01008297'undolevels' 'ul' number (default 100, 1000 for Unix, VMS and Win32)
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008298 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008299 Maximum number of changes that can be undone. Since undo information
Bram Moolenaar5be4cee2019-09-27 19:34:08 +02008300 is kept in memory, higher numbers will cause more memory to be used.
8301 Nevertheless, a single change can already use a large amount of memory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008302 Set to 0 for Vi compatibility: One level of undo and "u" undoes
8303 itself: >
8304 set ul=0
8305< But you can also get Vi compatibility by including the 'u' flag in
8306 'cpoptions', and still be able to use CTRL-R to repeat undo.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008307 Also see |undo-two-ways|.
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008308 Set to -1 for no undo at all. You might want to do this only for the
8309 current buffer: >
8310 setlocal ul=-1
Bram Moolenaar071d4272004-06-13 20:20:40 +00008311< This helps when you run out of memory for a single change.
Bram Moolenaar32efaf62014-11-05 17:02:17 +01008312
8313 The local value is set to -123456 when the global value is to be used.
8314
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008315 Also see |clear-undo|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008316
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008317 *'undoreload'* *'ur'*
8318'undoreload' 'ur' number (default 10000)
8319 global
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008320 Save the whole buffer for undo when reloading it. This applies to the
8321 ":e!" command and reloading for when the buffer changed outside of
8322 Vim. |FileChangedShell|
Bram Moolenaar24a98a02017-09-27 22:23:55 +02008323 The save only happens when this option is negative or when the number
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008324 of lines is smaller than the value of this option.
8325 Set this option to zero to disable undo for a reload.
8326
8327 When saving undo for a reload, any undo file is not read.
8328
8329 Note that this causes the whole buffer to be stored in memory. Set
8330 this option to a lower value if you run out of memory.
8331
Bram Moolenaar071d4272004-06-13 20:20:40 +00008332 *'updatecount'* *'uc'*
8333'updatecount' 'uc' number (default: 200)
8334 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008335 After typing this many characters the swap file will be written to
8336 disk. When zero, no swap file will be created at all (see chapter on
8337 recovery |crash-recovery|). 'updatecount' is set to zero by starting
8338 Vim with the "-n" option, see |startup|. When editing in readonly
8339 mode this option will be initialized to 10000.
8340 The swapfile can be disabled per buffer with |'swapfile'|.
8341 When 'updatecount' is set from zero to non-zero, swap files are
8342 created for all buffers that have 'swapfile' set. When 'updatecount'
8343 is set to zero, existing swap files are not deleted.
8344 Also see |'swapsync'|.
8345 This option has no meaning in buffers where |'buftype'| is "nofile"
8346 or "nowrite".
8347
8348 *'updatetime'* *'ut'*
8349'updatetime' 'ut' number (default 4000)
8350 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008351 If this many milliseconds nothing is typed the swap file will be
8352 written to disk (see |crash-recovery|). Also used for the
8353 |CursorHold| autocommand event.
8354
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008355 *'varsofttabstop'* *'vsts'*
8356'varsofttabstop' 'vsts' string (default "")
8357 local to buffer
8358 {only available when compiled with the |+vartabs|
8359 feature}
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008360 A list of the number of spaces that a <Tab> counts for while editing,
8361 such as inserting a <Tab> or using <BS>. It "feels" like variable-
8362 width <Tab>s are being inserted, while in fact a mixture of spaces
8363 and <Tab>s is used. Tab widths are separated with commas, with the
8364 final value applying to all subsequent tabs.
8365
8366 For example, when editing assembly language files where statements
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02008367 start in the 9th column and comments in the 41st, it may be useful
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008368 to use the following: >
8369 :set varsofttabstop=8,32,8
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02008370< This will set soft tabstops with 8 and 8 + 32 spaces, and 8 more
8371 for every column thereafter.
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008372
8373 Note that the value of |'softtabstop'| will be ignored while
8374 'varsofttabstop' is set.
8375
8376 *'vartabstop'* *'vts'*
8377'vartabstop' 'vts' string (default "")
8378 local to buffer
8379 {only available when compiled with the |+vartabs|
8380 feature}
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008381 A list of the number of spaces that a <Tab> in the file counts for,
8382 separated by commas. Each value corresponds to one tab, with the
8383 final value applying to all subsequent tabs. For example: >
8384 :set vartabstop=4,20,10,8
8385< This will make the first tab 4 spaces wide, the second 20 spaces,
8386 the third 10 spaces, and all following tabs 8 spaces.
8387
8388 Note that the value of |'tabstop'| will be ignored while 'vartabstop'
8389 is set.
8390
Bram Moolenaar071d4272004-06-13 20:20:40 +00008391 *'verbose'* *'vbs'*
8392'verbose' 'vbs' number (default 0)
8393 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008394 When bigger than zero, Vim will give messages about what it is doing.
8395 Currently, these messages are given:
8396 >= 1 When the viminfo file is read or written.
8397 >= 2 When a file is ":source"'ed.
Bram Moolenaar647a5302020-05-03 17:01:24 +02008398 >= 4 Shell commands.
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008399 >= 5 Every searched tags file and include file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008400 >= 8 Files for which a group of autocommands is executed.
8401 >= 9 Every executed autocommand.
Bram Moolenaar647a5302020-05-03 17:01:24 +02008402 >= 11 Finding items in a path
Bram Moolenaar071d4272004-06-13 20:20:40 +00008403 >= 12 Every executed function.
8404 >= 13 When an exception is thrown, caught, finished, or discarded.
8405 >= 14 Anything pending in a ":finally" clause.
Bram Moolenaar823654b2020-05-29 23:03:09 +02008406 >= 15 Every executed Ex command from a script (truncated at 200
8407 characters).
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02008408 >= 16 Every executed Ex command.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008409
8410 This option can also be set with the "-V" argument. See |-V|.
8411 This option is also set by the |:verbose| command.
8412
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008413 When the 'verbosefile' option is set then the verbose messages are not
8414 displayed.
8415
8416 *'verbosefile'* *'vfile'*
8417'verbosefile' 'vfile' string (default empty)
8418 global
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008419 When not empty all messages are written in a file with this name.
8420 When the file exists messages are appended.
8421 Writing to the file ends when Vim exits or when 'verbosefile' is made
Bram Moolenaar80794b12010-06-13 05:20:42 +02008422 empty. Writes are buffered, thus may not show up for some time.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008423 Setting 'verbosefile' to a new value is like making it empty first.
8424 The difference with |:redir| is that verbose messages are not
8425 displayed when 'verbosefile' is set.
8426
Bram Moolenaar071d4272004-06-13 20:20:40 +00008427 *'viewdir'* *'vdir'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008428'viewdir' 'vdir' string (default for Amiga and Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008429 "$VIM/vimfiles/view",
8430 for Unix: "~/.vim/view",
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02008431 for macOS: "$VIM:vimfiles:view"
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01008432 for VMS: "sys$login:vimfiles/view")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008433 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008434 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008435 feature}
8436 Name of the directory where to store files for |:mkview|.
8437 This option cannot be set from a |modeline| or in the |sandbox|, for
8438 security reasons.
8439
8440 *'viewoptions'* *'vop'*
Bram Moolenaar13e90412017-11-11 18:16:48 +01008441'viewoptions' 'vop' string (default: "folds,options,cursor,curdir")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008442 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008443 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008444 feature}
8445 Changes the effect of the |:mkview| command. It is a comma separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008446 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008447 word save and restore ~
8448 cursor cursor position in file and in window
8449 folds manually created folds, opened/closed folds and local
8450 fold options
8451 options options and mappings local to a window or buffer (not
8452 global values for local options)
Bram Moolenaar6e932462014-09-09 18:48:09 +02008453 localoptions same as "options"
Bram Moolenaar071d4272004-06-13 20:20:40 +00008454 slash backslashes in file names replaced with forward
8455 slashes
8456 unix with Unix end-of-line format (single <NL>), even when
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008457 on MS-Windows
Bram Moolenaar13e90412017-11-11 18:16:48 +01008458 curdir the window-local directory, if set with `:lcd`
Bram Moolenaar071d4272004-06-13 20:20:40 +00008459
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008460 "slash" and "unix" are useful on MS-Windows when sharing view files
Bram Moolenaar071d4272004-06-13 20:20:40 +00008461 with Unix. The Unix version of Vim cannot source dos format scripts,
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008462 but the MS-Windows version of Vim can source unix format scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008463
8464 *'viminfo'* *'vi'* *E526* *E527* *E528*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008465'viminfo' 'vi' string (Vi default: "", Vim default for
8466 MS-Windows: '100,<50,s10,h,rA:,rB:,
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01008467 for Amiga: '100,<50,s10,h,rdf0:,rdf1:,rdf2:
8468 for others: '100,<50,s10,h)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008469 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008470 {not available when compiled without the |+viminfo|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008471 feature}
8472 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008473 when exiting Vim (see |viminfo-file|). Except when 'viminfofile' is
8474 "NONE".
8475 The string should be a comma separated list of parameters, each
8476 consisting of a single character identifying the particular parameter,
8477 followed by a number or string which specifies the value of that
8478 parameter. If a particular character is left out, then the default
8479 value is used for that parameter. The following is a list of the
8480 identifying characters and the effect of their value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008481 CHAR VALUE ~
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008482 *viminfo-!*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008483 ! When included, save and restore global variables that start
8484 with an uppercase letter, and don't contain a lowercase
8485 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar680eeca2010-10-20 17:44:42 +02008486 and "_K_L_M" are not. Nested List and Dict items may not be
Bram Moolenaar166af9b2010-11-16 20:34:40 +01008487 read back correctly, you end up with an empty item.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008488 *viminfo-quote*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008489 " Maximum number of lines saved for each register. Old name of
8490 the '<' item, with the disadvantage that you need to put a
8491 backslash before the ", otherwise it will be recognized as the
8492 start of a comment!
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008493 *viminfo-%*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008494 % When included, save and restore the buffer list. If Vim is
8495 started with a file name argument, the buffer list is not
8496 restored. If Vim is started without a file name argument, the
Bram Moolenaard042dc82015-11-24 19:18:36 +01008497 buffer list is restored from the viminfo file. Quickfix
8498 ('buftype'), unlisted ('buflisted'), unnamed and buffers on
8499 removable media (|viminfo-r|) are not saved.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00008500 When followed by a number, the number specifies the maximum
8501 number of buffers that are stored. Without a number all
8502 buffers are stored.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008503 *viminfo-'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008504 ' Maximum number of previously edited files for which the marks
8505 are remembered. This parameter must always be included when
8506 'viminfo' is non-empty.
8507 Including this item also means that the |jumplist| and the
8508 |changelist| are stored in the viminfo file.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008509 *viminfo-/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008510 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008511 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00008512 patterns are also saved. When not included, the value of
8513 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008514 *viminfo-:*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008515 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008516 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008517 *viminfo-<*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008518 < Maximum number of lines saved for each register. If zero then
8519 registers are not saved. When not included, all lines are
8520 saved. '"' is the old name for this item.
8521 Also see the 's' item below: limit specified in Kbyte.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008522 *viminfo-@*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008523 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008524 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008525 *viminfo-c*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008526 c When included, convert the text in the viminfo file from the
8527 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00008528 'encoding'. See |viminfo-encoding|.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008529 *viminfo-f*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008530 f Whether file marks need to be stored. If zero, file marks ('0
8531 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008532 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00008533 cursor position (when exiting or when doing ":wviminfo").
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008534 *viminfo-h*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008535 h Disable the effect of 'hlsearch' when loading the viminfo
8536 file. When not included, it depends on whether ":nohlsearch"
8537 has been used since the last search command.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008538 *viminfo-n*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008539 n Name of the viminfo file. The name must immediately follow
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008540 the 'n'. Must be at the end of the option! If the
8541 'viminfofile' option is set, that file name overrides the one
8542 given here with 'viminfo'. Environment variables are
Bram Moolenaar063b9d12016-07-09 20:21:48 +02008543 expanded when opening the file, not when setting the option.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008544 *viminfo-r*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008545 r Removable media. The argument is a string (up to the next
8546 ','). This parameter can be given several times. Each
8547 specifies the start of a path for which no marks will be
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01008548 stored. This is to avoid removable media. For MS-Windows you
Bram Moolenaar071d4272004-06-13 20:20:40 +00008549 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
8550 also use it for temp files, e.g., for Unix: "r/tmp". Case is
8551 ignored. Maximum length of each 'r' argument is 50
8552 characters.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008553 *viminfo-s*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008554 s Maximum size of an item in Kbyte. If zero then registers are
8555 not saved. Currently only applies to registers. The default
8556 "s10" will exclude registers with more than 10 Kbyte of text.
8557 Also see the '<' item above: line count limit.
8558
8559 Example: >
8560 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
8561<
8562 '50 Marks will be remembered for the last 50 files you
8563 edited.
8564 <1000 Contents of registers (up to 1000 lines each) will be
8565 remembered.
8566 s100 Registers with more than 100 Kbyte text are skipped.
8567 :0 Command-line history will not be saved.
8568 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
8569 no / Since '/' is not specified, the default will be used,
8570 that is, save all of the search history, and also the
8571 previous search and substitute patterns.
8572 no % The buffer list will not be saved nor read back.
8573 no h 'hlsearch' highlighting will be restored.
8574
8575 When setting 'viminfo' from an empty value you can use |:rviminfo| to
8576 load the contents of the file, this is not done automatically.
8577
8578 This option cannot be set from a |modeline| or in the |sandbox|, for
8579 security reasons.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008580 NOTE: This option is set to the Vim default value when 'compatible'
8581 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008582
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008583 *'viminfofile'* *'vif'*
8584'viminfofile' 'vif' string (default: "")
8585 global
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008586 {not available when compiled without the |+viminfo|
8587 feature}
8588 When non-empty, overrides the file name used for viminfo.
8589 When equal to "NONE" no viminfo file will be read or written.
8590 This option can be set with the |-i| command line flag. The |--clean|
8591 command line flag sets it to "NONE".
Bram Moolenaar110289e2019-05-23 15:38:06 +02008592 This option cannot be set from a |modeline| or in the |sandbox|, for
8593 security reasons.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008594
Bram Moolenaar071d4272004-06-13 20:20:40 +00008595 *'virtualedit'* *'ve'*
8596'virtualedit' 've' string (default "")
8597 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008598 A comma separated list of these words:
8599 block Allow virtual editing in Visual block mode.
8600 insert Allow virtual editing in Insert mode.
8601 all Allow virtual editing in all modes.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008602 onemore Allow the cursor to move just past the end of the line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008603
Bram Moolenaar071d4272004-06-13 20:20:40 +00008604 Virtual editing means that the cursor can be positioned where there is
Bram Moolenaarebcbd022007-05-12 14:28:25 +00008605 no actual character. This can be halfway into a tab or beyond the end
Bram Moolenaar071d4272004-06-13 20:20:40 +00008606 of the line. Useful for selecting a rectangle in Visual mode and
8607 editing a table.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008608 "onemore" is not the same, it will only allow moving the cursor just
8609 after the last character of the line. This makes some commands more
8610 consistent. Previously the cursor was always past the end of the line
8611 if the line was empty. But it is far from Vi compatible. It may also
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008612 break some plugins or Vim scripts. For example because |l| can move
8613 the cursor after the last character. Use with care!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02008614 Using the `$` command will move to the last character in the line, not
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008615 past it. This may actually move the cursor to the left!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02008616 The `g$` command will move to the end of the screen line.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008617 It doesn't make sense to combine "all" with "onemore", but you will
8618 not get a warning for it.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008619 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008620
8621 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
8622'visualbell' 'vb' boolean (default off)
8623 global
Bram Moolenaar74675a62017-07-15 13:53:23 +02008624 Use a visual bell instead of beeping. The terminal code to display the
Bram Moolenaar071d4272004-06-13 20:20:40 +00008625 visual bell is given with 't_vb'. When no beep or flash is wanted,
Bram Moolenaar74675a62017-07-15 13:53:23 +02008626 use: >
8627 :set vb t_vb=
8628< If you want a short flash, you can use this on many terminals: >
8629 :set vb t_vb=[?5h$<100>[?5l
8630< Here $<100> specifies the time, you can use a smaller or bigger value
8631 to get a shorter or longer flash.
8632
8633 Note: Vim will limit the bell to once per half a second. This avoids
8634 having to wait for the flashing to finish when there are lots of
8635 bells, e.g. on key repeat. This also happens without 'visualbell'
8636 set.
8637
Bram Moolenaar071d4272004-06-13 20:20:40 +00008638 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
8639 for 20 msec. If you want to use a different time, use "<Esc>|40f",
8640 where 40 is the time in msec.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008641
8642 Note: When the GUI starts, 't_vb' is reset to its default value. You
8643 might want to set it again in your |gvimrc|.
8644
Bram Moolenaar071d4272004-06-13 20:20:40 +00008645 Does not work on the Amiga, you always get a screen flash.
8646 Also see 'errorbells'.
8647
8648 *'warn'* *'nowarn'*
8649'warn' boolean (default on)
8650 global
8651 Give a warning message when a shell command is used while the buffer
8652 has been changed.
8653
8654 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
8655'weirdinvert' 'wiv' boolean (default off)
8656 global
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00008657 This option has the same effect as the 't_xs' terminal option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008658 It is provided for backwards compatibility with version 4.x.
8659 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
8660 vice versa. Has no effect when the GUI is running.
8661
8662 *'whichwrap'* *'ww'*
8663'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
8664 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008665 Allow specified keys that move the cursor left/right to move to the
8666 previous/next line when the cursor is on the first/last character in
8667 the line. Concatenate characters to allow this for these keys:
8668 char key mode ~
8669 b <BS> Normal and Visual
8670 s <Space> Normal and Visual
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008671 h "h" Normal and Visual (not recommended)
8672 l "l" Normal and Visual (not recommended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008673 < <Left> Normal and Visual
8674 > <Right> Normal and Visual
8675 ~ "~" Normal
8676 [ <Left> Insert and Replace
8677 ] <Right> Insert and Replace
8678 For example: >
8679 :set ww=<,>,[,]
8680< allows wrap only when cursor keys are used.
8681 When the movement keys are used in combination with a delete or change
8682 operator, the <EOL> also counts for a character. This makes "3h"
8683 different from "3dh" when the cursor crosses the end of a line. This
8684 is also true for "x" and "X", because they do the same as "dl" and
8685 "dh". If you use this, you may also want to use the mapping
8686 ":map <BS> X" to make backspace delete the character in front of the
8687 cursor.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00008688 When 'l' is included and it is used after an operator at the end of a
Bram Moolenaar589edb32019-09-20 14:38:13 +02008689 line (not an empty line) then it will not move to the next line. This
8690 makes "dl", "cl", "yl" etc. work normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008691 NOTE: This option is set to the Vi default value when 'compatible' is
8692 set and to the Vim default value when 'compatible' is reset.
8693
8694 *'wildchar'* *'wc'*
8695'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
8696 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008697 Character you have to type to start wildcard expansion in the
8698 command-line, as specified with 'wildmode'.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008699 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008700 The character is not recognized when used inside a macro. See
8701 'wildcharm' for that.
8702 Although 'wc' is a number option, you can set it to a special key: >
8703 :set wc=<Esc>
8704< NOTE: This option is set to the Vi default value when 'compatible' is
8705 set and to the Vim default value when 'compatible' is reset.
8706
8707 *'wildcharm'* *'wcm'*
8708'wildcharm' 'wcm' number (default: none (0))
8709 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008710 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00008711 recognized when used inside a macro. You can find "spare" command-line
8712 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00008713 you'll never actually type 'wildcharm', just use it in mappings that
8714 automatically invoke completion mode, e.g.: >
8715 :set wcm=<C-Z>
Bram Moolenaar446cb832008-06-24 21:56:24 +00008716 :cnoremap ss so $vim/sessions/*.vim<C-Z>
Bram Moolenaar071d4272004-06-13 20:20:40 +00008717< Then after typing :ss you can use CTRL-P & CTRL-N.
8718
8719 *'wildignore'* *'wig'*
8720'wildignore' 'wig' string (default "")
8721 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008722 {not available when compiled without the |+wildignore|
8723 feature}
8724 A list of file patterns. A file that matches with one of these
Bram Moolenaar30b65812012-07-12 22:01:11 +02008725 patterns is ignored when expanding |wildcards|, completing file or
8726 directory names, and influences the result of |expand()|, |glob()| and
8727 |globpath()| unless a flag is passed to disable this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008728 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
8729 Also see 'suffixes'.
8730 Example: >
8731 :set wildignore=*.o,*.obj
8732< The use of |:set+=| and |:set-=| is preferred when adding or removing
8733 a pattern from the list. This avoids problems when a future version
8734 uses another default.
8735
Bram Moolenaar94950a92010-12-02 16:01:29 +01008736
Bram Moolenaar81af9252010-12-10 20:35:50 +01008737 *'wildignorecase'* *'wic'* *'nowildignorecase'* *'nowic'*
Bram Moolenaar94950a92010-12-02 16:01:29 +01008738'wildignorecase' 'wic' boolean (default off)
8739 global
Bram Moolenaar94950a92010-12-02 16:01:29 +01008740 When set case is ignored when completing file names and directories.
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01008741 Has no effect when 'fileignorecase' is set.
Bram Moolenaar94950a92010-12-02 16:01:29 +01008742 Does not apply when the shell is used to expand wildcards, which
8743 happens when there are special characters.
8744
8745
Bram Moolenaar071d4272004-06-13 20:20:40 +00008746 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02008747'wildmenu' 'wmnu' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008748 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008749 {not available if compiled without the |+wildmenu|
8750 feature}
8751 When 'wildmenu' is on, command-line completion operates in an enhanced
8752 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
8753 the possible matches are shown just above the command line, with the
8754 first match highlighted (overwriting the status line, if there is
8755 one). Keys that show the previous/next match, such as <Tab> or
8756 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
8757 When 'wildmode' is used, "wildmenu" mode is used where "full" is
8758 specified. "longest" and "list" do not start "wildmenu" mode.
Bram Moolenaar26402cb2013-02-20 21:26:00 +01008759 You can check the current mode with |wildmenumode()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008760 If there are more matches than can fit in the line, a ">" is shown on
8761 the right and/or a "<" is shown on the left. The status line scrolls
8762 as needed.
8763 The "wildmenu" mode is abandoned when a key is hit that is not used
8764 for selecting a completion.
8765 While the "wildmenu" is active the following keys have special
8766 meanings:
8767
8768 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
8769 <Down> - in filename/menu name completion: move into a
8770 subdirectory or submenu.
8771 <CR> - in menu completion, when the cursor is just after a
8772 dot: move into a submenu.
8773 <Up> - in filename/menu name completion: move up into
8774 parent directory or parent menu.
8775
8776 This makes the menus accessible from the console |console-menus|.
8777
8778 If you prefer the <Left> and <Right> keys to move the cursor instead
8779 of selecting a different match, use this: >
8780 :cnoremap <Left> <Space><BS><Left>
8781 :cnoremap <Right> <Space><BS><Right>
8782<
8783 The "WildMenu" highlighting is used for displaying the current match
8784 |hl-WildMenu|.
8785
8786 *'wildmode'* *'wim'*
8787'wildmode' 'wim' string (Vim default: "full")
8788 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008789 Completion mode that is used for the character specified with
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008790 'wildchar'. It is a comma separated list of up to four parts. Each
Bram Moolenaar02467872007-05-06 13:22:01 +00008791 part specifies what to do for each consecutive use of 'wildchar'. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00008792 first part specifies the behavior for the first use of 'wildchar',
8793 The second part for the second use, etc.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02008794
8795 Each part consists of a colon separated list consisting of the
8796 following possible values:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008797 "" Complete only the first match.
8798 "full" Complete the next full match. After the last match,
8799 the original string is used and then the first match
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02008800 again. Will also start 'wildmenu' if it is enabled.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008801 "longest" Complete till longest common string. If this doesn't
8802 result in a longer string, use the next part.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008803 "list" When more than one match, list all matches.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02008804 "lastused" When completing buffer names and more than one buffer
8805 matches, sort buffers by time last used (other than
8806 the current buffer).
8807 When there is only a single match, it is fully completed in all cases.
8808
8809 Examples of useful colon-separated values:
8810 "longest:full" Like "longest", but also start 'wildmenu' if it is
8811 enabled. Will not complete to the next full match.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008812 "list:full" When more than one match, list all matches and
8813 complete first match.
8814 "list:longest" When more than one match, list all matches and
8815 complete till longest common string.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02008816 "list:lastused" When more than one buffer matches, list all matches
8817 and sort buffers by time last used (other than the
8818 current buffer).
Bram Moolenaar071d4272004-06-13 20:20:40 +00008819
8820 Examples: >
8821 :set wildmode=full
Bram Moolenaar582fd852005-03-28 20:58:01 +00008822< Complete first full match, next match, etc. (the default) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008823 :set wildmode=longest,full
8824< Complete longest common string, then each full match >
8825 :set wildmode=list:full
8826< List all matches and complete each full match >
8827 :set wildmode=list,full
8828< List all matches without completing, then each full match >
8829 :set wildmode=longest,list
8830< Complete longest common string, then list alternatives.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008831 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008832
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00008833 *'wildoptions'* *'wop'*
8834'wildoptions' 'wop' string (default "")
8835 global
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00008836 {not available when compiled without the |+wildignore|
8837 feature}
8838 A list of words that change how command line completion is done.
8839 Currently only one word is allowed:
8840 tagfile When using CTRL-D to list matching tags, the kind of
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00008841 tag and the file of the tag is listed. Only one match
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00008842 is displayed per line. Often used tag kinds are:
8843 d #define
8844 f function
8845 Also see |cmdline-completion|.
8846
Bram Moolenaar071d4272004-06-13 20:20:40 +00008847 *'winaltkeys'* *'wak'*
8848'winaltkeys' 'wak' string (default "menu")
8849 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008850 {only used in Win32, Motif, GTK and Photon GUI}
8851 Some GUI versions allow the access to menu entries by using the ALT
8852 key in combination with a character that appears underlined in the
8853 menu. This conflicts with the use of the ALT key for mappings and
8854 entering special characters. This option tells what to do:
8855 no Don't use ALT keys for menus. ALT key combinations can be
8856 mapped, but there is no automatic handling. This can then be
8857 done with the |:simalt| command.
8858 yes ALT key handling is done by the windowing system. ALT key
8859 combinations cannot be mapped.
8860 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008861 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00008862 keys can be mapped.
8863 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
8864 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00008865 This option is not used for <F10>; on Win32 and with GTK <F10> will
8866 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008867
Bram Moolenaar4d784b22019-05-25 19:51:39 +02008868 *'wincolor'* *'wcr'*
8869'wincolor' 'wcr' string (default empty)
8870 local to window
8871 Highlight group name to use for this window instead of the Normal
8872 color |hl-Normal|.
8873
Bram Moolenaar4399ef42005-02-12 14:29:27 +00008874 *'window'* *'wi'*
8875'window' 'wi' number (default screen height - 1)
8876 global
Bram Moolenaardad44732021-03-31 20:07:33 +02008877 Window height used for |CTRL-F| and |CTRL-B| when there is only one
8878 window and the value is smaller than 'lines' minus one. The screen
8879 will scroll 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00008880 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
8881 in a much smarter way, taking care of wrapping lines.
8882 When resizing the Vim window, the value is smaller than 1 or more than
8883 or equal to 'lines' it will be set to 'lines' minus 1.
Bram Moolenaardad44732021-03-31 20:07:33 +02008884 Note: Do not confuse this with the height of the Vim window, use
8885 'lines' for that.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00008886
Bram Moolenaar071d4272004-06-13 20:20:40 +00008887 *'winheight'* *'wh'* *E591*
8888'winheight' 'wh' number (default 1)
8889 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008890 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008891 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar446cb832008-06-24 21:56:24 +00008892 focus goes to a window that is smaller, its size is increased, at the
8893 cost of the height of other windows.
8894 Set 'winheight' to a small number for normal editing.
8895 Set it to 999 to make the current window fill most of the screen.
8896 Other windows will be only 'winminheight' high. This has the drawback
8897 that ":all" will create only two windows. To avoid "vim -o 1 2 3 4"
8898 to create only two windows, set the option after startup is done,
8899 using the |VimEnter| event: >
8900 au VimEnter * set winheight=999
8901< Minimum value is 1.
8902 The height is not adjusted after one of the commands that change the
Bram Moolenaar071d4272004-06-13 20:20:40 +00008903 height of the current window.
8904 'winheight' applies to the current window. Use 'winminheight' to set
8905 the minimal height for other windows.
8906
8907 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
8908'winfixheight' 'wfh' boolean (default off)
8909 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00008910 Keep the window height when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00008911 'equalalways' is set. Also for |CTRL-W_=|. Set by default for the
8912 |preview-window| and |quickfix-window|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008913 The height may be changed anyway when running out of room.
8914
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008915 *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'*
8916'winfixwidth' 'wfw' boolean (default off)
8917 local to window
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008918 Keep the window width when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00008919 'equalalways' is set. Also for |CTRL-W_=|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008920 The width may be changed anyway when running out of room.
8921
Bram Moolenaar071d4272004-06-13 20:20:40 +00008922 *'winminheight'* *'wmh'*
8923'winminheight' 'wmh' number (default 1)
8924 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008925 The minimal height of a window, when it's not the current window.
8926 This is a hard minimum, windows will never become smaller.
8927 When set to zero, windows may be "squashed" to zero lines (i.e. just a
8928 status bar) if necessary. They will return to at least one line when
8929 they become active (since the cursor has to have somewhere to go.)
8930 Use 'winheight' to set the minimal height of the current window.
8931 This option is only checked when making a window smaller. Don't use a
8932 large number, it will cause errors when opening more than a few
8933 windows. A value of 0 to 3 is reasonable.
8934
8935 *'winminwidth'* *'wmw'*
8936'winminwidth' 'wmw' number (default 1)
8937 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008938 The minimal width of a window, when it's not the current window.
8939 This is a hard minimum, windows will never become smaller.
8940 When set to zero, windows may be "squashed" to zero columns (i.e. just
8941 a vertical separator) if necessary. They will return to at least one
8942 line when they become active (since the cursor has to have somewhere
8943 to go.)
8944 Use 'winwidth' to set the minimal width of the current window.
8945 This option is only checked when making a window smaller. Don't use a
8946 large number, it will cause errors when opening more than a few
8947 windows. A value of 0 to 12 is reasonable.
8948
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02008949 *'winptydll'*
8950'winptydll' string (default "winpty32.dll" or "winpty64.dll")
8951 global
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02008952 {only available when compiled with the |terminal|
8953 feature on MS-Windows}
8954 Specifies the name of the winpty shared library, used for the
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02008955 |:terminal| command. The default depends on whether Vim was built as a
Bram Moolenaarc572da52017-08-27 16:52:01 +02008956 32-bit or 64-bit executable. If not found, "winpty.dll" is tried as
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02008957 a fallback.
8958 Environment variables are expanded |:set_env|.
8959 This option cannot be set from a |modeline| or in the |sandbox|, for
8960 security reasons.
8961
Bram Moolenaar071d4272004-06-13 20:20:40 +00008962 *'winwidth'* *'wiw'* *E592*
8963'winwidth' 'wiw' number (default 20)
8964 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008965 Minimal number of columns for the current window. This is not a hard
8966 minimum, Vim will use fewer columns if there is not enough room. If
8967 the current window is smaller, its size is increased, at the cost of
8968 the width of other windows. Set it to 999 to make the current window
8969 always fill the screen. Set it to a small number for normal editing.
8970 The width is not adjusted after one of the commands to change the
8971 width of the current window.
8972 'winwidth' applies to the current window. Use 'winminwidth' to set
8973 the minimal width for other windows.
8974
8975 *'wrap'* *'nowrap'*
8976'wrap' boolean (default on)
8977 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00008978 This option changes how text is displayed. It doesn't change the text
8979 in the buffer, see 'textwidth' for that.
8980 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008981 displaying continues on the next line. When off lines will not wrap
8982 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00008983 moved to a part that is not shown, the screen will scroll
8984 horizontally.
8985 The line will be broken in the middle of a word if necessary. See
8986 'linebreak' to get the break at a word boundary.
8987 To make scrolling horizontally a bit more useful, try this: >
8988 :set sidescroll=5
8989 :set listchars+=precedes:<,extends:>
8990< See 'sidescroll', 'listchars' and |wrap-off|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01008991 This option can't be set from a |modeline| when the 'diff' option is
8992 on.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008993
8994 *'wrapmargin'* *'wm'*
8995'wrapmargin' 'wm' number (default 0)
8996 local to buffer
8997 Number of characters from the right window border where wrapping
8998 starts. When typing text beyond this limit, an <EOL> will be inserted
8999 and inserting continues on the next line.
9000 Options that add a margin, such as 'number' and 'foldcolumn', cause
9001 the text width to be further reduced. This is Vi compatible.
9002 When 'textwidth' is non-zero, this option is not used.
Bram Moolenaarca635012015-09-25 20:34:21 +02009003 This option is set to 0 when 'paste' is set and restored when 'paste'
9004 is reset.
Bram Moolenaara6c27c42019-05-09 19:16:22 +02009005 See also 'formatoptions' and |ins-textwidth|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009006
9007 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
9008'wrapscan' 'ws' boolean (default on) *E384* *E385*
9009 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00009010 Searches wrap around the end of the file. Also applies to |]s| and
9011 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009012
9013 *'write'* *'nowrite'*
9014'write' boolean (default on)
9015 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009016 Allows writing files. When not set, writing a file is not allowed.
9017 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009018 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00009019 argument. Filtering text is still possible, even though this requires
9020 writing a temporary file.
9021
9022 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
9023'writeany' 'wa' boolean (default off)
9024 global
9025 Allows writing to any file with no need for "!" override.
9026
9027 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
9028'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
9029 otherwise)
9030 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009031 Make a backup before overwriting a file. The backup is removed after
9032 the file was successfully written, unless the 'backup' option is
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02009033 also on.
9034 WARNING: Switching this option off means that when Vim fails to write
9035 your buffer correctly and then, for whatever reason, Vim exits, you
9036 lose both the original file and what you were writing. Only reset
9037 this option if your file system is almost full and it makes the write
9038 fail (and make sure not to exit Vim until the write was successful).
9039 See |backup-table| for another explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009040 When the 'backupskip' pattern matches, a backup is not made anyway.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01009041 Depending on 'backupcopy' the backup is a new file or the original
9042 file renamed (and a new file is written).
Bram Moolenaar071d4272004-06-13 20:20:40 +00009043 NOTE: This option is set to the default value when 'compatible' is
9044 set.
9045
9046 *'writedelay'* *'wd'*
9047'writedelay' 'wd' number (default 0)
9048 global
Bram Moolenaar802a0d92016-06-26 16:17:58 +02009049 The number of milliseconds to wait for each character sent to the
Bram Moolenaar071d4272004-06-13 20:20:40 +00009050 screen. When non-zero, characters are sent to the terminal one by
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01009051 one. For debugging purposes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009052
Bram Moolenaar91f84f62018-07-29 15:07:52 +02009053 vim:tw=78:ts=8:noet:ft=help:norl: