blob: aaac094884e66cccabf975a032d92d1edde985d4 [file] [log] [blame]
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02001*options.txt* For Vim version 8.2. Last change: 2021 Jun 20
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.
Christian Brabandt4a0b85a2021-07-14 20:00:27 +02001329 list:{n} Adds an additional indent for lines that match a
1330 numbered or bulleted list (using the
1331 'formatlistpat' setting).
1332 The default value for min is 20, shift and list is 0.
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001333
Bram Moolenaar071d4272004-06-13 20:20:40 +00001334 *'browsedir'* *'bsdir'*
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001335'browsedir' 'bsdir' string (default: "last")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001336 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02001337 {only for Motif, Athena, GTK, Mac and Win32 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001338 Which directory to use for the file browser:
Bram Moolenaar446cb832008-06-24 21:56:24 +00001339 last Use same directory as with last file browser, where a
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02001340 file was opened or saved.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001341 buffer Use the directory of the related buffer.
1342 current Use the current directory.
1343 {path} Use the specified directory
1344
1345 *'bufhidden'* *'bh'*
1346'bufhidden' 'bh' string (default: "")
1347 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001348 This option specifies what happens when a buffer is no longer
1349 displayed in a window:
1350 <empty> follow the global 'hidden' option
1351 hide hide the buffer (don't unload it), also when 'hidden'
1352 is not set
1353 unload unload the buffer, also when 'hidden' is set or using
1354 |:hide|
1355 delete delete the buffer from the buffer list, also when
1356 'hidden' is set or using |:hide|, like using
1357 |:bdelete|
1358 wipe wipe out the buffer from the buffer list, also when
1359 'hidden' is set or using |:hide|, like using
1360 |:bwipeout|
1361
Bram Moolenaara14de3d2005-01-07 21:48:26 +00001362 CAREFUL: when "unload", "delete" or "wipe" is used changes in a buffer
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01001363 are lost without a warning. Also, these values may break autocommands
1364 that switch between buffers temporarily.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001365 This option is used together with 'buftype' and 'swapfile' to specify
1366 special kinds of buffers. See |special-buffers|.
1367
1368 *'buflisted'* *'bl'* *'nobuflisted'* *'nobl'* *E85*
1369'buflisted' 'bl' boolean (default: on)
1370 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001371 When this option is set, the buffer shows up in the buffer list. If
1372 it is reset it is not used for ":bnext", "ls", the Buffers menu, etc.
1373 This option is reset by Vim for buffers that are only used to remember
1374 a file name or marks. Vim sets it when starting to edit a buffer.
1375 But not when moving to a buffer with ":buffer".
1376
1377 *'buftype'* *'bt'* *E382*
1378'buftype' 'bt' string (default: "")
1379 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001380 The value of this option specifies the type of a buffer:
1381 <empty> normal buffer
1382 nofile buffer which is not related to a file and will not be
1383 written
1384 nowrite buffer which will not be written
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001385 acwrite buffer which will always be written with BufWriteCmd
Bram Moolenaarb5b75622018-03-09 22:22:21 +01001386 autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001387 quickfix quickfix buffer, contains list of errors |:cwindow|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001388 or list of locations |:lwindow|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001389 help help buffer (you are not supposed to set this
1390 manually)
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02001391 terminal buffer for a |terminal| (you are not supposed to set
1392 this manually)
Bram Moolenaarf2732452018-06-03 14:47:35 +02001393 prompt buffer where only the last line can be edited, meant
1394 to be used by a plugin, see |prompt-buffer|
1395 {only when compiled with the |+channel| feature}
Bram Moolenaar4d784b22019-05-25 19:51:39 +02001396 popup buffer used in a popup window, see |popup|.
1397 {only when compiled with the |+textprop| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001398
1399 This option is used together with 'bufhidden' and 'swapfile' to
1400 specify special kinds of buffers. See |special-buffers|.
Bram Moolenaarebdf3c92020-02-15 21:41:42 +01001401 Also see |win_gettype()|, which returns the type of the window.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001402
1403 Be careful with changing this option, it can have many side effects!
1404
Bram Moolenaar280f1262006-01-30 00:14:18 +00001405 A "quickfix" buffer is only used for the error list and the location
1406 list. This value is set by the |:cwindow| and |:lwindow| commands and
1407 you are not supposed to change it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001408
1409 "nofile" and "nowrite" buffers are similar:
1410 both: The buffer is not to be written to disk, ":w" doesn't
1411 work (":w filename" does work though).
1412 both: The buffer is never considered to be |'modified'|.
1413 There is no warning when the changes will be lost, for
1414 example when you quit Vim.
1415 both: A swap file is only created when using too much memory
1416 (when 'swapfile' has been reset there is never a swap
1417 file).
1418 nofile only: The buffer name is fixed, it is not handled like a
1419 file name. It is not modified in response to a |:cd|
1420 command.
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01001421 both: When using ":e bufname" and already editing "bufname"
1422 the buffer is made empty and autocommands are
1423 triggered as usual for |:edit|.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001424 *E676*
1425 "acwrite" implies that the buffer name is not related to a file, like
1426 "nofile", but it will be written. Thus, in contrast to "nofile" and
1427 "nowrite", ":w" does work and a modified buffer can't be abandoned
1428 without saving. For writing there must be matching |BufWriteCmd|,
1429 |FileWriteCmd| or |FileAppendCmd| autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001430
1431 *'casemap'* *'cmp'*
1432'casemap' 'cmp' string (default: "internal,keepascii")
1433 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001434 Specifies details about changing the case of letters. It may contain
1435 these words, separated by a comma:
1436 internal Use internal case mapping functions, the current
1437 locale does not change the case mapping. This only
Bram Moolenaar6f16eb82005-08-23 21:02:42 +00001438 matters when 'encoding' is a Unicode encoding,
1439 "latin1" or "iso-8859-15". When "internal" is
1440 omitted, the towupper() and towlower() system library
1441 functions are used when available.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001442 keepascii For the ASCII characters (0x00 to 0x7f) use the US
1443 case mapping, the current locale is not effective.
1444 This probably only matters for Turkish.
1445
1446 *'cdpath'* *'cd'* *E344* *E346*
1447'cdpath' 'cd' string (default: equivalent to $CDPATH or ",,")
1448 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001449 {not available when compiled without the
1450 |+file_in_path| feature}
1451 This is a list of directories which will be searched when using the
Bram Moolenaar00aa0692019-04-27 20:37:57 +02001452 |:cd|, |:tcd| and |:lcd| commands, provided that the directory being
1453 searched for has a relative path, not an absolute part starting with
1454 "/", "./" or "../", the 'cdpath' option is not used then.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001455 The 'cdpath' option's value has the same form and semantics as
1456 |'path'|. Also see |file-searching|.
1457 The default value is taken from $CDPATH, with a "," prepended to look
1458 in the current directory first.
1459 If the default value taken from $CDPATH is not what you want, include
1460 a modified version of the following command in your vimrc file to
1461 override it: >
1462 :let &cdpath = ',' . substitute(substitute($CDPATH, '[, ]', '\\\0', 'g'), ':', ',', 'g')
1463< This option cannot be set from a |modeline| or in the |sandbox|, for
1464 security reasons.
1465 (parts of 'cdpath' can be passed to the shell to expand file names).
1466
1467 *'cedit'*
1468'cedit' string (Vi default: "", Vim default: CTRL-F)
1469 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001470 The key used in Command-line Mode to open the command-line window.
1471 The default is CTRL-F when 'compatible' is off.
1472 Only non-printable keys are allowed.
1473 The key can be specified as a single character, but it is difficult to
1474 type. The preferred way is to use the <> notation. Examples: >
Bram Moolenaare18dbe82016-07-02 21:42:23 +02001475 :exe "set cedit=\<C-Y>"
1476 :exe "set cedit=\<Esc>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001477< |Nvi| also has this option, but it only uses the first character.
1478 See |cmdwin|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001479 NOTE: This option is set to the Vim default value when 'compatible'
1480 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001481
1482 *'charconvert'* *'ccv'* *E202* *E214* *E513*
1483'charconvert' 'ccv' string (default "")
1484 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01001485 {only available when compiled with the |+eval| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001486 An expression that is used for character encoding conversion. It is
1487 evaluated when a file that is to be read or has been written has a
1488 different encoding from what is desired.
1489 'charconvert' is not used when the internal iconv() function is
1490 supported and is able to do the conversion. Using iconv() is
1491 preferred, because it is much faster.
1492 'charconvert' is not used when reading stdin |--|, because there is no
1493 file to convert from. You will have to save the text in a file first.
1494 The expression must return zero or an empty string for success,
1495 non-zero for failure.
1496 The possible encoding names encountered are in 'encoding'.
1497 Additionally, names given in 'fileencodings' and 'fileencoding' are
1498 used.
1499 Conversion between "latin1", "unicode", "ucs-2", "ucs-4" and "utf-8"
1500 is done internally by Vim, 'charconvert' is not used for this.
1501 'charconvert' is also used to convert the viminfo file, if the 'c'
1502 flag is present in 'viminfo'. Also used for Unicode conversion.
1503 Example: >
1504 set charconvert=CharConvert()
1505 fun CharConvert()
1506 system("recode "
1507 \ . v:charconvert_from . ".." . v:charconvert_to
1508 \ . " <" . v:fname_in . " >" v:fname_out)
1509 return v:shell_error
1510 endfun
1511< The related Vim variables are:
1512 v:charconvert_from name of the current encoding
1513 v:charconvert_to name of the desired encoding
1514 v:fname_in name of the input file
1515 v:fname_out name of the output file
1516 Note that v:fname_in and v:fname_out will never be the same.
1517 Note that v:charconvert_from and v:charconvert_to may be different
1518 from 'encoding'. Vim internally uses UTF-8 instead of UCS-2 or UCS-4.
1519 Encryption is not done by Vim when using 'charconvert'. If you want
1520 to encrypt the file after conversion, 'charconvert' should take care
1521 of this.
1522 This option cannot be set from a |modeline| or in the |sandbox|, for
1523 security reasons.
1524
1525 *'cindent'* *'cin'* *'nocindent'* *'nocin'*
1526'cindent' 'cin' boolean (default off)
1527 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001528 {not available when compiled without the |+cindent|
1529 feature}
Bram Moolenaar446cb832008-06-24 21:56:24 +00001530 Enables automatic C program indenting. See 'cinkeys' to set the keys
Bram Moolenaar071d4272004-06-13 20:20:40 +00001531 that trigger reindenting in insert mode and 'cinoptions' to set your
1532 preferred indent style.
1533 If 'indentexpr' is not empty, it overrules 'cindent'.
1534 If 'lisp' is not on and both 'indentexpr' and 'equalprg' are empty,
1535 the "=" operator indents using this algorithm rather than calling an
1536 external program.
1537 See |C-indenting|.
1538 When you don't like the way 'cindent' works, try the 'smartindent'
1539 option or 'indentexpr'.
1540 This option is not used when 'paste' is set.
1541 NOTE: This option is reset when 'compatible' is set.
1542
1543 *'cinkeys'* *'cink'*
Bram Moolenaarce655742019-01-31 14:12:57 +01001544'cinkeys' 'cink' string (default "0{,0},0),0],:,0#,!^F,o,O,e")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001545 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001546 {not available when compiled without the |+cindent|
1547 feature}
1548 A list of keys that, when typed in Insert mode, cause reindenting of
1549 the current line. Only used if 'cindent' is on and 'indentexpr' is
1550 empty.
1551 For the format of this option see |cinkeys-format|.
1552 See |C-indenting|.
1553
1554 *'cinoptions'* *'cino'*
1555'cinoptions' 'cino' string (default "")
1556 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001557 {not available when compiled without the |+cindent|
1558 feature}
1559 The 'cinoptions' affect the way 'cindent' reindents lines in a C
1560 program. See |cinoptions-values| for the values of this option, and
1561 |C-indenting| for info on C indenting in general.
1562
1563
1564 *'cinwords'* *'cinw'*
1565'cinwords' 'cinw' string (default "if,else,while,do,for,switch")
1566 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001567 {not available when compiled without both the
1568 |+cindent| and the |+smartindent| features}
1569 These keywords start an extra indent in the next line when
1570 'smartindent' or 'cindent' is set. For 'cindent' this is only done at
1571 an appropriate place (inside {}).
1572 Note that 'ignorecase' isn't used for 'cinwords'. If case doesn't
1573 matter, include the keyword both the uppercase and lowercase:
1574 "if,If,IF".
1575
1576 *'clipboard'* *'cb'*
1577'clipboard' 'cb' string (default "autoselect,exclude:cons\|linux"
1578 for X-windows, "" otherwise)
1579 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001580 {only in GUI versions or when the |+xterm_clipboard|
1581 feature is included}
1582 This option is a list of comma separated names.
Bram Moolenaar942db232021-02-13 18:14:48 +01001583 Note: if one of the items is "exclude:", then you can't add an item
1584 after that. Therefore do append an item with += but use ^= to
1585 prepend, e.g.: >
1586 set clipboard^=unnamed
1587< These names are recognized:
Bram Moolenaar071d4272004-06-13 20:20:40 +00001588
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001589 *clipboard-unnamed*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001590 unnamed When included, Vim will use the clipboard register '*'
1591 for all yank, delete, change and put operations which
1592 would normally go to the unnamed register. When a
1593 register is explicitly specified, it will always be
1594 used regardless of whether "unnamed" is in 'clipboard'
1595 or not. The clipboard register can always be
1596 explicitly accessed using the "* notation. Also see
1597 |gui-clipboard|.
1598
Bram Moolenaar30b65812012-07-12 22:01:11 +02001599 *clipboard-unnamedplus*
Bram Moolenaar00154502013-02-13 16:15:55 +01001600 unnamedplus A variant of the "unnamed" flag which uses the
1601 clipboard register '+' (|quoteplus|) instead of
1602 register '*' for all yank, delete, change and put
1603 operations which would normally go to the unnamed
1604 register. When "unnamed" is also included to the
1605 option, yank operations (but not delete, change or
1606 put) will additionally copy the text into register
1607 '*'.
Bram Moolenaar81af9252010-12-10 20:35:50 +01001608 Only available with the |+X11| feature.
Bram Moolenaarbf9680e2010-12-02 21:43:16 +01001609 Availability can be checked with: >
1610 if has('unnamedplus')
1611<
Bram Moolenaar30b65812012-07-12 22:01:11 +02001612 *clipboard-autoselect*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001613 autoselect Works like the 'a' flag in 'guioptions': If present,
1614 then whenever Visual mode is started, or the Visual
1615 area extended, Vim tries to become the owner of the
1616 windowing system's global selection or put the
1617 selected text on the clipboard used by the selection
Bram Moolenaarba3ff532018-11-04 14:45:49 +01001618 register "*. See |'go-a'| and |quotestar| for details.
1619 When the GUI is active, the 'a' flag in 'guioptions'
1620 is used, when the GUI is not active, this "autoselect"
1621 flag is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001622 Also applies to the modeless selection.
1623
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001624 *clipboard-autoselectplus*
1625 autoselectplus Like "autoselect" but using the + register instead of
1626 the * register. Compare to the 'P' flag in
1627 'guioptions'.
1628
1629 *clipboard-autoselectml*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001630 autoselectml Like "autoselect", but for the modeless selection
1631 only. Compare to the 'A' flag in 'guioptions'.
1632
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001633 *clipboard-html*
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001634 html When the clipboard contains HTML, use this when
1635 pasting. When putting text on the clipboard, mark it
1636 as HTML. This works to copy rendered HTML from
1637 Firefox, paste it as raw HTML in Vim, select the HTML
1638 in Vim and paste it in a rich edit box in Firefox.
Bram Moolenaar20a825a2010-05-31 21:27:30 +02001639 You probably want to add this only temporarily,
1640 possibly use BufEnter autocommands.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001641 Only supported for GTK version 2 and later.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001642
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001643 *clipboard-exclude*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001644 exclude:{pattern}
1645 Defines a pattern that is matched against the name of
1646 the terminal 'term'. If there is a match, no
1647 connection will be made to the X server. This is
1648 useful in this situation:
1649 - Running Vim in a console.
1650 - $DISPLAY is set to start applications on another
1651 display.
1652 - You do not want to connect to the X server in the
1653 console, but do want this in a terminal emulator.
1654 To never connect to the X server use: >
1655 exclude:.*
1656< This has the same effect as using the |-X| argument.
1657 Note that when there is no connection to the X server
1658 the window title won't be restored and the clipboard
1659 cannot be accessed.
1660 The value of 'magic' is ignored, {pattern} is
1661 interpreted as if 'magic' was on.
1662 The rest of the option value will be used for
1663 {pattern}, this must be the last entry.
1664
1665 *'cmdheight'* *'ch'*
1666'cmdheight' 'ch' number (default 1)
1667 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001668 Number of screen lines to use for the command-line. Helps avoiding
1669 |hit-enter| prompts.
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00001670 The value of this option is stored with the tab page, so that each tab
1671 page can have a different value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001672
1673 *'cmdwinheight'* *'cwh'*
1674'cmdwinheight' 'cwh' number (default 7)
1675 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001676 Number of screen lines to use for the command-line window. |cmdwin|
1677
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001678 *'colorcolumn'* *'cc'*
1679'colorcolumn' 'cc' string (default "")
1680 local to window
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001681 {not available when compiled without the |+syntax|
1682 feature}
1683 'colorcolumn' is a comma separated list of screen columns that are
1684 highlighted with ColorColumn |hl-ColorColumn|. Useful to align
1685 text. Will make screen redrawing slower.
1686 The screen column can be an absolute number, or a number preceded with
1687 '+' or '-', which is added to or subtracted from 'textwidth'. >
1688
1689 :set cc=+1 " highlight column after 'textwidth'
1690 :set cc=+1,+2,+3 " highlight three columns after 'textwidth'
1691 :hi ColorColumn ctermbg=lightgrey guibg=lightgrey
1692<
1693 When 'textwidth' is zero then the items with '-' and '+' are not used.
1694 A maximum of 256 columns are highlighted.
1695
Bram Moolenaar071d4272004-06-13 20:20:40 +00001696 *'columns'* *'co'* *E594*
1697'columns' 'co' number (default 80 or terminal width)
1698 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001699 Number of columns of the screen. Normally this is set by the terminal
Bram Moolenaar7c626922005-02-07 22:01:03 +00001700 initialization and does not have to be set by hand. Also see
1701 |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001702 When Vim is running in the GUI or in a resizable window, setting this
1703 option will cause the window size to be changed. When you only want
1704 to use the size for the GUI, put the command in your |gvimrc| file.
1705 When you set this option and Vim is unable to change the physical
Bram Moolenaar02467872007-05-06 13:22:01 +00001706 number of columns of the display, the display may be messed up. For
1707 the GUI it is always possible and Vim limits the number of columns to
1708 what fits on the screen. You can use this command to get the widest
1709 window possible: >
1710 :set columns=9999
1711< Minimum value is 12, maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001712
1713 *'comments'* *'com'* *E524* *E525*
1714'comments' 'com' string (default
1715 "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-")
1716 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001717 A comma separated list of strings that can start a comment line. See
1718 |format-comments|. See |option-backslash| about using backslashes to
1719 insert a space.
1720
1721 *'commentstring'* *'cms'* *E537*
1722'commentstring' 'cms' string (default "/*%s*/")
1723 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001724 {not available when compiled without the |+folding|
1725 feature}
1726 A template for a comment. The "%s" in the value is replaced with the
1727 comment text. Currently only used to add markers for folding, see
1728 |fold-marker|.
1729
1730 *'compatible'* *'cp'* *'nocompatible'* *'nocp'*
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001731'compatible' 'cp' boolean (default on, off when a |vimrc| or |gvimrc|
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02001732 file is found, reset in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001733 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001734 This option has the effect of making Vim either more Vi-compatible, or
1735 make Vim behave in a more useful way.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001736
Bram Moolenaar071d4272004-06-13 20:20:40 +00001737 This is a special kind of option, because when it's set or reset,
Bram Moolenaar214641f2017-03-05 17:04:09 +01001738 other options are also changed as a side effect.
1739 NOTE: Setting or resetting this option can have a lot of unexpected
1740 effects: Mappings are interpreted in another way, undo behaves
1741 differently, etc. If you set this option in your vimrc file, you
1742 should probably put it at the very start.
1743
Bram Moolenaar071d4272004-06-13 20:20:40 +00001744 By default this option is on and the Vi defaults are used for the
1745 options. This default was chosen for those people who want to use Vim
1746 just like Vi, and don't even (want to) know about the 'compatible'
1747 option.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001748 When a |vimrc| or |gvimrc| file is found while Vim is starting up,
Bram Moolenaard042c562005-06-30 22:04:15 +00001749 this option is switched off, and all options that have not been
1750 modified will be set to the Vim defaults. Effectively, this means
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001751 that when a |vimrc| or |gvimrc| file exists, Vim will use the Vim
Bram Moolenaard042c562005-06-30 22:04:15 +00001752 defaults, otherwise it will use the Vi defaults. (Note: This doesn't
Bram Moolenaar02467872007-05-06 13:22:01 +00001753 happen for the system-wide vimrc or gvimrc file, nor for a file given
1754 with the |-u| argument). Also see |compatible-default| and
1755 |posix-compliance|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001756 You can also set this option with the "-C" argument, and reset it with
1757 "-N". See |-C| and |-N|.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001758 See 'cpoptions' for more fine tuning of Vi compatibility.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001759
Bram Moolenaar214641f2017-03-05 17:04:09 +01001760 When this option is set, numerous other options are set to make Vim as
1761 Vi-compatible as possible. When this option is unset, various options
1762 are set to make Vim more useful. The table below lists all the
1763 options affected.
1764 The {?} column indicates when the options are affected:
1765 + Means that the option is set to the value given in {set value} when
1766 'compatible' is set.
1767 & Means that the option is set to the value given in {set value} when
1768 'compatible' is set AND is set to its Vim default value when
1769 'compatible' is unset.
1770 - Means the option is NOT changed when setting 'compatible' but IS
1771 set to its Vim default when 'compatible' is unset.
1772 The {effect} column summarises the change when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001773
Bram Moolenaar036986f2017-03-16 17:41:02 +01001774 option ? set value effect ~
Bram Moolenaar214641f2017-03-05 17:04:09 +01001775
1776 'allowrevins' + off no CTRL-_ command
1777 'antialias' + off don't use antialiased fonts
1778 'arabic' + off reset arabic-related options
1779 'arabicshape' + on correct character shapes
1780 'backspace' + "" normal backspace
1781 'backup' + off no backup file
1782 'backupcopy' & Unix: "yes" backup file is a copy
1783 else: "auto" copy or rename backup file
1784 'balloonexpr' + "" text to show in evaluation balloon
1785 'breakindent' + off don't indent when wrapping lines
1786 'cedit' - {unchanged} {set vim default only on resetting 'cp'}
1787 'cindent' + off no C code indentation
1788 'compatible' - {unchanged} {set vim default only on resetting 'cp'}
1789 'copyindent' + off don't copy indent structure
1790 'cpoptions' & (all flags) Vi-compatible flags
1791 'cscopepathcomp'+ 0 don't show directories in tags list
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01001792 'cscoperelative'+ off don't use basename of path as prefix
Bram Moolenaar214641f2017-03-05 17:04:09 +01001793 'cscopetag' + off don't use cscope for ":tag"
Bram Moolenaar036986f2017-03-16 17:41:02 +01001794 'cscopetagorder'+ 0 see |cscopetagorder|
Bram Moolenaar214641f2017-03-05 17:04:09 +01001795 'cscopeverbose' + off see |cscopeverbose|
1796 'delcombine' + off unicode: delete whole char combination
1797 'digraph' + off no digraphs
1798 'esckeys' & off no <Esc>-keys in Insert mode
1799 'expandtab' + off tabs not expanded to spaces
1800 'fileformats' & "" no automatic file format detection,
Bram Moolenaar6f345a12019-12-17 21:27:18 +01001801 "dos,unix" except for MS-Windows
Bram Moolenaar214641f2017-03-05 17:04:09 +01001802 'formatexpr' + "" use 'formatprg' for auto-formatting
1803 'formatoptions' & "vt" Vi compatible formatting
1804 'gdefault' + off no default 'g' flag for ":s"
1805 'history' & 0 no commandline history
1806 'hkmap' + off no Hebrew keyboard mapping
1807 'hkmapp' + off no phonetic Hebrew keyboard mapping
1808 'hlsearch' + off no highlighting of search matches
1809 'incsearch' + off no incremental searching
1810 'indentexpr' + "" no indenting by expression
1811 'insertmode' + off do not start in Insert mode
1812 'iskeyword' & "@,48-57,_" keywords contain alphanumeric
Bram Moolenaar071d4272004-06-13 20:20:40 +00001813 characters and '_'
Bram Moolenaar214641f2017-03-05 17:04:09 +01001814 'joinspaces' + on insert 2 spaces after period
1815 'modeline' & off no modelines
1816 'more' & off no pauses in listings
1817 'mzquantum' - {unchanged} {set vim default only on resetting 'cp'}
1818 'numberwidth' & 8 min number of columns for line number
1819 'preserveindent'+ off don't preserve current indent structure
1820 when changing it
1821 'revins' + off no reverse insert
1822 'ruler' + off no ruler
1823 'scrolljump' + 1 no jump scroll
1824 'scrolloff' + 0 no scroll offset
1825 'shelltemp' - {unchanged} {set vim default only on resetting 'cp'}
1826 'shiftround' + off indent not rounded to shiftwidth
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02001827 'shortmess' & "S" no shortening of messages
Bram Moolenaar214641f2017-03-05 17:04:09 +01001828 'showcmd' & off command characters not shown
1829 'showmode' & off current mode not shown
1830 'sidescrolloff' + 0 cursor moves to edge of screen in scroll
1831 'smartcase' + off no automatic ignore case switch
1832 'smartindent' + off no smart indentation
1833 'smarttab' + off no smart tab size
1834 'softtabstop' + 0 tabs are always 'tabstop' positions
1835 'startofline' + on goto startofline with some commands
1836 'tagcase' & "followic" 'ignorecase' when searching tags file
1837 'tagrelative' & off tag file names are not relative
1838 'termguicolors' + off don't use highlight-(guifg|guibg)
1839 'textauto' & off no automatic textmode detection
1840 'textwidth' + 0 no automatic line wrap
1841 'tildeop' + off tilde is not an operator
1842 'ttimeout' + off no terminal timeout
1843 'undofile' + off don't use an undo file
Bram Moolenaar036986f2017-03-16 17:41:02 +01001844 'viminfo' - {unchanged} {set Vim default only on resetting 'cp'}
Bram Moolenaar214641f2017-03-05 17:04:09 +01001845 'virtualedit' + "" cursor can only be placed on characters
1846 'whichwrap' & "" left-right movements don't wrap
1847 'wildchar' & CTRL-E only when the current value is <Tab>
Bram Moolenaar071d4272004-06-13 20:20:40 +00001848 use CTRL-E for cmdline completion
Bram Moolenaar214641f2017-03-05 17:04:09 +01001849 'writebackup' + on or off depends on the |+writebackup| feature
Bram Moolenaar071d4272004-06-13 20:20:40 +00001850
1851 *'complete'* *'cpt'* *E535*
1852'complete' 'cpt' string (default: ".,w,b,u,t,i")
1853 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001854 This option specifies how keyword completion |ins-completion| works
1855 when CTRL-P or CTRL-N are used. It is also used for whole-line
1856 completion |i_CTRL-X_CTRL-L|. It indicates the type of completion
1857 and the places to scan. It is a comma separated list of flags:
Bram Moolenaar3848e002016-03-19 18:42:29 +01001858 . scan the current buffer ('wrapscan' is ignored)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001859 w scan buffers from other windows
1860 b scan other loaded buffers that are in the buffer list
1861 u scan the unloaded buffers that are in the buffer list
1862 U scan the buffers that are not in the buffer list
1863 k scan the files given with the 'dictionary' option
Bram Moolenaar0b238792006-03-02 22:49:12 +00001864 kspell use the currently active spell checking |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001865 k{dict} scan the file {dict}. Several "k" flags can be given,
1866 patterns are valid too. For example: >
1867 :set cpt=k/usr/dict/*,k~/spanish
1868< s scan the files given with the 'thesaurus' option
1869 s{tsr} scan the file {tsr}. Several "s" flags can be given, patterns
1870 are valid too.
1871 i scan current and included files
1872 d scan current and included files for defined name or macro
1873 |i_CTRL-X_CTRL-D|
1874 ] tag completion
1875 t same as "]"
1876
1877 Unloaded buffers are not loaded, thus their autocmds |:autocmd| are
1878 not executed, this may lead to unexpected completions from some files
1879 (gzipped files for example). Unloaded buffers are not scanned for
1880 whole-line completion.
1881
1882 The default is ".,w,b,u,t,i", which means to scan:
1883 1. the current buffer
1884 2. buffers in other windows
1885 3. other loaded buffers
1886 4. unloaded buffers
1887 5. tags
1888 6. included files
1889
1890 As you can see, CTRL-N and CTRL-P can be used to do any 'iskeyword'-
Bram Moolenaar582fd852005-03-28 20:58:01 +00001891 based expansion (e.g., dictionary |i_CTRL-X_CTRL-K|, included patterns
1892 |i_CTRL-X_CTRL-I|, tags |i_CTRL-X_CTRL-]| and normal expansions).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001893
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001894 *'completefunc'* *'cfu'*
1895'completefunc' 'cfu' string (default: empty)
1896 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02001897 {not available when compiled without the |+eval|
Bram Moolenaare2c453d2019-08-21 14:37:09 +02001898 feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00001899 This option specifies a function to be used for Insert mode completion
1900 with CTRL-X CTRL-U. |i_CTRL-X_CTRL-U|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001901 See |complete-functions| for an explanation of how the function is
1902 invoked and what it should return.
Bram Moolenaar166af9b2010-11-16 20:34:40 +01001903 This option cannot be set from a |modeline| or in the |sandbox|, for
1904 security reasons.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00001905
Bram Moolenaarac3150d2019-07-28 16:36:39 +02001906 *'completeslash'* *'csl'*
1907'completeslash' 'csl' string (default: "")
1908 local to buffer
Bram Moolenaar2e693a82019-10-16 22:35:02 +02001909 {only for MS-Windows}
Bram Moolenaarac3150d2019-07-28 16:36:39 +02001910 When this option is set it overrules 'shellslash' for completion:
1911 - When this option is set to "slash", a forward slash is used for path
1912 completion in insert mode. This is useful when editing HTML tag, or
Bram Moolenaar6f345a12019-12-17 21:27:18 +01001913 Makefile with 'noshellslash' on MS-Windows.
Bram Moolenaarac3150d2019-07-28 16:36:39 +02001914 - When this option is set to "backslash", backslash is used. This is
Bram Moolenaar6f345a12019-12-17 21:27:18 +01001915 useful when editing a batch file with 'shellslash' set on MS-Windows.
Bram Moolenaarac3150d2019-07-28 16:36:39 +02001916 - When this option is empty, same character is used as for
1917 'shellslash'.
1918 For Insert mode completion the buffer-local value is used. For
1919 command line completion the global value is used.
1920
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001921 *'completeopt'* *'cot'*
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001922'completeopt' 'cot' string (default: "menu,preview")
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001923 global
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001924 A comma separated list of options for Insert mode completion
1925 |ins-completion|. The supported values are:
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001926
1927 menu Use a popup menu to show the possible completions. The
1928 menu is only shown when there is more than one match and
1929 sufficient colors are available. |ins-completion-menu|
1930
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001931 menuone Use the popup menu also when there is only one match.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00001932 Useful when there is additional information about the
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001933 match, e.g., what file it comes from.
1934
Bram Moolenaarc1e37902006-04-18 21:55:01 +00001935 longest Only insert the longest common text of the matches. If
1936 the menu is displayed you can use CTRL-L to add more
1937 characters. Whether case is ignored depends on the kind
1938 of completion. For buffer text the 'ignorecase' option is
1939 used.
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001940
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001941 preview Show extra information about the currently selected
Bram Moolenaar02467872007-05-06 13:22:01 +00001942 completion in the preview window. Only works in
1943 combination with "menu" or "menuone".
1944
Bram Moolenaar576a4a62019-08-18 15:25:17 +02001945 popup Show extra information about the currently selected
1946 completion in a popup window. Only works in combination
1947 with "menu" or "menuone". Overrides "preview".
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02001948 See |'completepopup'| for specifying properties.
Bram Moolenaar2e693a82019-10-16 22:35:02 +02001949 {only works when compiled with the |+textprop| feature}
Bram Moolenaar576a4a62019-08-18 15:25:17 +02001950
Bram Moolenaardca7abe2019-10-20 18:17:57 +02001951 popuphidden
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01001952 Just like "popup" but initially hide the popup. Use a
Bram Moolenaardca7abe2019-10-20 18:17:57 +02001953 |CompleteChanged| autocommand to fetch the info and call
1954 |popup_show()| once the popup has been filled.
1955 See the example at |complete-popuphidden|.
1956 {only works when compiled with the |+textprop| feature}
1957
Bram Moolenaarb6be1e22015-07-10 18:18:40 +02001958 noinsert Do not insert any text for a match until the user selects
1959 a match from the menu. Only works in combination with
1960 "menu" or "menuone". No effect if "longest" is present.
1961
1962 noselect Do not select a match in the menu, force the user to
1963 select one from the menu. Only works in combination with
1964 "menu" or "menuone".
1965
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001966
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02001967 *'completepopup'* *'cpp'*
1968'completepopup' 'cpp' string (default empty)
1969 global
1970 {not available when compiled without the |+textprop|
1971 or |+quickfix| feature}
1972 When 'completeopt' contains "popup" then this option is used for the
Bram Moolenaar447bfba2020-07-18 16:07:16 +02001973 properties of the info popup when it is created. If an info popup
1974 window already exists it is closed, so that the option value is
1975 applied when it is created again.
1976 You can also use |popup_findinfo()| and then set properties for an
1977 existing info popup with |popup_setoptions()|. See |complete-popup|.
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02001978
1979
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001980 *'concealcursor'* *'cocu'*
1981'concealcursor' 'cocu' string (default: "")
1982 local to window
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001983 {not available when compiled without the |+conceal|
1984 feature}
1985 Sets the modes in which text in the cursor line can also be concealed.
1986 When the current mode is listed then concealing happens just like in
1987 other lines.
1988 n Normal mode
1989 v Visual mode
1990 i Insert mode
Bram Moolenaarca8c9862010-07-24 15:00:38 +02001991 c Command line editing, for 'incsearch'
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001992
Bram Moolenaare6dc5732010-07-24 23:52:26 +02001993 'v' applies to all lines in the Visual area, not only the cursor.
Bram Moolenaarca8c9862010-07-24 15:00:38 +02001994 A useful value is "nc". This is used in help files. So long as you
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001995 are moving around text is concealed, but when starting to insert text
1996 or selecting a Visual area the concealed text is displayed, so that
1997 you can see what you are doing.
Bram Moolenaarf70e3d62010-07-24 13:15:07 +02001998 Keep in mind that the cursor position is not always where it's
1999 displayed. E.g., when moving vertically it may change column.
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002000
2001
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002002 *'conceallevel'* *'cole'*
2003'conceallevel' 'cole' number (default 0)
Bram Moolenaar860cae12010-06-05 23:22:07 +02002004 local to window
Bram Moolenaar860cae12010-06-05 23:22:07 +02002005 {not available when compiled without the |+conceal|
2006 feature}
Bram Moolenaar6df6f472010-07-18 18:04:50 +02002007 Determine how text with the "conceal" syntax attribute |:syn-conceal|
2008 is shown:
Bram Moolenaar860cae12010-06-05 23:22:07 +02002009
Bram Moolenaar6df6f472010-07-18 18:04:50 +02002010 Value Effect ~
Bram Moolenaar860cae12010-06-05 23:22:07 +02002011 0 Text is shown normally
Bram Moolenaar477db062010-07-28 18:17:41 +02002012 1 Each block of concealed text is replaced with one
2013 character. If the syntax item does not have a custom
2014 replacement character defined (see |:syn-cchar|) the
2015 character defined in 'listchars' is used (default is a
2016 space).
2017 It is highlighted with the "Conceal" highlight group.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002018 2 Concealed text is completely hidden unless it has a
2019 custom replacement character defined (see
Bram Moolenaar477db062010-07-28 18:17:41 +02002020 |:syn-cchar|).
Bram Moolenaara7781e02010-07-19 20:13:22 +02002021 3 Concealed text is completely hidden.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002022
Bram Moolenaara7781e02010-07-19 20:13:22 +02002023 Note: in the cursor line concealed text is not hidden, so that you can
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002024 edit and copy the text. This can be changed with the 'concealcursor'
2025 option.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002026
Bram Moolenaar071d4272004-06-13 20:20:40 +00002027 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
2028'confirm' 'cf' boolean (default off)
2029 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002030 When 'confirm' is on, certain operations that would normally
2031 fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
2032 instead raise a |dialog| asking if you wish to save the current
2033 file(s). You can still use a ! to unconditionally |abandon| a buffer.
2034 If 'confirm' is off you can still activate confirmation for one
2035 command only (this is most useful in mappings) with the |:confirm|
2036 command.
2037 Also see the |confirm()| function and the 'v' flag in 'guioptions'.
2038
2039 *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
2040'conskey' 'consk' boolean (default off)
2041 global
Bram Moolenaarf3913272016-02-25 00:00:01 +01002042 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002043
2044 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
2045'copyindent' 'ci' boolean (default off)
2046 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002047 Copy the structure of the existing lines indent when autoindenting a
2048 new line. Normally the new indent is reconstructed by a series of
2049 tabs followed by spaces as required (unless |'expandtab'| is enabled,
2050 in which case only spaces are used). Enabling this option makes the
2051 new line copy whatever characters were used for indenting on the
Bram Moolenaar446cb832008-06-24 21:56:24 +00002052 existing line. 'expandtab' has no effect on these characters, a Tab
2053 remains a Tab. If the new indent is greater than on the existing
Bram Moolenaar071d4272004-06-13 20:20:40 +00002054 line, the remaining space is filled in the normal manner.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002055 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002056 Also see 'preserveindent'.
2057
Bram Moolenaare0fa3742016-02-20 15:47:01 +01002058 *'cpoptions'* *'cpo'* *cpo*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002059'cpoptions' 'cpo' string (Vim default: "aABceFs",
2060 Vi default: all flags)
2061 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002062 A sequence of single character flags. When a character is present
Bram Moolenaar7cba6c02013-09-05 22:13:31 +02002063 this indicates Vi-compatible behavior. This is used for things where
2064 not being Vi-compatible is mostly or sometimes preferred.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002065 'cpoptions' stands for "compatible-options".
2066 Commas can be added for readability.
2067 To avoid problems with flags that are added in the future, use the
2068 "+=" and "-=" feature of ":set" |add-option-flags|.
2069 NOTE: This option is set to the Vi default value when 'compatible' is
2070 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002071 NOTE: This option is set to the POSIX default value at startup when
2072 the Vi default value would be used and the $VIM_POSIX environment
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002073 variable exists |posix|. This means Vim tries to behave like the
2074 POSIX specification.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002075
2076 contains behavior ~
2077 *cpo-a*
2078 a When included, a ":read" command with a file name
2079 argument will set the alternate file name for the
2080 current window.
2081 *cpo-A*
2082 A When included, a ":write" command with a file name
2083 argument will set the alternate file name for the
2084 current window.
2085 *cpo-b*
2086 b "\|" in a ":map" command is recognized as the end of
2087 the map command. The '\' is included in the mapping,
2088 the text after the '|' is interpreted as the next
2089 command. Use a CTRL-V instead of a backslash to
2090 include the '|' in the mapping. Applies to all
2091 mapping, abbreviation, menu and autocmd commands.
2092 See also |map_bar|.
2093 *cpo-B*
2094 B A backslash has no special meaning in mappings,
Bram Moolenaara9604e62018-07-21 05:56:22 +02002095 abbreviations, user commands and the "to" part of the
2096 menu commands. Remove this flag to be able to use a
2097 backslash like a CTRL-V. For example, the command
2098 ":map X \<Esc>" results in X being mapped to:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002099 'B' included: "\^[" (^[ is a real <Esc>)
2100 'B' excluded: "<Esc>" (5 characters)
2101 ('<' excluded in both cases)
2102 *cpo-c*
2103 c Searching continues at the end of any match at the
2104 cursor position, but not further than the start of the
2105 next line. When not present searching continues
2106 one character from the cursor position. With 'c'
2107 "abababababab" only gets three matches when repeating
2108 "/abab", without 'c' there are five matches.
2109 *cpo-C*
2110 C Do not concatenate sourced lines that start with a
2111 backslash. See |line-continuation|.
2112 *cpo-d*
2113 d Using "./" in the 'tags' option doesn't mean to use
2114 the tags file relative to the current file, but the
2115 tags file in the current directory.
2116 *cpo-D*
2117 D Can't use CTRL-K to enter a digraph after Normal mode
2118 commands with a character argument, like |r|, |f| and
2119 |t|.
2120 *cpo-e*
2121 e When executing a register with ":@r", always add a
2122 <CR> to the last line, also when the register is not
2123 linewise. If this flag is not present, the register
2124 is not linewise and the last line does not end in a
2125 <CR>, then the last line is put on the command-line
2126 and can be edited before hitting <CR>.
2127 *cpo-E*
2128 E It is an error when using "y", "d", "c", "g~", "gu" or
2129 "gU" on an Empty region. The operators only work when
Bram Moolenaar15142e22018-04-30 22:19:58 +02002130 at least one character is to be operated on. Example:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002131 This makes "y0" fail in the first column.
2132 *cpo-f*
2133 f When included, a ":read" command with a file name
2134 argument will set the file name for the current buffer,
2135 if the current buffer doesn't have a file name yet.
2136 *cpo-F*
2137 F When included, a ":write" command with a file name
2138 argument will set the file name for the current
2139 buffer, if the current buffer doesn't have a file name
Bram Moolenaarb3480382005-12-11 21:33:32 +00002140 yet. Also see |cpo-P|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002141 *cpo-g*
2142 g Goto line 1 when using ":edit" without argument.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002143 *cpo-H*
2144 H When using "I" on a line with only blanks, insert
2145 before the last blank. Without this flag insert after
2146 the last blank.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002147 *cpo-i*
2148 i When included, interrupting the reading of a file will
2149 leave it modified.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002150 *cpo-I*
2151 I When moving the cursor up or down just after inserting
2152 indent for 'autoindent', do not delete the indent.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002153 *cpo-j*
2154 j When joining lines, only add two spaces after a '.',
2155 not after '!' or '?'. Also see 'joinspaces'.
2156 *cpo-J*
2157 J A |sentence| has to be followed by two spaces after
Bram Moolenaar582fd852005-03-28 20:58:01 +00002158 the '.', '!' or '?'. A <Tab> is not recognized as
Bram Moolenaar071d4272004-06-13 20:20:40 +00002159 white space.
2160 *cpo-k*
2161 k Disable the recognition of raw key codes in
2162 mappings, abbreviations, and the "to" part of menu
2163 commands. For example, if <Key> sends ^[OA (where ^[
2164 is <Esc>), the command ":map X ^[OA" results in X
2165 being mapped to:
2166 'k' included: "^[OA" (3 characters)
2167 'k' excluded: "<Key>" (one key code)
2168 Also see the '<' flag below.
2169 *cpo-K*
2170 K Don't wait for a key code to complete when it is
2171 halfway a mapping. This breaks mapping <F1><F1> when
2172 only part of the second <F1> has been read. It
2173 enables cancelling the mapping by typing <F1><Esc>.
2174 *cpo-l*
2175 l Backslash in a [] range in a search pattern is taken
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002176 literally, only "\]", "\^", "\-" and "\\" are special.
2177 See |/[]|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002178 'l' included: "/[ \t]" finds <Space>, '\' and 't'
2179 'l' excluded: "/[ \t]" finds <Space> and <Tab>
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002180 Also see |cpo-\|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002181 *cpo-L*
2182 L When the 'list' option is set, 'wrapmargin',
2183 'textwidth', 'softtabstop' and Virtual Replace mode
2184 (see |gR|) count a <Tab> as two characters, instead of
2185 the normal behavior of a <Tab>.
2186 *cpo-m*
2187 m When included, a showmatch will always wait half a
2188 second. When not included, a showmatch will wait half
2189 a second or until a character is typed. |'showmatch'|
2190 *cpo-M*
2191 M When excluded, "%" matching will take backslashes into
2192 account. Thus in "( \( )" and "\( ( \)" the outer
2193 parenthesis match. When included "%" ignores
2194 backslashes, which is Vi compatible.
2195 *cpo-n*
Bram Moolenaar64486672010-05-16 15:46:46 +02002196 n When included, the column used for 'number' and
2197 'relativenumber' will also be used for text of wrapped
2198 lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002199 *cpo-o*
2200 o Line offset to search command is not remembered for
2201 next search.
2202 *cpo-O*
2203 O Don't complain if a file is being overwritten, even
2204 when it didn't exist when editing it. This is a
2205 protection against a file unexpectedly created by
2206 someone else. Vi didn't complain about this.
2207 *cpo-p*
2208 p Vi compatible Lisp indenting. When not present, a
2209 slightly better algorithm is used.
Bram Moolenaarb3480382005-12-11 21:33:32 +00002210 *cpo-P*
2211 P When included, a ":write" command that appends to a
2212 file will set the file name for the current buffer, if
2213 the current buffer doesn't have a file name yet and
2214 the 'F' flag is also included |cpo-F|.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002215 *cpo-q*
2216 q When joining multiple lines leave the cursor at the
2217 position where it would be when joining two lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002218 *cpo-r*
2219 r Redo ("." command) uses "/" to repeat a search
2220 command, instead of the actually used search string.
2221 *cpo-R*
2222 R Remove marks from filtered lines. Without this flag
2223 marks are kept like |:keepmarks| was used.
2224 *cpo-s*
2225 s Set buffer options when entering the buffer for the
2226 first time. This is like it is in Vim version 3.0.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002227 And it is the default. If not present the options are
Bram Moolenaar071d4272004-06-13 20:20:40 +00002228 set when the buffer is created.
2229 *cpo-S*
2230 S Set buffer options always when entering a buffer
2231 (except 'readonly', 'fileformat', 'filetype' and
2232 'syntax'). This is the (most) Vi compatible setting.
2233 The options are set to the values in the current
2234 buffer. When you change an option and go to another
2235 buffer, the value is copied. Effectively makes the
2236 buffer options global to all buffers.
2237
2238 's' 'S' copy buffer options
2239 no no when buffer created
2240 yes no when buffer first entered (default)
2241 X yes each time when buffer entered (vi comp.)
2242 *cpo-t*
2243 t Search pattern for the tag command is remembered for
2244 "n" command. Otherwise Vim only puts the pattern in
2245 the history for search pattern, but doesn't change the
2246 last used search pattern.
2247 *cpo-u*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002248 u Undo is Vi compatible. See |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002249 *cpo-v*
2250 v Backspaced characters remain visible on the screen in
2251 Insert mode. Without this flag the characters are
2252 erased from the screen right away. With this flag the
2253 screen newly typed text overwrites backspaced
2254 characters.
2255 *cpo-w*
2256 w When using "cw" on a blank character, only change one
2257 character and not all blanks until the start of the
2258 next word.
2259 *cpo-W*
2260 W Don't overwrite a readonly file. When omitted, ":w!"
2261 overwrites a readonly file, if possible.
2262 *cpo-x*
2263 x <Esc> on the command-line executes the command-line.
2264 The default in Vim is to abandon the command-line,
2265 because <Esc> normally aborts a command. |c_<Esc>|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002266 *cpo-X*
2267 X When using a count with "R" the replaced text is
2268 deleted only once. Also when repeating "R" with "."
2269 and a count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002270 *cpo-y*
Bram Moolenaard09091d2019-01-17 16:07:22 +01002271 y A yank command can be redone with ".". Think twice if
2272 you really want to use this, it may break some
2273 plugins, since most people expect "." to only repeat a
2274 change.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002275 *cpo-Z*
2276 Z When using "w!" while the 'readonly' option is set,
2277 don't reset 'readonly'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002278 *cpo-!*
2279 ! When redoing a filter command, use the last used
2280 external command, whatever it was. Otherwise the last
2281 used -filter- command is used.
2282 *cpo-$*
2283 $ When making a change to one line, don't redisplay the
2284 line, but put a '$' at the end of the changed text.
2285 The changed text will be overwritten when you type the
2286 new text. The line is redisplayed if you type any
2287 command that moves the cursor from the insertion
2288 point.
2289 *cpo-%*
2290 % Vi-compatible matching is done for the "%" command.
2291 Does not recognize "#if", "#endif", etc.
2292 Does not recognize "/*" and "*/".
2293 Parens inside single and double quotes are also
2294 counted, causing a string that contains a paren to
2295 disturb the matching. For example, in a line like
2296 "if (strcmp("foo(", s))" the first paren does not
2297 match the last one. When this flag is not included,
2298 parens inside single and double quotes are treated
2299 specially. When matching a paren outside of quotes,
2300 everything inside quotes is ignored. When matching a
2301 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002302 there is one). This works very well for C programs.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002303 This flag is also used for other features, such as
2304 C-indenting.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002305 *cpo--*
2306 - When included, a vertical movement command fails when
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002307 it would go above the first line or below the last
2308 line. Without it the cursor moves to the first or
2309 last line, unless it already was in that line.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002310 Applies to the commands "-", "k", CTRL-P, "+", "j",
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002311 CTRL-N, CTRL-J and ":1234".
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002312 *cpo-+*
2313 + When included, a ":write file" command will reset the
2314 'modified' flag of the buffer, even though the buffer
2315 itself may still be different from its file.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002316 *cpo-star*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002317 * Use ":*" in the same way as ":@". When not included,
2318 ":*" is an alias for ":'<,'>", select the Visual area.
2319 *cpo-<*
2320 < Disable the recognition of special key codes in |<>|
2321 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002322 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00002323 ":map X <Tab>" results in X being mapped to:
2324 '<' included: "<Tab>" (5 characters)
2325 '<' excluded: "^I" (^I is a real <Tab>)
2326 Also see the 'k' flag above.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002327 *cpo->*
2328 > When appending to a register, put a line break before
2329 the appended text.
Bram Moolenaar8b3e0332011-06-26 05:36:34 +02002330 *cpo-;*
2331 ; When using |,| or |;| to repeat the last |t| search
2332 and the cursor is right in front of the searched
2333 character, the cursor won't move. When not included,
2334 the cursor would skip over it and jump to the
Bram Moolenaarc8734422012-06-01 22:38:45 +02002335 following occurrence.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002336
2337 POSIX flags. These are not included in the Vi default value, except
2338 when $VIM_POSIX was set on startup. |posix|
2339
2340 contains behavior ~
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002341 *cpo-#*
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002342 # A count before "D", "o" and "O" has no effect.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002343 *cpo-&*
2344 & When ":preserve" was used keep the swap file when
2345 exiting normally while this buffer is still loaded.
2346 This flag is tested when exiting.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002347 *cpo-\*
2348 \ Backslash in a [] range in a search pattern is taken
2349 literally, only "\]" is special See |/[]|
Bram Moolenaar90915b52005-08-21 22:17:52 +00002350 '\' included: "/[ \-]" finds <Space>, '\' and '-'
2351 '\' excluded: "/[ \-]" finds <Space> and '-'
2352 Also see |cpo-l|.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002353 *cpo-/*
2354 / When "%" is used as the replacement string in a |:s|
2355 command, use the previous replacement string. |:s%|
2356 *cpo-{*
2357 { The |{| and |}| commands also stop at a "{" character
2358 at the start of a line.
2359 *cpo-.*
2360 . The ":chdir" and ":cd" commands fail if the current
2361 buffer is modified, unless ! is used. Vim doesn't
2362 need this, since it remembers the full path of an
2363 opened file.
2364 *cpo-bar*
2365 | The value of the $LINES and $COLUMNS environment
2366 variables overrule the terminal size values obtained
2367 with system specific functions.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002368
Bram Moolenaar071d4272004-06-13 20:20:40 +00002369
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002370 *'cryptmethod'* *'cm'*
Bram Moolenaara86187b2018-12-16 18:20:00 +01002371'cryptmethod' 'cm' string (default "blowfish2")
Bram Moolenaar49771f42010-07-20 17:32:38 +02002372 global or local to buffer |global-local|
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002373 Method used for encryption when the buffer is written to a file:
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002374 *pkzip*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002375 zip PkZip compatible method. A weak kind of encryption.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002376 Backwards compatible with Vim 7.2 and older.
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002377 *blowfish*
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002378 blowfish Blowfish method. Medium strong encryption but it has
2379 an implementation flaw. Requires Vim 7.3 or later,
2380 files can NOT be read by Vim 7.2 and older. This adds
2381 a "seed" to the file, every time you write the file
2382 the encrypted bytes will be different.
2383 *blowfish2*
2384 blowfish2 Blowfish method. Medium strong encryption. Requires
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01002385 Vim 7.4.401 or later, files can NOT be read by Vim 7.3
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002386 and older. This adds a "seed" to the file, every time
2387 you write the file the encrypted bytes will be
2388 different. The whole undo file is encrypted, not just
2389 the pieces of text.
Christian Brabandtf573c6e2021-06-20 14:02:16 +02002390 *E1193* *E1194* *E1195* *E1196*
2391 *E1197* *E1198* *E1199* *E1200* *E1201*
2392 xchacha20 XChaCha20 Cipher with Poly1305 Message Authentication
2393 Code. Medium strong till strong encryption.
2394 Encryption is provided by the libsodium library, it
2395 requires Vim to be built with |+sodium|
2396 It adds a seed and a message authentication code (MAC)
2397 to the file. This needs at least a Vim 8.2.3022 to
2398 read the encrypted file.
2399 Encryption of swap files is not supported, therefore
2400 no swap file will be used when xchacha20 encryption is
2401 enabled.
2402 Encryption of undo files is not yet supported,
2403 therefore no undo file will currently be written.
2404 CURRENTLY EXPERIMENTAL: Files written with this method
2405 might have to be read back with the same version of
2406 Vim if the binary format changes later.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002407
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01002408 You should use "blowfish2", also to re-encrypt older files.
2409
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002410 When reading an encrypted file 'cryptmethod' will be set automatically
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002411 to the detected method of the file being read. Thus if you write it
2412 without changing 'cryptmethod' the same method will be used.
2413 Changing 'cryptmethod' does not mark the file as modified, you have to
Bram Moolenaar49771f42010-07-20 17:32:38 +02002414 explicitly write it, you don't get a warning unless there are other
2415 modifications. Also see |:X|.
2416
2417 When setting the global value to an empty string, it will end up with
Bram Moolenaara86187b2018-12-16 18:20:00 +01002418 the value "blowfish2". When setting the local value to an empty
2419 string the buffer will use the global value.
Bram Moolenaar49771f42010-07-20 17:32:38 +02002420
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002421 When a new encryption method is added in a later version of Vim, and
2422 the current version does not recognize it, you will get *E821* .
Bram Moolenaar49771f42010-07-20 17:32:38 +02002423 You need to edit this file with the later version of Vim.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002424
2425
Bram Moolenaar071d4272004-06-13 20:20:40 +00002426 *'cscopepathcomp'* *'cspc'*
2427'cscopepathcomp' 'cspc' number (default 0)
2428 global
2429 {not available when compiled without the |+cscope|
2430 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002431 Determines how many components of the path to show in a list of tags.
2432 See |cscopepathcomp|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002433 NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002434
2435 *'cscopeprg'* *'csprg'*
2436'cscopeprg' 'csprg' string (default "cscope")
2437 global
2438 {not available when compiled without the |+cscope|
2439 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002440 Specifies the command to execute cscope. See |cscopeprg|.
2441 This option cannot be set from a |modeline| or in the |sandbox|, for
2442 security reasons.
2443
2444 *'cscopequickfix'* *'csqf'*
2445'cscopequickfix' 'csqf' string (default "")
2446 global
2447 {not available when compiled without the |+cscope|
2448 or |+quickfix| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002449 Specifies whether to use quickfix window to show cscope results.
2450 See |cscopequickfix|.
2451
Bram Moolenaarec7944a2013-06-12 21:29:15 +02002452 *'cscoperelative'* *'csre'* *'nocscoperelative'* *'nocsre'*
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002453'cscoperelative' 'csre' boolean (default off)
2454 global
2455 {not available when compiled without the |+cscope|
2456 feature}
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002457 In the absence of a prefix (-P) for cscope. setting this option enables
2458 to use the basename of cscope.out path as the prefix.
2459 See |cscoperelative|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002460 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002461
Bram Moolenaar071d4272004-06-13 20:20:40 +00002462 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
2463'cscopetag' 'cst' boolean (default off)
2464 global
2465 {not available when compiled without the |+cscope|
2466 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002467 Use cscope for tag commands. See |cscope-options|.
2468 NOTE: This option is reset when 'compatible' is set.
2469
2470 *'cscopetagorder'* *'csto'*
2471'cscopetagorder' 'csto' number (default 0)
2472 global
2473 {not available when compiled without the |+cscope|
2474 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002475 Determines the order in which ":cstag" performs a search. See
2476 |cscopetagorder|.
2477 NOTE: This option is set to 0 when 'compatible' is set.
2478
2479 *'cscopeverbose'* *'csverb'*
2480 *'nocscopeverbose'* *'nocsverb'*
2481'cscopeverbose' 'csverb' boolean (default off)
2482 global
2483 {not available when compiled without the |+cscope|
2484 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002485 Give messages when adding a cscope database. See |cscopeverbose|.
2486 NOTE: This option is reset when 'compatible' is set.
2487
Bram Moolenaar860cae12010-06-05 23:22:07 +02002488 *'cursorbind'* *'crb'* *'nocursorbind'* *'nocrb'*
2489'cursorbind' 'crb' boolean (default off)
2490 local to window
Bram Moolenaar860cae12010-06-05 23:22:07 +02002491 When this option is set, as the cursor in the current
2492 window moves other cursorbound windows (windows that also have
2493 this option set) move their cursors to the corresponding line and
2494 column. This option is useful for viewing the
2495 differences between two versions of a file (see 'diff'); in diff mode,
2496 inserted and deleted lines (though not characters within a line) are
Bram Moolenaar1a384422010-07-14 19:53:30 +02002497 taken into account.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002498
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002499
2500 *'cursorcolumn'* *'cuc'* *'nocursorcolumn'* *'nocuc'*
2501'cursorcolumn' 'cuc' boolean (default off)
2502 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02002503 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002504 feature}
2505 Highlight the screen column of the cursor with CursorColumn
2506 |hl-CursorColumn|. Useful to align text. Will make screen redrawing
2507 slower.
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00002508 If you only want the highlighting in the current window you can use
2509 these autocommands: >
2510 au WinLeave * set nocursorline nocursorcolumn
2511 au WinEnter * set cursorline cursorcolumn
2512<
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002513
2514 *'cursorline'* *'cul'* *'nocursorline'* *'nocul'*
2515'cursorline' 'cul' boolean (default off)
2516 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02002517 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002518 feature}
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002519 Highlight the text line of the cursor with CursorLine |hl-CursorLine|.
2520 Useful to easily spot the cursor. Will make screen redrawing slower.
Bram Moolenaare2f98b92006-03-29 21:18:24 +00002521 When Visual mode is active the highlighting isn't used to make it
Bram Moolenaar779b74b2006-04-10 14:55:34 +00002522 easier to see the selected text.
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002523
2524
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002525 *'cursorlineopt'* *'culopt'*
Bram Moolenaar017ba072019-09-14 21:01:23 +02002526'cursorlineopt' 'culopt' string (default: "number,line")
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002527 local to window
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002528 {not available when compiled without the |+syntax|
2529 feature}
Bram Moolenaar017ba072019-09-14 21:01:23 +02002530 Comma separated list of settings for how 'cursorline' is displayed.
2531 Valid values:
2532 "line" Highlight the text line of the cursor with
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002533 CursorLine |hl-CursorLine|.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002534 "screenline" Highlight only the screen line of the cursor with
2535 CursorLine |hl-CursorLine|.
2536 "number" Highlight the line number of the cursor with
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002537 CursorLineNr |hl-CursorLineNr|.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002538
2539 Special value:
2540 "both" Alias for the values "line,number".
2541
2542 "line" and "screenline" cannot be used together.
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002543
2544
Bram Moolenaar071d4272004-06-13 20:20:40 +00002545 *'debug'*
2546'debug' string (default "")
2547 global
Bram Moolenaar57657d82006-04-21 22:12:41 +00002548 These values can be used:
2549 msg Error messages that would otherwise be omitted will be given
2550 anyway.
2551 throw Error messages that would otherwise be omitted will be given
2552 anyway and also throw an exception and set |v:errmsg|.
2553 beep A message will be given when otherwise only a beep would be
2554 produced.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002555 The values can be combined, separated by a comma.
Bram Moolenaar57657d82006-04-21 22:12:41 +00002556 "msg" and "throw" are useful for debugging 'foldexpr', 'formatexpr' or
2557 'indentexpr'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002558
2559 *'define'* *'def'*
2560'define' 'def' string (default "^\s*#\s*define")
2561 global or local to buffer |global-local|
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002562 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002563 pattern, just like for the "/" command. This option is used for the
2564 commands like "[i" and "[d" |include-search|. The 'isident' option is
2565 used to recognize the defined name after the match:
2566 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2567 See |option-backslash| about inserting backslashes to include a space
2568 or backslash.
2569 The default value is for C programs. For C++ this value would be
2570 useful, to include const type declarations: >
2571 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
Bram Moolenaar63b74a82019-03-24 15:09:13 +01002572< You can also use "\ze" just before the name and continue the pattern
2573 to check what is following. E.g. for Javascript, if a function is
2574 defined with "func_name = function(args)": >
2575 ^\s*\ze\i\+\s*=\s*function(
2576< If the function is defined with "func_name : function() {...": >
2577 ^\s*\ze\i\+\s*[:]\s*(*function\s*(
Bram Moolenaar071d4272004-06-13 20:20:40 +00002578< When using the ":set" command, you need to double the backslashes!
Bram Moolenaar63b74a82019-03-24 15:09:13 +01002579 To avoid that use `:let` with a single quote string: >
2580 let &l:define = '^\s*\ze\k\+\s*=\s*function('
Bram Moolenaar911ead12019-04-21 00:03:35 +02002581<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002582
2583 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2584'delcombine' 'deco' boolean (default off)
2585 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002586 If editing Unicode and this option is set, backspace and Normal mode
2587 "x" delete each combining character on its own. When it is off (the
2588 default) the character along with its combining characters are
2589 deleted.
Bram Moolenaar4f4d51a2020-10-11 13:57:40 +02002590 Note: When 'delcombine' is set "xx" may work differently from "2x"!
Bram Moolenaar071d4272004-06-13 20:20:40 +00002591
2592 This is useful for Arabic, Hebrew and many other languages where one
2593 may have combining characters overtop of base characters, and want
2594 to remove only the combining ones.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002595 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002596
2597 *'dictionary'* *'dict'*
2598'dictionary' 'dict' string (default "")
2599 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002600 List of file names, separated by commas, that are used to lookup words
2601 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2602 contain a list of words. This can be one word per line, or several
2603 words per line, separated by non-keyword characters (white space is
2604 preferred). Maximum line length is 510 bytes.
Bram Moolenaar259f26a2018-05-15 22:25:40 +02002605
2606 When this option is empty or an entry "spell" is present, and spell
2607 checking is enabled, words in the word lists for the currently active
2608 'spelllang' are used. See |spell|.
2609
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002610 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002611 after a comma are ignored, otherwise spaces are included in the file
2612 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002613 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002614 Where to find a list of words?
2615 - On FreeBSD, there is the file "/usr/share/dict/words".
2616 - In the Simtel archive, look in the "msdos/linguist" directory.
2617 - In "miscfiles" of the GNU collection.
2618 The use of |:set+=| and |:set-=| is preferred when adding or removing
2619 directories from the list. This avoids problems when a future version
2620 uses another default.
2621 Backticks cannot be used in this option for security reasons.
2622
2623 *'diff'* *'nodiff'*
2624'diff' boolean (default off)
2625 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00002626 {not available when compiled without the |+diff|
2627 feature}
2628 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002629 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002630
2631 *'dex'* *'diffexpr'*
2632'diffexpr' 'dex' string (default "")
2633 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002634 {not available when compiled without the |+diff|
2635 feature}
Bram Moolenaare828b762018-09-10 17:51:58 +02002636 Expression which is evaluated to obtain a diff file (either ed-style
2637 or unified-style) from two versions of a file. See |diff-diffexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002638 This option cannot be set from a |modeline| or in the |sandbox|, for
2639 security reasons.
2640
2641 *'dip'* *'diffopt'*
Bram Moolenaarc8234772019-11-10 21:00:27 +01002642'diffopt' 'dip' string (default "internal,filler,closeoff")
Bram Moolenaar071d4272004-06-13 20:20:40 +00002643 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002644 {not available when compiled without the |+diff|
2645 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002646 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002647 All are optional. Items must be separated by a comma.
2648
2649 filler Show filler lines, to keep the text
2650 synchronized with a window that has inserted
2651 lines at the same position. Mostly useful
2652 when windows are side-by-side and 'scrollbind'
2653 is set.
2654
2655 context:{n} Use a context of {n} lines between a change
2656 and a fold that contains unchanged lines.
2657 When omitted a context of six lines is used.
Bram Moolenaarf6b40102019-02-22 15:24:03 +01002658 When using zero the context is actually one,
2659 since folds require a line in between, also
2660 for a deleted line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002661 See |fold-diff|.
2662
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002663 iblank Ignore changes where lines are all blank. Adds
2664 the "-B" 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 NOTE: the diff windows will get out of sync,
2669 because no differences between blank lines are
2670 taken into account.
2671
Bram Moolenaar071d4272004-06-13 20:20:40 +00002672 icase Ignore changes in case of text. "a" and "A"
2673 are considered the same. Adds the "-i" flag
2674 to the "diff" command if 'diffexpr' is empty.
2675
2676 iwhite Ignore changes in amount of white space. Adds
2677 the "-b" flag to the "diff" command if
2678 'diffexpr' is empty. Check the documentation
2679 of the "diff" command for what this does
2680 exactly. It should ignore adding trailing
2681 white space, but not leading white space.
2682
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002683 iwhiteall Ignore all white space changes. Adds
2684 the "-w" flag to the "diff" command if
2685 'diffexpr' is empty. Check the documentation
2686 of the "diff" command for what this does
2687 exactly.
2688
2689 iwhiteeol Ignore white space changes at end of line.
2690 Adds the "-Z" flag to the "diff" command if
2691 'diffexpr' is empty. Check the documentation
2692 of the "diff" command for what this does
2693 exactly.
2694
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002695 horizontal Start diff mode with horizontal splits (unless
2696 explicitly specified otherwise).
2697
2698 vertical Start diff mode with vertical splits (unless
2699 explicitly specified otherwise).
2700
Bram Moolenaarc8234772019-11-10 21:00:27 +01002701 closeoff When a window is closed where 'diff' is set
2702 and there is only one window remaining in the
2703 same tab page with 'diff' set, execute
2704 `:diffoff` in that window. This undoes a
2705 `:diffsplit` command.
2706
Bram Moolenaar97ce4192017-12-01 20:35:58 +01002707 hiddenoff Do not use diff mode for a buffer when it
2708 becomes hidden.
2709
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002710 foldcolumn:{n} Set the 'foldcolumn' option to {n} when
2711 starting diff mode. Without this 2 is used.
2712
Bram Moolenaar4223d432021-02-10 13:18:17 +01002713 followwrap Follow the 'wrap' option and leave as it is.
2714
Bram Moolenaare828b762018-09-10 17:51:58 +02002715 internal Use the internal diff library. This is
2716 ignored when 'diffexpr' is set. *E960*
2717 When running out of memory when writing a
2718 buffer this item will be ignored for diffs
2719 involving that buffer. Set the 'verbose'
2720 option to see when this happens.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002721
Bram Moolenaare828b762018-09-10 17:51:58 +02002722 indent-heuristic
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01002723 Use the indent heuristic for the internal
2724 diff library.
Bram Moolenaare828b762018-09-10 17:51:58 +02002725
2726 algorithm:{text} Use the specified diff algorithm with the
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01002727 internal diff engine. Currently supported
Bram Moolenaare828b762018-09-10 17:51:58 +02002728 algorithms are:
2729 myers the default algorithm
2730 minimal spend extra time to generate the
2731 smallest possible diff
2732 patience patience diff algorithm
2733 histogram histogram diff algorithm
2734
2735 Examples: >
2736 :set diffopt=internal,filler,context:4
Bram Moolenaar071d4272004-06-13 20:20:40 +00002737 :set diffopt=
Bram Moolenaare828b762018-09-10 17:51:58 +02002738 :set diffopt=internal,filler,foldcolumn:3
2739 :set diffopt-=internal " do NOT use the internal diff parser
Bram Moolenaar071d4272004-06-13 20:20:40 +00002740<
2741 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
2742'digraph' 'dg' boolean (default off)
2743 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002744 {not available when compiled without the |+digraphs|
2745 feature}
2746 Enable the entering of digraphs in Insert mode with {char1} <BS>
2747 {char2}. See |digraphs|.
2748 NOTE: This option is reset when 'compatible' is set.
2749
2750 *'directory'* *'dir'*
2751'directory' 'dir' string (default for Amiga: ".,t:",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01002752 for Win32: ".,$TEMP,c:\tmp,c:\temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00002753 for Unix: ".,~/tmp,/var/tmp,/tmp")
2754 global
2755 List of directory names for the swap file, separated with commas.
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02002756 Recommended value: ".,~/vimswap//" - this will put the swap file next
2757 to the edited file if possible, and in your personal swap directory
2758 otherwise. Make sure "~/vimswap//" is only readable for you.
2759
2760 Possible items:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002761 - The swap file will be created in the first directory where this is
2762 possible.
2763 - Empty means that no swap file will be used (recovery is
Bram Moolenaar00e192b2019-10-19 17:01:28 +02002764 impossible!) and no |E303| error will be given.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002765 - A directory "." means to put the swap file in the same directory as
2766 the edited file. On Unix, a dot is prepended to the file name, so
2767 it doesn't show in a directory listing. On MS-Windows the "hidden"
2768 attribute is set and a dot prepended if possible.
Bram Moolenaar8024f932020-01-14 19:29:13 +01002769 - A directory starting with "./" (or ".\" for MS-Windows) means to put
2770 the swap file relative to where the edited file is. The leading "."
2771 is replaced with the path name of the edited file.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02002772 - For Unix and Win32, if a directory ends in two path separators "//",
2773 the swap file name will be built from the complete path to the file
Bram Moolenaar207f0092020-08-30 17:20:20 +02002774 with all path separators replaced by percent '%' signs (including
2775 the colon following the drive letter on Win32). This will ensure
2776 file name uniqueness in the preserve directory.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02002777 On Win32, it is also possible to end with "\\". However, When a
2778 separating comma is following, you must use "//", since "\\" will
2779 include the comma in the file name. Therefore it is recommended to
2780 use '//', instead of '\\'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002781 - Spaces after the comma are ignored, other spaces are considered part
2782 of the directory name. To have a space at the start of a directory
2783 name, precede it with a backslash.
2784 - To include a comma in a directory name precede it with a backslash.
2785 - A directory name may end in an ':' or '/'.
2786 - Environment variables are expanded |:set_env|.
2787 - Careful with '\' characters, type one before a space, type two to
2788 get one in the option (see |option-backslash|), for example: >
2789 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
2790< - For backwards compatibility with Vim version 3.0 a '>' at the start
2791 of the option is removed.
2792 Using "." first in the list is recommended. This means that editing
2793 the same file twice will result in a warning. Using "/tmp" on Unix is
2794 discouraged: When the system crashes you lose the swap file.
2795 "/var/tmp" is often not cleared when rebooting, thus is a better
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02002796 choice than "/tmp". But others on the computer may be able to see the
2797 files, and it can contain a lot of files, your swap files get lost in
2798 the crowd. That is why a "tmp" directory in your home directory is
2799 tried first.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002800 The use of |:set+=| and |:set-=| is preferred when adding or removing
2801 directories from the list. This avoids problems when a future version
2802 uses another default.
2803 This option cannot be set from a |modeline| or in the |sandbox|, for
2804 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002805
2806 *'display'* *'dy'*
Bram Moolenaarbc8801c2016-08-02 21:04:33 +02002807'display' 'dy' string (default "", set to "truncate" in
2808 |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002809 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002810 Change the way text is displayed. This is comma separated list of
2811 flags:
2812 lastline When included, as much as possible of the last line
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02002813 in a window will be displayed. "@@@" is put in the
2814 last columns of the last screen line to indicate the
2815 rest of the line is not displayed.
2816 truncate Like "lastline", but "@@@" is displayed in the first
2817 column of the last screen line. Overrules "lastline".
Bram Moolenaar071d4272004-06-13 20:20:40 +00002818 uhex Show unprintable characters hexadecimal as <xx>
2819 instead of using ^C and ~C.
2820
Bram Moolenaard0796902016-09-16 20:02:31 +02002821 When neither "lastline" nor "truncate" is included, a last line that
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02002822 doesn't fit is replaced with "@" lines.
2823
Bram Moolenaar071d4272004-06-13 20:20:40 +00002824 *'eadirection'* *'ead'*
2825'eadirection' 'ead' string (default "both")
2826 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002827 Tells when the 'equalalways' option applies:
2828 ver vertically, width of windows is not affected
2829 hor horizontally, height of windows is not affected
2830 both width and height of windows is affected
2831
2832 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
2833'edcompatible' 'ed' boolean (default off)
2834 global
2835 Makes the 'g' and 'c' flags of the ":substitute" command to be
2836 toggled each time the flag is given. See |complex-change|. See
2837 also 'gdefault' option.
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +02002838 Switching this option on may break plugins!
Bram Moolenaar4072ba52020-12-23 13:56:35 +01002839 This option is not used in |Vim9| script.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002840
Bram Moolenaar03413f42016-04-12 21:07:15 +02002841 *'emoji'* *'emo'* *'noemoji'* *'noemo'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01002842'emoji' 'emo' boolean (default: on)
2843 global
Bram Moolenaar3848e002016-03-19 18:42:29 +01002844 When on all Unicode emoji characters are considered to be full width.
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02002845 This excludes "text emoji" characters, which are normally displayed as
2846 single width. Unfortunately there is no good specification for this
2847 and it has been determined on trial-and-error basis. Use the
2848 |setcellwidths()| function to change the behavior.
Bram Moolenaar3848e002016-03-19 18:42:29 +01002849
Bram Moolenaar071d4272004-06-13 20:20:40 +00002850 *'encoding'* *'enc'* *E543*
K.Takataf883d902021-05-30 18:04:19 +02002851'encoding' 'enc' string (default for MS-Windows: "utf-8",
2852 otherwise: value from $LANG or "latin1")
Bram Moolenaar071d4272004-06-13 20:20:40 +00002853 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002854 Sets the character encoding used inside Vim. It applies to text in
2855 the buffers, registers, Strings in expressions, text stored in the
2856 viminfo file, etc. It sets the kind of characters which Vim can work
2857 with. See |encoding-names| for the possible values.
2858
2859 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002860 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002861 It should normally be kept at its default value, or set when Vim
Bram Moolenaar02467872007-05-06 13:22:01 +00002862 starts up. See |multibyte|. To reload the menus see |:menutrans|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002863
Bram Moolenaar865242e2010-07-14 21:12:05 +02002864 This option cannot be set from a |modeline|. It would most likely
2865 corrupt the text.
2866
Bram Moolenaar3df01732017-02-17 22:47:16 +01002867 NOTE: For GTK+ 2 or later, it is highly recommended to set 'encoding'
2868 to "utf-8". Although care has been taken to allow different values of
Bram Moolenaar071d4272004-06-13 20:20:40 +00002869 'encoding', "utf-8" is the natural choice for the environment and
2870 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002871 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00002872 versions, and to avoid changing the encoding of newly created files
2873 without your knowledge (in case 'fileencodings' is empty).
2874
2875 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002876 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00002877 iconv() or as specified with 'charconvert'.
2878
Bram Moolenaar207f0092020-08-30 17:20:20 +02002879 If you need to know whether 'encoding' is a multibyte encoding, you
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002880 can use: >
2881 if has("multi_byte_encoding")
2882<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002883 Normally 'encoding' will be equal to your current locale. This will
2884 be the default if Vim recognizes your environment settings. If
2885 'encoding' is not set to the current locale, 'termencoding' must be
2886 set to convert typed and displayed text. See |encoding-table|.
2887
2888 When you set this option, it fires the |EncodingChanged| autocommand
2889 event so that you can set up fonts if necessary.
2890
2891 When the option is set, the value is converted to lowercase. Thus
2892 you can set it with uppercase values too. Underscores are translated
2893 to '-' signs.
2894 When the encoding is recognized, it is changed to the standard name.
2895 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
2896 "iso-8859-2" and "utf8" becomes "utf-8".
2897
2898 Note: "latin1" is also used when the encoding could not be detected.
2899 This only works when editing files in the same encoding! When the
2900 actual character set is not latin1, make sure 'fileencoding' and
2901 'fileencodings' are empty. When conversion is needed, switch to using
2902 utf-8.
2903
2904 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
2905 You don't notice this while editing, but it does matter for the
2906 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
2907 setting 'encoding' to one of these values instead of utf-8 only has
2908 effect for encoding used for files when 'fileencoding' is empty.
2909
Bram Moolenaar661b1822005-07-28 22:36:45 +00002910 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
2911 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002912
2913 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
2914'endofline' 'eol' boolean (default on)
2915 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002916 When writing a file and this option is off and the 'binary' option
Bram Moolenaar34d72d42015-07-17 14:18:08 +02002917 is on, or 'fixeol' option is off, no <EOL> will be written for the
2918 last line in the file. This option is automatically set or reset when
2919 starting to edit a new file, depending on whether file has an <EOL>
2920 for the last line in the file. Normally you don't have to set or
2921 reset this option.
2922 When 'binary' is off and 'fixeol' is on the value is not used when
2923 writing the file. When 'binary' is on or 'fixeol' is off it is used
2924 to remember the presence of a <EOL> for the last line in the file, so
2925 that when you write the file the situation from the original file can
2926 be kept. But you can change it if you want to.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002927
2928 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
2929'equalalways' 'ea' boolean (default on)
2930 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002931 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00002932 splitting or closing a window. This also happens the moment the
2933 option is switched on. When off, splitting a window will reduce the
2934 size of the current window and leave the other windows the same. When
2935 closing a window the extra lines are given to the window next to it
2936 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00002937 When mixing vertically and horizontally split windows, a minimal size
2938 is computed and some windows may be larger if there is room. The
2939 'eadirection' option tells in which direction the size is affected.
Bram Moolenaar67f71312007-08-12 14:55:56 +00002940 Changing the height and width of a window can be avoided by setting
2941 'winfixheight' and 'winfixwidth', respectively.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002942 If a window size is specified when creating a new window sizes are
2943 currently not equalized (it's complicated, but may be implemented in
2944 the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002945
2946 *'equalprg'* *'ep'*
2947'equalprg' 'ep' string (default "")
2948 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002949 External program to use for "=" command. When this option is empty
Bram Moolenaar446cb832008-06-24 21:56:24 +00002950 the internal formatting functions are used; either 'lisp', 'cindent'
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002951 or 'indentexpr'. When Vim was compiled without internal formatting,
2952 the "indent" program is used.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002953 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002954 about including spaces and backslashes.
2955 This option cannot be set from a |modeline| or in the |sandbox|, for
2956 security reasons.
2957
2958 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
2959'errorbells' 'eb' boolean (default off)
2960 global
2961 Ring the bell (beep or screen flash) for error messages. This only
2962 makes a difference for error messages, the bell will be used always
2963 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002964 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar165bc692015-07-21 17:53:25 +02002965 screen flash or do nothing. See 'belloff' to finetune when to ring the
2966 bell.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002967
2968 *'errorfile'* *'ef'*
2969'errorfile' 'ef' string (Amiga default: "AztecC.Err",
2970 others: "errors.err")
2971 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002972 {not available when compiled without the |+quickfix|
2973 feature}
2974 Name of the errorfile for the QuickFix mode (see |:cf|).
2975 When the "-q" command-line argument is used, 'errorfile' is set to the
2976 following argument. See |-q|.
2977 NOT used for the ":make" command. See 'makeef' for that.
2978 Environment variables are expanded |:set_env|.
2979 See |option-backslash| about including spaces and backslashes.
2980 This option cannot be set from a |modeline| or in the |sandbox|, for
2981 security reasons.
2982
2983 *'errorformat'* *'efm'*
2984'errorformat' 'efm' string (default is very long)
2985 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002986 {not available when compiled without the |+quickfix|
2987 feature}
2988 Scanf-like description of the format for the lines in the error file
2989 (see |errorformat|).
2990
2991 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
2992'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
2993 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002994 Function keys that start with an <Esc> are recognized in Insert
2995 mode. When this option is off, the cursor and function keys cannot be
2996 used in Insert mode if they start with an <Esc>. The advantage of
2997 this is that the single <Esc> is recognized immediately, instead of
2998 after one second. Instead of resetting this option, you might want to
2999 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
3000 when 'esckeys' is off, you can still map anything, but the cursor keys
3001 won't work by default.
3002 NOTE: This option is set to the Vi default value when 'compatible' is
3003 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaarc8234772019-11-10 21:00:27 +01003004 NOTE: when this option is off then the |modifyOtherKeys| functionality
3005 is disabled while in Insert mode to avoid ending Insert mode with any
3006 key that has a modifier.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003007
3008 *'eventignore'* *'ei'*
3009'eventignore' 'ei' string (default "")
3010 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003011 A list of autocommand event names, which are to be ignored.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00003012 When set to "all" or when "all" is one of the items, all autocommand
3013 events are ignored, autocommands will not be executed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003014 Otherwise this is a comma separated list of event names. Example: >
3015 :set ei=WinEnter,WinLeave
3016<
3017 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
3018'expandtab' 'et' boolean (default off)
3019 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003020 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003021 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00003022 when 'autoindent' is on. To insert a real tab when 'expandtab' is
3023 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
Bram Moolenaarca635012015-09-25 20:34:21 +02003024 This option is reset when the 'paste' option is set and restored when
3025 the 'paste' option is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003026 NOTE: This option is reset when 'compatible' is set.
3027
3028 *'exrc'* *'ex'* *'noexrc'* *'noex'*
3029'exrc' 'ex' boolean (default off)
3030 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003031 Enables the reading of .vimrc, .exrc and .gvimrc in the current
Bram Moolenaar36f44c22016-08-28 18:17:20 +02003032 directory.
3033
3034 Setting this option is a potential security leak. E.g., consider
3035 unpacking a package or fetching files from github, a .vimrc in there
3036 might be a trojan horse. BETTER NOT SET THIS OPTION!
3037 Instead, define an autocommand in your .vimrc to set options for a
3038 matching directory.
3039
3040 If you do switch this option on you should also consider setting the
3041 'secure' option (see |initialization|).
3042 Also see |.vimrc| and |gui-init|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003043 This option cannot be set from a |modeline| or in the |sandbox|, for
3044 security reasons.
3045
3046 *'fileencoding'* *'fenc'* *E213*
3047'fileencoding' 'fenc' string (default: "")
3048 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003049 Sets the character encoding for the file of this buffer.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003050
Bram Moolenaar071d4272004-06-13 20:20:40 +00003051 When 'fileencoding' is different from 'encoding', conversion will be
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003052 done when writing the file. For reading see below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003053 When 'fileencoding' is empty, the same value as 'encoding' will be
3054 used (no conversion when reading or writing a file).
Bram Moolenaar214641f2017-03-05 17:04:09 +01003055 No error will be given when the value is set, only when it is used,
3056 only when writing a file.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003057 Conversion will also be done when 'encoding' and 'fileencoding' are
3058 both a Unicode encoding and 'fileencoding' is not utf-8. That's
3059 because internally Unicode is always stored as utf-8.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003060 WARNING: Conversion can cause loss of information! When
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003061 'encoding' is "utf-8" or another Unicode encoding, conversion
3062 is most likely done in a way that the reverse conversion
3063 results in the same text. When 'encoding' is not "utf-8" some
3064 characters may be lost!
Bram Moolenaar865242e2010-07-14 21:12:05 +02003065
Bram Moolenaar071d4272004-06-13 20:20:40 +00003066 See 'encoding' for the possible values. Additionally, values may be
3067 specified that can be handled by the converter, see
3068 |mbyte-conversion|.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003069
Bram Moolenaar071d4272004-06-13 20:20:40 +00003070 When reading a file 'fileencoding' will be set from 'fileencodings'.
3071 To read a file in a certain encoding it won't work by setting
Bram Moolenaar02467872007-05-06 13:22:01 +00003072 'fileencoding', use the |++enc| argument. One exception: when
3073 'fileencodings' is empty the value of 'fileencoding' is used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003074 For a new file the global value of 'fileencoding' is used.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003075
Bram Moolenaar071d4272004-06-13 20:20:40 +00003076 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
3077 When the option is set, the value is converted to lowercase. Thus
3078 you can set it with uppercase values too. '_' characters are
3079 replaced with '-'. If a name is recognized from the list for
3080 'encoding', it is replaced by the standard name. For example
3081 "ISO8859-2" becomes "iso-8859-2".
Bram Moolenaar865242e2010-07-14 21:12:05 +02003082
Bram Moolenaar071d4272004-06-13 20:20:40 +00003083 When this option is set, after starting to edit a file, the 'modified'
3084 option is set, because the file would be different when written.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003085
3086 Keep in mind that changing 'fenc' from a modeline happens
3087 AFTER the text has been read, thus it applies to when the file will be
3088 written. If you do set 'fenc' in a modeline, you might want to set
3089 'nomodified' to avoid not being able to ":q".
3090
Bram Moolenaar071d4272004-06-13 20:20:40 +00003091 This option can not be changed when 'modifiable' is off.
3092
3093 *'fe'*
3094 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003095 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003096 old short name was 'fe', which is no longer used.
3097
3098 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003099'fileencodings' 'fencs' string (default: "ucs-bom",
3100 "ucs-bom,utf-8,default,latin1" when
3101 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003102 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003103 This is a list of character encodings considered when starting to edit
3104 an existing file. When a file is read, Vim tries to use the first
3105 mentioned character encoding. If an error is detected, the next one
3106 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003107 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00003108 an empty string, which means the value of 'encoding' is used.
3109 WARNING: Conversion can cause loss of information! When
3110 'encoding' is "utf-8" (or one of the other Unicode variants)
3111 conversion is most likely done in a way that the reverse
3112 conversion results in the same text. When 'encoding' is not
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003113 "utf-8" some non-ASCII characters may be lost! You can use
3114 the |++bad| argument to specify what is done with characters
3115 that can't be converted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003116 For an empty file or a file with only ASCII characters most encodings
3117 will work and the first entry of 'fileencodings' will be used (except
3118 "ucs-bom", which requires the BOM to be present). If you prefer
3119 another encoding use an BufReadPost autocommand event to test if your
3120 preferred encoding is to be used. Example: >
3121 au BufReadPost * if search('\S', 'w') == 0 |
3122 \ set fenc=iso-2022-jp | endif
3123< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
3124 non-blank characters.
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003125 When the |++enc| argument is used then the value of 'fileencodings' is
3126 not used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003127 Note that 'fileencodings' is not used for a new file, the global value
3128 of 'fileencoding' is used instead. You can set it with: >
3129 :setglobal fenc=iso-8859-2
3130< This means that a non-existing file may get a different encoding than
3131 an empty file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003132 The special value "ucs-bom" can be used to check for a Unicode BOM
3133 (Byte Order Mark) at the start of the file. It must not be preceded
3134 by "utf-8" or another Unicode encoding for this to work properly.
3135 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
3136 because Vim cannot detect an error, thus the encoding is always
3137 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003138 The special value "default" can be used for the encoding from the
K.Takataef8706f2021-05-31 18:40:49 +02003139 environment. On MS-Windows this is the system encoding. Otherwise
3140 this is the default value for 'encoding'. It is useful when
3141 'encoding' is set to "utf-8" and your environment uses a non-latin1
3142 encoding, such as Russian.
Bram Moolenaarca003e12006-03-17 23:19:38 +00003143 When 'encoding' is "utf-8" and a file contains an illegal byte
3144 sequence it won't be recognized as UTF-8. You can use the |8g8|
3145 command to find the illegal byte sequence.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003146 WRONG VALUES: WHAT'S WRONG:
3147 latin1,utf-8 "latin1" will always be used
3148 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
3149 file
3150 cp1250,latin1 "cp1250" will always be used
3151 If 'fileencodings' is empty, 'fileencoding' is not modified.
3152 See 'fileencoding' for the possible values.
3153 Setting this option does not have an effect until the next time a file
3154 is read.
3155
3156 *'fileformat'* *'ff'*
Bram Moolenaar00590742019-02-15 21:06:09 +01003157'fileformat' 'ff' string (MS-Windows default: "dos",
3158 Unix, macOS default: "unix")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003159 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003160 This gives the <EOL> of the current buffer, which is used for
3161 reading/writing the buffer from/to a file:
Bram Moolenaar4072ba52020-12-23 13:56:35 +01003162 dos <CR><NL>
Bram Moolenaar071d4272004-06-13 20:20:40 +00003163 unix <NL>
3164 mac <CR>
3165 When "dos" is used, CTRL-Z at the end of a file is ignored.
3166 See |file-formats| and |file-read|.
3167 For the character encoding of the file see 'fileencoding'.
3168 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
Bram Moolenaarbf884932013-04-05 22:26:15 +02003169 works like it was set to "unix".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003170 This option is set automatically when starting to edit a file and
3171 'fileformats' is not empty and 'binary' is off.
3172 When this option is set, after starting to edit a file, the 'modified'
3173 option is set, because the file would be different when written.
3174 This option can not be changed when 'modifiable' is off.
3175 For backwards compatibility: When this option is set to "dos",
3176 'textmode' is set, otherwise 'textmode' is reset.
3177
3178 *'fileformats'* *'ffs'*
3179'fileformats' 'ffs' string (default:
Bram Moolenaar00590742019-02-15 21:06:09 +01003180 Vim+Vi MS-Windows: "dos,unix",
3181 Vim Unix, macOS: "unix,dos",
Bram Moolenaar071d4272004-06-13 20:20:40 +00003182 Vi Cygwin: "unix,dos",
3183 Vi others: "")
3184 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003185 This gives the end-of-line (<EOL>) formats that will be tried when
3186 starting to edit a new buffer and when reading a file into an existing
3187 buffer:
3188 - When empty, the format defined with 'fileformat' will be used
3189 always. It is not set automatically.
3190 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003191 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003192 'fileformats' name will be used when a file is read into an existing
3193 buffer, no matter what 'fileformat' for that buffer is set to.
3194 - When more than one name is present, separated by commas, automatic
3195 <EOL> detection will be done when reading a file. When starting to
3196 edit a file, a check is done for the <EOL>:
3197 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
3198 'fileformat' is set to "dos".
3199 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003200 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003201 preceding <CR>, "unix" is preferred over "dos".
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01003202 3. If 'fileformat' has not yet been set, and if a <CR> is found, and
3203 if 'fileformats' includes "mac", 'fileformat' is set to "mac".
Bram Moolenaar00659062010-09-21 22:34:02 +02003204 This means that "mac" is only chosen when:
3205 "unix" is not present or no <NL> is found in the file, and
3206 "dos" is not present or no <CR><NL> is found in the file.
3207 Except: if "unix" was chosen, but there is a <CR> before
3208 the first <NL>, and there appear to be more <CR>s than <NL>s in
Bram Moolenaar166af9b2010-11-16 20:34:40 +01003209 the first few lines, "mac" is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003210 4. If 'fileformat' is still not set, the first name from
3211 'fileformats' is used.
3212 When reading a file into an existing buffer, the same is done, but
3213 this happens like 'fileformat' has been set appropriately for that
3214 file only, the option is not changed.
3215 When 'binary' is set, the value of 'fileformats' is not used.
3216
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01003217 When Vim starts up with an empty buffer the first item is used. You
3218 can overrule this by setting 'fileformat' in your .vimrc.
Bram Moolenaar81af9252010-12-10 20:35:50 +01003219
Bram Moolenaar071d4272004-06-13 20:20:40 +00003220 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
3221 are ":source"ed and for vimrc files, automatic <EOL> detection may be
3222 done:
3223 - When 'fileformats' is empty, there is no automatic detection. Dos
3224 format will be used.
3225 - When 'fileformats' is set to one or more names, automatic detection
3226 is done. This is based on the first <NL> in the file: If there is a
3227 <CR> in front of it, Dos format is used, otherwise Unix format is
3228 used.
3229 Also see |file-formats|.
3230 For backwards compatibility: When this option is set to an empty
3231 string or one format (no comma is included), 'textauto' is reset,
3232 otherwise 'textauto' is set.
3233 NOTE: This option is set to the Vi default value when 'compatible' is
3234 set and to the Vim default value when 'compatible' is reset.
3235
Bram Moolenaarbf884932013-04-05 22:26:15 +02003236 *'fileignorecase'* *'fic'* *'nofileignorecase'* *'nofic'*
3237'fileignorecase' 'fic' boolean (default on for systems where case in file
3238 names is normally ignored)
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003239 global
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003240 When set case is ignored when using file names and directories.
3241 See 'wildignorecase' for only ignoring case when doing completion.
3242
Bram Moolenaar071d4272004-06-13 20:20:40 +00003243 *'filetype'* *'ft'*
3244'filetype' 'ft' string (default: "")
3245 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003246 When this option is set, the FileType autocommand event is triggered.
3247 All autocommands that match with the value of this option will be
3248 executed. Thus the value of 'filetype' is used in place of the file
3249 name.
3250 Otherwise this option does not always reflect the current file type.
3251 This option is normally set when the file type is detected. To enable
3252 this use the ":filetype on" command. |:filetype|
3253 Setting this option to a different value is most useful in a modeline,
3254 for a file for which the file type is not automatically recognized.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003255 Example, for in an IDL file:
3256 /* vim: set filetype=idl : */ ~
3257 |FileType| |filetypes|
3258 When a dot appears in the value then this separates two filetype
3259 names. Example:
3260 /* vim: set filetype=c.doxygen : */ ~
3261 This will use the "c" filetype first, then the "doxygen" filetype.
3262 This works both for filetype plugins and for syntax files. More than
3263 one dot may appear.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003264 This option is not copied to another buffer, independent of the 's' or
3265 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003266 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003267
3268 *'fillchars'* *'fcs'*
Bram Moolenaara98f8a22021-02-13 18:24:23 +01003269'fillchars' 'fcs' string (default "vert:|,fold:-,eob:~")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003270 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02003271 {not available when compiled without the |+folding|
3272 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003273 Characters to fill the statuslines and vertical separators.
3274 It is a comma separated list of items:
3275
3276 item default Used for ~
3277 stl:c ' ' or '^' statusline of the current window
Bram Moolenaar38a55632016-02-15 22:07:32 +01003278 stlnc:c ' ' or '=' statusline of the non-current windows
Bram Moolenaar071d4272004-06-13 20:20:40 +00003279 vert:c '|' vertical separators |:vsplit|
3280 fold:c '-' filling 'foldtext'
Bram Moolenaar3aca5a62021-02-17 13:14:07 +01003281 foldopen:c '-' mark the beginning of a fold
3282 foldclose:c '+' show a closed fold
3283 foldsep:c '|' open fold middle character
Bram Moolenaar071d4272004-06-13 20:20:40 +00003284 diff:c '-' deleted lines of the 'diff' option
Bram Moolenaara98f8a22021-02-13 18:24:23 +01003285 eob:c '~' empty lines below the end of a buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003286
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003287 Any one that is omitted will fall back to the default. For "stl" and
Bram Moolenaar38a55632016-02-15 22:07:32 +01003288 "stlnc" the space will be used when there is highlighting, '^' or '='
Bram Moolenaar071d4272004-06-13 20:20:40 +00003289 otherwise.
3290
3291 Example: >
Bram Moolenaar38a55632016-02-15 22:07:32 +01003292 :set fillchars=stl:^,stlnc:=,vert:\|,fold:-,diff:-
Bram Moolenaar071d4272004-06-13 20:20:40 +00003293< This is similar to the default, except that these characters will also
3294 be used when there is highlighting.
3295
Bram Moolenaar008bff92021-03-04 21:55:58 +01003296 For "stl" and "stlnc" single-byte and multibyte characters are
3297 supported. But double-width characters are not supported.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003298
Bram Moolenaar071d4272004-06-13 20:20:40 +00003299 The highlighting used for these items:
3300 item highlight group ~
3301 stl:c StatusLine |hl-StatusLine|
3302 stlnc:c StatusLineNC |hl-StatusLineNC|
3303 vert:c VertSplit |hl-VertSplit|
3304 fold:c Folded |hl-Folded|
3305 diff:c DiffDelete |hl-DiffDelete|
Bram Moolenaara98f8a22021-02-13 18:24:23 +01003306 eob:c EndOfBuffer |hl-EndOfBuffer|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003307
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003308 *'fixendofline'* *'fixeol'* *'nofixendofline'* *'nofixeol'*
3309'fixendofline' 'fixeol' boolean (default on)
3310 local to buffer
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003311 When writing a file and this option is on, <EOL> at the end of file
3312 will be restored if missing. Turn this option off if you want to
3313 preserve the situation from the original file.
3314 When the 'binary' option is set the value of this option doesn't
3315 matter.
3316 See the 'endofline' option.
3317
Bram Moolenaar071d4272004-06-13 20:20:40 +00003318 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
Bram Moolenaar98a29d02021-01-18 19:55:44 +01003319'fkmap' 'fk' boolean (default off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003320 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003321 {only available when compiled with the |+rightleft|
3322 feature}
Bram Moolenaar14184a32019-02-16 15:10:30 +01003323 This option was for using Farsi, which has been removed. See
3324 |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003325
3326 *'foldclose'* *'fcl'*
3327'foldclose' 'fcl' string (default "")
3328 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003329 {not available when compiled without the |+folding|
3330 feature}
3331 When set to "all", a fold is closed when the cursor isn't in it and
3332 its level is higher than 'foldlevel'. Useful if you want folds to
3333 automatically close when moving out of them.
3334
3335 *'foldcolumn'* *'fdc'*
3336'foldcolumn' 'fdc' number (default 0)
3337 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003338 {not available when compiled without the |+folding|
3339 feature}
3340 When non-zero, a column with the specified width is shown at the side
3341 of the window which indicates open and closed folds. The maximum
3342 value is 12.
3343 See |folding|.
3344
3345 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
3346'foldenable' 'fen' boolean (default on)
3347 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003348 {not available when compiled without the |+folding|
3349 feature}
3350 When off, all folds are open. This option can be used to quickly
3351 switch between showing all text unfolded and viewing the text with
3352 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003353 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00003354 'foldenable' is off.
3355 This option is set by commands that create a new fold or close a fold.
3356 See |folding|.
3357
3358 *'foldexpr'* *'fde'*
3359'foldexpr' 'fde' string (default: "0")
3360 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003361 {not available when compiled without the |+folding|
Bram Moolenaardb84e452010-08-15 13:50:43 +02003362 or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003363 The expression used for when 'foldmethod' is "expr". It is evaluated
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003364 for each line to obtain its fold level. See |fold-expr|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003365
Bram Moolenaar30b65812012-07-12 22:01:11 +02003366 The expression will be evaluated in the |sandbox| if set from a
3367 modeline, see |sandbox-option|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003368 This option can't be set from a |modeline| when the 'diff' option is
Bram Moolenaar110289e2019-05-23 15:38:06 +02003369 on or the 'modelineexpr' option is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003370
3371 It is not allowed to change text or jump to another window while
3372 evaluating 'foldexpr' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003373
3374 *'foldignore'* *'fdi'*
3375'foldignore' 'fdi' string (default: "#")
3376 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003377 {not available when compiled without the |+folding|
3378 feature}
3379 Used only when 'foldmethod' is "indent". Lines starting with
3380 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003381 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003382 The default "#" works well for C programs. See |fold-indent|.
3383
3384 *'foldlevel'* *'fdl'*
3385'foldlevel' 'fdl' number (default: 0)
3386 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003387 {not available when compiled without the |+folding|
3388 feature}
3389 Sets the fold level: Folds with a higher level will be closed.
3390 Setting this option to zero will close all folds. Higher numbers will
3391 close fewer folds.
3392 This option is set by commands like |zm|, |zM| and |zR|.
3393 See |fold-foldlevel|.
3394
3395 *'foldlevelstart'* *'fdls'*
3396'foldlevelstart' 'fdls' number (default: -1)
3397 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003398 {not available when compiled without the |+folding|
3399 feature}
3400 Sets 'foldlevel' when starting to edit another buffer in a window.
3401 Useful to always start editing with all folds closed (value zero),
3402 some folds closed (one) or no folds closed (99).
3403 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003404 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00003405 ignores this option and closes all folds.
3406 It is also done before BufReadPre autocommands, to allow an autocmd to
3407 overrule the 'foldlevel' value for specific files.
3408 When the value is negative, it is not used.
3409
3410 *'foldmarker'* *'fmr'* *E536*
3411'foldmarker' 'fmr' string (default: "{{{,}}}")
3412 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003413 {not available when compiled without the |+folding|
3414 feature}
3415 The start and end marker used when 'foldmethod' is "marker". There
3416 must be one comma, which separates the start and end marker. The
3417 marker is a literal string (a regular expression would be too slow).
3418 See |fold-marker|.
3419
3420 *'foldmethod'* *'fdm'*
3421'foldmethod' 'fdm' string (default: "manual")
3422 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003423 {not available when compiled without the |+folding|
3424 feature}
3425 The kind of folding used for the current window. Possible values:
3426 |fold-manual| manual Folds are created manually.
3427 |fold-indent| indent Lines with equal indent form a fold.
3428 |fold-expr| expr 'foldexpr' gives the fold level of a line.
3429 |fold-marker| marker Markers are used to specify folds.
3430 |fold-syntax| syntax Syntax highlighting items specify folds.
3431 |fold-diff| diff Fold text that is not changed.
3432
3433 *'foldminlines'* *'fml'*
3434'foldminlines' 'fml' number (default: 1)
3435 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003436 {not available when compiled without the |+folding|
3437 feature}
Bram Moolenaar00654022011-02-25 14:42:19 +01003438 Sets the number of screen lines above which a fold can be displayed
3439 closed. Also for manually closed folds. With the default value of
3440 one a fold can only be closed if it takes up two or more screen lines.
3441 Set to zero to be able to close folds of just one screen line.
Bram Moolenaar446beb42011-05-10 17:18:44 +02003442 Note that this only has an effect on what is displayed. After using
Bram Moolenaar071d4272004-06-13 20:20:40 +00003443 "zc" to close a fold, which is displayed open because it's smaller
3444 than 'foldminlines', a following "zc" may close a containing fold.
3445
3446 *'foldnestmax'* *'fdn'*
3447'foldnestmax' 'fdn' number (default: 20)
3448 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003449 {not available when compiled without the |+folding|
3450 feature}
3451 Sets the maximum nesting of folds for the "indent" and "syntax"
3452 methods. This avoids that too many folds will be created. Using more
3453 than 20 doesn't work, because the internal limit is 20.
3454
3455 *'foldopen'* *'fdo'*
3456'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
3457 search,tag,undo")
3458 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003459 {not available when compiled without the |+folding|
3460 feature}
3461 Specifies for which type of commands folds will be opened, if the
3462 command moves the cursor into a closed fold. It is a comma separated
3463 list of items.
Bram Moolenaar05365702010-10-27 18:34:44 +02003464 NOTE: When the command is part of a mapping this option is not used.
3465 Add the |zv| command to the mapping to get the same effect.
3466 (rationale: the mapping may want to control opening folds itself)
3467
Bram Moolenaar071d4272004-06-13 20:20:40 +00003468 item commands ~
3469 all any
3470 block "(", "{", "[[", "[{", etc.
3471 hor horizontal movements: "l", "w", "fx", etc.
3472 insert any command in Insert mode
3473 jump far jumps: "G", "gg", etc.
3474 mark jumping to a mark: "'m", CTRL-O, etc.
3475 percent "%"
3476 quickfix ":cn", ":crew", ":make", etc.
3477 search search for a pattern: "/", "n", "*", "gd", etc.
3478 (not for a search pattern in a ":" command)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003479 Also for |[s| and |]s|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003480 tag jumping to a tag: ":ta", CTRL-T, etc.
3481 undo undo or redo: "u" and CTRL-R
Bram Moolenaar071d4272004-06-13 20:20:40 +00003482 When a movement command is used for an operator (e.g., "dl" or "y%")
3483 this option is not used. This means the operator will include the
3484 whole closed fold.
3485 Note that vertical movements are not here, because it would make it
3486 very difficult to move onto a closed fold.
3487 In insert mode the folds containing the cursor will always be open
3488 when text is inserted.
3489 To close folds you can re-apply 'foldlevel' with the |zx| command or
3490 set the 'foldclose' option to "all".
3491
3492 *'foldtext'* *'fdt'*
3493'foldtext' 'fdt' string (default: "foldtext()")
3494 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003495 {not available when compiled without the |+folding|
3496 feature}
3497 An expression which is used to specify the text displayed for a closed
3498 fold. See |fold-foldtext|.
3499
Bram Moolenaar30b65812012-07-12 22:01:11 +02003500 The expression will be evaluated in the |sandbox| if set from a
3501 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003502 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003503
3504 It is not allowed to change text or jump to another window while
3505 evaluating 'foldtext' |textlock|.
3506
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003507 *'formatexpr'* *'fex'*
3508'formatexpr' 'fex' string (default "")
3509 local to buffer
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003510 {not available when compiled without the |+eval|
3511 feature}
3512 Expression which is evaluated to format a range of lines for the |gq|
3513 operator or automatic formatting (see 'formatoptions'). When this
3514 option is empty 'formatprg' is used.
3515
3516 The |v:lnum| variable holds the first line to be formatted.
3517 The |v:count| variable holds the number of lines to be formatted.
3518 The |v:char| variable holds the character that is going to be
3519 inserted if the expression is being evaluated due to
3520 automatic formatting. This can be empty. Don't insert
3521 it yet!
3522
3523 Example: >
3524 :set formatexpr=mylang#Format()
3525< This will invoke the mylang#Format() function in the
3526 autoload/mylang.vim file in 'runtimepath'. |autoload|
3527
3528 The expression is also evaluated when 'textwidth' is set and adding
3529 text beyond that limit. This happens under the same conditions as
3530 when internal formatting is used. Make sure the cursor is kept in the
3531 same spot relative to the text then! The |mode()| function will
3532 return "i" or "R" in this situation.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01003533
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003534 When the expression evaluates to non-zero Vim will fall back to using
3535 the internal format mechanism.
3536
3537 The expression will be evaluated in the |sandbox| when set from a
3538 modeline, see |sandbox-option|. That stops the option from working,
3539 since changing the buffer text is not allowed.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003540 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaar036986f2017-03-16 17:41:02 +01003541 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003542
Bram Moolenaar86b68352004-12-27 21:59:20 +00003543 *'formatlistpat'* *'flp'*
3544'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
3545 local to buffer
Bram Moolenaar86b68352004-12-27 21:59:20 +00003546 A pattern that is used to recognize a list header. This is used for
3547 the "n" flag in 'formatoptions'.
3548 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00003549 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00003550 while still checking more characters. There must be a character
3551 following the pattern, when it matches the whole line it is handled
3552 like there is no match.
3553 The default recognizes a number, followed by an optional punctuation
3554 character and white space.
3555
Bram Moolenaar6c60f472019-04-28 16:00:35 +02003556 *'formatoptions'* *'fo'*
3557'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
3558 local to buffer
3559 This is a sequence of letters which describes how automatic
3560 formatting is to be done. See |fo-table|. When the 'paste' option is
3561 on, no formatting is done (like 'formatoptions' is empty). Commas can
3562 be inserted for readability.
3563 To avoid problems with flags that are added in the future, use the
3564 "+=" and "-=" feature of ":set" |add-option-flags|.
3565 NOTE: This option is set to the Vi default value when 'compatible' is
3566 set and to the Vim default value when 'compatible' is reset.
3567
Bram Moolenaar071d4272004-06-13 20:20:40 +00003568 *'formatprg'* *'fp'*
3569'formatprg' 'fp' string (default "")
Bram Moolenaar9be7c042017-01-14 14:28:30 +01003570 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003571 The name of an external program that will be used to format the lines
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003572 selected with the |gq| operator. The program must take the input on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003573 stdin and produce the output on stdout. The Unix program "fmt" is
Bram Moolenaara5792f52005-11-23 21:25:05 +00003574 such a program.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003575 If the 'formatexpr' option is not empty it will be used instead.
3576 Otherwise, if 'formatprg' option is an empty string, the internal
3577 format function will be used |C-indenting|.
Bram Moolenaara5792f52005-11-23 21:25:05 +00003578 Environment variables are expanded |:set_env|. See |option-backslash|
3579 about including spaces and backslashes.
Bram Moolenaar30b65812012-07-12 22:01:11 +02003580 This option cannot be set from a |modeline| or in the |sandbox|, for
3581 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003582
Bram Moolenaard94464e2015-11-02 15:28:18 +01003583 *'fsync'* *'fs'* *'nofsync'* *'nofs'*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003584'fsync' 'fs' boolean (default on)
3585 global
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003586 When on, the library function fsync() will be called after writing a
3587 file. This will flush a file to disk, ensuring that it is safely
3588 written even on filesystems which do metadata-only journaling. This
3589 will force the harddrive to spin up on Linux systems running in laptop
3590 mode, so it may be undesirable in some situations. Be warned that
3591 turning this off increases the chances of data loss after a crash. On
3592 systems without an fsync() implementation, this variable is always
3593 off.
3594 Also see 'swapsync' for controlling fsync() on swap files.
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003595 'fsync' also applies to |writefile()|, unless a flag is used to
3596 overrule it.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003597 This option cannot be set from a |modeline| or in the |sandbox|, for
3598 security reasons.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003599
Bram Moolenaar071d4272004-06-13 20:20:40 +00003600 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
3601'gdefault' 'gd' boolean (default off)
3602 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003603 When on, the ":substitute" flag 'g' is default on. This means that
3604 all matches in a line are substituted instead of one. When a 'g' flag
3605 is given to a ":substitute" command, this will toggle the substitution
3606 of all or one match. See |complex-change|.
3607
3608 command 'gdefault' on 'gdefault' off ~
3609 :s/// subst. all subst. one
3610 :s///g subst. one subst. all
3611 :s///gg subst. all subst. one
3612
3613 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar21020352017-06-13 17:21:04 +02003614 DEPRECATED: Setting this option may break plugins that are not aware
3615 of this option. Also, many users get confused that adding the /g flag
3616 has the opposite effect of that it normally does.
Bram Moolenaar4072ba52020-12-23 13:56:35 +01003617 This option is not used in |Vim9| script.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003618
3619 *'grepformat'* *'gfm'*
Bram Moolenaar6e932462014-09-09 18:48:09 +02003620'grepformat' 'gfm' string (default "%f:%l:%m,%f:%l%m,%f %l%m")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003621 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003622 Format to recognize for the ":grep" command output.
3623 This is a scanf-like string that uses the same format as the
3624 'errorformat' option: see |errorformat|.
3625
3626 *'grepprg'* *'gp'*
3627'grepprg' 'gp' string (default "grep -n ",
3628 Unix: "grep -n $* /dev/null",
3629 Win32: "findstr /n" or "grep -n",
3630 VMS: "SEARCH/NUMBERS ")
3631 global or local to buffer |global-local|
Bram Moolenaar582fd852005-03-28 20:58:01 +00003632 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003633 and '#' characters, which are expanded like when used in a command-
3634 line. The placeholder "$*" is allowed to specify where the arguments
3635 will be included. Environment variables are expanded |:set_env|. See
3636 |option-backslash| about including spaces and backslashes.
3637 When your "grep" accepts the "-H" argument, use this to make ":grep"
3638 also work well with a single file: >
3639 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00003640< Special value: When 'grepprg' is set to "internal" the |:grep| command
Bram Moolenaara6557602006-02-04 22:43:20 +00003641 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like
3642 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00003643 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00003644 apply equally to 'grepprg'.
3645 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
3646 otherwise it's "grep -n".
3647 This option cannot be set from a |modeline| or in the |sandbox|, for
3648 security reasons.
3649
3650 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
3651'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
3652 ve:ver35-Cursor,
3653 o:hor50-Cursor,
3654 i-ci:ver25-Cursor/lCursor,
3655 r-cr:hor20-Cursor/lCursor,
3656 sm:block-Cursor
3657 -blinkwait175-blinkoff150-blinkon175",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003658 for Win32 console:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003659 "n-v-c:block,o:hor50,i-ci:hor15,
3660 r-cr:hor30,sm:block")
3661 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003662 {only available when compiled with GUI enabled, and
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003663 for Win32 console}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003664 This option tells Vim what the cursor should look like in different
Bram Moolenaar8024f932020-01-14 19:29:13 +01003665 modes. It fully works in the GUI. In a Win32 console, only the
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003666 height of the cursor can be changed. This can be done by specifying a
3667 block cursor, or a percentage for a vertical or horizontal cursor.
Bram Moolenaar1e7813a2015-03-31 18:31:03 +02003668 For a console the 't_SI', 't_SR', and 't_EI' escape sequences are
3669 used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003670
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003671 The option is a comma separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003672 mode-list and an argument-list:
3673 mode-list:argument-list,mode-list:argument-list,..
3674 The mode-list is a dash separated list of these modes:
3675 n Normal mode
3676 v Visual mode
3677 ve Visual mode with 'selection' "exclusive" (same as 'v',
3678 if not specified)
3679 o Operator-pending mode
3680 i Insert mode
3681 r Replace mode
3682 c Command-line Normal (append) mode
3683 ci Command-line Insert mode
3684 cr Command-line Replace mode
3685 sm showmatch in Insert mode
3686 a all modes
3687 The argument-list is a dash separated list of these arguments:
3688 hor{N} horizontal bar, {N} percent of the character height
3689 ver{N} vertical bar, {N} percent of the character width
3690 block block cursor, fills the whole character
3691 [only one of the above three should be present]
3692 blinkwait{N} *cursor-blinking*
3693 blinkon{N}
3694 blinkoff{N}
3695 blink times for cursor: blinkwait is the delay before
3696 the cursor starts blinking, blinkon is the time that
3697 the cursor is shown and blinkoff is the time that the
3698 cursor is not shown. The times are in msec. When one
3699 of the numbers is zero, there is no blinking. The
3700 default is: "blinkwait700-blinkon400-blinkoff250".
3701 These numbers are used for a missing entry. This
3702 means that blinking is enabled by default. To switch
3703 blinking off you can use "blinkon0". The cursor only
3704 blinks when Vim is waiting for input, not while
3705 executing a command.
3706 To make the cursor blink in an xterm, see
3707 |xterm-blink|.
3708 {group-name}
3709 a highlight group name, that sets the color and font
3710 for the cursor
3711 {group-name}/{group-name}
3712 Two highlight group names, the first is used when
3713 no language mappings are used, the other when they
3714 are. |language-mapping|
3715
3716 Examples of parts:
3717 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
3718 block cursor with colors from the "nCursor"
3719 highlight group
3720 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
3721 In Insert and Command-line Insert mode, use a
3722 30% vertical bar cursor with colors from the
3723 "iCursor" highlight group. Blink a bit
3724 faster.
3725
3726 The 'a' mode is different. It will set the given argument-list for
3727 all modes. It does not reset anything to defaults. This can be used
3728 to do a common setting for all modes. For example, to switch off
3729 blinking: "a:blinkon0"
3730
3731 Examples of cursor highlighting: >
3732 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
3733 :highlight Cursor gui=NONE guifg=bg guibg=fg
3734<
3735 *'guifont'* *'gfn'*
Bram Moolenaar251e1912011-06-19 05:09:16 +02003736 *E235* *E596*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003737'guifont' 'gfn' string (default "")
3738 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003739 {only available when compiled with GUI enabled}
3740 This is a list of fonts which will be used for the GUI version of Vim.
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003741 In its simplest form the value is just one font name.
3742 See |gui-font| for the details.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003743
3744 *'guifontset'* *'gfs'*
3745 *E250* *E252* *E234* *E597* *E598*
3746'guifontset' 'gfs' string (default "")
3747 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003748 {only available when compiled with GUI enabled and
3749 with the |+xfontset| feature}
Bram Moolenaar3df01732017-02-17 22:47:16 +01003750 {not available in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003751 When not empty, specifies two (or more) fonts to be used. The first
3752 one for normal English, the second one for your special language. See
3753 |xfontset|.
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003754
Bram Moolenaar071d4272004-06-13 20:20:40 +00003755 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
3756'guifontwide' 'gfw' string (default "")
3757 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003758 {only available when compiled with GUI enabled}
3759 When not empty, specifies a comma-separated list of fonts to be used
3760 for double-width characters. The first font that can be loaded is
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003761 used. See |gui-fontwide|.
Bram Moolenaar0f272122013-01-23 18:37:40 +01003762
Bram Moolenaar071d4272004-06-13 20:20:40 +00003763 *'guiheadroom'* *'ghr'*
3764'guiheadroom' 'ghr' number (default 50)
3765 global
Bram Moolenaar110289e2019-05-23 15:38:06 +02003766 {only for GTK and X11 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003767 The number of pixels subtracted from the screen height when fitting
3768 the GUI window on the screen. Set this before the GUI is started,
3769 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003770 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00003771 lines will be left for window decorations and other items on the
3772 screen. Set it to a negative value to allow windows taller than the
3773 screen.
3774
3775 *'guioptions'* *'go'*
Bram Moolenaar2c64ca12018-10-19 16:22:31 +02003776'guioptions' 'go' string (default "egmrLtT" (MS-Windows,
3777 "t" is removed in |defaults.vim|),
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02003778 "aegimrLtT" (GTK, Motif and Athena),
3779 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00003780 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003781 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00003782 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003783 sequence of letters which describes what components and options of the
3784 GUI should be used.
3785 To avoid problems with flags that are added in the future, use the
3786 "+=" and "-=" feature of ":set" |add-option-flags|.
3787
Bram Moolenaar13568252018-03-16 20:46:58 +01003788 Valid characters are as follows:
3789 *'go-!'*
3790 '!' External commands are executed in a terminal window. Without
3791 this flag the MS-Windows GUI will open a console window to
3792 execute the command. The Unix GUI will simulate a dumb
3793 terminal to list the command output.
3794 The terminal window will be positioned at the bottom, and grow
3795 upwards as needed.
Bram Moolenaarba3ff532018-11-04 14:45:49 +01003796 *'go-a'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003797 'a' Autoselect: If present, then whenever VISUAL mode is started,
3798 or the Visual area extended, Vim tries to become the owner of
3799 the windowing system's global selection. This means that the
3800 Visually highlighted text is available for pasting into other
3801 applications as well as into Vim itself. When the Visual mode
3802 ends, possibly due to an operation on the text, or when an
3803 application wants to paste the selection, the highlighted text
3804 is automatically yanked into the "* selection register.
3805 Thus the selection is still available for pasting into other
3806 applications after the VISUAL mode has ended.
3807 If not present, then Vim won't become the owner of the
3808 windowing system's global selection unless explicitly told to
3809 by a yank or delete operation for the "* register.
3810 The same applies to the modeless selection.
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02003811 *'go-P'*
3812 'P' Like autoselect but using the "+ register instead of the "*
Bram Moolenaar3848e002016-03-19 18:42:29 +01003813 register.
Bram Moolenaar02467872007-05-06 13:22:01 +00003814 *'go-A'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003815 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003816 applies to the modeless selection.
3817
3818 'guioptions' autoselect Visual autoselect modeless ~
3819 "" - -
3820 "a" yes yes
3821 "A" - yes
3822 "aA" yes yes
3823
Bram Moolenaar02467872007-05-06 13:22:01 +00003824 *'go-c'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003825 'c' Use console dialogs instead of popup dialogs for simple
3826 choices.
Bram Moolenaar50bf7ce2019-09-15 13:17:00 +02003827 *'go-d'*
3828 'd' Use dark theme variant if available. Currently only works for
3829 GTK+ GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00003830 *'go-e'*
Bram Moolenaare224ffa2006-03-01 00:01:28 +00003831 'e' Add tab pages when indicated with 'showtabline'.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003832 'guitablabel' can be used to change the text in the labels.
3833 When 'e' is missing a non-GUI tab pages line may be used.
Bram Moolenaard68071d2006-05-02 22:08:30 +00003834 The GUI tabs are only supported on some systems, currently
Bram Moolenaarb3f74062020-02-26 16:16:53 +01003835 GTK, Motif, Mac OS/X, Haiku, and MS-Windows.
Bram Moolenaar02467872007-05-06 13:22:01 +00003836 *'go-f'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003837 'f' Foreground: Don't use fork() to detach the GUI from the shell
3838 where it was started. Use this for programs that wait for the
3839 editor to finish (e.g., an e-mail program). Alternatively you
3840 can use "gvim -f" or ":gui -f" to start the GUI in the
3841 foreground. |gui-fork|
3842 Note: Set this option in the vimrc file. The forking may have
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003843 happened already when the |gvimrc| file is read.
Bram Moolenaar02467872007-05-06 13:22:01 +00003844 *'go-i'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003845 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
3846 corner of the window. It's black&white on non-GTK, because of
3847 limitations of X11. For a color icon, see |X11-icon|.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003848 *'go-m'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003849 'm' Menu bar is present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003850 *'go-M'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003851 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00003852 that this flag must be added in the .vimrc file, before
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003853 switching on syntax or filetype recognition (when the |gvimrc|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003854 file is sourced the system menu has already been loaded; the
Bram Moolenaar01164a62017-11-02 22:58:42 +01003855 `:syntax on` and `:filetype on` commands load the menu too).
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003856 *'go-g'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003857 'g' Grey menu items: Make menu items that are not active grey. If
3858 'g' is not included inactive menu items are not shown at all.
3859 Exception: Athena will always use grey menu items.
Bram Moolenaar02467872007-05-06 13:22:01 +00003860 *'go-t'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003861 't' Include tearoff menu items. Currently only works for Win32,
3862 GTK+, and Motif 1.2 GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00003863 *'go-T'*
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00003864 'T' Include Toolbar. Currently only in Win32, GTK+, Motif, Photon
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00003865 and Athena GUIs.
Bram Moolenaar02467872007-05-06 13:22:01 +00003866 *'go-r'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003867 'r' Right-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003868 *'go-R'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003869 'R' Right-hand scrollbar is present when there is a vertically
3870 split window.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003871 *'go-l'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003872 'l' Left-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003873 *'go-L'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003874 'L' Left-hand scrollbar is present when there is a vertically
3875 split window.
Bram Moolenaar02467872007-05-06 13:22:01 +00003876 *'go-b'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003877 'b' Bottom (horizontal) scrollbar is present. Its size depends on
3878 the longest visible line, or on the cursor line if the 'h'
3879 flag is included. |gui-horiz-scroll|
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003880 *'go-h'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003881 'h' Limit horizontal scrollbar size to the length of the cursor
3882 line. Reduces computations. |gui-horiz-scroll|
3883
3884 And yes, you may even have scrollbars on the left AND the right if
3885 you really want to :-). See |gui-scrollbars| for more information.
3886
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003887 *'go-v'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003888 'v' Use a vertical button layout for dialogs. When not included,
3889 a horizontal layout is preferred, but when it doesn't fit a
Bram Moolenaardad44732021-03-31 20:07:33 +02003890 vertical layout is used anyway. Not supported in GTK 3.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003891 *'go-p'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003892 'p' Use Pointer callbacks for X11 GUI. This is required for some
3893 window managers. If the cursor is not blinking or hollow at
3894 the right moment, try adding this flag. This must be done
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003895 before starting the GUI. Set it in your |gvimrc|. Adding or
Bram Moolenaar071d4272004-06-13 20:20:40 +00003896 removing it after the GUI has started has no effect.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003897 *'go-F'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003898 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar8ac44152017-11-09 18:33:29 +01003899 *'go-k'*
3900 'k' Keep the GUI window size when adding/removing a scrollbar, or
3901 toolbar, tabline, etc. Instead, the behavior is similar to
3902 when the window is maximized and will adjust 'lines' and
3903 'columns' to fit to the window. Without the 'k' flag Vim will
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003904 try to keep 'lines' and 'columns' the same when adding and
Bram Moolenaar8ac44152017-11-09 18:33:29 +01003905 removing GUI components.
Bram Moolenaar02467872007-05-06 13:22:01 +00003906
Bram Moolenaar071d4272004-06-13 20:20:40 +00003907 *'guipty'* *'noguipty'*
3908'guipty' boolean (default on)
3909 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003910 {only available when compiled with GUI enabled}
3911 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
3912 I/O to/from shell commands. See |gui-pty|.
3913
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003914 *'guitablabel'* *'gtl'*
3915'guitablabel' 'gtl' string (default empty)
3916 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02003917 {only available when compiled with GUI enabled}
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003918 When nonempty describes the text to use in a label of the GUI tab
Bram Moolenaard68071d2006-05-02 22:08:30 +00003919 pages line. When empty and when the result is empty Vim will use a
3920 default label. See |setting-guitablabel| for more info.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003921
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003922 The format of this option is like that of 'statusline'.
Bram Moolenaar57657d82006-04-21 22:12:41 +00003923 'guitabtooltip' is used for the tooltip, see below.
Bram Moolenaar51628222016-12-01 23:03:28 +01003924 The expression will be evaluated in the |sandbox| when set from a
3925 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003926 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003927
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003928 Only used when the GUI tab pages line is displayed. 'e' must be
3929 present in 'guioptions'. For the non-GUI tab pages line 'tabline' is
3930 used.
3931
Bram Moolenaar57657d82006-04-21 22:12:41 +00003932 *'guitabtooltip'* *'gtt'*
3933'guitabtooltip' 'gtt' string (default empty)
3934 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02003935 {only available when compiled with GUI enabled}
Bram Moolenaar57657d82006-04-21 22:12:41 +00003936 When nonempty describes the text to use in a tooltip for the GUI tab
3937 pages line. When empty Vim will use a default tooltip.
3938 This option is otherwise just like 'guitablabel' above.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003939 You can include a line break. Simplest method is to use |:let|: >
3940 :let &guitabtooltip = "line one\nline two"
3941<
Bram Moolenaar57657d82006-04-21 22:12:41 +00003942
Bram Moolenaar071d4272004-06-13 20:20:40 +00003943 *'helpfile'* *'hf'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003944'helpfile' 'hf' string (default (MS-Windows) "$VIMRUNTIME\doc\help.txt"
Bram Moolenaar071d4272004-06-13 20:20:40 +00003945 (others) "$VIMRUNTIME/doc/help.txt")
3946 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003947 Name of the main help file. All distributed help files should be
3948 placed together in one directory. Additionally, all "doc" directories
3949 in 'runtimepath' will be used.
3950 Environment variables are expanded |:set_env|. For example:
3951 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003952 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00003953 spaces and backslashes.
3954 This option cannot be set from a |modeline| or in the |sandbox|, for
3955 security reasons.
3956
3957 *'helpheight'* *'hh'*
3958'helpheight' 'hh' number (default 20)
3959 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003960 Minimal initial height of the help window when it is opened with the
3961 ":help" command. The initial height of the help window is half of the
3962 current window, or (when the 'ea' option is on) the same as other
3963 windows. When the height is less than 'helpheight', the height is
3964 set to 'helpheight'. Set to zero to disable.
3965
3966 *'helplang'* *'hlg'*
3967'helplang' 'hlg' string (default: messages language or empty)
3968 global
3969 {only available when compiled with the |+multi_lang|
3970 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003971 Comma separated list of languages. Vim will use the first language
3972 for which the desired help can be found. The English help will always
3973 be used as a last resort. You can add "en" to prefer English over
3974 another language, but that will only find tags that exist in that
3975 language and not in the English help.
3976 Example: >
3977 :set helplang=de,it
3978< This will first search German, then Italian and finally English help
3979 files.
3980 When using |CTRL-]| and ":help!" in a non-English help file Vim will
3981 try to find the tag in the current language before using this option.
3982 See |help-translated|.
3983
3984 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
3985'hidden' 'hid' boolean (default off)
3986 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003987 When off a buffer is unloaded when it is |abandon|ed. When on a
3988 buffer becomes hidden when it is |abandon|ed. If the buffer is still
3989 displayed in another window, it does not become hidden, of course.
3990 The commands that move through the buffer list sometimes make a buffer
3991 hidden although the 'hidden' option is off: When the buffer is
3992 modified, 'autowrite' is off or writing is not possible, and the '!'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003993 flag was used. See also |windows.txt|.
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00003994 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003995 This option is set for one command with ":hide {command}" |:hide|.
3996 WARNING: It's easy to forget that you have changes in hidden buffers.
3997 Think twice when using ":q!" or ":qa!".
3998
3999 *'highlight'* *'hl'*
4000'highlight' 'hl' string (default (as a single string):
Bram Moolenaar58b85342016-08-14 19:54:54 +02004001 "8:SpecialKey,~:EndOfBuffer,@:NonText,
4002 d:Directory,e:ErrorMsg,i:IncSearch,
4003 l:Search,m:MoreMsg,M:ModeMsg,n:LineNr,
Bram Moolenaarefae76a2019-10-27 22:54:58 +01004004 a:LineNrAbove,b:LineNrBelow,
Bram Moolenaar58b85342016-08-14 19:54:54 +02004005 N:CursorLineNr,r:Question,s:StatusLine,
4006 S:StatusLineNC,c:VertSplit,t:Title,
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004007 v:Visual,V:VisualNOS,w:WarningMsg,
4008 W:WildMenu,f:Folded,F:FoldColumn,
4009 A:DiffAdd,C:DiffChange,D:DiffDelete,
4010 T:DiffText,>:SignColumn,-:Conceal,
Bram Moolenaarc8c88492018-12-27 23:59:26 +01004011 B:SpellBad,P:SpellCap,R:SpellRare,
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004012 L:SpellLocal,+:Pmenu,=:PmenuSel,
Bram Moolenaar21020352017-06-13 17:21:04 +02004013 x:PmenuSbar,X:PmenuThumb,*:TabLine,
4014 #:TabLineSel,_:TabLineFill,!:CursorColumn,
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02004015 .:CursorLine,o:ColorColumn,q:QuickFixLine,
Bram Moolenaarc572da52017-08-27 16:52:01 +02004016 z:StatusLineTerm,Z:StatusLineTermNC")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004017 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004018 This option can be used to set highlighting mode for various
4019 occasions. It is a comma separated list of character pairs. The
4020 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004021 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004022 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
Bram Moolenaar58b85342016-08-14 19:54:54 +02004023 |hl-EndOfBuffer| ~ lines after the last line in the buffer
4024 |hl-NonText| @ '@' at the end of the window and
Bram Moolenaar071d4272004-06-13 20:20:40 +00004025 characters from 'showbreak'
4026 |hl-Directory| d directories in CTRL-D listing and other special
4027 things in listings
4028 |hl-ErrorMsg| e error messages
4029 h (obsolete, ignored)
4030 |hl-IncSearch| i 'incsearch' highlighting
4031 |hl-Search| l last search pattern highlighting (see 'hlsearch')
4032 |hl-MoreMsg| m |more-prompt|
4033 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
Bram Moolenaar64486672010-05-16 15:46:46 +02004034 |hl-LineNr| n line number for ":number" and ":#" commands, and
4035 when 'number' or 'relativenumber' option is set.
Bram Moolenaarefae76a2019-10-27 22:54:58 +01004036 |hl-LineNrAbove| a line number above the cursor for when the
4037 'relativenumber' option is set.
4038 |hl-LineNrBelow| b line number below the cursor for when the
4039 'relativenumber' option is set.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01004040 |hl-CursorLineNr| N like n for when 'cursorline' or 'relativenumber' is
4041 set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004042 |hl-Question| r |hit-enter| prompt and yes/no questions
4043 |hl-StatusLine| s status line of current window |status-line|
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01004044 |hl-StatusLineNC| S status lines of not-current windows
Bram Moolenaar071d4272004-06-13 20:20:40 +00004045 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
4046 |hl-VertSplit| c column used to separate vertically split windows
4047 |hl-Visual| v Visual mode
4048 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
4049 Selection" Only X11 Gui's |gui-x11| and
4050 |xterm-clipboard|.
4051 |hl-WarningMsg| w warning messages
4052 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
4053 |hl-Folded| f line used for closed folds
4054 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00004055 |hl-DiffAdd| A added line in diff mode
4056 |hl-DiffChange| C changed line in diff mode
4057 |hl-DiffDelete| D deleted line in diff mode
4058 |hl-DiffText| T inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00004059 |hl-SignColumn| > column used for |signs|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004060 |hl-Conceal| - the placeholders used for concealed characters
4061 (see 'conceallevel')
Bram Moolenaar217ad922005-03-20 22:37:15 +00004062 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02004063 |hl-SpellCap| P word that should start with capital |spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00004064 |hl-SpellRare| R rare word |spell|
4065 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004066 |hl-Pmenu| + popup menu normal line
4067 |hl-PmenuSel| = popup menu selected line
4068 |hl-PmenuSbar| x popup menu scrollbar
4069 |hl-PmenuThumb| X popup menu scrollbar thumb
Bram Moolenaar071d4272004-06-13 20:20:40 +00004070
4071 The display modes are:
4072 r reverse (termcap entry "mr" and "me")
4073 i italic (termcap entry "ZH" and "ZR")
4074 b bold (termcap entry "md" and "me")
4075 s standout (termcap entry "so" and "se")
4076 u underline (termcap entry "us" and "ue")
Bram Moolenaare2cc9702005-03-15 22:43:58 +00004077 c undercurl (termcap entry "Cs" and "Ce")
Bram Moolenaarcf4b00c2017-09-02 18:33:56 +02004078 t strikethrough (termcap entry "Ts" and "Te")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004079 n no highlighting
4080 - no highlighting
4081 : use a highlight group
4082 The default is used for occasions that are not included.
4083 If you want to change what the display modes do, see |dos-colors|
4084 for an example.
4085 When using the ':' display mode, this must be followed by the name of
4086 a highlight group. A highlight group can be used to define any type
4087 of highlighting, including using color. See |:highlight| on how to
4088 define one. The default uses a different group for each occasion.
4089 See |highlight-default| for the default highlight groups.
4090
Bram Moolenaar071d4272004-06-13 20:20:40 +00004091 *'history'* *'hi'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004092'history' 'hi' number (Vim default: 50, Vi default: 0,
4093 set to 200 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004094 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004095 A history of ":" commands, and a history of previous search patterns
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004096 is remembered. This option decides how many entries may be stored in
Bram Moolenaar071d4272004-06-13 20:20:40 +00004097 each of these histories (see |cmdline-editing|).
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004098 The maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004099 NOTE: This option is set to the Vi default value when 'compatible' is
4100 set and to the Vim default value when 'compatible' is reset.
4101
4102 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
4103'hkmap' 'hk' boolean (default off)
4104 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004105 {only available when compiled with the |+rightleft|
4106 feature}
4107 When on, the keyboard is mapped for the Hebrew character set.
4108 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
4109 toggle this option. See |rileft.txt|.
4110 NOTE: This option is reset when 'compatible' is set.
4111
4112 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
4113'hkmapp' 'hkp' boolean (default off)
4114 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004115 {only available when compiled with the |+rightleft|
4116 feature}
4117 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
4118 This is useful if you have a non-Hebrew keyboard.
4119 See |rileft.txt|.
4120 NOTE: This option is reset when 'compatible' is set.
4121
Bram Moolenaar036986f2017-03-16 17:41:02 +01004122 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
4123'hlsearch' 'hls' boolean (default off)
4124 global
Bram Moolenaar036986f2017-03-16 17:41:02 +01004125 {not available when compiled without the
4126 |+extra_search| feature}
4127 When there is a previous search pattern, highlight all its matches.
4128 The type of highlighting used can be set with the 'l' occasion in the
4129 'highlight' option. This uses the "Search" highlight group by
4130 default. Note that only the matching text is highlighted, any offsets
4131 are not applied.
4132 See also: 'incsearch' and |:match|.
4133 When you get bored looking at the highlighted matches, you can turn it
4134 off with |:nohlsearch|. This does not change the option value, as
4135 soon as you use a search command, the highlighting comes back.
4136 'redrawtime' specifies the maximum time spent on finding matches.
4137 When the search pattern can match an end-of-line, Vim will try to
4138 highlight all of the matched text. However, this depends on where the
4139 search starts. This will be the first line in the window or the first
4140 line below a closed fold. A match in a previous line which is not
4141 drawn may not continue in a newly drawn line.
4142 You can specify whether the highlight status is restored on startup
4143 with the 'h' flag in 'viminfo' |viminfo-h|.
4144 NOTE: This option is reset when 'compatible' is set.
4145
Bram Moolenaar071d4272004-06-13 20:20:40 +00004146 *'icon'* *'noicon'*
4147'icon' boolean (default off, on when title can be restored)
4148 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004149 {not available when compiled without the |+title|
4150 feature}
4151 When on, the icon text of the window will be set to the value of
4152 'iconstring' (if it is not empty), or to the name of the file
4153 currently being edited. Only the last part of the name is used.
4154 Overridden by the 'iconstring' option.
4155 Only works if the terminal supports setting window icons (currently
4156 only X11 GUI and terminals with a non-empty 't_IS' option - these are
4157 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
4158 builtin termcap).
4159 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00004160 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00004161 X11.
Bram Moolenaar3a991dd2014-10-02 01:41:41 +02004162 For MS-Windows the icon can be changed, see |windows-icon|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004163
4164 *'iconstring'*
4165'iconstring' string (default "")
4166 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004167 {not available when compiled without the |+title|
4168 feature}
4169 When this option is not empty, it will be used for the icon text of
4170 the window. This happens only when the 'icon' option is on.
4171 Only works if the terminal supports setting window icon text
4172 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02004173 Does not work for MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004174 When Vim was compiled with HAVE_X11 defined, the original icon will be
4175 restored if possible |X11|.
4176 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004177 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004178 'titlestring' for example settings.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004179 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004180 {not available when compiled without the |+statusline| feature}
4181
4182 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
4183'ignorecase' 'ic' boolean (default off)
4184 global
4185 Ignore case in search patterns. Also used when searching in the tags
4186 file.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01004187 Also see 'smartcase' and 'tagcase'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004188 Can be overruled by using "\c" or "\C" in the pattern, see
4189 |/ignorecase|.
4190
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004191 *'imactivatefunc'* *'imaf'*
4192'imactivatefunc' 'imaf' string (default "")
4193 global
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004194 This option specifies a function that will be called to
Bram Moolenaar2877d332017-11-26 14:56:16 +01004195 activate or deactivate the Input Method.
Bram Moolenaaref8c6172020-07-01 15:12:44 +02004196 It is not used in the MS-Windows GUI version.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004197 The expression will be evaluated in the |sandbox| when set from a
4198 modeline, see |sandbox-option|.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004199
4200 Example: >
4201 function ImActivateFunc(active)
4202 if a:active
4203 ... do something
4204 else
4205 ... do something
4206 endif
4207 " return value is not used
4208 endfunction
4209 set imactivatefunc=ImActivateFunc
4210<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004211 *'imactivatekey'* *'imak'*
4212'imactivatekey' 'imak' string (default "")
4213 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004214 {only available when compiled with |+xim| and
Bram Moolenaar67c53842010-05-22 18:28:27 +02004215 |+GUI_GTK|} *E599*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004216 Specifies the key that your Input Method in X-Windows uses for
4217 activation. When this is specified correctly, vim can fully control
4218 IM with 'imcmdline', 'iminsert' and 'imsearch'.
4219 You can't use this option to change the activation key, the option
4220 tells Vim what the key is.
4221 Format:
4222 [MODIFIER_FLAG-]KEY_STRING
4223
4224 These characters can be used for MODIFIER_FLAG (case is ignored):
4225 S Shift key
4226 L Lock key
4227 C Control key
4228 1 Mod1 key
4229 2 Mod2 key
4230 3 Mod3 key
4231 4 Mod4 key
4232 5 Mod5 key
4233 Combinations are allowed, for example "S-C-space" or "SC-space" are
4234 both shift+ctrl+space.
4235 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
4236
4237 Example: >
4238 :set imactivatekey=S-space
4239< "S-space" means shift+space. This is the activation key for kinput2 +
4240 canna (Japanese), and ami (Korean).
4241
4242 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
4243'imcmdline' 'imc' boolean (default off)
4244 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004245 When set the Input Method is always on when starting to edit a command
4246 line, unless entering a search pattern (see 'imsearch' for that).
4247 Setting this option is useful when your input method allows entering
4248 English characters directly, e.g., when it's used to type accented
4249 characters with dead keys.
4250
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004251 *'imdisable'* *'imd'* *'noimdisable'* *'noimd'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004252'imdisable' 'imd' boolean (default off, on for some systems (SGI))
4253 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004254 When set the Input Method is never used. This is useful to disable
4255 the IM when it doesn't work properly.
4256 Currently this option is on by default for SGI/IRIX machines. This
4257 may change in later releases.
4258
4259 *'iminsert'* *'imi'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004260'iminsert' 'imi' number (default 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004261 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004262 Specifies whether :lmap or an Input Method (IM) is to be used in
4263 Insert mode. Valid values:
4264 0 :lmap is off and IM is off
4265 1 :lmap is ON and IM is off
4266 2 :lmap is off and IM is ON
Bram Moolenaar071d4272004-06-13 20:20:40 +00004267 To always reset the option to zero when leaving Insert mode with <Esc>
4268 this can be used: >
4269 :inoremap <ESC> <ESC>:set iminsert=0<CR>
4270< This makes :lmap and IM turn off automatically when leaving Insert
4271 mode.
4272 Note that this option changes when using CTRL-^ in Insert mode
4273 |i_CTRL-^|.
4274 The value is set to 1 when setting 'keymap' to a valid keymap name.
4275 It is also used for the argument of commands like "r" and "f".
4276 The value 0 may not work correctly with Athena and Motif with some XIM
4277 methods. Use 'imdisable' to disable XIM then.
4278
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004279 You can set 'imactivatefunc' and 'imstatusfunc' to handle IME/XIM
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004280 via external command if Vim is not compiled with the |+xim|,
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004281 |+multi_byte_ime| or |global-ime|.
4282
Bram Moolenaar071d4272004-06-13 20:20:40 +00004283 *'imsearch'* *'ims'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004284'imsearch' 'ims' number (default -1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004285 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004286 Specifies whether :lmap or an Input Method (IM) is to be used when
4287 entering a search pattern. Valid values:
4288 -1 the value of 'iminsert' is used, makes it look like
4289 'iminsert' is also used when typing a search pattern
4290 0 :lmap is off and IM is off
4291 1 :lmap is ON and IM is off
4292 2 :lmap is off and IM is ON
4293 Note that this option changes when using CTRL-^ in Command-line mode
4294 |c_CTRL-^|.
4295 The value is set to 1 when it is not -1 and setting the 'keymap'
4296 option to a valid keymap name.
4297 The value 0 may not work correctly with Athena and Motif with some XIM
4298 methods. Use 'imdisable' to disable XIM then.
4299
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004300 *'imstatusfunc'* *'imsf'*
4301'imstatusfunc' 'imsf' string (default "")
4302 global
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004303 This option specifies a function that is called to obtain the status
4304 of Input Method. It must return a positive number when IME is active.
Bram Moolenaaref8c6172020-07-01 15:12:44 +02004305 It is not used in the MS-Windows GUI version.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004306
4307 Example: >
4308 function ImStatusFunc()
4309 let is_active = ...do something
4310 return is_active ? 1 : 0
4311 endfunction
4312 set imstatusfunc=ImStatusFunc
4313<
4314 NOTE: This function is invoked very often. Keep it fast.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004315 The expression will be evaluated in the |sandbox| when set from a
4316 modeline, see |sandbox-option|.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004317
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004318 *'imstyle'* *'imst'*
4319'imstyle' 'imst' number (default 1)
4320 global
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004321 {only available when compiled with |+xim| and
4322 |+GUI_GTK|}
Bram Moolenaar37c64c72017-09-19 22:06:03 +02004323 This option specifies the input style of Input Method:
4324 0 use on-the-spot style
4325 1 over-the-spot style
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004326 See: |xim-input-style|
4327
Bram Moolenaar24a98a02017-09-27 22:23:55 +02004328 For a long time on-the-spot style had been used in the GTK version of
4329 vim, however, it is known that it causes troubles when using mappings,
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004330 |single-repeat|, etc. Therefore over-the-spot style becomes the
4331 default now. This should work fine for most people, however if you
4332 have any problem with it, try using on-the-spot style.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004333 The expression will be evaluated in the |sandbox| when set from a
4334 modeline, see |sandbox-option|.
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004335
Bram Moolenaar071d4272004-06-13 20:20:40 +00004336 *'include'* *'inc'*
4337'include' 'inc' string (default "^\s*#\s*include")
4338 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004339 {not available when compiled without the
4340 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004341 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00004342 pattern, just like for the "/" command (See |pattern|). The default
4343 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar1e015462005-09-25 22:16:38 +00004344 "]I", "[d", etc.
4345 Normally the 'isfname' option is used to recognize the file name that
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004346 comes after the matched pattern. But if "\zs" appears in the pattern
4347 then the text matched from "\zs" to the end, or until "\ze" if it
4348 appears, is used as the file name. Use this to include characters
4349 that are not in 'isfname', such as a space. You can then use
4350 'includeexpr' to process the matched text.
Bram Moolenaar1e015462005-09-25 22:16:38 +00004351 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004352
4353 *'includeexpr'* *'inex'*
4354'includeexpr' 'inex' string (default "")
4355 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004356 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004357 |+find_in_path| or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004358 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004359 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004360 :set includeexpr=substitute(v:fname,'\\.','/','g')
4361< The "v:fname" variable will be set to the file name that was detected.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004362
Bram Moolenaar071d4272004-06-13 20:20:40 +00004363 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004364 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004365 Also used for |<cfile>|.
4366
Bram Moolenaar30b65812012-07-12 22:01:11 +02004367 The expression will be evaluated in the |sandbox| when set from a
4368 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004369 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004370
4371 It is not allowed to change text or jump to another window while
4372 evaluating 'includeexpr' |textlock|.
4373
Bram Moolenaar071d4272004-06-13 20:20:40 +00004374 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004375'incsearch' 'is' boolean (default off, set in |defaults.vim| if the
4376 +reltime feature is supported)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004377 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004378 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004379 |+extra_search| features}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004380 While typing a search command, show where the pattern, as it was typed
4381 so far, matches. The matched string is highlighted. If the pattern
4382 is invalid or not found, nothing is shown. The screen will be updated
4383 often, this is only useful on fast terminals.
Bram Moolenaarfc65cab2018-08-28 22:58:02 +02004384 Also applies to the pattern in commands: >
4385 :global
4386 :lvimgrep
4387 :lvimgrepadd
4388 :smagic
4389 :snomagic
4390 :sort
4391 :substitute
4392 :vglobal
4393 :vimgrep
4394 :vimgrepadd
4395< Note that the match will be shown, but the cursor will return to its
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004396 original position when no match is found and when pressing <Esc>. You
4397 still need to finish the search command with <Enter> to move the
4398 cursor to the match.
Bram Moolenaardc083282016-10-11 08:57:33 +02004399 You can use the CTRL-G and CTRL-T keys to move to the next and
4400 previous match. |c_CTRL-G| |c_CTRL-T|
Bram Moolenaar91a4e822008-01-19 14:59:58 +00004401 When compiled with the |+reltime| feature Vim only searches for about
4402 half a second. With a complicated pattern and/or a lot of text the
4403 match may not be found. This is to avoid that Vim hangs while you
4404 are typing the pattern.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004405 The highlighting can be set with the 'i' flag in 'highlight'.
Bram Moolenaar2f058492017-11-30 20:27:52 +01004406 When 'hlsearch' is on, all matched strings are highlighted too while
4407 typing a search command. See also: 'hlsearch'.
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004408 If you don't want to turn 'hlsearch' on, but want to highlight all
4409 matches while searching, you can turn on and off 'hlsearch' with
4410 autocmd. Example: >
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004411 augroup vimrc-incsearch-highlight
4412 autocmd!
Bram Moolenaarf8f8b2e2017-11-02 19:08:48 +01004413 autocmd CmdlineEnter /,\? :set hlsearch
4414 autocmd CmdlineLeave /,\? :set nohlsearch
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004415 augroup END
4416<
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004417 CTRL-L can be used to add one character from after the current match
Bram Moolenaara9dc3752010-07-11 20:46:53 +02004418 to the command line. If 'ignorecase' and 'smartcase' are set and the
4419 command line has no uppercase characters, the added character is
4420 converted to lowercase.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004421 CTRL-R CTRL-W can be used to add the word at the end of the current
4422 match, excluding the characters that were already typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004423 NOTE: This option is reset when 'compatible' is set.
4424
4425 *'indentexpr'* *'inde'*
4426'indentexpr' 'inde' string (default "")
4427 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004428 {not available when compiled without the |+cindent|
4429 or |+eval| features}
4430 Expression which is evaluated to obtain the proper indent for a line.
4431 It is used when a new line is created, for the |=| operator and
4432 in Insert mode as specified with the 'indentkeys' option.
4433 When this option is not empty, it overrules the 'cindent' and
Bram Moolenaar20f90cf2011-05-19 12:22:51 +02004434 'smartindent' indenting. When 'lisp' is set, this option is
4435 overridden by the Lisp indentation algorithm.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004436 When 'paste' is set this option is not used for indenting.
4437 The expression is evaluated with |v:lnum| set to the line number for
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004438 which the indent is to be computed. The cursor is also in this line
Bram Moolenaar071d4272004-06-13 20:20:40 +00004439 when the expression is evaluated (but it may be moved around).
4440 The expression must return the number of spaces worth of indent. It
4441 can return "-1" to keep the current indent (this means 'autoindent' is
4442 used for the indent).
4443 Functions useful for computing the indent are |indent()|, |cindent()|
4444 and |lispindent()|.
4445 The evaluation of the expression must not have side effects! It must
4446 not change the text, jump to another window, etc. Afterwards the
4447 cursor position is always restored, thus the cursor may be moved.
4448 Normally this option would be set to call a function: >
4449 :set indentexpr=GetMyIndent()
4450< Error messages will be suppressed, unless the 'debug' option contains
4451 "msg".
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004452 See |indent-expression|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01004453 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004454
Bram Moolenaar30b65812012-07-12 22:01:11 +02004455 The expression will be evaluated in the |sandbox| when set from a
4456 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004457 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004458
4459 It is not allowed to change text or jump to another window while
4460 evaluating 'indentexpr' |textlock|.
4461
4462
Bram Moolenaar071d4272004-06-13 20:20:40 +00004463 *'indentkeys'* *'indk'*
Bram Moolenaarce655742019-01-31 14:12:57 +01004464'indentkeys' 'indk' string (default "0{,0},0),0],:,0#,!^F,o,O,e")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004465 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004466 {not available when compiled without the |+cindent|
4467 feature}
4468 A list of keys that, when typed in Insert mode, cause reindenting of
4469 the current line. Only happens if 'indentexpr' isn't empty.
4470 The format is identical to 'cinkeys', see |indentkeys-format|.
4471 See |C-indenting| and |indent-expression|.
4472
4473 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
4474'infercase' 'inf' boolean (default off)
4475 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004476 When doing keyword completion in insert mode |ins-completion|, and
Bram Moolenaar446cb832008-06-24 21:56:24 +00004477 'ignorecase' is also on, the case of the match is adjusted depending
4478 on the typed text. If the typed text contains a lowercase letter
4479 where the match has an upper case letter, the completed part is made
4480 lowercase. If the typed text has no lowercase letters and the match
4481 has a lowercase letter where the typed text has an uppercase letter,
4482 and there is a letter before it, the completed part is made uppercase.
4483 With 'noinfercase' the match is used as-is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004484
4485 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
4486'insertmode' 'im' boolean (default off)
4487 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004488 Makes Vim work in a way that Insert mode is the default mode. Useful
4489 if you want to use Vim as a modeless editor. Used for |evim|.
4490 These Insert mode commands will be useful:
4491 - Use the cursor keys to move around.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02004492 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|. When
Bram Moolenaar071d4272004-06-13 20:20:40 +00004493 this is a mapping, it is executed as if 'insertmode' was off.
4494 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004495 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00004496 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
4497 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004498
4499 These items change when 'insertmode' is set:
4500 - when starting to edit of a file, Vim goes to Insert mode.
4501 - <Esc> in Insert mode is a no-op and beeps.
4502 - <Esc> in Normal mode makes Vim go to Insert mode.
4503 - CTRL-L in Insert mode is a command, it is not inserted.
4504 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
4505 However, when <Esc> is used inside a mapping, it behaves like
4506 'insertmode' was not set. This was done to be able to use the same
4507 mappings with 'insertmode' set or not set.
4508 When executing commands with |:normal| 'insertmode' is not used.
4509
4510 NOTE: This option is reset when 'compatible' is set.
4511
4512 *'isfname'* *'isf'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004513'isfname' 'isf' string (default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004514 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
4515 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
4516 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
4517 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
4518 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
4519 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004520 The characters specified by this option are included in file names and
4521 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004522 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004523 Multi-byte characters 256 and above are always included, only the
4524 characters up to 255 are specified with this option.
4525 For UTF-8 the characters 0xa0 to 0xff are included as well.
Bram Moolenaar446cb832008-06-24 21:56:24 +00004526 Think twice before adding white space to this option. Although a
4527 space may appear inside a file name, the effect will be that Vim
4528 doesn't know where a file name starts or ends when doing completion.
4529 It most likely works better without a space in 'isfname'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004530
4531 Note that on systems using a backslash as path separator, Vim tries to
4532 do its best to make it work as you would expect. That is a bit
4533 tricky, since Vi originally used the backslash to escape special
4534 characters. Vim will not remove a backslash in front of a normal file
4535 name character on these systems, but it will on Unix and alikes. The
4536 '&' and '^' are not included by default, because these are special for
4537 cmd.exe.
4538
4539 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004540 Each part can be a single character number or a range. A range is two
4541 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004542 decimal number between 0 and 255 or the ASCII character itself (does
4543 not work for digits). Example:
4544 "_,-,128-140,#-43" (include '_' and '-' and the range
4545 128 to 140 and '#' to 43)
4546 If a part starts with '^', the following character number or range
4547 will be excluded from the option. The option is interpreted from left
4548 to right. Put the excluded character after the range where it is
4549 included. To include '^' itself use it as the last character of the
4550 option or the end of a range. Example:
4551 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
4552 If the character is '@', all characters where isalpha() returns TRUE
4553 are included. Normally these are the characters a to z and A to Z,
4554 plus accented characters. To include '@' itself use "@-@". Examples:
4555 "@,^a-z" All alphabetic characters, excluding lower
Bram Moolenaar446cb832008-06-24 21:56:24 +00004556 case ASCII letters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004557 "a-z,A-Z,@-@" All letters plus the '@' character.
4558 A comma can be included by using it where a character number is
4559 expected. Example:
4560 "48-57,,,_" Digits, comma and underscore.
4561 A comma can be excluded by prepending a '^'. Example:
4562 " -~,^,,9" All characters from space to '~', excluding
4563 comma, plus <Tab>.
4564 See |option-backslash| about including spaces and backslashes.
4565
4566 *'isident'* *'isi'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004567'isident' 'isi' string (default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004568 "@,48-57,_,128-167,224-235"
4569 otherwise: "@,48-57,_,192-255")
4570 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004571 The characters given by this option are included in identifiers.
4572 Identifiers are used in recognizing environment variables and after a
4573 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00004574 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004575 option. For '@' only characters up to 255 are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004576 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004577 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00004578 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
4579
4580 *'iskeyword'* *'isk'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004581'iskeyword' 'isk' string (Vim default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004582 "@,48-57,_,128-167,224-235"
4583 otherwise: "@,48-57,_,192-255"
4584 Vi default: "@,48-57,_")
4585 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004586 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004587 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004588 'isfname' for a description of the format of this option. For '@'
Bram Moolenaar4c295022021-05-02 17:19:11 +02004589 characters above 255 check the "word" character class (any character
4590 that is not white space or punctuation).
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004591 For C programs you could use "a-z,A-Z,48-57,_,.,-,>".
Bram Moolenaar071d4272004-06-13 20:20:40 +00004592 For a help file it is set to all non-blank printable characters except
4593 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
4594 command).
4595 When the 'lisp' option is on the '-' character is always included.
Bram Moolenaarb8060fe2016-01-19 22:29:28 +01004596 This option also influences syntax highlighting, unless the syntax
4597 uses |:syn-iskeyword|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004598 NOTE: This option is set to the Vi default value when 'compatible' is
4599 set and to the Vim default value when 'compatible' is reset.
4600
4601 *'isprint'* *'isp'*
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02004602'isprint' 'isp' string (default for Win32 and macOS:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004603 "@,~-255"; otherwise: "@,161-255")
4604 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004605 The characters given by this option are displayed directly on the
4606 screen. It is also used for "\p" in a |pattern|. The characters from
4607 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
4608 even when they are not included in 'isprint' or excluded. See
4609 'isfname' for a description of the format of this option.
4610
4611 Non-printable characters are displayed with two characters:
4612 0 - 31 "^@" - "^_"
4613 32 - 126 always single characters
4614 127 "^?"
4615 128 - 159 "~@" - "~_"
4616 160 - 254 "| " - "|~"
4617 255 "~?"
4618 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
4619 displayed as <xx>, with the hexadecimal value of the byte.
4620 When 'display' contains "uhex" all unprintable characters are
4621 displayed as <xx>.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004622 The SpecialKey highlighting will be used for unprintable characters.
4623 |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004624
4625 Multi-byte characters 256 and above are always included, only the
4626 characters up to 255 are specified with this option. When a character
4627 is printable but it is not available in the current font, a
4628 replacement character will be shown.
4629 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
4630 There is no option to specify these characters.
4631
4632 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
4633'joinspaces' 'js' boolean (default on)
4634 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004635 Insert two spaces after a '.', '?' and '!' with a join command.
4636 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
4637 Otherwise only one space is inserted.
4638 NOTE: This option is set when 'compatible' is set.
4639
4640 *'key'*
4641'key' string (default "")
4642 local to buffer
Bram Moolenaar996343d2010-07-04 22:20:21 +02004643 {only available when compiled with the |+cryptv|
4644 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004645 The key that is used for encrypting and decrypting the current buffer.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02004646 See |encryption| and 'cryptmethod'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004647 Careful: Do not set the key value by hand, someone might see the typed
4648 key. Use the |:X| command. But you can make 'key' empty: >
4649 :set key=
4650< It is not possible to get the value of this option with ":set key" or
4651 "echo &key". This is to avoid showing it to someone who shouldn't
4652 know. It also means you cannot see it yourself once you have set it,
4653 be careful not to make a typing error!
Bram Moolenaard58e9292011-02-09 17:07:58 +01004654 You can use "&key" in an expression to detect whether encryption is
4655 enabled. When 'key' is set it returns "*****" (five stars).
Bram Moolenaar071d4272004-06-13 20:20:40 +00004656
4657 *'keymap'* *'kmp'* *E544*
4658'keymap' 'kmp' string (default "")
4659 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004660 {only available when compiled with the |+keymap|
4661 feature}
4662 Name of a keyboard mapping. See |mbyte-keymap|.
4663 Setting this option to a valid keymap name has the side effect of
4664 setting 'iminsert' to one, so that the keymap becomes effective.
4665 'imsearch' is also set to one, unless it was -1
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004666 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004667
4668 *'keymodel'* *'km'*
4669'keymodel' 'km' string (default "")
4670 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004671 List of comma separated words, which enable special things that keys
4672 can do. These values can be used:
4673 startsel Using a shifted special key starts selection (either
4674 Select mode or Visual mode, depending on "key" being
4675 present in 'selectmode').
4676 stopsel Using a not-shifted special key stops selection.
4677 Special keys in this context are the cursor keys, <End>, <Home>,
4678 <PageUp> and <PageDown>.
4679 The 'keymodel' option is set by the |:behave| command.
4680
4681 *'keywordprg'* *'kp'*
4682'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02004683 VMS: "help")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004684 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004685 Program to use for the |K| command. Environment variables are
4686 expanded |:set_env|. ":help" may be used to access the Vim internal
4687 help. (Note that previously setting the global option to the empty
4688 value did this, which is now deprecated.)
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02004689 When the first character is ":", the command is invoked as a Vim
4690 Ex command prefixed with [count].
4691 When "man", "man -s" or an Ex command is used, Vim will automatically
4692 translate a count for the "K" command and pass it as the first
4693 argument. For "man -s" the "-s" is removed when there is no count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004694 See |option-backslash| about including spaces and backslashes.
4695 Example: >
4696 :set keywordprg=man\ -s
4697< This option cannot be set from a |modeline| or in the |sandbox|, for
4698 security reasons.
4699
4700 *'langmap'* *'lmap'* *E357* *E358*
4701'langmap' 'lmap' string (default "")
4702 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004703 {only available when compiled with the |+langmap|
4704 feature}
4705 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004706 mode. When you are typing text in Insert mode the characters are
Bram Moolenaarfa735342016-01-03 22:14:44 +01004707 inserted directly. When in Normal mode the 'langmap' option takes
Bram Moolenaar071d4272004-06-13 20:20:40 +00004708 care of translating these special characters to the original meaning
4709 of the key. This means you don't have to change the keyboard mode to
4710 be able to execute Normal mode commands.
4711 This is the opposite of the 'keymap' option, where characters are
4712 mapped in Insert mode.
Bram Moolenaarb17893a2020-03-14 08:19:51 +01004713 Also consider setting 'langremap' to off, to prevent 'langmap' from
4714 applying to characters resulting from a mapping.
Bram Moolenaare968e362014-05-13 20:23:24 +02004715 This option cannot be set from a |modeline| or in the |sandbox|, for
4716 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004717
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00004718 Example (for Greek, in UTF-8): *greek* >
4719 :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 +00004720< Example (exchanges meaning of z and y for commands): >
4721 :set langmap=zy,yz,ZY,YZ
4722<
4723 The 'langmap' option is a list of parts, separated with commas. Each
4724 part can be in one of two forms:
4725 1. A list of pairs. Each pair is a "from" character immediately
4726 followed by the "to" character. Examples: "aA", "aAbBcC".
4727 2. A list of "from" characters, a semi-colon and a list of "to"
4728 characters. Example: "abc;ABC"
4729 Example: "aA,fgh;FGH,cCdDeE"
4730 Special characters need to be preceded with a backslash. These are
Bram Moolenaar4f4d51a2020-10-11 13:57:40 +02004731 ";", ',', '"', '|' and backslash itself.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004732
4733 This will allow you to activate vim actions without having to switch
4734 back and forth between the languages. Your language characters will
4735 be understood as normal vim English characters (according to the
4736 langmap mappings) in the following cases:
4737 o Normal/Visual mode (commands, buffer/register names, user mappings)
4738 o Insert/Replace Mode: Register names after CTRL-R
4739 o Insert/Replace Mode: Mappings
4740 Characters entered in Command-line mode will NOT be affected by
4741 this option. Note that this option can be changed at any time
4742 allowing to switch between mappings for different languages/encodings.
4743 Use a mapping to avoid having to type it each time!
4744
4745 *'langmenu'* *'lm'*
4746'langmenu' 'lm' string (default "")
4747 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004748 {only available when compiled with the |+menu| and
4749 |+multi_lang| features}
4750 Language to use for menu translation. Tells which file is loaded
4751 from the "lang" directory in 'runtimepath': >
4752 "lang/menu_" . &langmenu . ".vim"
4753< (without the spaces). For example, to always use the Dutch menus, no
4754 matter what $LANG is set to: >
4755 :set langmenu=nl_NL.ISO_8859-1
4756< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004757 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004758 If your $LANG is set to a non-English language but you do want to use
4759 the English menus: >
4760 :set langmenu=none
4761< This option must be set before loading menus, switching on filetype
4762 detection or syntax highlighting. Once the menus are defined setting
4763 this option has no effect. But you could do this: >
4764 :source $VIMRUNTIME/delmenu.vim
4765 :set langmenu=de_DE.ISO_8859-1
4766 :source $VIMRUNTIME/menu.vim
4767< Warning: This deletes all menus that you defined yourself!
4768
Bram Moolenaard94464e2015-11-02 15:28:18 +01004769 *'langnoremap'* *'lnr'* *'nolangnoremap'* *'nolnr'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004770'langnoremap' 'lnr' boolean (default off, set in |defaults.vim|)
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004771 global
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004772 {only available when compiled with the |+langmap|
4773 feature}
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004774 This is just like 'langremap' but with the value inverted. It only
4775 exists for backwards compatibility. When setting 'langremap' then
4776 'langnoremap' is set to the inverted value, and the other way around.
4777
4778 *'langremap'* *'lrm'* *'nolangremap'* *'nolrm'*
Bram Moolenaarb17893a2020-03-14 08:19:51 +01004779'langremap' 'lrm' boolean (default on, set to off in |defaults.vim|)
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004780 global
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004781 {only available when compiled with the |+langmap|
4782 feature}
4783 When off, setting 'langmap' does not apply to characters resulting from
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004784 a mapping. This basically means, if you noticed that setting
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004785 'langmap' disables some of your mappings, try resetting this option.
4786 This option defaults to on for backwards compatibility. Set it off if
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004787 that works for you to avoid mappings to break.
4788
Bram Moolenaar071d4272004-06-13 20:20:40 +00004789 *'laststatus'* *'ls'*
4790'laststatus' 'ls' number (default 1)
4791 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004792 The value of this option influences when the last window will have a
4793 status line:
4794 0: never
4795 1: only if there are at least two windows
4796 2: always
4797 The screen looks nicer with a status line if you have several
4798 windows, but it takes another screen line. |status-line|
4799
4800 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
4801'lazyredraw' 'lz' boolean (default off)
4802 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004803 When this option is set, the screen will not be redrawn while
4804 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004805 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00004806 update use |:redraw|.
4807
4808 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
4809'linebreak' 'lbr' boolean (default off)
4810 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02004811 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004812 feature}
Bram Moolenaar946e27a2014-06-25 18:50:27 +02004813 If on, Vim will wrap long lines at a character in 'breakat' rather
Bram Moolenaar071d4272004-06-13 20:20:40 +00004814 than at the last character that fits on the screen. Unlike
4815 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
Bram Moolenaar946e27a2014-06-25 18:50:27 +02004816 it only affects the way the file is displayed, not its contents.
4817 If 'breakindent' is set, line is visually indented. Then, the value
4818 of 'showbreak' is used to put in front of wrapped lines. This option
Bram Moolenaar86b17e92014-07-02 20:00:47 +02004819 is not used when the 'wrap' option is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004820 Note that <Tab> characters after an <EOL> are mostly not displayed
4821 with the right amount of white space.
4822
4823 *'lines'* *E593*
4824'lines' number (default 24 or terminal height)
4825 global
4826 Number of lines of the Vim window.
4827 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00004828 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004829 When Vim is running in the GUI or in a resizable window, setting this
4830 option will cause the window size to be changed. When you only want
4831 to use the size for the GUI, put the command in your |gvimrc| file.
4832 Vim limits the number of lines to what fits on the screen. You can
4833 use this command to get the tallest window possible: >
4834 :set lines=999
Bram Moolenaarf4d11452005-12-02 00:46:37 +00004835< Minimum value is 2, maximum value is 1000.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02004836 If you get fewer lines than expected, check the 'guiheadroom' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004837 When you set this option and Vim is unable to change the physical
4838 number of lines of the display, the display may be messed up.
4839
4840 *'linespace'* *'lsp'*
4841'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
4842 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004843 {only in the GUI}
4844 Number of pixel lines inserted between characters. Useful if the font
4845 uses the full character cell height, making lines touch each other.
4846 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004847 With some fonts there can be too much room between lines (to have
4848 space for ascents and descents). Then it makes sense to set
4849 'linespace' to a negative value. This may cause display problems
4850 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00004851
4852 *'lisp'* *'nolisp'*
4853'lisp' boolean (default off)
4854 local to buffer
4855 {not available when compiled without the |+lispindent|
4856 feature}
4857 Lisp mode: When <Enter> is typed in insert mode set the indent for
4858 the next line to Lisp standards (well, sort of). Also happens with
4859 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
4860 flag in 'cpoptions' changes the method of indenting: Vi compatible or
4861 better. Also see 'lispwords'.
4862 The '-' character is included in keyword characters. Redefines the
4863 "=" operator to use this same indentation algorithm rather than
4864 calling an external program if 'equalprg' is empty.
4865 This option is not used when 'paste' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004866
4867 *'lispwords'* *'lw'*
4868'lispwords' 'lw' string (default is very long)
Bram Moolenaaraf6c1312014-03-12 18:55:58 +01004869 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004870 {not available when compiled without the |+lispindent|
4871 feature}
4872 Comma separated list of words that influence the Lisp indenting.
4873 |'lisp'|
4874
4875 *'list'* *'nolist'*
4876'list' boolean (default off)
4877 local to window
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004878 List mode: Show tabs as CTRL-I is displayed, display $ after end of
4879 line. Useful to see the difference between tabs and spaces and for
4880 trailing blanks. Further changed by the 'listchars' option.
4881
4882 The cursor is displayed at the start of the space a Tab character
4883 occupies, not at the end as usual in Normal mode. To get this cursor
4884 position while displaying Tabs with spaces, use: >
Bram Moolenaardd007ed2013-07-09 15:44:17 +02004885 :set list lcs=tab:\ \
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004886<
4887 Note that list mode will also affect formatting (set with 'textwidth'
4888 or 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
Bram Moolenaar071d4272004-06-13 20:20:40 +00004889 changing the way tabs are displayed.
4890
4891 *'listchars'* *'lcs'*
4892'listchars' 'lcs' string (default "eol:$")
Bram Moolenaareed9d462021-02-15 20:38:25 +01004893 global or local to window |global-local|
Bram Moolenaarf9d5ca12010-08-01 16:13:51 +02004894 Strings to use in 'list' mode and for the |:list| command. It is a
4895 comma separated list of string settings.
Bram Moolenaar79278362015-04-21 18:33:48 +02004896 *lcs-eol*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004897 eol:c Character to show at the end of each line. When
4898 omitted, there is no extra character at the end of the
4899 line.
Bram Moolenaar79278362015-04-21 18:33:48 +02004900 *lcs-tab*
Bram Moolenaar83a52172019-01-16 22:41:54 +01004901 tab:xy[z] Two or three characters to be used to show a tab.
4902 The third character is optional.
4903
4904 tab:xy The 'x' is always used, then 'y' as many times as will
4905 fit. Thus "tab:>-" displays:
4906 >
4907 >-
4908 >--
4909 etc.
4910
4911 tab:xyz The 'z' is always used, then 'x' is prepended, and
4912 then 'y' is used as many times as will fit. Thus
4913 "tab:<->" displays:
4914 >
4915 <>
4916 <->
4917 <-->
4918 etc.
4919
4920 When "tab:" is omitted, a tab is shown as ^I.
Bram Moolenaar79278362015-04-21 18:33:48 +02004921 *lcs-space*
4922 space:c Character to show for a space. When omitted, spaces
4923 are left blank.
Bram Moolenaar91478ae2021-02-03 15:58:13 +01004924 *lcs-lead*
4925 lead:c Character to show for leading spaces. When omitted,
4926 leading spaces are blank. Overrides the "space"
Bram Moolenaar942db232021-02-13 18:14:48 +01004927 setting for leading spaces. You can combine it with
4928 "tab:", for example: >
4929 :set listchars+=tab:>-,lead:.
4930< *lcs-trail*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004931 trail:c Character to show for trailing spaces. When omitted,
Bram Moolenaar79278362015-04-21 18:33:48 +02004932 trailing spaces are blank. Overrides the "space"
4933 setting for trailing spaces.
4934 *lcs-extends*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004935 extends:c Character to show in the last column, when 'wrap' is
4936 off and the line continues beyond the right of the
4937 screen.
Bram Moolenaar79278362015-04-21 18:33:48 +02004938 *lcs-precedes*
Bram Moolenaarbffba7f2019-09-20 17:00:17 +02004939 precedes:c Character to show in the first visible column of the
4940 physical line, when there is text preceding the
4941 character visible in the first column.
Bram Moolenaar79278362015-04-21 18:33:48 +02004942 *lcs-conceal*
Bram Moolenaar860cae12010-06-05 23:22:07 +02004943 conceal:c Character to show in place of concealed text, when
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004944 'conceallevel' is set to 1.
Bram Moolenaar79278362015-04-21 18:33:48 +02004945 *lcs-nbsp*
Bram Moolenaar73284b92015-05-04 17:28:22 +02004946 nbsp:c Character to show for a non-breakable space character
4947 (0xA0 (160 decimal) and U+202F). Left blank when
4948 omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004949
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004950 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00004951 be used when 'encoding' is "utf-8", otherwise only printable
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004952 characters are allowed. All characters must be single width.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004953
4954 Examples: >
4955 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004956 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00004957 :set lcs=extends:>,precedes:<
4958< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaar79278362015-04-21 18:33:48 +02004959 "precedes". "SpecialKey" for "nbsp", "space", "tab" and "trail".
Bram Moolenaar02467872007-05-06 13:22:01 +00004960 |hl-NonText| |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004961
4962 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
4963'loadplugins' 'lpl' boolean (default on)
4964 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004965 When on the plugin scripts are loaded when starting up |load-plugins|.
4966 This option can be reset in your |vimrc| file to disable the loading
4967 of plugins.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02004968 Note that using the "-u NONE", "-u DEFAULTS" and "--noplugin" command
4969 line arguments reset this option. See |-u| and |--noplugin|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004970
Bram Moolenaard94464e2015-11-02 15:28:18 +01004971 *'luadll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01004972'luadll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01004973 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01004974 {only available when compiled with the |+lua/dyn|
4975 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01004976 Specifies the name of the Lua shared library. The default is
4977 DYNAMIC_LUA_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02004978 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01004979 This option cannot be set from a |modeline| or in the |sandbox|, for
4980 security reasons.
4981
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00004982 *'macatsui'* *'nomacatsui'*
4983'macatsui' boolean (default on)
4984 global
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02004985 {not supported}
4986 No longer supported, as the Mac OS X GUI code was removed.
Bram Moolenaar02467872007-05-06 13:22:01 +00004987
Bram Moolenaar071d4272004-06-13 20:20:40 +00004988 *'magic'* *'nomagic'*
4989'magic' boolean (default on)
4990 global
4991 Changes the special characters that can be used in search patterns.
4992 See |pattern|.
Bram Moolenaar64d8e252016-09-06 22:12:34 +02004993 WARNING: Switching this option off most likely breaks plugins! That
4994 is because many patterns assume it's on and will fail when it's off.
4995 Only switch it off when working with old Vi scripts. In any other
4996 situation write patterns that work when 'magic' is on. Include "\M"
4997 when you want to |/\M|.
Bram Moolenaar4072ba52020-12-23 13:56:35 +01004998 In |Vim9| script the value of 'magic' is ignored, patterns behave like
4999 it is always set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005000
5001 *'makeef'* *'mef'*
5002'makeef' 'mef' string (default: "")
5003 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005004 {not available when compiled without the |+quickfix|
5005 feature}
5006 Name of the errorfile for the |:make| command (see |:make_makeprg|)
5007 and the |:grep| command.
5008 When it is empty, an internally generated temp file will be used.
5009 When "##" is included, it is replaced by a number to make the name
5010 unique. This makes sure that the ":make" command doesn't overwrite an
5011 existing file.
5012 NOT used for the ":cf" command. See 'errorfile' for that.
5013 Environment variables are expanded |:set_env|.
5014 See |option-backslash| about including spaces and backslashes.
5015 This option cannot be set from a |modeline| or in the |sandbox|, for
5016 security reasons.
5017
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01005018 *'makeencoding'* *'menc'*
5019'makeencoding' 'menc' string (default "")
5020 global or local to buffer |global-local|
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01005021 Encoding used for reading the output of external commands. When empty,
5022 encoding is not converted.
5023 This is used for `:make`, `:lmake`, `:grep`, `:lgrep`, `:grepadd`,
5024 `:lgrepadd`, `:cfile`, `:cgetfile`, `:caddfile`, `:lfile`, `:lgetfile`,
5025 and `:laddfile`.
5026
5027 This would be mostly useful when you use MS-Windows and set 'encoding'
5028 to "utf-8". If |+iconv| is enabled and GNU libiconv is used, setting
5029 'makeencoding' to "char" has the same effect as setting to the system
5030 locale encoding. Example: >
5031 :set encoding=utf-8
5032 :set makeencoding=char " system locale is used
5033<
Bram Moolenaar071d4272004-06-13 20:20:40 +00005034 *'makeprg'* *'mp'*
5035'makeprg' 'mp' string (default "make", VMS: "MMS")
5036 global or local to buffer |global-local|
Bram Moolenaar02467872007-05-06 13:22:01 +00005037 Program to use for the ":make" command. See |:make_makeprg|.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01005038 This option may contain '%' and '#' characters (see |:_%| and |:_#|),
5039 which are expanded to the current and alternate file name. Use |::S|
Bram Moolenaar26df0922014-02-23 23:39:13 +01005040 to escape file names in case they contain special characters.
Bram Moolenaar02467872007-05-06 13:22:01 +00005041 Environment variables are expanded |:set_env|. See |option-backslash|
5042 about including spaces and backslashes.
5043 Note that a '|' must be escaped twice: once for ":set" and once for
5044 the interpretation of a command. When you use a filter called
5045 "myfilter" do it like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005046 :set makeprg=gmake\ \\\|\ myfilter
5047< The placeholder "$*" can be given (even multiple times) to specify
5048 where the arguments will be included, for example: >
5049 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
5050< This option cannot be set from a |modeline| or in the |sandbox|, for
5051 security reasons.
5052
5053 *'matchpairs'* *'mps'*
5054'matchpairs' 'mps' string (default "(:),{:},[:]")
5055 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005056 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01005057 other.
5058 Only character pairs are allowed that are different, thus you cannot
5059 jump between two double quotes.
5060 The characters must be separated by a colon.
Bram Moolenaar02467872007-05-06 13:22:01 +00005061 The pairs must be separated by a comma. Example for including '<' and
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02005062 '>' (for HTML): >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005063 :set mps+=<:>
5064
5065< A more exotic example, to jump between the '=' and ';' in an
5066 assignment, useful for languages like C and Java: >
5067 :au FileType c,cpp,java set mps+==:;
5068
5069< For a more advanced way of using "%", see the matchit.vim plugin in
Bram Moolenaar01164a62017-11-02 22:58:42 +01005070 the $VIMRUNTIME/pack/dist/opt/matchit directory. |add-local-help|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005071
5072 *'matchtime'* *'mat'*
5073'matchtime' 'mat' number (default 5)
5074 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005075 Tenths of a second to show the matching paren, when 'showmatch' is
5076 set. Note that this is not in milliseconds, like other options that
5077 set a time. This is to be compatible with Nvi.
5078
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005079 *'maxcombine'* *'mco'*
5080'maxcombine' 'mco' number (default 2)
5081 global
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005082 The maximum number of combining characters supported for displaying.
5083 Only used when 'encoding' is "utf-8".
5084 The default is OK for most languages. Hebrew may require 4.
5085 Maximum value is 6.
5086 Even when this option is set to 2 you can still edit text with more
5087 combining characters, you just can't see them. Use |g8| or |ga|.
5088 See |mbyte-combining|.
5089
Bram Moolenaar071d4272004-06-13 20:20:40 +00005090 *'maxfuncdepth'* *'mfd'*
5091'maxfuncdepth' 'mfd' number (default 100)
5092 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02005093 {not available when compiled without the |+eval|
Bram Moolenaar02467872007-05-06 13:22:01 +00005094 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005095 Maximum depth of function calls for user functions. This normally
5096 catches endless recursion. When using a recursive function with
5097 more depth, set 'maxfuncdepth' to a bigger number. But this will use
5098 more memory, there is the danger of failing when memory is exhausted.
Bram Moolenaarbc2eada2017-01-02 21:27:47 +01005099 Increasing this limit above 200 also changes the maximum for Ex
Bram Moolenaar0b0f0992018-05-22 21:41:30 +02005100 command recursion, see |E169|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005101 See also |:function|.
5102
5103 *'maxmapdepth'* *'mmd'* *E223*
5104'maxmapdepth' 'mmd' number (default 1000)
5105 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005106 Maximum number of times a mapping is done without resulting in a
5107 character to be used. This normally catches endless mappings, like
5108 ":map x y" with ":map y x". It still does not catch ":map g wg",
5109 because the 'w' is used before the next mapping is done. See also
5110 |key-mapping|.
5111
5112 *'maxmem'* *'mm'*
5113'maxmem' 'mm' number (default between 256 to 5120 (system
5114 dependent) or half the amount of memory
5115 available)
5116 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005117 Maximum amount of memory (in Kbyte) to use for one buffer. When this
5118 limit is reached allocating extra memory for a buffer will cause
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005119 other memory to be freed.
5120 The maximum usable value is about 2000000. Use this to work without a
5121 limit.
5122 The value is ignored when 'swapfile' is off.
5123 Also see 'maxmemtot'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005124
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005125 *'maxmempattern'* *'mmp'*
5126'maxmempattern' 'mmp' number (default 1000)
5127 global
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005128 Maximum amount of memory (in Kbyte) to use for pattern matching.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005129 The maximum value is about 2000000. Use this to work without a limit.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005130 *E363*
Bram Moolenaar02467872007-05-06 13:22:01 +00005131 When Vim runs into the limit it gives an error message and mostly
5132 behaves like CTRL-C was typed.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005133 Running into the limit often means that the pattern is very
5134 inefficient or too complex. This may already happen with the pattern
5135 "\(.\)*" on a very long line. ".*" works much better.
Bram Moolenaarfd358112018-07-07 23:21:31 +02005136 Might also happen on redraw, when syntax rules try to match a complex
5137 text structure.
5138 Vim may run out of memory before hitting the 'maxmempattern' limit, in
5139 which case you get an "Out of memory" error instead.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005140
Bram Moolenaar071d4272004-06-13 20:20:40 +00005141 *'maxmemtot'* *'mmt'*
5142'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
5143 dependent) or half the amount of memory
5144 available)
5145 global
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005146 Maximum amount of memory in Kbyte to use for all buffers together.
5147 The maximum usable value is about 2000000 (2 Gbyte). Use this to work
Bram Moolenaarfa735342016-01-03 22:14:44 +01005148 without a limit.
5149 On 64 bit machines higher values might work. But hey, do you really
5150 need more than 2 Gbyte for text editing? Keep in mind that text is
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005151 stored in the swap file, one can edit files > 2 Gbyte anyway. We do
Bram Moolenaarfa735342016-01-03 22:14:44 +01005152 need the memory to store undo info.
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005153 Buffers with 'swapfile' off still count to the total amount of memory
5154 used.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005155 Also see 'maxmem'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005156
5157 *'menuitems'* *'mis'*
5158'menuitems' 'mis' number (default 25)
5159 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005160 {not available when compiled without the |+menu|
5161 feature}
5162 Maximum number of items to use in a menu. Used for menus that are
5163 generated from a list of items, e.g., the Buffers menu. Changing this
5164 option has no direct effect, the menu must be refreshed first.
5165
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005166 *'mkspellmem'* *'msm'*
5167'mkspellmem' 'msm' string (default "460000,2000,500")
5168 global
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005169 {not available when compiled without the |+syntax|
5170 feature}
5171 Parameters for |:mkspell|. This tunes when to start compressing the
5172 word tree. Compression can be slow when there are many words, but
5173 it's needed to avoid running out of memory. The amount of memory used
5174 per word depends very much on how similar the words are, that's why
5175 this tuning is complicated.
5176
5177 There are three numbers, separated by commas:
5178 {start},{inc},{added}
5179
5180 For most languages the uncompressed word tree fits in memory. {start}
5181 gives the amount of memory in Kbyte that can be used before any
5182 compression is done. It should be a bit smaller than the amount of
5183 memory that is available to Vim.
5184
5185 When going over the {start} limit the {inc} number specifies the
5186 amount of memory in Kbyte that can be allocated before another
5187 compression is done. A low number means compression is done after
5188 less words are added, which is slow. A high number means more memory
5189 will be allocated.
5190
5191 After doing compression, {added} times 1024 words can be added before
5192 the {inc} limit is ignored and compression is done when any extra
5193 amount of memory is needed. A low number means there is a smaller
5194 chance of hitting the {inc} limit, less memory is used but it's
5195 slower.
5196
5197 The languages for which these numbers are important are Italian and
5198 Hungarian. The default works for when you have about 512 Mbyte. If
5199 you have 1 Gbyte you could use: >
5200 :set mkspellmem=900000,3000,800
5201< If you have less than 512 Mbyte |:mkspell| may fail for some
5202 languages, no matter what you set 'mkspellmem' to.
5203
Bram Moolenaar07607392019-05-26 19:20:43 +02005204 This option cannot be set from a |modeline| or in the |sandbox|.
5205
Bram Moolenaar071d4272004-06-13 20:20:40 +00005206 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
Bram Moolenaar8243a792007-05-01 17:05:03 +00005207'modeline' 'ml' boolean (Vim default: on (off for root),
5208 Vi default: off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005209 local to buffer
Bram Moolenaar110289e2019-05-23 15:38:06 +02005210 If 'modeline' is on 'modelines' gives the number of lines that is
5211 checked for set commands. If 'modeline' is off or 'modelines' is zero
5212 no lines are checked. See |modeline|.
5213
5214 *'modelineexpr'* *'mle'* *'nomodelineexpr'* *'nomle'*
5215'modelineexpr' 'mle' boolean (default: off)
5216 global
5217 When on allow some options that are an expression to be set in the
5218 modeline. Check the option for whether it is affected by
5219 'modelineexpr'. Also see |modeline|.
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02005220 This option cannot be set from a |modeline| or in the |sandbox|, for
5221 security reasons.
Bram Moolenaar110289e2019-05-23 15:38:06 +02005222
Bram Moolenaar071d4272004-06-13 20:20:40 +00005223 *'modelines'* *'mls'*
5224'modelines' 'mls' number (default 5)
5225 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005226 If 'modeline' is on 'modelines' gives the number of lines that is
5227 checked for set commands. If 'modeline' is off or 'modelines' is zero
5228 no lines are checked. See |modeline|.
5229 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
5230 set and to the Vim default value when 'compatible' is reset.
5231
5232 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
Bram Moolenaar110289e2019-05-23 15:38:06 +02005233 *E21*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005234'modifiable' 'ma' boolean (default on)
5235 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005236 When off the buffer contents cannot be changed. The 'fileformat' and
5237 'fileencoding' options also can't be changed.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01005238 Can be reset on startup with the |-M| command line argument.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005239
5240 *'modified'* *'mod'* *'nomodified'* *'nomod'*
5241'modified' 'mod' boolean (default off)
5242 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005243 When on, the buffer is considered to be modified. This option is set
5244 when:
5245 1. A change was made to the text since it was last written. Using the
5246 |undo| command to go back to the original text will reset the
5247 option. But undoing changes that were made before writing the
5248 buffer will set the option again, since the text is different from
5249 when it was written.
5250 2. 'fileformat' or 'fileencoding' is different from its original
5251 value. The original value is set when the buffer is read or
5252 written. A ":set nomodified" command also resets the original
5253 values to the current values and the 'modified' option will be
5254 reset.
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01005255 Similarly for 'eol' and 'bomb'.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02005256 This option is not set when a change is made to the buffer as the
5257 result of a BufNewFile, BufRead/BufReadPost, BufWritePost,
5258 FileAppendPost or VimLeave autocommand event. See |gzip-example| for
5259 an explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005260 When 'buftype' is "nowrite" or "nofile" this option may be set, but
5261 will be ignored.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01005262 Note that the text may actually be the same, e.g. 'modified' is set
5263 when using "rA" on an "A".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005264
5265 *'more'* *'nomore'*
5266'more' boolean (Vim default: on, Vi default: off)
5267 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005268 When on, listings pause when the whole screen is filled. You will get
5269 the |more-prompt|. When this option is off there are no pauses, the
5270 listing continues until finished.
5271 NOTE: This option is set to the Vi default value when 'compatible' is
5272 set and to the Vim default value when 'compatible' is reset.
5273
Bram Moolenaar98a29d02021-01-18 19:55:44 +01005274 *'mouse'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005275'mouse' string (default "", "a" for GUI and Win32,
Bram Moolenaar5b418992019-10-27 18:50:25 +01005276 set to "a" or "nvi" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005277 global
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005278 Enable the use of the mouse. Works for most terminals (xterm, Win32
5279 |win32-mouse|, QNX pterm, *BSD console with sysmouse and Linux console
5280 with gpm). For using the mouse in the GUI, see |gui-mouse|. The
5281 mouse can be enabled for different modes:
Bram Moolenaar7f2e9d72017-11-11 20:58:53 +01005282 n Normal mode and Terminal modes
Bram Moolenaar071d4272004-06-13 20:20:40 +00005283 v Visual mode
5284 i Insert mode
5285 c Command-line mode
5286 h all previous modes when editing a help file
5287 a all previous modes
5288 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005289 Normally you would enable the mouse in all five modes with: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005290 :set mouse=a
Bram Moolenaar5b418992019-10-27 18:50:25 +01005291< If your terminal can't overrule the mouse events going to the
5292 application, use: >
5293 :set mouse=nvi
Bram Moolenaar65e0d772020-06-14 17:29:55 +02005294< Then you can press ":", select text for the system, and press Esc to go
Bram Moolenaar5b418992019-10-27 18:50:25 +01005295 back to Vim using the mouse events.
5296 In |defaults.vim| "nvi" is used if the 'term' option is not matching
5297 "xterm".
5298
5299 When the mouse is not enabled, the GUI will still use the mouse for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005300 modeless selection. This doesn't move the text cursor.
5301
5302 See |mouse-using|. Also see |'clipboard'|.
5303
5304 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005305 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005306 the mouse buttons can still be used by keeping the shift key pressed.
5307 Also see the 'clipboard' option.
5308
5309 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
5310'mousefocus' 'mousef' boolean (default off)
5311 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005312 {only works in the GUI}
5313 The window that the mouse pointer is on is automatically activated.
5314 When changing the window layout or window focus in another way, the
5315 mouse pointer is moved to the window with keyboard focus. Off is the
5316 default because it makes using the pull down menus a little goofy, as
5317 a pointer transit may activate a window unintentionally.
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01005318 MS-Windows: Also see 'scrollfocus' for what window is scrolled when
Bram Moolenaar1d9215b2020-01-25 13:27:42 +01005319 using the mouse scroll wheel.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005320
5321 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
5322'mousehide' 'mh' boolean (default on)
5323 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005324 {only works in the GUI}
5325 When on, the mouse pointer is hidden when characters are typed.
5326 The mouse pointer is restored when the mouse is moved.
5327
5328 *'mousemodel'* *'mousem'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005329'mousemodel' 'mousem' string (default "extend", "popup" for Win32)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005330 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005331 Sets the model to use for the mouse. The name mostly specifies what
5332 the right mouse button is used for:
5333 extend Right mouse button extends a selection. This works
5334 like in an xterm.
5335 popup Right mouse button pops up a menu. The shifted left
5336 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00005337 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005338 popup_setpos Like "popup", but the cursor will be moved to the
5339 position where the mouse was clicked, and thus the
5340 selected operation will act upon the clicked object.
5341 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00005342 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005343 course, that right clicking outside a selection will
5344 end Visual mode.
5345 Overview of what button does what for each model:
5346 mouse extend popup(_setpos) ~
5347 left click place cursor place cursor
5348 left drag start selection start selection
5349 shift-left search word extend selection
5350 right click extend selection popup menu (place cursor)
5351 right drag extend selection -
5352 middle click paste paste
5353
5354 In the "popup" model the right mouse button produces a pop-up menu.
5355 You need to define this first, see |popup-menu|.
5356
5357 Note that you can further refine the meaning of buttons with mappings.
5358 See |gui-mouse-mapping|. But mappings are NOT used for modeless
5359 selection (because that's handled in the GUI code directly).
5360
5361 The 'mousemodel' option is set by the |:behave| command.
5362
5363 *'mouseshape'* *'mouses'* *E547*
Bram Moolenaarf6b40102019-02-22 15:24:03 +01005364'mouseshape' 'mouses' string (default "i-r:beam,s:updown,sd:udsizing,
5365 vs:leftright,vd:lrsizing,m:no,
5366 ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005367 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005368 {only available when compiled with the |+mouseshape|
5369 feature}
5370 This option tells Vim what the mouse pointer should look like in
5371 different modes. The option is a comma separated list of parts, much
5372 like used for 'guicursor'. Each part consist of a mode/location-list
5373 and an argument-list:
5374 mode-list:shape,mode-list:shape,..
5375 The mode-list is a dash separated list of these modes/locations:
5376 In a normal window: ~
5377 n Normal mode
5378 v Visual mode
5379 ve Visual mode with 'selection' "exclusive" (same as 'v',
5380 if not specified)
5381 o Operator-pending mode
5382 i Insert mode
5383 r Replace mode
5384
5385 Others: ~
5386 c appending to the command-line
5387 ci inserting in the command-line
5388 cr replacing in the command-line
5389 m at the 'Hit ENTER' or 'More' prompts
5390 ml idem, but cursor in the last line
5391 e any mode, pointer below last window
5392 s any mode, pointer on a status line
5393 sd any mode, while dragging a status line
5394 vs any mode, pointer on a vertical separator line
5395 vd any mode, while dragging a vertical separator line
5396 a everywhere
5397
5398 The shape is one of the following:
5399 avail name looks like ~
5400 w x arrow Normal mouse pointer
5401 w x blank no pointer at all (use with care!)
5402 w x beam I-beam
5403 w x updown up-down sizing arrows
5404 w x leftright left-right sizing arrows
5405 w x busy The system's usual busy pointer
5406 w x no The system's usual 'no input' pointer
5407 x udsizing indicates up-down resizing
5408 x lrsizing indicates left-right resizing
5409 x crosshair like a big thin +
5410 x hand1 black hand
5411 x hand2 white hand
5412 x pencil what you write with
5413 x question big ?
5414 x rightup-arrow arrow pointing right-up
5415 w x up-arrow arrow pointing up
5416 x <number> any X11 pointer number (see X11/cursorfont.h)
5417
5418 The "avail" column contains a 'w' if the shape is available for Win32,
5419 x for X11.
5420 Any modes not specified or shapes not available use the normal mouse
5421 pointer.
5422
5423 Example: >
5424 :set mouseshape=s:udsizing,m:no
5425< will make the mouse turn to a sizing arrow over the status lines and
5426 indicate no input when the hit-enter prompt is displayed (since
5427 clicking the mouse has no effect in this state.)
5428
5429 *'mousetime'* *'mouset'*
5430'mousetime' 'mouset' number (default 500)
5431 global
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005432 Only for GUI, Win32 and Unix with xterm. Defines the maximum
Bram Moolenaar071d4272004-06-13 20:20:40 +00005433 time in msec between two mouse clicks for the second click to be
5434 recognized as a multi click.
5435
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005436 *'mzschemedll'*
5437'mzschemedll' string (default depends on the build)
5438 global
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005439 {only available when compiled with the |+mzscheme/dyn|
5440 feature}
5441 Specifies the name of the MzScheme shared library. The default is
5442 DYNAMIC_MZSCH_DLL which was specified at compile time.
5443 Environment variables are expanded |:set_env|.
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01005444 The value must be set in the |vimrc| script or earlier. In the
Bram Moolenaar01164a62017-11-02 22:58:42 +01005445 startup, before the |load-plugins| step.
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005446 This option cannot be set from a |modeline| or in the |sandbox|, for
5447 security reasons.
5448
5449 *'mzschemegcdll'*
5450'mzschemegcdll' string (default depends on the build)
5451 global
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005452 {only available when compiled with the |+mzscheme/dyn|
5453 feature}
5454 Specifies the name of the MzScheme GC shared library. The default is
5455 DYNAMIC_MZGC_DLL which was specified at compile time.
5456 The value can be equal to 'mzschemedll' if it includes the GC code.
5457 Environment variables are expanded |:set_env|.
5458 This option cannot be set from a |modeline| or in the |sandbox|, for
5459 security reasons.
5460
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005461 *'mzquantum'* *'mzq'*
5462'mzquantum' 'mzq' number (default 100)
5463 global
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005464 {not available when compiled without the |+mzscheme|
5465 feature}
5466 The number of milliseconds between polls for MzScheme threads.
5467 Negative or zero value means no thread scheduling.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005468 NOTE: This option is set to the Vim default value when 'compatible'
5469 is reset.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005470
Bram Moolenaar071d4272004-06-13 20:20:40 +00005471 *'nrformats'* *'nf'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02005472'nrformats' 'nf' string (default "bin,octal,hex",
5473 set to "bin,hex" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005474 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005475 This defines what bases Vim will consider for numbers when using the
5476 CTRL-A and CTRL-X commands for adding to and subtracting from a number
5477 respectively; see |CTRL-A| for more info on these commands.
Bram Moolenaar4770d092006-01-12 23:22:24 +00005478 alpha If included, single alphabetical characters will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005479 incremented or decremented. This is useful for a list with a
Bram Moolenaar3848e002016-03-19 18:42:29 +01005480 letter index a), b), etc. *octal-nrformats*
Bram Moolenaar4770d092006-01-12 23:22:24 +00005481 octal If included, numbers that start with a zero will be considered
Bram Moolenaar071d4272004-06-13 20:20:40 +00005482 to be octal. Example: Using CTRL-A on "007" results in "010".
Bram Moolenaar4770d092006-01-12 23:22:24 +00005483 hex If included, numbers starting with "0x" or "0X" will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005484 considered to be hexadecimal. Example: Using CTRL-X on
5485 "0x100" results in "0x0ff".
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005486 bin If included, numbers starting with "0b" or "0B" will be
5487 considered to be binary. Example: Using CTRL-X on
5488 "0b1000" subtracts one, resulting in "0b0111".
Bram Moolenaaraaad9952020-05-31 15:08:59 +02005489 unsigned If included, numbers are recognized as unsigned. Thus a
5490 leading dash or negative sign won't be considered as part of
5491 the number. Examples:
5492 Using CTRL-X on "2020" in "9-2020" results in "9-2019"
5493 (without "unsigned" it would become "9-2021").
5494 Using CTRL-A on "2020" in "9-2020" results in "9-2021"
5495 (without "unsigned" it would become "9-2019").
Bram Moolenaaracc22402020-06-07 21:07:18 +02005496 Using CTRL-X on "0" or CTRL-A on "18446744073709551615"
5497 (2^64 - 1) has no effect, overflow is prevented.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005498 Numbers which simply begin with a digit in the range 1-9 are always
5499 considered decimal. This also happens for numbers that are not
5500 recognized as octal or hex.
5501
5502 *'number'* *'nu'* *'nonumber'* *'nonu'*
5503'number' 'nu' boolean (default off)
5504 local to window
5505 Print the line number in front of each line. When the 'n' option is
5506 excluded from 'cpoptions' a wrapped line will not use the column of
5507 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005508 The 'numberwidth' option can be used to set the room used for the line
5509 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005510 When a long, wrapped line doesn't start with the first character, '-'
5511 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02005512 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
5513 the number.
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005514 *number_relativenumber*
5515 The 'relativenumber' option changes the displayed number to be
5516 relative to the cursor. Together with 'number' there are these
5517 four combinations (cursor in line 3):
5518
Bram Moolenaar3848e002016-03-19 18:42:29 +01005519 'nonu' 'nu' 'nonu' 'nu'
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005520 'nornu' 'nornu' 'rnu' 'rnu'
5521
5522 |apple | 1 apple | 2 apple | 2 apple
5523 |pear | 2 pear | 1 pear | 1 pear
5524 |nobody | 3 nobody | 0 nobody |3 nobody
5525 |there | 4 there | 1 there | 1 there
Bram Moolenaar071d4272004-06-13 20:20:40 +00005526
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005527 *'numberwidth'* *'nuw'*
5528'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
5529 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005530 {only available when compiled with the |+linebreak|
5531 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005532 Minimal number of columns to use for the line number. Only relevant
Bram Moolenaar64486672010-05-16 15:46:46 +02005533 when the 'number' or 'relativenumber' option is set or printing lines
5534 with a line number. Since one space is always between the number and
5535 the text, there is one less character for the number itself.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005536 The value is the minimum width. A bigger width is used when needed to
Bram Moolenaar64486672010-05-16 15:46:46 +02005537 fit the highest line number in the buffer respectively the number of
5538 rows in the window, depending on whether 'number' or 'relativenumber'
5539 is set. Thus with the Vim default of 4 there is room for a line number
5540 up to 999. When the buffer has 1000 lines five columns will be used.
Bram Moolenaarf8a07122019-07-01 22:06:07 +02005541 The minimum value is 1, the maximum value is 20.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005542 NOTE: This option is set to the Vi default value when 'compatible' is
5543 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005544
Bram Moolenaarf75a9632005-09-13 21:20:47 +00005545 *'omnifunc'* *'ofu'*
5546'omnifunc' 'ofu' string (default: empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00005547 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02005548 {not available when compiled without the |+eval|
Bram Moolenaare2c453d2019-08-21 14:37:09 +02005549 feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00005550 This option specifies a function to be used for Insert mode omni
5551 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
Bram Moolenaar280f1262006-01-30 00:14:18 +00005552 See |complete-functions| for an explanation of how the function is
5553 invoked and what it should return.
Bram Moolenaar043545e2006-10-10 16:44:07 +00005554 This option is usually set by a filetype plugin:
Bram Moolenaar9c102382006-05-03 21:26:49 +00005555 |:filetype-plugin-on|
Bram Moolenaar30b65812012-07-12 22:01:11 +02005556 This option cannot be set from a |modeline| or in the |sandbox|, for
5557 security reasons.
Bram Moolenaare344bea2005-09-01 20:46:49 +00005558
5559
Bram Moolenaar02467872007-05-06 13:22:01 +00005560 *'opendevice'* *'odev'* *'noopendevice'* *'noodev'*
Bram Moolenaar043545e2006-10-10 16:44:07 +00005561'opendevice' 'odev' boolean (default off)
5562 global
Bram Moolenaar6f345a12019-12-17 21:27:18 +01005563 {only for MS-Windows}
Bram Moolenaar043545e2006-10-10 16:44:07 +00005564 Enable reading and writing from devices. This may get Vim stuck on a
5565 device that can be opened but doesn't actually do the I/O. Therefore
5566 it is off by default.
5567 Note that on MS-Windows editing "aux.h", "lpt1.txt" and the like also
5568 result in editing a device.
5569
5570
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005571 *'operatorfunc'* *'opfunc'*
5572'operatorfunc' 'opfunc' string (default: empty)
5573 global
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005574 This option specifies a function to be called by the |g@| operator.
5575 See |:map-operator| for more info and an example.
5576
5577 This option cannot be set from a |modeline| or in the |sandbox|, for
5578 security reasons.
5579
5580
Bram Moolenaar251e1912011-06-19 05:09:16 +02005581 *'osfiletype'* *'oft'*
5582'osfiletype' 'oft' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005583 local to buffer
Bram Moolenaar251e1912011-06-19 05:09:16 +02005584 This option was supported on RISC OS, which has been removed.
5585
Bram Moolenaar071d4272004-06-13 20:20:40 +00005586
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005587 *'packpath'* *'pp'*
5588'packpath' 'pp' string (default: see 'runtimepath')
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005589 Directories used to find packages. See |packages|.
5590
5591
Bram Moolenaar071d4272004-06-13 20:20:40 +00005592 *'paragraphs'* *'para'*
Bram Moolenaar57e48462008-03-12 16:38:55 +00005593'paragraphs' 'para' string (default "IPLPPPQPP TPHPLIPpLpItpplpipbp")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005594 global
5595 Specifies the nroff macros that separate paragraphs. These are pairs
5596 of two letters (see |object-motions|).
5597
5598 *'paste'* *'nopaste'*
5599'paste' boolean (default off)
5600 global
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005601 Put Vim in Paste mode. This is useful if you want to cut or copy
5602 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005603 unexpected effects.
5604 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005605 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00005606 knows about pasting and will mostly do the right thing without 'paste'
5607 being set. The same is true for a terminal where Vim handles the
5608 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00005609 This option is reset when starting the GUI. Thus if you set it in
5610 your .vimrc it will work in a terminal, but not in the GUI. Setting
5611 'paste' in the GUI has side effects: e.g., the Paste toolbar button
5612 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005613 When the 'paste' option is switched on (also when it was already on):
5614 - mapping in Insert mode and Command-line mode is disabled
5615 - abbreviations are disabled
Bram Moolenaar071d4272004-06-13 20:20:40 +00005616 - 'autoindent' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02005617 - 'expandtab' is reset
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02005618 - 'hkmap' is reset
Bram Moolenaar071d4272004-06-13 20:20:40 +00005619 - 'revins' is reset
5620 - 'ruler' is reset
5621 - 'showmatch' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02005622 - 'smarttab' is reset
5623 - 'softtabstop' is set to 0
5624 - 'textwidth' is set to 0
5625 - 'wrapmargin' is set to 0
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02005626 - 'varsofttabstop' is made empty
Bram Moolenaar071d4272004-06-13 20:20:40 +00005627 These options keep their value, but their effect is disabled:
Bram Moolenaar071d4272004-06-13 20:20:40 +00005628 - 'cindent'
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02005629 - 'formatoptions' is used like it is empty
Bram Moolenaarca635012015-09-25 20:34:21 +02005630 - 'indentexpr'
5631 - 'lisp'
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02005632 - 'smartindent'
Bram Moolenaar071d4272004-06-13 20:20:40 +00005633 NOTE: When you start editing another file while the 'paste' option is
5634 on, settings from the modelines or autocommands may change the
5635 settings again, causing trouble when pasting text. You might want to
5636 set the 'paste' option again.
5637 When the 'paste' option is reset the mentioned options are restored to
5638 the value before the moment 'paste' was switched from off to on.
5639 Resetting 'paste' before ever setting it does not have any effect.
5640 Since mapping doesn't work while 'paste' is active, you need to use
5641 the 'pastetoggle' option to toggle the 'paste' option with some key.
5642
5643 *'pastetoggle'* *'pt'*
5644'pastetoggle' 'pt' string (default "")
5645 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005646 When non-empty, specifies the key sequence that toggles the 'paste'
5647 option. This is like specifying a mapping: >
5648 :map {keys} :set invpaste<CR>
5649< Where {keys} is the value of 'pastetoggle'.
5650 The difference is that it will work even when 'paste' is set.
5651 'pastetoggle' works in Insert mode and Normal mode, but not in
5652 Command-line mode.
5653 Mappings are checked first, thus overrule 'pastetoggle'. However,
5654 when 'paste' is on mappings are ignored in Insert mode, thus you can do
5655 this: >
5656 :map <F10> :set paste<CR>
5657 :map <F11> :set nopaste<CR>
5658 :imap <F10> <C-O>:set paste<CR>
5659 :imap <F11> <nop>
5660 :set pastetoggle=<F11>
5661< This will make <F10> start paste mode and <F11> stop paste mode.
5662 Note that typing <F10> in paste mode inserts "<F10>", since in paste
5663 mode everything is inserted literally, except the 'pastetoggle' key
5664 sequence.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005665 When the value has several bytes 'ttimeoutlen' applies.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005666
5667 *'pex'* *'patchexpr'*
5668'patchexpr' 'pex' string (default "")
5669 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005670 {not available when compiled without the |+diff|
5671 feature}
5672 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005673 the resulting new version of the file. See |diff-patchexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005674
Bram Moolenaardbc28022014-07-26 13:40:44 +02005675 *'patchmode'* *'pm'* *E205* *E206*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005676'patchmode' 'pm' string (default "")
5677 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005678 When non-empty the oldest version of a file is kept. This can be used
5679 to keep the original version of a file if you are changing files in a
5680 source distribution. Only the first time that a file is written a
5681 copy of the original file will be kept. The name of the copy is the
5682 name of the original file with the string in the 'patchmode' option
5683 appended. This option should start with a dot. Use a string like
Bram Moolenaardf980db2017-12-24 13:22:00 +01005684 ".orig" or ".org". 'backupdir' must not be empty for this to work
5685 (Detail: The backup file is renamed to the patchmode file after the
5686 new file has been successfully written, that's why it must be possible
5687 to write a backup file). If there was no file to be backed up, an
5688 empty file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005689 When the 'backupskip' pattern matches, a patchmode file is not made.
5690 Using 'patchmode' for compressed files appends the extension at the
5691 end (e.g., "file.gz.orig"), thus the resulting name isn't always
5692 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005693 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005694
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01005695 *'path'* *'pa'* *E343* *E345* *E347* *E854*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005696'path' 'pa' string (default on Unix: ".,/usr/include,,"
Bram Moolenaar071d4272004-06-13 20:20:40 +00005697 other systems: ".,,")
5698 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005699 This is a list of directories which will be searched when using the
Bram Moolenaarc236c162008-07-13 17:41:49 +00005700 |gf|, [f, ]f, ^Wf, |:find|, |:sfind|, |:tabfind| and other commands,
5701 provided that the file being searched for has a relative path (not
5702 starting with "/", "./" or "../"). The directories in the 'path'
5703 option may be relative or absolute.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005704 - Use commas to separate directory names: >
5705 :set path=.,/usr/local/include,/usr/include
5706< - Spaces can also be used to separate directory names (for backwards
5707 compatibility with version 3.0). To have a space in a directory
5708 name, precede it with an extra backslash, and escape the space: >
5709 :set path=.,/dir/with\\\ space
5710< - To include a comma in a directory name precede it with an extra
5711 backslash: >
5712 :set path=.,/dir/with\\,comma
5713< - To search relative to the directory of the current file, use: >
5714 :set path=.
5715< - To search in the current directory use an empty string between two
5716 commas: >
5717 :set path=,,
5718< - A directory name may end in a ':' or '/'.
5719 - Environment variables are expanded |:set_env|.
5720 - When using |netrw.vim| URLs can be used. For example, adding
5721 "http://www.vim.org" will make ":find index.html" work.
Bram Moolenaarc236c162008-07-13 17:41:49 +00005722 - Search upwards and downwards in a directory tree using "*", "**" and
5723 ";". See |file-searching| for info and syntax.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005724 {not available when compiled without the |+path_extra| feature}
5725 - Careful with '\' characters, type two to get one in the option: >
5726 :set path=.,c:\\include
5727< Or just use '/' instead: >
5728 :set path=.,c:/include
5729< Don't forget "." or files won't even be found in the same directory as
5730 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005731 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00005732 it is something like 256 or 1024 characters.
5733 You can check if all the include files are found, using the value of
5734 'path', see |:checkpath|.
5735 The use of |:set+=| and |:set-=| is preferred when adding or removing
5736 directories from the list. This avoids problems when a future version
5737 uses another default. To remove the current directory use: >
5738 :set path-=
5739< To add the current directory use: >
5740 :set path+=
5741< To use an environment variable, you probably need to replace the
5742 separator. Here is an example to append $INCL, in which directory
5743 names are separated with a semi-colon: >
5744 :let &path = &path . "," . substitute($INCL, ';', ',', 'g')
5745< Replace the ';' with a ':' or whatever separator is used. Note that
5746 this doesn't work when $INCL contains a comma or white space.
5747
Bram Moolenaar37c64c72017-09-19 22:06:03 +02005748 *'perldll'*
5749'perldll' string (default depends on the build)
5750 global
Bram Moolenaar37c64c72017-09-19 22:06:03 +02005751 {only available when compiled with the |+perl/dyn|
5752 feature}
5753 Specifies the name of the Perl shared library. The default is
5754 DYNAMIC_PERL_DLL, which was specified at compile time.
5755 Environment variables are expanded |:set_env|.
5756 This option cannot be set from a |modeline| or in the |sandbox|, for
5757 security reasons.
5758
Bram Moolenaar071d4272004-06-13 20:20:40 +00005759 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
5760'preserveindent' 'pi' boolean (default off)
5761 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005762 When changing the indent of the current line, preserve as much of the
5763 indent structure as possible. Normally the indent is replaced by a
5764 series of tabs followed by spaces as required (unless |'expandtab'| is
5765 enabled, in which case only spaces are used). Enabling this option
5766 means the indent will preserve as many existing characters as possible
5767 for indenting, and only add additional tabs or spaces as required.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005768 'expandtab' does not apply to the preserved white space, a Tab remains
5769 a Tab.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005770 NOTE: When using ">>" multiple times the resulting indent is a mix of
5771 tabs and spaces. You might not like this.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005772 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005773 Also see 'copyindent'.
5774 Use |:retab| to clean up white space.
5775
5776 *'previewheight'* *'pvh'*
5777'previewheight' 'pvh' number (default 12)
5778 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02005779 {not available when compiled without the |+quickfix|
5780 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005781 Default height for a preview window. Used for |:ptag| and associated
Bram Moolenaar79648732019-07-18 21:43:07 +02005782 commands. Used for |CTRL-W_}| when no count is given. Not used when
5783 'previewpopup' is set.
5784
5785 *'previewpopup'* *'pvp'*
5786'previewpopup' 'pvp' string (default empty)
5787 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02005788 {not available when compiled without the |+textprop|
5789 or |+quickfix| feature}
Bram Moolenaar79648732019-07-18 21:43:07 +02005790 When not empty a popup window is used for commands that would open a
5791 preview window. See |preview-popup|.
Bram Moolenaar576a4a62019-08-18 15:25:17 +02005792 Not used for the insert completion info, add "popup" to
5793 'completeopt' for that.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005794
5795 *'previewwindow'* *'nopreviewwindow'*
5796 *'pvw'* *'nopvw'* *E590*
5797'previewwindow' 'pvw' boolean (default off)
5798 local to window
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02005799 {not available when compiled without the |+quickfix|
5800 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005801 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00005802 set. It's normally not set directly, but by using one of the commands
5803 |:ptag|, |:pedit|, etc.
5804
5805 *'printdevice'* *'pdev'*
5806'printdevice' 'pdev' string (default empty)
5807 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005808 {only available when compiled with the |+printer|
5809 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005810 The name of the printer to be used for |:hardcopy|.
5811 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005812 This option cannot be set from a |modeline| or in the |sandbox|, for
5813 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005814
Bram Moolenaar8299df92004-07-10 09:47:34 +00005815 *'printencoding'* *'penc'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005816'printencoding' 'penc' string (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005817 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005818 {only available when compiled with the |+printer|
5819 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005820 Sets the character encoding used when printing.
5821 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005822
5823 *'printexpr'* *'pexpr'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005824'printexpr' 'pexpr' string (default: see below)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005825 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005826 {only available when compiled with the |+printer|
5827 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005828 Expression used to print the PostScript produced with |:hardcopy|.
5829 See |pexpr-option|.
Bram Moolenaar51628222016-12-01 23:03:28 +01005830 This option cannot be set from a |modeline| or in the |sandbox|, for
5831 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005832
Bram Moolenaar8299df92004-07-10 09:47:34 +00005833 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005834'printfont' 'pfn' string (default "courier")
5835 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005836 {only available when compiled with the |+printer|
5837 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005838 The name of the font that will be used for |:hardcopy|.
5839 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005840
5841 *'printheader'* *'pheader'*
5842'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
5843 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005844 {only available when compiled with the |+printer|
5845 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005846 The format of the header produced in |:hardcopy| output.
5847 See |pheader-option|.
5848
5849 *'printmbcharset'* *'pmbcs'*
5850'printmbcharset' 'pmbcs' string (default "")
5851 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01005852 {only available when compiled with the |+printer|
5853 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005854 The CJK character set to be used for CJK output from |:hardcopy|.
5855 See |pmbcs-option|.
5856
5857 *'printmbfont'* *'pmbfn'*
5858'printmbfont' 'pmbfn' string (default "")
5859 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01005860 {only available when compiled with the |+printer|
5861 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005862 List of font names to be used for CJK output from |:hardcopy|.
5863 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005864
5865 *'printoptions'* *'popt'*
5866'printoptions' 'popt' string (default "")
5867 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005868 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005869 List of items that control the format of the output of |:hardcopy|.
5870 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005871
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005872 *'prompt'* *'noprompt'*
5873'prompt' boolean (default on)
5874 global
5875 When on a ":" prompt is used in Ex mode.
5876
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005877 *'pumheight'* *'ph'*
5878'pumheight' 'ph' number (default 0)
5879 global
Bram Moolenaar06a89a52006-04-29 22:01:03 +00005880 Determines the maximum number of items to show in the popup menu for
5881 Insert mode completion. When zero as much space as available is used.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005882 |ins-completion-menu|.
5883
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01005884 *'pumwidth'* *'pw'*
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005885'pumwidth' 'pw' number (default 15)
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01005886 global
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01005887 Determines the minimum width to use for the popup menu for Insert mode
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005888 completion. |ins-completion-menu|.
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01005889
Bram Moolenaard94464e2015-11-02 15:28:18 +01005890 *'pythondll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01005891'pythondll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01005892 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01005893 {only available when compiled with the |+python/dyn|
5894 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005895 Specifies the name of the Python 2.x shared library. The default is
5896 DYNAMIC_PYTHON_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005897 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01005898 This option cannot be set from a |modeline| or in the |sandbox|, for
5899 security reasons.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005900
Bram Moolenaar94073162018-01-31 21:49:05 +01005901 *'pythonhome'*
5902'pythonhome' string (default "")
5903 global
Bram Moolenaar94073162018-01-31 21:49:05 +01005904 {only available when compiled with the |+python/dyn|
5905 feature}
5906 Specifies the name of the Python 2.x home directory. When 'pythonhome'
5907 and the PYTHONHOME environment variable are not set, PYTHON_HOME,
5908 which was specified at compile time, will be used for the Python 2.x
5909 home directory.
5910 Environment variables are expanded |:set_env|.
5911 This option cannot be set from a |modeline| or in the |sandbox|, for
5912 security reasons.
5913
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005914 *'pythonthreedll'*
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005915'pythonthreedll' string (default depends on the build)
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005916 global
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005917 {only available when compiled with the |+python3/dyn|
5918 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005919 Specifies the name of the Python 3 shared library. The default is
5920 DYNAMIC_PYTHON3_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005921 Environment variables are expanded |:set_env|.
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005922 This option cannot be set from a |modeline| or in the |sandbox|, for
5923 security reasons.
5924
Bram Moolenaar94073162018-01-31 21:49:05 +01005925 *'pythonthreehome'*
5926'pythonthreehome' string (default "")
5927 global
Bram Moolenaar94073162018-01-31 21:49:05 +01005928 {only available when compiled with the |+python3/dyn|
5929 feature}
5930 Specifies the name of the Python 3 home directory. When
5931 'pythonthreehome' and the PYTHONHOME environment variable are not set,
5932 PYTHON3_HOME, which was specified at compile time, will be used for
5933 the Python 3 home directory.
5934 Environment variables are expanded |:set_env|.
5935 This option cannot be set from a |modeline| or in the |sandbox|, for
5936 security reasons.
5937
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01005938 *'pyxversion'* *'pyx'*
5939'pyxversion' 'pyx' number (default depends on the build)
5940 global
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01005941 {only available when compiled with the |+python| or
5942 the |+python3| feature}
5943 Specifies the python version used for pyx* functions and commands
5944 |python_x|. The default value is as follows:
5945
5946 Compiled with Default ~
5947 |+python| and |+python3| 0
5948 only |+python| 2
5949 only |+python3| 3
5950
5951 Available values are 0, 2 and 3.
5952 If 'pyxversion' is 0, it is set to 2 or 3 after the first execution of
5953 any python2/3 commands or functions. E.g. `:py` sets to 2, and `:py3`
5954 sets to 3. `:pyx` sets it to 3 if Python 3 is available, otherwise sets
5955 to 2 if Python 2 is available.
5956 See also: |has-pythonx|
5957
5958 If Vim is compiled with only |+python| or |+python3| setting
5959 'pyxversion' has no effect. The pyx* functions and commands are
5960 always the same as the compiled version.
5961
5962 This option cannot be set from a |modeline| or in the |sandbox|, for
5963 security reasons.
5964
Bram Moolenaar858ba062020-05-31 23:11:59 +02005965 *'quickfixtextfunc'* *'qftf'*
5966'quickfixtextfunc' 'qftf' string (default "")
5967 global
5968 {only available when compiled with the |+quickfix|
5969 feature}
5970 This option specifies a function to be used to get the text to display
5971 in the quickfix and location list windows. This can be used to
5972 customize the information displayed in the quickfix or location window
5973 for each entry in the corresponding quickfix or location list. See
5974 |quickfix-window-function| for an explanation of how to write the
Bram Moolenaard43906d2020-07-20 21:31:32 +02005975 function and an example. The value can be the name of a function or a
5976 lambda.
Bram Moolenaar858ba062020-05-31 23:11:59 +02005977
5978 This option cannot be set from a |modeline| or in the |sandbox|, for
5979 security reasons.
5980
Bram Moolenaar677ee682005-01-27 14:41:15 +00005981 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005982'quoteescape' 'qe' string (default "\")
5983 local to buffer
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005984 The characters that are used to escape quotes in a string. Used for
5985 objects like a', a" and a` |a'|.
5986 When one of the characters in this option is found inside a string,
5987 the following character will be skipped. The default value makes the
5988 text "foo\"bar\\" considered to be one string.
5989
Bram Moolenaar071d4272004-06-13 20:20:40 +00005990 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
5991'readonly' 'ro' boolean (default off)
5992 local to buffer
5993 If on, writes fail unless you use a '!'. Protects you from
5994 accidentally overwriting a file. Default on when Vim is started
5995 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005996 When using ":w!" the 'readonly' option is reset for the current
5997 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar6c60f472019-04-28 16:00:35 +02005998 When using the ":view" command the 'readonly' option is set for the
5999 newly edited buffer.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01006000 See 'modifiable' for disallowing changes to the buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006001
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006002 *'redrawtime'* *'rdt'*
6003'redrawtime' 'rdt' number (default 2000)
6004 global
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006005 {only available when compiled with the |+reltime|
6006 feature}
6007 The time in milliseconds for redrawing the display. This applies to
Bram Moolenaar15142e22018-04-30 22:19:58 +02006008 searching for patterns for 'hlsearch', |:match| highlighting and syntax
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02006009 highlighting.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006010 When redrawing takes more than this many milliseconds no further
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02006011 matches will be highlighted.
6012 For syntax highlighting the time applies per window. When over the
6013 limit syntax highlighting is disabled until |CTRL-L| is used.
6014 This is used to avoid that Vim hangs when using a very complicated
6015 pattern.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006016
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02006017 *'regexpengine'* *'re'*
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006018'regexpengine' 're' number (default 0)
6019 global
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006020 This selects the default regexp engine. |two-engines|
6021 The possible values are:
6022 0 automatic selection
6023 1 old engine
6024 2 NFA engine
6025 Note that when using the NFA engine and the pattern contains something
6026 that is not supported the pattern will not match. This is only useful
6027 for debugging the regexp engine.
Bram Moolenaarfda37292014-11-05 14:27:36 +01006028 Using automatic selection enables Vim to switch the engine, if the
6029 default engine becomes too costly. E.g., when the NFA engine uses too
6030 many states. This should prevent Vim from hanging on a combination of
6031 a complex pattern with long text.
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006032
Bram Moolenaar64486672010-05-16 15:46:46 +02006033 *'relativenumber'* *'rnu'* *'norelativenumber'* *'nornu'*
6034'relativenumber' 'rnu' boolean (default off)
6035 local to window
Bram Moolenaar64486672010-05-16 15:46:46 +02006036 Show the line number relative to the line with the cursor in front of
Bram Moolenaar06b5d512010-05-22 15:37:44 +02006037 each line. Relative line numbers help you use the |count| you can
Bram Moolenaar64486672010-05-16 15:46:46 +02006038 precede some vertical motion commands (e.g. j k + -) with, without
6039 having to calculate it yourself. Especially useful in combination with
6040 other commands (e.g. y d c < > gq gw =).
6041 When the 'n' option is excluded from 'cpoptions' a wrapped
6042 line will not use the column of line numbers (this is the default when
6043 'compatible' isn't set).
6044 The 'numberwidth' option can be used to set the room used for the line
6045 number.
6046 When a long, wrapped line doesn't start with the first character, '-'
6047 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02006048 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
6049 the number.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01006050
Bram Moolenaar203d04d2013-06-06 21:36:40 +02006051 The number in front of the cursor line also depends on the value of
6052 'number', see |number_relativenumber| for all combinations of the two
6053 options.
Bram Moolenaar64486672010-05-16 15:46:46 +02006054
Bram Moolenaar071d4272004-06-13 20:20:40 +00006055 *'remap'* *'noremap'*
6056'remap' boolean (default on)
6057 global
6058 Allows for mappings to work recursively. If you do not want this for
6059 a single entry, use the :noremap[!] command.
Bram Moolenaara3227e22006-03-08 21:32:40 +00006060 NOTE: To avoid portability problems with Vim scripts, always keep
6061 this option at the default "on". Only switch it off when working with
6062 old Vi scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006063
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006064 *'renderoptions'* *'rop'*
6065'renderoptions' 'rop' string (default: empty)
6066 global
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006067 {only available when compiled with GUI and DIRECTX on
6068 MS-Windows}
6069 Select a text renderer and set its options. The options depend on the
6070 renderer.
6071
6072 Syntax: >
6073 set rop=type:{renderer}(,{name}:{value})*
6074<
6075 Currently, only one optional renderer is available.
6076
6077 render behavior ~
6078 directx Vim will draw text using DirectX (DirectWrite). It makes
6079 drawn glyphs more beautiful than default GDI.
6080 It requires 'encoding' is "utf-8", and only works on
6081 MS-Windows Vista or newer version.
6082
6083 Options:
6084 name meaning type value ~
6085 gamma gamma float 1.0 - 2.2 (maybe)
6086 contrast enhancedContrast float (unknown)
6087 level clearTypeLevel float (unknown)
6088 geom pixelGeometry int 0 - 2 (see below)
6089 renmode renderingMode int 0 - 6 (see below)
6090 taamode textAntialiasMode int 0 - 3 (see below)
Bram Moolenaara338adc2018-01-31 20:51:47 +01006091 scrlines Scroll Lines int (deprecated)
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006092
Bram Moolenaar92467d32017-12-05 13:22:16 +01006093 See this URL for detail (except for scrlines):
6094 https://msdn.microsoft.com/en-us/library/dd368190.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006095
6096 For geom: structure of a device pixel.
6097 0 - DWRITE_PIXEL_GEOMETRY_FLAT
6098 1 - DWRITE_PIXEL_GEOMETRY_RGB
6099 2 - DWRITE_PIXEL_GEOMETRY_BGR
6100
6101 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006102 https://msdn.microsoft.com/en-us/library/dd368114.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006103
6104 For renmode: method of rendering glyphs.
6105 0 - DWRITE_RENDERING_MODE_DEFAULT
6106 1 - DWRITE_RENDERING_MODE_ALIASED
6107 2 - DWRITE_RENDERING_MODE_GDI_CLASSIC
6108 3 - DWRITE_RENDERING_MODE_GDI_NATURAL
6109 4 - DWRITE_RENDERING_MODE_NATURAL
6110 5 - DWRITE_RENDERING_MODE_NATURAL_SYMMETRIC
6111 6 - DWRITE_RENDERING_MODE_OUTLINE
6112
6113 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006114 https://msdn.microsoft.com/en-us/library/dd368118.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006115
6116 For taamode: antialiasing mode used for drawing text.
6117 0 - D2D1_TEXT_ANTIALIAS_MODE_DEFAULT
6118 1 - D2D1_TEXT_ANTIALIAS_MODE_CLEARTYPE
6119 2 - D2D1_TEXT_ANTIALIAS_MODE_GRAYSCALE
6120 3 - D2D1_TEXT_ANTIALIAS_MODE_ALIASED
6121
6122 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006123 https://msdn.microsoft.com/en-us/library/dd368170.aspx
6124
Bram Moolenaara338adc2018-01-31 20:51:47 +01006125 For scrlines:
6126 This was used for optimizing scrolling behavior, however this
6127 is now deprecated. If specified, it is simply ignored.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006128
6129 Example: >
6130 set encoding=utf-8
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006131 set gfn=Ricty_Diminished:h12
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006132 set rop=type:directx
6133<
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006134 If select a raster font (Courier, Terminal or FixedSys which
6135 have ".fon" extension in file name) to 'guifont', it will be
Bram Moolenaar92467d32017-12-05 13:22:16 +01006136 drawn by GDI as a fallback.
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006137
6138 NOTE: It is known that some fonts and options combination
6139 causes trouble on drawing glyphs.
6140
Bram Moolenaar92467d32017-12-05 13:22:16 +01006141 - 'renmode:5' and 'renmode:6' will not work with some
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006142 special made fonts (True-Type fonts which includes only
6143 bitmap glyphs).
6144 - 'taamode:3' will not work with some vector fonts.
6145
6146 NOTE: With this option, you can display colored emoji
6147 (emoticon) in Windows 8.1 or later. To display colored emoji,
6148 there are some conditions which you should notice.
6149
6150 - If your font includes non-colored emoji already, it will
6151 be used.
6152 - If your font doesn't have emoji, the system chooses an
6153 alternative symbol font. On Windows 10, "Segoe UI Emoji"
6154 will be used.
6155 - When this alternative font didn't have fixed width glyph,
6156 emoji might be rendered beyond the bounding box of drawing
6157 cell.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006158
6159 Other render types are currently not supported.
6160
Bram Moolenaar071d4272004-06-13 20:20:40 +00006161 *'report'*
6162'report' number (default 2)
6163 global
6164 Threshold for reporting number of lines changed. When the number of
6165 changed lines is more than 'report' a message will be given for most
6166 ":" commands. If you want it always, set 'report' to 0.
6167 For the ":substitute" command the number of substitutions is used
6168 instead of the number of lines.
6169
6170 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
6171'restorescreen' 'rs' boolean (default on)
6172 global
Bram Moolenaar8024f932020-01-14 19:29:13 +01006173 {only in MS-Windows console version}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006174 When set, the screen contents is restored when exiting Vim. This also
6175 happens when executing external commands.
6176
6177 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
6178 options in your .vimrc. To disable restoring:
6179 set t_ti= t_te=
6180 To enable restoring (for an xterm):
6181 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
6182 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
6183
6184 *'revins'* *'ri'* *'norevins'* *'nori'*
6185'revins' 'ri' boolean (default off)
6186 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006187 {only available when compiled with the |+rightleft|
6188 feature}
6189 Inserting characters in Insert mode will work backwards. See "typing
6190 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
6191 command in Insert mode, when 'allowrevins' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02006192 NOTE: This option is reset when 'compatible' is set.
6193 This option is reset when 'paste' is set and restored when 'paste' is
6194 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006195
6196 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
6197'rightleft' 'rl' boolean (default off)
6198 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006199 {only available when compiled with the |+rightleft|
6200 feature}
6201 When on, display orientation becomes right-to-left, i.e., characters
6202 that are stored in the file appear from the right to the left.
6203 Using this option, it is possible to edit files for languages that
6204 are written from the right to the left such as Hebrew and Arabic.
6205 This option is per window, so it is possible to edit mixed files
6206 simultaneously, or to view the same file in both ways (this is
6207 useful whenever you have a mixed text file with both right-to-left
6208 and left-to-right strings so that both sets are displayed properly
6209 in different windows). Also see |rileft.txt|.
6210
Bram Moolenaar607cc1e2010-07-18 18:47:44 +02006211 *'rightleftcmd'* *'rlc'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006212'rightleftcmd' 'rlc' string (default "search")
6213 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006214 {only available when compiled with the |+rightleft|
6215 feature}
6216 Each word in this option enables the command line editing to work in
6217 right-to-left mode for a group of commands:
6218
6219 search "/" and "?" commands
6220
6221 This is useful for languages such as Hebrew, Arabic and Farsi.
6222 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
6223
Bram Moolenaard94464e2015-11-02 15:28:18 +01006224 *'rubydll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01006225'rubydll' string (default: depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01006226 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01006227 {only available when compiled with the |+ruby/dyn|
6228 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006229 Specifies the name of the Ruby shared library. The default is
6230 DYNAMIC_RUBY_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006231 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01006232 This option cannot be set from a |modeline| or in the |sandbox|, for
6233 security reasons.
6234
Bram Moolenaar071d4272004-06-13 20:20:40 +00006235 *'ruler'* *'ru'* *'noruler'* *'noru'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02006236'ruler' 'ru' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006237 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006238 {not available when compiled without the
6239 |+cmdline_info| feature}
6240 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006241 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00006242 text in the file is shown on the far right:
6243 Top first line is visible
6244 Bot last line is visible
6245 All first and last line are visible
6246 45% relative position in the file
6247 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006248 Each window has its own ruler. If a window has a status line, the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006249 ruler is shown there. Otherwise it is shown in the last line of the
Bram Moolenaar582fd852005-03-28 20:58:01 +00006250 screen. If the statusline is given by 'statusline' (i.e. not empty),
Bram Moolenaar071d4272004-06-13 20:20:40 +00006251 this option takes precedence over 'ruler' and 'rulerformat'
6252 If the number of characters displayed is different from the number of
Bram Moolenaar207f0092020-08-30 17:20:20 +02006253 bytes in the text (e.g., for a TAB or a multibyte character), both
Bram Moolenaar071d4272004-06-13 20:20:40 +00006254 the text column (byte number) and the screen column are shown,
6255 separated with a dash.
6256 For an empty line "0-1" is shown.
6257 For an empty buffer the line number will also be zero: "0,0-1".
Bram Moolenaarca635012015-09-25 20:34:21 +02006258 This option is reset when 'paste' is set and restored when 'paste' is
6259 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006260 If you don't want to see the ruler all the time but want to know where
6261 you are, use "g CTRL-G" |g_CTRL-G|.
6262 NOTE: This option is reset when 'compatible' is set.
6263
6264 *'rulerformat'* *'ruf'*
6265'rulerformat' 'ruf' string (default empty)
6266 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006267 {not available when compiled without the |+statusline|
6268 feature}
6269 When this option is not empty, it determines the content of the ruler
6270 string, as displayed for the 'ruler' option.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00006271 The format of this option is like that of 'statusline'.
Bram Moolenaar110289e2019-05-23 15:38:06 +02006272 This option cannot be set in a modeline when 'modelineexpr' is off.
6273
Bram Moolenaar071d4272004-06-13 20:20:40 +00006274 The default ruler width is 17 characters. To make the ruler 15
6275 characters wide, put "%15(" at the start and "%)" at the end.
6276 Example: >
6277 :set rulerformat=%15(%c%V\ %p%%%)
6278<
6279 *'runtimepath'* *'rtp'* *vimfiles*
6280'runtimepath' 'rtp' string (default:
Bram Moolenaar942db232021-02-13 18:14:48 +01006281 Unix: "$HOME/.vim,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006282 $VIM/vimfiles,
6283 $VIMRUNTIME,
6284 $VIM/vimfiles/after,
6285 $HOME/.vim/after"
6286 Amiga: "home:vimfiles,
6287 $VIM/vimfiles,
6288 $VIMRUNTIME,
6289 $VIM/vimfiles/after,
6290 home:vimfiles/after"
Bram Moolenaar942db232021-02-13 18:14:48 +01006291 MS-Windows: "$HOME/vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006292 $VIM/vimfiles,
6293 $VIMRUNTIME,
6294 $VIM/vimfiles/after,
6295 $HOME/vimfiles/after"
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02006296 macOS: "$VIM:vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006297 $VIMRUNTIME,
6298 $VIM:vimfiles:after"
Bram Moolenaarb3f74062020-02-26 16:16:53 +01006299 Haiku: "$BE_USER_SETTINGS/vim,
6300 $VIM/vimfiles,
6301 $VIMRUNTIME,
6302 $VIM/vimfiles/after,
Bram Moolenaar942db232021-02-13 18:14:48 +01006303 $BE_USER_SETTINGS/vim/after"
6304 VMS: "sys$login:vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006305 $VIM/vimfiles,
6306 $VIMRUNTIME,
6307 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00006308 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006309 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006310 This is a list of directories which will be searched for runtime
6311 files:
6312 filetype.vim filetypes by file name |new-filetype|
6313 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006314 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006315 colors/ color scheme files |:colorscheme|
6316 compiler/ compiler files |:compiler|
6317 doc/ documentation |write-local-help|
6318 ftplugin/ filetype plugins |write-filetype-plugin|
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01006319 import/ files that are found by `:import`
Bram Moolenaar071d4272004-06-13 20:20:40 +00006320 indent/ indent scripts |indent-expression|
6321 keymap/ key mapping files |mbyte-keymap|
6322 lang/ menu translations |:menutrans|
6323 menu.vim GUI menus |menu.vim|
Bram Moolenaar26852122016-05-24 20:02:38 +02006324 pack/ packages |:packadd|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006325 plugin/ plugin scripts |write-plugin|
6326 print/ files for printing |postscript-print-encoding|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006327 spell/ spell checking files |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006328 syntax/ syntax files |mysyntaxfile|
6329 tutor/ files for vimtutor |tutor|
6330
6331 And any other file searched for with the |:runtime| command.
6332
6333 The defaults for most systems are setup to search five locations:
6334 1. In your home directory, for your personal preferences.
6335 2. In a system-wide Vim directory, for preferences from the system
6336 administrator.
6337 3. In $VIMRUNTIME, for files distributed with Vim.
6338 *after-directory*
6339 4. In the "after" directory in the system-wide Vim directory. This is
6340 for the system administrator to overrule or add to the distributed
6341 defaults (rarely needed)
6342 5. In the "after" directory in your home directory. This is for
6343 personal preferences to overrule or add to the distributed defaults
6344 or system-wide settings (rarely needed).
6345
Bram Moolenaard0796902016-09-16 20:02:31 +02006346 More entries are added when using |packages|. If it gets very long
6347 then `:set rtp` will be truncated, use `:echo &rtp` to see the full
6348 string.
Bram Moolenaar26852122016-05-24 20:02:38 +02006349
Bram Moolenaar071d4272004-06-13 20:20:40 +00006350 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
6351 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006352 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00006353 wildcards.
6354 See |:runtime|.
6355 Example: >
6356 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
6357< This will use the directory "~/vimruntime" first (containing your
6358 personal Vim runtime files), then "/mygroup/vim" (shared between a
6359 group of people) and finally "$VIMRUNTIME" (the distributed runtime
6360 files).
6361 You probably should always include $VIMRUNTIME somewhere, to use the
6362 distributed runtime files. You can put a directory before $VIMRUNTIME
6363 to find files which replace a distributed runtime files. You can put
6364 a directory after $VIMRUNTIME to find files which add to distributed
6365 runtime files.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006366 When Vim is started with |--clean| the home directory entries are not
6367 included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006368 This option cannot be set from a |modeline| or in the |sandbox|, for
6369 security reasons.
6370
6371 *'scroll'* *'scr'*
6372'scroll' 'scr' number (default: half the window height)
6373 local to window
6374 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
6375 set to half the number of lines in the window when the window size
Bram Moolenaar74667062020-12-28 15:41:41 +01006376 changes. This may happen when enabling the |status-line| or
6377 'tabline' option after setting the 'scroll' option.
6378 If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006379 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar25c9c682019-05-05 18:13:34 +02006380 height with ":set scroll=0".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006381
6382 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
6383'scrollbind' 'scb' boolean (default off)
6384 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006385 See also |scroll-binding|. When this option is set, the current
6386 window scrolls as other scrollbind windows (windows that also have
6387 this option set) scroll. This option is useful for viewing the
6388 differences between two versions of a file, see 'diff'.
6389 See |'scrollopt'| for options that determine how this option should be
6390 interpreted.
6391 This option is mostly reset when splitting a window to edit another
6392 file. This means that ":split | edit file" results in two windows
6393 with scroll-binding, but ":split file" does not.
6394
Bram Moolenaarae20f342019-11-05 21:09:23 +01006395 *'scrollfocus'* *'scf'* *'noscrollfocus'* *'noscf'*
6396'scrollfocus' 'scf' boolean (default off)
6397 global
6398 {only for MS-Windows GUI}
6399 When using the scroll wheel and this option is set, the window under
6400 the mouse pointer is scrolled. With this option off the current
6401 window is scrolled.
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01006402 Systems other than MS-Windows always behave like this option is on.
Bram Moolenaarae20f342019-11-05 21:09:23 +01006403
Bram Moolenaar071d4272004-06-13 20:20:40 +00006404 *'scrolljump'* *'sj'*
6405'scrolljump' 'sj' number (default 1)
6406 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006407 Minimal number of lines to scroll when the cursor gets off the
6408 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
6409 CTRL-D). Useful if your terminal scrolls very slowly.
Bram Moolenaar1e015462005-09-25 22:16:38 +00006410 When set to a negative number from -1 to -100 this is used as the
6411 percentage of the window height. Thus -50 scrolls half the window
6412 height.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006413 NOTE: This option is set to 1 when 'compatible' is set.
6414
6415 *'scrolloff'* *'so'*
Bram Moolenaar50ba5262016-09-22 22:33:02 +02006416'scrolloff' 'so' number (default 0, set to 5 in |defaults.vim|)
Bram Moolenaar375e3392019-01-31 18:26:10 +01006417 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006418 Minimal number of screen lines to keep above and below the cursor.
6419 This will make some context visible around where you are working. If
6420 you set it to a very large value (999) the cursor line will always be
6421 in the middle of the window (except at the start or end of the file or
6422 when long lines wrap).
Bram Moolenaar375e3392019-01-31 18:26:10 +01006423 After using the local value, go back the global value with one of
6424 these two: >
6425 setlocal scrolloff<
6426 setlocal scrolloff=-1
6427< For scrolling horizontally see 'sidescrolloff'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006428 NOTE: This option is set to 0 when 'compatible' is set.
6429
6430 *'scrollopt'* *'sbo'*
6431'scrollopt' 'sbo' string (default "ver,jump")
6432 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006433 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006434 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
6435 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006436 The following words are available:
6437 ver Bind vertical scrolling for 'scrollbind' windows
6438 hor Bind horizontal scrolling for 'scrollbind' windows
6439 jump Applies to the offset between two windows for vertical
6440 scrolling. This offset is the difference in the first
6441 displayed line of the bound windows. When moving
6442 around in a window, another 'scrollbind' window may
6443 reach a position before the start or after the end of
6444 the buffer. The offset is not changed though, when
6445 moving back the 'scrollbind' window will try to scroll
6446 to the desired position when possible.
6447 When now making that window the current one, two
6448 things can be done with the relative offset:
6449 1. When "jump" is not included, the relative offset is
6450 adjusted for the scroll position in the new current
6451 window. When going back to the other window, the
Bram Moolenaar02467872007-05-06 13:22:01 +00006452 new relative offset will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006453 2. When "jump" is included, the other windows are
6454 scrolled to keep the same relative offset. When
6455 going back to the other window, it still uses the
6456 same relative offset.
6457 Also see |scroll-binding|.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006458 When 'diff' mode is active there always is vertical scroll binding,
6459 even when "ver" isn't there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006460
6461 *'sections'* *'sect'*
6462'sections' 'sect' string (default "SHNHH HUnhsh")
6463 global
6464 Specifies the nroff macros that separate sections. These are pairs of
6465 two letters (See |object-motions|). The default makes a section start
6466 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
6467
6468 *'secure'* *'nosecure'* *E523*
6469'secure' boolean (default off)
6470 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006471 When on, ":autocmd", shell and write commands are not allowed in
6472 ".vimrc" and ".exrc" in the current directory and map commands are
6473 displayed. Switch it off only if you know that you will not run into
6474 problems, or when the 'exrc' option is off. On Unix this option is
6475 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006476 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00006477 'secure' at the end of your ~/.vimrc then.
6478 This option cannot be set from a |modeline| or in the |sandbox|, for
6479 security reasons.
6480
6481 *'selection'* *'sel'*
6482'selection' 'sel' string (default "inclusive")
6483 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006484 This option defines the behavior of the selection. It is only used
6485 in Visual and Select mode.
6486 Possible values:
6487 value past line inclusive ~
6488 old no yes
6489 inclusive yes yes
6490 exclusive yes no
6491 "past line" means that the cursor is allowed to be positioned one
6492 character past the line.
6493 "inclusive" means that the last character of the selection is included
6494 in an operation. For example, when "x" is used to delete the
6495 selection.
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02006496 When "old" is used and 'virtualedit' allows the cursor to move past
6497 the end of line the line break still isn't included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006498 Note that when "exclusive" is used and selecting from the end
6499 backwards, you cannot include the last character of a line, when
6500 starting in Normal mode and 'virtualedit' empty.
6501
6502 The 'selection' option is set by the |:behave| command.
6503
6504 *'selectmode'* *'slm'*
6505'selectmode' 'slm' string (default "")
6506 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006507 This is a comma separated list of words, which specifies when to start
6508 Select mode instead of Visual mode, when a selection is started.
6509 Possible values:
6510 mouse when using the mouse
6511 key when using shifted special keys
6512 cmd when using "v", "V" or CTRL-V
6513 See |Select-mode|.
6514 The 'selectmode' option is set by the |:behave| command.
6515
6516 *'sessionoptions'* *'ssop'*
6517'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006518 help,options,tabpages,winsize,terminal")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006519 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02006520 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006521 feature}
6522 Changes the effect of the |:mksession| command. It is a comma
6523 separated list of words. Each word enables saving and restoring
6524 something:
6525 word save and restore ~
6526 blank empty windows
6527 buffers hidden and unloaded buffers, not just those in windows
6528 curdir the current directory
6529 folds manually created folds, opened/closed folds and local
6530 fold options
6531 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00006532 and contain at least one lowercase letter. Only
6533 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006534 help the help window
6535 localoptions options and mappings local to a window or buffer (not
6536 global values for local options)
6537 options all options and mappings (also global values for local
6538 options)
Bram Moolenaard23b7142021-04-17 21:04:34 +02006539 skiprtp exclude 'runtimepath' and 'packpath' from the options
Bram Moolenaar071d4272004-06-13 20:20:40 +00006540 resize size of the Vim window: 'lines' and 'columns'
6541 sesdir the directory in which the session file is located
6542 will become the current directory (useful with
6543 projects accessed over a network from different
6544 systems)
6545 slash backslashes in file names replaced with forward
6546 slashes
Bram Moolenaar18144c82006-04-12 21:52:12 +00006547 tabpages all tab pages; without this only the current tab page
6548 is restored, so that you can make a session for each
6549 tab page separately
Bram Moolenaard473c8c2018-08-11 18:00:22 +02006550 terminal include terminal windows where the command can be
6551 restored
Bram Moolenaar071d4272004-06-13 20:20:40 +00006552 unix with Unix end-of-line format (single <NL>), even when
6553 on Windows or DOS
6554 winpos position of the whole Vim window
6555 winsize window sizes
6556
6557 Don't include both "curdir" and "sesdir".
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006558 When neither "curdir" nor "sesdir" is included, file names are stored
6559 with absolute paths.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006560 "slash" and "unix" are useful on Windows when sharing session files
6561 with Unix. The Unix version of Vim cannot source dos format scripts,
6562 but the Windows version of Vim can source unix format scripts.
6563
6564 *'shell'* *'sh'* *E91*
Bram Moolenaar95a9dd12019-12-19 22:12:03 +01006565'shell' 'sh' string (default $SHELL or "sh", Win32: "cmd.exe")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006566 global
6567 Name of the shell to use for ! and :! commands. When changing the
6568 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
6569 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006570 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006571 See |option-backslash| about including spaces and backslashes.
6572 Environment variables are expanded |:set_env|.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006573
Bram Moolenaar1ff14ba2019-11-02 14:09:23 +01006574 If the name of the shell contains a space, you need to enclose it in
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01006575 quotes and escape the space. Example with quotes: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006576 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
6577< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006578 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006579 "-f" is not inside the quotes, because it is not part of the command
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006580 name. Vim automagically recognizes the backslashes that are path
Bram Moolenaar071d4272004-06-13 20:20:40 +00006581 separators.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006582 Example with escaped space (Vim will do this when initializing the
6583 option from $SHELL): >
6584 :set shell=/bin/with\\\ space/sh
Bram Moolenaard473c8c2018-08-11 18:00:22 +02006585< The resulting value of 'shell' is "/bin/with\ space/sh", two
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006586 backslashes are consumed by `:set`.
6587
Bram Moolenaar071d4272004-06-13 20:20:40 +00006588 Under MS-Windows, when the executable ends in ".com" it must be
6589 included. Thus setting the shell to "command.com" or "4dos.com"
6590 works, but "command" and "4dos" do not work for all commands (e.g.,
6591 filtering).
6592 For unknown reasons, when using "4dos.com" the current directory is
6593 changed to "C:\". To avoid this set 'shell' like this: >
6594 :set shell=command.com\ /c\ 4dos
6595< This option cannot be set from a |modeline| or in the |sandbox|, for
6596 security reasons.
6597
6598 *'shellcmdflag'* *'shcf'*
Bram Moolenaar5dc62522012-02-13 00:05:22 +01006599'shellcmdflag' 'shcf' string (default: "-c";
Mike Williams12795022021-06-28 20:53:58 +02006600 Win32, when 'shell' contains "powershell":
6601 "-Command", or when it does not contain "sh"
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006602 somewhere: "/c")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006603 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006604 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
Mike Williams12795022021-06-28 20:53:58 +02006605 "bash.exe -c ls", "powershell.exe -Command dir", or "cmd.exe /c dir".
6606 For MS-Windows, the default is set according to the value of 'shell',
6607 to reduce the need to set this option by the user.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02006608 On Unix it can have more than one flag. Each white space separated
6609 part is passed as an argument to the shell command.
6610 See |option-backslash| about including spaces and backslashes.
Mike Williams12795022021-06-28 20:53:58 +02006611 Also see |dos-shell| and |dos-powershell| for MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006612 This option cannot be set from a |modeline| or in the |sandbox|, for
6613 security reasons.
6614
6615 *'shellpipe'* *'sp'*
Mike Williams12795022021-06-28 20:53:58 +02006616'shellpipe' 'sp' string (default ">", ">%s 2>&1", "| tee", "|& tee"
6617 "2>&1| tee", or
6618 "2>&1 | Out-File -Encoding default")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006619 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006620 {not available when compiled without the |+quickfix|
6621 feature}
6622 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006623 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00006624 including spaces and backslashes.
6625 The name of the temporary file can be represented by "%s" if necessary
6626 (the file name is appended automatically if no %s appears in the value
6627 of this option).
Mike Williams12795022021-06-28 20:53:58 +02006628 For the Amiga the default is ">". For MS-Windows using powershell the
6629 default is "2>&1 | Out-File -Encoding default", otherwise the default
6630 is ">%s 2>&1". The output is directly saved in a file and not echoed
6631 to the screen.
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02006632 For Unix the default is "| tee". The stdout of the compiler is saved
Bram Moolenaar071d4272004-06-13 20:20:40 +00006633 in a file and echoed to the screen. If the 'shell' option is "csh" or
6634 "tcsh" after initializations, the default becomes "|& tee". If the
Bram Moolenaar96f45c02019-10-26 19:53:45 +02006635 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh", "zsh-beta",
Natanael Copa56318362021-05-06 18:46:35 +02006636 "bash", "fish", "ash" or "dash" the default becomes "2>&1| tee". This
6637 means that stderr is also included. Before using the 'shell' option a
6638 path is removed, thus "/bin/sh" uses "sh".
Mike Williamsa3d1b292021-06-30 20:56:00 +02006639 For Unix and MS-Windows, when the 'shell' option is "pwsh" the default
6640 becomes ">%s 2>&1" and the output is not echoed to the screen.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006641 The initialization of this option is done after reading the ".vimrc"
6642 and the other initializations, so that when the 'shell' option is set
6643 there, the 'shellpipe' option changes automatically, unless it was
6644 explicitly set before.
6645 When 'shellpipe' is set to an empty string, no redirection of the
6646 ":make" output will be done. This is useful if you use a 'makeprg'
6647 that writes to 'makeef' by itself. If you want no piping, but do
6648 want to include the 'makeef', set 'shellpipe' to a single space.
6649 Don't forget to precede the space with a backslash: ":set sp=\ ".
6650 In the future pipes may be used for filtering and this option will
6651 become obsolete (at least for Unix).
6652 This option cannot be set from a |modeline| or in the |sandbox|, for
6653 security reasons.
6654
6655 *'shellquote'* *'shq'*
Mike Williamsa3d1b292021-06-30 20:56:00 +02006656'shellquote' 'shq' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006657 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006658 Quoting character(s), put around the command passed to the shell, for
6659 the "!" and ":!" commands. The redirection is kept outside of the
6660 quoting. See 'shellxquote' to include the redirection. It's
6661 probably not useful to set both options.
6662 This is an empty string by default. Only known to be useful for
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006663 third-party shells on MS-Windows-like systems, such as the MKS Korn
Mike Williamsa3d1b292021-06-30 20:56:00 +02006664 Shell or bash, where it should be "\"". See |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006665 This option cannot be set from a |modeline| or in the |sandbox|, for
6666 security reasons.
6667
6668 *'shellredir'* *'srr'*
Mike Williams12795022021-06-28 20:53:58 +02006669'shellredir' 'srr' string (default ">", ">&", ">%s 2>&1", or
6670 "2>&1 | Out-File -Encoding default")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006671 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006672 String to be used to put the output of a filter command in a temporary
6673 file. See also |:!|. See |option-backslash| about including spaces
6674 and backslashes.
6675 The name of the temporary file can be represented by "%s" if necessary
6676 (the file name is appended automatically if no %s appears in the value
6677 of this option).
Bram Moolenaar96f45c02019-10-26 19:53:45 +02006678 The default is ">". For Unix, if the 'shell' option is "csh" or
6679 "tcsh" during initializations, the default becomes ">&". If the
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01006680 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh", "zsh-beta",
Mike Williamsa3d1b292021-06-30 20:56:00 +02006681 "bash", "fish", or "pwsh", the default becomes ">%s 2>&1". This means
6682 that stderr is also included. For Win32, the Unix checks are done and
Mike Williams12795022021-06-28 20:53:58 +02006683 additionally "cmd" is checked for, which makes the default ">%s 2>&1",
6684 and "powershell" is checked for which makes the default
Mike Williamsa3d1b292021-06-30 20:56:00 +02006685 "2>&1 | Out-File -Encoding default" (see |dos-powershell|). Also, the
6686 same names with ".exe" appended are checked for.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006687 The initialization of this option is done after reading the ".vimrc"
6688 and the other initializations, so that when the 'shell' option is set
6689 there, the 'shellredir' option changes automatically unless it was
6690 explicitly set before.
6691 In the future pipes may be used for filtering and this option will
6692 become obsolete (at least for Unix).
6693 This option cannot be set from a |modeline| or in the |sandbox|, for
6694 security reasons.
6695
6696 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
6697'shellslash' 'ssl' boolean (default off)
6698 global
Bram Moolenaar6f345a12019-12-17 21:27:18 +01006699 {only for MS-Windows}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006700 When set, a forward slash is used when expanding file names. This is
Mike Williamsa3d1b292021-06-30 20:56:00 +02006701 useful when a Unix-like shell is used instead of cmd.exe, pwsh.exe, or
Mike Williams12795022021-06-28 20:53:58 +02006702 powershell.exe. Backward slashes can still be typed, but they are
6703 changed to forward slashes by Vim.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006704 Note that setting or resetting this option has no effect for some
6705 existing file names, thus this option needs to be set before opening
6706 any file for best results. This might change in the future.
6707 'shellslash' only works when a backslash can be used as a path
6708 separator. To test if this is so use: >
6709 if exists('+shellslash')
Bram Moolenaarac3150d2019-07-28 16:36:39 +02006710< Also see 'completeslash'.
6711
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006712 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
6713'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
6714 global
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006715 When on, use temp files for shell commands. When off use a pipe.
6716 When using a pipe is not possible temp files are used anyway.
Bram Moolenaar97293012011-07-18 19:40:27 +02006717 Currently a pipe is only supported on Unix and MS-Windows 2K and
6718 later. You can check it with: >
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006719 :if has("filterpipe")
6720< The advantage of using a pipe is that nobody can read the temp file
6721 and the 'shell' command does not need to support redirection.
6722 The advantage of using a temp file is that the file type and encoding
6723 can be detected.
6724 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
6725 |FilterWritePost| autocommands event are not triggered when
6726 'shelltemp' is off.
Bram Moolenaar269f5952016-07-15 22:54:41 +02006727 The `system()` function does not respect this option and always uses
6728 temp files.
Bram Moolenaar036986f2017-03-16 17:41:02 +01006729 NOTE: This option is set to the Vim default value when 'compatible'
6730 is reset.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006731
Bram Moolenaar071d4272004-06-13 20:20:40 +00006732 *'shelltype'* *'st'*
6733'shelltype' 'st' number (default 0)
6734 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02006735 {only for the Amiga}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006736 On the Amiga this option influences the way how the commands work
6737 which use a shell.
6738 0 and 1: always use the shell
6739 2 and 3: use the shell only to filter lines
6740 4 and 5: use shell only for ':sh' command
6741 When not using the shell, the command is executed directly.
6742
6743 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
6744 1 and 3: use "shell cmd" to start external commands
6745
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006746 *'shellxescape'* *'sxe'*
6747'shellxescape' 'sxe' string (default: "";
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006748 for MS-Windows: "\"&|<>()@^")
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006749 global
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006750 When 'shellxquote' is set to "(" then the characters listed in this
6751 option will be escaped with a '^' character. This makes it possible
6752 to execute most external commands with cmd.exe.
6753
Bram Moolenaar071d4272004-06-13 20:20:40 +00006754 *'shellxquote'* *'sxq'*
6755'shellxquote' 'sxq' string (default: "";
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006756 for Win32, when 'shell' is cmd.exe: "("
Mike Williams12795022021-06-28 20:53:58 +02006757 for Win32, when 'shell' is
6758 powershell.exe: "\""
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006759 for Win32, when 'shell' contains "sh"
6760 somewhere: "\""
Bram Moolenaar071d4272004-06-13 20:20:40 +00006761 for Unix, when using system(): "\"")
6762 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006763 Quoting character(s), put around the command passed to the shell, for
6764 the "!" and ":!" commands. Includes the redirection. See
6765 'shellquote' to exclude the redirection. It's probably not useful
6766 to set both options.
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006767 When the value is '(' then ')' is appended. When the value is '"('
6768 then ')"' is appended.
6769 When the value is '(' then also see 'shellxescape'.
Bram Moolenaara64ba222012-02-12 23:23:31 +01006770 This is an empty string by default on most systems, but is known to be
Mike Williamsa3d1b292021-06-30 20:56:00 +02006771 useful for on Win32 version, either for cmd.exe, powershell.exe, or
6772 pwsh.exe which automatically strips off the first and last quote on a
6773 command, or 3rd-party shells such as the MKS Korn Shell or bash, where
6774 it should be "\"". The default is adjusted according the value of
Mike Williams12795022021-06-28 20:53:58 +02006775 'shell', to reduce the need to set this option by the user. See
6776 |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006777 This option cannot be set from a |modeline| or in the |sandbox|, for
6778 security reasons.
6779
6780 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
6781'shiftround' 'sr' boolean (default off)
6782 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006783 Round indent to multiple of 'shiftwidth'. Applies to > and <
6784 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
6785 a multiple of 'shiftwidth' (this is Vi compatible).
6786 NOTE: This option is reset when 'compatible' is set.
6787
6788 *'shiftwidth'* *'sw'*
6789'shiftwidth' 'sw' number (default 8)
6790 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006791 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00006792 |'cindent'|, |>>|, |<<|, etc.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02006793 When zero the 'ts' value will be used. Use the |shiftwidth()|
6794 function to get the effective shiftwidth value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006795
6796 *'shortmess'* *'shm'*
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02006797'shortmess' 'shm' string (Vim default "filnxtToOS", Vi default: "S",
6798 POSIX default: "AS")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006799 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006800 This option helps to avoid all the |hit-enter| prompts caused by file
6801 messages, for example with CTRL-G, and to avoid some other messages.
6802 It is a list of flags:
6803 flag meaning when present ~
6804 f use "(3 of 5)" instead of "(file 3 of 5)"
6805 i use "[noeol]" instead of "[Incomplete last line]"
Bram Moolenaar3f40ce72020-07-05 14:10:13 +02006806 l use "999L, 888B" instead of "999 lines, 888 bytes"
Bram Moolenaar071d4272004-06-13 20:20:40 +00006807 m use "[+]" instead of "[Modified]"
6808 n use "[New]" instead of "[New File]"
6809 r use "[RO]" instead of "[readonly]"
6810 w use "[w]" instead of "written" for file write message
6811 and "[a]" instead of "appended" for ':w >> file' command
6812 x use "[dos]" instead of "[dos format]", "[unix]" instead of
6813 "[unix format]" and "[mac]" instead of "[mac format]".
6814 a all of the above abbreviations
6815
6816 o overwrite message for writing a file with subsequent message
6817 for reading a file (useful for ":wn" or when 'autowrite' on)
6818 O message for reading a file overwrites any previous message.
6819 Also for quickfix message (e.g., ":cn").
6820 s don't give "search hit BOTTOM, continuing at TOP" or "search
Bram Moolenaara6c27c42019-05-09 19:16:22 +02006821 hit TOP, continuing at BOTTOM" messages; when using the search
6822 count do not show "W" after the count message (see S below)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006823 t truncate file message at the start if it is too long to fit
6824 on the command-line, "<" will appear in the left most column.
6825 Ignored in Ex mode.
6826 T truncate other messages in the middle if they are too long to
Bram Moolenaar582fd852005-03-28 20:58:01 +00006827 fit on the command line. "..." will appear in the middle.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006828 Ignored in Ex mode.
6829 W don't give "written" or "[w]" when writing a file
6830 A don't give the "ATTENTION" message when an existing swap file
6831 is found.
6832 I don't give the intro message when starting Vim |:intro|.
Bram Moolenaarea389e92014-05-28 21:40:52 +02006833 c don't give |ins-completion-menu| messages. For example,
6834 "-- XXX completion (YYY)", "match 1 of 2", "The only match",
6835 "Pattern not found", "Back at original", etc.
Bram Moolenaar426dd022016-03-15 15:09:29 +01006836 q use "recording" instead of "recording @a"
6837 F don't give the file info when editing a file, like `:silent`
Bram Moolenaar110289e2019-05-23 15:38:06 +02006838 was used for the command; note that this also affects messages
6839 from autocommands
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02006840 S do not show search count message when searching, e.g.
6841 "[1/5]"
Bram Moolenaar071d4272004-06-13 20:20:40 +00006842
6843 This gives you the opportunity to avoid that a change between buffers
6844 requires you to hit <Enter>, but still gives as useful a message as
6845 possible for the space available. To get the whole message that you
6846 would have got with 'shm' empty, use ":file!"
6847 Useful values:
6848 shm= No abbreviation of message.
6849 shm=a Abbreviation, but no loss of information.
6850 shm=at Abbreviation, and truncate message when necessary.
6851
6852 NOTE: This option is set to the Vi default value when 'compatible' is
6853 set and to the Vim default value when 'compatible' is reset.
6854
6855 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
6856'shortname' 'sn' boolean (default off)
6857 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00006858 Filenames are assumed to be 8 characters plus one extension of 3
6859 characters. Multiple dots in file names are not allowed. When this
6860 option is on, dots in file names are replaced with underscores when
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006861 adding an extension (".~" or ".swp"). This option is useful
Bram Moolenaar071d4272004-06-13 20:20:40 +00006862 when editing files on an MS-DOS compatible filesystem, e.g., messydos
Bram Moolenaarade0d392020-01-21 22:33:58 +01006863 or crossdos.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006864
6865 *'showbreak'* *'sbr'* *E595*
6866'showbreak' 'sbr' string (default "")
Bram Moolenaaree857022019-11-09 23:26:40 +01006867 global or local to window |global-local|
Bram Moolenaardb84e452010-08-15 13:50:43 +02006868 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006869 feature}
6870 String to put at the start of lines that have been wrapped. Useful
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006871 values are "> " or "+++ ": >
6872 :set showbreak=>\
6873< Note the backslash to escape the trailing space. It's easier like
6874 this: >
Bram Moolenaar1a384422010-07-14 19:53:30 +02006875 :let &showbreak = '+++ '
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006876< Only printable single-cell characters are allowed, excluding <Tab> and
Bram Moolenaar071d4272004-06-13 20:20:40 +00006877 comma (in a future version the comma might be used to separate the
6878 part that is shown at the end and at the start of a line).
6879 The characters are highlighted according to the '@' flag in
6880 'highlight'.
6881 Note that tabs after the showbreak will be displayed differently.
6882 If you want the 'showbreak' to appear in between line numbers, add the
6883 "n" flag to 'cpoptions'.
Bram Moolenaaree857022019-11-09 23:26:40 +01006884 A window-local value overrules a global value. If the global value is
6885 set and you want no value in the current window use NONE: >
6886 :setlocal showbreak=NONE
6887<
Bram Moolenaar071d4272004-06-13 20:20:40 +00006888 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02006889'showcmd' 'sc' boolean (Vim default: on, off for Unix,
6890 Vi default: off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006891 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006892 {not available when compiled without the
6893 |+cmdline_info| feature}
Bram Moolenaar02467872007-05-06 13:22:01 +00006894 Show (partial) command in the last line of the screen. Set this
6895 option off if your terminal is slow.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006896 In Visual mode the size of the selected area is shown:
6897 - When selecting characters within a line, the number of characters.
Bram Moolenaarf91787c2010-07-17 12:47:16 +02006898 If the number of bytes is different it is also displayed: "2-6"
6899 means two characters and six bytes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006900 - When selecting more than one line, the number of lines.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006901 - When selecting a block, the size in screen characters:
6902 {lines}x{columns}.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006903 NOTE: This option is set to the Vi default value when 'compatible' is
6904 set and to the Vim default value when 'compatible' is reset.
6905
6906 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
6907'showfulltag' 'sft' boolean (default off)
6908 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006909 When completing a word in insert mode (see |ins-completion|) from the
6910 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006911 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00006912 matched a C function, you can see a template for what arguments are
6913 required (coding style permitting).
Bram Moolenaar446cb832008-06-24 21:56:24 +00006914 Note that this doesn't work well together with having "longest" in
6915 'completeopt', because the completion from the search pattern may not
6916 match the typed text.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006917
6918 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
6919'showmatch' 'sm' boolean (default off)
6920 global
6921 When a bracket is inserted, briefly jump to the matching one. The
6922 jump is only done if the match can be seen on the screen. The time to
6923 show the match can be set with 'matchtime'.
6924 A Beep is given if there is no match (no matter if the match can be
Bram Moolenaarca635012015-09-25 20:34:21 +02006925 seen or not).
6926 This option is reset when 'paste' is set and restored when 'paste' is
6927 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006928 When the 'm' flag is not included in 'cpoptions', typing a character
6929 will immediately move the cursor back to where it belongs.
6930 See the "sm" field in 'guicursor' for setting the cursor shape and
6931 blinking when showing the match.
6932 The 'matchpairs' option can be used to specify the characters to show
6933 matches for. 'rightleft' and 'revins' are used to look for opposite
6934 matches.
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006935 Also see the matchparen plugin for highlighting the match when moving
6936 around |pi_paren.txt|.
6937 Note: Use of the short form is rated PG.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006938
6939 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
6940'showmode' 'smd' boolean (Vim default: on, Vi default: off)
6941 global
6942 If in Insert, Replace or Visual mode put a message on the last line.
6943 Use the 'M' flag in 'highlight' to set the type of highlighting for
6944 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006945 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00006946 doesn't mean XIM is really active, especially when 'imactivatekey' is
6947 not set.
6948 NOTE: This option is set to the Vi default value when 'compatible' is
6949 set and to the Vim default value when 'compatible' is reset.
6950
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006951 *'showtabline'* *'stal'*
6952'showtabline' 'stal' number (default 1)
6953 global
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006954 The value of this option specifies when the line with tab page labels
6955 will be displayed:
6956 0: never
6957 1: only if there are at least two tab pages
6958 2: always
6959 This is both for the GUI and non-GUI implementation of the tab pages
6960 line.
6961 See |tab-page| for more information about tab pages.
6962
Bram Moolenaar071d4272004-06-13 20:20:40 +00006963 *'sidescroll'* *'ss'*
6964'sidescroll' 'ss' number (default 0)
6965 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006966 The minimal number of columns to scroll horizontally. Used only when
6967 the 'wrap' option is off and the cursor is moved off of the screen.
6968 When it is zero the cursor will be put in the middle of the screen.
6969 When using a slow terminal set it to a large number or 0. When using
6970 a fast terminal use a small number or 1. Not used for "zh" and "zl"
6971 commands.
6972
6973 *'sidescrolloff'* *'siso'*
6974'sidescrolloff' 'siso' number (default 0)
Bram Moolenaar375e3392019-01-31 18:26:10 +01006975 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006976 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00006977 right of the cursor if 'nowrap' is set. Setting this option to a
6978 value greater than 0 while having |'sidescroll'| also at a non-zero
6979 value makes some context visible in the line you are scrolling in
6980 horizontally (except at beginning of the line). Setting this option
6981 to a large value (like 999) has the effect of keeping the cursor
6982 horizontally centered in the window, as long as one does not come too
6983 close to the beginning of the line.
Bram Moolenaar375e3392019-01-31 18:26:10 +01006984 After using the local value, go back the global value with one of
6985 these two: >
6986 setlocal sidescrolloff<
6987 setlocal sidescrolloff=-1
6988< NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006989
6990 Example: Try this together with 'sidescroll' and 'listchars' as
6991 in the following example to never allow the cursor to move
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02006992 onto the "extends" character: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006993
6994 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
6995 :set sidescrolloff=1
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02006996<
6997 *'signcolumn'* *'scl'*
6998'signcolumn' 'scl' string (default "auto")
6999 local to window
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007000 {not available when compiled without the |+signs|
7001 feature}
Bram Moolenaar09521312016-08-12 22:54:35 +02007002 Whether or not to draw the signcolumn. Valid values are:
7003 "auto" only when there is a sign to display
7004 "no" never
7005 "yes" always
Bram Moolenaar394c5d82019-06-17 21:48:05 +02007006 "number" display signs in the 'number' column. If the number
Bram Moolenaar6c1e1572019-06-22 02:13:00 +02007007 column is not present, then behaves like "auto".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007008
7009
7010 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
7011'smartcase' 'scs' boolean (default off)
7012 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007013 Override the 'ignorecase' option if the search pattern contains upper
7014 case characters. Only used when the search pattern is typed and
7015 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarc8734422012-06-01 22:38:45 +02007016 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00007017 "*" and "#" you can make 'smartcase' used by doing a "/" command,
7018 recalling the search pattern from history and hitting <Enter>.
7019 NOTE: This option is reset when 'compatible' is set.
7020
7021 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
7022'smartindent' 'si' boolean (default off)
7023 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007024 {not available when compiled without the
7025 |+smartindent| feature}
7026 Do smart autoindenting when starting a new line. Works for C-like
7027 programs, but can also be used for other languages. 'cindent' does
7028 something like this, works better in most cases, but is more strict,
Bram Moolenaar81af9252010-12-10 20:35:50 +01007029 see |C-indenting|. When 'cindent' is on or 'indentexpr' is set,
Bram Moolenaar166af9b2010-11-16 20:34:40 +01007030 setting 'si' has no effect. 'indentexpr' is a more advanced
7031 alternative.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007032 Normally 'autoindent' should also be on when using 'smartindent'.
7033 An indent is automatically inserted:
7034 - After a line ending in '{'.
7035 - After a line starting with a keyword from 'cinwords'.
7036 - Before a line starting with '}' (only with the "O" command).
7037 When typing '}' as the first character in a new line, that line is
7038 given the same indent as the matching '{'.
7039 When typing '#' as the first character in a new line, the indent for
7040 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007041 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00007042 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
7043 When using the ">>" command, lines starting with '#' are not shifted
7044 right.
Bram Moolenaar036986f2017-03-16 17:41:02 +01007045 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02007046 This option is reset when 'paste' is set and restored when 'paste' is
7047 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007048
7049 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
7050'smarttab' 'sta' boolean (default off)
7051 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007052 When on, a <Tab> in front of a line inserts blanks according to
Bram Moolenaar280f1262006-01-30 00:14:18 +00007053 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A
7054 <BS> will delete a 'shiftwidth' worth of space at the start of the
7055 line.
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00007056 When off, a <Tab> always inserts blanks according to 'tabstop' or
Bram Moolenaar280f1262006-01-30 00:14:18 +00007057 'softtabstop'. 'shiftwidth' is only used for shifting text left or
7058 right |shift-left-right|.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007059 What gets inserted (a <Tab> or spaces) depends on the 'expandtab'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007060 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00007061 number of spaces is minimized by using <Tab>s.
Bram Moolenaarca635012015-09-25 20:34:21 +02007062 This option is reset when 'paste' is set and restored when 'paste' is
7063 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007064 NOTE: This option is reset when 'compatible' is set.
7065
7066 *'softtabstop'* *'sts'*
7067'softtabstop' 'sts' number (default 0)
7068 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007069 Number of spaces that a <Tab> counts for while performing editing
7070 operations, like inserting a <Tab> or using <BS>. It "feels" like
7071 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
7072 used. This is useful to keep the 'ts' setting at its standard value
7073 of 8, while being able to edit like it is set to 'sts'. However,
7074 commands like "x" still work on the actual characters.
7075 When 'sts' is zero, this feature is off.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02007076 When 'sts' is negative, the value of 'shiftwidth' is used.
Bram Moolenaarca635012015-09-25 20:34:21 +02007077 'softtabstop' is set to 0 when the 'paste' option is set and restored
7078 when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007079 See also |ins-expandtab|. When 'expandtab' is not set, the number of
7080 spaces is minimized by using <Tab>s.
7081 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
7082 set.
7083 NOTE: This option is set to 0 when 'compatible' is set.
7084
Bram Moolenaar04958cb2018-06-23 19:23:02 +02007085 If Vim is compiled with the |+vartabs| feature then the value of
7086 'softtabstop' will be ignored if |'varsofttabstop'| is set to
7087 anything other than an empty string.
7088
Bram Moolenaar217ad922005-03-20 22:37:15 +00007089 *'spell'* *'nospell'*
7090'spell' boolean (default off)
7091 local to window
Bram Moolenaar217ad922005-03-20 22:37:15 +00007092 {not available when compiled without the |+syntax|
7093 feature}
7094 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007095 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007096
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007097 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00007098'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007099 local to buffer
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007100 {not available when compiled without the |+syntax|
7101 feature}
7102 Pattern to locate the end of a sentence. The following word will be
7103 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007104 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007105 When this check is not wanted make this option empty.
7106 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00007107 Be careful with special characters, see |option-backslash| about
7108 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007109 To set this option automatically depending on the language, see
7110 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007111
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007112 *'spellfile'* *'spf'*
7113'spellfile' 'spf' string (default empty)
7114 local to buffer
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007115 {not available when compiled without the |+syntax|
7116 feature}
7117 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00007118 commands. It must end in ".{encoding}.add". You need to include the
7119 path, otherwise the file is placed in the current directory.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007120 *E765*
7121 It may also be a comma separated list of names. A count before the
7122 |zg| and |zw| commands can be used to access each. This allows using
7123 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007124 When a word is added while this option is empty Vim will set it for
Bram Moolenaar910f66f2006-04-05 20:41:53 +00007125 you: Using the first directory in 'runtimepath' that is writable. If
7126 there is no "spell" directory yet it will be created. For the file
7127 name the first language name that appears in 'spelllang' is used,
Bram Moolenaar3b506942005-06-23 22:36:45 +00007128 ignoring the region.
7129 The resulting ".spl" file will be used for spell checking, it does not
7130 have to appear in 'spelllang'.
7131 Normally one file is used for all regions, but you can add the region
7132 name if you want to. However, it will then only be used when
7133 'spellfile' is set to it, for entries in 'spelllang' only files
7134 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00007135 This option cannot be set from a |modeline| or in the |sandbox|, for
7136 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007137
Bram Moolenaar217ad922005-03-20 22:37:15 +00007138 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007139'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00007140 local to buffer
Bram Moolenaar217ad922005-03-20 22:37:15 +00007141 {not available when compiled without the |+syntax|
7142 feature}
Bram Moolenaar3b506942005-06-23 22:36:45 +00007143 A comma separated list of word list names. When the 'spell' option is
7144 on spellchecking will be done for these languages. Example: >
7145 set spelllang=en_us,nl,medical
7146< This means US English, Dutch and medical words are recognized. Words
7147 that are not recognized will be highlighted.
Bram Moolenaar911ead12019-04-21 00:03:35 +02007148 The word list name must consist of alphanumeric characters, a dash or
7149 an underscore. It should not include a comma or dot. Using a dash is
Bram Moolenaar3b506942005-06-23 22:36:45 +00007150 recommended to separate the two letter language name from a
7151 specification. Thus "en-rare" is used for rare English words.
7152 A region name must come last and have the form "_xx", where "xx" is
7153 the two-letter, lower case region name. You can use more than one
7154 region by listing them: "en_us,en_ca" supports both US and Canadian
7155 English, but not words specific for Australia, New Zealand or Great
Bram Moolenaarfa735342016-01-03 22:14:44 +01007156 Britain. (Note: currently en_au and en_nz dictionaries are older than
7157 en_ca, en_gb and en_us).
Bram Moolenaarcc63c642013-11-12 04:44:01 +01007158 If the name "cjk" is included East Asian characters are excluded from
7159 spell checking. This is useful when editing text that also has Asian
7160 words.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007161 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007162 As a special case the name of a .spl file can be given as-is. The
7163 first "_xx" in the name is removed and used as the region name
7164 (_xx is an underscore, two letters and followed by a non-letter).
7165 This is mainly for testing purposes. You must make sure the correct
7166 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007167 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007168 idea to set 'spelllang' after setting 'encoding' to avoid loading the
7169 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00007170 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007171
Bram Moolenaar98692072006-02-04 00:57:42 +00007172 If the |spellfile.vim| plugin is active and you use a language name
7173 for which Vim cannot find the .spl file in 'runtimepath' the plugin
7174 will ask you if you want to download the file.
7175
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007176 After this option has been set successfully, Vim will source the files
7177 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
Bram Moolenaarb730f0c2018-11-25 03:56:26 +01007178 up to the first character that is not an ASCII letter or number and
7179 not a dash. Also see |set-spc-auto|.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007180
Bram Moolenaar362b44b2020-06-10 21:47:00 +02007181 *'spelloptions'* *'spo'*
7182'spelloptions' 'spo' string (default "")
7183 local to buffer
7184 {not available when compiled without the |+syntax|
7185 feature}
7186 A comma separated list of options for spell checking:
7187 camel When a word is CamelCased, assume "Cased" is a
7188 separate word: every upper-case character in a word
7189 that comes after a lower case character indicates the
7190 start of a new word.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007191
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007192 *'spellsuggest'* *'sps'*
7193'spellsuggest' 'sps' string (default "best")
7194 global
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007195 {not available when compiled without the |+syntax|
7196 feature}
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007197 Methods used for spelling suggestions. Both for the |z=| command and
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007198 the |spellsuggest()| function. This is a comma-separated list of
7199 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007200
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007201 best Internal method that works best for English. Finds
7202 changes like "fast" and uses a bit of sound-a-like
7203 scoring to improve the ordering.
7204
7205 double Internal method that uses two methods and mixes the
7206 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007207 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007208 word. That only works when the language specifies
7209 sound folding. Can be slow and doesn't always give
7210 better results.
7211
7212 fast Internal method that only checks for simple changes:
7213 character inserts/deletes/swaps. Works well for
7214 simple typing mistakes.
7215
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007216 {number} The maximum number of suggestions listed for |z=|.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007217 Not used for |spellsuggest()|. The number of
7218 suggestions is never more than the value of 'lines'
7219 minus two.
7220
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007221 file:{filename} Read file {filename}, which must have two columns,
7222 separated by a slash. The first column contains the
7223 bad word, the second column the suggested good word.
7224 Example:
7225 theribal/terrible ~
7226 Use this for common mistakes that do not appear at the
7227 top of the suggestion list with the internal methods.
7228 Lines without a slash are ignored, use this for
7229 comments.
Bram Moolenaarbcb98982014-05-01 14:08:19 +02007230 The word in the second column must be correct,
7231 otherwise it will not be used. Add the word to an
7232 ".add" file if it is currently flagged as a spelling
7233 mistake.
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007234 The file is used for all languages.
7235
7236 expr:{expr} Evaluate expression {expr}. Use a function to avoid
7237 trouble with spaces. |v:val| holds the badly spelled
7238 word. The expression must evaluate to a List of
7239 Lists, each with a suggestion and a score.
7240 Example:
Bram Moolenaar214641f2017-03-05 17:04:09 +01007241 [['the', 33], ['that', 44]] ~
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007242 Set 'verbose' and use |z=| to see the scores that the
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007243 internal methods use. A lower score is better.
7244 This may invoke |spellsuggest()| if you temporarily
7245 set 'spellsuggest' to exclude the "expr:" part.
7246 Errors are silently ignored, unless you set the
7247 'verbose' option to a non-zero value.
7248
7249 Only one of "best", "double" or "fast" may be used. The others may
7250 appear several times in any order. Example: >
7251 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
7252<
7253 This option cannot be set from a |modeline| or in the |sandbox|, for
7254 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007255
7256
Bram Moolenaar071d4272004-06-13 20:20:40 +00007257 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
7258'splitbelow' 'sb' boolean (default off)
7259 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007260 When on, splitting a window will put the new window below the current
7261 one. |:split|
7262
7263 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
7264'splitright' 'spr' boolean (default off)
7265 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007266 When on, splitting a window will put the new window right of the
7267 current one. |:vsplit|
7268
7269 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
7270'startofline' 'sol' boolean (default on)
7271 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007272 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00007273 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007274 (if possible). This applies to the commands: CTRL-D, CTRL-U, CTRL-B,
Bram Moolenaar843ee412004-06-30 16:16:41 +00007275 CTRL-F, "G", "H", "M", "L", gg, and to the commands "d", "<<" and ">>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007276 with a linewise operator, with "%" with a count and to buffer changing
7277 commands (CTRL-^, :bnext, :bNext, etc.). Also for an Ex command that
7278 only has a line number, e.g., ":25" or ":+".
7279 In case of buffer changing commands the cursor is placed at the column
7280 where it was the last time the buffer was edited.
7281 NOTE: This option is set when 'compatible' is set.
7282
Bram Moolenaar00654022011-02-25 14:42:19 +01007283 *'statusline'* *'stl'* *E540* *E542*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007284'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007285 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007286 {not available when compiled without the |+statusline|
7287 feature}
7288 When nonempty, this option determines the content of the status line.
7289 Also see |status-line|.
7290
7291 The option consists of printf style '%' items interspersed with
7292 normal text. Each status line item is of the form:
7293 %-0{minwid}.{maxwid}{item}
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01007294 All fields except the {item} are optional. A single percent sign can
Bram Moolenaar8133cc62020-10-26 21:05:27 +01007295 be given as "%%".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007296
Bram Moolenaar238a5642006-02-21 22:12:05 +00007297 When the option starts with "%!" then it is used as an expression,
7298 evaluated and the result is used as the option value. Example: >
7299 :set statusline=%!MyStatusLine()
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02007300< The *g:statusline_winid* variable will be set to the |window-ID| of the
7301 window that the status line belongs to.
7302 The result can contain %{} items that will be evaluated too.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02007303 Note that the "%!" expression is evaluated in the context of the
7304 current window and buffer, while %{} items are evaluated in the
7305 context of the window that the statusline belongs to.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007306
7307 When there is error while evaluating the option then it will be made
7308 empty to avoid further errors. Otherwise screen updating would loop.
7309
Bram Moolenaar071d4272004-06-13 20:20:40 +00007310 Note that the only effect of 'ruler' when this option is set (and
7311 'laststatus' is 2) is controlling the output of |CTRL-G|.
7312
7313 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00007314 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00007315 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007316 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007317 minwid Minimum width of the item, padding as set by '-' & '0'.
7318 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007319 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007320 on the left for text items. Numeric items will be
7321 shifted down to maxwid-2 digits followed by '>'number
7322 where number is the amount of missing digits, much like
7323 an exponential notation.
7324 item A one letter code as described below.
7325
7326 Following is a description of the possible statusline items. The
7327 second character in "item" is the type:
7328 N for number
7329 S for string
7330 F for flags as described below
7331 - not applicable
7332
7333 item meaning ~
Bram Moolenaar02467872007-05-06 13:22:01 +00007334 f S Path to the file in the buffer, as typed or relative to current
7335 directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007336 F S Full path to the file in the buffer.
7337 t S File name (tail) of file in the buffer.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007338 m F Modified flag, text is "[+]"; "[-]" if 'modifiable' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007339 M F Modified flag, text is ",+" or ",-".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007340 r F Readonly flag, text is "[RO]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007341 R F Readonly flag, text is ",RO".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007342 h F Help buffer flag, text is "[help]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007343 H F Help buffer flag, text is ",HLP".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007344 w F Preview window flag, text is "[Preview]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007345 W F Preview window flag, text is ",PRV".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007346 y F Type of file in the buffer, e.g., "[vim]". See 'filetype'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007347 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
Bram Moolenaar7fd73202010-07-25 16:58:46 +02007348 q S "[Quickfix List]", "[Location List]" or empty.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007349 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
7350 being used: "<keymap>"
7351 n N Buffer number.
Bram Moolenaar00654022011-02-25 14:42:19 +01007352 b N Value of character under cursor.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007353 B N As above, in hexadecimal.
7354 o N Byte number in file of byte under cursor, first byte is 1.
7355 Mnemonic: Offset from start of file (with one added)
7356 {not available when compiled without |+byte_offset| feature}
7357 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007358 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007359 l N Line number.
7360 L N Number of lines in buffer.
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02007361 c N Column number (byte index).
7362 v N Virtual column number (screen column).
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007363 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007364 p N Percentage through file in lines as in |CTRL-G|.
7365 P S Percentage through file of displayed window. This is like the
Bram Moolenaar14b69452013-06-29 23:05:20 +02007366 percentage described for 'ruler'. Always 3 in length, unless
7367 translated.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007368 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00007369 Empty if the argument file count is zero or one.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007370 { NF Evaluate expression between '%{' and '}' and substitute result.
Bram Moolenaar6d150f72018-04-21 20:03:20 +02007371 Note that there is no '%' before the closing '}'. The
7372 expression cannot contain a '}' character, call a function to
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007373 work around that. See |stl-%{| below.
shadmansaleh30e3de22021-05-15 17:23:28 +02007374 {% - This is almost same as { except the result of the expression is
7375 re-evaluated as a statusline format string. Thus if the
7376 return value of expr contains % items they will get expanded.
7377 The expression can contain the } character, the end of
7378 expression is denoted by %}.
7379 The For example: >
7380 func! Stl_filename() abort
7381 return "%t"
7382 endfunc
7383< `stl=%{Stl_filename()}` results in `"%t"`
7384 `stl=%{%Stl_filename()%}` results in `"Name of current file"`
7385 } - End of `{%` expression
Bram Moolenaar071d4272004-06-13 20:20:40 +00007386 ( - Start of item group. Can be used for setting the width and
7387 alignment of a section. Must be followed by %) somewhere.
7388 ) - End of item group. No width fields allowed.
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007389 T N For 'tabline': start of tab page N label. Use %T after the last
7390 label. This information is used for mouse clicks.
7391 X N For 'tabline': start of close tab N label. Use %X after the
7392 label, e.g.: %3Xclose%X. Use %999X for a "close current tab"
7393 mark. This information is used for mouse clicks.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007394 < - Where to truncate line if too long. Default is at the start.
7395 No width fields allowed.
7396 = - Separation point between left and right aligned items.
7397 No width fields allowed.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007398 # - Set highlight group. The name must follow and then a # again.
7399 Thus use %#HLname# for highlight group HLname. The same
7400 highlighting is used, also for the statusline of non-current
7401 windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007402 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00007403 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007404 The difference between User{N} and StatusLine will be applied
7405 to StatusLineNC for the statusline of non-current windows.
7406 The number N must be between 1 and 9. See |hl-User1..9|
7407
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007408 When displaying a flag, Vim removes the leading comma, if any, when
7409 that flag comes right after plaintext. This will make a nice display
7410 when flags are used like in the examples below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007411
Bram Moolenaar582fd852005-03-28 20:58:01 +00007412 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00007413 not set) and a minwid is not set for the group, the whole group will
7414 become empty. This will make a group like the following disappear
7415 completely from the statusline when none of the flags are set. >
7416 :set statusline=...%(\ [%M%R%H]%)...
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02007417< Beware that an expression is evaluated each and every time the status
7418 line is displayed.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007419 *stl-%{* *g:actual_curbuf* *g:actual_curwin*
Bram Moolenaarade0d392020-01-21 22:33:58 +01007420 While evaluating %{} the current buffer and current window will be set
7421 temporarily to that of the window (and buffer) whose statusline is
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007422 currently being drawn. The expression will evaluate in this context.
7423 The variable "g:actual_curbuf" is set to the `bufnr()` number of the
7424 real current buffer and "g:actual_curwin" to the |window-ID| of the
7425 real current window. These values are strings.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007426
Bram Moolenaar30b65812012-07-12 22:01:11 +02007427 The 'statusline' option will be evaluated in the |sandbox| if set from
7428 a modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02007429 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007430
7431 It is not allowed to change text or jump to another window while
7432 evaluating 'statusline' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007433
7434 If the statusline is not updated when you want it (e.g., after setting
7435 a variable that's used in an expression), you can force an update by
7436 setting an option without changing its value. Example: >
7437 :let &ro = &ro
7438
7439< A result of all digits is regarded a number for display purposes.
7440 Otherwise the result is taken as flag text and applied to the rules
7441 described above.
7442
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00007443 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00007444 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
Bram Moolenaarc4da1132017-07-15 19:39:43 +02007445 edit your .vimrc or whatever with "vim --clean" to get it right.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007446
7447 Examples:
7448 Emulate standard status line with 'ruler' set >
7449 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
7450< Similar, but add ASCII value of char under the cursor (like "ga") >
7451 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
7452< Display byte count and byte value, modified flag in red. >
7453 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
7454 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
7455< Display a ,GZ flag if a compressed file is loaded >
7456 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
7457< In the |:autocmd|'s: >
7458 :let b:gzflag = 1
7459< And: >
7460 :unlet b:gzflag
7461< And define this function: >
7462 :function VarExists(var, val)
7463 : if exists(a:var) | return a:val | else | return '' | endif
7464 :endfunction
7465<
7466 *'suffixes'* *'su'*
7467'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
7468 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007469 Files with these suffixes get a lower priority when multiple files
7470 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007471 suffixes. Spaces after the comma are ignored. A dot is also seen as
7472 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007473 separator, precede it with a backslash (see |option-backslash| about
7474 including spaces and backslashes).
7475 See 'wildignore' for completely ignoring files.
7476 The use of |:set+=| and |:set-=| is preferred when adding or removing
7477 suffixes from the list. This avoids problems when a future version
7478 uses another default.
7479
7480 *'suffixesadd'* *'sua'*
7481'suffixesadd' 'sua' string (default "")
7482 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007483 {not available when compiled without the
7484 |+file_in_path| feature}
7485 Comma separated list of suffixes, which are used when searching for a
7486 file for the "gf", "[I", etc. commands. Example: >
7487 :set suffixesadd=.java
7488<
7489 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
7490'swapfile' 'swf' boolean (default on)
7491 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007492 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007493 swapfile is not wanted for a specific buffer. For example, with
7494 confidential information that even root must not be able to access.
7495 Careful: All text will be in memory:
7496 - Don't use this for big files.
7497 - Recovery will be impossible!
7498 A swapfile will only be present when |'updatecount'| is non-zero and
7499 'swapfile' is set.
7500 When 'swapfile' is reset, the swap file for the current buffer is
7501 immediately deleted. When 'swapfile' is set, and 'updatecount' is
7502 non-zero, a swap file is immediately created.
7503 Also see |swap-file| and |'swapsync'|.
Bram Moolenaar76f3b1a2014-03-27 22:30:07 +01007504 If you want to open a new buffer without creating a swap file for it,
7505 use the |:noswapfile| modifier.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01007506 See 'directory' for where the swap file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007507
7508 This option is used together with 'bufhidden' and 'buftype' to
7509 specify special kinds of buffers. See |special-buffers|.
7510
7511 *'swapsync'* *'sws'*
7512'swapsync' 'sws' string (default "fsync")
7513 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007514 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007515 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007516 When this option is empty parts of the swap file may be in memory and
7517 not written to disk. When the system crashes you may lose more work.
7518 On Unix the system does a sync now and then without Vim asking for it,
7519 so the disadvantage of setting this option off is small. On some
7520 systems the swap file will not be written at all. For a unix system
7521 setting it to "sync" will use the sync() call instead of the default
7522 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007523 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007524
7525 *'switchbuf'* *'swb'*
7526'switchbuf' 'swb' string (default "")
7527 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007528 This option controls the behavior when switching between buffers.
Bram Moolenaard2ea7cf2021-05-30 20:54:13 +02007529 Mostly for |quickfix| commands some values are also used for other
7530 commands, as mentioned below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007531 Possible values (comma separated list):
7532 useopen If included, jump to the first open window that
7533 contains the specified buffer (if there is one).
7534 Otherwise: Do not examine other windows.
7535 This setting is checked with |quickfix| commands, when
7536 jumping to errors (":cc", ":cn", "cp", etc.). It is
7537 also used in all buffer related split commands, for
7538 example ":sbuffer", ":sbnext", or ":sbrewind".
Bram Moolenaar779b74b2006-04-10 14:55:34 +00007539 usetab Like "useopen", but also consider windows in other tab
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00007540 pages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007541 split If included, split the current window before loading
Bram Moolenaar15146672011-10-20 22:22:38 +02007542 a buffer for a |quickfix| command that display errors.
Bram Moolenaar63b74a82019-03-24 15:09:13 +01007543 Otherwise: do not split, use current window (when used
7544 in the quickfix window: the previously used window or
7545 split if there is no other window).
Bram Moolenaara594d772015-06-19 14:41:49 +02007546 vsplit Just like "split" but split vertically.
Bram Moolenaar446cb832008-06-24 21:56:24 +00007547 newtab Like "split", but open a new tab page. Overrules
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02007548 "split" when both are present.
Bram Moolenaar539aa6b2019-11-17 18:09:38 +01007549 uselast If included, jump to the previously used window when
7550 jumping to errors with |quickfix| commands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007551
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007552 *'synmaxcol'* *'smc'*
7553'synmaxcol' 'smc' number (default 3000)
7554 local to buffer
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007555 {not available when compiled without the |+syntax|
7556 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007557 Maximum column in which to search for syntax items. In long lines the
7558 text after this column is not highlighted and following lines may not
7559 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007560 This helps to avoid very slow redrawing for an XML file that is one
7561 long line.
7562 Set to zero to remove the limit.
7563
Bram Moolenaar071d4272004-06-13 20:20:40 +00007564 *'syntax'* *'syn'*
7565'syntax' 'syn' string (default empty)
7566 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007567 {not available when compiled without the |+syntax|
7568 feature}
7569 When this option is set, the syntax with this name is loaded, unless
7570 syntax highlighting has been switched off with ":syntax off".
7571 Otherwise this option does not always reflect the current syntax (the
7572 b:current_syntax variable does).
7573 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007574 not automatically recognized. Example, in an IDL file:
7575 /* vim: set syntax=idl : */ ~
7576 When a dot appears in the value then this separates two filetype
7577 names. Example:
7578 /* vim: set syntax=c.doxygen : */ ~
7579 This will use the "c" syntax first, then the "doxygen" syntax.
7580 Note that the second one must be prepared to be loaded as an addition,
7581 otherwise it will be skipped. More than one dot may appear.
7582 To switch off syntax highlighting for the current file, use: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007583 :set syntax=OFF
7584< To switch syntax highlighting on according to the current value of the
7585 'filetype' option: >
7586 :set syntax=ON
7587< What actually happens when setting the 'syntax' option is that the
7588 Syntax autocommand event is triggered with the value as argument.
7589 This option is not copied to another buffer, independent of the 's' or
7590 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007591 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007592
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007593 *'tabline'* *'tal'*
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007594'tabline' 'tal' string (default empty)
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007595 global
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007596 When nonempty, this option determines the content of the tab pages
7597 line at the top of the Vim window. When empty Vim will use a default
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007598 tab pages line. See |setting-tabline| for more info.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007599
7600 The tab pages line only appears as specified with the 'showtabline'
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00007601 option and only when there is no GUI tab line. When 'e' is in
7602 'guioptions' and the GUI supports a tab line 'guitablabel' is used
Bram Moolenaar7f036442010-08-15 15:24:20 +02007603 instead. Note that the two tab pages lines are very different.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007604
7605 The value is evaluated like with 'statusline'. You can use
7606 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007607 the text to be displayed. Use "%1T" for the first label, "%2T" for
7608 the second one, etc. Use "%X" items for closing labels.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007609
Bram Moolenaare12bab32019-01-08 22:02:56 +01007610 When changing something that is used in 'tabline' that does not
7611 trigger it to be updated, use |:redrawtabline|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02007612 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaare12bab32019-01-08 22:02:56 +01007613
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007614 Keep in mind that only one of the tab pages is the current one, others
7615 are invisible and you can't jump to their windows.
7616
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007617
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007618 *'tabpagemax'* *'tpm'*
7619'tabpagemax' 'tpm' number (default 10)
7620 global
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007621 Maximum number of tab pages to be opened by the |-p| command line
7622 argument or the ":tab all" command. |tabpage|
7623
7624
7625 *'tabstop'* *'ts'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007626'tabstop' 'ts' number (default 8)
7627 local to buffer
7628 Number of spaces that a <Tab> in the file counts for. Also see
7629 |:retab| command, and 'softtabstop' option.
7630
7631 Note: Setting 'tabstop' to any other value than 8 can make your file
7632 appear wrong in many places (e.g., when printing it).
7633
7634 There are four main ways to use tabs in Vim:
7635 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
7636 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007637 will use a mix of tabs and spaces, but typing <Tab> and <BS> will
Bram Moolenaar071d4272004-06-13 20:20:40 +00007638 behave like a tab appears every 4 (or 3) characters.
7639 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
7640 'expandtab'. This way you will always insert spaces. The
7641 formatting will never be messed up when 'tabstop' is changed.
7642 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007643 |modeline| to set these values when editing the file again. Only
Bram Moolenaar071d4272004-06-13 20:20:40 +00007644 works when using Vim to edit the file.
7645 4. Always set 'tabstop' and 'shiftwidth' to the same value, and
7646 'noexpandtab'. This should then work (for initial indents only)
7647 for any tabstop setting that people use. It might be nice to have
7648 tabs after the first non-blank inserted as spaces if you do this
7649 though. Otherwise aligned comments will be wrong when 'tabstop' is
7650 changed.
7651
Bram Moolenaar04958cb2018-06-23 19:23:02 +02007652 If Vim is compiled with the |+vartabs| feature then the value of
7653 'tabstop' will be ignored if |'vartabstop'| is set to anything other
7654 than an empty string.
7655
Bram Moolenaar071d4272004-06-13 20:20:40 +00007656 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
7657'tagbsearch' 'tbs' boolean (default on)
7658 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007659 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007660 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00007661 searching makes searching for a tag a LOT faster, but a linear search
7662 will find more tags if the tags file wasn't properly sorted.
7663 Vim normally assumes that your tags files are sorted, or indicate that
7664 they are not sorted. Only when this is not the case does the
7665 'tagbsearch' option need to be switched off.
7666
7667 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007668 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00007669 certain files, or retry all files with a linear search. When
7670 'tagbsearch' is off, only a linear search is done.
7671
7672 Linear searching is done anyway, for one file, when Vim finds a line
7673 at the start of the file indicating that it's not sorted: >
Bram Moolenaar446cb832008-06-24 21:56:24 +00007674 !_TAG_FILE_SORTED 0 /some comment/
Bram Moolenaar071d4272004-06-13 20:20:40 +00007675< [The whitespace before and after the '0' must be a single <Tab>]
7676
7677 When a binary search was done and no match was found in any of the
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007678 files listed in 'tags', and case is ignored or a pattern is used
Bram Moolenaar071d4272004-06-13 20:20:40 +00007679 instead of a normal tag name, a retry is done with a linear search.
7680 Tags in unsorted tags files, and matches with different case will only
7681 be found in the retry.
7682
Bram Moolenaard4755bb2004-09-02 19:12:26 +00007683 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007684 linear search can be avoided when case is ignored. Use a value of '2'
7685 in the "!_TAG_FILE_SORTED" line for this. A tag file can be case-fold
7686 sorted with the -f switch to "sort" in most unices, as in the command:
7687 "sort -f -o tags tags". For "Exuberant ctags" version 5.x or higher
7688 (at least 5.5) the --sort=foldcase switch can be used for this as
7689 well. Note that case must be folded to uppercase for this to work.
7690
7691 By default, tag searches are case-sensitive. Case is ignored when
7692 'ignorecase' is set and 'tagcase' is "followic", or when 'tagcase' is
7693 "ignore".
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007694 Also when 'tagcase' is "followscs" and 'smartcase' is set, or
7695 'tagcase' is "smart", and the pattern contains only lowercase
7696 characters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007697
7698 When 'tagbsearch' is off, tags searching is slower when a full match
7699 exists, but faster when no full match exists. Tags in unsorted tags
7700 files may only be found with 'tagbsearch' off.
7701 When the tags file is not sorted, or sorted in a wrong way (not on
7702 ASCII byte value), 'tagbsearch' should be off, or the line given above
7703 must be included in the tags file.
7704 This option doesn't affect commands that find all matching tags (e.g.,
7705 command-line completion and ":help").
Bram Moolenaar071d4272004-06-13 20:20:40 +00007706
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007707 *'tagcase'* *'tc'*
7708'tagcase' 'tc' string (default "followic")
7709 global or local to buffer |global-local|
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007710 This option specifies how case is handled when searching the tags
7711 file:
7712 followic Follow the 'ignorecase' option
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007713 followscs Follow the 'smartcase' and 'ignorecase' options
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007714 ignore Ignore case
7715 match Match case
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007716 smart Ignore case unless an upper case letter is used
Bram Moolenaar036986f2017-03-16 17:41:02 +01007717 NOTE: This option is set to the Vi default value when 'compatible' is
7718 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007719
Bram Moolenaar45e18cb2019-04-28 18:05:35 +02007720 *'tagfunc'* *'tfu'*
7721'tagfunc' 'tfu' string (default: empty)
7722 local to buffer
7723 {not available when compiled without the |+eval|
7724 feature}
7725 This option specifies a function to be used to perform tag searches.
7726 The function gets the tag pattern and should return a List of matching
7727 tags. See |tag-function| for an explanation of how to write the
7728 function and an example.
7729
Bram Moolenaar071d4272004-06-13 20:20:40 +00007730 *'taglength'* *'tl'*
7731'taglength' 'tl' number (default 0)
7732 global
7733 If non-zero, tags are significant up to this number of characters.
7734
7735 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
7736'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
7737 global
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00007738 If on and using a tags file in another directory, file names in that
7739 tags file are relative to the directory where the tags file is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007740 NOTE: This option is set to the Vi default value when 'compatible' is
7741 set and to the Vim default value when 'compatible' is reset.
7742
7743 *'tags'* *'tag'* *E433*
7744'tags' 'tag' string (default "./tags,tags", when compiled with
7745 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
7746 global or local to buffer |global-local|
7747 Filenames for the tag command, separated by spaces or commas. To
7748 include a space or comma in a file name, precede it with a backslash
7749 (see |option-backslash| about including spaces and backslashes).
7750 When a file name starts with "./", the '.' is replaced with the path
7751 of the current file. But only when the 'd' flag is not included in
7752 'cpoptions'. Environment variables are expanded |:set_env|. Also see
7753 |tags-option|.
7754 "*", "**" and other wildcards can be used to search for tags files in
Bram Moolenaare2b590e2010-08-08 18:29:48 +02007755 a directory tree. See |file-searching|. E.g., "/lib/**/tags" will
7756 find all files named "tags" below "/lib". The filename itself cannot
7757 contain wildcards, it is used as-is. E.g., "/lib/**/tags?" will find
7758 files called "tags?". {not available when compiled without the
7759 |+path_extra| feature}
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00007760 The |tagfiles()| function can be used to get a list of the file names
7761 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007762 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
7763 files are also supported. They are automatically recognized. The
7764 default value becomes "./tags,./TAGS,tags,TAGS", unless case
7765 differences are ignored (MS-Windows). |emacs-tags|
7766 The use of |:set+=| and |:set-=| is preferred when adding or removing
7767 file names from the list. This avoids problems when a future version
7768 uses another default.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007769
7770 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
7771'tagstack' 'tgst' boolean (default on)
7772 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007773 When on, the |tagstack| is used normally. When off, a ":tag" or
7774 ":tselect" command with an argument will not push the tag onto the
7775 tagstack. A following ":tag" without an argument, a ":pop" command or
7776 any other command that uses the tagstack will use the unmodified
7777 tagstack, but does change the pointer to the active entry.
7778 Resetting this option is useful when using a ":tag" command in a
7779 mapping which should not change the tagstack.
7780
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007781 *'tcldll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01007782'tcldll' string (default depends on the build)
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007783 global
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007784 {only available when compiled with the |+tcl/dyn|
7785 feature}
7786 Specifies the name of the Tcl shared library. The default is
7787 DYNAMIC_TCL_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02007788 Environment variables are expanded |:set_env|.
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007789 This option cannot be set from a |modeline| or in the |sandbox|, for
7790 security reasons.
7791
Bram Moolenaar071d4272004-06-13 20:20:40 +00007792 *'term'* *E529* *E530* *E531*
7793'term' string (default is $TERM, if that fails:
7794 in the GUI: "builtin_gui"
7795 on Amiga: "amiga"
Bram Moolenaarb3f74062020-02-26 16:16:53 +01007796 on Haiku: "xterm"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007797 on Mac: "mac-ansi"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007798 on Unix: "ansi"
7799 on VMS: "ansi"
7800 on Win 32: "win32")
7801 global
7802 Name of the terminal. Used for choosing the terminal control
7803 characters. Environment variables are expanded |:set_env|.
7804 For example: >
7805 :set term=$TERM
7806< See |termcap|.
7807
7808 *'termbidi'* *'tbidi'*
7809 *'notermbidi'* *'notbidi'*
7810'termbidi' 'tbidi' boolean (default off, on for "mlterm")
7811 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007812 {only available when compiled with the |+arabic|
7813 feature}
7814 The terminal is in charge of Bi-directionality of text (as specified
7815 by Unicode). The terminal is also expected to do the required shaping
7816 that some languages (such as Arabic) require.
7817 Setting this option implies that 'rightleft' will not be set when
7818 'arabic' is set and the value of 'arabicshape' will be ignored.
7819 Note that setting 'termbidi' has the immediate effect that
7820 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
7821 This option is reset when the GUI is started.
7822 For further details see |arabic.txt|.
7823
7824 *'termencoding'* *'tenc'*
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02007825'termencoding' 'tenc' string (default ""; with GTK+ GUI: "utf-8")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007826 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007827 Encoding used for the terminal. This specifies what character
7828 encoding the keyboard produces and the display will understand. For
Bram Moolenaar3848e002016-03-19 18:42:29 +01007829 the GUI it only applies to the keyboard ('encoding' is used for the
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02007830 display).
Bram Moolenaar4b7cdca2020-01-01 16:18:38 +01007831 *E617* *E950*
Bram Moolenaar3df01732017-02-17 22:47:16 +01007832 Note: This does not apply to the GTK+ GUI. After the GUI has been
Bram Moolenaar071d4272004-06-13 20:20:40 +00007833 successfully initialized, 'termencoding' is forcibly set to "utf-8".
7834 Any attempts to set a different value will be rejected, and an error
7835 message is shown.
Bram Moolenaarac360bf2015-09-01 20:31:20 +02007836 For the Win32 GUI and console versions 'termencoding' is not used,
Bram Moolenaar071d4272004-06-13 20:20:40 +00007837 because the Win32 system always passes Unicode characters.
7838 When empty, the same encoding is used as for the 'encoding' option.
7839 This is the normal value.
7840 Not all combinations for 'termencoding' and 'encoding' are valid. See
7841 |encoding-table|.
7842 The value for this option must be supported by internal conversions or
7843 iconv(). When this is not possible no conversion will be done and you
7844 will probably experience problems with non-ASCII characters.
7845 Example: You are working with the locale set to euc-jp (Japanese) and
7846 want to edit a UTF-8 file: >
7847 :let &termencoding = &encoding
7848 :set encoding=utf-8
7849< You need to do this when your system has no locale support for UTF-8.
7850
Bram Moolenaarcafafb32018-02-22 21:07:09 +01007851 *'termguicolors'* *'tgc'* *E954*
Bram Moolenaar61be73b2016-04-29 22:59:22 +02007852'termguicolors' 'tgc' boolean (default off)
7853 global
Bram Moolenaar61be73b2016-04-29 22:59:22 +02007854 {not available when compiled without the
7855 |+termguicolors| feature}
7856 When on, uses |highlight-guifg| and |highlight-guibg| attributes in
Bram Moolenaarcafafb32018-02-22 21:07:09 +01007857 the terminal (thus using 24-bit color).
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01007858
Bram Moolenaarcafafb32018-02-22 21:07:09 +01007859 Requires a ISO-8613-3 compatible terminal. If setting this option
7860 does not work (produces a colorless UI) reading |xterm-true-color|
7861 might help.
7862
7863 For Win32 console, Windows 10 version 1703 (Creators Update) or later
7864 is required. Use this check to find out: >
7865 if has('vcon')
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01007866< This requires Vim to be built with the |+vtp| feature.
7867
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +02007868 Note that the "cterm" attributes are still used, not the "gui" ones.
Bram Moolenaar036986f2017-03-16 17:41:02 +01007869 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar61be73b2016-04-29 22:59:22 +02007870
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02007871 *'termwinkey'* *'twk'*
7872'termwinkey' 'twk' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02007873 local to window
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007874 The key that starts a CTRL-W command in a terminal window. Other keys
Bram Moolenaar74675a62017-07-15 13:53:23 +02007875 are sent to the job running in the window.
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007876 The <> notation can be used, e.g.: >
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02007877 :set termwinkey=<C-L>
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007878< The string must be one key stroke but can be multiple bytes.
7879 When not set CTRL-W is used, so that CTRL-W : gets you to the command
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02007880 line. If 'termwinkey' is set to CTRL-L then CTRL-L : gets you to the
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007881 command line.
Bram Moolenaar74675a62017-07-15 13:53:23 +02007882
Bram Moolenaar6c60f472019-04-28 16:00:35 +02007883 *'termwinscroll'* *'twsl'*
7884'termwinscroll' 'twsl' number (default 10000)
7885 local to buffer
7886 {not available when compiled without the
7887 |+terminal| feature}
7888 Number of scrollback lines to keep. When going over this limit the
7889 first 10% of the scrollback lines are deleted. This is just to reduce
7890 the memory usage. See |Terminal-Normal|.
7891
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02007892 *'termwinsize'* *'tws'*
7893'termwinsize' 'tws' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02007894 local to window
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02007895 Size used when opening the |terminal| window. Format:
7896 {rows}x{columns} or {rows}*{columns}.
Bram Moolenaar74675a62017-07-15 13:53:23 +02007897 - When empty the terminal gets the size from the window.
Bram Moolenaar498c2562018-04-15 23:45:15 +02007898 - When set with a "x" (e.g., "24x80") the terminal size is not
7899 adjusted to the window size. If the window is smaller only the
7900 top-left part is displayed.
7901 - When set with a "*" (e.g., "10*50") the terminal size follows the
7902 window size, but will not be smaller than the specified rows and/or
7903 columns.
7904 - When rows is zero then use the height of the window.
7905 - When columns is zero then use the width of the window.
7906 - Using "0x0" or "0*0" is the same as empty.
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02007907 - Can be overruled in the |term_start()| options with "term_rows" and
7908 "term_cols".
Bram Moolenaar498c2562018-04-15 23:45:15 +02007909
7910 Examples:
7911 "30x0" uses 30 rows and the current window width.
7912 "20*0" uses at least 20 rows and the current window width.
7913 "0*40" uses the current window height and at least 40 columns.
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02007914 Note that the command running in the terminal window may still change
7915 the size of the terminal. In that case the Vim window will be
7916 adjusted to that size, if possible.
Bram Moolenaar74675a62017-07-15 13:53:23 +02007917
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01007918 *'termwintype'* *'twt'*
7919'termwintype' 'twt' string (default "")
7920 global
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01007921 {only available when compiled with the |terminal|
7922 feature on MS-Windows}
7923 Specify the virtual console (pty) used when opening the terminal
7924 window.
7925
7926 Possible values are:
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01007927 "" use ConPTY if it is stable, winpty otherwise
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01007928 "winpty" use winpty, fail if not supported
7929 "conpty" use |ConPTY|, fail if not supported
7930
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01007931 |ConPTY| support depends on the platform. Windows 10 October 2018
7932 Update is the first version that supports ConPTY, however it is still
7933 considered unstable. ConPTY might become stable in the next release
7934 of Windows 10. winpty support needs to be installed. If neither is
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01007935 supported then you cannot open a terminal window.
7936
Bram Moolenaar071d4272004-06-13 20:20:40 +00007937 *'terse'* *'noterse'*
7938'terse' boolean (default off)
7939 global
7940 When set: Add 's' flag to 'shortmess' option (this makes the message
7941 for a search that hits the start or end of the file not being
7942 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
7943 shortens a lot of messages}
7944
7945 *'textauto'* *'ta'* *'notextauto'* *'nota'*
7946'textauto' 'ta' boolean (Vim default: on, Vi default: off)
7947 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007948 This option is obsolete. Use 'fileformats'.
7949 For backwards compatibility, when 'textauto' is set, 'fileformats' is
7950 set to the default value for the current system. When 'textauto' is
7951 reset, 'fileformats' is made empty.
7952 NOTE: This option is set to the Vi default value when 'compatible' is
7953 set and to the Vim default value when 'compatible' is reset.
7954
7955 *'textmode'* *'tx'* *'notextmode'* *'notx'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01007956'textmode' 'tx' boolean (Win32: default on,
Bram Moolenaar071d4272004-06-13 20:20:40 +00007957 others: default off)
7958 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007959 This option is obsolete. Use 'fileformat'.
7960 For backwards compatibility, when 'textmode' is set, 'fileformat' is
7961 set to "dos". When 'textmode' is reset, 'fileformat' is set to
7962 "unix".
7963
7964 *'textwidth'* *'tw'*
7965'textwidth' 'tw' number (default 0)
7966 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007967 Maximum width of text that is being inserted. A longer line will be
7968 broken after white space to get this width. A zero value disables
Bram Moolenaarca635012015-09-25 20:34:21 +02007969 this.
7970 'textwidth' is set to 0 when the 'paste' option is set and restored
7971 when 'paste' is reset.
7972 When 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00007973 'formatoptions' and |ins-textwidth|.
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00007974 When 'formatexpr' is set it will be used to break the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007975 NOTE: This option is set to 0 when 'compatible' is set.
7976
7977 *'thesaurus'* *'tsr'*
7978'thesaurus' 'tsr' string (default "")
7979 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007980 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01007981 for thesaurus completion commands |i_CTRL-X_CTRL-T|.
7982
7983 Each line in the file should contain words with similar meaning,
7984 separated by non-keyword characters (white space is preferred).
7985 Maximum line length is 510 bytes.
7986
Bram Moolenaard47d5222018-12-09 20:43:55 +01007987 An English word list was added to this github issue:
7988 https://github.com/vim/vim/issues/629#issuecomment-443293282
7989 Unpack thesaurus_pkg.zip, put the thesaurus.txt file somewhere, e.g.
7990 ~/.vim/thesaurus/english.txt, and the 'thesaurus' option to this file
7991 name.
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01007992
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007993 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00007994 after a comma are ignored, otherwise spaces are included in the file
7995 name. See |option-backslash| about using backslashes.
7996 The use of |:set+=| and |:set-=| is preferred when adding or removing
7997 directories from the list. This avoids problems when a future version
7998 uses another default.
7999 Backticks cannot be used in this option for security reasons.
8000
8001 *'tildeop'* *'top'* *'notildeop'* *'notop'*
8002'tildeop' 'top' boolean (default off)
8003 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008004 When on: The tilde command "~" behaves like an operator.
8005 NOTE: This option is reset when 'compatible' is set.
8006
8007 *'timeout'* *'to'* *'notimeout'* *'noto'*
8008'timeout' 'to' boolean (default on)
8009 global
8010 *'ttimeout'* *'nottimeout'*
Bram Moolenaar94237492017-04-23 18:40:21 +02008011'ttimeout' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008012 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008013 These two options together determine the behavior when part of a
8014 mapped key sequence or keyboard code has been received:
8015
8016 'timeout' 'ttimeout' action ~
8017 off off do not time out
8018 on on or off time out on :mappings and key codes
8019 off on time out on key codes
8020
8021 If both options are off, Vim will wait until either the complete
8022 mapping or key sequence has been received, or it is clear that there
8023 is no mapping or key sequence for the received characters. For
8024 example: if you have mapped "vl" and Vim has received 'v', the next
8025 character is needed to see if the 'v' is followed by an 'l'.
8026 When one of the options is on, Vim will wait for about 1 second for
8027 the next character to arrive. After that the already received
8028 characters are interpreted as single characters. The waiting time can
8029 be changed with the 'timeoutlen' option.
8030 On slow terminals or very busy systems timing out may cause
8031 malfunctioning cursor keys. If both options are off, Vim waits
8032 forever after an entered <Esc> if there are key codes that start
8033 with <Esc>. You will have to type <Esc> twice. If you do not have
8034 problems with key codes, but would like to have :mapped key
8035 sequences not timing out in 1 second, set the 'ttimeout' option and
8036 reset the 'timeout' option.
8037
8038 NOTE: 'ttimeout' is reset when 'compatible' is set.
8039
8040 *'timeoutlen'* *'tm'*
8041'timeoutlen' 'tm' number (default 1000)
8042 global
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008043
Bram Moolenaar071d4272004-06-13 20:20:40 +00008044 *'ttimeoutlen'* *'ttm'*
Bram Moolenaar94237492017-04-23 18:40:21 +02008045'ttimeoutlen' 'ttm' number (default -1, set to 100 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008046 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008047 The time in milliseconds that is waited for a key code or mapped key
8048 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
8049 when part of a command has been typed.
8050 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
8051 different timeout value for key codes is desired set 'ttimeoutlen' to
8052 a non-negative number.
8053
8054 ttimeoutlen mapping delay key code delay ~
8055 < 0 'timeoutlen' 'timeoutlen'
8056 >= 0 'timeoutlen' 'ttimeoutlen'
8057
8058 The timeout only happens when the 'timeout' and 'ttimeout' options
8059 tell so. A useful setting would be >
8060 :set timeout timeoutlen=3000 ttimeoutlen=100
8061< (time out on mapping after three seconds, time out on key codes after
8062 a tenth of a second).
8063
8064 *'title'* *'notitle'*
8065'title' boolean (default off, on when title can be restored)
8066 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008067 {not available when compiled without the |+title|
8068 feature}
8069 When on, the title of the window will be set to the value of
8070 'titlestring' (if it is not empty), or to:
8071 filename [+=-] (path) - VIM
8072 Where:
8073 filename the name of the file being edited
8074 - indicates the file cannot be modified, 'ma' off
8075 + indicates the file was modified
8076 = indicates the file is read-only
8077 =+ indicates the file is read-only and modified
8078 (path) is the path of the file being edited
8079 - VIM the server name |v:servername| or "VIM"
8080 Only works if the terminal supports setting window titles
8081 (currently Amiga console, Win32 console, all GUI versions and
Bram Moolenaard1caa942020-04-10 22:10:56 +02008082 terminals with a non-empty 't_ts' option - these are Unix xterm and
Bram Moolenaar071d4272004-06-13 20:20:40 +00008083 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
8084 *X11*
8085 When Vim was compiled with HAVE_X11 defined, the original title will
8086 be restored if possible. The output of ":version" will include "+X11"
8087 when HAVE_X11 was defined, otherwise it will be "-X11". This also
8088 works for the icon name |'icon'|.
8089 But: When Vim was started with the |-X| argument, restoring the title
8090 will not work (except in the GUI).
8091 If the title cannot be restored, it is set to the value of 'titleold'.
8092 You might want to restore the title outside of Vim then.
8093 When using an xterm from a remote machine you can use this command:
8094 rsh machine_name xterm -display $DISPLAY &
8095 then the WINDOWID environment variable should be inherited and the
8096 title of the window should change back to what it should be after
8097 exiting Vim.
8098
8099 *'titlelen'*
8100'titlelen' number (default 85)
8101 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008102 {not available when compiled without the |+title|
8103 feature}
8104 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008105 title. When the title is longer, only the end of the path name is
8106 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008107 Using a percentage makes this adapt to the width of the window. But
8108 it won't work perfectly, because the actual number of characters
8109 available also depends on the font used and other things in the title
8110 bar. When 'titlelen' is zero the full path is used. Otherwise,
8111 values from 1 to 30000 percent can be used.
8112 'titlelen' is also used for the 'titlestring' option.
8113
8114 *'titleold'*
8115'titleold' string (default "Thanks for flying Vim")
8116 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008117 {only available when compiled with the |+title|
8118 feature}
8119 This option will be used for the window title when exiting Vim if the
8120 original title cannot be restored. Only happens if 'title' is on or
8121 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00008122 This option cannot be set from a |modeline| or in the |sandbox|, for
8123 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008124 *'titlestring'*
8125'titlestring' string (default "")
8126 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008127 {not available when compiled without the |+title|
8128 feature}
8129 When this option is not empty, it will be used for the title of the
8130 window. This happens only when the 'title' option is on.
8131 Only works if the terminal supports setting window titles (currently
8132 Amiga console, Win32 console, all GUI versions and terminals with a
8133 non-empty 't_ts' option).
8134 When Vim was compiled with HAVE_X11 defined, the original title will
Bram Moolenaar51628222016-12-01 23:03:28 +01008135 be restored if possible, see |X11|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008136
Bram Moolenaar071d4272004-06-13 20:20:40 +00008137 When this option contains printf-style '%' items, they will be
8138 expanded according to the rules used for 'statusline'.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008139 This option cannot be set in a modeline when 'modelineexpr' is off.
8140
Bram Moolenaar071d4272004-06-13 20:20:40 +00008141 Example: >
8142 :auto BufEnter * let &titlestring = hostname() . "/" . expand("%:p")
8143 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
8144< The value of 'titlelen' is used to align items in the middle or right
8145 of the available space.
8146 Some people prefer to have the file name first: >
8147 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
8148< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008149 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00008150 separating space only when needed.
8151 NOTE: Use of special characters in 'titlestring' may cause the display
8152 to be garbled (e.g., when it contains a CR or NL character).
8153 {not available when compiled without the |+statusline| feature}
8154
8155 *'toolbar'* *'tb'*
8156'toolbar' 'tb' string (default "icons,tooltips")
8157 global
8158 {only for |+GUI_GTK|, |+GUI_Athena|, |+GUI_Motif| and
8159 |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008160 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00008161 possible values are:
8162 icons Toolbar buttons are shown with icons.
8163 text Toolbar buttons shown with text.
8164 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008165 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008166 tooltips Tooltips are active for toolbar buttons.
8167 Tooltips refer to the popup help text which appears after the mouse
8168 cursor is placed over a toolbar button for a brief moment.
8169
8170 If you want the toolbar to be shown with icons as well as text, do the
8171 following: >
8172 :set tb=icons,text
8173< Motif and Athena cannot display icons and text at the same time. They
8174 will show icons if both are requested.
8175
8176 If none of the strings specified in 'toolbar' are valid or if
8177 'toolbar' is empty, this option is ignored. If you want to disable
8178 the toolbar, you need to set the 'guioptions' option. For example: >
8179 :set guioptions-=T
8180< Also see |gui-toolbar|.
8181
8182 *'toolbariconsize'* *'tbis'*
8183'toolbariconsize' 'tbis' string (default "small")
8184 global
Bram Moolenaar3df01732017-02-17 22:47:16 +01008185 {only in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008186 Controls the size of toolbar icons. The possible values are:
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008187 tiny Use tiny icons.
8188 small Use small icons (default).
8189 medium Use medium-sized icons.
8190 large Use large icons.
8191 huge Use even larger icons.
8192 giant Use very big icons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008193 The exact dimensions in pixels of the various icon sizes depend on
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008194 the current theme. Common dimensions are giant=48x48, huge=32x32,
8195 large=24x24, medium=24x24, small=20x20 and tiny=16x16.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008196
8197 If 'toolbariconsize' is empty, the global default size as determined
8198 by user preferences or the current theme is used.
8199
8200 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
8201'ttybuiltin' 'tbi' boolean (default on)
8202 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008203 When on, the builtin termcaps are searched before the external ones.
8204 When off the builtin termcaps are searched after the external ones.
8205 When this option is changed, you should set the 'term' option next for
8206 the change to take effect, for example: >
8207 :set notbi term=$TERM
8208< See also |termcap|.
8209 Rationale: The default for this option is "on", because the builtin
8210 termcap entries are generally better (many systems contain faulty
8211 xterm entries...).
8212
8213 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
8214'ttyfast' 'tf' boolean (default off, on when 'term' is xterm, hpterm,
8215 sun-cmd, screen, rxvt, dtterm or
8216 iris-ansi; also on when running Vim in
8217 a DOS console)
8218 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008219 Indicates a fast terminal connection. More characters will be sent to
8220 the screen for redrawing, instead of using insert/delete line
8221 commands. Improves smoothness of redrawing when there are multiple
8222 windows and the terminal does not support a scrolling region.
8223 Also enables the extra writing of characters at the end of each screen
8224 line for lines that wrap. This helps when using copy/paste with the
8225 mouse in an xterm and other terminals.
8226
8227 *'ttymouse'* *'ttym'*
8228'ttymouse' 'ttym' string (default depends on 'term')
8229 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008230 {only in Unix and VMS, doesn't work in the GUI; not
8231 available when compiled without |+mouse|}
8232 Name of the terminal type for which mouse codes are to be recognized.
Bram Moolenaar2c7a7632007-05-10 18:19:11 +00008233 Currently these strings are valid:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008234 *xterm-mouse*
8235 xterm xterm-like mouse handling. The mouse generates
8236 "<Esc>[Mscr", where "scr" is three bytes:
8237 "s" = button state
8238 "c" = column plus 33
8239 "r" = row plus 33
Bram Moolenaare968e362014-05-13 20:23:24 +02008240 This only works up to 223 columns! See "dec",
8241 "urxvt", and "sgr" for solutions.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008242 xterm2 Works like "xterm", but with the xterm reporting the
8243 mouse position while the mouse is dragged. This works
8244 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00008245 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00008246 work. See below for how Vim detects this
8247 automatically.
8248 *netterm-mouse*
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008249 netterm NetTerm mouse handling. A left mouse click generates
Bram Moolenaar071d4272004-06-13 20:20:40 +00008250 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008251 for the row and column. No other mouse events are
8252 supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008253 *dec-mouse*
8254 dec DEC terminal mouse handling. The mouse generates a
8255 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00008256 This is also available for an Xterm, if it was
8257 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00008258 *jsbterm-mouse*
8259 jsbterm JSB term mouse handling.
8260 *pterm-mouse*
8261 pterm QNX pterm mouse handling.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008262 *urxvt-mouse*
8263 urxvt Mouse handling for the urxvt (rxvt-unicode) terminal.
Bram Moolenaare968e362014-05-13 20:23:24 +02008264 The mouse works only if the terminal supports this
8265 encoding style, but it does not have 223 columns limit
8266 unlike "xterm" or "xterm2".
Bram Moolenaar9b451252012-08-15 17:43:31 +02008267 *sgr-mouse*
8268 sgr Mouse handling for the terminal that emits SGR-styled
Bram Moolenaare968e362014-05-13 20:23:24 +02008269 mouse reporting. The mouse works even in columns
8270 beyond 223. This option is backward compatible with
8271 "xterm2" because it can also decode "xterm2" style
8272 mouse codes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008273
8274 The mouse handling must be enabled at compile time |+mouse_xterm|
Bram Moolenaare968e362014-05-13 20:23:24 +02008275 |+mouse_dec| |+mouse_netterm| |+mouse_jsbterm| |+mouse_urxvt|
8276 |+mouse_sgr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008277 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
8278 recognized, if enabled at compile time. DEC terminal mouse codes
8279 are recognized if enabled at compile time, and 'ttymouse' is not
Bram Moolenaare968e362014-05-13 20:23:24 +02008280 "xterm", "xterm2", "urxvt" or "sgr" (because dec mouse codes conflict
8281 with them).
Bram Moolenaar071d4272004-06-13 20:20:40 +00008282 This option is automatically set to "xterm", when the 'term' option is
Bram Moolenaar45758762016-10-12 23:08:06 +02008283 set to a name that starts with "xterm", "mlterm", "screen", "tmux",
8284 "st" (full match only), "st-" or "stterm", and 'ttymouse' is not set
8285 already.
Bram Moolenaare968e362014-05-13 20:23:24 +02008286 Additionally, if vim is compiled with the |+termresponse| feature and
8287 |t_RV| is set to the escape sequence to request the xterm version
Bram Moolenaarf8a07122019-07-01 22:06:07 +02008288 number, more intelligent detection is done.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008289 The "xterm2" value will be set if the xterm version is reported to be
Bram Moolenaard47d5222018-12-09 20:43:55 +01008290 from 95 to 276. The "sgr" value will be set if Vim detects Mac
8291 Terminal.app, iTerm2 or mintty, and when the xterm version is 277 or
8292 higher.
Bram Moolenaare968e362014-05-13 20:23:24 +02008293 If you do not want 'ttymouse' to be set to "xterm2" or "sgr"
8294 automatically, set t_RV to an empty string: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008295 :set t_RV=
8296<
8297 *'ttyscroll'* *'tsl'*
8298'ttyscroll' 'tsl' number (default 999)
8299 global
8300 Maximum number of lines to scroll the screen. If there are more lines
8301 to scroll the window is redrawn. For terminals where scrolling is
8302 very slow and redrawing is not slow this can be set to a small number,
8303 e.g., 3, to speed up displaying.
8304
8305 *'ttytype'* *'tty'*
8306'ttytype' 'tty' string (default from $TERM)
8307 global
8308 Alias for 'term', see above.
8309
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008310 *'undodir'* *'udir'*
8311'undodir' 'udir' string (default ".")
8312 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008313 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008314 List of directory names for undo files, separated with commas.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008315 See |'backupdir'| for details of the format.
Bram Moolenaar6a244fe2010-05-24 22:02:24 +02008316 "." means using the directory of the file. The undo file name for
8317 "file.txt" is ".file.txt.un~".
8318 For other directories the file name is the full path of the edited
8319 file, with path separators replaced with "%".
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008320 When writing: The first directory that exists is used. "." always
8321 works, no directories after "." will be used for writing.
8322 When reading all entries are tried to find an undo file. The first
8323 undo file that exists is used. When it cannot be read an error is
8324 given, no further entry is used.
8325 See |undo-persistence|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008326 This option cannot be set from a |modeline| or in the |sandbox|, for
8327 security reasons.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008328
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02008329 *'undofile'* *'noundofile'* *'udf'* *'noudf'*
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008330'undofile' 'udf' boolean (default off)
8331 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02008332 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008333 When on, Vim automatically saves undo history to an undo file when
8334 writing a buffer to a file, and restores undo history from the same
8335 file on buffer read.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008336 The directory where the undo file is stored is specified by 'undodir'.
8337 For more information about this feature see |undo-persistence|.
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008338 The undo file is not read when 'undoreload' causes the buffer from
8339 before a reload to be saved for undo.
Bram Moolenaar97d62492012-11-15 21:28:22 +01008340 When 'undofile' is turned off the undo file is NOT deleted.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008341 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008342
Bram Moolenaar071d4272004-06-13 20:20:40 +00008343 *'undolevels'* *'ul'*
Bram Moolenaar8024f932020-01-14 19:29:13 +01008344'undolevels' 'ul' number (default 100, 1000 for Unix, VMS and Win32)
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008345 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008346 Maximum number of changes that can be undone. Since undo information
Bram Moolenaar5be4cee2019-09-27 19:34:08 +02008347 is kept in memory, higher numbers will cause more memory to be used.
8348 Nevertheless, a single change can already use a large amount of memory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008349 Set to 0 for Vi compatibility: One level of undo and "u" undoes
8350 itself: >
8351 set ul=0
8352< But you can also get Vi compatibility by including the 'u' flag in
8353 'cpoptions', and still be able to use CTRL-R to repeat undo.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008354 Also see |undo-two-ways|.
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008355 Set to -1 for no undo at all. You might want to do this only for the
8356 current buffer: >
8357 setlocal ul=-1
Bram Moolenaar071d4272004-06-13 20:20:40 +00008358< This helps when you run out of memory for a single change.
Bram Moolenaar32efaf62014-11-05 17:02:17 +01008359
8360 The local value is set to -123456 when the global value is to be used.
8361
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008362 Also see |clear-undo|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008363
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008364 *'undoreload'* *'ur'*
8365'undoreload' 'ur' number (default 10000)
8366 global
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008367 Save the whole buffer for undo when reloading it. This applies to the
8368 ":e!" command and reloading for when the buffer changed outside of
8369 Vim. |FileChangedShell|
Bram Moolenaar24a98a02017-09-27 22:23:55 +02008370 The save only happens when this option is negative or when the number
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008371 of lines is smaller than the value of this option.
8372 Set this option to zero to disable undo for a reload.
8373
8374 When saving undo for a reload, any undo file is not read.
8375
8376 Note that this causes the whole buffer to be stored in memory. Set
8377 this option to a lower value if you run out of memory.
8378
Bram Moolenaar071d4272004-06-13 20:20:40 +00008379 *'updatecount'* *'uc'*
8380'updatecount' 'uc' number (default: 200)
8381 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008382 After typing this many characters the swap file will be written to
8383 disk. When zero, no swap file will be created at all (see chapter on
8384 recovery |crash-recovery|). 'updatecount' is set to zero by starting
8385 Vim with the "-n" option, see |startup|. When editing in readonly
8386 mode this option will be initialized to 10000.
8387 The swapfile can be disabled per buffer with |'swapfile'|.
8388 When 'updatecount' is set from zero to non-zero, swap files are
8389 created for all buffers that have 'swapfile' set. When 'updatecount'
8390 is set to zero, existing swap files are not deleted.
8391 Also see |'swapsync'|.
8392 This option has no meaning in buffers where |'buftype'| is "nofile"
8393 or "nowrite".
8394
8395 *'updatetime'* *'ut'*
8396'updatetime' 'ut' number (default 4000)
8397 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008398 If this many milliseconds nothing is typed the swap file will be
8399 written to disk (see |crash-recovery|). Also used for the
8400 |CursorHold| autocommand event.
8401
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008402 *'varsofttabstop'* *'vsts'*
8403'varsofttabstop' 'vsts' string (default "")
8404 local to buffer
8405 {only available when compiled with the |+vartabs|
8406 feature}
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008407 A list of the number of spaces that a <Tab> counts for while editing,
8408 such as inserting a <Tab> or using <BS>. It "feels" like variable-
8409 width <Tab>s are being inserted, while in fact a mixture of spaces
8410 and <Tab>s is used. Tab widths are separated with commas, with the
8411 final value applying to all subsequent tabs.
8412
8413 For example, when editing assembly language files where statements
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02008414 start in the 9th column and comments in the 41st, it may be useful
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008415 to use the following: >
8416 :set varsofttabstop=8,32,8
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02008417< This will set soft tabstops with 8 and 8 + 32 spaces, and 8 more
8418 for every column thereafter.
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008419
8420 Note that the value of |'softtabstop'| will be ignored while
8421 'varsofttabstop' is set.
8422
8423 *'vartabstop'* *'vts'*
8424'vartabstop' 'vts' string (default "")
8425 local to buffer
8426 {only available when compiled with the |+vartabs|
8427 feature}
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008428 A list of the number of spaces that a <Tab> in the file counts for,
8429 separated by commas. Each value corresponds to one tab, with the
8430 final value applying to all subsequent tabs. For example: >
8431 :set vartabstop=4,20,10,8
8432< This will make the first tab 4 spaces wide, the second 20 spaces,
8433 the third 10 spaces, and all following tabs 8 spaces.
8434
8435 Note that the value of |'tabstop'| will be ignored while 'vartabstop'
8436 is set.
8437
Bram Moolenaar071d4272004-06-13 20:20:40 +00008438 *'verbose'* *'vbs'*
8439'verbose' 'vbs' number (default 0)
8440 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008441 When bigger than zero, Vim will give messages about what it is doing.
8442 Currently, these messages are given:
8443 >= 1 When the viminfo file is read or written.
8444 >= 2 When a file is ":source"'ed.
Bram Moolenaar647a5302020-05-03 17:01:24 +02008445 >= 4 Shell commands.
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008446 >= 5 Every searched tags file and include file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008447 >= 8 Files for which a group of autocommands is executed.
8448 >= 9 Every executed autocommand.
Bram Moolenaar647a5302020-05-03 17:01:24 +02008449 >= 11 Finding items in a path
Bram Moolenaar071d4272004-06-13 20:20:40 +00008450 >= 12 Every executed function.
8451 >= 13 When an exception is thrown, caught, finished, or discarded.
8452 >= 14 Anything pending in a ":finally" clause.
Bram Moolenaar823654b2020-05-29 23:03:09 +02008453 >= 15 Every executed Ex command from a script (truncated at 200
8454 characters).
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02008455 >= 16 Every executed Ex command.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008456
8457 This option can also be set with the "-V" argument. See |-V|.
8458 This option is also set by the |:verbose| command.
8459
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008460 When the 'verbosefile' option is set then the verbose messages are not
8461 displayed.
8462
8463 *'verbosefile'* *'vfile'*
8464'verbosefile' 'vfile' string (default empty)
8465 global
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008466 When not empty all messages are written in a file with this name.
8467 When the file exists messages are appended.
8468 Writing to the file ends when Vim exits or when 'verbosefile' is made
Bram Moolenaar80794b12010-06-13 05:20:42 +02008469 empty. Writes are buffered, thus may not show up for some time.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008470 Setting 'verbosefile' to a new value is like making it empty first.
8471 The difference with |:redir| is that verbose messages are not
8472 displayed when 'verbosefile' is set.
8473
Bram Moolenaar071d4272004-06-13 20:20:40 +00008474 *'viewdir'* *'vdir'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008475'viewdir' 'vdir' string (default for Amiga and Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008476 "$VIM/vimfiles/view",
8477 for Unix: "~/.vim/view",
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02008478 for macOS: "$VIM:vimfiles:view"
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01008479 for VMS: "sys$login:vimfiles/view")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008480 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008481 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008482 feature}
8483 Name of the directory where to store files for |:mkview|.
8484 This option cannot be set from a |modeline| or in the |sandbox|, for
8485 security reasons.
8486
8487 *'viewoptions'* *'vop'*
Bram Moolenaar13e90412017-11-11 18:16:48 +01008488'viewoptions' 'vop' string (default: "folds,options,cursor,curdir")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008489 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008490 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008491 feature}
8492 Changes the effect of the |:mkview| command. It is a comma separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008493 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008494 word save and restore ~
8495 cursor cursor position in file and in window
8496 folds manually created folds, opened/closed folds and local
8497 fold options
8498 options options and mappings local to a window or buffer (not
8499 global values for local options)
Bram Moolenaar6e932462014-09-09 18:48:09 +02008500 localoptions same as "options"
Bram Moolenaar071d4272004-06-13 20:20:40 +00008501 slash backslashes in file names replaced with forward
8502 slashes
8503 unix with Unix end-of-line format (single <NL>), even when
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008504 on MS-Windows
Bram Moolenaar13e90412017-11-11 18:16:48 +01008505 curdir the window-local directory, if set with `:lcd`
Bram Moolenaar071d4272004-06-13 20:20:40 +00008506
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008507 "slash" and "unix" are useful on MS-Windows when sharing view files
Bram Moolenaar071d4272004-06-13 20:20:40 +00008508 with Unix. The Unix version of Vim cannot source dos format scripts,
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008509 but the MS-Windows version of Vim can source unix format scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008510
8511 *'viminfo'* *'vi'* *E526* *E527* *E528*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008512'viminfo' 'vi' string (Vi default: "", Vim default for
8513 MS-Windows: '100,<50,s10,h,rA:,rB:,
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01008514 for Amiga: '100,<50,s10,h,rdf0:,rdf1:,rdf2:
8515 for others: '100,<50,s10,h)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008516 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008517 {not available when compiled without the |+viminfo|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008518 feature}
8519 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008520 when exiting Vim (see |viminfo-file|). Except when 'viminfofile' is
8521 "NONE".
8522 The string should be a comma separated list of parameters, each
8523 consisting of a single character identifying the particular parameter,
8524 followed by a number or string which specifies the value of that
8525 parameter. If a particular character is left out, then the default
8526 value is used for that parameter. The following is a list of the
8527 identifying characters and the effect of their value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008528 CHAR VALUE ~
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008529 *viminfo-!*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008530 ! When included, save and restore global variables that start
8531 with an uppercase letter, and don't contain a lowercase
8532 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar680eeca2010-10-20 17:44:42 +02008533 and "_K_L_M" are not. Nested List and Dict items may not be
Bram Moolenaar166af9b2010-11-16 20:34:40 +01008534 read back correctly, you end up with an empty item.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008535 *viminfo-quote*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008536 " Maximum number of lines saved for each register. Old name of
8537 the '<' item, with the disadvantage that you need to put a
8538 backslash before the ", otherwise it will be recognized as the
8539 start of a comment!
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008540 *viminfo-%*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008541 % When included, save and restore the buffer list. If Vim is
8542 started with a file name argument, the buffer list is not
8543 restored. If Vim is started without a file name argument, the
Bram Moolenaard042dc82015-11-24 19:18:36 +01008544 buffer list is restored from the viminfo file. Quickfix
8545 ('buftype'), unlisted ('buflisted'), unnamed and buffers on
8546 removable media (|viminfo-r|) are not saved.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00008547 When followed by a number, the number specifies the maximum
8548 number of buffers that are stored. Without a number all
8549 buffers are stored.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008550 *viminfo-'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008551 ' Maximum number of previously edited files for which the marks
8552 are remembered. This parameter must always be included when
8553 'viminfo' is non-empty.
8554 Including this item also means that the |jumplist| and the
8555 |changelist| are stored in the viminfo file.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008556 *viminfo-/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008557 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008558 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00008559 patterns are also saved. When not included, the value of
8560 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008561 *viminfo-:*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008562 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008563 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008564 *viminfo-<*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008565 < Maximum number of lines saved for each register. If zero then
8566 registers are not saved. When not included, all lines are
8567 saved. '"' is the old name for this item.
8568 Also see the 's' item below: limit specified in Kbyte.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008569 *viminfo-@*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008570 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008571 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008572 *viminfo-c*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008573 c When included, convert the text in the viminfo file from the
8574 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00008575 'encoding'. See |viminfo-encoding|.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008576 *viminfo-f*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008577 f Whether file marks need to be stored. If zero, file marks ('0
8578 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008579 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00008580 cursor position (when exiting or when doing ":wviminfo").
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008581 *viminfo-h*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008582 h Disable the effect of 'hlsearch' when loading the viminfo
8583 file. When not included, it depends on whether ":nohlsearch"
8584 has been used since the last search command.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008585 *viminfo-n*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008586 n Name of the viminfo file. The name must immediately follow
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008587 the 'n'. Must be at the end of the option! If the
8588 'viminfofile' option is set, that file name overrides the one
8589 given here with 'viminfo'. Environment variables are
Bram Moolenaar063b9d12016-07-09 20:21:48 +02008590 expanded when opening the file, not when setting the option.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008591 *viminfo-r*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008592 r Removable media. The argument is a string (up to the next
8593 ','). This parameter can be given several times. Each
8594 specifies the start of a path for which no marks will be
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01008595 stored. This is to avoid removable media. For MS-Windows you
Bram Moolenaar071d4272004-06-13 20:20:40 +00008596 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
8597 also use it for temp files, e.g., for Unix: "r/tmp". Case is
8598 ignored. Maximum length of each 'r' argument is 50
8599 characters.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008600 *viminfo-s*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008601 s Maximum size of an item in Kbyte. If zero then registers are
8602 not saved. Currently only applies to registers. The default
8603 "s10" will exclude registers with more than 10 Kbyte of text.
8604 Also see the '<' item above: line count limit.
8605
8606 Example: >
8607 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
8608<
8609 '50 Marks will be remembered for the last 50 files you
8610 edited.
8611 <1000 Contents of registers (up to 1000 lines each) will be
8612 remembered.
8613 s100 Registers with more than 100 Kbyte text are skipped.
8614 :0 Command-line history will not be saved.
8615 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
8616 no / Since '/' is not specified, the default will be used,
8617 that is, save all of the search history, and also the
8618 previous search and substitute patterns.
8619 no % The buffer list will not be saved nor read back.
8620 no h 'hlsearch' highlighting will be restored.
8621
8622 When setting 'viminfo' from an empty value you can use |:rviminfo| to
8623 load the contents of the file, this is not done automatically.
8624
8625 This option cannot be set from a |modeline| or in the |sandbox|, for
8626 security reasons.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008627 NOTE: This option is set to the Vim default value when 'compatible'
8628 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008629
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008630 *'viminfofile'* *'vif'*
8631'viminfofile' 'vif' string (default: "")
8632 global
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008633 {not available when compiled without the |+viminfo|
8634 feature}
8635 When non-empty, overrides the file name used for viminfo.
8636 When equal to "NONE" no viminfo file will be read or written.
8637 This option can be set with the |-i| command line flag. The |--clean|
8638 command line flag sets it to "NONE".
Bram Moolenaar110289e2019-05-23 15:38:06 +02008639 This option cannot be set from a |modeline| or in the |sandbox|, for
8640 security reasons.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008641
Bram Moolenaar071d4272004-06-13 20:20:40 +00008642 *'virtualedit'* *'ve'*
8643'virtualedit' 've' string (default "")
8644 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008645 A comma separated list of these words:
8646 block Allow virtual editing in Visual block mode.
8647 insert Allow virtual editing in Insert mode.
8648 all Allow virtual editing in all modes.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008649 onemore Allow the cursor to move just past the end of the line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008650
Bram Moolenaar071d4272004-06-13 20:20:40 +00008651 Virtual editing means that the cursor can be positioned where there is
Bram Moolenaarebcbd022007-05-12 14:28:25 +00008652 no actual character. This can be halfway into a tab or beyond the end
Bram Moolenaar071d4272004-06-13 20:20:40 +00008653 of the line. Useful for selecting a rectangle in Visual mode and
8654 editing a table.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008655 "onemore" is not the same, it will only allow moving the cursor just
8656 after the last character of the line. This makes some commands more
8657 consistent. Previously the cursor was always past the end of the line
8658 if the line was empty. But it is far from Vi compatible. It may also
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008659 break some plugins or Vim scripts. For example because |l| can move
8660 the cursor after the last character. Use with care!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02008661 Using the `$` command will move to the last character in the line, not
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008662 past it. This may actually move the cursor to the left!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02008663 The `g$` command will move to the end of the screen line.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008664 It doesn't make sense to combine "all" with "onemore", but you will
8665 not get a warning for it.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008666 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008667
8668 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
8669'visualbell' 'vb' boolean (default off)
8670 global
Bram Moolenaar74675a62017-07-15 13:53:23 +02008671 Use a visual bell instead of beeping. The terminal code to display the
Bram Moolenaar071d4272004-06-13 20:20:40 +00008672 visual bell is given with 't_vb'. When no beep or flash is wanted,
Bram Moolenaar74675a62017-07-15 13:53:23 +02008673 use: >
8674 :set vb t_vb=
8675< If you want a short flash, you can use this on many terminals: >
8676 :set vb t_vb=[?5h$<100>[?5l
8677< Here $<100> specifies the time, you can use a smaller or bigger value
8678 to get a shorter or longer flash.
8679
8680 Note: Vim will limit the bell to once per half a second. This avoids
8681 having to wait for the flashing to finish when there are lots of
8682 bells, e.g. on key repeat. This also happens without 'visualbell'
8683 set.
8684
Bram Moolenaar071d4272004-06-13 20:20:40 +00008685 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
8686 for 20 msec. If you want to use a different time, use "<Esc>|40f",
8687 where 40 is the time in msec.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008688
8689 Note: When the GUI starts, 't_vb' is reset to its default value. You
8690 might want to set it again in your |gvimrc|.
8691
Bram Moolenaar071d4272004-06-13 20:20:40 +00008692 Does not work on the Amiga, you always get a screen flash.
8693 Also see 'errorbells'.
8694
8695 *'warn'* *'nowarn'*
8696'warn' boolean (default on)
8697 global
8698 Give a warning message when a shell command is used while the buffer
8699 has been changed.
8700
8701 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
8702'weirdinvert' 'wiv' boolean (default off)
8703 global
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00008704 This option has the same effect as the 't_xs' terminal option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008705 It is provided for backwards compatibility with version 4.x.
8706 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
8707 vice versa. Has no effect when the GUI is running.
8708
8709 *'whichwrap'* *'ww'*
8710'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
8711 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008712 Allow specified keys that move the cursor left/right to move to the
8713 previous/next line when the cursor is on the first/last character in
8714 the line. Concatenate characters to allow this for these keys:
8715 char key mode ~
8716 b <BS> Normal and Visual
8717 s <Space> Normal and Visual
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008718 h "h" Normal and Visual (not recommended)
8719 l "l" Normal and Visual (not recommended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008720 < <Left> Normal and Visual
8721 > <Right> Normal and Visual
8722 ~ "~" Normal
8723 [ <Left> Insert and Replace
8724 ] <Right> Insert and Replace
8725 For example: >
8726 :set ww=<,>,[,]
8727< allows wrap only when cursor keys are used.
8728 When the movement keys are used in combination with a delete or change
8729 operator, the <EOL> also counts for a character. This makes "3h"
8730 different from "3dh" when the cursor crosses the end of a line. This
8731 is also true for "x" and "X", because they do the same as "dl" and
8732 "dh". If you use this, you may also want to use the mapping
8733 ":map <BS> X" to make backspace delete the character in front of the
8734 cursor.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00008735 When 'l' is included and it is used after an operator at the end of a
Bram Moolenaar589edb32019-09-20 14:38:13 +02008736 line (not an empty line) then it will not move to the next line. This
8737 makes "dl", "cl", "yl" etc. work normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008738 NOTE: This option is set to the Vi default value when 'compatible' is
8739 set and to the Vim default value when 'compatible' is reset.
8740
8741 *'wildchar'* *'wc'*
8742'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
8743 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008744 Character you have to type to start wildcard expansion in the
8745 command-line, as specified with 'wildmode'.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008746 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008747 The character is not recognized when used inside a macro. See
8748 'wildcharm' for that.
8749 Although 'wc' is a number option, you can set it to a special key: >
8750 :set wc=<Esc>
8751< NOTE: This option is set to the Vi default value when 'compatible' is
8752 set and to the Vim default value when 'compatible' is reset.
8753
8754 *'wildcharm'* *'wcm'*
8755'wildcharm' 'wcm' number (default: none (0))
8756 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008757 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00008758 recognized when used inside a macro. You can find "spare" command-line
8759 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00008760 you'll never actually type 'wildcharm', just use it in mappings that
8761 automatically invoke completion mode, e.g.: >
8762 :set wcm=<C-Z>
Bram Moolenaar446cb832008-06-24 21:56:24 +00008763 :cnoremap ss so $vim/sessions/*.vim<C-Z>
Bram Moolenaar071d4272004-06-13 20:20:40 +00008764< Then after typing :ss you can use CTRL-P & CTRL-N.
8765
8766 *'wildignore'* *'wig'*
8767'wildignore' 'wig' string (default "")
8768 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008769 {not available when compiled without the |+wildignore|
8770 feature}
8771 A list of file patterns. A file that matches with one of these
Bram Moolenaar30b65812012-07-12 22:01:11 +02008772 patterns is ignored when expanding |wildcards|, completing file or
8773 directory names, and influences the result of |expand()|, |glob()| and
8774 |globpath()| unless a flag is passed to disable this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008775 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
8776 Also see 'suffixes'.
8777 Example: >
8778 :set wildignore=*.o,*.obj
8779< The use of |:set+=| and |:set-=| is preferred when adding or removing
8780 a pattern from the list. This avoids problems when a future version
8781 uses another default.
8782
Bram Moolenaar94950a92010-12-02 16:01:29 +01008783
Bram Moolenaar81af9252010-12-10 20:35:50 +01008784 *'wildignorecase'* *'wic'* *'nowildignorecase'* *'nowic'*
Bram Moolenaar94950a92010-12-02 16:01:29 +01008785'wildignorecase' 'wic' boolean (default off)
8786 global
Bram Moolenaar94950a92010-12-02 16:01:29 +01008787 When set case is ignored when completing file names and directories.
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01008788 Has no effect when 'fileignorecase' is set.
Bram Moolenaar94950a92010-12-02 16:01:29 +01008789 Does not apply when the shell is used to expand wildcards, which
8790 happens when there are special characters.
8791
8792
Bram Moolenaar071d4272004-06-13 20:20:40 +00008793 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02008794'wildmenu' 'wmnu' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008795 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008796 {not available if compiled without the |+wildmenu|
8797 feature}
8798 When 'wildmenu' is on, command-line completion operates in an enhanced
8799 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
8800 the possible matches are shown just above the command line, with the
8801 first match highlighted (overwriting the status line, if there is
8802 one). Keys that show the previous/next match, such as <Tab> or
8803 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
8804 When 'wildmode' is used, "wildmenu" mode is used where "full" is
8805 specified. "longest" and "list" do not start "wildmenu" mode.
Bram Moolenaar26402cb2013-02-20 21:26:00 +01008806 You can check the current mode with |wildmenumode()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008807 If there are more matches than can fit in the line, a ">" is shown on
8808 the right and/or a "<" is shown on the left. The status line scrolls
8809 as needed.
8810 The "wildmenu" mode is abandoned when a key is hit that is not used
8811 for selecting a completion.
8812 While the "wildmenu" is active the following keys have special
8813 meanings:
8814
8815 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
8816 <Down> - in filename/menu name completion: move into a
8817 subdirectory or submenu.
8818 <CR> - in menu completion, when the cursor is just after a
8819 dot: move into a submenu.
8820 <Up> - in filename/menu name completion: move up into
8821 parent directory or parent menu.
8822
8823 This makes the menus accessible from the console |console-menus|.
8824
8825 If you prefer the <Left> and <Right> keys to move the cursor instead
8826 of selecting a different match, use this: >
8827 :cnoremap <Left> <Space><BS><Left>
8828 :cnoremap <Right> <Space><BS><Right>
8829<
8830 The "WildMenu" highlighting is used for displaying the current match
8831 |hl-WildMenu|.
8832
8833 *'wildmode'* *'wim'*
8834'wildmode' 'wim' string (Vim default: "full")
8835 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008836 Completion mode that is used for the character specified with
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008837 'wildchar'. It is a comma separated list of up to four parts. Each
Bram Moolenaar02467872007-05-06 13:22:01 +00008838 part specifies what to do for each consecutive use of 'wildchar'. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00008839 first part specifies the behavior for the first use of 'wildchar',
8840 The second part for the second use, etc.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02008841
8842 Each part consists of a colon separated list consisting of the
8843 following possible values:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008844 "" Complete only the first match.
8845 "full" Complete the next full match. After the last match,
8846 the original string is used and then the first match
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02008847 again. Will also start 'wildmenu' if it is enabled.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008848 "longest" Complete till longest common string. If this doesn't
8849 result in a longer string, use the next part.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008850 "list" When more than one match, list all matches.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02008851 "lastused" When completing buffer names and more than one buffer
8852 matches, sort buffers by time last used (other than
8853 the current buffer).
8854 When there is only a single match, it is fully completed in all cases.
8855
8856 Examples of useful colon-separated values:
8857 "longest:full" Like "longest", but also start 'wildmenu' if it is
8858 enabled. Will not complete to the next full match.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008859 "list:full" When more than one match, list all matches and
8860 complete first match.
8861 "list:longest" When more than one match, list all matches and
8862 complete till longest common string.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02008863 "list:lastused" When more than one buffer matches, list all matches
8864 and sort buffers by time last used (other than the
8865 current buffer).
Bram Moolenaar071d4272004-06-13 20:20:40 +00008866
8867 Examples: >
8868 :set wildmode=full
Bram Moolenaar582fd852005-03-28 20:58:01 +00008869< Complete first full match, next match, etc. (the default) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008870 :set wildmode=longest,full
8871< Complete longest common string, then each full match >
8872 :set wildmode=list:full
8873< List all matches and complete each full match >
8874 :set wildmode=list,full
8875< List all matches without completing, then each full match >
8876 :set wildmode=longest,list
8877< Complete longest common string, then list alternatives.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008878 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008879
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00008880 *'wildoptions'* *'wop'*
8881'wildoptions' 'wop' string (default "")
8882 global
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00008883 {not available when compiled without the |+wildignore|
8884 feature}
8885 A list of words that change how command line completion is done.
8886 Currently only one word is allowed:
8887 tagfile When using CTRL-D to list matching tags, the kind of
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00008888 tag and the file of the tag is listed. Only one match
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00008889 is displayed per line. Often used tag kinds are:
8890 d #define
8891 f function
8892 Also see |cmdline-completion|.
8893
Bram Moolenaar071d4272004-06-13 20:20:40 +00008894 *'winaltkeys'* *'wak'*
8895'winaltkeys' 'wak' string (default "menu")
8896 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008897 {only used in Win32, Motif, GTK and Photon GUI}
8898 Some GUI versions allow the access to menu entries by using the ALT
8899 key in combination with a character that appears underlined in the
8900 menu. This conflicts with the use of the ALT key for mappings and
8901 entering special characters. This option tells what to do:
8902 no Don't use ALT keys for menus. ALT key combinations can be
8903 mapped, but there is no automatic handling. This can then be
8904 done with the |:simalt| command.
8905 yes ALT key handling is done by the windowing system. ALT key
8906 combinations cannot be mapped.
8907 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008908 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00008909 keys can be mapped.
8910 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
8911 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00008912 This option is not used for <F10>; on Win32 and with GTK <F10> will
8913 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008914
Bram Moolenaar4d784b22019-05-25 19:51:39 +02008915 *'wincolor'* *'wcr'*
8916'wincolor' 'wcr' string (default empty)
8917 local to window
8918 Highlight group name to use for this window instead of the Normal
8919 color |hl-Normal|.
8920
Bram Moolenaar4399ef42005-02-12 14:29:27 +00008921 *'window'* *'wi'*
8922'window' 'wi' number (default screen height - 1)
8923 global
Bram Moolenaardad44732021-03-31 20:07:33 +02008924 Window height used for |CTRL-F| and |CTRL-B| when there is only one
8925 window and the value is smaller than 'lines' minus one. The screen
8926 will scroll 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00008927 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
8928 in a much smarter way, taking care of wrapping lines.
8929 When resizing the Vim window, the value is smaller than 1 or more than
8930 or equal to 'lines' it will be set to 'lines' minus 1.
Bram Moolenaardad44732021-03-31 20:07:33 +02008931 Note: Do not confuse this with the height of the Vim window, use
8932 'lines' for that.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00008933
Bram Moolenaar071d4272004-06-13 20:20:40 +00008934 *'winheight'* *'wh'* *E591*
8935'winheight' 'wh' number (default 1)
8936 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008937 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008938 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar446cb832008-06-24 21:56:24 +00008939 focus goes to a window that is smaller, its size is increased, at the
8940 cost of the height of other windows.
8941 Set 'winheight' to a small number for normal editing.
8942 Set it to 999 to make the current window fill most of the screen.
8943 Other windows will be only 'winminheight' high. This has the drawback
8944 that ":all" will create only two windows. To avoid "vim -o 1 2 3 4"
8945 to create only two windows, set the option after startup is done,
8946 using the |VimEnter| event: >
8947 au VimEnter * set winheight=999
8948< Minimum value is 1.
8949 The height is not adjusted after one of the commands that change the
Bram Moolenaar071d4272004-06-13 20:20:40 +00008950 height of the current window.
8951 'winheight' applies to the current window. Use 'winminheight' to set
8952 the minimal height for other windows.
8953
8954 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
8955'winfixheight' 'wfh' boolean (default off)
8956 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00008957 Keep the window height when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00008958 'equalalways' is set. Also for |CTRL-W_=|. Set by default for the
8959 |preview-window| and |quickfix-window|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008960 The height may be changed anyway when running out of room.
8961
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008962 *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'*
8963'winfixwidth' 'wfw' boolean (default off)
8964 local to window
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008965 Keep the window width when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00008966 'equalalways' is set. Also for |CTRL-W_=|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008967 The width may be changed anyway when running out of room.
8968
Bram Moolenaar071d4272004-06-13 20:20:40 +00008969 *'winminheight'* *'wmh'*
8970'winminheight' 'wmh' number (default 1)
8971 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008972 The minimal height of a window, when it's not the current window.
8973 This is a hard minimum, windows will never become smaller.
8974 When set to zero, windows may be "squashed" to zero lines (i.e. just a
8975 status bar) if necessary. They will return to at least one line when
8976 they become active (since the cursor has to have somewhere to go.)
8977 Use 'winheight' to set the minimal height of the current window.
8978 This option is only checked when making a window smaller. Don't use a
8979 large number, it will cause errors when opening more than a few
8980 windows. A value of 0 to 3 is reasonable.
8981
8982 *'winminwidth'* *'wmw'*
8983'winminwidth' 'wmw' number (default 1)
8984 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008985 The minimal width of a window, when it's not the current window.
8986 This is a hard minimum, windows will never become smaller.
8987 When set to zero, windows may be "squashed" to zero columns (i.e. just
8988 a vertical separator) if necessary. They will return to at least one
8989 line when they become active (since the cursor has to have somewhere
8990 to go.)
8991 Use 'winwidth' to set the minimal width of the current window.
8992 This option is only checked when making a window smaller. Don't use a
8993 large number, it will cause errors when opening more than a few
8994 windows. A value of 0 to 12 is reasonable.
8995
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02008996 *'winptydll'*
8997'winptydll' string (default "winpty32.dll" or "winpty64.dll")
8998 global
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02008999 {only available when compiled with the |terminal|
9000 feature on MS-Windows}
9001 Specifies the name of the winpty shared library, used for the
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02009002 |:terminal| command. The default depends on whether Vim was built as a
Bram Moolenaarc572da52017-08-27 16:52:01 +02009003 32-bit or 64-bit executable. If not found, "winpty.dll" is tried as
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009004 a fallback.
9005 Environment variables are expanded |:set_env|.
9006 This option cannot be set from a |modeline| or in the |sandbox|, for
9007 security reasons.
9008
Bram Moolenaar071d4272004-06-13 20:20:40 +00009009 *'winwidth'* *'wiw'* *E592*
9010'winwidth' 'wiw' number (default 20)
9011 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009012 Minimal number of columns for the current window. This is not a hard
9013 minimum, Vim will use fewer columns if there is not enough room. If
9014 the current window is smaller, its size is increased, at the cost of
9015 the width of other windows. Set it to 999 to make the current window
9016 always fill the screen. Set it to a small number for normal editing.
9017 The width is not adjusted after one of the commands to change the
9018 width of the current window.
9019 'winwidth' applies to the current window. Use 'winminwidth' to set
9020 the minimal width for other windows.
9021
9022 *'wrap'* *'nowrap'*
9023'wrap' boolean (default on)
9024 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00009025 This option changes how text is displayed. It doesn't change the text
9026 in the buffer, see 'textwidth' for that.
9027 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009028 displaying continues on the next line. When off lines will not wrap
9029 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00009030 moved to a part that is not shown, the screen will scroll
9031 horizontally.
9032 The line will be broken in the middle of a word if necessary. See
9033 'linebreak' to get the break at a word boundary.
9034 To make scrolling horizontally a bit more useful, try this: >
9035 :set sidescroll=5
9036 :set listchars+=precedes:<,extends:>
9037< See 'sidescroll', 'listchars' and |wrap-off|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01009038 This option can't be set from a |modeline| when the 'diff' option is
9039 on.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009040
9041 *'wrapmargin'* *'wm'*
9042'wrapmargin' 'wm' number (default 0)
9043 local to buffer
9044 Number of characters from the right window border where wrapping
9045 starts. When typing text beyond this limit, an <EOL> will be inserted
9046 and inserting continues on the next line.
9047 Options that add a margin, such as 'number' and 'foldcolumn', cause
9048 the text width to be further reduced. This is Vi compatible.
9049 When 'textwidth' is non-zero, this option is not used.
Bram Moolenaarca635012015-09-25 20:34:21 +02009050 This option is set to 0 when 'paste' is set and restored when 'paste'
9051 is reset.
Bram Moolenaara6c27c42019-05-09 19:16:22 +02009052 See also 'formatoptions' and |ins-textwidth|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009053
9054 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
9055'wrapscan' 'ws' boolean (default on) *E384* *E385*
9056 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00009057 Searches wrap around the end of the file. Also applies to |]s| and
9058 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009059
9060 *'write'* *'nowrite'*
9061'write' boolean (default on)
9062 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009063 Allows writing files. When not set, writing a file is not allowed.
9064 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009065 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00009066 argument. Filtering text is still possible, even though this requires
9067 writing a temporary file.
9068
9069 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
9070'writeany' 'wa' boolean (default off)
9071 global
9072 Allows writing to any file with no need for "!" override.
9073
9074 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
9075'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
9076 otherwise)
9077 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009078 Make a backup before overwriting a file. The backup is removed after
9079 the file was successfully written, unless the 'backup' option is
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02009080 also on.
9081 WARNING: Switching this option off means that when Vim fails to write
9082 your buffer correctly and then, for whatever reason, Vim exits, you
9083 lose both the original file and what you were writing. Only reset
9084 this option if your file system is almost full and it makes the write
9085 fail (and make sure not to exit Vim until the write was successful).
9086 See |backup-table| for another explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009087 When the 'backupskip' pattern matches, a backup is not made anyway.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01009088 Depending on 'backupcopy' the backup is a new file or the original
9089 file renamed (and a new file is written).
Bram Moolenaar071d4272004-06-13 20:20:40 +00009090 NOTE: This option is set to the default value when 'compatible' is
9091 set.
9092
9093 *'writedelay'* *'wd'*
9094'writedelay' 'wd' number (default 0)
9095 global
Bram Moolenaar802a0d92016-06-26 16:17:58 +02009096 The number of milliseconds to wait for each character sent to the
Bram Moolenaar071d4272004-06-13 20:20:40 +00009097 screen. When non-zero, characters are sent to the terminal one by
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01009098 one. For debugging purposes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009099
Bram Moolenaar91f84f62018-07-29 15:07:52 +02009100 vim:tw=78:ts=8:noet:ft=help:norl: