blob: 05489d7f63e97c6771463d2c0374d28d899e495e [file] [log] [blame]
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02001*options.txt* For Vim version 8.2. Last change: 2021 Jun 20
Bram Moolenaar071d4272004-06-13 20:20:40 +00002
3
4 VIM REFERENCE MANUAL by Bram Moolenaar
5
6
7Options *options*
8
91. Setting options |set-option|
102. Automatically setting options |auto-setting|
113. Options summary |option-summary|
12
Bram Moolenaar2ec618c2016-10-01 14:47:05 +020013For an overview of options see quickref.txt |option-list|.
Bram Moolenaar071d4272004-06-13 20:20:40 +000014
15Vim has a number of internal variables and switches which can be set to
16achieve special effects. These options come in three forms:
17 boolean can only be on or off *boolean* *toggle*
18 number has a numeric value
19 string has a string value
20
21==============================================================================
Bram Moolenaarf75a9632005-09-13 21:20:47 +0000221. Setting options *set-option* *E764*
Bram Moolenaar071d4272004-06-13 20:20:40 +000023
24 *:se* *:set*
Bram Moolenaar6b915c02020-01-18 15:53:19 +010025:se[t][!] Show all options that differ from their default value.
26 When [!] is present every option is on a separate
27 line.
Bram Moolenaar071d4272004-06-13 20:20:40 +000028
Bram Moolenaar6b915c02020-01-18 15:53:19 +010029:se[t][!] all Show all but terminal options.
30 When [!] is present every option is on a separate
31 line.
Bram Moolenaar071d4272004-06-13 20:20:40 +000032
33:se[t] termcap Show all terminal options. Note that in the GUI the
34 key codes are not shown, because they are generated
35 internally and can't be changed. Changing the terminal
36 codes in the GUI is not useful either...
37
38 *E518* *E519*
39:se[t] {option}? Show value of {option}.
40
41:se[t] {option} Toggle option: set, switch it on.
42 Number option: show value.
43 String option: show value.
44
45:se[t] no{option} Toggle option: Reset, switch it off.
46
Bram Moolenaar00a927d2010-05-14 23:24:24 +020047 *:set-!* *:set-inv*
Bram Moolenaar071d4272004-06-13 20:20:40 +000048:se[t] {option}! or
Bram Moolenaar6c60f472019-04-28 16:00:35 +020049:se[t] inv{option} Toggle option: Invert value.
Bram Moolenaar071d4272004-06-13 20:20:40 +000050
51 *:set-default* *:set-&* *:set-&vi* *:set-&vim*
52:se[t] {option}& Reset option to its default value. May depend on the
Bram Moolenaar6c60f472019-04-28 16:00:35 +020053 current value of 'compatible'.
54:se[t] {option}&vi Reset option to its Vi default value.
55:se[t] {option}&vim Reset option to its Vim default value.
Bram Moolenaar071d4272004-06-13 20:20:40 +000056
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +010057:se[t] all& Set all options to their default value. The values of
Bram Moolenaar88774fd2015-08-25 19:52:04 +020058 these options are not changed:
59 all terminal options, starting with t_
60 'columns'
61 'cryptmethod'
62 'encoding'
63 'key'
64 'lines'
65 'term'
66 'ttymouse'
67 'ttytype'
68 Warning: This may have a lot of side effects.
Bram Moolenaar071d4272004-06-13 20:20:40 +000069
70 *:set-args* *E487* *E521*
71:se[t] {option}={value} or
72:se[t] {option}:{value}
73 Set string or number option to {value}.
74 For numeric options the value can be given in decimal,
Bram Moolenaar3848e002016-03-19 18:42:29 +010075 hex (preceded with 0x) or octal (preceded with '0').
Bram Moolenaar071d4272004-06-13 20:20:40 +000076 The old value can be inserted by typing 'wildchar' (by
77 default this is a <Tab> or CTRL-E if 'compatible' is
78 set). See |cmdline-completion|.
79 White space between {option} and '=' is allowed and
80 will be ignored. White space between '=' and {value}
81 is not allowed.
82 See |option-backslash| for using white space and
83 backslashes in {value}.
84
85:se[t] {option}+={value} *:set+=*
86 Add the {value} to a number option, or append the
87 {value} to a string option. When the option is a
88 comma separated list, a comma is added, unless the
89 value was empty.
90 If the option is a list of flags, superfluous flags
Bram Moolenaara5792f52005-11-23 21:25:05 +000091 are removed. When adding a flag that was already
92 present the option value doesn't change.
Bram Moolenaar899dddf2006-03-26 21:06:50 +000093 Also see |:set-args| above.
Bram Moolenaar071d4272004-06-13 20:20:40 +000094
95:se[t] {option}^={value} *:set^=*
96 Multiply the {value} to a number option, or prepend
97 the {value} to a string option. When the option is a
98 comma separated list, a comma is added, unless the
99 value was empty.
100 Also see |:set-args| above.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000101
102:se[t] {option}-={value} *:set-=*
103 Subtract the {value} from a number option, or remove
104 the {value} from a string option, if it is there.
105 If the {value} is not found in a string option, there
106 is no error or warning. When the option is a comma
107 separated list, a comma is deleted, unless the option
108 becomes empty.
109 When the option is a list of flags, {value} must be
110 exactly as they appear in the option. Remove flags
111 one by one to avoid problems.
112 Also see |:set-args| above.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000113
114The {option} arguments to ":set" may be repeated. For example: >
115 :set ai nosi sw=3 ts=3
116If you make an error in one of the arguments, an error message will be given
117and the following arguments will be ignored.
118
119 *:set-verbose*
120When 'verbose' is non-zero, displaying an option value will also tell where it
121was last set. Example: >
122 :verbose set shiftwidth cindent?
Bram Moolenaar95bafa22018-10-02 13:26:25 +0200123< shiftwidth=4 ~
124 Last set from modeline line 1 ~
125 cindent ~
126 Last set from /usr/local/share/vim/vim60/ftplugin/c.vim line 30 ~
Bram Moolenaar446cb832008-06-24 21:56:24 +0000127This is only done when specific option values are requested, not for ":verbose
128set all" or ":verbose set" without an argument.
129When the option was set by hand there is no "Last set" message.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000130When the option was set while executing a function, user command or
131autocommand, the script in which it was defined is reported.
132Note that an option may also have been set as a side effect of setting
133'compatible'.
Bram Moolenaar446cb832008-06-24 21:56:24 +0000134A few special texts:
Bram Moolenaar95bafa22018-10-02 13:26:25 +0200135 Last set from modeline line 1 ~
Bram Moolenaar446cb832008-06-24 21:56:24 +0000136 Option was set in a |modeline|.
137 Last set from --cmd argument ~
138 Option was set with command line argument |--cmd| or +.
139 Last set from -c argument ~
140 Option was set with command line argument |-c|, +, |-S| or
141 |-q|.
142 Last set from environment variable ~
143 Option was set from an environment variable, $VIMINIT,
144 $GVIMINIT or $EXINIT.
145 Last set from error handler ~
146 Option was cleared when evaluating it resulted in an error.
147
Bram Moolenaardb84e452010-08-15 13:50:43 +0200148{not available when compiled without the |+eval| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000149
150 *:set-termcap* *E522*
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +0000151For {option} the form "t_xx" may be used to set a terminal option. This will
Bram Moolenaar071d4272004-06-13 20:20:40 +0000152override the value from the termcap. You can then use it in a mapping. If
153the "xx" part contains special characters, use the <t_xx> form: >
154 :set <t_#4>=^[Ot
155This can also be used to translate a special code for a normal key. For
156example, if Alt-b produces <Esc>b, use this: >
157 :set <M-b>=^[b
158(the ^[ is a real <Esc> here, use CTRL-V <Esc> to enter it)
159The advantage over a mapping is that it works in all situations.
160
Bram Moolenaar0b2f94d2011-03-22 14:35:05 +0100161You can define any key codes, e.g.: >
162 :set t_xy=^[foo;
163There is no warning for using a name that isn't recognized. You can map these
164codes as you like: >
165 :map <t_xy> something
166< *E846*
167When a key code is not set, it's like it does not exist. Trying to get its
168value will result in an error: >
169 :set t_kb=
170 :set t_kb
171 E846: Key code not set: t_kb
172
Bram Moolenaar293ee4d2004-12-09 21:34:53 +0000173The t_xx options cannot be set from a |modeline| or in the |sandbox|, for
174security reasons.
175
Bram Moolenaar071d4272004-06-13 20:20:40 +0000176The listing from ":set" looks different from Vi. Long string options are put
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000177at the end of the list. The number of options is quite large. The output of
Bram Moolenaar071d4272004-06-13 20:20:40 +0000178"set all" probably does not fit on the screen, causing Vim to give the
179|more-prompt|.
180
181 *option-backslash*
182To include white space in a string option value it has to be preceded with a
183backslash. To include a backslash you have to use two. Effectively this
184means that the number of backslashes in an option value is halved (rounded
185down).
186A few examples: >
187 :set tags=tags\ /usr/tags results in "tags /usr/tags"
188 :set tags=tags\\,file results in "tags\,file"
189 :set tags=tags\\\ file results in "tags\ file"
190
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000191The "|" character separates a ":set" command from a following command. To
192include the "|" in the option value, use "\|" instead. This example sets the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000193'titlestring' option to "hi|there": >
194 :set titlestring=hi\|there
195This sets the 'titlestring' option to "hi" and 'iconstring' to "there": >
196 :set titlestring=hi|set iconstring=there
197
Bram Moolenaar7df351e2006-01-23 22:30:28 +0000198Similarly, the double quote character starts a comment. To include the '"' in
199the option value, use '\"' instead. This example sets the 'titlestring'
200option to 'hi "there"': >
201 :set titlestring=hi\ \"there\"
202
Bram Moolenaar5666fcd2019-12-26 14:35:26 +0100203For Win32 backslashes in file names are mostly not removed. More precise: For
204options that expect a file name (those where environment variables are
205expanded) a backslash before a normal file name character is not removed. But
206a backslash before a special character (space, backslash, comma, etc.) is used
207like explained above.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000208There is one special situation, when the value starts with "\\": >
209 :set dir=\\machine\path results in "\\machine\path"
210 :set dir=\\\\machine\\path results in "\\machine\path"
211 :set dir=\\path\\file results in "\\path\file" (wrong!)
212For the first one the start is kept, but for the second one the backslashes
213are halved. This makes sure it works both when you expect backslashes to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000214halved and when you expect the backslashes to be kept. The third gives a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000215result which is probably not what you want. Avoid it.
216
217 *add-option-flags* *remove-option-flags*
218 *E539* *E550* *E551* *E552*
219Some options are a list of flags. When you want to add a flag to such an
220option, without changing the existing ones, you can do it like this: >
221 :set guioptions+=a
222Remove a flag from an option like this: >
223 :set guioptions-=a
224This removes the 'a' flag from 'guioptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000225Note that you should add or remove one flag at a time. If 'guioptions' has
Bram Moolenaar071d4272004-06-13 20:20:40 +0000226the value "ab", using "set guioptions-=ba" won't work, because the string "ba"
227doesn't appear.
228
229 *:set_env* *expand-env* *expand-environment-var*
Bram Moolenaard4755bb2004-09-02 19:12:26 +0000230Environment variables in specific string options will be expanded. If the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000231environment variable exists the '$' and the following environment variable
232name is replaced with its value. If it does not exist the '$' and the name
233are not modified. Any non-id character (not a letter, digit or '_') may
234follow the environment variable name. That character and what follows is
235appended to the value of the environment variable. Examples: >
236 :set term=$TERM.new
237 :set path=/usr/$INCLUDE,$HOME/include,.
238When adding or removing a string from an option with ":set opt-=val" or ":set
239opt+=val" the expansion is done before the adding or removing.
240
241
242Handling of local options *local-options*
243
244Some of the options only apply to a window or buffer. Each window or buffer
Bram Moolenaar51628222016-12-01 23:03:28 +0100245has its own copy of this option, thus each can have its own value. This
Bram Moolenaar071d4272004-06-13 20:20:40 +0000246allows you to set 'list' in one window but not in another. And set
247'shiftwidth' to 3 in one buffer and 4 in another.
248
249The following explains what happens to these local options in specific
250situations. You don't really need to know all of this, since Vim mostly uses
251the option values you would expect. Unfortunately, doing what the user
252expects is a bit complicated...
253
254When splitting a window, the local options are copied to the new window. Thus
255right after the split the contents of the two windows look the same.
256
257When editing a new buffer, its local option values must be initialized. Since
258the local options of the current buffer might be specifically for that buffer,
259these are not used. Instead, for each buffer-local option there also is a
260global value, which is used for new buffers. With ":set" both the local and
261global value is changed. With "setlocal" only the local value is changed,
262thus this value is not used when editing a new buffer.
263
Bram Moolenaar95ec9d62016-08-12 18:29:59 +0200264When editing a buffer that has been edited before, the options from the window
265that was last closed are used again. If this buffer has been edited in this
266window, the values from back then are used. Otherwise the values from the
267last closed window where the buffer was edited last are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000268
269It's possible to set a local window option specifically for a type of buffer.
270When you edit another buffer in the same window, you don't want to keep
271using these local window options. Therefore Vim keeps a global value of the
272local window options, which is used when editing another buffer. Each window
273has its own copy of these values. Thus these are local to the window, but
274global to all buffers in the window. With this you can do: >
275 :e one
276 :set list
277 :e two
278Now the 'list' option will also be set in "two", since with the ":set list"
279command you have also set the global value. >
280 :set nolist
281 :e one
282 :setlocal list
283 :e two
284Now the 'list' option is not set, because ":set nolist" resets the global
285value, ":setlocal list" only changes the local value and ":e two" gets the
286global value. Note that if you do this next: >
287 :e one
Bram Moolenaar531da592013-05-06 05:58:55 +0200288You will get back the 'list' value as it was the last time you edited "one".
289The options local to a window are remembered for each buffer. This also
290happens when the buffer is not loaded, but they are lost when the buffer is
291wiped out |:bwipe|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000292
293 *:setl* *:setlocal*
Bram Moolenaar6b915c02020-01-18 15:53:19 +0100294:setl[ocal][!] ... Like ":set" but set only the value local to the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000295 current buffer or window. Not all options have a
296 local value. If the option does not have a local
297 value the global value is set.
Bram Moolenaarc3301872010-07-25 20:53:06 +0200298 With the "all" argument: display local values for all
299 local options.
300 Without argument: Display local values for all local
301 options which are different from the default.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000302 When displaying a specific local option, show the
Bram Moolenaar446cb832008-06-24 21:56:24 +0000303 local value. For a global/local boolean option, when
304 the global value is being used, "--" is displayed
305 before the option name.
306 For a global option the global value is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000307 shown (but that might change in the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000308
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000309:setl[ocal] {option}< Set the local value of {option} to its global value by
310 copying the value.
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000311
Bram Moolenaar6be7f872012-01-20 21:08:56 +0100312:se[t] {option}< For |global-local| options: Remove the local value of
313 {option}, so that the global value will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000314
315 *:setg* *:setglobal*
Bram Moolenaar6b915c02020-01-18 15:53:19 +0100316:setg[lobal][!] ... Like ":set" but set only the global value for a local
Bram Moolenaar071d4272004-06-13 20:20:40 +0000317 option without changing the local value.
318 When displaying an option, the global value is shown.
Bram Moolenaarc3301872010-07-25 20:53:06 +0200319 With the "all" argument: display global values for all
320 local options.
321 Without argument: display global values for all local
322 options which are different from the default.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000323
324For buffer-local and window-local options:
325 Command global value local value ~
326 :set option=value set set
327 :setlocal option=value - set
328:setglobal option=value set -
329 :set option? - display
330 :setlocal option? - display
331:setglobal option? display -
332
333
334Global options with a local value *global-local*
335
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +0000336Options are global when you mostly use one value for all buffers and windows.
337For some global options it's useful to sometimes have a different local value.
338You can set the local value with ":setlocal". That buffer or window will then
339use the local value, while other buffers and windows continue using the global
340value.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000341
342For example, you have two windows, both on C source code. They use the global
343'makeprg' option. If you do this in one of the two windows: >
344 :set makeprg=gmake
345then the other window will switch to the same value. There is no need to set
346the 'makeprg' option in the other C source window too.
347However, if you start editing a Perl file in a new window, you want to use
Bram Moolenaar02467872007-05-06 13:22:01 +0000348another 'makeprg' for it, without changing the value used for the C source
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000349files. You use this command: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000350 :setlocal makeprg=perlmake
351You can switch back to using the global value by making the local value empty: >
352 :setlocal makeprg=
Bram Moolenaar314dd792019-02-03 15:27:20 +0100353This only works for a string option. For a number or boolean option you need
354to use the "<" flag, like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000355 :setlocal autoread<
Bram Moolenaar314dd792019-02-03 15:27:20 +0100356Note that for non-boolean and non-number options using "<" copies the global
357value to the local value, it doesn't switch back to using the global value
358(that matters when the global value changes later). You can also use: >
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000359 :set path<
360This will make the local value of 'path' empty, so that the global value is
361used. Thus it does the same as: >
362 :setlocal path=
Bram Moolenaar071d4272004-06-13 20:20:40 +0000363Note: In the future more global options can be made global-local. Using
364":setlocal" on a global option might work differently then.
365
366
367Setting the filetype
368
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200369:setf[iletype] [FALLBACK] {filetype} *:setf* *:setfiletype*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000370 Set the 'filetype' option to {filetype}, but only if
371 not done yet in a sequence of (nested) autocommands.
372 This is short for: >
373 :if !did_filetype()
374 : setlocal filetype={filetype}
375 :endif
376< This command is used in a filetype.vim file to avoid
377 setting the 'filetype' option twice, causing different
378 settings and syntax files to be loaded.
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200379
380 When the optional FALLBACK argument is present, a
381 later :setfiletype command will override the
Bram Moolenaar26967612019-03-17 17:13:16 +0100382 'filetype'. This is to be used for filetype
383 detections that are just a guess. |did_filetype()|
384 will return false after this command.
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200385
Bram Moolenaard58e9292011-02-09 17:07:58 +0100386 *option-window* *optwin*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000387:bro[wse] se[t] *:set-browse* *:browse-set* *:opt* *:options*
388:opt[ions] Open a window for viewing and setting all options.
389 Options are grouped by function.
390 Offers short help for each option. Hit <CR> on the
391 short help to open a help window with more help for
392 the option.
393 Modify the value of the option and hit <CR> on the
394 "set" line to set the new value. For window and
395 buffer specific options, the last accessed window is
396 used to set the option value in, unless this is a help
397 window, in which case the window below help window is
398 used (skipping the option-window).
Bram Moolenaarb5b75622018-03-09 22:22:21 +0100399 {not available when compiled without the |+eval|
400 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000401
402 *$HOME*
403Using "~" is like using "$HOME", but it is only recognized at the start of an
404option and after a space or comma.
405
406On Unix systems "~user" can be used too. It is replaced by the home directory
407of user "user". Example: >
408 :set path=~mool/include,/usr/include,.
409
410On Unix systems the form "${HOME}" can be used too. The name between {} can
411contain non-id characters then. Note that if you want to use this for the
412"gf" command, you need to add the '{' and '}' characters to 'isfname'.
413
414NOTE: expanding environment variables and "~/" is only done with the ":set"
415command, not when assigning a value to an option with ":let".
416
Bram Moolenaarc572da52017-08-27 16:52:01 +0200417 *$HOME-windows*
418On MS-Windows, if $HOME is not defined as an environment variable, then
419at runtime Vim will set it to the expansion of $HOMEDRIVE$HOMEPATH.
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200420If $HOMEDRIVE is not set then $USERPROFILE is used.
421
422This expanded value is not exported to the environment, this matters when
423running an external command: >
424 :echo system('set | findstr ^HOME=')
425and >
426 :echo luaeval('os.getenv("HOME")')
427should echo nothing (an empty string) despite exists('$HOME') being true.
428When setting $HOME to a non-empty string it will be exported to the
429subprocesses.
Bram Moolenaarc572da52017-08-27 16:52:01 +0200430
Bram Moolenaar071d4272004-06-13 20:20:40 +0000431
432Note the maximum length of an expanded option is limited. How much depends on
433the system, mostly it is something like 256 or 1024 characters.
434
435 *:fix* *:fixdel*
436:fix[del] Set the value of 't_kD':
437 't_kb' is 't_kD' becomes ~
438 CTRL-? CTRL-H
439 not CTRL-? CTRL-?
440
Bram Moolenaar82be4842021-01-11 19:40:15 +0100441 (CTRL-? is 0o177 octal, 0x7f hex)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000442
443 If your delete key terminal code is wrong, but the
444 code for backspace is alright, you can put this in
445 your .vimrc: >
446 :fixdel
447< This works no matter what the actual code for
448 backspace is.
449
450 If the backspace key terminal code is wrong you can
451 use this: >
452 :if &term == "termname"
453 : set t_kb=^V<BS>
454 : fixdel
455 :endif
456< Where "^V" is CTRL-V and "<BS>" is the backspace key
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000457 (don't type four characters!). Replace "termname"
Bram Moolenaar071d4272004-06-13 20:20:40 +0000458 with your terminal name.
459
460 If your <Delete> key sends a strange key sequence (not
461 CTRL-? or CTRL-H) you cannot use ":fixdel". Then use: >
462 :if &term == "termname"
463 : set t_kD=^V<Delete>
464 :endif
465< Where "^V" is CTRL-V and "<Delete>" is the delete key
466 (don't type eight characters!). Replace "termname"
467 with your terminal name.
468
469 *Linux-backspace*
470 Note about Linux: By default the backspace key
471 produces CTRL-?, which is wrong. You can fix it by
472 putting this line in your rc.local: >
473 echo "keycode 14 = BackSpace" | loadkeys
474<
475 *NetBSD-backspace*
476 Note about NetBSD: If your backspace doesn't produce
477 the right code, try this: >
478 xmodmap -e "keycode 22 = BackSpace"
479< If this works, add this in your .Xmodmap file: >
480 keysym 22 = BackSpace
481< You need to restart for this to take effect.
482
483==============================================================================
4842. Automatically setting options *auto-setting*
485
486Besides changing options with the ":set" command, there are three alternatives
487to set options automatically for one or more files:
488
4891. When starting Vim initializations are read from various places. See
490 |initialization|. Most of them are performed for all editing sessions,
491 and some of them depend on the directory where Vim is started.
492 You can create an initialization file with |:mkvimrc|, |:mkview| and
493 |:mksession|.
4942. If you start editing a new file, the automatic commands are executed.
495 This can be used to set options for files matching a particular pattern and
496 many other things. See |autocommand|.
4973. If you start editing a new file, and the 'modeline' option is on, a
498 number of lines at the beginning and end of the file are checked for
499 modelines. This is explained here.
500
501 *modeline* *vim:* *vi:* *ex:* *E520*
502There are two forms of modelines. The first form:
Bram Moolenaar664f3cf2019-12-07 16:03:51 +0100503 [text{white}]{vi:|vim:|ex:}[white]{options}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000504
Bram Moolenaar664f3cf2019-12-07 16:03:51 +0100505[text{white}] empty or any text followed by at least one blank
506 character (<Space> or <Tab>); "ex:" always requires at
507 least one blank character
Bram Moolenaar14b69452013-06-29 23:05:20 +0200508{vi:|vim:|ex:} the string "vi:", "vim:" or "ex:"
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200509[white] optional white space
510{options} a list of option settings, separated with white space
511 or ':', where each part between ':' is the argument
512 for a ":set" command (can be empty)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000513
Bram Moolenaar14b69452013-06-29 23:05:20 +0200514Examples:
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000515 vi:noai:sw=3 ts=6 ~
Bram Moolenaar14b69452013-06-29 23:05:20 +0200516 vim: tw=77 ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000517
518The second form (this is compatible with some versions of Vi):
519
Bram Moolenaarade0d392020-01-21 22:33:58 +0100520 [text{white}]{vi:|vim:|Vim:|ex:}[white]se[t] {options}:[text]
Bram Moolenaar071d4272004-06-13 20:20:40 +0000521
Bram Moolenaarade0d392020-01-21 22:33:58 +0100522[text{white}] empty or any text followed by at least one blank
523 character (<Space> or <Tab>); "ex:" always requires at
524 least one blank character
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200525{vi:|vim:|Vim:|ex:} the string "vi:", "vim:", "Vim:" or "ex:"
526[white] optional white space
Bram Moolenaar14b69452013-06-29 23:05:20 +0200527se[t] the string "set " or "se " (note the space); When
528 "Vim" is used it must be "set".
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200529{options} a list of options, separated with white space, which
530 is the argument for a ":set" command
531: a colon
532[text] any text or empty
Bram Moolenaar071d4272004-06-13 20:20:40 +0000533
Bram Moolenaar14b69452013-06-29 23:05:20 +0200534Examples:
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000535 /* vim: set ai tw=75: */ ~
Bram Moolenaar14b69452013-06-29 23:05:20 +0200536 /* Vim: set ai tw=75: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000537
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200538The white space before {vi:|vim:|Vim:|ex:} is required. This minimizes the
539chance that a normal word like "lex:" is caught. There is one exception:
540"vi:" and "vim:" can also be at the start of the line (for compatibility with
541version 3.0). Using "ex:" at the start of the line will be ignored (this
542could be short for "example:").
Bram Moolenaar071d4272004-06-13 20:20:40 +0000543
544 *modeline-local*
545The options are set like with ":setlocal": The new value only applies to the
Bram Moolenaar843ee412004-06-30 16:16:41 +0000546buffer and window that contain the file. Although it's possible to set global
547options from a modeline, this is unusual. If you have two windows open and
548the files in it set the same global option to a different value, the result
549depends on which one was opened last.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000550
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +0000551When editing a file that was already loaded, only the window-local options
552from the modeline are used. Thus if you manually changed a buffer-local
553option after opening the file, it won't be changed if you edit the same buffer
554in another window. But window-local options will be set.
555
Bram Moolenaar071d4272004-06-13 20:20:40 +0000556 *modeline-version*
557If the modeline is only to be used for some versions of Vim, the version
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200558number can be specified where "vim:" or "Vim:" is used:
Bram Moolenaar071d4272004-06-13 20:20:40 +0000559 vim{vers}: version {vers} or later
560 vim<{vers}: version before {vers}
561 vim={vers}: version {vers}
562 vim>{vers}: version after {vers}
Bram Moolenaar2b8388b2015-02-28 13:11:45 +0100563{vers} is 700 for Vim 7.0 (hundred times the major version plus minor).
564For example, to use a modeline only for Vim 7.0:
565 /* vim700: set foldmethod=marker */ ~
566To use a modeline for Vim after version 7.2:
567 /* vim>702: set cole=2: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000568There can be no blanks between "vim" and the ":".
569
570
571The number of lines that are checked can be set with the 'modelines' option.
572If 'modeline' is off or 'modelines' is 0 no lines are checked.
573
574Note that for the first form all of the rest of the line is used, thus a line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000575like:
576 /* vi:ts=4: */ ~
577will give an error message for the trailing "*/". This line is OK:
578 /* vi:set ts=4: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000579
580If an error is detected the rest of the line is skipped.
581
582If you want to include a ':' in a set command precede it with a '\'. The
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000583backslash in front of the ':' will be removed. Example:
Bram Moolenaar95a9dd12019-12-19 22:12:03 +0100584 /* vi:set fillchars=stl\:^,vert\:\|: */ ~
585This sets the 'fillchars' option to "stl:^,vert:\|". Only a single backslash
586before the ':' is removed. Thus to include "\:" you have to specify "\\:".
Bram Moolenaar110289e2019-05-23 15:38:06 +0200587 *E992*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000588No other commands than "set" are supported, for security reasons (somebody
Bram Moolenaar8243a792007-05-01 17:05:03 +0000589might create a Trojan horse text file with modelines). And not all options
Bram Moolenaar110289e2019-05-23 15:38:06 +0200590can be set. For some options a flag is set, so that when the value is used
591the |sandbox| is effective. Some options can only be set from the modeline
592when 'modelineexpr' is set (the default is off).
593
594Still, there is always a small risk that a modeline causes trouble. E.g.,
595when some joker sets 'textwidth' to 5 all your lines are wrapped unexpectedly.
596So disable modelines before editing untrusted text. The mail ftplugin does
597this, for example.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000598
599Hint: If you would like to do something else than setting an option, you could
600define an autocommand that checks the file for a specific string. For
601example: >
602 au BufReadPost * if getline(1) =~ "VAR" | call SetVar() | endif
603And define a function SetVar() that does something with the line containing
604"VAR".
605
606==============================================================================
6073. Options summary *option-summary*
608
609In the list below all the options are mentioned with their full name and with
610an abbreviation if there is one. Both forms may be used.
611
612In this document when a boolean option is "set" that means that ":set option"
613is entered. When an option is "reset", ":set nooption" is used.
614
615For some options there are two default values: The "Vim default", which is
616used when 'compatible' is not set, and the "Vi default", which is used when
617'compatible' is set.
618
619Most options are the same in all windows and buffers. There are a few that
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000620are specific to how the text is presented in a window. These can be set to a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000621different value in each window. For example the 'list' option can be set in
622one window and reset in another for the same text, giving both types of view
623at the same time. There are a few options that are specific to a certain
624file. These can have a different value for each file or buffer. For example
625the 'textwidth' option can be 78 for a normal text file and 0 for a C
626program.
627
628 global one option for all buffers and windows
629 local to window each window has its own copy of this option
630 local to buffer each buffer has its own copy of this option
631
632When creating a new window the option values from the currently active window
633are used as a default value for the window-specific options. For the
634buffer-specific options this depends on the 's' and 'S' flags in the
635'cpoptions' option. If 's' is included (which is the default) the values for
636buffer options are copied from the currently active buffer when a buffer is
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000637first entered. If 'S' is present the options are copied each time the buffer
638is entered, this is almost like having global options. If 's' and 'S' are not
Bram Moolenaar071d4272004-06-13 20:20:40 +0000639present, the options are copied from the currently active buffer when the
640buffer is created.
641
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000642Hidden options *hidden-options*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000643
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000644Not all options are supported in all versions. This depends on the supported
645features and sometimes on the system. A remark about this is in curly braces
646below. When an option is not supported it may still be set without getting an
647error, this is called a hidden option. You can't get the value of a hidden
648option though, it is not stored.
649
650To test if option "foo" can be used with ":set" use something like this: >
651 if exists('&foo')
652This also returns true for a hidden option. To test if option "foo" is really
653supported use something like this: >
654 if exists('+foo')
655<
Bram Moolenaar071d4272004-06-13 20:20:40 +0000656 *E355*
657A jump table for the options with a short description can be found at |Q_op|.
658
659 *'aleph'* *'al'* *aleph* *Aleph*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +0100660'aleph' 'al' number (default 128 for MS-Windows, 224 otherwise)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000661 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000662 {only available when compiled with the |+rightleft|
663 feature}
664 The ASCII code for the first letter of the Hebrew alphabet. The
665 routine that maps the keyboard in Hebrew mode, both in Insert mode
666 (when hkmap is set) and on the command-line (when hitting CTRL-_)
667 outputs the Hebrew characters in the range [aleph..aleph+26].
668 aleph=128 applies to PC code, and aleph=224 applies to ISO 8859-8.
669 See |rileft.txt|.
670
671 *'allowrevins'* *'ari'* *'noallowrevins'* *'noari'*
672'allowrevins' 'ari' boolean (default off)
673 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000674 {only available when compiled with the |+rightleft|
675 feature}
676 Allow CTRL-_ in Insert and Command-line mode. This is default off, to
677 avoid that users that accidentally type CTRL-_ instead of SHIFT-_ get
678 into reverse Insert mode, and don't know how to get out. See
679 'revins'.
680 NOTE: This option is reset when 'compatible' is set.
681
682 *'altkeymap'* *'akm'* *'noaltkeymap'* *'noakm'*
683'altkeymap' 'akm' boolean (default off)
684 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000685 {only available when compiled with the |+farsi|
686 feature}
Bram Moolenaar14184a32019-02-16 15:10:30 +0100687 This option was for using Farsi, which has been removed. See
688 |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000689
690 *'ambiwidth'* *'ambw'*
691'ambiwidth' 'ambw' string (default: "single")
692 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000693 Only effective when 'encoding' is "utf-8" or another Unicode encoding.
694 Tells Vim what to do with characters with East Asian Width Class
695 Ambiguous (such as Euro, Registered Sign, Copyright Sign, Greek
696 letters, Cyrillic letters).
697
698 There are currently two possible values:
Bram Moolenaar582fd852005-03-28 20:58:01 +0000699 "single": Use the same width as characters in US-ASCII. This is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000700 expected by most users.
701 "double": Use twice the width of ASCII characters.
Bram Moolenaar5c3bd0a2010-08-04 20:55:44 +0200702 *E834* *E835*
703 The value "double" cannot be used if 'listchars' or 'fillchars'
Bram Moolenaar1c6737b2020-09-07 22:18:52 +0200704 contains a character that would be double width.
Bram Moolenaar08aac3c2020-08-28 21:04:24 +0200705
706 The values are overruled for characters specified with
707 |setcellwidths()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000708
709 There are a number of CJK fonts for which the width of glyphs for
710 those characters are solely based on how many octets they take in
711 legacy/traditional CJK encodings. In those encodings, Euro,
712 Registered sign, Greek/Cyrillic letters are represented by two octets,
Bram Moolenaar582fd852005-03-28 20:58:01 +0000713 therefore those fonts have "wide" glyphs for them. This is also
Bram Moolenaar071d4272004-06-13 20:20:40 +0000714 true of some line drawing characters used to make tables in text
Bram Moolenaar582fd852005-03-28 20:58:01 +0000715 file. Therefore, when a CJK font is used for GUI Vim or
Bram Moolenaar071d4272004-06-13 20:20:40 +0000716 Vim is running inside a terminal (emulators) that uses a CJK font
717 (or Vim is run inside an xterm invoked with "-cjkwidth" option.),
718 this option should be set to "double" to match the width perceived
719 by Vim with the width of glyphs in the font. Perhaps it also has
Bram Moolenaar8024f932020-01-14 19:29:13 +0100720 to be set to "double" under CJK MS-Windows when the system locale is
721 set to one of CJK locales. See Unicode Standard Annex #11
722 (http://www.unicode.org/reports/tr11).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000723
Bram Moolenaarac7bd632013-03-19 11:35:58 +0100724 Vim may set this option automatically at startup time when Vim is
725 compiled with the |+termresponse| feature and if |t_u7| is set to the
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200726 escape sequence to request cursor position report. The response can
727 be found in |v:termu7resp|.
Bram Moolenaarac7bd632013-03-19 11:35:58 +0100728
Bram Moolenaar071d4272004-06-13 20:20:40 +0000729 *'antialias'* *'anti'* *'noantialias'* *'noanti'*
730'antialias' 'anti' boolean (default: off)
731 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000732 {only available when compiled with GUI enabled
Bram Moolenaar3d1cde82020-08-15 18:55:18 +0200733 on macOS}
734 This option only has an effect in the GUI version of Vim on macOS
Bram Moolenaar071d4272004-06-13 20:20:40 +0000735 v10.2 or later. When on, Vim will use smooth ("antialiased") fonts,
736 which can be easier to read at certain sizes on certain displays.
737 Setting this option can sometimes cause problems if 'guifont' is set
738 to its default (empty string).
Bram Moolenaar036986f2017-03-16 17:41:02 +0100739 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000740
741 *'autochdir'* *'acd'* *'noautochdir'* *'noacd'*
742'autochdir' 'acd' boolean (default off)
743 global
Bram Moolenaar00a927d2010-05-14 23:24:24 +0200744 {only available when compiled with it, use
745 exists("+autochdir") to check}
Bram Moolenaard8c00872005-07-22 21:52:15 +0000746 When on, Vim will change the current working directory whenever you
747 open a file, switch buffers, delete a buffer or open/close a window.
748 It will change to the directory containing the file which was opened
749 or selected.
Bram Moolenaar910f66f2006-04-05 20:41:53 +0000750 Note: When this option is on some plugins may not work.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000751
Bram Moolenaar8b9abfd2021-03-29 20:49:05 +0200752 *'autoshelldir'* *'asd'* *'noautoshelldir'* *'noasd'*
753'autoshelldir' 'asd' boolean (default off)
754 global
755 When on, Vim will change the current working directory whenever you
756 change the directory of the shell running in a terminal window. You
757 need proper setting-up, so whenever the shell's pwd changes an OSC 7
758 escape sequence will be emitted. For example, on Linux, you can source
759 /etc/profile.d/vte.sh in your shell profile if you use bash or zsh.
760
Bram Moolenaar071d4272004-06-13 20:20:40 +0000761 *'arabic'* *'arab'* *'noarabic'* *'noarab'*
762'arabic' 'arab' boolean (default off)
763 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +0000764 {only available when compiled with the |+arabic|
765 feature}
766 This option can be set to start editing Arabic text.
767 Setting this option will:
768 - Set the 'rightleft' option, unless 'termbidi' is set.
769 - Set the 'arabicshape' option, unless 'termbidi' is set.
770 - Set the 'keymap' option to "arabic"; in Insert mode CTRL-^ toggles
771 between typing English and Arabic key mapping.
772 - Set the 'delcombine' option
773 Note that 'encoding' must be "utf-8" for working with Arabic text.
774
775 Resetting this option will:
776 - Reset the 'rightleft' option.
777 - Disable the use of 'keymap' (without changing its value).
778 Note that 'arabicshape' and 'delcombine' are not reset (it is a global
Bram Moolenaarc8734422012-06-01 22:38:45 +0200779 option).
Bram Moolenaar036986f2017-03-16 17:41:02 +0100780 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000781 Also see |arabic.txt|.
782
783 *'arabicshape'* *'arshape'*
784 *'noarabicshape'* *'noarshape'*
785'arabicshape' 'arshape' boolean (default on)
786 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000787 {only available when compiled with the |+arabic|
788 feature}
789 When on and 'termbidi' is off, the required visual character
790 corrections that need to take place for displaying the Arabic language
Bram Moolenaar3a0d8092012-10-21 03:02:54 +0200791 take effect. Shaping, in essence, gets enabled; the term is a broad
Bram Moolenaar071d4272004-06-13 20:20:40 +0000792 one which encompasses:
793 a) the changing/morphing of characters based on their location
794 within a word (initial, medial, final and stand-alone).
795 b) the enabling of the ability to compose characters
796 c) the enabling of the required combining of some characters
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100797 When disabled the display shows each character's true stand-alone
798 form.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000799 Arabic is a complex language which requires other settings, for
800 further details see |arabic.txt|.
Bram Moolenaar036986f2017-03-16 17:41:02 +0100801 NOTE: This option is set when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000802
803 *'autoindent'* *'ai'* *'noautoindent'* *'noai'*
804'autoindent' 'ai' boolean (default off)
805 local to buffer
806 Copy indent from current line when starting a new line (typing <CR>
807 in Insert mode or when using the "o" or "O" command). If you do not
808 type anything on the new line except <BS> or CTRL-D and then type
Bram Moolenaar02467872007-05-06 13:22:01 +0000809 <Esc>, CTRL-O or <CR>, the indent is deleted again. Moving the cursor
810 to another line has the same effect, unless the 'I' flag is included
811 in 'cpoptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000812 When autoindent is on, formatting (with the "gq" command or when you
813 reach 'textwidth' in Insert mode) uses the indentation of the first
814 line.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000815 When 'smartindent' or 'cindent' is on the indent is changed in
816 a different way.
Bram Moolenaarca635012015-09-25 20:34:21 +0200817 The 'autoindent' option is reset when the 'paste' option is set and
818 restored when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000819
820 *'autoread'* *'ar'* *'noautoread'* *'noar'*
821'autoread' 'ar' boolean (default off)
822 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000823 When a file has been detected to have been changed outside of Vim and
824 it has not been changed inside of Vim, automatically read it again.
Bram Moolenaarfd358112018-07-07 23:21:31 +0200825 When the file has been deleted this is not done, so you have the text
826 from before it was deleted. When it appears again then it is read.
827 |timestamp|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000828 If this option has a local value, use this command to switch back to
829 using the global value: >
830 :set autoread<
831<
832 *'autowrite'* *'aw'* *'noautowrite'* *'noaw'*
833'autowrite' 'aw' boolean (default off)
834 global
835 Write the contents of the file, if it has been modified, on each
836 :next, :rewind, :last, :first, :previous, :stop, :suspend, :tag, :!,
Bram Moolenaar14716812006-05-04 21:54:08 +0000837 :make, CTRL-] and CTRL-^ command; and when a :buffer, CTRL-O, CTRL-I,
Bram Moolenaar071d4272004-06-13 20:20:40 +0000838 '{A-Z0-9}, or `{A-Z0-9} command takes one to another file.
839 Note that for some commands the 'autowrite' option is not used, see
840 'autowriteall' for that.
Bram Moolenaar93a1df22018-09-10 11:51:50 +0200841 Some buffers will not be written, specifically when 'buftype' is
Bram Moolenaar20aac6c2018-09-02 21:07:30 +0200842 "nowrite", "nofile", "terminal" or "prompt".
Bram Moolenaar071d4272004-06-13 20:20:40 +0000843
844 *'autowriteall'* *'awa'* *'noautowriteall'* *'noawa'*
845'autowriteall' 'awa' boolean (default off)
846 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000847 Like 'autowrite', but also used for commands ":edit", ":enew", ":quit",
848 ":qall", ":exit", ":xit", ":recover" and closing the Vim window.
849 Setting this option also implies that Vim behaves like 'autowrite' has
850 been set.
851
852 *'background'* *'bg'*
Bram Moolenaar446beb42011-05-10 17:18:44 +0200853'background' 'bg' string (default "dark" or "light", see below)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000854 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000855 When set to "dark", Vim will try to use colors that look good on a
856 dark background. When set to "light", Vim will try to use colors that
857 look good on a light background. Any other value is illegal.
858 Vim tries to set the default value according to the terminal used.
859 This will not always be correct.
860 Setting this option does not change the background color, it tells Vim
861 what the background color looks like. For changing the background
862 color, see |:hi-normal|.
863
864 When 'background' is set Vim will adjust the default color groups for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000865 the new value. But the colors used for syntax highlighting will not
Bram Moolenaar446cb832008-06-24 21:56:24 +0000866 change. *g:colors_name*
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100867 When a color scheme is loaded (the "g:colors_name" variable is set)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000868 setting 'background' will cause the color scheme to be reloaded. If
869 the color scheme adjusts to the value of 'background' this will work.
870 However, if the color scheme sets 'background' itself the effect may
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100871 be undone. First delete the "g:colors_name" variable when needed.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000872
873 When setting 'background' to the default value with: >
874 :set background&
875< Vim will guess the value. In the GUI this should work correctly,
876 in other cases Vim might not be able to guess the right value.
Bram Moolenaar2e693a82019-10-16 22:35:02 +0200877 If the GUI supports a dark theme, you can use the "d" flag in
Bram Moolenaar50bf7ce2019-09-15 13:17:00 +0200878 'guioptions', see 'go-d'.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000879
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200880 When the |t_RB| option is set, Vim will use it to request the background
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +0200881 color from the terminal. If the returned RGB value is dark/light and
882 'background' is not dark/light, 'background' will be set and the
883 screen is redrawn. This may have side effects, make t_BG empty in
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200884 your .vimrc if you suspect this problem. The response to |t_RB| can
Bram Moolenaar01164a62017-11-02 22:58:42 +0100885 be found in |v:termrbgresp|.
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +0200886
Bram Moolenaar071d4272004-06-13 20:20:40 +0000887 When starting the GUI, the default value for 'background' will be
888 "light". When the value is not set in the .gvimrc, and Vim detects
889 that the background is actually quite dark, 'background' is set to
890 "dark". But this happens only AFTER the .gvimrc file has been read
891 (because the window needs to be opened to find the actual background
892 color). To get around this, force the GUI window to be opened by
893 putting a ":gui" command in the .gvimrc file, before where the value
894 of 'background' is used (e.g., before ":syntax on").
Bram Moolenaar446beb42011-05-10 17:18:44 +0200895
Bram Moolenaar6f345a12019-12-17 21:27:18 +0100896 For MS-Windows the default is "dark".
Bram Moolenaar446beb42011-05-10 17:18:44 +0200897 For other systems "dark" is used when 'term' is "linux",
898 "screen.linux", "cygwin" or "putty", or $COLORFGBG suggests a dark
899 background. Otherwise the default is "light".
900
Bram Moolenaarc572da52017-08-27 16:52:01 +0200901 The |:terminal| command and the |term_start()| function use the
902 'background' value to decide whether the terminal window will start
903 with a white or black background.
904
Bram Moolenaar071d4272004-06-13 20:20:40 +0000905 Normally this option would be set in the .vimrc file. Possibly
906 depending on the terminal name. Example: >
907 :if &term == "pcterm"
908 : set background=dark
909 :endif
910< When this option is set, the default settings for the highlight groups
911 will change. To use other settings, place ":highlight" commands AFTER
912 the setting of the 'background' option.
913 This option is also used in the "$VIMRUNTIME/syntax/syntax.vim" file
914 to select the colors for syntax highlighting. After changing this
915 option, you must load syntax.vim again to see the result. This can be
916 done with ":syntax on".
917
918 *'backspace'* *'bs'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +0200919'backspace' 'bs' string (default "", set to "indent,eol,start"
920 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000921 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000922 Influences the working of <BS>, <Del>, CTRL-W and CTRL-U in Insert
923 mode. This is a list of items, separated by commas. Each item allows
924 a way to backspace over something:
925 value effect ~
926 indent allow backspacing over autoindent
927 eol allow backspacing over line breaks (join lines)
928 start allow backspacing over the start of insert; CTRL-W and CTRL-U
929 stop once at the start of insert.
Bram Moolenaaraa0489e2020-04-17 19:41:21 +0200930 nostop like start, except CTRL-W and CTRL-U do not stop at the start of
931 insert.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000932
933 When the value is empty, Vi compatible backspacing is used.
934
935 For backwards compatibility with version 5.4 and earlier:
936 value effect ~
937 0 same as ":set backspace=" (Vi compatible)
938 1 same as ":set backspace=indent,eol"
939 2 same as ":set backspace=indent,eol,start"
Bram Moolenaaraa0489e2020-04-17 19:41:21 +0200940 3 same as ":set backspace=indent,eol,nostop"
Bram Moolenaar071d4272004-06-13 20:20:40 +0000941
942 See |:fixdel| if your <BS> or <Del> key does not do what you want.
943 NOTE: This option is set to "" when 'compatible' is set.
944
945 *'backup'* *'bk'* *'nobackup'* *'nobk'*
946'backup' 'bk' boolean (default off)
947 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000948 Make a backup before overwriting a file. Leave it around after the
949 file has been successfully written. If you do not want to keep the
950 backup file, but you do want a backup while the file is being
951 written, reset this option and set the 'writebackup' option (this is
952 the default). If you do not want a backup file at all reset both
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000953 options (use this if your file system is almost full). See the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000954 |backup-table| for more explanations.
955 When the 'backupskip' pattern matches, a backup is not made anyway.
956 When 'patchmode' is set, the backup may be renamed to become the
957 oldest version of a file.
958 NOTE: This option is reset when 'compatible' is set.
959
960 *'backupcopy'* *'bkc'*
961'backupcopy' 'bkc' string (Vi default for Unix: "yes", otherwise: "auto")
Bram Moolenaarb8ee25a2014-09-23 15:45:08 +0200962 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000963 When writing a file and a backup is made, this option tells how it's
964 done. This is a comma separated list of words.
965
966 The main values are:
967 "yes" make a copy of the file and overwrite the original one
968 "no" rename the file and write a new one
969 "auto" one of the previous, what works best
970
971 Extra values that can be combined with the ones above are:
972 "breaksymlink" always break symlinks when writing
973 "breakhardlink" always break hardlinks when writing
974
975 Making a copy and overwriting the original file:
976 - Takes extra time to copy the file.
977 + When the file has special attributes, is a (hard/symbolic) link or
978 has a resource fork, all this is preserved.
979 - When the file is a link the backup will have the name of the link,
980 not of the real file.
981
982 Renaming the file and writing a new one:
983 + It's fast.
984 - Sometimes not all attributes of the file can be copied to the new
985 file.
986 - When the file is a link the new file will not be a link.
987
988 The "auto" value is the middle way: When Vim sees that renaming file
989 is possible without side effects (the attributes can be passed on and
Bram Moolenaar02467872007-05-06 13:22:01 +0000990 the file is not a link) that is used. When problems are expected, a
991 copy will be made.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000992
993 The "breaksymlink" and "breakhardlink" values can be used in
994 combination with any of "yes", "no" and "auto". When included, they
995 force Vim to always break either symbolic or hard links by doing
996 exactly what the "no" option does, renaming the original file to
997 become the backup and writing a new file in its place. This can be
998 useful for example in source trees where all the files are symbolic or
999 hard links and any changes should stay in the local source tree, not
1000 be propagated back to the original source.
1001 *crontab*
1002 One situation where "no" and "auto" will cause problems: A program
1003 that opens a file, invokes Vim to edit that file, and then tests if
1004 the open file was changed (through the file descriptor) will check the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001005 backup file instead of the newly created file. "crontab -e" is an
Bram Moolenaar071d4272004-06-13 20:20:40 +00001006 example.
1007
1008 When a copy is made, the original file is truncated and then filled
1009 with the new text. This means that protection bits, owner and
1010 symbolic links of the original file are unmodified. The backup file
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001011 however, is a new file, owned by the user who edited the file. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00001012 group of the backup is set to the group of the original file. If this
1013 fails, the protection bits for the group are made the same as for
1014 others.
1015
1016 When the file is renamed this is the other way around: The backup has
1017 the same attributes of the original file, and the newly written file
1018 is owned by the current user. When the file was a (hard/symbolic)
1019 link, the new file will not! That's why the "auto" value doesn't
1020 rename when the file is a link. The owner and group of the newly
1021 written file will be set to the same ones as the original file, but
1022 the system may refuse to do this. In that case the "auto" value will
1023 again not rename the file.
1024
Bram Moolenaar036986f2017-03-16 17:41:02 +01001025 NOTE: This option is set to the Vi default value when 'compatible' is
1026 set and to the Vim default value when 'compatible' is reset.
1027
Bram Moolenaar071d4272004-06-13 20:20:40 +00001028 *'backupdir'* *'bdir'*
1029'backupdir' 'bdir' string (default for Amiga: ".,t:",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01001030 for Win32: ".,$TEMP,c:/tmp,c:/temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001031 for Unix: ".,~/tmp,~/")
1032 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001033 List of directories for the backup file, separated with commas.
1034 - The backup file will be created in the first directory in the list
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001035 where this is possible. The directory must exist, Vim will not
1036 create it for you.
Bram Moolenaar3848e002016-03-19 18:42:29 +01001037 - Empty means that no backup file will be created ('patchmode' is
Bram Moolenaar071d4272004-06-13 20:20:40 +00001038 impossible!). Writing may fail because of this.
1039 - A directory "." means to put the backup file in the same directory
1040 as the edited file.
Bram Moolenaar8024f932020-01-14 19:29:13 +01001041 - A directory starting with "./" (or ".\" for MS-Windows) means to put
1042 the backup file relative to where the edited file is. The leading
1043 "." is replaced with the path name of the edited file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001044 ("." inside a directory name has no special meaning).
1045 - Spaces after the comma are ignored, other spaces are considered part
1046 of the directory name. To have a space at the start of a directory
1047 name, precede it with a backslash.
1048 - To include a comma in a directory name precede it with a backslash.
1049 - A directory name may end in an '/'.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02001050 - For Unix and Win32, if a directory ends in two path separators "//",
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01001051 the backup file name will be built from the complete path to the
1052 file with all path separators changed to percent '%' signs. This
1053 will ensure file name uniqueness in the backup directory.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02001054 On Win32, it is also possible to end with "\\". However, When a
1055 separating comma is following, you must use "//", since "\\" will
1056 include the comma in the file name. Therefore it is recommended to
1057 use '//', instead of '\\'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001058 - Environment variables are expanded |:set_env|.
1059 - Careful with '\' characters, type one before a space, type two to
1060 get one in the option (see |option-backslash|), for example: >
1061 :set bdir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
1062< - For backwards compatibility with Vim version 3.0 a '>' at the start
1063 of the option is removed.
1064 See also 'backup' and 'writebackup' options.
1065 If you want to hide your backup files on Unix, consider this value: >
1066 :set backupdir=./.backup,~/.backup,.,/tmp
1067< You must create a ".backup" directory in each directory and in your
1068 home directory for this to work properly.
1069 The use of |:set+=| and |:set-=| is preferred when adding or removing
1070 directories from the list. This avoids problems when a future version
1071 uses another default.
1072 This option cannot be set from a |modeline| or in the |sandbox|, for
1073 security reasons.
1074
1075 *'backupext'* *'bex'* *E589*
1076'backupext' 'bex' string (default "~", for VMS: "_")
1077 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001078 String which is appended to a file name to make the name of the
1079 backup file. The default is quite unusual, because this avoids
1080 accidentally overwriting existing files with a backup file. You might
1081 prefer using ".bak", but make sure that you don't have files with
1082 ".bak" that you want to keep.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001083 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001084
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001085 If you like to keep a lot of backups, you could use a BufWritePre
1086 autocommand to change 'backupext' just before writing the file to
1087 include a timestamp. >
1088 :au BufWritePre * let &bex = '-' . strftime("%Y%b%d%X") . '~'
1089< Use 'backupdir' to put the backup in a different directory.
1090
Bram Moolenaar071d4272004-06-13 20:20:40 +00001091 *'backupskip'* *'bsk'*
Bram Moolenaarb8e22a02018-04-12 21:37:34 +02001092'backupskip' 'bsk' string (default: "$TMPDIR/*,$TMP/*,$TEMP/*"
1093 Unix: "/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*"
1094 Mac: "/private/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001095 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001096 {not available when compiled without the |+wildignore|
1097 feature}
1098 A list of file patterns. When one of the patterns matches with the
1099 name of the file which is written, no backup file is created. Both
1100 the specified file name and the full path name of the file are used.
1101 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
1102 Watch out for special characters, see |option-backslash|.
1103 When $TMPDIR, $TMP or $TEMP is not defined, it is not used for the
Bram Moolenaar582fd852005-03-28 20:58:01 +00001104 default value. "/tmp/*" is only used for Unix.
Bram Moolenaar02467872007-05-06 13:22:01 +00001105
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02001106 WARNING: Not having a backup file means that when Vim fails to write
1107 your buffer correctly and then, for whatever reason, Vim exits, you
1108 lose both the original file and what you were writing. Only disable
1109 backups if you don't care about losing the file.
1110
Bram Moolenaar02467872007-05-06 13:22:01 +00001111 Note that environment variables are not expanded. If you want to use
1112 $HOME you must expand it explicitly, e.g.: >
Bram Moolenaar7c1c6db2016-04-03 22:08:05 +02001113 :let &backupskip = escape(expand('$HOME'), '\') . '/tmp/*'
Bram Moolenaar02467872007-05-06 13:22:01 +00001114
1115< Note that the default also makes sure that "crontab -e" works (when a
Bram Moolenaara5792f52005-11-23 21:25:05 +00001116 backup would be made by renaming the original file crontab won't see
1117 the newly created file). Also see 'backupcopy' and |crontab|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001118
1119 *'balloondelay'* *'bdlay'*
1120'balloondelay' 'bdlay' number (default: 600)
1121 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001122 {only available when compiled with the |+balloon_eval|
1123 feature}
1124 Delay in milliseconds before a balloon may pop up. See |balloon-eval|.
1125
1126 *'ballooneval'* *'beval'* *'noballooneval'* *'nobeval'*
1127'ballooneval' 'beval' boolean (default off)
1128 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001129 {only available when compiled with the |+balloon_eval|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001130 feature}
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001131 Switch on the |balloon-eval| functionality for the GUI.
1132
1133 *'balloonevalterm'* *'bevalterm'* *'noballoonevalterm'*
1134 *'nobevalterm'*
1135'balloonevalterm' 'bevalterm' boolean (default off)
1136 global
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001137 {only available when compiled with the
1138 |+balloon_eval_term| feature}
1139 Switch on the |balloon-eval| functionality for the terminal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001140
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001141 *'balloonexpr'* *'bexpr'*
1142'balloonexpr' 'bexpr' string (default "")
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00001143 global or local to buffer |global-local|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001144 {only available when compiled with the |+balloon_eval|
1145 feature}
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00001146 Expression for text to show in evaluation balloon. It is only used
Bram Moolenaara6c27c42019-05-09 19:16:22 +02001147 when 'ballooneval' or 'balloonevalterm' is on. These variables can be
1148 used:
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001149
1150 v:beval_bufnr number of the buffer in which balloon is going to show
1151 v:beval_winnr number of the window
Bram Moolenaar82af8712016-06-04 20:20:29 +02001152 v:beval_winid ID of the window
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001153 v:beval_lnum line number
1154 v:beval_col column number (byte index)
1155 v:beval_text word under or after the mouse pointer
1156
Bram Moolenaar54775062019-07-31 21:07:14 +02001157 Instead of showing a balloon, which is limited to plain text, consider
1158 using a popup window, see |popup_beval_example|. A popup window can
1159 use highlighting and show a border.
1160
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001161 The evaluation of the expression must not have side effects!
1162 Example: >
Bram Moolenaara6c27c42019-05-09 19:16:22 +02001163 function MyBalloonExpr()
Bram Moolenaar45360022005-07-21 21:08:21 +00001164 return 'Cursor is at line ' . v:beval_lnum .
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001165 \', column ' . v:beval_col .
1166 \ ' of file ' . bufname(v:beval_bufnr) .
1167 \ ' on word "' . v:beval_text . '"'
1168 endfunction
1169 set bexpr=MyBalloonExpr()
1170 set ballooneval
1171<
Bram Moolenaar396e8292019-07-13 23:04:31 +02001172 Also see |balloon_show()|, it can be used if the content of the balloon
1173 is to be fetched asynchronously. In that case evaluating
1174 'balloonexpr' should result in an empty string. If you get a balloon
1175 with only "0" you probably didn't return anything from your function.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001176
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001177 NOTE: The balloon is displayed only if the cursor is on a text
1178 character. If the result of evaluating 'balloonexpr' is not empty,
1179 Vim does not try to send a message to an external debugger (Netbeans
1180 or Sun Workshop).
1181
Bram Moolenaar30b65812012-07-12 22:01:11 +02001182 The expression will be evaluated in the |sandbox| when set from a
1183 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02001184 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001185
1186 It is not allowed to change text or jump to another window while
Bram Moolenaar396e8292019-07-13 23:04:31 +02001187 evaluating 'balloonexpr', see |textlock|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001188
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001189 To check whether line breaks in the balloon text work use this check: >
Bram Moolenaar45360022005-07-21 21:08:21 +00001190 if has("balloon_multiline")
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001191< When they are supported "\n" characters will start a new line. If the
1192 expression evaluates to a |List| this is equal to using each List item
1193 as a string and putting "\n" in between them.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001194 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001195
Bram Moolenaar165bc692015-07-21 17:53:25 +02001196 *'belloff'* *'bo'*
1197'belloff' 'bo' string (default "")
1198 global
Bram Moolenaar165bc692015-07-21 17:53:25 +02001199 Specifies for which events the bell will not be rung. It is a comma
1200 separated list of items. For each item that is present, the bell
1201 will be silenced. This is most useful to specify specific events in
1202 insert mode to be silenced.
1203
1204 item meaning when present ~
1205 all All events.
1206 backspace When hitting <BS> or <Del> and deleting results in an
1207 error.
1208 cursor Fail to move around using the cursor keys or
1209 <PageUp>/<PageDown> in |Insert-mode|.
1210 complete Error occurred when using |i_CTRL-X_CTRL-K| or
1211 |i_CTRL-X_CTRL-T|.
1212 copy Cannot copy char from insert mode using |i_CTRL-Y| or
1213 |i_CTRL-E|.
1214 ctrlg Unknown Char after <C-G> in Insert mode.
1215 error Other Error occurred (e.g. try to join last line)
1216 (mostly used in |Normal-mode| or |Cmdline-mode|).
1217 esc hitting <Esc> in |Normal-mode|.
1218 ex In |Visual-mode|, hitting |Q| results in an error.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01001219 hangul Ignored.
Bram Moolenaar165bc692015-07-21 17:53:25 +02001220 insertmode Pressing <Esc> in 'insertmode'.
1221 lang Calling the beep module for Lua/Mzscheme/TCL.
1222 mess No output available for |g<|.
1223 showmatch Error occurred for 'showmatch' function.
1224 operator Empty region error |cpo-E|.
1225 register Unknown register after <C-R> in |Insert-mode|.
1226 shell Bell from shell output |:!|.
1227 spell Error happened on spell suggest.
1228 wildmode More matches in |cmdline-completion| available
1229 (depends on the 'wildmode' setting).
1230
Bram Moolenaar036986f2017-03-16 17:41:02 +01001231 This is most useful to fine tune when in Insert mode the bell should
1232 be rung. For Normal mode and Ex commands, the bell is often rung to
Bram Moolenaar165bc692015-07-21 17:53:25 +02001233 indicate that an error occurred. It can be silenced by adding the
1234 "error" keyword.
1235
Bram Moolenaar071d4272004-06-13 20:20:40 +00001236 *'binary'* *'bin'* *'nobinary'* *'nobin'*
1237'binary' 'bin' boolean (default off)
1238 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001239 This option should be set before editing a binary file. You can also
1240 use the |-b| Vim argument. When this option is switched on a few
1241 options will be changed (also when it already was on):
1242 'textwidth' will be set to 0
1243 'wrapmargin' will be set to 0
1244 'modeline' will be off
1245 'expandtab' will be off
1246 Also, 'fileformat' and 'fileformats' options will not be used, the
1247 file is read and written like 'fileformat' was "unix" (a single <NL>
1248 separates lines).
1249 The 'fileencoding' and 'fileencodings' options will not be used, the
1250 file is read without conversion.
1251 NOTE: When you start editing a(nother) file while the 'bin' option is
1252 on, settings from autocommands may change the settings again (e.g.,
1253 'textwidth'), causing trouble when editing. You might want to set
1254 'bin' again when the file has been loaded.
1255 The previous values of these options are remembered and restored when
1256 'bin' is switched from on to off. Each buffer has its own set of
1257 saved option values.
1258 To edit a file with 'binary' set you can use the |++bin| argument.
1259 This avoids you have to do ":set bin", which would have effect for all
1260 files you edit.
1261 When writing a file the <EOL> for the last line is only written if
1262 there was one in the original file (normally Vim appends an <EOL> to
1263 the last line if there is none; this would make the file longer). See
1264 the 'endofline' option.
1265
1266 *'bioskey'* *'biosk'* *'nobioskey'* *'nobiosk'*
1267'bioskey' 'biosk' boolean (default on)
1268 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02001269 {only for MS-DOS}
Bram Moolenaarf3913272016-02-25 00:00:01 +01001270 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001271
1272 *'bomb'* *'nobomb'*
1273'bomb' boolean (default off)
1274 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001275 When writing a file and the following conditions are met, a BOM (Byte
1276 Order Mark) is prepended to the file:
1277 - this option is on
1278 - the 'binary' option is off
1279 - 'fileencoding' is "utf-8", "ucs-2", "ucs-4" or one of the little/big
1280 endian variants.
1281 Some applications use the BOM to recognize the encoding of the file.
1282 Often used for UCS-2 files on MS-Windows. For other applications it
1283 causes trouble, for example: "cat file1 file2" makes the BOM of file2
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001284 appear halfway the resulting file. Gcc doesn't accept a BOM.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001285 When Vim reads a file and 'fileencodings' starts with "ucs-bom", a
1286 check for the presence of the BOM is done and 'bomb' set accordingly.
1287 Unless 'binary' is set, it is removed from the first line, so that you
1288 don't see it when editing. When you don't change the options, the BOM
1289 will be restored when writing the file.
1290
1291 *'breakat'* *'brk'*
1292'breakat' 'brk' string (default " ^I!@*-+;:,./?")
1293 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02001294 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001295 feature}
1296 This option lets you choose which characters might cause a line
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00001297 break if 'linebreak' is on. Only works for ASCII and also for 8-bit
1298 characters when 'encoding' is an 8-bit encoding.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001299
Bram Moolenaar7c1c6db2016-04-03 22:08:05 +02001300 *'breakindent'* *'bri'* *'nobreakindent'* *'nobri'*
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001301'breakindent' 'bri' boolean (default off)
1302 local to window
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001303 {not available when compiled without the |+linebreak|
1304 feature}
1305 Every wrapped line will continue visually indented (same amount of
1306 space as the beginning of that line), thus preserving horizontal blocks
1307 of text.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001308 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001309
1310 *'breakindentopt'* *'briopt'*
1311'breakindentopt' 'briopt' string (default empty)
1312 local to window
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001313 {not available when compiled without the |+linebreak|
1314 feature}
1315 Settings for 'breakindent'. It can consist of the following optional
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001316 items and must be separated by a comma:
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001317 min:{n} Minimum text width that will be kept after
1318 applying 'breakindent', even if the resulting
1319 text should normally be narrower. This prevents
1320 text indented almost to the right window border
1321 occupying lot of vertical space when broken.
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001322 shift:{n} After applying 'breakindent', the wrapped line's
1323 beginning will be shifted by the given number of
1324 characters. It permits dynamic French paragraph
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001325 indentation (negative) or emphasizing the line
1326 continuation (positive).
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01001327 sbr Display the 'showbreak' value before applying the
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001328 additional indent.
1329 The default value for min is 20 and shift is 0.
1330
Bram Moolenaar071d4272004-06-13 20:20:40 +00001331 *'browsedir'* *'bsdir'*
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001332'browsedir' 'bsdir' string (default: "last")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001333 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02001334 {only for Motif, Athena, GTK, Mac and Win32 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001335 Which directory to use for the file browser:
Bram Moolenaar446cb832008-06-24 21:56:24 +00001336 last Use same directory as with last file browser, where a
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02001337 file was opened or saved.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001338 buffer Use the directory of the related buffer.
1339 current Use the current directory.
1340 {path} Use the specified directory
1341
1342 *'bufhidden'* *'bh'*
1343'bufhidden' 'bh' string (default: "")
1344 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001345 This option specifies what happens when a buffer is no longer
1346 displayed in a window:
1347 <empty> follow the global 'hidden' option
1348 hide hide the buffer (don't unload it), also when 'hidden'
1349 is not set
1350 unload unload the buffer, also when 'hidden' is set or using
1351 |:hide|
1352 delete delete the buffer from the buffer list, also when
1353 'hidden' is set or using |:hide|, like using
1354 |:bdelete|
1355 wipe wipe out the buffer from the buffer list, also when
1356 'hidden' is set or using |:hide|, like using
1357 |:bwipeout|
1358
Bram Moolenaara14de3d2005-01-07 21:48:26 +00001359 CAREFUL: when "unload", "delete" or "wipe" is used changes in a buffer
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01001360 are lost without a warning. Also, these values may break autocommands
1361 that switch between buffers temporarily.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001362 This option is used together with 'buftype' and 'swapfile' to specify
1363 special kinds of buffers. See |special-buffers|.
1364
1365 *'buflisted'* *'bl'* *'nobuflisted'* *'nobl'* *E85*
1366'buflisted' 'bl' boolean (default: on)
1367 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001368 When this option is set, the buffer shows up in the buffer list. If
1369 it is reset it is not used for ":bnext", "ls", the Buffers menu, etc.
1370 This option is reset by Vim for buffers that are only used to remember
1371 a file name or marks. Vim sets it when starting to edit a buffer.
1372 But not when moving to a buffer with ":buffer".
1373
1374 *'buftype'* *'bt'* *E382*
1375'buftype' 'bt' string (default: "")
1376 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001377 The value of this option specifies the type of a buffer:
1378 <empty> normal buffer
1379 nofile buffer which is not related to a file and will not be
1380 written
1381 nowrite buffer which will not be written
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001382 acwrite buffer which will always be written with BufWriteCmd
Bram Moolenaarb5b75622018-03-09 22:22:21 +01001383 autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001384 quickfix quickfix buffer, contains list of errors |:cwindow|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001385 or list of locations |:lwindow|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001386 help help buffer (you are not supposed to set this
1387 manually)
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02001388 terminal buffer for a |terminal| (you are not supposed to set
1389 this manually)
Bram Moolenaarf2732452018-06-03 14:47:35 +02001390 prompt buffer where only the last line can be edited, meant
1391 to be used by a plugin, see |prompt-buffer|
1392 {only when compiled with the |+channel| feature}
Bram Moolenaar4d784b22019-05-25 19:51:39 +02001393 popup buffer used in a popup window, see |popup|.
1394 {only when compiled with the |+textprop| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001395
1396 This option is used together with 'bufhidden' and 'swapfile' to
1397 specify special kinds of buffers. See |special-buffers|.
Bram Moolenaarebdf3c92020-02-15 21:41:42 +01001398 Also see |win_gettype()|, which returns the type of the window.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001399
1400 Be careful with changing this option, it can have many side effects!
1401
Bram Moolenaar280f1262006-01-30 00:14:18 +00001402 A "quickfix" buffer is only used for the error list and the location
1403 list. This value is set by the |:cwindow| and |:lwindow| commands and
1404 you are not supposed to change it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001405
1406 "nofile" and "nowrite" buffers are similar:
1407 both: The buffer is not to be written to disk, ":w" doesn't
1408 work (":w filename" does work though).
1409 both: The buffer is never considered to be |'modified'|.
1410 There is no warning when the changes will be lost, for
1411 example when you quit Vim.
1412 both: A swap file is only created when using too much memory
1413 (when 'swapfile' has been reset there is never a swap
1414 file).
1415 nofile only: The buffer name is fixed, it is not handled like a
1416 file name. It is not modified in response to a |:cd|
1417 command.
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01001418 both: When using ":e bufname" and already editing "bufname"
1419 the buffer is made empty and autocommands are
1420 triggered as usual for |:edit|.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001421 *E676*
1422 "acwrite" implies that the buffer name is not related to a file, like
1423 "nofile", but it will be written. Thus, in contrast to "nofile" and
1424 "nowrite", ":w" does work and a modified buffer can't be abandoned
1425 without saving. For writing there must be matching |BufWriteCmd|,
1426 |FileWriteCmd| or |FileAppendCmd| autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001427
1428 *'casemap'* *'cmp'*
1429'casemap' 'cmp' string (default: "internal,keepascii")
1430 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001431 Specifies details about changing the case of letters. It may contain
1432 these words, separated by a comma:
1433 internal Use internal case mapping functions, the current
1434 locale does not change the case mapping. This only
Bram Moolenaar6f16eb82005-08-23 21:02:42 +00001435 matters when 'encoding' is a Unicode encoding,
1436 "latin1" or "iso-8859-15". When "internal" is
1437 omitted, the towupper() and towlower() system library
1438 functions are used when available.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001439 keepascii For the ASCII characters (0x00 to 0x7f) use the US
1440 case mapping, the current locale is not effective.
1441 This probably only matters for Turkish.
1442
1443 *'cdpath'* *'cd'* *E344* *E346*
1444'cdpath' 'cd' string (default: equivalent to $CDPATH or ",,")
1445 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001446 {not available when compiled without the
1447 |+file_in_path| feature}
1448 This is a list of directories which will be searched when using the
Bram Moolenaar00aa0692019-04-27 20:37:57 +02001449 |:cd|, |:tcd| and |:lcd| commands, provided that the directory being
1450 searched for has a relative path, not an absolute part starting with
1451 "/", "./" or "../", the 'cdpath' option is not used then.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001452 The 'cdpath' option's value has the same form and semantics as
1453 |'path'|. Also see |file-searching|.
1454 The default value is taken from $CDPATH, with a "," prepended to look
1455 in the current directory first.
1456 If the default value taken from $CDPATH is not what you want, include
1457 a modified version of the following command in your vimrc file to
1458 override it: >
1459 :let &cdpath = ',' . substitute(substitute($CDPATH, '[, ]', '\\\0', 'g'), ':', ',', 'g')
1460< This option cannot be set from a |modeline| or in the |sandbox|, for
1461 security reasons.
1462 (parts of 'cdpath' can be passed to the shell to expand file names).
1463
1464 *'cedit'*
1465'cedit' string (Vi default: "", Vim default: CTRL-F)
1466 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001467 The key used in Command-line Mode to open the command-line window.
1468 The default is CTRL-F when 'compatible' is off.
1469 Only non-printable keys are allowed.
1470 The key can be specified as a single character, but it is difficult to
1471 type. The preferred way is to use the <> notation. Examples: >
Bram Moolenaare18dbe82016-07-02 21:42:23 +02001472 :exe "set cedit=\<C-Y>"
1473 :exe "set cedit=\<Esc>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001474< |Nvi| also has this option, but it only uses the first character.
1475 See |cmdwin|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001476 NOTE: This option is set to the Vim default value when 'compatible'
1477 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001478
1479 *'charconvert'* *'ccv'* *E202* *E214* *E513*
1480'charconvert' 'ccv' string (default "")
1481 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01001482 {only available when compiled with the |+eval| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001483 An expression that is used for character encoding conversion. It is
1484 evaluated when a file that is to be read or has been written has a
1485 different encoding from what is desired.
1486 'charconvert' is not used when the internal iconv() function is
1487 supported and is able to do the conversion. Using iconv() is
1488 preferred, because it is much faster.
1489 'charconvert' is not used when reading stdin |--|, because there is no
1490 file to convert from. You will have to save the text in a file first.
1491 The expression must return zero or an empty string for success,
1492 non-zero for failure.
1493 The possible encoding names encountered are in 'encoding'.
1494 Additionally, names given in 'fileencodings' and 'fileencoding' are
1495 used.
1496 Conversion between "latin1", "unicode", "ucs-2", "ucs-4" and "utf-8"
1497 is done internally by Vim, 'charconvert' is not used for this.
1498 'charconvert' is also used to convert the viminfo file, if the 'c'
1499 flag is present in 'viminfo'. Also used for Unicode conversion.
1500 Example: >
1501 set charconvert=CharConvert()
1502 fun CharConvert()
1503 system("recode "
1504 \ . v:charconvert_from . ".." . v:charconvert_to
1505 \ . " <" . v:fname_in . " >" v:fname_out)
1506 return v:shell_error
1507 endfun
1508< The related Vim variables are:
1509 v:charconvert_from name of the current encoding
1510 v:charconvert_to name of the desired encoding
1511 v:fname_in name of the input file
1512 v:fname_out name of the output file
1513 Note that v:fname_in and v:fname_out will never be the same.
1514 Note that v:charconvert_from and v:charconvert_to may be different
1515 from 'encoding'. Vim internally uses UTF-8 instead of UCS-2 or UCS-4.
1516 Encryption is not done by Vim when using 'charconvert'. If you want
1517 to encrypt the file after conversion, 'charconvert' should take care
1518 of this.
1519 This option cannot be set from a |modeline| or in the |sandbox|, for
1520 security reasons.
1521
1522 *'cindent'* *'cin'* *'nocindent'* *'nocin'*
1523'cindent' 'cin' boolean (default off)
1524 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001525 {not available when compiled without the |+cindent|
1526 feature}
Bram Moolenaar446cb832008-06-24 21:56:24 +00001527 Enables automatic C program indenting. See 'cinkeys' to set the keys
Bram Moolenaar071d4272004-06-13 20:20:40 +00001528 that trigger reindenting in insert mode and 'cinoptions' to set your
1529 preferred indent style.
1530 If 'indentexpr' is not empty, it overrules 'cindent'.
1531 If 'lisp' is not on and both 'indentexpr' and 'equalprg' are empty,
1532 the "=" operator indents using this algorithm rather than calling an
1533 external program.
1534 See |C-indenting|.
1535 When you don't like the way 'cindent' works, try the 'smartindent'
1536 option or 'indentexpr'.
1537 This option is not used when 'paste' is set.
1538 NOTE: This option is reset when 'compatible' is set.
1539
1540 *'cinkeys'* *'cink'*
Bram Moolenaarce655742019-01-31 14:12:57 +01001541'cinkeys' 'cink' string (default "0{,0},0),0],:,0#,!^F,o,O,e")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001542 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001543 {not available when compiled without the |+cindent|
1544 feature}
1545 A list of keys that, when typed in Insert mode, cause reindenting of
1546 the current line. Only used if 'cindent' is on and 'indentexpr' is
1547 empty.
1548 For the format of this option see |cinkeys-format|.
1549 See |C-indenting|.
1550
1551 *'cinoptions'* *'cino'*
1552'cinoptions' 'cino' string (default "")
1553 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001554 {not available when compiled without the |+cindent|
1555 feature}
1556 The 'cinoptions' affect the way 'cindent' reindents lines in a C
1557 program. See |cinoptions-values| for the values of this option, and
1558 |C-indenting| for info on C indenting in general.
1559
1560
1561 *'cinwords'* *'cinw'*
1562'cinwords' 'cinw' string (default "if,else,while,do,for,switch")
1563 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001564 {not available when compiled without both the
1565 |+cindent| and the |+smartindent| features}
1566 These keywords start an extra indent in the next line when
1567 'smartindent' or 'cindent' is set. For 'cindent' this is only done at
1568 an appropriate place (inside {}).
1569 Note that 'ignorecase' isn't used for 'cinwords'. If case doesn't
1570 matter, include the keyword both the uppercase and lowercase:
1571 "if,If,IF".
1572
1573 *'clipboard'* *'cb'*
1574'clipboard' 'cb' string (default "autoselect,exclude:cons\|linux"
1575 for X-windows, "" otherwise)
1576 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001577 {only in GUI versions or when the |+xterm_clipboard|
1578 feature is included}
1579 This option is a list of comma separated names.
Bram Moolenaar942db232021-02-13 18:14:48 +01001580 Note: if one of the items is "exclude:", then you can't add an item
1581 after that. Therefore do append an item with += but use ^= to
1582 prepend, e.g.: >
1583 set clipboard^=unnamed
1584< These names are recognized:
Bram Moolenaar071d4272004-06-13 20:20:40 +00001585
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001586 *clipboard-unnamed*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001587 unnamed When included, Vim will use the clipboard register '*'
1588 for all yank, delete, change and put operations which
1589 would normally go to the unnamed register. When a
1590 register is explicitly specified, it will always be
1591 used regardless of whether "unnamed" is in 'clipboard'
1592 or not. The clipboard register can always be
1593 explicitly accessed using the "* notation. Also see
1594 |gui-clipboard|.
1595
Bram Moolenaar30b65812012-07-12 22:01:11 +02001596 *clipboard-unnamedplus*
Bram Moolenaar00154502013-02-13 16:15:55 +01001597 unnamedplus A variant of the "unnamed" flag which uses the
1598 clipboard register '+' (|quoteplus|) instead of
1599 register '*' for all yank, delete, change and put
1600 operations which would normally go to the unnamed
1601 register. When "unnamed" is also included to the
1602 option, yank operations (but not delete, change or
1603 put) will additionally copy the text into register
1604 '*'.
Bram Moolenaar81af9252010-12-10 20:35:50 +01001605 Only available with the |+X11| feature.
Bram Moolenaarbf9680e2010-12-02 21:43:16 +01001606 Availability can be checked with: >
1607 if has('unnamedplus')
1608<
Bram Moolenaar30b65812012-07-12 22:01:11 +02001609 *clipboard-autoselect*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001610 autoselect Works like the 'a' flag in 'guioptions': If present,
1611 then whenever Visual mode is started, or the Visual
1612 area extended, Vim tries to become the owner of the
1613 windowing system's global selection or put the
1614 selected text on the clipboard used by the selection
Bram Moolenaarba3ff532018-11-04 14:45:49 +01001615 register "*. See |'go-a'| and |quotestar| for details.
1616 When the GUI is active, the 'a' flag in 'guioptions'
1617 is used, when the GUI is not active, this "autoselect"
1618 flag is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001619 Also applies to the modeless selection.
1620
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001621 *clipboard-autoselectplus*
1622 autoselectplus Like "autoselect" but using the + register instead of
1623 the * register. Compare to the 'P' flag in
1624 'guioptions'.
1625
1626 *clipboard-autoselectml*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001627 autoselectml Like "autoselect", but for the modeless selection
1628 only. Compare to the 'A' flag in 'guioptions'.
1629
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001630 *clipboard-html*
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001631 html When the clipboard contains HTML, use this when
1632 pasting. When putting text on the clipboard, mark it
1633 as HTML. This works to copy rendered HTML from
1634 Firefox, paste it as raw HTML in Vim, select the HTML
1635 in Vim and paste it in a rich edit box in Firefox.
Bram Moolenaar20a825a2010-05-31 21:27:30 +02001636 You probably want to add this only temporarily,
1637 possibly use BufEnter autocommands.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001638 Only supported for GTK version 2 and later.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001639
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001640 *clipboard-exclude*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001641 exclude:{pattern}
1642 Defines a pattern that is matched against the name of
1643 the terminal 'term'. If there is a match, no
1644 connection will be made to the X server. This is
1645 useful in this situation:
1646 - Running Vim in a console.
1647 - $DISPLAY is set to start applications on another
1648 display.
1649 - You do not want to connect to the X server in the
1650 console, but do want this in a terminal emulator.
1651 To never connect to the X server use: >
1652 exclude:.*
1653< This has the same effect as using the |-X| argument.
1654 Note that when there is no connection to the X server
1655 the window title won't be restored and the clipboard
1656 cannot be accessed.
1657 The value of 'magic' is ignored, {pattern} is
1658 interpreted as if 'magic' was on.
1659 The rest of the option value will be used for
1660 {pattern}, this must be the last entry.
1661
1662 *'cmdheight'* *'ch'*
1663'cmdheight' 'ch' number (default 1)
1664 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001665 Number of screen lines to use for the command-line. Helps avoiding
1666 |hit-enter| prompts.
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00001667 The value of this option is stored with the tab page, so that each tab
1668 page can have a different value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001669
1670 *'cmdwinheight'* *'cwh'*
1671'cmdwinheight' 'cwh' number (default 7)
1672 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001673 Number of screen lines to use for the command-line window. |cmdwin|
1674
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001675 *'colorcolumn'* *'cc'*
1676'colorcolumn' 'cc' string (default "")
1677 local to window
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001678 {not available when compiled without the |+syntax|
1679 feature}
1680 'colorcolumn' is a comma separated list of screen columns that are
1681 highlighted with ColorColumn |hl-ColorColumn|. Useful to align
1682 text. Will make screen redrawing slower.
1683 The screen column can be an absolute number, or a number preceded with
1684 '+' or '-', which is added to or subtracted from 'textwidth'. >
1685
1686 :set cc=+1 " highlight column after 'textwidth'
1687 :set cc=+1,+2,+3 " highlight three columns after 'textwidth'
1688 :hi ColorColumn ctermbg=lightgrey guibg=lightgrey
1689<
1690 When 'textwidth' is zero then the items with '-' and '+' are not used.
1691 A maximum of 256 columns are highlighted.
1692
Bram Moolenaar071d4272004-06-13 20:20:40 +00001693 *'columns'* *'co'* *E594*
1694'columns' 'co' number (default 80 or terminal width)
1695 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001696 Number of columns of the screen. Normally this is set by the terminal
Bram Moolenaar7c626922005-02-07 22:01:03 +00001697 initialization and does not have to be set by hand. Also see
1698 |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001699 When Vim is running in the GUI or in a resizable window, setting this
1700 option will cause the window size to be changed. When you only want
1701 to use the size for the GUI, put the command in your |gvimrc| file.
1702 When you set this option and Vim is unable to change the physical
Bram Moolenaar02467872007-05-06 13:22:01 +00001703 number of columns of the display, the display may be messed up. For
1704 the GUI it is always possible and Vim limits the number of columns to
1705 what fits on the screen. You can use this command to get the widest
1706 window possible: >
1707 :set columns=9999
1708< Minimum value is 12, maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001709
1710 *'comments'* *'com'* *E524* *E525*
1711'comments' 'com' string (default
1712 "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-")
1713 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001714 A comma separated list of strings that can start a comment line. See
1715 |format-comments|. See |option-backslash| about using backslashes to
1716 insert a space.
1717
1718 *'commentstring'* *'cms'* *E537*
1719'commentstring' 'cms' string (default "/*%s*/")
1720 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001721 {not available when compiled without the |+folding|
1722 feature}
1723 A template for a comment. The "%s" in the value is replaced with the
1724 comment text. Currently only used to add markers for folding, see
1725 |fold-marker|.
1726
1727 *'compatible'* *'cp'* *'nocompatible'* *'nocp'*
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001728'compatible' 'cp' boolean (default on, off when a |vimrc| or |gvimrc|
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02001729 file is found, reset in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001730 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001731 This option has the effect of making Vim either more Vi-compatible, or
1732 make Vim behave in a more useful way.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001733
Bram Moolenaar071d4272004-06-13 20:20:40 +00001734 This is a special kind of option, because when it's set or reset,
Bram Moolenaar214641f2017-03-05 17:04:09 +01001735 other options are also changed as a side effect.
1736 NOTE: Setting or resetting this option can have a lot of unexpected
1737 effects: Mappings are interpreted in another way, undo behaves
1738 differently, etc. If you set this option in your vimrc file, you
1739 should probably put it at the very start.
1740
Bram Moolenaar071d4272004-06-13 20:20:40 +00001741 By default this option is on and the Vi defaults are used for the
1742 options. This default was chosen for those people who want to use Vim
1743 just like Vi, and don't even (want to) know about the 'compatible'
1744 option.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001745 When a |vimrc| or |gvimrc| file is found while Vim is starting up,
Bram Moolenaard042c562005-06-30 22:04:15 +00001746 this option is switched off, and all options that have not been
1747 modified will be set to the Vim defaults. Effectively, this means
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001748 that when a |vimrc| or |gvimrc| file exists, Vim will use the Vim
Bram Moolenaard042c562005-06-30 22:04:15 +00001749 defaults, otherwise it will use the Vi defaults. (Note: This doesn't
Bram Moolenaar02467872007-05-06 13:22:01 +00001750 happen for the system-wide vimrc or gvimrc file, nor for a file given
1751 with the |-u| argument). Also see |compatible-default| and
1752 |posix-compliance|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001753 You can also set this option with the "-C" argument, and reset it with
1754 "-N". See |-C| and |-N|.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001755 See 'cpoptions' for more fine tuning of Vi compatibility.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001756
Bram Moolenaar214641f2017-03-05 17:04:09 +01001757 When this option is set, numerous other options are set to make Vim as
1758 Vi-compatible as possible. When this option is unset, various options
1759 are set to make Vim more useful. The table below lists all the
1760 options affected.
1761 The {?} column indicates when the options are affected:
1762 + Means that the option is set to the value given in {set value} when
1763 'compatible' is set.
1764 & Means that the option is set to the value given in {set value} when
1765 'compatible' is set AND is set to its Vim default value when
1766 'compatible' is unset.
1767 - Means the option is NOT changed when setting 'compatible' but IS
1768 set to its Vim default when 'compatible' is unset.
1769 The {effect} column summarises the change when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001770
Bram Moolenaar036986f2017-03-16 17:41:02 +01001771 option ? set value effect ~
Bram Moolenaar214641f2017-03-05 17:04:09 +01001772
1773 'allowrevins' + off no CTRL-_ command
1774 'antialias' + off don't use antialiased fonts
1775 'arabic' + off reset arabic-related options
1776 'arabicshape' + on correct character shapes
1777 'backspace' + "" normal backspace
1778 'backup' + off no backup file
1779 'backupcopy' & Unix: "yes" backup file is a copy
1780 else: "auto" copy or rename backup file
1781 'balloonexpr' + "" text to show in evaluation balloon
1782 'breakindent' + off don't indent when wrapping lines
1783 'cedit' - {unchanged} {set vim default only on resetting 'cp'}
1784 'cindent' + off no C code indentation
1785 'compatible' - {unchanged} {set vim default only on resetting 'cp'}
1786 'copyindent' + off don't copy indent structure
1787 'cpoptions' & (all flags) Vi-compatible flags
1788 'cscopepathcomp'+ 0 don't show directories in tags list
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01001789 'cscoperelative'+ off don't use basename of path as prefix
Bram Moolenaar214641f2017-03-05 17:04:09 +01001790 'cscopetag' + off don't use cscope for ":tag"
Bram Moolenaar036986f2017-03-16 17:41:02 +01001791 'cscopetagorder'+ 0 see |cscopetagorder|
Bram Moolenaar214641f2017-03-05 17:04:09 +01001792 'cscopeverbose' + off see |cscopeverbose|
1793 'delcombine' + off unicode: delete whole char combination
1794 'digraph' + off no digraphs
1795 'esckeys' & off no <Esc>-keys in Insert mode
1796 'expandtab' + off tabs not expanded to spaces
1797 'fileformats' & "" no automatic file format detection,
Bram Moolenaar6f345a12019-12-17 21:27:18 +01001798 "dos,unix" except for MS-Windows
Bram Moolenaar214641f2017-03-05 17:04:09 +01001799 'formatexpr' + "" use 'formatprg' for auto-formatting
1800 'formatoptions' & "vt" Vi compatible formatting
1801 'gdefault' + off no default 'g' flag for ":s"
1802 'history' & 0 no commandline history
1803 'hkmap' + off no Hebrew keyboard mapping
1804 'hkmapp' + off no phonetic Hebrew keyboard mapping
1805 'hlsearch' + off no highlighting of search matches
1806 'incsearch' + off no incremental searching
1807 'indentexpr' + "" no indenting by expression
1808 'insertmode' + off do not start in Insert mode
1809 'iskeyword' & "@,48-57,_" keywords contain alphanumeric
Bram Moolenaar071d4272004-06-13 20:20:40 +00001810 characters and '_'
Bram Moolenaar214641f2017-03-05 17:04:09 +01001811 'joinspaces' + on insert 2 spaces after period
1812 'modeline' & off no modelines
1813 'more' & off no pauses in listings
1814 'mzquantum' - {unchanged} {set vim default only on resetting 'cp'}
1815 'numberwidth' & 8 min number of columns for line number
1816 'preserveindent'+ off don't preserve current indent structure
1817 when changing it
1818 'revins' + off no reverse insert
1819 'ruler' + off no ruler
1820 'scrolljump' + 1 no jump scroll
1821 'scrolloff' + 0 no scroll offset
1822 'shelltemp' - {unchanged} {set vim default only on resetting 'cp'}
1823 'shiftround' + off indent not rounded to shiftwidth
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02001824 'shortmess' & "S" no shortening of messages
Bram Moolenaar214641f2017-03-05 17:04:09 +01001825 'showcmd' & off command characters not shown
1826 'showmode' & off current mode not shown
1827 'sidescrolloff' + 0 cursor moves to edge of screen in scroll
1828 'smartcase' + off no automatic ignore case switch
1829 'smartindent' + off no smart indentation
1830 'smarttab' + off no smart tab size
1831 'softtabstop' + 0 tabs are always 'tabstop' positions
1832 'startofline' + on goto startofline with some commands
1833 'tagcase' & "followic" 'ignorecase' when searching tags file
1834 'tagrelative' & off tag file names are not relative
1835 'termguicolors' + off don't use highlight-(guifg|guibg)
1836 'textauto' & off no automatic textmode detection
1837 'textwidth' + 0 no automatic line wrap
1838 'tildeop' + off tilde is not an operator
1839 'ttimeout' + off no terminal timeout
1840 'undofile' + off don't use an undo file
Bram Moolenaar036986f2017-03-16 17:41:02 +01001841 'viminfo' - {unchanged} {set Vim default only on resetting 'cp'}
Bram Moolenaar214641f2017-03-05 17:04:09 +01001842 'virtualedit' + "" cursor can only be placed on characters
1843 'whichwrap' & "" left-right movements don't wrap
1844 'wildchar' & CTRL-E only when the current value is <Tab>
Bram Moolenaar071d4272004-06-13 20:20:40 +00001845 use CTRL-E for cmdline completion
Bram Moolenaar214641f2017-03-05 17:04:09 +01001846 'writebackup' + on or off depends on the |+writebackup| feature
Bram Moolenaar071d4272004-06-13 20:20:40 +00001847
1848 *'complete'* *'cpt'* *E535*
1849'complete' 'cpt' string (default: ".,w,b,u,t,i")
1850 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001851 This option specifies how keyword completion |ins-completion| works
1852 when CTRL-P or CTRL-N are used. It is also used for whole-line
1853 completion |i_CTRL-X_CTRL-L|. It indicates the type of completion
1854 and the places to scan. It is a comma separated list of flags:
Bram Moolenaar3848e002016-03-19 18:42:29 +01001855 . scan the current buffer ('wrapscan' is ignored)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001856 w scan buffers from other windows
1857 b scan other loaded buffers that are in the buffer list
1858 u scan the unloaded buffers that are in the buffer list
1859 U scan the buffers that are not in the buffer list
1860 k scan the files given with the 'dictionary' option
Bram Moolenaar0b238792006-03-02 22:49:12 +00001861 kspell use the currently active spell checking |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001862 k{dict} scan the file {dict}. Several "k" flags can be given,
1863 patterns are valid too. For example: >
1864 :set cpt=k/usr/dict/*,k~/spanish
1865< s scan the files given with the 'thesaurus' option
1866 s{tsr} scan the file {tsr}. Several "s" flags can be given, patterns
1867 are valid too.
1868 i scan current and included files
1869 d scan current and included files for defined name or macro
1870 |i_CTRL-X_CTRL-D|
1871 ] tag completion
1872 t same as "]"
1873
1874 Unloaded buffers are not loaded, thus their autocmds |:autocmd| are
1875 not executed, this may lead to unexpected completions from some files
1876 (gzipped files for example). Unloaded buffers are not scanned for
1877 whole-line completion.
1878
1879 The default is ".,w,b,u,t,i", which means to scan:
1880 1. the current buffer
1881 2. buffers in other windows
1882 3. other loaded buffers
1883 4. unloaded buffers
1884 5. tags
1885 6. included files
1886
1887 As you can see, CTRL-N and CTRL-P can be used to do any 'iskeyword'-
Bram Moolenaar582fd852005-03-28 20:58:01 +00001888 based expansion (e.g., dictionary |i_CTRL-X_CTRL-K|, included patterns
1889 |i_CTRL-X_CTRL-I|, tags |i_CTRL-X_CTRL-]| and normal expansions).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001890
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001891 *'completefunc'* *'cfu'*
1892'completefunc' 'cfu' string (default: empty)
1893 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02001894 {not available when compiled without the |+eval|
Bram Moolenaare2c453d2019-08-21 14:37:09 +02001895 feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00001896 This option specifies a function to be used for Insert mode completion
1897 with CTRL-X CTRL-U. |i_CTRL-X_CTRL-U|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001898 See |complete-functions| for an explanation of how the function is
1899 invoked and what it should return.
Bram Moolenaar166af9b2010-11-16 20:34:40 +01001900 This option cannot be set from a |modeline| or in the |sandbox|, for
1901 security reasons.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00001902
Bram Moolenaarac3150d2019-07-28 16:36:39 +02001903 *'completeslash'* *'csl'*
1904'completeslash' 'csl' string (default: "")
1905 local to buffer
Bram Moolenaar2e693a82019-10-16 22:35:02 +02001906 {only for MS-Windows}
Bram Moolenaarac3150d2019-07-28 16:36:39 +02001907 When this option is set it overrules 'shellslash' for completion:
1908 - When this option is set to "slash", a forward slash is used for path
1909 completion in insert mode. This is useful when editing HTML tag, or
Bram Moolenaar6f345a12019-12-17 21:27:18 +01001910 Makefile with 'noshellslash' on MS-Windows.
Bram Moolenaarac3150d2019-07-28 16:36:39 +02001911 - When this option is set to "backslash", backslash is used. This is
Bram Moolenaar6f345a12019-12-17 21:27:18 +01001912 useful when editing a batch file with 'shellslash' set on MS-Windows.
Bram Moolenaarac3150d2019-07-28 16:36:39 +02001913 - When this option is empty, same character is used as for
1914 'shellslash'.
1915 For Insert mode completion the buffer-local value is used. For
1916 command line completion the global value is used.
1917
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001918 *'completeopt'* *'cot'*
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001919'completeopt' 'cot' string (default: "menu,preview")
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001920 global
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001921 A comma separated list of options for Insert mode completion
1922 |ins-completion|. The supported values are:
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001923
1924 menu Use a popup menu to show the possible completions. The
1925 menu is only shown when there is more than one match and
1926 sufficient colors are available. |ins-completion-menu|
1927
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001928 menuone Use the popup menu also when there is only one match.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00001929 Useful when there is additional information about the
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001930 match, e.g., what file it comes from.
1931
Bram Moolenaarc1e37902006-04-18 21:55:01 +00001932 longest Only insert the longest common text of the matches. If
1933 the menu is displayed you can use CTRL-L to add more
1934 characters. Whether case is ignored depends on the kind
1935 of completion. For buffer text the 'ignorecase' option is
1936 used.
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001937
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001938 preview Show extra information about the currently selected
Bram Moolenaar02467872007-05-06 13:22:01 +00001939 completion in the preview window. Only works in
1940 combination with "menu" or "menuone".
1941
Bram Moolenaar576a4a62019-08-18 15:25:17 +02001942 popup Show extra information about the currently selected
1943 completion in a popup window. Only works in combination
1944 with "menu" or "menuone". Overrides "preview".
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02001945 See |'completepopup'| for specifying properties.
Bram Moolenaar2e693a82019-10-16 22:35:02 +02001946 {only works when compiled with the |+textprop| feature}
Bram Moolenaar576a4a62019-08-18 15:25:17 +02001947
Bram Moolenaardca7abe2019-10-20 18:17:57 +02001948 popuphidden
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01001949 Just like "popup" but initially hide the popup. Use a
Bram Moolenaardca7abe2019-10-20 18:17:57 +02001950 |CompleteChanged| autocommand to fetch the info and call
1951 |popup_show()| once the popup has been filled.
1952 See the example at |complete-popuphidden|.
1953 {only works when compiled with the |+textprop| feature}
1954
Bram Moolenaarb6be1e22015-07-10 18:18:40 +02001955 noinsert Do not insert any text for a match until the user selects
1956 a match from the menu. Only works in combination with
1957 "menu" or "menuone". No effect if "longest" is present.
1958
1959 noselect Do not select a match in the menu, force the user to
1960 select one from the menu. Only works in combination with
1961 "menu" or "menuone".
1962
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001963
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02001964 *'completepopup'* *'cpp'*
1965'completepopup' 'cpp' string (default empty)
1966 global
1967 {not available when compiled without the |+textprop|
1968 or |+quickfix| feature}
1969 When 'completeopt' contains "popup" then this option is used for the
Bram Moolenaar447bfba2020-07-18 16:07:16 +02001970 properties of the info popup when it is created. If an info popup
1971 window already exists it is closed, so that the option value is
1972 applied when it is created again.
1973 You can also use |popup_findinfo()| and then set properties for an
1974 existing info popup with |popup_setoptions()|. See |complete-popup|.
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02001975
1976
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001977 *'concealcursor'* *'cocu'*
1978'concealcursor' 'cocu' string (default: "")
1979 local to window
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001980 {not available when compiled without the |+conceal|
1981 feature}
1982 Sets the modes in which text in the cursor line can also be concealed.
1983 When the current mode is listed then concealing happens just like in
1984 other lines.
1985 n Normal mode
1986 v Visual mode
1987 i Insert mode
Bram Moolenaarca8c9862010-07-24 15:00:38 +02001988 c Command line editing, for 'incsearch'
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001989
Bram Moolenaare6dc5732010-07-24 23:52:26 +02001990 'v' applies to all lines in the Visual area, not only the cursor.
Bram Moolenaarca8c9862010-07-24 15:00:38 +02001991 A useful value is "nc". This is used in help files. So long as you
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001992 are moving around text is concealed, but when starting to insert text
1993 or selecting a Visual area the concealed text is displayed, so that
1994 you can see what you are doing.
Bram Moolenaarf70e3d62010-07-24 13:15:07 +02001995 Keep in mind that the cursor position is not always where it's
1996 displayed. E.g., when moving vertically it may change column.
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001997
1998
Bram Moolenaar95bafa22018-10-02 13:26:25 +02001999 *'conceallevel'* *'cole'*
2000'conceallevel' 'cole' number (default 0)
Bram Moolenaar860cae12010-06-05 23:22:07 +02002001 local to window
Bram Moolenaar860cae12010-06-05 23:22:07 +02002002 {not available when compiled without the |+conceal|
2003 feature}
Bram Moolenaar6df6f472010-07-18 18:04:50 +02002004 Determine how text with the "conceal" syntax attribute |:syn-conceal|
2005 is shown:
Bram Moolenaar860cae12010-06-05 23:22:07 +02002006
Bram Moolenaar6df6f472010-07-18 18:04:50 +02002007 Value Effect ~
Bram Moolenaar860cae12010-06-05 23:22:07 +02002008 0 Text is shown normally
Bram Moolenaar477db062010-07-28 18:17:41 +02002009 1 Each block of concealed text is replaced with one
2010 character. If the syntax item does not have a custom
2011 replacement character defined (see |:syn-cchar|) the
2012 character defined in 'listchars' is used (default is a
2013 space).
2014 It is highlighted with the "Conceal" highlight group.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002015 2 Concealed text is completely hidden unless it has a
2016 custom replacement character defined (see
Bram Moolenaar477db062010-07-28 18:17:41 +02002017 |:syn-cchar|).
Bram Moolenaara7781e02010-07-19 20:13:22 +02002018 3 Concealed text is completely hidden.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002019
Bram Moolenaara7781e02010-07-19 20:13:22 +02002020 Note: in the cursor line concealed text is not hidden, so that you can
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002021 edit and copy the text. This can be changed with the 'concealcursor'
2022 option.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002023
Bram Moolenaar071d4272004-06-13 20:20:40 +00002024 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
2025'confirm' 'cf' boolean (default off)
2026 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002027 When 'confirm' is on, certain operations that would normally
2028 fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
2029 instead raise a |dialog| asking if you wish to save the current
2030 file(s). You can still use a ! to unconditionally |abandon| a buffer.
2031 If 'confirm' is off you can still activate confirmation for one
2032 command only (this is most useful in mappings) with the |:confirm|
2033 command.
2034 Also see the |confirm()| function and the 'v' flag in 'guioptions'.
2035
2036 *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
2037'conskey' 'consk' boolean (default off)
2038 global
Bram Moolenaarf3913272016-02-25 00:00:01 +01002039 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002040
2041 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
2042'copyindent' 'ci' boolean (default off)
2043 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002044 Copy the structure of the existing lines indent when autoindenting a
2045 new line. Normally the new indent is reconstructed by a series of
2046 tabs followed by spaces as required (unless |'expandtab'| is enabled,
2047 in which case only spaces are used). Enabling this option makes the
2048 new line copy whatever characters were used for indenting on the
Bram Moolenaar446cb832008-06-24 21:56:24 +00002049 existing line. 'expandtab' has no effect on these characters, a Tab
2050 remains a Tab. If the new indent is greater than on the existing
Bram Moolenaar071d4272004-06-13 20:20:40 +00002051 line, the remaining space is filled in the normal manner.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002052 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002053 Also see 'preserveindent'.
2054
Bram Moolenaare0fa3742016-02-20 15:47:01 +01002055 *'cpoptions'* *'cpo'* *cpo*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002056'cpoptions' 'cpo' string (Vim default: "aABceFs",
2057 Vi default: all flags)
2058 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002059 A sequence of single character flags. When a character is present
Bram Moolenaar7cba6c02013-09-05 22:13:31 +02002060 this indicates Vi-compatible behavior. This is used for things where
2061 not being Vi-compatible is mostly or sometimes preferred.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002062 'cpoptions' stands for "compatible-options".
2063 Commas can be added for readability.
2064 To avoid problems with flags that are added in the future, use the
2065 "+=" and "-=" feature of ":set" |add-option-flags|.
2066 NOTE: This option is set to the Vi default value when 'compatible' is
2067 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002068 NOTE: This option is set to the POSIX default value at startup when
2069 the Vi default value would be used and the $VIM_POSIX environment
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002070 variable exists |posix|. This means Vim tries to behave like the
2071 POSIX specification.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002072
2073 contains behavior ~
2074 *cpo-a*
2075 a When included, a ":read" command with a file name
2076 argument will set the alternate file name for the
2077 current window.
2078 *cpo-A*
2079 A When included, a ":write" command with a file name
2080 argument will set the alternate file name for the
2081 current window.
2082 *cpo-b*
2083 b "\|" in a ":map" command is recognized as the end of
2084 the map command. The '\' is included in the mapping,
2085 the text after the '|' is interpreted as the next
2086 command. Use a CTRL-V instead of a backslash to
2087 include the '|' in the mapping. Applies to all
2088 mapping, abbreviation, menu and autocmd commands.
2089 See also |map_bar|.
2090 *cpo-B*
2091 B A backslash has no special meaning in mappings,
Bram Moolenaara9604e62018-07-21 05:56:22 +02002092 abbreviations, user commands and the "to" part of the
2093 menu commands. Remove this flag to be able to use a
2094 backslash like a CTRL-V. For example, the command
2095 ":map X \<Esc>" results in X being mapped to:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002096 'B' included: "\^[" (^[ is a real <Esc>)
2097 'B' excluded: "<Esc>" (5 characters)
2098 ('<' excluded in both cases)
2099 *cpo-c*
2100 c Searching continues at the end of any match at the
2101 cursor position, but not further than the start of the
2102 next line. When not present searching continues
2103 one character from the cursor position. With 'c'
2104 "abababababab" only gets three matches when repeating
2105 "/abab", without 'c' there are five matches.
2106 *cpo-C*
2107 C Do not concatenate sourced lines that start with a
2108 backslash. See |line-continuation|.
2109 *cpo-d*
2110 d Using "./" in the 'tags' option doesn't mean to use
2111 the tags file relative to the current file, but the
2112 tags file in the current directory.
2113 *cpo-D*
2114 D Can't use CTRL-K to enter a digraph after Normal mode
2115 commands with a character argument, like |r|, |f| and
2116 |t|.
2117 *cpo-e*
2118 e When executing a register with ":@r", always add a
2119 <CR> to the last line, also when the register is not
2120 linewise. If this flag is not present, the register
2121 is not linewise and the last line does not end in a
2122 <CR>, then the last line is put on the command-line
2123 and can be edited before hitting <CR>.
2124 *cpo-E*
2125 E It is an error when using "y", "d", "c", "g~", "gu" or
2126 "gU" on an Empty region. The operators only work when
Bram Moolenaar15142e22018-04-30 22:19:58 +02002127 at least one character is to be operated on. Example:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002128 This makes "y0" fail in the first column.
2129 *cpo-f*
2130 f When included, a ":read" command with a file name
2131 argument will set the file name for the current buffer,
2132 if the current buffer doesn't have a file name yet.
2133 *cpo-F*
2134 F When included, a ":write" command with a file name
2135 argument will set the file name for the current
2136 buffer, if the current buffer doesn't have a file name
Bram Moolenaarb3480382005-12-11 21:33:32 +00002137 yet. Also see |cpo-P|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002138 *cpo-g*
2139 g Goto line 1 when using ":edit" without argument.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002140 *cpo-H*
2141 H When using "I" on a line with only blanks, insert
2142 before the last blank. Without this flag insert after
2143 the last blank.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002144 *cpo-i*
2145 i When included, interrupting the reading of a file will
2146 leave it modified.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002147 *cpo-I*
2148 I When moving the cursor up or down just after inserting
2149 indent for 'autoindent', do not delete the indent.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002150 *cpo-j*
2151 j When joining lines, only add two spaces after a '.',
2152 not after '!' or '?'. Also see 'joinspaces'.
2153 *cpo-J*
2154 J A |sentence| has to be followed by two spaces after
Bram Moolenaar582fd852005-03-28 20:58:01 +00002155 the '.', '!' or '?'. A <Tab> is not recognized as
Bram Moolenaar071d4272004-06-13 20:20:40 +00002156 white space.
2157 *cpo-k*
2158 k Disable the recognition of raw key codes in
2159 mappings, abbreviations, and the "to" part of menu
2160 commands. For example, if <Key> sends ^[OA (where ^[
2161 is <Esc>), the command ":map X ^[OA" results in X
2162 being mapped to:
2163 'k' included: "^[OA" (3 characters)
2164 'k' excluded: "<Key>" (one key code)
2165 Also see the '<' flag below.
2166 *cpo-K*
2167 K Don't wait for a key code to complete when it is
2168 halfway a mapping. This breaks mapping <F1><F1> when
2169 only part of the second <F1> has been read. It
2170 enables cancelling the mapping by typing <F1><Esc>.
2171 *cpo-l*
2172 l Backslash in a [] range in a search pattern is taken
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002173 literally, only "\]", "\^", "\-" and "\\" are special.
2174 See |/[]|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002175 'l' included: "/[ \t]" finds <Space>, '\' and 't'
2176 'l' excluded: "/[ \t]" finds <Space> and <Tab>
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002177 Also see |cpo-\|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002178 *cpo-L*
2179 L When the 'list' option is set, 'wrapmargin',
2180 'textwidth', 'softtabstop' and Virtual Replace mode
2181 (see |gR|) count a <Tab> as two characters, instead of
2182 the normal behavior of a <Tab>.
2183 *cpo-m*
2184 m When included, a showmatch will always wait half a
2185 second. When not included, a showmatch will wait half
2186 a second or until a character is typed. |'showmatch'|
2187 *cpo-M*
2188 M When excluded, "%" matching will take backslashes into
2189 account. Thus in "( \( )" and "\( ( \)" the outer
2190 parenthesis match. When included "%" ignores
2191 backslashes, which is Vi compatible.
2192 *cpo-n*
Bram Moolenaar64486672010-05-16 15:46:46 +02002193 n When included, the column used for 'number' and
2194 'relativenumber' will also be used for text of wrapped
2195 lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002196 *cpo-o*
2197 o Line offset to search command is not remembered for
2198 next search.
2199 *cpo-O*
2200 O Don't complain if a file is being overwritten, even
2201 when it didn't exist when editing it. This is a
2202 protection against a file unexpectedly created by
2203 someone else. Vi didn't complain about this.
2204 *cpo-p*
2205 p Vi compatible Lisp indenting. When not present, a
2206 slightly better algorithm is used.
Bram Moolenaarb3480382005-12-11 21:33:32 +00002207 *cpo-P*
2208 P When included, a ":write" command that appends to a
2209 file will set the file name for the current buffer, if
2210 the current buffer doesn't have a file name yet and
2211 the 'F' flag is also included |cpo-F|.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002212 *cpo-q*
2213 q When joining multiple lines leave the cursor at the
2214 position where it would be when joining two lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002215 *cpo-r*
2216 r Redo ("." command) uses "/" to repeat a search
2217 command, instead of the actually used search string.
2218 *cpo-R*
2219 R Remove marks from filtered lines. Without this flag
2220 marks are kept like |:keepmarks| was used.
2221 *cpo-s*
2222 s Set buffer options when entering the buffer for the
2223 first time. This is like it is in Vim version 3.0.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002224 And it is the default. If not present the options are
Bram Moolenaar071d4272004-06-13 20:20:40 +00002225 set when the buffer is created.
2226 *cpo-S*
2227 S Set buffer options always when entering a buffer
2228 (except 'readonly', 'fileformat', 'filetype' and
2229 'syntax'). This is the (most) Vi compatible setting.
2230 The options are set to the values in the current
2231 buffer. When you change an option and go to another
2232 buffer, the value is copied. Effectively makes the
2233 buffer options global to all buffers.
2234
2235 's' 'S' copy buffer options
2236 no no when buffer created
2237 yes no when buffer first entered (default)
2238 X yes each time when buffer entered (vi comp.)
2239 *cpo-t*
2240 t Search pattern for the tag command is remembered for
2241 "n" command. Otherwise Vim only puts the pattern in
2242 the history for search pattern, but doesn't change the
2243 last used search pattern.
2244 *cpo-u*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002245 u Undo is Vi compatible. See |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002246 *cpo-v*
2247 v Backspaced characters remain visible on the screen in
2248 Insert mode. Without this flag the characters are
2249 erased from the screen right away. With this flag the
2250 screen newly typed text overwrites backspaced
2251 characters.
2252 *cpo-w*
2253 w When using "cw" on a blank character, only change one
2254 character and not all blanks until the start of the
2255 next word.
2256 *cpo-W*
2257 W Don't overwrite a readonly file. When omitted, ":w!"
2258 overwrites a readonly file, if possible.
2259 *cpo-x*
2260 x <Esc> on the command-line executes the command-line.
2261 The default in Vim is to abandon the command-line,
2262 because <Esc> normally aborts a command. |c_<Esc>|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002263 *cpo-X*
2264 X When using a count with "R" the replaced text is
2265 deleted only once. Also when repeating "R" with "."
2266 and a count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002267 *cpo-y*
Bram Moolenaard09091d2019-01-17 16:07:22 +01002268 y A yank command can be redone with ".". Think twice if
2269 you really want to use this, it may break some
2270 plugins, since most people expect "." to only repeat a
2271 change.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002272 *cpo-Z*
2273 Z When using "w!" while the 'readonly' option is set,
2274 don't reset 'readonly'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002275 *cpo-!*
2276 ! When redoing a filter command, use the last used
2277 external command, whatever it was. Otherwise the last
2278 used -filter- command is used.
2279 *cpo-$*
2280 $ When making a change to one line, don't redisplay the
2281 line, but put a '$' at the end of the changed text.
2282 The changed text will be overwritten when you type the
2283 new text. The line is redisplayed if you type any
2284 command that moves the cursor from the insertion
2285 point.
2286 *cpo-%*
2287 % Vi-compatible matching is done for the "%" command.
2288 Does not recognize "#if", "#endif", etc.
2289 Does not recognize "/*" and "*/".
2290 Parens inside single and double quotes are also
2291 counted, causing a string that contains a paren to
2292 disturb the matching. For example, in a line like
2293 "if (strcmp("foo(", s))" the first paren does not
2294 match the last one. When this flag is not included,
2295 parens inside single and double quotes are treated
2296 specially. When matching a paren outside of quotes,
2297 everything inside quotes is ignored. When matching a
2298 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002299 there is one). This works very well for C programs.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002300 This flag is also used for other features, such as
2301 C-indenting.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002302 *cpo--*
2303 - When included, a vertical movement command fails when
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002304 it would go above the first line or below the last
2305 line. Without it the cursor moves to the first or
2306 last line, unless it already was in that line.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002307 Applies to the commands "-", "k", CTRL-P, "+", "j",
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002308 CTRL-N, CTRL-J and ":1234".
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002309 *cpo-+*
2310 + When included, a ":write file" command will reset the
2311 'modified' flag of the buffer, even though the buffer
2312 itself may still be different from its file.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002313 *cpo-star*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002314 * Use ":*" in the same way as ":@". When not included,
2315 ":*" is an alias for ":'<,'>", select the Visual area.
2316 *cpo-<*
2317 < Disable the recognition of special key codes in |<>|
2318 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002319 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00002320 ":map X <Tab>" results in X being mapped to:
2321 '<' included: "<Tab>" (5 characters)
2322 '<' excluded: "^I" (^I is a real <Tab>)
2323 Also see the 'k' flag above.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002324 *cpo->*
2325 > When appending to a register, put a line break before
2326 the appended text.
Bram Moolenaar8b3e0332011-06-26 05:36:34 +02002327 *cpo-;*
2328 ; When using |,| or |;| to repeat the last |t| search
2329 and the cursor is right in front of the searched
2330 character, the cursor won't move. When not included,
2331 the cursor would skip over it and jump to the
Bram Moolenaarc8734422012-06-01 22:38:45 +02002332 following occurrence.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002333
2334 POSIX flags. These are not included in the Vi default value, except
2335 when $VIM_POSIX was set on startup. |posix|
2336
2337 contains behavior ~
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002338 *cpo-#*
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002339 # A count before "D", "o" and "O" has no effect.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002340 *cpo-&*
2341 & When ":preserve" was used keep the swap file when
2342 exiting normally while this buffer is still loaded.
2343 This flag is tested when exiting.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002344 *cpo-\*
2345 \ Backslash in a [] range in a search pattern is taken
2346 literally, only "\]" is special See |/[]|
Bram Moolenaar90915b52005-08-21 22:17:52 +00002347 '\' included: "/[ \-]" finds <Space>, '\' and '-'
2348 '\' excluded: "/[ \-]" finds <Space> and '-'
2349 Also see |cpo-l|.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002350 *cpo-/*
2351 / When "%" is used as the replacement string in a |:s|
2352 command, use the previous replacement string. |:s%|
2353 *cpo-{*
2354 { The |{| and |}| commands also stop at a "{" character
2355 at the start of a line.
2356 *cpo-.*
2357 . The ":chdir" and ":cd" commands fail if the current
2358 buffer is modified, unless ! is used. Vim doesn't
2359 need this, since it remembers the full path of an
2360 opened file.
2361 *cpo-bar*
2362 | The value of the $LINES and $COLUMNS environment
2363 variables overrule the terminal size values obtained
2364 with system specific functions.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002365
Bram Moolenaar071d4272004-06-13 20:20:40 +00002366
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002367 *'cryptmethod'* *'cm'*
Bram Moolenaara86187b2018-12-16 18:20:00 +01002368'cryptmethod' 'cm' string (default "blowfish2")
Bram Moolenaar49771f42010-07-20 17:32:38 +02002369 global or local to buffer |global-local|
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002370 Method used for encryption when the buffer is written to a file:
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002371 *pkzip*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002372 zip PkZip compatible method. A weak kind of encryption.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002373 Backwards compatible with Vim 7.2 and older.
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002374 *blowfish*
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002375 blowfish Blowfish method. Medium strong encryption but it has
2376 an implementation flaw. Requires Vim 7.3 or later,
2377 files can NOT be read by Vim 7.2 and older. This adds
2378 a "seed" to the file, every time you write the file
2379 the encrypted bytes will be different.
2380 *blowfish2*
2381 blowfish2 Blowfish method. Medium strong encryption. Requires
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01002382 Vim 7.4.401 or later, files can NOT be read by Vim 7.3
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002383 and older. This adds a "seed" to the file, every time
2384 you write the file the encrypted bytes will be
2385 different. The whole undo file is encrypted, not just
2386 the pieces of text.
Christian Brabandtf573c6e2021-06-20 14:02:16 +02002387 *E1193* *E1194* *E1195* *E1196*
2388 *E1197* *E1198* *E1199* *E1200* *E1201*
2389 xchacha20 XChaCha20 Cipher with Poly1305 Message Authentication
2390 Code. Medium strong till strong encryption.
2391 Encryption is provided by the libsodium library, it
2392 requires Vim to be built with |+sodium|
2393 It adds a seed and a message authentication code (MAC)
2394 to the file. This needs at least a Vim 8.2.3022 to
2395 read the encrypted file.
2396 Encryption of swap files is not supported, therefore
2397 no swap file will be used when xchacha20 encryption is
2398 enabled.
2399 Encryption of undo files is not yet supported,
2400 therefore no undo file will currently be written.
2401 CURRENTLY EXPERIMENTAL: Files written with this method
2402 might have to be read back with the same version of
2403 Vim if the binary format changes later.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002404
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01002405 You should use "blowfish2", also to re-encrypt older files.
2406
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002407 When reading an encrypted file 'cryptmethod' will be set automatically
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002408 to the detected method of the file being read. Thus if you write it
2409 without changing 'cryptmethod' the same method will be used.
2410 Changing 'cryptmethod' does not mark the file as modified, you have to
Bram Moolenaar49771f42010-07-20 17:32:38 +02002411 explicitly write it, you don't get a warning unless there are other
2412 modifications. Also see |:X|.
2413
2414 When setting the global value to an empty string, it will end up with
Bram Moolenaara86187b2018-12-16 18:20:00 +01002415 the value "blowfish2". When setting the local value to an empty
2416 string the buffer will use the global value.
Bram Moolenaar49771f42010-07-20 17:32:38 +02002417
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002418 When a new encryption method is added in a later version of Vim, and
2419 the current version does not recognize it, you will get *E821* .
Bram Moolenaar49771f42010-07-20 17:32:38 +02002420 You need to edit this file with the later version of Vim.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002421
2422
Bram Moolenaar071d4272004-06-13 20:20:40 +00002423 *'cscopepathcomp'* *'cspc'*
2424'cscopepathcomp' 'cspc' number (default 0)
2425 global
2426 {not available when compiled without the |+cscope|
2427 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002428 Determines how many components of the path to show in a list of tags.
2429 See |cscopepathcomp|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002430 NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002431
2432 *'cscopeprg'* *'csprg'*
2433'cscopeprg' 'csprg' string (default "cscope")
2434 global
2435 {not available when compiled without the |+cscope|
2436 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002437 Specifies the command to execute cscope. See |cscopeprg|.
2438 This option cannot be set from a |modeline| or in the |sandbox|, for
2439 security reasons.
2440
2441 *'cscopequickfix'* *'csqf'*
2442'cscopequickfix' 'csqf' string (default "")
2443 global
2444 {not available when compiled without the |+cscope|
2445 or |+quickfix| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002446 Specifies whether to use quickfix window to show cscope results.
2447 See |cscopequickfix|.
2448
Bram Moolenaarec7944a2013-06-12 21:29:15 +02002449 *'cscoperelative'* *'csre'* *'nocscoperelative'* *'nocsre'*
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002450'cscoperelative' 'csre' boolean (default off)
2451 global
2452 {not available when compiled without the |+cscope|
2453 feature}
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002454 In the absence of a prefix (-P) for cscope. setting this option enables
2455 to use the basename of cscope.out path as the prefix.
2456 See |cscoperelative|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002457 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002458
Bram Moolenaar071d4272004-06-13 20:20:40 +00002459 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
2460'cscopetag' 'cst' boolean (default off)
2461 global
2462 {not available when compiled without the |+cscope|
2463 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002464 Use cscope for tag commands. See |cscope-options|.
2465 NOTE: This option is reset when 'compatible' is set.
2466
2467 *'cscopetagorder'* *'csto'*
2468'cscopetagorder' 'csto' number (default 0)
2469 global
2470 {not available when compiled without the |+cscope|
2471 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002472 Determines the order in which ":cstag" performs a search. See
2473 |cscopetagorder|.
2474 NOTE: This option is set to 0 when 'compatible' is set.
2475
2476 *'cscopeverbose'* *'csverb'*
2477 *'nocscopeverbose'* *'nocsverb'*
2478'cscopeverbose' 'csverb' boolean (default off)
2479 global
2480 {not available when compiled without the |+cscope|
2481 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002482 Give messages when adding a cscope database. See |cscopeverbose|.
2483 NOTE: This option is reset when 'compatible' is set.
2484
Bram Moolenaar860cae12010-06-05 23:22:07 +02002485 *'cursorbind'* *'crb'* *'nocursorbind'* *'nocrb'*
2486'cursorbind' 'crb' boolean (default off)
2487 local to window
Bram Moolenaar860cae12010-06-05 23:22:07 +02002488 When this option is set, as the cursor in the current
2489 window moves other cursorbound windows (windows that also have
2490 this option set) move their cursors to the corresponding line and
2491 column. This option is useful for viewing the
2492 differences between two versions of a file (see 'diff'); in diff mode,
2493 inserted and deleted lines (though not characters within a line) are
Bram Moolenaar1a384422010-07-14 19:53:30 +02002494 taken into account.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002495
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002496
2497 *'cursorcolumn'* *'cuc'* *'nocursorcolumn'* *'nocuc'*
2498'cursorcolumn' 'cuc' boolean (default off)
2499 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02002500 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002501 feature}
2502 Highlight the screen column of the cursor with CursorColumn
2503 |hl-CursorColumn|. Useful to align text. Will make screen redrawing
2504 slower.
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00002505 If you only want the highlighting in the current window you can use
2506 these autocommands: >
2507 au WinLeave * set nocursorline nocursorcolumn
2508 au WinEnter * set cursorline cursorcolumn
2509<
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002510
2511 *'cursorline'* *'cul'* *'nocursorline'* *'nocul'*
2512'cursorline' 'cul' boolean (default off)
2513 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02002514 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002515 feature}
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002516 Highlight the text line of the cursor with CursorLine |hl-CursorLine|.
2517 Useful to easily spot the cursor. Will make screen redrawing slower.
Bram Moolenaare2f98b92006-03-29 21:18:24 +00002518 When Visual mode is active the highlighting isn't used to make it
Bram Moolenaar779b74b2006-04-10 14:55:34 +00002519 easier to see the selected text.
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002520
2521
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002522 *'cursorlineopt'* *'culopt'*
Bram Moolenaar017ba072019-09-14 21:01:23 +02002523'cursorlineopt' 'culopt' string (default: "number,line")
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002524 local to window
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002525 {not available when compiled without the |+syntax|
2526 feature}
Bram Moolenaar017ba072019-09-14 21:01:23 +02002527 Comma separated list of settings for how 'cursorline' is displayed.
2528 Valid values:
2529 "line" Highlight the text line of the cursor with
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002530 CursorLine |hl-CursorLine|.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002531 "screenline" Highlight only the screen line of the cursor with
2532 CursorLine |hl-CursorLine|.
2533 "number" Highlight the line number of the cursor with
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002534 CursorLineNr |hl-CursorLineNr|.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002535
2536 Special value:
2537 "both" Alias for the values "line,number".
2538
2539 "line" and "screenline" cannot be used together.
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002540
2541
Bram Moolenaar071d4272004-06-13 20:20:40 +00002542 *'debug'*
2543'debug' string (default "")
2544 global
Bram Moolenaar57657d82006-04-21 22:12:41 +00002545 These values can be used:
2546 msg Error messages that would otherwise be omitted will be given
2547 anyway.
2548 throw Error messages that would otherwise be omitted will be given
2549 anyway and also throw an exception and set |v:errmsg|.
2550 beep A message will be given when otherwise only a beep would be
2551 produced.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002552 The values can be combined, separated by a comma.
Bram Moolenaar57657d82006-04-21 22:12:41 +00002553 "msg" and "throw" are useful for debugging 'foldexpr', 'formatexpr' or
2554 'indentexpr'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002555
2556 *'define'* *'def'*
2557'define' 'def' string (default "^\s*#\s*define")
2558 global or local to buffer |global-local|
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002559 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002560 pattern, just like for the "/" command. This option is used for the
2561 commands like "[i" and "[d" |include-search|. The 'isident' option is
2562 used to recognize the defined name after the match:
2563 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2564 See |option-backslash| about inserting backslashes to include a space
2565 or backslash.
2566 The default value is for C programs. For C++ this value would be
2567 useful, to include const type declarations: >
2568 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
Bram Moolenaar63b74a82019-03-24 15:09:13 +01002569< You can also use "\ze" just before the name and continue the pattern
2570 to check what is following. E.g. for Javascript, if a function is
2571 defined with "func_name = function(args)": >
2572 ^\s*\ze\i\+\s*=\s*function(
2573< If the function is defined with "func_name : function() {...": >
2574 ^\s*\ze\i\+\s*[:]\s*(*function\s*(
Bram Moolenaar071d4272004-06-13 20:20:40 +00002575< When using the ":set" command, you need to double the backslashes!
Bram Moolenaar63b74a82019-03-24 15:09:13 +01002576 To avoid that use `:let` with a single quote string: >
2577 let &l:define = '^\s*\ze\k\+\s*=\s*function('
Bram Moolenaar911ead12019-04-21 00:03:35 +02002578<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002579
2580 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2581'delcombine' 'deco' boolean (default off)
2582 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002583 If editing Unicode and this option is set, backspace and Normal mode
2584 "x" delete each combining character on its own. When it is off (the
2585 default) the character along with its combining characters are
2586 deleted.
Bram Moolenaar4f4d51a2020-10-11 13:57:40 +02002587 Note: When 'delcombine' is set "xx" may work differently from "2x"!
Bram Moolenaar071d4272004-06-13 20:20:40 +00002588
2589 This is useful for Arabic, Hebrew and many other languages where one
2590 may have combining characters overtop of base characters, and want
2591 to remove only the combining ones.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002592 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002593
2594 *'dictionary'* *'dict'*
2595'dictionary' 'dict' string (default "")
2596 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002597 List of file names, separated by commas, that are used to lookup words
2598 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2599 contain a list of words. This can be one word per line, or several
2600 words per line, separated by non-keyword characters (white space is
2601 preferred). Maximum line length is 510 bytes.
Bram Moolenaar259f26a2018-05-15 22:25:40 +02002602
2603 When this option is empty or an entry "spell" is present, and spell
2604 checking is enabled, words in the word lists for the currently active
2605 'spelllang' are used. See |spell|.
2606
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002607 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002608 after a comma are ignored, otherwise spaces are included in the file
2609 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002610 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002611 Where to find a list of words?
2612 - On FreeBSD, there is the file "/usr/share/dict/words".
2613 - In the Simtel archive, look in the "msdos/linguist" directory.
2614 - In "miscfiles" of the GNU collection.
2615 The use of |:set+=| and |:set-=| is preferred when adding or removing
2616 directories from the list. This avoids problems when a future version
2617 uses another default.
2618 Backticks cannot be used in this option for security reasons.
2619
2620 *'diff'* *'nodiff'*
2621'diff' boolean (default off)
2622 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00002623 {not available when compiled without the |+diff|
2624 feature}
2625 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002626 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002627
2628 *'dex'* *'diffexpr'*
2629'diffexpr' 'dex' string (default "")
2630 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002631 {not available when compiled without the |+diff|
2632 feature}
Bram Moolenaare828b762018-09-10 17:51:58 +02002633 Expression which is evaluated to obtain a diff file (either ed-style
2634 or unified-style) from two versions of a file. See |diff-diffexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002635 This option cannot be set from a |modeline| or in the |sandbox|, for
2636 security reasons.
2637
2638 *'dip'* *'diffopt'*
Bram Moolenaarc8234772019-11-10 21:00:27 +01002639'diffopt' 'dip' string (default "internal,filler,closeoff")
Bram Moolenaar071d4272004-06-13 20:20:40 +00002640 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002641 {not available when compiled without the |+diff|
2642 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002643 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002644 All are optional. Items must be separated by a comma.
2645
2646 filler Show filler lines, to keep the text
2647 synchronized with a window that has inserted
2648 lines at the same position. Mostly useful
2649 when windows are side-by-side and 'scrollbind'
2650 is set.
2651
2652 context:{n} Use a context of {n} lines between a change
2653 and a fold that contains unchanged lines.
2654 When omitted a context of six lines is used.
Bram Moolenaarf6b40102019-02-22 15:24:03 +01002655 When using zero the context is actually one,
2656 since folds require a line in between, also
2657 for a deleted line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002658 See |fold-diff|.
2659
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002660 iblank Ignore changes where lines are all blank. Adds
2661 the "-B" flag to the "diff" command if
2662 'diffexpr' is empty. Check the documentation
2663 of the "diff" command for what this does
2664 exactly.
2665 NOTE: the diff windows will get out of sync,
2666 because no differences between blank lines are
2667 taken into account.
2668
Bram Moolenaar071d4272004-06-13 20:20:40 +00002669 icase Ignore changes in case of text. "a" and "A"
2670 are considered the same. Adds the "-i" flag
2671 to the "diff" command if 'diffexpr' is empty.
2672
2673 iwhite Ignore changes in amount of white space. Adds
2674 the "-b" flag to the "diff" command if
2675 'diffexpr' is empty. Check the documentation
2676 of the "diff" command for what this does
2677 exactly. It should ignore adding trailing
2678 white space, but not leading white space.
2679
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002680 iwhiteall Ignore all white space changes. Adds
2681 the "-w" flag to the "diff" command if
2682 'diffexpr' is empty. Check the documentation
2683 of the "diff" command for what this does
2684 exactly.
2685
2686 iwhiteeol Ignore white space changes at end of line.
2687 Adds the "-Z" flag to the "diff" command if
2688 'diffexpr' is empty. Check the documentation
2689 of the "diff" command for what this does
2690 exactly.
2691
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002692 horizontal Start diff mode with horizontal splits (unless
2693 explicitly specified otherwise).
2694
2695 vertical Start diff mode with vertical splits (unless
2696 explicitly specified otherwise).
2697
Bram Moolenaarc8234772019-11-10 21:00:27 +01002698 closeoff When a window is closed where 'diff' is set
2699 and there is only one window remaining in the
2700 same tab page with 'diff' set, execute
2701 `:diffoff` in that window. This undoes a
2702 `:diffsplit` command.
2703
Bram Moolenaar97ce4192017-12-01 20:35:58 +01002704 hiddenoff Do not use diff mode for a buffer when it
2705 becomes hidden.
2706
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002707 foldcolumn:{n} Set the 'foldcolumn' option to {n} when
2708 starting diff mode. Without this 2 is used.
2709
Bram Moolenaar4223d432021-02-10 13:18:17 +01002710 followwrap Follow the 'wrap' option and leave as it is.
2711
Bram Moolenaare828b762018-09-10 17:51:58 +02002712 internal Use the internal diff library. This is
2713 ignored when 'diffexpr' is set. *E960*
2714 When running out of memory when writing a
2715 buffer this item will be ignored for diffs
2716 involving that buffer. Set the 'verbose'
2717 option to see when this happens.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002718
Bram Moolenaare828b762018-09-10 17:51:58 +02002719 indent-heuristic
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01002720 Use the indent heuristic for the internal
2721 diff library.
Bram Moolenaare828b762018-09-10 17:51:58 +02002722
2723 algorithm:{text} Use the specified diff algorithm with the
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01002724 internal diff engine. Currently supported
Bram Moolenaare828b762018-09-10 17:51:58 +02002725 algorithms are:
2726 myers the default algorithm
2727 minimal spend extra time to generate the
2728 smallest possible diff
2729 patience patience diff algorithm
2730 histogram histogram diff algorithm
2731
2732 Examples: >
2733 :set diffopt=internal,filler,context:4
Bram Moolenaar071d4272004-06-13 20:20:40 +00002734 :set diffopt=
Bram Moolenaare828b762018-09-10 17:51:58 +02002735 :set diffopt=internal,filler,foldcolumn:3
2736 :set diffopt-=internal " do NOT use the internal diff parser
Bram Moolenaar071d4272004-06-13 20:20:40 +00002737<
2738 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
2739'digraph' 'dg' boolean (default off)
2740 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002741 {not available when compiled without the |+digraphs|
2742 feature}
2743 Enable the entering of digraphs in Insert mode with {char1} <BS>
2744 {char2}. See |digraphs|.
2745 NOTE: This option is reset when 'compatible' is set.
2746
2747 *'directory'* *'dir'*
2748'directory' 'dir' string (default for Amiga: ".,t:",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01002749 for Win32: ".,$TEMP,c:\tmp,c:\temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00002750 for Unix: ".,~/tmp,/var/tmp,/tmp")
2751 global
2752 List of directory names for the swap file, separated with commas.
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02002753 Recommended value: ".,~/vimswap//" - this will put the swap file next
2754 to the edited file if possible, and in your personal swap directory
2755 otherwise. Make sure "~/vimswap//" is only readable for you.
2756
2757 Possible items:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002758 - The swap file will be created in the first directory where this is
2759 possible.
2760 - Empty means that no swap file will be used (recovery is
Bram Moolenaar00e192b2019-10-19 17:01:28 +02002761 impossible!) and no |E303| error will be given.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002762 - A directory "." means to put the swap file in the same directory as
2763 the edited file. On Unix, a dot is prepended to the file name, so
2764 it doesn't show in a directory listing. On MS-Windows the "hidden"
2765 attribute is set and a dot prepended if possible.
Bram Moolenaar8024f932020-01-14 19:29:13 +01002766 - A directory starting with "./" (or ".\" for MS-Windows) means to put
2767 the swap file relative to where the edited file is. The leading "."
2768 is replaced with the path name of the edited file.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02002769 - For Unix and Win32, if a directory ends in two path separators "//",
2770 the swap file name will be built from the complete path to the file
Bram Moolenaar207f0092020-08-30 17:20:20 +02002771 with all path separators replaced by percent '%' signs (including
2772 the colon following the drive letter on Win32). This will ensure
2773 file name uniqueness in the preserve directory.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02002774 On Win32, it is also possible to end with "\\". However, When a
2775 separating comma is following, you must use "//", since "\\" will
2776 include the comma in the file name. Therefore it is recommended to
2777 use '//', instead of '\\'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002778 - Spaces after the comma are ignored, other spaces are considered part
2779 of the directory name. To have a space at the start of a directory
2780 name, precede it with a backslash.
2781 - To include a comma in a directory name precede it with a backslash.
2782 - A directory name may end in an ':' or '/'.
2783 - Environment variables are expanded |:set_env|.
2784 - Careful with '\' characters, type one before a space, type two to
2785 get one in the option (see |option-backslash|), for example: >
2786 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
2787< - For backwards compatibility with Vim version 3.0 a '>' at the start
2788 of the option is removed.
2789 Using "." first in the list is recommended. This means that editing
2790 the same file twice will result in a warning. Using "/tmp" on Unix is
2791 discouraged: When the system crashes you lose the swap file.
2792 "/var/tmp" is often not cleared when rebooting, thus is a better
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02002793 choice than "/tmp". But others on the computer may be able to see the
2794 files, and it can contain a lot of files, your swap files get lost in
2795 the crowd. That is why a "tmp" directory in your home directory is
2796 tried first.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002797 The use of |:set+=| and |:set-=| is preferred when adding or removing
2798 directories from the list. This avoids problems when a future version
2799 uses another default.
2800 This option cannot be set from a |modeline| or in the |sandbox|, for
2801 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002802
2803 *'display'* *'dy'*
Bram Moolenaarbc8801c2016-08-02 21:04:33 +02002804'display' 'dy' string (default "", set to "truncate" in
2805 |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002806 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002807 Change the way text is displayed. This is comma separated list of
2808 flags:
2809 lastline When included, as much as possible of the last line
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02002810 in a window will be displayed. "@@@" is put in the
2811 last columns of the last screen line to indicate the
2812 rest of the line is not displayed.
2813 truncate Like "lastline", but "@@@" is displayed in the first
2814 column of the last screen line. Overrules "lastline".
Bram Moolenaar071d4272004-06-13 20:20:40 +00002815 uhex Show unprintable characters hexadecimal as <xx>
2816 instead of using ^C and ~C.
2817
Bram Moolenaard0796902016-09-16 20:02:31 +02002818 When neither "lastline" nor "truncate" is included, a last line that
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02002819 doesn't fit is replaced with "@" lines.
2820
Bram Moolenaar071d4272004-06-13 20:20:40 +00002821 *'eadirection'* *'ead'*
2822'eadirection' 'ead' string (default "both")
2823 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002824 Tells when the 'equalalways' option applies:
2825 ver vertically, width of windows is not affected
2826 hor horizontally, height of windows is not affected
2827 both width and height of windows is affected
2828
2829 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
2830'edcompatible' 'ed' boolean (default off)
2831 global
2832 Makes the 'g' and 'c' flags of the ":substitute" command to be
2833 toggled each time the flag is given. See |complex-change|. See
2834 also 'gdefault' option.
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +02002835 Switching this option on may break plugins!
Bram Moolenaar4072ba52020-12-23 13:56:35 +01002836 This option is not used in |Vim9| script.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002837
Bram Moolenaar03413f42016-04-12 21:07:15 +02002838 *'emoji'* *'emo'* *'noemoji'* *'noemo'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01002839'emoji' 'emo' boolean (default: on)
2840 global
Bram Moolenaar3848e002016-03-19 18:42:29 +01002841 When on all Unicode emoji characters are considered to be full width.
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02002842 This excludes "text emoji" characters, which are normally displayed as
2843 single width. Unfortunately there is no good specification for this
2844 and it has been determined on trial-and-error basis. Use the
2845 |setcellwidths()| function to change the behavior.
Bram Moolenaar3848e002016-03-19 18:42:29 +01002846
Bram Moolenaar071d4272004-06-13 20:20:40 +00002847 *'encoding'* *'enc'* *E543*
K.Takataf883d902021-05-30 18:04:19 +02002848'encoding' 'enc' string (default for MS-Windows: "utf-8",
2849 otherwise: value from $LANG or "latin1")
Bram Moolenaar071d4272004-06-13 20:20:40 +00002850 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002851 Sets the character encoding used inside Vim. It applies to text in
2852 the buffers, registers, Strings in expressions, text stored in the
2853 viminfo file, etc. It sets the kind of characters which Vim can work
2854 with. See |encoding-names| for the possible values.
2855
2856 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002857 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002858 It should normally be kept at its default value, or set when Vim
Bram Moolenaar02467872007-05-06 13:22:01 +00002859 starts up. See |multibyte|. To reload the menus see |:menutrans|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002860
Bram Moolenaar865242e2010-07-14 21:12:05 +02002861 This option cannot be set from a |modeline|. It would most likely
2862 corrupt the text.
2863
Bram Moolenaar3df01732017-02-17 22:47:16 +01002864 NOTE: For GTK+ 2 or later, it is highly recommended to set 'encoding'
2865 to "utf-8". Although care has been taken to allow different values of
Bram Moolenaar071d4272004-06-13 20:20:40 +00002866 'encoding', "utf-8" is the natural choice for the environment and
2867 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002868 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00002869 versions, and to avoid changing the encoding of newly created files
2870 without your knowledge (in case 'fileencodings' is empty).
2871
2872 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002873 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00002874 iconv() or as specified with 'charconvert'.
2875
Bram Moolenaar207f0092020-08-30 17:20:20 +02002876 If you need to know whether 'encoding' is a multibyte encoding, you
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002877 can use: >
2878 if has("multi_byte_encoding")
2879<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002880 Normally 'encoding' will be equal to your current locale. This will
2881 be the default if Vim recognizes your environment settings. If
2882 'encoding' is not set to the current locale, 'termencoding' must be
2883 set to convert typed and displayed text. See |encoding-table|.
2884
2885 When you set this option, it fires the |EncodingChanged| autocommand
2886 event so that you can set up fonts if necessary.
2887
2888 When the option is set, the value is converted to lowercase. Thus
2889 you can set it with uppercase values too. Underscores are translated
2890 to '-' signs.
2891 When the encoding is recognized, it is changed to the standard name.
2892 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
2893 "iso-8859-2" and "utf8" becomes "utf-8".
2894
2895 Note: "latin1" is also used when the encoding could not be detected.
2896 This only works when editing files in the same encoding! When the
2897 actual character set is not latin1, make sure 'fileencoding' and
2898 'fileencodings' are empty. When conversion is needed, switch to using
2899 utf-8.
2900
2901 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
2902 You don't notice this while editing, but it does matter for the
2903 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
2904 setting 'encoding' to one of these values instead of utf-8 only has
2905 effect for encoding used for files when 'fileencoding' is empty.
2906
Bram Moolenaar661b1822005-07-28 22:36:45 +00002907 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
2908 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002909
2910 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
2911'endofline' 'eol' boolean (default on)
2912 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002913 When writing a file and this option is off and the 'binary' option
Bram Moolenaar34d72d42015-07-17 14:18:08 +02002914 is on, or 'fixeol' option is off, no <EOL> will be written for the
2915 last line in the file. This option is automatically set or reset when
2916 starting to edit a new file, depending on whether file has an <EOL>
2917 for the last line in the file. Normally you don't have to set or
2918 reset this option.
2919 When 'binary' is off and 'fixeol' is on the value is not used when
2920 writing the file. When 'binary' is on or 'fixeol' is off it is used
2921 to remember the presence of a <EOL> for the last line in the file, so
2922 that when you write the file the situation from the original file can
2923 be kept. But you can change it if you want to.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002924
2925 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
2926'equalalways' 'ea' boolean (default on)
2927 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002928 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00002929 splitting or closing a window. This also happens the moment the
2930 option is switched on. When off, splitting a window will reduce the
2931 size of the current window and leave the other windows the same. When
2932 closing a window the extra lines are given to the window next to it
2933 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00002934 When mixing vertically and horizontally split windows, a minimal size
2935 is computed and some windows may be larger if there is room. The
2936 'eadirection' option tells in which direction the size is affected.
Bram Moolenaar67f71312007-08-12 14:55:56 +00002937 Changing the height and width of a window can be avoided by setting
2938 'winfixheight' and 'winfixwidth', respectively.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002939 If a window size is specified when creating a new window sizes are
2940 currently not equalized (it's complicated, but may be implemented in
2941 the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002942
2943 *'equalprg'* *'ep'*
2944'equalprg' 'ep' string (default "")
2945 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002946 External program to use for "=" command. When this option is empty
Bram Moolenaar446cb832008-06-24 21:56:24 +00002947 the internal formatting functions are used; either 'lisp', 'cindent'
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002948 or 'indentexpr'. When Vim was compiled without internal formatting,
2949 the "indent" program is used.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002950 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002951 about including spaces and backslashes.
2952 This option cannot be set from a |modeline| or in the |sandbox|, for
2953 security reasons.
2954
2955 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
2956'errorbells' 'eb' boolean (default off)
2957 global
2958 Ring the bell (beep or screen flash) for error messages. This only
2959 makes a difference for error messages, the bell will be used always
2960 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002961 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar165bc692015-07-21 17:53:25 +02002962 screen flash or do nothing. See 'belloff' to finetune when to ring the
2963 bell.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002964
2965 *'errorfile'* *'ef'*
2966'errorfile' 'ef' string (Amiga default: "AztecC.Err",
2967 others: "errors.err")
2968 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002969 {not available when compiled without the |+quickfix|
2970 feature}
2971 Name of the errorfile for the QuickFix mode (see |:cf|).
2972 When the "-q" command-line argument is used, 'errorfile' is set to the
2973 following argument. See |-q|.
2974 NOT used for the ":make" command. See 'makeef' for that.
2975 Environment variables are expanded |:set_env|.
2976 See |option-backslash| about including spaces and backslashes.
2977 This option cannot be set from a |modeline| or in the |sandbox|, for
2978 security reasons.
2979
2980 *'errorformat'* *'efm'*
2981'errorformat' 'efm' string (default is very long)
2982 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002983 {not available when compiled without the |+quickfix|
2984 feature}
2985 Scanf-like description of the format for the lines in the error file
2986 (see |errorformat|).
2987
2988 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
2989'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
2990 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002991 Function keys that start with an <Esc> are recognized in Insert
2992 mode. When this option is off, the cursor and function keys cannot be
2993 used in Insert mode if they start with an <Esc>. The advantage of
2994 this is that the single <Esc> is recognized immediately, instead of
2995 after one second. Instead of resetting this option, you might want to
2996 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
2997 when 'esckeys' is off, you can still map anything, but the cursor keys
2998 won't work by default.
2999 NOTE: This option is set to the Vi default value when 'compatible' is
3000 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaarc8234772019-11-10 21:00:27 +01003001 NOTE: when this option is off then the |modifyOtherKeys| functionality
3002 is disabled while in Insert mode to avoid ending Insert mode with any
3003 key that has a modifier.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003004
3005 *'eventignore'* *'ei'*
3006'eventignore' 'ei' string (default "")
3007 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003008 A list of autocommand event names, which are to be ignored.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00003009 When set to "all" or when "all" is one of the items, all autocommand
3010 events are ignored, autocommands will not be executed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003011 Otherwise this is a comma separated list of event names. Example: >
3012 :set ei=WinEnter,WinLeave
3013<
3014 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
3015'expandtab' 'et' boolean (default off)
3016 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003017 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003018 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00003019 when 'autoindent' is on. To insert a real tab when 'expandtab' is
3020 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
Bram Moolenaarca635012015-09-25 20:34:21 +02003021 This option is reset when the 'paste' option is set and restored when
3022 the 'paste' option is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003023 NOTE: This option is reset when 'compatible' is set.
3024
3025 *'exrc'* *'ex'* *'noexrc'* *'noex'*
3026'exrc' 'ex' boolean (default off)
3027 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003028 Enables the reading of .vimrc, .exrc and .gvimrc in the current
Bram Moolenaar36f44c22016-08-28 18:17:20 +02003029 directory.
3030
3031 Setting this option is a potential security leak. E.g., consider
3032 unpacking a package or fetching files from github, a .vimrc in there
3033 might be a trojan horse. BETTER NOT SET THIS OPTION!
3034 Instead, define an autocommand in your .vimrc to set options for a
3035 matching directory.
3036
3037 If you do switch this option on you should also consider setting the
3038 'secure' option (see |initialization|).
3039 Also see |.vimrc| and |gui-init|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003040 This option cannot be set from a |modeline| or in the |sandbox|, for
3041 security reasons.
3042
3043 *'fileencoding'* *'fenc'* *E213*
3044'fileencoding' 'fenc' string (default: "")
3045 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003046 Sets the character encoding for the file of this buffer.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003047
Bram Moolenaar071d4272004-06-13 20:20:40 +00003048 When 'fileencoding' is different from 'encoding', conversion will be
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003049 done when writing the file. For reading see below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003050 When 'fileencoding' is empty, the same value as 'encoding' will be
3051 used (no conversion when reading or writing a file).
Bram Moolenaar214641f2017-03-05 17:04:09 +01003052 No error will be given when the value is set, only when it is used,
3053 only when writing a file.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003054 Conversion will also be done when 'encoding' and 'fileencoding' are
3055 both a Unicode encoding and 'fileencoding' is not utf-8. That's
3056 because internally Unicode is always stored as utf-8.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003057 WARNING: Conversion can cause loss of information! When
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003058 'encoding' is "utf-8" or another Unicode encoding, conversion
3059 is most likely done in a way that the reverse conversion
3060 results in the same text. When 'encoding' is not "utf-8" some
3061 characters may be lost!
Bram Moolenaar865242e2010-07-14 21:12:05 +02003062
Bram Moolenaar071d4272004-06-13 20:20:40 +00003063 See 'encoding' for the possible values. Additionally, values may be
3064 specified that can be handled by the converter, see
3065 |mbyte-conversion|.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003066
Bram Moolenaar071d4272004-06-13 20:20:40 +00003067 When reading a file 'fileencoding' will be set from 'fileencodings'.
3068 To read a file in a certain encoding it won't work by setting
Bram Moolenaar02467872007-05-06 13:22:01 +00003069 'fileencoding', use the |++enc| argument. One exception: when
3070 'fileencodings' is empty the value of 'fileencoding' is used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003071 For a new file the global value of 'fileencoding' is used.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003072
Bram Moolenaar071d4272004-06-13 20:20:40 +00003073 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
3074 When the option is set, the value is converted to lowercase. Thus
3075 you can set it with uppercase values too. '_' characters are
3076 replaced with '-'. If a name is recognized from the list for
3077 'encoding', it is replaced by the standard name. For example
3078 "ISO8859-2" becomes "iso-8859-2".
Bram Moolenaar865242e2010-07-14 21:12:05 +02003079
Bram Moolenaar071d4272004-06-13 20:20:40 +00003080 When this option is set, after starting to edit a file, the 'modified'
3081 option is set, because the file would be different when written.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003082
3083 Keep in mind that changing 'fenc' from a modeline happens
3084 AFTER the text has been read, thus it applies to when the file will be
3085 written. If you do set 'fenc' in a modeline, you might want to set
3086 'nomodified' to avoid not being able to ":q".
3087
Bram Moolenaar071d4272004-06-13 20:20:40 +00003088 This option can not be changed when 'modifiable' is off.
3089
3090 *'fe'*
3091 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003092 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003093 old short name was 'fe', which is no longer used.
3094
3095 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003096'fileencodings' 'fencs' string (default: "ucs-bom",
3097 "ucs-bom,utf-8,default,latin1" when
3098 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003099 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003100 This is a list of character encodings considered when starting to edit
3101 an existing file. When a file is read, Vim tries to use the first
3102 mentioned character encoding. If an error is detected, the next one
3103 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003104 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00003105 an empty string, which means the value of 'encoding' is used.
3106 WARNING: Conversion can cause loss of information! When
3107 'encoding' is "utf-8" (or one of the other Unicode variants)
3108 conversion is most likely done in a way that the reverse
3109 conversion results in the same text. When 'encoding' is not
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003110 "utf-8" some non-ASCII characters may be lost! You can use
3111 the |++bad| argument to specify what is done with characters
3112 that can't be converted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003113 For an empty file or a file with only ASCII characters most encodings
3114 will work and the first entry of 'fileencodings' will be used (except
3115 "ucs-bom", which requires the BOM to be present). If you prefer
3116 another encoding use an BufReadPost autocommand event to test if your
3117 preferred encoding is to be used. Example: >
3118 au BufReadPost * if search('\S', 'w') == 0 |
3119 \ set fenc=iso-2022-jp | endif
3120< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
3121 non-blank characters.
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003122 When the |++enc| argument is used then the value of 'fileencodings' is
3123 not used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003124 Note that 'fileencodings' is not used for a new file, the global value
3125 of 'fileencoding' is used instead. You can set it with: >
3126 :setglobal fenc=iso-8859-2
3127< This means that a non-existing file may get a different encoding than
3128 an empty file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003129 The special value "ucs-bom" can be used to check for a Unicode BOM
3130 (Byte Order Mark) at the start of the file. It must not be preceded
3131 by "utf-8" or another Unicode encoding for this to work properly.
3132 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
3133 because Vim cannot detect an error, thus the encoding is always
3134 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003135 The special value "default" can be used for the encoding from the
K.Takataef8706f2021-05-31 18:40:49 +02003136 environment. On MS-Windows this is the system encoding. Otherwise
3137 this is the default value for 'encoding'. It is useful when
3138 'encoding' is set to "utf-8" and your environment uses a non-latin1
3139 encoding, such as Russian.
Bram Moolenaarca003e12006-03-17 23:19:38 +00003140 When 'encoding' is "utf-8" and a file contains an illegal byte
3141 sequence it won't be recognized as UTF-8. You can use the |8g8|
3142 command to find the illegal byte sequence.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003143 WRONG VALUES: WHAT'S WRONG:
3144 latin1,utf-8 "latin1" will always be used
3145 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
3146 file
3147 cp1250,latin1 "cp1250" will always be used
3148 If 'fileencodings' is empty, 'fileencoding' is not modified.
3149 See 'fileencoding' for the possible values.
3150 Setting this option does not have an effect until the next time a file
3151 is read.
3152
3153 *'fileformat'* *'ff'*
Bram Moolenaar00590742019-02-15 21:06:09 +01003154'fileformat' 'ff' string (MS-Windows default: "dos",
3155 Unix, macOS default: "unix")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003156 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003157 This gives the <EOL> of the current buffer, which is used for
3158 reading/writing the buffer from/to a file:
Bram Moolenaar4072ba52020-12-23 13:56:35 +01003159 dos <CR><NL>
Bram Moolenaar071d4272004-06-13 20:20:40 +00003160 unix <NL>
3161 mac <CR>
3162 When "dos" is used, CTRL-Z at the end of a file is ignored.
3163 See |file-formats| and |file-read|.
3164 For the character encoding of the file see 'fileencoding'.
3165 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
Bram Moolenaarbf884932013-04-05 22:26:15 +02003166 works like it was set to "unix".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003167 This option is set automatically when starting to edit a file and
3168 'fileformats' is not empty and 'binary' is off.
3169 When this option is set, after starting to edit a file, the 'modified'
3170 option is set, because the file would be different when written.
3171 This option can not be changed when 'modifiable' is off.
3172 For backwards compatibility: When this option is set to "dos",
3173 'textmode' is set, otherwise 'textmode' is reset.
3174
3175 *'fileformats'* *'ffs'*
3176'fileformats' 'ffs' string (default:
Bram Moolenaar00590742019-02-15 21:06:09 +01003177 Vim+Vi MS-Windows: "dos,unix",
3178 Vim Unix, macOS: "unix,dos",
Bram Moolenaar071d4272004-06-13 20:20:40 +00003179 Vi Cygwin: "unix,dos",
3180 Vi others: "")
3181 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003182 This gives the end-of-line (<EOL>) formats that will be tried when
3183 starting to edit a new buffer and when reading a file into an existing
3184 buffer:
3185 - When empty, the format defined with 'fileformat' will be used
3186 always. It is not set automatically.
3187 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003188 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003189 'fileformats' name will be used when a file is read into an existing
3190 buffer, no matter what 'fileformat' for that buffer is set to.
3191 - When more than one name is present, separated by commas, automatic
3192 <EOL> detection will be done when reading a file. When starting to
3193 edit a file, a check is done for the <EOL>:
3194 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
3195 'fileformat' is set to "dos".
3196 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003197 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003198 preceding <CR>, "unix" is preferred over "dos".
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01003199 3. If 'fileformat' has not yet been set, and if a <CR> is found, and
3200 if 'fileformats' includes "mac", 'fileformat' is set to "mac".
Bram Moolenaar00659062010-09-21 22:34:02 +02003201 This means that "mac" is only chosen when:
3202 "unix" is not present or no <NL> is found in the file, and
3203 "dos" is not present or no <CR><NL> is found in the file.
3204 Except: if "unix" was chosen, but there is a <CR> before
3205 the first <NL>, and there appear to be more <CR>s than <NL>s in
Bram Moolenaar166af9b2010-11-16 20:34:40 +01003206 the first few lines, "mac" is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003207 4. If 'fileformat' is still not set, the first name from
3208 'fileformats' is used.
3209 When reading a file into an existing buffer, the same is done, but
3210 this happens like 'fileformat' has been set appropriately for that
3211 file only, the option is not changed.
3212 When 'binary' is set, the value of 'fileformats' is not used.
3213
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01003214 When Vim starts up with an empty buffer the first item is used. You
3215 can overrule this by setting 'fileformat' in your .vimrc.
Bram Moolenaar81af9252010-12-10 20:35:50 +01003216
Bram Moolenaar071d4272004-06-13 20:20:40 +00003217 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
3218 are ":source"ed and for vimrc files, automatic <EOL> detection may be
3219 done:
3220 - When 'fileformats' is empty, there is no automatic detection. Dos
3221 format will be used.
3222 - When 'fileformats' is set to one or more names, automatic detection
3223 is done. This is based on the first <NL> in the file: If there is a
3224 <CR> in front of it, Dos format is used, otherwise Unix format is
3225 used.
3226 Also see |file-formats|.
3227 For backwards compatibility: When this option is set to an empty
3228 string or one format (no comma is included), 'textauto' is reset,
3229 otherwise 'textauto' is set.
3230 NOTE: This option is set to the Vi default value when 'compatible' is
3231 set and to the Vim default value when 'compatible' is reset.
3232
Bram Moolenaarbf884932013-04-05 22:26:15 +02003233 *'fileignorecase'* *'fic'* *'nofileignorecase'* *'nofic'*
3234'fileignorecase' 'fic' boolean (default on for systems where case in file
3235 names is normally ignored)
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003236 global
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003237 When set case is ignored when using file names and directories.
3238 See 'wildignorecase' for only ignoring case when doing completion.
3239
Bram Moolenaar071d4272004-06-13 20:20:40 +00003240 *'filetype'* *'ft'*
3241'filetype' 'ft' string (default: "")
3242 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003243 When this option is set, the FileType autocommand event is triggered.
3244 All autocommands that match with the value of this option will be
3245 executed. Thus the value of 'filetype' is used in place of the file
3246 name.
3247 Otherwise this option does not always reflect the current file type.
3248 This option is normally set when the file type is detected. To enable
3249 this use the ":filetype on" command. |:filetype|
3250 Setting this option to a different value is most useful in a modeline,
3251 for a file for which the file type is not automatically recognized.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003252 Example, for in an IDL file:
3253 /* vim: set filetype=idl : */ ~
3254 |FileType| |filetypes|
3255 When a dot appears in the value then this separates two filetype
3256 names. Example:
3257 /* vim: set filetype=c.doxygen : */ ~
3258 This will use the "c" filetype first, then the "doxygen" filetype.
3259 This works both for filetype plugins and for syntax files. More than
3260 one dot may appear.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003261 This option is not copied to another buffer, independent of the 's' or
3262 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003263 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003264
3265 *'fillchars'* *'fcs'*
Bram Moolenaara98f8a22021-02-13 18:24:23 +01003266'fillchars' 'fcs' string (default "vert:|,fold:-,eob:~")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003267 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02003268 {not available when compiled without the |+folding|
3269 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003270 Characters to fill the statuslines and vertical separators.
3271 It is a comma separated list of items:
3272
3273 item default Used for ~
3274 stl:c ' ' or '^' statusline of the current window
Bram Moolenaar38a55632016-02-15 22:07:32 +01003275 stlnc:c ' ' or '=' statusline of the non-current windows
Bram Moolenaar071d4272004-06-13 20:20:40 +00003276 vert:c '|' vertical separators |:vsplit|
3277 fold:c '-' filling 'foldtext'
Bram Moolenaar3aca5a62021-02-17 13:14:07 +01003278 foldopen:c '-' mark the beginning of a fold
3279 foldclose:c '+' show a closed fold
3280 foldsep:c '|' open fold middle character
Bram Moolenaar071d4272004-06-13 20:20:40 +00003281 diff:c '-' deleted lines of the 'diff' option
Bram Moolenaara98f8a22021-02-13 18:24:23 +01003282 eob:c '~' empty lines below the end of a buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003283
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003284 Any one that is omitted will fall back to the default. For "stl" and
Bram Moolenaar38a55632016-02-15 22:07:32 +01003285 "stlnc" the space will be used when there is highlighting, '^' or '='
Bram Moolenaar071d4272004-06-13 20:20:40 +00003286 otherwise.
3287
3288 Example: >
Bram Moolenaar38a55632016-02-15 22:07:32 +01003289 :set fillchars=stl:^,stlnc:=,vert:\|,fold:-,diff:-
Bram Moolenaar071d4272004-06-13 20:20:40 +00003290< This is similar to the default, except that these characters will also
3291 be used when there is highlighting.
3292
Bram Moolenaar008bff92021-03-04 21:55:58 +01003293 For "stl" and "stlnc" single-byte and multibyte characters are
3294 supported. But double-width characters are not supported.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003295
Bram Moolenaar071d4272004-06-13 20:20:40 +00003296 The highlighting used for these items:
3297 item highlight group ~
3298 stl:c StatusLine |hl-StatusLine|
3299 stlnc:c StatusLineNC |hl-StatusLineNC|
3300 vert:c VertSplit |hl-VertSplit|
3301 fold:c Folded |hl-Folded|
3302 diff:c DiffDelete |hl-DiffDelete|
Bram Moolenaara98f8a22021-02-13 18:24:23 +01003303 eob:c EndOfBuffer |hl-EndOfBuffer|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003304
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003305 *'fixendofline'* *'fixeol'* *'nofixendofline'* *'nofixeol'*
3306'fixendofline' 'fixeol' boolean (default on)
3307 local to buffer
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003308 When writing a file and this option is on, <EOL> at the end of file
3309 will be restored if missing. Turn this option off if you want to
3310 preserve the situation from the original file.
3311 When the 'binary' option is set the value of this option doesn't
3312 matter.
3313 See the 'endofline' option.
3314
Bram Moolenaar071d4272004-06-13 20:20:40 +00003315 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
Bram Moolenaar98a29d02021-01-18 19:55:44 +01003316'fkmap' 'fk' boolean (default off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003317 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003318 {only available when compiled with the |+rightleft|
3319 feature}
Bram Moolenaar14184a32019-02-16 15:10:30 +01003320 This option was for using Farsi, which has been removed. See
3321 |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003322
3323 *'foldclose'* *'fcl'*
3324'foldclose' 'fcl' string (default "")
3325 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003326 {not available when compiled without the |+folding|
3327 feature}
3328 When set to "all", a fold is closed when the cursor isn't in it and
3329 its level is higher than 'foldlevel'. Useful if you want folds to
3330 automatically close when moving out of them.
3331
3332 *'foldcolumn'* *'fdc'*
3333'foldcolumn' 'fdc' number (default 0)
3334 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003335 {not available when compiled without the |+folding|
3336 feature}
3337 When non-zero, a column with the specified width is shown at the side
3338 of the window which indicates open and closed folds. The maximum
3339 value is 12.
3340 See |folding|.
3341
3342 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
3343'foldenable' 'fen' boolean (default on)
3344 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003345 {not available when compiled without the |+folding|
3346 feature}
3347 When off, all folds are open. This option can be used to quickly
3348 switch between showing all text unfolded and viewing the text with
3349 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003350 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00003351 'foldenable' is off.
3352 This option is set by commands that create a new fold or close a fold.
3353 See |folding|.
3354
3355 *'foldexpr'* *'fde'*
3356'foldexpr' 'fde' string (default: "0")
3357 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003358 {not available when compiled without the |+folding|
Bram Moolenaardb84e452010-08-15 13:50:43 +02003359 or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003360 The expression used for when 'foldmethod' is "expr". It is evaluated
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003361 for each line to obtain its fold level. See |fold-expr|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003362
Bram Moolenaar30b65812012-07-12 22:01:11 +02003363 The expression will be evaluated in the |sandbox| if set from a
3364 modeline, see |sandbox-option|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003365 This option can't be set from a |modeline| when the 'diff' option is
Bram Moolenaar110289e2019-05-23 15:38:06 +02003366 on or the 'modelineexpr' option is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003367
3368 It is not allowed to change text or jump to another window while
3369 evaluating 'foldexpr' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003370
3371 *'foldignore'* *'fdi'*
3372'foldignore' 'fdi' string (default: "#")
3373 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003374 {not available when compiled without the |+folding|
3375 feature}
3376 Used only when 'foldmethod' is "indent". Lines starting with
3377 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003378 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003379 The default "#" works well for C programs. See |fold-indent|.
3380
3381 *'foldlevel'* *'fdl'*
3382'foldlevel' 'fdl' number (default: 0)
3383 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003384 {not available when compiled without the |+folding|
3385 feature}
3386 Sets the fold level: Folds with a higher level will be closed.
3387 Setting this option to zero will close all folds. Higher numbers will
3388 close fewer folds.
3389 This option is set by commands like |zm|, |zM| and |zR|.
3390 See |fold-foldlevel|.
3391
3392 *'foldlevelstart'* *'fdls'*
3393'foldlevelstart' 'fdls' number (default: -1)
3394 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003395 {not available when compiled without the |+folding|
3396 feature}
3397 Sets 'foldlevel' when starting to edit another buffer in a window.
3398 Useful to always start editing with all folds closed (value zero),
3399 some folds closed (one) or no folds closed (99).
3400 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003401 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00003402 ignores this option and closes all folds.
3403 It is also done before BufReadPre autocommands, to allow an autocmd to
3404 overrule the 'foldlevel' value for specific files.
3405 When the value is negative, it is not used.
3406
3407 *'foldmarker'* *'fmr'* *E536*
3408'foldmarker' 'fmr' string (default: "{{{,}}}")
3409 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003410 {not available when compiled without the |+folding|
3411 feature}
3412 The start and end marker used when 'foldmethod' is "marker". There
3413 must be one comma, which separates the start and end marker. The
3414 marker is a literal string (a regular expression would be too slow).
3415 See |fold-marker|.
3416
3417 *'foldmethod'* *'fdm'*
3418'foldmethod' 'fdm' string (default: "manual")
3419 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003420 {not available when compiled without the |+folding|
3421 feature}
3422 The kind of folding used for the current window. Possible values:
3423 |fold-manual| manual Folds are created manually.
3424 |fold-indent| indent Lines with equal indent form a fold.
3425 |fold-expr| expr 'foldexpr' gives the fold level of a line.
3426 |fold-marker| marker Markers are used to specify folds.
3427 |fold-syntax| syntax Syntax highlighting items specify folds.
3428 |fold-diff| diff Fold text that is not changed.
3429
3430 *'foldminlines'* *'fml'*
3431'foldminlines' 'fml' number (default: 1)
3432 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003433 {not available when compiled without the |+folding|
3434 feature}
Bram Moolenaar00654022011-02-25 14:42:19 +01003435 Sets the number of screen lines above which a fold can be displayed
3436 closed. Also for manually closed folds. With the default value of
3437 one a fold can only be closed if it takes up two or more screen lines.
3438 Set to zero to be able to close folds of just one screen line.
Bram Moolenaar446beb42011-05-10 17:18:44 +02003439 Note that this only has an effect on what is displayed. After using
Bram Moolenaar071d4272004-06-13 20:20:40 +00003440 "zc" to close a fold, which is displayed open because it's smaller
3441 than 'foldminlines', a following "zc" may close a containing fold.
3442
3443 *'foldnestmax'* *'fdn'*
3444'foldnestmax' 'fdn' number (default: 20)
3445 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003446 {not available when compiled without the |+folding|
3447 feature}
3448 Sets the maximum nesting of folds for the "indent" and "syntax"
3449 methods. This avoids that too many folds will be created. Using more
3450 than 20 doesn't work, because the internal limit is 20.
3451
3452 *'foldopen'* *'fdo'*
3453'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
3454 search,tag,undo")
3455 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003456 {not available when compiled without the |+folding|
3457 feature}
3458 Specifies for which type of commands folds will be opened, if the
3459 command moves the cursor into a closed fold. It is a comma separated
3460 list of items.
Bram Moolenaar05365702010-10-27 18:34:44 +02003461 NOTE: When the command is part of a mapping this option is not used.
3462 Add the |zv| command to the mapping to get the same effect.
3463 (rationale: the mapping may want to control opening folds itself)
3464
Bram Moolenaar071d4272004-06-13 20:20:40 +00003465 item commands ~
3466 all any
3467 block "(", "{", "[[", "[{", etc.
3468 hor horizontal movements: "l", "w", "fx", etc.
3469 insert any command in Insert mode
3470 jump far jumps: "G", "gg", etc.
3471 mark jumping to a mark: "'m", CTRL-O, etc.
3472 percent "%"
3473 quickfix ":cn", ":crew", ":make", etc.
3474 search search for a pattern: "/", "n", "*", "gd", etc.
3475 (not for a search pattern in a ":" command)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003476 Also for |[s| and |]s|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003477 tag jumping to a tag: ":ta", CTRL-T, etc.
3478 undo undo or redo: "u" and CTRL-R
Bram Moolenaar071d4272004-06-13 20:20:40 +00003479 When a movement command is used for an operator (e.g., "dl" or "y%")
3480 this option is not used. This means the operator will include the
3481 whole closed fold.
3482 Note that vertical movements are not here, because it would make it
3483 very difficult to move onto a closed fold.
3484 In insert mode the folds containing the cursor will always be open
3485 when text is inserted.
3486 To close folds you can re-apply 'foldlevel' with the |zx| command or
3487 set the 'foldclose' option to "all".
3488
3489 *'foldtext'* *'fdt'*
3490'foldtext' 'fdt' string (default: "foldtext()")
3491 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003492 {not available when compiled without the |+folding|
3493 feature}
3494 An expression which is used to specify the text displayed for a closed
3495 fold. See |fold-foldtext|.
3496
Bram Moolenaar30b65812012-07-12 22:01:11 +02003497 The expression will be evaluated in the |sandbox| if set from a
3498 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003499 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003500
3501 It is not allowed to change text or jump to another window while
3502 evaluating 'foldtext' |textlock|.
3503
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003504 *'formatexpr'* *'fex'*
3505'formatexpr' 'fex' string (default "")
3506 local to buffer
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003507 {not available when compiled without the |+eval|
3508 feature}
3509 Expression which is evaluated to format a range of lines for the |gq|
3510 operator or automatic formatting (see 'formatoptions'). When this
3511 option is empty 'formatprg' is used.
3512
3513 The |v:lnum| variable holds the first line to be formatted.
3514 The |v:count| variable holds the number of lines to be formatted.
3515 The |v:char| variable holds the character that is going to be
3516 inserted if the expression is being evaluated due to
3517 automatic formatting. This can be empty. Don't insert
3518 it yet!
3519
3520 Example: >
3521 :set formatexpr=mylang#Format()
3522< This will invoke the mylang#Format() function in the
3523 autoload/mylang.vim file in 'runtimepath'. |autoload|
3524
3525 The expression is also evaluated when 'textwidth' is set and adding
3526 text beyond that limit. This happens under the same conditions as
3527 when internal formatting is used. Make sure the cursor is kept in the
3528 same spot relative to the text then! The |mode()| function will
3529 return "i" or "R" in this situation.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01003530
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003531 When the expression evaluates to non-zero Vim will fall back to using
3532 the internal format mechanism.
3533
3534 The expression will be evaluated in the |sandbox| when set from a
3535 modeline, see |sandbox-option|. That stops the option from working,
3536 since changing the buffer text is not allowed.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003537 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaar036986f2017-03-16 17:41:02 +01003538 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003539
Bram Moolenaar86b68352004-12-27 21:59:20 +00003540 *'formatlistpat'* *'flp'*
3541'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
3542 local to buffer
Bram Moolenaar86b68352004-12-27 21:59:20 +00003543 A pattern that is used to recognize a list header. This is used for
3544 the "n" flag in 'formatoptions'.
3545 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00003546 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00003547 while still checking more characters. There must be a character
3548 following the pattern, when it matches the whole line it is handled
3549 like there is no match.
3550 The default recognizes a number, followed by an optional punctuation
3551 character and white space.
3552
Bram Moolenaar6c60f472019-04-28 16:00:35 +02003553 *'formatoptions'* *'fo'*
3554'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
3555 local to buffer
3556 This is a sequence of letters which describes how automatic
3557 formatting is to be done. See |fo-table|. When the 'paste' option is
3558 on, no formatting is done (like 'formatoptions' is empty). Commas can
3559 be inserted for readability.
3560 To avoid problems with flags that are added in the future, use the
3561 "+=" and "-=" feature of ":set" |add-option-flags|.
3562 NOTE: This option is set to the Vi default value when 'compatible' is
3563 set and to the Vim default value when 'compatible' is reset.
3564
Bram Moolenaar071d4272004-06-13 20:20:40 +00003565 *'formatprg'* *'fp'*
3566'formatprg' 'fp' string (default "")
Bram Moolenaar9be7c042017-01-14 14:28:30 +01003567 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003568 The name of an external program that will be used to format the lines
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003569 selected with the |gq| operator. The program must take the input on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003570 stdin and produce the output on stdout. The Unix program "fmt" is
Bram Moolenaara5792f52005-11-23 21:25:05 +00003571 such a program.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003572 If the 'formatexpr' option is not empty it will be used instead.
3573 Otherwise, if 'formatprg' option is an empty string, the internal
3574 format function will be used |C-indenting|.
Bram Moolenaara5792f52005-11-23 21:25:05 +00003575 Environment variables are expanded |:set_env|. See |option-backslash|
3576 about including spaces and backslashes.
Bram Moolenaar30b65812012-07-12 22:01:11 +02003577 This option cannot be set from a |modeline| or in the |sandbox|, for
3578 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003579
Bram Moolenaard94464e2015-11-02 15:28:18 +01003580 *'fsync'* *'fs'* *'nofsync'* *'nofs'*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003581'fsync' 'fs' boolean (default on)
3582 global
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003583 When on, the library function fsync() will be called after writing a
3584 file. This will flush a file to disk, ensuring that it is safely
3585 written even on filesystems which do metadata-only journaling. This
3586 will force the harddrive to spin up on Linux systems running in laptop
3587 mode, so it may be undesirable in some situations. Be warned that
3588 turning this off increases the chances of data loss after a crash. On
3589 systems without an fsync() implementation, this variable is always
3590 off.
3591 Also see 'swapsync' for controlling fsync() on swap files.
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003592 'fsync' also applies to |writefile()|, unless a flag is used to
3593 overrule it.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003594 This option cannot be set from a |modeline| or in the |sandbox|, for
3595 security reasons.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003596
Bram Moolenaar071d4272004-06-13 20:20:40 +00003597 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
3598'gdefault' 'gd' boolean (default off)
3599 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003600 When on, the ":substitute" flag 'g' is default on. This means that
3601 all matches in a line are substituted instead of one. When a 'g' flag
3602 is given to a ":substitute" command, this will toggle the substitution
3603 of all or one match. See |complex-change|.
3604
3605 command 'gdefault' on 'gdefault' off ~
3606 :s/// subst. all subst. one
3607 :s///g subst. one subst. all
3608 :s///gg subst. all subst. one
3609
3610 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar21020352017-06-13 17:21:04 +02003611 DEPRECATED: Setting this option may break plugins that are not aware
3612 of this option. Also, many users get confused that adding the /g flag
3613 has the opposite effect of that it normally does.
Bram Moolenaar4072ba52020-12-23 13:56:35 +01003614 This option is not used in |Vim9| script.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003615
3616 *'grepformat'* *'gfm'*
Bram Moolenaar6e932462014-09-09 18:48:09 +02003617'grepformat' 'gfm' string (default "%f:%l:%m,%f:%l%m,%f %l%m")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003618 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003619 Format to recognize for the ":grep" command output.
3620 This is a scanf-like string that uses the same format as the
3621 'errorformat' option: see |errorformat|.
3622
3623 *'grepprg'* *'gp'*
3624'grepprg' 'gp' string (default "grep -n ",
3625 Unix: "grep -n $* /dev/null",
3626 Win32: "findstr /n" or "grep -n",
3627 VMS: "SEARCH/NUMBERS ")
3628 global or local to buffer |global-local|
Bram Moolenaar582fd852005-03-28 20:58:01 +00003629 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003630 and '#' characters, which are expanded like when used in a command-
3631 line. The placeholder "$*" is allowed to specify where the arguments
3632 will be included. Environment variables are expanded |:set_env|. See
3633 |option-backslash| about including spaces and backslashes.
3634 When your "grep" accepts the "-H" argument, use this to make ":grep"
3635 also work well with a single file: >
3636 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00003637< Special value: When 'grepprg' is set to "internal" the |:grep| command
Bram Moolenaara6557602006-02-04 22:43:20 +00003638 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like
3639 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00003640 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00003641 apply equally to 'grepprg'.
3642 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
3643 otherwise it's "grep -n".
3644 This option cannot be set from a |modeline| or in the |sandbox|, for
3645 security reasons.
3646
3647 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
3648'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
3649 ve:ver35-Cursor,
3650 o:hor50-Cursor,
3651 i-ci:ver25-Cursor/lCursor,
3652 r-cr:hor20-Cursor/lCursor,
3653 sm:block-Cursor
3654 -blinkwait175-blinkoff150-blinkon175",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003655 for Win32 console:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003656 "n-v-c:block,o:hor50,i-ci:hor15,
3657 r-cr:hor30,sm:block")
3658 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003659 {only available when compiled with GUI enabled, and
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003660 for Win32 console}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003661 This option tells Vim what the cursor should look like in different
Bram Moolenaar8024f932020-01-14 19:29:13 +01003662 modes. It fully works in the GUI. In a Win32 console, only the
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003663 height of the cursor can be changed. This can be done by specifying a
3664 block cursor, or a percentage for a vertical or horizontal cursor.
Bram Moolenaar1e7813a2015-03-31 18:31:03 +02003665 For a console the 't_SI', 't_SR', and 't_EI' escape sequences are
3666 used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003667
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003668 The option is a comma separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003669 mode-list and an argument-list:
3670 mode-list:argument-list,mode-list:argument-list,..
3671 The mode-list is a dash separated list of these modes:
3672 n Normal mode
3673 v Visual mode
3674 ve Visual mode with 'selection' "exclusive" (same as 'v',
3675 if not specified)
3676 o Operator-pending mode
3677 i Insert mode
3678 r Replace mode
3679 c Command-line Normal (append) mode
3680 ci Command-line Insert mode
3681 cr Command-line Replace mode
3682 sm showmatch in Insert mode
3683 a all modes
3684 The argument-list is a dash separated list of these arguments:
3685 hor{N} horizontal bar, {N} percent of the character height
3686 ver{N} vertical bar, {N} percent of the character width
3687 block block cursor, fills the whole character
3688 [only one of the above three should be present]
3689 blinkwait{N} *cursor-blinking*
3690 blinkon{N}
3691 blinkoff{N}
3692 blink times for cursor: blinkwait is the delay before
3693 the cursor starts blinking, blinkon is the time that
3694 the cursor is shown and blinkoff is the time that the
3695 cursor is not shown. The times are in msec. When one
3696 of the numbers is zero, there is no blinking. The
3697 default is: "blinkwait700-blinkon400-blinkoff250".
3698 These numbers are used for a missing entry. This
3699 means that blinking is enabled by default. To switch
3700 blinking off you can use "blinkon0". The cursor only
3701 blinks when Vim is waiting for input, not while
3702 executing a command.
3703 To make the cursor blink in an xterm, see
3704 |xterm-blink|.
3705 {group-name}
3706 a highlight group name, that sets the color and font
3707 for the cursor
3708 {group-name}/{group-name}
3709 Two highlight group names, the first is used when
3710 no language mappings are used, the other when they
3711 are. |language-mapping|
3712
3713 Examples of parts:
3714 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
3715 block cursor with colors from the "nCursor"
3716 highlight group
3717 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
3718 In Insert and Command-line Insert mode, use a
3719 30% vertical bar cursor with colors from the
3720 "iCursor" highlight group. Blink a bit
3721 faster.
3722
3723 The 'a' mode is different. It will set the given argument-list for
3724 all modes. It does not reset anything to defaults. This can be used
3725 to do a common setting for all modes. For example, to switch off
3726 blinking: "a:blinkon0"
3727
3728 Examples of cursor highlighting: >
3729 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
3730 :highlight Cursor gui=NONE guifg=bg guibg=fg
3731<
3732 *'guifont'* *'gfn'*
Bram Moolenaar251e1912011-06-19 05:09:16 +02003733 *E235* *E596*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003734'guifont' 'gfn' string (default "")
3735 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003736 {only available when compiled with GUI enabled}
3737 This is a list of fonts which will be used for the GUI version of Vim.
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003738 In its simplest form the value is just one font name.
3739 See |gui-font| for the details.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003740
3741 *'guifontset'* *'gfs'*
3742 *E250* *E252* *E234* *E597* *E598*
3743'guifontset' 'gfs' string (default "")
3744 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003745 {only available when compiled with GUI enabled and
3746 with the |+xfontset| feature}
Bram Moolenaar3df01732017-02-17 22:47:16 +01003747 {not available in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003748 When not empty, specifies two (or more) fonts to be used. The first
3749 one for normal English, the second one for your special language. See
3750 |xfontset|.
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003751
Bram Moolenaar071d4272004-06-13 20:20:40 +00003752 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
3753'guifontwide' 'gfw' string (default "")
3754 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003755 {only available when compiled with GUI enabled}
3756 When not empty, specifies a comma-separated list of fonts to be used
3757 for double-width characters. The first font that can be loaded is
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003758 used. See |gui-fontwide|.
Bram Moolenaar0f272122013-01-23 18:37:40 +01003759
Bram Moolenaar071d4272004-06-13 20:20:40 +00003760 *'guiheadroom'* *'ghr'*
3761'guiheadroom' 'ghr' number (default 50)
3762 global
Bram Moolenaar110289e2019-05-23 15:38:06 +02003763 {only for GTK and X11 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003764 The number of pixels subtracted from the screen height when fitting
3765 the GUI window on the screen. Set this before the GUI is started,
3766 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003767 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00003768 lines will be left for window decorations and other items on the
3769 screen. Set it to a negative value to allow windows taller than the
3770 screen.
3771
3772 *'guioptions'* *'go'*
Bram Moolenaar2c64ca12018-10-19 16:22:31 +02003773'guioptions' 'go' string (default "egmrLtT" (MS-Windows,
3774 "t" is removed in |defaults.vim|),
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02003775 "aegimrLtT" (GTK, Motif and Athena),
3776 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00003777 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003778 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00003779 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003780 sequence of letters which describes what components and options of the
3781 GUI should be used.
3782 To avoid problems with flags that are added in the future, use the
3783 "+=" and "-=" feature of ":set" |add-option-flags|.
3784
Bram Moolenaar13568252018-03-16 20:46:58 +01003785 Valid characters are as follows:
3786 *'go-!'*
3787 '!' External commands are executed in a terminal window. Without
3788 this flag the MS-Windows GUI will open a console window to
3789 execute the command. The Unix GUI will simulate a dumb
3790 terminal to list the command output.
3791 The terminal window will be positioned at the bottom, and grow
3792 upwards as needed.
Bram Moolenaarba3ff532018-11-04 14:45:49 +01003793 *'go-a'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003794 'a' Autoselect: If present, then whenever VISUAL mode is started,
3795 or the Visual area extended, Vim tries to become the owner of
3796 the windowing system's global selection. This means that the
3797 Visually highlighted text is available for pasting into other
3798 applications as well as into Vim itself. When the Visual mode
3799 ends, possibly due to an operation on the text, or when an
3800 application wants to paste the selection, the highlighted text
3801 is automatically yanked into the "* selection register.
3802 Thus the selection is still available for pasting into other
3803 applications after the VISUAL mode has ended.
3804 If not present, then Vim won't become the owner of the
3805 windowing system's global selection unless explicitly told to
3806 by a yank or delete operation for the "* register.
3807 The same applies to the modeless selection.
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02003808 *'go-P'*
3809 'P' Like autoselect but using the "+ register instead of the "*
Bram Moolenaar3848e002016-03-19 18:42:29 +01003810 register.
Bram Moolenaar02467872007-05-06 13:22:01 +00003811 *'go-A'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003812 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003813 applies to the modeless selection.
3814
3815 'guioptions' autoselect Visual autoselect modeless ~
3816 "" - -
3817 "a" yes yes
3818 "A" - yes
3819 "aA" yes yes
3820
Bram Moolenaar02467872007-05-06 13:22:01 +00003821 *'go-c'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003822 'c' Use console dialogs instead of popup dialogs for simple
3823 choices.
Bram Moolenaar50bf7ce2019-09-15 13:17:00 +02003824 *'go-d'*
3825 'd' Use dark theme variant if available. Currently only works for
3826 GTK+ GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00003827 *'go-e'*
Bram Moolenaare224ffa2006-03-01 00:01:28 +00003828 'e' Add tab pages when indicated with 'showtabline'.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003829 'guitablabel' can be used to change the text in the labels.
3830 When 'e' is missing a non-GUI tab pages line may be used.
Bram Moolenaard68071d2006-05-02 22:08:30 +00003831 The GUI tabs are only supported on some systems, currently
Bram Moolenaarb3f74062020-02-26 16:16:53 +01003832 GTK, Motif, Mac OS/X, Haiku, and MS-Windows.
Bram Moolenaar02467872007-05-06 13:22:01 +00003833 *'go-f'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003834 'f' Foreground: Don't use fork() to detach the GUI from the shell
3835 where it was started. Use this for programs that wait for the
3836 editor to finish (e.g., an e-mail program). Alternatively you
3837 can use "gvim -f" or ":gui -f" to start the GUI in the
3838 foreground. |gui-fork|
3839 Note: Set this option in the vimrc file. The forking may have
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003840 happened already when the |gvimrc| file is read.
Bram Moolenaar02467872007-05-06 13:22:01 +00003841 *'go-i'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003842 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
3843 corner of the window. It's black&white on non-GTK, because of
3844 limitations of X11. For a color icon, see |X11-icon|.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003845 *'go-m'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003846 'm' Menu bar is present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003847 *'go-M'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003848 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00003849 that this flag must be added in the .vimrc file, before
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003850 switching on syntax or filetype recognition (when the |gvimrc|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003851 file is sourced the system menu has already been loaded; the
Bram Moolenaar01164a62017-11-02 22:58:42 +01003852 `:syntax on` and `:filetype on` commands load the menu too).
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003853 *'go-g'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003854 'g' Grey menu items: Make menu items that are not active grey. If
3855 'g' is not included inactive menu items are not shown at all.
3856 Exception: Athena will always use grey menu items.
Bram Moolenaar02467872007-05-06 13:22:01 +00003857 *'go-t'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003858 't' Include tearoff menu items. Currently only works for Win32,
3859 GTK+, and Motif 1.2 GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00003860 *'go-T'*
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00003861 'T' Include Toolbar. Currently only in Win32, GTK+, Motif, Photon
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00003862 and Athena GUIs.
Bram Moolenaar02467872007-05-06 13:22:01 +00003863 *'go-r'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003864 'r' Right-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003865 *'go-R'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003866 'R' Right-hand scrollbar is present when there is a vertically
3867 split window.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003868 *'go-l'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003869 'l' Left-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003870 *'go-L'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003871 'L' Left-hand scrollbar is present when there is a vertically
3872 split window.
Bram Moolenaar02467872007-05-06 13:22:01 +00003873 *'go-b'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003874 'b' Bottom (horizontal) scrollbar is present. Its size depends on
3875 the longest visible line, or on the cursor line if the 'h'
3876 flag is included. |gui-horiz-scroll|
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003877 *'go-h'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003878 'h' Limit horizontal scrollbar size to the length of the cursor
3879 line. Reduces computations. |gui-horiz-scroll|
3880
3881 And yes, you may even have scrollbars on the left AND the right if
3882 you really want to :-). See |gui-scrollbars| for more information.
3883
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003884 *'go-v'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003885 'v' Use a vertical button layout for dialogs. When not included,
3886 a horizontal layout is preferred, but when it doesn't fit a
Bram Moolenaardad44732021-03-31 20:07:33 +02003887 vertical layout is used anyway. Not supported in GTK 3.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003888 *'go-p'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003889 'p' Use Pointer callbacks for X11 GUI. This is required for some
3890 window managers. If the cursor is not blinking or hollow at
3891 the right moment, try adding this flag. This must be done
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003892 before starting the GUI. Set it in your |gvimrc|. Adding or
Bram Moolenaar071d4272004-06-13 20:20:40 +00003893 removing it after the GUI has started has no effect.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003894 *'go-F'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003895 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar8ac44152017-11-09 18:33:29 +01003896 *'go-k'*
3897 'k' Keep the GUI window size when adding/removing a scrollbar, or
3898 toolbar, tabline, etc. Instead, the behavior is similar to
3899 when the window is maximized and will adjust 'lines' and
3900 'columns' to fit to the window. Without the 'k' flag Vim will
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003901 try to keep 'lines' and 'columns' the same when adding and
Bram Moolenaar8ac44152017-11-09 18:33:29 +01003902 removing GUI components.
Bram Moolenaar02467872007-05-06 13:22:01 +00003903
Bram Moolenaar071d4272004-06-13 20:20:40 +00003904 *'guipty'* *'noguipty'*
3905'guipty' boolean (default on)
3906 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003907 {only available when compiled with GUI enabled}
3908 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
3909 I/O to/from shell commands. See |gui-pty|.
3910
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003911 *'guitablabel'* *'gtl'*
3912'guitablabel' 'gtl' string (default empty)
3913 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02003914 {only available when compiled with GUI enabled}
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003915 When nonempty describes the text to use in a label of the GUI tab
Bram Moolenaard68071d2006-05-02 22:08:30 +00003916 pages line. When empty and when the result is empty Vim will use a
3917 default label. See |setting-guitablabel| for more info.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003918
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003919 The format of this option is like that of 'statusline'.
Bram Moolenaar57657d82006-04-21 22:12:41 +00003920 'guitabtooltip' is used for the tooltip, see below.
Bram Moolenaar51628222016-12-01 23:03:28 +01003921 The expression will be evaluated in the |sandbox| when set from a
3922 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003923 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003924
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003925 Only used when the GUI tab pages line is displayed. 'e' must be
3926 present in 'guioptions'. For the non-GUI tab pages line 'tabline' is
3927 used.
3928
Bram Moolenaar57657d82006-04-21 22:12:41 +00003929 *'guitabtooltip'* *'gtt'*
3930'guitabtooltip' 'gtt' string (default empty)
3931 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02003932 {only available when compiled with GUI enabled}
Bram Moolenaar57657d82006-04-21 22:12:41 +00003933 When nonempty describes the text to use in a tooltip for the GUI tab
3934 pages line. When empty Vim will use a default tooltip.
3935 This option is otherwise just like 'guitablabel' above.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003936 You can include a line break. Simplest method is to use |:let|: >
3937 :let &guitabtooltip = "line one\nline two"
3938<
Bram Moolenaar57657d82006-04-21 22:12:41 +00003939
Bram Moolenaar071d4272004-06-13 20:20:40 +00003940 *'helpfile'* *'hf'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003941'helpfile' 'hf' string (default (MS-Windows) "$VIMRUNTIME\doc\help.txt"
Bram Moolenaar071d4272004-06-13 20:20:40 +00003942 (others) "$VIMRUNTIME/doc/help.txt")
3943 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003944 Name of the main help file. All distributed help files should be
3945 placed together in one directory. Additionally, all "doc" directories
3946 in 'runtimepath' will be used.
3947 Environment variables are expanded |:set_env|. For example:
3948 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003949 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00003950 spaces and backslashes.
3951 This option cannot be set from a |modeline| or in the |sandbox|, for
3952 security reasons.
3953
3954 *'helpheight'* *'hh'*
3955'helpheight' 'hh' number (default 20)
3956 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003957 Minimal initial height of the help window when it is opened with the
3958 ":help" command. The initial height of the help window is half of the
3959 current window, or (when the 'ea' option is on) the same as other
3960 windows. When the height is less than 'helpheight', the height is
3961 set to 'helpheight'. Set to zero to disable.
3962
3963 *'helplang'* *'hlg'*
3964'helplang' 'hlg' string (default: messages language or empty)
3965 global
3966 {only available when compiled with the |+multi_lang|
3967 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003968 Comma separated list of languages. Vim will use the first language
3969 for which the desired help can be found. The English help will always
3970 be used as a last resort. You can add "en" to prefer English over
3971 another language, but that will only find tags that exist in that
3972 language and not in the English help.
3973 Example: >
3974 :set helplang=de,it
3975< This will first search German, then Italian and finally English help
3976 files.
3977 When using |CTRL-]| and ":help!" in a non-English help file Vim will
3978 try to find the tag in the current language before using this option.
3979 See |help-translated|.
3980
3981 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
3982'hidden' 'hid' boolean (default off)
3983 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003984 When off a buffer is unloaded when it is |abandon|ed. When on a
3985 buffer becomes hidden when it is |abandon|ed. If the buffer is still
3986 displayed in another window, it does not become hidden, of course.
3987 The commands that move through the buffer list sometimes make a buffer
3988 hidden although the 'hidden' option is off: When the buffer is
3989 modified, 'autowrite' is off or writing is not possible, and the '!'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003990 flag was used. See also |windows.txt|.
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00003991 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003992 This option is set for one command with ":hide {command}" |:hide|.
3993 WARNING: It's easy to forget that you have changes in hidden buffers.
3994 Think twice when using ":q!" or ":qa!".
3995
3996 *'highlight'* *'hl'*
3997'highlight' 'hl' string (default (as a single string):
Bram Moolenaar58b85342016-08-14 19:54:54 +02003998 "8:SpecialKey,~:EndOfBuffer,@:NonText,
3999 d:Directory,e:ErrorMsg,i:IncSearch,
4000 l:Search,m:MoreMsg,M:ModeMsg,n:LineNr,
Bram Moolenaarefae76a2019-10-27 22:54:58 +01004001 a:LineNrAbove,b:LineNrBelow,
Bram Moolenaar58b85342016-08-14 19:54:54 +02004002 N:CursorLineNr,r:Question,s:StatusLine,
4003 S:StatusLineNC,c:VertSplit,t:Title,
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004004 v:Visual,V:VisualNOS,w:WarningMsg,
4005 W:WildMenu,f:Folded,F:FoldColumn,
4006 A:DiffAdd,C:DiffChange,D:DiffDelete,
4007 T:DiffText,>:SignColumn,-:Conceal,
Bram Moolenaarc8c88492018-12-27 23:59:26 +01004008 B:SpellBad,P:SpellCap,R:SpellRare,
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004009 L:SpellLocal,+:Pmenu,=:PmenuSel,
Bram Moolenaar21020352017-06-13 17:21:04 +02004010 x:PmenuSbar,X:PmenuThumb,*:TabLine,
4011 #:TabLineSel,_:TabLineFill,!:CursorColumn,
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02004012 .:CursorLine,o:ColorColumn,q:QuickFixLine,
Bram Moolenaarc572da52017-08-27 16:52:01 +02004013 z:StatusLineTerm,Z:StatusLineTermNC")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004014 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004015 This option can be used to set highlighting mode for various
4016 occasions. It is a comma separated list of character pairs. The
4017 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004018 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004019 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
Bram Moolenaar58b85342016-08-14 19:54:54 +02004020 |hl-EndOfBuffer| ~ lines after the last line in the buffer
4021 |hl-NonText| @ '@' at the end of the window and
Bram Moolenaar071d4272004-06-13 20:20:40 +00004022 characters from 'showbreak'
4023 |hl-Directory| d directories in CTRL-D listing and other special
4024 things in listings
4025 |hl-ErrorMsg| e error messages
4026 h (obsolete, ignored)
4027 |hl-IncSearch| i 'incsearch' highlighting
4028 |hl-Search| l last search pattern highlighting (see 'hlsearch')
4029 |hl-MoreMsg| m |more-prompt|
4030 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
Bram Moolenaar64486672010-05-16 15:46:46 +02004031 |hl-LineNr| n line number for ":number" and ":#" commands, and
4032 when 'number' or 'relativenumber' option is set.
Bram Moolenaarefae76a2019-10-27 22:54:58 +01004033 |hl-LineNrAbove| a line number above the cursor for when the
4034 'relativenumber' option is set.
4035 |hl-LineNrBelow| b line number below the cursor for when the
4036 'relativenumber' option is set.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01004037 |hl-CursorLineNr| N like n for when 'cursorline' or 'relativenumber' is
4038 set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004039 |hl-Question| r |hit-enter| prompt and yes/no questions
4040 |hl-StatusLine| s status line of current window |status-line|
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01004041 |hl-StatusLineNC| S status lines of not-current windows
Bram Moolenaar071d4272004-06-13 20:20:40 +00004042 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
4043 |hl-VertSplit| c column used to separate vertically split windows
4044 |hl-Visual| v Visual mode
4045 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
4046 Selection" Only X11 Gui's |gui-x11| and
4047 |xterm-clipboard|.
4048 |hl-WarningMsg| w warning messages
4049 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
4050 |hl-Folded| f line used for closed folds
4051 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00004052 |hl-DiffAdd| A added line in diff mode
4053 |hl-DiffChange| C changed line in diff mode
4054 |hl-DiffDelete| D deleted line in diff mode
4055 |hl-DiffText| T inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00004056 |hl-SignColumn| > column used for |signs|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004057 |hl-Conceal| - the placeholders used for concealed characters
4058 (see 'conceallevel')
Bram Moolenaar217ad922005-03-20 22:37:15 +00004059 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02004060 |hl-SpellCap| P word that should start with capital |spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00004061 |hl-SpellRare| R rare word |spell|
4062 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004063 |hl-Pmenu| + popup menu normal line
4064 |hl-PmenuSel| = popup menu selected line
4065 |hl-PmenuSbar| x popup menu scrollbar
4066 |hl-PmenuThumb| X popup menu scrollbar thumb
Bram Moolenaar071d4272004-06-13 20:20:40 +00004067
4068 The display modes are:
4069 r reverse (termcap entry "mr" and "me")
4070 i italic (termcap entry "ZH" and "ZR")
4071 b bold (termcap entry "md" and "me")
4072 s standout (termcap entry "so" and "se")
4073 u underline (termcap entry "us" and "ue")
Bram Moolenaare2cc9702005-03-15 22:43:58 +00004074 c undercurl (termcap entry "Cs" and "Ce")
Bram Moolenaarcf4b00c2017-09-02 18:33:56 +02004075 t strikethrough (termcap entry "Ts" and "Te")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004076 n no highlighting
4077 - no highlighting
4078 : use a highlight group
4079 The default is used for occasions that are not included.
4080 If you want to change what the display modes do, see |dos-colors|
4081 for an example.
4082 When using the ':' display mode, this must be followed by the name of
4083 a highlight group. A highlight group can be used to define any type
4084 of highlighting, including using color. See |:highlight| on how to
4085 define one. The default uses a different group for each occasion.
4086 See |highlight-default| for the default highlight groups.
4087
Bram Moolenaar071d4272004-06-13 20:20:40 +00004088 *'history'* *'hi'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004089'history' 'hi' number (Vim default: 50, Vi default: 0,
4090 set to 200 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004091 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004092 A history of ":" commands, and a history of previous search patterns
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004093 is remembered. This option decides how many entries may be stored in
Bram Moolenaar071d4272004-06-13 20:20:40 +00004094 each of these histories (see |cmdline-editing|).
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004095 The maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004096 NOTE: This option is set to the Vi default value when 'compatible' is
4097 set and to the Vim default value when 'compatible' is reset.
4098
4099 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
4100'hkmap' 'hk' boolean (default off)
4101 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004102 {only available when compiled with the |+rightleft|
4103 feature}
4104 When on, the keyboard is mapped for the Hebrew character set.
4105 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
4106 toggle this option. See |rileft.txt|.
4107 NOTE: This option is reset when 'compatible' is set.
4108
4109 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
4110'hkmapp' 'hkp' boolean (default off)
4111 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004112 {only available when compiled with the |+rightleft|
4113 feature}
4114 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
4115 This is useful if you have a non-Hebrew keyboard.
4116 See |rileft.txt|.
4117 NOTE: This option is reset when 'compatible' is set.
4118
Bram Moolenaar036986f2017-03-16 17:41:02 +01004119 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
4120'hlsearch' 'hls' boolean (default off)
4121 global
Bram Moolenaar036986f2017-03-16 17:41:02 +01004122 {not available when compiled without the
4123 |+extra_search| feature}
4124 When there is a previous search pattern, highlight all its matches.
4125 The type of highlighting used can be set with the 'l' occasion in the
4126 'highlight' option. This uses the "Search" highlight group by
4127 default. Note that only the matching text is highlighted, any offsets
4128 are not applied.
4129 See also: 'incsearch' and |:match|.
4130 When you get bored looking at the highlighted matches, you can turn it
4131 off with |:nohlsearch|. This does not change the option value, as
4132 soon as you use a search command, the highlighting comes back.
4133 'redrawtime' specifies the maximum time spent on finding matches.
4134 When the search pattern can match an end-of-line, Vim will try to
4135 highlight all of the matched text. However, this depends on where the
4136 search starts. This will be the first line in the window or the first
4137 line below a closed fold. A match in a previous line which is not
4138 drawn may not continue in a newly drawn line.
4139 You can specify whether the highlight status is restored on startup
4140 with the 'h' flag in 'viminfo' |viminfo-h|.
4141 NOTE: This option is reset when 'compatible' is set.
4142
Bram Moolenaar071d4272004-06-13 20:20:40 +00004143 *'icon'* *'noicon'*
4144'icon' boolean (default off, on when title can be restored)
4145 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004146 {not available when compiled without the |+title|
4147 feature}
4148 When on, the icon text of the window will be set to the value of
4149 'iconstring' (if it is not empty), or to the name of the file
4150 currently being edited. Only the last part of the name is used.
4151 Overridden by the 'iconstring' option.
4152 Only works if the terminal supports setting window icons (currently
4153 only X11 GUI and terminals with a non-empty 't_IS' option - these are
4154 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
4155 builtin termcap).
4156 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00004157 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00004158 X11.
Bram Moolenaar3a991dd2014-10-02 01:41:41 +02004159 For MS-Windows the icon can be changed, see |windows-icon|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004160
4161 *'iconstring'*
4162'iconstring' string (default "")
4163 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004164 {not available when compiled without the |+title|
4165 feature}
4166 When this option is not empty, it will be used for the icon text of
4167 the window. This happens only when the 'icon' option is on.
4168 Only works if the terminal supports setting window icon text
4169 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02004170 Does not work for MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004171 When Vim was compiled with HAVE_X11 defined, the original icon will be
4172 restored if possible |X11|.
4173 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004174 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004175 'titlestring' for example settings.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004176 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004177 {not available when compiled without the |+statusline| feature}
4178
4179 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
4180'ignorecase' 'ic' boolean (default off)
4181 global
4182 Ignore case in search patterns. Also used when searching in the tags
4183 file.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01004184 Also see 'smartcase' and 'tagcase'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004185 Can be overruled by using "\c" or "\C" in the pattern, see
4186 |/ignorecase|.
4187
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004188 *'imactivatefunc'* *'imaf'*
4189'imactivatefunc' 'imaf' string (default "")
4190 global
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004191 This option specifies a function that will be called to
Bram Moolenaar2877d332017-11-26 14:56:16 +01004192 activate or deactivate the Input Method.
Bram Moolenaaref8c6172020-07-01 15:12:44 +02004193 It is not used in the MS-Windows GUI version.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004194 The expression will be evaluated in the |sandbox| when set from a
4195 modeline, see |sandbox-option|.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004196
4197 Example: >
4198 function ImActivateFunc(active)
4199 if a:active
4200 ... do something
4201 else
4202 ... do something
4203 endif
4204 " return value is not used
4205 endfunction
4206 set imactivatefunc=ImActivateFunc
4207<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004208 *'imactivatekey'* *'imak'*
4209'imactivatekey' 'imak' string (default "")
4210 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004211 {only available when compiled with |+xim| and
Bram Moolenaar67c53842010-05-22 18:28:27 +02004212 |+GUI_GTK|} *E599*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004213 Specifies the key that your Input Method in X-Windows uses for
4214 activation. When this is specified correctly, vim can fully control
4215 IM with 'imcmdline', 'iminsert' and 'imsearch'.
4216 You can't use this option to change the activation key, the option
4217 tells Vim what the key is.
4218 Format:
4219 [MODIFIER_FLAG-]KEY_STRING
4220
4221 These characters can be used for MODIFIER_FLAG (case is ignored):
4222 S Shift key
4223 L Lock key
4224 C Control key
4225 1 Mod1 key
4226 2 Mod2 key
4227 3 Mod3 key
4228 4 Mod4 key
4229 5 Mod5 key
4230 Combinations are allowed, for example "S-C-space" or "SC-space" are
4231 both shift+ctrl+space.
4232 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
4233
4234 Example: >
4235 :set imactivatekey=S-space
4236< "S-space" means shift+space. This is the activation key for kinput2 +
4237 canna (Japanese), and ami (Korean).
4238
4239 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
4240'imcmdline' 'imc' boolean (default off)
4241 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004242 When set the Input Method is always on when starting to edit a command
4243 line, unless entering a search pattern (see 'imsearch' for that).
4244 Setting this option is useful when your input method allows entering
4245 English characters directly, e.g., when it's used to type accented
4246 characters with dead keys.
4247
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004248 *'imdisable'* *'imd'* *'noimdisable'* *'noimd'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004249'imdisable' 'imd' boolean (default off, on for some systems (SGI))
4250 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004251 When set the Input Method is never used. This is useful to disable
4252 the IM when it doesn't work properly.
4253 Currently this option is on by default for SGI/IRIX machines. This
4254 may change in later releases.
4255
4256 *'iminsert'* *'imi'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004257'iminsert' 'imi' number (default 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004258 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004259 Specifies whether :lmap or an Input Method (IM) is to be used in
4260 Insert mode. Valid values:
4261 0 :lmap is off and IM is off
4262 1 :lmap is ON and IM is off
4263 2 :lmap is off and IM is ON
Bram Moolenaar071d4272004-06-13 20:20:40 +00004264 To always reset the option to zero when leaving Insert mode with <Esc>
4265 this can be used: >
4266 :inoremap <ESC> <ESC>:set iminsert=0<CR>
4267< This makes :lmap and IM turn off automatically when leaving Insert
4268 mode.
4269 Note that this option changes when using CTRL-^ in Insert mode
4270 |i_CTRL-^|.
4271 The value is set to 1 when setting 'keymap' to a valid keymap name.
4272 It is also used for the argument of commands like "r" and "f".
4273 The value 0 may not work correctly with Athena and Motif with some XIM
4274 methods. Use 'imdisable' to disable XIM then.
4275
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004276 You can set 'imactivatefunc' and 'imstatusfunc' to handle IME/XIM
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004277 via external command if Vim is not compiled with the |+xim|,
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004278 |+multi_byte_ime| or |global-ime|.
4279
Bram Moolenaar071d4272004-06-13 20:20:40 +00004280 *'imsearch'* *'ims'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004281'imsearch' 'ims' number (default -1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004282 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004283 Specifies whether :lmap or an Input Method (IM) is to be used when
4284 entering a search pattern. Valid values:
4285 -1 the value of 'iminsert' is used, makes it look like
4286 'iminsert' is also used when typing a search pattern
4287 0 :lmap is off and IM is off
4288 1 :lmap is ON and IM is off
4289 2 :lmap is off and IM is ON
4290 Note that this option changes when using CTRL-^ in Command-line mode
4291 |c_CTRL-^|.
4292 The value is set to 1 when it is not -1 and setting the 'keymap'
4293 option to a valid keymap name.
4294 The value 0 may not work correctly with Athena and Motif with some XIM
4295 methods. Use 'imdisable' to disable XIM then.
4296
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004297 *'imstatusfunc'* *'imsf'*
4298'imstatusfunc' 'imsf' string (default "")
4299 global
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004300 This option specifies a function that is called to obtain the status
4301 of Input Method. It must return a positive number when IME is active.
Bram Moolenaaref8c6172020-07-01 15:12:44 +02004302 It is not used in the MS-Windows GUI version.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004303
4304 Example: >
4305 function ImStatusFunc()
4306 let is_active = ...do something
4307 return is_active ? 1 : 0
4308 endfunction
4309 set imstatusfunc=ImStatusFunc
4310<
4311 NOTE: This function is invoked very often. Keep it fast.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004312 The expression will be evaluated in the |sandbox| when set from a
4313 modeline, see |sandbox-option|.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004314
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004315 *'imstyle'* *'imst'*
4316'imstyle' 'imst' number (default 1)
4317 global
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004318 {only available when compiled with |+xim| and
4319 |+GUI_GTK|}
Bram Moolenaar37c64c72017-09-19 22:06:03 +02004320 This option specifies the input style of Input Method:
4321 0 use on-the-spot style
4322 1 over-the-spot style
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004323 See: |xim-input-style|
4324
Bram Moolenaar24a98a02017-09-27 22:23:55 +02004325 For a long time on-the-spot style had been used in the GTK version of
4326 vim, however, it is known that it causes troubles when using mappings,
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004327 |single-repeat|, etc. Therefore over-the-spot style becomes the
4328 default now. This should work fine for most people, however if you
4329 have any problem with it, try using on-the-spot style.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004330 The expression will be evaluated in the |sandbox| when set from a
4331 modeline, see |sandbox-option|.
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004332
Bram Moolenaar071d4272004-06-13 20:20:40 +00004333 *'include'* *'inc'*
4334'include' 'inc' string (default "^\s*#\s*include")
4335 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004336 {not available when compiled without the
4337 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004338 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00004339 pattern, just like for the "/" command (See |pattern|). The default
4340 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar1e015462005-09-25 22:16:38 +00004341 "]I", "[d", etc.
4342 Normally the 'isfname' option is used to recognize the file name that
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004343 comes after the matched pattern. But if "\zs" appears in the pattern
4344 then the text matched from "\zs" to the end, or until "\ze" if it
4345 appears, is used as the file name. Use this to include characters
4346 that are not in 'isfname', such as a space. You can then use
4347 'includeexpr' to process the matched text.
Bram Moolenaar1e015462005-09-25 22:16:38 +00004348 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004349
4350 *'includeexpr'* *'inex'*
4351'includeexpr' 'inex' string (default "")
4352 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004353 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004354 |+find_in_path| or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004355 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004356 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004357 :set includeexpr=substitute(v:fname,'\\.','/','g')
4358< The "v:fname" variable will be set to the file name that was detected.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004359
Bram Moolenaar071d4272004-06-13 20:20:40 +00004360 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004361 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004362 Also used for |<cfile>|.
4363
Bram Moolenaar30b65812012-07-12 22:01:11 +02004364 The expression will be evaluated in the |sandbox| when set from a
4365 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004366 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004367
4368 It is not allowed to change text or jump to another window while
4369 evaluating 'includeexpr' |textlock|.
4370
Bram Moolenaar071d4272004-06-13 20:20:40 +00004371 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004372'incsearch' 'is' boolean (default off, set in |defaults.vim| if the
4373 +reltime feature is supported)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004374 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004375 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004376 |+extra_search| features}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004377 While typing a search command, show where the pattern, as it was typed
4378 so far, matches. The matched string is highlighted. If the pattern
4379 is invalid or not found, nothing is shown. The screen will be updated
4380 often, this is only useful on fast terminals.
Bram Moolenaarfc65cab2018-08-28 22:58:02 +02004381 Also applies to the pattern in commands: >
4382 :global
4383 :lvimgrep
4384 :lvimgrepadd
4385 :smagic
4386 :snomagic
4387 :sort
4388 :substitute
4389 :vglobal
4390 :vimgrep
4391 :vimgrepadd
4392< Note that the match will be shown, but the cursor will return to its
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004393 original position when no match is found and when pressing <Esc>. You
4394 still need to finish the search command with <Enter> to move the
4395 cursor to the match.
Bram Moolenaardc083282016-10-11 08:57:33 +02004396 You can use the CTRL-G and CTRL-T keys to move to the next and
4397 previous match. |c_CTRL-G| |c_CTRL-T|
Bram Moolenaar91a4e822008-01-19 14:59:58 +00004398 When compiled with the |+reltime| feature Vim only searches for about
4399 half a second. With a complicated pattern and/or a lot of text the
4400 match may not be found. This is to avoid that Vim hangs while you
4401 are typing the pattern.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004402 The highlighting can be set with the 'i' flag in 'highlight'.
Bram Moolenaar2f058492017-11-30 20:27:52 +01004403 When 'hlsearch' is on, all matched strings are highlighted too while
4404 typing a search command. See also: 'hlsearch'.
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004405 If you don't want to turn 'hlsearch' on, but want to highlight all
4406 matches while searching, you can turn on and off 'hlsearch' with
4407 autocmd. Example: >
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004408 augroup vimrc-incsearch-highlight
4409 autocmd!
Bram Moolenaarf8f8b2e2017-11-02 19:08:48 +01004410 autocmd CmdlineEnter /,\? :set hlsearch
4411 autocmd CmdlineLeave /,\? :set nohlsearch
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004412 augroup END
4413<
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004414 CTRL-L can be used to add one character from after the current match
Bram Moolenaara9dc3752010-07-11 20:46:53 +02004415 to the command line. If 'ignorecase' and 'smartcase' are set and the
4416 command line has no uppercase characters, the added character is
4417 converted to lowercase.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004418 CTRL-R CTRL-W can be used to add the word at the end of the current
4419 match, excluding the characters that were already typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004420 NOTE: This option is reset when 'compatible' is set.
4421
4422 *'indentexpr'* *'inde'*
4423'indentexpr' 'inde' string (default "")
4424 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004425 {not available when compiled without the |+cindent|
4426 or |+eval| features}
4427 Expression which is evaluated to obtain the proper indent for a line.
4428 It is used when a new line is created, for the |=| operator and
4429 in Insert mode as specified with the 'indentkeys' option.
4430 When this option is not empty, it overrules the 'cindent' and
Bram Moolenaar20f90cf2011-05-19 12:22:51 +02004431 'smartindent' indenting. When 'lisp' is set, this option is
4432 overridden by the Lisp indentation algorithm.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004433 When 'paste' is set this option is not used for indenting.
4434 The expression is evaluated with |v:lnum| set to the line number for
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004435 which the indent is to be computed. The cursor is also in this line
Bram Moolenaar071d4272004-06-13 20:20:40 +00004436 when the expression is evaluated (but it may be moved around).
4437 The expression must return the number of spaces worth of indent. It
4438 can return "-1" to keep the current indent (this means 'autoindent' is
4439 used for the indent).
4440 Functions useful for computing the indent are |indent()|, |cindent()|
4441 and |lispindent()|.
4442 The evaluation of the expression must not have side effects! It must
4443 not change the text, jump to another window, etc. Afterwards the
4444 cursor position is always restored, thus the cursor may be moved.
4445 Normally this option would be set to call a function: >
4446 :set indentexpr=GetMyIndent()
4447< Error messages will be suppressed, unless the 'debug' option contains
4448 "msg".
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004449 See |indent-expression|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01004450 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004451
Bram Moolenaar30b65812012-07-12 22:01:11 +02004452 The expression will be evaluated in the |sandbox| when set from a
4453 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004454 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004455
4456 It is not allowed to change text or jump to another window while
4457 evaluating 'indentexpr' |textlock|.
4458
4459
Bram Moolenaar071d4272004-06-13 20:20:40 +00004460 *'indentkeys'* *'indk'*
Bram Moolenaarce655742019-01-31 14:12:57 +01004461'indentkeys' 'indk' string (default "0{,0},0),0],:,0#,!^F,o,O,e")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004462 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004463 {not available when compiled without the |+cindent|
4464 feature}
4465 A list of keys that, when typed in Insert mode, cause reindenting of
4466 the current line. Only happens if 'indentexpr' isn't empty.
4467 The format is identical to 'cinkeys', see |indentkeys-format|.
4468 See |C-indenting| and |indent-expression|.
4469
4470 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
4471'infercase' 'inf' boolean (default off)
4472 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004473 When doing keyword completion in insert mode |ins-completion|, and
Bram Moolenaar446cb832008-06-24 21:56:24 +00004474 'ignorecase' is also on, the case of the match is adjusted depending
4475 on the typed text. If the typed text contains a lowercase letter
4476 where the match has an upper case letter, the completed part is made
4477 lowercase. If the typed text has no lowercase letters and the match
4478 has a lowercase letter where the typed text has an uppercase letter,
4479 and there is a letter before it, the completed part is made uppercase.
4480 With 'noinfercase' the match is used as-is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004481
4482 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
4483'insertmode' 'im' boolean (default off)
4484 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004485 Makes Vim work in a way that Insert mode is the default mode. Useful
4486 if you want to use Vim as a modeless editor. Used for |evim|.
4487 These Insert mode commands will be useful:
4488 - Use the cursor keys to move around.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02004489 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|. When
Bram Moolenaar071d4272004-06-13 20:20:40 +00004490 this is a mapping, it is executed as if 'insertmode' was off.
4491 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004492 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00004493 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
4494 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004495
4496 These items change when 'insertmode' is set:
4497 - when starting to edit of a file, Vim goes to Insert mode.
4498 - <Esc> in Insert mode is a no-op and beeps.
4499 - <Esc> in Normal mode makes Vim go to Insert mode.
4500 - CTRL-L in Insert mode is a command, it is not inserted.
4501 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
4502 However, when <Esc> is used inside a mapping, it behaves like
4503 'insertmode' was not set. This was done to be able to use the same
4504 mappings with 'insertmode' set or not set.
4505 When executing commands with |:normal| 'insertmode' is not used.
4506
4507 NOTE: This option is reset when 'compatible' is set.
4508
4509 *'isfname'* *'isf'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004510'isfname' 'isf' string (default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004511 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
4512 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
4513 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
4514 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
4515 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
4516 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004517 The characters specified by this option are included in file names and
4518 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004519 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004520 Multi-byte characters 256 and above are always included, only the
4521 characters up to 255 are specified with this option.
4522 For UTF-8 the characters 0xa0 to 0xff are included as well.
Bram Moolenaar446cb832008-06-24 21:56:24 +00004523 Think twice before adding white space to this option. Although a
4524 space may appear inside a file name, the effect will be that Vim
4525 doesn't know where a file name starts or ends when doing completion.
4526 It most likely works better without a space in 'isfname'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004527
4528 Note that on systems using a backslash as path separator, Vim tries to
4529 do its best to make it work as you would expect. That is a bit
4530 tricky, since Vi originally used the backslash to escape special
4531 characters. Vim will not remove a backslash in front of a normal file
4532 name character on these systems, but it will on Unix and alikes. The
4533 '&' and '^' are not included by default, because these are special for
4534 cmd.exe.
4535
4536 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004537 Each part can be a single character number or a range. A range is two
4538 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004539 decimal number between 0 and 255 or the ASCII character itself (does
4540 not work for digits). Example:
4541 "_,-,128-140,#-43" (include '_' and '-' and the range
4542 128 to 140 and '#' to 43)
4543 If a part starts with '^', the following character number or range
4544 will be excluded from the option. The option is interpreted from left
4545 to right. Put the excluded character after the range where it is
4546 included. To include '^' itself use it as the last character of the
4547 option or the end of a range. Example:
4548 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
4549 If the character is '@', all characters where isalpha() returns TRUE
4550 are included. Normally these are the characters a to z and A to Z,
4551 plus accented characters. To include '@' itself use "@-@". Examples:
4552 "@,^a-z" All alphabetic characters, excluding lower
Bram Moolenaar446cb832008-06-24 21:56:24 +00004553 case ASCII letters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004554 "a-z,A-Z,@-@" All letters plus the '@' character.
4555 A comma can be included by using it where a character number is
4556 expected. Example:
4557 "48-57,,,_" Digits, comma and underscore.
4558 A comma can be excluded by prepending a '^'. Example:
4559 " -~,^,,9" All characters from space to '~', excluding
4560 comma, plus <Tab>.
4561 See |option-backslash| about including spaces and backslashes.
4562
4563 *'isident'* *'isi'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004564'isident' 'isi' string (default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004565 "@,48-57,_,128-167,224-235"
4566 otherwise: "@,48-57,_,192-255")
4567 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004568 The characters given by this option are included in identifiers.
4569 Identifiers are used in recognizing environment variables and after a
4570 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00004571 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004572 option. For '@' only characters up to 255 are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004573 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004574 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00004575 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
4576
4577 *'iskeyword'* *'isk'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004578'iskeyword' 'isk' string (Vim default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004579 "@,48-57,_,128-167,224-235"
4580 otherwise: "@,48-57,_,192-255"
4581 Vi default: "@,48-57,_")
4582 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004583 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004584 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004585 'isfname' for a description of the format of this option. For '@'
Bram Moolenaar4c295022021-05-02 17:19:11 +02004586 characters above 255 check the "word" character class (any character
4587 that is not white space or punctuation).
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004588 For C programs you could use "a-z,A-Z,48-57,_,.,-,>".
Bram Moolenaar071d4272004-06-13 20:20:40 +00004589 For a help file it is set to all non-blank printable characters except
4590 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
4591 command).
4592 When the 'lisp' option is on the '-' character is always included.
Bram Moolenaarb8060fe2016-01-19 22:29:28 +01004593 This option also influences syntax highlighting, unless the syntax
4594 uses |:syn-iskeyword|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004595 NOTE: This option is set to the Vi default value when 'compatible' is
4596 set and to the Vim default value when 'compatible' is reset.
4597
4598 *'isprint'* *'isp'*
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02004599'isprint' 'isp' string (default for Win32 and macOS:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004600 "@,~-255"; otherwise: "@,161-255")
4601 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004602 The characters given by this option are displayed directly on the
4603 screen. It is also used for "\p" in a |pattern|. The characters from
4604 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
4605 even when they are not included in 'isprint' or excluded. See
4606 'isfname' for a description of the format of this option.
4607
4608 Non-printable characters are displayed with two characters:
4609 0 - 31 "^@" - "^_"
4610 32 - 126 always single characters
4611 127 "^?"
4612 128 - 159 "~@" - "~_"
4613 160 - 254 "| " - "|~"
4614 255 "~?"
4615 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
4616 displayed as <xx>, with the hexadecimal value of the byte.
4617 When 'display' contains "uhex" all unprintable characters are
4618 displayed as <xx>.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004619 The SpecialKey highlighting will be used for unprintable characters.
4620 |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004621
4622 Multi-byte characters 256 and above are always included, only the
4623 characters up to 255 are specified with this option. When a character
4624 is printable but it is not available in the current font, a
4625 replacement character will be shown.
4626 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
4627 There is no option to specify these characters.
4628
4629 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
4630'joinspaces' 'js' boolean (default on)
4631 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004632 Insert two spaces after a '.', '?' and '!' with a join command.
4633 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
4634 Otherwise only one space is inserted.
4635 NOTE: This option is set when 'compatible' is set.
4636
4637 *'key'*
4638'key' string (default "")
4639 local to buffer
Bram Moolenaar996343d2010-07-04 22:20:21 +02004640 {only available when compiled with the |+cryptv|
4641 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004642 The key that is used for encrypting and decrypting the current buffer.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02004643 See |encryption| and 'cryptmethod'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004644 Careful: Do not set the key value by hand, someone might see the typed
4645 key. Use the |:X| command. But you can make 'key' empty: >
4646 :set key=
4647< It is not possible to get the value of this option with ":set key" or
4648 "echo &key". This is to avoid showing it to someone who shouldn't
4649 know. It also means you cannot see it yourself once you have set it,
4650 be careful not to make a typing error!
Bram Moolenaard58e9292011-02-09 17:07:58 +01004651 You can use "&key" in an expression to detect whether encryption is
4652 enabled. When 'key' is set it returns "*****" (five stars).
Bram Moolenaar071d4272004-06-13 20:20:40 +00004653
4654 *'keymap'* *'kmp'* *E544*
4655'keymap' 'kmp' string (default "")
4656 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004657 {only available when compiled with the |+keymap|
4658 feature}
4659 Name of a keyboard mapping. See |mbyte-keymap|.
4660 Setting this option to a valid keymap name has the side effect of
4661 setting 'iminsert' to one, so that the keymap becomes effective.
4662 'imsearch' is also set to one, unless it was -1
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004663 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004664
4665 *'keymodel'* *'km'*
4666'keymodel' 'km' string (default "")
4667 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004668 List of comma separated words, which enable special things that keys
4669 can do. These values can be used:
4670 startsel Using a shifted special key starts selection (either
4671 Select mode or Visual mode, depending on "key" being
4672 present in 'selectmode').
4673 stopsel Using a not-shifted special key stops selection.
4674 Special keys in this context are the cursor keys, <End>, <Home>,
4675 <PageUp> and <PageDown>.
4676 The 'keymodel' option is set by the |:behave| command.
4677
4678 *'keywordprg'* *'kp'*
4679'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02004680 VMS: "help")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004681 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004682 Program to use for the |K| command. Environment variables are
4683 expanded |:set_env|. ":help" may be used to access the Vim internal
4684 help. (Note that previously setting the global option to the empty
4685 value did this, which is now deprecated.)
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02004686 When the first character is ":", the command is invoked as a Vim
4687 Ex command prefixed with [count].
4688 When "man", "man -s" or an Ex command is used, Vim will automatically
4689 translate a count for the "K" command and pass it as the first
4690 argument. For "man -s" the "-s" is removed when there is no count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004691 See |option-backslash| about including spaces and backslashes.
4692 Example: >
4693 :set keywordprg=man\ -s
4694< This option cannot be set from a |modeline| or in the |sandbox|, for
4695 security reasons.
4696
4697 *'langmap'* *'lmap'* *E357* *E358*
4698'langmap' 'lmap' string (default "")
4699 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004700 {only available when compiled with the |+langmap|
4701 feature}
4702 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004703 mode. When you are typing text in Insert mode the characters are
Bram Moolenaarfa735342016-01-03 22:14:44 +01004704 inserted directly. When in Normal mode the 'langmap' option takes
Bram Moolenaar071d4272004-06-13 20:20:40 +00004705 care of translating these special characters to the original meaning
4706 of the key. This means you don't have to change the keyboard mode to
4707 be able to execute Normal mode commands.
4708 This is the opposite of the 'keymap' option, where characters are
4709 mapped in Insert mode.
Bram Moolenaarb17893a2020-03-14 08:19:51 +01004710 Also consider setting 'langremap' to off, to prevent 'langmap' from
4711 applying to characters resulting from a mapping.
Bram Moolenaare968e362014-05-13 20:23:24 +02004712 This option cannot be set from a |modeline| or in the |sandbox|, for
4713 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004714
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00004715 Example (for Greek, in UTF-8): *greek* >
4716 :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 +00004717< Example (exchanges meaning of z and y for commands): >
4718 :set langmap=zy,yz,ZY,YZ
4719<
4720 The 'langmap' option is a list of parts, separated with commas. Each
4721 part can be in one of two forms:
4722 1. A list of pairs. Each pair is a "from" character immediately
4723 followed by the "to" character. Examples: "aA", "aAbBcC".
4724 2. A list of "from" characters, a semi-colon and a list of "to"
4725 characters. Example: "abc;ABC"
4726 Example: "aA,fgh;FGH,cCdDeE"
4727 Special characters need to be preceded with a backslash. These are
Bram Moolenaar4f4d51a2020-10-11 13:57:40 +02004728 ";", ',', '"', '|' and backslash itself.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004729
4730 This will allow you to activate vim actions without having to switch
4731 back and forth between the languages. Your language characters will
4732 be understood as normal vim English characters (according to the
4733 langmap mappings) in the following cases:
4734 o Normal/Visual mode (commands, buffer/register names, user mappings)
4735 o Insert/Replace Mode: Register names after CTRL-R
4736 o Insert/Replace Mode: Mappings
4737 Characters entered in Command-line mode will NOT be affected by
4738 this option. Note that this option can be changed at any time
4739 allowing to switch between mappings for different languages/encodings.
4740 Use a mapping to avoid having to type it each time!
4741
4742 *'langmenu'* *'lm'*
4743'langmenu' 'lm' string (default "")
4744 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004745 {only available when compiled with the |+menu| and
4746 |+multi_lang| features}
4747 Language to use for menu translation. Tells which file is loaded
4748 from the "lang" directory in 'runtimepath': >
4749 "lang/menu_" . &langmenu . ".vim"
4750< (without the spaces). For example, to always use the Dutch menus, no
4751 matter what $LANG is set to: >
4752 :set langmenu=nl_NL.ISO_8859-1
4753< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004754 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004755 If your $LANG is set to a non-English language but you do want to use
4756 the English menus: >
4757 :set langmenu=none
4758< This option must be set before loading menus, switching on filetype
4759 detection or syntax highlighting. Once the menus are defined setting
4760 this option has no effect. But you could do this: >
4761 :source $VIMRUNTIME/delmenu.vim
4762 :set langmenu=de_DE.ISO_8859-1
4763 :source $VIMRUNTIME/menu.vim
4764< Warning: This deletes all menus that you defined yourself!
4765
Bram Moolenaard94464e2015-11-02 15:28:18 +01004766 *'langnoremap'* *'lnr'* *'nolangnoremap'* *'nolnr'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004767'langnoremap' 'lnr' boolean (default off, set in |defaults.vim|)
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004768 global
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004769 {only available when compiled with the |+langmap|
4770 feature}
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004771 This is just like 'langremap' but with the value inverted. It only
4772 exists for backwards compatibility. When setting 'langremap' then
4773 'langnoremap' is set to the inverted value, and the other way around.
4774
4775 *'langremap'* *'lrm'* *'nolangremap'* *'nolrm'*
Bram Moolenaarb17893a2020-03-14 08:19:51 +01004776'langremap' 'lrm' boolean (default on, set to off in |defaults.vim|)
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004777 global
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004778 {only available when compiled with the |+langmap|
4779 feature}
4780 When off, setting 'langmap' does not apply to characters resulting from
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004781 a mapping. This basically means, if you noticed that setting
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004782 'langmap' disables some of your mappings, try resetting this option.
4783 This option defaults to on for backwards compatibility. Set it off if
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004784 that works for you to avoid mappings to break.
4785
Bram Moolenaar071d4272004-06-13 20:20:40 +00004786 *'laststatus'* *'ls'*
4787'laststatus' 'ls' number (default 1)
4788 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004789 The value of this option influences when the last window will have a
4790 status line:
4791 0: never
4792 1: only if there are at least two windows
4793 2: always
4794 The screen looks nicer with a status line if you have several
4795 windows, but it takes another screen line. |status-line|
4796
4797 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
4798'lazyredraw' 'lz' boolean (default off)
4799 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004800 When this option is set, the screen will not be redrawn while
4801 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004802 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00004803 update use |:redraw|.
4804
4805 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
4806'linebreak' 'lbr' boolean (default off)
4807 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02004808 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004809 feature}
Bram Moolenaar946e27a2014-06-25 18:50:27 +02004810 If on, Vim will wrap long lines at a character in 'breakat' rather
Bram Moolenaar071d4272004-06-13 20:20:40 +00004811 than at the last character that fits on the screen. Unlike
4812 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
Bram Moolenaar946e27a2014-06-25 18:50:27 +02004813 it only affects the way the file is displayed, not its contents.
4814 If 'breakindent' is set, line is visually indented. Then, the value
4815 of 'showbreak' is used to put in front of wrapped lines. This option
Bram Moolenaar86b17e92014-07-02 20:00:47 +02004816 is not used when the 'wrap' option is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004817 Note that <Tab> characters after an <EOL> are mostly not displayed
4818 with the right amount of white space.
4819
4820 *'lines'* *E593*
4821'lines' number (default 24 or terminal height)
4822 global
4823 Number of lines of the Vim window.
4824 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00004825 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004826 When Vim is running in the GUI or in a resizable window, setting this
4827 option will cause the window size to be changed. When you only want
4828 to use the size for the GUI, put the command in your |gvimrc| file.
4829 Vim limits the number of lines to what fits on the screen. You can
4830 use this command to get the tallest window possible: >
4831 :set lines=999
Bram Moolenaarf4d11452005-12-02 00:46:37 +00004832< Minimum value is 2, maximum value is 1000.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02004833 If you get fewer lines than expected, check the 'guiheadroom' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004834 When you set this option and Vim is unable to change the physical
4835 number of lines of the display, the display may be messed up.
4836
4837 *'linespace'* *'lsp'*
4838'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
4839 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004840 {only in the GUI}
4841 Number of pixel lines inserted between characters. Useful if the font
4842 uses the full character cell height, making lines touch each other.
4843 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004844 With some fonts there can be too much room between lines (to have
4845 space for ascents and descents). Then it makes sense to set
4846 'linespace' to a negative value. This may cause display problems
4847 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00004848
4849 *'lisp'* *'nolisp'*
4850'lisp' boolean (default off)
4851 local to buffer
4852 {not available when compiled without the |+lispindent|
4853 feature}
4854 Lisp mode: When <Enter> is typed in insert mode set the indent for
4855 the next line to Lisp standards (well, sort of). Also happens with
4856 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
4857 flag in 'cpoptions' changes the method of indenting: Vi compatible or
4858 better. Also see 'lispwords'.
4859 The '-' character is included in keyword characters. Redefines the
4860 "=" operator to use this same indentation algorithm rather than
4861 calling an external program if 'equalprg' is empty.
4862 This option is not used when 'paste' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004863
4864 *'lispwords'* *'lw'*
4865'lispwords' 'lw' string (default is very long)
Bram Moolenaaraf6c1312014-03-12 18:55:58 +01004866 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004867 {not available when compiled without the |+lispindent|
4868 feature}
4869 Comma separated list of words that influence the Lisp indenting.
4870 |'lisp'|
4871
4872 *'list'* *'nolist'*
4873'list' boolean (default off)
4874 local to window
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004875 List mode: Show tabs as CTRL-I is displayed, display $ after end of
4876 line. Useful to see the difference between tabs and spaces and for
4877 trailing blanks. Further changed by the 'listchars' option.
4878
4879 The cursor is displayed at the start of the space a Tab character
4880 occupies, not at the end as usual in Normal mode. To get this cursor
4881 position while displaying Tabs with spaces, use: >
Bram Moolenaardd007ed2013-07-09 15:44:17 +02004882 :set list lcs=tab:\ \
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004883<
4884 Note that list mode will also affect formatting (set with 'textwidth'
4885 or 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
Bram Moolenaar071d4272004-06-13 20:20:40 +00004886 changing the way tabs are displayed.
4887
4888 *'listchars'* *'lcs'*
4889'listchars' 'lcs' string (default "eol:$")
Bram Moolenaareed9d462021-02-15 20:38:25 +01004890 global or local to window |global-local|
Bram Moolenaarf9d5ca12010-08-01 16:13:51 +02004891 Strings to use in 'list' mode and for the |:list| command. It is a
4892 comma separated list of string settings.
Bram Moolenaar79278362015-04-21 18:33:48 +02004893 *lcs-eol*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004894 eol:c Character to show at the end of each line. When
4895 omitted, there is no extra character at the end of the
4896 line.
Bram Moolenaar79278362015-04-21 18:33:48 +02004897 *lcs-tab*
Bram Moolenaar83a52172019-01-16 22:41:54 +01004898 tab:xy[z] Two or three characters to be used to show a tab.
4899 The third character is optional.
4900
4901 tab:xy The 'x' is always used, then 'y' as many times as will
4902 fit. Thus "tab:>-" displays:
4903 >
4904 >-
4905 >--
4906 etc.
4907
4908 tab:xyz The 'z' is always used, then 'x' is prepended, and
4909 then 'y' is used as many times as will fit. Thus
4910 "tab:<->" displays:
4911 >
4912 <>
4913 <->
4914 <-->
4915 etc.
4916
4917 When "tab:" is omitted, a tab is shown as ^I.
Bram Moolenaar79278362015-04-21 18:33:48 +02004918 *lcs-space*
4919 space:c Character to show for a space. When omitted, spaces
4920 are left blank.
Bram Moolenaar91478ae2021-02-03 15:58:13 +01004921 *lcs-lead*
4922 lead:c Character to show for leading spaces. When omitted,
4923 leading spaces are blank. Overrides the "space"
Bram Moolenaar942db232021-02-13 18:14:48 +01004924 setting for leading spaces. You can combine it with
4925 "tab:", for example: >
4926 :set listchars+=tab:>-,lead:.
4927< *lcs-trail*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004928 trail:c Character to show for trailing spaces. When omitted,
Bram Moolenaar79278362015-04-21 18:33:48 +02004929 trailing spaces are blank. Overrides the "space"
4930 setting for trailing spaces.
4931 *lcs-extends*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004932 extends:c Character to show in the last column, when 'wrap' is
4933 off and the line continues beyond the right of the
4934 screen.
Bram Moolenaar79278362015-04-21 18:33:48 +02004935 *lcs-precedes*
Bram Moolenaarbffba7f2019-09-20 17:00:17 +02004936 precedes:c Character to show in the first visible column of the
4937 physical line, when there is text preceding the
4938 character visible in the first column.
Bram Moolenaar79278362015-04-21 18:33:48 +02004939 *lcs-conceal*
Bram Moolenaar860cae12010-06-05 23:22:07 +02004940 conceal:c Character to show in place of concealed text, when
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004941 'conceallevel' is set to 1.
Bram Moolenaar79278362015-04-21 18:33:48 +02004942 *lcs-nbsp*
Bram Moolenaar73284b92015-05-04 17:28:22 +02004943 nbsp:c Character to show for a non-breakable space character
4944 (0xA0 (160 decimal) and U+202F). Left blank when
4945 omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004946
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004947 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00004948 be used when 'encoding' is "utf-8", otherwise only printable
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004949 characters are allowed. All characters must be single width.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004950
4951 Examples: >
4952 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004953 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00004954 :set lcs=extends:>,precedes:<
4955< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaar79278362015-04-21 18:33:48 +02004956 "precedes". "SpecialKey" for "nbsp", "space", "tab" and "trail".
Bram Moolenaar02467872007-05-06 13:22:01 +00004957 |hl-NonText| |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004958
4959 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
4960'loadplugins' 'lpl' boolean (default on)
4961 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004962 When on the plugin scripts are loaded when starting up |load-plugins|.
4963 This option can be reset in your |vimrc| file to disable the loading
4964 of plugins.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02004965 Note that using the "-u NONE", "-u DEFAULTS" and "--noplugin" command
4966 line arguments reset this option. See |-u| and |--noplugin|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004967
Bram Moolenaard94464e2015-11-02 15:28:18 +01004968 *'luadll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01004969'luadll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01004970 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01004971 {only available when compiled with the |+lua/dyn|
4972 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01004973 Specifies the name of the Lua shared library. The default is
4974 DYNAMIC_LUA_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02004975 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01004976 This option cannot be set from a |modeline| or in the |sandbox|, for
4977 security reasons.
4978
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00004979 *'macatsui'* *'nomacatsui'*
4980'macatsui' boolean (default on)
4981 global
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02004982 {not supported}
4983 No longer supported, as the Mac OS X GUI code was removed.
Bram Moolenaar02467872007-05-06 13:22:01 +00004984
Bram Moolenaar071d4272004-06-13 20:20:40 +00004985 *'magic'* *'nomagic'*
4986'magic' boolean (default on)
4987 global
4988 Changes the special characters that can be used in search patterns.
4989 See |pattern|.
Bram Moolenaar64d8e252016-09-06 22:12:34 +02004990 WARNING: Switching this option off most likely breaks plugins! That
4991 is because many patterns assume it's on and will fail when it's off.
4992 Only switch it off when working with old Vi scripts. In any other
4993 situation write patterns that work when 'magic' is on. Include "\M"
4994 when you want to |/\M|.
Bram Moolenaar4072ba52020-12-23 13:56:35 +01004995 In |Vim9| script the value of 'magic' is ignored, patterns behave like
4996 it is always set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004997
4998 *'makeef'* *'mef'*
4999'makeef' 'mef' string (default: "")
5000 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005001 {not available when compiled without the |+quickfix|
5002 feature}
5003 Name of the errorfile for the |:make| command (see |:make_makeprg|)
5004 and the |:grep| command.
5005 When it is empty, an internally generated temp file will be used.
5006 When "##" is included, it is replaced by a number to make the name
5007 unique. This makes sure that the ":make" command doesn't overwrite an
5008 existing file.
5009 NOT used for the ":cf" command. See 'errorfile' for that.
5010 Environment variables are expanded |:set_env|.
5011 See |option-backslash| about including spaces and backslashes.
5012 This option cannot be set from a |modeline| or in the |sandbox|, for
5013 security reasons.
5014
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01005015 *'makeencoding'* *'menc'*
5016'makeencoding' 'menc' string (default "")
5017 global or local to buffer |global-local|
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01005018 Encoding used for reading the output of external commands. When empty,
5019 encoding is not converted.
5020 This is used for `:make`, `:lmake`, `:grep`, `:lgrep`, `:grepadd`,
5021 `:lgrepadd`, `:cfile`, `:cgetfile`, `:caddfile`, `:lfile`, `:lgetfile`,
5022 and `:laddfile`.
5023
5024 This would be mostly useful when you use MS-Windows and set 'encoding'
5025 to "utf-8". If |+iconv| is enabled and GNU libiconv is used, setting
5026 'makeencoding' to "char" has the same effect as setting to the system
5027 locale encoding. Example: >
5028 :set encoding=utf-8
5029 :set makeencoding=char " system locale is used
5030<
Bram Moolenaar071d4272004-06-13 20:20:40 +00005031 *'makeprg'* *'mp'*
5032'makeprg' 'mp' string (default "make", VMS: "MMS")
5033 global or local to buffer |global-local|
Bram Moolenaar02467872007-05-06 13:22:01 +00005034 Program to use for the ":make" command. See |:make_makeprg|.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01005035 This option may contain '%' and '#' characters (see |:_%| and |:_#|),
5036 which are expanded to the current and alternate file name. Use |::S|
Bram Moolenaar26df0922014-02-23 23:39:13 +01005037 to escape file names in case they contain special characters.
Bram Moolenaar02467872007-05-06 13:22:01 +00005038 Environment variables are expanded |:set_env|. See |option-backslash|
5039 about including spaces and backslashes.
5040 Note that a '|' must be escaped twice: once for ":set" and once for
5041 the interpretation of a command. When you use a filter called
5042 "myfilter" do it like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005043 :set makeprg=gmake\ \\\|\ myfilter
5044< The placeholder "$*" can be given (even multiple times) to specify
5045 where the arguments will be included, for example: >
5046 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
5047< This option cannot be set from a |modeline| or in the |sandbox|, for
5048 security reasons.
5049
5050 *'matchpairs'* *'mps'*
5051'matchpairs' 'mps' string (default "(:),{:},[:]")
5052 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005053 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01005054 other.
5055 Only character pairs are allowed that are different, thus you cannot
5056 jump between two double quotes.
5057 The characters must be separated by a colon.
Bram Moolenaar02467872007-05-06 13:22:01 +00005058 The pairs must be separated by a comma. Example for including '<' and
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02005059 '>' (for HTML): >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005060 :set mps+=<:>
5061
5062< A more exotic example, to jump between the '=' and ';' in an
5063 assignment, useful for languages like C and Java: >
5064 :au FileType c,cpp,java set mps+==:;
5065
5066< For a more advanced way of using "%", see the matchit.vim plugin in
Bram Moolenaar01164a62017-11-02 22:58:42 +01005067 the $VIMRUNTIME/pack/dist/opt/matchit directory. |add-local-help|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005068
5069 *'matchtime'* *'mat'*
5070'matchtime' 'mat' number (default 5)
5071 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005072 Tenths of a second to show the matching paren, when 'showmatch' is
5073 set. Note that this is not in milliseconds, like other options that
5074 set a time. This is to be compatible with Nvi.
5075
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005076 *'maxcombine'* *'mco'*
5077'maxcombine' 'mco' number (default 2)
5078 global
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005079 The maximum number of combining characters supported for displaying.
5080 Only used when 'encoding' is "utf-8".
5081 The default is OK for most languages. Hebrew may require 4.
5082 Maximum value is 6.
5083 Even when this option is set to 2 you can still edit text with more
5084 combining characters, you just can't see them. Use |g8| or |ga|.
5085 See |mbyte-combining|.
5086
Bram Moolenaar071d4272004-06-13 20:20:40 +00005087 *'maxfuncdepth'* *'mfd'*
5088'maxfuncdepth' 'mfd' number (default 100)
5089 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02005090 {not available when compiled without the |+eval|
Bram Moolenaar02467872007-05-06 13:22:01 +00005091 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005092 Maximum depth of function calls for user functions. This normally
5093 catches endless recursion. When using a recursive function with
5094 more depth, set 'maxfuncdepth' to a bigger number. But this will use
5095 more memory, there is the danger of failing when memory is exhausted.
Bram Moolenaarbc2eada2017-01-02 21:27:47 +01005096 Increasing this limit above 200 also changes the maximum for Ex
Bram Moolenaar0b0f0992018-05-22 21:41:30 +02005097 command recursion, see |E169|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005098 See also |:function|.
5099
5100 *'maxmapdepth'* *'mmd'* *E223*
5101'maxmapdepth' 'mmd' number (default 1000)
5102 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005103 Maximum number of times a mapping is done without resulting in a
5104 character to be used. This normally catches endless mappings, like
5105 ":map x y" with ":map y x". It still does not catch ":map g wg",
5106 because the 'w' is used before the next mapping is done. See also
5107 |key-mapping|.
5108
5109 *'maxmem'* *'mm'*
5110'maxmem' 'mm' number (default between 256 to 5120 (system
5111 dependent) or half the amount of memory
5112 available)
5113 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005114 Maximum amount of memory (in Kbyte) to use for one buffer. When this
5115 limit is reached allocating extra memory for a buffer will cause
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005116 other memory to be freed.
5117 The maximum usable value is about 2000000. Use this to work without a
5118 limit.
5119 The value is ignored when 'swapfile' is off.
5120 Also see 'maxmemtot'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005121
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005122 *'maxmempattern'* *'mmp'*
5123'maxmempattern' 'mmp' number (default 1000)
5124 global
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005125 Maximum amount of memory (in Kbyte) to use for pattern matching.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005126 The maximum value is about 2000000. Use this to work without a limit.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005127 *E363*
Bram Moolenaar02467872007-05-06 13:22:01 +00005128 When Vim runs into the limit it gives an error message and mostly
5129 behaves like CTRL-C was typed.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005130 Running into the limit often means that the pattern is very
5131 inefficient or too complex. This may already happen with the pattern
5132 "\(.\)*" on a very long line. ".*" works much better.
Bram Moolenaarfd358112018-07-07 23:21:31 +02005133 Might also happen on redraw, when syntax rules try to match a complex
5134 text structure.
5135 Vim may run out of memory before hitting the 'maxmempattern' limit, in
5136 which case you get an "Out of memory" error instead.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005137
Bram Moolenaar071d4272004-06-13 20:20:40 +00005138 *'maxmemtot'* *'mmt'*
5139'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
5140 dependent) or half the amount of memory
5141 available)
5142 global
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005143 Maximum amount of memory in Kbyte to use for all buffers together.
5144 The maximum usable value is about 2000000 (2 Gbyte). Use this to work
Bram Moolenaarfa735342016-01-03 22:14:44 +01005145 without a limit.
5146 On 64 bit machines higher values might work. But hey, do you really
5147 need more than 2 Gbyte for text editing? Keep in mind that text is
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005148 stored in the swap file, one can edit files > 2 Gbyte anyway. We do
Bram Moolenaarfa735342016-01-03 22:14:44 +01005149 need the memory to store undo info.
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005150 Buffers with 'swapfile' off still count to the total amount of memory
5151 used.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005152 Also see 'maxmem'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005153
5154 *'menuitems'* *'mis'*
5155'menuitems' 'mis' number (default 25)
5156 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005157 {not available when compiled without the |+menu|
5158 feature}
5159 Maximum number of items to use in a menu. Used for menus that are
5160 generated from a list of items, e.g., the Buffers menu. Changing this
5161 option has no direct effect, the menu must be refreshed first.
5162
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005163 *'mkspellmem'* *'msm'*
5164'mkspellmem' 'msm' string (default "460000,2000,500")
5165 global
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005166 {not available when compiled without the |+syntax|
5167 feature}
5168 Parameters for |:mkspell|. This tunes when to start compressing the
5169 word tree. Compression can be slow when there are many words, but
5170 it's needed to avoid running out of memory. The amount of memory used
5171 per word depends very much on how similar the words are, that's why
5172 this tuning is complicated.
5173
5174 There are three numbers, separated by commas:
5175 {start},{inc},{added}
5176
5177 For most languages the uncompressed word tree fits in memory. {start}
5178 gives the amount of memory in Kbyte that can be used before any
5179 compression is done. It should be a bit smaller than the amount of
5180 memory that is available to Vim.
5181
5182 When going over the {start} limit the {inc} number specifies the
5183 amount of memory in Kbyte that can be allocated before another
5184 compression is done. A low number means compression is done after
5185 less words are added, which is slow. A high number means more memory
5186 will be allocated.
5187
5188 After doing compression, {added} times 1024 words can be added before
5189 the {inc} limit is ignored and compression is done when any extra
5190 amount of memory is needed. A low number means there is a smaller
5191 chance of hitting the {inc} limit, less memory is used but it's
5192 slower.
5193
5194 The languages for which these numbers are important are Italian and
5195 Hungarian. The default works for when you have about 512 Mbyte. If
5196 you have 1 Gbyte you could use: >
5197 :set mkspellmem=900000,3000,800
5198< If you have less than 512 Mbyte |:mkspell| may fail for some
5199 languages, no matter what you set 'mkspellmem' to.
5200
Bram Moolenaar07607392019-05-26 19:20:43 +02005201 This option cannot be set from a |modeline| or in the |sandbox|.
5202
Bram Moolenaar071d4272004-06-13 20:20:40 +00005203 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
Bram Moolenaar8243a792007-05-01 17:05:03 +00005204'modeline' 'ml' boolean (Vim default: on (off for root),
5205 Vi default: off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005206 local to buffer
Bram Moolenaar110289e2019-05-23 15:38:06 +02005207 If 'modeline' is on 'modelines' gives the number of lines that is
5208 checked for set commands. If 'modeline' is off or 'modelines' is zero
5209 no lines are checked. See |modeline|.
5210
5211 *'modelineexpr'* *'mle'* *'nomodelineexpr'* *'nomle'*
5212'modelineexpr' 'mle' boolean (default: off)
5213 global
5214 When on allow some options that are an expression to be set in the
5215 modeline. Check the option for whether it is affected by
5216 'modelineexpr'. Also see |modeline|.
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02005217 This option cannot be set from a |modeline| or in the |sandbox|, for
5218 security reasons.
Bram Moolenaar110289e2019-05-23 15:38:06 +02005219
Bram Moolenaar071d4272004-06-13 20:20:40 +00005220 *'modelines'* *'mls'*
5221'modelines' 'mls' number (default 5)
5222 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005223 If 'modeline' is on 'modelines' gives the number of lines that is
5224 checked for set commands. If 'modeline' is off or 'modelines' is zero
5225 no lines are checked. See |modeline|.
5226 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
5227 set and to the Vim default value when 'compatible' is reset.
5228
5229 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
Bram Moolenaar110289e2019-05-23 15:38:06 +02005230 *E21*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005231'modifiable' 'ma' boolean (default on)
5232 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005233 When off the buffer contents cannot be changed. The 'fileformat' and
5234 'fileencoding' options also can't be changed.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01005235 Can be reset on startup with the |-M| command line argument.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005236
5237 *'modified'* *'mod'* *'nomodified'* *'nomod'*
5238'modified' 'mod' boolean (default off)
5239 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005240 When on, the buffer is considered to be modified. This option is set
5241 when:
5242 1. A change was made to the text since it was last written. Using the
5243 |undo| command to go back to the original text will reset the
5244 option. But undoing changes that were made before writing the
5245 buffer will set the option again, since the text is different from
5246 when it was written.
5247 2. 'fileformat' or 'fileencoding' is different from its original
5248 value. The original value is set when the buffer is read or
5249 written. A ":set nomodified" command also resets the original
5250 values to the current values and the 'modified' option will be
5251 reset.
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01005252 Similarly for 'eol' and 'bomb'.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02005253 This option is not set when a change is made to the buffer as the
5254 result of a BufNewFile, BufRead/BufReadPost, BufWritePost,
5255 FileAppendPost or VimLeave autocommand event. See |gzip-example| for
5256 an explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005257 When 'buftype' is "nowrite" or "nofile" this option may be set, but
5258 will be ignored.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01005259 Note that the text may actually be the same, e.g. 'modified' is set
5260 when using "rA" on an "A".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005261
5262 *'more'* *'nomore'*
5263'more' boolean (Vim default: on, Vi default: off)
5264 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005265 When on, listings pause when the whole screen is filled. You will get
5266 the |more-prompt|. When this option is off there are no pauses, the
5267 listing continues until finished.
5268 NOTE: This option is set to the Vi default value when 'compatible' is
5269 set and to the Vim default value when 'compatible' is reset.
5270
Bram Moolenaar98a29d02021-01-18 19:55:44 +01005271 *'mouse'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005272'mouse' string (default "", "a" for GUI and Win32,
Bram Moolenaar5b418992019-10-27 18:50:25 +01005273 set to "a" or "nvi" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005274 global
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005275 Enable the use of the mouse. Works for most terminals (xterm, Win32
5276 |win32-mouse|, QNX pterm, *BSD console with sysmouse and Linux console
5277 with gpm). For using the mouse in the GUI, see |gui-mouse|. The
5278 mouse can be enabled for different modes:
Bram Moolenaar7f2e9d72017-11-11 20:58:53 +01005279 n Normal mode and Terminal modes
Bram Moolenaar071d4272004-06-13 20:20:40 +00005280 v Visual mode
5281 i Insert mode
5282 c Command-line mode
5283 h all previous modes when editing a help file
5284 a all previous modes
5285 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005286 Normally you would enable the mouse in all five modes with: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005287 :set mouse=a
Bram Moolenaar5b418992019-10-27 18:50:25 +01005288< If your terminal can't overrule the mouse events going to the
5289 application, use: >
5290 :set mouse=nvi
Bram Moolenaar65e0d772020-06-14 17:29:55 +02005291< Then you can press ":", select text for the system, and press Esc to go
Bram Moolenaar5b418992019-10-27 18:50:25 +01005292 back to Vim using the mouse events.
5293 In |defaults.vim| "nvi" is used if the 'term' option is not matching
5294 "xterm".
5295
5296 When the mouse is not enabled, the GUI will still use the mouse for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005297 modeless selection. This doesn't move the text cursor.
5298
5299 See |mouse-using|. Also see |'clipboard'|.
5300
5301 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005302 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005303 the mouse buttons can still be used by keeping the shift key pressed.
5304 Also see the 'clipboard' option.
5305
5306 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
5307'mousefocus' 'mousef' boolean (default off)
5308 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005309 {only works in the GUI}
5310 The window that the mouse pointer is on is automatically activated.
5311 When changing the window layout or window focus in another way, the
5312 mouse pointer is moved to the window with keyboard focus. Off is the
5313 default because it makes using the pull down menus a little goofy, as
5314 a pointer transit may activate a window unintentionally.
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01005315 MS-Windows: Also see 'scrollfocus' for what window is scrolled when
Bram Moolenaar1d9215b2020-01-25 13:27:42 +01005316 using the mouse scroll wheel.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005317
5318 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
5319'mousehide' 'mh' boolean (default on)
5320 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005321 {only works in the GUI}
5322 When on, the mouse pointer is hidden when characters are typed.
5323 The mouse pointer is restored when the mouse is moved.
5324
5325 *'mousemodel'* *'mousem'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005326'mousemodel' 'mousem' string (default "extend", "popup" for Win32)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005327 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005328 Sets the model to use for the mouse. The name mostly specifies what
5329 the right mouse button is used for:
5330 extend Right mouse button extends a selection. This works
5331 like in an xterm.
5332 popup Right mouse button pops up a menu. The shifted left
5333 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00005334 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005335 popup_setpos Like "popup", but the cursor will be moved to the
5336 position where the mouse was clicked, and thus the
5337 selected operation will act upon the clicked object.
5338 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00005339 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005340 course, that right clicking outside a selection will
5341 end Visual mode.
5342 Overview of what button does what for each model:
5343 mouse extend popup(_setpos) ~
5344 left click place cursor place cursor
5345 left drag start selection start selection
5346 shift-left search word extend selection
5347 right click extend selection popup menu (place cursor)
5348 right drag extend selection -
5349 middle click paste paste
5350
5351 In the "popup" model the right mouse button produces a pop-up menu.
5352 You need to define this first, see |popup-menu|.
5353
5354 Note that you can further refine the meaning of buttons with mappings.
5355 See |gui-mouse-mapping|. But mappings are NOT used for modeless
5356 selection (because that's handled in the GUI code directly).
5357
5358 The 'mousemodel' option is set by the |:behave| command.
5359
5360 *'mouseshape'* *'mouses'* *E547*
Bram Moolenaarf6b40102019-02-22 15:24:03 +01005361'mouseshape' 'mouses' string (default "i-r:beam,s:updown,sd:udsizing,
5362 vs:leftright,vd:lrsizing,m:no,
5363 ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005364 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005365 {only available when compiled with the |+mouseshape|
5366 feature}
5367 This option tells Vim what the mouse pointer should look like in
5368 different modes. The option is a comma separated list of parts, much
5369 like used for 'guicursor'. Each part consist of a mode/location-list
5370 and an argument-list:
5371 mode-list:shape,mode-list:shape,..
5372 The mode-list is a dash separated list of these modes/locations:
5373 In a normal window: ~
5374 n Normal mode
5375 v Visual mode
5376 ve Visual mode with 'selection' "exclusive" (same as 'v',
5377 if not specified)
5378 o Operator-pending mode
5379 i Insert mode
5380 r Replace mode
5381
5382 Others: ~
5383 c appending to the command-line
5384 ci inserting in the command-line
5385 cr replacing in the command-line
5386 m at the 'Hit ENTER' or 'More' prompts
5387 ml idem, but cursor in the last line
5388 e any mode, pointer below last window
5389 s any mode, pointer on a status line
5390 sd any mode, while dragging a status line
5391 vs any mode, pointer on a vertical separator line
5392 vd any mode, while dragging a vertical separator line
5393 a everywhere
5394
5395 The shape is one of the following:
5396 avail name looks like ~
5397 w x arrow Normal mouse pointer
5398 w x blank no pointer at all (use with care!)
5399 w x beam I-beam
5400 w x updown up-down sizing arrows
5401 w x leftright left-right sizing arrows
5402 w x busy The system's usual busy pointer
5403 w x no The system's usual 'no input' pointer
5404 x udsizing indicates up-down resizing
5405 x lrsizing indicates left-right resizing
5406 x crosshair like a big thin +
5407 x hand1 black hand
5408 x hand2 white hand
5409 x pencil what you write with
5410 x question big ?
5411 x rightup-arrow arrow pointing right-up
5412 w x up-arrow arrow pointing up
5413 x <number> any X11 pointer number (see X11/cursorfont.h)
5414
5415 The "avail" column contains a 'w' if the shape is available for Win32,
5416 x for X11.
5417 Any modes not specified or shapes not available use the normal mouse
5418 pointer.
5419
5420 Example: >
5421 :set mouseshape=s:udsizing,m:no
5422< will make the mouse turn to a sizing arrow over the status lines and
5423 indicate no input when the hit-enter prompt is displayed (since
5424 clicking the mouse has no effect in this state.)
5425
5426 *'mousetime'* *'mouset'*
5427'mousetime' 'mouset' number (default 500)
5428 global
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005429 Only for GUI, Win32 and Unix with xterm. Defines the maximum
Bram Moolenaar071d4272004-06-13 20:20:40 +00005430 time in msec between two mouse clicks for the second click to be
5431 recognized as a multi click.
5432
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005433 *'mzschemedll'*
5434'mzschemedll' string (default depends on the build)
5435 global
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005436 {only available when compiled with the |+mzscheme/dyn|
5437 feature}
5438 Specifies the name of the MzScheme shared library. The default is
5439 DYNAMIC_MZSCH_DLL which was specified at compile time.
5440 Environment variables are expanded |:set_env|.
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01005441 The value must be set in the |vimrc| script or earlier. In the
Bram Moolenaar01164a62017-11-02 22:58:42 +01005442 startup, before the |load-plugins| step.
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005443 This option cannot be set from a |modeline| or in the |sandbox|, for
5444 security reasons.
5445
5446 *'mzschemegcdll'*
5447'mzschemegcdll' string (default depends on the build)
5448 global
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005449 {only available when compiled with the |+mzscheme/dyn|
5450 feature}
5451 Specifies the name of the MzScheme GC shared library. The default is
5452 DYNAMIC_MZGC_DLL which was specified at compile time.
5453 The value can be equal to 'mzschemedll' if it includes the GC code.
5454 Environment variables are expanded |:set_env|.
5455 This option cannot be set from a |modeline| or in the |sandbox|, for
5456 security reasons.
5457
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005458 *'mzquantum'* *'mzq'*
5459'mzquantum' 'mzq' number (default 100)
5460 global
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005461 {not available when compiled without the |+mzscheme|
5462 feature}
5463 The number of milliseconds between polls for MzScheme threads.
5464 Negative or zero value means no thread scheduling.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005465 NOTE: This option is set to the Vim default value when 'compatible'
5466 is reset.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005467
Bram Moolenaar071d4272004-06-13 20:20:40 +00005468 *'nrformats'* *'nf'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02005469'nrformats' 'nf' string (default "bin,octal,hex",
5470 set to "bin,hex" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005471 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005472 This defines what bases Vim will consider for numbers when using the
5473 CTRL-A and CTRL-X commands for adding to and subtracting from a number
5474 respectively; see |CTRL-A| for more info on these commands.
Bram Moolenaar4770d092006-01-12 23:22:24 +00005475 alpha If included, single alphabetical characters will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005476 incremented or decremented. This is useful for a list with a
Bram Moolenaar3848e002016-03-19 18:42:29 +01005477 letter index a), b), etc. *octal-nrformats*
Bram Moolenaar4770d092006-01-12 23:22:24 +00005478 octal If included, numbers that start with a zero will be considered
Bram Moolenaar071d4272004-06-13 20:20:40 +00005479 to be octal. Example: Using CTRL-A on "007" results in "010".
Bram Moolenaar4770d092006-01-12 23:22:24 +00005480 hex If included, numbers starting with "0x" or "0X" will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005481 considered to be hexadecimal. Example: Using CTRL-X on
5482 "0x100" results in "0x0ff".
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005483 bin If included, numbers starting with "0b" or "0B" will be
5484 considered to be binary. Example: Using CTRL-X on
5485 "0b1000" subtracts one, resulting in "0b0111".
Bram Moolenaaraaad9952020-05-31 15:08:59 +02005486 unsigned If included, numbers are recognized as unsigned. Thus a
5487 leading dash or negative sign won't be considered as part of
5488 the number. Examples:
5489 Using CTRL-X on "2020" in "9-2020" results in "9-2019"
5490 (without "unsigned" it would become "9-2021").
5491 Using CTRL-A on "2020" in "9-2020" results in "9-2021"
5492 (without "unsigned" it would become "9-2019").
Bram Moolenaaracc22402020-06-07 21:07:18 +02005493 Using CTRL-X on "0" or CTRL-A on "18446744073709551615"
5494 (2^64 - 1) has no effect, overflow is prevented.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005495 Numbers which simply begin with a digit in the range 1-9 are always
5496 considered decimal. This also happens for numbers that are not
5497 recognized as octal or hex.
5498
5499 *'number'* *'nu'* *'nonumber'* *'nonu'*
5500'number' 'nu' boolean (default off)
5501 local to window
5502 Print the line number in front of each line. When the 'n' option is
5503 excluded from 'cpoptions' a wrapped line will not use the column of
5504 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005505 The 'numberwidth' option can be used to set the room used for the line
5506 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005507 When a long, wrapped line doesn't start with the first character, '-'
5508 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02005509 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
5510 the number.
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005511 *number_relativenumber*
5512 The 'relativenumber' option changes the displayed number to be
5513 relative to the cursor. Together with 'number' there are these
5514 four combinations (cursor in line 3):
5515
Bram Moolenaar3848e002016-03-19 18:42:29 +01005516 'nonu' 'nu' 'nonu' 'nu'
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005517 'nornu' 'nornu' 'rnu' 'rnu'
5518
5519 |apple | 1 apple | 2 apple | 2 apple
5520 |pear | 2 pear | 1 pear | 1 pear
5521 |nobody | 3 nobody | 0 nobody |3 nobody
5522 |there | 4 there | 1 there | 1 there
Bram Moolenaar071d4272004-06-13 20:20:40 +00005523
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005524 *'numberwidth'* *'nuw'*
5525'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
5526 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005527 {only available when compiled with the |+linebreak|
5528 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005529 Minimal number of columns to use for the line number. Only relevant
Bram Moolenaar64486672010-05-16 15:46:46 +02005530 when the 'number' or 'relativenumber' option is set or printing lines
5531 with a line number. Since one space is always between the number and
5532 the text, there is one less character for the number itself.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005533 The value is the minimum width. A bigger width is used when needed to
Bram Moolenaar64486672010-05-16 15:46:46 +02005534 fit the highest line number in the buffer respectively the number of
5535 rows in the window, depending on whether 'number' or 'relativenumber'
5536 is set. Thus with the Vim default of 4 there is room for a line number
5537 up to 999. When the buffer has 1000 lines five columns will be used.
Bram Moolenaarf8a07122019-07-01 22:06:07 +02005538 The minimum value is 1, the maximum value is 20.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005539 NOTE: This option is set to the Vi default value when 'compatible' is
5540 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005541
Bram Moolenaarf75a9632005-09-13 21:20:47 +00005542 *'omnifunc'* *'ofu'*
5543'omnifunc' 'ofu' string (default: empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00005544 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02005545 {not available when compiled without the |+eval|
Bram Moolenaare2c453d2019-08-21 14:37:09 +02005546 feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00005547 This option specifies a function to be used for Insert mode omni
5548 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
Bram Moolenaar280f1262006-01-30 00:14:18 +00005549 See |complete-functions| for an explanation of how the function is
5550 invoked and what it should return.
Bram Moolenaar043545e2006-10-10 16:44:07 +00005551 This option is usually set by a filetype plugin:
Bram Moolenaar9c102382006-05-03 21:26:49 +00005552 |:filetype-plugin-on|
Bram Moolenaar30b65812012-07-12 22:01:11 +02005553 This option cannot be set from a |modeline| or in the |sandbox|, for
5554 security reasons.
Bram Moolenaare344bea2005-09-01 20:46:49 +00005555
5556
Bram Moolenaar02467872007-05-06 13:22:01 +00005557 *'opendevice'* *'odev'* *'noopendevice'* *'noodev'*
Bram Moolenaar043545e2006-10-10 16:44:07 +00005558'opendevice' 'odev' boolean (default off)
5559 global
Bram Moolenaar6f345a12019-12-17 21:27:18 +01005560 {only for MS-Windows}
Bram Moolenaar043545e2006-10-10 16:44:07 +00005561 Enable reading and writing from devices. This may get Vim stuck on a
5562 device that can be opened but doesn't actually do the I/O. Therefore
5563 it is off by default.
5564 Note that on MS-Windows editing "aux.h", "lpt1.txt" and the like also
5565 result in editing a device.
5566
5567
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005568 *'operatorfunc'* *'opfunc'*
5569'operatorfunc' 'opfunc' string (default: empty)
5570 global
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005571 This option specifies a function to be called by the |g@| operator.
5572 See |:map-operator| for more info and an example.
5573
5574 This option cannot be set from a |modeline| or in the |sandbox|, for
5575 security reasons.
5576
5577
Bram Moolenaar251e1912011-06-19 05:09:16 +02005578 *'osfiletype'* *'oft'*
5579'osfiletype' 'oft' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005580 local to buffer
Bram Moolenaar251e1912011-06-19 05:09:16 +02005581 This option was supported on RISC OS, which has been removed.
5582
Bram Moolenaar071d4272004-06-13 20:20:40 +00005583
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005584 *'packpath'* *'pp'*
5585'packpath' 'pp' string (default: see 'runtimepath')
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005586 Directories used to find packages. See |packages|.
5587
5588
Bram Moolenaar071d4272004-06-13 20:20:40 +00005589 *'paragraphs'* *'para'*
Bram Moolenaar57e48462008-03-12 16:38:55 +00005590'paragraphs' 'para' string (default "IPLPPPQPP TPHPLIPpLpItpplpipbp")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005591 global
5592 Specifies the nroff macros that separate paragraphs. These are pairs
5593 of two letters (see |object-motions|).
5594
5595 *'paste'* *'nopaste'*
5596'paste' boolean (default off)
5597 global
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005598 Put Vim in Paste mode. This is useful if you want to cut or copy
5599 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005600 unexpected effects.
5601 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005602 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00005603 knows about pasting and will mostly do the right thing without 'paste'
5604 being set. The same is true for a terminal where Vim handles the
5605 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00005606 This option is reset when starting the GUI. Thus if you set it in
5607 your .vimrc it will work in a terminal, but not in the GUI. Setting
5608 'paste' in the GUI has side effects: e.g., the Paste toolbar button
5609 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005610 When the 'paste' option is switched on (also when it was already on):
5611 - mapping in Insert mode and Command-line mode is disabled
5612 - abbreviations are disabled
Bram Moolenaar071d4272004-06-13 20:20:40 +00005613 - 'autoindent' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02005614 - 'expandtab' is reset
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02005615 - 'hkmap' is reset
Bram Moolenaar071d4272004-06-13 20:20:40 +00005616 - 'revins' is reset
5617 - 'ruler' is reset
5618 - 'showmatch' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02005619 - 'smarttab' is reset
5620 - 'softtabstop' is set to 0
5621 - 'textwidth' is set to 0
5622 - 'wrapmargin' is set to 0
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02005623 - 'varsofttabstop' is made empty
Bram Moolenaar071d4272004-06-13 20:20:40 +00005624 These options keep their value, but their effect is disabled:
Bram Moolenaar071d4272004-06-13 20:20:40 +00005625 - 'cindent'
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02005626 - 'formatoptions' is used like it is empty
Bram Moolenaarca635012015-09-25 20:34:21 +02005627 - 'indentexpr'
5628 - 'lisp'
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02005629 - 'smartindent'
Bram Moolenaar071d4272004-06-13 20:20:40 +00005630 NOTE: When you start editing another file while the 'paste' option is
5631 on, settings from the modelines or autocommands may change the
5632 settings again, causing trouble when pasting text. You might want to
5633 set the 'paste' option again.
5634 When the 'paste' option is reset the mentioned options are restored to
5635 the value before the moment 'paste' was switched from off to on.
5636 Resetting 'paste' before ever setting it does not have any effect.
5637 Since mapping doesn't work while 'paste' is active, you need to use
5638 the 'pastetoggle' option to toggle the 'paste' option with some key.
5639
5640 *'pastetoggle'* *'pt'*
5641'pastetoggle' 'pt' string (default "")
5642 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005643 When non-empty, specifies the key sequence that toggles the 'paste'
5644 option. This is like specifying a mapping: >
5645 :map {keys} :set invpaste<CR>
5646< Where {keys} is the value of 'pastetoggle'.
5647 The difference is that it will work even when 'paste' is set.
5648 'pastetoggle' works in Insert mode and Normal mode, but not in
5649 Command-line mode.
5650 Mappings are checked first, thus overrule 'pastetoggle'. However,
5651 when 'paste' is on mappings are ignored in Insert mode, thus you can do
5652 this: >
5653 :map <F10> :set paste<CR>
5654 :map <F11> :set nopaste<CR>
5655 :imap <F10> <C-O>:set paste<CR>
5656 :imap <F11> <nop>
5657 :set pastetoggle=<F11>
5658< This will make <F10> start paste mode and <F11> stop paste mode.
5659 Note that typing <F10> in paste mode inserts "<F10>", since in paste
5660 mode everything is inserted literally, except the 'pastetoggle' key
5661 sequence.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005662 When the value has several bytes 'ttimeoutlen' applies.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005663
5664 *'pex'* *'patchexpr'*
5665'patchexpr' 'pex' string (default "")
5666 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005667 {not available when compiled without the |+diff|
5668 feature}
5669 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005670 the resulting new version of the file. See |diff-patchexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005671
Bram Moolenaardbc28022014-07-26 13:40:44 +02005672 *'patchmode'* *'pm'* *E205* *E206*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005673'patchmode' 'pm' string (default "")
5674 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005675 When non-empty the oldest version of a file is kept. This can be used
5676 to keep the original version of a file if you are changing files in a
5677 source distribution. Only the first time that a file is written a
5678 copy of the original file will be kept. The name of the copy is the
5679 name of the original file with the string in the 'patchmode' option
5680 appended. This option should start with a dot. Use a string like
Bram Moolenaardf980db2017-12-24 13:22:00 +01005681 ".orig" or ".org". 'backupdir' must not be empty for this to work
5682 (Detail: The backup file is renamed to the patchmode file after the
5683 new file has been successfully written, that's why it must be possible
5684 to write a backup file). If there was no file to be backed up, an
5685 empty file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005686 When the 'backupskip' pattern matches, a patchmode file is not made.
5687 Using 'patchmode' for compressed files appends the extension at the
5688 end (e.g., "file.gz.orig"), thus the resulting name isn't always
5689 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005690 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005691
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01005692 *'path'* *'pa'* *E343* *E345* *E347* *E854*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005693'path' 'pa' string (default on Unix: ".,/usr/include,,"
Bram Moolenaar071d4272004-06-13 20:20:40 +00005694 other systems: ".,,")
5695 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005696 This is a list of directories which will be searched when using the
Bram Moolenaarc236c162008-07-13 17:41:49 +00005697 |gf|, [f, ]f, ^Wf, |:find|, |:sfind|, |:tabfind| and other commands,
5698 provided that the file being searched for has a relative path (not
5699 starting with "/", "./" or "../"). The directories in the 'path'
5700 option may be relative or absolute.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005701 - Use commas to separate directory names: >
5702 :set path=.,/usr/local/include,/usr/include
5703< - Spaces can also be used to separate directory names (for backwards
5704 compatibility with version 3.0). To have a space in a directory
5705 name, precede it with an extra backslash, and escape the space: >
5706 :set path=.,/dir/with\\\ space
5707< - To include a comma in a directory name precede it with an extra
5708 backslash: >
5709 :set path=.,/dir/with\\,comma
5710< - To search relative to the directory of the current file, use: >
5711 :set path=.
5712< - To search in the current directory use an empty string between two
5713 commas: >
5714 :set path=,,
5715< - A directory name may end in a ':' or '/'.
5716 - Environment variables are expanded |:set_env|.
5717 - When using |netrw.vim| URLs can be used. For example, adding
5718 "http://www.vim.org" will make ":find index.html" work.
Bram Moolenaarc236c162008-07-13 17:41:49 +00005719 - Search upwards and downwards in a directory tree using "*", "**" and
5720 ";". See |file-searching| for info and syntax.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005721 {not available when compiled without the |+path_extra| feature}
5722 - Careful with '\' characters, type two to get one in the option: >
5723 :set path=.,c:\\include
5724< Or just use '/' instead: >
5725 :set path=.,c:/include
5726< Don't forget "." or files won't even be found in the same directory as
5727 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005728 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00005729 it is something like 256 or 1024 characters.
5730 You can check if all the include files are found, using the value of
5731 'path', see |:checkpath|.
5732 The use of |:set+=| and |:set-=| is preferred when adding or removing
5733 directories from the list. This avoids problems when a future version
5734 uses another default. To remove the current directory use: >
5735 :set path-=
5736< To add the current directory use: >
5737 :set path+=
5738< To use an environment variable, you probably need to replace the
5739 separator. Here is an example to append $INCL, in which directory
5740 names are separated with a semi-colon: >
5741 :let &path = &path . "," . substitute($INCL, ';', ',', 'g')
5742< Replace the ';' with a ':' or whatever separator is used. Note that
5743 this doesn't work when $INCL contains a comma or white space.
5744
Bram Moolenaar37c64c72017-09-19 22:06:03 +02005745 *'perldll'*
5746'perldll' string (default depends on the build)
5747 global
Bram Moolenaar37c64c72017-09-19 22:06:03 +02005748 {only available when compiled with the |+perl/dyn|
5749 feature}
5750 Specifies the name of the Perl shared library. The default is
5751 DYNAMIC_PERL_DLL, which was specified at compile time.
5752 Environment variables are expanded |:set_env|.
5753 This option cannot be set from a |modeline| or in the |sandbox|, for
5754 security reasons.
5755
Bram Moolenaar071d4272004-06-13 20:20:40 +00005756 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
5757'preserveindent' 'pi' boolean (default off)
5758 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005759 When changing the indent of the current line, preserve as much of the
5760 indent structure as possible. Normally the indent is replaced by a
5761 series of tabs followed by spaces as required (unless |'expandtab'| is
5762 enabled, in which case only spaces are used). Enabling this option
5763 means the indent will preserve as many existing characters as possible
5764 for indenting, and only add additional tabs or spaces as required.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005765 'expandtab' does not apply to the preserved white space, a Tab remains
5766 a Tab.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005767 NOTE: When using ">>" multiple times the resulting indent is a mix of
5768 tabs and spaces. You might not like this.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005769 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005770 Also see 'copyindent'.
5771 Use |:retab| to clean up white space.
5772
5773 *'previewheight'* *'pvh'*
5774'previewheight' 'pvh' number (default 12)
5775 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02005776 {not available when compiled without the |+quickfix|
5777 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005778 Default height for a preview window. Used for |:ptag| and associated
Bram Moolenaar79648732019-07-18 21:43:07 +02005779 commands. Used for |CTRL-W_}| when no count is given. Not used when
5780 'previewpopup' is set.
5781
5782 *'previewpopup'* *'pvp'*
5783'previewpopup' 'pvp' string (default empty)
5784 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02005785 {not available when compiled without the |+textprop|
5786 or |+quickfix| feature}
Bram Moolenaar79648732019-07-18 21:43:07 +02005787 When not empty a popup window is used for commands that would open a
5788 preview window. See |preview-popup|.
Bram Moolenaar576a4a62019-08-18 15:25:17 +02005789 Not used for the insert completion info, add "popup" to
5790 'completeopt' for that.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005791
5792 *'previewwindow'* *'nopreviewwindow'*
5793 *'pvw'* *'nopvw'* *E590*
5794'previewwindow' 'pvw' boolean (default off)
5795 local to window
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02005796 {not available when compiled without the |+quickfix|
5797 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005798 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00005799 set. It's normally not set directly, but by using one of the commands
5800 |:ptag|, |:pedit|, etc.
5801
5802 *'printdevice'* *'pdev'*
5803'printdevice' 'pdev' string (default empty)
5804 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005805 {only available when compiled with the |+printer|
5806 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005807 The name of the printer to be used for |:hardcopy|.
5808 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005809 This option cannot be set from a |modeline| or in the |sandbox|, for
5810 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005811
Bram Moolenaar8299df92004-07-10 09:47:34 +00005812 *'printencoding'* *'penc'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005813'printencoding' 'penc' string (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005814 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005815 {only available when compiled with the |+printer|
5816 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005817 Sets the character encoding used when printing.
5818 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005819
5820 *'printexpr'* *'pexpr'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005821'printexpr' 'pexpr' string (default: see below)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005822 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005823 {only available when compiled with the |+printer|
5824 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005825 Expression used to print the PostScript produced with |:hardcopy|.
5826 See |pexpr-option|.
Bram Moolenaar51628222016-12-01 23:03:28 +01005827 This option cannot be set from a |modeline| or in the |sandbox|, for
5828 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005829
Bram Moolenaar8299df92004-07-10 09:47:34 +00005830 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005831'printfont' 'pfn' string (default "courier")
5832 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005833 {only available when compiled with the |+printer|
5834 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005835 The name of the font that will be used for |:hardcopy|.
5836 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005837
5838 *'printheader'* *'pheader'*
5839'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
5840 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005841 {only available when compiled with the |+printer|
5842 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005843 The format of the header produced in |:hardcopy| output.
5844 See |pheader-option|.
5845
5846 *'printmbcharset'* *'pmbcs'*
5847'printmbcharset' 'pmbcs' string (default "")
5848 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01005849 {only available when compiled with the |+printer|
5850 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005851 The CJK character set to be used for CJK output from |:hardcopy|.
5852 See |pmbcs-option|.
5853
5854 *'printmbfont'* *'pmbfn'*
5855'printmbfont' 'pmbfn' string (default "")
5856 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01005857 {only available when compiled with the |+printer|
5858 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005859 List of font names to be used for CJK output from |:hardcopy|.
5860 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005861
5862 *'printoptions'* *'popt'*
5863'printoptions' 'popt' string (default "")
5864 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005865 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005866 List of items that control the format of the output of |:hardcopy|.
5867 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005868
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005869 *'prompt'* *'noprompt'*
5870'prompt' boolean (default on)
5871 global
5872 When on a ":" prompt is used in Ex mode.
5873
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005874 *'pumheight'* *'ph'*
5875'pumheight' 'ph' number (default 0)
5876 global
Bram Moolenaar06a89a52006-04-29 22:01:03 +00005877 Determines the maximum number of items to show in the popup menu for
5878 Insert mode completion. When zero as much space as available is used.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005879 |ins-completion-menu|.
5880
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01005881 *'pumwidth'* *'pw'*
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005882'pumwidth' 'pw' number (default 15)
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01005883 global
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01005884 Determines the minimum width to use for the popup menu for Insert mode
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005885 completion. |ins-completion-menu|.
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01005886
Bram Moolenaard94464e2015-11-02 15:28:18 +01005887 *'pythondll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01005888'pythondll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01005889 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01005890 {only available when compiled with the |+python/dyn|
5891 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005892 Specifies the name of the Python 2.x shared library. The default is
5893 DYNAMIC_PYTHON_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005894 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01005895 This option cannot be set from a |modeline| or in the |sandbox|, for
5896 security reasons.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005897
Bram Moolenaar94073162018-01-31 21:49:05 +01005898 *'pythonhome'*
5899'pythonhome' string (default "")
5900 global
Bram Moolenaar94073162018-01-31 21:49:05 +01005901 {only available when compiled with the |+python/dyn|
5902 feature}
5903 Specifies the name of the Python 2.x home directory. When 'pythonhome'
5904 and the PYTHONHOME environment variable are not set, PYTHON_HOME,
5905 which was specified at compile time, will be used for the Python 2.x
5906 home directory.
5907 Environment variables are expanded |:set_env|.
5908 This option cannot be set from a |modeline| or in the |sandbox|, for
5909 security reasons.
5910
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005911 *'pythonthreedll'*
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005912'pythonthreedll' string (default depends on the build)
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005913 global
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005914 {only available when compiled with the |+python3/dyn|
5915 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005916 Specifies the name of the Python 3 shared library. The default is
5917 DYNAMIC_PYTHON3_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005918 Environment variables are expanded |:set_env|.
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005919 This option cannot be set from a |modeline| or in the |sandbox|, for
5920 security reasons.
5921
Bram Moolenaar94073162018-01-31 21:49:05 +01005922 *'pythonthreehome'*
5923'pythonthreehome' string (default "")
5924 global
Bram Moolenaar94073162018-01-31 21:49:05 +01005925 {only available when compiled with the |+python3/dyn|
5926 feature}
5927 Specifies the name of the Python 3 home directory. When
5928 'pythonthreehome' and the PYTHONHOME environment variable are not set,
5929 PYTHON3_HOME, which was specified at compile time, will be used for
5930 the Python 3 home directory.
5931 Environment variables are expanded |:set_env|.
5932 This option cannot be set from a |modeline| or in the |sandbox|, for
5933 security reasons.
5934
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01005935 *'pyxversion'* *'pyx'*
5936'pyxversion' 'pyx' number (default depends on the build)
5937 global
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01005938 {only available when compiled with the |+python| or
5939 the |+python3| feature}
5940 Specifies the python version used for pyx* functions and commands
5941 |python_x|. The default value is as follows:
5942
5943 Compiled with Default ~
5944 |+python| and |+python3| 0
5945 only |+python| 2
5946 only |+python3| 3
5947
5948 Available values are 0, 2 and 3.
5949 If 'pyxversion' is 0, it is set to 2 or 3 after the first execution of
5950 any python2/3 commands or functions. E.g. `:py` sets to 2, and `:py3`
5951 sets to 3. `:pyx` sets it to 3 if Python 3 is available, otherwise sets
5952 to 2 if Python 2 is available.
5953 See also: |has-pythonx|
5954
5955 If Vim is compiled with only |+python| or |+python3| setting
5956 'pyxversion' has no effect. The pyx* functions and commands are
5957 always the same as the compiled version.
5958
5959 This option cannot be set from a |modeline| or in the |sandbox|, for
5960 security reasons.
5961
Bram Moolenaar858ba062020-05-31 23:11:59 +02005962 *'quickfixtextfunc'* *'qftf'*
5963'quickfixtextfunc' 'qftf' string (default "")
5964 global
5965 {only available when compiled with the |+quickfix|
5966 feature}
5967 This option specifies a function to be used to get the text to display
5968 in the quickfix and location list windows. This can be used to
5969 customize the information displayed in the quickfix or location window
5970 for each entry in the corresponding quickfix or location list. See
5971 |quickfix-window-function| for an explanation of how to write the
Bram Moolenaard43906d2020-07-20 21:31:32 +02005972 function and an example. The value can be the name of a function or a
5973 lambda.
Bram Moolenaar858ba062020-05-31 23:11:59 +02005974
5975 This option cannot be set from a |modeline| or in the |sandbox|, for
5976 security reasons.
5977
Bram Moolenaar677ee682005-01-27 14:41:15 +00005978 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005979'quoteescape' 'qe' string (default "\")
5980 local to buffer
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005981 The characters that are used to escape quotes in a string. Used for
5982 objects like a', a" and a` |a'|.
5983 When one of the characters in this option is found inside a string,
5984 the following character will be skipped. The default value makes the
5985 text "foo\"bar\\" considered to be one string.
5986
Bram Moolenaar071d4272004-06-13 20:20:40 +00005987 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
5988'readonly' 'ro' boolean (default off)
5989 local to buffer
5990 If on, writes fail unless you use a '!'. Protects you from
5991 accidentally overwriting a file. Default on when Vim is started
5992 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005993 When using ":w!" the 'readonly' option is reset for the current
5994 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar6c60f472019-04-28 16:00:35 +02005995 When using the ":view" command the 'readonly' option is set for the
5996 newly edited buffer.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01005997 See 'modifiable' for disallowing changes to the buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005998
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005999 *'redrawtime'* *'rdt'*
6000'redrawtime' 'rdt' number (default 2000)
6001 global
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006002 {only available when compiled with the |+reltime|
6003 feature}
6004 The time in milliseconds for redrawing the display. This applies to
Bram Moolenaar15142e22018-04-30 22:19:58 +02006005 searching for patterns for 'hlsearch', |:match| highlighting and syntax
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02006006 highlighting.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006007 When redrawing takes more than this many milliseconds no further
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02006008 matches will be highlighted.
6009 For syntax highlighting the time applies per window. When over the
6010 limit syntax highlighting is disabled until |CTRL-L| is used.
6011 This is used to avoid that Vim hangs when using a very complicated
6012 pattern.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006013
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02006014 *'regexpengine'* *'re'*
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006015'regexpengine' 're' number (default 0)
6016 global
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006017 This selects the default regexp engine. |two-engines|
6018 The possible values are:
6019 0 automatic selection
6020 1 old engine
6021 2 NFA engine
6022 Note that when using the NFA engine and the pattern contains something
6023 that is not supported the pattern will not match. This is only useful
6024 for debugging the regexp engine.
Bram Moolenaarfda37292014-11-05 14:27:36 +01006025 Using automatic selection enables Vim to switch the engine, if the
6026 default engine becomes too costly. E.g., when the NFA engine uses too
6027 many states. This should prevent Vim from hanging on a combination of
6028 a complex pattern with long text.
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006029
Bram Moolenaar64486672010-05-16 15:46:46 +02006030 *'relativenumber'* *'rnu'* *'norelativenumber'* *'nornu'*
6031'relativenumber' 'rnu' boolean (default off)
6032 local to window
Bram Moolenaar64486672010-05-16 15:46:46 +02006033 Show the line number relative to the line with the cursor in front of
Bram Moolenaar06b5d512010-05-22 15:37:44 +02006034 each line. Relative line numbers help you use the |count| you can
Bram Moolenaar64486672010-05-16 15:46:46 +02006035 precede some vertical motion commands (e.g. j k + -) with, without
6036 having to calculate it yourself. Especially useful in combination with
6037 other commands (e.g. y d c < > gq gw =).
6038 When the 'n' option is excluded from 'cpoptions' a wrapped
6039 line will not use the column of line numbers (this is the default when
6040 'compatible' isn't set).
6041 The 'numberwidth' option can be used to set the room used for the line
6042 number.
6043 When a long, wrapped line doesn't start with the first character, '-'
6044 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02006045 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
6046 the number.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01006047
Bram Moolenaar203d04d2013-06-06 21:36:40 +02006048 The number in front of the cursor line also depends on the value of
6049 'number', see |number_relativenumber| for all combinations of the two
6050 options.
Bram Moolenaar64486672010-05-16 15:46:46 +02006051
Bram Moolenaar071d4272004-06-13 20:20:40 +00006052 *'remap'* *'noremap'*
6053'remap' boolean (default on)
6054 global
6055 Allows for mappings to work recursively. If you do not want this for
6056 a single entry, use the :noremap[!] command.
Bram Moolenaara3227e22006-03-08 21:32:40 +00006057 NOTE: To avoid portability problems with Vim scripts, always keep
6058 this option at the default "on". Only switch it off when working with
6059 old Vi scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006060
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006061 *'renderoptions'* *'rop'*
6062'renderoptions' 'rop' string (default: empty)
6063 global
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006064 {only available when compiled with GUI and DIRECTX on
6065 MS-Windows}
6066 Select a text renderer and set its options. The options depend on the
6067 renderer.
6068
6069 Syntax: >
6070 set rop=type:{renderer}(,{name}:{value})*
6071<
6072 Currently, only one optional renderer is available.
6073
6074 render behavior ~
6075 directx Vim will draw text using DirectX (DirectWrite). It makes
6076 drawn glyphs more beautiful than default GDI.
6077 It requires 'encoding' is "utf-8", and only works on
6078 MS-Windows Vista or newer version.
6079
6080 Options:
6081 name meaning type value ~
6082 gamma gamma float 1.0 - 2.2 (maybe)
6083 contrast enhancedContrast float (unknown)
6084 level clearTypeLevel float (unknown)
6085 geom pixelGeometry int 0 - 2 (see below)
6086 renmode renderingMode int 0 - 6 (see below)
6087 taamode textAntialiasMode int 0 - 3 (see below)
Bram Moolenaara338adc2018-01-31 20:51:47 +01006088 scrlines Scroll Lines int (deprecated)
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006089
Bram Moolenaar92467d32017-12-05 13:22:16 +01006090 See this URL for detail (except for scrlines):
6091 https://msdn.microsoft.com/en-us/library/dd368190.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006092
6093 For geom: structure of a device pixel.
6094 0 - DWRITE_PIXEL_GEOMETRY_FLAT
6095 1 - DWRITE_PIXEL_GEOMETRY_RGB
6096 2 - DWRITE_PIXEL_GEOMETRY_BGR
6097
6098 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006099 https://msdn.microsoft.com/en-us/library/dd368114.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006100
6101 For renmode: method of rendering glyphs.
6102 0 - DWRITE_RENDERING_MODE_DEFAULT
6103 1 - DWRITE_RENDERING_MODE_ALIASED
6104 2 - DWRITE_RENDERING_MODE_GDI_CLASSIC
6105 3 - DWRITE_RENDERING_MODE_GDI_NATURAL
6106 4 - DWRITE_RENDERING_MODE_NATURAL
6107 5 - DWRITE_RENDERING_MODE_NATURAL_SYMMETRIC
6108 6 - DWRITE_RENDERING_MODE_OUTLINE
6109
6110 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006111 https://msdn.microsoft.com/en-us/library/dd368118.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006112
6113 For taamode: antialiasing mode used for drawing text.
6114 0 - D2D1_TEXT_ANTIALIAS_MODE_DEFAULT
6115 1 - D2D1_TEXT_ANTIALIAS_MODE_CLEARTYPE
6116 2 - D2D1_TEXT_ANTIALIAS_MODE_GRAYSCALE
6117 3 - D2D1_TEXT_ANTIALIAS_MODE_ALIASED
6118
6119 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006120 https://msdn.microsoft.com/en-us/library/dd368170.aspx
6121
Bram Moolenaara338adc2018-01-31 20:51:47 +01006122 For scrlines:
6123 This was used for optimizing scrolling behavior, however this
6124 is now deprecated. If specified, it is simply ignored.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006125
6126 Example: >
6127 set encoding=utf-8
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006128 set gfn=Ricty_Diminished:h12
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006129 set rop=type:directx
6130<
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006131 If select a raster font (Courier, Terminal or FixedSys which
6132 have ".fon" extension in file name) to 'guifont', it will be
Bram Moolenaar92467d32017-12-05 13:22:16 +01006133 drawn by GDI as a fallback.
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006134
6135 NOTE: It is known that some fonts and options combination
6136 causes trouble on drawing glyphs.
6137
Bram Moolenaar92467d32017-12-05 13:22:16 +01006138 - 'renmode:5' and 'renmode:6' will not work with some
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006139 special made fonts (True-Type fonts which includes only
6140 bitmap glyphs).
6141 - 'taamode:3' will not work with some vector fonts.
6142
6143 NOTE: With this option, you can display colored emoji
6144 (emoticon) in Windows 8.1 or later. To display colored emoji,
6145 there are some conditions which you should notice.
6146
6147 - If your font includes non-colored emoji already, it will
6148 be used.
6149 - If your font doesn't have emoji, the system chooses an
6150 alternative symbol font. On Windows 10, "Segoe UI Emoji"
6151 will be used.
6152 - When this alternative font didn't have fixed width glyph,
6153 emoji might be rendered beyond the bounding box of drawing
6154 cell.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006155
6156 Other render types are currently not supported.
6157
Bram Moolenaar071d4272004-06-13 20:20:40 +00006158 *'report'*
6159'report' number (default 2)
6160 global
6161 Threshold for reporting number of lines changed. When the number of
6162 changed lines is more than 'report' a message will be given for most
6163 ":" commands. If you want it always, set 'report' to 0.
6164 For the ":substitute" command the number of substitutions is used
6165 instead of the number of lines.
6166
6167 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
6168'restorescreen' 'rs' boolean (default on)
6169 global
Bram Moolenaar8024f932020-01-14 19:29:13 +01006170 {only in MS-Windows console version}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006171 When set, the screen contents is restored when exiting Vim. This also
6172 happens when executing external commands.
6173
6174 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
6175 options in your .vimrc. To disable restoring:
6176 set t_ti= t_te=
6177 To enable restoring (for an xterm):
6178 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
6179 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
6180
6181 *'revins'* *'ri'* *'norevins'* *'nori'*
6182'revins' 'ri' boolean (default off)
6183 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006184 {only available when compiled with the |+rightleft|
6185 feature}
6186 Inserting characters in Insert mode will work backwards. See "typing
6187 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
6188 command in Insert mode, when 'allowrevins' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02006189 NOTE: This option is reset when 'compatible' is set.
6190 This option is reset when 'paste' is set and restored when 'paste' is
6191 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006192
6193 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
6194'rightleft' 'rl' boolean (default off)
6195 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006196 {only available when compiled with the |+rightleft|
6197 feature}
6198 When on, display orientation becomes right-to-left, i.e., characters
6199 that are stored in the file appear from the right to the left.
6200 Using this option, it is possible to edit files for languages that
6201 are written from the right to the left such as Hebrew and Arabic.
6202 This option is per window, so it is possible to edit mixed files
6203 simultaneously, or to view the same file in both ways (this is
6204 useful whenever you have a mixed text file with both right-to-left
6205 and left-to-right strings so that both sets are displayed properly
6206 in different windows). Also see |rileft.txt|.
6207
Bram Moolenaar607cc1e2010-07-18 18:47:44 +02006208 *'rightleftcmd'* *'rlc'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006209'rightleftcmd' 'rlc' string (default "search")
6210 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006211 {only available when compiled with the |+rightleft|
6212 feature}
6213 Each word in this option enables the command line editing to work in
6214 right-to-left mode for a group of commands:
6215
6216 search "/" and "?" commands
6217
6218 This is useful for languages such as Hebrew, Arabic and Farsi.
6219 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
6220
Bram Moolenaard94464e2015-11-02 15:28:18 +01006221 *'rubydll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01006222'rubydll' string (default: depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01006223 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01006224 {only available when compiled with the |+ruby/dyn|
6225 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006226 Specifies the name of the Ruby shared library. The default is
6227 DYNAMIC_RUBY_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006228 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01006229 This option cannot be set from a |modeline| or in the |sandbox|, for
6230 security reasons.
6231
Bram Moolenaar071d4272004-06-13 20:20:40 +00006232 *'ruler'* *'ru'* *'noruler'* *'noru'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02006233'ruler' 'ru' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006234 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006235 {not available when compiled without the
6236 |+cmdline_info| feature}
6237 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006238 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00006239 text in the file is shown on the far right:
6240 Top first line is visible
6241 Bot last line is visible
6242 All first and last line are visible
6243 45% relative position in the file
6244 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006245 Each window has its own ruler. If a window has a status line, the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006246 ruler is shown there. Otherwise it is shown in the last line of the
Bram Moolenaar582fd852005-03-28 20:58:01 +00006247 screen. If the statusline is given by 'statusline' (i.e. not empty),
Bram Moolenaar071d4272004-06-13 20:20:40 +00006248 this option takes precedence over 'ruler' and 'rulerformat'
6249 If the number of characters displayed is different from the number of
Bram Moolenaar207f0092020-08-30 17:20:20 +02006250 bytes in the text (e.g., for a TAB or a multibyte character), both
Bram Moolenaar071d4272004-06-13 20:20:40 +00006251 the text column (byte number) and the screen column are shown,
6252 separated with a dash.
6253 For an empty line "0-1" is shown.
6254 For an empty buffer the line number will also be zero: "0,0-1".
Bram Moolenaarca635012015-09-25 20:34:21 +02006255 This option is reset when 'paste' is set and restored when 'paste' is
6256 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006257 If you don't want to see the ruler all the time but want to know where
6258 you are, use "g CTRL-G" |g_CTRL-G|.
6259 NOTE: This option is reset when 'compatible' is set.
6260
6261 *'rulerformat'* *'ruf'*
6262'rulerformat' 'ruf' string (default empty)
6263 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006264 {not available when compiled without the |+statusline|
6265 feature}
6266 When this option is not empty, it determines the content of the ruler
6267 string, as displayed for the 'ruler' option.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00006268 The format of this option is like that of 'statusline'.
Bram Moolenaar110289e2019-05-23 15:38:06 +02006269 This option cannot be set in a modeline when 'modelineexpr' is off.
6270
Bram Moolenaar071d4272004-06-13 20:20:40 +00006271 The default ruler width is 17 characters. To make the ruler 15
6272 characters wide, put "%15(" at the start and "%)" at the end.
6273 Example: >
6274 :set rulerformat=%15(%c%V\ %p%%%)
6275<
6276 *'runtimepath'* *'rtp'* *vimfiles*
6277'runtimepath' 'rtp' string (default:
Bram Moolenaar942db232021-02-13 18:14:48 +01006278 Unix: "$HOME/.vim,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006279 $VIM/vimfiles,
6280 $VIMRUNTIME,
6281 $VIM/vimfiles/after,
6282 $HOME/.vim/after"
6283 Amiga: "home:vimfiles,
6284 $VIM/vimfiles,
6285 $VIMRUNTIME,
6286 $VIM/vimfiles/after,
6287 home:vimfiles/after"
Bram Moolenaar942db232021-02-13 18:14:48 +01006288 MS-Windows: "$HOME/vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006289 $VIM/vimfiles,
6290 $VIMRUNTIME,
6291 $VIM/vimfiles/after,
6292 $HOME/vimfiles/after"
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02006293 macOS: "$VIM:vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006294 $VIMRUNTIME,
6295 $VIM:vimfiles:after"
Bram Moolenaarb3f74062020-02-26 16:16:53 +01006296 Haiku: "$BE_USER_SETTINGS/vim,
6297 $VIM/vimfiles,
6298 $VIMRUNTIME,
6299 $VIM/vimfiles/after,
Bram Moolenaar942db232021-02-13 18:14:48 +01006300 $BE_USER_SETTINGS/vim/after"
6301 VMS: "sys$login:vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006302 $VIM/vimfiles,
6303 $VIMRUNTIME,
6304 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00006305 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006306 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006307 This is a list of directories which will be searched for runtime
6308 files:
6309 filetype.vim filetypes by file name |new-filetype|
6310 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006311 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006312 colors/ color scheme files |:colorscheme|
6313 compiler/ compiler files |:compiler|
6314 doc/ documentation |write-local-help|
6315 ftplugin/ filetype plugins |write-filetype-plugin|
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01006316 import/ files that are found by `:import`
Bram Moolenaar071d4272004-06-13 20:20:40 +00006317 indent/ indent scripts |indent-expression|
6318 keymap/ key mapping files |mbyte-keymap|
6319 lang/ menu translations |:menutrans|
6320 menu.vim GUI menus |menu.vim|
Bram Moolenaar26852122016-05-24 20:02:38 +02006321 pack/ packages |:packadd|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006322 plugin/ plugin scripts |write-plugin|
6323 print/ files for printing |postscript-print-encoding|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006324 spell/ spell checking files |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006325 syntax/ syntax files |mysyntaxfile|
6326 tutor/ files for vimtutor |tutor|
6327
6328 And any other file searched for with the |:runtime| command.
6329
6330 The defaults for most systems are setup to search five locations:
6331 1. In your home directory, for your personal preferences.
6332 2. In a system-wide Vim directory, for preferences from the system
6333 administrator.
6334 3. In $VIMRUNTIME, for files distributed with Vim.
6335 *after-directory*
6336 4. In the "after" directory in the system-wide Vim directory. This is
6337 for the system administrator to overrule or add to the distributed
6338 defaults (rarely needed)
6339 5. In the "after" directory in your home directory. This is for
6340 personal preferences to overrule or add to the distributed defaults
6341 or system-wide settings (rarely needed).
6342
Bram Moolenaard0796902016-09-16 20:02:31 +02006343 More entries are added when using |packages|. If it gets very long
6344 then `:set rtp` will be truncated, use `:echo &rtp` to see the full
6345 string.
Bram Moolenaar26852122016-05-24 20:02:38 +02006346
Bram Moolenaar071d4272004-06-13 20:20:40 +00006347 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
6348 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006349 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00006350 wildcards.
6351 See |:runtime|.
6352 Example: >
6353 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
6354< This will use the directory "~/vimruntime" first (containing your
6355 personal Vim runtime files), then "/mygroup/vim" (shared between a
6356 group of people) and finally "$VIMRUNTIME" (the distributed runtime
6357 files).
6358 You probably should always include $VIMRUNTIME somewhere, to use the
6359 distributed runtime files. You can put a directory before $VIMRUNTIME
6360 to find files which replace a distributed runtime files. You can put
6361 a directory after $VIMRUNTIME to find files which add to distributed
6362 runtime files.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006363 When Vim is started with |--clean| the home directory entries are not
6364 included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006365 This option cannot be set from a |modeline| or in the |sandbox|, for
6366 security reasons.
6367
6368 *'scroll'* *'scr'*
6369'scroll' 'scr' number (default: half the window height)
6370 local to window
6371 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
6372 set to half the number of lines in the window when the window size
Bram Moolenaar74667062020-12-28 15:41:41 +01006373 changes. This may happen when enabling the |status-line| or
6374 'tabline' option after setting the 'scroll' option.
6375 If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006376 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar25c9c682019-05-05 18:13:34 +02006377 height with ":set scroll=0".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006378
6379 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
6380'scrollbind' 'scb' boolean (default off)
6381 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006382 See also |scroll-binding|. When this option is set, the current
6383 window scrolls as other scrollbind windows (windows that also have
6384 this option set) scroll. This option is useful for viewing the
6385 differences between two versions of a file, see 'diff'.
6386 See |'scrollopt'| for options that determine how this option should be
6387 interpreted.
6388 This option is mostly reset when splitting a window to edit another
6389 file. This means that ":split | edit file" results in two windows
6390 with scroll-binding, but ":split file" does not.
6391
Bram Moolenaarae20f342019-11-05 21:09:23 +01006392 *'scrollfocus'* *'scf'* *'noscrollfocus'* *'noscf'*
6393'scrollfocus' 'scf' boolean (default off)
6394 global
6395 {only for MS-Windows GUI}
6396 When using the scroll wheel and this option is set, the window under
6397 the mouse pointer is scrolled. With this option off the current
6398 window is scrolled.
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01006399 Systems other than MS-Windows always behave like this option is on.
Bram Moolenaarae20f342019-11-05 21:09:23 +01006400
Bram Moolenaar071d4272004-06-13 20:20:40 +00006401 *'scrolljump'* *'sj'*
6402'scrolljump' 'sj' number (default 1)
6403 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006404 Minimal number of lines to scroll when the cursor gets off the
6405 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
6406 CTRL-D). Useful if your terminal scrolls very slowly.
Bram Moolenaar1e015462005-09-25 22:16:38 +00006407 When set to a negative number from -1 to -100 this is used as the
6408 percentage of the window height. Thus -50 scrolls half the window
6409 height.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006410 NOTE: This option is set to 1 when 'compatible' is set.
6411
6412 *'scrolloff'* *'so'*
Bram Moolenaar50ba5262016-09-22 22:33:02 +02006413'scrolloff' 'so' number (default 0, set to 5 in |defaults.vim|)
Bram Moolenaar375e3392019-01-31 18:26:10 +01006414 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006415 Minimal number of screen lines to keep above and below the cursor.
6416 This will make some context visible around where you are working. If
6417 you set it to a very large value (999) the cursor line will always be
6418 in the middle of the window (except at the start or end of the file or
6419 when long lines wrap).
Bram Moolenaar375e3392019-01-31 18:26:10 +01006420 After using the local value, go back the global value with one of
6421 these two: >
6422 setlocal scrolloff<
6423 setlocal scrolloff=-1
6424< For scrolling horizontally see 'sidescrolloff'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006425 NOTE: This option is set to 0 when 'compatible' is set.
6426
6427 *'scrollopt'* *'sbo'*
6428'scrollopt' 'sbo' string (default "ver,jump")
6429 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006430 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006431 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
6432 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006433 The following words are available:
6434 ver Bind vertical scrolling for 'scrollbind' windows
6435 hor Bind horizontal scrolling for 'scrollbind' windows
6436 jump Applies to the offset between two windows for vertical
6437 scrolling. This offset is the difference in the first
6438 displayed line of the bound windows. When moving
6439 around in a window, another 'scrollbind' window may
6440 reach a position before the start or after the end of
6441 the buffer. The offset is not changed though, when
6442 moving back the 'scrollbind' window will try to scroll
6443 to the desired position when possible.
6444 When now making that window the current one, two
6445 things can be done with the relative offset:
6446 1. When "jump" is not included, the relative offset is
6447 adjusted for the scroll position in the new current
6448 window. When going back to the other window, the
Bram Moolenaar02467872007-05-06 13:22:01 +00006449 new relative offset will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006450 2. When "jump" is included, the other windows are
6451 scrolled to keep the same relative offset. When
6452 going back to the other window, it still uses the
6453 same relative offset.
6454 Also see |scroll-binding|.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006455 When 'diff' mode is active there always is vertical scroll binding,
6456 even when "ver" isn't there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006457
6458 *'sections'* *'sect'*
6459'sections' 'sect' string (default "SHNHH HUnhsh")
6460 global
6461 Specifies the nroff macros that separate sections. These are pairs of
6462 two letters (See |object-motions|). The default makes a section start
6463 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
6464
6465 *'secure'* *'nosecure'* *E523*
6466'secure' boolean (default off)
6467 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006468 When on, ":autocmd", shell and write commands are not allowed in
6469 ".vimrc" and ".exrc" in the current directory and map commands are
6470 displayed. Switch it off only if you know that you will not run into
6471 problems, or when the 'exrc' option is off. On Unix this option is
6472 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006473 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00006474 'secure' at the end of your ~/.vimrc then.
6475 This option cannot be set from a |modeline| or in the |sandbox|, for
6476 security reasons.
6477
6478 *'selection'* *'sel'*
6479'selection' 'sel' string (default "inclusive")
6480 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006481 This option defines the behavior of the selection. It is only used
6482 in Visual and Select mode.
6483 Possible values:
6484 value past line inclusive ~
6485 old no yes
6486 inclusive yes yes
6487 exclusive yes no
6488 "past line" means that the cursor is allowed to be positioned one
6489 character past the line.
6490 "inclusive" means that the last character of the selection is included
6491 in an operation. For example, when "x" is used to delete the
6492 selection.
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02006493 When "old" is used and 'virtualedit' allows the cursor to move past
6494 the end of line the line break still isn't included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006495 Note that when "exclusive" is used and selecting from the end
6496 backwards, you cannot include the last character of a line, when
6497 starting in Normal mode and 'virtualedit' empty.
6498
6499 The 'selection' option is set by the |:behave| command.
6500
6501 *'selectmode'* *'slm'*
6502'selectmode' 'slm' string (default "")
6503 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006504 This is a comma separated list of words, which specifies when to start
6505 Select mode instead of Visual mode, when a selection is started.
6506 Possible values:
6507 mouse when using the mouse
6508 key when using shifted special keys
6509 cmd when using "v", "V" or CTRL-V
6510 See |Select-mode|.
6511 The 'selectmode' option is set by the |:behave| command.
6512
6513 *'sessionoptions'* *'ssop'*
6514'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006515 help,options,tabpages,winsize,terminal")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006516 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02006517 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006518 feature}
6519 Changes the effect of the |:mksession| command. It is a comma
6520 separated list of words. Each word enables saving and restoring
6521 something:
6522 word save and restore ~
6523 blank empty windows
6524 buffers hidden and unloaded buffers, not just those in windows
6525 curdir the current directory
6526 folds manually created folds, opened/closed folds and local
6527 fold options
6528 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00006529 and contain at least one lowercase letter. Only
6530 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006531 help the help window
6532 localoptions options and mappings local to a window or buffer (not
6533 global values for local options)
6534 options all options and mappings (also global values for local
6535 options)
Bram Moolenaard23b7142021-04-17 21:04:34 +02006536 skiprtp exclude 'runtimepath' and 'packpath' from the options
Bram Moolenaar071d4272004-06-13 20:20:40 +00006537 resize size of the Vim window: 'lines' and 'columns'
6538 sesdir the directory in which the session file is located
6539 will become the current directory (useful with
6540 projects accessed over a network from different
6541 systems)
6542 slash backslashes in file names replaced with forward
6543 slashes
Bram Moolenaar18144c82006-04-12 21:52:12 +00006544 tabpages all tab pages; without this only the current tab page
6545 is restored, so that you can make a session for each
6546 tab page separately
Bram Moolenaard473c8c2018-08-11 18:00:22 +02006547 terminal include terminal windows where the command can be
6548 restored
Bram Moolenaar071d4272004-06-13 20:20:40 +00006549 unix with Unix end-of-line format (single <NL>), even when
6550 on Windows or DOS
6551 winpos position of the whole Vim window
6552 winsize window sizes
6553
6554 Don't include both "curdir" and "sesdir".
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006555 When neither "curdir" nor "sesdir" is included, file names are stored
6556 with absolute paths.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006557 "slash" and "unix" are useful on Windows when sharing session files
6558 with Unix. The Unix version of Vim cannot source dos format scripts,
6559 but the Windows version of Vim can source unix format scripts.
6560
6561 *'shell'* *'sh'* *E91*
Bram Moolenaar95a9dd12019-12-19 22:12:03 +01006562'shell' 'sh' string (default $SHELL or "sh", Win32: "cmd.exe")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006563 global
6564 Name of the shell to use for ! and :! commands. When changing the
6565 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
6566 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006567 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006568 See |option-backslash| about including spaces and backslashes.
6569 Environment variables are expanded |:set_env|.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006570
Bram Moolenaar1ff14ba2019-11-02 14:09:23 +01006571 If the name of the shell contains a space, you need to enclose it in
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01006572 quotes and escape the space. Example with quotes: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006573 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
6574< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006575 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006576 "-f" is not inside the quotes, because it is not part of the command
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006577 name. Vim automagically recognizes the backslashes that are path
Bram Moolenaar071d4272004-06-13 20:20:40 +00006578 separators.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006579 Example with escaped space (Vim will do this when initializing the
6580 option from $SHELL): >
6581 :set shell=/bin/with\\\ space/sh
Bram Moolenaard473c8c2018-08-11 18:00:22 +02006582< The resulting value of 'shell' is "/bin/with\ space/sh", two
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006583 backslashes are consumed by `:set`.
6584
Bram Moolenaar071d4272004-06-13 20:20:40 +00006585 Under MS-Windows, when the executable ends in ".com" it must be
6586 included. Thus setting the shell to "command.com" or "4dos.com"
6587 works, but "command" and "4dos" do not work for all commands (e.g.,
6588 filtering).
6589 For unknown reasons, when using "4dos.com" the current directory is
6590 changed to "C:\". To avoid this set 'shell' like this: >
6591 :set shell=command.com\ /c\ 4dos
6592< This option cannot be set from a |modeline| or in the |sandbox|, for
6593 security reasons.
6594
6595 *'shellcmdflag'* *'shcf'*
Bram Moolenaar5dc62522012-02-13 00:05:22 +01006596'shellcmdflag' 'shcf' string (default: "-c";
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006597 Win32, when 'shell' does not contain "sh"
6598 somewhere: "/c")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006599 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006600 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
Bram Moolenaar8024f932020-01-14 19:29:13 +01006601 "bash.exe -c ls" or "cmd.exe /c dir". For MS-Windows, the default is
6602 set according to the value of 'shell', to reduce the need to set this
6603 option by the user.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02006604 On Unix it can have more than one flag. Each white space separated
6605 part is passed as an argument to the shell command.
6606 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006607 Also see |dos-shell| for MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006608 This option cannot be set from a |modeline| or in the |sandbox|, for
6609 security reasons.
6610
6611 *'shellpipe'* *'sp'*
Bram Moolenaar8024f932020-01-14 19:29:13 +01006612'shellpipe' 'sp' string (default ">", ">%s 2>&1", "| tee", "|& tee" or
6613 "2>&1| tee")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006614 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006615 {not available when compiled without the |+quickfix|
6616 feature}
6617 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006618 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00006619 including spaces and backslashes.
6620 The name of the temporary file can be represented by "%s" if necessary
6621 (the file name is appended automatically if no %s appears in the value
6622 of this option).
Bram Moolenaar8024f932020-01-14 19:29:13 +01006623 For the Amiga the default is ">". For MS-Windows the default is
6624 ">%s 2>&1". The output is directly saved in a file and not echoed to
6625 the screen.
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02006626 For Unix the default is "| tee". The stdout of the compiler is saved
Bram Moolenaar071d4272004-06-13 20:20:40 +00006627 in a file and echoed to the screen. If the 'shell' option is "csh" or
6628 "tcsh" after initializations, the default becomes "|& tee". If the
Bram Moolenaar96f45c02019-10-26 19:53:45 +02006629 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh", "zsh-beta",
Natanael Copa56318362021-05-06 18:46:35 +02006630 "bash", "fish", "ash" or "dash" the default becomes "2>&1| tee". This
6631 means that stderr is also included. Before using the 'shell' option a
6632 path is removed, thus "/bin/sh" uses "sh".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006633 The initialization of this option is done after reading the ".vimrc"
6634 and the other initializations, so that when the 'shell' option is set
6635 there, the 'shellpipe' option changes automatically, unless it was
6636 explicitly set before.
6637 When 'shellpipe' is set to an empty string, no redirection of the
6638 ":make" output will be done. This is useful if you use a 'makeprg'
6639 that writes to 'makeef' by itself. If you want no piping, but do
6640 want to include the 'makeef', set 'shellpipe' to a single space.
6641 Don't forget to precede the space with a backslash: ":set sp=\ ".
6642 In the future pipes may be used for filtering and this option will
6643 become obsolete (at least for Unix).
6644 This option cannot be set from a |modeline| or in the |sandbox|, for
6645 security reasons.
6646
6647 *'shellquote'* *'shq'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006648'shellquote' 'shq' string (default: ""; Win32, when 'shell'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006649 contains "sh" somewhere: "\"")
6650 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006651 Quoting character(s), put around the command passed to the shell, for
6652 the "!" and ":!" commands. The redirection is kept outside of the
6653 quoting. See 'shellxquote' to include the redirection. It's
6654 probably not useful to set both options.
6655 This is an empty string by default. Only known to be useful for
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006656 third-party shells on MS-Windows-like systems, such as the MKS Korn
6657 Shell or bash, where it should be "\"". The default is adjusted
6658 according the value of 'shell', to reduce the need to set this option
6659 by the user. See |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006660 This option cannot be set from a |modeline| or in the |sandbox|, for
6661 security reasons.
6662
6663 *'shellredir'* *'srr'*
6664'shellredir' 'srr' string (default ">", ">&" or ">%s 2>&1")
6665 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006666 String to be used to put the output of a filter command in a temporary
6667 file. See also |:!|. See |option-backslash| about including spaces
6668 and backslashes.
6669 The name of the temporary file can be represented by "%s" if necessary
6670 (the file name is appended automatically if no %s appears in the value
6671 of this option).
Bram Moolenaar96f45c02019-10-26 19:53:45 +02006672 The default is ">". For Unix, if the 'shell' option is "csh" or
6673 "tcsh" during initializations, the default becomes ">&". If the
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01006674 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh", "zsh-beta",
6675 "bash" or "fish", the default becomes ">%s 2>&1". This means that
6676 stderr is also included. For Win32, the Unix checks are done and
6677 additionally "cmd" is checked for, which makes the default ">%s 2>&1".
6678 Also, the same names with ".exe" appended are checked for.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006679 The initialization of this option is done after reading the ".vimrc"
6680 and the other initializations, so that when the 'shell' option is set
6681 there, the 'shellredir' option changes automatically unless it was
6682 explicitly set before.
6683 In the future pipes may be used for filtering and this option will
6684 become obsolete (at least for Unix).
6685 This option cannot be set from a |modeline| or in the |sandbox|, for
6686 security reasons.
6687
6688 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
6689'shellslash' 'ssl' boolean (default off)
6690 global
Bram Moolenaar6f345a12019-12-17 21:27:18 +01006691 {only for MS-Windows}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006692 When set, a forward slash is used when expanding file names. This is
Bram Moolenaar8024f932020-01-14 19:29:13 +01006693 useful when a Unix-like shell is used instead of cmd.exe. Backward
6694 slashes can still be typed, but they are changed to forward slashes by
6695 Vim.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006696 Note that setting or resetting this option has no effect for some
6697 existing file names, thus this option needs to be set before opening
6698 any file for best results. This might change in the future.
6699 'shellslash' only works when a backslash can be used as a path
6700 separator. To test if this is so use: >
6701 if exists('+shellslash')
Bram Moolenaarac3150d2019-07-28 16:36:39 +02006702< Also see 'completeslash'.
6703
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006704 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
6705'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
6706 global
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006707 When on, use temp files for shell commands. When off use a pipe.
6708 When using a pipe is not possible temp files are used anyway.
Bram Moolenaar97293012011-07-18 19:40:27 +02006709 Currently a pipe is only supported on Unix and MS-Windows 2K and
6710 later. You can check it with: >
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006711 :if has("filterpipe")
6712< The advantage of using a pipe is that nobody can read the temp file
6713 and the 'shell' command does not need to support redirection.
6714 The advantage of using a temp file is that the file type and encoding
6715 can be detected.
6716 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
6717 |FilterWritePost| autocommands event are not triggered when
6718 'shelltemp' is off.
Bram Moolenaar269f5952016-07-15 22:54:41 +02006719 The `system()` function does not respect this option and always uses
6720 temp files.
Bram Moolenaar036986f2017-03-16 17:41:02 +01006721 NOTE: This option is set to the Vim default value when 'compatible'
6722 is reset.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006723
Bram Moolenaar071d4272004-06-13 20:20:40 +00006724 *'shelltype'* *'st'*
6725'shelltype' 'st' number (default 0)
6726 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02006727 {only for the Amiga}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006728 On the Amiga this option influences the way how the commands work
6729 which use a shell.
6730 0 and 1: always use the shell
6731 2 and 3: use the shell only to filter lines
6732 4 and 5: use shell only for ':sh' command
6733 When not using the shell, the command is executed directly.
6734
6735 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
6736 1 and 3: use "shell cmd" to start external commands
6737
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006738 *'shellxescape'* *'sxe'*
6739'shellxescape' 'sxe' string (default: "";
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006740 for MS-Windows: "\"&|<>()@^")
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006741 global
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006742 When 'shellxquote' is set to "(" then the characters listed in this
6743 option will be escaped with a '^' character. This makes it possible
6744 to execute most external commands with cmd.exe.
6745
Bram Moolenaar071d4272004-06-13 20:20:40 +00006746 *'shellxquote'* *'sxq'*
6747'shellxquote' 'sxq' string (default: "";
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006748 for Win32, when 'shell' is cmd.exe: "("
6749 for Win32, when 'shell' contains "sh"
6750 somewhere: "\""
Bram Moolenaar071d4272004-06-13 20:20:40 +00006751 for Unix, when using system(): "\"")
6752 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006753 Quoting character(s), put around the command passed to the shell, for
6754 the "!" and ":!" commands. Includes the redirection. See
6755 'shellquote' to exclude the redirection. It's probably not useful
6756 to set both options.
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006757 When the value is '(' then ')' is appended. When the value is '"('
6758 then ')"' is appended.
6759 When the value is '(' then also see 'shellxescape'.
Bram Moolenaara64ba222012-02-12 23:23:31 +01006760 This is an empty string by default on most systems, but is known to be
6761 useful for on Win32 version, either for cmd.exe which automatically
6762 strips off the first and last quote on a command, or 3rd-party shells
6763 such as the MKS Korn Shell or bash, where it should be "\"". The
6764 default is adjusted according the value of 'shell', to reduce the need
6765 to set this option by the user. See |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006766 This option cannot be set from a |modeline| or in the |sandbox|, for
6767 security reasons.
6768
6769 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
6770'shiftround' 'sr' boolean (default off)
6771 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006772 Round indent to multiple of 'shiftwidth'. Applies to > and <
6773 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
6774 a multiple of 'shiftwidth' (this is Vi compatible).
6775 NOTE: This option is reset when 'compatible' is set.
6776
6777 *'shiftwidth'* *'sw'*
6778'shiftwidth' 'sw' number (default 8)
6779 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006780 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00006781 |'cindent'|, |>>|, |<<|, etc.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02006782 When zero the 'ts' value will be used. Use the |shiftwidth()|
6783 function to get the effective shiftwidth value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006784
6785 *'shortmess'* *'shm'*
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02006786'shortmess' 'shm' string (Vim default "filnxtToOS", Vi default: "S",
6787 POSIX default: "AS")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006788 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006789 This option helps to avoid all the |hit-enter| prompts caused by file
6790 messages, for example with CTRL-G, and to avoid some other messages.
6791 It is a list of flags:
6792 flag meaning when present ~
6793 f use "(3 of 5)" instead of "(file 3 of 5)"
6794 i use "[noeol]" instead of "[Incomplete last line]"
Bram Moolenaar3f40ce72020-07-05 14:10:13 +02006795 l use "999L, 888B" instead of "999 lines, 888 bytes"
Bram Moolenaar071d4272004-06-13 20:20:40 +00006796 m use "[+]" instead of "[Modified]"
6797 n use "[New]" instead of "[New File]"
6798 r use "[RO]" instead of "[readonly]"
6799 w use "[w]" instead of "written" for file write message
6800 and "[a]" instead of "appended" for ':w >> file' command
6801 x use "[dos]" instead of "[dos format]", "[unix]" instead of
6802 "[unix format]" and "[mac]" instead of "[mac format]".
6803 a all of the above abbreviations
6804
6805 o overwrite message for writing a file with subsequent message
6806 for reading a file (useful for ":wn" or when 'autowrite' on)
6807 O message for reading a file overwrites any previous message.
6808 Also for quickfix message (e.g., ":cn").
6809 s don't give "search hit BOTTOM, continuing at TOP" or "search
Bram Moolenaara6c27c42019-05-09 19:16:22 +02006810 hit TOP, continuing at BOTTOM" messages; when using the search
6811 count do not show "W" after the count message (see S below)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006812 t truncate file message at the start if it is too long to fit
6813 on the command-line, "<" will appear in the left most column.
6814 Ignored in Ex mode.
6815 T truncate other messages in the middle if they are too long to
Bram Moolenaar582fd852005-03-28 20:58:01 +00006816 fit on the command line. "..." will appear in the middle.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006817 Ignored in Ex mode.
6818 W don't give "written" or "[w]" when writing a file
6819 A don't give the "ATTENTION" message when an existing swap file
6820 is found.
6821 I don't give the intro message when starting Vim |:intro|.
Bram Moolenaarea389e92014-05-28 21:40:52 +02006822 c don't give |ins-completion-menu| messages. For example,
6823 "-- XXX completion (YYY)", "match 1 of 2", "The only match",
6824 "Pattern not found", "Back at original", etc.
Bram Moolenaar426dd022016-03-15 15:09:29 +01006825 q use "recording" instead of "recording @a"
6826 F don't give the file info when editing a file, like `:silent`
Bram Moolenaar110289e2019-05-23 15:38:06 +02006827 was used for the command; note that this also affects messages
6828 from autocommands
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02006829 S do not show search count message when searching, e.g.
6830 "[1/5]"
Bram Moolenaar071d4272004-06-13 20:20:40 +00006831
6832 This gives you the opportunity to avoid that a change between buffers
6833 requires you to hit <Enter>, but still gives as useful a message as
6834 possible for the space available. To get the whole message that you
6835 would have got with 'shm' empty, use ":file!"
6836 Useful values:
6837 shm= No abbreviation of message.
6838 shm=a Abbreviation, but no loss of information.
6839 shm=at Abbreviation, and truncate message when necessary.
6840
6841 NOTE: This option is set to the Vi default value when 'compatible' is
6842 set and to the Vim default value when 'compatible' is reset.
6843
6844 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
6845'shortname' 'sn' boolean (default off)
6846 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00006847 Filenames are assumed to be 8 characters plus one extension of 3
6848 characters. Multiple dots in file names are not allowed. When this
6849 option is on, dots in file names are replaced with underscores when
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006850 adding an extension (".~" or ".swp"). This option is useful
Bram Moolenaar071d4272004-06-13 20:20:40 +00006851 when editing files on an MS-DOS compatible filesystem, e.g., messydos
Bram Moolenaarade0d392020-01-21 22:33:58 +01006852 or crossdos.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006853
6854 *'showbreak'* *'sbr'* *E595*
6855'showbreak' 'sbr' string (default "")
Bram Moolenaaree857022019-11-09 23:26:40 +01006856 global or local to window |global-local|
Bram Moolenaardb84e452010-08-15 13:50:43 +02006857 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006858 feature}
6859 String to put at the start of lines that have been wrapped. Useful
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006860 values are "> " or "+++ ": >
6861 :set showbreak=>\
6862< Note the backslash to escape the trailing space. It's easier like
6863 this: >
Bram Moolenaar1a384422010-07-14 19:53:30 +02006864 :let &showbreak = '+++ '
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006865< Only printable single-cell characters are allowed, excluding <Tab> and
Bram Moolenaar071d4272004-06-13 20:20:40 +00006866 comma (in a future version the comma might be used to separate the
6867 part that is shown at the end and at the start of a line).
6868 The characters are highlighted according to the '@' flag in
6869 'highlight'.
6870 Note that tabs after the showbreak will be displayed differently.
6871 If you want the 'showbreak' to appear in between line numbers, add the
6872 "n" flag to 'cpoptions'.
Bram Moolenaaree857022019-11-09 23:26:40 +01006873 A window-local value overrules a global value. If the global value is
6874 set and you want no value in the current window use NONE: >
6875 :setlocal showbreak=NONE
6876<
Bram Moolenaar071d4272004-06-13 20:20:40 +00006877 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02006878'showcmd' 'sc' boolean (Vim default: on, off for Unix,
6879 Vi default: off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006880 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006881 {not available when compiled without the
6882 |+cmdline_info| feature}
Bram Moolenaar02467872007-05-06 13:22:01 +00006883 Show (partial) command in the last line of the screen. Set this
6884 option off if your terminal is slow.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006885 In Visual mode the size of the selected area is shown:
6886 - When selecting characters within a line, the number of characters.
Bram Moolenaarf91787c2010-07-17 12:47:16 +02006887 If the number of bytes is different it is also displayed: "2-6"
6888 means two characters and six bytes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006889 - When selecting more than one line, the number of lines.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006890 - When selecting a block, the size in screen characters:
6891 {lines}x{columns}.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006892 NOTE: This option is set to the Vi default value when 'compatible' is
6893 set and to the Vim default value when 'compatible' is reset.
6894
6895 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
6896'showfulltag' 'sft' boolean (default off)
6897 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006898 When completing a word in insert mode (see |ins-completion|) from the
6899 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006900 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00006901 matched a C function, you can see a template for what arguments are
6902 required (coding style permitting).
Bram Moolenaar446cb832008-06-24 21:56:24 +00006903 Note that this doesn't work well together with having "longest" in
6904 'completeopt', because the completion from the search pattern may not
6905 match the typed text.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006906
6907 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
6908'showmatch' 'sm' boolean (default off)
6909 global
6910 When a bracket is inserted, briefly jump to the matching one. The
6911 jump is only done if the match can be seen on the screen. The time to
6912 show the match can be set with 'matchtime'.
6913 A Beep is given if there is no match (no matter if the match can be
Bram Moolenaarca635012015-09-25 20:34:21 +02006914 seen or not).
6915 This option is reset when 'paste' is set and restored when 'paste' is
6916 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006917 When the 'm' flag is not included in 'cpoptions', typing a character
6918 will immediately move the cursor back to where it belongs.
6919 See the "sm" field in 'guicursor' for setting the cursor shape and
6920 blinking when showing the match.
6921 The 'matchpairs' option can be used to specify the characters to show
6922 matches for. 'rightleft' and 'revins' are used to look for opposite
6923 matches.
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006924 Also see the matchparen plugin for highlighting the match when moving
6925 around |pi_paren.txt|.
6926 Note: Use of the short form is rated PG.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006927
6928 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
6929'showmode' 'smd' boolean (Vim default: on, Vi default: off)
6930 global
6931 If in Insert, Replace or Visual mode put a message on the last line.
6932 Use the 'M' flag in 'highlight' to set the type of highlighting for
6933 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006934 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00006935 doesn't mean XIM is really active, especially when 'imactivatekey' is
6936 not set.
6937 NOTE: This option is set to the Vi default value when 'compatible' is
6938 set and to the Vim default value when 'compatible' is reset.
6939
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006940 *'showtabline'* *'stal'*
6941'showtabline' 'stal' number (default 1)
6942 global
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006943 The value of this option specifies when the line with tab page labels
6944 will be displayed:
6945 0: never
6946 1: only if there are at least two tab pages
6947 2: always
6948 This is both for the GUI and non-GUI implementation of the tab pages
6949 line.
6950 See |tab-page| for more information about tab pages.
6951
Bram Moolenaar071d4272004-06-13 20:20:40 +00006952 *'sidescroll'* *'ss'*
6953'sidescroll' 'ss' number (default 0)
6954 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006955 The minimal number of columns to scroll horizontally. Used only when
6956 the 'wrap' option is off and the cursor is moved off of the screen.
6957 When it is zero the cursor will be put in the middle of the screen.
6958 When using a slow terminal set it to a large number or 0. When using
6959 a fast terminal use a small number or 1. Not used for "zh" and "zl"
6960 commands.
6961
6962 *'sidescrolloff'* *'siso'*
6963'sidescrolloff' 'siso' number (default 0)
Bram Moolenaar375e3392019-01-31 18:26:10 +01006964 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006965 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00006966 right of the cursor if 'nowrap' is set. Setting this option to a
6967 value greater than 0 while having |'sidescroll'| also at a non-zero
6968 value makes some context visible in the line you are scrolling in
6969 horizontally (except at beginning of the line). Setting this option
6970 to a large value (like 999) has the effect of keeping the cursor
6971 horizontally centered in the window, as long as one does not come too
6972 close to the beginning of the line.
Bram Moolenaar375e3392019-01-31 18:26:10 +01006973 After using the local value, go back the global value with one of
6974 these two: >
6975 setlocal sidescrolloff<
6976 setlocal sidescrolloff=-1
6977< NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006978
6979 Example: Try this together with 'sidescroll' and 'listchars' as
6980 in the following example to never allow the cursor to move
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02006981 onto the "extends" character: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006982
6983 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
6984 :set sidescrolloff=1
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02006985<
6986 *'signcolumn'* *'scl'*
6987'signcolumn' 'scl' string (default "auto")
6988 local to window
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02006989 {not available when compiled without the |+signs|
6990 feature}
Bram Moolenaar09521312016-08-12 22:54:35 +02006991 Whether or not to draw the signcolumn. Valid values are:
6992 "auto" only when there is a sign to display
6993 "no" never
6994 "yes" always
Bram Moolenaar394c5d82019-06-17 21:48:05 +02006995 "number" display signs in the 'number' column. If the number
Bram Moolenaar6c1e1572019-06-22 02:13:00 +02006996 column is not present, then behaves like "auto".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006997
6998
6999 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
7000'smartcase' 'scs' boolean (default off)
7001 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007002 Override the 'ignorecase' option if the search pattern contains upper
7003 case characters. Only used when the search pattern is typed and
7004 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarc8734422012-06-01 22:38:45 +02007005 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00007006 "*" and "#" you can make 'smartcase' used by doing a "/" command,
7007 recalling the search pattern from history and hitting <Enter>.
7008 NOTE: This option is reset when 'compatible' is set.
7009
7010 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
7011'smartindent' 'si' boolean (default off)
7012 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007013 {not available when compiled without the
7014 |+smartindent| feature}
7015 Do smart autoindenting when starting a new line. Works for C-like
7016 programs, but can also be used for other languages. 'cindent' does
7017 something like this, works better in most cases, but is more strict,
Bram Moolenaar81af9252010-12-10 20:35:50 +01007018 see |C-indenting|. When 'cindent' is on or 'indentexpr' is set,
Bram Moolenaar166af9b2010-11-16 20:34:40 +01007019 setting 'si' has no effect. 'indentexpr' is a more advanced
7020 alternative.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007021 Normally 'autoindent' should also be on when using 'smartindent'.
7022 An indent is automatically inserted:
7023 - After a line ending in '{'.
7024 - After a line starting with a keyword from 'cinwords'.
7025 - Before a line starting with '}' (only with the "O" command).
7026 When typing '}' as the first character in a new line, that line is
7027 given the same indent as the matching '{'.
7028 When typing '#' as the first character in a new line, the indent for
7029 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007030 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00007031 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
7032 When using the ">>" command, lines starting with '#' are not shifted
7033 right.
Bram Moolenaar036986f2017-03-16 17:41:02 +01007034 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02007035 This option is reset when 'paste' is set and restored when 'paste' is
7036 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007037
7038 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
7039'smarttab' 'sta' boolean (default off)
7040 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007041 When on, a <Tab> in front of a line inserts blanks according to
Bram Moolenaar280f1262006-01-30 00:14:18 +00007042 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A
7043 <BS> will delete a 'shiftwidth' worth of space at the start of the
7044 line.
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00007045 When off, a <Tab> always inserts blanks according to 'tabstop' or
Bram Moolenaar280f1262006-01-30 00:14:18 +00007046 'softtabstop'. 'shiftwidth' is only used for shifting text left or
7047 right |shift-left-right|.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007048 What gets inserted (a <Tab> or spaces) depends on the 'expandtab'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007049 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00007050 number of spaces is minimized by using <Tab>s.
Bram Moolenaarca635012015-09-25 20:34:21 +02007051 This option is reset when 'paste' is set and restored when 'paste' is
7052 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007053 NOTE: This option is reset when 'compatible' is set.
7054
7055 *'softtabstop'* *'sts'*
7056'softtabstop' 'sts' number (default 0)
7057 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007058 Number of spaces that a <Tab> counts for while performing editing
7059 operations, like inserting a <Tab> or using <BS>. It "feels" like
7060 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
7061 used. This is useful to keep the 'ts' setting at its standard value
7062 of 8, while being able to edit like it is set to 'sts'. However,
7063 commands like "x" still work on the actual characters.
7064 When 'sts' is zero, this feature is off.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02007065 When 'sts' is negative, the value of 'shiftwidth' is used.
Bram Moolenaarca635012015-09-25 20:34:21 +02007066 'softtabstop' is set to 0 when the 'paste' option is set and restored
7067 when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007068 See also |ins-expandtab|. When 'expandtab' is not set, the number of
7069 spaces is minimized by using <Tab>s.
7070 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
7071 set.
7072 NOTE: This option is set to 0 when 'compatible' is set.
7073
Bram Moolenaar04958cb2018-06-23 19:23:02 +02007074 If Vim is compiled with the |+vartabs| feature then the value of
7075 'softtabstop' will be ignored if |'varsofttabstop'| is set to
7076 anything other than an empty string.
7077
Bram Moolenaar217ad922005-03-20 22:37:15 +00007078 *'spell'* *'nospell'*
7079'spell' boolean (default off)
7080 local to window
Bram Moolenaar217ad922005-03-20 22:37:15 +00007081 {not available when compiled without the |+syntax|
7082 feature}
7083 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007084 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007085
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007086 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00007087'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007088 local to buffer
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007089 {not available when compiled without the |+syntax|
7090 feature}
7091 Pattern to locate the end of a sentence. The following word will be
7092 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007093 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007094 When this check is not wanted make this option empty.
7095 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00007096 Be careful with special characters, see |option-backslash| about
7097 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007098 To set this option automatically depending on the language, see
7099 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007100
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007101 *'spellfile'* *'spf'*
7102'spellfile' 'spf' string (default empty)
7103 local to buffer
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007104 {not available when compiled without the |+syntax|
7105 feature}
7106 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00007107 commands. It must end in ".{encoding}.add". You need to include the
7108 path, otherwise the file is placed in the current directory.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007109 *E765*
7110 It may also be a comma separated list of names. A count before the
7111 |zg| and |zw| commands can be used to access each. This allows using
7112 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007113 When a word is added while this option is empty Vim will set it for
Bram Moolenaar910f66f2006-04-05 20:41:53 +00007114 you: Using the first directory in 'runtimepath' that is writable. If
7115 there is no "spell" directory yet it will be created. For the file
7116 name the first language name that appears in 'spelllang' is used,
Bram Moolenaar3b506942005-06-23 22:36:45 +00007117 ignoring the region.
7118 The resulting ".spl" file will be used for spell checking, it does not
7119 have to appear in 'spelllang'.
7120 Normally one file is used for all regions, but you can add the region
7121 name if you want to. However, it will then only be used when
7122 'spellfile' is set to it, for entries in 'spelllang' only files
7123 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00007124 This option cannot be set from a |modeline| or in the |sandbox|, for
7125 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007126
Bram Moolenaar217ad922005-03-20 22:37:15 +00007127 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007128'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00007129 local to buffer
Bram Moolenaar217ad922005-03-20 22:37:15 +00007130 {not available when compiled without the |+syntax|
7131 feature}
Bram Moolenaar3b506942005-06-23 22:36:45 +00007132 A comma separated list of word list names. When the 'spell' option is
7133 on spellchecking will be done for these languages. Example: >
7134 set spelllang=en_us,nl,medical
7135< This means US English, Dutch and medical words are recognized. Words
7136 that are not recognized will be highlighted.
Bram Moolenaar911ead12019-04-21 00:03:35 +02007137 The word list name must consist of alphanumeric characters, a dash or
7138 an underscore. It should not include a comma or dot. Using a dash is
Bram Moolenaar3b506942005-06-23 22:36:45 +00007139 recommended to separate the two letter language name from a
7140 specification. Thus "en-rare" is used for rare English words.
7141 A region name must come last and have the form "_xx", where "xx" is
7142 the two-letter, lower case region name. You can use more than one
7143 region by listing them: "en_us,en_ca" supports both US and Canadian
7144 English, but not words specific for Australia, New Zealand or Great
Bram Moolenaarfa735342016-01-03 22:14:44 +01007145 Britain. (Note: currently en_au and en_nz dictionaries are older than
7146 en_ca, en_gb and en_us).
Bram Moolenaarcc63c642013-11-12 04:44:01 +01007147 If the name "cjk" is included East Asian characters are excluded from
7148 spell checking. This is useful when editing text that also has Asian
7149 words.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007150 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007151 As a special case the name of a .spl file can be given as-is. The
7152 first "_xx" in the name is removed and used as the region name
7153 (_xx is an underscore, two letters and followed by a non-letter).
7154 This is mainly for testing purposes. You must make sure the correct
7155 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007156 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007157 idea to set 'spelllang' after setting 'encoding' to avoid loading the
7158 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00007159 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007160
Bram Moolenaar98692072006-02-04 00:57:42 +00007161 If the |spellfile.vim| plugin is active and you use a language name
7162 for which Vim cannot find the .spl file in 'runtimepath' the plugin
7163 will ask you if you want to download the file.
7164
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007165 After this option has been set successfully, Vim will source the files
7166 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
Bram Moolenaarb730f0c2018-11-25 03:56:26 +01007167 up to the first character that is not an ASCII letter or number and
7168 not a dash. Also see |set-spc-auto|.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007169
Bram Moolenaar362b44b2020-06-10 21:47:00 +02007170 *'spelloptions'* *'spo'*
7171'spelloptions' 'spo' string (default "")
7172 local to buffer
7173 {not available when compiled without the |+syntax|
7174 feature}
7175 A comma separated list of options for spell checking:
7176 camel When a word is CamelCased, assume "Cased" is a
7177 separate word: every upper-case character in a word
7178 that comes after a lower case character indicates the
7179 start of a new word.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007180
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007181 *'spellsuggest'* *'sps'*
7182'spellsuggest' 'sps' string (default "best")
7183 global
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007184 {not available when compiled without the |+syntax|
7185 feature}
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007186 Methods used for spelling suggestions. Both for the |z=| command and
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007187 the |spellsuggest()| function. This is a comma-separated list of
7188 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007189
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007190 best Internal method that works best for English. Finds
7191 changes like "fast" and uses a bit of sound-a-like
7192 scoring to improve the ordering.
7193
7194 double Internal method that uses two methods and mixes the
7195 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007196 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007197 word. That only works when the language specifies
7198 sound folding. Can be slow and doesn't always give
7199 better results.
7200
7201 fast Internal method that only checks for simple changes:
7202 character inserts/deletes/swaps. Works well for
7203 simple typing mistakes.
7204
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007205 {number} The maximum number of suggestions listed for |z=|.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007206 Not used for |spellsuggest()|. The number of
7207 suggestions is never more than the value of 'lines'
7208 minus two.
7209
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007210 file:{filename} Read file {filename}, which must have two columns,
7211 separated by a slash. The first column contains the
7212 bad word, the second column the suggested good word.
7213 Example:
7214 theribal/terrible ~
7215 Use this for common mistakes that do not appear at the
7216 top of the suggestion list with the internal methods.
7217 Lines without a slash are ignored, use this for
7218 comments.
Bram Moolenaarbcb98982014-05-01 14:08:19 +02007219 The word in the second column must be correct,
7220 otherwise it will not be used. Add the word to an
7221 ".add" file if it is currently flagged as a spelling
7222 mistake.
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007223 The file is used for all languages.
7224
7225 expr:{expr} Evaluate expression {expr}. Use a function to avoid
7226 trouble with spaces. |v:val| holds the badly spelled
7227 word. The expression must evaluate to a List of
7228 Lists, each with a suggestion and a score.
7229 Example:
Bram Moolenaar214641f2017-03-05 17:04:09 +01007230 [['the', 33], ['that', 44]] ~
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007231 Set 'verbose' and use |z=| to see the scores that the
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007232 internal methods use. A lower score is better.
7233 This may invoke |spellsuggest()| if you temporarily
7234 set 'spellsuggest' to exclude the "expr:" part.
7235 Errors are silently ignored, unless you set the
7236 'verbose' option to a non-zero value.
7237
7238 Only one of "best", "double" or "fast" may be used. The others may
7239 appear several times in any order. Example: >
7240 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
7241<
7242 This option cannot be set from a |modeline| or in the |sandbox|, for
7243 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007244
7245
Bram Moolenaar071d4272004-06-13 20:20:40 +00007246 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
7247'splitbelow' 'sb' boolean (default off)
7248 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007249 When on, splitting a window will put the new window below the current
7250 one. |:split|
7251
7252 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
7253'splitright' 'spr' boolean (default off)
7254 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007255 When on, splitting a window will put the new window right of the
7256 current one. |:vsplit|
7257
7258 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
7259'startofline' 'sol' boolean (default on)
7260 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007261 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00007262 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007263 (if possible). This applies to the commands: CTRL-D, CTRL-U, CTRL-B,
Bram Moolenaar843ee412004-06-30 16:16:41 +00007264 CTRL-F, "G", "H", "M", "L", gg, and to the commands "d", "<<" and ">>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007265 with a linewise operator, with "%" with a count and to buffer changing
7266 commands (CTRL-^, :bnext, :bNext, etc.). Also for an Ex command that
7267 only has a line number, e.g., ":25" or ":+".
7268 In case of buffer changing commands the cursor is placed at the column
7269 where it was the last time the buffer was edited.
7270 NOTE: This option is set when 'compatible' is set.
7271
Bram Moolenaar00654022011-02-25 14:42:19 +01007272 *'statusline'* *'stl'* *E540* *E542*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007273'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007274 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007275 {not available when compiled without the |+statusline|
7276 feature}
7277 When nonempty, this option determines the content of the status line.
7278 Also see |status-line|.
7279
7280 The option consists of printf style '%' items interspersed with
7281 normal text. Each status line item is of the form:
7282 %-0{minwid}.{maxwid}{item}
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01007283 All fields except the {item} are optional. A single percent sign can
Bram Moolenaar8133cc62020-10-26 21:05:27 +01007284 be given as "%%".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007285
Bram Moolenaar238a5642006-02-21 22:12:05 +00007286 When the option starts with "%!" then it is used as an expression,
7287 evaluated and the result is used as the option value. Example: >
7288 :set statusline=%!MyStatusLine()
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02007289< The *g:statusline_winid* variable will be set to the |window-ID| of the
7290 window that the status line belongs to.
7291 The result can contain %{} items that will be evaluated too.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02007292 Note that the "%!" expression is evaluated in the context of the
7293 current window and buffer, while %{} items are evaluated in the
7294 context of the window that the statusline belongs to.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007295
7296 When there is error while evaluating the option then it will be made
7297 empty to avoid further errors. Otherwise screen updating would loop.
7298
Bram Moolenaar071d4272004-06-13 20:20:40 +00007299 Note that the only effect of 'ruler' when this option is set (and
7300 'laststatus' is 2) is controlling the output of |CTRL-G|.
7301
7302 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00007303 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00007304 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007305 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007306 minwid Minimum width of the item, padding as set by '-' & '0'.
7307 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007308 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007309 on the left for text items. Numeric items will be
7310 shifted down to maxwid-2 digits followed by '>'number
7311 where number is the amount of missing digits, much like
7312 an exponential notation.
7313 item A one letter code as described below.
7314
7315 Following is a description of the possible statusline items. The
7316 second character in "item" is the type:
7317 N for number
7318 S for string
7319 F for flags as described below
7320 - not applicable
7321
7322 item meaning ~
Bram Moolenaar02467872007-05-06 13:22:01 +00007323 f S Path to the file in the buffer, as typed or relative to current
7324 directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007325 F S Full path to the file in the buffer.
7326 t S File name (tail) of file in the buffer.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007327 m F Modified flag, text is "[+]"; "[-]" if 'modifiable' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007328 M F Modified flag, text is ",+" or ",-".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007329 r F Readonly flag, text is "[RO]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007330 R F Readonly flag, text is ",RO".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007331 h F Help buffer flag, text is "[help]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007332 H F Help buffer flag, text is ",HLP".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007333 w F Preview window flag, text is "[Preview]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007334 W F Preview window flag, text is ",PRV".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007335 y F Type of file in the buffer, e.g., "[vim]". See 'filetype'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007336 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
Bram Moolenaar7fd73202010-07-25 16:58:46 +02007337 q S "[Quickfix List]", "[Location List]" or empty.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007338 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
7339 being used: "<keymap>"
7340 n N Buffer number.
Bram Moolenaar00654022011-02-25 14:42:19 +01007341 b N Value of character under cursor.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007342 B N As above, in hexadecimal.
7343 o N Byte number in file of byte under cursor, first byte is 1.
7344 Mnemonic: Offset from start of file (with one added)
7345 {not available when compiled without |+byte_offset| feature}
7346 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007347 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007348 l N Line number.
7349 L N Number of lines in buffer.
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02007350 c N Column number (byte index).
7351 v N Virtual column number (screen column).
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007352 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007353 p N Percentage through file in lines as in |CTRL-G|.
7354 P S Percentage through file of displayed window. This is like the
Bram Moolenaar14b69452013-06-29 23:05:20 +02007355 percentage described for 'ruler'. Always 3 in length, unless
7356 translated.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007357 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00007358 Empty if the argument file count is zero or one.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007359 { NF Evaluate expression between '%{' and '}' and substitute result.
Bram Moolenaar6d150f72018-04-21 20:03:20 +02007360 Note that there is no '%' before the closing '}'. The
7361 expression cannot contain a '}' character, call a function to
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007362 work around that. See |stl-%{| below.
shadmansaleh30e3de22021-05-15 17:23:28 +02007363 {% - This is almost same as { except the result of the expression is
7364 re-evaluated as a statusline format string. Thus if the
7365 return value of expr contains % items they will get expanded.
7366 The expression can contain the } character, the end of
7367 expression is denoted by %}.
7368 The For example: >
7369 func! Stl_filename() abort
7370 return "%t"
7371 endfunc
7372< `stl=%{Stl_filename()}` results in `"%t"`
7373 `stl=%{%Stl_filename()%}` results in `"Name of current file"`
7374 } - End of `{%` expression
Bram Moolenaar071d4272004-06-13 20:20:40 +00007375 ( - Start of item group. Can be used for setting the width and
7376 alignment of a section. Must be followed by %) somewhere.
7377 ) - End of item group. No width fields allowed.
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007378 T N For 'tabline': start of tab page N label. Use %T after the last
7379 label. This information is used for mouse clicks.
7380 X N For 'tabline': start of close tab N label. Use %X after the
7381 label, e.g.: %3Xclose%X. Use %999X for a "close current tab"
7382 mark. This information is used for mouse clicks.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007383 < - Where to truncate line if too long. Default is at the start.
7384 No width fields allowed.
7385 = - Separation point between left and right aligned items.
7386 No width fields allowed.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007387 # - Set highlight group. The name must follow and then a # again.
7388 Thus use %#HLname# for highlight group HLname. The same
7389 highlighting is used, also for the statusline of non-current
7390 windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007391 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00007392 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007393 The difference between User{N} and StatusLine will be applied
7394 to StatusLineNC for the statusline of non-current windows.
7395 The number N must be between 1 and 9. See |hl-User1..9|
7396
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007397 When displaying a flag, Vim removes the leading comma, if any, when
7398 that flag comes right after plaintext. This will make a nice display
7399 when flags are used like in the examples below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007400
Bram Moolenaar582fd852005-03-28 20:58:01 +00007401 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00007402 not set) and a minwid is not set for the group, the whole group will
7403 become empty. This will make a group like the following disappear
7404 completely from the statusline when none of the flags are set. >
7405 :set statusline=...%(\ [%M%R%H]%)...
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02007406< Beware that an expression is evaluated each and every time the status
7407 line is displayed.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007408 *stl-%{* *g:actual_curbuf* *g:actual_curwin*
Bram Moolenaarade0d392020-01-21 22:33:58 +01007409 While evaluating %{} the current buffer and current window will be set
7410 temporarily to that of the window (and buffer) whose statusline is
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007411 currently being drawn. The expression will evaluate in this context.
7412 The variable "g:actual_curbuf" is set to the `bufnr()` number of the
7413 real current buffer and "g:actual_curwin" to the |window-ID| of the
7414 real current window. These values are strings.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007415
Bram Moolenaar30b65812012-07-12 22:01:11 +02007416 The 'statusline' option will be evaluated in the |sandbox| if set from
7417 a modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02007418 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007419
7420 It is not allowed to change text or jump to another window while
7421 evaluating 'statusline' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007422
7423 If the statusline is not updated when you want it (e.g., after setting
7424 a variable that's used in an expression), you can force an update by
7425 setting an option without changing its value. Example: >
7426 :let &ro = &ro
7427
7428< A result of all digits is regarded a number for display purposes.
7429 Otherwise the result is taken as flag text and applied to the rules
7430 described above.
7431
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00007432 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00007433 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
Bram Moolenaarc4da1132017-07-15 19:39:43 +02007434 edit your .vimrc or whatever with "vim --clean" to get it right.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007435
7436 Examples:
7437 Emulate standard status line with 'ruler' set >
7438 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
7439< Similar, but add ASCII value of char under the cursor (like "ga") >
7440 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
7441< Display byte count and byte value, modified flag in red. >
7442 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
7443 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
7444< Display a ,GZ flag if a compressed file is loaded >
7445 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
7446< In the |:autocmd|'s: >
7447 :let b:gzflag = 1
7448< And: >
7449 :unlet b:gzflag
7450< And define this function: >
7451 :function VarExists(var, val)
7452 : if exists(a:var) | return a:val | else | return '' | endif
7453 :endfunction
7454<
7455 *'suffixes'* *'su'*
7456'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
7457 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007458 Files with these suffixes get a lower priority when multiple files
7459 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007460 suffixes. Spaces after the comma are ignored. A dot is also seen as
7461 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007462 separator, precede it with a backslash (see |option-backslash| about
7463 including spaces and backslashes).
7464 See 'wildignore' for completely ignoring files.
7465 The use of |:set+=| and |:set-=| is preferred when adding or removing
7466 suffixes from the list. This avoids problems when a future version
7467 uses another default.
7468
7469 *'suffixesadd'* *'sua'*
7470'suffixesadd' 'sua' string (default "")
7471 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007472 {not available when compiled without the
7473 |+file_in_path| feature}
7474 Comma separated list of suffixes, which are used when searching for a
7475 file for the "gf", "[I", etc. commands. Example: >
7476 :set suffixesadd=.java
7477<
7478 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
7479'swapfile' 'swf' boolean (default on)
7480 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007481 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007482 swapfile is not wanted for a specific buffer. For example, with
7483 confidential information that even root must not be able to access.
7484 Careful: All text will be in memory:
7485 - Don't use this for big files.
7486 - Recovery will be impossible!
7487 A swapfile will only be present when |'updatecount'| is non-zero and
7488 'swapfile' is set.
7489 When 'swapfile' is reset, the swap file for the current buffer is
7490 immediately deleted. When 'swapfile' is set, and 'updatecount' is
7491 non-zero, a swap file is immediately created.
7492 Also see |swap-file| and |'swapsync'|.
Bram Moolenaar76f3b1a2014-03-27 22:30:07 +01007493 If you want to open a new buffer without creating a swap file for it,
7494 use the |:noswapfile| modifier.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01007495 See 'directory' for where the swap file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007496
7497 This option is used together with 'bufhidden' and 'buftype' to
7498 specify special kinds of buffers. See |special-buffers|.
7499
7500 *'swapsync'* *'sws'*
7501'swapsync' 'sws' string (default "fsync")
7502 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007503 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007504 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007505 When this option is empty parts of the swap file may be in memory and
7506 not written to disk. When the system crashes you may lose more work.
7507 On Unix the system does a sync now and then without Vim asking for it,
7508 so the disadvantage of setting this option off is small. On some
7509 systems the swap file will not be written at all. For a unix system
7510 setting it to "sync" will use the sync() call instead of the default
7511 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007512 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007513
7514 *'switchbuf'* *'swb'*
7515'switchbuf' 'swb' string (default "")
7516 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007517 This option controls the behavior when switching between buffers.
Bram Moolenaard2ea7cf2021-05-30 20:54:13 +02007518 Mostly for |quickfix| commands some values are also used for other
7519 commands, as mentioned below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007520 Possible values (comma separated list):
7521 useopen If included, jump to the first open window that
7522 contains the specified buffer (if there is one).
7523 Otherwise: Do not examine other windows.
7524 This setting is checked with |quickfix| commands, when
7525 jumping to errors (":cc", ":cn", "cp", etc.). It is
7526 also used in all buffer related split commands, for
7527 example ":sbuffer", ":sbnext", or ":sbrewind".
Bram Moolenaar779b74b2006-04-10 14:55:34 +00007528 usetab Like "useopen", but also consider windows in other tab
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00007529 pages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007530 split If included, split the current window before loading
Bram Moolenaar15146672011-10-20 22:22:38 +02007531 a buffer for a |quickfix| command that display errors.
Bram Moolenaar63b74a82019-03-24 15:09:13 +01007532 Otherwise: do not split, use current window (when used
7533 in the quickfix window: the previously used window or
7534 split if there is no other window).
Bram Moolenaara594d772015-06-19 14:41:49 +02007535 vsplit Just like "split" but split vertically.
Bram Moolenaar446cb832008-06-24 21:56:24 +00007536 newtab Like "split", but open a new tab page. Overrules
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02007537 "split" when both are present.
Bram Moolenaar539aa6b2019-11-17 18:09:38 +01007538 uselast If included, jump to the previously used window when
7539 jumping to errors with |quickfix| commands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007540
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007541 *'synmaxcol'* *'smc'*
7542'synmaxcol' 'smc' number (default 3000)
7543 local to buffer
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007544 {not available when compiled without the |+syntax|
7545 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007546 Maximum column in which to search for syntax items. In long lines the
7547 text after this column is not highlighted and following lines may not
7548 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007549 This helps to avoid very slow redrawing for an XML file that is one
7550 long line.
7551 Set to zero to remove the limit.
7552
Bram Moolenaar071d4272004-06-13 20:20:40 +00007553 *'syntax'* *'syn'*
7554'syntax' 'syn' string (default empty)
7555 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007556 {not available when compiled without the |+syntax|
7557 feature}
7558 When this option is set, the syntax with this name is loaded, unless
7559 syntax highlighting has been switched off with ":syntax off".
7560 Otherwise this option does not always reflect the current syntax (the
7561 b:current_syntax variable does).
7562 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007563 not automatically recognized. Example, in an IDL file:
7564 /* vim: set syntax=idl : */ ~
7565 When a dot appears in the value then this separates two filetype
7566 names. Example:
7567 /* vim: set syntax=c.doxygen : */ ~
7568 This will use the "c" syntax first, then the "doxygen" syntax.
7569 Note that the second one must be prepared to be loaded as an addition,
7570 otherwise it will be skipped. More than one dot may appear.
7571 To switch off syntax highlighting for the current file, use: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007572 :set syntax=OFF
7573< To switch syntax highlighting on according to the current value of the
7574 'filetype' option: >
7575 :set syntax=ON
7576< What actually happens when setting the 'syntax' option is that the
7577 Syntax autocommand event is triggered with the value as argument.
7578 This option is not copied to another buffer, independent of the 's' or
7579 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007580 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007581
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007582 *'tabline'* *'tal'*
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007583'tabline' 'tal' string (default empty)
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007584 global
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007585 When nonempty, this option determines the content of the tab pages
7586 line at the top of the Vim window. When empty Vim will use a default
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007587 tab pages line. See |setting-tabline| for more info.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007588
7589 The tab pages line only appears as specified with the 'showtabline'
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00007590 option and only when there is no GUI tab line. When 'e' is in
7591 'guioptions' and the GUI supports a tab line 'guitablabel' is used
Bram Moolenaar7f036442010-08-15 15:24:20 +02007592 instead. Note that the two tab pages lines are very different.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007593
7594 The value is evaluated like with 'statusline'. You can use
7595 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007596 the text to be displayed. Use "%1T" for the first label, "%2T" for
7597 the second one, etc. Use "%X" items for closing labels.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007598
Bram Moolenaare12bab32019-01-08 22:02:56 +01007599 When changing something that is used in 'tabline' that does not
7600 trigger it to be updated, use |:redrawtabline|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02007601 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaare12bab32019-01-08 22:02:56 +01007602
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007603 Keep in mind that only one of the tab pages is the current one, others
7604 are invisible and you can't jump to their windows.
7605
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007606
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007607 *'tabpagemax'* *'tpm'*
7608'tabpagemax' 'tpm' number (default 10)
7609 global
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007610 Maximum number of tab pages to be opened by the |-p| command line
7611 argument or the ":tab all" command. |tabpage|
7612
7613
7614 *'tabstop'* *'ts'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007615'tabstop' 'ts' number (default 8)
7616 local to buffer
7617 Number of spaces that a <Tab> in the file counts for. Also see
7618 |:retab| command, and 'softtabstop' option.
7619
7620 Note: Setting 'tabstop' to any other value than 8 can make your file
7621 appear wrong in many places (e.g., when printing it).
7622
7623 There are four main ways to use tabs in Vim:
7624 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
7625 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007626 will use a mix of tabs and spaces, but typing <Tab> and <BS> will
Bram Moolenaar071d4272004-06-13 20:20:40 +00007627 behave like a tab appears every 4 (or 3) characters.
7628 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
7629 'expandtab'. This way you will always insert spaces. The
7630 formatting will never be messed up when 'tabstop' is changed.
7631 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007632 |modeline| to set these values when editing the file again. Only
Bram Moolenaar071d4272004-06-13 20:20:40 +00007633 works when using Vim to edit the file.
7634 4. Always set 'tabstop' and 'shiftwidth' to the same value, and
7635 'noexpandtab'. This should then work (for initial indents only)
7636 for any tabstop setting that people use. It might be nice to have
7637 tabs after the first non-blank inserted as spaces if you do this
7638 though. Otherwise aligned comments will be wrong when 'tabstop' is
7639 changed.
7640
Bram Moolenaar04958cb2018-06-23 19:23:02 +02007641 If Vim is compiled with the |+vartabs| feature then the value of
7642 'tabstop' will be ignored if |'vartabstop'| is set to anything other
7643 than an empty string.
7644
Bram Moolenaar071d4272004-06-13 20:20:40 +00007645 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
7646'tagbsearch' 'tbs' boolean (default on)
7647 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007648 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007649 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00007650 searching makes searching for a tag a LOT faster, but a linear search
7651 will find more tags if the tags file wasn't properly sorted.
7652 Vim normally assumes that your tags files are sorted, or indicate that
7653 they are not sorted. Only when this is not the case does the
7654 'tagbsearch' option need to be switched off.
7655
7656 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007657 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00007658 certain files, or retry all files with a linear search. When
7659 'tagbsearch' is off, only a linear search is done.
7660
7661 Linear searching is done anyway, for one file, when Vim finds a line
7662 at the start of the file indicating that it's not sorted: >
Bram Moolenaar446cb832008-06-24 21:56:24 +00007663 !_TAG_FILE_SORTED 0 /some comment/
Bram Moolenaar071d4272004-06-13 20:20:40 +00007664< [The whitespace before and after the '0' must be a single <Tab>]
7665
7666 When a binary search was done and no match was found in any of the
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007667 files listed in 'tags', and case is ignored or a pattern is used
Bram Moolenaar071d4272004-06-13 20:20:40 +00007668 instead of a normal tag name, a retry is done with a linear search.
7669 Tags in unsorted tags files, and matches with different case will only
7670 be found in the retry.
7671
Bram Moolenaard4755bb2004-09-02 19:12:26 +00007672 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007673 linear search can be avoided when case is ignored. Use a value of '2'
7674 in the "!_TAG_FILE_SORTED" line for this. A tag file can be case-fold
7675 sorted with the -f switch to "sort" in most unices, as in the command:
7676 "sort -f -o tags tags". For "Exuberant ctags" version 5.x or higher
7677 (at least 5.5) the --sort=foldcase switch can be used for this as
7678 well. Note that case must be folded to uppercase for this to work.
7679
7680 By default, tag searches are case-sensitive. Case is ignored when
7681 'ignorecase' is set and 'tagcase' is "followic", or when 'tagcase' is
7682 "ignore".
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007683 Also when 'tagcase' is "followscs" and 'smartcase' is set, or
7684 'tagcase' is "smart", and the pattern contains only lowercase
7685 characters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007686
7687 When 'tagbsearch' is off, tags searching is slower when a full match
7688 exists, but faster when no full match exists. Tags in unsorted tags
7689 files may only be found with 'tagbsearch' off.
7690 When the tags file is not sorted, or sorted in a wrong way (not on
7691 ASCII byte value), 'tagbsearch' should be off, or the line given above
7692 must be included in the tags file.
7693 This option doesn't affect commands that find all matching tags (e.g.,
7694 command-line completion and ":help").
Bram Moolenaar071d4272004-06-13 20:20:40 +00007695
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007696 *'tagcase'* *'tc'*
7697'tagcase' 'tc' string (default "followic")
7698 global or local to buffer |global-local|
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007699 This option specifies how case is handled when searching the tags
7700 file:
7701 followic Follow the 'ignorecase' option
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007702 followscs Follow the 'smartcase' and 'ignorecase' options
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007703 ignore Ignore case
7704 match Match case
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007705 smart Ignore case unless an upper case letter is used
Bram Moolenaar036986f2017-03-16 17:41:02 +01007706 NOTE: This option is set to the Vi default value when 'compatible' is
7707 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007708
Bram Moolenaar45e18cb2019-04-28 18:05:35 +02007709 *'tagfunc'* *'tfu'*
7710'tagfunc' 'tfu' string (default: empty)
7711 local to buffer
7712 {not available when compiled without the |+eval|
7713 feature}
7714 This option specifies a function to be used to perform tag searches.
7715 The function gets the tag pattern and should return a List of matching
7716 tags. See |tag-function| for an explanation of how to write the
7717 function and an example.
7718
Bram Moolenaar071d4272004-06-13 20:20:40 +00007719 *'taglength'* *'tl'*
7720'taglength' 'tl' number (default 0)
7721 global
7722 If non-zero, tags are significant up to this number of characters.
7723
7724 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
7725'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
7726 global
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00007727 If on and using a tags file in another directory, file names in that
7728 tags file are relative to the directory where the tags file is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007729 NOTE: This option is set to the Vi default value when 'compatible' is
7730 set and to the Vim default value when 'compatible' is reset.
7731
7732 *'tags'* *'tag'* *E433*
7733'tags' 'tag' string (default "./tags,tags", when compiled with
7734 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
7735 global or local to buffer |global-local|
7736 Filenames for the tag command, separated by spaces or commas. To
7737 include a space or comma in a file name, precede it with a backslash
7738 (see |option-backslash| about including spaces and backslashes).
7739 When a file name starts with "./", the '.' is replaced with the path
7740 of the current file. But only when the 'd' flag is not included in
7741 'cpoptions'. Environment variables are expanded |:set_env|. Also see
7742 |tags-option|.
7743 "*", "**" and other wildcards can be used to search for tags files in
Bram Moolenaare2b590e2010-08-08 18:29:48 +02007744 a directory tree. See |file-searching|. E.g., "/lib/**/tags" will
7745 find all files named "tags" below "/lib". The filename itself cannot
7746 contain wildcards, it is used as-is. E.g., "/lib/**/tags?" will find
7747 files called "tags?". {not available when compiled without the
7748 |+path_extra| feature}
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00007749 The |tagfiles()| function can be used to get a list of the file names
7750 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007751 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
7752 files are also supported. They are automatically recognized. The
7753 default value becomes "./tags,./TAGS,tags,TAGS", unless case
7754 differences are ignored (MS-Windows). |emacs-tags|
7755 The use of |:set+=| and |:set-=| is preferred when adding or removing
7756 file names from the list. This avoids problems when a future version
7757 uses another default.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007758
7759 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
7760'tagstack' 'tgst' boolean (default on)
7761 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007762 When on, the |tagstack| is used normally. When off, a ":tag" or
7763 ":tselect" command with an argument will not push the tag onto the
7764 tagstack. A following ":tag" without an argument, a ":pop" command or
7765 any other command that uses the tagstack will use the unmodified
7766 tagstack, but does change the pointer to the active entry.
7767 Resetting this option is useful when using a ":tag" command in a
7768 mapping which should not change the tagstack.
7769
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007770 *'tcldll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01007771'tcldll' string (default depends on the build)
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007772 global
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007773 {only available when compiled with the |+tcl/dyn|
7774 feature}
7775 Specifies the name of the Tcl shared library. The default is
7776 DYNAMIC_TCL_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02007777 Environment variables are expanded |:set_env|.
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007778 This option cannot be set from a |modeline| or in the |sandbox|, for
7779 security reasons.
7780
Bram Moolenaar071d4272004-06-13 20:20:40 +00007781 *'term'* *E529* *E530* *E531*
7782'term' string (default is $TERM, if that fails:
7783 in the GUI: "builtin_gui"
7784 on Amiga: "amiga"
Bram Moolenaarb3f74062020-02-26 16:16:53 +01007785 on Haiku: "xterm"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007786 on Mac: "mac-ansi"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007787 on Unix: "ansi"
7788 on VMS: "ansi"
7789 on Win 32: "win32")
7790 global
7791 Name of the terminal. Used for choosing the terminal control
7792 characters. Environment variables are expanded |:set_env|.
7793 For example: >
7794 :set term=$TERM
7795< See |termcap|.
7796
7797 *'termbidi'* *'tbidi'*
7798 *'notermbidi'* *'notbidi'*
7799'termbidi' 'tbidi' boolean (default off, on for "mlterm")
7800 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007801 {only available when compiled with the |+arabic|
7802 feature}
7803 The terminal is in charge of Bi-directionality of text (as specified
7804 by Unicode). The terminal is also expected to do the required shaping
7805 that some languages (such as Arabic) require.
7806 Setting this option implies that 'rightleft' will not be set when
7807 'arabic' is set and the value of 'arabicshape' will be ignored.
7808 Note that setting 'termbidi' has the immediate effect that
7809 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
7810 This option is reset when the GUI is started.
7811 For further details see |arabic.txt|.
7812
7813 *'termencoding'* *'tenc'*
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02007814'termencoding' 'tenc' string (default ""; with GTK+ GUI: "utf-8")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007815 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007816 Encoding used for the terminal. This specifies what character
7817 encoding the keyboard produces and the display will understand. For
Bram Moolenaar3848e002016-03-19 18:42:29 +01007818 the GUI it only applies to the keyboard ('encoding' is used for the
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02007819 display).
Bram Moolenaar4b7cdca2020-01-01 16:18:38 +01007820 *E617* *E950*
Bram Moolenaar3df01732017-02-17 22:47:16 +01007821 Note: This does not apply to the GTK+ GUI. After the GUI has been
Bram Moolenaar071d4272004-06-13 20:20:40 +00007822 successfully initialized, 'termencoding' is forcibly set to "utf-8".
7823 Any attempts to set a different value will be rejected, and an error
7824 message is shown.
Bram Moolenaarac360bf2015-09-01 20:31:20 +02007825 For the Win32 GUI and console versions 'termencoding' is not used,
Bram Moolenaar071d4272004-06-13 20:20:40 +00007826 because the Win32 system always passes Unicode characters.
7827 When empty, the same encoding is used as for the 'encoding' option.
7828 This is the normal value.
7829 Not all combinations for 'termencoding' and 'encoding' are valid. See
7830 |encoding-table|.
7831 The value for this option must be supported by internal conversions or
7832 iconv(). When this is not possible no conversion will be done and you
7833 will probably experience problems with non-ASCII characters.
7834 Example: You are working with the locale set to euc-jp (Japanese) and
7835 want to edit a UTF-8 file: >
7836 :let &termencoding = &encoding
7837 :set encoding=utf-8
7838< You need to do this when your system has no locale support for UTF-8.
7839
Bram Moolenaarcafafb32018-02-22 21:07:09 +01007840 *'termguicolors'* *'tgc'* *E954*
Bram Moolenaar61be73b2016-04-29 22:59:22 +02007841'termguicolors' 'tgc' boolean (default off)
7842 global
Bram Moolenaar61be73b2016-04-29 22:59:22 +02007843 {not available when compiled without the
7844 |+termguicolors| feature}
7845 When on, uses |highlight-guifg| and |highlight-guibg| attributes in
Bram Moolenaarcafafb32018-02-22 21:07:09 +01007846 the terminal (thus using 24-bit color).
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01007847
Bram Moolenaarcafafb32018-02-22 21:07:09 +01007848 Requires a ISO-8613-3 compatible terminal. If setting this option
7849 does not work (produces a colorless UI) reading |xterm-true-color|
7850 might help.
7851
7852 For Win32 console, Windows 10 version 1703 (Creators Update) or later
7853 is required. Use this check to find out: >
7854 if has('vcon')
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01007855< This requires Vim to be built with the |+vtp| feature.
7856
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +02007857 Note that the "cterm" attributes are still used, not the "gui" ones.
Bram Moolenaar036986f2017-03-16 17:41:02 +01007858 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar61be73b2016-04-29 22:59:22 +02007859
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02007860 *'termwinkey'* *'twk'*
7861'termwinkey' 'twk' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02007862 local to window
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007863 The key that starts a CTRL-W command in a terminal window. Other keys
Bram Moolenaar74675a62017-07-15 13:53:23 +02007864 are sent to the job running in the window.
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007865 The <> notation can be used, e.g.: >
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02007866 :set termwinkey=<C-L>
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007867< The string must be one key stroke but can be multiple bytes.
7868 When not set CTRL-W is used, so that CTRL-W : gets you to the command
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02007869 line. If 'termwinkey' is set to CTRL-L then CTRL-L : gets you to the
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007870 command line.
Bram Moolenaar74675a62017-07-15 13:53:23 +02007871
Bram Moolenaar6c60f472019-04-28 16:00:35 +02007872 *'termwinscroll'* *'twsl'*
7873'termwinscroll' 'twsl' number (default 10000)
7874 local to buffer
7875 {not available when compiled without the
7876 |+terminal| feature}
7877 Number of scrollback lines to keep. When going over this limit the
7878 first 10% of the scrollback lines are deleted. This is just to reduce
7879 the memory usage. See |Terminal-Normal|.
7880
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02007881 *'termwinsize'* *'tws'*
7882'termwinsize' 'tws' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02007883 local to window
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02007884 Size used when opening the |terminal| window. Format:
7885 {rows}x{columns} or {rows}*{columns}.
Bram Moolenaar74675a62017-07-15 13:53:23 +02007886 - When empty the terminal gets the size from the window.
Bram Moolenaar498c2562018-04-15 23:45:15 +02007887 - When set with a "x" (e.g., "24x80") the terminal size is not
7888 adjusted to the window size. If the window is smaller only the
7889 top-left part is displayed.
7890 - When set with a "*" (e.g., "10*50") the terminal size follows the
7891 window size, but will not be smaller than the specified rows and/or
7892 columns.
7893 - When rows is zero then use the height of the window.
7894 - When columns is zero then use the width of the window.
7895 - Using "0x0" or "0*0" is the same as empty.
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02007896 - Can be overruled in the |term_start()| options with "term_rows" and
7897 "term_cols".
Bram Moolenaar498c2562018-04-15 23:45:15 +02007898
7899 Examples:
7900 "30x0" uses 30 rows and the current window width.
7901 "20*0" uses at least 20 rows and the current window width.
7902 "0*40" uses the current window height and at least 40 columns.
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02007903 Note that the command running in the terminal window may still change
7904 the size of the terminal. In that case the Vim window will be
7905 adjusted to that size, if possible.
Bram Moolenaar74675a62017-07-15 13:53:23 +02007906
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01007907 *'termwintype'* *'twt'*
7908'termwintype' 'twt' string (default "")
7909 global
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01007910 {only available when compiled with the |terminal|
7911 feature on MS-Windows}
7912 Specify the virtual console (pty) used when opening the terminal
7913 window.
7914
7915 Possible values are:
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01007916 "" use ConPTY if it is stable, winpty otherwise
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01007917 "winpty" use winpty, fail if not supported
7918 "conpty" use |ConPTY|, fail if not supported
7919
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01007920 |ConPTY| support depends on the platform. Windows 10 October 2018
7921 Update is the first version that supports ConPTY, however it is still
7922 considered unstable. ConPTY might become stable in the next release
7923 of Windows 10. winpty support needs to be installed. If neither is
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01007924 supported then you cannot open a terminal window.
7925
Bram Moolenaar071d4272004-06-13 20:20:40 +00007926 *'terse'* *'noterse'*
7927'terse' boolean (default off)
7928 global
7929 When set: Add 's' flag to 'shortmess' option (this makes the message
7930 for a search that hits the start or end of the file not being
7931 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
7932 shortens a lot of messages}
7933
7934 *'textauto'* *'ta'* *'notextauto'* *'nota'*
7935'textauto' 'ta' boolean (Vim default: on, Vi default: off)
7936 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007937 This option is obsolete. Use 'fileformats'.
7938 For backwards compatibility, when 'textauto' is set, 'fileformats' is
7939 set to the default value for the current system. When 'textauto' is
7940 reset, 'fileformats' is made empty.
7941 NOTE: This option is set to the Vi default value when 'compatible' is
7942 set and to the Vim default value when 'compatible' is reset.
7943
7944 *'textmode'* *'tx'* *'notextmode'* *'notx'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01007945'textmode' 'tx' boolean (Win32: default on,
Bram Moolenaar071d4272004-06-13 20:20:40 +00007946 others: default off)
7947 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007948 This option is obsolete. Use 'fileformat'.
7949 For backwards compatibility, when 'textmode' is set, 'fileformat' is
7950 set to "dos". When 'textmode' is reset, 'fileformat' is set to
7951 "unix".
7952
7953 *'textwidth'* *'tw'*
7954'textwidth' 'tw' number (default 0)
7955 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007956 Maximum width of text that is being inserted. A longer line will be
7957 broken after white space to get this width. A zero value disables
Bram Moolenaarca635012015-09-25 20:34:21 +02007958 this.
7959 'textwidth' is set to 0 when the 'paste' option is set and restored
7960 when 'paste' is reset.
7961 When 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00007962 'formatoptions' and |ins-textwidth|.
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00007963 When 'formatexpr' is set it will be used to break the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007964 NOTE: This option is set to 0 when 'compatible' is set.
7965
7966 *'thesaurus'* *'tsr'*
7967'thesaurus' 'tsr' string (default "")
7968 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007969 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01007970 for thesaurus completion commands |i_CTRL-X_CTRL-T|.
7971
7972 Each line in the file should contain words with similar meaning,
7973 separated by non-keyword characters (white space is preferred).
7974 Maximum line length is 510 bytes.
7975
Bram Moolenaard47d5222018-12-09 20:43:55 +01007976 An English word list was added to this github issue:
7977 https://github.com/vim/vim/issues/629#issuecomment-443293282
7978 Unpack thesaurus_pkg.zip, put the thesaurus.txt file somewhere, e.g.
7979 ~/.vim/thesaurus/english.txt, and the 'thesaurus' option to this file
7980 name.
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01007981
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007982 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00007983 after a comma are ignored, otherwise spaces are included in the file
7984 name. See |option-backslash| about using backslashes.
7985 The use of |:set+=| and |:set-=| is preferred when adding or removing
7986 directories from the list. This avoids problems when a future version
7987 uses another default.
7988 Backticks cannot be used in this option for security reasons.
7989
7990 *'tildeop'* *'top'* *'notildeop'* *'notop'*
7991'tildeop' 'top' boolean (default off)
7992 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007993 When on: The tilde command "~" behaves like an operator.
7994 NOTE: This option is reset when 'compatible' is set.
7995
7996 *'timeout'* *'to'* *'notimeout'* *'noto'*
7997'timeout' 'to' boolean (default on)
7998 global
7999 *'ttimeout'* *'nottimeout'*
Bram Moolenaar94237492017-04-23 18:40:21 +02008000'ttimeout' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008001 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008002 These two options together determine the behavior when part of a
8003 mapped key sequence or keyboard code has been received:
8004
8005 'timeout' 'ttimeout' action ~
8006 off off do not time out
8007 on on or off time out on :mappings and key codes
8008 off on time out on key codes
8009
8010 If both options are off, Vim will wait until either the complete
8011 mapping or key sequence has been received, or it is clear that there
8012 is no mapping or key sequence for the received characters. For
8013 example: if you have mapped "vl" and Vim has received 'v', the next
8014 character is needed to see if the 'v' is followed by an 'l'.
8015 When one of the options is on, Vim will wait for about 1 second for
8016 the next character to arrive. After that the already received
8017 characters are interpreted as single characters. The waiting time can
8018 be changed with the 'timeoutlen' option.
8019 On slow terminals or very busy systems timing out may cause
8020 malfunctioning cursor keys. If both options are off, Vim waits
8021 forever after an entered <Esc> if there are key codes that start
8022 with <Esc>. You will have to type <Esc> twice. If you do not have
8023 problems with key codes, but would like to have :mapped key
8024 sequences not timing out in 1 second, set the 'ttimeout' option and
8025 reset the 'timeout' option.
8026
8027 NOTE: 'ttimeout' is reset when 'compatible' is set.
8028
8029 *'timeoutlen'* *'tm'*
8030'timeoutlen' 'tm' number (default 1000)
8031 global
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008032
Bram Moolenaar071d4272004-06-13 20:20:40 +00008033 *'ttimeoutlen'* *'ttm'*
Bram Moolenaar94237492017-04-23 18:40:21 +02008034'ttimeoutlen' 'ttm' number (default -1, set to 100 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008035 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008036 The time in milliseconds that is waited for a key code or mapped key
8037 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
8038 when part of a command has been typed.
8039 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
8040 different timeout value for key codes is desired set 'ttimeoutlen' to
8041 a non-negative number.
8042
8043 ttimeoutlen mapping delay key code delay ~
8044 < 0 'timeoutlen' 'timeoutlen'
8045 >= 0 'timeoutlen' 'ttimeoutlen'
8046
8047 The timeout only happens when the 'timeout' and 'ttimeout' options
8048 tell so. A useful setting would be >
8049 :set timeout timeoutlen=3000 ttimeoutlen=100
8050< (time out on mapping after three seconds, time out on key codes after
8051 a tenth of a second).
8052
8053 *'title'* *'notitle'*
8054'title' boolean (default off, on when title can be restored)
8055 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008056 {not available when compiled without the |+title|
8057 feature}
8058 When on, the title of the window will be set to the value of
8059 'titlestring' (if it is not empty), or to:
8060 filename [+=-] (path) - VIM
8061 Where:
8062 filename the name of the file being edited
8063 - indicates the file cannot be modified, 'ma' off
8064 + indicates the file was modified
8065 = indicates the file is read-only
8066 =+ indicates the file is read-only and modified
8067 (path) is the path of the file being edited
8068 - VIM the server name |v:servername| or "VIM"
8069 Only works if the terminal supports setting window titles
8070 (currently Amiga console, Win32 console, all GUI versions and
Bram Moolenaard1caa942020-04-10 22:10:56 +02008071 terminals with a non-empty 't_ts' option - these are Unix xterm and
Bram Moolenaar071d4272004-06-13 20:20:40 +00008072 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
8073 *X11*
8074 When Vim was compiled with HAVE_X11 defined, the original title will
8075 be restored if possible. The output of ":version" will include "+X11"
8076 when HAVE_X11 was defined, otherwise it will be "-X11". This also
8077 works for the icon name |'icon'|.
8078 But: When Vim was started with the |-X| argument, restoring the title
8079 will not work (except in the GUI).
8080 If the title cannot be restored, it is set to the value of 'titleold'.
8081 You might want to restore the title outside of Vim then.
8082 When using an xterm from a remote machine you can use this command:
8083 rsh machine_name xterm -display $DISPLAY &
8084 then the WINDOWID environment variable should be inherited and the
8085 title of the window should change back to what it should be after
8086 exiting Vim.
8087
8088 *'titlelen'*
8089'titlelen' number (default 85)
8090 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008091 {not available when compiled without the |+title|
8092 feature}
8093 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008094 title. When the title is longer, only the end of the path name is
8095 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008096 Using a percentage makes this adapt to the width of the window. But
8097 it won't work perfectly, because the actual number of characters
8098 available also depends on the font used and other things in the title
8099 bar. When 'titlelen' is zero the full path is used. Otherwise,
8100 values from 1 to 30000 percent can be used.
8101 'titlelen' is also used for the 'titlestring' option.
8102
8103 *'titleold'*
8104'titleold' string (default "Thanks for flying Vim")
8105 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008106 {only available when compiled with the |+title|
8107 feature}
8108 This option will be used for the window title when exiting Vim if the
8109 original title cannot be restored. Only happens if 'title' is on or
8110 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00008111 This option cannot be set from a |modeline| or in the |sandbox|, for
8112 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008113 *'titlestring'*
8114'titlestring' string (default "")
8115 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008116 {not available when compiled without the |+title|
8117 feature}
8118 When this option is not empty, it will be used for the title of the
8119 window. This happens only when the 'title' option is on.
8120 Only works if the terminal supports setting window titles (currently
8121 Amiga console, Win32 console, all GUI versions and terminals with a
8122 non-empty 't_ts' option).
8123 When Vim was compiled with HAVE_X11 defined, the original title will
Bram Moolenaar51628222016-12-01 23:03:28 +01008124 be restored if possible, see |X11|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008125
Bram Moolenaar071d4272004-06-13 20:20:40 +00008126 When this option contains printf-style '%' items, they will be
8127 expanded according to the rules used for 'statusline'.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008128 This option cannot be set in a modeline when 'modelineexpr' is off.
8129
Bram Moolenaar071d4272004-06-13 20:20:40 +00008130 Example: >
8131 :auto BufEnter * let &titlestring = hostname() . "/" . expand("%:p")
8132 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
8133< The value of 'titlelen' is used to align items in the middle or right
8134 of the available space.
8135 Some people prefer to have the file name first: >
8136 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
8137< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008138 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00008139 separating space only when needed.
8140 NOTE: Use of special characters in 'titlestring' may cause the display
8141 to be garbled (e.g., when it contains a CR or NL character).
8142 {not available when compiled without the |+statusline| feature}
8143
8144 *'toolbar'* *'tb'*
8145'toolbar' 'tb' string (default "icons,tooltips")
8146 global
8147 {only for |+GUI_GTK|, |+GUI_Athena|, |+GUI_Motif| and
8148 |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008149 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00008150 possible values are:
8151 icons Toolbar buttons are shown with icons.
8152 text Toolbar buttons shown with text.
8153 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008154 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008155 tooltips Tooltips are active for toolbar buttons.
8156 Tooltips refer to the popup help text which appears after the mouse
8157 cursor is placed over a toolbar button for a brief moment.
8158
8159 If you want the toolbar to be shown with icons as well as text, do the
8160 following: >
8161 :set tb=icons,text
8162< Motif and Athena cannot display icons and text at the same time. They
8163 will show icons if both are requested.
8164
8165 If none of the strings specified in 'toolbar' are valid or if
8166 'toolbar' is empty, this option is ignored. If you want to disable
8167 the toolbar, you need to set the 'guioptions' option. For example: >
8168 :set guioptions-=T
8169< Also see |gui-toolbar|.
8170
8171 *'toolbariconsize'* *'tbis'*
8172'toolbariconsize' 'tbis' string (default "small")
8173 global
Bram Moolenaar3df01732017-02-17 22:47:16 +01008174 {only in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008175 Controls the size of toolbar icons. The possible values are:
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008176 tiny Use tiny icons.
8177 small Use small icons (default).
8178 medium Use medium-sized icons.
8179 large Use large icons.
8180 huge Use even larger icons.
8181 giant Use very big icons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008182 The exact dimensions in pixels of the various icon sizes depend on
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008183 the current theme. Common dimensions are giant=48x48, huge=32x32,
8184 large=24x24, medium=24x24, small=20x20 and tiny=16x16.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008185
8186 If 'toolbariconsize' is empty, the global default size as determined
8187 by user preferences or the current theme is used.
8188
8189 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
8190'ttybuiltin' 'tbi' boolean (default on)
8191 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008192 When on, the builtin termcaps are searched before the external ones.
8193 When off the builtin termcaps are searched after the external ones.
8194 When this option is changed, you should set the 'term' option next for
8195 the change to take effect, for example: >
8196 :set notbi term=$TERM
8197< See also |termcap|.
8198 Rationale: The default for this option is "on", because the builtin
8199 termcap entries are generally better (many systems contain faulty
8200 xterm entries...).
8201
8202 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
8203'ttyfast' 'tf' boolean (default off, on when 'term' is xterm, hpterm,
8204 sun-cmd, screen, rxvt, dtterm or
8205 iris-ansi; also on when running Vim in
8206 a DOS console)
8207 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008208 Indicates a fast terminal connection. More characters will be sent to
8209 the screen for redrawing, instead of using insert/delete line
8210 commands. Improves smoothness of redrawing when there are multiple
8211 windows and the terminal does not support a scrolling region.
8212 Also enables the extra writing of characters at the end of each screen
8213 line for lines that wrap. This helps when using copy/paste with the
8214 mouse in an xterm and other terminals.
8215
8216 *'ttymouse'* *'ttym'*
8217'ttymouse' 'ttym' string (default depends on 'term')
8218 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008219 {only in Unix and VMS, doesn't work in the GUI; not
8220 available when compiled without |+mouse|}
8221 Name of the terminal type for which mouse codes are to be recognized.
Bram Moolenaar2c7a7632007-05-10 18:19:11 +00008222 Currently these strings are valid:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008223 *xterm-mouse*
8224 xterm xterm-like mouse handling. The mouse generates
8225 "<Esc>[Mscr", where "scr" is three bytes:
8226 "s" = button state
8227 "c" = column plus 33
8228 "r" = row plus 33
Bram Moolenaare968e362014-05-13 20:23:24 +02008229 This only works up to 223 columns! See "dec",
8230 "urxvt", and "sgr" for solutions.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008231 xterm2 Works like "xterm", but with the xterm reporting the
8232 mouse position while the mouse is dragged. This works
8233 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00008234 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00008235 work. See below for how Vim detects this
8236 automatically.
8237 *netterm-mouse*
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008238 netterm NetTerm mouse handling. A left mouse click generates
Bram Moolenaar071d4272004-06-13 20:20:40 +00008239 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008240 for the row and column. No other mouse events are
8241 supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008242 *dec-mouse*
8243 dec DEC terminal mouse handling. The mouse generates a
8244 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00008245 This is also available for an Xterm, if it was
8246 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00008247 *jsbterm-mouse*
8248 jsbterm JSB term mouse handling.
8249 *pterm-mouse*
8250 pterm QNX pterm mouse handling.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008251 *urxvt-mouse*
8252 urxvt Mouse handling for the urxvt (rxvt-unicode) terminal.
Bram Moolenaare968e362014-05-13 20:23:24 +02008253 The mouse works only if the terminal supports this
8254 encoding style, but it does not have 223 columns limit
8255 unlike "xterm" or "xterm2".
Bram Moolenaar9b451252012-08-15 17:43:31 +02008256 *sgr-mouse*
8257 sgr Mouse handling for the terminal that emits SGR-styled
Bram Moolenaare968e362014-05-13 20:23:24 +02008258 mouse reporting. The mouse works even in columns
8259 beyond 223. This option is backward compatible with
8260 "xterm2" because it can also decode "xterm2" style
8261 mouse codes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008262
8263 The mouse handling must be enabled at compile time |+mouse_xterm|
Bram Moolenaare968e362014-05-13 20:23:24 +02008264 |+mouse_dec| |+mouse_netterm| |+mouse_jsbterm| |+mouse_urxvt|
8265 |+mouse_sgr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008266 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
8267 recognized, if enabled at compile time. DEC terminal mouse codes
8268 are recognized if enabled at compile time, and 'ttymouse' is not
Bram Moolenaare968e362014-05-13 20:23:24 +02008269 "xterm", "xterm2", "urxvt" or "sgr" (because dec mouse codes conflict
8270 with them).
Bram Moolenaar071d4272004-06-13 20:20:40 +00008271 This option is automatically set to "xterm", when the 'term' option is
Bram Moolenaar45758762016-10-12 23:08:06 +02008272 set to a name that starts with "xterm", "mlterm", "screen", "tmux",
8273 "st" (full match only), "st-" or "stterm", and 'ttymouse' is not set
8274 already.
Bram Moolenaare968e362014-05-13 20:23:24 +02008275 Additionally, if vim is compiled with the |+termresponse| feature and
8276 |t_RV| is set to the escape sequence to request the xterm version
Bram Moolenaarf8a07122019-07-01 22:06:07 +02008277 number, more intelligent detection is done.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008278 The "xterm2" value will be set if the xterm version is reported to be
Bram Moolenaard47d5222018-12-09 20:43:55 +01008279 from 95 to 276. The "sgr" value will be set if Vim detects Mac
8280 Terminal.app, iTerm2 or mintty, and when the xterm version is 277 or
8281 higher.
Bram Moolenaare968e362014-05-13 20:23:24 +02008282 If you do not want 'ttymouse' to be set to "xterm2" or "sgr"
8283 automatically, set t_RV to an empty string: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008284 :set t_RV=
8285<
8286 *'ttyscroll'* *'tsl'*
8287'ttyscroll' 'tsl' number (default 999)
8288 global
8289 Maximum number of lines to scroll the screen. If there are more lines
8290 to scroll the window is redrawn. For terminals where scrolling is
8291 very slow and redrawing is not slow this can be set to a small number,
8292 e.g., 3, to speed up displaying.
8293
8294 *'ttytype'* *'tty'*
8295'ttytype' 'tty' string (default from $TERM)
8296 global
8297 Alias for 'term', see above.
8298
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008299 *'undodir'* *'udir'*
8300'undodir' 'udir' string (default ".")
8301 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008302 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008303 List of directory names for undo files, separated with commas.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008304 See |'backupdir'| for details of the format.
Bram Moolenaar6a244fe2010-05-24 22:02:24 +02008305 "." means using the directory of the file. The undo file name for
8306 "file.txt" is ".file.txt.un~".
8307 For other directories the file name is the full path of the edited
8308 file, with path separators replaced with "%".
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008309 When writing: The first directory that exists is used. "." always
8310 works, no directories after "." will be used for writing.
8311 When reading all entries are tried to find an undo file. The first
8312 undo file that exists is used. When it cannot be read an error is
8313 given, no further entry is used.
8314 See |undo-persistence|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008315 This option cannot be set from a |modeline| or in the |sandbox|, for
8316 security reasons.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008317
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02008318 *'undofile'* *'noundofile'* *'udf'* *'noudf'*
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008319'undofile' 'udf' boolean (default off)
8320 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02008321 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008322 When on, Vim automatically saves undo history to an undo file when
8323 writing a buffer to a file, and restores undo history from the same
8324 file on buffer read.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008325 The directory where the undo file is stored is specified by 'undodir'.
8326 For more information about this feature see |undo-persistence|.
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008327 The undo file is not read when 'undoreload' causes the buffer from
8328 before a reload to be saved for undo.
Bram Moolenaar97d62492012-11-15 21:28:22 +01008329 When 'undofile' is turned off the undo file is NOT deleted.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008330 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008331
Bram Moolenaar071d4272004-06-13 20:20:40 +00008332 *'undolevels'* *'ul'*
Bram Moolenaar8024f932020-01-14 19:29:13 +01008333'undolevels' 'ul' number (default 100, 1000 for Unix, VMS and Win32)
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008334 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008335 Maximum number of changes that can be undone. Since undo information
Bram Moolenaar5be4cee2019-09-27 19:34:08 +02008336 is kept in memory, higher numbers will cause more memory to be used.
8337 Nevertheless, a single change can already use a large amount of memory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008338 Set to 0 for Vi compatibility: One level of undo and "u" undoes
8339 itself: >
8340 set ul=0
8341< But you can also get Vi compatibility by including the 'u' flag in
8342 'cpoptions', and still be able to use CTRL-R to repeat undo.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008343 Also see |undo-two-ways|.
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008344 Set to -1 for no undo at all. You might want to do this only for the
8345 current buffer: >
8346 setlocal ul=-1
Bram Moolenaar071d4272004-06-13 20:20:40 +00008347< This helps when you run out of memory for a single change.
Bram Moolenaar32efaf62014-11-05 17:02:17 +01008348
8349 The local value is set to -123456 when the global value is to be used.
8350
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008351 Also see |clear-undo|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008352
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008353 *'undoreload'* *'ur'*
8354'undoreload' 'ur' number (default 10000)
8355 global
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008356 Save the whole buffer for undo when reloading it. This applies to the
8357 ":e!" command and reloading for when the buffer changed outside of
8358 Vim. |FileChangedShell|
Bram Moolenaar24a98a02017-09-27 22:23:55 +02008359 The save only happens when this option is negative or when the number
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008360 of lines is smaller than the value of this option.
8361 Set this option to zero to disable undo for a reload.
8362
8363 When saving undo for a reload, any undo file is not read.
8364
8365 Note that this causes the whole buffer to be stored in memory. Set
8366 this option to a lower value if you run out of memory.
8367
Bram Moolenaar071d4272004-06-13 20:20:40 +00008368 *'updatecount'* *'uc'*
8369'updatecount' 'uc' number (default: 200)
8370 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008371 After typing this many characters the swap file will be written to
8372 disk. When zero, no swap file will be created at all (see chapter on
8373 recovery |crash-recovery|). 'updatecount' is set to zero by starting
8374 Vim with the "-n" option, see |startup|. When editing in readonly
8375 mode this option will be initialized to 10000.
8376 The swapfile can be disabled per buffer with |'swapfile'|.
8377 When 'updatecount' is set from zero to non-zero, swap files are
8378 created for all buffers that have 'swapfile' set. When 'updatecount'
8379 is set to zero, existing swap files are not deleted.
8380 Also see |'swapsync'|.
8381 This option has no meaning in buffers where |'buftype'| is "nofile"
8382 or "nowrite".
8383
8384 *'updatetime'* *'ut'*
8385'updatetime' 'ut' number (default 4000)
8386 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008387 If this many milliseconds nothing is typed the swap file will be
8388 written to disk (see |crash-recovery|). Also used for the
8389 |CursorHold| autocommand event.
8390
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008391 *'varsofttabstop'* *'vsts'*
8392'varsofttabstop' 'vsts' string (default "")
8393 local to buffer
8394 {only available when compiled with the |+vartabs|
8395 feature}
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008396 A list of the number of spaces that a <Tab> counts for while editing,
8397 such as inserting a <Tab> or using <BS>. It "feels" like variable-
8398 width <Tab>s are being inserted, while in fact a mixture of spaces
8399 and <Tab>s is used. Tab widths are separated with commas, with the
8400 final value applying to all subsequent tabs.
8401
8402 For example, when editing assembly language files where statements
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02008403 start in the 9th column and comments in the 41st, it may be useful
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008404 to use the following: >
8405 :set varsofttabstop=8,32,8
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02008406< This will set soft tabstops with 8 and 8 + 32 spaces, and 8 more
8407 for every column thereafter.
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008408
8409 Note that the value of |'softtabstop'| will be ignored while
8410 'varsofttabstop' is set.
8411
8412 *'vartabstop'* *'vts'*
8413'vartabstop' 'vts' string (default "")
8414 local to buffer
8415 {only available when compiled with the |+vartabs|
8416 feature}
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008417 A list of the number of spaces that a <Tab> in the file counts for,
8418 separated by commas. Each value corresponds to one tab, with the
8419 final value applying to all subsequent tabs. For example: >
8420 :set vartabstop=4,20,10,8
8421< This will make the first tab 4 spaces wide, the second 20 spaces,
8422 the third 10 spaces, and all following tabs 8 spaces.
8423
8424 Note that the value of |'tabstop'| will be ignored while 'vartabstop'
8425 is set.
8426
Bram Moolenaar071d4272004-06-13 20:20:40 +00008427 *'verbose'* *'vbs'*
8428'verbose' 'vbs' number (default 0)
8429 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008430 When bigger than zero, Vim will give messages about what it is doing.
8431 Currently, these messages are given:
8432 >= 1 When the viminfo file is read or written.
8433 >= 2 When a file is ":source"'ed.
Bram Moolenaar647a5302020-05-03 17:01:24 +02008434 >= 4 Shell commands.
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008435 >= 5 Every searched tags file and include file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008436 >= 8 Files for which a group of autocommands is executed.
8437 >= 9 Every executed autocommand.
Bram Moolenaar647a5302020-05-03 17:01:24 +02008438 >= 11 Finding items in a path
Bram Moolenaar071d4272004-06-13 20:20:40 +00008439 >= 12 Every executed function.
8440 >= 13 When an exception is thrown, caught, finished, or discarded.
8441 >= 14 Anything pending in a ":finally" clause.
Bram Moolenaar823654b2020-05-29 23:03:09 +02008442 >= 15 Every executed Ex command from a script (truncated at 200
8443 characters).
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02008444 >= 16 Every executed Ex command.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008445
8446 This option can also be set with the "-V" argument. See |-V|.
8447 This option is also set by the |:verbose| command.
8448
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008449 When the 'verbosefile' option is set then the verbose messages are not
8450 displayed.
8451
8452 *'verbosefile'* *'vfile'*
8453'verbosefile' 'vfile' string (default empty)
8454 global
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008455 When not empty all messages are written in a file with this name.
8456 When the file exists messages are appended.
8457 Writing to the file ends when Vim exits or when 'verbosefile' is made
Bram Moolenaar80794b12010-06-13 05:20:42 +02008458 empty. Writes are buffered, thus may not show up for some time.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008459 Setting 'verbosefile' to a new value is like making it empty first.
8460 The difference with |:redir| is that verbose messages are not
8461 displayed when 'verbosefile' is set.
8462
Bram Moolenaar071d4272004-06-13 20:20:40 +00008463 *'viewdir'* *'vdir'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008464'viewdir' 'vdir' string (default for Amiga and Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008465 "$VIM/vimfiles/view",
8466 for Unix: "~/.vim/view",
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02008467 for macOS: "$VIM:vimfiles:view"
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01008468 for VMS: "sys$login:vimfiles/view")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008469 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008470 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008471 feature}
8472 Name of the directory where to store files for |:mkview|.
8473 This option cannot be set from a |modeline| or in the |sandbox|, for
8474 security reasons.
8475
8476 *'viewoptions'* *'vop'*
Bram Moolenaar13e90412017-11-11 18:16:48 +01008477'viewoptions' 'vop' string (default: "folds,options,cursor,curdir")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008478 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008479 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008480 feature}
8481 Changes the effect of the |:mkview| command. It is a comma separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008482 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008483 word save and restore ~
8484 cursor cursor position in file and in window
8485 folds manually created folds, opened/closed folds and local
8486 fold options
8487 options options and mappings local to a window or buffer (not
8488 global values for local options)
Bram Moolenaar6e932462014-09-09 18:48:09 +02008489 localoptions same as "options"
Bram Moolenaar071d4272004-06-13 20:20:40 +00008490 slash backslashes in file names replaced with forward
8491 slashes
8492 unix with Unix end-of-line format (single <NL>), even when
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008493 on MS-Windows
Bram Moolenaar13e90412017-11-11 18:16:48 +01008494 curdir the window-local directory, if set with `:lcd`
Bram Moolenaar071d4272004-06-13 20:20:40 +00008495
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008496 "slash" and "unix" are useful on MS-Windows when sharing view files
Bram Moolenaar071d4272004-06-13 20:20:40 +00008497 with Unix. The Unix version of Vim cannot source dos format scripts,
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008498 but the MS-Windows version of Vim can source unix format scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008499
8500 *'viminfo'* *'vi'* *E526* *E527* *E528*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008501'viminfo' 'vi' string (Vi default: "", Vim default for
8502 MS-Windows: '100,<50,s10,h,rA:,rB:,
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01008503 for Amiga: '100,<50,s10,h,rdf0:,rdf1:,rdf2:
8504 for others: '100,<50,s10,h)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008505 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008506 {not available when compiled without the |+viminfo|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008507 feature}
8508 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008509 when exiting Vim (see |viminfo-file|). Except when 'viminfofile' is
8510 "NONE".
8511 The string should be a comma separated list of parameters, each
8512 consisting of a single character identifying the particular parameter,
8513 followed by a number or string which specifies the value of that
8514 parameter. If a particular character is left out, then the default
8515 value is used for that parameter. The following is a list of the
8516 identifying characters and the effect of their value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008517 CHAR VALUE ~
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008518 *viminfo-!*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008519 ! When included, save and restore global variables that start
8520 with an uppercase letter, and don't contain a lowercase
8521 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar680eeca2010-10-20 17:44:42 +02008522 and "_K_L_M" are not. Nested List and Dict items may not be
Bram Moolenaar166af9b2010-11-16 20:34:40 +01008523 read back correctly, you end up with an empty item.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008524 *viminfo-quote*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008525 " Maximum number of lines saved for each register. Old name of
8526 the '<' item, with the disadvantage that you need to put a
8527 backslash before the ", otherwise it will be recognized as the
8528 start of a comment!
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008529 *viminfo-%*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008530 % When included, save and restore the buffer list. If Vim is
8531 started with a file name argument, the buffer list is not
8532 restored. If Vim is started without a file name argument, the
Bram Moolenaard042dc82015-11-24 19:18:36 +01008533 buffer list is restored from the viminfo file. Quickfix
8534 ('buftype'), unlisted ('buflisted'), unnamed and buffers on
8535 removable media (|viminfo-r|) are not saved.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00008536 When followed by a number, the number specifies the maximum
8537 number of buffers that are stored. Without a number all
8538 buffers are stored.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008539 *viminfo-'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008540 ' Maximum number of previously edited files for which the marks
8541 are remembered. This parameter must always be included when
8542 'viminfo' is non-empty.
8543 Including this item also means that the |jumplist| and the
8544 |changelist| are stored in the viminfo file.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008545 *viminfo-/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008546 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008547 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00008548 patterns are also saved. When not included, the value of
8549 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008550 *viminfo-:*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008551 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008552 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008553 *viminfo-<*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008554 < Maximum number of lines saved for each register. If zero then
8555 registers are not saved. When not included, all lines are
8556 saved. '"' is the old name for this item.
8557 Also see the 's' item below: limit specified in Kbyte.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008558 *viminfo-@*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008559 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008560 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008561 *viminfo-c*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008562 c When included, convert the text in the viminfo file from the
8563 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00008564 'encoding'. See |viminfo-encoding|.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008565 *viminfo-f*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008566 f Whether file marks need to be stored. If zero, file marks ('0
8567 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008568 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00008569 cursor position (when exiting or when doing ":wviminfo").
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008570 *viminfo-h*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008571 h Disable the effect of 'hlsearch' when loading the viminfo
8572 file. When not included, it depends on whether ":nohlsearch"
8573 has been used since the last search command.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008574 *viminfo-n*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008575 n Name of the viminfo file. The name must immediately follow
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008576 the 'n'. Must be at the end of the option! If the
8577 'viminfofile' option is set, that file name overrides the one
8578 given here with 'viminfo'. Environment variables are
Bram Moolenaar063b9d12016-07-09 20:21:48 +02008579 expanded when opening the file, not when setting the option.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008580 *viminfo-r*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008581 r Removable media. The argument is a string (up to the next
8582 ','). This parameter can be given several times. Each
8583 specifies the start of a path for which no marks will be
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01008584 stored. This is to avoid removable media. For MS-Windows you
Bram Moolenaar071d4272004-06-13 20:20:40 +00008585 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
8586 also use it for temp files, e.g., for Unix: "r/tmp". Case is
8587 ignored. Maximum length of each 'r' argument is 50
8588 characters.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008589 *viminfo-s*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008590 s Maximum size of an item in Kbyte. If zero then registers are
8591 not saved. Currently only applies to registers. The default
8592 "s10" will exclude registers with more than 10 Kbyte of text.
8593 Also see the '<' item above: line count limit.
8594
8595 Example: >
8596 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
8597<
8598 '50 Marks will be remembered for the last 50 files you
8599 edited.
8600 <1000 Contents of registers (up to 1000 lines each) will be
8601 remembered.
8602 s100 Registers with more than 100 Kbyte text are skipped.
8603 :0 Command-line history will not be saved.
8604 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
8605 no / Since '/' is not specified, the default will be used,
8606 that is, save all of the search history, and also the
8607 previous search and substitute patterns.
8608 no % The buffer list will not be saved nor read back.
8609 no h 'hlsearch' highlighting will be restored.
8610
8611 When setting 'viminfo' from an empty value you can use |:rviminfo| to
8612 load the contents of the file, this is not done automatically.
8613
8614 This option cannot be set from a |modeline| or in the |sandbox|, for
8615 security reasons.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008616 NOTE: This option is set to the Vim default value when 'compatible'
8617 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008618
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008619 *'viminfofile'* *'vif'*
8620'viminfofile' 'vif' string (default: "")
8621 global
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008622 {not available when compiled without the |+viminfo|
8623 feature}
8624 When non-empty, overrides the file name used for viminfo.
8625 When equal to "NONE" no viminfo file will be read or written.
8626 This option can be set with the |-i| command line flag. The |--clean|
8627 command line flag sets it to "NONE".
Bram Moolenaar110289e2019-05-23 15:38:06 +02008628 This option cannot be set from a |modeline| or in the |sandbox|, for
8629 security reasons.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008630
Bram Moolenaar071d4272004-06-13 20:20:40 +00008631 *'virtualedit'* *'ve'*
8632'virtualedit' 've' string (default "")
8633 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008634 A comma separated list of these words:
8635 block Allow virtual editing in Visual block mode.
8636 insert Allow virtual editing in Insert mode.
8637 all Allow virtual editing in all modes.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008638 onemore Allow the cursor to move just past the end of the line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008639
Bram Moolenaar071d4272004-06-13 20:20:40 +00008640 Virtual editing means that the cursor can be positioned where there is
Bram Moolenaarebcbd022007-05-12 14:28:25 +00008641 no actual character. This can be halfway into a tab or beyond the end
Bram Moolenaar071d4272004-06-13 20:20:40 +00008642 of the line. Useful for selecting a rectangle in Visual mode and
8643 editing a table.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008644 "onemore" is not the same, it will only allow moving the cursor just
8645 after the last character of the line. This makes some commands more
8646 consistent. Previously the cursor was always past the end of the line
8647 if the line was empty. But it is far from Vi compatible. It may also
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008648 break some plugins or Vim scripts. For example because |l| can move
8649 the cursor after the last character. Use with care!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02008650 Using the `$` command will move to the last character in the line, not
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008651 past it. This may actually move the cursor to the left!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02008652 The `g$` command will move to the end of the screen line.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008653 It doesn't make sense to combine "all" with "onemore", but you will
8654 not get a warning for it.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008655 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008656
8657 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
8658'visualbell' 'vb' boolean (default off)
8659 global
Bram Moolenaar74675a62017-07-15 13:53:23 +02008660 Use a visual bell instead of beeping. The terminal code to display the
Bram Moolenaar071d4272004-06-13 20:20:40 +00008661 visual bell is given with 't_vb'. When no beep or flash is wanted,
Bram Moolenaar74675a62017-07-15 13:53:23 +02008662 use: >
8663 :set vb t_vb=
8664< If you want a short flash, you can use this on many terminals: >
8665 :set vb t_vb=[?5h$<100>[?5l
8666< Here $<100> specifies the time, you can use a smaller or bigger value
8667 to get a shorter or longer flash.
8668
8669 Note: Vim will limit the bell to once per half a second. This avoids
8670 having to wait for the flashing to finish when there are lots of
8671 bells, e.g. on key repeat. This also happens without 'visualbell'
8672 set.
8673
Bram Moolenaar071d4272004-06-13 20:20:40 +00008674 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
8675 for 20 msec. If you want to use a different time, use "<Esc>|40f",
8676 where 40 is the time in msec.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008677
8678 Note: When the GUI starts, 't_vb' is reset to its default value. You
8679 might want to set it again in your |gvimrc|.
8680
Bram Moolenaar071d4272004-06-13 20:20:40 +00008681 Does not work on the Amiga, you always get a screen flash.
8682 Also see 'errorbells'.
8683
8684 *'warn'* *'nowarn'*
8685'warn' boolean (default on)
8686 global
8687 Give a warning message when a shell command is used while the buffer
8688 has been changed.
8689
8690 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
8691'weirdinvert' 'wiv' boolean (default off)
8692 global
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00008693 This option has the same effect as the 't_xs' terminal option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008694 It is provided for backwards compatibility with version 4.x.
8695 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
8696 vice versa. Has no effect when the GUI is running.
8697
8698 *'whichwrap'* *'ww'*
8699'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
8700 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008701 Allow specified keys that move the cursor left/right to move to the
8702 previous/next line when the cursor is on the first/last character in
8703 the line. Concatenate characters to allow this for these keys:
8704 char key mode ~
8705 b <BS> Normal and Visual
8706 s <Space> Normal and Visual
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008707 h "h" Normal and Visual (not recommended)
8708 l "l" Normal and Visual (not recommended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008709 < <Left> Normal and Visual
8710 > <Right> Normal and Visual
8711 ~ "~" Normal
8712 [ <Left> Insert and Replace
8713 ] <Right> Insert and Replace
8714 For example: >
8715 :set ww=<,>,[,]
8716< allows wrap only when cursor keys are used.
8717 When the movement keys are used in combination with a delete or change
8718 operator, the <EOL> also counts for a character. This makes "3h"
8719 different from "3dh" when the cursor crosses the end of a line. This
8720 is also true for "x" and "X", because they do the same as "dl" and
8721 "dh". If you use this, you may also want to use the mapping
8722 ":map <BS> X" to make backspace delete the character in front of the
8723 cursor.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00008724 When 'l' is included and it is used after an operator at the end of a
Bram Moolenaar589edb32019-09-20 14:38:13 +02008725 line (not an empty line) then it will not move to the next line. This
8726 makes "dl", "cl", "yl" etc. work normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008727 NOTE: This option is set to the Vi default value when 'compatible' is
8728 set and to the Vim default value when 'compatible' is reset.
8729
8730 *'wildchar'* *'wc'*
8731'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
8732 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008733 Character you have to type to start wildcard expansion in the
8734 command-line, as specified with 'wildmode'.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008735 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008736 The character is not recognized when used inside a macro. See
8737 'wildcharm' for that.
8738 Although 'wc' is a number option, you can set it to a special key: >
8739 :set wc=<Esc>
8740< NOTE: This option is set to the Vi default value when 'compatible' is
8741 set and to the Vim default value when 'compatible' is reset.
8742
8743 *'wildcharm'* *'wcm'*
8744'wildcharm' 'wcm' number (default: none (0))
8745 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008746 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00008747 recognized when used inside a macro. You can find "spare" command-line
8748 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00008749 you'll never actually type 'wildcharm', just use it in mappings that
8750 automatically invoke completion mode, e.g.: >
8751 :set wcm=<C-Z>
Bram Moolenaar446cb832008-06-24 21:56:24 +00008752 :cnoremap ss so $vim/sessions/*.vim<C-Z>
Bram Moolenaar071d4272004-06-13 20:20:40 +00008753< Then after typing :ss you can use CTRL-P & CTRL-N.
8754
8755 *'wildignore'* *'wig'*
8756'wildignore' 'wig' string (default "")
8757 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008758 {not available when compiled without the |+wildignore|
8759 feature}
8760 A list of file patterns. A file that matches with one of these
Bram Moolenaar30b65812012-07-12 22:01:11 +02008761 patterns is ignored when expanding |wildcards|, completing file or
8762 directory names, and influences the result of |expand()|, |glob()| and
8763 |globpath()| unless a flag is passed to disable this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008764 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
8765 Also see 'suffixes'.
8766 Example: >
8767 :set wildignore=*.o,*.obj
8768< The use of |:set+=| and |:set-=| is preferred when adding or removing
8769 a pattern from the list. This avoids problems when a future version
8770 uses another default.
8771
Bram Moolenaar94950a92010-12-02 16:01:29 +01008772
Bram Moolenaar81af9252010-12-10 20:35:50 +01008773 *'wildignorecase'* *'wic'* *'nowildignorecase'* *'nowic'*
Bram Moolenaar94950a92010-12-02 16:01:29 +01008774'wildignorecase' 'wic' boolean (default off)
8775 global
Bram Moolenaar94950a92010-12-02 16:01:29 +01008776 When set case is ignored when completing file names and directories.
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01008777 Has no effect when 'fileignorecase' is set.
Bram Moolenaar94950a92010-12-02 16:01:29 +01008778 Does not apply when the shell is used to expand wildcards, which
8779 happens when there are special characters.
8780
8781
Bram Moolenaar071d4272004-06-13 20:20:40 +00008782 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02008783'wildmenu' 'wmnu' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008784 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008785 {not available if compiled without the |+wildmenu|
8786 feature}
8787 When 'wildmenu' is on, command-line completion operates in an enhanced
8788 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
8789 the possible matches are shown just above the command line, with the
8790 first match highlighted (overwriting the status line, if there is
8791 one). Keys that show the previous/next match, such as <Tab> or
8792 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
8793 When 'wildmode' is used, "wildmenu" mode is used where "full" is
8794 specified. "longest" and "list" do not start "wildmenu" mode.
Bram Moolenaar26402cb2013-02-20 21:26:00 +01008795 You can check the current mode with |wildmenumode()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008796 If there are more matches than can fit in the line, a ">" is shown on
8797 the right and/or a "<" is shown on the left. The status line scrolls
8798 as needed.
8799 The "wildmenu" mode is abandoned when a key is hit that is not used
8800 for selecting a completion.
8801 While the "wildmenu" is active the following keys have special
8802 meanings:
8803
8804 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
8805 <Down> - in filename/menu name completion: move into a
8806 subdirectory or submenu.
8807 <CR> - in menu completion, when the cursor is just after a
8808 dot: move into a submenu.
8809 <Up> - in filename/menu name completion: move up into
8810 parent directory or parent menu.
8811
8812 This makes the menus accessible from the console |console-menus|.
8813
8814 If you prefer the <Left> and <Right> keys to move the cursor instead
8815 of selecting a different match, use this: >
8816 :cnoremap <Left> <Space><BS><Left>
8817 :cnoremap <Right> <Space><BS><Right>
8818<
8819 The "WildMenu" highlighting is used for displaying the current match
8820 |hl-WildMenu|.
8821
8822 *'wildmode'* *'wim'*
8823'wildmode' 'wim' string (Vim default: "full")
8824 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008825 Completion mode that is used for the character specified with
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008826 'wildchar'. It is a comma separated list of up to four parts. Each
Bram Moolenaar02467872007-05-06 13:22:01 +00008827 part specifies what to do for each consecutive use of 'wildchar'. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00008828 first part specifies the behavior for the first use of 'wildchar',
8829 The second part for the second use, etc.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02008830
8831 Each part consists of a colon separated list consisting of the
8832 following possible values:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008833 "" Complete only the first match.
8834 "full" Complete the next full match. After the last match,
8835 the original string is used and then the first match
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02008836 again. Will also start 'wildmenu' if it is enabled.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008837 "longest" Complete till longest common string. If this doesn't
8838 result in a longer string, use the next part.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008839 "list" When more than one match, list all matches.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02008840 "lastused" When completing buffer names and more than one buffer
8841 matches, sort buffers by time last used (other than
8842 the current buffer).
8843 When there is only a single match, it is fully completed in all cases.
8844
8845 Examples of useful colon-separated values:
8846 "longest:full" Like "longest", but also start 'wildmenu' if it is
8847 enabled. Will not complete to the next full match.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008848 "list:full" When more than one match, list all matches and
8849 complete first match.
8850 "list:longest" When more than one match, list all matches and
8851 complete till longest common string.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02008852 "list:lastused" When more than one buffer matches, list all matches
8853 and sort buffers by time last used (other than the
8854 current buffer).
Bram Moolenaar071d4272004-06-13 20:20:40 +00008855
8856 Examples: >
8857 :set wildmode=full
Bram Moolenaar582fd852005-03-28 20:58:01 +00008858< Complete first full match, next match, etc. (the default) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008859 :set wildmode=longest,full
8860< Complete longest common string, then each full match >
8861 :set wildmode=list:full
8862< List all matches and complete each full match >
8863 :set wildmode=list,full
8864< List all matches without completing, then each full match >
8865 :set wildmode=longest,list
8866< Complete longest common string, then list alternatives.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008867 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008868
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00008869 *'wildoptions'* *'wop'*
8870'wildoptions' 'wop' string (default "")
8871 global
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00008872 {not available when compiled without the |+wildignore|
8873 feature}
8874 A list of words that change how command line completion is done.
8875 Currently only one word is allowed:
8876 tagfile When using CTRL-D to list matching tags, the kind of
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00008877 tag and the file of the tag is listed. Only one match
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00008878 is displayed per line. Often used tag kinds are:
8879 d #define
8880 f function
8881 Also see |cmdline-completion|.
8882
Bram Moolenaar071d4272004-06-13 20:20:40 +00008883 *'winaltkeys'* *'wak'*
8884'winaltkeys' 'wak' string (default "menu")
8885 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008886 {only used in Win32, Motif, GTK and Photon GUI}
8887 Some GUI versions allow the access to menu entries by using the ALT
8888 key in combination with a character that appears underlined in the
8889 menu. This conflicts with the use of the ALT key for mappings and
8890 entering special characters. This option tells what to do:
8891 no Don't use ALT keys for menus. ALT key combinations can be
8892 mapped, but there is no automatic handling. This can then be
8893 done with the |:simalt| command.
8894 yes ALT key handling is done by the windowing system. ALT key
8895 combinations cannot be mapped.
8896 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008897 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00008898 keys can be mapped.
8899 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
8900 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00008901 This option is not used for <F10>; on Win32 and with GTK <F10> will
8902 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008903
Bram Moolenaar4d784b22019-05-25 19:51:39 +02008904 *'wincolor'* *'wcr'*
8905'wincolor' 'wcr' string (default empty)
8906 local to window
8907 Highlight group name to use for this window instead of the Normal
8908 color |hl-Normal|.
8909
Bram Moolenaar4399ef42005-02-12 14:29:27 +00008910 *'window'* *'wi'*
8911'window' 'wi' number (default screen height - 1)
8912 global
Bram Moolenaardad44732021-03-31 20:07:33 +02008913 Window height used for |CTRL-F| and |CTRL-B| when there is only one
8914 window and the value is smaller than 'lines' minus one. The screen
8915 will scroll 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00008916 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
8917 in a much smarter way, taking care of wrapping lines.
8918 When resizing the Vim window, the value is smaller than 1 or more than
8919 or equal to 'lines' it will be set to 'lines' minus 1.
Bram Moolenaardad44732021-03-31 20:07:33 +02008920 Note: Do not confuse this with the height of the Vim window, use
8921 'lines' for that.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00008922
Bram Moolenaar071d4272004-06-13 20:20:40 +00008923 *'winheight'* *'wh'* *E591*
8924'winheight' 'wh' number (default 1)
8925 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008926 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008927 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar446cb832008-06-24 21:56:24 +00008928 focus goes to a window that is smaller, its size is increased, at the
8929 cost of the height of other windows.
8930 Set 'winheight' to a small number for normal editing.
8931 Set it to 999 to make the current window fill most of the screen.
8932 Other windows will be only 'winminheight' high. This has the drawback
8933 that ":all" will create only two windows. To avoid "vim -o 1 2 3 4"
8934 to create only two windows, set the option after startup is done,
8935 using the |VimEnter| event: >
8936 au VimEnter * set winheight=999
8937< Minimum value is 1.
8938 The height is not adjusted after one of the commands that change the
Bram Moolenaar071d4272004-06-13 20:20:40 +00008939 height of the current window.
8940 'winheight' applies to the current window. Use 'winminheight' to set
8941 the minimal height for other windows.
8942
8943 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
8944'winfixheight' 'wfh' boolean (default off)
8945 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00008946 Keep the window height when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00008947 'equalalways' is set. Also for |CTRL-W_=|. Set by default for the
8948 |preview-window| and |quickfix-window|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008949 The height may be changed anyway when running out of room.
8950
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008951 *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'*
8952'winfixwidth' 'wfw' boolean (default off)
8953 local to window
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008954 Keep the window width when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00008955 'equalalways' is set. Also for |CTRL-W_=|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008956 The width may be changed anyway when running out of room.
8957
Bram Moolenaar071d4272004-06-13 20:20:40 +00008958 *'winminheight'* *'wmh'*
8959'winminheight' 'wmh' number (default 1)
8960 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008961 The minimal height of a window, when it's not the current window.
8962 This is a hard minimum, windows will never become smaller.
8963 When set to zero, windows may be "squashed" to zero lines (i.e. just a
8964 status bar) if necessary. They will return to at least one line when
8965 they become active (since the cursor has to have somewhere to go.)
8966 Use 'winheight' to set the minimal height of the current window.
8967 This option is only checked when making a window smaller. Don't use a
8968 large number, it will cause errors when opening more than a few
8969 windows. A value of 0 to 3 is reasonable.
8970
8971 *'winminwidth'* *'wmw'*
8972'winminwidth' 'wmw' number (default 1)
8973 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008974 The minimal width of a window, when it's not the current window.
8975 This is a hard minimum, windows will never become smaller.
8976 When set to zero, windows may be "squashed" to zero columns (i.e. just
8977 a vertical separator) if necessary. They will return to at least one
8978 line when they become active (since the cursor has to have somewhere
8979 to go.)
8980 Use 'winwidth' to set the minimal width of the current window.
8981 This option is only checked when making a window smaller. Don't use a
8982 large number, it will cause errors when opening more than a few
8983 windows. A value of 0 to 12 is reasonable.
8984
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02008985 *'winptydll'*
8986'winptydll' string (default "winpty32.dll" or "winpty64.dll")
8987 global
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02008988 {only available when compiled with the |terminal|
8989 feature on MS-Windows}
8990 Specifies the name of the winpty shared library, used for the
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02008991 |:terminal| command. The default depends on whether Vim was built as a
Bram Moolenaarc572da52017-08-27 16:52:01 +02008992 32-bit or 64-bit executable. If not found, "winpty.dll" is tried as
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02008993 a fallback.
8994 Environment variables are expanded |:set_env|.
8995 This option cannot be set from a |modeline| or in the |sandbox|, for
8996 security reasons.
8997
Bram Moolenaar071d4272004-06-13 20:20:40 +00008998 *'winwidth'* *'wiw'* *E592*
8999'winwidth' 'wiw' number (default 20)
9000 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009001 Minimal number of columns for the current window. This is not a hard
9002 minimum, Vim will use fewer columns if there is not enough room. If
9003 the current window is smaller, its size is increased, at the cost of
9004 the width of other windows. Set it to 999 to make the current window
9005 always fill the screen. Set it to a small number for normal editing.
9006 The width is not adjusted after one of the commands to change the
9007 width of the current window.
9008 'winwidth' applies to the current window. Use 'winminwidth' to set
9009 the minimal width for other windows.
9010
9011 *'wrap'* *'nowrap'*
9012'wrap' boolean (default on)
9013 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00009014 This option changes how text is displayed. It doesn't change the text
9015 in the buffer, see 'textwidth' for that.
9016 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009017 displaying continues on the next line. When off lines will not wrap
9018 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00009019 moved to a part that is not shown, the screen will scroll
9020 horizontally.
9021 The line will be broken in the middle of a word if necessary. See
9022 'linebreak' to get the break at a word boundary.
9023 To make scrolling horizontally a bit more useful, try this: >
9024 :set sidescroll=5
9025 :set listchars+=precedes:<,extends:>
9026< See 'sidescroll', 'listchars' and |wrap-off|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01009027 This option can't be set from a |modeline| when the 'diff' option is
9028 on.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009029
9030 *'wrapmargin'* *'wm'*
9031'wrapmargin' 'wm' number (default 0)
9032 local to buffer
9033 Number of characters from the right window border where wrapping
9034 starts. When typing text beyond this limit, an <EOL> will be inserted
9035 and inserting continues on the next line.
9036 Options that add a margin, such as 'number' and 'foldcolumn', cause
9037 the text width to be further reduced. This is Vi compatible.
9038 When 'textwidth' is non-zero, this option is not used.
Bram Moolenaarca635012015-09-25 20:34:21 +02009039 This option is set to 0 when 'paste' is set and restored when 'paste'
9040 is reset.
Bram Moolenaara6c27c42019-05-09 19:16:22 +02009041 See also 'formatoptions' and |ins-textwidth|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009042
9043 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
9044'wrapscan' 'ws' boolean (default on) *E384* *E385*
9045 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00009046 Searches wrap around the end of the file. Also applies to |]s| and
9047 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009048
9049 *'write'* *'nowrite'*
9050'write' boolean (default on)
9051 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009052 Allows writing files. When not set, writing a file is not allowed.
9053 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009054 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00009055 argument. Filtering text is still possible, even though this requires
9056 writing a temporary file.
9057
9058 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
9059'writeany' 'wa' boolean (default off)
9060 global
9061 Allows writing to any file with no need for "!" override.
9062
9063 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
9064'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
9065 otherwise)
9066 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009067 Make a backup before overwriting a file. The backup is removed after
9068 the file was successfully written, unless the 'backup' option is
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02009069 also on.
9070 WARNING: Switching this option off means that when Vim fails to write
9071 your buffer correctly and then, for whatever reason, Vim exits, you
9072 lose both the original file and what you were writing. Only reset
9073 this option if your file system is almost full and it makes the write
9074 fail (and make sure not to exit Vim until the write was successful).
9075 See |backup-table| for another explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009076 When the 'backupskip' pattern matches, a backup is not made anyway.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01009077 Depending on 'backupcopy' the backup is a new file or the original
9078 file renamed (and a new file is written).
Bram Moolenaar071d4272004-06-13 20:20:40 +00009079 NOTE: This option is set to the default value when 'compatible' is
9080 set.
9081
9082 *'writedelay'* *'wd'*
9083'writedelay' 'wd' number (default 0)
9084 global
Bram Moolenaar802a0d92016-06-26 16:17:58 +02009085 The number of milliseconds to wait for each character sent to the
Bram Moolenaar071d4272004-06-13 20:20:40 +00009086 screen. When non-zero, characters are sent to the terminal one by
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01009087 one. For debugging purposes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009088
Bram Moolenaar91f84f62018-07-29 15:07:52 +02009089 vim:tw=78:ts=8:noet:ft=help:norl: