blob: ebb408dd4971e30f6809eede2504e33712d57152 [file] [log] [blame]
Bram Moolenaar53f7fcc2021-07-28 20:10:16 +02001*options.txt* For Vim version 8.2. Last change: 2021 Jul 22
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.
Maxim Kimf674b352021-07-22 11:46:59 +02001329 list:{n} Adds an additional indent for lines that match a
Christian Brabandt4a0b85a2021-07-14 20:00:27 +02001330 numbered or bulleted list (using the
1331 'formatlistpat' setting).
Maxim Kimf674b352021-07-22 11:46:59 +02001332 list:-1 Uses the length of a match with 'formatlistpat'
1333 for indentation.
Christian Brabandt4a0b85a2021-07-14 20:00:27 +02001334 The default value for min is 20, shift and list is 0.
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001335
Bram Moolenaar071d4272004-06-13 20:20:40 +00001336 *'browsedir'* *'bsdir'*
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001337'browsedir' 'bsdir' string (default: "last")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001338 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02001339 {only for Motif, Athena, GTK, Mac and Win32 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001340 Which directory to use for the file browser:
Bram Moolenaar446cb832008-06-24 21:56:24 +00001341 last Use same directory as with last file browser, where a
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02001342 file was opened or saved.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001343 buffer Use the directory of the related buffer.
1344 current Use the current directory.
1345 {path} Use the specified directory
1346
1347 *'bufhidden'* *'bh'*
1348'bufhidden' 'bh' string (default: "")
1349 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001350 This option specifies what happens when a buffer is no longer
1351 displayed in a window:
1352 <empty> follow the global 'hidden' option
1353 hide hide the buffer (don't unload it), also when 'hidden'
1354 is not set
1355 unload unload the buffer, also when 'hidden' is set or using
1356 |:hide|
1357 delete delete the buffer from the buffer list, also when
1358 'hidden' is set or using |:hide|, like using
1359 |:bdelete|
1360 wipe wipe out the buffer from the buffer list, also when
1361 'hidden' is set or using |:hide|, like using
1362 |:bwipeout|
1363
Bram Moolenaara14de3d2005-01-07 21:48:26 +00001364 CAREFUL: when "unload", "delete" or "wipe" is used changes in a buffer
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01001365 are lost without a warning. Also, these values may break autocommands
1366 that switch between buffers temporarily.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001367 This option is used together with 'buftype' and 'swapfile' to specify
1368 special kinds of buffers. See |special-buffers|.
1369
1370 *'buflisted'* *'bl'* *'nobuflisted'* *'nobl'* *E85*
1371'buflisted' 'bl' boolean (default: on)
1372 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001373 When this option is set, the buffer shows up in the buffer list. If
1374 it is reset it is not used for ":bnext", "ls", the Buffers menu, etc.
1375 This option is reset by Vim for buffers that are only used to remember
1376 a file name or marks. Vim sets it when starting to edit a buffer.
1377 But not when moving to a buffer with ":buffer".
1378
1379 *'buftype'* *'bt'* *E382*
1380'buftype' 'bt' string (default: "")
1381 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001382 The value of this option specifies the type of a buffer:
1383 <empty> normal buffer
1384 nofile buffer which is not related to a file and will not be
1385 written
1386 nowrite buffer which will not be written
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001387 acwrite buffer which will always be written with BufWriteCmd
Bram Moolenaarb5b75622018-03-09 22:22:21 +01001388 autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001389 quickfix quickfix buffer, contains list of errors |:cwindow|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001390 or list of locations |:lwindow|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001391 help help buffer (you are not supposed to set this
1392 manually)
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02001393 terminal buffer for a |terminal| (you are not supposed to set
1394 this manually)
Bram Moolenaarf2732452018-06-03 14:47:35 +02001395 prompt buffer where only the last line can be edited, meant
1396 to be used by a plugin, see |prompt-buffer|
1397 {only when compiled with the |+channel| feature}
Bram Moolenaar4d784b22019-05-25 19:51:39 +02001398 popup buffer used in a popup window, see |popup|.
1399 {only when compiled with the |+textprop| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001400
1401 This option is used together with 'bufhidden' and 'swapfile' to
1402 specify special kinds of buffers. See |special-buffers|.
Bram Moolenaarebdf3c92020-02-15 21:41:42 +01001403 Also see |win_gettype()|, which returns the type of the window.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001404
1405 Be careful with changing this option, it can have many side effects!
1406
Bram Moolenaar280f1262006-01-30 00:14:18 +00001407 A "quickfix" buffer is only used for the error list and the location
1408 list. This value is set by the |:cwindow| and |:lwindow| commands and
1409 you are not supposed to change it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001410
1411 "nofile" and "nowrite" buffers are similar:
1412 both: The buffer is not to be written to disk, ":w" doesn't
1413 work (":w filename" does work though).
1414 both: The buffer is never considered to be |'modified'|.
1415 There is no warning when the changes will be lost, for
1416 example when you quit Vim.
1417 both: A swap file is only created when using too much memory
1418 (when 'swapfile' has been reset there is never a swap
1419 file).
1420 nofile only: The buffer name is fixed, it is not handled like a
1421 file name. It is not modified in response to a |:cd|
1422 command.
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01001423 both: When using ":e bufname" and already editing "bufname"
1424 the buffer is made empty and autocommands are
1425 triggered as usual for |:edit|.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001426 *E676*
1427 "acwrite" implies that the buffer name is not related to a file, like
1428 "nofile", but it will be written. Thus, in contrast to "nofile" and
1429 "nowrite", ":w" does work and a modified buffer can't be abandoned
1430 without saving. For writing there must be matching |BufWriteCmd|,
1431 |FileWriteCmd| or |FileAppendCmd| autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001432
1433 *'casemap'* *'cmp'*
1434'casemap' 'cmp' string (default: "internal,keepascii")
1435 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001436 Specifies details about changing the case of letters. It may contain
1437 these words, separated by a comma:
1438 internal Use internal case mapping functions, the current
1439 locale does not change the case mapping. This only
Bram Moolenaar6f16eb82005-08-23 21:02:42 +00001440 matters when 'encoding' is a Unicode encoding,
1441 "latin1" or "iso-8859-15". When "internal" is
1442 omitted, the towupper() and towlower() system library
1443 functions are used when available.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001444 keepascii For the ASCII characters (0x00 to 0x7f) use the US
1445 case mapping, the current locale is not effective.
1446 This probably only matters for Turkish.
1447
1448 *'cdpath'* *'cd'* *E344* *E346*
1449'cdpath' 'cd' string (default: equivalent to $CDPATH or ",,")
1450 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001451 {not available when compiled without the
1452 |+file_in_path| feature}
1453 This is a list of directories which will be searched when using the
Bram Moolenaar00aa0692019-04-27 20:37:57 +02001454 |:cd|, |:tcd| and |:lcd| commands, provided that the directory being
1455 searched for has a relative path, not an absolute part starting with
1456 "/", "./" or "../", the 'cdpath' option is not used then.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001457 The 'cdpath' option's value has the same form and semantics as
1458 |'path'|. Also see |file-searching|.
1459 The default value is taken from $CDPATH, with a "," prepended to look
1460 in the current directory first.
1461 If the default value taken from $CDPATH is not what you want, include
1462 a modified version of the following command in your vimrc file to
1463 override it: >
1464 :let &cdpath = ',' . substitute(substitute($CDPATH, '[, ]', '\\\0', 'g'), ':', ',', 'g')
1465< This option cannot be set from a |modeline| or in the |sandbox|, for
1466 security reasons.
1467 (parts of 'cdpath' can be passed to the shell to expand file names).
1468
1469 *'cedit'*
1470'cedit' string (Vi default: "", Vim default: CTRL-F)
1471 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001472 The key used in Command-line Mode to open the command-line window.
1473 The default is CTRL-F when 'compatible' is off.
1474 Only non-printable keys are allowed.
1475 The key can be specified as a single character, but it is difficult to
1476 type. The preferred way is to use the <> notation. Examples: >
Bram Moolenaare18dbe82016-07-02 21:42:23 +02001477 :exe "set cedit=\<C-Y>"
1478 :exe "set cedit=\<Esc>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001479< |Nvi| also has this option, but it only uses the first character.
1480 See |cmdwin|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001481 NOTE: This option is set to the Vim default value when 'compatible'
1482 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001483
1484 *'charconvert'* *'ccv'* *E202* *E214* *E513*
1485'charconvert' 'ccv' string (default "")
1486 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01001487 {only available when compiled with the |+eval| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001488 An expression that is used for character encoding conversion. It is
1489 evaluated when a file that is to be read or has been written has a
1490 different encoding from what is desired.
1491 'charconvert' is not used when the internal iconv() function is
1492 supported and is able to do the conversion. Using iconv() is
1493 preferred, because it is much faster.
1494 'charconvert' is not used when reading stdin |--|, because there is no
1495 file to convert from. You will have to save the text in a file first.
1496 The expression must return zero or an empty string for success,
1497 non-zero for failure.
1498 The possible encoding names encountered are in 'encoding'.
1499 Additionally, names given in 'fileencodings' and 'fileencoding' are
1500 used.
1501 Conversion between "latin1", "unicode", "ucs-2", "ucs-4" and "utf-8"
1502 is done internally by Vim, 'charconvert' is not used for this.
1503 'charconvert' is also used to convert the viminfo file, if the 'c'
1504 flag is present in 'viminfo'. Also used for Unicode conversion.
1505 Example: >
1506 set charconvert=CharConvert()
1507 fun CharConvert()
1508 system("recode "
1509 \ . v:charconvert_from . ".." . v:charconvert_to
1510 \ . " <" . v:fname_in . " >" v:fname_out)
1511 return v:shell_error
1512 endfun
1513< The related Vim variables are:
1514 v:charconvert_from name of the current encoding
1515 v:charconvert_to name of the desired encoding
1516 v:fname_in name of the input file
1517 v:fname_out name of the output file
1518 Note that v:fname_in and v:fname_out will never be the same.
1519 Note that v:charconvert_from and v:charconvert_to may be different
1520 from 'encoding'. Vim internally uses UTF-8 instead of UCS-2 or UCS-4.
1521 Encryption is not done by Vim when using 'charconvert'. If you want
1522 to encrypt the file after conversion, 'charconvert' should take care
1523 of this.
1524 This option cannot be set from a |modeline| or in the |sandbox|, for
1525 security reasons.
1526
1527 *'cindent'* *'cin'* *'nocindent'* *'nocin'*
1528'cindent' 'cin' boolean (default off)
1529 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001530 {not available when compiled without the |+cindent|
1531 feature}
Bram Moolenaar446cb832008-06-24 21:56:24 +00001532 Enables automatic C program indenting. See 'cinkeys' to set the keys
Bram Moolenaar071d4272004-06-13 20:20:40 +00001533 that trigger reindenting in insert mode and 'cinoptions' to set your
1534 preferred indent style.
1535 If 'indentexpr' is not empty, it overrules 'cindent'.
1536 If 'lisp' is not on and both 'indentexpr' and 'equalprg' are empty,
1537 the "=" operator indents using this algorithm rather than calling an
1538 external program.
1539 See |C-indenting|.
1540 When you don't like the way 'cindent' works, try the 'smartindent'
1541 option or 'indentexpr'.
1542 This option is not used when 'paste' is set.
1543 NOTE: This option is reset when 'compatible' is set.
1544
1545 *'cinkeys'* *'cink'*
Bram Moolenaarce655742019-01-31 14:12:57 +01001546'cinkeys' 'cink' string (default "0{,0},0),0],:,0#,!^F,o,O,e")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001547 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001548 {not available when compiled without the |+cindent|
1549 feature}
1550 A list of keys that, when typed in Insert mode, cause reindenting of
1551 the current line. Only used if 'cindent' is on and 'indentexpr' is
1552 empty.
1553 For the format of this option see |cinkeys-format|.
1554 See |C-indenting|.
1555
1556 *'cinoptions'* *'cino'*
1557'cinoptions' 'cino' string (default "")
1558 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001559 {not available when compiled without the |+cindent|
1560 feature}
1561 The 'cinoptions' affect the way 'cindent' reindents lines in a C
1562 program. See |cinoptions-values| for the values of this option, and
1563 |C-indenting| for info on C indenting in general.
1564
1565
1566 *'cinwords'* *'cinw'*
1567'cinwords' 'cinw' string (default "if,else,while,do,for,switch")
1568 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001569 {not available when compiled without both the
1570 |+cindent| and the |+smartindent| features}
1571 These keywords start an extra indent in the next line when
1572 'smartindent' or 'cindent' is set. For 'cindent' this is only done at
1573 an appropriate place (inside {}).
1574 Note that 'ignorecase' isn't used for 'cinwords'. If case doesn't
1575 matter, include the keyword both the uppercase and lowercase:
1576 "if,If,IF".
1577
1578 *'clipboard'* *'cb'*
1579'clipboard' 'cb' string (default "autoselect,exclude:cons\|linux"
1580 for X-windows, "" otherwise)
1581 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001582 {only in GUI versions or when the |+xterm_clipboard|
1583 feature is included}
1584 This option is a list of comma separated names.
Bram Moolenaar942db232021-02-13 18:14:48 +01001585 Note: if one of the items is "exclude:", then you can't add an item
1586 after that. Therefore do append an item with += but use ^= to
1587 prepend, e.g.: >
1588 set clipboard^=unnamed
1589< These names are recognized:
Bram Moolenaar071d4272004-06-13 20:20:40 +00001590
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001591 *clipboard-unnamed*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001592 unnamed When included, Vim will use the clipboard register '*'
1593 for all yank, delete, change and put operations which
1594 would normally go to the unnamed register. When a
1595 register is explicitly specified, it will always be
1596 used regardless of whether "unnamed" is in 'clipboard'
1597 or not. The clipboard register can always be
1598 explicitly accessed using the "* notation. Also see
1599 |gui-clipboard|.
1600
Bram Moolenaar30b65812012-07-12 22:01:11 +02001601 *clipboard-unnamedplus*
Bram Moolenaar00154502013-02-13 16:15:55 +01001602 unnamedplus A variant of the "unnamed" flag which uses the
1603 clipboard register '+' (|quoteplus|) instead of
1604 register '*' for all yank, delete, change and put
1605 operations which would normally go to the unnamed
1606 register. When "unnamed" is also included to the
1607 option, yank operations (but not delete, change or
1608 put) will additionally copy the text into register
1609 '*'.
Bram Moolenaar81af9252010-12-10 20:35:50 +01001610 Only available with the |+X11| feature.
Bram Moolenaarbf9680e2010-12-02 21:43:16 +01001611 Availability can be checked with: >
1612 if has('unnamedplus')
1613<
Bram Moolenaar30b65812012-07-12 22:01:11 +02001614 *clipboard-autoselect*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001615 autoselect Works like the 'a' flag in 'guioptions': If present,
1616 then whenever Visual mode is started, or the Visual
1617 area extended, Vim tries to become the owner of the
1618 windowing system's global selection or put the
1619 selected text on the clipboard used by the selection
Bram Moolenaarba3ff532018-11-04 14:45:49 +01001620 register "*. See |'go-a'| and |quotestar| for details.
1621 When the GUI is active, the 'a' flag in 'guioptions'
1622 is used, when the GUI is not active, this "autoselect"
1623 flag is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001624 Also applies to the modeless selection.
1625
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001626 *clipboard-autoselectplus*
1627 autoselectplus Like "autoselect" but using the + register instead of
1628 the * register. Compare to the 'P' flag in
1629 'guioptions'.
1630
1631 *clipboard-autoselectml*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001632 autoselectml Like "autoselect", but for the modeless selection
1633 only. Compare to the 'A' flag in 'guioptions'.
1634
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001635 *clipboard-html*
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001636 html When the clipboard contains HTML, use this when
1637 pasting. When putting text on the clipboard, mark it
1638 as HTML. This works to copy rendered HTML from
1639 Firefox, paste it as raw HTML in Vim, select the HTML
1640 in Vim and paste it in a rich edit box in Firefox.
Bram Moolenaar20a825a2010-05-31 21:27:30 +02001641 You probably want to add this only temporarily,
1642 possibly use BufEnter autocommands.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001643 Only supported for GTK version 2 and later.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001644
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001645 *clipboard-exclude*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001646 exclude:{pattern}
1647 Defines a pattern that is matched against the name of
1648 the terminal 'term'. If there is a match, no
1649 connection will be made to the X server. This is
1650 useful in this situation:
1651 - Running Vim in a console.
1652 - $DISPLAY is set to start applications on another
1653 display.
1654 - You do not want to connect to the X server in the
1655 console, but do want this in a terminal emulator.
1656 To never connect to the X server use: >
1657 exclude:.*
1658< This has the same effect as using the |-X| argument.
1659 Note that when there is no connection to the X server
1660 the window title won't be restored and the clipboard
1661 cannot be accessed.
1662 The value of 'magic' is ignored, {pattern} is
1663 interpreted as if 'magic' was on.
1664 The rest of the option value will be used for
1665 {pattern}, this must be the last entry.
1666
1667 *'cmdheight'* *'ch'*
1668'cmdheight' 'ch' number (default 1)
1669 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001670 Number of screen lines to use for the command-line. Helps avoiding
1671 |hit-enter| prompts.
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00001672 The value of this option is stored with the tab page, so that each tab
1673 page can have a different value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001674
1675 *'cmdwinheight'* *'cwh'*
1676'cmdwinheight' 'cwh' number (default 7)
1677 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001678 Number of screen lines to use for the command-line window. |cmdwin|
1679
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001680 *'colorcolumn'* *'cc'*
1681'colorcolumn' 'cc' string (default "")
1682 local to window
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001683 {not available when compiled without the |+syntax|
1684 feature}
1685 'colorcolumn' is a comma separated list of screen columns that are
1686 highlighted with ColorColumn |hl-ColorColumn|. Useful to align
1687 text. Will make screen redrawing slower.
1688 The screen column can be an absolute number, or a number preceded with
1689 '+' or '-', which is added to or subtracted from 'textwidth'. >
1690
1691 :set cc=+1 " highlight column after 'textwidth'
1692 :set cc=+1,+2,+3 " highlight three columns after 'textwidth'
1693 :hi ColorColumn ctermbg=lightgrey guibg=lightgrey
1694<
1695 When 'textwidth' is zero then the items with '-' and '+' are not used.
1696 A maximum of 256 columns are highlighted.
1697
Bram Moolenaar071d4272004-06-13 20:20:40 +00001698 *'columns'* *'co'* *E594*
1699'columns' 'co' number (default 80 or terminal width)
1700 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001701 Number of columns of the screen. Normally this is set by the terminal
Bram Moolenaar7c626922005-02-07 22:01:03 +00001702 initialization and does not have to be set by hand. Also see
1703 |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001704 When Vim is running in the GUI or in a resizable window, setting this
1705 option will cause the window size to be changed. When you only want
1706 to use the size for the GUI, put the command in your |gvimrc| file.
1707 When you set this option and Vim is unable to change the physical
Bram Moolenaar02467872007-05-06 13:22:01 +00001708 number of columns of the display, the display may be messed up. For
1709 the GUI it is always possible and Vim limits the number of columns to
1710 what fits on the screen. You can use this command to get the widest
1711 window possible: >
1712 :set columns=9999
1713< Minimum value is 12, maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001714
1715 *'comments'* *'com'* *E524* *E525*
1716'comments' 'com' string (default
1717 "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-")
1718 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001719 A comma separated list of strings that can start a comment line. See
1720 |format-comments|. See |option-backslash| about using backslashes to
1721 insert a space.
1722
1723 *'commentstring'* *'cms'* *E537*
1724'commentstring' 'cms' string (default "/*%s*/")
1725 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001726 {not available when compiled without the |+folding|
1727 feature}
1728 A template for a comment. The "%s" in the value is replaced with the
1729 comment text. Currently only used to add markers for folding, see
1730 |fold-marker|.
1731
1732 *'compatible'* *'cp'* *'nocompatible'* *'nocp'*
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001733'compatible' 'cp' boolean (default on, off when a |vimrc| or |gvimrc|
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02001734 file is found, reset in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001735 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001736 This option has the effect of making Vim either more Vi-compatible, or
1737 make Vim behave in a more useful way.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001738
Bram Moolenaar071d4272004-06-13 20:20:40 +00001739 This is a special kind of option, because when it's set or reset,
Bram Moolenaar214641f2017-03-05 17:04:09 +01001740 other options are also changed as a side effect.
1741 NOTE: Setting or resetting this option can have a lot of unexpected
1742 effects: Mappings are interpreted in another way, undo behaves
1743 differently, etc. If you set this option in your vimrc file, you
1744 should probably put it at the very start.
1745
Bram Moolenaar071d4272004-06-13 20:20:40 +00001746 By default this option is on and the Vi defaults are used for the
1747 options. This default was chosen for those people who want to use Vim
1748 just like Vi, and don't even (want to) know about the 'compatible'
1749 option.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001750 When a |vimrc| or |gvimrc| file is found while Vim is starting up,
Bram Moolenaard042c562005-06-30 22:04:15 +00001751 this option is switched off, and all options that have not been
1752 modified will be set to the Vim defaults. Effectively, this means
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001753 that when a |vimrc| or |gvimrc| file exists, Vim will use the Vim
Bram Moolenaard042c562005-06-30 22:04:15 +00001754 defaults, otherwise it will use the Vi defaults. (Note: This doesn't
Bram Moolenaar02467872007-05-06 13:22:01 +00001755 happen for the system-wide vimrc or gvimrc file, nor for a file given
1756 with the |-u| argument). Also see |compatible-default| and
1757 |posix-compliance|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001758 You can also set this option with the "-C" argument, and reset it with
1759 "-N". See |-C| and |-N|.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001760 See 'cpoptions' for more fine tuning of Vi compatibility.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001761
Bram Moolenaar214641f2017-03-05 17:04:09 +01001762 When this option is set, numerous other options are set to make Vim as
1763 Vi-compatible as possible. When this option is unset, various options
1764 are set to make Vim more useful. The table below lists all the
1765 options affected.
1766 The {?} column indicates when the options are affected:
1767 + Means that the option is set to the value given in {set value} when
1768 'compatible' is set.
1769 & Means that the option is set to the value given in {set value} when
1770 'compatible' is set AND is set to its Vim default value when
1771 'compatible' is unset.
1772 - Means the option is NOT changed when setting 'compatible' but IS
1773 set to its Vim default when 'compatible' is unset.
1774 The {effect} column summarises the change when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001775
Bram Moolenaar036986f2017-03-16 17:41:02 +01001776 option ? set value effect ~
Bram Moolenaar214641f2017-03-05 17:04:09 +01001777
1778 'allowrevins' + off no CTRL-_ command
1779 'antialias' + off don't use antialiased fonts
1780 'arabic' + off reset arabic-related options
1781 'arabicshape' + on correct character shapes
1782 'backspace' + "" normal backspace
1783 'backup' + off no backup file
1784 'backupcopy' & Unix: "yes" backup file is a copy
1785 else: "auto" copy or rename backup file
1786 'balloonexpr' + "" text to show in evaluation balloon
1787 'breakindent' + off don't indent when wrapping lines
1788 'cedit' - {unchanged} {set vim default only on resetting 'cp'}
1789 'cindent' + off no C code indentation
1790 'compatible' - {unchanged} {set vim default only on resetting 'cp'}
1791 'copyindent' + off don't copy indent structure
1792 'cpoptions' & (all flags) Vi-compatible flags
1793 'cscopepathcomp'+ 0 don't show directories in tags list
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01001794 'cscoperelative'+ off don't use basename of path as prefix
Bram Moolenaar214641f2017-03-05 17:04:09 +01001795 'cscopetag' + off don't use cscope for ":tag"
Bram Moolenaar036986f2017-03-16 17:41:02 +01001796 'cscopetagorder'+ 0 see |cscopetagorder|
Bram Moolenaar214641f2017-03-05 17:04:09 +01001797 'cscopeverbose' + off see |cscopeverbose|
1798 'delcombine' + off unicode: delete whole char combination
1799 'digraph' + off no digraphs
1800 'esckeys' & off no <Esc>-keys in Insert mode
1801 'expandtab' + off tabs not expanded to spaces
1802 'fileformats' & "" no automatic file format detection,
Bram Moolenaar6f345a12019-12-17 21:27:18 +01001803 "dos,unix" except for MS-Windows
Bram Moolenaar214641f2017-03-05 17:04:09 +01001804 'formatexpr' + "" use 'formatprg' for auto-formatting
1805 'formatoptions' & "vt" Vi compatible formatting
1806 'gdefault' + off no default 'g' flag for ":s"
1807 'history' & 0 no commandline history
1808 'hkmap' + off no Hebrew keyboard mapping
1809 'hkmapp' + off no phonetic Hebrew keyboard mapping
1810 'hlsearch' + off no highlighting of search matches
1811 'incsearch' + off no incremental searching
1812 'indentexpr' + "" no indenting by expression
1813 'insertmode' + off do not start in Insert mode
1814 'iskeyword' & "@,48-57,_" keywords contain alphanumeric
Bram Moolenaar071d4272004-06-13 20:20:40 +00001815 characters and '_'
Bram Moolenaar214641f2017-03-05 17:04:09 +01001816 'joinspaces' + on insert 2 spaces after period
1817 'modeline' & off no modelines
1818 'more' & off no pauses in listings
1819 'mzquantum' - {unchanged} {set vim default only on resetting 'cp'}
1820 'numberwidth' & 8 min number of columns for line number
1821 'preserveindent'+ off don't preserve current indent structure
1822 when changing it
1823 'revins' + off no reverse insert
1824 'ruler' + off no ruler
1825 'scrolljump' + 1 no jump scroll
1826 'scrolloff' + 0 no scroll offset
1827 'shelltemp' - {unchanged} {set vim default only on resetting 'cp'}
1828 'shiftround' + off indent not rounded to shiftwidth
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02001829 'shortmess' & "S" no shortening of messages
Bram Moolenaar214641f2017-03-05 17:04:09 +01001830 'showcmd' & off command characters not shown
1831 'showmode' & off current mode not shown
1832 'sidescrolloff' + 0 cursor moves to edge of screen in scroll
1833 'smartcase' + off no automatic ignore case switch
1834 'smartindent' + off no smart indentation
1835 'smarttab' + off no smart tab size
1836 'softtabstop' + 0 tabs are always 'tabstop' positions
1837 'startofline' + on goto startofline with some commands
1838 'tagcase' & "followic" 'ignorecase' when searching tags file
1839 'tagrelative' & off tag file names are not relative
1840 'termguicolors' + off don't use highlight-(guifg|guibg)
1841 'textauto' & off no automatic textmode detection
1842 'textwidth' + 0 no automatic line wrap
1843 'tildeop' + off tilde is not an operator
1844 'ttimeout' + off no terminal timeout
1845 'undofile' + off don't use an undo file
Bram Moolenaar036986f2017-03-16 17:41:02 +01001846 'viminfo' - {unchanged} {set Vim default only on resetting 'cp'}
Bram Moolenaar214641f2017-03-05 17:04:09 +01001847 'virtualedit' + "" cursor can only be placed on characters
1848 'whichwrap' & "" left-right movements don't wrap
1849 'wildchar' & CTRL-E only when the current value is <Tab>
Bram Moolenaar071d4272004-06-13 20:20:40 +00001850 use CTRL-E for cmdline completion
Bram Moolenaar214641f2017-03-05 17:04:09 +01001851 'writebackup' + on or off depends on the |+writebackup| feature
Bram Moolenaar071d4272004-06-13 20:20:40 +00001852
1853 *'complete'* *'cpt'* *E535*
1854'complete' 'cpt' string (default: ".,w,b,u,t,i")
1855 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001856 This option specifies how keyword completion |ins-completion| works
1857 when CTRL-P or CTRL-N are used. It is also used for whole-line
1858 completion |i_CTRL-X_CTRL-L|. It indicates the type of completion
1859 and the places to scan. It is a comma separated list of flags:
Bram Moolenaar3848e002016-03-19 18:42:29 +01001860 . scan the current buffer ('wrapscan' is ignored)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001861 w scan buffers from other windows
1862 b scan other loaded buffers that are in the buffer list
1863 u scan the unloaded buffers that are in the buffer list
1864 U scan the buffers that are not in the buffer list
1865 k scan the files given with the 'dictionary' option
Bram Moolenaar0b238792006-03-02 22:49:12 +00001866 kspell use the currently active spell checking |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001867 k{dict} scan the file {dict}. Several "k" flags can be given,
1868 patterns are valid too. For example: >
1869 :set cpt=k/usr/dict/*,k~/spanish
1870< s scan the files given with the 'thesaurus' option
1871 s{tsr} scan the file {tsr}. Several "s" flags can be given, patterns
1872 are valid too.
1873 i scan current and included files
1874 d scan current and included files for defined name or macro
1875 |i_CTRL-X_CTRL-D|
1876 ] tag completion
1877 t same as "]"
1878
1879 Unloaded buffers are not loaded, thus their autocmds |:autocmd| are
1880 not executed, this may lead to unexpected completions from some files
1881 (gzipped files for example). Unloaded buffers are not scanned for
1882 whole-line completion.
1883
1884 The default is ".,w,b,u,t,i", which means to scan:
1885 1. the current buffer
1886 2. buffers in other windows
1887 3. other loaded buffers
1888 4. unloaded buffers
1889 5. tags
1890 6. included files
1891
1892 As you can see, CTRL-N and CTRL-P can be used to do any 'iskeyword'-
Bram Moolenaar582fd852005-03-28 20:58:01 +00001893 based expansion (e.g., dictionary |i_CTRL-X_CTRL-K|, included patterns
1894 |i_CTRL-X_CTRL-I|, tags |i_CTRL-X_CTRL-]| and normal expansions).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001895
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001896 *'completefunc'* *'cfu'*
1897'completefunc' 'cfu' string (default: empty)
1898 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02001899 {not available when compiled without the |+eval|
Bram Moolenaare2c453d2019-08-21 14:37:09 +02001900 feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00001901 This option specifies a function to be used for Insert mode completion
1902 with CTRL-X CTRL-U. |i_CTRL-X_CTRL-U|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001903 See |complete-functions| for an explanation of how the function is
1904 invoked and what it should return.
Bram Moolenaar166af9b2010-11-16 20:34:40 +01001905 This option cannot be set from a |modeline| or in the |sandbox|, for
1906 security reasons.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00001907
Bram Moolenaarac3150d2019-07-28 16:36:39 +02001908 *'completeslash'* *'csl'*
1909'completeslash' 'csl' string (default: "")
1910 local to buffer
Bram Moolenaar2e693a82019-10-16 22:35:02 +02001911 {only for MS-Windows}
Bram Moolenaarac3150d2019-07-28 16:36:39 +02001912 When this option is set it overrules 'shellslash' for completion:
1913 - When this option is set to "slash", a forward slash is used for path
1914 completion in insert mode. This is useful when editing HTML tag, or
Bram Moolenaar6f345a12019-12-17 21:27:18 +01001915 Makefile with 'noshellslash' on MS-Windows.
Bram Moolenaarac3150d2019-07-28 16:36:39 +02001916 - When this option is set to "backslash", backslash is used. This is
Bram Moolenaar6f345a12019-12-17 21:27:18 +01001917 useful when editing a batch file with 'shellslash' set on MS-Windows.
Bram Moolenaarac3150d2019-07-28 16:36:39 +02001918 - When this option is empty, same character is used as for
1919 'shellslash'.
1920 For Insert mode completion the buffer-local value is used. For
1921 command line completion the global value is used.
1922
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001923 *'completeopt'* *'cot'*
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001924'completeopt' 'cot' string (default: "menu,preview")
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001925 global
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001926 A comma separated list of options for Insert mode completion
1927 |ins-completion|. The supported values are:
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001928
1929 menu Use a popup menu to show the possible completions. The
1930 menu is only shown when there is more than one match and
1931 sufficient colors are available. |ins-completion-menu|
1932
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001933 menuone Use the popup menu also when there is only one match.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00001934 Useful when there is additional information about the
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001935 match, e.g., what file it comes from.
1936
Bram Moolenaarc1e37902006-04-18 21:55:01 +00001937 longest Only insert the longest common text of the matches. If
1938 the menu is displayed you can use CTRL-L to add more
1939 characters. Whether case is ignored depends on the kind
1940 of completion. For buffer text the 'ignorecase' option is
1941 used.
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001942
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001943 preview Show extra information about the currently selected
Bram Moolenaar02467872007-05-06 13:22:01 +00001944 completion in the preview window. Only works in
1945 combination with "menu" or "menuone".
1946
Bram Moolenaar576a4a62019-08-18 15:25:17 +02001947 popup Show extra information about the currently selected
1948 completion in a popup window. Only works in combination
1949 with "menu" or "menuone". Overrides "preview".
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02001950 See |'completepopup'| for specifying properties.
Bram Moolenaar2e693a82019-10-16 22:35:02 +02001951 {only works when compiled with the |+textprop| feature}
Bram Moolenaar576a4a62019-08-18 15:25:17 +02001952
Bram Moolenaardca7abe2019-10-20 18:17:57 +02001953 popuphidden
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01001954 Just like "popup" but initially hide the popup. Use a
Bram Moolenaardca7abe2019-10-20 18:17:57 +02001955 |CompleteChanged| autocommand to fetch the info and call
1956 |popup_show()| once the popup has been filled.
1957 See the example at |complete-popuphidden|.
1958 {only works when compiled with the |+textprop| feature}
1959
Bram Moolenaarb6be1e22015-07-10 18:18:40 +02001960 noinsert Do not insert any text for a match until the user selects
1961 a match from the menu. Only works in combination with
1962 "menu" or "menuone". No effect if "longest" is present.
1963
1964 noselect Do not select a match in the menu, force the user to
1965 select one from the menu. Only works in combination with
1966 "menu" or "menuone".
1967
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001968
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02001969 *'completepopup'* *'cpp'*
1970'completepopup' 'cpp' string (default empty)
1971 global
1972 {not available when compiled without the |+textprop|
1973 or |+quickfix| feature}
1974 When 'completeopt' contains "popup" then this option is used for the
Bram Moolenaar447bfba2020-07-18 16:07:16 +02001975 properties of the info popup when it is created. If an info popup
1976 window already exists it is closed, so that the option value is
1977 applied when it is created again.
1978 You can also use |popup_findinfo()| and then set properties for an
1979 existing info popup with |popup_setoptions()|. See |complete-popup|.
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02001980
1981
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001982 *'concealcursor'* *'cocu'*
1983'concealcursor' 'cocu' string (default: "")
1984 local to window
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001985 {not available when compiled without the |+conceal|
1986 feature}
1987 Sets the modes in which text in the cursor line can also be concealed.
1988 When the current mode is listed then concealing happens just like in
1989 other lines.
1990 n Normal mode
1991 v Visual mode
1992 i Insert mode
Bram Moolenaarca8c9862010-07-24 15:00:38 +02001993 c Command line editing, for 'incsearch'
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001994
Bram Moolenaare6dc5732010-07-24 23:52:26 +02001995 'v' applies to all lines in the Visual area, not only the cursor.
Bram Moolenaarca8c9862010-07-24 15:00:38 +02001996 A useful value is "nc". This is used in help files. So long as you
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001997 are moving around text is concealed, but when starting to insert text
1998 or selecting a Visual area the concealed text is displayed, so that
1999 you can see what you are doing.
Bram Moolenaarf70e3d62010-07-24 13:15:07 +02002000 Keep in mind that the cursor position is not always where it's
2001 displayed. E.g., when moving vertically it may change column.
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002002
2003
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002004 *'conceallevel'* *'cole'*
2005'conceallevel' 'cole' number (default 0)
Bram Moolenaar860cae12010-06-05 23:22:07 +02002006 local to window
Bram Moolenaar860cae12010-06-05 23:22:07 +02002007 {not available when compiled without the |+conceal|
2008 feature}
Bram Moolenaar6df6f472010-07-18 18:04:50 +02002009 Determine how text with the "conceal" syntax attribute |:syn-conceal|
2010 is shown:
Bram Moolenaar860cae12010-06-05 23:22:07 +02002011
Bram Moolenaar6df6f472010-07-18 18:04:50 +02002012 Value Effect ~
Bram Moolenaar860cae12010-06-05 23:22:07 +02002013 0 Text is shown normally
Bram Moolenaar477db062010-07-28 18:17:41 +02002014 1 Each block of concealed text is replaced with one
2015 character. If the syntax item does not have a custom
2016 replacement character defined (see |:syn-cchar|) the
2017 character defined in 'listchars' is used (default is a
2018 space).
2019 It is highlighted with the "Conceal" highlight group.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002020 2 Concealed text is completely hidden unless it has a
2021 custom replacement character defined (see
Bram Moolenaar477db062010-07-28 18:17:41 +02002022 |:syn-cchar|).
Bram Moolenaara7781e02010-07-19 20:13:22 +02002023 3 Concealed text is completely hidden.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002024
Bram Moolenaara7781e02010-07-19 20:13:22 +02002025 Note: in the cursor line concealed text is not hidden, so that you can
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002026 edit and copy the text. This can be changed with the 'concealcursor'
2027 option.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002028
Bram Moolenaar071d4272004-06-13 20:20:40 +00002029 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
2030'confirm' 'cf' boolean (default off)
2031 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002032 When 'confirm' is on, certain operations that would normally
2033 fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
2034 instead raise a |dialog| asking if you wish to save the current
2035 file(s). You can still use a ! to unconditionally |abandon| a buffer.
2036 If 'confirm' is off you can still activate confirmation for one
2037 command only (this is most useful in mappings) with the |:confirm|
2038 command.
2039 Also see the |confirm()| function and the 'v' flag in 'guioptions'.
2040
2041 *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
2042'conskey' 'consk' boolean (default off)
2043 global
Bram Moolenaarf3913272016-02-25 00:00:01 +01002044 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002045
2046 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
2047'copyindent' 'ci' boolean (default off)
2048 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002049 Copy the structure of the existing lines indent when autoindenting a
2050 new line. Normally the new indent is reconstructed by a series of
2051 tabs followed by spaces as required (unless |'expandtab'| is enabled,
2052 in which case only spaces are used). Enabling this option makes the
2053 new line copy whatever characters were used for indenting on the
Bram Moolenaar446cb832008-06-24 21:56:24 +00002054 existing line. 'expandtab' has no effect on these characters, a Tab
2055 remains a Tab. If the new indent is greater than on the existing
Bram Moolenaar071d4272004-06-13 20:20:40 +00002056 line, the remaining space is filled in the normal manner.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002057 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002058 Also see 'preserveindent'.
2059
Bram Moolenaare0fa3742016-02-20 15:47:01 +01002060 *'cpoptions'* *'cpo'* *cpo*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002061'cpoptions' 'cpo' string (Vim default: "aABceFs",
2062 Vi default: all flags)
2063 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002064 A sequence of single character flags. When a character is present
Bram Moolenaar7cba6c02013-09-05 22:13:31 +02002065 this indicates Vi-compatible behavior. This is used for things where
2066 not being Vi-compatible is mostly or sometimes preferred.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002067 'cpoptions' stands for "compatible-options".
2068 Commas can be added for readability.
2069 To avoid problems with flags that are added in the future, use the
2070 "+=" and "-=" feature of ":set" |add-option-flags|.
2071 NOTE: This option is set to the Vi default value when 'compatible' is
2072 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002073 NOTE: This option is set to the POSIX default value at startup when
2074 the Vi default value would be used and the $VIM_POSIX environment
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002075 variable exists |posix|. This means Vim tries to behave like the
2076 POSIX specification.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002077
2078 contains behavior ~
2079 *cpo-a*
2080 a When included, a ":read" command with a file name
2081 argument will set the alternate file name for the
2082 current window.
2083 *cpo-A*
2084 A When included, a ":write" command with a file name
2085 argument will set the alternate file name for the
2086 current window.
2087 *cpo-b*
2088 b "\|" in a ":map" command is recognized as the end of
2089 the map command. The '\' is included in the mapping,
2090 the text after the '|' is interpreted as the next
2091 command. Use a CTRL-V instead of a backslash to
2092 include the '|' in the mapping. Applies to all
2093 mapping, abbreviation, menu and autocmd commands.
2094 See also |map_bar|.
2095 *cpo-B*
2096 B A backslash has no special meaning in mappings,
Bram Moolenaara9604e62018-07-21 05:56:22 +02002097 abbreviations, user commands and the "to" part of the
2098 menu commands. Remove this flag to be able to use a
2099 backslash like a CTRL-V. For example, the command
2100 ":map X \<Esc>" results in X being mapped to:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002101 'B' included: "\^[" (^[ is a real <Esc>)
2102 'B' excluded: "<Esc>" (5 characters)
2103 ('<' excluded in both cases)
2104 *cpo-c*
2105 c Searching continues at the end of any match at the
2106 cursor position, but not further than the start of the
2107 next line. When not present searching continues
2108 one character from the cursor position. With 'c'
2109 "abababababab" only gets three matches when repeating
2110 "/abab", without 'c' there are five matches.
2111 *cpo-C*
2112 C Do not concatenate sourced lines that start with a
2113 backslash. See |line-continuation|.
2114 *cpo-d*
2115 d Using "./" in the 'tags' option doesn't mean to use
2116 the tags file relative to the current file, but the
2117 tags file in the current directory.
2118 *cpo-D*
2119 D Can't use CTRL-K to enter a digraph after Normal mode
2120 commands with a character argument, like |r|, |f| and
2121 |t|.
2122 *cpo-e*
2123 e When executing a register with ":@r", always add a
2124 <CR> to the last line, also when the register is not
2125 linewise. If this flag is not present, the register
2126 is not linewise and the last line does not end in a
2127 <CR>, then the last line is put on the command-line
2128 and can be edited before hitting <CR>.
2129 *cpo-E*
2130 E It is an error when using "y", "d", "c", "g~", "gu" or
2131 "gU" on an Empty region. The operators only work when
Bram Moolenaar15142e22018-04-30 22:19:58 +02002132 at least one character is to be operated on. Example:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002133 This makes "y0" fail in the first column.
2134 *cpo-f*
2135 f When included, a ":read" command with a file name
2136 argument will set the file name for the current buffer,
2137 if the current buffer doesn't have a file name yet.
2138 *cpo-F*
2139 F When included, a ":write" command with a file name
2140 argument will set the file name for the current
2141 buffer, if the current buffer doesn't have a file name
Bram Moolenaarb3480382005-12-11 21:33:32 +00002142 yet. Also see |cpo-P|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002143 *cpo-g*
2144 g Goto line 1 when using ":edit" without argument.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002145 *cpo-H*
2146 H When using "I" on a line with only blanks, insert
2147 before the last blank. Without this flag insert after
2148 the last blank.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002149 *cpo-i*
2150 i When included, interrupting the reading of a file will
2151 leave it modified.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002152 *cpo-I*
2153 I When moving the cursor up or down just after inserting
2154 indent for 'autoindent', do not delete the indent.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002155 *cpo-j*
2156 j When joining lines, only add two spaces after a '.',
2157 not after '!' or '?'. Also see 'joinspaces'.
2158 *cpo-J*
2159 J A |sentence| has to be followed by two spaces after
Bram Moolenaar582fd852005-03-28 20:58:01 +00002160 the '.', '!' or '?'. A <Tab> is not recognized as
Bram Moolenaar071d4272004-06-13 20:20:40 +00002161 white space.
2162 *cpo-k*
2163 k Disable the recognition of raw key codes in
2164 mappings, abbreviations, and the "to" part of menu
2165 commands. For example, if <Key> sends ^[OA (where ^[
2166 is <Esc>), the command ":map X ^[OA" results in X
2167 being mapped to:
2168 'k' included: "^[OA" (3 characters)
2169 'k' excluded: "<Key>" (one key code)
2170 Also see the '<' flag below.
2171 *cpo-K*
2172 K Don't wait for a key code to complete when it is
2173 halfway a mapping. This breaks mapping <F1><F1> when
2174 only part of the second <F1> has been read. It
2175 enables cancelling the mapping by typing <F1><Esc>.
2176 *cpo-l*
2177 l Backslash in a [] range in a search pattern is taken
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002178 literally, only "\]", "\^", "\-" and "\\" are special.
2179 See |/[]|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002180 'l' included: "/[ \t]" finds <Space>, '\' and 't'
2181 'l' excluded: "/[ \t]" finds <Space> and <Tab>
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002182 Also see |cpo-\|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002183 *cpo-L*
2184 L When the 'list' option is set, 'wrapmargin',
2185 'textwidth', 'softtabstop' and Virtual Replace mode
2186 (see |gR|) count a <Tab> as two characters, instead of
2187 the normal behavior of a <Tab>.
2188 *cpo-m*
2189 m When included, a showmatch will always wait half a
2190 second. When not included, a showmatch will wait half
2191 a second or until a character is typed. |'showmatch'|
2192 *cpo-M*
2193 M When excluded, "%" matching will take backslashes into
2194 account. Thus in "( \( )" and "\( ( \)" the outer
2195 parenthesis match. When included "%" ignores
2196 backslashes, which is Vi compatible.
2197 *cpo-n*
Bram Moolenaar64486672010-05-16 15:46:46 +02002198 n When included, the column used for 'number' and
2199 'relativenumber' will also be used for text of wrapped
2200 lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002201 *cpo-o*
2202 o Line offset to search command is not remembered for
2203 next search.
2204 *cpo-O*
2205 O Don't complain if a file is being overwritten, even
2206 when it didn't exist when editing it. This is a
2207 protection against a file unexpectedly created by
2208 someone else. Vi didn't complain about this.
2209 *cpo-p*
2210 p Vi compatible Lisp indenting. When not present, a
2211 slightly better algorithm is used.
Bram Moolenaarb3480382005-12-11 21:33:32 +00002212 *cpo-P*
2213 P When included, a ":write" command that appends to a
2214 file will set the file name for the current buffer, if
2215 the current buffer doesn't have a file name yet and
2216 the 'F' flag is also included |cpo-F|.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002217 *cpo-q*
2218 q When joining multiple lines leave the cursor at the
2219 position where it would be when joining two lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002220 *cpo-r*
2221 r Redo ("." command) uses "/" to repeat a search
2222 command, instead of the actually used search string.
2223 *cpo-R*
2224 R Remove marks from filtered lines. Without this flag
2225 marks are kept like |:keepmarks| was used.
2226 *cpo-s*
2227 s Set buffer options when entering the buffer for the
2228 first time. This is like it is in Vim version 3.0.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002229 And it is the default. If not present the options are
Bram Moolenaar071d4272004-06-13 20:20:40 +00002230 set when the buffer is created.
2231 *cpo-S*
2232 S Set buffer options always when entering a buffer
2233 (except 'readonly', 'fileformat', 'filetype' and
2234 'syntax'). This is the (most) Vi compatible setting.
2235 The options are set to the values in the current
2236 buffer. When you change an option and go to another
2237 buffer, the value is copied. Effectively makes the
2238 buffer options global to all buffers.
2239
2240 's' 'S' copy buffer options
2241 no no when buffer created
2242 yes no when buffer first entered (default)
2243 X yes each time when buffer entered (vi comp.)
2244 *cpo-t*
2245 t Search pattern for the tag command is remembered for
2246 "n" command. Otherwise Vim only puts the pattern in
2247 the history for search pattern, but doesn't change the
2248 last used search pattern.
2249 *cpo-u*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002250 u Undo is Vi compatible. See |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002251 *cpo-v*
2252 v Backspaced characters remain visible on the screen in
2253 Insert mode. Without this flag the characters are
2254 erased from the screen right away. With this flag the
2255 screen newly typed text overwrites backspaced
2256 characters.
2257 *cpo-w*
2258 w When using "cw" on a blank character, only change one
2259 character and not all blanks until the start of the
2260 next word.
2261 *cpo-W*
2262 W Don't overwrite a readonly file. When omitted, ":w!"
2263 overwrites a readonly file, if possible.
2264 *cpo-x*
2265 x <Esc> on the command-line executes the command-line.
2266 The default in Vim is to abandon the command-line,
2267 because <Esc> normally aborts a command. |c_<Esc>|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002268 *cpo-X*
2269 X When using a count with "R" the replaced text is
2270 deleted only once. Also when repeating "R" with "."
2271 and a count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002272 *cpo-y*
Bram Moolenaard09091d2019-01-17 16:07:22 +01002273 y A yank command can be redone with ".". Think twice if
2274 you really want to use this, it may break some
2275 plugins, since most people expect "." to only repeat a
2276 change.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002277 *cpo-Z*
2278 Z When using "w!" while the 'readonly' option is set,
2279 don't reset 'readonly'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002280 *cpo-!*
2281 ! When redoing a filter command, use the last used
2282 external command, whatever it was. Otherwise the last
2283 used -filter- command is used.
2284 *cpo-$*
2285 $ When making a change to one line, don't redisplay the
2286 line, but put a '$' at the end of the changed text.
2287 The changed text will be overwritten when you type the
2288 new text. The line is redisplayed if you type any
2289 command that moves the cursor from the insertion
2290 point.
2291 *cpo-%*
2292 % Vi-compatible matching is done for the "%" command.
2293 Does not recognize "#if", "#endif", etc.
2294 Does not recognize "/*" and "*/".
2295 Parens inside single and double quotes are also
2296 counted, causing a string that contains a paren to
2297 disturb the matching. For example, in a line like
2298 "if (strcmp("foo(", s))" the first paren does not
2299 match the last one. When this flag is not included,
2300 parens inside single and double quotes are treated
2301 specially. When matching a paren outside of quotes,
2302 everything inside quotes is ignored. When matching a
2303 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002304 there is one). This works very well for C programs.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002305 This flag is also used for other features, such as
2306 C-indenting.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002307 *cpo--*
2308 - When included, a vertical movement command fails when
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002309 it would go above the first line or below the last
2310 line. Without it the cursor moves to the first or
2311 last line, unless it already was in that line.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002312 Applies to the commands "-", "k", CTRL-P, "+", "j",
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002313 CTRL-N, CTRL-J and ":1234".
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002314 *cpo-+*
2315 + When included, a ":write file" command will reset the
2316 'modified' flag of the buffer, even though the buffer
2317 itself may still be different from its file.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002318 *cpo-star*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002319 * Use ":*" in the same way as ":@". When not included,
2320 ":*" is an alias for ":'<,'>", select the Visual area.
2321 *cpo-<*
2322 < Disable the recognition of special key codes in |<>|
2323 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002324 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00002325 ":map X <Tab>" results in X being mapped to:
2326 '<' included: "<Tab>" (5 characters)
2327 '<' excluded: "^I" (^I is a real <Tab>)
2328 Also see the 'k' flag above.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002329 *cpo->*
2330 > When appending to a register, put a line break before
2331 the appended text.
Bram Moolenaar8b3e0332011-06-26 05:36:34 +02002332 *cpo-;*
2333 ; When using |,| or |;| to repeat the last |t| search
2334 and the cursor is right in front of the searched
2335 character, the cursor won't move. When not included,
2336 the cursor would skip over it and jump to the
Bram Moolenaarc8734422012-06-01 22:38:45 +02002337 following occurrence.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002338
2339 POSIX flags. These are not included in the Vi default value, except
2340 when $VIM_POSIX was set on startup. |posix|
2341
2342 contains behavior ~
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002343 *cpo-#*
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002344 # A count before "D", "o" and "O" has no effect.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002345 *cpo-&*
2346 & When ":preserve" was used keep the swap file when
2347 exiting normally while this buffer is still loaded.
2348 This flag is tested when exiting.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002349 *cpo-\*
2350 \ Backslash in a [] range in a search pattern is taken
2351 literally, only "\]" is special See |/[]|
Bram Moolenaar90915b52005-08-21 22:17:52 +00002352 '\' included: "/[ \-]" finds <Space>, '\' and '-'
2353 '\' excluded: "/[ \-]" finds <Space> and '-'
2354 Also see |cpo-l|.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002355 *cpo-/*
2356 / When "%" is used as the replacement string in a |:s|
2357 command, use the previous replacement string. |:s%|
2358 *cpo-{*
2359 { The |{| and |}| commands also stop at a "{" character
2360 at the start of a line.
2361 *cpo-.*
2362 . The ":chdir" and ":cd" commands fail if the current
2363 buffer is modified, unless ! is used. Vim doesn't
2364 need this, since it remembers the full path of an
2365 opened file.
2366 *cpo-bar*
2367 | The value of the $LINES and $COLUMNS environment
2368 variables overrule the terminal size values obtained
2369 with system specific functions.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002370
Bram Moolenaar071d4272004-06-13 20:20:40 +00002371
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002372 *'cryptmethod'* *'cm'*
Bram Moolenaara86187b2018-12-16 18:20:00 +01002373'cryptmethod' 'cm' string (default "blowfish2")
Bram Moolenaar49771f42010-07-20 17:32:38 +02002374 global or local to buffer |global-local|
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002375 Method used for encryption when the buffer is written to a file:
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002376 *pkzip*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002377 zip PkZip compatible method. A weak kind of encryption.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002378 Backwards compatible with Vim 7.2 and older.
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002379 *blowfish*
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002380 blowfish Blowfish method. Medium strong encryption but it has
2381 an implementation flaw. Requires Vim 7.3 or later,
2382 files can NOT be read by Vim 7.2 and older. This adds
2383 a "seed" to the file, every time you write the file
2384 the encrypted bytes will be different.
2385 *blowfish2*
2386 blowfish2 Blowfish method. Medium strong encryption. Requires
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01002387 Vim 7.4.401 or later, files can NOT be read by Vim 7.3
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002388 and older. This adds a "seed" to the file, every time
2389 you write the file the encrypted bytes will be
2390 different. The whole undo file is encrypted, not just
2391 the pieces of text.
Christian Brabandtf573c6e2021-06-20 14:02:16 +02002392 *E1193* *E1194* *E1195* *E1196*
2393 *E1197* *E1198* *E1199* *E1200* *E1201*
2394 xchacha20 XChaCha20 Cipher with Poly1305 Message Authentication
2395 Code. Medium strong till strong encryption.
2396 Encryption is provided by the libsodium library, it
2397 requires Vim to be built with |+sodium|
2398 It adds a seed and a message authentication code (MAC)
2399 to the file. This needs at least a Vim 8.2.3022 to
2400 read the encrypted file.
2401 Encryption of swap files is not supported, therefore
2402 no swap file will be used when xchacha20 encryption is
2403 enabled.
2404 Encryption of undo files is not yet supported,
2405 therefore no undo file will currently be written.
2406 CURRENTLY EXPERIMENTAL: Files written with this method
2407 might have to be read back with the same version of
2408 Vim if the binary format changes later.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002409
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01002410 You should use "blowfish2", also to re-encrypt older files.
2411
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002412 When reading an encrypted file 'cryptmethod' will be set automatically
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002413 to the detected method of the file being read. Thus if you write it
2414 without changing 'cryptmethod' the same method will be used.
2415 Changing 'cryptmethod' does not mark the file as modified, you have to
Bram Moolenaar49771f42010-07-20 17:32:38 +02002416 explicitly write it, you don't get a warning unless there are other
2417 modifications. Also see |:X|.
2418
2419 When setting the global value to an empty string, it will end up with
Bram Moolenaara86187b2018-12-16 18:20:00 +01002420 the value "blowfish2". When setting the local value to an empty
2421 string the buffer will use the global value.
Bram Moolenaar49771f42010-07-20 17:32:38 +02002422
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002423 When a new encryption method is added in a later version of Vim, and
2424 the current version does not recognize it, you will get *E821* .
Bram Moolenaar49771f42010-07-20 17:32:38 +02002425 You need to edit this file with the later version of Vim.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002426
2427
Bram Moolenaar071d4272004-06-13 20:20:40 +00002428 *'cscopepathcomp'* *'cspc'*
2429'cscopepathcomp' 'cspc' number (default 0)
2430 global
2431 {not available when compiled without the |+cscope|
2432 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002433 Determines how many components of the path to show in a list of tags.
2434 See |cscopepathcomp|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002435 NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002436
2437 *'cscopeprg'* *'csprg'*
2438'cscopeprg' 'csprg' string (default "cscope")
2439 global
2440 {not available when compiled without the |+cscope|
2441 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002442 Specifies the command to execute cscope. See |cscopeprg|.
2443 This option cannot be set from a |modeline| or in the |sandbox|, for
2444 security reasons.
2445
2446 *'cscopequickfix'* *'csqf'*
2447'cscopequickfix' 'csqf' string (default "")
2448 global
2449 {not available when compiled without the |+cscope|
2450 or |+quickfix| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002451 Specifies whether to use quickfix window to show cscope results.
2452 See |cscopequickfix|.
2453
Bram Moolenaarec7944a2013-06-12 21:29:15 +02002454 *'cscoperelative'* *'csre'* *'nocscoperelative'* *'nocsre'*
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002455'cscoperelative' 'csre' boolean (default off)
2456 global
2457 {not available when compiled without the |+cscope|
2458 feature}
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002459 In the absence of a prefix (-P) for cscope. setting this option enables
2460 to use the basename of cscope.out path as the prefix.
2461 See |cscoperelative|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002462 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002463
Bram Moolenaar071d4272004-06-13 20:20:40 +00002464 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
2465'cscopetag' 'cst' boolean (default off)
2466 global
2467 {not available when compiled without the |+cscope|
2468 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002469 Use cscope for tag commands. See |cscope-options|.
2470 NOTE: This option is reset when 'compatible' is set.
2471
2472 *'cscopetagorder'* *'csto'*
2473'cscopetagorder' 'csto' number (default 0)
2474 global
2475 {not available when compiled without the |+cscope|
2476 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002477 Determines the order in which ":cstag" performs a search. See
2478 |cscopetagorder|.
2479 NOTE: This option is set to 0 when 'compatible' is set.
2480
2481 *'cscopeverbose'* *'csverb'*
2482 *'nocscopeverbose'* *'nocsverb'*
2483'cscopeverbose' 'csverb' boolean (default off)
2484 global
2485 {not available when compiled without the |+cscope|
2486 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002487 Give messages when adding a cscope database. See |cscopeverbose|.
2488 NOTE: This option is reset when 'compatible' is set.
2489
Bram Moolenaar860cae12010-06-05 23:22:07 +02002490 *'cursorbind'* *'crb'* *'nocursorbind'* *'nocrb'*
2491'cursorbind' 'crb' boolean (default off)
2492 local to window
Bram Moolenaar860cae12010-06-05 23:22:07 +02002493 When this option is set, as the cursor in the current
2494 window moves other cursorbound windows (windows that also have
2495 this option set) move their cursors to the corresponding line and
2496 column. This option is useful for viewing the
2497 differences between two versions of a file (see 'diff'); in diff mode,
2498 inserted and deleted lines (though not characters within a line) are
Bram Moolenaar1a384422010-07-14 19:53:30 +02002499 taken into account.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002500
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002501
2502 *'cursorcolumn'* *'cuc'* *'nocursorcolumn'* *'nocuc'*
2503'cursorcolumn' 'cuc' boolean (default off)
2504 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02002505 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002506 feature}
2507 Highlight the screen column of the cursor with CursorColumn
2508 |hl-CursorColumn|. Useful to align text. Will make screen redrawing
2509 slower.
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00002510 If you only want the highlighting in the current window you can use
2511 these autocommands: >
2512 au WinLeave * set nocursorline nocursorcolumn
2513 au WinEnter * set cursorline cursorcolumn
2514<
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002515
2516 *'cursorline'* *'cul'* *'nocursorline'* *'nocul'*
2517'cursorline' 'cul' boolean (default off)
2518 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02002519 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002520 feature}
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002521 Highlight the text line of the cursor with CursorLine |hl-CursorLine|.
2522 Useful to easily spot the cursor. Will make screen redrawing slower.
Bram Moolenaare2f98b92006-03-29 21:18:24 +00002523 When Visual mode is active the highlighting isn't used to make it
Bram Moolenaar779b74b2006-04-10 14:55:34 +00002524 easier to see the selected text.
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002525
2526
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002527 *'cursorlineopt'* *'culopt'*
Bram Moolenaar017ba072019-09-14 21:01:23 +02002528'cursorlineopt' 'culopt' string (default: "number,line")
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002529 local to window
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002530 {not available when compiled without the |+syntax|
2531 feature}
Bram Moolenaar017ba072019-09-14 21:01:23 +02002532 Comma separated list of settings for how 'cursorline' is displayed.
2533 Valid values:
2534 "line" Highlight the text line of the cursor with
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002535 CursorLine |hl-CursorLine|.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002536 "screenline" Highlight only the screen line of the cursor with
2537 CursorLine |hl-CursorLine|.
2538 "number" Highlight the line number of the cursor with
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002539 CursorLineNr |hl-CursorLineNr|.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002540
2541 Special value:
2542 "both" Alias for the values "line,number".
2543
2544 "line" and "screenline" cannot be used together.
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002545
2546
Bram Moolenaar071d4272004-06-13 20:20:40 +00002547 *'debug'*
2548'debug' string (default "")
2549 global
Bram Moolenaar57657d82006-04-21 22:12:41 +00002550 These values can be used:
2551 msg Error messages that would otherwise be omitted will be given
2552 anyway.
2553 throw Error messages that would otherwise be omitted will be given
2554 anyway and also throw an exception and set |v:errmsg|.
2555 beep A message will be given when otherwise only a beep would be
2556 produced.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002557 The values can be combined, separated by a comma.
Bram Moolenaar57657d82006-04-21 22:12:41 +00002558 "msg" and "throw" are useful for debugging 'foldexpr', 'formatexpr' or
2559 'indentexpr'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002560
2561 *'define'* *'def'*
2562'define' 'def' string (default "^\s*#\s*define")
2563 global or local to buffer |global-local|
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002564 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002565 pattern, just like for the "/" command. This option is used for the
2566 commands like "[i" and "[d" |include-search|. The 'isident' option is
2567 used to recognize the defined name after the match:
2568 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2569 See |option-backslash| about inserting backslashes to include a space
2570 or backslash.
2571 The default value is for C programs. For C++ this value would be
2572 useful, to include const type declarations: >
2573 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
Bram Moolenaar63b74a82019-03-24 15:09:13 +01002574< You can also use "\ze" just before the name and continue the pattern
2575 to check what is following. E.g. for Javascript, if a function is
2576 defined with "func_name = function(args)": >
2577 ^\s*\ze\i\+\s*=\s*function(
2578< If the function is defined with "func_name : function() {...": >
2579 ^\s*\ze\i\+\s*[:]\s*(*function\s*(
Bram Moolenaar071d4272004-06-13 20:20:40 +00002580< When using the ":set" command, you need to double the backslashes!
Bram Moolenaar63b74a82019-03-24 15:09:13 +01002581 To avoid that use `:let` with a single quote string: >
2582 let &l:define = '^\s*\ze\k\+\s*=\s*function('
Bram Moolenaar911ead12019-04-21 00:03:35 +02002583<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002584
2585 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2586'delcombine' 'deco' boolean (default off)
2587 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002588 If editing Unicode and this option is set, backspace and Normal mode
2589 "x" delete each combining character on its own. When it is off (the
2590 default) the character along with its combining characters are
2591 deleted.
Bram Moolenaar4f4d51a2020-10-11 13:57:40 +02002592 Note: When 'delcombine' is set "xx" may work differently from "2x"!
Bram Moolenaar071d4272004-06-13 20:20:40 +00002593
2594 This is useful for Arabic, Hebrew and many other languages where one
2595 may have combining characters overtop of base characters, and want
2596 to remove only the combining ones.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002597 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002598
2599 *'dictionary'* *'dict'*
2600'dictionary' 'dict' string (default "")
2601 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002602 List of file names, separated by commas, that are used to lookup words
2603 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2604 contain a list of words. This can be one word per line, or several
2605 words per line, separated by non-keyword characters (white space is
2606 preferred). Maximum line length is 510 bytes.
Bram Moolenaar259f26a2018-05-15 22:25:40 +02002607
2608 When this option is empty or an entry "spell" is present, and spell
2609 checking is enabled, words in the word lists for the currently active
2610 'spelllang' are used. See |spell|.
2611
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002612 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002613 after a comma are ignored, otherwise spaces are included in the file
2614 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002615 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002616 Where to find a list of words?
2617 - On FreeBSD, there is the file "/usr/share/dict/words".
2618 - In the Simtel archive, look in the "msdos/linguist" directory.
2619 - In "miscfiles" of the GNU collection.
2620 The use of |:set+=| and |:set-=| is preferred when adding or removing
2621 directories from the list. This avoids problems when a future version
2622 uses another default.
2623 Backticks cannot be used in this option for security reasons.
2624
2625 *'diff'* *'nodiff'*
2626'diff' boolean (default off)
2627 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00002628 {not available when compiled without the |+diff|
2629 feature}
2630 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002631 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002632
2633 *'dex'* *'diffexpr'*
2634'diffexpr' 'dex' string (default "")
2635 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002636 {not available when compiled without the |+diff|
2637 feature}
Bram Moolenaare828b762018-09-10 17:51:58 +02002638 Expression which is evaluated to obtain a diff file (either ed-style
2639 or unified-style) from two versions of a file. See |diff-diffexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002640 This option cannot be set from a |modeline| or in the |sandbox|, for
2641 security reasons.
2642
2643 *'dip'* *'diffopt'*
Bram Moolenaarc8234772019-11-10 21:00:27 +01002644'diffopt' 'dip' string (default "internal,filler,closeoff")
Bram Moolenaar071d4272004-06-13 20:20:40 +00002645 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002646 {not available when compiled without the |+diff|
2647 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002648 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002649 All are optional. Items must be separated by a comma.
2650
2651 filler Show filler lines, to keep the text
2652 synchronized with a window that has inserted
2653 lines at the same position. Mostly useful
2654 when windows are side-by-side and 'scrollbind'
2655 is set.
2656
2657 context:{n} Use a context of {n} lines between a change
2658 and a fold that contains unchanged lines.
2659 When omitted a context of six lines is used.
Bram Moolenaarf6b40102019-02-22 15:24:03 +01002660 When using zero the context is actually one,
2661 since folds require a line in between, also
2662 for a deleted line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002663 See |fold-diff|.
2664
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002665 iblank Ignore changes where lines are all blank. Adds
2666 the "-B" flag to the "diff" command if
2667 'diffexpr' is empty. Check the documentation
2668 of the "diff" command for what this does
2669 exactly.
2670 NOTE: the diff windows will get out of sync,
2671 because no differences between blank lines are
2672 taken into account.
2673
Bram Moolenaar071d4272004-06-13 20:20:40 +00002674 icase Ignore changes in case of text. "a" and "A"
2675 are considered the same. Adds the "-i" flag
2676 to the "diff" command if 'diffexpr' is empty.
2677
2678 iwhite Ignore changes in amount of white space. Adds
2679 the "-b" flag to the "diff" command if
2680 'diffexpr' is empty. Check the documentation
2681 of the "diff" command for what this does
2682 exactly. It should ignore adding trailing
2683 white space, but not leading white space.
2684
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002685 iwhiteall Ignore all white space changes. Adds
2686 the "-w" flag to the "diff" command if
2687 'diffexpr' is empty. Check the documentation
2688 of the "diff" command for what this does
2689 exactly.
2690
2691 iwhiteeol Ignore white space changes at end of line.
2692 Adds the "-Z" flag to the "diff" command if
2693 'diffexpr' is empty. Check the documentation
2694 of the "diff" command for what this does
2695 exactly.
2696
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002697 horizontal Start diff mode with horizontal splits (unless
2698 explicitly specified otherwise).
2699
2700 vertical Start diff mode with vertical splits (unless
2701 explicitly specified otherwise).
2702
Bram Moolenaarc8234772019-11-10 21:00:27 +01002703 closeoff When a window is closed where 'diff' is set
2704 and there is only one window remaining in the
2705 same tab page with 'diff' set, execute
2706 `:diffoff` in that window. This undoes a
2707 `:diffsplit` command.
2708
Bram Moolenaar97ce4192017-12-01 20:35:58 +01002709 hiddenoff Do not use diff mode for a buffer when it
2710 becomes hidden.
2711
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002712 foldcolumn:{n} Set the 'foldcolumn' option to {n} when
2713 starting diff mode. Without this 2 is used.
2714
Bram Moolenaar4223d432021-02-10 13:18:17 +01002715 followwrap Follow the 'wrap' option and leave as it is.
2716
Bram Moolenaare828b762018-09-10 17:51:58 +02002717 internal Use the internal diff library. This is
2718 ignored when 'diffexpr' is set. *E960*
2719 When running out of memory when writing a
2720 buffer this item will be ignored for diffs
2721 involving that buffer. Set the 'verbose'
2722 option to see when this happens.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002723
Bram Moolenaare828b762018-09-10 17:51:58 +02002724 indent-heuristic
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01002725 Use the indent heuristic for the internal
2726 diff library.
Bram Moolenaare828b762018-09-10 17:51:58 +02002727
2728 algorithm:{text} Use the specified diff algorithm with the
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01002729 internal diff engine. Currently supported
Bram Moolenaare828b762018-09-10 17:51:58 +02002730 algorithms are:
2731 myers the default algorithm
2732 minimal spend extra time to generate the
2733 smallest possible diff
2734 patience patience diff algorithm
2735 histogram histogram diff algorithm
2736
2737 Examples: >
2738 :set diffopt=internal,filler,context:4
Bram Moolenaar071d4272004-06-13 20:20:40 +00002739 :set diffopt=
Bram Moolenaare828b762018-09-10 17:51:58 +02002740 :set diffopt=internal,filler,foldcolumn:3
2741 :set diffopt-=internal " do NOT use the internal diff parser
Bram Moolenaar071d4272004-06-13 20:20:40 +00002742<
2743 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
2744'digraph' 'dg' boolean (default off)
2745 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002746 {not available when compiled without the |+digraphs|
2747 feature}
2748 Enable the entering of digraphs in Insert mode with {char1} <BS>
2749 {char2}. See |digraphs|.
2750 NOTE: This option is reset when 'compatible' is set.
2751
2752 *'directory'* *'dir'*
2753'directory' 'dir' string (default for Amiga: ".,t:",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01002754 for Win32: ".,$TEMP,c:\tmp,c:\temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00002755 for Unix: ".,~/tmp,/var/tmp,/tmp")
2756 global
2757 List of directory names for the swap file, separated with commas.
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02002758 Recommended value: ".,~/vimswap//" - this will put the swap file next
2759 to the edited file if possible, and in your personal swap directory
2760 otherwise. Make sure "~/vimswap//" is only readable for you.
2761
2762 Possible items:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002763 - The swap file will be created in the first directory where this is
2764 possible.
2765 - Empty means that no swap file will be used (recovery is
Bram Moolenaar00e192b2019-10-19 17:01:28 +02002766 impossible!) and no |E303| error will be given.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002767 - A directory "." means to put the swap file in the same directory as
2768 the edited file. On Unix, a dot is prepended to the file name, so
2769 it doesn't show in a directory listing. On MS-Windows the "hidden"
2770 attribute is set and a dot prepended if possible.
Bram Moolenaar8024f932020-01-14 19:29:13 +01002771 - A directory starting with "./" (or ".\" for MS-Windows) means to put
2772 the swap file relative to where the edited file is. The leading "."
2773 is replaced with the path name of the edited file.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02002774 - For Unix and Win32, if a directory ends in two path separators "//",
2775 the swap file name will be built from the complete path to the file
Bram Moolenaar207f0092020-08-30 17:20:20 +02002776 with all path separators replaced by percent '%' signs (including
2777 the colon following the drive letter on Win32). This will ensure
2778 file name uniqueness in the preserve directory.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02002779 On Win32, it is also possible to end with "\\". However, When a
2780 separating comma is following, you must use "//", since "\\" will
2781 include the comma in the file name. Therefore it is recommended to
2782 use '//', instead of '\\'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002783 - Spaces after the comma are ignored, other spaces are considered part
2784 of the directory name. To have a space at the start of a directory
2785 name, precede it with a backslash.
2786 - To include a comma in a directory name precede it with a backslash.
2787 - A directory name may end in an ':' or '/'.
2788 - Environment variables are expanded |:set_env|.
2789 - Careful with '\' characters, type one before a space, type two to
2790 get one in the option (see |option-backslash|), for example: >
2791 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
2792< - For backwards compatibility with Vim version 3.0 a '>' at the start
2793 of the option is removed.
2794 Using "." first in the list is recommended. This means that editing
2795 the same file twice will result in a warning. Using "/tmp" on Unix is
2796 discouraged: When the system crashes you lose the swap file.
2797 "/var/tmp" is often not cleared when rebooting, thus is a better
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02002798 choice than "/tmp". But others on the computer may be able to see the
2799 files, and it can contain a lot of files, your swap files get lost in
2800 the crowd. That is why a "tmp" directory in your home directory is
2801 tried first.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002802 The use of |:set+=| and |:set-=| is preferred when adding or removing
2803 directories from the list. This avoids problems when a future version
2804 uses another default.
2805 This option cannot be set from a |modeline| or in the |sandbox|, for
2806 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002807
2808 *'display'* *'dy'*
Bram Moolenaarbc8801c2016-08-02 21:04:33 +02002809'display' 'dy' string (default "", set to "truncate" in
2810 |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002811 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002812 Change the way text is displayed. This is comma separated list of
2813 flags:
2814 lastline When included, as much as possible of the last line
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02002815 in a window will be displayed. "@@@" is put in the
2816 last columns of the last screen line to indicate the
2817 rest of the line is not displayed.
2818 truncate Like "lastline", but "@@@" is displayed in the first
2819 column of the last screen line. Overrules "lastline".
Bram Moolenaar071d4272004-06-13 20:20:40 +00002820 uhex Show unprintable characters hexadecimal as <xx>
2821 instead of using ^C and ~C.
2822
Bram Moolenaard0796902016-09-16 20:02:31 +02002823 When neither "lastline" nor "truncate" is included, a last line that
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02002824 doesn't fit is replaced with "@" lines.
2825
Bram Moolenaar071d4272004-06-13 20:20:40 +00002826 *'eadirection'* *'ead'*
2827'eadirection' 'ead' string (default "both")
2828 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002829 Tells when the 'equalalways' option applies:
2830 ver vertically, width of windows is not affected
2831 hor horizontally, height of windows is not affected
2832 both width and height of windows is affected
2833
2834 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
2835'edcompatible' 'ed' boolean (default off)
2836 global
2837 Makes the 'g' and 'c' flags of the ":substitute" command to be
2838 toggled each time the flag is given. See |complex-change|. See
2839 also 'gdefault' option.
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +02002840 Switching this option on may break plugins!
Bram Moolenaar4072ba52020-12-23 13:56:35 +01002841 This option is not used in |Vim9| script.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002842
Bram Moolenaar03413f42016-04-12 21:07:15 +02002843 *'emoji'* *'emo'* *'noemoji'* *'noemo'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01002844'emoji' 'emo' boolean (default: on)
2845 global
Bram Moolenaar3848e002016-03-19 18:42:29 +01002846 When on all Unicode emoji characters are considered to be full width.
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02002847 This excludes "text emoji" characters, which are normally displayed as
2848 single width. Unfortunately there is no good specification for this
2849 and it has been determined on trial-and-error basis. Use the
2850 |setcellwidths()| function to change the behavior.
Bram Moolenaar3848e002016-03-19 18:42:29 +01002851
Bram Moolenaar071d4272004-06-13 20:20:40 +00002852 *'encoding'* *'enc'* *E543*
K.Takataf883d902021-05-30 18:04:19 +02002853'encoding' 'enc' string (default for MS-Windows: "utf-8",
2854 otherwise: value from $LANG or "latin1")
Bram Moolenaar071d4272004-06-13 20:20:40 +00002855 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002856 Sets the character encoding used inside Vim. It applies to text in
2857 the buffers, registers, Strings in expressions, text stored in the
2858 viminfo file, etc. It sets the kind of characters which Vim can work
2859 with. See |encoding-names| for the possible values.
2860
2861 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002862 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002863 It should normally be kept at its default value, or set when Vim
Bram Moolenaar02467872007-05-06 13:22:01 +00002864 starts up. See |multibyte|. To reload the menus see |:menutrans|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002865
Bram Moolenaar865242e2010-07-14 21:12:05 +02002866 This option cannot be set from a |modeline|. It would most likely
2867 corrupt the text.
2868
Bram Moolenaar3df01732017-02-17 22:47:16 +01002869 NOTE: For GTK+ 2 or later, it is highly recommended to set 'encoding'
2870 to "utf-8". Although care has been taken to allow different values of
Bram Moolenaar071d4272004-06-13 20:20:40 +00002871 'encoding', "utf-8" is the natural choice for the environment and
2872 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002873 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00002874 versions, and to avoid changing the encoding of newly created files
2875 without your knowledge (in case 'fileencodings' is empty).
2876
2877 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002878 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00002879 iconv() or as specified with 'charconvert'.
2880
Bram Moolenaar207f0092020-08-30 17:20:20 +02002881 If you need to know whether 'encoding' is a multibyte encoding, you
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002882 can use: >
2883 if has("multi_byte_encoding")
2884<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002885 Normally 'encoding' will be equal to your current locale. This will
2886 be the default if Vim recognizes your environment settings. If
2887 'encoding' is not set to the current locale, 'termencoding' must be
2888 set to convert typed and displayed text. See |encoding-table|.
2889
2890 When you set this option, it fires the |EncodingChanged| autocommand
2891 event so that you can set up fonts if necessary.
2892
2893 When the option is set, the value is converted to lowercase. Thus
2894 you can set it with uppercase values too. Underscores are translated
2895 to '-' signs.
2896 When the encoding is recognized, it is changed to the standard name.
2897 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
2898 "iso-8859-2" and "utf8" becomes "utf-8".
2899
2900 Note: "latin1" is also used when the encoding could not be detected.
2901 This only works when editing files in the same encoding! When the
2902 actual character set is not latin1, make sure 'fileencoding' and
2903 'fileencodings' are empty. When conversion is needed, switch to using
2904 utf-8.
2905
2906 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
2907 You don't notice this while editing, but it does matter for the
2908 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
2909 setting 'encoding' to one of these values instead of utf-8 only has
2910 effect for encoding used for files when 'fileencoding' is empty.
2911
Bram Moolenaar661b1822005-07-28 22:36:45 +00002912 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
2913 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002914
2915 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
2916'endofline' 'eol' boolean (default on)
2917 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002918 When writing a file and this option is off and the 'binary' option
Bram Moolenaar34d72d42015-07-17 14:18:08 +02002919 is on, or 'fixeol' option is off, no <EOL> will be written for the
2920 last line in the file. This option is automatically set or reset when
2921 starting to edit a new file, depending on whether file has an <EOL>
2922 for the last line in the file. Normally you don't have to set or
2923 reset this option.
2924 When 'binary' is off and 'fixeol' is on the value is not used when
2925 writing the file. When 'binary' is on or 'fixeol' is off it is used
2926 to remember the presence of a <EOL> for the last line in the file, so
2927 that when you write the file the situation from the original file can
2928 be kept. But you can change it if you want to.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002929
2930 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
2931'equalalways' 'ea' boolean (default on)
2932 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002933 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00002934 splitting or closing a window. This also happens the moment the
2935 option is switched on. When off, splitting a window will reduce the
2936 size of the current window and leave the other windows the same. When
2937 closing a window the extra lines are given to the window next to it
2938 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00002939 When mixing vertically and horizontally split windows, a minimal size
2940 is computed and some windows may be larger if there is room. The
2941 'eadirection' option tells in which direction the size is affected.
Bram Moolenaar67f71312007-08-12 14:55:56 +00002942 Changing the height and width of a window can be avoided by setting
2943 'winfixheight' and 'winfixwidth', respectively.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002944 If a window size is specified when creating a new window sizes are
2945 currently not equalized (it's complicated, but may be implemented in
2946 the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002947
2948 *'equalprg'* *'ep'*
2949'equalprg' 'ep' string (default "")
2950 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002951 External program to use for "=" command. When this option is empty
Bram Moolenaar446cb832008-06-24 21:56:24 +00002952 the internal formatting functions are used; either 'lisp', 'cindent'
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002953 or 'indentexpr'. When Vim was compiled without internal formatting,
2954 the "indent" program is used.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002955 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002956 about including spaces and backslashes.
2957 This option cannot be set from a |modeline| or in the |sandbox|, for
2958 security reasons.
2959
2960 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
2961'errorbells' 'eb' boolean (default off)
2962 global
2963 Ring the bell (beep or screen flash) for error messages. This only
2964 makes a difference for error messages, the bell will be used always
2965 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002966 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar165bc692015-07-21 17:53:25 +02002967 screen flash or do nothing. See 'belloff' to finetune when to ring the
2968 bell.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002969
2970 *'errorfile'* *'ef'*
2971'errorfile' 'ef' string (Amiga default: "AztecC.Err",
2972 others: "errors.err")
2973 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002974 {not available when compiled without the |+quickfix|
2975 feature}
2976 Name of the errorfile for the QuickFix mode (see |:cf|).
2977 When the "-q" command-line argument is used, 'errorfile' is set to the
2978 following argument. See |-q|.
2979 NOT used for the ":make" command. See 'makeef' for that.
2980 Environment variables are expanded |:set_env|.
2981 See |option-backslash| about including spaces and backslashes.
2982 This option cannot be set from a |modeline| or in the |sandbox|, for
2983 security reasons.
2984
2985 *'errorformat'* *'efm'*
2986'errorformat' 'efm' string (default is very long)
2987 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002988 {not available when compiled without the |+quickfix|
2989 feature}
2990 Scanf-like description of the format for the lines in the error file
2991 (see |errorformat|).
2992
2993 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
2994'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
2995 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002996 Function keys that start with an <Esc> are recognized in Insert
2997 mode. When this option is off, the cursor and function keys cannot be
2998 used in Insert mode if they start with an <Esc>. The advantage of
2999 this is that the single <Esc> is recognized immediately, instead of
3000 after one second. Instead of resetting this option, you might want to
3001 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
3002 when 'esckeys' is off, you can still map anything, but the cursor keys
3003 won't work by default.
3004 NOTE: This option is set to the Vi default value when 'compatible' is
3005 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaarc8234772019-11-10 21:00:27 +01003006 NOTE: when this option is off then the |modifyOtherKeys| functionality
3007 is disabled while in Insert mode to avoid ending Insert mode with any
3008 key that has a modifier.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003009
3010 *'eventignore'* *'ei'*
3011'eventignore' 'ei' string (default "")
3012 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003013 A list of autocommand event names, which are to be ignored.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00003014 When set to "all" or when "all" is one of the items, all autocommand
3015 events are ignored, autocommands will not be executed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003016 Otherwise this is a comma separated list of event names. Example: >
3017 :set ei=WinEnter,WinLeave
3018<
3019 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
3020'expandtab' 'et' boolean (default off)
3021 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003022 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003023 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00003024 when 'autoindent' is on. To insert a real tab when 'expandtab' is
3025 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
Bram Moolenaarca635012015-09-25 20:34:21 +02003026 This option is reset when the 'paste' option is set and restored when
3027 the 'paste' option is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003028 NOTE: This option is reset when 'compatible' is set.
3029
3030 *'exrc'* *'ex'* *'noexrc'* *'noex'*
3031'exrc' 'ex' boolean (default off)
3032 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003033 Enables the reading of .vimrc, .exrc and .gvimrc in the current
Bram Moolenaar36f44c22016-08-28 18:17:20 +02003034 directory.
3035
3036 Setting this option is a potential security leak. E.g., consider
3037 unpacking a package or fetching files from github, a .vimrc in there
3038 might be a trojan horse. BETTER NOT SET THIS OPTION!
3039 Instead, define an autocommand in your .vimrc to set options for a
3040 matching directory.
3041
3042 If you do switch this option on you should also consider setting the
3043 'secure' option (see |initialization|).
3044 Also see |.vimrc| and |gui-init|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003045 This option cannot be set from a |modeline| or in the |sandbox|, for
3046 security reasons.
3047
3048 *'fileencoding'* *'fenc'* *E213*
3049'fileencoding' 'fenc' string (default: "")
3050 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003051 Sets the character encoding for the file of this buffer.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003052
Bram Moolenaar071d4272004-06-13 20:20:40 +00003053 When 'fileencoding' is different from 'encoding', conversion will be
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003054 done when writing the file. For reading see below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003055 When 'fileencoding' is empty, the same value as 'encoding' will be
3056 used (no conversion when reading or writing a file).
Bram Moolenaar214641f2017-03-05 17:04:09 +01003057 No error will be given when the value is set, only when it is used,
3058 only when writing a file.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003059 Conversion will also be done when 'encoding' and 'fileencoding' are
3060 both a Unicode encoding and 'fileencoding' is not utf-8. That's
3061 because internally Unicode is always stored as utf-8.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003062 WARNING: Conversion can cause loss of information! When
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003063 'encoding' is "utf-8" or another Unicode encoding, conversion
3064 is most likely done in a way that the reverse conversion
3065 results in the same text. When 'encoding' is not "utf-8" some
3066 characters may be lost!
Bram Moolenaar865242e2010-07-14 21:12:05 +02003067
Bram Moolenaar071d4272004-06-13 20:20:40 +00003068 See 'encoding' for the possible values. Additionally, values may be
3069 specified that can be handled by the converter, see
3070 |mbyte-conversion|.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003071
Bram Moolenaar071d4272004-06-13 20:20:40 +00003072 When reading a file 'fileencoding' will be set from 'fileencodings'.
3073 To read a file in a certain encoding it won't work by setting
Bram Moolenaar02467872007-05-06 13:22:01 +00003074 'fileencoding', use the |++enc| argument. One exception: when
3075 'fileencodings' is empty the value of 'fileencoding' is used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003076 For a new file the global value of 'fileencoding' is used.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003077
Bram Moolenaar071d4272004-06-13 20:20:40 +00003078 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
3079 When the option is set, the value is converted to lowercase. Thus
3080 you can set it with uppercase values too. '_' characters are
3081 replaced with '-'. If a name is recognized from the list for
3082 'encoding', it is replaced by the standard name. For example
3083 "ISO8859-2" becomes "iso-8859-2".
Bram Moolenaar865242e2010-07-14 21:12:05 +02003084
Bram Moolenaar071d4272004-06-13 20:20:40 +00003085 When this option is set, after starting to edit a file, the 'modified'
3086 option is set, because the file would be different when written.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003087
3088 Keep in mind that changing 'fenc' from a modeline happens
3089 AFTER the text has been read, thus it applies to when the file will be
3090 written. If you do set 'fenc' in a modeline, you might want to set
3091 'nomodified' to avoid not being able to ":q".
3092
Bram Moolenaar071d4272004-06-13 20:20:40 +00003093 This option can not be changed when 'modifiable' is off.
3094
3095 *'fe'*
3096 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003097 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003098 old short name was 'fe', which is no longer used.
3099
3100 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003101'fileencodings' 'fencs' string (default: "ucs-bom",
3102 "ucs-bom,utf-8,default,latin1" when
3103 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003104 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003105 This is a list of character encodings considered when starting to edit
3106 an existing file. When a file is read, Vim tries to use the first
3107 mentioned character encoding. If an error is detected, the next one
3108 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003109 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00003110 an empty string, which means the value of 'encoding' is used.
3111 WARNING: Conversion can cause loss of information! When
3112 'encoding' is "utf-8" (or one of the other Unicode variants)
3113 conversion is most likely done in a way that the reverse
3114 conversion results in the same text. When 'encoding' is not
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003115 "utf-8" some non-ASCII characters may be lost! You can use
3116 the |++bad| argument to specify what is done with characters
3117 that can't be converted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003118 For an empty file or a file with only ASCII characters most encodings
3119 will work and the first entry of 'fileencodings' will be used (except
3120 "ucs-bom", which requires the BOM to be present). If you prefer
3121 another encoding use an BufReadPost autocommand event to test if your
3122 preferred encoding is to be used. Example: >
3123 au BufReadPost * if search('\S', 'w') == 0 |
3124 \ set fenc=iso-2022-jp | endif
3125< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
3126 non-blank characters.
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003127 When the |++enc| argument is used then the value of 'fileencodings' is
3128 not used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003129 Note that 'fileencodings' is not used for a new file, the global value
3130 of 'fileencoding' is used instead. You can set it with: >
3131 :setglobal fenc=iso-8859-2
3132< This means that a non-existing file may get a different encoding than
3133 an empty file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003134 The special value "ucs-bom" can be used to check for a Unicode BOM
3135 (Byte Order Mark) at the start of the file. It must not be preceded
3136 by "utf-8" or another Unicode encoding for this to work properly.
3137 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
3138 because Vim cannot detect an error, thus the encoding is always
3139 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003140 The special value "default" can be used for the encoding from the
K.Takataef8706f2021-05-31 18:40:49 +02003141 environment. On MS-Windows this is the system encoding. Otherwise
3142 this is the default value for 'encoding'. It is useful when
3143 'encoding' is set to "utf-8" and your environment uses a non-latin1
3144 encoding, such as Russian.
Bram Moolenaarca003e12006-03-17 23:19:38 +00003145 When 'encoding' is "utf-8" and a file contains an illegal byte
3146 sequence it won't be recognized as UTF-8. You can use the |8g8|
3147 command to find the illegal byte sequence.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003148 WRONG VALUES: WHAT'S WRONG:
3149 latin1,utf-8 "latin1" will always be used
3150 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
3151 file
3152 cp1250,latin1 "cp1250" will always be used
3153 If 'fileencodings' is empty, 'fileencoding' is not modified.
3154 See 'fileencoding' for the possible values.
3155 Setting this option does not have an effect until the next time a file
3156 is read.
3157
3158 *'fileformat'* *'ff'*
Bram Moolenaar00590742019-02-15 21:06:09 +01003159'fileformat' 'ff' string (MS-Windows default: "dos",
3160 Unix, macOS default: "unix")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003161 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003162 This gives the <EOL> of the current buffer, which is used for
3163 reading/writing the buffer from/to a file:
Bram Moolenaar4072ba52020-12-23 13:56:35 +01003164 dos <CR><NL>
Bram Moolenaar071d4272004-06-13 20:20:40 +00003165 unix <NL>
3166 mac <CR>
3167 When "dos" is used, CTRL-Z at the end of a file is ignored.
3168 See |file-formats| and |file-read|.
3169 For the character encoding of the file see 'fileencoding'.
3170 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
Bram Moolenaarbf884932013-04-05 22:26:15 +02003171 works like it was set to "unix".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003172 This option is set automatically when starting to edit a file and
3173 'fileformats' is not empty and 'binary' is off.
3174 When this option is set, after starting to edit a file, the 'modified'
3175 option is set, because the file would be different when written.
3176 This option can not be changed when 'modifiable' is off.
3177 For backwards compatibility: When this option is set to "dos",
3178 'textmode' is set, otherwise 'textmode' is reset.
3179
3180 *'fileformats'* *'ffs'*
3181'fileformats' 'ffs' string (default:
Bram Moolenaar00590742019-02-15 21:06:09 +01003182 Vim+Vi MS-Windows: "dos,unix",
3183 Vim Unix, macOS: "unix,dos",
Bram Moolenaar071d4272004-06-13 20:20:40 +00003184 Vi Cygwin: "unix,dos",
3185 Vi others: "")
3186 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003187 This gives the end-of-line (<EOL>) formats that will be tried when
3188 starting to edit a new buffer and when reading a file into an existing
3189 buffer:
3190 - When empty, the format defined with 'fileformat' will be used
3191 always. It is not set automatically.
3192 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003193 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003194 'fileformats' name will be used when a file is read into an existing
3195 buffer, no matter what 'fileformat' for that buffer is set to.
3196 - When more than one name is present, separated by commas, automatic
3197 <EOL> detection will be done when reading a file. When starting to
3198 edit a file, a check is done for the <EOL>:
3199 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
3200 'fileformat' is set to "dos".
3201 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003202 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003203 preceding <CR>, "unix" is preferred over "dos".
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01003204 3. If 'fileformat' has not yet been set, and if a <CR> is found, and
3205 if 'fileformats' includes "mac", 'fileformat' is set to "mac".
Bram Moolenaar00659062010-09-21 22:34:02 +02003206 This means that "mac" is only chosen when:
3207 "unix" is not present or no <NL> is found in the file, and
3208 "dos" is not present or no <CR><NL> is found in the file.
3209 Except: if "unix" was chosen, but there is a <CR> before
3210 the first <NL>, and there appear to be more <CR>s than <NL>s in
Bram Moolenaar166af9b2010-11-16 20:34:40 +01003211 the first few lines, "mac" is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003212 4. If 'fileformat' is still not set, the first name from
3213 'fileformats' is used.
3214 When reading a file into an existing buffer, the same is done, but
3215 this happens like 'fileformat' has been set appropriately for that
3216 file only, the option is not changed.
3217 When 'binary' is set, the value of 'fileformats' is not used.
3218
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01003219 When Vim starts up with an empty buffer the first item is used. You
3220 can overrule this by setting 'fileformat' in your .vimrc.
Bram Moolenaar81af9252010-12-10 20:35:50 +01003221
Bram Moolenaar071d4272004-06-13 20:20:40 +00003222 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
3223 are ":source"ed and for vimrc files, automatic <EOL> detection may be
3224 done:
3225 - When 'fileformats' is empty, there is no automatic detection. Dos
3226 format will be used.
3227 - When 'fileformats' is set to one or more names, automatic detection
3228 is done. This is based on the first <NL> in the file: If there is a
3229 <CR> in front of it, Dos format is used, otherwise Unix format is
3230 used.
3231 Also see |file-formats|.
3232 For backwards compatibility: When this option is set to an empty
3233 string or one format (no comma is included), 'textauto' is reset,
3234 otherwise 'textauto' is set.
3235 NOTE: This option is set to the Vi default value when 'compatible' is
3236 set and to the Vim default value when 'compatible' is reset.
3237
Bram Moolenaarbf884932013-04-05 22:26:15 +02003238 *'fileignorecase'* *'fic'* *'nofileignorecase'* *'nofic'*
3239'fileignorecase' 'fic' boolean (default on for systems where case in file
3240 names is normally ignored)
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003241 global
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003242 When set case is ignored when using file names and directories.
3243 See 'wildignorecase' for only ignoring case when doing completion.
3244
Bram Moolenaar071d4272004-06-13 20:20:40 +00003245 *'filetype'* *'ft'*
3246'filetype' 'ft' string (default: "")
3247 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003248 When this option is set, the FileType autocommand event is triggered.
3249 All autocommands that match with the value of this option will be
3250 executed. Thus the value of 'filetype' is used in place of the file
3251 name.
3252 Otherwise this option does not always reflect the current file type.
3253 This option is normally set when the file type is detected. To enable
3254 this use the ":filetype on" command. |:filetype|
3255 Setting this option to a different value is most useful in a modeline,
3256 for a file for which the file type is not automatically recognized.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003257 Example, for in an IDL file:
3258 /* vim: set filetype=idl : */ ~
3259 |FileType| |filetypes|
3260 When a dot appears in the value then this separates two filetype
3261 names. Example:
3262 /* vim: set filetype=c.doxygen : */ ~
3263 This will use the "c" filetype first, then the "doxygen" filetype.
3264 This works both for filetype plugins and for syntax files. More than
3265 one dot may appear.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003266 This option is not copied to another buffer, independent of the 's' or
3267 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003268 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003269
3270 *'fillchars'* *'fcs'*
Bram Moolenaara98f8a22021-02-13 18:24:23 +01003271'fillchars' 'fcs' string (default "vert:|,fold:-,eob:~")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003272 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02003273 {not available when compiled without the |+folding|
3274 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003275 Characters to fill the statuslines and vertical separators.
3276 It is a comma separated list of items:
3277
3278 item default Used for ~
3279 stl:c ' ' or '^' statusline of the current window
Bram Moolenaar38a55632016-02-15 22:07:32 +01003280 stlnc:c ' ' or '=' statusline of the non-current windows
Bram Moolenaar071d4272004-06-13 20:20:40 +00003281 vert:c '|' vertical separators |:vsplit|
3282 fold:c '-' filling 'foldtext'
Bram Moolenaar3aca5a62021-02-17 13:14:07 +01003283 foldopen:c '-' mark the beginning of a fold
3284 foldclose:c '+' show a closed fold
3285 foldsep:c '|' open fold middle character
Bram Moolenaar071d4272004-06-13 20:20:40 +00003286 diff:c '-' deleted lines of the 'diff' option
Bram Moolenaara98f8a22021-02-13 18:24:23 +01003287 eob:c '~' empty lines below the end of a buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003288
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003289 Any one that is omitted will fall back to the default. For "stl" and
Bram Moolenaar38a55632016-02-15 22:07:32 +01003290 "stlnc" the space will be used when there is highlighting, '^' or '='
Bram Moolenaar071d4272004-06-13 20:20:40 +00003291 otherwise.
3292
3293 Example: >
Bram Moolenaar38a55632016-02-15 22:07:32 +01003294 :set fillchars=stl:^,stlnc:=,vert:\|,fold:-,diff:-
Bram Moolenaar071d4272004-06-13 20:20:40 +00003295< This is similar to the default, except that these characters will also
3296 be used when there is highlighting.
3297
Bram Moolenaar008bff92021-03-04 21:55:58 +01003298 For "stl" and "stlnc" single-byte and multibyte characters are
3299 supported. But double-width characters are not supported.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003300
Bram Moolenaar071d4272004-06-13 20:20:40 +00003301 The highlighting used for these items:
3302 item highlight group ~
3303 stl:c StatusLine |hl-StatusLine|
3304 stlnc:c StatusLineNC |hl-StatusLineNC|
3305 vert:c VertSplit |hl-VertSplit|
3306 fold:c Folded |hl-Folded|
3307 diff:c DiffDelete |hl-DiffDelete|
Bram Moolenaara98f8a22021-02-13 18:24:23 +01003308 eob:c EndOfBuffer |hl-EndOfBuffer|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003309
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003310 *'fixendofline'* *'fixeol'* *'nofixendofline'* *'nofixeol'*
3311'fixendofline' 'fixeol' boolean (default on)
3312 local to buffer
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003313 When writing a file and this option is on, <EOL> at the end of file
3314 will be restored if missing. Turn this option off if you want to
3315 preserve the situation from the original file.
3316 When the 'binary' option is set the value of this option doesn't
3317 matter.
3318 See the 'endofline' option.
3319
Bram Moolenaar071d4272004-06-13 20:20:40 +00003320 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
Bram Moolenaar98a29d02021-01-18 19:55:44 +01003321'fkmap' 'fk' boolean (default off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003322 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003323 {only available when compiled with the |+rightleft|
3324 feature}
Bram Moolenaar14184a32019-02-16 15:10:30 +01003325 This option was for using Farsi, which has been removed. See
3326 |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003327
3328 *'foldclose'* *'fcl'*
3329'foldclose' 'fcl' string (default "")
3330 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003331 {not available when compiled without the |+folding|
3332 feature}
3333 When set to "all", a fold is closed when the cursor isn't in it and
3334 its level is higher than 'foldlevel'. Useful if you want folds to
3335 automatically close when moving out of them.
3336
3337 *'foldcolumn'* *'fdc'*
3338'foldcolumn' 'fdc' number (default 0)
3339 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003340 {not available when compiled without the |+folding|
3341 feature}
3342 When non-zero, a column with the specified width is shown at the side
3343 of the window which indicates open and closed folds. The maximum
3344 value is 12.
3345 See |folding|.
3346
3347 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
3348'foldenable' 'fen' boolean (default on)
3349 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003350 {not available when compiled without the |+folding|
3351 feature}
3352 When off, all folds are open. This option can be used to quickly
3353 switch between showing all text unfolded and viewing the text with
3354 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003355 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00003356 'foldenable' is off.
3357 This option is set by commands that create a new fold or close a fold.
3358 See |folding|.
3359
3360 *'foldexpr'* *'fde'*
3361'foldexpr' 'fde' string (default: "0")
3362 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003363 {not available when compiled without the |+folding|
Bram Moolenaardb84e452010-08-15 13:50:43 +02003364 or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003365 The expression used for when 'foldmethod' is "expr". It is evaluated
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003366 for each line to obtain its fold level. See |fold-expr|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003367
Bram Moolenaar30b65812012-07-12 22:01:11 +02003368 The expression will be evaluated in the |sandbox| if set from a
3369 modeline, see |sandbox-option|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003370 This option can't be set from a |modeline| when the 'diff' option is
Bram Moolenaar110289e2019-05-23 15:38:06 +02003371 on or the 'modelineexpr' option is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003372
3373 It is not allowed to change text or jump to another window while
3374 evaluating 'foldexpr' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003375
3376 *'foldignore'* *'fdi'*
3377'foldignore' 'fdi' string (default: "#")
3378 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003379 {not available when compiled without the |+folding|
3380 feature}
3381 Used only when 'foldmethod' is "indent". Lines starting with
3382 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003383 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003384 The default "#" works well for C programs. See |fold-indent|.
3385
3386 *'foldlevel'* *'fdl'*
3387'foldlevel' 'fdl' number (default: 0)
3388 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003389 {not available when compiled without the |+folding|
3390 feature}
3391 Sets the fold level: Folds with a higher level will be closed.
3392 Setting this option to zero will close all folds. Higher numbers will
3393 close fewer folds.
3394 This option is set by commands like |zm|, |zM| and |zR|.
3395 See |fold-foldlevel|.
3396
3397 *'foldlevelstart'* *'fdls'*
3398'foldlevelstart' 'fdls' number (default: -1)
3399 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003400 {not available when compiled without the |+folding|
3401 feature}
3402 Sets 'foldlevel' when starting to edit another buffer in a window.
3403 Useful to always start editing with all folds closed (value zero),
3404 some folds closed (one) or no folds closed (99).
3405 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003406 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00003407 ignores this option and closes all folds.
3408 It is also done before BufReadPre autocommands, to allow an autocmd to
3409 overrule the 'foldlevel' value for specific files.
3410 When the value is negative, it is not used.
3411
3412 *'foldmarker'* *'fmr'* *E536*
3413'foldmarker' 'fmr' string (default: "{{{,}}}")
3414 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003415 {not available when compiled without the |+folding|
3416 feature}
3417 The start and end marker used when 'foldmethod' is "marker". There
3418 must be one comma, which separates the start and end marker. The
3419 marker is a literal string (a regular expression would be too slow).
3420 See |fold-marker|.
3421
3422 *'foldmethod'* *'fdm'*
3423'foldmethod' 'fdm' string (default: "manual")
3424 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003425 {not available when compiled without the |+folding|
3426 feature}
3427 The kind of folding used for the current window. Possible values:
3428 |fold-manual| manual Folds are created manually.
3429 |fold-indent| indent Lines with equal indent form a fold.
3430 |fold-expr| expr 'foldexpr' gives the fold level of a line.
3431 |fold-marker| marker Markers are used to specify folds.
3432 |fold-syntax| syntax Syntax highlighting items specify folds.
3433 |fold-diff| diff Fold text that is not changed.
3434
3435 *'foldminlines'* *'fml'*
3436'foldminlines' 'fml' number (default: 1)
3437 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003438 {not available when compiled without the |+folding|
3439 feature}
Bram Moolenaar00654022011-02-25 14:42:19 +01003440 Sets the number of screen lines above which a fold can be displayed
3441 closed. Also for manually closed folds. With the default value of
3442 one a fold can only be closed if it takes up two or more screen lines.
3443 Set to zero to be able to close folds of just one screen line.
Bram Moolenaar446beb42011-05-10 17:18:44 +02003444 Note that this only has an effect on what is displayed. After using
Bram Moolenaar071d4272004-06-13 20:20:40 +00003445 "zc" to close a fold, which is displayed open because it's smaller
3446 than 'foldminlines', a following "zc" may close a containing fold.
3447
3448 *'foldnestmax'* *'fdn'*
3449'foldnestmax' 'fdn' number (default: 20)
3450 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003451 {not available when compiled without the |+folding|
3452 feature}
3453 Sets the maximum nesting of folds for the "indent" and "syntax"
3454 methods. This avoids that too many folds will be created. Using more
3455 than 20 doesn't work, because the internal limit is 20.
3456
3457 *'foldopen'* *'fdo'*
3458'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
3459 search,tag,undo")
3460 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003461 {not available when compiled without the |+folding|
3462 feature}
3463 Specifies for which type of commands folds will be opened, if the
3464 command moves the cursor into a closed fold. It is a comma separated
3465 list of items.
Bram Moolenaar05365702010-10-27 18:34:44 +02003466 NOTE: When the command is part of a mapping this option is not used.
3467 Add the |zv| command to the mapping to get the same effect.
3468 (rationale: the mapping may want to control opening folds itself)
3469
Bram Moolenaar071d4272004-06-13 20:20:40 +00003470 item commands ~
3471 all any
3472 block "(", "{", "[[", "[{", etc.
3473 hor horizontal movements: "l", "w", "fx", etc.
3474 insert any command in Insert mode
3475 jump far jumps: "G", "gg", etc.
3476 mark jumping to a mark: "'m", CTRL-O, etc.
3477 percent "%"
3478 quickfix ":cn", ":crew", ":make", etc.
3479 search search for a pattern: "/", "n", "*", "gd", etc.
3480 (not for a search pattern in a ":" command)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003481 Also for |[s| and |]s|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003482 tag jumping to a tag: ":ta", CTRL-T, etc.
3483 undo undo or redo: "u" and CTRL-R
Bram Moolenaar071d4272004-06-13 20:20:40 +00003484 When a movement command is used for an operator (e.g., "dl" or "y%")
3485 this option is not used. This means the operator will include the
3486 whole closed fold.
3487 Note that vertical movements are not here, because it would make it
3488 very difficult to move onto a closed fold.
3489 In insert mode the folds containing the cursor will always be open
3490 when text is inserted.
3491 To close folds you can re-apply 'foldlevel' with the |zx| command or
3492 set the 'foldclose' option to "all".
3493
3494 *'foldtext'* *'fdt'*
3495'foldtext' 'fdt' string (default: "foldtext()")
3496 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003497 {not available when compiled without the |+folding|
3498 feature}
3499 An expression which is used to specify the text displayed for a closed
3500 fold. See |fold-foldtext|.
3501
Bram Moolenaar30b65812012-07-12 22:01:11 +02003502 The expression will be evaluated in the |sandbox| if set from a
3503 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003504 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003505
3506 It is not allowed to change text or jump to another window while
3507 evaluating 'foldtext' |textlock|.
3508
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003509 *'formatexpr'* *'fex'*
3510'formatexpr' 'fex' string (default "")
3511 local to buffer
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003512 {not available when compiled without the |+eval|
3513 feature}
3514 Expression which is evaluated to format a range of lines for the |gq|
3515 operator or automatic formatting (see 'formatoptions'). When this
3516 option is empty 'formatprg' is used.
3517
3518 The |v:lnum| variable holds the first line to be formatted.
3519 The |v:count| variable holds the number of lines to be formatted.
3520 The |v:char| variable holds the character that is going to be
3521 inserted if the expression is being evaluated due to
3522 automatic formatting. This can be empty. Don't insert
3523 it yet!
3524
3525 Example: >
3526 :set formatexpr=mylang#Format()
3527< This will invoke the mylang#Format() function in the
3528 autoload/mylang.vim file in 'runtimepath'. |autoload|
3529
3530 The expression is also evaluated when 'textwidth' is set and adding
3531 text beyond that limit. This happens under the same conditions as
3532 when internal formatting is used. Make sure the cursor is kept in the
3533 same spot relative to the text then! The |mode()| function will
3534 return "i" or "R" in this situation.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01003535
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003536 When the expression evaluates to non-zero Vim will fall back to using
3537 the internal format mechanism.
3538
3539 The expression will be evaluated in the |sandbox| when set from a
3540 modeline, see |sandbox-option|. That stops the option from working,
3541 since changing the buffer text is not allowed.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003542 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaar036986f2017-03-16 17:41:02 +01003543 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003544
Bram Moolenaar86b68352004-12-27 21:59:20 +00003545 *'formatlistpat'* *'flp'*
3546'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
3547 local to buffer
Bram Moolenaar86b68352004-12-27 21:59:20 +00003548 A pattern that is used to recognize a list header. This is used for
3549 the "n" flag in 'formatoptions'.
3550 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00003551 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00003552 while still checking more characters. There must be a character
3553 following the pattern, when it matches the whole line it is handled
3554 like there is no match.
3555 The default recognizes a number, followed by an optional punctuation
3556 character and white space.
3557
Bram Moolenaar6c60f472019-04-28 16:00:35 +02003558 *'formatoptions'* *'fo'*
3559'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
3560 local to buffer
3561 This is a sequence of letters which describes how automatic
3562 formatting is to be done. See |fo-table|. When the 'paste' option is
3563 on, no formatting is done (like 'formatoptions' is empty). Commas can
3564 be inserted for readability.
3565 To avoid problems with flags that are added in the future, use the
3566 "+=" and "-=" feature of ":set" |add-option-flags|.
3567 NOTE: This option is set to the Vi default value when 'compatible' is
3568 set and to the Vim default value when 'compatible' is reset.
3569
Bram Moolenaar071d4272004-06-13 20:20:40 +00003570 *'formatprg'* *'fp'*
3571'formatprg' 'fp' string (default "")
Bram Moolenaar9be7c042017-01-14 14:28:30 +01003572 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003573 The name of an external program that will be used to format the lines
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003574 selected with the |gq| operator. The program must take the input on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003575 stdin and produce the output on stdout. The Unix program "fmt" is
Bram Moolenaara5792f52005-11-23 21:25:05 +00003576 such a program.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003577 If the 'formatexpr' option is not empty it will be used instead.
3578 Otherwise, if 'formatprg' option is an empty string, the internal
3579 format function will be used |C-indenting|.
Bram Moolenaara5792f52005-11-23 21:25:05 +00003580 Environment variables are expanded |:set_env|. See |option-backslash|
3581 about including spaces and backslashes.
Bram Moolenaar30b65812012-07-12 22:01:11 +02003582 This option cannot be set from a |modeline| or in the |sandbox|, for
3583 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003584
Bram Moolenaard94464e2015-11-02 15:28:18 +01003585 *'fsync'* *'fs'* *'nofsync'* *'nofs'*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003586'fsync' 'fs' boolean (default on)
3587 global
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003588 When on, the library function fsync() will be called after writing a
3589 file. This will flush a file to disk, ensuring that it is safely
3590 written even on filesystems which do metadata-only journaling. This
3591 will force the harddrive to spin up on Linux systems running in laptop
3592 mode, so it may be undesirable in some situations. Be warned that
3593 turning this off increases the chances of data loss after a crash. On
3594 systems without an fsync() implementation, this variable is always
3595 off.
3596 Also see 'swapsync' for controlling fsync() on swap files.
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003597 'fsync' also applies to |writefile()|, unless a flag is used to
3598 overrule it.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003599 This option cannot be set from a |modeline| or in the |sandbox|, for
3600 security reasons.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003601
Bram Moolenaar071d4272004-06-13 20:20:40 +00003602 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
3603'gdefault' 'gd' boolean (default off)
3604 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003605 When on, the ":substitute" flag 'g' is default on. This means that
3606 all matches in a line are substituted instead of one. When a 'g' flag
3607 is given to a ":substitute" command, this will toggle the substitution
3608 of all or one match. See |complex-change|.
3609
3610 command 'gdefault' on 'gdefault' off ~
3611 :s/// subst. all subst. one
3612 :s///g subst. one subst. all
3613 :s///gg subst. all subst. one
3614
3615 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar21020352017-06-13 17:21:04 +02003616 DEPRECATED: Setting this option may break plugins that are not aware
3617 of this option. Also, many users get confused that adding the /g flag
3618 has the opposite effect of that it normally does.
Bram Moolenaar4072ba52020-12-23 13:56:35 +01003619 This option is not used in |Vim9| script.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003620
3621 *'grepformat'* *'gfm'*
Bram Moolenaar6e932462014-09-09 18:48:09 +02003622'grepformat' 'gfm' string (default "%f:%l:%m,%f:%l%m,%f %l%m")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003623 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003624 Format to recognize for the ":grep" command output.
3625 This is a scanf-like string that uses the same format as the
3626 'errorformat' option: see |errorformat|.
3627
3628 *'grepprg'* *'gp'*
3629'grepprg' 'gp' string (default "grep -n ",
3630 Unix: "grep -n $* /dev/null",
3631 Win32: "findstr /n" or "grep -n",
3632 VMS: "SEARCH/NUMBERS ")
3633 global or local to buffer |global-local|
Bram Moolenaar582fd852005-03-28 20:58:01 +00003634 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003635 and '#' characters, which are expanded like when used in a command-
3636 line. The placeholder "$*" is allowed to specify where the arguments
3637 will be included. Environment variables are expanded |:set_env|. See
3638 |option-backslash| about including spaces and backslashes.
3639 When your "grep" accepts the "-H" argument, use this to make ":grep"
3640 also work well with a single file: >
3641 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00003642< Special value: When 'grepprg' is set to "internal" the |:grep| command
Bram Moolenaara6557602006-02-04 22:43:20 +00003643 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like
3644 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00003645 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00003646 apply equally to 'grepprg'.
3647 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
3648 otherwise it's "grep -n".
3649 This option cannot be set from a |modeline| or in the |sandbox|, for
3650 security reasons.
3651
3652 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
3653'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
3654 ve:ver35-Cursor,
3655 o:hor50-Cursor,
3656 i-ci:ver25-Cursor/lCursor,
3657 r-cr:hor20-Cursor/lCursor,
3658 sm:block-Cursor
3659 -blinkwait175-blinkoff150-blinkon175",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003660 for Win32 console:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003661 "n-v-c:block,o:hor50,i-ci:hor15,
3662 r-cr:hor30,sm:block")
3663 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003664 {only available when compiled with GUI enabled, and
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003665 for Win32 console}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003666 This option tells Vim what the cursor should look like in different
Bram Moolenaar8024f932020-01-14 19:29:13 +01003667 modes. It fully works in the GUI. In a Win32 console, only the
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003668 height of the cursor can be changed. This can be done by specifying a
3669 block cursor, or a percentage for a vertical or horizontal cursor.
Bram Moolenaar1e7813a2015-03-31 18:31:03 +02003670 For a console the 't_SI', 't_SR', and 't_EI' escape sequences are
3671 used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003672
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003673 The option is a comma separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003674 mode-list and an argument-list:
3675 mode-list:argument-list,mode-list:argument-list,..
3676 The mode-list is a dash separated list of these modes:
3677 n Normal mode
3678 v Visual mode
3679 ve Visual mode with 'selection' "exclusive" (same as 'v',
3680 if not specified)
3681 o Operator-pending mode
3682 i Insert mode
3683 r Replace mode
3684 c Command-line Normal (append) mode
3685 ci Command-line Insert mode
3686 cr Command-line Replace mode
3687 sm showmatch in Insert mode
3688 a all modes
3689 The argument-list is a dash separated list of these arguments:
3690 hor{N} horizontal bar, {N} percent of the character height
3691 ver{N} vertical bar, {N} percent of the character width
3692 block block cursor, fills the whole character
3693 [only one of the above three should be present]
3694 blinkwait{N} *cursor-blinking*
3695 blinkon{N}
3696 blinkoff{N}
3697 blink times for cursor: blinkwait is the delay before
3698 the cursor starts blinking, blinkon is the time that
3699 the cursor is shown and blinkoff is the time that the
3700 cursor is not shown. The times are in msec. When one
3701 of the numbers is zero, there is no blinking. The
3702 default is: "blinkwait700-blinkon400-blinkoff250".
3703 These numbers are used for a missing entry. This
3704 means that blinking is enabled by default. To switch
3705 blinking off you can use "blinkon0". The cursor only
3706 blinks when Vim is waiting for input, not while
3707 executing a command.
3708 To make the cursor blink in an xterm, see
3709 |xterm-blink|.
3710 {group-name}
3711 a highlight group name, that sets the color and font
3712 for the cursor
3713 {group-name}/{group-name}
3714 Two highlight group names, the first is used when
3715 no language mappings are used, the other when they
3716 are. |language-mapping|
3717
3718 Examples of parts:
3719 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
3720 block cursor with colors from the "nCursor"
3721 highlight group
3722 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
3723 In Insert and Command-line Insert mode, use a
3724 30% vertical bar cursor with colors from the
3725 "iCursor" highlight group. Blink a bit
3726 faster.
3727
3728 The 'a' mode is different. It will set the given argument-list for
3729 all modes. It does not reset anything to defaults. This can be used
3730 to do a common setting for all modes. For example, to switch off
3731 blinking: "a:blinkon0"
3732
3733 Examples of cursor highlighting: >
3734 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
3735 :highlight Cursor gui=NONE guifg=bg guibg=fg
3736<
3737 *'guifont'* *'gfn'*
Bram Moolenaar251e1912011-06-19 05:09:16 +02003738 *E235* *E596*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003739'guifont' 'gfn' string (default "")
3740 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003741 {only available when compiled with GUI enabled}
3742 This is a list of fonts which will be used for the GUI version of Vim.
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003743 In its simplest form the value is just one font name.
3744 See |gui-font| for the details.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003745
3746 *'guifontset'* *'gfs'*
3747 *E250* *E252* *E234* *E597* *E598*
3748'guifontset' 'gfs' string (default "")
3749 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003750 {only available when compiled with GUI enabled and
3751 with the |+xfontset| feature}
Bram Moolenaar3df01732017-02-17 22:47:16 +01003752 {not available in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003753 When not empty, specifies two (or more) fonts to be used. The first
3754 one for normal English, the second one for your special language. See
3755 |xfontset|.
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003756
Bram Moolenaar071d4272004-06-13 20:20:40 +00003757 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
3758'guifontwide' 'gfw' string (default "")
3759 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003760 {only available when compiled with GUI enabled}
3761 When not empty, specifies a comma-separated list of fonts to be used
3762 for double-width characters. The first font that can be loaded is
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003763 used. See |gui-fontwide|.
Bram Moolenaar0f272122013-01-23 18:37:40 +01003764
Bram Moolenaar071d4272004-06-13 20:20:40 +00003765 *'guiheadroom'* *'ghr'*
3766'guiheadroom' 'ghr' number (default 50)
3767 global
Bram Moolenaar110289e2019-05-23 15:38:06 +02003768 {only for GTK and X11 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003769 The number of pixels subtracted from the screen height when fitting
3770 the GUI window on the screen. Set this before the GUI is started,
3771 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003772 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00003773 lines will be left for window decorations and other items on the
3774 screen. Set it to a negative value to allow windows taller than the
3775 screen.
3776
3777 *'guioptions'* *'go'*
Bram Moolenaar2c64ca12018-10-19 16:22:31 +02003778'guioptions' 'go' string (default "egmrLtT" (MS-Windows,
3779 "t" is removed in |defaults.vim|),
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02003780 "aegimrLtT" (GTK, Motif and Athena),
3781 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00003782 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003783 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00003784 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003785 sequence of letters which describes what components and options of the
3786 GUI should be used.
3787 To avoid problems with flags that are added in the future, use the
3788 "+=" and "-=" feature of ":set" |add-option-flags|.
3789
Bram Moolenaar13568252018-03-16 20:46:58 +01003790 Valid characters are as follows:
3791 *'go-!'*
3792 '!' External commands are executed in a terminal window. Without
3793 this flag the MS-Windows GUI will open a console window to
3794 execute the command. The Unix GUI will simulate a dumb
3795 terminal to list the command output.
3796 The terminal window will be positioned at the bottom, and grow
3797 upwards as needed.
Bram Moolenaarba3ff532018-11-04 14:45:49 +01003798 *'go-a'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003799 'a' Autoselect: If present, then whenever VISUAL mode is started,
3800 or the Visual area extended, Vim tries to become the owner of
3801 the windowing system's global selection. This means that the
3802 Visually highlighted text is available for pasting into other
3803 applications as well as into Vim itself. When the Visual mode
3804 ends, possibly due to an operation on the text, or when an
3805 application wants to paste the selection, the highlighted text
3806 is automatically yanked into the "* selection register.
3807 Thus the selection is still available for pasting into other
3808 applications after the VISUAL mode has ended.
3809 If not present, then Vim won't become the owner of the
3810 windowing system's global selection unless explicitly told to
3811 by a yank or delete operation for the "* register.
3812 The same applies to the modeless selection.
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02003813 *'go-P'*
3814 'P' Like autoselect but using the "+ register instead of the "*
Bram Moolenaar3848e002016-03-19 18:42:29 +01003815 register.
Bram Moolenaar02467872007-05-06 13:22:01 +00003816 *'go-A'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003817 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003818 applies to the modeless selection.
3819
3820 'guioptions' autoselect Visual autoselect modeless ~
3821 "" - -
3822 "a" yes yes
3823 "A" - yes
3824 "aA" yes yes
3825
Bram Moolenaar02467872007-05-06 13:22:01 +00003826 *'go-c'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003827 'c' Use console dialogs instead of popup dialogs for simple
3828 choices.
Bram Moolenaar50bf7ce2019-09-15 13:17:00 +02003829 *'go-d'*
3830 'd' Use dark theme variant if available. Currently only works for
3831 GTK+ GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00003832 *'go-e'*
Bram Moolenaare224ffa2006-03-01 00:01:28 +00003833 'e' Add tab pages when indicated with 'showtabline'.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003834 'guitablabel' can be used to change the text in the labels.
3835 When 'e' is missing a non-GUI tab pages line may be used.
Bram Moolenaard68071d2006-05-02 22:08:30 +00003836 The GUI tabs are only supported on some systems, currently
Bram Moolenaarb3f74062020-02-26 16:16:53 +01003837 GTK, Motif, Mac OS/X, Haiku, and MS-Windows.
Bram Moolenaar02467872007-05-06 13:22:01 +00003838 *'go-f'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003839 'f' Foreground: Don't use fork() to detach the GUI from the shell
3840 where it was started. Use this for programs that wait for the
3841 editor to finish (e.g., an e-mail program). Alternatively you
3842 can use "gvim -f" or ":gui -f" to start the GUI in the
3843 foreground. |gui-fork|
3844 Note: Set this option in the vimrc file. The forking may have
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003845 happened already when the |gvimrc| file is read.
Bram Moolenaar02467872007-05-06 13:22:01 +00003846 *'go-i'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003847 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
3848 corner of the window. It's black&white on non-GTK, because of
3849 limitations of X11. For a color icon, see |X11-icon|.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003850 *'go-m'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003851 'm' Menu bar is present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003852 *'go-M'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003853 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00003854 that this flag must be added in the .vimrc file, before
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003855 switching on syntax or filetype recognition (when the |gvimrc|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003856 file is sourced the system menu has already been loaded; the
Bram Moolenaar01164a62017-11-02 22:58:42 +01003857 `:syntax on` and `:filetype on` commands load the menu too).
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003858 *'go-g'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003859 'g' Grey menu items: Make menu items that are not active grey. If
3860 'g' is not included inactive menu items are not shown at all.
3861 Exception: Athena will always use grey menu items.
Bram Moolenaar02467872007-05-06 13:22:01 +00003862 *'go-t'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003863 't' Include tearoff menu items. Currently only works for Win32,
3864 GTK+, and Motif 1.2 GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00003865 *'go-T'*
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00003866 'T' Include Toolbar. Currently only in Win32, GTK+, Motif, Photon
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00003867 and Athena GUIs.
Bram Moolenaar02467872007-05-06 13:22:01 +00003868 *'go-r'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003869 'r' Right-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003870 *'go-R'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003871 'R' Right-hand scrollbar is present when there is a vertically
3872 split window.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003873 *'go-l'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003874 'l' Left-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003875 *'go-L'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003876 'L' Left-hand scrollbar is present when there is a vertically
3877 split window.
Bram Moolenaar02467872007-05-06 13:22:01 +00003878 *'go-b'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003879 'b' Bottom (horizontal) scrollbar is present. Its size depends on
3880 the longest visible line, or on the cursor line if the 'h'
3881 flag is included. |gui-horiz-scroll|
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003882 *'go-h'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003883 'h' Limit horizontal scrollbar size to the length of the cursor
3884 line. Reduces computations. |gui-horiz-scroll|
3885
3886 And yes, you may even have scrollbars on the left AND the right if
3887 you really want to :-). See |gui-scrollbars| for more information.
3888
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003889 *'go-v'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003890 'v' Use a vertical button layout for dialogs. When not included,
3891 a horizontal layout is preferred, but when it doesn't fit a
Bram Moolenaardad44732021-03-31 20:07:33 +02003892 vertical layout is used anyway. Not supported in GTK 3.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003893 *'go-p'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003894 'p' Use Pointer callbacks for X11 GUI. This is required for some
3895 window managers. If the cursor is not blinking or hollow at
3896 the right moment, try adding this flag. This must be done
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003897 before starting the GUI. Set it in your |gvimrc|. Adding or
Bram Moolenaar071d4272004-06-13 20:20:40 +00003898 removing it after the GUI has started has no effect.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003899 *'go-F'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003900 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar8ac44152017-11-09 18:33:29 +01003901 *'go-k'*
3902 'k' Keep the GUI window size when adding/removing a scrollbar, or
3903 toolbar, tabline, etc. Instead, the behavior is similar to
3904 when the window is maximized and will adjust 'lines' and
3905 'columns' to fit to the window. Without the 'k' flag Vim will
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003906 try to keep 'lines' and 'columns' the same when adding and
Bram Moolenaar8ac44152017-11-09 18:33:29 +01003907 removing GUI components.
Bram Moolenaar02467872007-05-06 13:22:01 +00003908
Bram Moolenaar071d4272004-06-13 20:20:40 +00003909 *'guipty'* *'noguipty'*
3910'guipty' boolean (default on)
3911 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003912 {only available when compiled with GUI enabled}
3913 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
3914 I/O to/from shell commands. See |gui-pty|.
3915
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003916 *'guitablabel'* *'gtl'*
3917'guitablabel' 'gtl' string (default empty)
3918 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02003919 {only available when compiled with GUI enabled}
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003920 When nonempty describes the text to use in a label of the GUI tab
Bram Moolenaard68071d2006-05-02 22:08:30 +00003921 pages line. When empty and when the result is empty Vim will use a
3922 default label. See |setting-guitablabel| for more info.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003923
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003924 The format of this option is like that of 'statusline'.
Bram Moolenaar57657d82006-04-21 22:12:41 +00003925 'guitabtooltip' is used for the tooltip, see below.
Bram Moolenaar51628222016-12-01 23:03:28 +01003926 The expression will be evaluated in the |sandbox| when set from a
3927 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003928 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003929
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003930 Only used when the GUI tab pages line is displayed. 'e' must be
3931 present in 'guioptions'. For the non-GUI tab pages line 'tabline' is
3932 used.
3933
Bram Moolenaar57657d82006-04-21 22:12:41 +00003934 *'guitabtooltip'* *'gtt'*
3935'guitabtooltip' 'gtt' string (default empty)
3936 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02003937 {only available when compiled with GUI enabled}
Bram Moolenaar57657d82006-04-21 22:12:41 +00003938 When nonempty describes the text to use in a tooltip for the GUI tab
3939 pages line. When empty Vim will use a default tooltip.
3940 This option is otherwise just like 'guitablabel' above.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003941 You can include a line break. Simplest method is to use |:let|: >
3942 :let &guitabtooltip = "line one\nline two"
3943<
Bram Moolenaar57657d82006-04-21 22:12:41 +00003944
Bram Moolenaar071d4272004-06-13 20:20:40 +00003945 *'helpfile'* *'hf'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003946'helpfile' 'hf' string (default (MS-Windows) "$VIMRUNTIME\doc\help.txt"
Bram Moolenaar071d4272004-06-13 20:20:40 +00003947 (others) "$VIMRUNTIME/doc/help.txt")
3948 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003949 Name of the main help file. All distributed help files should be
3950 placed together in one directory. Additionally, all "doc" directories
3951 in 'runtimepath' will be used.
3952 Environment variables are expanded |:set_env|. For example:
3953 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003954 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00003955 spaces and backslashes.
3956 This option cannot be set from a |modeline| or in the |sandbox|, for
3957 security reasons.
3958
3959 *'helpheight'* *'hh'*
3960'helpheight' 'hh' number (default 20)
3961 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003962 Minimal initial height of the help window when it is opened with the
3963 ":help" command. The initial height of the help window is half of the
3964 current window, or (when the 'ea' option is on) the same as other
3965 windows. When the height is less than 'helpheight', the height is
3966 set to 'helpheight'. Set to zero to disable.
3967
3968 *'helplang'* *'hlg'*
3969'helplang' 'hlg' string (default: messages language or empty)
3970 global
3971 {only available when compiled with the |+multi_lang|
3972 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003973 Comma separated list of languages. Vim will use the first language
3974 for which the desired help can be found. The English help will always
3975 be used as a last resort. You can add "en" to prefer English over
3976 another language, but that will only find tags that exist in that
3977 language and not in the English help.
3978 Example: >
3979 :set helplang=de,it
3980< This will first search German, then Italian and finally English help
3981 files.
3982 When using |CTRL-]| and ":help!" in a non-English help file Vim will
3983 try to find the tag in the current language before using this option.
3984 See |help-translated|.
3985
3986 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
3987'hidden' 'hid' boolean (default off)
3988 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003989 When off a buffer is unloaded when it is |abandon|ed. When on a
3990 buffer becomes hidden when it is |abandon|ed. If the buffer is still
3991 displayed in another window, it does not become hidden, of course.
3992 The commands that move through the buffer list sometimes make a buffer
3993 hidden although the 'hidden' option is off: When the buffer is
3994 modified, 'autowrite' is off or writing is not possible, and the '!'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003995 flag was used. See also |windows.txt|.
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00003996 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003997 This option is set for one command with ":hide {command}" |:hide|.
3998 WARNING: It's easy to forget that you have changes in hidden buffers.
3999 Think twice when using ":q!" or ":qa!".
4000
4001 *'highlight'* *'hl'*
4002'highlight' 'hl' string (default (as a single string):
Bram Moolenaar58b85342016-08-14 19:54:54 +02004003 "8:SpecialKey,~:EndOfBuffer,@:NonText,
4004 d:Directory,e:ErrorMsg,i:IncSearch,
4005 l:Search,m:MoreMsg,M:ModeMsg,n:LineNr,
Bram Moolenaarefae76a2019-10-27 22:54:58 +01004006 a:LineNrAbove,b:LineNrBelow,
Bram Moolenaar58b85342016-08-14 19:54:54 +02004007 N:CursorLineNr,r:Question,s:StatusLine,
4008 S:StatusLineNC,c:VertSplit,t:Title,
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004009 v:Visual,V:VisualNOS,w:WarningMsg,
4010 W:WildMenu,f:Folded,F:FoldColumn,
4011 A:DiffAdd,C:DiffChange,D:DiffDelete,
4012 T:DiffText,>:SignColumn,-:Conceal,
Bram Moolenaarc8c88492018-12-27 23:59:26 +01004013 B:SpellBad,P:SpellCap,R:SpellRare,
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004014 L:SpellLocal,+:Pmenu,=:PmenuSel,
Bram Moolenaar21020352017-06-13 17:21:04 +02004015 x:PmenuSbar,X:PmenuThumb,*:TabLine,
4016 #:TabLineSel,_:TabLineFill,!:CursorColumn,
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02004017 .:CursorLine,o:ColorColumn,q:QuickFixLine,
Bram Moolenaarc572da52017-08-27 16:52:01 +02004018 z:StatusLineTerm,Z:StatusLineTermNC")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004019 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004020 This option can be used to set highlighting mode for various
4021 occasions. It is a comma separated list of character pairs. The
4022 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004023 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004024 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
Bram Moolenaar58b85342016-08-14 19:54:54 +02004025 |hl-EndOfBuffer| ~ lines after the last line in the buffer
4026 |hl-NonText| @ '@' at the end of the window and
Bram Moolenaar071d4272004-06-13 20:20:40 +00004027 characters from 'showbreak'
4028 |hl-Directory| d directories in CTRL-D listing and other special
4029 things in listings
4030 |hl-ErrorMsg| e error messages
4031 h (obsolete, ignored)
4032 |hl-IncSearch| i 'incsearch' highlighting
4033 |hl-Search| l last search pattern highlighting (see 'hlsearch')
4034 |hl-MoreMsg| m |more-prompt|
4035 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
Bram Moolenaar64486672010-05-16 15:46:46 +02004036 |hl-LineNr| n line number for ":number" and ":#" commands, and
4037 when 'number' or 'relativenumber' option is set.
Bram Moolenaarefae76a2019-10-27 22:54:58 +01004038 |hl-LineNrAbove| a line number above the cursor for when the
4039 'relativenumber' option is set.
4040 |hl-LineNrBelow| b line number below the cursor for when the
4041 'relativenumber' option is set.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01004042 |hl-CursorLineNr| N like n for when 'cursorline' or 'relativenumber' is
4043 set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004044 |hl-Question| r |hit-enter| prompt and yes/no questions
4045 |hl-StatusLine| s status line of current window |status-line|
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01004046 |hl-StatusLineNC| S status lines of not-current windows
Bram Moolenaar071d4272004-06-13 20:20:40 +00004047 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
4048 |hl-VertSplit| c column used to separate vertically split windows
4049 |hl-Visual| v Visual mode
4050 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
4051 Selection" Only X11 Gui's |gui-x11| and
4052 |xterm-clipboard|.
4053 |hl-WarningMsg| w warning messages
4054 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
4055 |hl-Folded| f line used for closed folds
4056 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00004057 |hl-DiffAdd| A added line in diff mode
4058 |hl-DiffChange| C changed line in diff mode
4059 |hl-DiffDelete| D deleted line in diff mode
4060 |hl-DiffText| T inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00004061 |hl-SignColumn| > column used for |signs|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004062 |hl-Conceal| - the placeholders used for concealed characters
4063 (see 'conceallevel')
Bram Moolenaar217ad922005-03-20 22:37:15 +00004064 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02004065 |hl-SpellCap| P word that should start with capital |spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00004066 |hl-SpellRare| R rare word |spell|
4067 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004068 |hl-Pmenu| + popup menu normal line
4069 |hl-PmenuSel| = popup menu selected line
4070 |hl-PmenuSbar| x popup menu scrollbar
4071 |hl-PmenuThumb| X popup menu scrollbar thumb
Bram Moolenaar071d4272004-06-13 20:20:40 +00004072
4073 The display modes are:
4074 r reverse (termcap entry "mr" and "me")
4075 i italic (termcap entry "ZH" and "ZR")
4076 b bold (termcap entry "md" and "me")
4077 s standout (termcap entry "so" and "se")
4078 u underline (termcap entry "us" and "ue")
Bram Moolenaare2cc9702005-03-15 22:43:58 +00004079 c undercurl (termcap entry "Cs" and "Ce")
Bram Moolenaarcf4b00c2017-09-02 18:33:56 +02004080 t strikethrough (termcap entry "Ts" and "Te")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004081 n no highlighting
4082 - no highlighting
4083 : use a highlight group
4084 The default is used for occasions that are not included.
4085 If you want to change what the display modes do, see |dos-colors|
4086 for an example.
4087 When using the ':' display mode, this must be followed by the name of
4088 a highlight group. A highlight group can be used to define any type
4089 of highlighting, including using color. See |:highlight| on how to
4090 define one. The default uses a different group for each occasion.
4091 See |highlight-default| for the default highlight groups.
4092
Bram Moolenaar071d4272004-06-13 20:20:40 +00004093 *'history'* *'hi'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004094'history' 'hi' number (Vim default: 50, Vi default: 0,
4095 set to 200 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004096 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004097 A history of ":" commands, and a history of previous search patterns
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004098 is remembered. This option decides how many entries may be stored in
Bram Moolenaar071d4272004-06-13 20:20:40 +00004099 each of these histories (see |cmdline-editing|).
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004100 The maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004101 NOTE: This option is set to the Vi default value when 'compatible' is
4102 set and to the Vim default value when 'compatible' is reset.
4103
4104 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
4105'hkmap' 'hk' boolean (default off)
4106 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004107 {only available when compiled with the |+rightleft|
4108 feature}
4109 When on, the keyboard is mapped for the Hebrew character set.
4110 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
4111 toggle this option. See |rileft.txt|.
4112 NOTE: This option is reset when 'compatible' is set.
4113
4114 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
4115'hkmapp' 'hkp' boolean (default off)
4116 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004117 {only available when compiled with the |+rightleft|
4118 feature}
4119 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
4120 This is useful if you have a non-Hebrew keyboard.
4121 See |rileft.txt|.
4122 NOTE: This option is reset when 'compatible' is set.
4123
Bram Moolenaar036986f2017-03-16 17:41:02 +01004124 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
4125'hlsearch' 'hls' boolean (default off)
4126 global
Bram Moolenaar036986f2017-03-16 17:41:02 +01004127 {not available when compiled without the
4128 |+extra_search| feature}
4129 When there is a previous search pattern, highlight all its matches.
4130 The type of highlighting used can be set with the 'l' occasion in the
4131 'highlight' option. This uses the "Search" highlight group by
4132 default. Note that only the matching text is highlighted, any offsets
4133 are not applied.
4134 See also: 'incsearch' and |:match|.
4135 When you get bored looking at the highlighted matches, you can turn it
4136 off with |:nohlsearch|. This does not change the option value, as
4137 soon as you use a search command, the highlighting comes back.
4138 'redrawtime' specifies the maximum time spent on finding matches.
4139 When the search pattern can match an end-of-line, Vim will try to
4140 highlight all of the matched text. However, this depends on where the
4141 search starts. This will be the first line in the window or the first
4142 line below a closed fold. A match in a previous line which is not
4143 drawn may not continue in a newly drawn line.
4144 You can specify whether the highlight status is restored on startup
4145 with the 'h' flag in 'viminfo' |viminfo-h|.
4146 NOTE: This option is reset when 'compatible' is set.
4147
Bram Moolenaar071d4272004-06-13 20:20:40 +00004148 *'icon'* *'noicon'*
4149'icon' boolean (default off, on when title can be restored)
4150 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004151 {not available when compiled without the |+title|
4152 feature}
4153 When on, the icon text of the window will be set to the value of
4154 'iconstring' (if it is not empty), or to the name of the file
4155 currently being edited. Only the last part of the name is used.
4156 Overridden by the 'iconstring' option.
4157 Only works if the terminal supports setting window icons (currently
4158 only X11 GUI and terminals with a non-empty 't_IS' option - these are
4159 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
4160 builtin termcap).
4161 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00004162 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00004163 X11.
Bram Moolenaar3a991dd2014-10-02 01:41:41 +02004164 For MS-Windows the icon can be changed, see |windows-icon|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004165
4166 *'iconstring'*
4167'iconstring' string (default "")
4168 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004169 {not available when compiled without the |+title|
4170 feature}
4171 When this option is not empty, it will be used for the icon text of
4172 the window. This happens only when the 'icon' option is on.
4173 Only works if the terminal supports setting window icon text
4174 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02004175 Does not work for MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004176 When Vim was compiled with HAVE_X11 defined, the original icon will be
4177 restored if possible |X11|.
4178 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004179 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004180 'titlestring' for example settings.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004181 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004182 {not available when compiled without the |+statusline| feature}
4183
4184 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
4185'ignorecase' 'ic' boolean (default off)
4186 global
4187 Ignore case in search patterns. Also used when searching in the tags
4188 file.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01004189 Also see 'smartcase' and 'tagcase'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004190 Can be overruled by using "\c" or "\C" in the pattern, see
4191 |/ignorecase|.
4192
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004193 *'imactivatefunc'* *'imaf'*
4194'imactivatefunc' 'imaf' string (default "")
4195 global
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004196 This option specifies a function that will be called to
Bram Moolenaar2877d332017-11-26 14:56:16 +01004197 activate or deactivate the Input Method.
Bram Moolenaaref8c6172020-07-01 15:12:44 +02004198 It is not used in the MS-Windows GUI version.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004199 The expression will be evaluated in the |sandbox| when set from a
4200 modeline, see |sandbox-option|.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004201
4202 Example: >
4203 function ImActivateFunc(active)
4204 if a:active
4205 ... do something
4206 else
4207 ... do something
4208 endif
4209 " return value is not used
4210 endfunction
4211 set imactivatefunc=ImActivateFunc
4212<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004213 *'imactivatekey'* *'imak'*
4214'imactivatekey' 'imak' string (default "")
4215 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004216 {only available when compiled with |+xim| and
Bram Moolenaar67c53842010-05-22 18:28:27 +02004217 |+GUI_GTK|} *E599*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004218 Specifies the key that your Input Method in X-Windows uses for
4219 activation. When this is specified correctly, vim can fully control
4220 IM with 'imcmdline', 'iminsert' and 'imsearch'.
4221 You can't use this option to change the activation key, the option
4222 tells Vim what the key is.
4223 Format:
4224 [MODIFIER_FLAG-]KEY_STRING
4225
4226 These characters can be used for MODIFIER_FLAG (case is ignored):
4227 S Shift key
4228 L Lock key
4229 C Control key
4230 1 Mod1 key
4231 2 Mod2 key
4232 3 Mod3 key
4233 4 Mod4 key
4234 5 Mod5 key
4235 Combinations are allowed, for example "S-C-space" or "SC-space" are
4236 both shift+ctrl+space.
4237 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
4238
4239 Example: >
4240 :set imactivatekey=S-space
4241< "S-space" means shift+space. This is the activation key for kinput2 +
4242 canna (Japanese), and ami (Korean).
4243
4244 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
4245'imcmdline' 'imc' boolean (default off)
4246 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004247 When set the Input Method is always on when starting to edit a command
4248 line, unless entering a search pattern (see 'imsearch' for that).
4249 Setting this option is useful when your input method allows entering
4250 English characters directly, e.g., when it's used to type accented
4251 characters with dead keys.
4252
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004253 *'imdisable'* *'imd'* *'noimdisable'* *'noimd'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004254'imdisable' 'imd' boolean (default off, on for some systems (SGI))
4255 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004256 When set the Input Method is never used. This is useful to disable
4257 the IM when it doesn't work properly.
4258 Currently this option is on by default for SGI/IRIX machines. This
4259 may change in later releases.
4260
4261 *'iminsert'* *'imi'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004262'iminsert' 'imi' number (default 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004263 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004264 Specifies whether :lmap or an Input Method (IM) is to be used in
4265 Insert mode. Valid values:
4266 0 :lmap is off and IM is off
4267 1 :lmap is ON and IM is off
4268 2 :lmap is off and IM is ON
Bram Moolenaar071d4272004-06-13 20:20:40 +00004269 To always reset the option to zero when leaving Insert mode with <Esc>
4270 this can be used: >
4271 :inoremap <ESC> <ESC>:set iminsert=0<CR>
4272< This makes :lmap and IM turn off automatically when leaving Insert
4273 mode.
4274 Note that this option changes when using CTRL-^ in Insert mode
4275 |i_CTRL-^|.
4276 The value is set to 1 when setting 'keymap' to a valid keymap name.
4277 It is also used for the argument of commands like "r" and "f".
4278 The value 0 may not work correctly with Athena and Motif with some XIM
4279 methods. Use 'imdisable' to disable XIM then.
4280
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004281 You can set 'imactivatefunc' and 'imstatusfunc' to handle IME/XIM
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004282 via external command if Vim is not compiled with the |+xim|,
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004283 |+multi_byte_ime| or |global-ime|.
4284
Bram Moolenaar071d4272004-06-13 20:20:40 +00004285 *'imsearch'* *'ims'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004286'imsearch' 'ims' number (default -1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004287 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004288 Specifies whether :lmap or an Input Method (IM) is to be used when
4289 entering a search pattern. Valid values:
4290 -1 the value of 'iminsert' is used, makes it look like
4291 'iminsert' is also used when typing a search pattern
4292 0 :lmap is off and IM is off
4293 1 :lmap is ON and IM is off
4294 2 :lmap is off and IM is ON
4295 Note that this option changes when using CTRL-^ in Command-line mode
4296 |c_CTRL-^|.
4297 The value is set to 1 when it is not -1 and setting the 'keymap'
4298 option to a valid keymap name.
4299 The value 0 may not work correctly with Athena and Motif with some XIM
4300 methods. Use 'imdisable' to disable XIM then.
4301
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004302 *'imstatusfunc'* *'imsf'*
4303'imstatusfunc' 'imsf' string (default "")
4304 global
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004305 This option specifies a function that is called to obtain the status
4306 of Input Method. It must return a positive number when IME is active.
Bram Moolenaaref8c6172020-07-01 15:12:44 +02004307 It is not used in the MS-Windows GUI version.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004308
4309 Example: >
4310 function ImStatusFunc()
4311 let is_active = ...do something
4312 return is_active ? 1 : 0
4313 endfunction
4314 set imstatusfunc=ImStatusFunc
4315<
4316 NOTE: This function is invoked very often. Keep it fast.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004317 The expression will be evaluated in the |sandbox| when set from a
4318 modeline, see |sandbox-option|.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004319
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004320 *'imstyle'* *'imst'*
4321'imstyle' 'imst' number (default 1)
4322 global
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004323 {only available when compiled with |+xim| and
4324 |+GUI_GTK|}
Bram Moolenaar37c64c72017-09-19 22:06:03 +02004325 This option specifies the input style of Input Method:
4326 0 use on-the-spot style
4327 1 over-the-spot style
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004328 See: |xim-input-style|
4329
Bram Moolenaar24a98a02017-09-27 22:23:55 +02004330 For a long time on-the-spot style had been used in the GTK version of
4331 vim, however, it is known that it causes troubles when using mappings,
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004332 |single-repeat|, etc. Therefore over-the-spot style becomes the
4333 default now. This should work fine for most people, however if you
4334 have any problem with it, try using on-the-spot style.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004335 The expression will be evaluated in the |sandbox| when set from a
4336 modeline, see |sandbox-option|.
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004337
Bram Moolenaar071d4272004-06-13 20:20:40 +00004338 *'include'* *'inc'*
4339'include' 'inc' string (default "^\s*#\s*include")
4340 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004341 {not available when compiled without the
4342 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004343 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00004344 pattern, just like for the "/" command (See |pattern|). The default
4345 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar1e015462005-09-25 22:16:38 +00004346 "]I", "[d", etc.
4347 Normally the 'isfname' option is used to recognize the file name that
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004348 comes after the matched pattern. But if "\zs" appears in the pattern
4349 then the text matched from "\zs" to the end, or until "\ze" if it
4350 appears, is used as the file name. Use this to include characters
4351 that are not in 'isfname', such as a space. You can then use
4352 'includeexpr' to process the matched text.
Bram Moolenaar1e015462005-09-25 22:16:38 +00004353 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004354
4355 *'includeexpr'* *'inex'*
4356'includeexpr' 'inex' string (default "")
4357 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004358 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004359 |+find_in_path| or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004360 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004361 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004362 :set includeexpr=substitute(v:fname,'\\.','/','g')
4363< The "v:fname" variable will be set to the file name that was detected.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004364
Bram Moolenaar071d4272004-06-13 20:20:40 +00004365 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004366 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004367 Also used for |<cfile>|.
4368
Bram Moolenaar30b65812012-07-12 22:01:11 +02004369 The expression will be evaluated in the |sandbox| when set from a
4370 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004371 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004372
4373 It is not allowed to change text or jump to another window while
4374 evaluating 'includeexpr' |textlock|.
4375
Bram Moolenaar071d4272004-06-13 20:20:40 +00004376 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004377'incsearch' 'is' boolean (default off, set in |defaults.vim| if the
4378 +reltime feature is supported)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004379 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004380 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004381 |+extra_search| features}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004382 While typing a search command, show where the pattern, as it was typed
4383 so far, matches. The matched string is highlighted. If the pattern
4384 is invalid or not found, nothing is shown. The screen will be updated
4385 often, this is only useful on fast terminals.
Bram Moolenaarfc65cab2018-08-28 22:58:02 +02004386 Also applies to the pattern in commands: >
4387 :global
4388 :lvimgrep
4389 :lvimgrepadd
4390 :smagic
4391 :snomagic
4392 :sort
4393 :substitute
4394 :vglobal
4395 :vimgrep
4396 :vimgrepadd
4397< Note that the match will be shown, but the cursor will return to its
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004398 original position when no match is found and when pressing <Esc>. You
4399 still need to finish the search command with <Enter> to move the
4400 cursor to the match.
Bram Moolenaardc083282016-10-11 08:57:33 +02004401 You can use the CTRL-G and CTRL-T keys to move to the next and
4402 previous match. |c_CTRL-G| |c_CTRL-T|
Bram Moolenaar91a4e822008-01-19 14:59:58 +00004403 When compiled with the |+reltime| feature Vim only searches for about
4404 half a second. With a complicated pattern and/or a lot of text the
4405 match may not be found. This is to avoid that Vim hangs while you
4406 are typing the pattern.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004407 The highlighting can be set with the 'i' flag in 'highlight'.
Bram Moolenaar2f058492017-11-30 20:27:52 +01004408 When 'hlsearch' is on, all matched strings are highlighted too while
4409 typing a search command. See also: 'hlsearch'.
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004410 If you don't want to turn 'hlsearch' on, but want to highlight all
4411 matches while searching, you can turn on and off 'hlsearch' with
4412 autocmd. Example: >
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004413 augroup vimrc-incsearch-highlight
4414 autocmd!
Bram Moolenaarf8f8b2e2017-11-02 19:08:48 +01004415 autocmd CmdlineEnter /,\? :set hlsearch
4416 autocmd CmdlineLeave /,\? :set nohlsearch
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004417 augroup END
4418<
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004419 CTRL-L can be used to add one character from after the current match
Bram Moolenaara9dc3752010-07-11 20:46:53 +02004420 to the command line. If 'ignorecase' and 'smartcase' are set and the
4421 command line has no uppercase characters, the added character is
4422 converted to lowercase.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004423 CTRL-R CTRL-W can be used to add the word at the end of the current
4424 match, excluding the characters that were already typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004425 NOTE: This option is reset when 'compatible' is set.
4426
4427 *'indentexpr'* *'inde'*
4428'indentexpr' 'inde' string (default "")
4429 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004430 {not available when compiled without the |+cindent|
4431 or |+eval| features}
4432 Expression which is evaluated to obtain the proper indent for a line.
4433 It is used when a new line is created, for the |=| operator and
4434 in Insert mode as specified with the 'indentkeys' option.
4435 When this option is not empty, it overrules the 'cindent' and
Bram Moolenaar20f90cf2011-05-19 12:22:51 +02004436 'smartindent' indenting. When 'lisp' is set, this option is
4437 overridden by the Lisp indentation algorithm.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004438 When 'paste' is set this option is not used for indenting.
4439 The expression is evaluated with |v:lnum| set to the line number for
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004440 which the indent is to be computed. The cursor is also in this line
Bram Moolenaar071d4272004-06-13 20:20:40 +00004441 when the expression is evaluated (but it may be moved around).
4442 The expression must return the number of spaces worth of indent. It
4443 can return "-1" to keep the current indent (this means 'autoindent' is
4444 used for the indent).
4445 Functions useful for computing the indent are |indent()|, |cindent()|
4446 and |lispindent()|.
4447 The evaluation of the expression must not have side effects! It must
4448 not change the text, jump to another window, etc. Afterwards the
4449 cursor position is always restored, thus the cursor may be moved.
4450 Normally this option would be set to call a function: >
4451 :set indentexpr=GetMyIndent()
4452< Error messages will be suppressed, unless the 'debug' option contains
4453 "msg".
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004454 See |indent-expression|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01004455 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004456
Bram Moolenaar30b65812012-07-12 22:01:11 +02004457 The expression will be evaluated in the |sandbox| when set from a
4458 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004459 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004460
4461 It is not allowed to change text or jump to another window while
4462 evaluating 'indentexpr' |textlock|.
4463
4464
Bram Moolenaar071d4272004-06-13 20:20:40 +00004465 *'indentkeys'* *'indk'*
Bram Moolenaarce655742019-01-31 14:12:57 +01004466'indentkeys' 'indk' string (default "0{,0},0),0],:,0#,!^F,o,O,e")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004467 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004468 {not available when compiled without the |+cindent|
4469 feature}
4470 A list of keys that, when typed in Insert mode, cause reindenting of
4471 the current line. Only happens if 'indentexpr' isn't empty.
4472 The format is identical to 'cinkeys', see |indentkeys-format|.
4473 See |C-indenting| and |indent-expression|.
4474
4475 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
4476'infercase' 'inf' boolean (default off)
4477 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004478 When doing keyword completion in insert mode |ins-completion|, and
Bram Moolenaar446cb832008-06-24 21:56:24 +00004479 'ignorecase' is also on, the case of the match is adjusted depending
4480 on the typed text. If the typed text contains a lowercase letter
4481 where the match has an upper case letter, the completed part is made
4482 lowercase. If the typed text has no lowercase letters and the match
4483 has a lowercase letter where the typed text has an uppercase letter,
4484 and there is a letter before it, the completed part is made uppercase.
4485 With 'noinfercase' the match is used as-is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004486
4487 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
4488'insertmode' 'im' boolean (default off)
4489 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004490 Makes Vim work in a way that Insert mode is the default mode. Useful
4491 if you want to use Vim as a modeless editor. Used for |evim|.
4492 These Insert mode commands will be useful:
4493 - Use the cursor keys to move around.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02004494 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|. When
Bram Moolenaar071d4272004-06-13 20:20:40 +00004495 this is a mapping, it is executed as if 'insertmode' was off.
4496 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004497 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00004498 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
4499 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004500
4501 These items change when 'insertmode' is set:
4502 - when starting to edit of a file, Vim goes to Insert mode.
4503 - <Esc> in Insert mode is a no-op and beeps.
4504 - <Esc> in Normal mode makes Vim go to Insert mode.
4505 - CTRL-L in Insert mode is a command, it is not inserted.
4506 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
4507 However, when <Esc> is used inside a mapping, it behaves like
4508 'insertmode' was not set. This was done to be able to use the same
4509 mappings with 'insertmode' set or not set.
4510 When executing commands with |:normal| 'insertmode' is not used.
4511
4512 NOTE: This option is reset when 'compatible' is set.
4513
4514 *'isfname'* *'isf'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004515'isfname' 'isf' string (default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004516 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
4517 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
4518 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
4519 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
4520 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
4521 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004522 The characters specified by this option are included in file names and
4523 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004524 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004525 Multi-byte characters 256 and above are always included, only the
4526 characters up to 255 are specified with this option.
4527 For UTF-8 the characters 0xa0 to 0xff are included as well.
Bram Moolenaar446cb832008-06-24 21:56:24 +00004528 Think twice before adding white space to this option. Although a
4529 space may appear inside a file name, the effect will be that Vim
4530 doesn't know where a file name starts or ends when doing completion.
4531 It most likely works better without a space in 'isfname'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004532
4533 Note that on systems using a backslash as path separator, Vim tries to
4534 do its best to make it work as you would expect. That is a bit
4535 tricky, since Vi originally used the backslash to escape special
4536 characters. Vim will not remove a backslash in front of a normal file
4537 name character on these systems, but it will on Unix and alikes. The
4538 '&' and '^' are not included by default, because these are special for
4539 cmd.exe.
4540
4541 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004542 Each part can be a single character number or a range. A range is two
4543 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004544 decimal number between 0 and 255 or the ASCII character itself (does
4545 not work for digits). Example:
4546 "_,-,128-140,#-43" (include '_' and '-' and the range
4547 128 to 140 and '#' to 43)
4548 If a part starts with '^', the following character number or range
4549 will be excluded from the option. The option is interpreted from left
4550 to right. Put the excluded character after the range where it is
4551 included. To include '^' itself use it as the last character of the
4552 option or the end of a range. Example:
4553 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
4554 If the character is '@', all characters where isalpha() returns TRUE
4555 are included. Normally these are the characters a to z and A to Z,
4556 plus accented characters. To include '@' itself use "@-@". Examples:
4557 "@,^a-z" All alphabetic characters, excluding lower
Bram Moolenaar446cb832008-06-24 21:56:24 +00004558 case ASCII letters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004559 "a-z,A-Z,@-@" All letters plus the '@' character.
4560 A comma can be included by using it where a character number is
4561 expected. Example:
4562 "48-57,,,_" Digits, comma and underscore.
4563 A comma can be excluded by prepending a '^'. Example:
4564 " -~,^,,9" All characters from space to '~', excluding
4565 comma, plus <Tab>.
4566 See |option-backslash| about including spaces and backslashes.
4567
4568 *'isident'* *'isi'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004569'isident' 'isi' string (default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004570 "@,48-57,_,128-167,224-235"
4571 otherwise: "@,48-57,_,192-255")
4572 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004573 The characters given by this option are included in identifiers.
4574 Identifiers are used in recognizing environment variables and after a
4575 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00004576 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004577 option. For '@' only characters up to 255 are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004578 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004579 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00004580 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
4581
4582 *'iskeyword'* *'isk'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004583'iskeyword' 'isk' string (Vim default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004584 "@,48-57,_,128-167,224-235"
4585 otherwise: "@,48-57,_,192-255"
4586 Vi default: "@,48-57,_")
4587 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004588 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004589 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004590 'isfname' for a description of the format of this option. For '@'
Bram Moolenaar4c295022021-05-02 17:19:11 +02004591 characters above 255 check the "word" character class (any character
4592 that is not white space or punctuation).
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004593 For C programs you could use "a-z,A-Z,48-57,_,.,-,>".
Bram Moolenaar071d4272004-06-13 20:20:40 +00004594 For a help file it is set to all non-blank printable characters except
4595 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
4596 command).
4597 When the 'lisp' option is on the '-' character is always included.
Bram Moolenaarb8060fe2016-01-19 22:29:28 +01004598 This option also influences syntax highlighting, unless the syntax
4599 uses |:syn-iskeyword|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004600 NOTE: This option is set to the Vi default value when 'compatible' is
4601 set and to the Vim default value when 'compatible' is reset.
4602
4603 *'isprint'* *'isp'*
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02004604'isprint' 'isp' string (default for Win32 and macOS:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004605 "@,~-255"; otherwise: "@,161-255")
4606 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004607 The characters given by this option are displayed directly on the
4608 screen. It is also used for "\p" in a |pattern|. The characters from
4609 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
4610 even when they are not included in 'isprint' or excluded. See
4611 'isfname' for a description of the format of this option.
4612
4613 Non-printable characters are displayed with two characters:
4614 0 - 31 "^@" - "^_"
4615 32 - 126 always single characters
4616 127 "^?"
4617 128 - 159 "~@" - "~_"
4618 160 - 254 "| " - "|~"
4619 255 "~?"
4620 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
4621 displayed as <xx>, with the hexadecimal value of the byte.
4622 When 'display' contains "uhex" all unprintable characters are
4623 displayed as <xx>.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004624 The SpecialKey highlighting will be used for unprintable characters.
4625 |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004626
4627 Multi-byte characters 256 and above are always included, only the
4628 characters up to 255 are specified with this option. When a character
4629 is printable but it is not available in the current font, a
4630 replacement character will be shown.
4631 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
4632 There is no option to specify these characters.
4633
4634 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
4635'joinspaces' 'js' boolean (default on)
4636 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004637 Insert two spaces after a '.', '?' and '!' with a join command.
4638 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
4639 Otherwise only one space is inserted.
4640 NOTE: This option is set when 'compatible' is set.
4641
4642 *'key'*
4643'key' string (default "")
4644 local to buffer
Bram Moolenaar996343d2010-07-04 22:20:21 +02004645 {only available when compiled with the |+cryptv|
4646 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004647 The key that is used for encrypting and decrypting the current buffer.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02004648 See |encryption| and 'cryptmethod'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004649 Careful: Do not set the key value by hand, someone might see the typed
4650 key. Use the |:X| command. But you can make 'key' empty: >
4651 :set key=
4652< It is not possible to get the value of this option with ":set key" or
4653 "echo &key". This is to avoid showing it to someone who shouldn't
4654 know. It also means you cannot see it yourself once you have set it,
4655 be careful not to make a typing error!
Bram Moolenaard58e9292011-02-09 17:07:58 +01004656 You can use "&key" in an expression to detect whether encryption is
4657 enabled. When 'key' is set it returns "*****" (five stars).
Bram Moolenaar071d4272004-06-13 20:20:40 +00004658
4659 *'keymap'* *'kmp'* *E544*
4660'keymap' 'kmp' string (default "")
4661 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004662 {only available when compiled with the |+keymap|
4663 feature}
4664 Name of a keyboard mapping. See |mbyte-keymap|.
4665 Setting this option to a valid keymap name has the side effect of
4666 setting 'iminsert' to one, so that the keymap becomes effective.
4667 'imsearch' is also set to one, unless it was -1
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004668 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004669
4670 *'keymodel'* *'km'*
4671'keymodel' 'km' string (default "")
4672 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004673 List of comma separated words, which enable special things that keys
4674 can do. These values can be used:
4675 startsel Using a shifted special key starts selection (either
4676 Select mode or Visual mode, depending on "key" being
4677 present in 'selectmode').
4678 stopsel Using a not-shifted special key stops selection.
4679 Special keys in this context are the cursor keys, <End>, <Home>,
4680 <PageUp> and <PageDown>.
4681 The 'keymodel' option is set by the |:behave| command.
4682
4683 *'keywordprg'* *'kp'*
4684'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02004685 VMS: "help")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004686 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004687 Program to use for the |K| command. Environment variables are
4688 expanded |:set_env|. ":help" may be used to access the Vim internal
4689 help. (Note that previously setting the global option to the empty
4690 value did this, which is now deprecated.)
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02004691 When the first character is ":", the command is invoked as a Vim
4692 Ex command prefixed with [count].
4693 When "man", "man -s" or an Ex command is used, Vim will automatically
4694 translate a count for the "K" command and pass it as the first
4695 argument. For "man -s" the "-s" is removed when there is no count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004696 See |option-backslash| about including spaces and backslashes.
4697 Example: >
4698 :set keywordprg=man\ -s
4699< This option cannot be set from a |modeline| or in the |sandbox|, for
4700 security reasons.
4701
4702 *'langmap'* *'lmap'* *E357* *E358*
4703'langmap' 'lmap' string (default "")
4704 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004705 {only available when compiled with the |+langmap|
4706 feature}
4707 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004708 mode. When you are typing text in Insert mode the characters are
Bram Moolenaarfa735342016-01-03 22:14:44 +01004709 inserted directly. When in Normal mode the 'langmap' option takes
Bram Moolenaar071d4272004-06-13 20:20:40 +00004710 care of translating these special characters to the original meaning
4711 of the key. This means you don't have to change the keyboard mode to
4712 be able to execute Normal mode commands.
4713 This is the opposite of the 'keymap' option, where characters are
4714 mapped in Insert mode.
Bram Moolenaarb17893a2020-03-14 08:19:51 +01004715 Also consider setting 'langremap' to off, to prevent 'langmap' from
4716 applying to characters resulting from a mapping.
Bram Moolenaare968e362014-05-13 20:23:24 +02004717 This option cannot be set from a |modeline| or in the |sandbox|, for
4718 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004719
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00004720 Example (for Greek, in UTF-8): *greek* >
4721 :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 +00004722< Example (exchanges meaning of z and y for commands): >
4723 :set langmap=zy,yz,ZY,YZ
4724<
4725 The 'langmap' option is a list of parts, separated with commas. Each
4726 part can be in one of two forms:
4727 1. A list of pairs. Each pair is a "from" character immediately
4728 followed by the "to" character. Examples: "aA", "aAbBcC".
4729 2. A list of "from" characters, a semi-colon and a list of "to"
4730 characters. Example: "abc;ABC"
4731 Example: "aA,fgh;FGH,cCdDeE"
4732 Special characters need to be preceded with a backslash. These are
Bram Moolenaar4f4d51a2020-10-11 13:57:40 +02004733 ";", ',', '"', '|' and backslash itself.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004734
4735 This will allow you to activate vim actions without having to switch
4736 back and forth between the languages. Your language characters will
4737 be understood as normal vim English characters (according to the
4738 langmap mappings) in the following cases:
4739 o Normal/Visual mode (commands, buffer/register names, user mappings)
4740 o Insert/Replace Mode: Register names after CTRL-R
4741 o Insert/Replace Mode: Mappings
4742 Characters entered in Command-line mode will NOT be affected by
4743 this option. Note that this option can be changed at any time
4744 allowing to switch between mappings for different languages/encodings.
4745 Use a mapping to avoid having to type it each time!
4746
4747 *'langmenu'* *'lm'*
4748'langmenu' 'lm' string (default "")
4749 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004750 {only available when compiled with the |+menu| and
4751 |+multi_lang| features}
4752 Language to use for menu translation. Tells which file is loaded
4753 from the "lang" directory in 'runtimepath': >
4754 "lang/menu_" . &langmenu . ".vim"
4755< (without the spaces). For example, to always use the Dutch menus, no
4756 matter what $LANG is set to: >
4757 :set langmenu=nl_NL.ISO_8859-1
4758< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004759 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004760 If your $LANG is set to a non-English language but you do want to use
4761 the English menus: >
4762 :set langmenu=none
4763< This option must be set before loading menus, switching on filetype
4764 detection or syntax highlighting. Once the menus are defined setting
4765 this option has no effect. But you could do this: >
4766 :source $VIMRUNTIME/delmenu.vim
4767 :set langmenu=de_DE.ISO_8859-1
4768 :source $VIMRUNTIME/menu.vim
4769< Warning: This deletes all menus that you defined yourself!
4770
Bram Moolenaard94464e2015-11-02 15:28:18 +01004771 *'langnoremap'* *'lnr'* *'nolangnoremap'* *'nolnr'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004772'langnoremap' 'lnr' boolean (default off, set in |defaults.vim|)
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004773 global
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004774 {only available when compiled with the |+langmap|
4775 feature}
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004776 This is just like 'langremap' but with the value inverted. It only
4777 exists for backwards compatibility. When setting 'langremap' then
4778 'langnoremap' is set to the inverted value, and the other way around.
4779
4780 *'langremap'* *'lrm'* *'nolangremap'* *'nolrm'*
Bram Moolenaarb17893a2020-03-14 08:19:51 +01004781'langremap' 'lrm' boolean (default on, set to off in |defaults.vim|)
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004782 global
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004783 {only available when compiled with the |+langmap|
4784 feature}
4785 When off, setting 'langmap' does not apply to characters resulting from
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004786 a mapping. This basically means, if you noticed that setting
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004787 'langmap' disables some of your mappings, try resetting this option.
4788 This option defaults to on for backwards compatibility. Set it off if
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004789 that works for you to avoid mappings to break.
4790
Bram Moolenaar071d4272004-06-13 20:20:40 +00004791 *'laststatus'* *'ls'*
4792'laststatus' 'ls' number (default 1)
4793 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004794 The value of this option influences when the last window will have a
4795 status line:
4796 0: never
4797 1: only if there are at least two windows
4798 2: always
4799 The screen looks nicer with a status line if you have several
4800 windows, but it takes another screen line. |status-line|
4801
4802 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
4803'lazyredraw' 'lz' boolean (default off)
4804 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004805 When this option is set, the screen will not be redrawn while
4806 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004807 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00004808 update use |:redraw|.
4809
4810 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
4811'linebreak' 'lbr' boolean (default off)
4812 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02004813 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004814 feature}
Bram Moolenaar946e27a2014-06-25 18:50:27 +02004815 If on, Vim will wrap long lines at a character in 'breakat' rather
Bram Moolenaar071d4272004-06-13 20:20:40 +00004816 than at the last character that fits on the screen. Unlike
4817 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
Bram Moolenaar946e27a2014-06-25 18:50:27 +02004818 it only affects the way the file is displayed, not its contents.
4819 If 'breakindent' is set, line is visually indented. Then, the value
4820 of 'showbreak' is used to put in front of wrapped lines. This option
Bram Moolenaar86b17e92014-07-02 20:00:47 +02004821 is not used when the 'wrap' option is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004822 Note that <Tab> characters after an <EOL> are mostly not displayed
4823 with the right amount of white space.
4824
4825 *'lines'* *E593*
4826'lines' number (default 24 or terminal height)
4827 global
4828 Number of lines of the Vim window.
4829 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00004830 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004831 When Vim is running in the GUI or in a resizable window, setting this
4832 option will cause the window size to be changed. When you only want
4833 to use the size for the GUI, put the command in your |gvimrc| file.
4834 Vim limits the number of lines to what fits on the screen. You can
4835 use this command to get the tallest window possible: >
4836 :set lines=999
Bram Moolenaarf4d11452005-12-02 00:46:37 +00004837< Minimum value is 2, maximum value is 1000.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02004838 If you get fewer lines than expected, check the 'guiheadroom' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004839 When you set this option and Vim is unable to change the physical
4840 number of lines of the display, the display may be messed up.
4841
4842 *'linespace'* *'lsp'*
4843'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
4844 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004845 {only in the GUI}
4846 Number of pixel lines inserted between characters. Useful if the font
4847 uses the full character cell height, making lines touch each other.
4848 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004849 With some fonts there can be too much room between lines (to have
4850 space for ascents and descents). Then it makes sense to set
4851 'linespace' to a negative value. This may cause display problems
4852 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00004853
4854 *'lisp'* *'nolisp'*
4855'lisp' boolean (default off)
4856 local to buffer
4857 {not available when compiled without the |+lispindent|
4858 feature}
4859 Lisp mode: When <Enter> is typed in insert mode set the indent for
4860 the next line to Lisp standards (well, sort of). Also happens with
4861 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
4862 flag in 'cpoptions' changes the method of indenting: Vi compatible or
4863 better. Also see 'lispwords'.
4864 The '-' character is included in keyword characters. Redefines the
4865 "=" operator to use this same indentation algorithm rather than
4866 calling an external program if 'equalprg' is empty.
4867 This option is not used when 'paste' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004868
4869 *'lispwords'* *'lw'*
4870'lispwords' 'lw' string (default is very long)
Bram Moolenaaraf6c1312014-03-12 18:55:58 +01004871 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004872 {not available when compiled without the |+lispindent|
4873 feature}
4874 Comma separated list of words that influence the Lisp indenting.
4875 |'lisp'|
4876
4877 *'list'* *'nolist'*
4878'list' boolean (default off)
4879 local to window
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004880 List mode: Show tabs as CTRL-I is displayed, display $ after end of
4881 line. Useful to see the difference between tabs and spaces and for
4882 trailing blanks. Further changed by the 'listchars' option.
4883
4884 The cursor is displayed at the start of the space a Tab character
4885 occupies, not at the end as usual in Normal mode. To get this cursor
4886 position while displaying Tabs with spaces, use: >
Bram Moolenaardd007ed2013-07-09 15:44:17 +02004887 :set list lcs=tab:\ \
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004888<
4889 Note that list mode will also affect formatting (set with 'textwidth'
4890 or 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
Bram Moolenaar071d4272004-06-13 20:20:40 +00004891 changing the way tabs are displayed.
4892
4893 *'listchars'* *'lcs'*
4894'listchars' 'lcs' string (default "eol:$")
Bram Moolenaareed9d462021-02-15 20:38:25 +01004895 global or local to window |global-local|
Bram Moolenaarf9d5ca12010-08-01 16:13:51 +02004896 Strings to use in 'list' mode and for the |:list| command. It is a
4897 comma separated list of string settings.
Bram Moolenaar79278362015-04-21 18:33:48 +02004898 *lcs-eol*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004899 eol:c Character to show at the end of each line. When
4900 omitted, there is no extra character at the end of the
4901 line.
Bram Moolenaar79278362015-04-21 18:33:48 +02004902 *lcs-tab*
Bram Moolenaar83a52172019-01-16 22:41:54 +01004903 tab:xy[z] Two or three characters to be used to show a tab.
4904 The third character is optional.
4905
4906 tab:xy The 'x' is always used, then 'y' as many times as will
4907 fit. Thus "tab:>-" displays:
4908 >
4909 >-
4910 >--
4911 etc.
4912
4913 tab:xyz The 'z' is always used, then 'x' is prepended, and
4914 then 'y' is used as many times as will fit. Thus
4915 "tab:<->" displays:
4916 >
4917 <>
4918 <->
4919 <-->
4920 etc.
4921
4922 When "tab:" is omitted, a tab is shown as ^I.
Bram Moolenaar79278362015-04-21 18:33:48 +02004923 *lcs-space*
4924 space:c Character to show for a space. When omitted, spaces
4925 are left blank.
Bram Moolenaar91478ae2021-02-03 15:58:13 +01004926 *lcs-lead*
4927 lead:c Character to show for leading spaces. When omitted,
4928 leading spaces are blank. Overrides the "space"
Bram Moolenaar942db232021-02-13 18:14:48 +01004929 setting for leading spaces. You can combine it with
4930 "tab:", for example: >
4931 :set listchars+=tab:>-,lead:.
4932< *lcs-trail*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004933 trail:c Character to show for trailing spaces. When omitted,
Bram Moolenaar79278362015-04-21 18:33:48 +02004934 trailing spaces are blank. Overrides the "space"
4935 setting for trailing spaces.
4936 *lcs-extends*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004937 extends:c Character to show in the last column, when 'wrap' is
4938 off and the line continues beyond the right of the
4939 screen.
Bram Moolenaar79278362015-04-21 18:33:48 +02004940 *lcs-precedes*
Bram Moolenaarbffba7f2019-09-20 17:00:17 +02004941 precedes:c Character to show in the first visible column of the
4942 physical line, when there is text preceding the
4943 character visible in the first column.
Bram Moolenaar79278362015-04-21 18:33:48 +02004944 *lcs-conceal*
Bram Moolenaar860cae12010-06-05 23:22:07 +02004945 conceal:c Character to show in place of concealed text, when
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004946 'conceallevel' is set to 1.
Bram Moolenaar79278362015-04-21 18:33:48 +02004947 *lcs-nbsp*
Bram Moolenaar73284b92015-05-04 17:28:22 +02004948 nbsp:c Character to show for a non-breakable space character
4949 (0xA0 (160 decimal) and U+202F). Left blank when
4950 omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004951
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004952 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00004953 be used when 'encoding' is "utf-8", otherwise only printable
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004954 characters are allowed. All characters must be single width.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004955
4956 Examples: >
4957 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004958 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00004959 :set lcs=extends:>,precedes:<
4960< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaar79278362015-04-21 18:33:48 +02004961 "precedes". "SpecialKey" for "nbsp", "space", "tab" and "trail".
Bram Moolenaar02467872007-05-06 13:22:01 +00004962 |hl-NonText| |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004963
4964 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
4965'loadplugins' 'lpl' boolean (default on)
4966 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004967 When on the plugin scripts are loaded when starting up |load-plugins|.
4968 This option can be reset in your |vimrc| file to disable the loading
4969 of plugins.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02004970 Note that using the "-u NONE", "-u DEFAULTS" and "--noplugin" command
4971 line arguments reset this option. See |-u| and |--noplugin|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004972
Bram Moolenaard94464e2015-11-02 15:28:18 +01004973 *'luadll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01004974'luadll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01004975 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01004976 {only available when compiled with the |+lua/dyn|
4977 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01004978 Specifies the name of the Lua shared library. The default is
4979 DYNAMIC_LUA_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02004980 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01004981 This option cannot be set from a |modeline| or in the |sandbox|, for
4982 security reasons.
4983
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00004984 *'macatsui'* *'nomacatsui'*
4985'macatsui' boolean (default on)
4986 global
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02004987 {not supported}
4988 No longer supported, as the Mac OS X GUI code was removed.
Bram Moolenaar02467872007-05-06 13:22:01 +00004989
Bram Moolenaar071d4272004-06-13 20:20:40 +00004990 *'magic'* *'nomagic'*
4991'magic' boolean (default on)
4992 global
4993 Changes the special characters that can be used in search patterns.
4994 See |pattern|.
Bram Moolenaar64d8e252016-09-06 22:12:34 +02004995 WARNING: Switching this option off most likely breaks plugins! That
4996 is because many patterns assume it's on and will fail when it's off.
4997 Only switch it off when working with old Vi scripts. In any other
4998 situation write patterns that work when 'magic' is on. Include "\M"
4999 when you want to |/\M|.
Bram Moolenaar4072ba52020-12-23 13:56:35 +01005000 In |Vim9| script the value of 'magic' is ignored, patterns behave like
5001 it is always set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005002
5003 *'makeef'* *'mef'*
5004'makeef' 'mef' string (default: "")
5005 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005006 {not available when compiled without the |+quickfix|
5007 feature}
5008 Name of the errorfile for the |:make| command (see |:make_makeprg|)
5009 and the |:grep| command.
5010 When it is empty, an internally generated temp file will be used.
5011 When "##" is included, it is replaced by a number to make the name
5012 unique. This makes sure that the ":make" command doesn't overwrite an
5013 existing file.
5014 NOT used for the ":cf" command. See 'errorfile' for that.
5015 Environment variables are expanded |:set_env|.
5016 See |option-backslash| about including spaces and backslashes.
5017 This option cannot be set from a |modeline| or in the |sandbox|, for
5018 security reasons.
5019
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01005020 *'makeencoding'* *'menc'*
5021'makeencoding' 'menc' string (default "")
5022 global or local to buffer |global-local|
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01005023 Encoding used for reading the output of external commands. When empty,
5024 encoding is not converted.
5025 This is used for `:make`, `:lmake`, `:grep`, `:lgrep`, `:grepadd`,
5026 `:lgrepadd`, `:cfile`, `:cgetfile`, `:caddfile`, `:lfile`, `:lgetfile`,
5027 and `:laddfile`.
5028
5029 This would be mostly useful when you use MS-Windows and set 'encoding'
5030 to "utf-8". If |+iconv| is enabled and GNU libiconv is used, setting
5031 'makeencoding' to "char" has the same effect as setting to the system
5032 locale encoding. Example: >
5033 :set encoding=utf-8
5034 :set makeencoding=char " system locale is used
5035<
Bram Moolenaar071d4272004-06-13 20:20:40 +00005036 *'makeprg'* *'mp'*
5037'makeprg' 'mp' string (default "make", VMS: "MMS")
5038 global or local to buffer |global-local|
Bram Moolenaar02467872007-05-06 13:22:01 +00005039 Program to use for the ":make" command. See |:make_makeprg|.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01005040 This option may contain '%' and '#' characters (see |:_%| and |:_#|),
5041 which are expanded to the current and alternate file name. Use |::S|
Bram Moolenaar26df0922014-02-23 23:39:13 +01005042 to escape file names in case they contain special characters.
Bram Moolenaar02467872007-05-06 13:22:01 +00005043 Environment variables are expanded |:set_env|. See |option-backslash|
5044 about including spaces and backslashes.
5045 Note that a '|' must be escaped twice: once for ":set" and once for
5046 the interpretation of a command. When you use a filter called
5047 "myfilter" do it like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005048 :set makeprg=gmake\ \\\|\ myfilter
5049< The placeholder "$*" can be given (even multiple times) to specify
5050 where the arguments will be included, for example: >
5051 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
5052< This option cannot be set from a |modeline| or in the |sandbox|, for
5053 security reasons.
5054
5055 *'matchpairs'* *'mps'*
5056'matchpairs' 'mps' string (default "(:),{:},[:]")
5057 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005058 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01005059 other.
5060 Only character pairs are allowed that are different, thus you cannot
5061 jump between two double quotes.
5062 The characters must be separated by a colon.
Bram Moolenaar02467872007-05-06 13:22:01 +00005063 The pairs must be separated by a comma. Example for including '<' and
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02005064 '>' (for HTML): >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005065 :set mps+=<:>
5066
5067< A more exotic example, to jump between the '=' and ';' in an
5068 assignment, useful for languages like C and Java: >
5069 :au FileType c,cpp,java set mps+==:;
5070
5071< For a more advanced way of using "%", see the matchit.vim plugin in
Bram Moolenaar01164a62017-11-02 22:58:42 +01005072 the $VIMRUNTIME/pack/dist/opt/matchit directory. |add-local-help|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005073
5074 *'matchtime'* *'mat'*
5075'matchtime' 'mat' number (default 5)
5076 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005077 Tenths of a second to show the matching paren, when 'showmatch' is
5078 set. Note that this is not in milliseconds, like other options that
5079 set a time. This is to be compatible with Nvi.
5080
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005081 *'maxcombine'* *'mco'*
5082'maxcombine' 'mco' number (default 2)
5083 global
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005084 The maximum number of combining characters supported for displaying.
5085 Only used when 'encoding' is "utf-8".
5086 The default is OK for most languages. Hebrew may require 4.
5087 Maximum value is 6.
5088 Even when this option is set to 2 you can still edit text with more
5089 combining characters, you just can't see them. Use |g8| or |ga|.
5090 See |mbyte-combining|.
5091
Bram Moolenaar071d4272004-06-13 20:20:40 +00005092 *'maxfuncdepth'* *'mfd'*
5093'maxfuncdepth' 'mfd' number (default 100)
5094 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02005095 {not available when compiled without the |+eval|
Bram Moolenaar02467872007-05-06 13:22:01 +00005096 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005097 Maximum depth of function calls for user functions. This normally
5098 catches endless recursion. When using a recursive function with
5099 more depth, set 'maxfuncdepth' to a bigger number. But this will use
5100 more memory, there is the danger of failing when memory is exhausted.
Bram Moolenaarbc2eada2017-01-02 21:27:47 +01005101 Increasing this limit above 200 also changes the maximum for Ex
Bram Moolenaar0b0f0992018-05-22 21:41:30 +02005102 command recursion, see |E169|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005103 See also |:function|.
5104
5105 *'maxmapdepth'* *'mmd'* *E223*
5106'maxmapdepth' 'mmd' number (default 1000)
5107 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005108 Maximum number of times a mapping is done without resulting in a
5109 character to be used. This normally catches endless mappings, like
5110 ":map x y" with ":map y x". It still does not catch ":map g wg",
5111 because the 'w' is used before the next mapping is done. See also
5112 |key-mapping|.
5113
5114 *'maxmem'* *'mm'*
5115'maxmem' 'mm' number (default between 256 to 5120 (system
5116 dependent) or half the amount of memory
5117 available)
5118 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005119 Maximum amount of memory (in Kbyte) to use for one buffer. When this
5120 limit is reached allocating extra memory for a buffer will cause
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005121 other memory to be freed.
5122 The maximum usable value is about 2000000. Use this to work without a
5123 limit.
5124 The value is ignored when 'swapfile' is off.
5125 Also see 'maxmemtot'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005126
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005127 *'maxmempattern'* *'mmp'*
5128'maxmempattern' 'mmp' number (default 1000)
5129 global
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005130 Maximum amount of memory (in Kbyte) to use for pattern matching.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005131 The maximum value is about 2000000. Use this to work without a limit.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005132 *E363*
Bram Moolenaar02467872007-05-06 13:22:01 +00005133 When Vim runs into the limit it gives an error message and mostly
5134 behaves like CTRL-C was typed.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005135 Running into the limit often means that the pattern is very
5136 inefficient or too complex. This may already happen with the pattern
5137 "\(.\)*" on a very long line. ".*" works much better.
Bram Moolenaarfd358112018-07-07 23:21:31 +02005138 Might also happen on redraw, when syntax rules try to match a complex
5139 text structure.
5140 Vim may run out of memory before hitting the 'maxmempattern' limit, in
5141 which case you get an "Out of memory" error instead.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005142
Bram Moolenaar071d4272004-06-13 20:20:40 +00005143 *'maxmemtot'* *'mmt'*
5144'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
5145 dependent) or half the amount of memory
5146 available)
5147 global
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005148 Maximum amount of memory in Kbyte to use for all buffers together.
5149 The maximum usable value is about 2000000 (2 Gbyte). Use this to work
Bram Moolenaarfa735342016-01-03 22:14:44 +01005150 without a limit.
5151 On 64 bit machines higher values might work. But hey, do you really
5152 need more than 2 Gbyte for text editing? Keep in mind that text is
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005153 stored in the swap file, one can edit files > 2 Gbyte anyway. We do
Bram Moolenaarfa735342016-01-03 22:14:44 +01005154 need the memory to store undo info.
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005155 Buffers with 'swapfile' off still count to the total amount of memory
5156 used.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005157 Also see 'maxmem'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005158
5159 *'menuitems'* *'mis'*
5160'menuitems' 'mis' number (default 25)
5161 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005162 {not available when compiled without the |+menu|
5163 feature}
5164 Maximum number of items to use in a menu. Used for menus that are
5165 generated from a list of items, e.g., the Buffers menu. Changing this
5166 option has no direct effect, the menu must be refreshed first.
5167
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005168 *'mkspellmem'* *'msm'*
5169'mkspellmem' 'msm' string (default "460000,2000,500")
5170 global
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005171 {not available when compiled without the |+syntax|
5172 feature}
5173 Parameters for |:mkspell|. This tunes when to start compressing the
5174 word tree. Compression can be slow when there are many words, but
5175 it's needed to avoid running out of memory. The amount of memory used
5176 per word depends very much on how similar the words are, that's why
5177 this tuning is complicated.
5178
5179 There are three numbers, separated by commas:
5180 {start},{inc},{added}
5181
5182 For most languages the uncompressed word tree fits in memory. {start}
5183 gives the amount of memory in Kbyte that can be used before any
5184 compression is done. It should be a bit smaller than the amount of
5185 memory that is available to Vim.
5186
5187 When going over the {start} limit the {inc} number specifies the
5188 amount of memory in Kbyte that can be allocated before another
5189 compression is done. A low number means compression is done after
5190 less words are added, which is slow. A high number means more memory
5191 will be allocated.
5192
5193 After doing compression, {added} times 1024 words can be added before
5194 the {inc} limit is ignored and compression is done when any extra
5195 amount of memory is needed. A low number means there is a smaller
5196 chance of hitting the {inc} limit, less memory is used but it's
5197 slower.
5198
5199 The languages for which these numbers are important are Italian and
5200 Hungarian. The default works for when you have about 512 Mbyte. If
5201 you have 1 Gbyte you could use: >
5202 :set mkspellmem=900000,3000,800
5203< If you have less than 512 Mbyte |:mkspell| may fail for some
5204 languages, no matter what you set 'mkspellmem' to.
5205
Bram Moolenaar07607392019-05-26 19:20:43 +02005206 This option cannot be set from a |modeline| or in the |sandbox|.
5207
Bram Moolenaar071d4272004-06-13 20:20:40 +00005208 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
Bram Moolenaar8243a792007-05-01 17:05:03 +00005209'modeline' 'ml' boolean (Vim default: on (off for root),
5210 Vi default: off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005211 local to buffer
Bram Moolenaar110289e2019-05-23 15:38:06 +02005212 If 'modeline' is on 'modelines' gives the number of lines that is
5213 checked for set commands. If 'modeline' is off or 'modelines' is zero
5214 no lines are checked. See |modeline|.
5215
5216 *'modelineexpr'* *'mle'* *'nomodelineexpr'* *'nomle'*
5217'modelineexpr' 'mle' boolean (default: off)
5218 global
5219 When on allow some options that are an expression to be set in the
5220 modeline. Check the option for whether it is affected by
5221 'modelineexpr'. Also see |modeline|.
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02005222 This option cannot be set from a |modeline| or in the |sandbox|, for
5223 security reasons.
Bram Moolenaar110289e2019-05-23 15:38:06 +02005224
Bram Moolenaar071d4272004-06-13 20:20:40 +00005225 *'modelines'* *'mls'*
5226'modelines' 'mls' number (default 5)
5227 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005228 If 'modeline' is on 'modelines' gives the number of lines that is
5229 checked for set commands. If 'modeline' is off or 'modelines' is zero
5230 no lines are checked. See |modeline|.
5231 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
5232 set and to the Vim default value when 'compatible' is reset.
5233
5234 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
Bram Moolenaar110289e2019-05-23 15:38:06 +02005235 *E21*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005236'modifiable' 'ma' boolean (default on)
5237 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005238 When off the buffer contents cannot be changed. The 'fileformat' and
5239 'fileencoding' options also can't be changed.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01005240 Can be reset on startup with the |-M| command line argument.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005241
5242 *'modified'* *'mod'* *'nomodified'* *'nomod'*
5243'modified' 'mod' boolean (default off)
5244 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005245 When on, the buffer is considered to be modified. This option is set
5246 when:
5247 1. A change was made to the text since it was last written. Using the
5248 |undo| command to go back to the original text will reset the
5249 option. But undoing changes that were made before writing the
5250 buffer will set the option again, since the text is different from
5251 when it was written.
5252 2. 'fileformat' or 'fileencoding' is different from its original
5253 value. The original value is set when the buffer is read or
5254 written. A ":set nomodified" command also resets the original
5255 values to the current values and the 'modified' option will be
5256 reset.
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01005257 Similarly for 'eol' and 'bomb'.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02005258 This option is not set when a change is made to the buffer as the
5259 result of a BufNewFile, BufRead/BufReadPost, BufWritePost,
5260 FileAppendPost or VimLeave autocommand event. See |gzip-example| for
5261 an explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005262 When 'buftype' is "nowrite" or "nofile" this option may be set, but
5263 will be ignored.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01005264 Note that the text may actually be the same, e.g. 'modified' is set
5265 when using "rA" on an "A".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005266
5267 *'more'* *'nomore'*
5268'more' boolean (Vim default: on, Vi default: off)
5269 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005270 When on, listings pause when the whole screen is filled. You will get
5271 the |more-prompt|. When this option is off there are no pauses, the
5272 listing continues until finished.
5273 NOTE: This option is set to the Vi default value when 'compatible' is
5274 set and to the Vim default value when 'compatible' is reset.
5275
Bram Moolenaar98a29d02021-01-18 19:55:44 +01005276 *'mouse'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005277'mouse' string (default "", "a" for GUI and Win32,
Bram Moolenaar5b418992019-10-27 18:50:25 +01005278 set to "a" or "nvi" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005279 global
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005280 Enable the use of the mouse. Works for most terminals (xterm, Win32
5281 |win32-mouse|, QNX pterm, *BSD console with sysmouse and Linux console
5282 with gpm). For using the mouse in the GUI, see |gui-mouse|. The
5283 mouse can be enabled for different modes:
Bram Moolenaar7f2e9d72017-11-11 20:58:53 +01005284 n Normal mode and Terminal modes
Bram Moolenaar071d4272004-06-13 20:20:40 +00005285 v Visual mode
5286 i Insert mode
5287 c Command-line mode
5288 h all previous modes when editing a help file
5289 a all previous modes
5290 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005291 Normally you would enable the mouse in all five modes with: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005292 :set mouse=a
Bram Moolenaar5b418992019-10-27 18:50:25 +01005293< If your terminal can't overrule the mouse events going to the
5294 application, use: >
5295 :set mouse=nvi
Bram Moolenaar65e0d772020-06-14 17:29:55 +02005296< Then you can press ":", select text for the system, and press Esc to go
Bram Moolenaar5b418992019-10-27 18:50:25 +01005297 back to Vim using the mouse events.
5298 In |defaults.vim| "nvi" is used if the 'term' option is not matching
5299 "xterm".
5300
5301 When the mouse is not enabled, the GUI will still use the mouse for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005302 modeless selection. This doesn't move the text cursor.
5303
5304 See |mouse-using|. Also see |'clipboard'|.
5305
5306 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005307 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005308 the mouse buttons can still be used by keeping the shift key pressed.
5309 Also see the 'clipboard' option.
5310
5311 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
5312'mousefocus' 'mousef' boolean (default off)
5313 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005314 {only works in the GUI}
5315 The window that the mouse pointer is on is automatically activated.
5316 When changing the window layout or window focus in another way, the
5317 mouse pointer is moved to the window with keyboard focus. Off is the
5318 default because it makes using the pull down menus a little goofy, as
5319 a pointer transit may activate a window unintentionally.
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01005320 MS-Windows: Also see 'scrollfocus' for what window is scrolled when
Bram Moolenaar1d9215b2020-01-25 13:27:42 +01005321 using the mouse scroll wheel.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005322
5323 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
5324'mousehide' 'mh' boolean (default on)
5325 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005326 {only works in the GUI}
5327 When on, the mouse pointer is hidden when characters are typed.
5328 The mouse pointer is restored when the mouse is moved.
5329
5330 *'mousemodel'* *'mousem'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005331'mousemodel' 'mousem' string (default "extend", "popup" for Win32)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005332 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005333 Sets the model to use for the mouse. The name mostly specifies what
5334 the right mouse button is used for:
5335 extend Right mouse button extends a selection. This works
5336 like in an xterm.
5337 popup Right mouse button pops up a menu. The shifted left
5338 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00005339 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005340 popup_setpos Like "popup", but the cursor will be moved to the
5341 position where the mouse was clicked, and thus the
5342 selected operation will act upon the clicked object.
5343 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00005344 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005345 course, that right clicking outside a selection will
5346 end Visual mode.
5347 Overview of what button does what for each model:
5348 mouse extend popup(_setpos) ~
5349 left click place cursor place cursor
5350 left drag start selection start selection
5351 shift-left search word extend selection
5352 right click extend selection popup menu (place cursor)
5353 right drag extend selection -
5354 middle click paste paste
5355
5356 In the "popup" model the right mouse button produces a pop-up menu.
5357 You need to define this first, see |popup-menu|.
5358
5359 Note that you can further refine the meaning of buttons with mappings.
5360 See |gui-mouse-mapping|. But mappings are NOT used for modeless
5361 selection (because that's handled in the GUI code directly).
5362
5363 The 'mousemodel' option is set by the |:behave| command.
5364
5365 *'mouseshape'* *'mouses'* *E547*
Bram Moolenaarf6b40102019-02-22 15:24:03 +01005366'mouseshape' 'mouses' string (default "i-r:beam,s:updown,sd:udsizing,
5367 vs:leftright,vd:lrsizing,m:no,
5368 ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005369 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005370 {only available when compiled with the |+mouseshape|
5371 feature}
5372 This option tells Vim what the mouse pointer should look like in
5373 different modes. The option is a comma separated list of parts, much
5374 like used for 'guicursor'. Each part consist of a mode/location-list
5375 and an argument-list:
5376 mode-list:shape,mode-list:shape,..
5377 The mode-list is a dash separated list of these modes/locations:
5378 In a normal window: ~
5379 n Normal mode
5380 v Visual mode
5381 ve Visual mode with 'selection' "exclusive" (same as 'v',
5382 if not specified)
5383 o Operator-pending mode
5384 i Insert mode
5385 r Replace mode
5386
5387 Others: ~
5388 c appending to the command-line
5389 ci inserting in the command-line
5390 cr replacing in the command-line
5391 m at the 'Hit ENTER' or 'More' prompts
5392 ml idem, but cursor in the last line
5393 e any mode, pointer below last window
5394 s any mode, pointer on a status line
5395 sd any mode, while dragging a status line
5396 vs any mode, pointer on a vertical separator line
5397 vd any mode, while dragging a vertical separator line
5398 a everywhere
5399
5400 The shape is one of the following:
5401 avail name looks like ~
5402 w x arrow Normal mouse pointer
5403 w x blank no pointer at all (use with care!)
5404 w x beam I-beam
5405 w x updown up-down sizing arrows
5406 w x leftright left-right sizing arrows
5407 w x busy The system's usual busy pointer
5408 w x no The system's usual 'no input' pointer
5409 x udsizing indicates up-down resizing
5410 x lrsizing indicates left-right resizing
5411 x crosshair like a big thin +
5412 x hand1 black hand
5413 x hand2 white hand
5414 x pencil what you write with
5415 x question big ?
5416 x rightup-arrow arrow pointing right-up
5417 w x up-arrow arrow pointing up
5418 x <number> any X11 pointer number (see X11/cursorfont.h)
5419
5420 The "avail" column contains a 'w' if the shape is available for Win32,
5421 x for X11.
5422 Any modes not specified or shapes not available use the normal mouse
5423 pointer.
5424
5425 Example: >
5426 :set mouseshape=s:udsizing,m:no
5427< will make the mouse turn to a sizing arrow over the status lines and
5428 indicate no input when the hit-enter prompt is displayed (since
5429 clicking the mouse has no effect in this state.)
5430
5431 *'mousetime'* *'mouset'*
5432'mousetime' 'mouset' number (default 500)
5433 global
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005434 Only for GUI, Win32 and Unix with xterm. Defines the maximum
Bram Moolenaar071d4272004-06-13 20:20:40 +00005435 time in msec between two mouse clicks for the second click to be
5436 recognized as a multi click.
5437
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005438 *'mzschemedll'*
5439'mzschemedll' string (default depends on the build)
5440 global
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005441 {only available when compiled with the |+mzscheme/dyn|
5442 feature}
5443 Specifies the name of the MzScheme shared library. The default is
5444 DYNAMIC_MZSCH_DLL which was specified at compile time.
5445 Environment variables are expanded |:set_env|.
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01005446 The value must be set in the |vimrc| script or earlier. In the
Bram Moolenaar01164a62017-11-02 22:58:42 +01005447 startup, before the |load-plugins| step.
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005448 This option cannot be set from a |modeline| or in the |sandbox|, for
5449 security reasons.
5450
5451 *'mzschemegcdll'*
5452'mzschemegcdll' string (default depends on the build)
5453 global
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005454 {only available when compiled with the |+mzscheme/dyn|
5455 feature}
5456 Specifies the name of the MzScheme GC shared library. The default is
5457 DYNAMIC_MZGC_DLL which was specified at compile time.
5458 The value can be equal to 'mzschemedll' if it includes the GC code.
5459 Environment variables are expanded |:set_env|.
5460 This option cannot be set from a |modeline| or in the |sandbox|, for
5461 security reasons.
5462
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005463 *'mzquantum'* *'mzq'*
5464'mzquantum' 'mzq' number (default 100)
5465 global
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005466 {not available when compiled without the |+mzscheme|
5467 feature}
5468 The number of milliseconds between polls for MzScheme threads.
5469 Negative or zero value means no thread scheduling.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005470 NOTE: This option is set to the Vim default value when 'compatible'
5471 is reset.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005472
Bram Moolenaar071d4272004-06-13 20:20:40 +00005473 *'nrformats'* *'nf'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02005474'nrformats' 'nf' string (default "bin,octal,hex",
5475 set to "bin,hex" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005476 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005477 This defines what bases Vim will consider for numbers when using the
5478 CTRL-A and CTRL-X commands for adding to and subtracting from a number
5479 respectively; see |CTRL-A| for more info on these commands.
Bram Moolenaar4770d092006-01-12 23:22:24 +00005480 alpha If included, single alphabetical characters will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005481 incremented or decremented. This is useful for a list with a
Bram Moolenaar3848e002016-03-19 18:42:29 +01005482 letter index a), b), etc. *octal-nrformats*
Bram Moolenaar4770d092006-01-12 23:22:24 +00005483 octal If included, numbers that start with a zero will be considered
Bram Moolenaar071d4272004-06-13 20:20:40 +00005484 to be octal. Example: Using CTRL-A on "007" results in "010".
Bram Moolenaar4770d092006-01-12 23:22:24 +00005485 hex If included, numbers starting with "0x" or "0X" will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005486 considered to be hexadecimal. Example: Using CTRL-X on
5487 "0x100" results in "0x0ff".
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005488 bin If included, numbers starting with "0b" or "0B" will be
5489 considered to be binary. Example: Using CTRL-X on
5490 "0b1000" subtracts one, resulting in "0b0111".
Bram Moolenaaraaad9952020-05-31 15:08:59 +02005491 unsigned If included, numbers are recognized as unsigned. Thus a
5492 leading dash or negative sign won't be considered as part of
5493 the number. Examples:
5494 Using CTRL-X on "2020" in "9-2020" results in "9-2019"
5495 (without "unsigned" it would become "9-2021").
5496 Using CTRL-A on "2020" in "9-2020" results in "9-2021"
5497 (without "unsigned" it would become "9-2019").
Bram Moolenaaracc22402020-06-07 21:07:18 +02005498 Using CTRL-X on "0" or CTRL-A on "18446744073709551615"
5499 (2^64 - 1) has no effect, overflow is prevented.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005500 Numbers which simply begin with a digit in the range 1-9 are always
5501 considered decimal. This also happens for numbers that are not
5502 recognized as octal or hex.
5503
5504 *'number'* *'nu'* *'nonumber'* *'nonu'*
5505'number' 'nu' boolean (default off)
5506 local to window
5507 Print the line number in front of each line. When the 'n' option is
5508 excluded from 'cpoptions' a wrapped line will not use the column of
5509 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005510 The 'numberwidth' option can be used to set the room used for the line
5511 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005512 When a long, wrapped line doesn't start with the first character, '-'
5513 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02005514 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
5515 the number.
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005516 *number_relativenumber*
5517 The 'relativenumber' option changes the displayed number to be
5518 relative to the cursor. Together with 'number' there are these
5519 four combinations (cursor in line 3):
5520
Bram Moolenaar3848e002016-03-19 18:42:29 +01005521 'nonu' 'nu' 'nonu' 'nu'
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005522 'nornu' 'nornu' 'rnu' 'rnu'
5523
5524 |apple | 1 apple | 2 apple | 2 apple
5525 |pear | 2 pear | 1 pear | 1 pear
5526 |nobody | 3 nobody | 0 nobody |3 nobody
5527 |there | 4 there | 1 there | 1 there
Bram Moolenaar071d4272004-06-13 20:20:40 +00005528
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005529 *'numberwidth'* *'nuw'*
5530'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
5531 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005532 {only available when compiled with the |+linebreak|
5533 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005534 Minimal number of columns to use for the line number. Only relevant
Bram Moolenaar64486672010-05-16 15:46:46 +02005535 when the 'number' or 'relativenumber' option is set or printing lines
5536 with a line number. Since one space is always between the number and
5537 the text, there is one less character for the number itself.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005538 The value is the minimum width. A bigger width is used when needed to
Bram Moolenaar64486672010-05-16 15:46:46 +02005539 fit the highest line number in the buffer respectively the number of
5540 rows in the window, depending on whether 'number' or 'relativenumber'
5541 is set. Thus with the Vim default of 4 there is room for a line number
5542 up to 999. When the buffer has 1000 lines five columns will be used.
Bram Moolenaarf8a07122019-07-01 22:06:07 +02005543 The minimum value is 1, the maximum value is 20.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005544 NOTE: This option is set to the Vi default value when 'compatible' is
5545 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005546
Bram Moolenaarf75a9632005-09-13 21:20:47 +00005547 *'omnifunc'* *'ofu'*
5548'omnifunc' 'ofu' string (default: empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00005549 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02005550 {not available when compiled without the |+eval|
Bram Moolenaare2c453d2019-08-21 14:37:09 +02005551 feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00005552 This option specifies a function to be used for Insert mode omni
5553 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
Bram Moolenaar280f1262006-01-30 00:14:18 +00005554 See |complete-functions| for an explanation of how the function is
5555 invoked and what it should return.
Bram Moolenaar043545e2006-10-10 16:44:07 +00005556 This option is usually set by a filetype plugin:
Bram Moolenaar9c102382006-05-03 21:26:49 +00005557 |:filetype-plugin-on|
Bram Moolenaar30b65812012-07-12 22:01:11 +02005558 This option cannot be set from a |modeline| or in the |sandbox|, for
5559 security reasons.
Bram Moolenaare344bea2005-09-01 20:46:49 +00005560
5561
Bram Moolenaar02467872007-05-06 13:22:01 +00005562 *'opendevice'* *'odev'* *'noopendevice'* *'noodev'*
Bram Moolenaar043545e2006-10-10 16:44:07 +00005563'opendevice' 'odev' boolean (default off)
5564 global
Bram Moolenaar6f345a12019-12-17 21:27:18 +01005565 {only for MS-Windows}
Bram Moolenaar043545e2006-10-10 16:44:07 +00005566 Enable reading and writing from devices. This may get Vim stuck on a
5567 device that can be opened but doesn't actually do the I/O. Therefore
5568 it is off by default.
5569 Note that on MS-Windows editing "aux.h", "lpt1.txt" and the like also
5570 result in editing a device.
5571
5572
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005573 *'operatorfunc'* *'opfunc'*
5574'operatorfunc' 'opfunc' string (default: empty)
5575 global
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005576 This option specifies a function to be called by the |g@| operator.
5577 See |:map-operator| for more info and an example.
5578
5579 This option cannot be set from a |modeline| or in the |sandbox|, for
5580 security reasons.
5581
5582
Bram Moolenaar251e1912011-06-19 05:09:16 +02005583 *'osfiletype'* *'oft'*
5584'osfiletype' 'oft' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005585 local to buffer
Bram Moolenaar251e1912011-06-19 05:09:16 +02005586 This option was supported on RISC OS, which has been removed.
5587
Bram Moolenaar071d4272004-06-13 20:20:40 +00005588
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005589 *'packpath'* *'pp'*
5590'packpath' 'pp' string (default: see 'runtimepath')
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005591 Directories used to find packages. See |packages|.
5592
5593
Bram Moolenaar071d4272004-06-13 20:20:40 +00005594 *'paragraphs'* *'para'*
Bram Moolenaar57e48462008-03-12 16:38:55 +00005595'paragraphs' 'para' string (default "IPLPPPQPP TPHPLIPpLpItpplpipbp")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005596 global
5597 Specifies the nroff macros that separate paragraphs. These are pairs
5598 of two letters (see |object-motions|).
5599
5600 *'paste'* *'nopaste'*
5601'paste' boolean (default off)
5602 global
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005603 Put Vim in Paste mode. This is useful if you want to cut or copy
5604 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005605 unexpected effects.
5606 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005607 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00005608 knows about pasting and will mostly do the right thing without 'paste'
5609 being set. The same is true for a terminal where Vim handles the
5610 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00005611 This option is reset when starting the GUI. Thus if you set it in
5612 your .vimrc it will work in a terminal, but not in the GUI. Setting
5613 'paste' in the GUI has side effects: e.g., the Paste toolbar button
5614 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005615 When the 'paste' option is switched on (also when it was already on):
5616 - mapping in Insert mode and Command-line mode is disabled
5617 - abbreviations are disabled
Bram Moolenaar071d4272004-06-13 20:20:40 +00005618 - 'autoindent' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02005619 - 'expandtab' is reset
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02005620 - 'hkmap' is reset
Bram Moolenaar071d4272004-06-13 20:20:40 +00005621 - 'revins' is reset
5622 - 'ruler' is reset
5623 - 'showmatch' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02005624 - 'smarttab' is reset
5625 - 'softtabstop' is set to 0
5626 - 'textwidth' is set to 0
5627 - 'wrapmargin' is set to 0
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02005628 - 'varsofttabstop' is made empty
Bram Moolenaar071d4272004-06-13 20:20:40 +00005629 These options keep their value, but their effect is disabled:
Bram Moolenaar071d4272004-06-13 20:20:40 +00005630 - 'cindent'
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02005631 - 'formatoptions' is used like it is empty
Bram Moolenaarca635012015-09-25 20:34:21 +02005632 - 'indentexpr'
5633 - 'lisp'
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02005634 - 'smartindent'
Bram Moolenaar071d4272004-06-13 20:20:40 +00005635 NOTE: When you start editing another file while the 'paste' option is
5636 on, settings from the modelines or autocommands may change the
5637 settings again, causing trouble when pasting text. You might want to
5638 set the 'paste' option again.
5639 When the 'paste' option is reset the mentioned options are restored to
5640 the value before the moment 'paste' was switched from off to on.
5641 Resetting 'paste' before ever setting it does not have any effect.
5642 Since mapping doesn't work while 'paste' is active, you need to use
5643 the 'pastetoggle' option to toggle the 'paste' option with some key.
5644
5645 *'pastetoggle'* *'pt'*
5646'pastetoggle' 'pt' string (default "")
5647 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005648 When non-empty, specifies the key sequence that toggles the 'paste'
5649 option. This is like specifying a mapping: >
5650 :map {keys} :set invpaste<CR>
5651< Where {keys} is the value of 'pastetoggle'.
5652 The difference is that it will work even when 'paste' is set.
5653 'pastetoggle' works in Insert mode and Normal mode, but not in
5654 Command-line mode.
5655 Mappings are checked first, thus overrule 'pastetoggle'. However,
5656 when 'paste' is on mappings are ignored in Insert mode, thus you can do
5657 this: >
5658 :map <F10> :set paste<CR>
5659 :map <F11> :set nopaste<CR>
5660 :imap <F10> <C-O>:set paste<CR>
5661 :imap <F11> <nop>
5662 :set pastetoggle=<F11>
5663< This will make <F10> start paste mode and <F11> stop paste mode.
5664 Note that typing <F10> in paste mode inserts "<F10>", since in paste
5665 mode everything is inserted literally, except the 'pastetoggle' key
5666 sequence.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005667 When the value has several bytes 'ttimeoutlen' applies.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005668
5669 *'pex'* *'patchexpr'*
5670'patchexpr' 'pex' string (default "")
5671 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005672 {not available when compiled without the |+diff|
5673 feature}
5674 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005675 the resulting new version of the file. See |diff-patchexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005676
Bram Moolenaardbc28022014-07-26 13:40:44 +02005677 *'patchmode'* *'pm'* *E205* *E206*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005678'patchmode' 'pm' string (default "")
5679 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005680 When non-empty the oldest version of a file is kept. This can be used
5681 to keep the original version of a file if you are changing files in a
5682 source distribution. Only the first time that a file is written a
5683 copy of the original file will be kept. The name of the copy is the
5684 name of the original file with the string in the 'patchmode' option
5685 appended. This option should start with a dot. Use a string like
Bram Moolenaardf980db2017-12-24 13:22:00 +01005686 ".orig" or ".org". 'backupdir' must not be empty for this to work
5687 (Detail: The backup file is renamed to the patchmode file after the
5688 new file has been successfully written, that's why it must be possible
5689 to write a backup file). If there was no file to be backed up, an
5690 empty file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005691 When the 'backupskip' pattern matches, a patchmode file is not made.
5692 Using 'patchmode' for compressed files appends the extension at the
5693 end (e.g., "file.gz.orig"), thus the resulting name isn't always
5694 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005695 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005696
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01005697 *'path'* *'pa'* *E343* *E345* *E347* *E854*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005698'path' 'pa' string (default on Unix: ".,/usr/include,,"
Bram Moolenaar071d4272004-06-13 20:20:40 +00005699 other systems: ".,,")
5700 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005701 This is a list of directories which will be searched when using the
Bram Moolenaarc236c162008-07-13 17:41:49 +00005702 |gf|, [f, ]f, ^Wf, |:find|, |:sfind|, |:tabfind| and other commands,
5703 provided that the file being searched for has a relative path (not
5704 starting with "/", "./" or "../"). The directories in the 'path'
5705 option may be relative or absolute.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005706 - Use commas to separate directory names: >
5707 :set path=.,/usr/local/include,/usr/include
5708< - Spaces can also be used to separate directory names (for backwards
5709 compatibility with version 3.0). To have a space in a directory
5710 name, precede it with an extra backslash, and escape the space: >
5711 :set path=.,/dir/with\\\ space
5712< - To include a comma in a directory name precede it with an extra
5713 backslash: >
5714 :set path=.,/dir/with\\,comma
5715< - To search relative to the directory of the current file, use: >
5716 :set path=.
5717< - To search in the current directory use an empty string between two
5718 commas: >
5719 :set path=,,
5720< - A directory name may end in a ':' or '/'.
5721 - Environment variables are expanded |:set_env|.
5722 - When using |netrw.vim| URLs can be used. For example, adding
5723 "http://www.vim.org" will make ":find index.html" work.
Bram Moolenaarc236c162008-07-13 17:41:49 +00005724 - Search upwards and downwards in a directory tree using "*", "**" and
5725 ";". See |file-searching| for info and syntax.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005726 {not available when compiled without the |+path_extra| feature}
5727 - Careful with '\' characters, type two to get one in the option: >
5728 :set path=.,c:\\include
5729< Or just use '/' instead: >
5730 :set path=.,c:/include
5731< Don't forget "." or files won't even be found in the same directory as
5732 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005733 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00005734 it is something like 256 or 1024 characters.
5735 You can check if all the include files are found, using the value of
5736 'path', see |:checkpath|.
5737 The use of |:set+=| and |:set-=| is preferred when adding or removing
5738 directories from the list. This avoids problems when a future version
5739 uses another default. To remove the current directory use: >
5740 :set path-=
5741< To add the current directory use: >
5742 :set path+=
5743< To use an environment variable, you probably need to replace the
5744 separator. Here is an example to append $INCL, in which directory
5745 names are separated with a semi-colon: >
5746 :let &path = &path . "," . substitute($INCL, ';', ',', 'g')
5747< Replace the ';' with a ':' or whatever separator is used. Note that
5748 this doesn't work when $INCL contains a comma or white space.
5749
Bram Moolenaar37c64c72017-09-19 22:06:03 +02005750 *'perldll'*
5751'perldll' string (default depends on the build)
5752 global
Bram Moolenaar37c64c72017-09-19 22:06:03 +02005753 {only available when compiled with the |+perl/dyn|
5754 feature}
5755 Specifies the name of the Perl shared library. The default is
5756 DYNAMIC_PERL_DLL, which was specified at compile time.
5757 Environment variables are expanded |:set_env|.
5758 This option cannot be set from a |modeline| or in the |sandbox|, for
5759 security reasons.
5760
Bram Moolenaar071d4272004-06-13 20:20:40 +00005761 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
5762'preserveindent' 'pi' boolean (default off)
5763 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005764 When changing the indent of the current line, preserve as much of the
5765 indent structure as possible. Normally the indent is replaced by a
5766 series of tabs followed by spaces as required (unless |'expandtab'| is
5767 enabled, in which case only spaces are used). Enabling this option
5768 means the indent will preserve as many existing characters as possible
5769 for indenting, and only add additional tabs or spaces as required.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005770 'expandtab' does not apply to the preserved white space, a Tab remains
5771 a Tab.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005772 NOTE: When using ">>" multiple times the resulting indent is a mix of
5773 tabs and spaces. You might not like this.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005774 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005775 Also see 'copyindent'.
5776 Use |:retab| to clean up white space.
5777
5778 *'previewheight'* *'pvh'*
5779'previewheight' 'pvh' number (default 12)
5780 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02005781 {not available when compiled without the |+quickfix|
5782 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005783 Default height for a preview window. Used for |:ptag| and associated
Bram Moolenaar79648732019-07-18 21:43:07 +02005784 commands. Used for |CTRL-W_}| when no count is given. Not used when
5785 'previewpopup' is set.
5786
5787 *'previewpopup'* *'pvp'*
5788'previewpopup' 'pvp' string (default empty)
5789 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02005790 {not available when compiled without the |+textprop|
5791 or |+quickfix| feature}
Bram Moolenaar79648732019-07-18 21:43:07 +02005792 When not empty a popup window is used for commands that would open a
5793 preview window. See |preview-popup|.
Bram Moolenaar576a4a62019-08-18 15:25:17 +02005794 Not used for the insert completion info, add "popup" to
5795 'completeopt' for that.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005796
5797 *'previewwindow'* *'nopreviewwindow'*
5798 *'pvw'* *'nopvw'* *E590*
5799'previewwindow' 'pvw' boolean (default off)
5800 local to window
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02005801 {not available when compiled without the |+quickfix|
5802 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005803 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00005804 set. It's normally not set directly, but by using one of the commands
5805 |:ptag|, |:pedit|, etc.
5806
5807 *'printdevice'* *'pdev'*
5808'printdevice' 'pdev' string (default empty)
5809 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005810 {only available when compiled with the |+printer|
5811 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005812 The name of the printer to be used for |:hardcopy|.
5813 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005814 This option cannot be set from a |modeline| or in the |sandbox|, for
5815 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005816
Bram Moolenaar8299df92004-07-10 09:47:34 +00005817 *'printencoding'* *'penc'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005818'printencoding' 'penc' string (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005819 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005820 {only available when compiled with the |+printer|
5821 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005822 Sets the character encoding used when printing.
5823 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005824
5825 *'printexpr'* *'pexpr'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005826'printexpr' 'pexpr' string (default: see below)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005827 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005828 {only available when compiled with the |+printer|
5829 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005830 Expression used to print the PostScript produced with |:hardcopy|.
5831 See |pexpr-option|.
Bram Moolenaar51628222016-12-01 23:03:28 +01005832 This option cannot be set from a |modeline| or in the |sandbox|, for
5833 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005834
Bram Moolenaar8299df92004-07-10 09:47:34 +00005835 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005836'printfont' 'pfn' string (default "courier")
5837 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005838 {only available when compiled with the |+printer|
5839 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005840 The name of the font that will be used for |:hardcopy|.
5841 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005842
5843 *'printheader'* *'pheader'*
5844'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
5845 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005846 {only available when compiled with the |+printer|
5847 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005848 The format of the header produced in |:hardcopy| output.
5849 See |pheader-option|.
5850
5851 *'printmbcharset'* *'pmbcs'*
5852'printmbcharset' 'pmbcs' string (default "")
5853 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01005854 {only available when compiled with the |+printer|
5855 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005856 The CJK character set to be used for CJK output from |:hardcopy|.
5857 See |pmbcs-option|.
5858
5859 *'printmbfont'* *'pmbfn'*
5860'printmbfont' 'pmbfn' string (default "")
5861 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01005862 {only available when compiled with the |+printer|
5863 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005864 List of font names to be used for CJK output from |:hardcopy|.
5865 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005866
5867 *'printoptions'* *'popt'*
5868'printoptions' 'popt' string (default "")
5869 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005870 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005871 List of items that control the format of the output of |:hardcopy|.
5872 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005873
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005874 *'prompt'* *'noprompt'*
5875'prompt' boolean (default on)
5876 global
5877 When on a ":" prompt is used in Ex mode.
5878
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005879 *'pumheight'* *'ph'*
5880'pumheight' 'ph' number (default 0)
5881 global
Bram Moolenaar06a89a52006-04-29 22:01:03 +00005882 Determines the maximum number of items to show in the popup menu for
5883 Insert mode completion. When zero as much space as available is used.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005884 |ins-completion-menu|.
5885
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01005886 *'pumwidth'* *'pw'*
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005887'pumwidth' 'pw' number (default 15)
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01005888 global
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01005889 Determines the minimum width to use for the popup menu for Insert mode
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005890 completion. |ins-completion-menu|.
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01005891
Bram Moolenaard94464e2015-11-02 15:28:18 +01005892 *'pythondll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01005893'pythondll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01005894 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01005895 {only available when compiled with the |+python/dyn|
5896 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005897 Specifies the name of the Python 2.x shared library. The default is
5898 DYNAMIC_PYTHON_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005899 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01005900 This option cannot be set from a |modeline| or in the |sandbox|, for
5901 security reasons.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005902
Bram Moolenaar94073162018-01-31 21:49:05 +01005903 *'pythonhome'*
5904'pythonhome' string (default "")
5905 global
Bram Moolenaar94073162018-01-31 21:49:05 +01005906 {only available when compiled with the |+python/dyn|
5907 feature}
5908 Specifies the name of the Python 2.x home directory. When 'pythonhome'
5909 and the PYTHONHOME environment variable are not set, PYTHON_HOME,
5910 which was specified at compile time, will be used for the Python 2.x
5911 home directory.
5912 Environment variables are expanded |:set_env|.
5913 This option cannot be set from a |modeline| or in the |sandbox|, for
5914 security reasons.
5915
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005916 *'pythonthreedll'*
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005917'pythonthreedll' string (default depends on the build)
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005918 global
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005919 {only available when compiled with the |+python3/dyn|
5920 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005921 Specifies the name of the Python 3 shared library. The default is
5922 DYNAMIC_PYTHON3_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005923 Environment variables are expanded |:set_env|.
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005924 This option cannot be set from a |modeline| or in the |sandbox|, for
5925 security reasons.
5926
Bram Moolenaar94073162018-01-31 21:49:05 +01005927 *'pythonthreehome'*
5928'pythonthreehome' string (default "")
5929 global
Bram Moolenaar94073162018-01-31 21:49:05 +01005930 {only available when compiled with the |+python3/dyn|
5931 feature}
5932 Specifies the name of the Python 3 home directory. When
5933 'pythonthreehome' and the PYTHONHOME environment variable are not set,
5934 PYTHON3_HOME, which was specified at compile time, will be used for
5935 the Python 3 home directory.
5936 Environment variables are expanded |:set_env|.
5937 This option cannot be set from a |modeline| or in the |sandbox|, for
5938 security reasons.
5939
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01005940 *'pyxversion'* *'pyx'*
5941'pyxversion' 'pyx' number (default depends on the build)
5942 global
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01005943 {only available when compiled with the |+python| or
5944 the |+python3| feature}
5945 Specifies the python version used for pyx* functions and commands
5946 |python_x|. The default value is as follows:
5947
5948 Compiled with Default ~
5949 |+python| and |+python3| 0
5950 only |+python| 2
5951 only |+python3| 3
5952
5953 Available values are 0, 2 and 3.
5954 If 'pyxversion' is 0, it is set to 2 or 3 after the first execution of
5955 any python2/3 commands or functions. E.g. `:py` sets to 2, and `:py3`
5956 sets to 3. `:pyx` sets it to 3 if Python 3 is available, otherwise sets
5957 to 2 if Python 2 is available.
5958 See also: |has-pythonx|
5959
5960 If Vim is compiled with only |+python| or |+python3| setting
5961 'pyxversion' has no effect. The pyx* functions and commands are
5962 always the same as the compiled version.
5963
5964 This option cannot be set from a |modeline| or in the |sandbox|, for
5965 security reasons.
5966
Bram Moolenaar858ba062020-05-31 23:11:59 +02005967 *'quickfixtextfunc'* *'qftf'*
5968'quickfixtextfunc' 'qftf' string (default "")
5969 global
5970 {only available when compiled with the |+quickfix|
5971 feature}
5972 This option specifies a function to be used to get the text to display
5973 in the quickfix and location list windows. This can be used to
5974 customize the information displayed in the quickfix or location window
5975 for each entry in the corresponding quickfix or location list. See
5976 |quickfix-window-function| for an explanation of how to write the
Bram Moolenaard43906d2020-07-20 21:31:32 +02005977 function and an example. The value can be the name of a function or a
5978 lambda.
Bram Moolenaar858ba062020-05-31 23:11:59 +02005979
5980 This option cannot be set from a |modeline| or in the |sandbox|, for
5981 security reasons.
5982
Bram Moolenaar677ee682005-01-27 14:41:15 +00005983 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005984'quoteescape' 'qe' string (default "\")
5985 local to buffer
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005986 The characters that are used to escape quotes in a string. Used for
5987 objects like a', a" and a` |a'|.
5988 When one of the characters in this option is found inside a string,
5989 the following character will be skipped. The default value makes the
5990 text "foo\"bar\\" considered to be one string.
5991
Bram Moolenaar071d4272004-06-13 20:20:40 +00005992 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
5993'readonly' 'ro' boolean (default off)
5994 local to buffer
5995 If on, writes fail unless you use a '!'. Protects you from
5996 accidentally overwriting a file. Default on when Vim is started
5997 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005998 When using ":w!" the 'readonly' option is reset for the current
5999 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar6c60f472019-04-28 16:00:35 +02006000 When using the ":view" command the 'readonly' option is set for the
6001 newly edited buffer.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01006002 See 'modifiable' for disallowing changes to the buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006003
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006004 *'redrawtime'* *'rdt'*
6005'redrawtime' 'rdt' number (default 2000)
6006 global
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006007 {only available when compiled with the |+reltime|
6008 feature}
6009 The time in milliseconds for redrawing the display. This applies to
Bram Moolenaar15142e22018-04-30 22:19:58 +02006010 searching for patterns for 'hlsearch', |:match| highlighting and syntax
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02006011 highlighting.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006012 When redrawing takes more than this many milliseconds no further
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02006013 matches will be highlighted.
6014 For syntax highlighting the time applies per window. When over the
6015 limit syntax highlighting is disabled until |CTRL-L| is used.
6016 This is used to avoid that Vim hangs when using a very complicated
6017 pattern.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006018
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02006019 *'regexpengine'* *'re'*
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006020'regexpengine' 're' number (default 0)
6021 global
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006022 This selects the default regexp engine. |two-engines|
6023 The possible values are:
6024 0 automatic selection
6025 1 old engine
6026 2 NFA engine
6027 Note that when using the NFA engine and the pattern contains something
6028 that is not supported the pattern will not match. This is only useful
6029 for debugging the regexp engine.
Bram Moolenaarfda37292014-11-05 14:27:36 +01006030 Using automatic selection enables Vim to switch the engine, if the
6031 default engine becomes too costly. E.g., when the NFA engine uses too
6032 many states. This should prevent Vim from hanging on a combination of
6033 a complex pattern with long text.
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006034
Bram Moolenaar64486672010-05-16 15:46:46 +02006035 *'relativenumber'* *'rnu'* *'norelativenumber'* *'nornu'*
6036'relativenumber' 'rnu' boolean (default off)
6037 local to window
Bram Moolenaar64486672010-05-16 15:46:46 +02006038 Show the line number relative to the line with the cursor in front of
Bram Moolenaar06b5d512010-05-22 15:37:44 +02006039 each line. Relative line numbers help you use the |count| you can
Bram Moolenaar64486672010-05-16 15:46:46 +02006040 precede some vertical motion commands (e.g. j k + -) with, without
6041 having to calculate it yourself. Especially useful in combination with
6042 other commands (e.g. y d c < > gq gw =).
6043 When the 'n' option is excluded from 'cpoptions' a wrapped
6044 line will not use the column of line numbers (this is the default when
6045 'compatible' isn't set).
6046 The 'numberwidth' option can be used to set the room used for the line
6047 number.
6048 When a long, wrapped line doesn't start with the first character, '-'
6049 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02006050 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
6051 the number.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01006052
Bram Moolenaar203d04d2013-06-06 21:36:40 +02006053 The number in front of the cursor line also depends on the value of
6054 'number', see |number_relativenumber| for all combinations of the two
6055 options.
Bram Moolenaar64486672010-05-16 15:46:46 +02006056
Bram Moolenaar071d4272004-06-13 20:20:40 +00006057 *'remap'* *'noremap'*
6058'remap' boolean (default on)
6059 global
6060 Allows for mappings to work recursively. If you do not want this for
6061 a single entry, use the :noremap[!] command.
Bram Moolenaara3227e22006-03-08 21:32:40 +00006062 NOTE: To avoid portability problems with Vim scripts, always keep
6063 this option at the default "on". Only switch it off when working with
6064 old Vi scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006065
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006066 *'renderoptions'* *'rop'*
6067'renderoptions' 'rop' string (default: empty)
6068 global
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006069 {only available when compiled with GUI and DIRECTX on
6070 MS-Windows}
6071 Select a text renderer and set its options. The options depend on the
6072 renderer.
6073
6074 Syntax: >
6075 set rop=type:{renderer}(,{name}:{value})*
6076<
6077 Currently, only one optional renderer is available.
6078
6079 render behavior ~
6080 directx Vim will draw text using DirectX (DirectWrite). It makes
6081 drawn glyphs more beautiful than default GDI.
6082 It requires 'encoding' is "utf-8", and only works on
6083 MS-Windows Vista or newer version.
6084
6085 Options:
6086 name meaning type value ~
6087 gamma gamma float 1.0 - 2.2 (maybe)
6088 contrast enhancedContrast float (unknown)
6089 level clearTypeLevel float (unknown)
6090 geom pixelGeometry int 0 - 2 (see below)
6091 renmode renderingMode int 0 - 6 (see below)
6092 taamode textAntialiasMode int 0 - 3 (see below)
Bram Moolenaara338adc2018-01-31 20:51:47 +01006093 scrlines Scroll Lines int (deprecated)
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006094
Bram Moolenaar92467d32017-12-05 13:22:16 +01006095 See this URL for detail (except for scrlines):
6096 https://msdn.microsoft.com/en-us/library/dd368190.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006097
6098 For geom: structure of a device pixel.
6099 0 - DWRITE_PIXEL_GEOMETRY_FLAT
6100 1 - DWRITE_PIXEL_GEOMETRY_RGB
6101 2 - DWRITE_PIXEL_GEOMETRY_BGR
6102
6103 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006104 https://msdn.microsoft.com/en-us/library/dd368114.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006105
6106 For renmode: method of rendering glyphs.
6107 0 - DWRITE_RENDERING_MODE_DEFAULT
6108 1 - DWRITE_RENDERING_MODE_ALIASED
6109 2 - DWRITE_RENDERING_MODE_GDI_CLASSIC
6110 3 - DWRITE_RENDERING_MODE_GDI_NATURAL
6111 4 - DWRITE_RENDERING_MODE_NATURAL
6112 5 - DWRITE_RENDERING_MODE_NATURAL_SYMMETRIC
6113 6 - DWRITE_RENDERING_MODE_OUTLINE
6114
6115 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006116 https://msdn.microsoft.com/en-us/library/dd368118.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006117
6118 For taamode: antialiasing mode used for drawing text.
6119 0 - D2D1_TEXT_ANTIALIAS_MODE_DEFAULT
6120 1 - D2D1_TEXT_ANTIALIAS_MODE_CLEARTYPE
6121 2 - D2D1_TEXT_ANTIALIAS_MODE_GRAYSCALE
6122 3 - D2D1_TEXT_ANTIALIAS_MODE_ALIASED
6123
6124 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006125 https://msdn.microsoft.com/en-us/library/dd368170.aspx
6126
Bram Moolenaara338adc2018-01-31 20:51:47 +01006127 For scrlines:
6128 This was used for optimizing scrolling behavior, however this
6129 is now deprecated. If specified, it is simply ignored.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006130
6131 Example: >
6132 set encoding=utf-8
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006133 set gfn=Ricty_Diminished:h12
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006134 set rop=type:directx
6135<
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006136 If select a raster font (Courier, Terminal or FixedSys which
6137 have ".fon" extension in file name) to 'guifont', it will be
Bram Moolenaar92467d32017-12-05 13:22:16 +01006138 drawn by GDI as a fallback.
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006139
6140 NOTE: It is known that some fonts and options combination
6141 causes trouble on drawing glyphs.
6142
Bram Moolenaar92467d32017-12-05 13:22:16 +01006143 - 'renmode:5' and 'renmode:6' will not work with some
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006144 special made fonts (True-Type fonts which includes only
6145 bitmap glyphs).
6146 - 'taamode:3' will not work with some vector fonts.
6147
6148 NOTE: With this option, you can display colored emoji
6149 (emoticon) in Windows 8.1 or later. To display colored emoji,
6150 there are some conditions which you should notice.
6151
6152 - If your font includes non-colored emoji already, it will
6153 be used.
6154 - If your font doesn't have emoji, the system chooses an
6155 alternative symbol font. On Windows 10, "Segoe UI Emoji"
6156 will be used.
6157 - When this alternative font didn't have fixed width glyph,
6158 emoji might be rendered beyond the bounding box of drawing
6159 cell.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006160
6161 Other render types are currently not supported.
6162
Bram Moolenaar071d4272004-06-13 20:20:40 +00006163 *'report'*
6164'report' number (default 2)
6165 global
6166 Threshold for reporting number of lines changed. When the number of
6167 changed lines is more than 'report' a message will be given for most
6168 ":" commands. If you want it always, set 'report' to 0.
6169 For the ":substitute" command the number of substitutions is used
6170 instead of the number of lines.
6171
6172 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
6173'restorescreen' 'rs' boolean (default on)
6174 global
Bram Moolenaar8024f932020-01-14 19:29:13 +01006175 {only in MS-Windows console version}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006176 When set, the screen contents is restored when exiting Vim. This also
6177 happens when executing external commands.
6178
6179 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
6180 options in your .vimrc. To disable restoring:
6181 set t_ti= t_te=
6182 To enable restoring (for an xterm):
6183 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
6184 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
6185
6186 *'revins'* *'ri'* *'norevins'* *'nori'*
6187'revins' 'ri' boolean (default off)
6188 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006189 {only available when compiled with the |+rightleft|
6190 feature}
6191 Inserting characters in Insert mode will work backwards. See "typing
6192 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
6193 command in Insert mode, when 'allowrevins' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02006194 NOTE: This option is reset when 'compatible' is set.
6195 This option is reset when 'paste' is set and restored when 'paste' is
6196 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006197
6198 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
6199'rightleft' 'rl' boolean (default off)
6200 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006201 {only available when compiled with the |+rightleft|
6202 feature}
6203 When on, display orientation becomes right-to-left, i.e., characters
6204 that are stored in the file appear from the right to the left.
6205 Using this option, it is possible to edit files for languages that
6206 are written from the right to the left such as Hebrew and Arabic.
6207 This option is per window, so it is possible to edit mixed files
6208 simultaneously, or to view the same file in both ways (this is
6209 useful whenever you have a mixed text file with both right-to-left
6210 and left-to-right strings so that both sets are displayed properly
6211 in different windows). Also see |rileft.txt|.
6212
Bram Moolenaar607cc1e2010-07-18 18:47:44 +02006213 *'rightleftcmd'* *'rlc'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006214'rightleftcmd' 'rlc' string (default "search")
6215 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006216 {only available when compiled with the |+rightleft|
6217 feature}
6218 Each word in this option enables the command line editing to work in
6219 right-to-left mode for a group of commands:
6220
6221 search "/" and "?" commands
6222
6223 This is useful for languages such as Hebrew, Arabic and Farsi.
6224 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
6225
Bram Moolenaard94464e2015-11-02 15:28:18 +01006226 *'rubydll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01006227'rubydll' string (default: depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01006228 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01006229 {only available when compiled with the |+ruby/dyn|
6230 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006231 Specifies the name of the Ruby shared library. The default is
6232 DYNAMIC_RUBY_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006233 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01006234 This option cannot be set from a |modeline| or in the |sandbox|, for
6235 security reasons.
6236
Bram Moolenaar071d4272004-06-13 20:20:40 +00006237 *'ruler'* *'ru'* *'noruler'* *'noru'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02006238'ruler' 'ru' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006239 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006240 {not available when compiled without the
6241 |+cmdline_info| feature}
6242 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006243 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00006244 text in the file is shown on the far right:
6245 Top first line is visible
6246 Bot last line is visible
6247 All first and last line are visible
6248 45% relative position in the file
6249 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006250 Each window has its own ruler. If a window has a status line, the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006251 ruler is shown there. Otherwise it is shown in the last line of the
Bram Moolenaar582fd852005-03-28 20:58:01 +00006252 screen. If the statusline is given by 'statusline' (i.e. not empty),
Bram Moolenaar071d4272004-06-13 20:20:40 +00006253 this option takes precedence over 'ruler' and 'rulerformat'
6254 If the number of characters displayed is different from the number of
Bram Moolenaar207f0092020-08-30 17:20:20 +02006255 bytes in the text (e.g., for a TAB or a multibyte character), both
Bram Moolenaar071d4272004-06-13 20:20:40 +00006256 the text column (byte number) and the screen column are shown,
6257 separated with a dash.
6258 For an empty line "0-1" is shown.
6259 For an empty buffer the line number will also be zero: "0,0-1".
Bram Moolenaarca635012015-09-25 20:34:21 +02006260 This option is reset when 'paste' is set and restored when 'paste' is
6261 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006262 If you don't want to see the ruler all the time but want to know where
6263 you are, use "g CTRL-G" |g_CTRL-G|.
6264 NOTE: This option is reset when 'compatible' is set.
6265
6266 *'rulerformat'* *'ruf'*
6267'rulerformat' 'ruf' string (default empty)
6268 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006269 {not available when compiled without the |+statusline|
6270 feature}
6271 When this option is not empty, it determines the content of the ruler
6272 string, as displayed for the 'ruler' option.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00006273 The format of this option is like that of 'statusline'.
Bram Moolenaar110289e2019-05-23 15:38:06 +02006274 This option cannot be set in a modeline when 'modelineexpr' is off.
6275
Bram Moolenaar071d4272004-06-13 20:20:40 +00006276 The default ruler width is 17 characters. To make the ruler 15
6277 characters wide, put "%15(" at the start and "%)" at the end.
6278 Example: >
6279 :set rulerformat=%15(%c%V\ %p%%%)
6280<
6281 *'runtimepath'* *'rtp'* *vimfiles*
6282'runtimepath' 'rtp' string (default:
Bram Moolenaar942db232021-02-13 18:14:48 +01006283 Unix: "$HOME/.vim,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006284 $VIM/vimfiles,
6285 $VIMRUNTIME,
6286 $VIM/vimfiles/after,
6287 $HOME/.vim/after"
6288 Amiga: "home:vimfiles,
6289 $VIM/vimfiles,
6290 $VIMRUNTIME,
6291 $VIM/vimfiles/after,
6292 home:vimfiles/after"
Bram Moolenaar942db232021-02-13 18:14:48 +01006293 MS-Windows: "$HOME/vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006294 $VIM/vimfiles,
6295 $VIMRUNTIME,
6296 $VIM/vimfiles/after,
6297 $HOME/vimfiles/after"
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02006298 macOS: "$VIM:vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006299 $VIMRUNTIME,
6300 $VIM:vimfiles:after"
Bram Moolenaarb3f74062020-02-26 16:16:53 +01006301 Haiku: "$BE_USER_SETTINGS/vim,
6302 $VIM/vimfiles,
6303 $VIMRUNTIME,
6304 $VIM/vimfiles/after,
Bram Moolenaar942db232021-02-13 18:14:48 +01006305 $BE_USER_SETTINGS/vim/after"
6306 VMS: "sys$login:vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006307 $VIM/vimfiles,
6308 $VIMRUNTIME,
6309 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00006310 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006311 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006312 This is a list of directories which will be searched for runtime
6313 files:
6314 filetype.vim filetypes by file name |new-filetype|
6315 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006316 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006317 colors/ color scheme files |:colorscheme|
6318 compiler/ compiler files |:compiler|
6319 doc/ documentation |write-local-help|
6320 ftplugin/ filetype plugins |write-filetype-plugin|
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01006321 import/ files that are found by `:import`
Bram Moolenaar071d4272004-06-13 20:20:40 +00006322 indent/ indent scripts |indent-expression|
6323 keymap/ key mapping files |mbyte-keymap|
6324 lang/ menu translations |:menutrans|
6325 menu.vim GUI menus |menu.vim|
Bram Moolenaar26852122016-05-24 20:02:38 +02006326 pack/ packages |:packadd|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006327 plugin/ plugin scripts |write-plugin|
6328 print/ files for printing |postscript-print-encoding|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006329 spell/ spell checking files |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006330 syntax/ syntax files |mysyntaxfile|
6331 tutor/ files for vimtutor |tutor|
6332
6333 And any other file searched for with the |:runtime| command.
6334
6335 The defaults for most systems are setup to search five locations:
6336 1. In your home directory, for your personal preferences.
6337 2. In a system-wide Vim directory, for preferences from the system
6338 administrator.
6339 3. In $VIMRUNTIME, for files distributed with Vim.
6340 *after-directory*
6341 4. In the "after" directory in the system-wide Vim directory. This is
6342 for the system administrator to overrule or add to the distributed
6343 defaults (rarely needed)
6344 5. In the "after" directory in your home directory. This is for
6345 personal preferences to overrule or add to the distributed defaults
6346 or system-wide settings (rarely needed).
6347
Bram Moolenaard0796902016-09-16 20:02:31 +02006348 More entries are added when using |packages|. If it gets very long
6349 then `:set rtp` will be truncated, use `:echo &rtp` to see the full
6350 string.
Bram Moolenaar26852122016-05-24 20:02:38 +02006351
Bram Moolenaar071d4272004-06-13 20:20:40 +00006352 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
6353 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006354 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00006355 wildcards.
6356 See |:runtime|.
6357 Example: >
6358 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
6359< This will use the directory "~/vimruntime" first (containing your
6360 personal Vim runtime files), then "/mygroup/vim" (shared between a
6361 group of people) and finally "$VIMRUNTIME" (the distributed runtime
6362 files).
6363 You probably should always include $VIMRUNTIME somewhere, to use the
6364 distributed runtime files. You can put a directory before $VIMRUNTIME
6365 to find files which replace a distributed runtime files. You can put
6366 a directory after $VIMRUNTIME to find files which add to distributed
6367 runtime files.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006368 When Vim is started with |--clean| the home directory entries are not
6369 included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006370 This option cannot be set from a |modeline| or in the |sandbox|, for
6371 security reasons.
6372
6373 *'scroll'* *'scr'*
6374'scroll' 'scr' number (default: half the window height)
6375 local to window
6376 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
6377 set to half the number of lines in the window when the window size
Bram Moolenaar74667062020-12-28 15:41:41 +01006378 changes. This may happen when enabling the |status-line| or
6379 'tabline' option after setting the 'scroll' option.
6380 If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006381 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar25c9c682019-05-05 18:13:34 +02006382 height with ":set scroll=0".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006383
6384 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
6385'scrollbind' 'scb' boolean (default off)
6386 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006387 See also |scroll-binding|. When this option is set, the current
6388 window scrolls as other scrollbind windows (windows that also have
6389 this option set) scroll. This option is useful for viewing the
6390 differences between two versions of a file, see 'diff'.
6391 See |'scrollopt'| for options that determine how this option should be
6392 interpreted.
6393 This option is mostly reset when splitting a window to edit another
6394 file. This means that ":split | edit file" results in two windows
6395 with scroll-binding, but ":split file" does not.
6396
Bram Moolenaarae20f342019-11-05 21:09:23 +01006397 *'scrollfocus'* *'scf'* *'noscrollfocus'* *'noscf'*
6398'scrollfocus' 'scf' boolean (default off)
6399 global
6400 {only for MS-Windows GUI}
6401 When using the scroll wheel and this option is set, the window under
6402 the mouse pointer is scrolled. With this option off the current
6403 window is scrolled.
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01006404 Systems other than MS-Windows always behave like this option is on.
Bram Moolenaarae20f342019-11-05 21:09:23 +01006405
Bram Moolenaar071d4272004-06-13 20:20:40 +00006406 *'scrolljump'* *'sj'*
6407'scrolljump' 'sj' number (default 1)
6408 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006409 Minimal number of lines to scroll when the cursor gets off the
6410 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
6411 CTRL-D). Useful if your terminal scrolls very slowly.
Bram Moolenaar1e015462005-09-25 22:16:38 +00006412 When set to a negative number from -1 to -100 this is used as the
6413 percentage of the window height. Thus -50 scrolls half the window
6414 height.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006415 NOTE: This option is set to 1 when 'compatible' is set.
6416
6417 *'scrolloff'* *'so'*
Bram Moolenaar50ba5262016-09-22 22:33:02 +02006418'scrolloff' 'so' number (default 0, set to 5 in |defaults.vim|)
Bram Moolenaar375e3392019-01-31 18:26:10 +01006419 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006420 Minimal number of screen lines to keep above and below the cursor.
6421 This will make some context visible around where you are working. If
6422 you set it to a very large value (999) the cursor line will always be
6423 in the middle of the window (except at the start or end of the file or
6424 when long lines wrap).
Bram Moolenaar375e3392019-01-31 18:26:10 +01006425 After using the local value, go back the global value with one of
6426 these two: >
6427 setlocal scrolloff<
6428 setlocal scrolloff=-1
6429< For scrolling horizontally see 'sidescrolloff'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006430 NOTE: This option is set to 0 when 'compatible' is set.
6431
6432 *'scrollopt'* *'sbo'*
6433'scrollopt' 'sbo' string (default "ver,jump")
6434 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006435 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006436 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
6437 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006438 The following words are available:
6439 ver Bind vertical scrolling for 'scrollbind' windows
6440 hor Bind horizontal scrolling for 'scrollbind' windows
6441 jump Applies to the offset between two windows for vertical
6442 scrolling. This offset is the difference in the first
6443 displayed line of the bound windows. When moving
6444 around in a window, another 'scrollbind' window may
6445 reach a position before the start or after the end of
6446 the buffer. The offset is not changed though, when
6447 moving back the 'scrollbind' window will try to scroll
6448 to the desired position when possible.
6449 When now making that window the current one, two
6450 things can be done with the relative offset:
6451 1. When "jump" is not included, the relative offset is
6452 adjusted for the scroll position in the new current
6453 window. When going back to the other window, the
Bram Moolenaar02467872007-05-06 13:22:01 +00006454 new relative offset will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006455 2. When "jump" is included, the other windows are
6456 scrolled to keep the same relative offset. When
6457 going back to the other window, it still uses the
6458 same relative offset.
6459 Also see |scroll-binding|.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006460 When 'diff' mode is active there always is vertical scroll binding,
6461 even when "ver" isn't there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006462
6463 *'sections'* *'sect'*
6464'sections' 'sect' string (default "SHNHH HUnhsh")
6465 global
6466 Specifies the nroff macros that separate sections. These are pairs of
6467 two letters (See |object-motions|). The default makes a section start
6468 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
6469
6470 *'secure'* *'nosecure'* *E523*
6471'secure' boolean (default off)
6472 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006473 When on, ":autocmd", shell and write commands are not allowed in
6474 ".vimrc" and ".exrc" in the current directory and map commands are
6475 displayed. Switch it off only if you know that you will not run into
6476 problems, or when the 'exrc' option is off. On Unix this option is
6477 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006478 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00006479 'secure' at the end of your ~/.vimrc then.
6480 This option cannot be set from a |modeline| or in the |sandbox|, for
6481 security reasons.
6482
6483 *'selection'* *'sel'*
6484'selection' 'sel' string (default "inclusive")
6485 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006486 This option defines the behavior of the selection. It is only used
6487 in Visual and Select mode.
6488 Possible values:
6489 value past line inclusive ~
6490 old no yes
6491 inclusive yes yes
6492 exclusive yes no
6493 "past line" means that the cursor is allowed to be positioned one
6494 character past the line.
6495 "inclusive" means that the last character of the selection is included
6496 in an operation. For example, when "x" is used to delete the
6497 selection.
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02006498 When "old" is used and 'virtualedit' allows the cursor to move past
6499 the end of line the line break still isn't included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006500 Note that when "exclusive" is used and selecting from the end
6501 backwards, you cannot include the last character of a line, when
6502 starting in Normal mode and 'virtualedit' empty.
6503
6504 The 'selection' option is set by the |:behave| command.
6505
6506 *'selectmode'* *'slm'*
6507'selectmode' 'slm' string (default "")
6508 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006509 This is a comma separated list of words, which specifies when to start
6510 Select mode instead of Visual mode, when a selection is started.
6511 Possible values:
6512 mouse when using the mouse
6513 key when using shifted special keys
6514 cmd when using "v", "V" or CTRL-V
6515 See |Select-mode|.
6516 The 'selectmode' option is set by the |:behave| command.
6517
6518 *'sessionoptions'* *'ssop'*
6519'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006520 help,options,tabpages,winsize,terminal")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006521 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02006522 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006523 feature}
6524 Changes the effect of the |:mksession| command. It is a comma
6525 separated list of words. Each word enables saving and restoring
6526 something:
6527 word save and restore ~
6528 blank empty windows
6529 buffers hidden and unloaded buffers, not just those in windows
6530 curdir the current directory
6531 folds manually created folds, opened/closed folds and local
6532 fold options
6533 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00006534 and contain at least one lowercase letter. Only
6535 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006536 help the help window
6537 localoptions options and mappings local to a window or buffer (not
6538 global values for local options)
6539 options all options and mappings (also global values for local
6540 options)
Bram Moolenaard23b7142021-04-17 21:04:34 +02006541 skiprtp exclude 'runtimepath' and 'packpath' from the options
Bram Moolenaar071d4272004-06-13 20:20:40 +00006542 resize size of the Vim window: 'lines' and 'columns'
6543 sesdir the directory in which the session file is located
6544 will become the current directory (useful with
6545 projects accessed over a network from different
6546 systems)
6547 slash backslashes in file names replaced with forward
6548 slashes
Bram Moolenaar18144c82006-04-12 21:52:12 +00006549 tabpages all tab pages; without this only the current tab page
6550 is restored, so that you can make a session for each
6551 tab page separately
Bram Moolenaard473c8c2018-08-11 18:00:22 +02006552 terminal include terminal windows where the command can be
6553 restored
Bram Moolenaar071d4272004-06-13 20:20:40 +00006554 unix with Unix end-of-line format (single <NL>), even when
6555 on Windows or DOS
6556 winpos position of the whole Vim window
6557 winsize window sizes
6558
6559 Don't include both "curdir" and "sesdir".
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006560 When neither "curdir" nor "sesdir" is included, file names are stored
6561 with absolute paths.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006562 "slash" and "unix" are useful on Windows when sharing session files
6563 with Unix. The Unix version of Vim cannot source dos format scripts,
6564 but the Windows version of Vim can source unix format scripts.
6565
6566 *'shell'* *'sh'* *E91*
Bram Moolenaar95a9dd12019-12-19 22:12:03 +01006567'shell' 'sh' string (default $SHELL or "sh", Win32: "cmd.exe")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006568 global
6569 Name of the shell to use for ! and :! commands. When changing the
6570 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
6571 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006572 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006573 See |option-backslash| about including spaces and backslashes.
6574 Environment variables are expanded |:set_env|.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006575
Bram Moolenaar1ff14ba2019-11-02 14:09:23 +01006576 If the name of the shell contains a space, you need to enclose it in
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01006577 quotes and escape the space. Example with quotes: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006578 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
6579< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006580 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006581 "-f" is not inside the quotes, because it is not part of the command
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006582 name. Vim automagically recognizes the backslashes that are path
Bram Moolenaar071d4272004-06-13 20:20:40 +00006583 separators.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006584 Example with escaped space (Vim will do this when initializing the
6585 option from $SHELL): >
6586 :set shell=/bin/with\\\ space/sh
Bram Moolenaard473c8c2018-08-11 18:00:22 +02006587< The resulting value of 'shell' is "/bin/with\ space/sh", two
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006588 backslashes are consumed by `:set`.
6589
Bram Moolenaar071d4272004-06-13 20:20:40 +00006590 Under MS-Windows, when the executable ends in ".com" it must be
6591 included. Thus setting the shell to "command.com" or "4dos.com"
6592 works, but "command" and "4dos" do not work for all commands (e.g.,
6593 filtering).
6594 For unknown reasons, when using "4dos.com" the current directory is
6595 changed to "C:\". To avoid this set 'shell' like this: >
6596 :set shell=command.com\ /c\ 4dos
6597< This option cannot be set from a |modeline| or in the |sandbox|, for
6598 security reasons.
6599
6600 *'shellcmdflag'* *'shcf'*
Bram Moolenaar5dc62522012-02-13 00:05:22 +01006601'shellcmdflag' 'shcf' string (default: "-c";
Mike Williams12795022021-06-28 20:53:58 +02006602 Win32, when 'shell' contains "powershell":
6603 "-Command", or when it does not contain "sh"
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006604 somewhere: "/c")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006605 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006606 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
Mike Williams12795022021-06-28 20:53:58 +02006607 "bash.exe -c ls", "powershell.exe -Command dir", or "cmd.exe /c dir".
6608 For MS-Windows, the default is set according to the value of 'shell',
6609 to reduce the need to set this option by the user.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02006610 On Unix it can have more than one flag. Each white space separated
6611 part is passed as an argument to the shell command.
6612 See |option-backslash| about including spaces and backslashes.
Mike Williams12795022021-06-28 20:53:58 +02006613 Also see |dos-shell| and |dos-powershell| for MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006614 This option cannot be set from a |modeline| or in the |sandbox|, for
6615 security reasons.
6616
6617 *'shellpipe'* *'sp'*
Mike Williams12795022021-06-28 20:53:58 +02006618'shellpipe' 'sp' string (default ">", ">%s 2>&1", "| tee", "|& tee"
6619 "2>&1| tee", or
6620 "2>&1 | Out-File -Encoding default")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006621 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006622 {not available when compiled without the |+quickfix|
6623 feature}
6624 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006625 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00006626 including spaces and backslashes.
6627 The name of the temporary file can be represented by "%s" if necessary
6628 (the file name is appended automatically if no %s appears in the value
6629 of this option).
Mike Williams12795022021-06-28 20:53:58 +02006630 For the Amiga the default is ">". For MS-Windows using powershell the
6631 default is "2>&1 | Out-File -Encoding default", otherwise the default
6632 is ">%s 2>&1". The output is directly saved in a file and not echoed
6633 to the screen.
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02006634 For Unix the default is "| tee". The stdout of the compiler is saved
Bram Moolenaar071d4272004-06-13 20:20:40 +00006635 in a file and echoed to the screen. If the 'shell' option is "csh" or
6636 "tcsh" after initializations, the default becomes "|& tee". If the
Bram Moolenaar96f45c02019-10-26 19:53:45 +02006637 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh", "zsh-beta",
Natanael Copa56318362021-05-06 18:46:35 +02006638 "bash", "fish", "ash" or "dash" the default becomes "2>&1| tee". This
6639 means that stderr is also included. Before using the 'shell' option a
6640 path is removed, thus "/bin/sh" uses "sh".
Mike Williamsa3d1b292021-06-30 20:56:00 +02006641 For Unix and MS-Windows, when the 'shell' option is "pwsh" the default
6642 becomes ">%s 2>&1" and the output is not echoed to the screen.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006643 The initialization of this option is done after reading the ".vimrc"
6644 and the other initializations, so that when the 'shell' option is set
6645 there, the 'shellpipe' option changes automatically, unless it was
6646 explicitly set before.
6647 When 'shellpipe' is set to an empty string, no redirection of the
6648 ":make" output will be done. This is useful if you use a 'makeprg'
6649 that writes to 'makeef' by itself. If you want no piping, but do
6650 want to include the 'makeef', set 'shellpipe' to a single space.
6651 Don't forget to precede the space with a backslash: ":set sp=\ ".
6652 In the future pipes may be used for filtering and this option will
6653 become obsolete (at least for Unix).
6654 This option cannot be set from a |modeline| or in the |sandbox|, for
6655 security reasons.
6656
6657 *'shellquote'* *'shq'*
Mike Williamsa3d1b292021-06-30 20:56:00 +02006658'shellquote' 'shq' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006659 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006660 Quoting character(s), put around the command passed to the shell, for
6661 the "!" and ":!" commands. The redirection is kept outside of the
6662 quoting. See 'shellxquote' to include the redirection. It's
6663 probably not useful to set both options.
6664 This is an empty string by default. Only known to be useful for
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006665 third-party shells on MS-Windows-like systems, such as the MKS Korn
Mike Williamsa3d1b292021-06-30 20:56:00 +02006666 Shell or bash, where it should be "\"". See |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006667 This option cannot be set from a |modeline| or in the |sandbox|, for
6668 security reasons.
6669
6670 *'shellredir'* *'srr'*
Mike Williams12795022021-06-28 20:53:58 +02006671'shellredir' 'srr' string (default ">", ">&", ">%s 2>&1", or
6672 "2>&1 | Out-File -Encoding default")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006673 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006674 String to be used to put the output of a filter command in a temporary
6675 file. See also |:!|. See |option-backslash| about including spaces
6676 and backslashes.
6677 The name of the temporary file can be represented by "%s" if necessary
6678 (the file name is appended automatically if no %s appears in the value
6679 of this option).
Bram Moolenaar96f45c02019-10-26 19:53:45 +02006680 The default is ">". For Unix, if the 'shell' option is "csh" or
6681 "tcsh" during initializations, the default becomes ">&". If the
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01006682 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh", "zsh-beta",
Mike Williamsa3d1b292021-06-30 20:56:00 +02006683 "bash", "fish", or "pwsh", the default becomes ">%s 2>&1". This means
6684 that stderr is also included. For Win32, the Unix checks are done and
Mike Williams12795022021-06-28 20:53:58 +02006685 additionally "cmd" is checked for, which makes the default ">%s 2>&1",
6686 and "powershell" is checked for which makes the default
Mike Williamsa3d1b292021-06-30 20:56:00 +02006687 "2>&1 | Out-File -Encoding default" (see |dos-powershell|). Also, the
6688 same names with ".exe" appended are checked for.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006689 The initialization of this option is done after reading the ".vimrc"
6690 and the other initializations, so that when the 'shell' option is set
6691 there, the 'shellredir' option changes automatically unless it was
6692 explicitly set before.
6693 In the future pipes may be used for filtering and this option will
6694 become obsolete (at least for Unix).
6695 This option cannot be set from a |modeline| or in the |sandbox|, for
6696 security reasons.
6697
6698 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
6699'shellslash' 'ssl' boolean (default off)
6700 global
Bram Moolenaar6f345a12019-12-17 21:27:18 +01006701 {only for MS-Windows}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006702 When set, a forward slash is used when expanding file names. This is
Mike Williamsa3d1b292021-06-30 20:56:00 +02006703 useful when a Unix-like shell is used instead of cmd.exe, pwsh.exe, or
Mike Williams12795022021-06-28 20:53:58 +02006704 powershell.exe. Backward slashes can still be typed, but they are
6705 changed to forward slashes by Vim.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006706 Note that setting or resetting this option has no effect for some
6707 existing file names, thus this option needs to be set before opening
6708 any file for best results. This might change in the future.
6709 'shellslash' only works when a backslash can be used as a path
6710 separator. To test if this is so use: >
6711 if exists('+shellslash')
Bram Moolenaarac3150d2019-07-28 16:36:39 +02006712< Also see 'completeslash'.
6713
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006714 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
6715'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
6716 global
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006717 When on, use temp files for shell commands. When off use a pipe.
6718 When using a pipe is not possible temp files are used anyway.
Bram Moolenaar97293012011-07-18 19:40:27 +02006719 Currently a pipe is only supported on Unix and MS-Windows 2K and
6720 later. You can check it with: >
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006721 :if has("filterpipe")
6722< The advantage of using a pipe is that nobody can read the temp file
6723 and the 'shell' command does not need to support redirection.
6724 The advantage of using a temp file is that the file type and encoding
6725 can be detected.
6726 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
6727 |FilterWritePost| autocommands event are not triggered when
6728 'shelltemp' is off.
Bram Moolenaar269f5952016-07-15 22:54:41 +02006729 The `system()` function does not respect this option and always uses
6730 temp files.
Bram Moolenaar036986f2017-03-16 17:41:02 +01006731 NOTE: This option is set to the Vim default value when 'compatible'
6732 is reset.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006733
Bram Moolenaar071d4272004-06-13 20:20:40 +00006734 *'shelltype'* *'st'*
6735'shelltype' 'st' number (default 0)
6736 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02006737 {only for the Amiga}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006738 On the Amiga this option influences the way how the commands work
6739 which use a shell.
6740 0 and 1: always use the shell
6741 2 and 3: use the shell only to filter lines
6742 4 and 5: use shell only for ':sh' command
6743 When not using the shell, the command is executed directly.
6744
6745 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
6746 1 and 3: use "shell cmd" to start external commands
6747
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006748 *'shellxescape'* *'sxe'*
6749'shellxescape' 'sxe' string (default: "";
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006750 for MS-Windows: "\"&|<>()@^")
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006751 global
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006752 When 'shellxquote' is set to "(" then the characters listed in this
6753 option will be escaped with a '^' character. This makes it possible
6754 to execute most external commands with cmd.exe.
6755
Bram Moolenaar071d4272004-06-13 20:20:40 +00006756 *'shellxquote'* *'sxq'*
6757'shellxquote' 'sxq' string (default: "";
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006758 for Win32, when 'shell' is cmd.exe: "("
Mike Williams12795022021-06-28 20:53:58 +02006759 for Win32, when 'shell' is
6760 powershell.exe: "\""
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006761 for Win32, when 'shell' contains "sh"
6762 somewhere: "\""
Bram Moolenaar071d4272004-06-13 20:20:40 +00006763 for Unix, when using system(): "\"")
6764 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006765 Quoting character(s), put around the command passed to the shell, for
6766 the "!" and ":!" commands. Includes the redirection. See
6767 'shellquote' to exclude the redirection. It's probably not useful
6768 to set both options.
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006769 When the value is '(' then ')' is appended. When the value is '"('
6770 then ')"' is appended.
6771 When the value is '(' then also see 'shellxescape'.
Bram Moolenaara64ba222012-02-12 23:23:31 +01006772 This is an empty string by default on most systems, but is known to be
Mike Williamsa3d1b292021-06-30 20:56:00 +02006773 useful for on Win32 version, either for cmd.exe, powershell.exe, or
6774 pwsh.exe which automatically strips off the first and last quote on a
6775 command, or 3rd-party shells such as the MKS Korn Shell or bash, where
6776 it should be "\"". The default is adjusted according the value of
Mike Williams12795022021-06-28 20:53:58 +02006777 'shell', to reduce the need to set this option by the user. See
6778 |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006779 This option cannot be set from a |modeline| or in the |sandbox|, for
6780 security reasons.
6781
6782 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
6783'shiftround' 'sr' boolean (default off)
6784 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006785 Round indent to multiple of 'shiftwidth'. Applies to > and <
6786 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
6787 a multiple of 'shiftwidth' (this is Vi compatible).
6788 NOTE: This option is reset when 'compatible' is set.
6789
6790 *'shiftwidth'* *'sw'*
6791'shiftwidth' 'sw' number (default 8)
6792 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006793 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00006794 |'cindent'|, |>>|, |<<|, etc.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02006795 When zero the 'ts' value will be used. Use the |shiftwidth()|
6796 function to get the effective shiftwidth value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006797
6798 *'shortmess'* *'shm'*
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02006799'shortmess' 'shm' string (Vim default "filnxtToOS", Vi default: "S",
6800 POSIX default: "AS")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006801 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006802 This option helps to avoid all the |hit-enter| prompts caused by file
6803 messages, for example with CTRL-G, and to avoid some other messages.
6804 It is a list of flags:
6805 flag meaning when present ~
6806 f use "(3 of 5)" instead of "(file 3 of 5)"
6807 i use "[noeol]" instead of "[Incomplete last line]"
Bram Moolenaar3f40ce72020-07-05 14:10:13 +02006808 l use "999L, 888B" instead of "999 lines, 888 bytes"
Bram Moolenaar071d4272004-06-13 20:20:40 +00006809 m use "[+]" instead of "[Modified]"
6810 n use "[New]" instead of "[New File]"
6811 r use "[RO]" instead of "[readonly]"
6812 w use "[w]" instead of "written" for file write message
6813 and "[a]" instead of "appended" for ':w >> file' command
6814 x use "[dos]" instead of "[dos format]", "[unix]" instead of
6815 "[unix format]" and "[mac]" instead of "[mac format]".
6816 a all of the above abbreviations
6817
6818 o overwrite message for writing a file with subsequent message
6819 for reading a file (useful for ":wn" or when 'autowrite' on)
6820 O message for reading a file overwrites any previous message.
6821 Also for quickfix message (e.g., ":cn").
6822 s don't give "search hit BOTTOM, continuing at TOP" or "search
Bram Moolenaara6c27c42019-05-09 19:16:22 +02006823 hit TOP, continuing at BOTTOM" messages; when using the search
6824 count do not show "W" after the count message (see S below)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006825 t truncate file message at the start if it is too long to fit
6826 on the command-line, "<" will appear in the left most column.
6827 Ignored in Ex mode.
6828 T truncate other messages in the middle if they are too long to
Bram Moolenaar582fd852005-03-28 20:58:01 +00006829 fit on the command line. "..." will appear in the middle.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006830 Ignored in Ex mode.
6831 W don't give "written" or "[w]" when writing a file
6832 A don't give the "ATTENTION" message when an existing swap file
6833 is found.
6834 I don't give the intro message when starting Vim |:intro|.
Bram Moolenaarea389e92014-05-28 21:40:52 +02006835 c don't give |ins-completion-menu| messages. For example,
6836 "-- XXX completion (YYY)", "match 1 of 2", "The only match",
6837 "Pattern not found", "Back at original", etc.
Bram Moolenaar426dd022016-03-15 15:09:29 +01006838 q use "recording" instead of "recording @a"
6839 F don't give the file info when editing a file, like `:silent`
Bram Moolenaar110289e2019-05-23 15:38:06 +02006840 was used for the command; note that this also affects messages
6841 from autocommands
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02006842 S do not show search count message when searching, e.g.
6843 "[1/5]"
Bram Moolenaar071d4272004-06-13 20:20:40 +00006844
6845 This gives you the opportunity to avoid that a change between buffers
6846 requires you to hit <Enter>, but still gives as useful a message as
6847 possible for the space available. To get the whole message that you
6848 would have got with 'shm' empty, use ":file!"
6849 Useful values:
6850 shm= No abbreviation of message.
6851 shm=a Abbreviation, but no loss of information.
6852 shm=at Abbreviation, and truncate message when necessary.
6853
6854 NOTE: This option is set to the Vi default value when 'compatible' is
6855 set and to the Vim default value when 'compatible' is reset.
6856
6857 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
6858'shortname' 'sn' boolean (default off)
6859 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00006860 Filenames are assumed to be 8 characters plus one extension of 3
6861 characters. Multiple dots in file names are not allowed. When this
6862 option is on, dots in file names are replaced with underscores when
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006863 adding an extension (".~" or ".swp"). This option is useful
Bram Moolenaar071d4272004-06-13 20:20:40 +00006864 when editing files on an MS-DOS compatible filesystem, e.g., messydos
Bram Moolenaarade0d392020-01-21 22:33:58 +01006865 or crossdos.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006866
6867 *'showbreak'* *'sbr'* *E595*
6868'showbreak' 'sbr' string (default "")
Bram Moolenaaree857022019-11-09 23:26:40 +01006869 global or local to window |global-local|
Bram Moolenaardb84e452010-08-15 13:50:43 +02006870 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006871 feature}
6872 String to put at the start of lines that have been wrapped. Useful
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006873 values are "> " or "+++ ": >
6874 :set showbreak=>\
6875< Note the backslash to escape the trailing space. It's easier like
6876 this: >
Bram Moolenaar1a384422010-07-14 19:53:30 +02006877 :let &showbreak = '+++ '
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006878< Only printable single-cell characters are allowed, excluding <Tab> and
Bram Moolenaar071d4272004-06-13 20:20:40 +00006879 comma (in a future version the comma might be used to separate the
6880 part that is shown at the end and at the start of a line).
6881 The characters are highlighted according to the '@' flag in
6882 'highlight'.
6883 Note that tabs after the showbreak will be displayed differently.
6884 If you want the 'showbreak' to appear in between line numbers, add the
6885 "n" flag to 'cpoptions'.
Bram Moolenaaree857022019-11-09 23:26:40 +01006886 A window-local value overrules a global value. If the global value is
6887 set and you want no value in the current window use NONE: >
6888 :setlocal showbreak=NONE
6889<
Bram Moolenaar071d4272004-06-13 20:20:40 +00006890 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02006891'showcmd' 'sc' boolean (Vim default: on, off for Unix,
6892 Vi default: off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006893 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006894 {not available when compiled without the
6895 |+cmdline_info| feature}
Bram Moolenaar02467872007-05-06 13:22:01 +00006896 Show (partial) command in the last line of the screen. Set this
6897 option off if your terminal is slow.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006898 In Visual mode the size of the selected area is shown:
6899 - When selecting characters within a line, the number of characters.
Bram Moolenaarf91787c2010-07-17 12:47:16 +02006900 If the number of bytes is different it is also displayed: "2-6"
6901 means two characters and six bytes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006902 - When selecting more than one line, the number of lines.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006903 - When selecting a block, the size in screen characters:
6904 {lines}x{columns}.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006905 NOTE: This option is set to the Vi default value when 'compatible' is
6906 set and to the Vim default value when 'compatible' is reset.
6907
6908 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
6909'showfulltag' 'sft' boolean (default off)
6910 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006911 When completing a word in insert mode (see |ins-completion|) from the
6912 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006913 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00006914 matched a C function, you can see a template for what arguments are
6915 required (coding style permitting).
Bram Moolenaar446cb832008-06-24 21:56:24 +00006916 Note that this doesn't work well together with having "longest" in
6917 'completeopt', because the completion from the search pattern may not
6918 match the typed text.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006919
6920 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
6921'showmatch' 'sm' boolean (default off)
6922 global
6923 When a bracket is inserted, briefly jump to the matching one. The
6924 jump is only done if the match can be seen on the screen. The time to
6925 show the match can be set with 'matchtime'.
6926 A Beep is given if there is no match (no matter if the match can be
Bram Moolenaarca635012015-09-25 20:34:21 +02006927 seen or not).
6928 This option is reset when 'paste' is set and restored when 'paste' is
6929 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006930 When the 'm' flag is not included in 'cpoptions', typing a character
6931 will immediately move the cursor back to where it belongs.
6932 See the "sm" field in 'guicursor' for setting the cursor shape and
6933 blinking when showing the match.
6934 The 'matchpairs' option can be used to specify the characters to show
6935 matches for. 'rightleft' and 'revins' are used to look for opposite
6936 matches.
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006937 Also see the matchparen plugin for highlighting the match when moving
6938 around |pi_paren.txt|.
6939 Note: Use of the short form is rated PG.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006940
6941 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
6942'showmode' 'smd' boolean (Vim default: on, Vi default: off)
6943 global
6944 If in Insert, Replace or Visual mode put a message on the last line.
6945 Use the 'M' flag in 'highlight' to set the type of highlighting for
6946 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006947 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00006948 doesn't mean XIM is really active, especially when 'imactivatekey' is
6949 not set.
6950 NOTE: This option is set to the Vi default value when 'compatible' is
6951 set and to the Vim default value when 'compatible' is reset.
6952
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006953 *'showtabline'* *'stal'*
6954'showtabline' 'stal' number (default 1)
6955 global
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006956 The value of this option specifies when the line with tab page labels
6957 will be displayed:
6958 0: never
6959 1: only if there are at least two tab pages
6960 2: always
6961 This is both for the GUI and non-GUI implementation of the tab pages
6962 line.
6963 See |tab-page| for more information about tab pages.
6964
Bram Moolenaar071d4272004-06-13 20:20:40 +00006965 *'sidescroll'* *'ss'*
6966'sidescroll' 'ss' number (default 0)
6967 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006968 The minimal number of columns to scroll horizontally. Used only when
6969 the 'wrap' option is off and the cursor is moved off of the screen.
6970 When it is zero the cursor will be put in the middle of the screen.
6971 When using a slow terminal set it to a large number or 0. When using
6972 a fast terminal use a small number or 1. Not used for "zh" and "zl"
6973 commands.
6974
6975 *'sidescrolloff'* *'siso'*
6976'sidescrolloff' 'siso' number (default 0)
Bram Moolenaar375e3392019-01-31 18:26:10 +01006977 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006978 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00006979 right of the cursor if 'nowrap' is set. Setting this option to a
6980 value greater than 0 while having |'sidescroll'| also at a non-zero
6981 value makes some context visible in the line you are scrolling in
6982 horizontally (except at beginning of the line). Setting this option
6983 to a large value (like 999) has the effect of keeping the cursor
6984 horizontally centered in the window, as long as one does not come too
6985 close to the beginning of the line.
Bram Moolenaar375e3392019-01-31 18:26:10 +01006986 After using the local value, go back the global value with one of
6987 these two: >
6988 setlocal sidescrolloff<
6989 setlocal sidescrolloff=-1
6990< NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006991
6992 Example: Try this together with 'sidescroll' and 'listchars' as
6993 in the following example to never allow the cursor to move
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02006994 onto the "extends" character: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006995
6996 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
6997 :set sidescrolloff=1
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02006998<
6999 *'signcolumn'* *'scl'*
7000'signcolumn' 'scl' string (default "auto")
7001 local to window
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007002 {not available when compiled without the |+signs|
7003 feature}
Bram Moolenaar09521312016-08-12 22:54:35 +02007004 Whether or not to draw the signcolumn. Valid values are:
7005 "auto" only when there is a sign to display
7006 "no" never
7007 "yes" always
Bram Moolenaar394c5d82019-06-17 21:48:05 +02007008 "number" display signs in the 'number' column. If the number
Bram Moolenaar6c1e1572019-06-22 02:13:00 +02007009 column is not present, then behaves like "auto".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007010
7011
7012 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
7013'smartcase' 'scs' boolean (default off)
7014 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007015 Override the 'ignorecase' option if the search pattern contains upper
7016 case characters. Only used when the search pattern is typed and
7017 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarc8734422012-06-01 22:38:45 +02007018 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00007019 "*" and "#" you can make 'smartcase' used by doing a "/" command,
7020 recalling the search pattern from history and hitting <Enter>.
7021 NOTE: This option is reset when 'compatible' is set.
7022
7023 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
7024'smartindent' 'si' boolean (default off)
7025 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007026 {not available when compiled without the
7027 |+smartindent| feature}
7028 Do smart autoindenting when starting a new line. Works for C-like
7029 programs, but can also be used for other languages. 'cindent' does
7030 something like this, works better in most cases, but is more strict,
Bram Moolenaar81af9252010-12-10 20:35:50 +01007031 see |C-indenting|. When 'cindent' is on or 'indentexpr' is set,
Bram Moolenaar166af9b2010-11-16 20:34:40 +01007032 setting 'si' has no effect. 'indentexpr' is a more advanced
7033 alternative.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007034 Normally 'autoindent' should also be on when using 'smartindent'.
7035 An indent is automatically inserted:
7036 - After a line ending in '{'.
7037 - After a line starting with a keyword from 'cinwords'.
7038 - Before a line starting with '}' (only with the "O" command).
7039 When typing '}' as the first character in a new line, that line is
7040 given the same indent as the matching '{'.
7041 When typing '#' as the first character in a new line, the indent for
7042 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007043 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00007044 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
7045 When using the ">>" command, lines starting with '#' are not shifted
7046 right.
Bram Moolenaar036986f2017-03-16 17:41:02 +01007047 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02007048 This option is reset when 'paste' is set and restored when 'paste' is
7049 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007050
7051 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
7052'smarttab' 'sta' boolean (default off)
7053 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007054 When on, a <Tab> in front of a line inserts blanks according to
Bram Moolenaar280f1262006-01-30 00:14:18 +00007055 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A
7056 <BS> will delete a 'shiftwidth' worth of space at the start of the
7057 line.
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00007058 When off, a <Tab> always inserts blanks according to 'tabstop' or
Bram Moolenaar280f1262006-01-30 00:14:18 +00007059 'softtabstop'. 'shiftwidth' is only used for shifting text left or
7060 right |shift-left-right|.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007061 What gets inserted (a <Tab> or spaces) depends on the 'expandtab'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007062 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00007063 number of spaces is minimized by using <Tab>s.
Bram Moolenaarca635012015-09-25 20:34:21 +02007064 This option is reset when 'paste' is set and restored when 'paste' is
7065 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007066 NOTE: This option is reset when 'compatible' is set.
7067
7068 *'softtabstop'* *'sts'*
7069'softtabstop' 'sts' number (default 0)
7070 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007071 Number of spaces that a <Tab> counts for while performing editing
7072 operations, like inserting a <Tab> or using <BS>. It "feels" like
7073 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
7074 used. This is useful to keep the 'ts' setting at its standard value
7075 of 8, while being able to edit like it is set to 'sts'. However,
7076 commands like "x" still work on the actual characters.
7077 When 'sts' is zero, this feature is off.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02007078 When 'sts' is negative, the value of 'shiftwidth' is used.
Bram Moolenaarca635012015-09-25 20:34:21 +02007079 'softtabstop' is set to 0 when the 'paste' option is set and restored
7080 when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007081 See also |ins-expandtab|. When 'expandtab' is not set, the number of
7082 spaces is minimized by using <Tab>s.
7083 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
7084 set.
7085 NOTE: This option is set to 0 when 'compatible' is set.
7086
Bram Moolenaar04958cb2018-06-23 19:23:02 +02007087 If Vim is compiled with the |+vartabs| feature then the value of
7088 'softtabstop' will be ignored if |'varsofttabstop'| is set to
7089 anything other than an empty string.
7090
Bram Moolenaar217ad922005-03-20 22:37:15 +00007091 *'spell'* *'nospell'*
7092'spell' boolean (default off)
7093 local to window
Bram Moolenaar217ad922005-03-20 22:37:15 +00007094 {not available when compiled without the |+syntax|
7095 feature}
7096 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007097 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007098
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007099 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00007100'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007101 local to buffer
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007102 {not available when compiled without the |+syntax|
7103 feature}
7104 Pattern to locate the end of a sentence. The following word will be
7105 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007106 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007107 When this check is not wanted make this option empty.
7108 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00007109 Be careful with special characters, see |option-backslash| about
7110 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007111 To set this option automatically depending on the language, see
7112 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007113
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007114 *'spellfile'* *'spf'*
7115'spellfile' 'spf' string (default empty)
7116 local to buffer
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007117 {not available when compiled without the |+syntax|
7118 feature}
7119 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00007120 commands. It must end in ".{encoding}.add". You need to include the
7121 path, otherwise the file is placed in the current directory.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007122 *E765*
7123 It may also be a comma separated list of names. A count before the
7124 |zg| and |zw| commands can be used to access each. This allows using
7125 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007126 When a word is added while this option is empty Vim will set it for
Bram Moolenaar910f66f2006-04-05 20:41:53 +00007127 you: Using the first directory in 'runtimepath' that is writable. If
7128 there is no "spell" directory yet it will be created. For the file
7129 name the first language name that appears in 'spelllang' is used,
Bram Moolenaar3b506942005-06-23 22:36:45 +00007130 ignoring the region.
7131 The resulting ".spl" file will be used for spell checking, it does not
7132 have to appear in 'spelllang'.
7133 Normally one file is used for all regions, but you can add the region
7134 name if you want to. However, it will then only be used when
7135 'spellfile' is set to it, for entries in 'spelllang' only files
7136 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00007137 This option cannot be set from a |modeline| or in the |sandbox|, for
7138 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007139
Bram Moolenaar217ad922005-03-20 22:37:15 +00007140 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007141'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00007142 local to buffer
Bram Moolenaar217ad922005-03-20 22:37:15 +00007143 {not available when compiled without the |+syntax|
7144 feature}
Bram Moolenaar3b506942005-06-23 22:36:45 +00007145 A comma separated list of word list names. When the 'spell' option is
7146 on spellchecking will be done for these languages. Example: >
7147 set spelllang=en_us,nl,medical
7148< This means US English, Dutch and medical words are recognized. Words
7149 that are not recognized will be highlighted.
Bram Moolenaar911ead12019-04-21 00:03:35 +02007150 The word list name must consist of alphanumeric characters, a dash or
7151 an underscore. It should not include a comma or dot. Using a dash is
Bram Moolenaar3b506942005-06-23 22:36:45 +00007152 recommended to separate the two letter language name from a
7153 specification. Thus "en-rare" is used for rare English words.
7154 A region name must come last and have the form "_xx", where "xx" is
7155 the two-letter, lower case region name. You can use more than one
7156 region by listing them: "en_us,en_ca" supports both US and Canadian
7157 English, but not words specific for Australia, New Zealand or Great
Bram Moolenaarfa735342016-01-03 22:14:44 +01007158 Britain. (Note: currently en_au and en_nz dictionaries are older than
7159 en_ca, en_gb and en_us).
Bram Moolenaarcc63c642013-11-12 04:44:01 +01007160 If the name "cjk" is included East Asian characters are excluded from
7161 spell checking. This is useful when editing text that also has Asian
7162 words.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007163 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007164 As a special case the name of a .spl file can be given as-is. The
7165 first "_xx" in the name is removed and used as the region name
7166 (_xx is an underscore, two letters and followed by a non-letter).
7167 This is mainly for testing purposes. You must make sure the correct
7168 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007169 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007170 idea to set 'spelllang' after setting 'encoding' to avoid loading the
7171 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00007172 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007173
Bram Moolenaar98692072006-02-04 00:57:42 +00007174 If the |spellfile.vim| plugin is active and you use a language name
7175 for which Vim cannot find the .spl file in 'runtimepath' the plugin
7176 will ask you if you want to download the file.
7177
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007178 After this option has been set successfully, Vim will source the files
7179 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
Bram Moolenaarb730f0c2018-11-25 03:56:26 +01007180 up to the first character that is not an ASCII letter or number and
7181 not a dash. Also see |set-spc-auto|.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007182
Bram Moolenaar362b44b2020-06-10 21:47:00 +02007183 *'spelloptions'* *'spo'*
7184'spelloptions' 'spo' string (default "")
7185 local to buffer
7186 {not available when compiled without the |+syntax|
7187 feature}
7188 A comma separated list of options for spell checking:
7189 camel When a word is CamelCased, assume "Cased" is a
7190 separate word: every upper-case character in a word
7191 that comes after a lower case character indicates the
7192 start of a new word.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007193
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007194 *'spellsuggest'* *'sps'*
7195'spellsuggest' 'sps' string (default "best")
7196 global
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007197 {not available when compiled without the |+syntax|
7198 feature}
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007199 Methods used for spelling suggestions. Both for the |z=| command and
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007200 the |spellsuggest()| function. This is a comma-separated list of
7201 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007202
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007203 best Internal method that works best for English. Finds
7204 changes like "fast" and uses a bit of sound-a-like
7205 scoring to improve the ordering.
7206
7207 double Internal method that uses two methods and mixes the
7208 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007209 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007210 word. That only works when the language specifies
7211 sound folding. Can be slow and doesn't always give
7212 better results.
7213
7214 fast Internal method that only checks for simple changes:
7215 character inserts/deletes/swaps. Works well for
7216 simple typing mistakes.
7217
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007218 {number} The maximum number of suggestions listed for |z=|.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007219 Not used for |spellsuggest()|. The number of
7220 suggestions is never more than the value of 'lines'
7221 minus two.
7222
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007223 file:{filename} Read file {filename}, which must have two columns,
7224 separated by a slash. The first column contains the
7225 bad word, the second column the suggested good word.
7226 Example:
7227 theribal/terrible ~
7228 Use this for common mistakes that do not appear at the
7229 top of the suggestion list with the internal methods.
7230 Lines without a slash are ignored, use this for
7231 comments.
Bram Moolenaarbcb98982014-05-01 14:08:19 +02007232 The word in the second column must be correct,
7233 otherwise it will not be used. Add the word to an
7234 ".add" file if it is currently flagged as a spelling
7235 mistake.
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007236 The file is used for all languages.
7237
7238 expr:{expr} Evaluate expression {expr}. Use a function to avoid
7239 trouble with spaces. |v:val| holds the badly spelled
7240 word. The expression must evaluate to a List of
7241 Lists, each with a suggestion and a score.
7242 Example:
Bram Moolenaar214641f2017-03-05 17:04:09 +01007243 [['the', 33], ['that', 44]] ~
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007244 Set 'verbose' and use |z=| to see the scores that the
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007245 internal methods use. A lower score is better.
7246 This may invoke |spellsuggest()| if you temporarily
7247 set 'spellsuggest' to exclude the "expr:" part.
7248 Errors are silently ignored, unless you set the
7249 'verbose' option to a non-zero value.
7250
7251 Only one of "best", "double" or "fast" may be used. The others may
7252 appear several times in any order. Example: >
7253 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
7254<
7255 This option cannot be set from a |modeline| or in the |sandbox|, for
7256 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007257
7258
Bram Moolenaar071d4272004-06-13 20:20:40 +00007259 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
7260'splitbelow' 'sb' boolean (default off)
7261 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007262 When on, splitting a window will put the new window below the current
7263 one. |:split|
7264
7265 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
7266'splitright' 'spr' boolean (default off)
7267 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007268 When on, splitting a window will put the new window right of the
7269 current one. |:vsplit|
7270
7271 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
7272'startofline' 'sol' boolean (default on)
7273 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007274 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00007275 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007276 (if possible). This applies to the commands: CTRL-D, CTRL-U, CTRL-B,
Bram Moolenaar843ee412004-06-30 16:16:41 +00007277 CTRL-F, "G", "H", "M", "L", gg, and to the commands "d", "<<" and ">>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007278 with a linewise operator, with "%" with a count and to buffer changing
7279 commands (CTRL-^, :bnext, :bNext, etc.). Also for an Ex command that
7280 only has a line number, e.g., ":25" or ":+".
7281 In case of buffer changing commands the cursor is placed at the column
7282 where it was the last time the buffer was edited.
7283 NOTE: This option is set when 'compatible' is set.
7284
Bram Moolenaar00654022011-02-25 14:42:19 +01007285 *'statusline'* *'stl'* *E540* *E542*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007286'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007287 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007288 {not available when compiled without the |+statusline|
7289 feature}
7290 When nonempty, this option determines the content of the status line.
7291 Also see |status-line|.
7292
7293 The option consists of printf style '%' items interspersed with
7294 normal text. Each status line item is of the form:
7295 %-0{minwid}.{maxwid}{item}
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01007296 All fields except the {item} are optional. A single percent sign can
Bram Moolenaar8133cc62020-10-26 21:05:27 +01007297 be given as "%%".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007298
Bram Moolenaar238a5642006-02-21 22:12:05 +00007299 When the option starts with "%!" then it is used as an expression,
7300 evaluated and the result is used as the option value. Example: >
7301 :set statusline=%!MyStatusLine()
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02007302< The *g:statusline_winid* variable will be set to the |window-ID| of the
7303 window that the status line belongs to.
7304 The result can contain %{} items that will be evaluated too.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02007305 Note that the "%!" expression is evaluated in the context of the
7306 current window and buffer, while %{} items are evaluated in the
7307 context of the window that the statusline belongs to.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007308
7309 When there is error while evaluating the option then it will be made
7310 empty to avoid further errors. Otherwise screen updating would loop.
7311
Bram Moolenaar071d4272004-06-13 20:20:40 +00007312 Note that the only effect of 'ruler' when this option is set (and
7313 'laststatus' is 2) is controlling the output of |CTRL-G|.
7314
7315 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00007316 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00007317 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007318 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007319 minwid Minimum width of the item, padding as set by '-' & '0'.
7320 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007321 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007322 on the left for text items. Numeric items will be
7323 shifted down to maxwid-2 digits followed by '>'number
7324 where number is the amount of missing digits, much like
7325 an exponential notation.
7326 item A one letter code as described below.
7327
7328 Following is a description of the possible statusline items. The
7329 second character in "item" is the type:
7330 N for number
7331 S for string
7332 F for flags as described below
7333 - not applicable
7334
7335 item meaning ~
Bram Moolenaar02467872007-05-06 13:22:01 +00007336 f S Path to the file in the buffer, as typed or relative to current
7337 directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007338 F S Full path to the file in the buffer.
7339 t S File name (tail) of file in the buffer.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007340 m F Modified flag, text is "[+]"; "[-]" if 'modifiable' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007341 M F Modified flag, text is ",+" or ",-".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007342 r F Readonly flag, text is "[RO]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007343 R F Readonly flag, text is ",RO".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007344 h F Help buffer flag, text is "[help]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007345 H F Help buffer flag, text is ",HLP".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007346 w F Preview window flag, text is "[Preview]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007347 W F Preview window flag, text is ",PRV".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007348 y F Type of file in the buffer, e.g., "[vim]". See 'filetype'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007349 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
Bram Moolenaar7fd73202010-07-25 16:58:46 +02007350 q S "[Quickfix List]", "[Location List]" or empty.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007351 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
7352 being used: "<keymap>"
7353 n N Buffer number.
Bram Moolenaar00654022011-02-25 14:42:19 +01007354 b N Value of character under cursor.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007355 B N As above, in hexadecimal.
7356 o N Byte number in file of byte under cursor, first byte is 1.
7357 Mnemonic: Offset from start of file (with one added)
7358 {not available when compiled without |+byte_offset| feature}
7359 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007360 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007361 l N Line number.
7362 L N Number of lines in buffer.
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02007363 c N Column number (byte index).
7364 v N Virtual column number (screen column).
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007365 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007366 p N Percentage through file in lines as in |CTRL-G|.
7367 P S Percentage through file of displayed window. This is like the
Bram Moolenaar14b69452013-06-29 23:05:20 +02007368 percentage described for 'ruler'. Always 3 in length, unless
7369 translated.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007370 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00007371 Empty if the argument file count is zero or one.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007372 { NF Evaluate expression between '%{' and '}' and substitute result.
Bram Moolenaar6d150f72018-04-21 20:03:20 +02007373 Note that there is no '%' before the closing '}'. The
7374 expression cannot contain a '}' character, call a function to
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007375 work around that. See |stl-%{| below.
shadmansaleh30e3de22021-05-15 17:23:28 +02007376 {% - This is almost same as { except the result of the expression is
7377 re-evaluated as a statusline format string. Thus if the
7378 return value of expr contains % items they will get expanded.
7379 The expression can contain the } character, the end of
7380 expression is denoted by %}.
7381 The For example: >
7382 func! Stl_filename() abort
7383 return "%t"
7384 endfunc
7385< `stl=%{Stl_filename()}` results in `"%t"`
7386 `stl=%{%Stl_filename()%}` results in `"Name of current file"`
7387 } - End of `{%` expression
Bram Moolenaar071d4272004-06-13 20:20:40 +00007388 ( - Start of item group. Can be used for setting the width and
7389 alignment of a section. Must be followed by %) somewhere.
7390 ) - End of item group. No width fields allowed.
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007391 T N For 'tabline': start of tab page N label. Use %T after the last
7392 label. This information is used for mouse clicks.
7393 X N For 'tabline': start of close tab N label. Use %X after the
7394 label, e.g.: %3Xclose%X. Use %999X for a "close current tab"
7395 mark. This information is used for mouse clicks.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007396 < - Where to truncate line if too long. Default is at the start.
7397 No width fields allowed.
7398 = - Separation point between left and right aligned items.
7399 No width fields allowed.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007400 # - Set highlight group. The name must follow and then a # again.
7401 Thus use %#HLname# for highlight group HLname. The same
7402 highlighting is used, also for the statusline of non-current
7403 windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007404 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00007405 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007406 The difference between User{N} and StatusLine will be applied
7407 to StatusLineNC for the statusline of non-current windows.
7408 The number N must be between 1 and 9. See |hl-User1..9|
7409
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007410 When displaying a flag, Vim removes the leading comma, if any, when
7411 that flag comes right after plaintext. This will make a nice display
7412 when flags are used like in the examples below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007413
Bram Moolenaar582fd852005-03-28 20:58:01 +00007414 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00007415 not set) and a minwid is not set for the group, the whole group will
7416 become empty. This will make a group like the following disappear
7417 completely from the statusline when none of the flags are set. >
7418 :set statusline=...%(\ [%M%R%H]%)...
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02007419< Beware that an expression is evaluated each and every time the status
7420 line is displayed.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007421 *stl-%{* *g:actual_curbuf* *g:actual_curwin*
Bram Moolenaarade0d392020-01-21 22:33:58 +01007422 While evaluating %{} the current buffer and current window will be set
7423 temporarily to that of the window (and buffer) whose statusline is
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007424 currently being drawn. The expression will evaluate in this context.
7425 The variable "g:actual_curbuf" is set to the `bufnr()` number of the
7426 real current buffer and "g:actual_curwin" to the |window-ID| of the
7427 real current window. These values are strings.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007428
Bram Moolenaar30b65812012-07-12 22:01:11 +02007429 The 'statusline' option will be evaluated in the |sandbox| if set from
7430 a modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02007431 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007432
7433 It is not allowed to change text or jump to another window while
7434 evaluating 'statusline' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007435
7436 If the statusline is not updated when you want it (e.g., after setting
7437 a variable that's used in an expression), you can force an update by
7438 setting an option without changing its value. Example: >
7439 :let &ro = &ro
7440
7441< A result of all digits is regarded a number for display purposes.
7442 Otherwise the result is taken as flag text and applied to the rules
7443 described above.
7444
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00007445 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00007446 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
Bram Moolenaarc4da1132017-07-15 19:39:43 +02007447 edit your .vimrc or whatever with "vim --clean" to get it right.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007448
7449 Examples:
7450 Emulate standard status line with 'ruler' set >
7451 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
7452< Similar, but add ASCII value of char under the cursor (like "ga") >
7453 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
7454< Display byte count and byte value, modified flag in red. >
7455 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
7456 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
7457< Display a ,GZ flag if a compressed file is loaded >
7458 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
7459< In the |:autocmd|'s: >
7460 :let b:gzflag = 1
7461< And: >
7462 :unlet b:gzflag
7463< And define this function: >
7464 :function VarExists(var, val)
7465 : if exists(a:var) | return a:val | else | return '' | endif
7466 :endfunction
7467<
7468 *'suffixes'* *'su'*
7469'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
7470 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007471 Files with these suffixes get a lower priority when multiple files
7472 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007473 suffixes. Spaces after the comma are ignored. A dot is also seen as
7474 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007475 separator, precede it with a backslash (see |option-backslash| about
7476 including spaces and backslashes).
7477 See 'wildignore' for completely ignoring files.
7478 The use of |:set+=| and |:set-=| is preferred when adding or removing
7479 suffixes from the list. This avoids problems when a future version
7480 uses another default.
7481
7482 *'suffixesadd'* *'sua'*
7483'suffixesadd' 'sua' string (default "")
7484 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007485 {not available when compiled without the
7486 |+file_in_path| feature}
7487 Comma separated list of suffixes, which are used when searching for a
7488 file for the "gf", "[I", etc. commands. Example: >
7489 :set suffixesadd=.java
7490<
7491 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
7492'swapfile' 'swf' boolean (default on)
7493 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007494 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007495 swapfile is not wanted for a specific buffer. For example, with
7496 confidential information that even root must not be able to access.
7497 Careful: All text will be in memory:
7498 - Don't use this for big files.
7499 - Recovery will be impossible!
7500 A swapfile will only be present when |'updatecount'| is non-zero and
7501 'swapfile' is set.
7502 When 'swapfile' is reset, the swap file for the current buffer is
7503 immediately deleted. When 'swapfile' is set, and 'updatecount' is
7504 non-zero, a swap file is immediately created.
7505 Also see |swap-file| and |'swapsync'|.
Bram Moolenaar76f3b1a2014-03-27 22:30:07 +01007506 If you want to open a new buffer without creating a swap file for it,
7507 use the |:noswapfile| modifier.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01007508 See 'directory' for where the swap file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007509
7510 This option is used together with 'bufhidden' and 'buftype' to
7511 specify special kinds of buffers. See |special-buffers|.
7512
7513 *'swapsync'* *'sws'*
7514'swapsync' 'sws' string (default "fsync")
7515 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007516 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007517 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007518 When this option is empty parts of the swap file may be in memory and
7519 not written to disk. When the system crashes you may lose more work.
7520 On Unix the system does a sync now and then without Vim asking for it,
7521 so the disadvantage of setting this option off is small. On some
7522 systems the swap file will not be written at all. For a unix system
7523 setting it to "sync" will use the sync() call instead of the default
7524 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007525 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007526
7527 *'switchbuf'* *'swb'*
7528'switchbuf' 'swb' string (default "")
7529 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007530 This option controls the behavior when switching between buffers.
Bram Moolenaard2ea7cf2021-05-30 20:54:13 +02007531 Mostly for |quickfix| commands some values are also used for other
7532 commands, as mentioned below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007533 Possible values (comma separated list):
7534 useopen If included, jump to the first open window that
7535 contains the specified buffer (if there is one).
7536 Otherwise: Do not examine other windows.
7537 This setting is checked with |quickfix| commands, when
7538 jumping to errors (":cc", ":cn", "cp", etc.). It is
7539 also used in all buffer related split commands, for
7540 example ":sbuffer", ":sbnext", or ":sbrewind".
Bram Moolenaar779b74b2006-04-10 14:55:34 +00007541 usetab Like "useopen", but also consider windows in other tab
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00007542 pages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007543 split If included, split the current window before loading
Bram Moolenaar15146672011-10-20 22:22:38 +02007544 a buffer for a |quickfix| command that display errors.
Bram Moolenaar63b74a82019-03-24 15:09:13 +01007545 Otherwise: do not split, use current window (when used
7546 in the quickfix window: the previously used window or
7547 split if there is no other window).
Bram Moolenaara594d772015-06-19 14:41:49 +02007548 vsplit Just like "split" but split vertically.
Bram Moolenaar446cb832008-06-24 21:56:24 +00007549 newtab Like "split", but open a new tab page. Overrules
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02007550 "split" when both are present.
Bram Moolenaar539aa6b2019-11-17 18:09:38 +01007551 uselast If included, jump to the previously used window when
7552 jumping to errors with |quickfix| commands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007553
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007554 *'synmaxcol'* *'smc'*
7555'synmaxcol' 'smc' number (default 3000)
7556 local to buffer
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007557 {not available when compiled without the |+syntax|
7558 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007559 Maximum column in which to search for syntax items. In long lines the
7560 text after this column is not highlighted and following lines may not
7561 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007562 This helps to avoid very slow redrawing for an XML file that is one
7563 long line.
7564 Set to zero to remove the limit.
7565
Bram Moolenaar071d4272004-06-13 20:20:40 +00007566 *'syntax'* *'syn'*
7567'syntax' 'syn' string (default empty)
7568 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007569 {not available when compiled without the |+syntax|
7570 feature}
7571 When this option is set, the syntax with this name is loaded, unless
7572 syntax highlighting has been switched off with ":syntax off".
7573 Otherwise this option does not always reflect the current syntax (the
7574 b:current_syntax variable does).
7575 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007576 not automatically recognized. Example, in an IDL file:
7577 /* vim: set syntax=idl : */ ~
7578 When a dot appears in the value then this separates two filetype
7579 names. Example:
7580 /* vim: set syntax=c.doxygen : */ ~
7581 This will use the "c" syntax first, then the "doxygen" syntax.
7582 Note that the second one must be prepared to be loaded as an addition,
7583 otherwise it will be skipped. More than one dot may appear.
7584 To switch off syntax highlighting for the current file, use: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007585 :set syntax=OFF
7586< To switch syntax highlighting on according to the current value of the
7587 'filetype' option: >
7588 :set syntax=ON
7589< What actually happens when setting the 'syntax' option is that the
7590 Syntax autocommand event is triggered with the value as argument.
7591 This option is not copied to another buffer, independent of the 's' or
7592 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007593 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007594
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007595 *'tabline'* *'tal'*
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007596'tabline' 'tal' string (default empty)
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007597 global
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007598 When nonempty, this option determines the content of the tab pages
7599 line at the top of the Vim window. When empty Vim will use a default
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007600 tab pages line. See |setting-tabline| for more info.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007601
7602 The tab pages line only appears as specified with the 'showtabline'
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00007603 option and only when there is no GUI tab line. When 'e' is in
7604 'guioptions' and the GUI supports a tab line 'guitablabel' is used
Bram Moolenaar7f036442010-08-15 15:24:20 +02007605 instead. Note that the two tab pages lines are very different.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007606
7607 The value is evaluated like with 'statusline'. You can use
7608 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007609 the text to be displayed. Use "%1T" for the first label, "%2T" for
7610 the second one, etc. Use "%X" items for closing labels.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007611
Bram Moolenaare12bab32019-01-08 22:02:56 +01007612 When changing something that is used in 'tabline' that does not
7613 trigger it to be updated, use |:redrawtabline|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02007614 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaare12bab32019-01-08 22:02:56 +01007615
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007616 Keep in mind that only one of the tab pages is the current one, others
7617 are invisible and you can't jump to their windows.
7618
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007619
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007620 *'tabpagemax'* *'tpm'*
7621'tabpagemax' 'tpm' number (default 10)
7622 global
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007623 Maximum number of tab pages to be opened by the |-p| command line
7624 argument or the ":tab all" command. |tabpage|
7625
7626
7627 *'tabstop'* *'ts'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007628'tabstop' 'ts' number (default 8)
7629 local to buffer
7630 Number of spaces that a <Tab> in the file counts for. Also see
7631 |:retab| command, and 'softtabstop' option.
7632
7633 Note: Setting 'tabstop' to any other value than 8 can make your file
7634 appear wrong in many places (e.g., when printing it).
7635
7636 There are four main ways to use tabs in Vim:
7637 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
7638 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007639 will use a mix of tabs and spaces, but typing <Tab> and <BS> will
Bram Moolenaar071d4272004-06-13 20:20:40 +00007640 behave like a tab appears every 4 (or 3) characters.
7641 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
7642 'expandtab'. This way you will always insert spaces. The
7643 formatting will never be messed up when 'tabstop' is changed.
7644 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007645 |modeline| to set these values when editing the file again. Only
Bram Moolenaar071d4272004-06-13 20:20:40 +00007646 works when using Vim to edit the file.
7647 4. Always set 'tabstop' and 'shiftwidth' to the same value, and
7648 'noexpandtab'. This should then work (for initial indents only)
7649 for any tabstop setting that people use. It might be nice to have
7650 tabs after the first non-blank inserted as spaces if you do this
7651 though. Otherwise aligned comments will be wrong when 'tabstop' is
7652 changed.
7653
Bram Moolenaar04958cb2018-06-23 19:23:02 +02007654 If Vim is compiled with the |+vartabs| feature then the value of
7655 'tabstop' will be ignored if |'vartabstop'| is set to anything other
7656 than an empty string.
7657
Bram Moolenaar071d4272004-06-13 20:20:40 +00007658 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
7659'tagbsearch' 'tbs' boolean (default on)
7660 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007661 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007662 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00007663 searching makes searching for a tag a LOT faster, but a linear search
7664 will find more tags if the tags file wasn't properly sorted.
7665 Vim normally assumes that your tags files are sorted, or indicate that
7666 they are not sorted. Only when this is not the case does the
7667 'tagbsearch' option need to be switched off.
7668
7669 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007670 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00007671 certain files, or retry all files with a linear search. When
7672 'tagbsearch' is off, only a linear search is done.
7673
7674 Linear searching is done anyway, for one file, when Vim finds a line
7675 at the start of the file indicating that it's not sorted: >
Bram Moolenaar446cb832008-06-24 21:56:24 +00007676 !_TAG_FILE_SORTED 0 /some comment/
Bram Moolenaar071d4272004-06-13 20:20:40 +00007677< [The whitespace before and after the '0' must be a single <Tab>]
7678
7679 When a binary search was done and no match was found in any of the
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007680 files listed in 'tags', and case is ignored or a pattern is used
Bram Moolenaar071d4272004-06-13 20:20:40 +00007681 instead of a normal tag name, a retry is done with a linear search.
7682 Tags in unsorted tags files, and matches with different case will only
7683 be found in the retry.
7684
Bram Moolenaard4755bb2004-09-02 19:12:26 +00007685 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007686 linear search can be avoided when case is ignored. Use a value of '2'
7687 in the "!_TAG_FILE_SORTED" line for this. A tag file can be case-fold
7688 sorted with the -f switch to "sort" in most unices, as in the command:
7689 "sort -f -o tags tags". For "Exuberant ctags" version 5.x or higher
7690 (at least 5.5) the --sort=foldcase switch can be used for this as
7691 well. Note that case must be folded to uppercase for this to work.
7692
7693 By default, tag searches are case-sensitive. Case is ignored when
7694 'ignorecase' is set and 'tagcase' is "followic", or when 'tagcase' is
7695 "ignore".
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007696 Also when 'tagcase' is "followscs" and 'smartcase' is set, or
7697 'tagcase' is "smart", and the pattern contains only lowercase
7698 characters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007699
7700 When 'tagbsearch' is off, tags searching is slower when a full match
7701 exists, but faster when no full match exists. Tags in unsorted tags
7702 files may only be found with 'tagbsearch' off.
7703 When the tags file is not sorted, or sorted in a wrong way (not on
7704 ASCII byte value), 'tagbsearch' should be off, or the line given above
7705 must be included in the tags file.
7706 This option doesn't affect commands that find all matching tags (e.g.,
7707 command-line completion and ":help").
Bram Moolenaar071d4272004-06-13 20:20:40 +00007708
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007709 *'tagcase'* *'tc'*
7710'tagcase' 'tc' string (default "followic")
7711 global or local to buffer |global-local|
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007712 This option specifies how case is handled when searching the tags
7713 file:
7714 followic Follow the 'ignorecase' option
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007715 followscs Follow the 'smartcase' and 'ignorecase' options
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007716 ignore Ignore case
7717 match Match case
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007718 smart Ignore case unless an upper case letter is used
Bram Moolenaar036986f2017-03-16 17:41:02 +01007719 NOTE: This option is set to the Vi default value when 'compatible' is
7720 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007721
Bram Moolenaar45e18cb2019-04-28 18:05:35 +02007722 *'tagfunc'* *'tfu'*
7723'tagfunc' 'tfu' string (default: empty)
7724 local to buffer
7725 {not available when compiled without the |+eval|
7726 feature}
7727 This option specifies a function to be used to perform tag searches.
7728 The function gets the tag pattern and should return a List of matching
7729 tags. See |tag-function| for an explanation of how to write the
7730 function and an example.
7731
Bram Moolenaar071d4272004-06-13 20:20:40 +00007732 *'taglength'* *'tl'*
7733'taglength' 'tl' number (default 0)
7734 global
7735 If non-zero, tags are significant up to this number of characters.
7736
7737 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
7738'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
7739 global
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00007740 If on and using a tags file in another directory, file names in that
7741 tags file are relative to the directory where the tags file is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007742 NOTE: This option is set to the Vi default value when 'compatible' is
7743 set and to the Vim default value when 'compatible' is reset.
7744
7745 *'tags'* *'tag'* *E433*
7746'tags' 'tag' string (default "./tags,tags", when compiled with
7747 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
7748 global or local to buffer |global-local|
7749 Filenames for the tag command, separated by spaces or commas. To
7750 include a space or comma in a file name, precede it with a backslash
7751 (see |option-backslash| about including spaces and backslashes).
7752 When a file name starts with "./", the '.' is replaced with the path
7753 of the current file. But only when the 'd' flag is not included in
7754 'cpoptions'. Environment variables are expanded |:set_env|. Also see
7755 |tags-option|.
7756 "*", "**" and other wildcards can be used to search for tags files in
Bram Moolenaare2b590e2010-08-08 18:29:48 +02007757 a directory tree. See |file-searching|. E.g., "/lib/**/tags" will
7758 find all files named "tags" below "/lib". The filename itself cannot
7759 contain wildcards, it is used as-is. E.g., "/lib/**/tags?" will find
7760 files called "tags?". {not available when compiled without the
7761 |+path_extra| feature}
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00007762 The |tagfiles()| function can be used to get a list of the file names
7763 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007764 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
7765 files are also supported. They are automatically recognized. The
7766 default value becomes "./tags,./TAGS,tags,TAGS", unless case
7767 differences are ignored (MS-Windows). |emacs-tags|
7768 The use of |:set+=| and |:set-=| is preferred when adding or removing
7769 file names from the list. This avoids problems when a future version
7770 uses another default.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007771
7772 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
7773'tagstack' 'tgst' boolean (default on)
7774 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007775 When on, the |tagstack| is used normally. When off, a ":tag" or
7776 ":tselect" command with an argument will not push the tag onto the
7777 tagstack. A following ":tag" without an argument, a ":pop" command or
7778 any other command that uses the tagstack will use the unmodified
7779 tagstack, but does change the pointer to the active entry.
7780 Resetting this option is useful when using a ":tag" command in a
7781 mapping which should not change the tagstack.
7782
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007783 *'tcldll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01007784'tcldll' string (default depends on the build)
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007785 global
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007786 {only available when compiled with the |+tcl/dyn|
7787 feature}
7788 Specifies the name of the Tcl shared library. The default is
7789 DYNAMIC_TCL_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02007790 Environment variables are expanded |:set_env|.
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007791 This option cannot be set from a |modeline| or in the |sandbox|, for
7792 security reasons.
7793
Bram Moolenaar071d4272004-06-13 20:20:40 +00007794 *'term'* *E529* *E530* *E531*
7795'term' string (default is $TERM, if that fails:
7796 in the GUI: "builtin_gui"
7797 on Amiga: "amiga"
Bram Moolenaarb3f74062020-02-26 16:16:53 +01007798 on Haiku: "xterm"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007799 on Mac: "mac-ansi"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007800 on Unix: "ansi"
7801 on VMS: "ansi"
7802 on Win 32: "win32")
7803 global
7804 Name of the terminal. Used for choosing the terminal control
7805 characters. Environment variables are expanded |:set_env|.
7806 For example: >
7807 :set term=$TERM
7808< See |termcap|.
7809
7810 *'termbidi'* *'tbidi'*
7811 *'notermbidi'* *'notbidi'*
7812'termbidi' 'tbidi' boolean (default off, on for "mlterm")
7813 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007814 {only available when compiled with the |+arabic|
7815 feature}
7816 The terminal is in charge of Bi-directionality of text (as specified
7817 by Unicode). The terminal is also expected to do the required shaping
7818 that some languages (such as Arabic) require.
7819 Setting this option implies that 'rightleft' will not be set when
7820 'arabic' is set and the value of 'arabicshape' will be ignored.
7821 Note that setting 'termbidi' has the immediate effect that
7822 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
7823 This option is reset when the GUI is started.
7824 For further details see |arabic.txt|.
7825
7826 *'termencoding'* *'tenc'*
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02007827'termencoding' 'tenc' string (default ""; with GTK+ GUI: "utf-8")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007828 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007829 Encoding used for the terminal. This specifies what character
7830 encoding the keyboard produces and the display will understand. For
Bram Moolenaar3848e002016-03-19 18:42:29 +01007831 the GUI it only applies to the keyboard ('encoding' is used for the
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02007832 display).
Bram Moolenaar4b7cdca2020-01-01 16:18:38 +01007833 *E617* *E950*
Bram Moolenaar3df01732017-02-17 22:47:16 +01007834 Note: This does not apply to the GTK+ GUI. After the GUI has been
Bram Moolenaar071d4272004-06-13 20:20:40 +00007835 successfully initialized, 'termencoding' is forcibly set to "utf-8".
7836 Any attempts to set a different value will be rejected, and an error
7837 message is shown.
Bram Moolenaarac360bf2015-09-01 20:31:20 +02007838 For the Win32 GUI and console versions 'termencoding' is not used,
Bram Moolenaar071d4272004-06-13 20:20:40 +00007839 because the Win32 system always passes Unicode characters.
7840 When empty, the same encoding is used as for the 'encoding' option.
7841 This is the normal value.
7842 Not all combinations for 'termencoding' and 'encoding' are valid. See
7843 |encoding-table|.
7844 The value for this option must be supported by internal conversions or
7845 iconv(). When this is not possible no conversion will be done and you
7846 will probably experience problems with non-ASCII characters.
7847 Example: You are working with the locale set to euc-jp (Japanese) and
7848 want to edit a UTF-8 file: >
7849 :let &termencoding = &encoding
7850 :set encoding=utf-8
7851< You need to do this when your system has no locale support for UTF-8.
7852
Bram Moolenaarcafafb32018-02-22 21:07:09 +01007853 *'termguicolors'* *'tgc'* *E954*
Bram Moolenaar61be73b2016-04-29 22:59:22 +02007854'termguicolors' 'tgc' boolean (default off)
7855 global
Bram Moolenaar61be73b2016-04-29 22:59:22 +02007856 {not available when compiled without the
7857 |+termguicolors| feature}
7858 When on, uses |highlight-guifg| and |highlight-guibg| attributes in
Bram Moolenaarcafafb32018-02-22 21:07:09 +01007859 the terminal (thus using 24-bit color).
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01007860
Bram Moolenaarcafafb32018-02-22 21:07:09 +01007861 Requires a ISO-8613-3 compatible terminal. If setting this option
7862 does not work (produces a colorless UI) reading |xterm-true-color|
7863 might help.
7864
7865 For Win32 console, Windows 10 version 1703 (Creators Update) or later
7866 is required. Use this check to find out: >
7867 if has('vcon')
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01007868< This requires Vim to be built with the |+vtp| feature.
7869
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +02007870 Note that the "cterm" attributes are still used, not the "gui" ones.
Bram Moolenaar036986f2017-03-16 17:41:02 +01007871 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar61be73b2016-04-29 22:59:22 +02007872
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02007873 *'termwinkey'* *'twk'*
7874'termwinkey' 'twk' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02007875 local to window
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007876 The key that starts a CTRL-W command in a terminal window. Other keys
Bram Moolenaar74675a62017-07-15 13:53:23 +02007877 are sent to the job running in the window.
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007878 The <> notation can be used, e.g.: >
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02007879 :set termwinkey=<C-L>
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007880< The string must be one key stroke but can be multiple bytes.
7881 When not set CTRL-W is used, so that CTRL-W : gets you to the command
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02007882 line. If 'termwinkey' is set to CTRL-L then CTRL-L : gets you to the
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007883 command line.
Bram Moolenaar74675a62017-07-15 13:53:23 +02007884
Bram Moolenaar6c60f472019-04-28 16:00:35 +02007885 *'termwinscroll'* *'twsl'*
7886'termwinscroll' 'twsl' number (default 10000)
7887 local to buffer
7888 {not available when compiled without the
7889 |+terminal| feature}
7890 Number of scrollback lines to keep. When going over this limit the
7891 first 10% of the scrollback lines are deleted. This is just to reduce
7892 the memory usage. See |Terminal-Normal|.
7893
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02007894 *'termwinsize'* *'tws'*
7895'termwinsize' 'tws' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02007896 local to window
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02007897 Size used when opening the |terminal| window. Format:
7898 {rows}x{columns} or {rows}*{columns}.
Bram Moolenaar74675a62017-07-15 13:53:23 +02007899 - When empty the terminal gets the size from the window.
Bram Moolenaar498c2562018-04-15 23:45:15 +02007900 - When set with a "x" (e.g., "24x80") the terminal size is not
7901 adjusted to the window size. If the window is smaller only the
7902 top-left part is displayed.
7903 - When set with a "*" (e.g., "10*50") the terminal size follows the
7904 window size, but will not be smaller than the specified rows and/or
7905 columns.
7906 - When rows is zero then use the height of the window.
7907 - When columns is zero then use the width of the window.
7908 - Using "0x0" or "0*0" is the same as empty.
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02007909 - Can be overruled in the |term_start()| options with "term_rows" and
7910 "term_cols".
Bram Moolenaar498c2562018-04-15 23:45:15 +02007911
7912 Examples:
7913 "30x0" uses 30 rows and the current window width.
7914 "20*0" uses at least 20 rows and the current window width.
7915 "0*40" uses the current window height and at least 40 columns.
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02007916 Note that the command running in the terminal window may still change
7917 the size of the terminal. In that case the Vim window will be
7918 adjusted to that size, if possible.
Bram Moolenaar74675a62017-07-15 13:53:23 +02007919
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01007920 *'termwintype'* *'twt'*
7921'termwintype' 'twt' string (default "")
7922 global
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01007923 {only available when compiled with the |terminal|
7924 feature on MS-Windows}
7925 Specify the virtual console (pty) used when opening the terminal
7926 window.
7927
7928 Possible values are:
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01007929 "" use ConPTY if it is stable, winpty otherwise
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01007930 "winpty" use winpty, fail if not supported
7931 "conpty" use |ConPTY|, fail if not supported
7932
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01007933 |ConPTY| support depends on the platform. Windows 10 October 2018
7934 Update is the first version that supports ConPTY, however it is still
7935 considered unstable. ConPTY might become stable in the next release
7936 of Windows 10. winpty support needs to be installed. If neither is
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01007937 supported then you cannot open a terminal window.
7938
Bram Moolenaar071d4272004-06-13 20:20:40 +00007939 *'terse'* *'noterse'*
7940'terse' boolean (default off)
7941 global
7942 When set: Add 's' flag to 'shortmess' option (this makes the message
7943 for a search that hits the start or end of the file not being
7944 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
7945 shortens a lot of messages}
7946
7947 *'textauto'* *'ta'* *'notextauto'* *'nota'*
7948'textauto' 'ta' boolean (Vim default: on, Vi default: off)
7949 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007950 This option is obsolete. Use 'fileformats'.
7951 For backwards compatibility, when 'textauto' is set, 'fileformats' is
7952 set to the default value for the current system. When 'textauto' is
7953 reset, 'fileformats' is made empty.
7954 NOTE: This option is set to the Vi default value when 'compatible' is
7955 set and to the Vim default value when 'compatible' is reset.
7956
7957 *'textmode'* *'tx'* *'notextmode'* *'notx'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01007958'textmode' 'tx' boolean (Win32: default on,
Bram Moolenaar071d4272004-06-13 20:20:40 +00007959 others: default off)
7960 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007961 This option is obsolete. Use 'fileformat'.
7962 For backwards compatibility, when 'textmode' is set, 'fileformat' is
7963 set to "dos". When 'textmode' is reset, 'fileformat' is set to
7964 "unix".
7965
7966 *'textwidth'* *'tw'*
7967'textwidth' 'tw' number (default 0)
7968 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007969 Maximum width of text that is being inserted. A longer line will be
7970 broken after white space to get this width. A zero value disables
Bram Moolenaarca635012015-09-25 20:34:21 +02007971 this.
7972 'textwidth' is set to 0 when the 'paste' option is set and restored
7973 when 'paste' is reset.
7974 When 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00007975 'formatoptions' and |ins-textwidth|.
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00007976 When 'formatexpr' is set it will be used to break the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007977 NOTE: This option is set to 0 when 'compatible' is set.
7978
7979 *'thesaurus'* *'tsr'*
7980'thesaurus' 'tsr' string (default "")
7981 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007982 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01007983 for thesaurus completion commands |i_CTRL-X_CTRL-T|.
7984
7985 Each line in the file should contain words with similar meaning,
7986 separated by non-keyword characters (white space is preferred).
7987 Maximum line length is 510 bytes.
7988
Bram Moolenaard47d5222018-12-09 20:43:55 +01007989 An English word list was added to this github issue:
7990 https://github.com/vim/vim/issues/629#issuecomment-443293282
7991 Unpack thesaurus_pkg.zip, put the thesaurus.txt file somewhere, e.g.
7992 ~/.vim/thesaurus/english.txt, and the 'thesaurus' option to this file
7993 name.
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01007994
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007995 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00007996 after a comma are ignored, otherwise spaces are included in the file
7997 name. See |option-backslash| about using backslashes.
7998 The use of |:set+=| and |:set-=| is preferred when adding or removing
7999 directories from the list. This avoids problems when a future version
8000 uses another default.
8001 Backticks cannot be used in this option for security reasons.
8002
8003 *'tildeop'* *'top'* *'notildeop'* *'notop'*
8004'tildeop' 'top' boolean (default off)
8005 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008006 When on: The tilde command "~" behaves like an operator.
8007 NOTE: This option is reset when 'compatible' is set.
8008
8009 *'timeout'* *'to'* *'notimeout'* *'noto'*
8010'timeout' 'to' boolean (default on)
8011 global
8012 *'ttimeout'* *'nottimeout'*
Bram Moolenaar94237492017-04-23 18:40:21 +02008013'ttimeout' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008014 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008015 These two options together determine the behavior when part of a
8016 mapped key sequence or keyboard code has been received:
8017
8018 'timeout' 'ttimeout' action ~
8019 off off do not time out
8020 on on or off time out on :mappings and key codes
8021 off on time out on key codes
8022
8023 If both options are off, Vim will wait until either the complete
8024 mapping or key sequence has been received, or it is clear that there
8025 is no mapping or key sequence for the received characters. For
8026 example: if you have mapped "vl" and Vim has received 'v', the next
8027 character is needed to see if the 'v' is followed by an 'l'.
8028 When one of the options is on, Vim will wait for about 1 second for
8029 the next character to arrive. After that the already received
8030 characters are interpreted as single characters. The waiting time can
8031 be changed with the 'timeoutlen' option.
8032 On slow terminals or very busy systems timing out may cause
8033 malfunctioning cursor keys. If both options are off, Vim waits
8034 forever after an entered <Esc> if there are key codes that start
8035 with <Esc>. You will have to type <Esc> twice. If you do not have
8036 problems with key codes, but would like to have :mapped key
8037 sequences not timing out in 1 second, set the 'ttimeout' option and
8038 reset the 'timeout' option.
8039
8040 NOTE: 'ttimeout' is reset when 'compatible' is set.
8041
8042 *'timeoutlen'* *'tm'*
8043'timeoutlen' 'tm' number (default 1000)
8044 global
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008045
Bram Moolenaar071d4272004-06-13 20:20:40 +00008046 *'ttimeoutlen'* *'ttm'*
Bram Moolenaar94237492017-04-23 18:40:21 +02008047'ttimeoutlen' 'ttm' number (default -1, set to 100 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008048 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008049 The time in milliseconds that is waited for a key code or mapped key
8050 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
8051 when part of a command has been typed.
8052 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
8053 different timeout value for key codes is desired set 'ttimeoutlen' to
8054 a non-negative number.
8055
8056 ttimeoutlen mapping delay key code delay ~
8057 < 0 'timeoutlen' 'timeoutlen'
8058 >= 0 'timeoutlen' 'ttimeoutlen'
8059
8060 The timeout only happens when the 'timeout' and 'ttimeout' options
8061 tell so. A useful setting would be >
8062 :set timeout timeoutlen=3000 ttimeoutlen=100
8063< (time out on mapping after three seconds, time out on key codes after
8064 a tenth of a second).
8065
8066 *'title'* *'notitle'*
8067'title' boolean (default off, on when title can be restored)
8068 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008069 {not available when compiled without the |+title|
8070 feature}
8071 When on, the title of the window will be set to the value of
8072 'titlestring' (if it is not empty), or to:
8073 filename [+=-] (path) - VIM
8074 Where:
8075 filename the name of the file being edited
8076 - indicates the file cannot be modified, 'ma' off
8077 + indicates the file was modified
8078 = indicates the file is read-only
8079 =+ indicates the file is read-only and modified
8080 (path) is the path of the file being edited
8081 - VIM the server name |v:servername| or "VIM"
8082 Only works if the terminal supports setting window titles
8083 (currently Amiga console, Win32 console, all GUI versions and
Bram Moolenaard1caa942020-04-10 22:10:56 +02008084 terminals with a non-empty 't_ts' option - these are Unix xterm and
Bram Moolenaar071d4272004-06-13 20:20:40 +00008085 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
8086 *X11*
8087 When Vim was compiled with HAVE_X11 defined, the original title will
8088 be restored if possible. The output of ":version" will include "+X11"
8089 when HAVE_X11 was defined, otherwise it will be "-X11". This also
8090 works for the icon name |'icon'|.
8091 But: When Vim was started with the |-X| argument, restoring the title
8092 will not work (except in the GUI).
8093 If the title cannot be restored, it is set to the value of 'titleold'.
8094 You might want to restore the title outside of Vim then.
8095 When using an xterm from a remote machine you can use this command:
8096 rsh machine_name xterm -display $DISPLAY &
8097 then the WINDOWID environment variable should be inherited and the
8098 title of the window should change back to what it should be after
8099 exiting Vim.
8100
8101 *'titlelen'*
8102'titlelen' number (default 85)
8103 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008104 {not available when compiled without the |+title|
8105 feature}
8106 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008107 title. When the title is longer, only the end of the path name is
8108 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008109 Using a percentage makes this adapt to the width of the window. But
8110 it won't work perfectly, because the actual number of characters
8111 available also depends on the font used and other things in the title
8112 bar. When 'titlelen' is zero the full path is used. Otherwise,
8113 values from 1 to 30000 percent can be used.
8114 'titlelen' is also used for the 'titlestring' option.
8115
8116 *'titleold'*
8117'titleold' string (default "Thanks for flying Vim")
8118 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008119 {only available when compiled with the |+title|
8120 feature}
8121 This option will be used for the window title when exiting Vim if the
8122 original title cannot be restored. Only happens if 'title' is on or
8123 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00008124 This option cannot be set from a |modeline| or in the |sandbox|, for
8125 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008126 *'titlestring'*
8127'titlestring' string (default "")
8128 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008129 {not available when compiled without the |+title|
8130 feature}
8131 When this option is not empty, it will be used for the title of the
8132 window. This happens only when the 'title' option is on.
8133 Only works if the terminal supports setting window titles (currently
8134 Amiga console, Win32 console, all GUI versions and terminals with a
8135 non-empty 't_ts' option).
8136 When Vim was compiled with HAVE_X11 defined, the original title will
Bram Moolenaar51628222016-12-01 23:03:28 +01008137 be restored if possible, see |X11|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008138
Bram Moolenaar071d4272004-06-13 20:20:40 +00008139 When this option contains printf-style '%' items, they will be
8140 expanded according to the rules used for 'statusline'.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008141 This option cannot be set in a modeline when 'modelineexpr' is off.
8142
Bram Moolenaar071d4272004-06-13 20:20:40 +00008143 Example: >
8144 :auto BufEnter * let &titlestring = hostname() . "/" . expand("%:p")
8145 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
8146< The value of 'titlelen' is used to align items in the middle or right
8147 of the available space.
8148 Some people prefer to have the file name first: >
8149 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
8150< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008151 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00008152 separating space only when needed.
8153 NOTE: Use of special characters in 'titlestring' may cause the display
8154 to be garbled (e.g., when it contains a CR or NL character).
8155 {not available when compiled without the |+statusline| feature}
8156
8157 *'toolbar'* *'tb'*
8158'toolbar' 'tb' string (default "icons,tooltips")
8159 global
8160 {only for |+GUI_GTK|, |+GUI_Athena|, |+GUI_Motif| and
8161 |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008162 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00008163 possible values are:
8164 icons Toolbar buttons are shown with icons.
8165 text Toolbar buttons shown with text.
8166 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008167 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008168 tooltips Tooltips are active for toolbar buttons.
8169 Tooltips refer to the popup help text which appears after the mouse
8170 cursor is placed over a toolbar button for a brief moment.
8171
8172 If you want the toolbar to be shown with icons as well as text, do the
8173 following: >
8174 :set tb=icons,text
8175< Motif and Athena cannot display icons and text at the same time. They
8176 will show icons if both are requested.
8177
8178 If none of the strings specified in 'toolbar' are valid or if
8179 'toolbar' is empty, this option is ignored. If you want to disable
8180 the toolbar, you need to set the 'guioptions' option. For example: >
8181 :set guioptions-=T
8182< Also see |gui-toolbar|.
8183
8184 *'toolbariconsize'* *'tbis'*
8185'toolbariconsize' 'tbis' string (default "small")
8186 global
Bram Moolenaar3df01732017-02-17 22:47:16 +01008187 {only in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008188 Controls the size of toolbar icons. The possible values are:
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008189 tiny Use tiny icons.
8190 small Use small icons (default).
8191 medium Use medium-sized icons.
8192 large Use large icons.
8193 huge Use even larger icons.
8194 giant Use very big icons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008195 The exact dimensions in pixels of the various icon sizes depend on
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008196 the current theme. Common dimensions are giant=48x48, huge=32x32,
8197 large=24x24, medium=24x24, small=20x20 and tiny=16x16.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008198
8199 If 'toolbariconsize' is empty, the global default size as determined
8200 by user preferences or the current theme is used.
8201
8202 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
8203'ttybuiltin' 'tbi' boolean (default on)
8204 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008205 When on, the builtin termcaps are searched before the external ones.
8206 When off the builtin termcaps are searched after the external ones.
8207 When this option is changed, you should set the 'term' option next for
8208 the change to take effect, for example: >
8209 :set notbi term=$TERM
8210< See also |termcap|.
8211 Rationale: The default for this option is "on", because the builtin
8212 termcap entries are generally better (many systems contain faulty
8213 xterm entries...).
8214
8215 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
8216'ttyfast' 'tf' boolean (default off, on when 'term' is xterm, hpterm,
8217 sun-cmd, screen, rxvt, dtterm or
8218 iris-ansi; also on when running Vim in
8219 a DOS console)
8220 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008221 Indicates a fast terminal connection. More characters will be sent to
8222 the screen for redrawing, instead of using insert/delete line
8223 commands. Improves smoothness of redrawing when there are multiple
8224 windows and the terminal does not support a scrolling region.
8225 Also enables the extra writing of characters at the end of each screen
8226 line for lines that wrap. This helps when using copy/paste with the
8227 mouse in an xterm and other terminals.
8228
8229 *'ttymouse'* *'ttym'*
8230'ttymouse' 'ttym' string (default depends on 'term')
8231 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008232 {only in Unix and VMS, doesn't work in the GUI; not
8233 available when compiled without |+mouse|}
8234 Name of the terminal type for which mouse codes are to be recognized.
Bram Moolenaar2c7a7632007-05-10 18:19:11 +00008235 Currently these strings are valid:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008236 *xterm-mouse*
8237 xterm xterm-like mouse handling. The mouse generates
8238 "<Esc>[Mscr", where "scr" is three bytes:
8239 "s" = button state
8240 "c" = column plus 33
8241 "r" = row plus 33
Bram Moolenaare968e362014-05-13 20:23:24 +02008242 This only works up to 223 columns! See "dec",
8243 "urxvt", and "sgr" for solutions.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008244 xterm2 Works like "xterm", but with the xterm reporting the
8245 mouse position while the mouse is dragged. This works
8246 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00008247 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00008248 work. See below for how Vim detects this
8249 automatically.
8250 *netterm-mouse*
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008251 netterm NetTerm mouse handling. A left mouse click generates
Bram Moolenaar071d4272004-06-13 20:20:40 +00008252 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008253 for the row and column. No other mouse events are
8254 supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008255 *dec-mouse*
8256 dec DEC terminal mouse handling. The mouse generates a
8257 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00008258 This is also available for an Xterm, if it was
8259 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00008260 *jsbterm-mouse*
8261 jsbterm JSB term mouse handling.
8262 *pterm-mouse*
8263 pterm QNX pterm mouse handling.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008264 *urxvt-mouse*
8265 urxvt Mouse handling for the urxvt (rxvt-unicode) terminal.
Bram Moolenaare968e362014-05-13 20:23:24 +02008266 The mouse works only if the terminal supports this
8267 encoding style, but it does not have 223 columns limit
8268 unlike "xterm" or "xterm2".
Bram Moolenaar9b451252012-08-15 17:43:31 +02008269 *sgr-mouse*
8270 sgr Mouse handling for the terminal that emits SGR-styled
Bram Moolenaare968e362014-05-13 20:23:24 +02008271 mouse reporting. The mouse works even in columns
8272 beyond 223. This option is backward compatible with
8273 "xterm2" because it can also decode "xterm2" style
8274 mouse codes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008275
8276 The mouse handling must be enabled at compile time |+mouse_xterm|
Bram Moolenaare968e362014-05-13 20:23:24 +02008277 |+mouse_dec| |+mouse_netterm| |+mouse_jsbterm| |+mouse_urxvt|
8278 |+mouse_sgr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008279 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
8280 recognized, if enabled at compile time. DEC terminal mouse codes
8281 are recognized if enabled at compile time, and 'ttymouse' is not
Bram Moolenaare968e362014-05-13 20:23:24 +02008282 "xterm", "xterm2", "urxvt" or "sgr" (because dec mouse codes conflict
8283 with them).
Bram Moolenaar071d4272004-06-13 20:20:40 +00008284 This option is automatically set to "xterm", when the 'term' option is
Bram Moolenaar45758762016-10-12 23:08:06 +02008285 set to a name that starts with "xterm", "mlterm", "screen", "tmux",
8286 "st" (full match only), "st-" or "stterm", and 'ttymouse' is not set
8287 already.
Bram Moolenaare968e362014-05-13 20:23:24 +02008288 Additionally, if vim is compiled with the |+termresponse| feature and
8289 |t_RV| is set to the escape sequence to request the xterm version
Bram Moolenaarf8a07122019-07-01 22:06:07 +02008290 number, more intelligent detection is done.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008291 The "xterm2" value will be set if the xterm version is reported to be
Bram Moolenaard47d5222018-12-09 20:43:55 +01008292 from 95 to 276. The "sgr" value will be set if Vim detects Mac
8293 Terminal.app, iTerm2 or mintty, and when the xterm version is 277 or
8294 higher.
Bram Moolenaare968e362014-05-13 20:23:24 +02008295 If you do not want 'ttymouse' to be set to "xterm2" or "sgr"
8296 automatically, set t_RV to an empty string: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008297 :set t_RV=
8298<
8299 *'ttyscroll'* *'tsl'*
8300'ttyscroll' 'tsl' number (default 999)
8301 global
8302 Maximum number of lines to scroll the screen. If there are more lines
8303 to scroll the window is redrawn. For terminals where scrolling is
8304 very slow and redrawing is not slow this can be set to a small number,
8305 e.g., 3, to speed up displaying.
8306
8307 *'ttytype'* *'tty'*
8308'ttytype' 'tty' string (default from $TERM)
8309 global
8310 Alias for 'term', see above.
8311
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008312 *'undodir'* *'udir'*
8313'undodir' 'udir' string (default ".")
8314 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008315 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008316 List of directory names for undo files, separated with commas.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008317 See |'backupdir'| for details of the format.
Bram Moolenaar6a244fe2010-05-24 22:02:24 +02008318 "." means using the directory of the file. The undo file name for
8319 "file.txt" is ".file.txt.un~".
8320 For other directories the file name is the full path of the edited
8321 file, with path separators replaced with "%".
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008322 When writing: The first directory that exists is used. "." always
8323 works, no directories after "." will be used for writing.
8324 When reading all entries are tried to find an undo file. The first
8325 undo file that exists is used. When it cannot be read an error is
8326 given, no further entry is used.
8327 See |undo-persistence|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008328 This option cannot be set from a |modeline| or in the |sandbox|, for
8329 security reasons.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008330
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02008331 *'undofile'* *'noundofile'* *'udf'* *'noudf'*
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008332'undofile' 'udf' boolean (default off)
8333 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02008334 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008335 When on, Vim automatically saves undo history to an undo file when
8336 writing a buffer to a file, and restores undo history from the same
8337 file on buffer read.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008338 The directory where the undo file is stored is specified by 'undodir'.
8339 For more information about this feature see |undo-persistence|.
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008340 The undo file is not read when 'undoreload' causes the buffer from
8341 before a reload to be saved for undo.
Bram Moolenaar97d62492012-11-15 21:28:22 +01008342 When 'undofile' is turned off the undo file is NOT deleted.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008343 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008344
Bram Moolenaar071d4272004-06-13 20:20:40 +00008345 *'undolevels'* *'ul'*
Bram Moolenaar8024f932020-01-14 19:29:13 +01008346'undolevels' 'ul' number (default 100, 1000 for Unix, VMS and Win32)
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008347 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008348 Maximum number of changes that can be undone. Since undo information
Bram Moolenaar5be4cee2019-09-27 19:34:08 +02008349 is kept in memory, higher numbers will cause more memory to be used.
8350 Nevertheless, a single change can already use a large amount of memory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008351 Set to 0 for Vi compatibility: One level of undo and "u" undoes
8352 itself: >
8353 set ul=0
8354< But you can also get Vi compatibility by including the 'u' flag in
8355 'cpoptions', and still be able to use CTRL-R to repeat undo.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008356 Also see |undo-two-ways|.
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008357 Set to -1 for no undo at all. You might want to do this only for the
8358 current buffer: >
8359 setlocal ul=-1
Bram Moolenaar071d4272004-06-13 20:20:40 +00008360< This helps when you run out of memory for a single change.
Bram Moolenaar32efaf62014-11-05 17:02:17 +01008361
8362 The local value is set to -123456 when the global value is to be used.
8363
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008364 Also see |clear-undo|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008365
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008366 *'undoreload'* *'ur'*
8367'undoreload' 'ur' number (default 10000)
8368 global
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008369 Save the whole buffer for undo when reloading it. This applies to the
8370 ":e!" command and reloading for when the buffer changed outside of
8371 Vim. |FileChangedShell|
Bram Moolenaar24a98a02017-09-27 22:23:55 +02008372 The save only happens when this option is negative or when the number
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008373 of lines is smaller than the value of this option.
8374 Set this option to zero to disable undo for a reload.
8375
8376 When saving undo for a reload, any undo file is not read.
8377
8378 Note that this causes the whole buffer to be stored in memory. Set
8379 this option to a lower value if you run out of memory.
8380
Bram Moolenaar071d4272004-06-13 20:20:40 +00008381 *'updatecount'* *'uc'*
8382'updatecount' 'uc' number (default: 200)
8383 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008384 After typing this many characters the swap file will be written to
8385 disk. When zero, no swap file will be created at all (see chapter on
8386 recovery |crash-recovery|). 'updatecount' is set to zero by starting
8387 Vim with the "-n" option, see |startup|. When editing in readonly
8388 mode this option will be initialized to 10000.
8389 The swapfile can be disabled per buffer with |'swapfile'|.
8390 When 'updatecount' is set from zero to non-zero, swap files are
8391 created for all buffers that have 'swapfile' set. When 'updatecount'
8392 is set to zero, existing swap files are not deleted.
8393 Also see |'swapsync'|.
8394 This option has no meaning in buffers where |'buftype'| is "nofile"
8395 or "nowrite".
8396
8397 *'updatetime'* *'ut'*
8398'updatetime' 'ut' number (default 4000)
8399 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008400 If this many milliseconds nothing is typed the swap file will be
8401 written to disk (see |crash-recovery|). Also used for the
8402 |CursorHold| autocommand event.
8403
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008404 *'varsofttabstop'* *'vsts'*
8405'varsofttabstop' 'vsts' string (default "")
8406 local to buffer
8407 {only available when compiled with the |+vartabs|
8408 feature}
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008409 A list of the number of spaces that a <Tab> counts for while editing,
8410 such as inserting a <Tab> or using <BS>. It "feels" like variable-
8411 width <Tab>s are being inserted, while in fact a mixture of spaces
8412 and <Tab>s is used. Tab widths are separated with commas, with the
8413 final value applying to all subsequent tabs.
8414
8415 For example, when editing assembly language files where statements
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02008416 start in the 9th column and comments in the 41st, it may be useful
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008417 to use the following: >
8418 :set varsofttabstop=8,32,8
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02008419< This will set soft tabstops with 8 and 8 + 32 spaces, and 8 more
8420 for every column thereafter.
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008421
8422 Note that the value of |'softtabstop'| will be ignored while
8423 'varsofttabstop' is set.
8424
8425 *'vartabstop'* *'vts'*
8426'vartabstop' 'vts' string (default "")
8427 local to buffer
8428 {only available when compiled with the |+vartabs|
8429 feature}
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008430 A list of the number of spaces that a <Tab> in the file counts for,
8431 separated by commas. Each value corresponds to one tab, with the
8432 final value applying to all subsequent tabs. For example: >
8433 :set vartabstop=4,20,10,8
8434< This will make the first tab 4 spaces wide, the second 20 spaces,
8435 the third 10 spaces, and all following tabs 8 spaces.
8436
8437 Note that the value of |'tabstop'| will be ignored while 'vartabstop'
8438 is set.
8439
Bram Moolenaar071d4272004-06-13 20:20:40 +00008440 *'verbose'* *'vbs'*
8441'verbose' 'vbs' number (default 0)
8442 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008443 When bigger than zero, Vim will give messages about what it is doing.
8444 Currently, these messages are given:
8445 >= 1 When the viminfo file is read or written.
8446 >= 2 When a file is ":source"'ed.
Bram Moolenaar647a5302020-05-03 17:01:24 +02008447 >= 4 Shell commands.
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008448 >= 5 Every searched tags file and include file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008449 >= 8 Files for which a group of autocommands is executed.
8450 >= 9 Every executed autocommand.
Bram Moolenaar647a5302020-05-03 17:01:24 +02008451 >= 11 Finding items in a path
Bram Moolenaar071d4272004-06-13 20:20:40 +00008452 >= 12 Every executed function.
8453 >= 13 When an exception is thrown, caught, finished, or discarded.
8454 >= 14 Anything pending in a ":finally" clause.
Bram Moolenaar823654b2020-05-29 23:03:09 +02008455 >= 15 Every executed Ex command from a script (truncated at 200
8456 characters).
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02008457 >= 16 Every executed Ex command.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008458
8459 This option can also be set with the "-V" argument. See |-V|.
8460 This option is also set by the |:verbose| command.
8461
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008462 When the 'verbosefile' option is set then the verbose messages are not
8463 displayed.
8464
8465 *'verbosefile'* *'vfile'*
8466'verbosefile' 'vfile' string (default empty)
8467 global
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008468 When not empty all messages are written in a file with this name.
8469 When the file exists messages are appended.
8470 Writing to the file ends when Vim exits or when 'verbosefile' is made
Bram Moolenaar80794b12010-06-13 05:20:42 +02008471 empty. Writes are buffered, thus may not show up for some time.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008472 Setting 'verbosefile' to a new value is like making it empty first.
8473 The difference with |:redir| is that verbose messages are not
8474 displayed when 'verbosefile' is set.
8475
Bram Moolenaar071d4272004-06-13 20:20:40 +00008476 *'viewdir'* *'vdir'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008477'viewdir' 'vdir' string (default for Amiga and Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008478 "$VIM/vimfiles/view",
8479 for Unix: "~/.vim/view",
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02008480 for macOS: "$VIM:vimfiles:view"
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01008481 for VMS: "sys$login:vimfiles/view")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008482 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008483 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008484 feature}
8485 Name of the directory where to store files for |:mkview|.
8486 This option cannot be set from a |modeline| or in the |sandbox|, for
8487 security reasons.
8488
8489 *'viewoptions'* *'vop'*
Bram Moolenaar13e90412017-11-11 18:16:48 +01008490'viewoptions' 'vop' string (default: "folds,options,cursor,curdir")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008491 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008492 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008493 feature}
8494 Changes the effect of the |:mkview| command. It is a comma separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008495 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008496 word save and restore ~
8497 cursor cursor position in file and in window
8498 folds manually created folds, opened/closed folds and local
8499 fold options
8500 options options and mappings local to a window or buffer (not
8501 global values for local options)
Bram Moolenaar6e932462014-09-09 18:48:09 +02008502 localoptions same as "options"
Bram Moolenaar071d4272004-06-13 20:20:40 +00008503 slash backslashes in file names replaced with forward
8504 slashes
8505 unix with Unix end-of-line format (single <NL>), even when
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008506 on MS-Windows
Bram Moolenaar13e90412017-11-11 18:16:48 +01008507 curdir the window-local directory, if set with `:lcd`
Bram Moolenaar071d4272004-06-13 20:20:40 +00008508
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008509 "slash" and "unix" are useful on MS-Windows when sharing view files
Bram Moolenaar071d4272004-06-13 20:20:40 +00008510 with Unix. The Unix version of Vim cannot source dos format scripts,
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008511 but the MS-Windows version of Vim can source unix format scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008512
8513 *'viminfo'* *'vi'* *E526* *E527* *E528*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008514'viminfo' 'vi' string (Vi default: "", Vim default for
8515 MS-Windows: '100,<50,s10,h,rA:,rB:,
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01008516 for Amiga: '100,<50,s10,h,rdf0:,rdf1:,rdf2:
8517 for others: '100,<50,s10,h)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008518 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008519 {not available when compiled without the |+viminfo|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008520 feature}
8521 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008522 when exiting Vim (see |viminfo-file|). Except when 'viminfofile' is
8523 "NONE".
8524 The string should be a comma separated list of parameters, each
8525 consisting of a single character identifying the particular parameter,
8526 followed by a number or string which specifies the value of that
8527 parameter. If a particular character is left out, then the default
8528 value is used for that parameter. The following is a list of the
8529 identifying characters and the effect of their value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008530 CHAR VALUE ~
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008531 *viminfo-!*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008532 ! When included, save and restore global variables that start
8533 with an uppercase letter, and don't contain a lowercase
8534 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar680eeca2010-10-20 17:44:42 +02008535 and "_K_L_M" are not. Nested List and Dict items may not be
Bram Moolenaar166af9b2010-11-16 20:34:40 +01008536 read back correctly, you end up with an empty item.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008537 *viminfo-quote*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008538 " Maximum number of lines saved for each register. Old name of
8539 the '<' item, with the disadvantage that you need to put a
8540 backslash before the ", otherwise it will be recognized as the
8541 start of a comment!
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008542 *viminfo-%*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008543 % When included, save and restore the buffer list. If Vim is
8544 started with a file name argument, the buffer list is not
8545 restored. If Vim is started without a file name argument, the
Bram Moolenaard042dc82015-11-24 19:18:36 +01008546 buffer list is restored from the viminfo file. Quickfix
8547 ('buftype'), unlisted ('buflisted'), unnamed and buffers on
8548 removable media (|viminfo-r|) are not saved.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00008549 When followed by a number, the number specifies the maximum
8550 number of buffers that are stored. Without a number all
8551 buffers are stored.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008552 *viminfo-'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008553 ' Maximum number of previously edited files for which the marks
8554 are remembered. This parameter must always be included when
8555 'viminfo' is non-empty.
8556 Including this item also means that the |jumplist| and the
8557 |changelist| are stored in the viminfo file.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008558 *viminfo-/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008559 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008560 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00008561 patterns are also saved. When not included, the value of
8562 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008563 *viminfo-:*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008564 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008565 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008566 *viminfo-<*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008567 < Maximum number of lines saved for each register. If zero then
8568 registers are not saved. When not included, all lines are
8569 saved. '"' is the old name for this item.
8570 Also see the 's' item below: limit specified in Kbyte.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008571 *viminfo-@*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008572 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008573 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008574 *viminfo-c*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008575 c When included, convert the text in the viminfo file from the
8576 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00008577 'encoding'. See |viminfo-encoding|.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008578 *viminfo-f*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008579 f Whether file marks need to be stored. If zero, file marks ('0
8580 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008581 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00008582 cursor position (when exiting or when doing ":wviminfo").
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008583 *viminfo-h*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008584 h Disable the effect of 'hlsearch' when loading the viminfo
8585 file. When not included, it depends on whether ":nohlsearch"
8586 has been used since the last search command.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008587 *viminfo-n*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008588 n Name of the viminfo file. The name must immediately follow
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008589 the 'n'. Must be at the end of the option! If the
8590 'viminfofile' option is set, that file name overrides the one
8591 given here with 'viminfo'. Environment variables are
Bram Moolenaar063b9d12016-07-09 20:21:48 +02008592 expanded when opening the file, not when setting the option.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008593 *viminfo-r*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008594 r Removable media. The argument is a string (up to the next
8595 ','). This parameter can be given several times. Each
8596 specifies the start of a path for which no marks will be
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01008597 stored. This is to avoid removable media. For MS-Windows you
Bram Moolenaar071d4272004-06-13 20:20:40 +00008598 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
8599 also use it for temp files, e.g., for Unix: "r/tmp". Case is
8600 ignored. Maximum length of each 'r' argument is 50
8601 characters.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008602 *viminfo-s*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008603 s Maximum size of an item in Kbyte. If zero then registers are
8604 not saved. Currently only applies to registers. The default
8605 "s10" will exclude registers with more than 10 Kbyte of text.
8606 Also see the '<' item above: line count limit.
8607
8608 Example: >
8609 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
8610<
8611 '50 Marks will be remembered for the last 50 files you
8612 edited.
8613 <1000 Contents of registers (up to 1000 lines each) will be
8614 remembered.
8615 s100 Registers with more than 100 Kbyte text are skipped.
8616 :0 Command-line history will not be saved.
8617 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
8618 no / Since '/' is not specified, the default will be used,
8619 that is, save all of the search history, and also the
8620 previous search and substitute patterns.
8621 no % The buffer list will not be saved nor read back.
8622 no h 'hlsearch' highlighting will be restored.
8623
8624 When setting 'viminfo' from an empty value you can use |:rviminfo| to
8625 load the contents of the file, this is not done automatically.
8626
8627 This option cannot be set from a |modeline| or in the |sandbox|, for
8628 security reasons.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008629 NOTE: This option is set to the Vim default value when 'compatible'
8630 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008631
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008632 *'viminfofile'* *'vif'*
8633'viminfofile' 'vif' string (default: "")
8634 global
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008635 {not available when compiled without the |+viminfo|
8636 feature}
8637 When non-empty, overrides the file name used for viminfo.
8638 When equal to "NONE" no viminfo file will be read or written.
8639 This option can be set with the |-i| command line flag. The |--clean|
8640 command line flag sets it to "NONE".
Bram Moolenaar110289e2019-05-23 15:38:06 +02008641 This option cannot be set from a |modeline| or in the |sandbox|, for
8642 security reasons.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008643
Bram Moolenaar071d4272004-06-13 20:20:40 +00008644 *'virtualedit'* *'ve'*
8645'virtualedit' 've' string (default "")
Gary Johnson51ad8502021-08-03 18:33:08 +02008646 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008647 A comma separated list of these words:
8648 block Allow virtual editing in Visual block mode.
8649 insert Allow virtual editing in Insert mode.
8650 all Allow virtual editing in all modes.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008651 onemore Allow the cursor to move just past the end of the line
Gary Johnson53ba05b2021-07-26 22:19:10 +02008652 none When used as the local value, do not allow virtual
8653 editing even when the global value is set. When used
8654 as the global value, "none" is the same as "".
8655 NONE Alternative spelling of "none".
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008656
Bram Moolenaar071d4272004-06-13 20:20:40 +00008657 Virtual editing means that the cursor can be positioned where there is
Bram Moolenaarebcbd022007-05-12 14:28:25 +00008658 no actual character. This can be halfway into a tab or beyond the end
Bram Moolenaar071d4272004-06-13 20:20:40 +00008659 of the line. Useful for selecting a rectangle in Visual mode and
8660 editing a table.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008661 "onemore" is not the same, it will only allow moving the cursor just
8662 after the last character of the line. This makes some commands more
8663 consistent. Previously the cursor was always past the end of the line
8664 if the line was empty. But it is far from Vi compatible. It may also
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008665 break some plugins or Vim scripts. For example because |l| can move
8666 the cursor after the last character. Use with care!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02008667 Using the `$` command will move to the last character in the line, not
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008668 past it. This may actually move the cursor to the left!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02008669 The `g$` command will move to the end of the screen line.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008670 It doesn't make sense to combine "all" with "onemore", but you will
8671 not get a warning for it.
Bram Moolenaar53f7fcc2021-07-28 20:10:16 +02008672 When combined with other words, "none" is ignored.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008673 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008674
8675 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
8676'visualbell' 'vb' boolean (default off)
8677 global
Bram Moolenaar74675a62017-07-15 13:53:23 +02008678 Use a visual bell instead of beeping. The terminal code to display the
Bram Moolenaar071d4272004-06-13 20:20:40 +00008679 visual bell is given with 't_vb'. When no beep or flash is wanted,
Bram Moolenaar74675a62017-07-15 13:53:23 +02008680 use: >
8681 :set vb t_vb=
8682< If you want a short flash, you can use this on many terminals: >
8683 :set vb t_vb=[?5h$<100>[?5l
8684< Here $<100> specifies the time, you can use a smaller or bigger value
8685 to get a shorter or longer flash.
8686
8687 Note: Vim will limit the bell to once per half a second. This avoids
8688 having to wait for the flashing to finish when there are lots of
8689 bells, e.g. on key repeat. This also happens without 'visualbell'
8690 set.
8691
Bram Moolenaar071d4272004-06-13 20:20:40 +00008692 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
8693 for 20 msec. If you want to use a different time, use "<Esc>|40f",
8694 where 40 is the time in msec.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008695
8696 Note: When the GUI starts, 't_vb' is reset to its default value. You
8697 might want to set it again in your |gvimrc|.
8698
Bram Moolenaar071d4272004-06-13 20:20:40 +00008699 Does not work on the Amiga, you always get a screen flash.
8700 Also see 'errorbells'.
8701
8702 *'warn'* *'nowarn'*
8703'warn' boolean (default on)
8704 global
8705 Give a warning message when a shell command is used while the buffer
8706 has been changed.
8707
8708 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
8709'weirdinvert' 'wiv' boolean (default off)
8710 global
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00008711 This option has the same effect as the 't_xs' terminal option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008712 It is provided for backwards compatibility with version 4.x.
8713 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
8714 vice versa. Has no effect when the GUI is running.
8715
8716 *'whichwrap'* *'ww'*
8717'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
8718 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008719 Allow specified keys that move the cursor left/right to move to the
8720 previous/next line when the cursor is on the first/last character in
8721 the line. Concatenate characters to allow this for these keys:
8722 char key mode ~
8723 b <BS> Normal and Visual
8724 s <Space> Normal and Visual
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008725 h "h" Normal and Visual (not recommended)
8726 l "l" Normal and Visual (not recommended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008727 < <Left> Normal and Visual
8728 > <Right> Normal and Visual
8729 ~ "~" Normal
8730 [ <Left> Insert and Replace
8731 ] <Right> Insert and Replace
8732 For example: >
8733 :set ww=<,>,[,]
8734< allows wrap only when cursor keys are used.
8735 When the movement keys are used in combination with a delete or change
8736 operator, the <EOL> also counts for a character. This makes "3h"
8737 different from "3dh" when the cursor crosses the end of a line. This
8738 is also true for "x" and "X", because they do the same as "dl" and
8739 "dh". If you use this, you may also want to use the mapping
8740 ":map <BS> X" to make backspace delete the character in front of the
8741 cursor.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00008742 When 'l' is included and it is used after an operator at the end of a
Bram Moolenaar589edb32019-09-20 14:38:13 +02008743 line (not an empty line) then it will not move to the next line. This
8744 makes "dl", "cl", "yl" etc. work normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008745 NOTE: This option is set to the Vi default value when 'compatible' is
8746 set and to the Vim default value when 'compatible' is reset.
8747
8748 *'wildchar'* *'wc'*
8749'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
8750 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008751 Character you have to type to start wildcard expansion in the
8752 command-line, as specified with 'wildmode'.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008753 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008754 The character is not recognized when used inside a macro. See
8755 'wildcharm' for that.
8756 Although 'wc' is a number option, you can set it to a special key: >
8757 :set wc=<Esc>
8758< NOTE: This option is set to the Vi default value when 'compatible' is
8759 set and to the Vim default value when 'compatible' is reset.
8760
8761 *'wildcharm'* *'wcm'*
8762'wildcharm' 'wcm' number (default: none (0))
8763 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008764 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00008765 recognized when used inside a macro. You can find "spare" command-line
8766 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00008767 you'll never actually type 'wildcharm', just use it in mappings that
8768 automatically invoke completion mode, e.g.: >
8769 :set wcm=<C-Z>
Bram Moolenaar446cb832008-06-24 21:56:24 +00008770 :cnoremap ss so $vim/sessions/*.vim<C-Z>
Bram Moolenaar071d4272004-06-13 20:20:40 +00008771< Then after typing :ss you can use CTRL-P & CTRL-N.
8772
8773 *'wildignore'* *'wig'*
8774'wildignore' 'wig' string (default "")
8775 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008776 {not available when compiled without the |+wildignore|
8777 feature}
8778 A list of file patterns. A file that matches with one of these
Bram Moolenaar30b65812012-07-12 22:01:11 +02008779 patterns is ignored when expanding |wildcards|, completing file or
8780 directory names, and influences the result of |expand()|, |glob()| and
8781 |globpath()| unless a flag is passed to disable this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008782 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
8783 Also see 'suffixes'.
8784 Example: >
8785 :set wildignore=*.o,*.obj
8786< The use of |:set+=| and |:set-=| is preferred when adding or removing
8787 a pattern from the list. This avoids problems when a future version
8788 uses another default.
8789
Bram Moolenaar94950a92010-12-02 16:01:29 +01008790
Bram Moolenaar81af9252010-12-10 20:35:50 +01008791 *'wildignorecase'* *'wic'* *'nowildignorecase'* *'nowic'*
Bram Moolenaar94950a92010-12-02 16:01:29 +01008792'wildignorecase' 'wic' boolean (default off)
8793 global
Bram Moolenaar94950a92010-12-02 16:01:29 +01008794 When set case is ignored when completing file names and directories.
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01008795 Has no effect when 'fileignorecase' is set.
Bram Moolenaar94950a92010-12-02 16:01:29 +01008796 Does not apply when the shell is used to expand wildcards, which
8797 happens when there are special characters.
8798
8799
Bram Moolenaar071d4272004-06-13 20:20:40 +00008800 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02008801'wildmenu' 'wmnu' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008802 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008803 {not available if compiled without the |+wildmenu|
8804 feature}
8805 When 'wildmenu' is on, command-line completion operates in an enhanced
8806 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
8807 the possible matches are shown just above the command line, with the
8808 first match highlighted (overwriting the status line, if there is
8809 one). Keys that show the previous/next match, such as <Tab> or
8810 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
8811 When 'wildmode' is used, "wildmenu" mode is used where "full" is
8812 specified. "longest" and "list" do not start "wildmenu" mode.
Bram Moolenaar26402cb2013-02-20 21:26:00 +01008813 You can check the current mode with |wildmenumode()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008814 If there are more matches than can fit in the line, a ">" is shown on
8815 the right and/or a "<" is shown on the left. The status line scrolls
8816 as needed.
8817 The "wildmenu" mode is abandoned when a key is hit that is not used
8818 for selecting a completion.
8819 While the "wildmenu" is active the following keys have special
8820 meanings:
8821
8822 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
8823 <Down> - in filename/menu name completion: move into a
8824 subdirectory or submenu.
8825 <CR> - in menu completion, when the cursor is just after a
8826 dot: move into a submenu.
8827 <Up> - in filename/menu name completion: move up into
8828 parent directory or parent menu.
8829
8830 This makes the menus accessible from the console |console-menus|.
8831
8832 If you prefer the <Left> and <Right> keys to move the cursor instead
8833 of selecting a different match, use this: >
8834 :cnoremap <Left> <Space><BS><Left>
8835 :cnoremap <Right> <Space><BS><Right>
8836<
8837 The "WildMenu" highlighting is used for displaying the current match
8838 |hl-WildMenu|.
8839
8840 *'wildmode'* *'wim'*
8841'wildmode' 'wim' string (Vim default: "full")
8842 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008843 Completion mode that is used for the character specified with
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008844 'wildchar'. It is a comma separated list of up to four parts. Each
Bram Moolenaar02467872007-05-06 13:22:01 +00008845 part specifies what to do for each consecutive use of 'wildchar'. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00008846 first part specifies the behavior for the first use of 'wildchar',
8847 The second part for the second use, etc.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02008848
8849 Each part consists of a colon separated list consisting of the
8850 following possible values:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008851 "" Complete only the first match.
8852 "full" Complete the next full match. After the last match,
8853 the original string is used and then the first match
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02008854 again. Will also start 'wildmenu' if it is enabled.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008855 "longest" Complete till longest common string. If this doesn't
8856 result in a longer string, use the next part.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008857 "list" When more than one match, list all matches.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02008858 "lastused" When completing buffer names and more than one buffer
8859 matches, sort buffers by time last used (other than
8860 the current buffer).
8861 When there is only a single match, it is fully completed in all cases.
8862
8863 Examples of useful colon-separated values:
8864 "longest:full" Like "longest", but also start 'wildmenu' if it is
8865 enabled. Will not complete to the next full match.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008866 "list:full" When more than one match, list all matches and
8867 complete first match.
8868 "list:longest" When more than one match, list all matches and
8869 complete till longest common string.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02008870 "list:lastused" When more than one buffer matches, list all matches
8871 and sort buffers by time last used (other than the
8872 current buffer).
Bram Moolenaar071d4272004-06-13 20:20:40 +00008873
8874 Examples: >
8875 :set wildmode=full
Bram Moolenaar582fd852005-03-28 20:58:01 +00008876< Complete first full match, next match, etc. (the default) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008877 :set wildmode=longest,full
8878< Complete longest common string, then each full match >
8879 :set wildmode=list:full
8880< List all matches and complete each full match >
8881 :set wildmode=list,full
8882< List all matches without completing, then each full match >
8883 :set wildmode=longest,list
8884< Complete longest common string, then list alternatives.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008885 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008886
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00008887 *'wildoptions'* *'wop'*
8888'wildoptions' 'wop' string (default "")
8889 global
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00008890 {not available when compiled without the |+wildignore|
8891 feature}
8892 A list of words that change how command line completion is done.
8893 Currently only one word is allowed:
8894 tagfile When using CTRL-D to list matching tags, the kind of
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00008895 tag and the file of the tag is listed. Only one match
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00008896 is displayed per line. Often used tag kinds are:
8897 d #define
8898 f function
8899 Also see |cmdline-completion|.
8900
Bram Moolenaar071d4272004-06-13 20:20:40 +00008901 *'winaltkeys'* *'wak'*
8902'winaltkeys' 'wak' string (default "menu")
8903 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008904 {only used in Win32, Motif, GTK and Photon GUI}
8905 Some GUI versions allow the access to menu entries by using the ALT
8906 key in combination with a character that appears underlined in the
8907 menu. This conflicts with the use of the ALT key for mappings and
8908 entering special characters. This option tells what to do:
8909 no Don't use ALT keys for menus. ALT key combinations can be
8910 mapped, but there is no automatic handling. This can then be
8911 done with the |:simalt| command.
8912 yes ALT key handling is done by the windowing system. ALT key
8913 combinations cannot be mapped.
8914 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008915 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00008916 keys can be mapped.
8917 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
8918 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00008919 This option is not used for <F10>; on Win32 and with GTK <F10> will
8920 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008921
Bram Moolenaar4d784b22019-05-25 19:51:39 +02008922 *'wincolor'* *'wcr'*
8923'wincolor' 'wcr' string (default empty)
8924 local to window
8925 Highlight group name to use for this window instead of the Normal
8926 color |hl-Normal|.
8927
Bram Moolenaar4399ef42005-02-12 14:29:27 +00008928 *'window'* *'wi'*
8929'window' 'wi' number (default screen height - 1)
8930 global
Bram Moolenaardad44732021-03-31 20:07:33 +02008931 Window height used for |CTRL-F| and |CTRL-B| when there is only one
8932 window and the value is smaller than 'lines' minus one. The screen
8933 will scroll 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00008934 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
8935 in a much smarter way, taking care of wrapping lines.
8936 When resizing the Vim window, the value is smaller than 1 or more than
8937 or equal to 'lines' it will be set to 'lines' minus 1.
Bram Moolenaardad44732021-03-31 20:07:33 +02008938 Note: Do not confuse this with the height of the Vim window, use
8939 'lines' for that.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00008940
Bram Moolenaar071d4272004-06-13 20:20:40 +00008941 *'winheight'* *'wh'* *E591*
8942'winheight' 'wh' number (default 1)
8943 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008944 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008945 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar446cb832008-06-24 21:56:24 +00008946 focus goes to a window that is smaller, its size is increased, at the
8947 cost of the height of other windows.
8948 Set 'winheight' to a small number for normal editing.
8949 Set it to 999 to make the current window fill most of the screen.
8950 Other windows will be only 'winminheight' high. This has the drawback
8951 that ":all" will create only two windows. To avoid "vim -o 1 2 3 4"
8952 to create only two windows, set the option after startup is done,
8953 using the |VimEnter| event: >
8954 au VimEnter * set winheight=999
8955< Minimum value is 1.
8956 The height is not adjusted after one of the commands that change the
Bram Moolenaar071d4272004-06-13 20:20:40 +00008957 height of the current window.
8958 'winheight' applies to the current window. Use 'winminheight' to set
8959 the minimal height for other windows.
8960
8961 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
8962'winfixheight' 'wfh' boolean (default off)
8963 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00008964 Keep the window height when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00008965 'equalalways' is set. Also for |CTRL-W_=|. Set by default for the
8966 |preview-window| and |quickfix-window|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008967 The height may be changed anyway when running out of room.
8968
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008969 *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'*
8970'winfixwidth' 'wfw' boolean (default off)
8971 local to window
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008972 Keep the window width when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00008973 'equalalways' is set. Also for |CTRL-W_=|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008974 The width may be changed anyway when running out of room.
8975
Bram Moolenaar071d4272004-06-13 20:20:40 +00008976 *'winminheight'* *'wmh'*
8977'winminheight' 'wmh' number (default 1)
8978 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008979 The minimal height of a window, when it's not the current window.
8980 This is a hard minimum, windows will never become smaller.
8981 When set to zero, windows may be "squashed" to zero lines (i.e. just a
8982 status bar) if necessary. They will return to at least one line when
8983 they become active (since the cursor has to have somewhere to go.)
8984 Use 'winheight' to set the minimal height of the current window.
8985 This option is only checked when making a window smaller. Don't use a
8986 large number, it will cause errors when opening more than a few
8987 windows. A value of 0 to 3 is reasonable.
8988
8989 *'winminwidth'* *'wmw'*
8990'winminwidth' 'wmw' number (default 1)
8991 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008992 The minimal width of a window, when it's not the current window.
8993 This is a hard minimum, windows will never become smaller.
8994 When set to zero, windows may be "squashed" to zero columns (i.e. just
8995 a vertical separator) if necessary. They will return to at least one
8996 line when they become active (since the cursor has to have somewhere
8997 to go.)
8998 Use 'winwidth' to set the minimal width of the current window.
8999 This option is only checked when making a window smaller. Don't use a
9000 large number, it will cause errors when opening more than a few
9001 windows. A value of 0 to 12 is reasonable.
9002
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009003 *'winptydll'*
9004'winptydll' string (default "winpty32.dll" or "winpty64.dll")
9005 global
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009006 {only available when compiled with the |terminal|
9007 feature on MS-Windows}
9008 Specifies the name of the winpty shared library, used for the
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02009009 |:terminal| command. The default depends on whether Vim was built as a
Bram Moolenaarc572da52017-08-27 16:52:01 +02009010 32-bit or 64-bit executable. If not found, "winpty.dll" is tried as
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009011 a fallback.
9012 Environment variables are expanded |:set_env|.
9013 This option cannot be set from a |modeline| or in the |sandbox|, for
9014 security reasons.
9015
Bram Moolenaar071d4272004-06-13 20:20:40 +00009016 *'winwidth'* *'wiw'* *E592*
9017'winwidth' 'wiw' number (default 20)
9018 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009019 Minimal number of columns for the current window. This is not a hard
9020 minimum, Vim will use fewer columns if there is not enough room. If
9021 the current window is smaller, its size is increased, at the cost of
9022 the width of other windows. Set it to 999 to make the current window
9023 always fill the screen. Set it to a small number for normal editing.
9024 The width is not adjusted after one of the commands to change the
9025 width of the current window.
9026 'winwidth' applies to the current window. Use 'winminwidth' to set
9027 the minimal width for other windows.
9028
9029 *'wrap'* *'nowrap'*
9030'wrap' boolean (default on)
9031 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00009032 This option changes how text is displayed. It doesn't change the text
9033 in the buffer, see 'textwidth' for that.
9034 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009035 displaying continues on the next line. When off lines will not wrap
9036 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00009037 moved to a part that is not shown, the screen will scroll
9038 horizontally.
9039 The line will be broken in the middle of a word if necessary. See
9040 'linebreak' to get the break at a word boundary.
9041 To make scrolling horizontally a bit more useful, try this: >
9042 :set sidescroll=5
9043 :set listchars+=precedes:<,extends:>
9044< See 'sidescroll', 'listchars' and |wrap-off|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01009045 This option can't be set from a |modeline| when the 'diff' option is
9046 on.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009047
9048 *'wrapmargin'* *'wm'*
9049'wrapmargin' 'wm' number (default 0)
9050 local to buffer
9051 Number of characters from the right window border where wrapping
9052 starts. When typing text beyond this limit, an <EOL> will be inserted
9053 and inserting continues on the next line.
9054 Options that add a margin, such as 'number' and 'foldcolumn', cause
9055 the text width to be further reduced. This is Vi compatible.
9056 When 'textwidth' is non-zero, this option is not used.
Bram Moolenaarca635012015-09-25 20:34:21 +02009057 This option is set to 0 when 'paste' is set and restored when 'paste'
9058 is reset.
Bram Moolenaara6c27c42019-05-09 19:16:22 +02009059 See also 'formatoptions' and |ins-textwidth|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009060
9061 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
9062'wrapscan' 'ws' boolean (default on) *E384* *E385*
9063 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00009064 Searches wrap around the end of the file. Also applies to |]s| and
9065 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009066
9067 *'write'* *'nowrite'*
9068'write' boolean (default on)
9069 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009070 Allows writing files. When not set, writing a file is not allowed.
9071 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009072 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00009073 argument. Filtering text is still possible, even though this requires
9074 writing a temporary file.
9075
9076 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
9077'writeany' 'wa' boolean (default off)
9078 global
9079 Allows writing to any file with no need for "!" override.
9080
9081 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
9082'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
9083 otherwise)
9084 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009085 Make a backup before overwriting a file. The backup is removed after
9086 the file was successfully written, unless the 'backup' option is
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02009087 also on.
9088 WARNING: Switching this option off means that when Vim fails to write
9089 your buffer correctly and then, for whatever reason, Vim exits, you
9090 lose both the original file and what you were writing. Only reset
9091 this option if your file system is almost full and it makes the write
9092 fail (and make sure not to exit Vim until the write was successful).
9093 See |backup-table| for another explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009094 When the 'backupskip' pattern matches, a backup is not made anyway.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01009095 Depending on 'backupcopy' the backup is a new file or the original
9096 file renamed (and a new file is written).
Bram Moolenaar071d4272004-06-13 20:20:40 +00009097 NOTE: This option is set to the default value when 'compatible' is
9098 set.
9099
9100 *'writedelay'* *'wd'*
9101'writedelay' 'wd' number (default 0)
9102 global
Bram Moolenaar802a0d92016-06-26 16:17:58 +02009103 The number of milliseconds to wait for each character sent to the
Bram Moolenaar071d4272004-06-13 20:20:40 +00009104 screen. When non-zero, characters are sent to the terminal one by
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01009105 one. For debugging purposes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009106
Bram Moolenaar91f84f62018-07-29 15:07:52 +02009107 vim:tw=78:ts=8:noet:ft=help:norl: