blob: a181ecb0d89cf2ded6f61f997d4793a7d41d4387 [file] [log] [blame]
Bram Moolenaar53f7fcc2021-07-28 20:10:16 +02001*options.txt* For Vim version 8.2. Last change: 2021 Jul 22
Bram Moolenaar071d4272004-06-13 20:20:40 +00002
3
4 VIM REFERENCE MANUAL by Bram Moolenaar
5
6
7Options *options*
8
91. Setting options |set-option|
102. Automatically setting options |auto-setting|
113. Options summary |option-summary|
12
Bram Moolenaar2ec618c2016-10-01 14:47:05 +020013For an overview of options see quickref.txt |option-list|.
Bram Moolenaar071d4272004-06-13 20:20:40 +000014
15Vim has a number of internal variables and switches which can be set to
16achieve special effects. These options come in three forms:
17 boolean can only be on or off *boolean* *toggle*
18 number has a numeric value
19 string has a string value
20
21==============================================================================
Bram Moolenaarf75a9632005-09-13 21:20:47 +0000221. Setting options *set-option* *E764*
Bram Moolenaar071d4272004-06-13 20:20:40 +000023
24 *:se* *:set*
Bram Moolenaar6b915c02020-01-18 15:53:19 +010025:se[t][!] Show all options that differ from their default value.
26 When [!] is present every option is on a separate
27 line.
Bram Moolenaar071d4272004-06-13 20:20:40 +000028
Bram Moolenaar6b915c02020-01-18 15:53:19 +010029:se[t][!] all Show all but terminal options.
30 When [!] is present every option is on a separate
31 line.
Bram Moolenaar071d4272004-06-13 20:20:40 +000032
33:se[t] termcap Show all terminal options. Note that in the GUI the
34 key codes are not shown, because they are generated
35 internally and can't be changed. Changing the terminal
36 codes in the GUI is not useful either...
37
38 *E518* *E519*
39:se[t] {option}? Show value of {option}.
40
41:se[t] {option} Toggle option: set, switch it on.
42 Number option: show value.
43 String option: show value.
44
45:se[t] no{option} Toggle option: Reset, switch it off.
46
Bram Moolenaar00a927d2010-05-14 23:24:24 +020047 *:set-!* *:set-inv*
Bram Moolenaar071d4272004-06-13 20:20:40 +000048:se[t] {option}! or
Bram Moolenaar6c60f472019-04-28 16:00:35 +020049:se[t] inv{option} Toggle option: Invert value.
Bram Moolenaar071d4272004-06-13 20:20:40 +000050
51 *:set-default* *:set-&* *:set-&vi* *:set-&vim*
52:se[t] {option}& Reset option to its default value. May depend on the
Bram Moolenaar6c60f472019-04-28 16:00:35 +020053 current value of 'compatible'.
54:se[t] {option}&vi Reset option to its Vi default value.
55:se[t] {option}&vim Reset option to its Vim default value.
Bram Moolenaar071d4272004-06-13 20:20:40 +000056
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +010057:se[t] all& Set all options to their default value. The values of
Bram Moolenaar88774fd2015-08-25 19:52:04 +020058 these options are not changed:
59 all terminal options, starting with t_
60 'columns'
61 'cryptmethod'
62 'encoding'
63 'key'
64 'lines'
65 'term'
66 'ttymouse'
67 'ttytype'
68 Warning: This may have a lot of side effects.
Bram Moolenaar071d4272004-06-13 20:20:40 +000069
70 *:set-args* *E487* *E521*
71:se[t] {option}={value} or
72:se[t] {option}:{value}
73 Set string or number option to {value}.
74 For numeric options the value can be given in decimal,
Bram Moolenaar3848e002016-03-19 18:42:29 +010075 hex (preceded with 0x) or octal (preceded with '0').
Bram Moolenaar071d4272004-06-13 20:20:40 +000076 The old value can be inserted by typing 'wildchar' (by
77 default this is a <Tab> or CTRL-E if 'compatible' is
78 set). See |cmdline-completion|.
79 White space between {option} and '=' is allowed and
80 will be ignored. White space between '=' and {value}
81 is not allowed.
82 See |option-backslash| for using white space and
83 backslashes in {value}.
84
85:se[t] {option}+={value} *:set+=*
86 Add the {value} to a number option, or append the
87 {value} to a string option. When the option is a
88 comma separated list, a comma is added, unless the
89 value was empty.
90 If the option is a list of flags, superfluous flags
Bram Moolenaara5792f52005-11-23 21:25:05 +000091 are removed. When adding a flag that was already
92 present the option value doesn't change.
Bram Moolenaar899dddf2006-03-26 21:06:50 +000093 Also see |:set-args| above.
Bram Moolenaar071d4272004-06-13 20:20:40 +000094
95:se[t] {option}^={value} *:set^=*
96 Multiply the {value} to a number option, or prepend
97 the {value} to a string option. When the option is a
98 comma separated list, a comma is added, unless the
99 value was empty.
100 Also see |:set-args| above.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000101
102:se[t] {option}-={value} *:set-=*
103 Subtract the {value} from a number option, or remove
104 the {value} from a string option, if it is there.
105 If the {value} is not found in a string option, there
106 is no error or warning. When the option is a comma
107 separated list, a comma is deleted, unless the option
108 becomes empty.
109 When the option is a list of flags, {value} must be
110 exactly as they appear in the option. Remove flags
111 one by one to avoid problems.
112 Also see |:set-args| above.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000113
114The {option} arguments to ":set" may be repeated. For example: >
115 :set ai nosi sw=3 ts=3
116If you make an error in one of the arguments, an error message will be given
117and the following arguments will be ignored.
118
119 *:set-verbose*
120When 'verbose' is non-zero, displaying an option value will also tell where it
121was last set. Example: >
122 :verbose set shiftwidth cindent?
Bram Moolenaar95bafa22018-10-02 13:26:25 +0200123< shiftwidth=4 ~
124 Last set from modeline line 1 ~
125 cindent ~
126 Last set from /usr/local/share/vim/vim60/ftplugin/c.vim line 30 ~
Bram Moolenaar446cb832008-06-24 21:56:24 +0000127This is only done when specific option values are requested, not for ":verbose
128set all" or ":verbose set" without an argument.
129When the option was set by hand there is no "Last set" message.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000130When the option was set while executing a function, user command or
131autocommand, the script in which it was defined is reported.
132Note that an option may also have been set as a side effect of setting
133'compatible'.
Bram Moolenaar446cb832008-06-24 21:56:24 +0000134A few special texts:
Bram Moolenaar95bafa22018-10-02 13:26:25 +0200135 Last set from modeline line 1 ~
Bram Moolenaar446cb832008-06-24 21:56:24 +0000136 Option was set in a |modeline|.
137 Last set from --cmd argument ~
138 Option was set with command line argument |--cmd| or +.
139 Last set from -c argument ~
140 Option was set with command line argument |-c|, +, |-S| or
141 |-q|.
142 Last set from environment variable ~
143 Option was set from an environment variable, $VIMINIT,
144 $GVIMINIT or $EXINIT.
145 Last set from error handler ~
146 Option was cleared when evaluating it resulted in an error.
147
Bram Moolenaardb84e452010-08-15 13:50:43 +0200148{not available when compiled without the |+eval| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000149
150 *:set-termcap* *E522*
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +0000151For {option} the form "t_xx" may be used to set a terminal option. This will
Bram Moolenaar071d4272004-06-13 20:20:40 +0000152override the value from the termcap. You can then use it in a mapping. If
153the "xx" part contains special characters, use the <t_xx> form: >
154 :set <t_#4>=^[Ot
155This can also be used to translate a special code for a normal key. For
156example, if Alt-b produces <Esc>b, use this: >
157 :set <M-b>=^[b
158(the ^[ is a real <Esc> here, use CTRL-V <Esc> to enter it)
159The advantage over a mapping is that it works in all situations.
160
Bram Moolenaar0b2f94d2011-03-22 14:35:05 +0100161You can define any key codes, e.g.: >
162 :set t_xy=^[foo;
163There is no warning for using a name that isn't recognized. You can map these
164codes as you like: >
165 :map <t_xy> something
166< *E846*
167When a key code is not set, it's like it does not exist. Trying to get its
168value will result in an error: >
169 :set t_kb=
170 :set t_kb
171 E846: Key code not set: t_kb
172
Bram Moolenaar293ee4d2004-12-09 21:34:53 +0000173The t_xx options cannot be set from a |modeline| or in the |sandbox|, for
174security reasons.
175
Bram Moolenaar071d4272004-06-13 20:20:40 +0000176The listing from ":set" looks different from Vi. Long string options are put
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000177at the end of the list. The number of options is quite large. The output of
Bram Moolenaar071d4272004-06-13 20:20:40 +0000178"set all" probably does not fit on the screen, causing Vim to give the
179|more-prompt|.
180
181 *option-backslash*
182To include white space in a string option value it has to be preceded with a
183backslash. To include a backslash you have to use two. Effectively this
184means that the number of backslashes in an option value is halved (rounded
185down).
186A few examples: >
187 :set tags=tags\ /usr/tags results in "tags /usr/tags"
188 :set tags=tags\\,file results in "tags\,file"
189 :set tags=tags\\\ file results in "tags\ file"
190
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000191The "|" character separates a ":set" command from a following command. To
192include the "|" in the option value, use "\|" instead. This example sets the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000193'titlestring' option to "hi|there": >
194 :set titlestring=hi\|there
195This sets the 'titlestring' option to "hi" and 'iconstring' to "there": >
196 :set titlestring=hi|set iconstring=there
197
Bram Moolenaar7df351e2006-01-23 22:30:28 +0000198Similarly, the double quote character starts a comment. To include the '"' in
199the option value, use '\"' instead. This example sets the 'titlestring'
200option to 'hi "there"': >
201 :set titlestring=hi\ \"there\"
202
Bram Moolenaar5666fcd2019-12-26 14:35:26 +0100203For Win32 backslashes in file names are mostly not removed. More precise: For
204options that expect a file name (those where environment variables are
205expanded) a backslash before a normal file name character is not removed. But
206a backslash before a special character (space, backslash, comma, etc.) is used
207like explained above.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000208There is one special situation, when the value starts with "\\": >
209 :set dir=\\machine\path results in "\\machine\path"
210 :set dir=\\\\machine\\path results in "\\machine\path"
211 :set dir=\\path\\file results in "\\path\file" (wrong!)
212For the first one the start is kept, but for the second one the backslashes
213are halved. This makes sure it works both when you expect backslashes to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000214halved and when you expect the backslashes to be kept. The third gives a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000215result which is probably not what you want. Avoid it.
216
217 *add-option-flags* *remove-option-flags*
218 *E539* *E550* *E551* *E552*
219Some options are a list of flags. When you want to add a flag to such an
220option, without changing the existing ones, you can do it like this: >
221 :set guioptions+=a
222Remove a flag from an option like this: >
223 :set guioptions-=a
224This removes the 'a' flag from 'guioptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000225Note that you should add or remove one flag at a time. If 'guioptions' has
Bram Moolenaar071d4272004-06-13 20:20:40 +0000226the value "ab", using "set guioptions-=ba" won't work, because the string "ba"
227doesn't appear.
228
229 *:set_env* *expand-env* *expand-environment-var*
Bram Moolenaard4755bb2004-09-02 19:12:26 +0000230Environment variables in specific string options will be expanded. If the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000231environment variable exists the '$' and the following environment variable
232name is replaced with its value. If it does not exist the '$' and the name
233are not modified. Any non-id character (not a letter, digit or '_') may
234follow the environment variable name. That character and what follows is
235appended to the value of the environment variable. Examples: >
236 :set term=$TERM.new
237 :set path=/usr/$INCLUDE,$HOME/include,.
238When adding or removing a string from an option with ":set opt-=val" or ":set
239opt+=val" the expansion is done before the adding or removing.
240
241
242Handling of local options *local-options*
243
244Some of the options only apply to a window or buffer. Each window or buffer
Bram Moolenaar51628222016-12-01 23:03:28 +0100245has its own copy of this option, thus each can have its own value. This
Bram Moolenaar071d4272004-06-13 20:20:40 +0000246allows you to set 'list' in one window but not in another. And set
247'shiftwidth' to 3 in one buffer and 4 in another.
248
249The following explains what happens to these local options in specific
250situations. You don't really need to know all of this, since Vim mostly uses
251the option values you would expect. Unfortunately, doing what the user
252expects is a bit complicated...
253
254When splitting a window, the local options are copied to the new window. Thus
255right after the split the contents of the two windows look the same.
256
257When editing a new buffer, its local option values must be initialized. Since
258the local options of the current buffer might be specifically for that buffer,
259these are not used. Instead, for each buffer-local option there also is a
260global value, which is used for new buffers. With ":set" both the local and
261global value is changed. With "setlocal" only the local value is changed,
262thus this value is not used when editing a new buffer.
263
Bram Moolenaar95ec9d62016-08-12 18:29:59 +0200264When editing a buffer that has been edited before, the options from the window
265that was last closed are used again. If this buffer has been edited in this
266window, the values from back then are used. Otherwise the values from the
267last closed window where the buffer was edited last are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000268
269It's possible to set a local window option specifically for a type of buffer.
270When you edit another buffer in the same window, you don't want to keep
271using these local window options. Therefore Vim keeps a global value of the
272local window options, which is used when editing another buffer. Each window
273has its own copy of these values. Thus these are local to the window, but
274global to all buffers in the window. With this you can do: >
275 :e one
276 :set list
277 :e two
278Now the 'list' option will also be set in "two", since with the ":set list"
279command you have also set the global value. >
280 :set nolist
281 :e one
282 :setlocal list
283 :e two
284Now the 'list' option is not set, because ":set nolist" resets the global
285value, ":setlocal list" only changes the local value and ":e two" gets the
286global value. Note that if you do this next: >
287 :e one
Bram Moolenaar531da592013-05-06 05:58:55 +0200288You will get back the 'list' value as it was the last time you edited "one".
289The options local to a window are remembered for each buffer. This also
290happens when the buffer is not loaded, but they are lost when the buffer is
291wiped out |:bwipe|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000292
293 *:setl* *:setlocal*
Bram Moolenaar6b915c02020-01-18 15:53:19 +0100294:setl[ocal][!] ... Like ":set" but set only the value local to the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000295 current buffer or window. Not all options have a
296 local value. If the option does not have a local
297 value the global value is set.
Bram Moolenaarc3301872010-07-25 20:53:06 +0200298 With the "all" argument: display local values for all
299 local options.
300 Without argument: Display local values for all local
301 options which are different from the default.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000302 When displaying a specific local option, show the
Bram Moolenaar446cb832008-06-24 21:56:24 +0000303 local value. For a global/local boolean option, when
304 the global value is being used, "--" is displayed
305 before the option name.
306 For a global option the global value is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000307 shown (but that might change in the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000308
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000309:setl[ocal] {option}< Set the local value of {option} to its global value by
310 copying the value.
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000311
Bram Moolenaar6be7f872012-01-20 21:08:56 +0100312:se[t] {option}< For |global-local| options: Remove the local value of
313 {option}, so that the global value will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000314
315 *:setg* *:setglobal*
Bram Moolenaar6b915c02020-01-18 15:53:19 +0100316:setg[lobal][!] ... Like ":set" but set only the global value for a local
Bram Moolenaar071d4272004-06-13 20:20:40 +0000317 option without changing the local value.
318 When displaying an option, the global value is shown.
Bram Moolenaarc3301872010-07-25 20:53:06 +0200319 With the "all" argument: display global values for all
320 local options.
321 Without argument: display global values for all local
322 options which are different from the default.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000323
324For buffer-local and window-local options:
325 Command global value local value ~
326 :set option=value set set
327 :setlocal option=value - set
328:setglobal option=value set -
329 :set option? - display
330 :setlocal option? - display
331:setglobal option? display -
332
333
334Global options with a local value *global-local*
335
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +0000336Options are global when you mostly use one value for all buffers and windows.
337For some global options it's useful to sometimes have a different local value.
338You can set the local value with ":setlocal". That buffer or window will then
339use the local value, while other buffers and windows continue using the global
340value.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000341
342For example, you have two windows, both on C source code. They use the global
343'makeprg' option. If you do this in one of the two windows: >
344 :set makeprg=gmake
345then the other window will switch to the same value. There is no need to set
346the 'makeprg' option in the other C source window too.
347However, if you start editing a Perl file in a new window, you want to use
Bram Moolenaar02467872007-05-06 13:22:01 +0000348another 'makeprg' for it, without changing the value used for the C source
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000349files. You use this command: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000350 :setlocal makeprg=perlmake
351You can switch back to using the global value by making the local value empty: >
352 :setlocal makeprg=
Bram Moolenaar314dd792019-02-03 15:27:20 +0100353This only works for a string option. For a number or boolean option you need
354to use the "<" flag, like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000355 :setlocal autoread<
Bram Moolenaar314dd792019-02-03 15:27:20 +0100356Note that for non-boolean and non-number options using "<" copies the global
357value to the local value, it doesn't switch back to using the global value
358(that matters when the global value changes later). You can also use: >
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000359 :set path<
360This will make the local value of 'path' empty, so that the global value is
361used. Thus it does the same as: >
362 :setlocal path=
Bram Moolenaar071d4272004-06-13 20:20:40 +0000363Note: In the future more global options can be made global-local. Using
364":setlocal" on a global option might work differently then.
365
366
367Setting the filetype
368
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200369:setf[iletype] [FALLBACK] {filetype} *:setf* *:setfiletype*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000370 Set the 'filetype' option to {filetype}, but only if
371 not done yet in a sequence of (nested) autocommands.
372 This is short for: >
373 :if !did_filetype()
374 : setlocal filetype={filetype}
375 :endif
376< This command is used in a filetype.vim file to avoid
377 setting the 'filetype' option twice, causing different
378 settings and syntax files to be loaded.
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200379
380 When the optional FALLBACK argument is present, a
381 later :setfiletype command will override the
Bram Moolenaar26967612019-03-17 17:13:16 +0100382 'filetype'. This is to be used for filetype
383 detections that are just a guess. |did_filetype()|
384 will return false after this command.
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200385
Bram Moolenaard58e9292011-02-09 17:07:58 +0100386 *option-window* *optwin*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000387:bro[wse] se[t] *:set-browse* *:browse-set* *:opt* *:options*
388:opt[ions] Open a window for viewing and setting all options.
389 Options are grouped by function.
390 Offers short help for each option. Hit <CR> on the
391 short help to open a help window with more help for
392 the option.
393 Modify the value of the option and hit <CR> on the
394 "set" line to set the new value. For window and
395 buffer specific options, the last accessed window is
396 used to set the option value in, unless this is a help
397 window, in which case the window below help window is
398 used (skipping the option-window).
Bram Moolenaarb5b75622018-03-09 22:22:21 +0100399 {not available when compiled without the |+eval|
400 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000401
402 *$HOME*
403Using "~" is like using "$HOME", but it is only recognized at the start of an
404option and after a space or comma.
405
406On Unix systems "~user" can be used too. It is replaced by the home directory
407of user "user". Example: >
408 :set path=~mool/include,/usr/include,.
409
410On Unix systems the form "${HOME}" can be used too. The name between {} can
411contain non-id characters then. Note that if you want to use this for the
412"gf" command, you need to add the '{' and '}' characters to 'isfname'.
413
414NOTE: expanding environment variables and "~/" is only done with the ":set"
415command, not when assigning a value to an option with ":let".
416
Bram Moolenaarc572da52017-08-27 16:52:01 +0200417 *$HOME-windows*
418On MS-Windows, if $HOME is not defined as an environment variable, then
419at runtime Vim will set it to the expansion of $HOMEDRIVE$HOMEPATH.
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200420If $HOMEDRIVE is not set then $USERPROFILE is used.
421
422This expanded value is not exported to the environment, this matters when
423running an external command: >
424 :echo system('set | findstr ^HOME=')
425and >
426 :echo luaeval('os.getenv("HOME")')
427should echo nothing (an empty string) despite exists('$HOME') being true.
428When setting $HOME to a non-empty string it will be exported to the
429subprocesses.
Bram Moolenaarc572da52017-08-27 16:52:01 +0200430
Bram Moolenaar071d4272004-06-13 20:20:40 +0000431
432Note the maximum length of an expanded option is limited. How much depends on
433the system, mostly it is something like 256 or 1024 characters.
434
435 *:fix* *:fixdel*
436:fix[del] Set the value of 't_kD':
437 't_kb' is 't_kD' becomes ~
438 CTRL-? CTRL-H
439 not CTRL-? CTRL-?
440
Bram Moolenaar82be4842021-01-11 19:40:15 +0100441 (CTRL-? is 0o177 octal, 0x7f hex)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000442
443 If your delete key terminal code is wrong, but the
444 code for backspace is alright, you can put this in
445 your .vimrc: >
446 :fixdel
447< This works no matter what the actual code for
448 backspace is.
449
450 If the backspace key terminal code is wrong you can
451 use this: >
452 :if &term == "termname"
453 : set t_kb=^V<BS>
454 : fixdel
455 :endif
456< Where "^V" is CTRL-V and "<BS>" is the backspace key
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000457 (don't type four characters!). Replace "termname"
Bram Moolenaar071d4272004-06-13 20:20:40 +0000458 with your terminal name.
459
460 If your <Delete> key sends a strange key sequence (not
461 CTRL-? or CTRL-H) you cannot use ":fixdel". Then use: >
462 :if &term == "termname"
463 : set t_kD=^V<Delete>
464 :endif
465< Where "^V" is CTRL-V and "<Delete>" is the delete key
466 (don't type eight characters!). Replace "termname"
467 with your terminal name.
468
469 *Linux-backspace*
470 Note about Linux: By default the backspace key
471 produces CTRL-?, which is wrong. You can fix it by
472 putting this line in your rc.local: >
473 echo "keycode 14 = BackSpace" | loadkeys
474<
475 *NetBSD-backspace*
476 Note about NetBSD: If your backspace doesn't produce
477 the right code, try this: >
478 xmodmap -e "keycode 22 = BackSpace"
479< If this works, add this in your .Xmodmap file: >
480 keysym 22 = BackSpace
481< You need to restart for this to take effect.
482
483==============================================================================
4842. Automatically setting options *auto-setting*
485
486Besides changing options with the ":set" command, there are three alternatives
487to set options automatically for one or more files:
488
4891. When starting Vim initializations are read from various places. See
490 |initialization|. Most of them are performed for all editing sessions,
491 and some of them depend on the directory where Vim is started.
492 You can create an initialization file with |:mkvimrc|, |:mkview| and
493 |:mksession|.
4942. If you start editing a new file, the automatic commands are executed.
495 This can be used to set options for files matching a particular pattern and
496 many other things. See |autocommand|.
4973. If you start editing a new file, and the 'modeline' option is on, a
498 number of lines at the beginning and end of the file are checked for
499 modelines. This is explained here.
500
501 *modeline* *vim:* *vi:* *ex:* *E520*
502There are two forms of modelines. The first form:
Bram Moolenaar664f3cf2019-12-07 16:03:51 +0100503 [text{white}]{vi:|vim:|ex:}[white]{options}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000504
Bram Moolenaar664f3cf2019-12-07 16:03:51 +0100505[text{white}] empty or any text followed by at least one blank
506 character (<Space> or <Tab>); "ex:" always requires at
507 least one blank character
Bram Moolenaar14b69452013-06-29 23:05:20 +0200508{vi:|vim:|ex:} the string "vi:", "vim:" or "ex:"
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200509[white] optional white space
510{options} a list of option settings, separated with white space
511 or ':', where each part between ':' is the argument
512 for a ":set" command (can be empty)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000513
Bram Moolenaar14b69452013-06-29 23:05:20 +0200514Examples:
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000515 vi:noai:sw=3 ts=6 ~
Bram Moolenaar14b69452013-06-29 23:05:20 +0200516 vim: tw=77 ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000517
518The second form (this is compatible with some versions of Vi):
519
Bram Moolenaarade0d392020-01-21 22:33:58 +0100520 [text{white}]{vi:|vim:|Vim:|ex:}[white]se[t] {options}:[text]
Bram Moolenaar071d4272004-06-13 20:20:40 +0000521
Bram Moolenaarade0d392020-01-21 22:33:58 +0100522[text{white}] empty or any text followed by at least one blank
523 character (<Space> or <Tab>); "ex:" always requires at
524 least one blank character
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200525{vi:|vim:|Vim:|ex:} the string "vi:", "vim:", "Vim:" or "ex:"
526[white] optional white space
Bram Moolenaar14b69452013-06-29 23:05:20 +0200527se[t] the string "set " or "se " (note the space); When
528 "Vim" is used it must be "set".
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200529{options} a list of options, separated with white space, which
530 is the argument for a ":set" command
531: a colon
532[text] any text or empty
Bram Moolenaar071d4272004-06-13 20:20:40 +0000533
Bram Moolenaar14b69452013-06-29 23:05:20 +0200534Examples:
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000535 /* vim: set ai tw=75: */ ~
Bram Moolenaar14b69452013-06-29 23:05:20 +0200536 /* Vim: set ai tw=75: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000537
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200538The white space before {vi:|vim:|Vim:|ex:} is required. This minimizes the
539chance that a normal word like "lex:" is caught. There is one exception:
540"vi:" and "vim:" can also be at the start of the line (for compatibility with
541version 3.0). Using "ex:" at the start of the line will be ignored (this
542could be short for "example:").
Bram Moolenaar071d4272004-06-13 20:20:40 +0000543
Hu Jialun9dcd3492021-08-28 20:42:50 +0200544If the modeline is disabled within a modeline, subsequent modelines will be
545ignored. This is to allow turning off modeline on a per-file basis. This is
546useful when a line looks like a modeline but isn't. For example, it would be
547good to start a YAML file containing strings like "vim:" with
548 # vim: nomodeline ~
549so as to avoid modeline misdetection. Following options on the same line
550after modeline deactivation, if any, are still evaluated (but you would
551normally not have any).
552
Bram Moolenaar071d4272004-06-13 20:20:40 +0000553 *modeline-local*
554The options are set like with ":setlocal": The new value only applies to the
Bram Moolenaar843ee412004-06-30 16:16:41 +0000555buffer and window that contain the file. Although it's possible to set global
556options from a modeline, this is unusual. If you have two windows open and
557the files in it set the same global option to a different value, the result
558depends on which one was opened last.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000559
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +0000560When editing a file that was already loaded, only the window-local options
561from the modeline are used. Thus if you manually changed a buffer-local
562option after opening the file, it won't be changed if you edit the same buffer
563in another window. But window-local options will be set.
564
Bram Moolenaar071d4272004-06-13 20:20:40 +0000565 *modeline-version*
566If the modeline is only to be used for some versions of Vim, the version
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200567number can be specified where "vim:" or "Vim:" is used:
Bram Moolenaar071d4272004-06-13 20:20:40 +0000568 vim{vers}: version {vers} or later
569 vim<{vers}: version before {vers}
570 vim={vers}: version {vers}
571 vim>{vers}: version after {vers}
Bram Moolenaar2b8388b2015-02-28 13:11:45 +0100572{vers} is 700 for Vim 7.0 (hundred times the major version plus minor).
573For example, to use a modeline only for Vim 7.0:
574 /* vim700: set foldmethod=marker */ ~
575To use a modeline for Vim after version 7.2:
576 /* vim>702: set cole=2: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000577There can be no blanks between "vim" and the ":".
578
579
580The number of lines that are checked can be set with the 'modelines' option.
581If 'modeline' is off or 'modelines' is 0 no lines are checked.
582
583Note that for the first form all of the rest of the line is used, thus a line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000584like:
585 /* vi:ts=4: */ ~
586will give an error message for the trailing "*/". This line is OK:
587 /* vi:set ts=4: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000588
589If an error is detected the rest of the line is skipped.
590
591If you want to include a ':' in a set command precede it with a '\'. The
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000592backslash in front of the ':' will be removed. Example:
Bram Moolenaar95a9dd12019-12-19 22:12:03 +0100593 /* vi:set fillchars=stl\:^,vert\:\|: */ ~
594This sets the 'fillchars' option to "stl:^,vert:\|". Only a single backslash
595before the ':' is removed. Thus to include "\:" you have to specify "\\:".
Bram Moolenaar110289e2019-05-23 15:38:06 +0200596 *E992*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000597No other commands than "set" are supported, for security reasons (somebody
Bram Moolenaar8243a792007-05-01 17:05:03 +0000598might create a Trojan horse text file with modelines). And not all options
Bram Moolenaar110289e2019-05-23 15:38:06 +0200599can be set. For some options a flag is set, so that when the value is used
600the |sandbox| is effective. Some options can only be set from the modeline
601when 'modelineexpr' is set (the default is off).
602
603Still, there is always a small risk that a modeline causes trouble. E.g.,
604when some joker sets 'textwidth' to 5 all your lines are wrapped unexpectedly.
605So disable modelines before editing untrusted text. The mail ftplugin does
606this, for example.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000607
608Hint: If you would like to do something else than setting an option, you could
609define an autocommand that checks the file for a specific string. For
610example: >
611 au BufReadPost * if getline(1) =~ "VAR" | call SetVar() | endif
612And define a function SetVar() that does something with the line containing
613"VAR".
614
615==============================================================================
6163. Options summary *option-summary*
617
618In the list below all the options are mentioned with their full name and with
619an abbreviation if there is one. Both forms may be used.
620
621In this document when a boolean option is "set" that means that ":set option"
622is entered. When an option is "reset", ":set nooption" is used.
623
624For some options there are two default values: The "Vim default", which is
625used when 'compatible' is not set, and the "Vi default", which is used when
626'compatible' is set.
627
628Most options are the same in all windows and buffers. There are a few that
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000629are specific to how the text is presented in a window. These can be set to a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000630different value in each window. For example the 'list' option can be set in
631one window and reset in another for the same text, giving both types of view
632at the same time. There are a few options that are specific to a certain
633file. These can have a different value for each file or buffer. For example
634the 'textwidth' option can be 78 for a normal text file and 0 for a C
635program.
636
637 global one option for all buffers and windows
638 local to window each window has its own copy of this option
639 local to buffer each buffer has its own copy of this option
640
641When creating a new window the option values from the currently active window
642are used as a default value for the window-specific options. For the
643buffer-specific options this depends on the 's' and 'S' flags in the
644'cpoptions' option. If 's' is included (which is the default) the values for
645buffer options are copied from the currently active buffer when a buffer is
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000646first entered. If 'S' is present the options are copied each time the buffer
647is entered, this is almost like having global options. If 's' and 'S' are not
Bram Moolenaar071d4272004-06-13 20:20:40 +0000648present, the options are copied from the currently active buffer when the
649buffer is created.
650
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000651Hidden options *hidden-options*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000652
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000653Not all options are supported in all versions. This depends on the supported
654features and sometimes on the system. A remark about this is in curly braces
655below. When an option is not supported it may still be set without getting an
656error, this is called a hidden option. You can't get the value of a hidden
657option though, it is not stored.
658
659To test if option "foo" can be used with ":set" use something like this: >
660 if exists('&foo')
661This also returns true for a hidden option. To test if option "foo" is really
662supported use something like this: >
663 if exists('+foo')
664<
Bram Moolenaar071d4272004-06-13 20:20:40 +0000665 *E355*
666A jump table for the options with a short description can be found at |Q_op|.
667
668 *'aleph'* *'al'* *aleph* *Aleph*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +0100669'aleph' 'al' number (default 128 for MS-Windows, 224 otherwise)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000670 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000671 {only available when compiled with the |+rightleft|
672 feature}
673 The ASCII code for the first letter of the Hebrew alphabet. The
674 routine that maps the keyboard in Hebrew mode, both in Insert mode
675 (when hkmap is set) and on the command-line (when hitting CTRL-_)
676 outputs the Hebrew characters in the range [aleph..aleph+26].
677 aleph=128 applies to PC code, and aleph=224 applies to ISO 8859-8.
678 See |rileft.txt|.
679
680 *'allowrevins'* *'ari'* *'noallowrevins'* *'noari'*
681'allowrevins' 'ari' boolean (default off)
682 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000683 {only available when compiled with the |+rightleft|
684 feature}
685 Allow CTRL-_ in Insert and Command-line mode. This is default off, to
686 avoid that users that accidentally type CTRL-_ instead of SHIFT-_ get
687 into reverse Insert mode, and don't know how to get out. See
688 'revins'.
689 NOTE: This option is reset when 'compatible' is set.
690
691 *'altkeymap'* *'akm'* *'noaltkeymap'* *'noakm'*
692'altkeymap' 'akm' boolean (default off)
693 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000694 {only available when compiled with the |+farsi|
695 feature}
Bram Moolenaar14184a32019-02-16 15:10:30 +0100696 This option was for using Farsi, which has been removed. See
697 |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000698
699 *'ambiwidth'* *'ambw'*
700'ambiwidth' 'ambw' string (default: "single")
701 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000702 Only effective when 'encoding' is "utf-8" or another Unicode encoding.
703 Tells Vim what to do with characters with East Asian Width Class
704 Ambiguous (such as Euro, Registered Sign, Copyright Sign, Greek
705 letters, Cyrillic letters).
706
707 There are currently two possible values:
Bram Moolenaar582fd852005-03-28 20:58:01 +0000708 "single": Use the same width as characters in US-ASCII. This is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000709 expected by most users.
710 "double": Use twice the width of ASCII characters.
Bram Moolenaar5c3bd0a2010-08-04 20:55:44 +0200711 *E834* *E835*
712 The value "double" cannot be used if 'listchars' or 'fillchars'
Bram Moolenaar1c6737b2020-09-07 22:18:52 +0200713 contains a character that would be double width.
Bram Moolenaar08aac3c2020-08-28 21:04:24 +0200714
715 The values are overruled for characters specified with
716 |setcellwidths()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000717
718 There are a number of CJK fonts for which the width of glyphs for
719 those characters are solely based on how many octets they take in
720 legacy/traditional CJK encodings. In those encodings, Euro,
721 Registered sign, Greek/Cyrillic letters are represented by two octets,
Bram Moolenaar582fd852005-03-28 20:58:01 +0000722 therefore those fonts have "wide" glyphs for them. This is also
Bram Moolenaar071d4272004-06-13 20:20:40 +0000723 true of some line drawing characters used to make tables in text
Bram Moolenaar582fd852005-03-28 20:58:01 +0000724 file. Therefore, when a CJK font is used for GUI Vim or
Bram Moolenaar071d4272004-06-13 20:20:40 +0000725 Vim is running inside a terminal (emulators) that uses a CJK font
726 (or Vim is run inside an xterm invoked with "-cjkwidth" option.),
727 this option should be set to "double" to match the width perceived
728 by Vim with the width of glyphs in the font. Perhaps it also has
Bram Moolenaar8024f932020-01-14 19:29:13 +0100729 to be set to "double" under CJK MS-Windows when the system locale is
730 set to one of CJK locales. See Unicode Standard Annex #11
731 (http://www.unicode.org/reports/tr11).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000732
Bram Moolenaarac7bd632013-03-19 11:35:58 +0100733 Vim may set this option automatically at startup time when Vim is
734 compiled with the |+termresponse| feature and if |t_u7| is set to the
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200735 escape sequence to request cursor position report. The response can
736 be found in |v:termu7resp|.
Bram Moolenaarac7bd632013-03-19 11:35:58 +0100737
Bram Moolenaar071d4272004-06-13 20:20:40 +0000738 *'antialias'* *'anti'* *'noantialias'* *'noanti'*
739'antialias' 'anti' boolean (default: off)
740 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000741 {only available when compiled with GUI enabled
Bram Moolenaar3d1cde82020-08-15 18:55:18 +0200742 on macOS}
743 This option only has an effect in the GUI version of Vim on macOS
Bram Moolenaar071d4272004-06-13 20:20:40 +0000744 v10.2 or later. When on, Vim will use smooth ("antialiased") fonts,
745 which can be easier to read at certain sizes on certain displays.
746 Setting this option can sometimes cause problems if 'guifont' is set
747 to its default (empty string).
Bram Moolenaar036986f2017-03-16 17:41:02 +0100748 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000749
750 *'autochdir'* *'acd'* *'noautochdir'* *'noacd'*
751'autochdir' 'acd' boolean (default off)
752 global
Bram Moolenaar00a927d2010-05-14 23:24:24 +0200753 {only available when compiled with it, use
754 exists("+autochdir") to check}
Bram Moolenaard8c00872005-07-22 21:52:15 +0000755 When on, Vim will change the current working directory whenever you
756 open a file, switch buffers, delete a buffer or open/close a window.
757 It will change to the directory containing the file which was opened
758 or selected.
Bram Moolenaar910f66f2006-04-05 20:41:53 +0000759 Note: When this option is on some plugins may not work.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000760
Bram Moolenaar8b9abfd2021-03-29 20:49:05 +0200761 *'autoshelldir'* *'asd'* *'noautoshelldir'* *'noasd'*
762'autoshelldir' 'asd' boolean (default off)
763 global
764 When on, Vim will change the current working directory whenever you
765 change the directory of the shell running in a terminal window. You
766 need proper setting-up, so whenever the shell's pwd changes an OSC 7
767 escape sequence will be emitted. For example, on Linux, you can source
768 /etc/profile.d/vte.sh in your shell profile if you use bash or zsh.
769
Bram Moolenaar071d4272004-06-13 20:20:40 +0000770 *'arabic'* *'arab'* *'noarabic'* *'noarab'*
771'arabic' 'arab' boolean (default off)
772 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +0000773 {only available when compiled with the |+arabic|
774 feature}
775 This option can be set to start editing Arabic text.
776 Setting this option will:
777 - Set the 'rightleft' option, unless 'termbidi' is set.
778 - Set the 'arabicshape' option, unless 'termbidi' is set.
779 - Set the 'keymap' option to "arabic"; in Insert mode CTRL-^ toggles
780 between typing English and Arabic key mapping.
781 - Set the 'delcombine' option
782 Note that 'encoding' must be "utf-8" for working with Arabic text.
783
784 Resetting this option will:
785 - Reset the 'rightleft' option.
786 - Disable the use of 'keymap' (without changing its value).
787 Note that 'arabicshape' and 'delcombine' are not reset (it is a global
Bram Moolenaarc8734422012-06-01 22:38:45 +0200788 option).
Bram Moolenaar036986f2017-03-16 17:41:02 +0100789 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000790 Also see |arabic.txt|.
791
792 *'arabicshape'* *'arshape'*
793 *'noarabicshape'* *'noarshape'*
794'arabicshape' 'arshape' boolean (default on)
795 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000796 {only available when compiled with the |+arabic|
797 feature}
798 When on and 'termbidi' is off, the required visual character
799 corrections that need to take place for displaying the Arabic language
Bram Moolenaar3a0d8092012-10-21 03:02:54 +0200800 take effect. Shaping, in essence, gets enabled; the term is a broad
Bram Moolenaar071d4272004-06-13 20:20:40 +0000801 one which encompasses:
802 a) the changing/morphing of characters based on their location
803 within a word (initial, medial, final and stand-alone).
804 b) the enabling of the ability to compose characters
805 c) the enabling of the required combining of some characters
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100806 When disabled the display shows each character's true stand-alone
807 form.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000808 Arabic is a complex language which requires other settings, for
809 further details see |arabic.txt|.
Bram Moolenaar036986f2017-03-16 17:41:02 +0100810 NOTE: This option is set when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000811
812 *'autoindent'* *'ai'* *'noautoindent'* *'noai'*
813'autoindent' 'ai' boolean (default off)
814 local to buffer
815 Copy indent from current line when starting a new line (typing <CR>
816 in Insert mode or when using the "o" or "O" command). If you do not
817 type anything on the new line except <BS> or CTRL-D and then type
Bram Moolenaar02467872007-05-06 13:22:01 +0000818 <Esc>, CTRL-O or <CR>, the indent is deleted again. Moving the cursor
819 to another line has the same effect, unless the 'I' flag is included
820 in 'cpoptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000821 When autoindent is on, formatting (with the "gq" command or when you
822 reach 'textwidth' in Insert mode) uses the indentation of the first
823 line.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000824 When 'smartindent' or 'cindent' is on the indent is changed in
825 a different way.
Bram Moolenaarca635012015-09-25 20:34:21 +0200826 The 'autoindent' option is reset when the 'paste' option is set and
827 restored when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000828
829 *'autoread'* *'ar'* *'noautoread'* *'noar'*
830'autoread' 'ar' boolean (default off)
831 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000832 When a file has been detected to have been changed outside of Vim and
833 it has not been changed inside of Vim, automatically read it again.
Bram Moolenaarfd358112018-07-07 23:21:31 +0200834 When the file has been deleted this is not done, so you have the text
835 from before it was deleted. When it appears again then it is read.
836 |timestamp|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000837 If this option has a local value, use this command to switch back to
838 using the global value: >
839 :set autoread<
840<
841 *'autowrite'* *'aw'* *'noautowrite'* *'noaw'*
842'autowrite' 'aw' boolean (default off)
843 global
844 Write the contents of the file, if it has been modified, on each
845 :next, :rewind, :last, :first, :previous, :stop, :suspend, :tag, :!,
Bram Moolenaar14716812006-05-04 21:54:08 +0000846 :make, CTRL-] and CTRL-^ command; and when a :buffer, CTRL-O, CTRL-I,
Bram Moolenaar071d4272004-06-13 20:20:40 +0000847 '{A-Z0-9}, or `{A-Z0-9} command takes one to another file.
848 Note that for some commands the 'autowrite' option is not used, see
849 'autowriteall' for that.
Bram Moolenaar93a1df22018-09-10 11:51:50 +0200850 Some buffers will not be written, specifically when 'buftype' is
Bram Moolenaar20aac6c2018-09-02 21:07:30 +0200851 "nowrite", "nofile", "terminal" or "prompt".
Bram Moolenaar071d4272004-06-13 20:20:40 +0000852
853 *'autowriteall'* *'awa'* *'noautowriteall'* *'noawa'*
854'autowriteall' 'awa' boolean (default off)
855 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000856 Like 'autowrite', but also used for commands ":edit", ":enew", ":quit",
857 ":qall", ":exit", ":xit", ":recover" and closing the Vim window.
858 Setting this option also implies that Vim behaves like 'autowrite' has
859 been set.
860
861 *'background'* *'bg'*
Bram Moolenaar446beb42011-05-10 17:18:44 +0200862'background' 'bg' string (default "dark" or "light", see below)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000863 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000864 When set to "dark", Vim will try to use colors that look good on a
865 dark background. When set to "light", Vim will try to use colors that
866 look good on a light background. Any other value is illegal.
867 Vim tries to set the default value according to the terminal used.
868 This will not always be correct.
869 Setting this option does not change the background color, it tells Vim
870 what the background color looks like. For changing the background
871 color, see |:hi-normal|.
872
873 When 'background' is set Vim will adjust the default color groups for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000874 the new value. But the colors used for syntax highlighting will not
Bram Moolenaar446cb832008-06-24 21:56:24 +0000875 change. *g:colors_name*
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100876 When a color scheme is loaded (the "g:colors_name" variable is set)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000877 setting 'background' will cause the color scheme to be reloaded. If
878 the color scheme adjusts to the value of 'background' this will work.
879 However, if the color scheme sets 'background' itself the effect may
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100880 be undone. First delete the "g:colors_name" variable when needed.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000881
882 When setting 'background' to the default value with: >
883 :set background&
884< Vim will guess the value. In the GUI this should work correctly,
885 in other cases Vim might not be able to guess the right value.
Bram Moolenaar2e693a82019-10-16 22:35:02 +0200886 If the GUI supports a dark theme, you can use the "d" flag in
Bram Moolenaar50bf7ce2019-09-15 13:17:00 +0200887 'guioptions', see 'go-d'.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000888
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200889 When the |t_RB| option is set, Vim will use it to request the background
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +0200890 color from the terminal. If the returned RGB value is dark/light and
891 'background' is not dark/light, 'background' will be set and the
892 screen is redrawn. This may have side effects, make t_BG empty in
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200893 your .vimrc if you suspect this problem. The response to |t_RB| can
Bram Moolenaar01164a62017-11-02 22:58:42 +0100894 be found in |v:termrbgresp|.
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +0200895
Bram Moolenaar071d4272004-06-13 20:20:40 +0000896 When starting the GUI, the default value for 'background' will be
897 "light". When the value is not set in the .gvimrc, and Vim detects
898 that the background is actually quite dark, 'background' is set to
899 "dark". But this happens only AFTER the .gvimrc file has been read
900 (because the window needs to be opened to find the actual background
901 color). To get around this, force the GUI window to be opened by
902 putting a ":gui" command in the .gvimrc file, before where the value
903 of 'background' is used (e.g., before ":syntax on").
Bram Moolenaar446beb42011-05-10 17:18:44 +0200904
Bram Moolenaar6f345a12019-12-17 21:27:18 +0100905 For MS-Windows the default is "dark".
Bram Moolenaar446beb42011-05-10 17:18:44 +0200906 For other systems "dark" is used when 'term' is "linux",
907 "screen.linux", "cygwin" or "putty", or $COLORFGBG suggests a dark
908 background. Otherwise the default is "light".
909
Bram Moolenaarc572da52017-08-27 16:52:01 +0200910 The |:terminal| command and the |term_start()| function use the
911 'background' value to decide whether the terminal window will start
912 with a white or black background.
913
Bram Moolenaar071d4272004-06-13 20:20:40 +0000914 Normally this option would be set in the .vimrc file. Possibly
915 depending on the terminal name. Example: >
916 :if &term == "pcterm"
917 : set background=dark
918 :endif
919< When this option is set, the default settings for the highlight groups
920 will change. To use other settings, place ":highlight" commands AFTER
921 the setting of the 'background' option.
922 This option is also used in the "$VIMRUNTIME/syntax/syntax.vim" file
923 to select the colors for syntax highlighting. After changing this
924 option, you must load syntax.vim again to see the result. This can be
925 done with ":syntax on".
926
927 *'backspace'* *'bs'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +0200928'backspace' 'bs' string (default "", set to "indent,eol,start"
929 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000930 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000931 Influences the working of <BS>, <Del>, CTRL-W and CTRL-U in Insert
932 mode. This is a list of items, separated by commas. Each item allows
933 a way to backspace over something:
934 value effect ~
935 indent allow backspacing over autoindent
936 eol allow backspacing over line breaks (join lines)
937 start allow backspacing over the start of insert; CTRL-W and CTRL-U
938 stop once at the start of insert.
Bram Moolenaaraa0489e2020-04-17 19:41:21 +0200939 nostop like start, except CTRL-W and CTRL-U do not stop at the start of
940 insert.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000941
942 When the value is empty, Vi compatible backspacing is used.
943
944 For backwards compatibility with version 5.4 and earlier:
945 value effect ~
946 0 same as ":set backspace=" (Vi compatible)
947 1 same as ":set backspace=indent,eol"
948 2 same as ":set backspace=indent,eol,start"
Bram Moolenaaraa0489e2020-04-17 19:41:21 +0200949 3 same as ":set backspace=indent,eol,nostop"
Bram Moolenaar071d4272004-06-13 20:20:40 +0000950
951 See |:fixdel| if your <BS> or <Del> key does not do what you want.
952 NOTE: This option is set to "" when 'compatible' is set.
953
954 *'backup'* *'bk'* *'nobackup'* *'nobk'*
955'backup' 'bk' boolean (default off)
956 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000957 Make a backup before overwriting a file. Leave it around after the
958 file has been successfully written. If you do not want to keep the
959 backup file, but you do want a backup while the file is being
960 written, reset this option and set the 'writebackup' option (this is
961 the default). If you do not want a backup file at all reset both
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000962 options (use this if your file system is almost full). See the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000963 |backup-table| for more explanations.
964 When the 'backupskip' pattern matches, a backup is not made anyway.
965 When 'patchmode' is set, the backup may be renamed to become the
966 oldest version of a file.
967 NOTE: This option is reset when 'compatible' is set.
968
969 *'backupcopy'* *'bkc'*
970'backupcopy' 'bkc' string (Vi default for Unix: "yes", otherwise: "auto")
Bram Moolenaarb8ee25a2014-09-23 15:45:08 +0200971 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000972 When writing a file and a backup is made, this option tells how it's
973 done. This is a comma separated list of words.
974
975 The main values are:
976 "yes" make a copy of the file and overwrite the original one
977 "no" rename the file and write a new one
978 "auto" one of the previous, what works best
979
980 Extra values that can be combined with the ones above are:
981 "breaksymlink" always break symlinks when writing
982 "breakhardlink" always break hardlinks when writing
983
984 Making a copy and overwriting the original file:
985 - Takes extra time to copy the file.
986 + When the file has special attributes, is a (hard/symbolic) link or
987 has a resource fork, all this is preserved.
988 - When the file is a link the backup will have the name of the link,
989 not of the real file.
990
991 Renaming the file and writing a new one:
992 + It's fast.
993 - Sometimes not all attributes of the file can be copied to the new
994 file.
995 - When the file is a link the new file will not be a link.
996
997 The "auto" value is the middle way: When Vim sees that renaming file
998 is possible without side effects (the attributes can be passed on and
Bram Moolenaar02467872007-05-06 13:22:01 +0000999 the file is not a link) that is used. When problems are expected, a
1000 copy will be made.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001001
1002 The "breaksymlink" and "breakhardlink" values can be used in
1003 combination with any of "yes", "no" and "auto". When included, they
1004 force Vim to always break either symbolic or hard links by doing
1005 exactly what the "no" option does, renaming the original file to
1006 become the backup and writing a new file in its place. This can be
1007 useful for example in source trees where all the files are symbolic or
1008 hard links and any changes should stay in the local source tree, not
1009 be propagated back to the original source.
1010 *crontab*
1011 One situation where "no" and "auto" will cause problems: A program
1012 that opens a file, invokes Vim to edit that file, and then tests if
1013 the open file was changed (through the file descriptor) will check the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001014 backup file instead of the newly created file. "crontab -e" is an
Bram Moolenaar071d4272004-06-13 20:20:40 +00001015 example.
1016
1017 When a copy is made, the original file is truncated and then filled
1018 with the new text. This means that protection bits, owner and
1019 symbolic links of the original file are unmodified. The backup file
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001020 however, is a new file, owned by the user who edited the file. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00001021 group of the backup is set to the group of the original file. If this
1022 fails, the protection bits for the group are made the same as for
1023 others.
1024
1025 When the file is renamed this is the other way around: The backup has
1026 the same attributes of the original file, and the newly written file
1027 is owned by the current user. When the file was a (hard/symbolic)
1028 link, the new file will not! That's why the "auto" value doesn't
1029 rename when the file is a link. The owner and group of the newly
1030 written file will be set to the same ones as the original file, but
1031 the system may refuse to do this. In that case the "auto" value will
1032 again not rename the file.
1033
Bram Moolenaar036986f2017-03-16 17:41:02 +01001034 NOTE: This option is set to the Vi default value when 'compatible' is
1035 set and to the Vim default value when 'compatible' is reset.
1036
Bram Moolenaar071d4272004-06-13 20:20:40 +00001037 *'backupdir'* *'bdir'*
1038'backupdir' 'bdir' string (default for Amiga: ".,t:",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01001039 for Win32: ".,$TEMP,c:/tmp,c:/temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001040 for Unix: ".,~/tmp,~/")
1041 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001042 List of directories for the backup file, separated with commas.
1043 - The backup file will be created in the first directory in the list
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001044 where this is possible. The directory must exist, Vim will not
1045 create it for you.
Bram Moolenaar3848e002016-03-19 18:42:29 +01001046 - Empty means that no backup file will be created ('patchmode' is
Bram Moolenaar071d4272004-06-13 20:20:40 +00001047 impossible!). Writing may fail because of this.
1048 - A directory "." means to put the backup file in the same directory
1049 as the edited file.
Bram Moolenaar8024f932020-01-14 19:29:13 +01001050 - A directory starting with "./" (or ".\" for MS-Windows) means to put
1051 the backup file relative to where the edited file is. The leading
1052 "." is replaced with the path name of the edited file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001053 ("." inside a directory name has no special meaning).
1054 - Spaces after the comma are ignored, other spaces are considered part
1055 of the directory name. To have a space at the start of a directory
1056 name, precede it with a backslash.
1057 - To include a comma in a directory name precede it with a backslash.
1058 - A directory name may end in an '/'.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02001059 - For Unix and Win32, if a directory ends in two path separators "//",
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01001060 the backup file name will be built from the complete path to the
1061 file with all path separators changed to percent '%' signs. This
1062 will ensure file name uniqueness in the backup directory.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02001063 On Win32, it is also possible to end with "\\". However, When a
1064 separating comma is following, you must use "//", since "\\" will
1065 include the comma in the file name. Therefore it is recommended to
1066 use '//', instead of '\\'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001067 - Environment variables are expanded |:set_env|.
1068 - Careful with '\' characters, type one before a space, type two to
1069 get one in the option (see |option-backslash|), for example: >
1070 :set bdir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
1071< - For backwards compatibility with Vim version 3.0 a '>' at the start
1072 of the option is removed.
1073 See also 'backup' and 'writebackup' options.
1074 If you want to hide your backup files on Unix, consider this value: >
1075 :set backupdir=./.backup,~/.backup,.,/tmp
1076< You must create a ".backup" directory in each directory and in your
1077 home directory for this to work properly.
1078 The use of |:set+=| and |:set-=| is preferred when adding or removing
1079 directories from the list. This avoids problems when a future version
1080 uses another default.
1081 This option cannot be set from a |modeline| or in the |sandbox|, for
1082 security reasons.
1083
1084 *'backupext'* *'bex'* *E589*
1085'backupext' 'bex' string (default "~", for VMS: "_")
1086 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001087 String which is appended to a file name to make the name of the
1088 backup file. The default is quite unusual, because this avoids
1089 accidentally overwriting existing files with a backup file. You might
1090 prefer using ".bak", but make sure that you don't have files with
1091 ".bak" that you want to keep.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001092 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001093
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001094 If you like to keep a lot of backups, you could use a BufWritePre
1095 autocommand to change 'backupext' just before writing the file to
1096 include a timestamp. >
1097 :au BufWritePre * let &bex = '-' . strftime("%Y%b%d%X") . '~'
1098< Use 'backupdir' to put the backup in a different directory.
1099
Bram Moolenaar071d4272004-06-13 20:20:40 +00001100 *'backupskip'* *'bsk'*
Bram Moolenaarb8e22a02018-04-12 21:37:34 +02001101'backupskip' 'bsk' string (default: "$TMPDIR/*,$TMP/*,$TEMP/*"
1102 Unix: "/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*"
1103 Mac: "/private/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001104 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001105 {not available when compiled without the |+wildignore|
1106 feature}
1107 A list of file patterns. When one of the patterns matches with the
1108 name of the file which is written, no backup file is created. Both
1109 the specified file name and the full path name of the file are used.
1110 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
1111 Watch out for special characters, see |option-backslash|.
1112 When $TMPDIR, $TMP or $TEMP is not defined, it is not used for the
Bram Moolenaar582fd852005-03-28 20:58:01 +00001113 default value. "/tmp/*" is only used for Unix.
Bram Moolenaar02467872007-05-06 13:22:01 +00001114
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02001115 WARNING: Not having a backup file means that when Vim fails to write
1116 your buffer correctly and then, for whatever reason, Vim exits, you
1117 lose both the original file and what you were writing. Only disable
1118 backups if you don't care about losing the file.
1119
Bram Moolenaar02467872007-05-06 13:22:01 +00001120 Note that environment variables are not expanded. If you want to use
1121 $HOME you must expand it explicitly, e.g.: >
Bram Moolenaar7c1c6db2016-04-03 22:08:05 +02001122 :let &backupskip = escape(expand('$HOME'), '\') . '/tmp/*'
Bram Moolenaar02467872007-05-06 13:22:01 +00001123
1124< Note that the default also makes sure that "crontab -e" works (when a
Bram Moolenaara5792f52005-11-23 21:25:05 +00001125 backup would be made by renaming the original file crontab won't see
1126 the newly created file). Also see 'backupcopy' and |crontab|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001127
1128 *'balloondelay'* *'bdlay'*
1129'balloondelay' 'bdlay' number (default: 600)
1130 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001131 {only available when compiled with the |+balloon_eval|
1132 feature}
1133 Delay in milliseconds before a balloon may pop up. See |balloon-eval|.
1134
1135 *'ballooneval'* *'beval'* *'noballooneval'* *'nobeval'*
1136'ballooneval' 'beval' boolean (default off)
1137 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001138 {only available when compiled with the |+balloon_eval|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001139 feature}
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001140 Switch on the |balloon-eval| functionality for the GUI.
1141
1142 *'balloonevalterm'* *'bevalterm'* *'noballoonevalterm'*
1143 *'nobevalterm'*
1144'balloonevalterm' 'bevalterm' boolean (default off)
1145 global
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001146 {only available when compiled with the
1147 |+balloon_eval_term| feature}
1148 Switch on the |balloon-eval| functionality for the terminal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001149
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001150 *'balloonexpr'* *'bexpr'*
1151'balloonexpr' 'bexpr' string (default "")
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00001152 global or local to buffer |global-local|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001153 {only available when compiled with the |+balloon_eval|
1154 feature}
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00001155 Expression for text to show in evaluation balloon. It is only used
Bram Moolenaara6c27c42019-05-09 19:16:22 +02001156 when 'ballooneval' or 'balloonevalterm' is on. These variables can be
1157 used:
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001158
1159 v:beval_bufnr number of the buffer in which balloon is going to show
1160 v:beval_winnr number of the window
Bram Moolenaar82af8712016-06-04 20:20:29 +02001161 v:beval_winid ID of the window
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001162 v:beval_lnum line number
1163 v:beval_col column number (byte index)
1164 v:beval_text word under or after the mouse pointer
1165
Bram Moolenaar54775062019-07-31 21:07:14 +02001166 Instead of showing a balloon, which is limited to plain text, consider
1167 using a popup window, see |popup_beval_example|. A popup window can
1168 use highlighting and show a border.
1169
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001170 The evaluation of the expression must not have side effects!
1171 Example: >
Bram Moolenaara6c27c42019-05-09 19:16:22 +02001172 function MyBalloonExpr()
Bram Moolenaar45360022005-07-21 21:08:21 +00001173 return 'Cursor is at line ' . v:beval_lnum .
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001174 \', column ' . v:beval_col .
1175 \ ' of file ' . bufname(v:beval_bufnr) .
1176 \ ' on word "' . v:beval_text . '"'
1177 endfunction
1178 set bexpr=MyBalloonExpr()
1179 set ballooneval
1180<
Bram Moolenaar396e8292019-07-13 23:04:31 +02001181 Also see |balloon_show()|, it can be used if the content of the balloon
1182 is to be fetched asynchronously. In that case evaluating
1183 'balloonexpr' should result in an empty string. If you get a balloon
1184 with only "0" you probably didn't return anything from your function.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001185
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001186 NOTE: The balloon is displayed only if the cursor is on a text
1187 character. If the result of evaluating 'balloonexpr' is not empty,
1188 Vim does not try to send a message to an external debugger (Netbeans
1189 or Sun Workshop).
1190
Bram Moolenaar30b65812012-07-12 22:01:11 +02001191 The expression will be evaluated in the |sandbox| when set from a
1192 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02001193 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001194
1195 It is not allowed to change text or jump to another window while
Bram Moolenaar396e8292019-07-13 23:04:31 +02001196 evaluating 'balloonexpr', see |textlock|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001197
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001198 To check whether line breaks in the balloon text work use this check: >
Bram Moolenaar45360022005-07-21 21:08:21 +00001199 if has("balloon_multiline")
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001200< When they are supported "\n" characters will start a new line. If the
1201 expression evaluates to a |List| this is equal to using each List item
1202 as a string and putting "\n" in between them.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001203 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001204
Bram Moolenaar165bc692015-07-21 17:53:25 +02001205 *'belloff'* *'bo'*
1206'belloff' 'bo' string (default "")
1207 global
Bram Moolenaar165bc692015-07-21 17:53:25 +02001208 Specifies for which events the bell will not be rung. It is a comma
1209 separated list of items. For each item that is present, the bell
1210 will be silenced. This is most useful to specify specific events in
1211 insert mode to be silenced.
1212
1213 item meaning when present ~
1214 all All events.
1215 backspace When hitting <BS> or <Del> and deleting results in an
1216 error.
1217 cursor Fail to move around using the cursor keys or
1218 <PageUp>/<PageDown> in |Insert-mode|.
1219 complete Error occurred when using |i_CTRL-X_CTRL-K| or
1220 |i_CTRL-X_CTRL-T|.
1221 copy Cannot copy char from insert mode using |i_CTRL-Y| or
1222 |i_CTRL-E|.
1223 ctrlg Unknown Char after <C-G> in Insert mode.
1224 error Other Error occurred (e.g. try to join last line)
1225 (mostly used in |Normal-mode| or |Cmdline-mode|).
1226 esc hitting <Esc> in |Normal-mode|.
1227 ex In |Visual-mode|, hitting |Q| results in an error.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01001228 hangul Ignored.
Bram Moolenaar165bc692015-07-21 17:53:25 +02001229 insertmode Pressing <Esc> in 'insertmode'.
1230 lang Calling the beep module for Lua/Mzscheme/TCL.
1231 mess No output available for |g<|.
1232 showmatch Error occurred for 'showmatch' function.
1233 operator Empty region error |cpo-E|.
1234 register Unknown register after <C-R> in |Insert-mode|.
1235 shell Bell from shell output |:!|.
1236 spell Error happened on spell suggest.
1237 wildmode More matches in |cmdline-completion| available
1238 (depends on the 'wildmode' setting).
1239
Bram Moolenaar036986f2017-03-16 17:41:02 +01001240 This is most useful to fine tune when in Insert mode the bell should
1241 be rung. For Normal mode and Ex commands, the bell is often rung to
Bram Moolenaar165bc692015-07-21 17:53:25 +02001242 indicate that an error occurred. It can be silenced by adding the
1243 "error" keyword.
1244
Bram Moolenaar071d4272004-06-13 20:20:40 +00001245 *'binary'* *'bin'* *'nobinary'* *'nobin'*
1246'binary' 'bin' boolean (default off)
1247 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001248 This option should be set before editing a binary file. You can also
1249 use the |-b| Vim argument. When this option is switched on a few
1250 options will be changed (also when it already was on):
1251 'textwidth' will be set to 0
1252 'wrapmargin' will be set to 0
1253 'modeline' will be off
1254 'expandtab' will be off
1255 Also, 'fileformat' and 'fileformats' options will not be used, the
1256 file is read and written like 'fileformat' was "unix" (a single <NL>
1257 separates lines).
1258 The 'fileencoding' and 'fileencodings' options will not be used, the
1259 file is read without conversion.
1260 NOTE: When you start editing a(nother) file while the 'bin' option is
1261 on, settings from autocommands may change the settings again (e.g.,
1262 'textwidth'), causing trouble when editing. You might want to set
1263 'bin' again when the file has been loaded.
1264 The previous values of these options are remembered and restored when
1265 'bin' is switched from on to off. Each buffer has its own set of
1266 saved option values.
1267 To edit a file with 'binary' set you can use the |++bin| argument.
1268 This avoids you have to do ":set bin", which would have effect for all
1269 files you edit.
1270 When writing a file the <EOL> for the last line is only written if
1271 there was one in the original file (normally Vim appends an <EOL> to
1272 the last line if there is none; this would make the file longer). See
1273 the 'endofline' option.
1274
1275 *'bioskey'* *'biosk'* *'nobioskey'* *'nobiosk'*
1276'bioskey' 'biosk' boolean (default on)
1277 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02001278 {only for MS-DOS}
Bram Moolenaarf3913272016-02-25 00:00:01 +01001279 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001280
1281 *'bomb'* *'nobomb'*
1282'bomb' boolean (default off)
1283 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001284 When writing a file and the following conditions are met, a BOM (Byte
1285 Order Mark) is prepended to the file:
1286 - this option is on
1287 - the 'binary' option is off
1288 - 'fileencoding' is "utf-8", "ucs-2", "ucs-4" or one of the little/big
1289 endian variants.
1290 Some applications use the BOM to recognize the encoding of the file.
1291 Often used for UCS-2 files on MS-Windows. For other applications it
1292 causes trouble, for example: "cat file1 file2" makes the BOM of file2
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001293 appear halfway the resulting file. Gcc doesn't accept a BOM.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001294 When Vim reads a file and 'fileencodings' starts with "ucs-bom", a
1295 check for the presence of the BOM is done and 'bomb' set accordingly.
1296 Unless 'binary' is set, it is removed from the first line, so that you
1297 don't see it when editing. When you don't change the options, the BOM
1298 will be restored when writing the file.
1299
1300 *'breakat'* *'brk'*
1301'breakat' 'brk' string (default " ^I!@*-+;:,./?")
1302 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02001303 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001304 feature}
1305 This option lets you choose which characters might cause a line
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00001306 break if 'linebreak' is on. Only works for ASCII and also for 8-bit
1307 characters when 'encoding' is an 8-bit encoding.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001308
Bram Moolenaar7c1c6db2016-04-03 22:08:05 +02001309 *'breakindent'* *'bri'* *'nobreakindent'* *'nobri'*
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001310'breakindent' 'bri' boolean (default off)
1311 local to window
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001312 {not available when compiled without the |+linebreak|
1313 feature}
1314 Every wrapped line will continue visually indented (same amount of
1315 space as the beginning of that line), thus preserving horizontal blocks
1316 of text.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001317 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001318
1319 *'breakindentopt'* *'briopt'*
1320'breakindentopt' 'briopt' string (default empty)
1321 local to window
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001322 {not available when compiled without the |+linebreak|
1323 feature}
1324 Settings for 'breakindent'. It can consist of the following optional
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001325 items and must be separated by a comma:
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001326 min:{n} Minimum text width that will be kept after
1327 applying 'breakindent', even if the resulting
1328 text should normally be narrower. This prevents
1329 text indented almost to the right window border
1330 occupying lot of vertical space when broken.
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001331 shift:{n} After applying 'breakindent', the wrapped line's
1332 beginning will be shifted by the given number of
1333 characters. It permits dynamic French paragraph
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001334 indentation (negative) or emphasizing the line
1335 continuation (positive).
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01001336 sbr Display the 'showbreak' value before applying the
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001337 additional indent.
Maxim Kimf674b352021-07-22 11:46:59 +02001338 list:{n} Adds an additional indent for lines that match a
Christian Brabandt4a0b85a2021-07-14 20:00:27 +02001339 numbered or bulleted list (using the
1340 'formatlistpat' setting).
Maxim Kimf674b352021-07-22 11:46:59 +02001341 list:-1 Uses the length of a match with 'formatlistpat'
1342 for indentation.
Christian Brabandt4a0b85a2021-07-14 20:00:27 +02001343 The default value for min is 20, shift and list is 0.
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001344
Bram Moolenaar071d4272004-06-13 20:20:40 +00001345 *'browsedir'* *'bsdir'*
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001346'browsedir' 'bsdir' string (default: "last")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001347 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02001348 {only for Motif, Athena, GTK, Mac and Win32 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001349 Which directory to use for the file browser:
Bram Moolenaar446cb832008-06-24 21:56:24 +00001350 last Use same directory as with last file browser, where a
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02001351 file was opened or saved.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001352 buffer Use the directory of the related buffer.
1353 current Use the current directory.
1354 {path} Use the specified directory
1355
1356 *'bufhidden'* *'bh'*
1357'bufhidden' 'bh' string (default: "")
1358 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001359 This option specifies what happens when a buffer is no longer
1360 displayed in a window:
1361 <empty> follow the global 'hidden' option
1362 hide hide the buffer (don't unload it), also when 'hidden'
1363 is not set
1364 unload unload the buffer, also when 'hidden' is set or using
1365 |:hide|
1366 delete delete the buffer from the buffer list, also when
1367 'hidden' is set or using |:hide|, like using
1368 |:bdelete|
1369 wipe wipe out the buffer from the buffer list, also when
1370 'hidden' is set or using |:hide|, like using
1371 |:bwipeout|
1372
Bram Moolenaara14de3d2005-01-07 21:48:26 +00001373 CAREFUL: when "unload", "delete" or "wipe" is used changes in a buffer
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01001374 are lost without a warning. Also, these values may break autocommands
1375 that switch between buffers temporarily.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001376 This option is used together with 'buftype' and 'swapfile' to specify
1377 special kinds of buffers. See |special-buffers|.
1378
1379 *'buflisted'* *'bl'* *'nobuflisted'* *'nobl'* *E85*
1380'buflisted' 'bl' boolean (default: on)
1381 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001382 When this option is set, the buffer shows up in the buffer list. If
1383 it is reset it is not used for ":bnext", "ls", the Buffers menu, etc.
1384 This option is reset by Vim for buffers that are only used to remember
1385 a file name or marks. Vim sets it when starting to edit a buffer.
1386 But not when moving to a buffer with ":buffer".
1387
1388 *'buftype'* *'bt'* *E382*
1389'buftype' 'bt' string (default: "")
1390 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001391 The value of this option specifies the type of a buffer:
1392 <empty> normal buffer
1393 nofile buffer which is not related to a file and will not be
1394 written
1395 nowrite buffer which will not be written
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001396 acwrite buffer which will always be written with BufWriteCmd
Bram Moolenaarb5b75622018-03-09 22:22:21 +01001397 autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001398 quickfix quickfix buffer, contains list of errors |:cwindow|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001399 or list of locations |:lwindow|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001400 help help buffer (you are not supposed to set this
1401 manually)
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02001402 terminal buffer for a |terminal| (you are not supposed to set
1403 this manually)
Bram Moolenaarf2732452018-06-03 14:47:35 +02001404 prompt buffer where only the last line can be edited, meant
1405 to be used by a plugin, see |prompt-buffer|
1406 {only when compiled with the |+channel| feature}
Bram Moolenaar4d784b22019-05-25 19:51:39 +02001407 popup buffer used in a popup window, see |popup|.
1408 {only when compiled with the |+textprop| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001409
1410 This option is used together with 'bufhidden' and 'swapfile' to
1411 specify special kinds of buffers. See |special-buffers|.
Bram Moolenaarebdf3c92020-02-15 21:41:42 +01001412 Also see |win_gettype()|, which returns the type of the window.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001413
1414 Be careful with changing this option, it can have many side effects!
1415
Bram Moolenaar280f1262006-01-30 00:14:18 +00001416 A "quickfix" buffer is only used for the error list and the location
1417 list. This value is set by the |:cwindow| and |:lwindow| commands and
1418 you are not supposed to change it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001419
1420 "nofile" and "nowrite" buffers are similar:
1421 both: The buffer is not to be written to disk, ":w" doesn't
1422 work (":w filename" does work though).
1423 both: The buffer is never considered to be |'modified'|.
1424 There is no warning when the changes will be lost, for
1425 example when you quit Vim.
1426 both: A swap file is only created when using too much memory
1427 (when 'swapfile' has been reset there is never a swap
1428 file).
1429 nofile only: The buffer name is fixed, it is not handled like a
1430 file name. It is not modified in response to a |:cd|
1431 command.
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01001432 both: When using ":e bufname" and already editing "bufname"
1433 the buffer is made empty and autocommands are
1434 triggered as usual for |:edit|.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001435 *E676*
1436 "acwrite" implies that the buffer name is not related to a file, like
1437 "nofile", but it will be written. Thus, in contrast to "nofile" and
1438 "nowrite", ":w" does work and a modified buffer can't be abandoned
1439 without saving. For writing there must be matching |BufWriteCmd|,
1440 |FileWriteCmd| or |FileAppendCmd| autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001441
1442 *'casemap'* *'cmp'*
1443'casemap' 'cmp' string (default: "internal,keepascii")
1444 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001445 Specifies details about changing the case of letters. It may contain
1446 these words, separated by a comma:
1447 internal Use internal case mapping functions, the current
1448 locale does not change the case mapping. This only
Bram Moolenaar6f16eb82005-08-23 21:02:42 +00001449 matters when 'encoding' is a Unicode encoding,
1450 "latin1" or "iso-8859-15". When "internal" is
1451 omitted, the towupper() and towlower() system library
1452 functions are used when available.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001453 keepascii For the ASCII characters (0x00 to 0x7f) use the US
1454 case mapping, the current locale is not effective.
1455 This probably only matters for Turkish.
1456
1457 *'cdpath'* *'cd'* *E344* *E346*
1458'cdpath' 'cd' string (default: equivalent to $CDPATH or ",,")
1459 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001460 {not available when compiled without the
1461 |+file_in_path| feature}
1462 This is a list of directories which will be searched when using the
Bram Moolenaar00aa0692019-04-27 20:37:57 +02001463 |:cd|, |:tcd| and |:lcd| commands, provided that the directory being
1464 searched for has a relative path, not an absolute part starting with
1465 "/", "./" or "../", the 'cdpath' option is not used then.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001466 The 'cdpath' option's value has the same form and semantics as
1467 |'path'|. Also see |file-searching|.
1468 The default value is taken from $CDPATH, with a "," prepended to look
1469 in the current directory first.
1470 If the default value taken from $CDPATH is not what you want, include
1471 a modified version of the following command in your vimrc file to
1472 override it: >
1473 :let &cdpath = ',' . substitute(substitute($CDPATH, '[, ]', '\\\0', 'g'), ':', ',', 'g')
1474< This option cannot be set from a |modeline| or in the |sandbox|, for
1475 security reasons.
1476 (parts of 'cdpath' can be passed to the shell to expand file names).
1477
1478 *'cedit'*
1479'cedit' string (Vi default: "", Vim default: CTRL-F)
1480 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001481 The key used in Command-line Mode to open the command-line window.
1482 The default is CTRL-F when 'compatible' is off.
1483 Only non-printable keys are allowed.
1484 The key can be specified as a single character, but it is difficult to
1485 type. The preferred way is to use the <> notation. Examples: >
Bram Moolenaare18dbe82016-07-02 21:42:23 +02001486 :exe "set cedit=\<C-Y>"
1487 :exe "set cedit=\<Esc>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001488< |Nvi| also has this option, but it only uses the first character.
1489 See |cmdwin|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001490 NOTE: This option is set to the Vim default value when 'compatible'
1491 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001492
1493 *'charconvert'* *'ccv'* *E202* *E214* *E513*
1494'charconvert' 'ccv' string (default "")
1495 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01001496 {only available when compiled with the |+eval| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001497 An expression that is used for character encoding conversion. It is
1498 evaluated when a file that is to be read or has been written has a
1499 different encoding from what is desired.
1500 'charconvert' is not used when the internal iconv() function is
1501 supported and is able to do the conversion. Using iconv() is
1502 preferred, because it is much faster.
1503 'charconvert' is not used when reading stdin |--|, because there is no
1504 file to convert from. You will have to save the text in a file first.
1505 The expression must return zero or an empty string for success,
1506 non-zero for failure.
1507 The possible encoding names encountered are in 'encoding'.
1508 Additionally, names given in 'fileencodings' and 'fileencoding' are
1509 used.
1510 Conversion between "latin1", "unicode", "ucs-2", "ucs-4" and "utf-8"
1511 is done internally by Vim, 'charconvert' is not used for this.
1512 'charconvert' is also used to convert the viminfo file, if the 'c'
1513 flag is present in 'viminfo'. Also used for Unicode conversion.
1514 Example: >
1515 set charconvert=CharConvert()
1516 fun CharConvert()
1517 system("recode "
1518 \ . v:charconvert_from . ".." . v:charconvert_to
1519 \ . " <" . v:fname_in . " >" v:fname_out)
1520 return v:shell_error
1521 endfun
1522< The related Vim variables are:
1523 v:charconvert_from name of the current encoding
1524 v:charconvert_to name of the desired encoding
1525 v:fname_in name of the input file
1526 v:fname_out name of the output file
1527 Note that v:fname_in and v:fname_out will never be the same.
1528 Note that v:charconvert_from and v:charconvert_to may be different
1529 from 'encoding'. Vim internally uses UTF-8 instead of UCS-2 or UCS-4.
1530 Encryption is not done by Vim when using 'charconvert'. If you want
1531 to encrypt the file after conversion, 'charconvert' should take care
1532 of this.
1533 This option cannot be set from a |modeline| or in the |sandbox|, for
1534 security reasons.
1535
1536 *'cindent'* *'cin'* *'nocindent'* *'nocin'*
1537'cindent' 'cin' boolean (default off)
1538 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001539 {not available when compiled without the |+cindent|
1540 feature}
Bram Moolenaar446cb832008-06-24 21:56:24 +00001541 Enables automatic C program indenting. See 'cinkeys' to set the keys
Bram Moolenaar071d4272004-06-13 20:20:40 +00001542 that trigger reindenting in insert mode and 'cinoptions' to set your
1543 preferred indent style.
1544 If 'indentexpr' is not empty, it overrules 'cindent'.
1545 If 'lisp' is not on and both 'indentexpr' and 'equalprg' are empty,
1546 the "=" operator indents using this algorithm rather than calling an
1547 external program.
1548 See |C-indenting|.
1549 When you don't like the way 'cindent' works, try the 'smartindent'
1550 option or 'indentexpr'.
1551 This option is not used when 'paste' is set.
1552 NOTE: This option is reset when 'compatible' is set.
1553
1554 *'cinkeys'* *'cink'*
Bram Moolenaarce655742019-01-31 14:12:57 +01001555'cinkeys' 'cink' string (default "0{,0},0),0],:,0#,!^F,o,O,e")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001556 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001557 {not available when compiled without the |+cindent|
1558 feature}
1559 A list of keys that, when typed in Insert mode, cause reindenting of
1560 the current line. Only used if 'cindent' is on and 'indentexpr' is
1561 empty.
1562 For the format of this option see |cinkeys-format|.
1563 See |C-indenting|.
1564
1565 *'cinoptions'* *'cino'*
1566'cinoptions' 'cino' string (default "")
1567 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001568 {not available when compiled without the |+cindent|
1569 feature}
1570 The 'cinoptions' affect the way 'cindent' reindents lines in a C
1571 program. See |cinoptions-values| for the values of this option, and
1572 |C-indenting| for info on C indenting in general.
1573
1574
1575 *'cinwords'* *'cinw'*
1576'cinwords' 'cinw' string (default "if,else,while,do,for,switch")
1577 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001578 {not available when compiled without both the
1579 |+cindent| and the |+smartindent| features}
1580 These keywords start an extra indent in the next line when
1581 'smartindent' or 'cindent' is set. For 'cindent' this is only done at
1582 an appropriate place (inside {}).
1583 Note that 'ignorecase' isn't used for 'cinwords'. If case doesn't
1584 matter, include the keyword both the uppercase and lowercase:
1585 "if,If,IF".
1586
1587 *'clipboard'* *'cb'*
1588'clipboard' 'cb' string (default "autoselect,exclude:cons\|linux"
1589 for X-windows, "" otherwise)
1590 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001591 {only in GUI versions or when the |+xterm_clipboard|
1592 feature is included}
1593 This option is a list of comma separated names.
Bram Moolenaar942db232021-02-13 18:14:48 +01001594 Note: if one of the items is "exclude:", then you can't add an item
1595 after that. Therefore do append an item with += but use ^= to
1596 prepend, e.g.: >
1597 set clipboard^=unnamed
1598< These names are recognized:
Bram Moolenaar071d4272004-06-13 20:20:40 +00001599
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001600 *clipboard-unnamed*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001601 unnamed When included, Vim will use the clipboard register '*'
1602 for all yank, delete, change and put operations which
1603 would normally go to the unnamed register. When a
1604 register is explicitly specified, it will always be
1605 used regardless of whether "unnamed" is in 'clipboard'
1606 or not. The clipboard register can always be
1607 explicitly accessed using the "* notation. Also see
1608 |gui-clipboard|.
1609
Bram Moolenaar30b65812012-07-12 22:01:11 +02001610 *clipboard-unnamedplus*
Bram Moolenaar00154502013-02-13 16:15:55 +01001611 unnamedplus A variant of the "unnamed" flag which uses the
1612 clipboard register '+' (|quoteplus|) instead of
1613 register '*' for all yank, delete, change and put
1614 operations which would normally go to the unnamed
1615 register. When "unnamed" is also included to the
1616 option, yank operations (but not delete, change or
1617 put) will additionally copy the text into register
1618 '*'.
Bram Moolenaar81af9252010-12-10 20:35:50 +01001619 Only available with the |+X11| feature.
Bram Moolenaarbf9680e2010-12-02 21:43:16 +01001620 Availability can be checked with: >
1621 if has('unnamedplus')
1622<
Bram Moolenaar30b65812012-07-12 22:01:11 +02001623 *clipboard-autoselect*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001624 autoselect Works like the 'a' flag in 'guioptions': If present,
1625 then whenever Visual mode is started, or the Visual
1626 area extended, Vim tries to become the owner of the
1627 windowing system's global selection or put the
1628 selected text on the clipboard used by the selection
Bram Moolenaarba3ff532018-11-04 14:45:49 +01001629 register "*. See |'go-a'| and |quotestar| for details.
1630 When the GUI is active, the 'a' flag in 'guioptions'
1631 is used, when the GUI is not active, this "autoselect"
1632 flag is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001633 Also applies to the modeless selection.
1634
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001635 *clipboard-autoselectplus*
1636 autoselectplus Like "autoselect" but using the + register instead of
1637 the * register. Compare to the 'P' flag in
1638 'guioptions'.
1639
1640 *clipboard-autoselectml*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001641 autoselectml Like "autoselect", but for the modeless selection
1642 only. Compare to the 'A' flag in 'guioptions'.
1643
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001644 *clipboard-html*
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001645 html When the clipboard contains HTML, use this when
1646 pasting. When putting text on the clipboard, mark it
1647 as HTML. This works to copy rendered HTML from
1648 Firefox, paste it as raw HTML in Vim, select the HTML
1649 in Vim and paste it in a rich edit box in Firefox.
Bram Moolenaar20a825a2010-05-31 21:27:30 +02001650 You probably want to add this only temporarily,
1651 possibly use BufEnter autocommands.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001652 Only supported for GTK version 2 and later.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001653
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001654 *clipboard-exclude*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001655 exclude:{pattern}
1656 Defines a pattern that is matched against the name of
1657 the terminal 'term'. If there is a match, no
1658 connection will be made to the X server. This is
1659 useful in this situation:
1660 - Running Vim in a console.
1661 - $DISPLAY is set to start applications on another
1662 display.
1663 - You do not want to connect to the X server in the
1664 console, but do want this in a terminal emulator.
1665 To never connect to the X server use: >
1666 exclude:.*
1667< This has the same effect as using the |-X| argument.
1668 Note that when there is no connection to the X server
1669 the window title won't be restored and the clipboard
1670 cannot be accessed.
1671 The value of 'magic' is ignored, {pattern} is
1672 interpreted as if 'magic' was on.
1673 The rest of the option value will be used for
1674 {pattern}, this must be the last entry.
1675
1676 *'cmdheight'* *'ch'*
1677'cmdheight' 'ch' number (default 1)
1678 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001679 Number of screen lines to use for the command-line. Helps avoiding
1680 |hit-enter| prompts.
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00001681 The value of this option is stored with the tab page, so that each tab
1682 page can have a different value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001683
1684 *'cmdwinheight'* *'cwh'*
1685'cmdwinheight' 'cwh' number (default 7)
1686 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001687 Number of screen lines to use for the command-line window. |cmdwin|
1688
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001689 *'colorcolumn'* *'cc'*
1690'colorcolumn' 'cc' string (default "")
1691 local to window
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001692 {not available when compiled without the |+syntax|
1693 feature}
1694 'colorcolumn' is a comma separated list of screen columns that are
1695 highlighted with ColorColumn |hl-ColorColumn|. Useful to align
1696 text. Will make screen redrawing slower.
1697 The screen column can be an absolute number, or a number preceded with
1698 '+' or '-', which is added to or subtracted from 'textwidth'. >
1699
1700 :set cc=+1 " highlight column after 'textwidth'
1701 :set cc=+1,+2,+3 " highlight three columns after 'textwidth'
1702 :hi ColorColumn ctermbg=lightgrey guibg=lightgrey
1703<
1704 When 'textwidth' is zero then the items with '-' and '+' are not used.
1705 A maximum of 256 columns are highlighted.
1706
Bram Moolenaar071d4272004-06-13 20:20:40 +00001707 *'columns'* *'co'* *E594*
1708'columns' 'co' number (default 80 or terminal width)
1709 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001710 Number of columns of the screen. Normally this is set by the terminal
Bram Moolenaar7c626922005-02-07 22:01:03 +00001711 initialization and does not have to be set by hand. Also see
1712 |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001713 When Vim is running in the GUI or in a resizable window, setting this
1714 option will cause the window size to be changed. When you only want
1715 to use the size for the GUI, put the command in your |gvimrc| file.
1716 When you set this option and Vim is unable to change the physical
Bram Moolenaar02467872007-05-06 13:22:01 +00001717 number of columns of the display, the display may be messed up. For
1718 the GUI it is always possible and Vim limits the number of columns to
1719 what fits on the screen. You can use this command to get the widest
1720 window possible: >
1721 :set columns=9999
1722< Minimum value is 12, maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001723
1724 *'comments'* *'com'* *E524* *E525*
1725'comments' 'com' string (default
1726 "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-")
1727 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001728 A comma separated list of strings that can start a comment line. See
1729 |format-comments|. See |option-backslash| about using backslashes to
1730 insert a space.
1731
1732 *'commentstring'* *'cms'* *E537*
1733'commentstring' 'cms' string (default "/*%s*/")
1734 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001735 {not available when compiled without the |+folding|
1736 feature}
1737 A template for a comment. The "%s" in the value is replaced with the
1738 comment text. Currently only used to add markers for folding, see
1739 |fold-marker|.
1740
1741 *'compatible'* *'cp'* *'nocompatible'* *'nocp'*
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001742'compatible' 'cp' boolean (default on, off when a |vimrc| or |gvimrc|
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02001743 file is found, reset in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001744 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001745 This option has the effect of making Vim either more Vi-compatible, or
1746 make Vim behave in a more useful way.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001747
Bram Moolenaar071d4272004-06-13 20:20:40 +00001748 This is a special kind of option, because when it's set or reset,
Bram Moolenaar214641f2017-03-05 17:04:09 +01001749 other options are also changed as a side effect.
1750 NOTE: Setting or resetting this option can have a lot of unexpected
1751 effects: Mappings are interpreted in another way, undo behaves
1752 differently, etc. If you set this option in your vimrc file, you
1753 should probably put it at the very start.
1754
Bram Moolenaar071d4272004-06-13 20:20:40 +00001755 By default this option is on and the Vi defaults are used for the
1756 options. This default was chosen for those people who want to use Vim
1757 just like Vi, and don't even (want to) know about the 'compatible'
1758 option.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001759 When a |vimrc| or |gvimrc| file is found while Vim is starting up,
Bram Moolenaard042c562005-06-30 22:04:15 +00001760 this option is switched off, and all options that have not been
1761 modified will be set to the Vim defaults. Effectively, this means
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001762 that when a |vimrc| or |gvimrc| file exists, Vim will use the Vim
Bram Moolenaard042c562005-06-30 22:04:15 +00001763 defaults, otherwise it will use the Vi defaults. (Note: This doesn't
Bram Moolenaar02467872007-05-06 13:22:01 +00001764 happen for the system-wide vimrc or gvimrc file, nor for a file given
1765 with the |-u| argument). Also see |compatible-default| and
1766 |posix-compliance|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001767 You can also set this option with the "-C" argument, and reset it with
1768 "-N". See |-C| and |-N|.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001769 See 'cpoptions' for more fine tuning of Vi compatibility.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001770
Bram Moolenaar214641f2017-03-05 17:04:09 +01001771 When this option is set, numerous other options are set to make Vim as
1772 Vi-compatible as possible. When this option is unset, various options
1773 are set to make Vim more useful. The table below lists all the
1774 options affected.
1775 The {?} column indicates when the options are affected:
1776 + Means that the option is set to the value given in {set value} when
1777 'compatible' is set.
1778 & Means that the option is set to the value given in {set value} when
1779 'compatible' is set AND is set to its Vim default value when
1780 'compatible' is unset.
1781 - Means the option is NOT changed when setting 'compatible' but IS
1782 set to its Vim default when 'compatible' is unset.
1783 The {effect} column summarises the change when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001784
Bram Moolenaar036986f2017-03-16 17:41:02 +01001785 option ? set value effect ~
Bram Moolenaar214641f2017-03-05 17:04:09 +01001786
1787 'allowrevins' + off no CTRL-_ command
1788 'antialias' + off don't use antialiased fonts
1789 'arabic' + off reset arabic-related options
1790 'arabicshape' + on correct character shapes
1791 'backspace' + "" normal backspace
1792 'backup' + off no backup file
1793 'backupcopy' & Unix: "yes" backup file is a copy
1794 else: "auto" copy or rename backup file
1795 'balloonexpr' + "" text to show in evaluation balloon
1796 'breakindent' + off don't indent when wrapping lines
1797 'cedit' - {unchanged} {set vim default only on resetting 'cp'}
1798 'cindent' + off no C code indentation
1799 'compatible' - {unchanged} {set vim default only on resetting 'cp'}
1800 'copyindent' + off don't copy indent structure
1801 'cpoptions' & (all flags) Vi-compatible flags
1802 'cscopepathcomp'+ 0 don't show directories in tags list
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01001803 'cscoperelative'+ off don't use basename of path as prefix
Bram Moolenaar214641f2017-03-05 17:04:09 +01001804 'cscopetag' + off don't use cscope for ":tag"
Bram Moolenaar036986f2017-03-16 17:41:02 +01001805 'cscopetagorder'+ 0 see |cscopetagorder|
Bram Moolenaar214641f2017-03-05 17:04:09 +01001806 'cscopeverbose' + off see |cscopeverbose|
1807 'delcombine' + off unicode: delete whole char combination
1808 'digraph' + off no digraphs
1809 'esckeys' & off no <Esc>-keys in Insert mode
1810 'expandtab' + off tabs not expanded to spaces
1811 'fileformats' & "" no automatic file format detection,
Bram Moolenaar6f345a12019-12-17 21:27:18 +01001812 "dos,unix" except for MS-Windows
Bram Moolenaar214641f2017-03-05 17:04:09 +01001813 'formatexpr' + "" use 'formatprg' for auto-formatting
1814 'formatoptions' & "vt" Vi compatible formatting
1815 'gdefault' + off no default 'g' flag for ":s"
1816 'history' & 0 no commandline history
1817 'hkmap' + off no Hebrew keyboard mapping
1818 'hkmapp' + off no phonetic Hebrew keyboard mapping
1819 'hlsearch' + off no highlighting of search matches
1820 'incsearch' + off no incremental searching
1821 'indentexpr' + "" no indenting by expression
1822 'insertmode' + off do not start in Insert mode
1823 'iskeyword' & "@,48-57,_" keywords contain alphanumeric
Bram Moolenaar071d4272004-06-13 20:20:40 +00001824 characters and '_'
Bram Moolenaar214641f2017-03-05 17:04:09 +01001825 'joinspaces' + on insert 2 spaces after period
1826 'modeline' & off no modelines
1827 'more' & off no pauses in listings
1828 'mzquantum' - {unchanged} {set vim default only on resetting 'cp'}
1829 'numberwidth' & 8 min number of columns for line number
1830 'preserveindent'+ off don't preserve current indent structure
1831 when changing it
1832 'revins' + off no reverse insert
1833 'ruler' + off no ruler
1834 'scrolljump' + 1 no jump scroll
1835 'scrolloff' + 0 no scroll offset
1836 'shelltemp' - {unchanged} {set vim default only on resetting 'cp'}
1837 'shiftround' + off indent not rounded to shiftwidth
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02001838 'shortmess' & "S" no shortening of messages
Bram Moolenaar214641f2017-03-05 17:04:09 +01001839 'showcmd' & off command characters not shown
1840 'showmode' & off current mode not shown
1841 'sidescrolloff' + 0 cursor moves to edge of screen in scroll
1842 'smartcase' + off no automatic ignore case switch
1843 'smartindent' + off no smart indentation
1844 'smarttab' + off no smart tab size
1845 'softtabstop' + 0 tabs are always 'tabstop' positions
1846 'startofline' + on goto startofline with some commands
1847 'tagcase' & "followic" 'ignorecase' when searching tags file
1848 'tagrelative' & off tag file names are not relative
1849 'termguicolors' + off don't use highlight-(guifg|guibg)
1850 'textauto' & off no automatic textmode detection
1851 'textwidth' + 0 no automatic line wrap
1852 'tildeop' + off tilde is not an operator
1853 'ttimeout' + off no terminal timeout
1854 'undofile' + off don't use an undo file
Bram Moolenaar036986f2017-03-16 17:41:02 +01001855 'viminfo' - {unchanged} {set Vim default only on resetting 'cp'}
Bram Moolenaar214641f2017-03-05 17:04:09 +01001856 'virtualedit' + "" cursor can only be placed on characters
1857 'whichwrap' & "" left-right movements don't wrap
1858 'wildchar' & CTRL-E only when the current value is <Tab>
Bram Moolenaar071d4272004-06-13 20:20:40 +00001859 use CTRL-E for cmdline completion
Bram Moolenaar214641f2017-03-05 17:04:09 +01001860 'writebackup' + on or off depends on the |+writebackup| feature
Bram Moolenaar071d4272004-06-13 20:20:40 +00001861
1862 *'complete'* *'cpt'* *E535*
1863'complete' 'cpt' string (default: ".,w,b,u,t,i")
1864 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001865 This option specifies how keyword completion |ins-completion| works
1866 when CTRL-P or CTRL-N are used. It is also used for whole-line
1867 completion |i_CTRL-X_CTRL-L|. It indicates the type of completion
1868 and the places to scan. It is a comma separated list of flags:
Bram Moolenaar3848e002016-03-19 18:42:29 +01001869 . scan the current buffer ('wrapscan' is ignored)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001870 w scan buffers from other windows
1871 b scan other loaded buffers that are in the buffer list
1872 u scan the unloaded buffers that are in the buffer list
1873 U scan the buffers that are not in the buffer list
1874 k scan the files given with the 'dictionary' option
Bram Moolenaar0b238792006-03-02 22:49:12 +00001875 kspell use the currently active spell checking |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001876 k{dict} scan the file {dict}. Several "k" flags can be given,
1877 patterns are valid too. For example: >
1878 :set cpt=k/usr/dict/*,k~/spanish
1879< s scan the files given with the 'thesaurus' option
1880 s{tsr} scan the file {tsr}. Several "s" flags can be given, patterns
1881 are valid too.
1882 i scan current and included files
1883 d scan current and included files for defined name or macro
1884 |i_CTRL-X_CTRL-D|
1885 ] tag completion
1886 t same as "]"
1887
1888 Unloaded buffers are not loaded, thus their autocmds |:autocmd| are
1889 not executed, this may lead to unexpected completions from some files
1890 (gzipped files for example). Unloaded buffers are not scanned for
1891 whole-line completion.
1892
1893 The default is ".,w,b,u,t,i", which means to scan:
1894 1. the current buffer
1895 2. buffers in other windows
1896 3. other loaded buffers
1897 4. unloaded buffers
1898 5. tags
1899 6. included files
1900
1901 As you can see, CTRL-N and CTRL-P can be used to do any 'iskeyword'-
Bram Moolenaar582fd852005-03-28 20:58:01 +00001902 based expansion (e.g., dictionary |i_CTRL-X_CTRL-K|, included patterns
1903 |i_CTRL-X_CTRL-I|, tags |i_CTRL-X_CTRL-]| and normal expansions).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001904
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001905 *'completefunc'* *'cfu'*
1906'completefunc' 'cfu' string (default: empty)
1907 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02001908 {not available when compiled without the |+eval|
Bram Moolenaare2c453d2019-08-21 14:37:09 +02001909 feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00001910 This option specifies a function to be used for Insert mode completion
1911 with CTRL-X CTRL-U. |i_CTRL-X_CTRL-U|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001912 See |complete-functions| for an explanation of how the function is
1913 invoked and what it should return.
Bram Moolenaar166af9b2010-11-16 20:34:40 +01001914 This option cannot be set from a |modeline| or in the |sandbox|, for
1915 security reasons.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00001916
Bram Moolenaarac3150d2019-07-28 16:36:39 +02001917 *'completeslash'* *'csl'*
1918'completeslash' 'csl' string (default: "")
1919 local to buffer
Bram Moolenaar2e693a82019-10-16 22:35:02 +02001920 {only for MS-Windows}
Bram Moolenaarac3150d2019-07-28 16:36:39 +02001921 When this option is set it overrules 'shellslash' for completion:
1922 - When this option is set to "slash", a forward slash is used for path
1923 completion in insert mode. This is useful when editing HTML tag, or
Bram Moolenaar6f345a12019-12-17 21:27:18 +01001924 Makefile with 'noshellslash' on MS-Windows.
Bram Moolenaarac3150d2019-07-28 16:36:39 +02001925 - When this option is set to "backslash", backslash is used. This is
Bram Moolenaar6f345a12019-12-17 21:27:18 +01001926 useful when editing a batch file with 'shellslash' set on MS-Windows.
Bram Moolenaarac3150d2019-07-28 16:36:39 +02001927 - When this option is empty, same character is used as for
1928 'shellslash'.
1929 For Insert mode completion the buffer-local value is used. For
1930 command line completion the global value is used.
1931
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001932 *'completeopt'* *'cot'*
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001933'completeopt' 'cot' string (default: "menu,preview")
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001934 global
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001935 A comma separated list of options for Insert mode completion
1936 |ins-completion|. The supported values are:
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001937
1938 menu Use a popup menu to show the possible completions. The
1939 menu is only shown when there is more than one match and
1940 sufficient colors are available. |ins-completion-menu|
1941
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001942 menuone Use the popup menu also when there is only one match.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00001943 Useful when there is additional information about the
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001944 match, e.g., what file it comes from.
1945
Bram Moolenaarc1e37902006-04-18 21:55:01 +00001946 longest Only insert the longest common text of the matches. If
1947 the menu is displayed you can use CTRL-L to add more
1948 characters. Whether case is ignored depends on the kind
1949 of completion. For buffer text the 'ignorecase' option is
1950 used.
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001951
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001952 preview Show extra information about the currently selected
Bram Moolenaar02467872007-05-06 13:22:01 +00001953 completion in the preview window. Only works in
1954 combination with "menu" or "menuone".
1955
Bram Moolenaar576a4a62019-08-18 15:25:17 +02001956 popup Show extra information about the currently selected
1957 completion in a popup window. Only works in combination
1958 with "menu" or "menuone". Overrides "preview".
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02001959 See |'completepopup'| for specifying properties.
Bram Moolenaar2e693a82019-10-16 22:35:02 +02001960 {only works when compiled with the |+textprop| feature}
Bram Moolenaar576a4a62019-08-18 15:25:17 +02001961
Bram Moolenaardca7abe2019-10-20 18:17:57 +02001962 popuphidden
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01001963 Just like "popup" but initially hide the popup. Use a
Bram Moolenaardca7abe2019-10-20 18:17:57 +02001964 |CompleteChanged| autocommand to fetch the info and call
1965 |popup_show()| once the popup has been filled.
1966 See the example at |complete-popuphidden|.
1967 {only works when compiled with the |+textprop| feature}
1968
Bram Moolenaarb6be1e22015-07-10 18:18:40 +02001969 noinsert Do not insert any text for a match until the user selects
1970 a match from the menu. Only works in combination with
1971 "menu" or "menuone". No effect if "longest" is present.
1972
1973 noselect Do not select a match in the menu, force the user to
1974 select one from the menu. Only works in combination with
1975 "menu" or "menuone".
1976
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001977
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02001978 *'completepopup'* *'cpp'*
1979'completepopup' 'cpp' string (default empty)
1980 global
1981 {not available when compiled without the |+textprop|
1982 or |+quickfix| feature}
1983 When 'completeopt' contains "popup" then this option is used for the
Bram Moolenaar447bfba2020-07-18 16:07:16 +02001984 properties of the info popup when it is created. If an info popup
1985 window already exists it is closed, so that the option value is
1986 applied when it is created again.
1987 You can also use |popup_findinfo()| and then set properties for an
1988 existing info popup with |popup_setoptions()|. See |complete-popup|.
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02001989
1990
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001991 *'concealcursor'* *'cocu'*
1992'concealcursor' 'cocu' string (default: "")
1993 local to window
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001994 {not available when compiled without the |+conceal|
1995 feature}
1996 Sets the modes in which text in the cursor line can also be concealed.
1997 When the current mode is listed then concealing happens just like in
1998 other lines.
1999 n Normal mode
2000 v Visual mode
2001 i Insert mode
Bram Moolenaarca8c9862010-07-24 15:00:38 +02002002 c Command line editing, for 'incsearch'
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002003
Bram Moolenaare6dc5732010-07-24 23:52:26 +02002004 'v' applies to all lines in the Visual area, not only the cursor.
Bram Moolenaarca8c9862010-07-24 15:00:38 +02002005 A useful value is "nc". This is used in help files. So long as you
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002006 are moving around text is concealed, but when starting to insert text
2007 or selecting a Visual area the concealed text is displayed, so that
2008 you can see what you are doing.
Bram Moolenaarf70e3d62010-07-24 13:15:07 +02002009 Keep in mind that the cursor position is not always where it's
2010 displayed. E.g., when moving vertically it may change column.
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002011
2012
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002013 *'conceallevel'* *'cole'*
2014'conceallevel' 'cole' number (default 0)
Bram Moolenaar860cae12010-06-05 23:22:07 +02002015 local to window
Bram Moolenaar860cae12010-06-05 23:22:07 +02002016 {not available when compiled without the |+conceal|
2017 feature}
Bram Moolenaar6df6f472010-07-18 18:04:50 +02002018 Determine how text with the "conceal" syntax attribute |:syn-conceal|
2019 is shown:
Bram Moolenaar860cae12010-06-05 23:22:07 +02002020
Bram Moolenaar6df6f472010-07-18 18:04:50 +02002021 Value Effect ~
Bram Moolenaar860cae12010-06-05 23:22:07 +02002022 0 Text is shown normally
Bram Moolenaar477db062010-07-28 18:17:41 +02002023 1 Each block of concealed text is replaced with one
2024 character. If the syntax item does not have a custom
2025 replacement character defined (see |:syn-cchar|) the
2026 character defined in 'listchars' is used (default is a
2027 space).
2028 It is highlighted with the "Conceal" highlight group.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002029 2 Concealed text is completely hidden unless it has a
2030 custom replacement character defined (see
Bram Moolenaar477db062010-07-28 18:17:41 +02002031 |:syn-cchar|).
Bram Moolenaara7781e02010-07-19 20:13:22 +02002032 3 Concealed text is completely hidden.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002033
Bram Moolenaara7781e02010-07-19 20:13:22 +02002034 Note: in the cursor line concealed text is not hidden, so that you can
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002035 edit and copy the text. This can be changed with the 'concealcursor'
2036 option.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002037
Bram Moolenaar071d4272004-06-13 20:20:40 +00002038 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
2039'confirm' 'cf' boolean (default off)
2040 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002041 When 'confirm' is on, certain operations that would normally
2042 fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
2043 instead raise a |dialog| asking if you wish to save the current
2044 file(s). You can still use a ! to unconditionally |abandon| a buffer.
2045 If 'confirm' is off you can still activate confirmation for one
2046 command only (this is most useful in mappings) with the |:confirm|
2047 command.
2048 Also see the |confirm()| function and the 'v' flag in 'guioptions'.
2049
2050 *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
2051'conskey' 'consk' boolean (default off)
2052 global
Bram Moolenaarf3913272016-02-25 00:00:01 +01002053 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002054
2055 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
2056'copyindent' 'ci' boolean (default off)
2057 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002058 Copy the structure of the existing lines indent when autoindenting a
2059 new line. Normally the new indent is reconstructed by a series of
2060 tabs followed by spaces as required (unless |'expandtab'| is enabled,
2061 in which case only spaces are used). Enabling this option makes the
2062 new line copy whatever characters were used for indenting on the
Bram Moolenaar446cb832008-06-24 21:56:24 +00002063 existing line. 'expandtab' has no effect on these characters, a Tab
2064 remains a Tab. If the new indent is greater than on the existing
Bram Moolenaar071d4272004-06-13 20:20:40 +00002065 line, the remaining space is filled in the normal manner.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002066 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002067 Also see 'preserveindent'.
2068
Bram Moolenaare0fa3742016-02-20 15:47:01 +01002069 *'cpoptions'* *'cpo'* *cpo*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002070'cpoptions' 'cpo' string (Vim default: "aABceFs",
2071 Vi default: all flags)
2072 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002073 A sequence of single character flags. When a character is present
Bram Moolenaar7cba6c02013-09-05 22:13:31 +02002074 this indicates Vi-compatible behavior. This is used for things where
2075 not being Vi-compatible is mostly or sometimes preferred.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002076 'cpoptions' stands for "compatible-options".
2077 Commas can be added for readability.
2078 To avoid problems with flags that are added in the future, use the
2079 "+=" and "-=" feature of ":set" |add-option-flags|.
2080 NOTE: This option is set to the Vi default value when 'compatible' is
2081 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002082 NOTE: This option is set to the POSIX default value at startup when
2083 the Vi default value would be used and the $VIM_POSIX environment
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002084 variable exists |posix|. This means Vim tries to behave like the
2085 POSIX specification.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002086
2087 contains behavior ~
2088 *cpo-a*
2089 a When included, a ":read" command with a file name
2090 argument will set the alternate file name for the
2091 current window.
2092 *cpo-A*
2093 A When included, a ":write" command with a file name
2094 argument will set the alternate file name for the
2095 current window.
2096 *cpo-b*
2097 b "\|" in a ":map" command is recognized as the end of
2098 the map command. The '\' is included in the mapping,
2099 the text after the '|' is interpreted as the next
2100 command. Use a CTRL-V instead of a backslash to
2101 include the '|' in the mapping. Applies to all
2102 mapping, abbreviation, menu and autocmd commands.
2103 See also |map_bar|.
2104 *cpo-B*
2105 B A backslash has no special meaning in mappings,
Bram Moolenaara9604e62018-07-21 05:56:22 +02002106 abbreviations, user commands and the "to" part of the
2107 menu commands. Remove this flag to be able to use a
2108 backslash like a CTRL-V. For example, the command
2109 ":map X \<Esc>" results in X being mapped to:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002110 'B' included: "\^[" (^[ is a real <Esc>)
2111 'B' excluded: "<Esc>" (5 characters)
2112 ('<' excluded in both cases)
2113 *cpo-c*
2114 c Searching continues at the end of any match at the
2115 cursor position, but not further than the start of the
2116 next line. When not present searching continues
2117 one character from the cursor position. With 'c'
2118 "abababababab" only gets three matches when repeating
2119 "/abab", without 'c' there are five matches.
2120 *cpo-C*
2121 C Do not concatenate sourced lines that start with a
2122 backslash. See |line-continuation|.
2123 *cpo-d*
2124 d Using "./" in the 'tags' option doesn't mean to use
2125 the tags file relative to the current file, but the
2126 tags file in the current directory.
2127 *cpo-D*
2128 D Can't use CTRL-K to enter a digraph after Normal mode
2129 commands with a character argument, like |r|, |f| and
2130 |t|.
2131 *cpo-e*
2132 e When executing a register with ":@r", always add a
2133 <CR> to the last line, also when the register is not
2134 linewise. If this flag is not present, the register
2135 is not linewise and the last line does not end in a
2136 <CR>, then the last line is put on the command-line
2137 and can be edited before hitting <CR>.
2138 *cpo-E*
2139 E It is an error when using "y", "d", "c", "g~", "gu" or
2140 "gU" on an Empty region. The operators only work when
Bram Moolenaar15142e22018-04-30 22:19:58 +02002141 at least one character is to be operated on. Example:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002142 This makes "y0" fail in the first column.
2143 *cpo-f*
2144 f When included, a ":read" command with a file name
2145 argument will set the file name for the current buffer,
2146 if the current buffer doesn't have a file name yet.
2147 *cpo-F*
2148 F When included, a ":write" command with a file name
2149 argument will set the file name for the current
2150 buffer, if the current buffer doesn't have a file name
Bram Moolenaarb3480382005-12-11 21:33:32 +00002151 yet. Also see |cpo-P|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002152 *cpo-g*
2153 g Goto line 1 when using ":edit" without argument.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002154 *cpo-H*
2155 H When using "I" on a line with only blanks, insert
2156 before the last blank. Without this flag insert after
2157 the last blank.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002158 *cpo-i*
2159 i When included, interrupting the reading of a file will
2160 leave it modified.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002161 *cpo-I*
2162 I When moving the cursor up or down just after inserting
2163 indent for 'autoindent', do not delete the indent.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002164 *cpo-j*
2165 j When joining lines, only add two spaces after a '.',
2166 not after '!' or '?'. Also see 'joinspaces'.
2167 *cpo-J*
2168 J A |sentence| has to be followed by two spaces after
Bram Moolenaar582fd852005-03-28 20:58:01 +00002169 the '.', '!' or '?'. A <Tab> is not recognized as
Bram Moolenaar071d4272004-06-13 20:20:40 +00002170 white space.
2171 *cpo-k*
2172 k Disable the recognition of raw key codes in
2173 mappings, abbreviations, and the "to" part of menu
2174 commands. For example, if <Key> sends ^[OA (where ^[
2175 is <Esc>), the command ":map X ^[OA" results in X
2176 being mapped to:
2177 'k' included: "^[OA" (3 characters)
2178 'k' excluded: "<Key>" (one key code)
2179 Also see the '<' flag below.
2180 *cpo-K*
2181 K Don't wait for a key code to complete when it is
2182 halfway a mapping. This breaks mapping <F1><F1> when
2183 only part of the second <F1> has been read. It
2184 enables cancelling the mapping by typing <F1><Esc>.
2185 *cpo-l*
2186 l Backslash in a [] range in a search pattern is taken
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002187 literally, only "\]", "\^", "\-" and "\\" are special.
2188 See |/[]|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002189 'l' included: "/[ \t]" finds <Space>, '\' and 't'
2190 'l' excluded: "/[ \t]" finds <Space> and <Tab>
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002191 Also see |cpo-\|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002192 *cpo-L*
2193 L When the 'list' option is set, 'wrapmargin',
2194 'textwidth', 'softtabstop' and Virtual Replace mode
2195 (see |gR|) count a <Tab> as two characters, instead of
2196 the normal behavior of a <Tab>.
2197 *cpo-m*
2198 m When included, a showmatch will always wait half a
2199 second. When not included, a showmatch will wait half
2200 a second or until a character is typed. |'showmatch'|
2201 *cpo-M*
2202 M When excluded, "%" matching will take backslashes into
2203 account. Thus in "( \( )" and "\( ( \)" the outer
2204 parenthesis match. When included "%" ignores
2205 backslashes, which is Vi compatible.
2206 *cpo-n*
Bram Moolenaar64486672010-05-16 15:46:46 +02002207 n When included, the column used for 'number' and
2208 'relativenumber' will also be used for text of wrapped
2209 lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002210 *cpo-o*
2211 o Line offset to search command is not remembered for
2212 next search.
2213 *cpo-O*
2214 O Don't complain if a file is being overwritten, even
2215 when it didn't exist when editing it. This is a
2216 protection against a file unexpectedly created by
2217 someone else. Vi didn't complain about this.
2218 *cpo-p*
2219 p Vi compatible Lisp indenting. When not present, a
2220 slightly better algorithm is used.
Bram Moolenaarb3480382005-12-11 21:33:32 +00002221 *cpo-P*
2222 P When included, a ":write" command that appends to a
2223 file will set the file name for the current buffer, if
2224 the current buffer doesn't have a file name yet and
2225 the 'F' flag is also included |cpo-F|.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002226 *cpo-q*
2227 q When joining multiple lines leave the cursor at the
2228 position where it would be when joining two lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002229 *cpo-r*
2230 r Redo ("." command) uses "/" to repeat a search
2231 command, instead of the actually used search string.
2232 *cpo-R*
2233 R Remove marks from filtered lines. Without this flag
2234 marks are kept like |:keepmarks| was used.
2235 *cpo-s*
2236 s Set buffer options when entering the buffer for the
2237 first time. This is like it is in Vim version 3.0.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002238 And it is the default. If not present the options are
Bram Moolenaar071d4272004-06-13 20:20:40 +00002239 set when the buffer is created.
2240 *cpo-S*
2241 S Set buffer options always when entering a buffer
2242 (except 'readonly', 'fileformat', 'filetype' and
2243 'syntax'). This is the (most) Vi compatible setting.
2244 The options are set to the values in the current
2245 buffer. When you change an option and go to another
2246 buffer, the value is copied. Effectively makes the
2247 buffer options global to all buffers.
2248
2249 's' 'S' copy buffer options
2250 no no when buffer created
2251 yes no when buffer first entered (default)
2252 X yes each time when buffer entered (vi comp.)
2253 *cpo-t*
2254 t Search pattern for the tag command is remembered for
2255 "n" command. Otherwise Vim only puts the pattern in
2256 the history for search pattern, but doesn't change the
2257 last used search pattern.
2258 *cpo-u*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002259 u Undo is Vi compatible. See |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002260 *cpo-v*
2261 v Backspaced characters remain visible on the screen in
2262 Insert mode. Without this flag the characters are
2263 erased from the screen right away. With this flag the
2264 screen newly typed text overwrites backspaced
2265 characters.
2266 *cpo-w*
2267 w When using "cw" on a blank character, only change one
2268 character and not all blanks until the start of the
2269 next word.
2270 *cpo-W*
2271 W Don't overwrite a readonly file. When omitted, ":w!"
2272 overwrites a readonly file, if possible.
2273 *cpo-x*
2274 x <Esc> on the command-line executes the command-line.
2275 The default in Vim is to abandon the command-line,
2276 because <Esc> normally aborts a command. |c_<Esc>|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002277 *cpo-X*
2278 X When using a count with "R" the replaced text is
2279 deleted only once. Also when repeating "R" with "."
2280 and a count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002281 *cpo-y*
Bram Moolenaard09091d2019-01-17 16:07:22 +01002282 y A yank command can be redone with ".". Think twice if
2283 you really want to use this, it may break some
2284 plugins, since most people expect "." to only repeat a
2285 change.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002286 *cpo-Z*
2287 Z When using "w!" while the 'readonly' option is set,
2288 don't reset 'readonly'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002289 *cpo-!*
2290 ! When redoing a filter command, use the last used
2291 external command, whatever it was. Otherwise the last
2292 used -filter- command is used.
2293 *cpo-$*
2294 $ When making a change to one line, don't redisplay the
2295 line, but put a '$' at the end of the changed text.
2296 The changed text will be overwritten when you type the
2297 new text. The line is redisplayed if you type any
2298 command that moves the cursor from the insertion
2299 point.
2300 *cpo-%*
2301 % Vi-compatible matching is done for the "%" command.
2302 Does not recognize "#if", "#endif", etc.
2303 Does not recognize "/*" and "*/".
2304 Parens inside single and double quotes are also
2305 counted, causing a string that contains a paren to
2306 disturb the matching. For example, in a line like
2307 "if (strcmp("foo(", s))" the first paren does not
2308 match the last one. When this flag is not included,
2309 parens inside single and double quotes are treated
2310 specially. When matching a paren outside of quotes,
2311 everything inside quotes is ignored. When matching a
2312 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002313 there is one). This works very well for C programs.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002314 This flag is also used for other features, such as
2315 C-indenting.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002316 *cpo--*
2317 - When included, a vertical movement command fails when
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002318 it would go above the first line or below the last
2319 line. Without it the cursor moves to the first or
2320 last line, unless it already was in that line.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002321 Applies to the commands "-", "k", CTRL-P, "+", "j",
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002322 CTRL-N, CTRL-J and ":1234".
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002323 *cpo-+*
2324 + When included, a ":write file" command will reset the
2325 'modified' flag of the buffer, even though the buffer
2326 itself may still be different from its file.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002327 *cpo-star*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002328 * Use ":*" in the same way as ":@". When not included,
2329 ":*" is an alias for ":'<,'>", select the Visual area.
2330 *cpo-<*
2331 < Disable the recognition of special key codes in |<>|
2332 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002333 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00002334 ":map X <Tab>" results in X being mapped to:
2335 '<' included: "<Tab>" (5 characters)
2336 '<' excluded: "^I" (^I is a real <Tab>)
2337 Also see the 'k' flag above.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002338 *cpo->*
2339 > When appending to a register, put a line break before
2340 the appended text.
Bram Moolenaar8b3e0332011-06-26 05:36:34 +02002341 *cpo-;*
2342 ; When using |,| or |;| to repeat the last |t| search
2343 and the cursor is right in front of the searched
2344 character, the cursor won't move. When not included,
2345 the cursor would skip over it and jump to the
Bram Moolenaarc8734422012-06-01 22:38:45 +02002346 following occurrence.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002347
2348 POSIX flags. These are not included in the Vi default value, except
2349 when $VIM_POSIX was set on startup. |posix|
2350
2351 contains behavior ~
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002352 *cpo-#*
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002353 # A count before "D", "o" and "O" has no effect.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002354 *cpo-&*
2355 & When ":preserve" was used keep the swap file when
2356 exiting normally while this buffer is still loaded.
2357 This flag is tested when exiting.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002358 *cpo-\*
2359 \ Backslash in a [] range in a search pattern is taken
2360 literally, only "\]" is special See |/[]|
Bram Moolenaar90915b52005-08-21 22:17:52 +00002361 '\' included: "/[ \-]" finds <Space>, '\' and '-'
2362 '\' excluded: "/[ \-]" finds <Space> and '-'
2363 Also see |cpo-l|.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002364 *cpo-/*
2365 / When "%" is used as the replacement string in a |:s|
2366 command, use the previous replacement string. |:s%|
2367 *cpo-{*
2368 { The |{| and |}| commands also stop at a "{" character
2369 at the start of a line.
2370 *cpo-.*
2371 . The ":chdir" and ":cd" commands fail if the current
2372 buffer is modified, unless ! is used. Vim doesn't
2373 need this, since it remembers the full path of an
2374 opened file.
2375 *cpo-bar*
2376 | The value of the $LINES and $COLUMNS environment
2377 variables overrule the terminal size values obtained
2378 with system specific functions.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002379
Bram Moolenaar071d4272004-06-13 20:20:40 +00002380
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002381 *'cryptmethod'* *'cm'*
Bram Moolenaara86187b2018-12-16 18:20:00 +01002382'cryptmethod' 'cm' string (default "blowfish2")
Bram Moolenaar49771f42010-07-20 17:32:38 +02002383 global or local to buffer |global-local|
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002384 Method used for encryption when the buffer is written to a file:
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002385 *pkzip*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002386 zip PkZip compatible method. A weak kind of encryption.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002387 Backwards compatible with Vim 7.2 and older.
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002388 *blowfish*
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002389 blowfish Blowfish method. Medium strong encryption but it has
2390 an implementation flaw. Requires Vim 7.3 or later,
2391 files can NOT be read by Vim 7.2 and older. This adds
2392 a "seed" to the file, every time you write the file
2393 the encrypted bytes will be different.
2394 *blowfish2*
2395 blowfish2 Blowfish method. Medium strong encryption. Requires
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01002396 Vim 7.4.401 or later, files can NOT be read by Vim 7.3
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002397 and older. This adds a "seed" to the file, every time
2398 you write the file the encrypted bytes will be
2399 different. The whole undo file is encrypted, not just
2400 the pieces of text.
Christian Brabandtf573c6e2021-06-20 14:02:16 +02002401 *E1193* *E1194* *E1195* *E1196*
2402 *E1197* *E1198* *E1199* *E1200* *E1201*
2403 xchacha20 XChaCha20 Cipher with Poly1305 Message Authentication
2404 Code. Medium strong till strong encryption.
2405 Encryption is provided by the libsodium library, it
2406 requires Vim to be built with |+sodium|
2407 It adds a seed and a message authentication code (MAC)
2408 to the file. This needs at least a Vim 8.2.3022 to
2409 read the encrypted file.
2410 Encryption of swap files is not supported, therefore
2411 no swap file will be used when xchacha20 encryption is
2412 enabled.
2413 Encryption of undo files is not yet supported,
2414 therefore no undo file will currently be written.
2415 CURRENTLY EXPERIMENTAL: Files written with this method
2416 might have to be read back with the same version of
2417 Vim if the binary format changes later.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002418
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01002419 You should use "blowfish2", also to re-encrypt older files.
2420
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002421 When reading an encrypted file 'cryptmethod' will be set automatically
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002422 to the detected method of the file being read. Thus if you write it
2423 without changing 'cryptmethod' the same method will be used.
2424 Changing 'cryptmethod' does not mark the file as modified, you have to
Bram Moolenaar49771f42010-07-20 17:32:38 +02002425 explicitly write it, you don't get a warning unless there are other
2426 modifications. Also see |:X|.
2427
2428 When setting the global value to an empty string, it will end up with
Bram Moolenaara86187b2018-12-16 18:20:00 +01002429 the value "blowfish2". When setting the local value to an empty
2430 string the buffer will use the global value.
Bram Moolenaar49771f42010-07-20 17:32:38 +02002431
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002432 When a new encryption method is added in a later version of Vim, and
2433 the current version does not recognize it, you will get *E821* .
Bram Moolenaar49771f42010-07-20 17:32:38 +02002434 You need to edit this file with the later version of Vim.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002435
2436
Bram Moolenaar071d4272004-06-13 20:20:40 +00002437 *'cscopepathcomp'* *'cspc'*
2438'cscopepathcomp' 'cspc' number (default 0)
2439 global
2440 {not available when compiled without the |+cscope|
2441 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002442 Determines how many components of the path to show in a list of tags.
2443 See |cscopepathcomp|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002444 NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002445
2446 *'cscopeprg'* *'csprg'*
2447'cscopeprg' 'csprg' string (default "cscope")
2448 global
2449 {not available when compiled without the |+cscope|
2450 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002451 Specifies the command to execute cscope. See |cscopeprg|.
2452 This option cannot be set from a |modeline| or in the |sandbox|, for
2453 security reasons.
2454
2455 *'cscopequickfix'* *'csqf'*
2456'cscopequickfix' 'csqf' string (default "")
2457 global
2458 {not available when compiled without the |+cscope|
2459 or |+quickfix| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002460 Specifies whether to use quickfix window to show cscope results.
2461 See |cscopequickfix|.
2462
Bram Moolenaarec7944a2013-06-12 21:29:15 +02002463 *'cscoperelative'* *'csre'* *'nocscoperelative'* *'nocsre'*
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002464'cscoperelative' 'csre' boolean (default off)
2465 global
2466 {not available when compiled without the |+cscope|
2467 feature}
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002468 In the absence of a prefix (-P) for cscope. setting this option enables
2469 to use the basename of cscope.out path as the prefix.
2470 See |cscoperelative|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002471 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002472
Bram Moolenaar071d4272004-06-13 20:20:40 +00002473 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
2474'cscopetag' 'cst' boolean (default off)
2475 global
2476 {not available when compiled without the |+cscope|
2477 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002478 Use cscope for tag commands. See |cscope-options|.
2479 NOTE: This option is reset when 'compatible' is set.
2480
2481 *'cscopetagorder'* *'csto'*
2482'cscopetagorder' 'csto' number (default 0)
2483 global
2484 {not available when compiled without the |+cscope|
2485 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002486 Determines the order in which ":cstag" performs a search. See
2487 |cscopetagorder|.
2488 NOTE: This option is set to 0 when 'compatible' is set.
2489
2490 *'cscopeverbose'* *'csverb'*
2491 *'nocscopeverbose'* *'nocsverb'*
2492'cscopeverbose' 'csverb' boolean (default off)
2493 global
2494 {not available when compiled without the |+cscope|
2495 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002496 Give messages when adding a cscope database. See |cscopeverbose|.
2497 NOTE: This option is reset when 'compatible' is set.
2498
Bram Moolenaar860cae12010-06-05 23:22:07 +02002499 *'cursorbind'* *'crb'* *'nocursorbind'* *'nocrb'*
2500'cursorbind' 'crb' boolean (default off)
2501 local to window
Bram Moolenaar860cae12010-06-05 23:22:07 +02002502 When this option is set, as the cursor in the current
2503 window moves other cursorbound windows (windows that also have
2504 this option set) move their cursors to the corresponding line and
2505 column. This option is useful for viewing the
2506 differences between two versions of a file (see 'diff'); in diff mode,
2507 inserted and deleted lines (though not characters within a line) are
Bram Moolenaar1a384422010-07-14 19:53:30 +02002508 taken into account.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002509
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002510
2511 *'cursorcolumn'* *'cuc'* *'nocursorcolumn'* *'nocuc'*
2512'cursorcolumn' 'cuc' 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}
2516 Highlight the screen column of the cursor with CursorColumn
2517 |hl-CursorColumn|. Useful to align text. Will make screen redrawing
2518 slower.
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00002519 If you only want the highlighting in the current window you can use
2520 these autocommands: >
2521 au WinLeave * set nocursorline nocursorcolumn
2522 au WinEnter * set cursorline cursorcolumn
2523<
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002524
2525 *'cursorline'* *'cul'* *'nocursorline'* *'nocul'*
2526'cursorline' 'cul' boolean (default off)
2527 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02002528 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002529 feature}
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002530 Highlight the text line of the cursor with CursorLine |hl-CursorLine|.
2531 Useful to easily spot the cursor. Will make screen redrawing slower.
Bram Moolenaare2f98b92006-03-29 21:18:24 +00002532 When Visual mode is active the highlighting isn't used to make it
Bram Moolenaar779b74b2006-04-10 14:55:34 +00002533 easier to see the selected text.
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002534
2535
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002536 *'cursorlineopt'* *'culopt'*
Bram Moolenaar017ba072019-09-14 21:01:23 +02002537'cursorlineopt' 'culopt' string (default: "number,line")
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002538 local to window
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002539 {not available when compiled without the |+syntax|
2540 feature}
Bram Moolenaar017ba072019-09-14 21:01:23 +02002541 Comma separated list of settings for how 'cursorline' is displayed.
2542 Valid values:
2543 "line" Highlight the text line of the cursor with
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002544 CursorLine |hl-CursorLine|.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002545 "screenline" Highlight only the screen line of the cursor with
2546 CursorLine |hl-CursorLine|.
2547 "number" Highlight the line number of the cursor with
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002548 CursorLineNr |hl-CursorLineNr|.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002549
2550 Special value:
2551 "both" Alias for the values "line,number".
2552
2553 "line" and "screenline" cannot be used together.
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002554
2555
Bram Moolenaar071d4272004-06-13 20:20:40 +00002556 *'debug'*
2557'debug' string (default "")
2558 global
Bram Moolenaar57657d82006-04-21 22:12:41 +00002559 These values can be used:
2560 msg Error messages that would otherwise be omitted will be given
2561 anyway.
2562 throw Error messages that would otherwise be omitted will be given
2563 anyway and also throw an exception and set |v:errmsg|.
2564 beep A message will be given when otherwise only a beep would be
2565 produced.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002566 The values can be combined, separated by a comma.
Bram Moolenaar57657d82006-04-21 22:12:41 +00002567 "msg" and "throw" are useful for debugging 'foldexpr', 'formatexpr' or
2568 'indentexpr'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002569
2570 *'define'* *'def'*
2571'define' 'def' string (default "^\s*#\s*define")
2572 global or local to buffer |global-local|
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002573 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002574 pattern, just like for the "/" command. This option is used for the
2575 commands like "[i" and "[d" |include-search|. The 'isident' option is
2576 used to recognize the defined name after the match:
2577 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2578 See |option-backslash| about inserting backslashes to include a space
2579 or backslash.
2580 The default value is for C programs. For C++ this value would be
2581 useful, to include const type declarations: >
2582 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
Bram Moolenaar63b74a82019-03-24 15:09:13 +01002583< You can also use "\ze" just before the name and continue the pattern
2584 to check what is following. E.g. for Javascript, if a function is
2585 defined with "func_name = function(args)": >
2586 ^\s*\ze\i\+\s*=\s*function(
2587< If the function is defined with "func_name : function() {...": >
2588 ^\s*\ze\i\+\s*[:]\s*(*function\s*(
Bram Moolenaar071d4272004-06-13 20:20:40 +00002589< When using the ":set" command, you need to double the backslashes!
Bram Moolenaar63b74a82019-03-24 15:09:13 +01002590 To avoid that use `:let` with a single quote string: >
2591 let &l:define = '^\s*\ze\k\+\s*=\s*function('
Bram Moolenaar911ead12019-04-21 00:03:35 +02002592<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002593
2594 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2595'delcombine' 'deco' boolean (default off)
2596 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002597 If editing Unicode and this option is set, backspace and Normal mode
2598 "x" delete each combining character on its own. When it is off (the
2599 default) the character along with its combining characters are
2600 deleted.
Bram Moolenaar4f4d51a2020-10-11 13:57:40 +02002601 Note: When 'delcombine' is set "xx" may work differently from "2x"!
Bram Moolenaar071d4272004-06-13 20:20:40 +00002602
2603 This is useful for Arabic, Hebrew and many other languages where one
2604 may have combining characters overtop of base characters, and want
2605 to remove only the combining ones.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002606 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002607
2608 *'dictionary'* *'dict'*
2609'dictionary' 'dict' string (default "")
2610 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002611 List of file names, separated by commas, that are used to lookup words
2612 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2613 contain a list of words. This can be one word per line, or several
2614 words per line, separated by non-keyword characters (white space is
2615 preferred). Maximum line length is 510 bytes.
Bram Moolenaar259f26a2018-05-15 22:25:40 +02002616
2617 When this option is empty or an entry "spell" is present, and spell
2618 checking is enabled, words in the word lists for the currently active
2619 'spelllang' are used. See |spell|.
2620
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002621 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002622 after a comma are ignored, otherwise spaces are included in the file
2623 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002624 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002625 Where to find a list of words?
2626 - On FreeBSD, there is the file "/usr/share/dict/words".
2627 - In the Simtel archive, look in the "msdos/linguist" directory.
2628 - In "miscfiles" of the GNU collection.
2629 The use of |:set+=| and |:set-=| is preferred when adding or removing
2630 directories from the list. This avoids problems when a future version
2631 uses another default.
2632 Backticks cannot be used in this option for security reasons.
2633
2634 *'diff'* *'nodiff'*
2635'diff' boolean (default off)
2636 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00002637 {not available when compiled without the |+diff|
2638 feature}
2639 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002640 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002641
2642 *'dex'* *'diffexpr'*
2643'diffexpr' 'dex' string (default "")
2644 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002645 {not available when compiled without the |+diff|
2646 feature}
Bram Moolenaare828b762018-09-10 17:51:58 +02002647 Expression which is evaluated to obtain a diff file (either ed-style
2648 or unified-style) from two versions of a file. See |diff-diffexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002649 This option cannot be set from a |modeline| or in the |sandbox|, for
2650 security reasons.
2651
2652 *'dip'* *'diffopt'*
Bram Moolenaarc8234772019-11-10 21:00:27 +01002653'diffopt' 'dip' string (default "internal,filler,closeoff")
Bram Moolenaar071d4272004-06-13 20:20:40 +00002654 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002655 {not available when compiled without the |+diff|
2656 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002657 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002658 All are optional. Items must be separated by a comma.
2659
2660 filler Show filler lines, to keep the text
2661 synchronized with a window that has inserted
2662 lines at the same position. Mostly useful
2663 when windows are side-by-side and 'scrollbind'
2664 is set.
2665
2666 context:{n} Use a context of {n} lines between a change
2667 and a fold that contains unchanged lines.
2668 When omitted a context of six lines is used.
Bram Moolenaarf6b40102019-02-22 15:24:03 +01002669 When using zero the context is actually one,
2670 since folds require a line in between, also
2671 for a deleted line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002672 See |fold-diff|.
2673
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002674 iblank Ignore changes where lines are all blank. Adds
2675 the "-B" flag to the "diff" command if
2676 'diffexpr' is empty. Check the documentation
2677 of the "diff" command for what this does
2678 exactly.
2679 NOTE: the diff windows will get out of sync,
2680 because no differences between blank lines are
2681 taken into account.
2682
Bram Moolenaar071d4272004-06-13 20:20:40 +00002683 icase Ignore changes in case of text. "a" and "A"
2684 are considered the same. Adds the "-i" flag
2685 to the "diff" command if 'diffexpr' is empty.
2686
2687 iwhite Ignore changes in amount of white space. Adds
2688 the "-b" flag to the "diff" command if
2689 'diffexpr' is empty. Check the documentation
2690 of the "diff" command for what this does
2691 exactly. It should ignore adding trailing
2692 white space, but not leading white space.
2693
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002694 iwhiteall Ignore all white space changes. Adds
2695 the "-w" flag to the "diff" command if
2696 'diffexpr' is empty. Check the documentation
2697 of the "diff" command for what this does
2698 exactly.
2699
2700 iwhiteeol Ignore white space changes at end of line.
2701 Adds the "-Z" flag to the "diff" command if
2702 'diffexpr' is empty. Check the documentation
2703 of the "diff" command for what this does
2704 exactly.
2705
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002706 horizontal Start diff mode with horizontal splits (unless
2707 explicitly specified otherwise).
2708
2709 vertical Start diff mode with vertical splits (unless
2710 explicitly specified otherwise).
2711
Bram Moolenaarc8234772019-11-10 21:00:27 +01002712 closeoff When a window is closed where 'diff' is set
2713 and there is only one window remaining in the
2714 same tab page with 'diff' set, execute
2715 `:diffoff` in that window. This undoes a
2716 `:diffsplit` command.
2717
Bram Moolenaar97ce4192017-12-01 20:35:58 +01002718 hiddenoff Do not use diff mode for a buffer when it
2719 becomes hidden.
2720
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002721 foldcolumn:{n} Set the 'foldcolumn' option to {n} when
2722 starting diff mode. Without this 2 is used.
2723
Bram Moolenaar4223d432021-02-10 13:18:17 +01002724 followwrap Follow the 'wrap' option and leave as it is.
2725
Bram Moolenaare828b762018-09-10 17:51:58 +02002726 internal Use the internal diff library. This is
2727 ignored when 'diffexpr' is set. *E960*
2728 When running out of memory when writing a
2729 buffer this item will be ignored for diffs
2730 involving that buffer. Set the 'verbose'
2731 option to see when this happens.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002732
Bram Moolenaare828b762018-09-10 17:51:58 +02002733 indent-heuristic
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01002734 Use the indent heuristic for the internal
2735 diff library.
Bram Moolenaare828b762018-09-10 17:51:58 +02002736
2737 algorithm:{text} Use the specified diff algorithm with the
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01002738 internal diff engine. Currently supported
Bram Moolenaare828b762018-09-10 17:51:58 +02002739 algorithms are:
2740 myers the default algorithm
2741 minimal spend extra time to generate the
2742 smallest possible diff
2743 patience patience diff algorithm
2744 histogram histogram diff algorithm
2745
2746 Examples: >
2747 :set diffopt=internal,filler,context:4
Bram Moolenaar071d4272004-06-13 20:20:40 +00002748 :set diffopt=
Bram Moolenaare828b762018-09-10 17:51:58 +02002749 :set diffopt=internal,filler,foldcolumn:3
2750 :set diffopt-=internal " do NOT use the internal diff parser
Bram Moolenaar071d4272004-06-13 20:20:40 +00002751<
2752 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
2753'digraph' 'dg' boolean (default off)
2754 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002755 {not available when compiled without the |+digraphs|
2756 feature}
2757 Enable the entering of digraphs in Insert mode with {char1} <BS>
2758 {char2}. See |digraphs|.
2759 NOTE: This option is reset when 'compatible' is set.
2760
2761 *'directory'* *'dir'*
2762'directory' 'dir' string (default for Amiga: ".,t:",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01002763 for Win32: ".,$TEMP,c:\tmp,c:\temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00002764 for Unix: ".,~/tmp,/var/tmp,/tmp")
2765 global
2766 List of directory names for the swap file, separated with commas.
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02002767 Recommended value: ".,~/vimswap//" - this will put the swap file next
2768 to the edited file if possible, and in your personal swap directory
2769 otherwise. Make sure "~/vimswap//" is only readable for you.
2770
2771 Possible items:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002772 - The swap file will be created in the first directory where this is
2773 possible.
2774 - Empty means that no swap file will be used (recovery is
Bram Moolenaar00e192b2019-10-19 17:01:28 +02002775 impossible!) and no |E303| error will be given.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002776 - A directory "." means to put the swap file in the same directory as
2777 the edited file. On Unix, a dot is prepended to the file name, so
2778 it doesn't show in a directory listing. On MS-Windows the "hidden"
2779 attribute is set and a dot prepended if possible.
Bram Moolenaar8024f932020-01-14 19:29:13 +01002780 - A directory starting with "./" (or ".\" for MS-Windows) means to put
2781 the swap file relative to where the edited file is. The leading "."
2782 is replaced with the path name of the edited file.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02002783 - For Unix and Win32, if a directory ends in two path separators "//",
2784 the swap file name will be built from the complete path to the file
Bram Moolenaar207f0092020-08-30 17:20:20 +02002785 with all path separators replaced by percent '%' signs (including
2786 the colon following the drive letter on Win32). This will ensure
2787 file name uniqueness in the preserve directory.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02002788 On Win32, it is also possible to end with "\\". However, When a
2789 separating comma is following, you must use "//", since "\\" will
2790 include the comma in the file name. Therefore it is recommended to
2791 use '//', instead of '\\'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002792 - Spaces after the comma are ignored, other spaces are considered part
2793 of the directory name. To have a space at the start of a directory
2794 name, precede it with a backslash.
2795 - To include a comma in a directory name precede it with a backslash.
2796 - A directory name may end in an ':' or '/'.
2797 - Environment variables are expanded |:set_env|.
2798 - Careful with '\' characters, type one before a space, type two to
2799 get one in the option (see |option-backslash|), for example: >
2800 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
2801< - For backwards compatibility with Vim version 3.0 a '>' at the start
2802 of the option is removed.
2803 Using "." first in the list is recommended. This means that editing
2804 the same file twice will result in a warning. Using "/tmp" on Unix is
2805 discouraged: When the system crashes you lose the swap file.
2806 "/var/tmp" is often not cleared when rebooting, thus is a better
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02002807 choice than "/tmp". But others on the computer may be able to see the
2808 files, and it can contain a lot of files, your swap files get lost in
2809 the crowd. That is why a "tmp" directory in your home directory is
2810 tried first.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002811 The use of |:set+=| and |:set-=| is preferred when adding or removing
2812 directories from the list. This avoids problems when a future version
2813 uses another default.
2814 This option cannot be set from a |modeline| or in the |sandbox|, for
2815 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002816
2817 *'display'* *'dy'*
Bram Moolenaarbc8801c2016-08-02 21:04:33 +02002818'display' 'dy' string (default "", set to "truncate" in
2819 |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002820 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002821 Change the way text is displayed. This is comma separated list of
2822 flags:
2823 lastline When included, as much as possible of the last line
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02002824 in a window will be displayed. "@@@" is put in the
2825 last columns of the last screen line to indicate the
2826 rest of the line is not displayed.
2827 truncate Like "lastline", but "@@@" is displayed in the first
2828 column of the last screen line. Overrules "lastline".
Bram Moolenaar071d4272004-06-13 20:20:40 +00002829 uhex Show unprintable characters hexadecimal as <xx>
2830 instead of using ^C and ~C.
2831
Bram Moolenaard0796902016-09-16 20:02:31 +02002832 When neither "lastline" nor "truncate" is included, a last line that
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02002833 doesn't fit is replaced with "@" lines.
2834
Bram Moolenaar071d4272004-06-13 20:20:40 +00002835 *'eadirection'* *'ead'*
2836'eadirection' 'ead' string (default "both")
2837 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002838 Tells when the 'equalalways' option applies:
2839 ver vertically, width of windows is not affected
2840 hor horizontally, height of windows is not affected
2841 both width and height of windows is affected
2842
2843 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
2844'edcompatible' 'ed' boolean (default off)
2845 global
2846 Makes the 'g' and 'c' flags of the ":substitute" command to be
2847 toggled each time the flag is given. See |complex-change|. See
2848 also 'gdefault' option.
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +02002849 Switching this option on may break plugins!
Bram Moolenaar4072ba52020-12-23 13:56:35 +01002850 This option is not used in |Vim9| script.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002851
Bram Moolenaar03413f42016-04-12 21:07:15 +02002852 *'emoji'* *'emo'* *'noemoji'* *'noemo'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01002853'emoji' 'emo' boolean (default: on)
2854 global
Bram Moolenaar3848e002016-03-19 18:42:29 +01002855 When on all Unicode emoji characters are considered to be full width.
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02002856 This excludes "text emoji" characters, which are normally displayed as
2857 single width. Unfortunately there is no good specification for this
2858 and it has been determined on trial-and-error basis. Use the
2859 |setcellwidths()| function to change the behavior.
Bram Moolenaar3848e002016-03-19 18:42:29 +01002860
Bram Moolenaar071d4272004-06-13 20:20:40 +00002861 *'encoding'* *'enc'* *E543*
K.Takataf883d902021-05-30 18:04:19 +02002862'encoding' 'enc' string (default for MS-Windows: "utf-8",
2863 otherwise: value from $LANG or "latin1")
Bram Moolenaar071d4272004-06-13 20:20:40 +00002864 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002865 Sets the character encoding used inside Vim. It applies to text in
2866 the buffers, registers, Strings in expressions, text stored in the
2867 viminfo file, etc. It sets the kind of characters which Vim can work
2868 with. See |encoding-names| for the possible values.
2869
2870 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002871 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002872 It should normally be kept at its default value, or set when Vim
Bram Moolenaar02467872007-05-06 13:22:01 +00002873 starts up. See |multibyte|. To reload the menus see |:menutrans|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002874
Bram Moolenaar865242e2010-07-14 21:12:05 +02002875 This option cannot be set from a |modeline|. It would most likely
2876 corrupt the text.
2877
Bram Moolenaar3df01732017-02-17 22:47:16 +01002878 NOTE: For GTK+ 2 or later, it is highly recommended to set 'encoding'
2879 to "utf-8". Although care has been taken to allow different values of
Bram Moolenaar071d4272004-06-13 20:20:40 +00002880 'encoding', "utf-8" is the natural choice for the environment and
2881 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002882 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00002883 versions, and to avoid changing the encoding of newly created files
2884 without your knowledge (in case 'fileencodings' is empty).
2885
2886 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002887 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00002888 iconv() or as specified with 'charconvert'.
2889
Bram Moolenaar207f0092020-08-30 17:20:20 +02002890 If you need to know whether 'encoding' is a multibyte encoding, you
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002891 can use: >
2892 if has("multi_byte_encoding")
2893<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002894 Normally 'encoding' will be equal to your current locale. This will
2895 be the default if Vim recognizes your environment settings. If
2896 'encoding' is not set to the current locale, 'termencoding' must be
2897 set to convert typed and displayed text. See |encoding-table|.
2898
2899 When you set this option, it fires the |EncodingChanged| autocommand
2900 event so that you can set up fonts if necessary.
2901
2902 When the option is set, the value is converted to lowercase. Thus
2903 you can set it with uppercase values too. Underscores are translated
2904 to '-' signs.
2905 When the encoding is recognized, it is changed to the standard name.
2906 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
2907 "iso-8859-2" and "utf8" becomes "utf-8".
2908
2909 Note: "latin1" is also used when the encoding could not be detected.
2910 This only works when editing files in the same encoding! When the
2911 actual character set is not latin1, make sure 'fileencoding' and
2912 'fileencodings' are empty. When conversion is needed, switch to using
2913 utf-8.
2914
2915 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
2916 You don't notice this while editing, but it does matter for the
2917 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
2918 setting 'encoding' to one of these values instead of utf-8 only has
2919 effect for encoding used for files when 'fileencoding' is empty.
2920
Bram Moolenaar661b1822005-07-28 22:36:45 +00002921 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
2922 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002923
2924 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
2925'endofline' 'eol' boolean (default on)
2926 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002927 When writing a file and this option is off and the 'binary' option
Bram Moolenaar34d72d42015-07-17 14:18:08 +02002928 is on, or 'fixeol' option is off, no <EOL> will be written for the
2929 last line in the file. This option is automatically set or reset when
2930 starting to edit a new file, depending on whether file has an <EOL>
2931 for the last line in the file. Normally you don't have to set or
2932 reset this option.
2933 When 'binary' is off and 'fixeol' is on the value is not used when
2934 writing the file. When 'binary' is on or 'fixeol' is off it is used
2935 to remember the presence of a <EOL> for the last line in the file, so
2936 that when you write the file the situation from the original file can
2937 be kept. But you can change it if you want to.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002938
2939 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
2940'equalalways' 'ea' boolean (default on)
2941 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002942 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00002943 splitting or closing a window. This also happens the moment the
2944 option is switched on. When off, splitting a window will reduce the
2945 size of the current window and leave the other windows the same. When
2946 closing a window the extra lines are given to the window next to it
2947 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00002948 When mixing vertically and horizontally split windows, a minimal size
2949 is computed and some windows may be larger if there is room. The
2950 'eadirection' option tells in which direction the size is affected.
Bram Moolenaar67f71312007-08-12 14:55:56 +00002951 Changing the height and width of a window can be avoided by setting
2952 'winfixheight' and 'winfixwidth', respectively.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002953 If a window size is specified when creating a new window sizes are
2954 currently not equalized (it's complicated, but may be implemented in
2955 the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002956
2957 *'equalprg'* *'ep'*
2958'equalprg' 'ep' string (default "")
2959 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002960 External program to use for "=" command. When this option is empty
Bram Moolenaar446cb832008-06-24 21:56:24 +00002961 the internal formatting functions are used; either 'lisp', 'cindent'
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002962 or 'indentexpr'. When Vim was compiled without internal formatting,
2963 the "indent" program is used.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002964 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002965 about including spaces and backslashes.
2966 This option cannot be set from a |modeline| or in the |sandbox|, for
2967 security reasons.
2968
2969 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
2970'errorbells' 'eb' boolean (default off)
2971 global
2972 Ring the bell (beep or screen flash) for error messages. This only
2973 makes a difference for error messages, the bell will be used always
2974 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002975 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar165bc692015-07-21 17:53:25 +02002976 screen flash or do nothing. See 'belloff' to finetune when to ring the
2977 bell.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002978
2979 *'errorfile'* *'ef'*
2980'errorfile' 'ef' string (Amiga default: "AztecC.Err",
2981 others: "errors.err")
2982 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002983 {not available when compiled without the |+quickfix|
2984 feature}
2985 Name of the errorfile for the QuickFix mode (see |:cf|).
2986 When the "-q" command-line argument is used, 'errorfile' is set to the
2987 following argument. See |-q|.
2988 NOT used for the ":make" command. See 'makeef' for that.
2989 Environment variables are expanded |:set_env|.
2990 See |option-backslash| about including spaces and backslashes.
2991 This option cannot be set from a |modeline| or in the |sandbox|, for
2992 security reasons.
2993
2994 *'errorformat'* *'efm'*
2995'errorformat' 'efm' string (default is very long)
2996 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002997 {not available when compiled without the |+quickfix|
2998 feature}
2999 Scanf-like description of the format for the lines in the error file
3000 (see |errorformat|).
3001
3002 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
3003'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
3004 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003005 Function keys that start with an <Esc> are recognized in Insert
3006 mode. When this option is off, the cursor and function keys cannot be
3007 used in Insert mode if they start with an <Esc>. The advantage of
3008 this is that the single <Esc> is recognized immediately, instead of
3009 after one second. Instead of resetting this option, you might want to
3010 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
3011 when 'esckeys' is off, you can still map anything, but the cursor keys
3012 won't work by default.
3013 NOTE: This option is set to the Vi default value when 'compatible' is
3014 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaarc8234772019-11-10 21:00:27 +01003015 NOTE: when this option is off then the |modifyOtherKeys| functionality
3016 is disabled while in Insert mode to avoid ending Insert mode with any
3017 key that has a modifier.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003018
3019 *'eventignore'* *'ei'*
3020'eventignore' 'ei' string (default "")
3021 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003022 A list of autocommand event names, which are to be ignored.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00003023 When set to "all" or when "all" is one of the items, all autocommand
3024 events are ignored, autocommands will not be executed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003025 Otherwise this is a comma separated list of event names. Example: >
3026 :set ei=WinEnter,WinLeave
3027<
3028 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
3029'expandtab' 'et' boolean (default off)
3030 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003031 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003032 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00003033 when 'autoindent' is on. To insert a real tab when 'expandtab' is
3034 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
Bram Moolenaarca635012015-09-25 20:34:21 +02003035 This option is reset when the 'paste' option is set and restored when
3036 the 'paste' option is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003037 NOTE: This option is reset when 'compatible' is set.
3038
3039 *'exrc'* *'ex'* *'noexrc'* *'noex'*
3040'exrc' 'ex' boolean (default off)
3041 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003042 Enables the reading of .vimrc, .exrc and .gvimrc in the current
Bram Moolenaar36f44c22016-08-28 18:17:20 +02003043 directory.
3044
3045 Setting this option is a potential security leak. E.g., consider
3046 unpacking a package or fetching files from github, a .vimrc in there
3047 might be a trojan horse. BETTER NOT SET THIS OPTION!
3048 Instead, define an autocommand in your .vimrc to set options for a
3049 matching directory.
3050
3051 If you do switch this option on you should also consider setting the
3052 'secure' option (see |initialization|).
3053 Also see |.vimrc| and |gui-init|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003054 This option cannot be set from a |modeline| or in the |sandbox|, for
3055 security reasons.
3056
3057 *'fileencoding'* *'fenc'* *E213*
3058'fileencoding' 'fenc' string (default: "")
3059 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003060 Sets the character encoding for the file of this buffer.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003061
Bram Moolenaar071d4272004-06-13 20:20:40 +00003062 When 'fileencoding' is different from 'encoding', conversion will be
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003063 done when writing the file. For reading see below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003064 When 'fileencoding' is empty, the same value as 'encoding' will be
3065 used (no conversion when reading or writing a file).
Bram Moolenaar214641f2017-03-05 17:04:09 +01003066 No error will be given when the value is set, only when it is used,
3067 only when writing a file.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003068 Conversion will also be done when 'encoding' and 'fileencoding' are
3069 both a Unicode encoding and 'fileencoding' is not utf-8. That's
3070 because internally Unicode is always stored as utf-8.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003071 WARNING: Conversion can cause loss of information! When
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003072 'encoding' is "utf-8" or another Unicode encoding, conversion
3073 is most likely done in a way that the reverse conversion
3074 results in the same text. When 'encoding' is not "utf-8" some
3075 characters may be lost!
Bram Moolenaar865242e2010-07-14 21:12:05 +02003076
Bram Moolenaar071d4272004-06-13 20:20:40 +00003077 See 'encoding' for the possible values. Additionally, values may be
3078 specified that can be handled by the converter, see
3079 |mbyte-conversion|.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003080
Bram Moolenaar071d4272004-06-13 20:20:40 +00003081 When reading a file 'fileencoding' will be set from 'fileencodings'.
3082 To read a file in a certain encoding it won't work by setting
Bram Moolenaar02467872007-05-06 13:22:01 +00003083 'fileencoding', use the |++enc| argument. One exception: when
3084 'fileencodings' is empty the value of 'fileencoding' is used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003085 For a new file the global value of 'fileencoding' is used.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003086
Bram Moolenaar071d4272004-06-13 20:20:40 +00003087 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
3088 When the option is set, the value is converted to lowercase. Thus
3089 you can set it with uppercase values too. '_' characters are
3090 replaced with '-'. If a name is recognized from the list for
3091 'encoding', it is replaced by the standard name. For example
3092 "ISO8859-2" becomes "iso-8859-2".
Bram Moolenaar865242e2010-07-14 21:12:05 +02003093
Bram Moolenaar071d4272004-06-13 20:20:40 +00003094 When this option is set, after starting to edit a file, the 'modified'
3095 option is set, because the file would be different when written.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003096
3097 Keep in mind that changing 'fenc' from a modeline happens
3098 AFTER the text has been read, thus it applies to when the file will be
3099 written. If you do set 'fenc' in a modeline, you might want to set
3100 'nomodified' to avoid not being able to ":q".
3101
Bram Moolenaar071d4272004-06-13 20:20:40 +00003102 This option can not be changed when 'modifiable' is off.
3103
3104 *'fe'*
3105 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003106 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003107 old short name was 'fe', which is no longer used.
3108
3109 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003110'fileencodings' 'fencs' string (default: "ucs-bom",
3111 "ucs-bom,utf-8,default,latin1" when
3112 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003113 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003114 This is a list of character encodings considered when starting to edit
3115 an existing file. When a file is read, Vim tries to use the first
3116 mentioned character encoding. If an error is detected, the next one
3117 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003118 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00003119 an empty string, which means the value of 'encoding' is used.
3120 WARNING: Conversion can cause loss of information! When
3121 'encoding' is "utf-8" (or one of the other Unicode variants)
3122 conversion is most likely done in a way that the reverse
3123 conversion results in the same text. When 'encoding' is not
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003124 "utf-8" some non-ASCII characters may be lost! You can use
3125 the |++bad| argument to specify what is done with characters
3126 that can't be converted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003127 For an empty file or a file with only ASCII characters most encodings
3128 will work and the first entry of 'fileencodings' will be used (except
3129 "ucs-bom", which requires the BOM to be present). If you prefer
3130 another encoding use an BufReadPost autocommand event to test if your
3131 preferred encoding is to be used. Example: >
3132 au BufReadPost * if search('\S', 'w') == 0 |
3133 \ set fenc=iso-2022-jp | endif
3134< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
3135 non-blank characters.
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003136 When the |++enc| argument is used then the value of 'fileencodings' is
3137 not used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003138 Note that 'fileencodings' is not used for a new file, the global value
3139 of 'fileencoding' is used instead. You can set it with: >
3140 :setglobal fenc=iso-8859-2
3141< This means that a non-existing file may get a different encoding than
3142 an empty file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003143 The special value "ucs-bom" can be used to check for a Unicode BOM
3144 (Byte Order Mark) at the start of the file. It must not be preceded
3145 by "utf-8" or another Unicode encoding for this to work properly.
3146 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
3147 because Vim cannot detect an error, thus the encoding is always
3148 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003149 The special value "default" can be used for the encoding from the
K.Takataef8706f2021-05-31 18:40:49 +02003150 environment. On MS-Windows this is the system encoding. Otherwise
3151 this is the default value for 'encoding'. It is useful when
3152 'encoding' is set to "utf-8" and your environment uses a non-latin1
3153 encoding, such as Russian.
Bram Moolenaarca003e12006-03-17 23:19:38 +00003154 When 'encoding' is "utf-8" and a file contains an illegal byte
3155 sequence it won't be recognized as UTF-8. You can use the |8g8|
3156 command to find the illegal byte sequence.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003157 WRONG VALUES: WHAT'S WRONG:
3158 latin1,utf-8 "latin1" will always be used
3159 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
3160 file
3161 cp1250,latin1 "cp1250" will always be used
3162 If 'fileencodings' is empty, 'fileencoding' is not modified.
3163 See 'fileencoding' for the possible values.
3164 Setting this option does not have an effect until the next time a file
3165 is read.
3166
3167 *'fileformat'* *'ff'*
Bram Moolenaar00590742019-02-15 21:06:09 +01003168'fileformat' 'ff' string (MS-Windows default: "dos",
3169 Unix, macOS default: "unix")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003170 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003171 This gives the <EOL> of the current buffer, which is used for
3172 reading/writing the buffer from/to a file:
Bram Moolenaar4072ba52020-12-23 13:56:35 +01003173 dos <CR><NL>
Bram Moolenaar071d4272004-06-13 20:20:40 +00003174 unix <NL>
3175 mac <CR>
3176 When "dos" is used, CTRL-Z at the end of a file is ignored.
3177 See |file-formats| and |file-read|.
3178 For the character encoding of the file see 'fileencoding'.
3179 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
Bram Moolenaarbf884932013-04-05 22:26:15 +02003180 works like it was set to "unix".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003181 This option is set automatically when starting to edit a file and
3182 'fileformats' is not empty and 'binary' is off.
3183 When this option is set, after starting to edit a file, the 'modified'
3184 option is set, because the file would be different when written.
3185 This option can not be changed when 'modifiable' is off.
3186 For backwards compatibility: When this option is set to "dos",
3187 'textmode' is set, otherwise 'textmode' is reset.
3188
3189 *'fileformats'* *'ffs'*
3190'fileformats' 'ffs' string (default:
Bram Moolenaar00590742019-02-15 21:06:09 +01003191 Vim+Vi MS-Windows: "dos,unix",
3192 Vim Unix, macOS: "unix,dos",
Bram Moolenaar071d4272004-06-13 20:20:40 +00003193 Vi Cygwin: "unix,dos",
3194 Vi others: "")
3195 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003196 This gives the end-of-line (<EOL>) formats that will be tried when
3197 starting to edit a new buffer and when reading a file into an existing
3198 buffer:
3199 - When empty, the format defined with 'fileformat' will be used
3200 always. It is not set automatically.
3201 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003202 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003203 'fileformats' name will be used when a file is read into an existing
3204 buffer, no matter what 'fileformat' for that buffer is set to.
3205 - When more than one name is present, separated by commas, automatic
3206 <EOL> detection will be done when reading a file. When starting to
3207 edit a file, a check is done for the <EOL>:
3208 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
3209 'fileformat' is set to "dos".
3210 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003211 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003212 preceding <CR>, "unix" is preferred over "dos".
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01003213 3. If 'fileformat' has not yet been set, and if a <CR> is found, and
3214 if 'fileformats' includes "mac", 'fileformat' is set to "mac".
Bram Moolenaar00659062010-09-21 22:34:02 +02003215 This means that "mac" is only chosen when:
3216 "unix" is not present or no <NL> is found in the file, and
3217 "dos" is not present or no <CR><NL> is found in the file.
3218 Except: if "unix" was chosen, but there is a <CR> before
3219 the first <NL>, and there appear to be more <CR>s than <NL>s in
Bram Moolenaar166af9b2010-11-16 20:34:40 +01003220 the first few lines, "mac" is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003221 4. If 'fileformat' is still not set, the first name from
3222 'fileformats' is used.
3223 When reading a file into an existing buffer, the same is done, but
3224 this happens like 'fileformat' has been set appropriately for that
3225 file only, the option is not changed.
3226 When 'binary' is set, the value of 'fileformats' is not used.
3227
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01003228 When Vim starts up with an empty buffer the first item is used. You
3229 can overrule this by setting 'fileformat' in your .vimrc.
Bram Moolenaar81af9252010-12-10 20:35:50 +01003230
Bram Moolenaar071d4272004-06-13 20:20:40 +00003231 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
3232 are ":source"ed and for vimrc files, automatic <EOL> detection may be
3233 done:
3234 - When 'fileformats' is empty, there is no automatic detection. Dos
3235 format will be used.
3236 - When 'fileformats' is set to one or more names, automatic detection
3237 is done. This is based on the first <NL> in the file: If there is a
3238 <CR> in front of it, Dos format is used, otherwise Unix format is
3239 used.
3240 Also see |file-formats|.
3241 For backwards compatibility: When this option is set to an empty
3242 string or one format (no comma is included), 'textauto' is reset,
3243 otherwise 'textauto' is set.
3244 NOTE: This option is set to the Vi default value when 'compatible' is
3245 set and to the Vim default value when 'compatible' is reset.
3246
Bram Moolenaarbf884932013-04-05 22:26:15 +02003247 *'fileignorecase'* *'fic'* *'nofileignorecase'* *'nofic'*
3248'fileignorecase' 'fic' boolean (default on for systems where case in file
3249 names is normally ignored)
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003250 global
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003251 When set case is ignored when using file names and directories.
3252 See 'wildignorecase' for only ignoring case when doing completion.
3253
Bram Moolenaar071d4272004-06-13 20:20:40 +00003254 *'filetype'* *'ft'*
3255'filetype' 'ft' string (default: "")
3256 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003257 When this option is set, the FileType autocommand event is triggered.
3258 All autocommands that match with the value of this option will be
3259 executed. Thus the value of 'filetype' is used in place of the file
3260 name.
3261 Otherwise this option does not always reflect the current file type.
3262 This option is normally set when the file type is detected. To enable
3263 this use the ":filetype on" command. |:filetype|
3264 Setting this option to a different value is most useful in a modeline,
3265 for a file for which the file type is not automatically recognized.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003266 Example, for in an IDL file:
3267 /* vim: set filetype=idl : */ ~
3268 |FileType| |filetypes|
3269 When a dot appears in the value then this separates two filetype
3270 names. Example:
3271 /* vim: set filetype=c.doxygen : */ ~
3272 This will use the "c" filetype first, then the "doxygen" filetype.
3273 This works both for filetype plugins and for syntax files. More than
3274 one dot may appear.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003275 This option is not copied to another buffer, independent of the 's' or
3276 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003277 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003278
3279 *'fillchars'* *'fcs'*
Bram Moolenaara98f8a22021-02-13 18:24:23 +01003280'fillchars' 'fcs' string (default "vert:|,fold:-,eob:~")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003281 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02003282 {not available when compiled without the |+folding|
3283 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003284 Characters to fill the statuslines and vertical separators.
3285 It is a comma separated list of items:
3286
3287 item default Used for ~
3288 stl:c ' ' or '^' statusline of the current window
Bram Moolenaar38a55632016-02-15 22:07:32 +01003289 stlnc:c ' ' or '=' statusline of the non-current windows
Bram Moolenaar071d4272004-06-13 20:20:40 +00003290 vert:c '|' vertical separators |:vsplit|
3291 fold:c '-' filling 'foldtext'
Bram Moolenaar3aca5a62021-02-17 13:14:07 +01003292 foldopen:c '-' mark the beginning of a fold
3293 foldclose:c '+' show a closed fold
3294 foldsep:c '|' open fold middle character
Bram Moolenaar071d4272004-06-13 20:20:40 +00003295 diff:c '-' deleted lines of the 'diff' option
Bram Moolenaara98f8a22021-02-13 18:24:23 +01003296 eob:c '~' empty lines below the end of a buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003297
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003298 Any one that is omitted will fall back to the default. For "stl" and
Bram Moolenaar38a55632016-02-15 22:07:32 +01003299 "stlnc" the space will be used when there is highlighting, '^' or '='
Bram Moolenaar071d4272004-06-13 20:20:40 +00003300 otherwise.
3301
3302 Example: >
Bram Moolenaar38a55632016-02-15 22:07:32 +01003303 :set fillchars=stl:^,stlnc:=,vert:\|,fold:-,diff:-
Bram Moolenaar071d4272004-06-13 20:20:40 +00003304< This is similar to the default, except that these characters will also
3305 be used when there is highlighting.
3306
Bram Moolenaar008bff92021-03-04 21:55:58 +01003307 For "stl" and "stlnc" single-byte and multibyte characters are
3308 supported. But double-width characters are not supported.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003309
Bram Moolenaar071d4272004-06-13 20:20:40 +00003310 The highlighting used for these items:
3311 item highlight group ~
3312 stl:c StatusLine |hl-StatusLine|
3313 stlnc:c StatusLineNC |hl-StatusLineNC|
3314 vert:c VertSplit |hl-VertSplit|
3315 fold:c Folded |hl-Folded|
3316 diff:c DiffDelete |hl-DiffDelete|
Bram Moolenaara98f8a22021-02-13 18:24:23 +01003317 eob:c EndOfBuffer |hl-EndOfBuffer|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003318
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003319 *'fixendofline'* *'fixeol'* *'nofixendofline'* *'nofixeol'*
3320'fixendofline' 'fixeol' boolean (default on)
3321 local to buffer
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003322 When writing a file and this option is on, <EOL> at the end of file
3323 will be restored if missing. Turn this option off if you want to
3324 preserve the situation from the original file.
3325 When the 'binary' option is set the value of this option doesn't
3326 matter.
3327 See the 'endofline' option.
3328
Bram Moolenaar071d4272004-06-13 20:20:40 +00003329 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
Bram Moolenaar98a29d02021-01-18 19:55:44 +01003330'fkmap' 'fk' boolean (default off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003331 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003332 {only available when compiled with the |+rightleft|
3333 feature}
Bram Moolenaar14184a32019-02-16 15:10:30 +01003334 This option was for using Farsi, which has been removed. See
3335 |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003336
3337 *'foldclose'* *'fcl'*
3338'foldclose' 'fcl' string (default "")
3339 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003340 {not available when compiled without the |+folding|
3341 feature}
3342 When set to "all", a fold is closed when the cursor isn't in it and
3343 its level is higher than 'foldlevel'. Useful if you want folds to
3344 automatically close when moving out of them.
3345
3346 *'foldcolumn'* *'fdc'*
3347'foldcolumn' 'fdc' number (default 0)
3348 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003349 {not available when compiled without the |+folding|
3350 feature}
3351 When non-zero, a column with the specified width is shown at the side
3352 of the window which indicates open and closed folds. The maximum
3353 value is 12.
3354 See |folding|.
3355
3356 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
3357'foldenable' 'fen' boolean (default on)
3358 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003359 {not available when compiled without the |+folding|
3360 feature}
3361 When off, all folds are open. This option can be used to quickly
3362 switch between showing all text unfolded and viewing the text with
3363 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003364 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00003365 'foldenable' is off.
3366 This option is set by commands that create a new fold or close a fold.
3367 See |folding|.
3368
3369 *'foldexpr'* *'fde'*
3370'foldexpr' 'fde' string (default: "0")
3371 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003372 {not available when compiled without the |+folding|
Bram Moolenaardb84e452010-08-15 13:50:43 +02003373 or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003374 The expression used for when 'foldmethod' is "expr". It is evaluated
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003375 for each line to obtain its fold level. See |fold-expr|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003376
Bram Moolenaar30b65812012-07-12 22:01:11 +02003377 The expression will be evaluated in the |sandbox| if set from a
3378 modeline, see |sandbox-option|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003379 This option can't be set from a |modeline| when the 'diff' option is
Bram Moolenaar110289e2019-05-23 15:38:06 +02003380 on or the 'modelineexpr' option is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003381
3382 It is not allowed to change text or jump to another window while
3383 evaluating 'foldexpr' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003384
3385 *'foldignore'* *'fdi'*
3386'foldignore' 'fdi' string (default: "#")
3387 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003388 {not available when compiled without the |+folding|
3389 feature}
3390 Used only when 'foldmethod' is "indent". Lines starting with
3391 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003392 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003393 The default "#" works well for C programs. See |fold-indent|.
3394
3395 *'foldlevel'* *'fdl'*
3396'foldlevel' 'fdl' number (default: 0)
3397 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003398 {not available when compiled without the |+folding|
3399 feature}
3400 Sets the fold level: Folds with a higher level will be closed.
3401 Setting this option to zero will close all folds. Higher numbers will
3402 close fewer folds.
3403 This option is set by commands like |zm|, |zM| and |zR|.
3404 See |fold-foldlevel|.
3405
3406 *'foldlevelstart'* *'fdls'*
3407'foldlevelstart' 'fdls' number (default: -1)
3408 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003409 {not available when compiled without the |+folding|
3410 feature}
3411 Sets 'foldlevel' when starting to edit another buffer in a window.
3412 Useful to always start editing with all folds closed (value zero),
3413 some folds closed (one) or no folds closed (99).
3414 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003415 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00003416 ignores this option and closes all folds.
3417 It is also done before BufReadPre autocommands, to allow an autocmd to
3418 overrule the 'foldlevel' value for specific files.
3419 When the value is negative, it is not used.
3420
3421 *'foldmarker'* *'fmr'* *E536*
3422'foldmarker' 'fmr' string (default: "{{{,}}}")
3423 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003424 {not available when compiled without the |+folding|
3425 feature}
3426 The start and end marker used when 'foldmethod' is "marker". There
3427 must be one comma, which separates the start and end marker. The
3428 marker is a literal string (a regular expression would be too slow).
3429 See |fold-marker|.
3430
3431 *'foldmethod'* *'fdm'*
3432'foldmethod' 'fdm' string (default: "manual")
3433 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003434 {not available when compiled without the |+folding|
3435 feature}
3436 The kind of folding used for the current window. Possible values:
3437 |fold-manual| manual Folds are created manually.
3438 |fold-indent| indent Lines with equal indent form a fold.
3439 |fold-expr| expr 'foldexpr' gives the fold level of a line.
3440 |fold-marker| marker Markers are used to specify folds.
3441 |fold-syntax| syntax Syntax highlighting items specify folds.
3442 |fold-diff| diff Fold text that is not changed.
3443
3444 *'foldminlines'* *'fml'*
3445'foldminlines' 'fml' number (default: 1)
3446 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003447 {not available when compiled without the |+folding|
3448 feature}
Bram Moolenaar00654022011-02-25 14:42:19 +01003449 Sets the number of screen lines above which a fold can be displayed
3450 closed. Also for manually closed folds. With the default value of
3451 one a fold can only be closed if it takes up two or more screen lines.
3452 Set to zero to be able to close folds of just one screen line.
Bram Moolenaar446beb42011-05-10 17:18:44 +02003453 Note that this only has an effect on what is displayed. After using
Bram Moolenaar071d4272004-06-13 20:20:40 +00003454 "zc" to close a fold, which is displayed open because it's smaller
3455 than 'foldminlines', a following "zc" may close a containing fold.
3456
3457 *'foldnestmax'* *'fdn'*
3458'foldnestmax' 'fdn' number (default: 20)
3459 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003460 {not available when compiled without the |+folding|
3461 feature}
3462 Sets the maximum nesting of folds for the "indent" and "syntax"
3463 methods. This avoids that too many folds will be created. Using more
3464 than 20 doesn't work, because the internal limit is 20.
3465
3466 *'foldopen'* *'fdo'*
3467'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
3468 search,tag,undo")
3469 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003470 {not available when compiled without the |+folding|
3471 feature}
3472 Specifies for which type of commands folds will be opened, if the
3473 command moves the cursor into a closed fold. It is a comma separated
3474 list of items.
Bram Moolenaar05365702010-10-27 18:34:44 +02003475 NOTE: When the command is part of a mapping this option is not used.
3476 Add the |zv| command to the mapping to get the same effect.
3477 (rationale: the mapping may want to control opening folds itself)
3478
Bram Moolenaar071d4272004-06-13 20:20:40 +00003479 item commands ~
3480 all any
3481 block "(", "{", "[[", "[{", etc.
3482 hor horizontal movements: "l", "w", "fx", etc.
3483 insert any command in Insert mode
3484 jump far jumps: "G", "gg", etc.
3485 mark jumping to a mark: "'m", CTRL-O, etc.
3486 percent "%"
3487 quickfix ":cn", ":crew", ":make", etc.
3488 search search for a pattern: "/", "n", "*", "gd", etc.
3489 (not for a search pattern in a ":" command)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003490 Also for |[s| and |]s|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003491 tag jumping to a tag: ":ta", CTRL-T, etc.
3492 undo undo or redo: "u" and CTRL-R
Bram Moolenaar071d4272004-06-13 20:20:40 +00003493 When a movement command is used for an operator (e.g., "dl" or "y%")
3494 this option is not used. This means the operator will include the
3495 whole closed fold.
3496 Note that vertical movements are not here, because it would make it
3497 very difficult to move onto a closed fold.
3498 In insert mode the folds containing the cursor will always be open
3499 when text is inserted.
3500 To close folds you can re-apply 'foldlevel' with the |zx| command or
3501 set the 'foldclose' option to "all".
3502
3503 *'foldtext'* *'fdt'*
3504'foldtext' 'fdt' string (default: "foldtext()")
3505 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003506 {not available when compiled without the |+folding|
3507 feature}
3508 An expression which is used to specify the text displayed for a closed
3509 fold. See |fold-foldtext|.
3510
Bram Moolenaar30b65812012-07-12 22:01:11 +02003511 The expression will be evaluated in the |sandbox| if set from a
3512 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003513 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003514
3515 It is not allowed to change text or jump to another window while
3516 evaluating 'foldtext' |textlock|.
3517
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003518 *'formatexpr'* *'fex'*
3519'formatexpr' 'fex' string (default "")
3520 local to buffer
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003521 {not available when compiled without the |+eval|
3522 feature}
3523 Expression which is evaluated to format a range of lines for the |gq|
3524 operator or automatic formatting (see 'formatoptions'). When this
3525 option is empty 'formatprg' is used.
3526
3527 The |v:lnum| variable holds the first line to be formatted.
3528 The |v:count| variable holds the number of lines to be formatted.
3529 The |v:char| variable holds the character that is going to be
3530 inserted if the expression is being evaluated due to
3531 automatic formatting. This can be empty. Don't insert
3532 it yet!
3533
3534 Example: >
3535 :set formatexpr=mylang#Format()
3536< This will invoke the mylang#Format() function in the
3537 autoload/mylang.vim file in 'runtimepath'. |autoload|
3538
3539 The expression is also evaluated when 'textwidth' is set and adding
3540 text beyond that limit. This happens under the same conditions as
3541 when internal formatting is used. Make sure the cursor is kept in the
3542 same spot relative to the text then! The |mode()| function will
3543 return "i" or "R" in this situation.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01003544
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003545 When the expression evaluates to non-zero Vim will fall back to using
3546 the internal format mechanism.
3547
3548 The expression will be evaluated in the |sandbox| when set from a
3549 modeline, see |sandbox-option|. That stops the option from working,
3550 since changing the buffer text is not allowed.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003551 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaar036986f2017-03-16 17:41:02 +01003552 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003553
Bram Moolenaar86b68352004-12-27 21:59:20 +00003554 *'formatlistpat'* *'flp'*
3555'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
3556 local to buffer
Bram Moolenaar86b68352004-12-27 21:59:20 +00003557 A pattern that is used to recognize a list header. This is used for
3558 the "n" flag in 'formatoptions'.
3559 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00003560 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00003561 while still checking more characters. There must be a character
3562 following the pattern, when it matches the whole line it is handled
3563 like there is no match.
3564 The default recognizes a number, followed by an optional punctuation
3565 character and white space.
3566
Bram Moolenaar6c60f472019-04-28 16:00:35 +02003567 *'formatoptions'* *'fo'*
3568'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
3569 local to buffer
3570 This is a sequence of letters which describes how automatic
3571 formatting is to be done. See |fo-table|. When the 'paste' option is
3572 on, no formatting is done (like 'formatoptions' is empty). Commas can
3573 be inserted for readability.
3574 To avoid problems with flags that are added in the future, use the
3575 "+=" and "-=" feature of ":set" |add-option-flags|.
3576 NOTE: This option is set to the Vi default value when 'compatible' is
3577 set and to the Vim default value when 'compatible' is reset.
3578
Bram Moolenaar071d4272004-06-13 20:20:40 +00003579 *'formatprg'* *'fp'*
3580'formatprg' 'fp' string (default "")
Bram Moolenaar9be7c042017-01-14 14:28:30 +01003581 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003582 The name of an external program that will be used to format the lines
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003583 selected with the |gq| operator. The program must take the input on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003584 stdin and produce the output on stdout. The Unix program "fmt" is
Bram Moolenaara5792f52005-11-23 21:25:05 +00003585 such a program.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003586 If the 'formatexpr' option is not empty it will be used instead.
3587 Otherwise, if 'formatprg' option is an empty string, the internal
3588 format function will be used |C-indenting|.
Bram Moolenaara5792f52005-11-23 21:25:05 +00003589 Environment variables are expanded |:set_env|. See |option-backslash|
3590 about including spaces and backslashes.
Bram Moolenaar30b65812012-07-12 22:01:11 +02003591 This option cannot be set from a |modeline| or in the |sandbox|, for
3592 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003593
Bram Moolenaard94464e2015-11-02 15:28:18 +01003594 *'fsync'* *'fs'* *'nofsync'* *'nofs'*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003595'fsync' 'fs' boolean (default on)
3596 global
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003597 When on, the library function fsync() will be called after writing a
3598 file. This will flush a file to disk, ensuring that it is safely
3599 written even on filesystems which do metadata-only journaling. This
3600 will force the harddrive to spin up on Linux systems running in laptop
3601 mode, so it may be undesirable in some situations. Be warned that
3602 turning this off increases the chances of data loss after a crash. On
3603 systems without an fsync() implementation, this variable is always
3604 off.
3605 Also see 'swapsync' for controlling fsync() on swap files.
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003606 'fsync' also applies to |writefile()|, unless a flag is used to
3607 overrule it.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003608 This option cannot be set from a |modeline| or in the |sandbox|, for
3609 security reasons.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003610
Bram Moolenaar071d4272004-06-13 20:20:40 +00003611 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
3612'gdefault' 'gd' boolean (default off)
3613 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003614 When on, the ":substitute" flag 'g' is default on. This means that
3615 all matches in a line are substituted instead of one. When a 'g' flag
3616 is given to a ":substitute" command, this will toggle the substitution
3617 of all or one match. See |complex-change|.
3618
3619 command 'gdefault' on 'gdefault' off ~
3620 :s/// subst. all subst. one
3621 :s///g subst. one subst. all
3622 :s///gg subst. all subst. one
3623
3624 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar21020352017-06-13 17:21:04 +02003625 DEPRECATED: Setting this option may break plugins that are not aware
3626 of this option. Also, many users get confused that adding the /g flag
3627 has the opposite effect of that it normally does.
Bram Moolenaar4072ba52020-12-23 13:56:35 +01003628 This option is not used in |Vim9| script.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003629
3630 *'grepformat'* *'gfm'*
Bram Moolenaar6e932462014-09-09 18:48:09 +02003631'grepformat' 'gfm' string (default "%f:%l:%m,%f:%l%m,%f %l%m")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003632 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003633 Format to recognize for the ":grep" command output.
3634 This is a scanf-like string that uses the same format as the
3635 'errorformat' option: see |errorformat|.
3636
3637 *'grepprg'* *'gp'*
3638'grepprg' 'gp' string (default "grep -n ",
3639 Unix: "grep -n $* /dev/null",
3640 Win32: "findstr /n" or "grep -n",
3641 VMS: "SEARCH/NUMBERS ")
3642 global or local to buffer |global-local|
Bram Moolenaar582fd852005-03-28 20:58:01 +00003643 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003644 and '#' characters, which are expanded like when used in a command-
3645 line. The placeholder "$*" is allowed to specify where the arguments
3646 will be included. Environment variables are expanded |:set_env|. See
3647 |option-backslash| about including spaces and backslashes.
3648 When your "grep" accepts the "-H" argument, use this to make ":grep"
3649 also work well with a single file: >
3650 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00003651< Special value: When 'grepprg' is set to "internal" the |:grep| command
Bram Moolenaara6557602006-02-04 22:43:20 +00003652 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like
3653 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00003654 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00003655 apply equally to 'grepprg'.
3656 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
3657 otherwise it's "grep -n".
3658 This option cannot be set from a |modeline| or in the |sandbox|, for
3659 security reasons.
3660
3661 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
3662'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
3663 ve:ver35-Cursor,
3664 o:hor50-Cursor,
3665 i-ci:ver25-Cursor/lCursor,
3666 r-cr:hor20-Cursor/lCursor,
3667 sm:block-Cursor
3668 -blinkwait175-blinkoff150-blinkon175",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003669 for Win32 console:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003670 "n-v-c:block,o:hor50,i-ci:hor15,
3671 r-cr:hor30,sm:block")
3672 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003673 {only available when compiled with GUI enabled, and
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003674 for Win32 console}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003675 This option tells Vim what the cursor should look like in different
Bram Moolenaar8024f932020-01-14 19:29:13 +01003676 modes. It fully works in the GUI. In a Win32 console, only the
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003677 height of the cursor can be changed. This can be done by specifying a
3678 block cursor, or a percentage for a vertical or horizontal cursor.
Bram Moolenaar1e7813a2015-03-31 18:31:03 +02003679 For a console the 't_SI', 't_SR', and 't_EI' escape sequences are
3680 used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003681
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003682 The option is a comma separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003683 mode-list and an argument-list:
3684 mode-list:argument-list,mode-list:argument-list,..
3685 The mode-list is a dash separated list of these modes:
3686 n Normal mode
3687 v Visual mode
3688 ve Visual mode with 'selection' "exclusive" (same as 'v',
3689 if not specified)
3690 o Operator-pending mode
3691 i Insert mode
3692 r Replace mode
3693 c Command-line Normal (append) mode
3694 ci Command-line Insert mode
3695 cr Command-line Replace mode
3696 sm showmatch in Insert mode
3697 a all modes
3698 The argument-list is a dash separated list of these arguments:
3699 hor{N} horizontal bar, {N} percent of the character height
3700 ver{N} vertical bar, {N} percent of the character width
3701 block block cursor, fills the whole character
3702 [only one of the above three should be present]
3703 blinkwait{N} *cursor-blinking*
3704 blinkon{N}
3705 blinkoff{N}
3706 blink times for cursor: blinkwait is the delay before
3707 the cursor starts blinking, blinkon is the time that
3708 the cursor is shown and blinkoff is the time that the
3709 cursor is not shown. The times are in msec. When one
3710 of the numbers is zero, there is no blinking. The
3711 default is: "blinkwait700-blinkon400-blinkoff250".
3712 These numbers are used for a missing entry. This
3713 means that blinking is enabled by default. To switch
3714 blinking off you can use "blinkon0". The cursor only
3715 blinks when Vim is waiting for input, not while
3716 executing a command.
3717 To make the cursor blink in an xterm, see
3718 |xterm-blink|.
3719 {group-name}
3720 a highlight group name, that sets the color and font
3721 for the cursor
3722 {group-name}/{group-name}
3723 Two highlight group names, the first is used when
3724 no language mappings are used, the other when they
3725 are. |language-mapping|
3726
3727 Examples of parts:
3728 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
3729 block cursor with colors from the "nCursor"
3730 highlight group
3731 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
3732 In Insert and Command-line Insert mode, use a
3733 30% vertical bar cursor with colors from the
3734 "iCursor" highlight group. Blink a bit
3735 faster.
3736
3737 The 'a' mode is different. It will set the given argument-list for
3738 all modes. It does not reset anything to defaults. This can be used
3739 to do a common setting for all modes. For example, to switch off
3740 blinking: "a:blinkon0"
3741
3742 Examples of cursor highlighting: >
3743 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
3744 :highlight Cursor gui=NONE guifg=bg guibg=fg
3745<
3746 *'guifont'* *'gfn'*
Bram Moolenaar251e1912011-06-19 05:09:16 +02003747 *E235* *E596*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003748'guifont' 'gfn' string (default "")
3749 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003750 {only available when compiled with GUI enabled}
3751 This is a list of fonts which will be used for the GUI version of Vim.
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003752 In its simplest form the value is just one font name.
3753 See |gui-font| for the details.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003754
3755 *'guifontset'* *'gfs'*
3756 *E250* *E252* *E234* *E597* *E598*
3757'guifontset' 'gfs' string (default "")
3758 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003759 {only available when compiled with GUI enabled and
3760 with the |+xfontset| feature}
Bram Moolenaar3df01732017-02-17 22:47:16 +01003761 {not available in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003762 When not empty, specifies two (or more) fonts to be used. The first
3763 one for normal English, the second one for your special language. See
3764 |xfontset|.
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003765
Bram Moolenaar071d4272004-06-13 20:20:40 +00003766 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
3767'guifontwide' 'gfw' string (default "")
3768 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003769 {only available when compiled with GUI enabled}
3770 When not empty, specifies a comma-separated list of fonts to be used
3771 for double-width characters. The first font that can be loaded is
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003772 used. See |gui-fontwide|.
Bram Moolenaar0f272122013-01-23 18:37:40 +01003773
Bram Moolenaar071d4272004-06-13 20:20:40 +00003774 *'guiheadroom'* *'ghr'*
3775'guiheadroom' 'ghr' number (default 50)
3776 global
Bram Moolenaar110289e2019-05-23 15:38:06 +02003777 {only for GTK and X11 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003778 The number of pixels subtracted from the screen height when fitting
3779 the GUI window on the screen. Set this before the GUI is started,
3780 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003781 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00003782 lines will be left for window decorations and other items on the
3783 screen. Set it to a negative value to allow windows taller than the
3784 screen.
3785
3786 *'guioptions'* *'go'*
Bram Moolenaar2c64ca12018-10-19 16:22:31 +02003787'guioptions' 'go' string (default "egmrLtT" (MS-Windows,
3788 "t" is removed in |defaults.vim|),
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02003789 "aegimrLtT" (GTK, Motif and Athena),
3790 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00003791 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003792 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00003793 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003794 sequence of letters which describes what components and options of the
3795 GUI should be used.
3796 To avoid problems with flags that are added in the future, use the
3797 "+=" and "-=" feature of ":set" |add-option-flags|.
3798
Bram Moolenaar13568252018-03-16 20:46:58 +01003799 Valid characters are as follows:
3800 *'go-!'*
3801 '!' External commands are executed in a terminal window. Without
3802 this flag the MS-Windows GUI will open a console window to
3803 execute the command. The Unix GUI will simulate a dumb
3804 terminal to list the command output.
3805 The terminal window will be positioned at the bottom, and grow
3806 upwards as needed.
Bram Moolenaarba3ff532018-11-04 14:45:49 +01003807 *'go-a'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003808 'a' Autoselect: If present, then whenever VISUAL mode is started,
3809 or the Visual area extended, Vim tries to become the owner of
3810 the windowing system's global selection. This means that the
3811 Visually highlighted text is available for pasting into other
3812 applications as well as into Vim itself. When the Visual mode
3813 ends, possibly due to an operation on the text, or when an
3814 application wants to paste the selection, the highlighted text
3815 is automatically yanked into the "* selection register.
3816 Thus the selection is still available for pasting into other
3817 applications after the VISUAL mode has ended.
3818 If not present, then Vim won't become the owner of the
3819 windowing system's global selection unless explicitly told to
3820 by a yank or delete operation for the "* register.
3821 The same applies to the modeless selection.
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02003822 *'go-P'*
3823 'P' Like autoselect but using the "+ register instead of the "*
Bram Moolenaar3848e002016-03-19 18:42:29 +01003824 register.
Bram Moolenaar02467872007-05-06 13:22:01 +00003825 *'go-A'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003826 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003827 applies to the modeless selection.
3828
3829 'guioptions' autoselect Visual autoselect modeless ~
3830 "" - -
3831 "a" yes yes
3832 "A" - yes
3833 "aA" yes yes
3834
Bram Moolenaar02467872007-05-06 13:22:01 +00003835 *'go-c'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003836 'c' Use console dialogs instead of popup dialogs for simple
3837 choices.
Bram Moolenaar50bf7ce2019-09-15 13:17:00 +02003838 *'go-d'*
3839 'd' Use dark theme variant if available. Currently only works for
3840 GTK+ GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00003841 *'go-e'*
Bram Moolenaare224ffa2006-03-01 00:01:28 +00003842 'e' Add tab pages when indicated with 'showtabline'.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003843 'guitablabel' can be used to change the text in the labels.
3844 When 'e' is missing a non-GUI tab pages line may be used.
Bram Moolenaard68071d2006-05-02 22:08:30 +00003845 The GUI tabs are only supported on some systems, currently
Bram Moolenaarb3f74062020-02-26 16:16:53 +01003846 GTK, Motif, Mac OS/X, Haiku, and MS-Windows.
Bram Moolenaar02467872007-05-06 13:22:01 +00003847 *'go-f'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003848 'f' Foreground: Don't use fork() to detach the GUI from the shell
3849 where it was started. Use this for programs that wait for the
3850 editor to finish (e.g., an e-mail program). Alternatively you
3851 can use "gvim -f" or ":gui -f" to start the GUI in the
3852 foreground. |gui-fork|
3853 Note: Set this option in the vimrc file. The forking may have
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003854 happened already when the |gvimrc| file is read.
Bram Moolenaar02467872007-05-06 13:22:01 +00003855 *'go-i'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003856 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
3857 corner of the window. It's black&white on non-GTK, because of
3858 limitations of X11. For a color icon, see |X11-icon|.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003859 *'go-m'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003860 'm' Menu bar is present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003861 *'go-M'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003862 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00003863 that this flag must be added in the .vimrc file, before
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003864 switching on syntax or filetype recognition (when the |gvimrc|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003865 file is sourced the system menu has already been loaded; the
Bram Moolenaar01164a62017-11-02 22:58:42 +01003866 `:syntax on` and `:filetype on` commands load the menu too).
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003867 *'go-g'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003868 'g' Grey menu items: Make menu items that are not active grey. If
3869 'g' is not included inactive menu items are not shown at all.
3870 Exception: Athena will always use grey menu items.
Bram Moolenaar02467872007-05-06 13:22:01 +00003871 *'go-t'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003872 't' Include tearoff menu items. Currently only works for Win32,
3873 GTK+, and Motif 1.2 GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00003874 *'go-T'*
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00003875 'T' Include Toolbar. Currently only in Win32, GTK+, Motif, Photon
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00003876 and Athena GUIs.
Bram Moolenaar02467872007-05-06 13:22:01 +00003877 *'go-r'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003878 'r' Right-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003879 *'go-R'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003880 'R' Right-hand scrollbar is present when there is a vertically
3881 split window.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003882 *'go-l'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003883 'l' Left-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003884 *'go-L'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003885 'L' Left-hand scrollbar is present when there is a vertically
3886 split window.
Bram Moolenaar02467872007-05-06 13:22:01 +00003887 *'go-b'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003888 'b' Bottom (horizontal) scrollbar is present. Its size depends on
3889 the longest visible line, or on the cursor line if the 'h'
3890 flag is included. |gui-horiz-scroll|
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003891 *'go-h'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003892 'h' Limit horizontal scrollbar size to the length of the cursor
3893 line. Reduces computations. |gui-horiz-scroll|
3894
3895 And yes, you may even have scrollbars on the left AND the right if
3896 you really want to :-). See |gui-scrollbars| for more information.
3897
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003898 *'go-v'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003899 'v' Use a vertical button layout for dialogs. When not included,
3900 a horizontal layout is preferred, but when it doesn't fit a
Bram Moolenaardad44732021-03-31 20:07:33 +02003901 vertical layout is used anyway. Not supported in GTK 3.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003902 *'go-p'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003903 'p' Use Pointer callbacks for X11 GUI. This is required for some
3904 window managers. If the cursor is not blinking or hollow at
3905 the right moment, try adding this flag. This must be done
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003906 before starting the GUI. Set it in your |gvimrc|. Adding or
Bram Moolenaar071d4272004-06-13 20:20:40 +00003907 removing it after the GUI has started has no effect.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003908 *'go-F'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003909 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar8ac44152017-11-09 18:33:29 +01003910 *'go-k'*
3911 'k' Keep the GUI window size when adding/removing a scrollbar, or
3912 toolbar, tabline, etc. Instead, the behavior is similar to
3913 when the window is maximized and will adjust 'lines' and
3914 'columns' to fit to the window. Without the 'k' flag Vim will
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003915 try to keep 'lines' and 'columns' the same when adding and
Bram Moolenaar8ac44152017-11-09 18:33:29 +01003916 removing GUI components.
Bram Moolenaar02467872007-05-06 13:22:01 +00003917
Bram Moolenaar071d4272004-06-13 20:20:40 +00003918 *'guipty'* *'noguipty'*
3919'guipty' boolean (default on)
3920 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003921 {only available when compiled with GUI enabled}
3922 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
3923 I/O to/from shell commands. See |gui-pty|.
3924
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003925 *'guitablabel'* *'gtl'*
3926'guitablabel' 'gtl' string (default empty)
3927 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02003928 {only available when compiled with GUI enabled}
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003929 When nonempty describes the text to use in a label of the GUI tab
Bram Moolenaard68071d2006-05-02 22:08:30 +00003930 pages line. When empty and when the result is empty Vim will use a
3931 default label. See |setting-guitablabel| for more info.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003932
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003933 The format of this option is like that of 'statusline'.
Bram Moolenaar57657d82006-04-21 22:12:41 +00003934 'guitabtooltip' is used for the tooltip, see below.
Bram Moolenaar51628222016-12-01 23:03:28 +01003935 The expression will be evaluated in the |sandbox| when set from a
3936 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003937 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003938
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003939 Only used when the GUI tab pages line is displayed. 'e' must be
3940 present in 'guioptions'. For the non-GUI tab pages line 'tabline' is
3941 used.
3942
Bram Moolenaar57657d82006-04-21 22:12:41 +00003943 *'guitabtooltip'* *'gtt'*
3944'guitabtooltip' 'gtt' string (default empty)
3945 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02003946 {only available when compiled with GUI enabled}
Bram Moolenaar57657d82006-04-21 22:12:41 +00003947 When nonempty describes the text to use in a tooltip for the GUI tab
3948 pages line. When empty Vim will use a default tooltip.
3949 This option is otherwise just like 'guitablabel' above.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003950 You can include a line break. Simplest method is to use |:let|: >
3951 :let &guitabtooltip = "line one\nline two"
3952<
Bram Moolenaar57657d82006-04-21 22:12:41 +00003953
Bram Moolenaar071d4272004-06-13 20:20:40 +00003954 *'helpfile'* *'hf'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003955'helpfile' 'hf' string (default (MS-Windows) "$VIMRUNTIME\doc\help.txt"
Bram Moolenaar071d4272004-06-13 20:20:40 +00003956 (others) "$VIMRUNTIME/doc/help.txt")
3957 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003958 Name of the main help file. All distributed help files should be
3959 placed together in one directory. Additionally, all "doc" directories
3960 in 'runtimepath' will be used.
3961 Environment variables are expanded |:set_env|. For example:
3962 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003963 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00003964 spaces and backslashes.
3965 This option cannot be set from a |modeline| or in the |sandbox|, for
3966 security reasons.
3967
3968 *'helpheight'* *'hh'*
3969'helpheight' 'hh' number (default 20)
3970 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003971 Minimal initial height of the help window when it is opened with the
3972 ":help" command. The initial height of the help window is half of the
3973 current window, or (when the 'ea' option is on) the same as other
3974 windows. When the height is less than 'helpheight', the height is
3975 set to 'helpheight'. Set to zero to disable.
3976
3977 *'helplang'* *'hlg'*
3978'helplang' 'hlg' string (default: messages language or empty)
3979 global
3980 {only available when compiled with the |+multi_lang|
3981 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003982 Comma separated list of languages. Vim will use the first language
3983 for which the desired help can be found. The English help will always
3984 be used as a last resort. You can add "en" to prefer English over
3985 another language, but that will only find tags that exist in that
3986 language and not in the English help.
3987 Example: >
3988 :set helplang=de,it
3989< This will first search German, then Italian and finally English help
3990 files.
3991 When using |CTRL-]| and ":help!" in a non-English help file Vim will
3992 try to find the tag in the current language before using this option.
3993 See |help-translated|.
3994
3995 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
3996'hidden' 'hid' boolean (default off)
3997 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003998 When off a buffer is unloaded when it is |abandon|ed. When on a
3999 buffer becomes hidden when it is |abandon|ed. If the buffer is still
4000 displayed in another window, it does not become hidden, of course.
4001 The commands that move through the buffer list sometimes make a buffer
4002 hidden although the 'hidden' option is off: When the buffer is
4003 modified, 'autowrite' is off or writing is not possible, and the '!'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004004 flag was used. See also |windows.txt|.
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004005 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004006 This option is set for one command with ":hide {command}" |:hide|.
4007 WARNING: It's easy to forget that you have changes in hidden buffers.
4008 Think twice when using ":q!" or ":qa!".
4009
4010 *'highlight'* *'hl'*
4011'highlight' 'hl' string (default (as a single string):
Bram Moolenaar58b85342016-08-14 19:54:54 +02004012 "8:SpecialKey,~:EndOfBuffer,@:NonText,
4013 d:Directory,e:ErrorMsg,i:IncSearch,
4014 l:Search,m:MoreMsg,M:ModeMsg,n:LineNr,
Bram Moolenaarefae76a2019-10-27 22:54:58 +01004015 a:LineNrAbove,b:LineNrBelow,
Bram Moolenaar58b85342016-08-14 19:54:54 +02004016 N:CursorLineNr,r:Question,s:StatusLine,
4017 S:StatusLineNC,c:VertSplit,t:Title,
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004018 v:Visual,V:VisualNOS,w:WarningMsg,
4019 W:WildMenu,f:Folded,F:FoldColumn,
4020 A:DiffAdd,C:DiffChange,D:DiffDelete,
4021 T:DiffText,>:SignColumn,-:Conceal,
Bram Moolenaarc8c88492018-12-27 23:59:26 +01004022 B:SpellBad,P:SpellCap,R:SpellRare,
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004023 L:SpellLocal,+:Pmenu,=:PmenuSel,
Bram Moolenaar21020352017-06-13 17:21:04 +02004024 x:PmenuSbar,X:PmenuThumb,*:TabLine,
4025 #:TabLineSel,_:TabLineFill,!:CursorColumn,
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02004026 .:CursorLine,o:ColorColumn,q:QuickFixLine,
Bram Moolenaarc572da52017-08-27 16:52:01 +02004027 z:StatusLineTerm,Z:StatusLineTermNC")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004028 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004029 This option can be used to set highlighting mode for various
4030 occasions. It is a comma separated list of character pairs. The
4031 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004032 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004033 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
Bram Moolenaar58b85342016-08-14 19:54:54 +02004034 |hl-EndOfBuffer| ~ lines after the last line in the buffer
4035 |hl-NonText| @ '@' at the end of the window and
Bram Moolenaar071d4272004-06-13 20:20:40 +00004036 characters from 'showbreak'
4037 |hl-Directory| d directories in CTRL-D listing and other special
4038 things in listings
4039 |hl-ErrorMsg| e error messages
4040 h (obsolete, ignored)
4041 |hl-IncSearch| i 'incsearch' highlighting
4042 |hl-Search| l last search pattern highlighting (see 'hlsearch')
4043 |hl-MoreMsg| m |more-prompt|
4044 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
Bram Moolenaar64486672010-05-16 15:46:46 +02004045 |hl-LineNr| n line number for ":number" and ":#" commands, and
4046 when 'number' or 'relativenumber' option is set.
Bram Moolenaarefae76a2019-10-27 22:54:58 +01004047 |hl-LineNrAbove| a line number above the cursor for when the
4048 'relativenumber' option is set.
4049 |hl-LineNrBelow| b line number below the cursor for when the
4050 'relativenumber' option is set.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01004051 |hl-CursorLineNr| N like n for when 'cursorline' or 'relativenumber' is
4052 set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004053 |hl-Question| r |hit-enter| prompt and yes/no questions
4054 |hl-StatusLine| s status line of current window |status-line|
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01004055 |hl-StatusLineNC| S status lines of not-current windows
Bram Moolenaar071d4272004-06-13 20:20:40 +00004056 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
4057 |hl-VertSplit| c column used to separate vertically split windows
4058 |hl-Visual| v Visual mode
4059 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
4060 Selection" Only X11 Gui's |gui-x11| and
4061 |xterm-clipboard|.
4062 |hl-WarningMsg| w warning messages
4063 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
4064 |hl-Folded| f line used for closed folds
4065 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00004066 |hl-DiffAdd| A added line in diff mode
4067 |hl-DiffChange| C changed line in diff mode
4068 |hl-DiffDelete| D deleted line in diff mode
4069 |hl-DiffText| T inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00004070 |hl-SignColumn| > column used for |signs|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004071 |hl-Conceal| - the placeholders used for concealed characters
4072 (see 'conceallevel')
Bram Moolenaar217ad922005-03-20 22:37:15 +00004073 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02004074 |hl-SpellCap| P word that should start with capital |spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00004075 |hl-SpellRare| R rare word |spell|
4076 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004077 |hl-Pmenu| + popup menu normal line
4078 |hl-PmenuSel| = popup menu selected line
4079 |hl-PmenuSbar| x popup menu scrollbar
4080 |hl-PmenuThumb| X popup menu scrollbar thumb
Bram Moolenaar071d4272004-06-13 20:20:40 +00004081
4082 The display modes are:
4083 r reverse (termcap entry "mr" and "me")
4084 i italic (termcap entry "ZH" and "ZR")
4085 b bold (termcap entry "md" and "me")
4086 s standout (termcap entry "so" and "se")
4087 u underline (termcap entry "us" and "ue")
Bram Moolenaare2cc9702005-03-15 22:43:58 +00004088 c undercurl (termcap entry "Cs" and "Ce")
Bram Moolenaarcf4b00c2017-09-02 18:33:56 +02004089 t strikethrough (termcap entry "Ts" and "Te")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004090 n no highlighting
4091 - no highlighting
4092 : use a highlight group
4093 The default is used for occasions that are not included.
4094 If you want to change what the display modes do, see |dos-colors|
4095 for an example.
4096 When using the ':' display mode, this must be followed by the name of
4097 a highlight group. A highlight group can be used to define any type
4098 of highlighting, including using color. See |:highlight| on how to
4099 define one. The default uses a different group for each occasion.
4100 See |highlight-default| for the default highlight groups.
4101
Bram Moolenaar071d4272004-06-13 20:20:40 +00004102 *'history'* *'hi'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004103'history' 'hi' number (Vim default: 50, Vi default: 0,
4104 set to 200 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004105 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004106 A history of ":" commands, and a history of previous search patterns
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004107 is remembered. This option decides how many entries may be stored in
Bram Moolenaar071d4272004-06-13 20:20:40 +00004108 each of these histories (see |cmdline-editing|).
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004109 The maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004110 NOTE: This option is set to the Vi default value when 'compatible' is
4111 set and to the Vim default value when 'compatible' is reset.
4112
4113 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
4114'hkmap' 'hk' boolean (default off)
4115 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004116 {only available when compiled with the |+rightleft|
4117 feature}
4118 When on, the keyboard is mapped for the Hebrew character set.
4119 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
4120 toggle this option. See |rileft.txt|.
4121 NOTE: This option is reset when 'compatible' is set.
4122
4123 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
4124'hkmapp' 'hkp' boolean (default off)
4125 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004126 {only available when compiled with the |+rightleft|
4127 feature}
4128 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
4129 This is useful if you have a non-Hebrew keyboard.
4130 See |rileft.txt|.
4131 NOTE: This option is reset when 'compatible' is set.
4132
Bram Moolenaar036986f2017-03-16 17:41:02 +01004133 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
4134'hlsearch' 'hls' boolean (default off)
4135 global
Bram Moolenaar036986f2017-03-16 17:41:02 +01004136 {not available when compiled without the
4137 |+extra_search| feature}
4138 When there is a previous search pattern, highlight all its matches.
4139 The type of highlighting used can be set with the 'l' occasion in the
4140 'highlight' option. This uses the "Search" highlight group by
4141 default. Note that only the matching text is highlighted, any offsets
4142 are not applied.
4143 See also: 'incsearch' and |:match|.
4144 When you get bored looking at the highlighted matches, you can turn it
4145 off with |:nohlsearch|. This does not change the option value, as
4146 soon as you use a search command, the highlighting comes back.
4147 'redrawtime' specifies the maximum time spent on finding matches.
4148 When the search pattern can match an end-of-line, Vim will try to
4149 highlight all of the matched text. However, this depends on where the
4150 search starts. This will be the first line in the window or the first
4151 line below a closed fold. A match in a previous line which is not
4152 drawn may not continue in a newly drawn line.
4153 You can specify whether the highlight status is restored on startup
4154 with the 'h' flag in 'viminfo' |viminfo-h|.
4155 NOTE: This option is reset when 'compatible' is set.
4156
Bram Moolenaar071d4272004-06-13 20:20:40 +00004157 *'icon'* *'noicon'*
4158'icon' boolean (default off, on when title can be restored)
4159 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004160 {not available when compiled without the |+title|
4161 feature}
4162 When on, the icon text of the window will be set to the value of
4163 'iconstring' (if it is not empty), or to the name of the file
4164 currently being edited. Only the last part of the name is used.
4165 Overridden by the 'iconstring' option.
4166 Only works if the terminal supports setting window icons (currently
4167 only X11 GUI and terminals with a non-empty 't_IS' option - these are
4168 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
4169 builtin termcap).
4170 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00004171 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00004172 X11.
Bram Moolenaar3a991dd2014-10-02 01:41:41 +02004173 For MS-Windows the icon can be changed, see |windows-icon|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004174
4175 *'iconstring'*
4176'iconstring' string (default "")
4177 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004178 {not available when compiled without the |+title|
4179 feature}
4180 When this option is not empty, it will be used for the icon text of
4181 the window. This happens only when the 'icon' option is on.
4182 Only works if the terminal supports setting window icon text
4183 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02004184 Does not work for MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004185 When Vim was compiled with HAVE_X11 defined, the original icon will be
4186 restored if possible |X11|.
4187 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004188 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004189 'titlestring' for example settings.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004190 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004191 {not available when compiled without the |+statusline| feature}
4192
4193 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
4194'ignorecase' 'ic' boolean (default off)
4195 global
4196 Ignore case in search patterns. Also used when searching in the tags
4197 file.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01004198 Also see 'smartcase' and 'tagcase'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004199 Can be overruled by using "\c" or "\C" in the pattern, see
4200 |/ignorecase|.
4201
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004202 *'imactivatefunc'* *'imaf'*
4203'imactivatefunc' 'imaf' string (default "")
4204 global
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004205 This option specifies a function that will be called to
Bram Moolenaar2877d332017-11-26 14:56:16 +01004206 activate or deactivate the Input Method.
Bram Moolenaaref8c6172020-07-01 15:12:44 +02004207 It is not used in the MS-Windows GUI version.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004208 The expression will be evaluated in the |sandbox| when set from a
4209 modeline, see |sandbox-option|.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004210
4211 Example: >
4212 function ImActivateFunc(active)
4213 if a:active
4214 ... do something
4215 else
4216 ... do something
4217 endif
4218 " return value is not used
4219 endfunction
4220 set imactivatefunc=ImActivateFunc
4221<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004222 *'imactivatekey'* *'imak'*
4223'imactivatekey' 'imak' string (default "")
4224 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004225 {only available when compiled with |+xim| and
Bram Moolenaar67c53842010-05-22 18:28:27 +02004226 |+GUI_GTK|} *E599*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004227 Specifies the key that your Input Method in X-Windows uses for
4228 activation. When this is specified correctly, vim can fully control
4229 IM with 'imcmdline', 'iminsert' and 'imsearch'.
4230 You can't use this option to change the activation key, the option
4231 tells Vim what the key is.
4232 Format:
4233 [MODIFIER_FLAG-]KEY_STRING
4234
4235 These characters can be used for MODIFIER_FLAG (case is ignored):
4236 S Shift key
4237 L Lock key
4238 C Control key
4239 1 Mod1 key
4240 2 Mod2 key
4241 3 Mod3 key
4242 4 Mod4 key
4243 5 Mod5 key
4244 Combinations are allowed, for example "S-C-space" or "SC-space" are
4245 both shift+ctrl+space.
4246 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
4247
4248 Example: >
4249 :set imactivatekey=S-space
4250< "S-space" means shift+space. This is the activation key for kinput2 +
4251 canna (Japanese), and ami (Korean).
4252
4253 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
4254'imcmdline' 'imc' boolean (default off)
4255 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004256 When set the Input Method is always on when starting to edit a command
4257 line, unless entering a search pattern (see 'imsearch' for that).
4258 Setting this option is useful when your input method allows entering
4259 English characters directly, e.g., when it's used to type accented
4260 characters with dead keys.
4261
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004262 *'imdisable'* *'imd'* *'noimdisable'* *'noimd'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004263'imdisable' 'imd' boolean (default off, on for some systems (SGI))
4264 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004265 When set the Input Method is never used. This is useful to disable
4266 the IM when it doesn't work properly.
4267 Currently this option is on by default for SGI/IRIX machines. This
4268 may change in later releases.
4269
4270 *'iminsert'* *'imi'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004271'iminsert' 'imi' number (default 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004272 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004273 Specifies whether :lmap or an Input Method (IM) is to be used in
4274 Insert mode. Valid values:
4275 0 :lmap is off and IM is off
4276 1 :lmap is ON and IM is off
4277 2 :lmap is off and IM is ON
Bram Moolenaar071d4272004-06-13 20:20:40 +00004278 To always reset the option to zero when leaving Insert mode with <Esc>
4279 this can be used: >
4280 :inoremap <ESC> <ESC>:set iminsert=0<CR>
4281< This makes :lmap and IM turn off automatically when leaving Insert
4282 mode.
4283 Note that this option changes when using CTRL-^ in Insert mode
4284 |i_CTRL-^|.
4285 The value is set to 1 when setting 'keymap' to a valid keymap name.
4286 It is also used for the argument of commands like "r" and "f".
4287 The value 0 may not work correctly with Athena and Motif with some XIM
4288 methods. Use 'imdisable' to disable XIM then.
4289
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004290 You can set 'imactivatefunc' and 'imstatusfunc' to handle IME/XIM
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004291 via external command if Vim is not compiled with the |+xim|,
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004292 |+multi_byte_ime| or |global-ime|.
4293
Bram Moolenaar071d4272004-06-13 20:20:40 +00004294 *'imsearch'* *'ims'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004295'imsearch' 'ims' number (default -1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004296 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004297 Specifies whether :lmap or an Input Method (IM) is to be used when
4298 entering a search pattern. Valid values:
4299 -1 the value of 'iminsert' is used, makes it look like
4300 'iminsert' is also used when typing a search pattern
4301 0 :lmap is off and IM is off
4302 1 :lmap is ON and IM is off
4303 2 :lmap is off and IM is ON
4304 Note that this option changes when using CTRL-^ in Command-line mode
4305 |c_CTRL-^|.
4306 The value is set to 1 when it is not -1 and setting the 'keymap'
4307 option to a valid keymap name.
4308 The value 0 may not work correctly with Athena and Motif with some XIM
4309 methods. Use 'imdisable' to disable XIM then.
4310
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004311 *'imstatusfunc'* *'imsf'*
4312'imstatusfunc' 'imsf' string (default "")
4313 global
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004314 This option specifies a function that is called to obtain the status
4315 of Input Method. It must return a positive number when IME is active.
Bram Moolenaaref8c6172020-07-01 15:12:44 +02004316 It is not used in the MS-Windows GUI version.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004317
4318 Example: >
4319 function ImStatusFunc()
4320 let is_active = ...do something
4321 return is_active ? 1 : 0
4322 endfunction
4323 set imstatusfunc=ImStatusFunc
4324<
4325 NOTE: This function is invoked very often. Keep it fast.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004326 The expression will be evaluated in the |sandbox| when set from a
4327 modeline, see |sandbox-option|.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004328
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004329 *'imstyle'* *'imst'*
4330'imstyle' 'imst' number (default 1)
4331 global
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004332 {only available when compiled with |+xim| and
4333 |+GUI_GTK|}
Bram Moolenaar37c64c72017-09-19 22:06:03 +02004334 This option specifies the input style of Input Method:
4335 0 use on-the-spot style
4336 1 over-the-spot style
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004337 See: |xim-input-style|
4338
Bram Moolenaar24a98a02017-09-27 22:23:55 +02004339 For a long time on-the-spot style had been used in the GTK version of
4340 vim, however, it is known that it causes troubles when using mappings,
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004341 |single-repeat|, etc. Therefore over-the-spot style becomes the
4342 default now. This should work fine for most people, however if you
4343 have any problem with it, try using on-the-spot style.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004344 The expression will be evaluated in the |sandbox| when set from a
4345 modeline, see |sandbox-option|.
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004346
Bram Moolenaar071d4272004-06-13 20:20:40 +00004347 *'include'* *'inc'*
4348'include' 'inc' string (default "^\s*#\s*include")
4349 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004350 {not available when compiled without the
4351 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004352 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00004353 pattern, just like for the "/" command (See |pattern|). The default
4354 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar1e015462005-09-25 22:16:38 +00004355 "]I", "[d", etc.
4356 Normally the 'isfname' option is used to recognize the file name that
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004357 comes after the matched pattern. But if "\zs" appears in the pattern
4358 then the text matched from "\zs" to the end, or until "\ze" if it
4359 appears, is used as the file name. Use this to include characters
4360 that are not in 'isfname', such as a space. You can then use
4361 'includeexpr' to process the matched text.
Bram Moolenaar1e015462005-09-25 22:16:38 +00004362 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004363
4364 *'includeexpr'* *'inex'*
4365'includeexpr' 'inex' string (default "")
4366 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004367 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004368 |+find_in_path| or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004369 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004370 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004371 :set includeexpr=substitute(v:fname,'\\.','/','g')
4372< The "v:fname" variable will be set to the file name that was detected.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004373
Bram Moolenaar071d4272004-06-13 20:20:40 +00004374 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004375 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004376 Also used for |<cfile>|.
4377
Bram Moolenaar30b65812012-07-12 22:01:11 +02004378 The expression will be evaluated in the |sandbox| when set from a
4379 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004380 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004381
4382 It is not allowed to change text or jump to another window while
4383 evaluating 'includeexpr' |textlock|.
4384
Bram Moolenaar071d4272004-06-13 20:20:40 +00004385 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004386'incsearch' 'is' boolean (default off, set in |defaults.vim| if the
4387 +reltime feature is supported)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004388 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004389 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004390 |+extra_search| features}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004391 While typing a search command, show where the pattern, as it was typed
4392 so far, matches. The matched string is highlighted. If the pattern
4393 is invalid or not found, nothing is shown. The screen will be updated
4394 often, this is only useful on fast terminals.
Bram Moolenaarfc65cab2018-08-28 22:58:02 +02004395 Also applies to the pattern in commands: >
4396 :global
4397 :lvimgrep
4398 :lvimgrepadd
4399 :smagic
4400 :snomagic
4401 :sort
4402 :substitute
4403 :vglobal
4404 :vimgrep
4405 :vimgrepadd
4406< Note that the match will be shown, but the cursor will return to its
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004407 original position when no match is found and when pressing <Esc>. You
4408 still need to finish the search command with <Enter> to move the
4409 cursor to the match.
Bram Moolenaardc083282016-10-11 08:57:33 +02004410 You can use the CTRL-G and CTRL-T keys to move to the next and
4411 previous match. |c_CTRL-G| |c_CTRL-T|
Bram Moolenaar91a4e822008-01-19 14:59:58 +00004412 When compiled with the |+reltime| feature Vim only searches for about
4413 half a second. With a complicated pattern and/or a lot of text the
4414 match may not be found. This is to avoid that Vim hangs while you
4415 are typing the pattern.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004416 The highlighting can be set with the 'i' flag in 'highlight'.
Bram Moolenaar2f058492017-11-30 20:27:52 +01004417 When 'hlsearch' is on, all matched strings are highlighted too while
4418 typing a search command. See also: 'hlsearch'.
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004419 If you don't want to turn 'hlsearch' on, but want to highlight all
4420 matches while searching, you can turn on and off 'hlsearch' with
4421 autocmd. Example: >
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004422 augroup vimrc-incsearch-highlight
4423 autocmd!
Bram Moolenaarf8f8b2e2017-11-02 19:08:48 +01004424 autocmd CmdlineEnter /,\? :set hlsearch
4425 autocmd CmdlineLeave /,\? :set nohlsearch
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004426 augroup END
4427<
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004428 CTRL-L can be used to add one character from after the current match
Bram Moolenaara9dc3752010-07-11 20:46:53 +02004429 to the command line. If 'ignorecase' and 'smartcase' are set and the
4430 command line has no uppercase characters, the added character is
4431 converted to lowercase.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004432 CTRL-R CTRL-W can be used to add the word at the end of the current
4433 match, excluding the characters that were already typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004434 NOTE: This option is reset when 'compatible' is set.
4435
4436 *'indentexpr'* *'inde'*
4437'indentexpr' 'inde' string (default "")
4438 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004439 {not available when compiled without the |+cindent|
4440 or |+eval| features}
4441 Expression which is evaluated to obtain the proper indent for a line.
4442 It is used when a new line is created, for the |=| operator and
4443 in Insert mode as specified with the 'indentkeys' option.
4444 When this option is not empty, it overrules the 'cindent' and
Bram Moolenaar20f90cf2011-05-19 12:22:51 +02004445 'smartindent' indenting. When 'lisp' is set, this option is
4446 overridden by the Lisp indentation algorithm.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004447 When 'paste' is set this option is not used for indenting.
4448 The expression is evaluated with |v:lnum| set to the line number for
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004449 which the indent is to be computed. The cursor is also in this line
Bram Moolenaar071d4272004-06-13 20:20:40 +00004450 when the expression is evaluated (but it may be moved around).
4451 The expression must return the number of spaces worth of indent. It
4452 can return "-1" to keep the current indent (this means 'autoindent' is
4453 used for the indent).
4454 Functions useful for computing the indent are |indent()|, |cindent()|
4455 and |lispindent()|.
4456 The evaluation of the expression must not have side effects! It must
4457 not change the text, jump to another window, etc. Afterwards the
4458 cursor position is always restored, thus the cursor may be moved.
4459 Normally this option would be set to call a function: >
4460 :set indentexpr=GetMyIndent()
4461< Error messages will be suppressed, unless the 'debug' option contains
4462 "msg".
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004463 See |indent-expression|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01004464 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004465
Bram Moolenaar30b65812012-07-12 22:01:11 +02004466 The expression will be evaluated in the |sandbox| when set from a
4467 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004468 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004469
4470 It is not allowed to change text or jump to another window while
4471 evaluating 'indentexpr' |textlock|.
4472
4473
Bram Moolenaar071d4272004-06-13 20:20:40 +00004474 *'indentkeys'* *'indk'*
Bram Moolenaarce655742019-01-31 14:12:57 +01004475'indentkeys' 'indk' string (default "0{,0},0),0],:,0#,!^F,o,O,e")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004476 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004477 {not available when compiled without the |+cindent|
4478 feature}
4479 A list of keys that, when typed in Insert mode, cause reindenting of
4480 the current line. Only happens if 'indentexpr' isn't empty.
4481 The format is identical to 'cinkeys', see |indentkeys-format|.
4482 See |C-indenting| and |indent-expression|.
4483
4484 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
4485'infercase' 'inf' boolean (default off)
4486 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004487 When doing keyword completion in insert mode |ins-completion|, and
Bram Moolenaar446cb832008-06-24 21:56:24 +00004488 'ignorecase' is also on, the case of the match is adjusted depending
4489 on the typed text. If the typed text contains a lowercase letter
4490 where the match has an upper case letter, the completed part is made
4491 lowercase. If the typed text has no lowercase letters and the match
4492 has a lowercase letter where the typed text has an uppercase letter,
4493 and there is a letter before it, the completed part is made uppercase.
4494 With 'noinfercase' the match is used as-is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004495
4496 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
4497'insertmode' 'im' boolean (default off)
4498 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004499 Makes Vim work in a way that Insert mode is the default mode. Useful
4500 if you want to use Vim as a modeless editor. Used for |evim|.
4501 These Insert mode commands will be useful:
4502 - Use the cursor keys to move around.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02004503 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|. When
Bram Moolenaar071d4272004-06-13 20:20:40 +00004504 this is a mapping, it is executed as if 'insertmode' was off.
4505 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004506 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00004507 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
4508 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004509
4510 These items change when 'insertmode' is set:
4511 - when starting to edit of a file, Vim goes to Insert mode.
4512 - <Esc> in Insert mode is a no-op and beeps.
4513 - <Esc> in Normal mode makes Vim go to Insert mode.
4514 - CTRL-L in Insert mode is a command, it is not inserted.
4515 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
4516 However, when <Esc> is used inside a mapping, it behaves like
4517 'insertmode' was not set. This was done to be able to use the same
4518 mappings with 'insertmode' set or not set.
4519 When executing commands with |:normal| 'insertmode' is not used.
4520
4521 NOTE: This option is reset when 'compatible' is set.
4522
4523 *'isfname'* *'isf'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004524'isfname' 'isf' string (default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004525 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
4526 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
4527 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
4528 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
4529 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
4530 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004531 The characters specified by this option are included in file names and
4532 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004533 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004534 Multi-byte characters 256 and above are always included, only the
4535 characters up to 255 are specified with this option.
4536 For UTF-8 the characters 0xa0 to 0xff are included as well.
Bram Moolenaar446cb832008-06-24 21:56:24 +00004537 Think twice before adding white space to this option. Although a
4538 space may appear inside a file name, the effect will be that Vim
4539 doesn't know where a file name starts or ends when doing completion.
4540 It most likely works better without a space in 'isfname'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004541
4542 Note that on systems using a backslash as path separator, Vim tries to
4543 do its best to make it work as you would expect. That is a bit
4544 tricky, since Vi originally used the backslash to escape special
4545 characters. Vim will not remove a backslash in front of a normal file
4546 name character on these systems, but it will on Unix and alikes. The
4547 '&' and '^' are not included by default, because these are special for
4548 cmd.exe.
4549
4550 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004551 Each part can be a single character number or a range. A range is two
4552 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004553 decimal number between 0 and 255 or the ASCII character itself (does
4554 not work for digits). Example:
4555 "_,-,128-140,#-43" (include '_' and '-' and the range
4556 128 to 140 and '#' to 43)
4557 If a part starts with '^', the following character number or range
4558 will be excluded from the option. The option is interpreted from left
4559 to right. Put the excluded character after the range where it is
4560 included. To include '^' itself use it as the last character of the
4561 option or the end of a range. Example:
4562 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
4563 If the character is '@', all characters where isalpha() returns TRUE
4564 are included. Normally these are the characters a to z and A to Z,
4565 plus accented characters. To include '@' itself use "@-@". Examples:
4566 "@,^a-z" All alphabetic characters, excluding lower
Bram Moolenaar446cb832008-06-24 21:56:24 +00004567 case ASCII letters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004568 "a-z,A-Z,@-@" All letters plus the '@' character.
4569 A comma can be included by using it where a character number is
4570 expected. Example:
4571 "48-57,,,_" Digits, comma and underscore.
4572 A comma can be excluded by prepending a '^'. Example:
4573 " -~,^,,9" All characters from space to '~', excluding
4574 comma, plus <Tab>.
4575 See |option-backslash| about including spaces and backslashes.
4576
4577 *'isident'* *'isi'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004578'isident' 'isi' string (default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004579 "@,48-57,_,128-167,224-235"
4580 otherwise: "@,48-57,_,192-255")
4581 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004582 The characters given by this option are included in identifiers.
4583 Identifiers are used in recognizing environment variables and after a
4584 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00004585 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004586 option. For '@' only characters up to 255 are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004587 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004588 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00004589 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
4590
4591 *'iskeyword'* *'isk'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004592'iskeyword' 'isk' string (Vim default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004593 "@,48-57,_,128-167,224-235"
4594 otherwise: "@,48-57,_,192-255"
4595 Vi default: "@,48-57,_")
4596 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004597 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004598 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004599 'isfname' for a description of the format of this option. For '@'
Bram Moolenaar4c295022021-05-02 17:19:11 +02004600 characters above 255 check the "word" character class (any character
4601 that is not white space or punctuation).
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004602 For C programs you could use "a-z,A-Z,48-57,_,.,-,>".
Bram Moolenaar071d4272004-06-13 20:20:40 +00004603 For a help file it is set to all non-blank printable characters except
4604 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
4605 command).
4606 When the 'lisp' option is on the '-' character is always included.
Bram Moolenaarb8060fe2016-01-19 22:29:28 +01004607 This option also influences syntax highlighting, unless the syntax
4608 uses |:syn-iskeyword|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004609 NOTE: This option is set to the Vi default value when 'compatible' is
4610 set and to the Vim default value when 'compatible' is reset.
4611
4612 *'isprint'* *'isp'*
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02004613'isprint' 'isp' string (default for Win32 and macOS:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004614 "@,~-255"; otherwise: "@,161-255")
4615 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004616 The characters given by this option are displayed directly on the
4617 screen. It is also used for "\p" in a |pattern|. The characters from
4618 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
4619 even when they are not included in 'isprint' or excluded. See
4620 'isfname' for a description of the format of this option.
4621
4622 Non-printable characters are displayed with two characters:
4623 0 - 31 "^@" - "^_"
4624 32 - 126 always single characters
4625 127 "^?"
4626 128 - 159 "~@" - "~_"
4627 160 - 254 "| " - "|~"
4628 255 "~?"
4629 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
4630 displayed as <xx>, with the hexadecimal value of the byte.
4631 When 'display' contains "uhex" all unprintable characters are
4632 displayed as <xx>.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004633 The SpecialKey highlighting will be used for unprintable characters.
4634 |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004635
4636 Multi-byte characters 256 and above are always included, only the
4637 characters up to 255 are specified with this option. When a character
4638 is printable but it is not available in the current font, a
4639 replacement character will be shown.
4640 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
4641 There is no option to specify these characters.
4642
4643 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
4644'joinspaces' 'js' boolean (default on)
4645 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004646 Insert two spaces after a '.', '?' and '!' with a join command.
4647 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
4648 Otherwise only one space is inserted.
4649 NOTE: This option is set when 'compatible' is set.
4650
4651 *'key'*
4652'key' string (default "")
4653 local to buffer
Bram Moolenaar996343d2010-07-04 22:20:21 +02004654 {only available when compiled with the |+cryptv|
4655 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004656 The key that is used for encrypting and decrypting the current buffer.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02004657 See |encryption| and 'cryptmethod'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004658 Careful: Do not set the key value by hand, someone might see the typed
4659 key. Use the |:X| command. But you can make 'key' empty: >
4660 :set key=
4661< It is not possible to get the value of this option with ":set key" or
4662 "echo &key". This is to avoid showing it to someone who shouldn't
4663 know. It also means you cannot see it yourself once you have set it,
4664 be careful not to make a typing error!
Bram Moolenaard58e9292011-02-09 17:07:58 +01004665 You can use "&key" in an expression to detect whether encryption is
4666 enabled. When 'key' is set it returns "*****" (five stars).
Bram Moolenaar071d4272004-06-13 20:20:40 +00004667
4668 *'keymap'* *'kmp'* *E544*
4669'keymap' 'kmp' string (default "")
4670 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004671 {only available when compiled with the |+keymap|
4672 feature}
4673 Name of a keyboard mapping. See |mbyte-keymap|.
4674 Setting this option to a valid keymap name has the side effect of
4675 setting 'iminsert' to one, so that the keymap becomes effective.
4676 'imsearch' is also set to one, unless it was -1
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004677 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004678
4679 *'keymodel'* *'km'*
4680'keymodel' 'km' string (default "")
4681 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004682 List of comma separated words, which enable special things that keys
4683 can do. These values can be used:
4684 startsel Using a shifted special key starts selection (either
4685 Select mode or Visual mode, depending on "key" being
4686 present in 'selectmode').
4687 stopsel Using a not-shifted special key stops selection.
4688 Special keys in this context are the cursor keys, <End>, <Home>,
4689 <PageUp> and <PageDown>.
4690 The 'keymodel' option is set by the |:behave| command.
4691
4692 *'keywordprg'* *'kp'*
4693'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02004694 VMS: "help")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004695 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004696 Program to use for the |K| command. Environment variables are
4697 expanded |:set_env|. ":help" may be used to access the Vim internal
4698 help. (Note that previously setting the global option to the empty
4699 value did this, which is now deprecated.)
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02004700 When the first character is ":", the command is invoked as a Vim
4701 Ex command prefixed with [count].
4702 When "man", "man -s" or an Ex command is used, Vim will automatically
4703 translate a count for the "K" command and pass it as the first
4704 argument. For "man -s" the "-s" is removed when there is no count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004705 See |option-backslash| about including spaces and backslashes.
4706 Example: >
4707 :set keywordprg=man\ -s
4708< This option cannot be set from a |modeline| or in the |sandbox|, for
4709 security reasons.
4710
4711 *'langmap'* *'lmap'* *E357* *E358*
4712'langmap' 'lmap' string (default "")
4713 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004714 {only available when compiled with the |+langmap|
4715 feature}
4716 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004717 mode. When you are typing text in Insert mode the characters are
Bram Moolenaarfa735342016-01-03 22:14:44 +01004718 inserted directly. When in Normal mode the 'langmap' option takes
Bram Moolenaar071d4272004-06-13 20:20:40 +00004719 care of translating these special characters to the original meaning
4720 of the key. This means you don't have to change the keyboard mode to
4721 be able to execute Normal mode commands.
4722 This is the opposite of the 'keymap' option, where characters are
4723 mapped in Insert mode.
Bram Moolenaarb17893a2020-03-14 08:19:51 +01004724 Also consider setting 'langremap' to off, to prevent 'langmap' from
4725 applying to characters resulting from a mapping.
Bram Moolenaare968e362014-05-13 20:23:24 +02004726 This option cannot be set from a |modeline| or in the |sandbox|, for
4727 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004728
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00004729 Example (for Greek, in UTF-8): *greek* >
4730 :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 +00004731< Example (exchanges meaning of z and y for commands): >
4732 :set langmap=zy,yz,ZY,YZ
4733<
4734 The 'langmap' option is a list of parts, separated with commas. Each
4735 part can be in one of two forms:
4736 1. A list of pairs. Each pair is a "from" character immediately
4737 followed by the "to" character. Examples: "aA", "aAbBcC".
4738 2. A list of "from" characters, a semi-colon and a list of "to"
4739 characters. Example: "abc;ABC"
4740 Example: "aA,fgh;FGH,cCdDeE"
4741 Special characters need to be preceded with a backslash. These are
Bram Moolenaar4f4d51a2020-10-11 13:57:40 +02004742 ";", ',', '"', '|' and backslash itself.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004743
4744 This will allow you to activate vim actions without having to switch
4745 back and forth between the languages. Your language characters will
4746 be understood as normal vim English characters (according to the
4747 langmap mappings) in the following cases:
4748 o Normal/Visual mode (commands, buffer/register names, user mappings)
4749 o Insert/Replace Mode: Register names after CTRL-R
4750 o Insert/Replace Mode: Mappings
4751 Characters entered in Command-line mode will NOT be affected by
4752 this option. Note that this option can be changed at any time
4753 allowing to switch between mappings for different languages/encodings.
4754 Use a mapping to avoid having to type it each time!
4755
4756 *'langmenu'* *'lm'*
4757'langmenu' 'lm' string (default "")
4758 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004759 {only available when compiled with the |+menu| and
4760 |+multi_lang| features}
4761 Language to use for menu translation. Tells which file is loaded
4762 from the "lang" directory in 'runtimepath': >
4763 "lang/menu_" . &langmenu . ".vim"
4764< (without the spaces). For example, to always use the Dutch menus, no
4765 matter what $LANG is set to: >
4766 :set langmenu=nl_NL.ISO_8859-1
4767< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004768 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004769 If your $LANG is set to a non-English language but you do want to use
4770 the English menus: >
4771 :set langmenu=none
4772< This option must be set before loading menus, switching on filetype
4773 detection or syntax highlighting. Once the menus are defined setting
4774 this option has no effect. But you could do this: >
4775 :source $VIMRUNTIME/delmenu.vim
4776 :set langmenu=de_DE.ISO_8859-1
4777 :source $VIMRUNTIME/menu.vim
4778< Warning: This deletes all menus that you defined yourself!
4779
Bram Moolenaard94464e2015-11-02 15:28:18 +01004780 *'langnoremap'* *'lnr'* *'nolangnoremap'* *'nolnr'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004781'langnoremap' 'lnr' boolean (default off, set in |defaults.vim|)
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004782 global
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004783 {only available when compiled with the |+langmap|
4784 feature}
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004785 This is just like 'langremap' but with the value inverted. It only
4786 exists for backwards compatibility. When setting 'langremap' then
4787 'langnoremap' is set to the inverted value, and the other way around.
4788
4789 *'langremap'* *'lrm'* *'nolangremap'* *'nolrm'*
Bram Moolenaarb17893a2020-03-14 08:19:51 +01004790'langremap' 'lrm' boolean (default on, set to off in |defaults.vim|)
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004791 global
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004792 {only available when compiled with the |+langmap|
4793 feature}
4794 When off, setting 'langmap' does not apply to characters resulting from
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004795 a mapping. This basically means, if you noticed that setting
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004796 'langmap' disables some of your mappings, try resetting this option.
4797 This option defaults to on for backwards compatibility. Set it off if
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004798 that works for you to avoid mappings to break.
4799
Bram Moolenaar071d4272004-06-13 20:20:40 +00004800 *'laststatus'* *'ls'*
4801'laststatus' 'ls' number (default 1)
4802 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004803 The value of this option influences when the last window will have a
4804 status line:
4805 0: never
4806 1: only if there are at least two windows
4807 2: always
4808 The screen looks nicer with a status line if you have several
4809 windows, but it takes another screen line. |status-line|
4810
4811 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
4812'lazyredraw' 'lz' boolean (default off)
4813 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004814 When this option is set, the screen will not be redrawn while
4815 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004816 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00004817 update use |:redraw|.
4818
4819 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
4820'linebreak' 'lbr' boolean (default off)
4821 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02004822 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004823 feature}
Bram Moolenaar946e27a2014-06-25 18:50:27 +02004824 If on, Vim will wrap long lines at a character in 'breakat' rather
Bram Moolenaar071d4272004-06-13 20:20:40 +00004825 than at the last character that fits on the screen. Unlike
4826 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
Bram Moolenaar946e27a2014-06-25 18:50:27 +02004827 it only affects the way the file is displayed, not its contents.
4828 If 'breakindent' is set, line is visually indented. Then, the value
4829 of 'showbreak' is used to put in front of wrapped lines. This option
Bram Moolenaar86b17e92014-07-02 20:00:47 +02004830 is not used when the 'wrap' option is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004831 Note that <Tab> characters after an <EOL> are mostly not displayed
4832 with the right amount of white space.
4833
4834 *'lines'* *E593*
4835'lines' number (default 24 or terminal height)
4836 global
4837 Number of lines of the Vim window.
4838 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00004839 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004840 When Vim is running in the GUI or in a resizable window, setting this
4841 option will cause the window size to be changed. When you only want
4842 to use the size for the GUI, put the command in your |gvimrc| file.
4843 Vim limits the number of lines to what fits on the screen. You can
4844 use this command to get the tallest window possible: >
4845 :set lines=999
Bram Moolenaarf4d11452005-12-02 00:46:37 +00004846< Minimum value is 2, maximum value is 1000.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02004847 If you get fewer lines than expected, check the 'guiheadroom' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004848 When you set this option and Vim is unable to change the physical
4849 number of lines of the display, the display may be messed up.
4850
4851 *'linespace'* *'lsp'*
4852'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
4853 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004854 {only in the GUI}
4855 Number of pixel lines inserted between characters. Useful if the font
4856 uses the full character cell height, making lines touch each other.
4857 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004858 With some fonts there can be too much room between lines (to have
4859 space for ascents and descents). Then it makes sense to set
4860 'linespace' to a negative value. This may cause display problems
4861 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00004862
4863 *'lisp'* *'nolisp'*
4864'lisp' boolean (default off)
4865 local to buffer
4866 {not available when compiled without the |+lispindent|
4867 feature}
4868 Lisp mode: When <Enter> is typed in insert mode set the indent for
4869 the next line to Lisp standards (well, sort of). Also happens with
4870 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
4871 flag in 'cpoptions' changes the method of indenting: Vi compatible or
4872 better. Also see 'lispwords'.
4873 The '-' character is included in keyword characters. Redefines the
4874 "=" operator to use this same indentation algorithm rather than
4875 calling an external program if 'equalprg' is empty.
4876 This option is not used when 'paste' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004877
4878 *'lispwords'* *'lw'*
4879'lispwords' 'lw' string (default is very long)
Bram Moolenaaraf6c1312014-03-12 18:55:58 +01004880 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004881 {not available when compiled without the |+lispindent|
4882 feature}
4883 Comma separated list of words that influence the Lisp indenting.
4884 |'lisp'|
4885
4886 *'list'* *'nolist'*
4887'list' boolean (default off)
4888 local to window
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004889 List mode: Show tabs as CTRL-I is displayed, display $ after end of
4890 line. Useful to see the difference between tabs and spaces and for
4891 trailing blanks. Further changed by the 'listchars' option.
4892
4893 The cursor is displayed at the start of the space a Tab character
4894 occupies, not at the end as usual in Normal mode. To get this cursor
4895 position while displaying Tabs with spaces, use: >
Bram Moolenaardd007ed2013-07-09 15:44:17 +02004896 :set list lcs=tab:\ \
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004897<
4898 Note that list mode will also affect formatting (set with 'textwidth'
4899 or 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
Bram Moolenaar071d4272004-06-13 20:20:40 +00004900 changing the way tabs are displayed.
4901
4902 *'listchars'* *'lcs'*
4903'listchars' 'lcs' string (default "eol:$")
Bram Moolenaareed9d462021-02-15 20:38:25 +01004904 global or local to window |global-local|
Bram Moolenaarf9d5ca12010-08-01 16:13:51 +02004905 Strings to use in 'list' mode and for the |:list| command. It is a
4906 comma separated list of string settings.
Bram Moolenaar79278362015-04-21 18:33:48 +02004907 *lcs-eol*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004908 eol:c Character to show at the end of each line. When
4909 omitted, there is no extra character at the end of the
4910 line.
Bram Moolenaar79278362015-04-21 18:33:48 +02004911 *lcs-tab*
Bram Moolenaar83a52172019-01-16 22:41:54 +01004912 tab:xy[z] Two or three characters to be used to show a tab.
4913 The third character is optional.
4914
4915 tab:xy The 'x' is always used, then 'y' as many times as will
4916 fit. Thus "tab:>-" displays:
4917 >
4918 >-
4919 >--
4920 etc.
4921
4922 tab:xyz The 'z' is always used, then 'x' is prepended, and
4923 then 'y' is used as many times as will fit. Thus
4924 "tab:<->" displays:
4925 >
4926 <>
4927 <->
4928 <-->
4929 etc.
4930
4931 When "tab:" is omitted, a tab is shown as ^I.
Bram Moolenaar79278362015-04-21 18:33:48 +02004932 *lcs-space*
4933 space:c Character to show for a space. When omitted, spaces
4934 are left blank.
Bram Moolenaar91478ae2021-02-03 15:58:13 +01004935 *lcs-lead*
4936 lead:c Character to show for leading spaces. When omitted,
4937 leading spaces are blank. Overrides the "space"
Bram Moolenaar942db232021-02-13 18:14:48 +01004938 setting for leading spaces. You can combine it with
4939 "tab:", for example: >
4940 :set listchars+=tab:>-,lead:.
4941< *lcs-trail*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004942 trail:c Character to show for trailing spaces. When omitted,
Bram Moolenaar79278362015-04-21 18:33:48 +02004943 trailing spaces are blank. Overrides the "space"
4944 setting for trailing spaces.
4945 *lcs-extends*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004946 extends:c Character to show in the last column, when 'wrap' is
4947 off and the line continues beyond the right of the
4948 screen.
Bram Moolenaar79278362015-04-21 18:33:48 +02004949 *lcs-precedes*
Bram Moolenaarbffba7f2019-09-20 17:00:17 +02004950 precedes:c Character to show in the first visible column of the
4951 physical line, when there is text preceding the
4952 character visible in the first column.
Bram Moolenaar79278362015-04-21 18:33:48 +02004953 *lcs-conceal*
Bram Moolenaar860cae12010-06-05 23:22:07 +02004954 conceal:c Character to show in place of concealed text, when
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004955 'conceallevel' is set to 1.
Bram Moolenaar79278362015-04-21 18:33:48 +02004956 *lcs-nbsp*
Bram Moolenaar73284b92015-05-04 17:28:22 +02004957 nbsp:c Character to show for a non-breakable space character
4958 (0xA0 (160 decimal) and U+202F). Left blank when
4959 omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004960
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004961 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00004962 be used when 'encoding' is "utf-8", otherwise only printable
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004963 characters are allowed. All characters must be single width.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004964
4965 Examples: >
4966 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004967 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00004968 :set lcs=extends:>,precedes:<
4969< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaar79278362015-04-21 18:33:48 +02004970 "precedes". "SpecialKey" for "nbsp", "space", "tab" and "trail".
Bram Moolenaar02467872007-05-06 13:22:01 +00004971 |hl-NonText| |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004972
4973 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
4974'loadplugins' 'lpl' boolean (default on)
4975 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004976 When on the plugin scripts are loaded when starting up |load-plugins|.
4977 This option can be reset in your |vimrc| file to disable the loading
4978 of plugins.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02004979 Note that using the "-u NONE", "-u DEFAULTS" and "--noplugin" command
4980 line arguments reset this option. See |-u| and |--noplugin|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004981
Bram Moolenaard94464e2015-11-02 15:28:18 +01004982 *'luadll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01004983'luadll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01004984 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01004985 {only available when compiled with the |+lua/dyn|
4986 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01004987 Specifies the name of the Lua shared library. The default is
4988 DYNAMIC_LUA_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02004989 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01004990 This option cannot be set from a |modeline| or in the |sandbox|, for
4991 security reasons.
4992
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00004993 *'macatsui'* *'nomacatsui'*
4994'macatsui' boolean (default on)
4995 global
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02004996 {not supported}
4997 No longer supported, as the Mac OS X GUI code was removed.
Bram Moolenaar02467872007-05-06 13:22:01 +00004998
Bram Moolenaar071d4272004-06-13 20:20:40 +00004999 *'magic'* *'nomagic'*
5000'magic' boolean (default on)
5001 global
5002 Changes the special characters that can be used in search patterns.
5003 See |pattern|.
Bram Moolenaar64d8e252016-09-06 22:12:34 +02005004 WARNING: Switching this option off most likely breaks plugins! That
5005 is because many patterns assume it's on and will fail when it's off.
5006 Only switch it off when working with old Vi scripts. In any other
5007 situation write patterns that work when 'magic' is on. Include "\M"
5008 when you want to |/\M|.
Bram Moolenaar4072ba52020-12-23 13:56:35 +01005009 In |Vim9| script the value of 'magic' is ignored, patterns behave like
5010 it is always set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005011
5012 *'makeef'* *'mef'*
5013'makeef' 'mef' string (default: "")
5014 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005015 {not available when compiled without the |+quickfix|
5016 feature}
5017 Name of the errorfile for the |:make| command (see |:make_makeprg|)
5018 and the |:grep| command.
5019 When it is empty, an internally generated temp file will be used.
5020 When "##" is included, it is replaced by a number to make the name
5021 unique. This makes sure that the ":make" command doesn't overwrite an
5022 existing file.
5023 NOT used for the ":cf" command. See 'errorfile' for that.
5024 Environment variables are expanded |:set_env|.
5025 See |option-backslash| about including spaces and backslashes.
5026 This option cannot be set from a |modeline| or in the |sandbox|, for
5027 security reasons.
5028
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01005029 *'makeencoding'* *'menc'*
5030'makeencoding' 'menc' string (default "")
5031 global or local to buffer |global-local|
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01005032 Encoding used for reading the output of external commands. When empty,
5033 encoding is not converted.
5034 This is used for `:make`, `:lmake`, `:grep`, `:lgrep`, `:grepadd`,
5035 `:lgrepadd`, `:cfile`, `:cgetfile`, `:caddfile`, `:lfile`, `:lgetfile`,
5036 and `:laddfile`.
5037
5038 This would be mostly useful when you use MS-Windows and set 'encoding'
5039 to "utf-8". If |+iconv| is enabled and GNU libiconv is used, setting
5040 'makeencoding' to "char" has the same effect as setting to the system
5041 locale encoding. Example: >
5042 :set encoding=utf-8
5043 :set makeencoding=char " system locale is used
5044<
Bram Moolenaar071d4272004-06-13 20:20:40 +00005045 *'makeprg'* *'mp'*
5046'makeprg' 'mp' string (default "make", VMS: "MMS")
5047 global or local to buffer |global-local|
Bram Moolenaar02467872007-05-06 13:22:01 +00005048 Program to use for the ":make" command. See |:make_makeprg|.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01005049 This option may contain '%' and '#' characters (see |:_%| and |:_#|),
5050 which are expanded to the current and alternate file name. Use |::S|
Bram Moolenaar26df0922014-02-23 23:39:13 +01005051 to escape file names in case they contain special characters.
Bram Moolenaar02467872007-05-06 13:22:01 +00005052 Environment variables are expanded |:set_env|. See |option-backslash|
5053 about including spaces and backslashes.
5054 Note that a '|' must be escaped twice: once for ":set" and once for
5055 the interpretation of a command. When you use a filter called
5056 "myfilter" do it like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005057 :set makeprg=gmake\ \\\|\ myfilter
5058< The placeholder "$*" can be given (even multiple times) to specify
5059 where the arguments will be included, for example: >
5060 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
5061< This option cannot be set from a |modeline| or in the |sandbox|, for
5062 security reasons.
5063
5064 *'matchpairs'* *'mps'*
5065'matchpairs' 'mps' string (default "(:),{:},[:]")
5066 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005067 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01005068 other.
5069 Only character pairs are allowed that are different, thus you cannot
5070 jump between two double quotes.
5071 The characters must be separated by a colon.
Bram Moolenaar02467872007-05-06 13:22:01 +00005072 The pairs must be separated by a comma. Example for including '<' and
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02005073 '>' (for HTML): >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005074 :set mps+=<:>
5075
5076< A more exotic example, to jump between the '=' and ';' in an
5077 assignment, useful for languages like C and Java: >
5078 :au FileType c,cpp,java set mps+==:;
5079
5080< For a more advanced way of using "%", see the matchit.vim plugin in
Bram Moolenaar01164a62017-11-02 22:58:42 +01005081 the $VIMRUNTIME/pack/dist/opt/matchit directory. |add-local-help|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005082
5083 *'matchtime'* *'mat'*
5084'matchtime' 'mat' number (default 5)
5085 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005086 Tenths of a second to show the matching paren, when 'showmatch' is
5087 set. Note that this is not in milliseconds, like other options that
5088 set a time. This is to be compatible with Nvi.
5089
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005090 *'maxcombine'* *'mco'*
5091'maxcombine' 'mco' number (default 2)
5092 global
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005093 The maximum number of combining characters supported for displaying.
5094 Only used when 'encoding' is "utf-8".
5095 The default is OK for most languages. Hebrew may require 4.
5096 Maximum value is 6.
5097 Even when this option is set to 2 you can still edit text with more
5098 combining characters, you just can't see them. Use |g8| or |ga|.
5099 See |mbyte-combining|.
5100
Bram Moolenaar071d4272004-06-13 20:20:40 +00005101 *'maxfuncdepth'* *'mfd'*
5102'maxfuncdepth' 'mfd' number (default 100)
5103 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02005104 {not available when compiled without the |+eval|
Bram Moolenaar02467872007-05-06 13:22:01 +00005105 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005106 Maximum depth of function calls for user functions. This normally
5107 catches endless recursion. When using a recursive function with
5108 more depth, set 'maxfuncdepth' to a bigger number. But this will use
5109 more memory, there is the danger of failing when memory is exhausted.
Bram Moolenaarbc2eada2017-01-02 21:27:47 +01005110 Increasing this limit above 200 also changes the maximum for Ex
Bram Moolenaar0b0f0992018-05-22 21:41:30 +02005111 command recursion, see |E169|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005112 See also |:function|.
5113
5114 *'maxmapdepth'* *'mmd'* *E223*
5115'maxmapdepth' 'mmd' number (default 1000)
5116 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005117 Maximum number of times a mapping is done without resulting in a
5118 character to be used. This normally catches endless mappings, like
5119 ":map x y" with ":map y x". It still does not catch ":map g wg",
5120 because the 'w' is used before the next mapping is done. See also
5121 |key-mapping|.
5122
5123 *'maxmem'* *'mm'*
5124'maxmem' 'mm' number (default between 256 to 5120 (system
5125 dependent) or half the amount of memory
5126 available)
5127 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005128 Maximum amount of memory (in Kbyte) to use for one buffer. When this
5129 limit is reached allocating extra memory for a buffer will cause
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005130 other memory to be freed.
5131 The maximum usable value is about 2000000. Use this to work without a
5132 limit.
5133 The value is ignored when 'swapfile' is off.
5134 Also see 'maxmemtot'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005135
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005136 *'maxmempattern'* *'mmp'*
5137'maxmempattern' 'mmp' number (default 1000)
5138 global
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005139 Maximum amount of memory (in Kbyte) to use for pattern matching.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005140 The maximum value is about 2000000. Use this to work without a limit.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005141 *E363*
Bram Moolenaar02467872007-05-06 13:22:01 +00005142 When Vim runs into the limit it gives an error message and mostly
5143 behaves like CTRL-C was typed.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005144 Running into the limit often means that the pattern is very
5145 inefficient or too complex. This may already happen with the pattern
5146 "\(.\)*" on a very long line. ".*" works much better.
Bram Moolenaarfd358112018-07-07 23:21:31 +02005147 Might also happen on redraw, when syntax rules try to match a complex
5148 text structure.
5149 Vim may run out of memory before hitting the 'maxmempattern' limit, in
5150 which case you get an "Out of memory" error instead.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005151
Bram Moolenaar071d4272004-06-13 20:20:40 +00005152 *'maxmemtot'* *'mmt'*
5153'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
5154 dependent) or half the amount of memory
5155 available)
5156 global
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005157 Maximum amount of memory in Kbyte to use for all buffers together.
5158 The maximum usable value is about 2000000 (2 Gbyte). Use this to work
Bram Moolenaarfa735342016-01-03 22:14:44 +01005159 without a limit.
5160 On 64 bit machines higher values might work. But hey, do you really
5161 need more than 2 Gbyte for text editing? Keep in mind that text is
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005162 stored in the swap file, one can edit files > 2 Gbyte anyway. We do
Bram Moolenaarfa735342016-01-03 22:14:44 +01005163 need the memory to store undo info.
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005164 Buffers with 'swapfile' off still count to the total amount of memory
5165 used.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005166 Also see 'maxmem'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005167
5168 *'menuitems'* *'mis'*
5169'menuitems' 'mis' number (default 25)
5170 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005171 {not available when compiled without the |+menu|
5172 feature}
5173 Maximum number of items to use in a menu. Used for menus that are
5174 generated from a list of items, e.g., the Buffers menu. Changing this
5175 option has no direct effect, the menu must be refreshed first.
5176
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005177 *'mkspellmem'* *'msm'*
5178'mkspellmem' 'msm' string (default "460000,2000,500")
5179 global
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005180 {not available when compiled without the |+syntax|
5181 feature}
5182 Parameters for |:mkspell|. This tunes when to start compressing the
5183 word tree. Compression can be slow when there are many words, but
5184 it's needed to avoid running out of memory. The amount of memory used
5185 per word depends very much on how similar the words are, that's why
5186 this tuning is complicated.
5187
5188 There are three numbers, separated by commas:
5189 {start},{inc},{added}
5190
5191 For most languages the uncompressed word tree fits in memory. {start}
5192 gives the amount of memory in Kbyte that can be used before any
5193 compression is done. It should be a bit smaller than the amount of
5194 memory that is available to Vim.
5195
5196 When going over the {start} limit the {inc} number specifies the
5197 amount of memory in Kbyte that can be allocated before another
5198 compression is done. A low number means compression is done after
5199 less words are added, which is slow. A high number means more memory
5200 will be allocated.
5201
5202 After doing compression, {added} times 1024 words can be added before
5203 the {inc} limit is ignored and compression is done when any extra
5204 amount of memory is needed. A low number means there is a smaller
5205 chance of hitting the {inc} limit, less memory is used but it's
5206 slower.
5207
5208 The languages for which these numbers are important are Italian and
5209 Hungarian. The default works for when you have about 512 Mbyte. If
5210 you have 1 Gbyte you could use: >
5211 :set mkspellmem=900000,3000,800
5212< If you have less than 512 Mbyte |:mkspell| may fail for some
5213 languages, no matter what you set 'mkspellmem' to.
5214
Bram Moolenaar07607392019-05-26 19:20:43 +02005215 This option cannot be set from a |modeline| or in the |sandbox|.
5216
Bram Moolenaar071d4272004-06-13 20:20:40 +00005217 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
Bram Moolenaar8243a792007-05-01 17:05:03 +00005218'modeline' 'ml' boolean (Vim default: on (off for root),
5219 Vi default: off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005220 local to buffer
Bram Moolenaar110289e2019-05-23 15:38:06 +02005221 If 'modeline' is on 'modelines' gives the number of lines that is
5222 checked for set commands. If 'modeline' is off or 'modelines' is zero
5223 no lines are checked. See |modeline|.
5224
5225 *'modelineexpr'* *'mle'* *'nomodelineexpr'* *'nomle'*
5226'modelineexpr' 'mle' boolean (default: off)
5227 global
5228 When on allow some options that are an expression to be set in the
5229 modeline. Check the option for whether it is affected by
5230 'modelineexpr'. Also see |modeline|.
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02005231 This option cannot be set from a |modeline| or in the |sandbox|, for
5232 security reasons.
Bram Moolenaar110289e2019-05-23 15:38:06 +02005233
Bram Moolenaar071d4272004-06-13 20:20:40 +00005234 *'modelines'* *'mls'*
5235'modelines' 'mls' number (default 5)
5236 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005237 If 'modeline' is on 'modelines' gives the number of lines that is
5238 checked for set commands. If 'modeline' is off or 'modelines' is zero
5239 no lines are checked. See |modeline|.
5240 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
5241 set and to the Vim default value when 'compatible' is reset.
5242
5243 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
Bram Moolenaar110289e2019-05-23 15:38:06 +02005244 *E21*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005245'modifiable' 'ma' boolean (default on)
5246 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005247 When off the buffer contents cannot be changed. The 'fileformat' and
5248 'fileencoding' options also can't be changed.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01005249 Can be reset on startup with the |-M| command line argument.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005250
5251 *'modified'* *'mod'* *'nomodified'* *'nomod'*
5252'modified' 'mod' boolean (default off)
5253 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005254 When on, the buffer is considered to be modified. This option is set
5255 when:
5256 1. A change was made to the text since it was last written. Using the
5257 |undo| command to go back to the original text will reset the
5258 option. But undoing changes that were made before writing the
5259 buffer will set the option again, since the text is different from
5260 when it was written.
5261 2. 'fileformat' or 'fileencoding' is different from its original
5262 value. The original value is set when the buffer is read or
5263 written. A ":set nomodified" command also resets the original
5264 values to the current values and the 'modified' option will be
5265 reset.
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01005266 Similarly for 'eol' and 'bomb'.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02005267 This option is not set when a change is made to the buffer as the
5268 result of a BufNewFile, BufRead/BufReadPost, BufWritePost,
5269 FileAppendPost or VimLeave autocommand event. See |gzip-example| for
5270 an explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005271 When 'buftype' is "nowrite" or "nofile" this option may be set, but
5272 will be ignored.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01005273 Note that the text may actually be the same, e.g. 'modified' is set
5274 when using "rA" on an "A".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005275
5276 *'more'* *'nomore'*
5277'more' boolean (Vim default: on, Vi default: off)
5278 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005279 When on, listings pause when the whole screen is filled. You will get
5280 the |more-prompt|. When this option is off there are no pauses, the
5281 listing continues until finished.
5282 NOTE: This option is set to the Vi default value when 'compatible' is
5283 set and to the Vim default value when 'compatible' is reset.
5284
Bram Moolenaar98a29d02021-01-18 19:55:44 +01005285 *'mouse'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005286'mouse' string (default "", "a" for GUI and Win32,
Bram Moolenaar5b418992019-10-27 18:50:25 +01005287 set to "a" or "nvi" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005288 global
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005289 Enable the use of the mouse. Works for most terminals (xterm, Win32
5290 |win32-mouse|, QNX pterm, *BSD console with sysmouse and Linux console
5291 with gpm). For using the mouse in the GUI, see |gui-mouse|. The
5292 mouse can be enabled for different modes:
Bram Moolenaar7f2e9d72017-11-11 20:58:53 +01005293 n Normal mode and Terminal modes
Bram Moolenaar071d4272004-06-13 20:20:40 +00005294 v Visual mode
5295 i Insert mode
5296 c Command-line mode
5297 h all previous modes when editing a help file
5298 a all previous modes
5299 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005300 Normally you would enable the mouse in all five modes with: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005301 :set mouse=a
Bram Moolenaar5b418992019-10-27 18:50:25 +01005302< If your terminal can't overrule the mouse events going to the
5303 application, use: >
5304 :set mouse=nvi
Bram Moolenaar65e0d772020-06-14 17:29:55 +02005305< Then you can press ":", select text for the system, and press Esc to go
Bram Moolenaar5b418992019-10-27 18:50:25 +01005306 back to Vim using the mouse events.
5307 In |defaults.vim| "nvi" is used if the 'term' option is not matching
5308 "xterm".
5309
5310 When the mouse is not enabled, the GUI will still use the mouse for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005311 modeless selection. This doesn't move the text cursor.
5312
5313 See |mouse-using|. Also see |'clipboard'|.
5314
5315 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005316 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005317 the mouse buttons can still be used by keeping the shift key pressed.
5318 Also see the 'clipboard' option.
5319
5320 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
5321'mousefocus' 'mousef' boolean (default off)
5322 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005323 {only works in the GUI}
5324 The window that the mouse pointer is on is automatically activated.
5325 When changing the window layout or window focus in another way, the
5326 mouse pointer is moved to the window with keyboard focus. Off is the
5327 default because it makes using the pull down menus a little goofy, as
5328 a pointer transit may activate a window unintentionally.
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01005329 MS-Windows: Also see 'scrollfocus' for what window is scrolled when
Bram Moolenaar1d9215b2020-01-25 13:27:42 +01005330 using the mouse scroll wheel.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005331
5332 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
5333'mousehide' 'mh' boolean (default on)
5334 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005335 {only works in the GUI}
5336 When on, the mouse pointer is hidden when characters are typed.
5337 The mouse pointer is restored when the mouse is moved.
5338
5339 *'mousemodel'* *'mousem'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005340'mousemodel' 'mousem' string (default "extend", "popup" for Win32)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005341 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005342 Sets the model to use for the mouse. The name mostly specifies what
5343 the right mouse button is used for:
5344 extend Right mouse button extends a selection. This works
5345 like in an xterm.
5346 popup Right mouse button pops up a menu. The shifted left
5347 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00005348 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005349 popup_setpos Like "popup", but the cursor will be moved to the
5350 position where the mouse was clicked, and thus the
5351 selected operation will act upon the clicked object.
5352 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00005353 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005354 course, that right clicking outside a selection will
5355 end Visual mode.
5356 Overview of what button does what for each model:
5357 mouse extend popup(_setpos) ~
5358 left click place cursor place cursor
5359 left drag start selection start selection
5360 shift-left search word extend selection
5361 right click extend selection popup menu (place cursor)
5362 right drag extend selection -
5363 middle click paste paste
5364
5365 In the "popup" model the right mouse button produces a pop-up menu.
5366 You need to define this first, see |popup-menu|.
5367
5368 Note that you can further refine the meaning of buttons with mappings.
5369 See |gui-mouse-mapping|. But mappings are NOT used for modeless
5370 selection (because that's handled in the GUI code directly).
5371
5372 The 'mousemodel' option is set by the |:behave| command.
5373
5374 *'mouseshape'* *'mouses'* *E547*
Bram Moolenaarf6b40102019-02-22 15:24:03 +01005375'mouseshape' 'mouses' string (default "i-r:beam,s:updown,sd:udsizing,
5376 vs:leftright,vd:lrsizing,m:no,
5377 ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005378 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005379 {only available when compiled with the |+mouseshape|
5380 feature}
5381 This option tells Vim what the mouse pointer should look like in
5382 different modes. The option is a comma separated list of parts, much
5383 like used for 'guicursor'. Each part consist of a mode/location-list
5384 and an argument-list:
5385 mode-list:shape,mode-list:shape,..
5386 The mode-list is a dash separated list of these modes/locations:
5387 In a normal window: ~
5388 n Normal mode
5389 v Visual mode
5390 ve Visual mode with 'selection' "exclusive" (same as 'v',
5391 if not specified)
5392 o Operator-pending mode
5393 i Insert mode
5394 r Replace mode
5395
5396 Others: ~
5397 c appending to the command-line
5398 ci inserting in the command-line
5399 cr replacing in the command-line
5400 m at the 'Hit ENTER' or 'More' prompts
5401 ml idem, but cursor in the last line
5402 e any mode, pointer below last window
5403 s any mode, pointer on a status line
5404 sd any mode, while dragging a status line
5405 vs any mode, pointer on a vertical separator line
5406 vd any mode, while dragging a vertical separator line
5407 a everywhere
5408
5409 The shape is one of the following:
5410 avail name looks like ~
5411 w x arrow Normal mouse pointer
5412 w x blank no pointer at all (use with care!)
5413 w x beam I-beam
5414 w x updown up-down sizing arrows
5415 w x leftright left-right sizing arrows
5416 w x busy The system's usual busy pointer
5417 w x no The system's usual 'no input' pointer
5418 x udsizing indicates up-down resizing
5419 x lrsizing indicates left-right resizing
5420 x crosshair like a big thin +
5421 x hand1 black hand
5422 x hand2 white hand
5423 x pencil what you write with
5424 x question big ?
5425 x rightup-arrow arrow pointing right-up
5426 w x up-arrow arrow pointing up
5427 x <number> any X11 pointer number (see X11/cursorfont.h)
5428
5429 The "avail" column contains a 'w' if the shape is available for Win32,
5430 x for X11.
5431 Any modes not specified or shapes not available use the normal mouse
5432 pointer.
5433
5434 Example: >
5435 :set mouseshape=s:udsizing,m:no
5436< will make the mouse turn to a sizing arrow over the status lines and
5437 indicate no input when the hit-enter prompt is displayed (since
5438 clicking the mouse has no effect in this state.)
5439
5440 *'mousetime'* *'mouset'*
5441'mousetime' 'mouset' number (default 500)
5442 global
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005443 Only for GUI, Win32 and Unix with xterm. Defines the maximum
Bram Moolenaar071d4272004-06-13 20:20:40 +00005444 time in msec between two mouse clicks for the second click to be
5445 recognized as a multi click.
5446
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005447 *'mzschemedll'*
5448'mzschemedll' string (default depends on the build)
5449 global
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005450 {only available when compiled with the |+mzscheme/dyn|
5451 feature}
5452 Specifies the name of the MzScheme shared library. The default is
5453 DYNAMIC_MZSCH_DLL which was specified at compile time.
5454 Environment variables are expanded |:set_env|.
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01005455 The value must be set in the |vimrc| script or earlier. In the
Bram Moolenaar01164a62017-11-02 22:58:42 +01005456 startup, before the |load-plugins| step.
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005457 This option cannot be set from a |modeline| or in the |sandbox|, for
5458 security reasons.
5459
5460 *'mzschemegcdll'*
5461'mzschemegcdll' string (default depends on the build)
5462 global
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005463 {only available when compiled with the |+mzscheme/dyn|
5464 feature}
5465 Specifies the name of the MzScheme GC shared library. The default is
5466 DYNAMIC_MZGC_DLL which was specified at compile time.
5467 The value can be equal to 'mzschemedll' if it includes the GC code.
5468 Environment variables are expanded |:set_env|.
5469 This option cannot be set from a |modeline| or in the |sandbox|, for
5470 security reasons.
5471
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005472 *'mzquantum'* *'mzq'*
5473'mzquantum' 'mzq' number (default 100)
5474 global
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005475 {not available when compiled without the |+mzscheme|
5476 feature}
5477 The number of milliseconds between polls for MzScheme threads.
5478 Negative or zero value means no thread scheduling.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005479 NOTE: This option is set to the Vim default value when 'compatible'
5480 is reset.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005481
Bram Moolenaar071d4272004-06-13 20:20:40 +00005482 *'nrformats'* *'nf'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02005483'nrformats' 'nf' string (default "bin,octal,hex",
5484 set to "bin,hex" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005485 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005486 This defines what bases Vim will consider for numbers when using the
5487 CTRL-A and CTRL-X commands for adding to and subtracting from a number
5488 respectively; see |CTRL-A| for more info on these commands.
Bram Moolenaar4770d092006-01-12 23:22:24 +00005489 alpha If included, single alphabetical characters will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005490 incremented or decremented. This is useful for a list with a
Bram Moolenaar3848e002016-03-19 18:42:29 +01005491 letter index a), b), etc. *octal-nrformats*
Bram Moolenaar4770d092006-01-12 23:22:24 +00005492 octal If included, numbers that start with a zero will be considered
Bram Moolenaar071d4272004-06-13 20:20:40 +00005493 to be octal. Example: Using CTRL-A on "007" results in "010".
Bram Moolenaar4770d092006-01-12 23:22:24 +00005494 hex If included, numbers starting with "0x" or "0X" will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005495 considered to be hexadecimal. Example: Using CTRL-X on
5496 "0x100" results in "0x0ff".
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005497 bin If included, numbers starting with "0b" or "0B" will be
5498 considered to be binary. Example: Using CTRL-X on
5499 "0b1000" subtracts one, resulting in "0b0111".
Bram Moolenaaraaad9952020-05-31 15:08:59 +02005500 unsigned If included, numbers are recognized as unsigned. Thus a
5501 leading dash or negative sign won't be considered as part of
5502 the number. Examples:
5503 Using CTRL-X on "2020" in "9-2020" results in "9-2019"
5504 (without "unsigned" it would become "9-2021").
5505 Using CTRL-A on "2020" in "9-2020" results in "9-2021"
5506 (without "unsigned" it would become "9-2019").
Bram Moolenaaracc22402020-06-07 21:07:18 +02005507 Using CTRL-X on "0" or CTRL-A on "18446744073709551615"
5508 (2^64 - 1) has no effect, overflow is prevented.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005509 Numbers which simply begin with a digit in the range 1-9 are always
5510 considered decimal. This also happens for numbers that are not
5511 recognized as octal or hex.
5512
5513 *'number'* *'nu'* *'nonumber'* *'nonu'*
5514'number' 'nu' boolean (default off)
5515 local to window
5516 Print the line number in front of each line. When the 'n' option is
5517 excluded from 'cpoptions' a wrapped line will not use the column of
5518 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005519 The 'numberwidth' option can be used to set the room used for the line
5520 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005521 When a long, wrapped line doesn't start with the first character, '-'
5522 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02005523 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
5524 the number.
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005525 *number_relativenumber*
5526 The 'relativenumber' option changes the displayed number to be
5527 relative to the cursor. Together with 'number' there are these
5528 four combinations (cursor in line 3):
5529
Bram Moolenaar3848e002016-03-19 18:42:29 +01005530 'nonu' 'nu' 'nonu' 'nu'
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005531 'nornu' 'nornu' 'rnu' 'rnu'
5532
5533 |apple | 1 apple | 2 apple | 2 apple
5534 |pear | 2 pear | 1 pear | 1 pear
5535 |nobody | 3 nobody | 0 nobody |3 nobody
5536 |there | 4 there | 1 there | 1 there
Bram Moolenaar071d4272004-06-13 20:20:40 +00005537
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005538 *'numberwidth'* *'nuw'*
5539'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
5540 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005541 {only available when compiled with the |+linebreak|
5542 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005543 Minimal number of columns to use for the line number. Only relevant
Bram Moolenaar64486672010-05-16 15:46:46 +02005544 when the 'number' or 'relativenumber' option is set or printing lines
5545 with a line number. Since one space is always between the number and
5546 the text, there is one less character for the number itself.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005547 The value is the minimum width. A bigger width is used when needed to
Bram Moolenaar64486672010-05-16 15:46:46 +02005548 fit the highest line number in the buffer respectively the number of
5549 rows in the window, depending on whether 'number' or 'relativenumber'
5550 is set. Thus with the Vim default of 4 there is room for a line number
5551 up to 999. When the buffer has 1000 lines five columns will be used.
Bram Moolenaarf8a07122019-07-01 22:06:07 +02005552 The minimum value is 1, the maximum value is 20.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005553 NOTE: This option is set to the Vi default value when 'compatible' is
5554 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005555
Bram Moolenaarf75a9632005-09-13 21:20:47 +00005556 *'omnifunc'* *'ofu'*
5557'omnifunc' 'ofu' string (default: empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00005558 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02005559 {not available when compiled without the |+eval|
Bram Moolenaare2c453d2019-08-21 14:37:09 +02005560 feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00005561 This option specifies a function to be used for Insert mode omni
5562 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
Bram Moolenaar280f1262006-01-30 00:14:18 +00005563 See |complete-functions| for an explanation of how the function is
5564 invoked and what it should return.
Bram Moolenaar043545e2006-10-10 16:44:07 +00005565 This option is usually set by a filetype plugin:
Bram Moolenaar9c102382006-05-03 21:26:49 +00005566 |:filetype-plugin-on|
Bram Moolenaar30b65812012-07-12 22:01:11 +02005567 This option cannot be set from a |modeline| or in the |sandbox|, for
5568 security reasons.
Bram Moolenaare344bea2005-09-01 20:46:49 +00005569
5570
Bram Moolenaar02467872007-05-06 13:22:01 +00005571 *'opendevice'* *'odev'* *'noopendevice'* *'noodev'*
Bram Moolenaar043545e2006-10-10 16:44:07 +00005572'opendevice' 'odev' boolean (default off)
5573 global
Bram Moolenaar6f345a12019-12-17 21:27:18 +01005574 {only for MS-Windows}
Bram Moolenaar043545e2006-10-10 16:44:07 +00005575 Enable reading and writing from devices. This may get Vim stuck on a
5576 device that can be opened but doesn't actually do the I/O. Therefore
5577 it is off by default.
5578 Note that on MS-Windows editing "aux.h", "lpt1.txt" and the like also
5579 result in editing a device.
5580
5581
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005582 *'operatorfunc'* *'opfunc'*
5583'operatorfunc' 'opfunc' string (default: empty)
5584 global
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005585 This option specifies a function to be called by the |g@| operator.
5586 See |:map-operator| for more info and an example.
5587
5588 This option cannot be set from a |modeline| or in the |sandbox|, for
5589 security reasons.
5590
5591
Bram Moolenaar251e1912011-06-19 05:09:16 +02005592 *'osfiletype'* *'oft'*
5593'osfiletype' 'oft' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005594 local to buffer
Bram Moolenaar251e1912011-06-19 05:09:16 +02005595 This option was supported on RISC OS, which has been removed.
5596
Bram Moolenaar071d4272004-06-13 20:20:40 +00005597
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005598 *'packpath'* *'pp'*
5599'packpath' 'pp' string (default: see 'runtimepath')
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005600 Directories used to find packages. See |packages|.
5601
5602
Bram Moolenaar071d4272004-06-13 20:20:40 +00005603 *'paragraphs'* *'para'*
Bram Moolenaar57e48462008-03-12 16:38:55 +00005604'paragraphs' 'para' string (default "IPLPPPQPP TPHPLIPpLpItpplpipbp")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005605 global
5606 Specifies the nroff macros that separate paragraphs. These are pairs
5607 of two letters (see |object-motions|).
5608
5609 *'paste'* *'nopaste'*
5610'paste' boolean (default off)
5611 global
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005612 Put Vim in Paste mode. This is useful if you want to cut or copy
5613 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005614 unexpected effects.
5615 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005616 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00005617 knows about pasting and will mostly do the right thing without 'paste'
5618 being set. The same is true for a terminal where Vim handles the
5619 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00005620 This option is reset when starting the GUI. Thus if you set it in
5621 your .vimrc it will work in a terminal, but not in the GUI. Setting
5622 'paste' in the GUI has side effects: e.g., the Paste toolbar button
5623 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005624 When the 'paste' option is switched on (also when it was already on):
5625 - mapping in Insert mode and Command-line mode is disabled
5626 - abbreviations are disabled
Bram Moolenaar071d4272004-06-13 20:20:40 +00005627 - 'autoindent' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02005628 - 'expandtab' is reset
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02005629 - 'hkmap' is reset
Bram Moolenaar071d4272004-06-13 20:20:40 +00005630 - 'revins' is reset
5631 - 'ruler' is reset
5632 - 'showmatch' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02005633 - 'smarttab' is reset
5634 - 'softtabstop' is set to 0
5635 - 'textwidth' is set to 0
5636 - 'wrapmargin' is set to 0
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02005637 - 'varsofttabstop' is made empty
Bram Moolenaar071d4272004-06-13 20:20:40 +00005638 These options keep their value, but their effect is disabled:
Bram Moolenaar071d4272004-06-13 20:20:40 +00005639 - 'cindent'
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02005640 - 'formatoptions' is used like it is empty
Bram Moolenaarca635012015-09-25 20:34:21 +02005641 - 'indentexpr'
5642 - 'lisp'
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02005643 - 'smartindent'
Bram Moolenaar071d4272004-06-13 20:20:40 +00005644 NOTE: When you start editing another file while the 'paste' option is
5645 on, settings from the modelines or autocommands may change the
5646 settings again, causing trouble when pasting text. You might want to
5647 set the 'paste' option again.
5648 When the 'paste' option is reset the mentioned options are restored to
5649 the value before the moment 'paste' was switched from off to on.
5650 Resetting 'paste' before ever setting it does not have any effect.
5651 Since mapping doesn't work while 'paste' is active, you need to use
5652 the 'pastetoggle' option to toggle the 'paste' option with some key.
5653
5654 *'pastetoggle'* *'pt'*
5655'pastetoggle' 'pt' string (default "")
5656 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005657 When non-empty, specifies the key sequence that toggles the 'paste'
5658 option. This is like specifying a mapping: >
5659 :map {keys} :set invpaste<CR>
5660< Where {keys} is the value of 'pastetoggle'.
5661 The difference is that it will work even when 'paste' is set.
5662 'pastetoggle' works in Insert mode and Normal mode, but not in
5663 Command-line mode.
5664 Mappings are checked first, thus overrule 'pastetoggle'. However,
5665 when 'paste' is on mappings are ignored in Insert mode, thus you can do
5666 this: >
5667 :map <F10> :set paste<CR>
5668 :map <F11> :set nopaste<CR>
5669 :imap <F10> <C-O>:set paste<CR>
5670 :imap <F11> <nop>
5671 :set pastetoggle=<F11>
5672< This will make <F10> start paste mode and <F11> stop paste mode.
5673 Note that typing <F10> in paste mode inserts "<F10>", since in paste
5674 mode everything is inserted literally, except the 'pastetoggle' key
5675 sequence.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005676 When the value has several bytes 'ttimeoutlen' applies.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005677
5678 *'pex'* *'patchexpr'*
5679'patchexpr' 'pex' string (default "")
5680 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005681 {not available when compiled without the |+diff|
5682 feature}
5683 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005684 the resulting new version of the file. See |diff-patchexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005685
Bram Moolenaardbc28022014-07-26 13:40:44 +02005686 *'patchmode'* *'pm'* *E205* *E206*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005687'patchmode' 'pm' string (default "")
5688 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005689 When non-empty the oldest version of a file is kept. This can be used
5690 to keep the original version of a file if you are changing files in a
5691 source distribution. Only the first time that a file is written a
5692 copy of the original file will be kept. The name of the copy is the
5693 name of the original file with the string in the 'patchmode' option
5694 appended. This option should start with a dot. Use a string like
Bram Moolenaardf980db2017-12-24 13:22:00 +01005695 ".orig" or ".org". 'backupdir' must not be empty for this to work
5696 (Detail: The backup file is renamed to the patchmode file after the
5697 new file has been successfully written, that's why it must be possible
5698 to write a backup file). If there was no file to be backed up, an
5699 empty file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005700 When the 'backupskip' pattern matches, a patchmode file is not made.
5701 Using 'patchmode' for compressed files appends the extension at the
5702 end (e.g., "file.gz.orig"), thus the resulting name isn't always
5703 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005704 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005705
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01005706 *'path'* *'pa'* *E343* *E345* *E347* *E854*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005707'path' 'pa' string (default on Unix: ".,/usr/include,,"
Bram Moolenaar071d4272004-06-13 20:20:40 +00005708 other systems: ".,,")
5709 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005710 This is a list of directories which will be searched when using the
Bram Moolenaarc236c162008-07-13 17:41:49 +00005711 |gf|, [f, ]f, ^Wf, |:find|, |:sfind|, |:tabfind| and other commands,
5712 provided that the file being searched for has a relative path (not
5713 starting with "/", "./" or "../"). The directories in the 'path'
5714 option may be relative or absolute.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005715 - Use commas to separate directory names: >
5716 :set path=.,/usr/local/include,/usr/include
5717< - Spaces can also be used to separate directory names (for backwards
5718 compatibility with version 3.0). To have a space in a directory
5719 name, precede it with an extra backslash, and escape the space: >
5720 :set path=.,/dir/with\\\ space
5721< - To include a comma in a directory name precede it with an extra
5722 backslash: >
5723 :set path=.,/dir/with\\,comma
5724< - To search relative to the directory of the current file, use: >
5725 :set path=.
5726< - To search in the current directory use an empty string between two
5727 commas: >
5728 :set path=,,
5729< - A directory name may end in a ':' or '/'.
5730 - Environment variables are expanded |:set_env|.
5731 - When using |netrw.vim| URLs can be used. For example, adding
5732 "http://www.vim.org" will make ":find index.html" work.
Bram Moolenaarc236c162008-07-13 17:41:49 +00005733 - Search upwards and downwards in a directory tree using "*", "**" and
5734 ";". See |file-searching| for info and syntax.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005735 {not available when compiled without the |+path_extra| feature}
5736 - Careful with '\' characters, type two to get one in the option: >
5737 :set path=.,c:\\include
5738< Or just use '/' instead: >
5739 :set path=.,c:/include
5740< Don't forget "." or files won't even be found in the same directory as
5741 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005742 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00005743 it is something like 256 or 1024 characters.
5744 You can check if all the include files are found, using the value of
5745 'path', see |:checkpath|.
5746 The use of |:set+=| and |:set-=| is preferred when adding or removing
5747 directories from the list. This avoids problems when a future version
5748 uses another default. To remove the current directory use: >
5749 :set path-=
5750< To add the current directory use: >
5751 :set path+=
5752< To use an environment variable, you probably need to replace the
5753 separator. Here is an example to append $INCL, in which directory
5754 names are separated with a semi-colon: >
5755 :let &path = &path . "," . substitute($INCL, ';', ',', 'g')
5756< Replace the ';' with a ':' or whatever separator is used. Note that
5757 this doesn't work when $INCL contains a comma or white space.
5758
Bram Moolenaar37c64c72017-09-19 22:06:03 +02005759 *'perldll'*
5760'perldll' string (default depends on the build)
5761 global
Bram Moolenaar37c64c72017-09-19 22:06:03 +02005762 {only available when compiled with the |+perl/dyn|
5763 feature}
5764 Specifies the name of the Perl shared library. The default is
5765 DYNAMIC_PERL_DLL, which was specified at compile time.
5766 Environment variables are expanded |:set_env|.
5767 This option cannot be set from a |modeline| or in the |sandbox|, for
5768 security reasons.
5769
Bram Moolenaar071d4272004-06-13 20:20:40 +00005770 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
5771'preserveindent' 'pi' boolean (default off)
5772 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005773 When changing the indent of the current line, preserve as much of the
5774 indent structure as possible. Normally the indent is replaced by a
5775 series of tabs followed by spaces as required (unless |'expandtab'| is
5776 enabled, in which case only spaces are used). Enabling this option
5777 means the indent will preserve as many existing characters as possible
5778 for indenting, and only add additional tabs or spaces as required.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005779 'expandtab' does not apply to the preserved white space, a Tab remains
5780 a Tab.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005781 NOTE: When using ">>" multiple times the resulting indent is a mix of
5782 tabs and spaces. You might not like this.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005783 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005784 Also see 'copyindent'.
5785 Use |:retab| to clean up white space.
5786
5787 *'previewheight'* *'pvh'*
5788'previewheight' 'pvh' number (default 12)
5789 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02005790 {not available when compiled without the |+quickfix|
5791 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005792 Default height for a preview window. Used for |:ptag| and associated
Bram Moolenaar79648732019-07-18 21:43:07 +02005793 commands. Used for |CTRL-W_}| when no count is given. Not used when
5794 'previewpopup' is set.
5795
5796 *'previewpopup'* *'pvp'*
5797'previewpopup' 'pvp' string (default empty)
5798 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02005799 {not available when compiled without the |+textprop|
5800 or |+quickfix| feature}
Bram Moolenaar79648732019-07-18 21:43:07 +02005801 When not empty a popup window is used for commands that would open a
5802 preview window. See |preview-popup|.
Bram Moolenaar576a4a62019-08-18 15:25:17 +02005803 Not used for the insert completion info, add "popup" to
5804 'completeopt' for that.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005805
5806 *'previewwindow'* *'nopreviewwindow'*
5807 *'pvw'* *'nopvw'* *E590*
5808'previewwindow' 'pvw' boolean (default off)
5809 local to window
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02005810 {not available when compiled without the |+quickfix|
5811 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005812 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00005813 set. It's normally not set directly, but by using one of the commands
5814 |:ptag|, |:pedit|, etc.
5815
5816 *'printdevice'* *'pdev'*
5817'printdevice' 'pdev' string (default empty)
5818 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005819 {only available when compiled with the |+printer|
5820 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005821 The name of the printer to be used for |:hardcopy|.
5822 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005823 This option cannot be set from a |modeline| or in the |sandbox|, for
5824 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005825
Bram Moolenaar8299df92004-07-10 09:47:34 +00005826 *'printencoding'* *'penc'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005827'printencoding' 'penc' string (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005828 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005829 {only available when compiled with the |+printer|
5830 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005831 Sets the character encoding used when printing.
5832 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005833
5834 *'printexpr'* *'pexpr'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005835'printexpr' 'pexpr' string (default: see below)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005836 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005837 {only available when compiled with the |+printer|
5838 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005839 Expression used to print the PostScript produced with |:hardcopy|.
5840 See |pexpr-option|.
Bram Moolenaar51628222016-12-01 23:03:28 +01005841 This option cannot be set from a |modeline| or in the |sandbox|, for
5842 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005843
Bram Moolenaar8299df92004-07-10 09:47:34 +00005844 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005845'printfont' 'pfn' string (default "courier")
5846 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005847 {only available when compiled with the |+printer|
5848 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005849 The name of the font that will be used for |:hardcopy|.
5850 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005851
5852 *'printheader'* *'pheader'*
5853'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
5854 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005855 {only available when compiled with the |+printer|
5856 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005857 The format of the header produced in |:hardcopy| output.
5858 See |pheader-option|.
5859
5860 *'printmbcharset'* *'pmbcs'*
5861'printmbcharset' 'pmbcs' string (default "")
5862 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01005863 {only available when compiled with the |+printer|
5864 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005865 The CJK character set to be used for CJK output from |:hardcopy|.
5866 See |pmbcs-option|.
5867
5868 *'printmbfont'* *'pmbfn'*
5869'printmbfont' 'pmbfn' string (default "")
5870 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01005871 {only available when compiled with the |+printer|
5872 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005873 List of font names to be used for CJK output from |:hardcopy|.
5874 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005875
5876 *'printoptions'* *'popt'*
5877'printoptions' 'popt' string (default "")
5878 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005879 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005880 List of items that control the format of the output of |:hardcopy|.
5881 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005882
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005883 *'prompt'* *'noprompt'*
5884'prompt' boolean (default on)
5885 global
5886 When on a ":" prompt is used in Ex mode.
5887
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005888 *'pumheight'* *'ph'*
5889'pumheight' 'ph' number (default 0)
5890 global
Bram Moolenaar06a89a52006-04-29 22:01:03 +00005891 Determines the maximum number of items to show in the popup menu for
5892 Insert mode completion. When zero as much space as available is used.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005893 |ins-completion-menu|.
5894
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01005895 *'pumwidth'* *'pw'*
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005896'pumwidth' 'pw' number (default 15)
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01005897 global
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01005898 Determines the minimum width to use for the popup menu for Insert mode
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005899 completion. |ins-completion-menu|.
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01005900
Bram Moolenaard94464e2015-11-02 15:28:18 +01005901 *'pythondll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01005902'pythondll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01005903 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01005904 {only available when compiled with the |+python/dyn|
5905 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005906 Specifies the name of the Python 2.x shared library. The default is
5907 DYNAMIC_PYTHON_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005908 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01005909 This option cannot be set from a |modeline| or in the |sandbox|, for
5910 security reasons.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005911
Bram Moolenaar94073162018-01-31 21:49:05 +01005912 *'pythonhome'*
5913'pythonhome' string (default "")
5914 global
Bram Moolenaar94073162018-01-31 21:49:05 +01005915 {only available when compiled with the |+python/dyn|
5916 feature}
5917 Specifies the name of the Python 2.x home directory. When 'pythonhome'
5918 and the PYTHONHOME environment variable are not set, PYTHON_HOME,
5919 which was specified at compile time, will be used for the Python 2.x
5920 home directory.
5921 Environment variables are expanded |:set_env|.
5922 This option cannot be set from a |modeline| or in the |sandbox|, for
5923 security reasons.
5924
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005925 *'pythonthreedll'*
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005926'pythonthreedll' string (default depends on the build)
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005927 global
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005928 {only available when compiled with the |+python3/dyn|
5929 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005930 Specifies the name of the Python 3 shared library. The default is
5931 DYNAMIC_PYTHON3_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005932 Environment variables are expanded |:set_env|.
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005933 This option cannot be set from a |modeline| or in the |sandbox|, for
5934 security reasons.
5935
Bram Moolenaar94073162018-01-31 21:49:05 +01005936 *'pythonthreehome'*
5937'pythonthreehome' string (default "")
5938 global
Bram Moolenaar94073162018-01-31 21:49:05 +01005939 {only available when compiled with the |+python3/dyn|
5940 feature}
5941 Specifies the name of the Python 3 home directory. When
5942 'pythonthreehome' and the PYTHONHOME environment variable are not set,
5943 PYTHON3_HOME, which was specified at compile time, will be used for
5944 the Python 3 home directory.
5945 Environment variables are expanded |:set_env|.
5946 This option cannot be set from a |modeline| or in the |sandbox|, for
5947 security reasons.
5948
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01005949 *'pyxversion'* *'pyx'*
5950'pyxversion' 'pyx' number (default depends on the build)
5951 global
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01005952 {only available when compiled with the |+python| or
5953 the |+python3| feature}
5954 Specifies the python version used for pyx* functions and commands
5955 |python_x|. The default value is as follows:
5956
5957 Compiled with Default ~
5958 |+python| and |+python3| 0
5959 only |+python| 2
5960 only |+python3| 3
5961
5962 Available values are 0, 2 and 3.
5963 If 'pyxversion' is 0, it is set to 2 or 3 after the first execution of
5964 any python2/3 commands or functions. E.g. `:py` sets to 2, and `:py3`
5965 sets to 3. `:pyx` sets it to 3 if Python 3 is available, otherwise sets
5966 to 2 if Python 2 is available.
5967 See also: |has-pythonx|
5968
5969 If Vim is compiled with only |+python| or |+python3| setting
5970 'pyxversion' has no effect. The pyx* functions and commands are
5971 always the same as the compiled version.
5972
5973 This option cannot be set from a |modeline| or in the |sandbox|, for
5974 security reasons.
5975
Bram Moolenaar858ba062020-05-31 23:11:59 +02005976 *'quickfixtextfunc'* *'qftf'*
5977'quickfixtextfunc' 'qftf' string (default "")
5978 global
5979 {only available when compiled with the |+quickfix|
5980 feature}
5981 This option specifies a function to be used to get the text to display
5982 in the quickfix and location list windows. This can be used to
5983 customize the information displayed in the quickfix or location window
5984 for each entry in the corresponding quickfix or location list. See
5985 |quickfix-window-function| for an explanation of how to write the
Bram Moolenaard43906d2020-07-20 21:31:32 +02005986 function and an example. The value can be the name of a function or a
5987 lambda.
Bram Moolenaar858ba062020-05-31 23:11:59 +02005988
5989 This option cannot be set from a |modeline| or in the |sandbox|, for
5990 security reasons.
5991
Bram Moolenaar677ee682005-01-27 14:41:15 +00005992 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005993'quoteescape' 'qe' string (default "\")
5994 local to buffer
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005995 The characters that are used to escape quotes in a string. Used for
5996 objects like a', a" and a` |a'|.
5997 When one of the characters in this option is found inside a string,
5998 the following character will be skipped. The default value makes the
5999 text "foo\"bar\\" considered to be one string.
6000
Bram Moolenaar071d4272004-06-13 20:20:40 +00006001 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
6002'readonly' 'ro' boolean (default off)
6003 local to buffer
6004 If on, writes fail unless you use a '!'. Protects you from
6005 accidentally overwriting a file. Default on when Vim is started
6006 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006007 When using ":w!" the 'readonly' option is reset for the current
6008 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar6c60f472019-04-28 16:00:35 +02006009 When using the ":view" command the 'readonly' option is set for the
6010 newly edited buffer.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01006011 See 'modifiable' for disallowing changes to the buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006012
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006013 *'redrawtime'* *'rdt'*
6014'redrawtime' 'rdt' number (default 2000)
6015 global
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006016 {only available when compiled with the |+reltime|
6017 feature}
6018 The time in milliseconds for redrawing the display. This applies to
Bram Moolenaar15142e22018-04-30 22:19:58 +02006019 searching for patterns for 'hlsearch', |:match| highlighting and syntax
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02006020 highlighting.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006021 When redrawing takes more than this many milliseconds no further
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02006022 matches will be highlighted.
6023 For syntax highlighting the time applies per window. When over the
6024 limit syntax highlighting is disabled until |CTRL-L| is used.
6025 This is used to avoid that Vim hangs when using a very complicated
6026 pattern.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006027
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02006028 *'regexpengine'* *'re'*
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006029'regexpengine' 're' number (default 0)
6030 global
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006031 This selects the default regexp engine. |two-engines|
6032 The possible values are:
6033 0 automatic selection
6034 1 old engine
6035 2 NFA engine
6036 Note that when using the NFA engine and the pattern contains something
6037 that is not supported the pattern will not match. This is only useful
6038 for debugging the regexp engine.
Bram Moolenaarfda37292014-11-05 14:27:36 +01006039 Using automatic selection enables Vim to switch the engine, if the
6040 default engine becomes too costly. E.g., when the NFA engine uses too
6041 many states. This should prevent Vim from hanging on a combination of
6042 a complex pattern with long text.
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006043
Bram Moolenaar64486672010-05-16 15:46:46 +02006044 *'relativenumber'* *'rnu'* *'norelativenumber'* *'nornu'*
6045'relativenumber' 'rnu' boolean (default off)
6046 local to window
Bram Moolenaar64486672010-05-16 15:46:46 +02006047 Show the line number relative to the line with the cursor in front of
Bram Moolenaar06b5d512010-05-22 15:37:44 +02006048 each line. Relative line numbers help you use the |count| you can
Bram Moolenaar64486672010-05-16 15:46:46 +02006049 precede some vertical motion commands (e.g. j k + -) with, without
6050 having to calculate it yourself. Especially useful in combination with
6051 other commands (e.g. y d c < > gq gw =).
6052 When the 'n' option is excluded from 'cpoptions' a wrapped
6053 line will not use the column of line numbers (this is the default when
6054 'compatible' isn't set).
6055 The 'numberwidth' option can be used to set the room used for the line
6056 number.
6057 When a long, wrapped line doesn't start with the first character, '-'
6058 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02006059 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
6060 the number.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01006061
Bram Moolenaar203d04d2013-06-06 21:36:40 +02006062 The number in front of the cursor line also depends on the value of
6063 'number', see |number_relativenumber| for all combinations of the two
6064 options.
Bram Moolenaar64486672010-05-16 15:46:46 +02006065
Bram Moolenaar071d4272004-06-13 20:20:40 +00006066 *'remap'* *'noremap'*
6067'remap' boolean (default on)
6068 global
6069 Allows for mappings to work recursively. If you do not want this for
6070 a single entry, use the :noremap[!] command.
Bram Moolenaara3227e22006-03-08 21:32:40 +00006071 NOTE: To avoid portability problems with Vim scripts, always keep
6072 this option at the default "on". Only switch it off when working with
6073 old Vi scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006074
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006075 *'renderoptions'* *'rop'*
6076'renderoptions' 'rop' string (default: empty)
6077 global
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006078 {only available when compiled with GUI and DIRECTX on
6079 MS-Windows}
6080 Select a text renderer and set its options. The options depend on the
6081 renderer.
6082
6083 Syntax: >
6084 set rop=type:{renderer}(,{name}:{value})*
6085<
6086 Currently, only one optional renderer is available.
6087
6088 render behavior ~
6089 directx Vim will draw text using DirectX (DirectWrite). It makes
6090 drawn glyphs more beautiful than default GDI.
6091 It requires 'encoding' is "utf-8", and only works on
6092 MS-Windows Vista or newer version.
6093
6094 Options:
6095 name meaning type value ~
6096 gamma gamma float 1.0 - 2.2 (maybe)
6097 contrast enhancedContrast float (unknown)
6098 level clearTypeLevel float (unknown)
6099 geom pixelGeometry int 0 - 2 (see below)
6100 renmode renderingMode int 0 - 6 (see below)
6101 taamode textAntialiasMode int 0 - 3 (see below)
Bram Moolenaara338adc2018-01-31 20:51:47 +01006102 scrlines Scroll Lines int (deprecated)
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006103
Bram Moolenaar92467d32017-12-05 13:22:16 +01006104 See this URL for detail (except for scrlines):
6105 https://msdn.microsoft.com/en-us/library/dd368190.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006106
6107 For geom: structure of a device pixel.
6108 0 - DWRITE_PIXEL_GEOMETRY_FLAT
6109 1 - DWRITE_PIXEL_GEOMETRY_RGB
6110 2 - DWRITE_PIXEL_GEOMETRY_BGR
6111
6112 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006113 https://msdn.microsoft.com/en-us/library/dd368114.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006114
6115 For renmode: method of rendering glyphs.
6116 0 - DWRITE_RENDERING_MODE_DEFAULT
6117 1 - DWRITE_RENDERING_MODE_ALIASED
6118 2 - DWRITE_RENDERING_MODE_GDI_CLASSIC
6119 3 - DWRITE_RENDERING_MODE_GDI_NATURAL
6120 4 - DWRITE_RENDERING_MODE_NATURAL
6121 5 - DWRITE_RENDERING_MODE_NATURAL_SYMMETRIC
6122 6 - DWRITE_RENDERING_MODE_OUTLINE
6123
6124 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006125 https://msdn.microsoft.com/en-us/library/dd368118.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006126
6127 For taamode: antialiasing mode used for drawing text.
6128 0 - D2D1_TEXT_ANTIALIAS_MODE_DEFAULT
6129 1 - D2D1_TEXT_ANTIALIAS_MODE_CLEARTYPE
6130 2 - D2D1_TEXT_ANTIALIAS_MODE_GRAYSCALE
6131 3 - D2D1_TEXT_ANTIALIAS_MODE_ALIASED
6132
6133 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006134 https://msdn.microsoft.com/en-us/library/dd368170.aspx
6135
Bram Moolenaara338adc2018-01-31 20:51:47 +01006136 For scrlines:
6137 This was used for optimizing scrolling behavior, however this
6138 is now deprecated. If specified, it is simply ignored.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006139
6140 Example: >
6141 set encoding=utf-8
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006142 set gfn=Ricty_Diminished:h12
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006143 set rop=type:directx
6144<
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006145 If select a raster font (Courier, Terminal or FixedSys which
6146 have ".fon" extension in file name) to 'guifont', it will be
Bram Moolenaar92467d32017-12-05 13:22:16 +01006147 drawn by GDI as a fallback.
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006148
6149 NOTE: It is known that some fonts and options combination
6150 causes trouble on drawing glyphs.
6151
Bram Moolenaar92467d32017-12-05 13:22:16 +01006152 - 'renmode:5' and 'renmode:6' will not work with some
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006153 special made fonts (True-Type fonts which includes only
6154 bitmap glyphs).
6155 - 'taamode:3' will not work with some vector fonts.
6156
6157 NOTE: With this option, you can display colored emoji
6158 (emoticon) in Windows 8.1 or later. To display colored emoji,
6159 there are some conditions which you should notice.
6160
6161 - If your font includes non-colored emoji already, it will
6162 be used.
6163 - If your font doesn't have emoji, the system chooses an
6164 alternative symbol font. On Windows 10, "Segoe UI Emoji"
6165 will be used.
6166 - When this alternative font didn't have fixed width glyph,
6167 emoji might be rendered beyond the bounding box of drawing
6168 cell.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006169
6170 Other render types are currently not supported.
6171
Bram Moolenaar071d4272004-06-13 20:20:40 +00006172 *'report'*
6173'report' number (default 2)
6174 global
6175 Threshold for reporting number of lines changed. When the number of
6176 changed lines is more than 'report' a message will be given for most
6177 ":" commands. If you want it always, set 'report' to 0.
6178 For the ":substitute" command the number of substitutions is used
6179 instead of the number of lines.
6180
6181 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
6182'restorescreen' 'rs' boolean (default on)
6183 global
Bram Moolenaar8024f932020-01-14 19:29:13 +01006184 {only in MS-Windows console version}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006185 When set, the screen contents is restored when exiting Vim. This also
6186 happens when executing external commands.
6187
6188 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
6189 options in your .vimrc. To disable restoring:
6190 set t_ti= t_te=
6191 To enable restoring (for an xterm):
6192 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
6193 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
6194
6195 *'revins'* *'ri'* *'norevins'* *'nori'*
6196'revins' 'ri' boolean (default off)
6197 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006198 {only available when compiled with the |+rightleft|
6199 feature}
6200 Inserting characters in Insert mode will work backwards. See "typing
6201 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
6202 command in Insert mode, when 'allowrevins' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02006203 NOTE: This option is reset when 'compatible' is set.
6204 This option is reset when 'paste' is set and restored when 'paste' is
6205 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006206
6207 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
6208'rightleft' 'rl' boolean (default off)
6209 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006210 {only available when compiled with the |+rightleft|
6211 feature}
6212 When on, display orientation becomes right-to-left, i.e., characters
6213 that are stored in the file appear from the right to the left.
6214 Using this option, it is possible to edit files for languages that
6215 are written from the right to the left such as Hebrew and Arabic.
6216 This option is per window, so it is possible to edit mixed files
6217 simultaneously, or to view the same file in both ways (this is
6218 useful whenever you have a mixed text file with both right-to-left
6219 and left-to-right strings so that both sets are displayed properly
6220 in different windows). Also see |rileft.txt|.
6221
Bram Moolenaar607cc1e2010-07-18 18:47:44 +02006222 *'rightleftcmd'* *'rlc'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006223'rightleftcmd' 'rlc' string (default "search")
6224 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006225 {only available when compiled with the |+rightleft|
6226 feature}
6227 Each word in this option enables the command line editing to work in
6228 right-to-left mode for a group of commands:
6229
6230 search "/" and "?" commands
6231
6232 This is useful for languages such as Hebrew, Arabic and Farsi.
6233 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
6234
Bram Moolenaard94464e2015-11-02 15:28:18 +01006235 *'rubydll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01006236'rubydll' string (default: depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01006237 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01006238 {only available when compiled with the |+ruby/dyn|
6239 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006240 Specifies the name of the Ruby shared library. The default is
6241 DYNAMIC_RUBY_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006242 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01006243 This option cannot be set from a |modeline| or in the |sandbox|, for
6244 security reasons.
6245
Bram Moolenaar071d4272004-06-13 20:20:40 +00006246 *'ruler'* *'ru'* *'noruler'* *'noru'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02006247'ruler' 'ru' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006248 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006249 {not available when compiled without the
6250 |+cmdline_info| feature}
6251 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006252 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00006253 text in the file is shown on the far right:
6254 Top first line is visible
6255 Bot last line is visible
6256 All first and last line are visible
6257 45% relative position in the file
6258 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006259 Each window has its own ruler. If a window has a status line, the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006260 ruler is shown there. Otherwise it is shown in the last line of the
Bram Moolenaar582fd852005-03-28 20:58:01 +00006261 screen. If the statusline is given by 'statusline' (i.e. not empty),
Bram Moolenaar071d4272004-06-13 20:20:40 +00006262 this option takes precedence over 'ruler' and 'rulerformat'
6263 If the number of characters displayed is different from the number of
Bram Moolenaar207f0092020-08-30 17:20:20 +02006264 bytes in the text (e.g., for a TAB or a multibyte character), both
Bram Moolenaar071d4272004-06-13 20:20:40 +00006265 the text column (byte number) and the screen column are shown,
6266 separated with a dash.
6267 For an empty line "0-1" is shown.
6268 For an empty buffer the line number will also be zero: "0,0-1".
Bram Moolenaarca635012015-09-25 20:34:21 +02006269 This option is reset when 'paste' is set and restored when 'paste' is
6270 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006271 If you don't want to see the ruler all the time but want to know where
6272 you are, use "g CTRL-G" |g_CTRL-G|.
6273 NOTE: This option is reset when 'compatible' is set.
6274
6275 *'rulerformat'* *'ruf'*
6276'rulerformat' 'ruf' string (default empty)
6277 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006278 {not available when compiled without the |+statusline|
6279 feature}
6280 When this option is not empty, it determines the content of the ruler
6281 string, as displayed for the 'ruler' option.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00006282 The format of this option is like that of 'statusline'.
Bram Moolenaar110289e2019-05-23 15:38:06 +02006283 This option cannot be set in a modeline when 'modelineexpr' is off.
6284
Bram Moolenaar071d4272004-06-13 20:20:40 +00006285 The default ruler width is 17 characters. To make the ruler 15
6286 characters wide, put "%15(" at the start and "%)" at the end.
6287 Example: >
6288 :set rulerformat=%15(%c%V\ %p%%%)
6289<
6290 *'runtimepath'* *'rtp'* *vimfiles*
6291'runtimepath' 'rtp' string (default:
Bram Moolenaar942db232021-02-13 18:14:48 +01006292 Unix: "$HOME/.vim,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006293 $VIM/vimfiles,
6294 $VIMRUNTIME,
6295 $VIM/vimfiles/after,
6296 $HOME/.vim/after"
6297 Amiga: "home:vimfiles,
6298 $VIM/vimfiles,
6299 $VIMRUNTIME,
6300 $VIM/vimfiles/after,
6301 home:vimfiles/after"
Bram Moolenaar942db232021-02-13 18:14:48 +01006302 MS-Windows: "$HOME/vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006303 $VIM/vimfiles,
6304 $VIMRUNTIME,
6305 $VIM/vimfiles/after,
6306 $HOME/vimfiles/after"
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02006307 macOS: "$VIM:vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006308 $VIMRUNTIME,
6309 $VIM:vimfiles:after"
Bram Moolenaarb3f74062020-02-26 16:16:53 +01006310 Haiku: "$BE_USER_SETTINGS/vim,
6311 $VIM/vimfiles,
6312 $VIMRUNTIME,
6313 $VIM/vimfiles/after,
Bram Moolenaar942db232021-02-13 18:14:48 +01006314 $BE_USER_SETTINGS/vim/after"
6315 VMS: "sys$login:vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006316 $VIM/vimfiles,
6317 $VIMRUNTIME,
6318 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00006319 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006320 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006321 This is a list of directories which will be searched for runtime
6322 files:
6323 filetype.vim filetypes by file name |new-filetype|
6324 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006325 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006326 colors/ color scheme files |:colorscheme|
6327 compiler/ compiler files |:compiler|
6328 doc/ documentation |write-local-help|
6329 ftplugin/ filetype plugins |write-filetype-plugin|
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01006330 import/ files that are found by `:import`
Bram Moolenaar071d4272004-06-13 20:20:40 +00006331 indent/ indent scripts |indent-expression|
6332 keymap/ key mapping files |mbyte-keymap|
6333 lang/ menu translations |:menutrans|
6334 menu.vim GUI menus |menu.vim|
Bram Moolenaar26852122016-05-24 20:02:38 +02006335 pack/ packages |:packadd|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006336 plugin/ plugin scripts |write-plugin|
6337 print/ files for printing |postscript-print-encoding|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006338 spell/ spell checking files |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006339 syntax/ syntax files |mysyntaxfile|
6340 tutor/ files for vimtutor |tutor|
6341
6342 And any other file searched for with the |:runtime| command.
6343
6344 The defaults for most systems are setup to search five locations:
6345 1. In your home directory, for your personal preferences.
6346 2. In a system-wide Vim directory, for preferences from the system
6347 administrator.
6348 3. In $VIMRUNTIME, for files distributed with Vim.
6349 *after-directory*
6350 4. In the "after" directory in the system-wide Vim directory. This is
6351 for the system administrator to overrule or add to the distributed
6352 defaults (rarely needed)
6353 5. In the "after" directory in your home directory. This is for
6354 personal preferences to overrule or add to the distributed defaults
6355 or system-wide settings (rarely needed).
6356
Bram Moolenaard0796902016-09-16 20:02:31 +02006357 More entries are added when using |packages|. If it gets very long
6358 then `:set rtp` will be truncated, use `:echo &rtp` to see the full
6359 string.
Bram Moolenaar26852122016-05-24 20:02:38 +02006360
Bram Moolenaar071d4272004-06-13 20:20:40 +00006361 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
6362 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006363 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00006364 wildcards.
6365 See |:runtime|.
6366 Example: >
6367 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
6368< This will use the directory "~/vimruntime" first (containing your
6369 personal Vim runtime files), then "/mygroup/vim" (shared between a
6370 group of people) and finally "$VIMRUNTIME" (the distributed runtime
6371 files).
6372 You probably should always include $VIMRUNTIME somewhere, to use the
6373 distributed runtime files. You can put a directory before $VIMRUNTIME
6374 to find files which replace a distributed runtime files. You can put
6375 a directory after $VIMRUNTIME to find files which add to distributed
6376 runtime files.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006377 When Vim is started with |--clean| the home directory entries are not
6378 included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006379 This option cannot be set from a |modeline| or in the |sandbox|, for
6380 security reasons.
6381
6382 *'scroll'* *'scr'*
6383'scroll' 'scr' number (default: half the window height)
6384 local to window
6385 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
6386 set to half the number of lines in the window when the window size
Bram Moolenaar74667062020-12-28 15:41:41 +01006387 changes. This may happen when enabling the |status-line| or
6388 'tabline' option after setting the 'scroll' option.
6389 If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006390 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar25c9c682019-05-05 18:13:34 +02006391 height with ":set scroll=0".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006392
6393 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
6394'scrollbind' 'scb' boolean (default off)
6395 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006396 See also |scroll-binding|. When this option is set, the current
6397 window scrolls as other scrollbind windows (windows that also have
6398 this option set) scroll. This option is useful for viewing the
6399 differences between two versions of a file, see 'diff'.
6400 See |'scrollopt'| for options that determine how this option should be
6401 interpreted.
6402 This option is mostly reset when splitting a window to edit another
6403 file. This means that ":split | edit file" results in two windows
6404 with scroll-binding, but ":split file" does not.
6405
Bram Moolenaarae20f342019-11-05 21:09:23 +01006406 *'scrollfocus'* *'scf'* *'noscrollfocus'* *'noscf'*
6407'scrollfocus' 'scf' boolean (default off)
6408 global
6409 {only for MS-Windows GUI}
6410 When using the scroll wheel and this option is set, the window under
6411 the mouse pointer is scrolled. With this option off the current
6412 window is scrolled.
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01006413 Systems other than MS-Windows always behave like this option is on.
Bram Moolenaarae20f342019-11-05 21:09:23 +01006414
Bram Moolenaar071d4272004-06-13 20:20:40 +00006415 *'scrolljump'* *'sj'*
6416'scrolljump' 'sj' number (default 1)
6417 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006418 Minimal number of lines to scroll when the cursor gets off the
6419 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
6420 CTRL-D). Useful if your terminal scrolls very slowly.
Bram Moolenaar1e015462005-09-25 22:16:38 +00006421 When set to a negative number from -1 to -100 this is used as the
6422 percentage of the window height. Thus -50 scrolls half the window
6423 height.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006424 NOTE: This option is set to 1 when 'compatible' is set.
6425
6426 *'scrolloff'* *'so'*
Bram Moolenaar50ba5262016-09-22 22:33:02 +02006427'scrolloff' 'so' number (default 0, set to 5 in |defaults.vim|)
Bram Moolenaar375e3392019-01-31 18:26:10 +01006428 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006429 Minimal number of screen lines to keep above and below the cursor.
6430 This will make some context visible around where you are working. If
6431 you set it to a very large value (999) the cursor line will always be
6432 in the middle of the window (except at the start or end of the file or
6433 when long lines wrap).
Bram Moolenaar375e3392019-01-31 18:26:10 +01006434 After using the local value, go back the global value with one of
6435 these two: >
6436 setlocal scrolloff<
6437 setlocal scrolloff=-1
6438< For scrolling horizontally see 'sidescrolloff'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006439 NOTE: This option is set to 0 when 'compatible' is set.
6440
6441 *'scrollopt'* *'sbo'*
6442'scrollopt' 'sbo' string (default "ver,jump")
6443 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006444 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006445 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
6446 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006447 The following words are available:
6448 ver Bind vertical scrolling for 'scrollbind' windows
6449 hor Bind horizontal scrolling for 'scrollbind' windows
6450 jump Applies to the offset between two windows for vertical
6451 scrolling. This offset is the difference in the first
6452 displayed line of the bound windows. When moving
6453 around in a window, another 'scrollbind' window may
6454 reach a position before the start or after the end of
6455 the buffer. The offset is not changed though, when
6456 moving back the 'scrollbind' window will try to scroll
6457 to the desired position when possible.
6458 When now making that window the current one, two
6459 things can be done with the relative offset:
6460 1. When "jump" is not included, the relative offset is
6461 adjusted for the scroll position in the new current
6462 window. When going back to the other window, the
Bram Moolenaar02467872007-05-06 13:22:01 +00006463 new relative offset will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006464 2. When "jump" is included, the other windows are
6465 scrolled to keep the same relative offset. When
6466 going back to the other window, it still uses the
6467 same relative offset.
6468 Also see |scroll-binding|.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006469 When 'diff' mode is active there always is vertical scroll binding,
6470 even when "ver" isn't there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006471
6472 *'sections'* *'sect'*
6473'sections' 'sect' string (default "SHNHH HUnhsh")
6474 global
6475 Specifies the nroff macros that separate sections. These are pairs of
6476 two letters (See |object-motions|). The default makes a section start
6477 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
6478
6479 *'secure'* *'nosecure'* *E523*
6480'secure' boolean (default off)
6481 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006482 When on, ":autocmd", shell and write commands are not allowed in
6483 ".vimrc" and ".exrc" in the current directory and map commands are
6484 displayed. Switch it off only if you know that you will not run into
6485 problems, or when the 'exrc' option is off. On Unix this option is
6486 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006487 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00006488 'secure' at the end of your ~/.vimrc then.
6489 This option cannot be set from a |modeline| or in the |sandbox|, for
6490 security reasons.
6491
6492 *'selection'* *'sel'*
6493'selection' 'sel' string (default "inclusive")
6494 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006495 This option defines the behavior of the selection. It is only used
6496 in Visual and Select mode.
6497 Possible values:
6498 value past line inclusive ~
6499 old no yes
6500 inclusive yes yes
6501 exclusive yes no
6502 "past line" means that the cursor is allowed to be positioned one
6503 character past the line.
6504 "inclusive" means that the last character of the selection is included
6505 in an operation. For example, when "x" is used to delete the
6506 selection.
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02006507 When "old" is used and 'virtualedit' allows the cursor to move past
6508 the end of line the line break still isn't included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006509 Note that when "exclusive" is used and selecting from the end
6510 backwards, you cannot include the last character of a line, when
6511 starting in Normal mode and 'virtualedit' empty.
6512
6513 The 'selection' option is set by the |:behave| command.
6514
6515 *'selectmode'* *'slm'*
6516'selectmode' 'slm' string (default "")
6517 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006518 This is a comma separated list of words, which specifies when to start
6519 Select mode instead of Visual mode, when a selection is started.
6520 Possible values:
6521 mouse when using the mouse
6522 key when using shifted special keys
6523 cmd when using "v", "V" or CTRL-V
6524 See |Select-mode|.
6525 The 'selectmode' option is set by the |:behave| command.
6526
6527 *'sessionoptions'* *'ssop'*
6528'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006529 help,options,tabpages,winsize,terminal")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006530 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02006531 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006532 feature}
6533 Changes the effect of the |:mksession| command. It is a comma
6534 separated list of words. Each word enables saving and restoring
6535 something:
6536 word save and restore ~
6537 blank empty windows
6538 buffers hidden and unloaded buffers, not just those in windows
6539 curdir the current directory
6540 folds manually created folds, opened/closed folds and local
6541 fold options
6542 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00006543 and contain at least one lowercase letter. Only
6544 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006545 help the help window
6546 localoptions options and mappings local to a window or buffer (not
6547 global values for local options)
6548 options all options and mappings (also global values for local
6549 options)
Bram Moolenaard23b7142021-04-17 21:04:34 +02006550 skiprtp exclude 'runtimepath' and 'packpath' from the options
Bram Moolenaar071d4272004-06-13 20:20:40 +00006551 resize size of the Vim window: 'lines' and 'columns'
6552 sesdir the directory in which the session file is located
6553 will become the current directory (useful with
6554 projects accessed over a network from different
6555 systems)
6556 slash backslashes in file names replaced with forward
6557 slashes
Bram Moolenaar18144c82006-04-12 21:52:12 +00006558 tabpages all tab pages; without this only the current tab page
6559 is restored, so that you can make a session for each
6560 tab page separately
Bram Moolenaard473c8c2018-08-11 18:00:22 +02006561 terminal include terminal windows where the command can be
6562 restored
Bram Moolenaar071d4272004-06-13 20:20:40 +00006563 unix with Unix end-of-line format (single <NL>), even when
6564 on Windows or DOS
6565 winpos position of the whole Vim window
6566 winsize window sizes
6567
6568 Don't include both "curdir" and "sesdir".
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006569 When neither "curdir" nor "sesdir" is included, file names are stored
6570 with absolute paths.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006571 "slash" and "unix" are useful on Windows when sharing session files
6572 with Unix. The Unix version of Vim cannot source dos format scripts,
6573 but the Windows version of Vim can source unix format scripts.
6574
6575 *'shell'* *'sh'* *E91*
Bram Moolenaar95a9dd12019-12-19 22:12:03 +01006576'shell' 'sh' string (default $SHELL or "sh", Win32: "cmd.exe")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006577 global
6578 Name of the shell to use for ! and :! commands. When changing the
6579 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
6580 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006581 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006582 See |option-backslash| about including spaces and backslashes.
6583 Environment variables are expanded |:set_env|.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006584
Bram Moolenaar1ff14ba2019-11-02 14:09:23 +01006585 If the name of the shell contains a space, you need to enclose it in
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01006586 quotes and escape the space. Example with quotes: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006587 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
6588< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006589 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006590 "-f" is not inside the quotes, because it is not part of the command
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006591 name. Vim automagically recognizes the backslashes that are path
Bram Moolenaar071d4272004-06-13 20:20:40 +00006592 separators.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006593 Example with escaped space (Vim will do this when initializing the
6594 option from $SHELL): >
6595 :set shell=/bin/with\\\ space/sh
Bram Moolenaard473c8c2018-08-11 18:00:22 +02006596< The resulting value of 'shell' is "/bin/with\ space/sh", two
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006597 backslashes are consumed by `:set`.
6598
Bram Moolenaar071d4272004-06-13 20:20:40 +00006599 Under MS-Windows, when the executable ends in ".com" it must be
6600 included. Thus setting the shell to "command.com" or "4dos.com"
6601 works, but "command" and "4dos" do not work for all commands (e.g.,
6602 filtering).
6603 For unknown reasons, when using "4dos.com" the current directory is
6604 changed to "C:\". To avoid this set 'shell' like this: >
6605 :set shell=command.com\ /c\ 4dos
6606< This option cannot be set from a |modeline| or in the |sandbox|, for
6607 security reasons.
6608
6609 *'shellcmdflag'* *'shcf'*
Bram Moolenaar5dc62522012-02-13 00:05:22 +01006610'shellcmdflag' 'shcf' string (default: "-c";
Mike Williams12795022021-06-28 20:53:58 +02006611 Win32, when 'shell' contains "powershell":
6612 "-Command", or when it does not contain "sh"
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006613 somewhere: "/c")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006614 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006615 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
Mike Williams12795022021-06-28 20:53:58 +02006616 "bash.exe -c ls", "powershell.exe -Command dir", or "cmd.exe /c dir".
6617 For MS-Windows, the default is set according to the value of 'shell',
6618 to reduce the need to set this option by the user.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02006619 On Unix it can have more than one flag. Each white space separated
6620 part is passed as an argument to the shell command.
6621 See |option-backslash| about including spaces and backslashes.
Mike Williams12795022021-06-28 20:53:58 +02006622 Also see |dos-shell| and |dos-powershell| for MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006623 This option cannot be set from a |modeline| or in the |sandbox|, for
6624 security reasons.
6625
6626 *'shellpipe'* *'sp'*
Mike Williams12795022021-06-28 20:53:58 +02006627'shellpipe' 'sp' string (default ">", ">%s 2>&1", "| tee", "|& tee"
6628 "2>&1| tee", or
6629 "2>&1 | Out-File -Encoding default")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006630 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006631 {not available when compiled without the |+quickfix|
6632 feature}
6633 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006634 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00006635 including spaces and backslashes.
6636 The name of the temporary file can be represented by "%s" if necessary
6637 (the file name is appended automatically if no %s appears in the value
6638 of this option).
Mike Williams12795022021-06-28 20:53:58 +02006639 For the Amiga the default is ">". For MS-Windows using powershell the
6640 default is "2>&1 | Out-File -Encoding default", otherwise the default
6641 is ">%s 2>&1". The output is directly saved in a file and not echoed
6642 to the screen.
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02006643 For Unix the default is "| tee". The stdout of the compiler is saved
Bram Moolenaar071d4272004-06-13 20:20:40 +00006644 in a file and echoed to the screen. If the 'shell' option is "csh" or
6645 "tcsh" after initializations, the default becomes "|& tee". If the
Bram Moolenaar96f45c02019-10-26 19:53:45 +02006646 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh", "zsh-beta",
Natanael Copa56318362021-05-06 18:46:35 +02006647 "bash", "fish", "ash" or "dash" the default becomes "2>&1| tee". This
6648 means that stderr is also included. Before using the 'shell' option a
6649 path is removed, thus "/bin/sh" uses "sh".
Mike Williamsa3d1b292021-06-30 20:56:00 +02006650 For Unix and MS-Windows, when the 'shell' option is "pwsh" the default
6651 becomes ">%s 2>&1" and the output is not echoed to the screen.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006652 The initialization of this option is done after reading the ".vimrc"
6653 and the other initializations, so that when the 'shell' option is set
6654 there, the 'shellpipe' option changes automatically, unless it was
6655 explicitly set before.
6656 When 'shellpipe' is set to an empty string, no redirection of the
6657 ":make" output will be done. This is useful if you use a 'makeprg'
6658 that writes to 'makeef' by itself. If you want no piping, but do
6659 want to include the 'makeef', set 'shellpipe' to a single space.
6660 Don't forget to precede the space with a backslash: ":set sp=\ ".
6661 In the future pipes may be used for filtering and this option will
6662 become obsolete (at least for Unix).
6663 This option cannot be set from a |modeline| or in the |sandbox|, for
6664 security reasons.
6665
6666 *'shellquote'* *'shq'*
Mike Williamsa3d1b292021-06-30 20:56:00 +02006667'shellquote' 'shq' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006668 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006669 Quoting character(s), put around the command passed to the shell, for
6670 the "!" and ":!" commands. The redirection is kept outside of the
6671 quoting. See 'shellxquote' to include the redirection. It's
6672 probably not useful to set both options.
6673 This is an empty string by default. Only known to be useful for
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006674 third-party shells on MS-Windows-like systems, such as the MKS Korn
Mike Williamsa3d1b292021-06-30 20:56:00 +02006675 Shell or bash, where it should be "\"". See |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006676 This option cannot be set from a |modeline| or in the |sandbox|, for
6677 security reasons.
6678
6679 *'shellredir'* *'srr'*
Mike Williams12795022021-06-28 20:53:58 +02006680'shellredir' 'srr' string (default ">", ">&", ">%s 2>&1", or
6681 "2>&1 | Out-File -Encoding default")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006682 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006683 String to be used to put the output of a filter command in a temporary
6684 file. See also |:!|. See |option-backslash| about including spaces
6685 and backslashes.
6686 The name of the temporary file can be represented by "%s" if necessary
6687 (the file name is appended automatically if no %s appears in the value
6688 of this option).
Bram Moolenaar96f45c02019-10-26 19:53:45 +02006689 The default is ">". For Unix, if the 'shell' option is "csh" or
6690 "tcsh" during initializations, the default becomes ">&". If the
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01006691 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh", "zsh-beta",
Mike Williamsa3d1b292021-06-30 20:56:00 +02006692 "bash", "fish", or "pwsh", the default becomes ">%s 2>&1". This means
6693 that stderr is also included. For Win32, the Unix checks are done and
Mike Williams12795022021-06-28 20:53:58 +02006694 additionally "cmd" is checked for, which makes the default ">%s 2>&1",
6695 and "powershell" is checked for which makes the default
Mike Williamsa3d1b292021-06-30 20:56:00 +02006696 "2>&1 | Out-File -Encoding default" (see |dos-powershell|). Also, the
6697 same names with ".exe" appended are checked for.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006698 The initialization of this option is done after reading the ".vimrc"
6699 and the other initializations, so that when the 'shell' option is set
6700 there, the 'shellredir' option changes automatically unless it was
6701 explicitly set before.
6702 In the future pipes may be used for filtering and this option will
6703 become obsolete (at least for Unix).
6704 This option cannot be set from a |modeline| or in the |sandbox|, for
6705 security reasons.
6706
6707 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
6708'shellslash' 'ssl' boolean (default off)
6709 global
Bram Moolenaar6f345a12019-12-17 21:27:18 +01006710 {only for MS-Windows}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006711 When set, a forward slash is used when expanding file names. This is
Mike Williamsa3d1b292021-06-30 20:56:00 +02006712 useful when a Unix-like shell is used instead of cmd.exe, pwsh.exe, or
Mike Williams12795022021-06-28 20:53:58 +02006713 powershell.exe. Backward slashes can still be typed, but they are
6714 changed to forward slashes by Vim.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006715 Note that setting or resetting this option has no effect for some
6716 existing file names, thus this option needs to be set before opening
6717 any file for best results. This might change in the future.
6718 'shellslash' only works when a backslash can be used as a path
6719 separator. To test if this is so use: >
6720 if exists('+shellslash')
Bram Moolenaarac3150d2019-07-28 16:36:39 +02006721< Also see 'completeslash'.
6722
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006723 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
6724'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
6725 global
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006726 When on, use temp files for shell commands. When off use a pipe.
6727 When using a pipe is not possible temp files are used anyway.
Bram Moolenaar97293012011-07-18 19:40:27 +02006728 Currently a pipe is only supported on Unix and MS-Windows 2K and
6729 later. You can check it with: >
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006730 :if has("filterpipe")
6731< The advantage of using a pipe is that nobody can read the temp file
6732 and the 'shell' command does not need to support redirection.
6733 The advantage of using a temp file is that the file type and encoding
6734 can be detected.
6735 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
6736 |FilterWritePost| autocommands event are not triggered when
6737 'shelltemp' is off.
Bram Moolenaar269f5952016-07-15 22:54:41 +02006738 The `system()` function does not respect this option and always uses
6739 temp files.
Bram Moolenaar036986f2017-03-16 17:41:02 +01006740 NOTE: This option is set to the Vim default value when 'compatible'
6741 is reset.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006742
Bram Moolenaar071d4272004-06-13 20:20:40 +00006743 *'shelltype'* *'st'*
6744'shelltype' 'st' number (default 0)
6745 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02006746 {only for the Amiga}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006747 On the Amiga this option influences the way how the commands work
6748 which use a shell.
6749 0 and 1: always use the shell
6750 2 and 3: use the shell only to filter lines
6751 4 and 5: use shell only for ':sh' command
6752 When not using the shell, the command is executed directly.
6753
6754 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
6755 1 and 3: use "shell cmd" to start external commands
6756
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006757 *'shellxescape'* *'sxe'*
6758'shellxescape' 'sxe' string (default: "";
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006759 for MS-Windows: "\"&|<>()@^")
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006760 global
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006761 When 'shellxquote' is set to "(" then the characters listed in this
6762 option will be escaped with a '^' character. This makes it possible
6763 to execute most external commands with cmd.exe.
6764
Bram Moolenaar071d4272004-06-13 20:20:40 +00006765 *'shellxquote'* *'sxq'*
6766'shellxquote' 'sxq' string (default: "";
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006767 for Win32, when 'shell' is cmd.exe: "("
Mike Williams12795022021-06-28 20:53:58 +02006768 for Win32, when 'shell' is
6769 powershell.exe: "\""
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006770 for Win32, when 'shell' contains "sh"
6771 somewhere: "\""
Bram Moolenaar071d4272004-06-13 20:20:40 +00006772 for Unix, when using system(): "\"")
6773 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006774 Quoting character(s), put around the command passed to the shell, for
6775 the "!" and ":!" commands. Includes the redirection. See
6776 'shellquote' to exclude the redirection. It's probably not useful
6777 to set both options.
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006778 When the value is '(' then ')' is appended. When the value is '"('
6779 then ')"' is appended.
6780 When the value is '(' then also see 'shellxescape'.
Bram Moolenaara64ba222012-02-12 23:23:31 +01006781 This is an empty string by default on most systems, but is known to be
Mike Williamsa3d1b292021-06-30 20:56:00 +02006782 useful for on Win32 version, either for cmd.exe, powershell.exe, or
6783 pwsh.exe which automatically strips off the first and last quote on a
6784 command, or 3rd-party shells such as the MKS Korn Shell or bash, where
6785 it should be "\"". The default is adjusted according the value of
Mike Williams12795022021-06-28 20:53:58 +02006786 'shell', to reduce the need to set this option by the user. See
6787 |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006788 This option cannot be set from a |modeline| or in the |sandbox|, for
6789 security reasons.
6790
6791 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
6792'shiftround' 'sr' boolean (default off)
6793 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006794 Round indent to multiple of 'shiftwidth'. Applies to > and <
6795 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
6796 a multiple of 'shiftwidth' (this is Vi compatible).
6797 NOTE: This option is reset when 'compatible' is set.
6798
6799 *'shiftwidth'* *'sw'*
6800'shiftwidth' 'sw' number (default 8)
6801 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006802 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00006803 |'cindent'|, |>>|, |<<|, etc.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02006804 When zero the 'ts' value will be used. Use the |shiftwidth()|
6805 function to get the effective shiftwidth value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006806
6807 *'shortmess'* *'shm'*
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02006808'shortmess' 'shm' string (Vim default "filnxtToOS", Vi default: "S",
6809 POSIX default: "AS")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006810 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006811 This option helps to avoid all the |hit-enter| prompts caused by file
6812 messages, for example with CTRL-G, and to avoid some other messages.
6813 It is a list of flags:
6814 flag meaning when present ~
6815 f use "(3 of 5)" instead of "(file 3 of 5)"
6816 i use "[noeol]" instead of "[Incomplete last line]"
Bram Moolenaar3f40ce72020-07-05 14:10:13 +02006817 l use "999L, 888B" instead of "999 lines, 888 bytes"
Bram Moolenaar071d4272004-06-13 20:20:40 +00006818 m use "[+]" instead of "[Modified]"
6819 n use "[New]" instead of "[New File]"
6820 r use "[RO]" instead of "[readonly]"
6821 w use "[w]" instead of "written" for file write message
6822 and "[a]" instead of "appended" for ':w >> file' command
6823 x use "[dos]" instead of "[dos format]", "[unix]" instead of
6824 "[unix format]" and "[mac]" instead of "[mac format]".
6825 a all of the above abbreviations
6826
6827 o overwrite message for writing a file with subsequent message
6828 for reading a file (useful for ":wn" or when 'autowrite' on)
6829 O message for reading a file overwrites any previous message.
6830 Also for quickfix message (e.g., ":cn").
6831 s don't give "search hit BOTTOM, continuing at TOP" or "search
Bram Moolenaara6c27c42019-05-09 19:16:22 +02006832 hit TOP, continuing at BOTTOM" messages; when using the search
6833 count do not show "W" after the count message (see S below)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006834 t truncate file message at the start if it is too long to fit
6835 on the command-line, "<" will appear in the left most column.
6836 Ignored in Ex mode.
6837 T truncate other messages in the middle if they are too long to
Bram Moolenaar582fd852005-03-28 20:58:01 +00006838 fit on the command line. "..." will appear in the middle.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006839 Ignored in Ex mode.
6840 W don't give "written" or "[w]" when writing a file
6841 A don't give the "ATTENTION" message when an existing swap file
6842 is found.
6843 I don't give the intro message when starting Vim |:intro|.
Bram Moolenaarea389e92014-05-28 21:40:52 +02006844 c don't give |ins-completion-menu| messages. For example,
6845 "-- XXX completion (YYY)", "match 1 of 2", "The only match",
6846 "Pattern not found", "Back at original", etc.
Bram Moolenaar426dd022016-03-15 15:09:29 +01006847 q use "recording" instead of "recording @a"
6848 F don't give the file info when editing a file, like `:silent`
Bram Moolenaar110289e2019-05-23 15:38:06 +02006849 was used for the command; note that this also affects messages
6850 from autocommands
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02006851 S do not show search count message when searching, e.g.
6852 "[1/5]"
Bram Moolenaar071d4272004-06-13 20:20:40 +00006853
6854 This gives you the opportunity to avoid that a change between buffers
6855 requires you to hit <Enter>, but still gives as useful a message as
6856 possible for the space available. To get the whole message that you
6857 would have got with 'shm' empty, use ":file!"
6858 Useful values:
6859 shm= No abbreviation of message.
6860 shm=a Abbreviation, but no loss of information.
6861 shm=at Abbreviation, and truncate message when necessary.
6862
6863 NOTE: This option is set to the Vi default value when 'compatible' is
6864 set and to the Vim default value when 'compatible' is reset.
6865
6866 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
6867'shortname' 'sn' boolean (default off)
6868 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00006869 Filenames are assumed to be 8 characters plus one extension of 3
6870 characters. Multiple dots in file names are not allowed. When this
6871 option is on, dots in file names are replaced with underscores when
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006872 adding an extension (".~" or ".swp"). This option is useful
Bram Moolenaar071d4272004-06-13 20:20:40 +00006873 when editing files on an MS-DOS compatible filesystem, e.g., messydos
Bram Moolenaarade0d392020-01-21 22:33:58 +01006874 or crossdos.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006875
6876 *'showbreak'* *'sbr'* *E595*
6877'showbreak' 'sbr' string (default "")
Bram Moolenaaree857022019-11-09 23:26:40 +01006878 global or local to window |global-local|
Bram Moolenaardb84e452010-08-15 13:50:43 +02006879 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006880 feature}
6881 String to put at the start of lines that have been wrapped. Useful
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006882 values are "> " or "+++ ": >
6883 :set showbreak=>\
6884< Note the backslash to escape the trailing space. It's easier like
6885 this: >
Bram Moolenaar1a384422010-07-14 19:53:30 +02006886 :let &showbreak = '+++ '
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006887< Only printable single-cell characters are allowed, excluding <Tab> and
Bram Moolenaar071d4272004-06-13 20:20:40 +00006888 comma (in a future version the comma might be used to separate the
6889 part that is shown at the end and at the start of a line).
6890 The characters are highlighted according to the '@' flag in
6891 'highlight'.
6892 Note that tabs after the showbreak will be displayed differently.
6893 If you want the 'showbreak' to appear in between line numbers, add the
6894 "n" flag to 'cpoptions'.
Bram Moolenaaree857022019-11-09 23:26:40 +01006895 A window-local value overrules a global value. If the global value is
6896 set and you want no value in the current window use NONE: >
6897 :setlocal showbreak=NONE
6898<
Bram Moolenaar071d4272004-06-13 20:20:40 +00006899 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02006900'showcmd' 'sc' boolean (Vim default: on, off for Unix,
6901 Vi default: off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006902 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006903 {not available when compiled without the
6904 |+cmdline_info| feature}
Bram Moolenaar02467872007-05-06 13:22:01 +00006905 Show (partial) command in the last line of the screen. Set this
6906 option off if your terminal is slow.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006907 In Visual mode the size of the selected area is shown:
6908 - When selecting characters within a line, the number of characters.
Bram Moolenaarf91787c2010-07-17 12:47:16 +02006909 If the number of bytes is different it is also displayed: "2-6"
6910 means two characters and six bytes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006911 - When selecting more than one line, the number of lines.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006912 - When selecting a block, the size in screen characters:
6913 {lines}x{columns}.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006914 NOTE: This option is set to the Vi default value when 'compatible' is
6915 set and to the Vim default value when 'compatible' is reset.
6916
6917 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
6918'showfulltag' 'sft' boolean (default off)
6919 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006920 When completing a word in insert mode (see |ins-completion|) from the
6921 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006922 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00006923 matched a C function, you can see a template for what arguments are
6924 required (coding style permitting).
Bram Moolenaar446cb832008-06-24 21:56:24 +00006925 Note that this doesn't work well together with having "longest" in
6926 'completeopt', because the completion from the search pattern may not
6927 match the typed text.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006928
6929 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
6930'showmatch' 'sm' boolean (default off)
6931 global
6932 When a bracket is inserted, briefly jump to the matching one. The
6933 jump is only done if the match can be seen on the screen. The time to
6934 show the match can be set with 'matchtime'.
6935 A Beep is given if there is no match (no matter if the match can be
Bram Moolenaarca635012015-09-25 20:34:21 +02006936 seen or not).
6937 This option is reset when 'paste' is set and restored when 'paste' is
6938 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006939 When the 'm' flag is not included in 'cpoptions', typing a character
6940 will immediately move the cursor back to where it belongs.
6941 See the "sm" field in 'guicursor' for setting the cursor shape and
6942 blinking when showing the match.
6943 The 'matchpairs' option can be used to specify the characters to show
6944 matches for. 'rightleft' and 'revins' are used to look for opposite
6945 matches.
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006946 Also see the matchparen plugin for highlighting the match when moving
6947 around |pi_paren.txt|.
6948 Note: Use of the short form is rated PG.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006949
6950 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
6951'showmode' 'smd' boolean (Vim default: on, Vi default: off)
6952 global
6953 If in Insert, Replace or Visual mode put a message on the last line.
6954 Use the 'M' flag in 'highlight' to set the type of highlighting for
6955 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006956 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00006957 doesn't mean XIM is really active, especially when 'imactivatekey' is
6958 not set.
6959 NOTE: This option is set to the Vi default value when 'compatible' is
6960 set and to the Vim default value when 'compatible' is reset.
6961
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006962 *'showtabline'* *'stal'*
6963'showtabline' 'stal' number (default 1)
6964 global
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006965 The value of this option specifies when the line with tab page labels
6966 will be displayed:
6967 0: never
6968 1: only if there are at least two tab pages
6969 2: always
6970 This is both for the GUI and non-GUI implementation of the tab pages
6971 line.
6972 See |tab-page| for more information about tab pages.
6973
Bram Moolenaar071d4272004-06-13 20:20:40 +00006974 *'sidescroll'* *'ss'*
6975'sidescroll' 'ss' number (default 0)
6976 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006977 The minimal number of columns to scroll horizontally. Used only when
6978 the 'wrap' option is off and the cursor is moved off of the screen.
6979 When it is zero the cursor will be put in the middle of the screen.
6980 When using a slow terminal set it to a large number or 0. When using
6981 a fast terminal use a small number or 1. Not used for "zh" and "zl"
6982 commands.
6983
6984 *'sidescrolloff'* *'siso'*
6985'sidescrolloff' 'siso' number (default 0)
Bram Moolenaar375e3392019-01-31 18:26:10 +01006986 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006987 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00006988 right of the cursor if 'nowrap' is set. Setting this option to a
6989 value greater than 0 while having |'sidescroll'| also at a non-zero
6990 value makes some context visible in the line you are scrolling in
6991 horizontally (except at beginning of the line). Setting this option
6992 to a large value (like 999) has the effect of keeping the cursor
6993 horizontally centered in the window, as long as one does not come too
6994 close to the beginning of the line.
Bram Moolenaar375e3392019-01-31 18:26:10 +01006995 After using the local value, go back the global value with one of
6996 these two: >
6997 setlocal sidescrolloff<
6998 setlocal sidescrolloff=-1
6999< NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007000
7001 Example: Try this together with 'sidescroll' and 'listchars' as
7002 in the following example to never allow the cursor to move
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007003 onto the "extends" character: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007004
7005 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
7006 :set sidescrolloff=1
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007007<
7008 *'signcolumn'* *'scl'*
7009'signcolumn' 'scl' string (default "auto")
7010 local to window
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007011 {not available when compiled without the |+signs|
7012 feature}
Bram Moolenaar09521312016-08-12 22:54:35 +02007013 Whether or not to draw the signcolumn. Valid values are:
7014 "auto" only when there is a sign to display
7015 "no" never
7016 "yes" always
Bram Moolenaar394c5d82019-06-17 21:48:05 +02007017 "number" display signs in the 'number' column. If the number
Bram Moolenaar6c1e1572019-06-22 02:13:00 +02007018 column is not present, then behaves like "auto".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007019
7020
7021 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
7022'smartcase' 'scs' boolean (default off)
7023 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007024 Override the 'ignorecase' option if the search pattern contains upper
7025 case characters. Only used when the search pattern is typed and
7026 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarc8734422012-06-01 22:38:45 +02007027 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00007028 "*" and "#" you can make 'smartcase' used by doing a "/" command,
7029 recalling the search pattern from history and hitting <Enter>.
7030 NOTE: This option is reset when 'compatible' is set.
7031
7032 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
7033'smartindent' 'si' boolean (default off)
7034 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007035 {not available when compiled without the
7036 |+smartindent| feature}
7037 Do smart autoindenting when starting a new line. Works for C-like
7038 programs, but can also be used for other languages. 'cindent' does
7039 something like this, works better in most cases, but is more strict,
Bram Moolenaar81af9252010-12-10 20:35:50 +01007040 see |C-indenting|. When 'cindent' is on or 'indentexpr' is set,
Bram Moolenaar166af9b2010-11-16 20:34:40 +01007041 setting 'si' has no effect. 'indentexpr' is a more advanced
7042 alternative.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007043 Normally 'autoindent' should also be on when using 'smartindent'.
7044 An indent is automatically inserted:
7045 - After a line ending in '{'.
7046 - After a line starting with a keyword from 'cinwords'.
7047 - Before a line starting with '}' (only with the "O" command).
7048 When typing '}' as the first character in a new line, that line is
7049 given the same indent as the matching '{'.
7050 When typing '#' as the first character in a new line, the indent for
7051 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007052 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00007053 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
7054 When using the ">>" command, lines starting with '#' are not shifted
7055 right.
Bram Moolenaar036986f2017-03-16 17:41:02 +01007056 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02007057 This option is reset when 'paste' is set and restored when 'paste' is
7058 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007059
7060 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
7061'smarttab' 'sta' boolean (default off)
7062 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007063 When on, a <Tab> in front of a line inserts blanks according to
Bram Moolenaar280f1262006-01-30 00:14:18 +00007064 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A
7065 <BS> will delete a 'shiftwidth' worth of space at the start of the
7066 line.
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00007067 When off, a <Tab> always inserts blanks according to 'tabstop' or
Bram Moolenaar280f1262006-01-30 00:14:18 +00007068 'softtabstop'. 'shiftwidth' is only used for shifting text left or
7069 right |shift-left-right|.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007070 What gets inserted (a <Tab> or spaces) depends on the 'expandtab'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007071 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00007072 number of spaces is minimized by using <Tab>s.
Bram Moolenaarca635012015-09-25 20:34:21 +02007073 This option is reset when 'paste' is set and restored when 'paste' is
7074 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007075 NOTE: This option is reset when 'compatible' is set.
7076
7077 *'softtabstop'* *'sts'*
7078'softtabstop' 'sts' number (default 0)
7079 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007080 Number of spaces that a <Tab> counts for while performing editing
7081 operations, like inserting a <Tab> or using <BS>. It "feels" like
7082 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
7083 used. This is useful to keep the 'ts' setting at its standard value
7084 of 8, while being able to edit like it is set to 'sts'. However,
7085 commands like "x" still work on the actual characters.
7086 When 'sts' is zero, this feature is off.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02007087 When 'sts' is negative, the value of 'shiftwidth' is used.
Bram Moolenaarca635012015-09-25 20:34:21 +02007088 'softtabstop' is set to 0 when the 'paste' option is set and restored
7089 when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007090 See also |ins-expandtab|. When 'expandtab' is not set, the number of
7091 spaces is minimized by using <Tab>s.
7092 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
7093 set.
7094 NOTE: This option is set to 0 when 'compatible' is set.
7095
Bram Moolenaar04958cb2018-06-23 19:23:02 +02007096 If Vim is compiled with the |+vartabs| feature then the value of
7097 'softtabstop' will be ignored if |'varsofttabstop'| is set to
7098 anything other than an empty string.
7099
Bram Moolenaar217ad922005-03-20 22:37:15 +00007100 *'spell'* *'nospell'*
7101'spell' boolean (default off)
7102 local to window
Bram Moolenaar217ad922005-03-20 22:37:15 +00007103 {not available when compiled without the |+syntax|
7104 feature}
7105 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007106 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007107
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007108 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00007109'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007110 local to buffer
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007111 {not available when compiled without the |+syntax|
7112 feature}
7113 Pattern to locate the end of a sentence. The following word will be
7114 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007115 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007116 When this check is not wanted make this option empty.
7117 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00007118 Be careful with special characters, see |option-backslash| about
7119 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007120 To set this option automatically depending on the language, see
7121 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007122
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007123 *'spellfile'* *'spf'*
7124'spellfile' 'spf' string (default empty)
7125 local to buffer
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007126 {not available when compiled without the |+syntax|
7127 feature}
7128 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00007129 commands. It must end in ".{encoding}.add". You need to include the
7130 path, otherwise the file is placed in the current directory.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007131 *E765*
7132 It may also be a comma separated list of names. A count before the
7133 |zg| and |zw| commands can be used to access each. This allows using
7134 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007135 When a word is added while this option is empty Vim will set it for
Bram Moolenaar910f66f2006-04-05 20:41:53 +00007136 you: Using the first directory in 'runtimepath' that is writable. If
7137 there is no "spell" directory yet it will be created. For the file
7138 name the first language name that appears in 'spelllang' is used,
Bram Moolenaar3b506942005-06-23 22:36:45 +00007139 ignoring the region.
7140 The resulting ".spl" file will be used for spell checking, it does not
7141 have to appear in 'spelllang'.
7142 Normally one file is used for all regions, but you can add the region
7143 name if you want to. However, it will then only be used when
7144 'spellfile' is set to it, for entries in 'spelllang' only files
7145 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00007146 This option cannot be set from a |modeline| or in the |sandbox|, for
7147 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007148
Bram Moolenaar217ad922005-03-20 22:37:15 +00007149 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007150'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00007151 local to buffer
Bram Moolenaar217ad922005-03-20 22:37:15 +00007152 {not available when compiled without the |+syntax|
7153 feature}
Bram Moolenaar3b506942005-06-23 22:36:45 +00007154 A comma separated list of word list names. When the 'spell' option is
7155 on spellchecking will be done for these languages. Example: >
7156 set spelllang=en_us,nl,medical
7157< This means US English, Dutch and medical words are recognized. Words
7158 that are not recognized will be highlighted.
Bram Moolenaar911ead12019-04-21 00:03:35 +02007159 The word list name must consist of alphanumeric characters, a dash or
7160 an underscore. It should not include a comma or dot. Using a dash is
Bram Moolenaar3b506942005-06-23 22:36:45 +00007161 recommended to separate the two letter language name from a
7162 specification. Thus "en-rare" is used for rare English words.
7163 A region name must come last and have the form "_xx", where "xx" is
7164 the two-letter, lower case region name. You can use more than one
7165 region by listing them: "en_us,en_ca" supports both US and Canadian
7166 English, but not words specific for Australia, New Zealand or Great
Bram Moolenaarfa735342016-01-03 22:14:44 +01007167 Britain. (Note: currently en_au and en_nz dictionaries are older than
7168 en_ca, en_gb and en_us).
Bram Moolenaarcc63c642013-11-12 04:44:01 +01007169 If the name "cjk" is included East Asian characters are excluded from
7170 spell checking. This is useful when editing text that also has Asian
7171 words.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007172 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007173 As a special case the name of a .spl file can be given as-is. The
7174 first "_xx" in the name is removed and used as the region name
7175 (_xx is an underscore, two letters and followed by a non-letter).
7176 This is mainly for testing purposes. You must make sure the correct
7177 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007178 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007179 idea to set 'spelllang' after setting 'encoding' to avoid loading the
7180 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00007181 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007182
Bram Moolenaar98692072006-02-04 00:57:42 +00007183 If the |spellfile.vim| plugin is active and you use a language name
7184 for which Vim cannot find the .spl file in 'runtimepath' the plugin
7185 will ask you if you want to download the file.
7186
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007187 After this option has been set successfully, Vim will source the files
7188 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
Bram Moolenaarb730f0c2018-11-25 03:56:26 +01007189 up to the first character that is not an ASCII letter or number and
7190 not a dash. Also see |set-spc-auto|.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007191
Bram Moolenaar362b44b2020-06-10 21:47:00 +02007192 *'spelloptions'* *'spo'*
7193'spelloptions' 'spo' string (default "")
7194 local to buffer
7195 {not available when compiled without the |+syntax|
7196 feature}
7197 A comma separated list of options for spell checking:
7198 camel When a word is CamelCased, assume "Cased" is a
7199 separate word: every upper-case character in a word
7200 that comes after a lower case character indicates the
7201 start of a new word.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007202
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007203 *'spellsuggest'* *'sps'*
7204'spellsuggest' 'sps' string (default "best")
7205 global
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007206 {not available when compiled without the |+syntax|
7207 feature}
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007208 Methods used for spelling suggestions. Both for the |z=| command and
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007209 the |spellsuggest()| function. This is a comma-separated list of
7210 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007211
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007212 best Internal method that works best for English. Finds
7213 changes like "fast" and uses a bit of sound-a-like
7214 scoring to improve the ordering.
7215
7216 double Internal method that uses two methods and mixes the
7217 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007218 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007219 word. That only works when the language specifies
7220 sound folding. Can be slow and doesn't always give
7221 better results.
7222
7223 fast Internal method that only checks for simple changes:
7224 character inserts/deletes/swaps. Works well for
7225 simple typing mistakes.
7226
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007227 {number} The maximum number of suggestions listed for |z=|.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007228 Not used for |spellsuggest()|. The number of
7229 suggestions is never more than the value of 'lines'
7230 minus two.
7231
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007232 file:{filename} Read file {filename}, which must have two columns,
7233 separated by a slash. The first column contains the
7234 bad word, the second column the suggested good word.
7235 Example:
7236 theribal/terrible ~
7237 Use this for common mistakes that do not appear at the
7238 top of the suggestion list with the internal methods.
7239 Lines without a slash are ignored, use this for
7240 comments.
Bram Moolenaarbcb98982014-05-01 14:08:19 +02007241 The word in the second column must be correct,
7242 otherwise it will not be used. Add the word to an
7243 ".add" file if it is currently flagged as a spelling
7244 mistake.
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007245 The file is used for all languages.
7246
7247 expr:{expr} Evaluate expression {expr}. Use a function to avoid
7248 trouble with spaces. |v:val| holds the badly spelled
7249 word. The expression must evaluate to a List of
7250 Lists, each with a suggestion and a score.
7251 Example:
Bram Moolenaar214641f2017-03-05 17:04:09 +01007252 [['the', 33], ['that', 44]] ~
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007253 Set 'verbose' and use |z=| to see the scores that the
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007254 internal methods use. A lower score is better.
7255 This may invoke |spellsuggest()| if you temporarily
7256 set 'spellsuggest' to exclude the "expr:" part.
7257 Errors are silently ignored, unless you set the
7258 'verbose' option to a non-zero value.
7259
7260 Only one of "best", "double" or "fast" may be used. The others may
7261 appear several times in any order. Example: >
7262 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
7263<
7264 This option cannot be set from a |modeline| or in the |sandbox|, for
7265 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007266
7267
Bram Moolenaar071d4272004-06-13 20:20:40 +00007268 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
7269'splitbelow' 'sb' boolean (default off)
7270 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007271 When on, splitting a window will put the new window below the current
7272 one. |:split|
7273
7274 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
7275'splitright' 'spr' boolean (default off)
7276 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007277 When on, splitting a window will put the new window right of the
7278 current one. |:vsplit|
7279
7280 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
7281'startofline' 'sol' boolean (default on)
7282 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007283 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00007284 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007285 (if possible). This applies to the commands: CTRL-D, CTRL-U, CTRL-B,
Bram Moolenaar843ee412004-06-30 16:16:41 +00007286 CTRL-F, "G", "H", "M", "L", gg, and to the commands "d", "<<" and ">>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007287 with a linewise operator, with "%" with a count and to buffer changing
7288 commands (CTRL-^, :bnext, :bNext, etc.). Also for an Ex command that
7289 only has a line number, e.g., ":25" or ":+".
7290 In case of buffer changing commands the cursor is placed at the column
7291 where it was the last time the buffer was edited.
7292 NOTE: This option is set when 'compatible' is set.
7293
Bram Moolenaar00654022011-02-25 14:42:19 +01007294 *'statusline'* *'stl'* *E540* *E542*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007295'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007296 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007297 {not available when compiled without the |+statusline|
7298 feature}
7299 When nonempty, this option determines the content of the status line.
7300 Also see |status-line|.
7301
7302 The option consists of printf style '%' items interspersed with
7303 normal text. Each status line item is of the form:
7304 %-0{minwid}.{maxwid}{item}
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01007305 All fields except the {item} are optional. A single percent sign can
Bram Moolenaar8133cc62020-10-26 21:05:27 +01007306 be given as "%%".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007307
Bram Moolenaar238a5642006-02-21 22:12:05 +00007308 When the option starts with "%!" then it is used as an expression,
7309 evaluated and the result is used as the option value. Example: >
7310 :set statusline=%!MyStatusLine()
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02007311< The *g:statusline_winid* variable will be set to the |window-ID| of the
7312 window that the status line belongs to.
7313 The result can contain %{} items that will be evaluated too.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02007314 Note that the "%!" expression is evaluated in the context of the
7315 current window and buffer, while %{} items are evaluated in the
7316 context of the window that the statusline belongs to.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007317
7318 When there is error while evaluating the option then it will be made
7319 empty to avoid further errors. Otherwise screen updating would loop.
7320
Bram Moolenaar071d4272004-06-13 20:20:40 +00007321 Note that the only effect of 'ruler' when this option is set (and
7322 'laststatus' is 2) is controlling the output of |CTRL-G|.
7323
7324 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00007325 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00007326 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007327 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007328 minwid Minimum width of the item, padding as set by '-' & '0'.
7329 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007330 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007331 on the left for text items. Numeric items will be
7332 shifted down to maxwid-2 digits followed by '>'number
7333 where number is the amount of missing digits, much like
7334 an exponential notation.
7335 item A one letter code as described below.
7336
7337 Following is a description of the possible statusline items. The
7338 second character in "item" is the type:
7339 N for number
7340 S for string
7341 F for flags as described below
7342 - not applicable
7343
7344 item meaning ~
Bram Moolenaar02467872007-05-06 13:22:01 +00007345 f S Path to the file in the buffer, as typed or relative to current
7346 directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007347 F S Full path to the file in the buffer.
7348 t S File name (tail) of file in the buffer.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007349 m F Modified flag, text is "[+]"; "[-]" if 'modifiable' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007350 M F Modified flag, text is ",+" or ",-".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007351 r F Readonly flag, text is "[RO]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007352 R F Readonly flag, text is ",RO".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007353 h F Help buffer flag, text is "[help]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007354 H F Help buffer flag, text is ",HLP".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007355 w F Preview window flag, text is "[Preview]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007356 W F Preview window flag, text is ",PRV".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007357 y F Type of file in the buffer, e.g., "[vim]". See 'filetype'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007358 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
Bram Moolenaar7fd73202010-07-25 16:58:46 +02007359 q S "[Quickfix List]", "[Location List]" or empty.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007360 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
7361 being used: "<keymap>"
7362 n N Buffer number.
Bram Moolenaar00654022011-02-25 14:42:19 +01007363 b N Value of character under cursor.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007364 B N As above, in hexadecimal.
7365 o N Byte number in file of byte under cursor, first byte is 1.
7366 Mnemonic: Offset from start of file (with one added)
7367 {not available when compiled without |+byte_offset| feature}
7368 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007369 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007370 l N Line number.
7371 L N Number of lines in buffer.
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02007372 c N Column number (byte index).
7373 v N Virtual column number (screen column).
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007374 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007375 p N Percentage through file in lines as in |CTRL-G|.
7376 P S Percentage through file of displayed window. This is like the
Bram Moolenaar14b69452013-06-29 23:05:20 +02007377 percentage described for 'ruler'. Always 3 in length, unless
7378 translated.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007379 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00007380 Empty if the argument file count is zero or one.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007381 { NF Evaluate expression between '%{' and '}' and substitute result.
Bram Moolenaar6d150f72018-04-21 20:03:20 +02007382 Note that there is no '%' before the closing '}'. The
7383 expression cannot contain a '}' character, call a function to
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007384 work around that. See |stl-%{| below.
shadmansaleh30e3de22021-05-15 17:23:28 +02007385 {% - This is almost same as { except the result of the expression is
7386 re-evaluated as a statusline format string. Thus if the
7387 return value of expr contains % items they will get expanded.
7388 The expression can contain the } character, the end of
7389 expression is denoted by %}.
7390 The For example: >
7391 func! Stl_filename() abort
7392 return "%t"
7393 endfunc
7394< `stl=%{Stl_filename()}` results in `"%t"`
7395 `stl=%{%Stl_filename()%}` results in `"Name of current file"`
7396 } - End of `{%` expression
Bram Moolenaar071d4272004-06-13 20:20:40 +00007397 ( - Start of item group. Can be used for setting the width and
7398 alignment of a section. Must be followed by %) somewhere.
7399 ) - End of item group. No width fields allowed.
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007400 T N For 'tabline': start of tab page N label. Use %T after the last
7401 label. This information is used for mouse clicks.
7402 X N For 'tabline': start of close tab N label. Use %X after the
7403 label, e.g.: %3Xclose%X. Use %999X for a "close current tab"
7404 mark. This information is used for mouse clicks.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007405 < - Where to truncate line if too long. Default is at the start.
7406 No width fields allowed.
7407 = - Separation point between left and right aligned items.
7408 No width fields allowed.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007409 # - Set highlight group. The name must follow and then a # again.
7410 Thus use %#HLname# for highlight group HLname. The same
7411 highlighting is used, also for the statusline of non-current
7412 windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007413 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00007414 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007415 The difference between User{N} and StatusLine will be applied
7416 to StatusLineNC for the statusline of non-current windows.
7417 The number N must be between 1 and 9. See |hl-User1..9|
7418
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007419 When displaying a flag, Vim removes the leading comma, if any, when
7420 that flag comes right after plaintext. This will make a nice display
7421 when flags are used like in the examples below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007422
Bram Moolenaar582fd852005-03-28 20:58:01 +00007423 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00007424 not set) and a minwid is not set for the group, the whole group will
7425 become empty. This will make a group like the following disappear
7426 completely from the statusline when none of the flags are set. >
7427 :set statusline=...%(\ [%M%R%H]%)...
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02007428< Beware that an expression is evaluated each and every time the status
7429 line is displayed.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007430 *stl-%{* *g:actual_curbuf* *g:actual_curwin*
Bram Moolenaarade0d392020-01-21 22:33:58 +01007431 While evaluating %{} the current buffer and current window will be set
7432 temporarily to that of the window (and buffer) whose statusline is
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007433 currently being drawn. The expression will evaluate in this context.
7434 The variable "g:actual_curbuf" is set to the `bufnr()` number of the
7435 real current buffer and "g:actual_curwin" to the |window-ID| of the
7436 real current window. These values are strings.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007437
Bram Moolenaar30b65812012-07-12 22:01:11 +02007438 The 'statusline' option will be evaluated in the |sandbox| if set from
7439 a modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02007440 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007441
7442 It is not allowed to change text or jump to another window while
7443 evaluating 'statusline' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007444
7445 If the statusline is not updated when you want it (e.g., after setting
7446 a variable that's used in an expression), you can force an update by
7447 setting an option without changing its value. Example: >
7448 :let &ro = &ro
7449
7450< A result of all digits is regarded a number for display purposes.
7451 Otherwise the result is taken as flag text and applied to the rules
7452 described above.
7453
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00007454 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00007455 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
Bram Moolenaarc4da1132017-07-15 19:39:43 +02007456 edit your .vimrc or whatever with "vim --clean" to get it right.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007457
7458 Examples:
7459 Emulate standard status line with 'ruler' set >
7460 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
7461< Similar, but add ASCII value of char under the cursor (like "ga") >
7462 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
7463< Display byte count and byte value, modified flag in red. >
7464 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
7465 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
7466< Display a ,GZ flag if a compressed file is loaded >
7467 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
7468< In the |:autocmd|'s: >
7469 :let b:gzflag = 1
7470< And: >
7471 :unlet b:gzflag
7472< And define this function: >
7473 :function VarExists(var, val)
7474 : if exists(a:var) | return a:val | else | return '' | endif
7475 :endfunction
7476<
7477 *'suffixes'* *'su'*
7478'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
7479 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007480 Files with these suffixes get a lower priority when multiple files
7481 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007482 suffixes. Spaces after the comma are ignored. A dot is also seen as
7483 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007484 separator, precede it with a backslash (see |option-backslash| about
7485 including spaces and backslashes).
7486 See 'wildignore' for completely ignoring files.
7487 The use of |:set+=| and |:set-=| is preferred when adding or removing
7488 suffixes from the list. This avoids problems when a future version
7489 uses another default.
7490
7491 *'suffixesadd'* *'sua'*
7492'suffixesadd' 'sua' string (default "")
7493 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007494 {not available when compiled without the
7495 |+file_in_path| feature}
7496 Comma separated list of suffixes, which are used when searching for a
7497 file for the "gf", "[I", etc. commands. Example: >
7498 :set suffixesadd=.java
7499<
7500 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
7501'swapfile' 'swf' boolean (default on)
7502 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007503 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007504 swapfile is not wanted for a specific buffer. For example, with
7505 confidential information that even root must not be able to access.
7506 Careful: All text will be in memory:
7507 - Don't use this for big files.
7508 - Recovery will be impossible!
7509 A swapfile will only be present when |'updatecount'| is non-zero and
7510 'swapfile' is set.
7511 When 'swapfile' is reset, the swap file for the current buffer is
7512 immediately deleted. When 'swapfile' is set, and 'updatecount' is
7513 non-zero, a swap file is immediately created.
7514 Also see |swap-file| and |'swapsync'|.
Bram Moolenaar76f3b1a2014-03-27 22:30:07 +01007515 If you want to open a new buffer without creating a swap file for it,
7516 use the |:noswapfile| modifier.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01007517 See 'directory' for where the swap file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007518
7519 This option is used together with 'bufhidden' and 'buftype' to
7520 specify special kinds of buffers. See |special-buffers|.
7521
7522 *'swapsync'* *'sws'*
7523'swapsync' 'sws' string (default "fsync")
7524 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007525 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007526 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007527 When this option is empty parts of the swap file may be in memory and
7528 not written to disk. When the system crashes you may lose more work.
7529 On Unix the system does a sync now and then without Vim asking for it,
7530 so the disadvantage of setting this option off is small. On some
7531 systems the swap file will not be written at all. For a unix system
7532 setting it to "sync" will use the sync() call instead of the default
7533 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007534 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007535
7536 *'switchbuf'* *'swb'*
7537'switchbuf' 'swb' string (default "")
7538 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007539 This option controls the behavior when switching between buffers.
Bram Moolenaard2ea7cf2021-05-30 20:54:13 +02007540 Mostly for |quickfix| commands some values are also used for other
7541 commands, as mentioned below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007542 Possible values (comma separated list):
7543 useopen If included, jump to the first open window that
7544 contains the specified buffer (if there is one).
7545 Otherwise: Do not examine other windows.
7546 This setting is checked with |quickfix| commands, when
7547 jumping to errors (":cc", ":cn", "cp", etc.). It is
7548 also used in all buffer related split commands, for
7549 example ":sbuffer", ":sbnext", or ":sbrewind".
Bram Moolenaar779b74b2006-04-10 14:55:34 +00007550 usetab Like "useopen", but also consider windows in other tab
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00007551 pages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007552 split If included, split the current window before loading
Bram Moolenaar15146672011-10-20 22:22:38 +02007553 a buffer for a |quickfix| command that display errors.
Bram Moolenaar63b74a82019-03-24 15:09:13 +01007554 Otherwise: do not split, use current window (when used
7555 in the quickfix window: the previously used window or
7556 split if there is no other window).
Bram Moolenaara594d772015-06-19 14:41:49 +02007557 vsplit Just like "split" but split vertically.
Bram Moolenaar446cb832008-06-24 21:56:24 +00007558 newtab Like "split", but open a new tab page. Overrules
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02007559 "split" when both are present.
Bram Moolenaar539aa6b2019-11-17 18:09:38 +01007560 uselast If included, jump to the previously used window when
7561 jumping to errors with |quickfix| commands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007562
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007563 *'synmaxcol'* *'smc'*
7564'synmaxcol' 'smc' number (default 3000)
7565 local to buffer
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007566 {not available when compiled without the |+syntax|
7567 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007568 Maximum column in which to search for syntax items. In long lines the
7569 text after this column is not highlighted and following lines may not
7570 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007571 This helps to avoid very slow redrawing for an XML file that is one
7572 long line.
7573 Set to zero to remove the limit.
7574
Bram Moolenaar071d4272004-06-13 20:20:40 +00007575 *'syntax'* *'syn'*
7576'syntax' 'syn' string (default empty)
7577 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007578 {not available when compiled without the |+syntax|
7579 feature}
7580 When this option is set, the syntax with this name is loaded, unless
7581 syntax highlighting has been switched off with ":syntax off".
7582 Otherwise this option does not always reflect the current syntax (the
7583 b:current_syntax variable does).
7584 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007585 not automatically recognized. Example, in an IDL file:
7586 /* vim: set syntax=idl : */ ~
7587 When a dot appears in the value then this separates two filetype
7588 names. Example:
7589 /* vim: set syntax=c.doxygen : */ ~
7590 This will use the "c" syntax first, then the "doxygen" syntax.
7591 Note that the second one must be prepared to be loaded as an addition,
7592 otherwise it will be skipped. More than one dot may appear.
7593 To switch off syntax highlighting for the current file, use: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007594 :set syntax=OFF
7595< To switch syntax highlighting on according to the current value of the
7596 'filetype' option: >
7597 :set syntax=ON
7598< What actually happens when setting the 'syntax' option is that the
7599 Syntax autocommand event is triggered with the value as argument.
7600 This option is not copied to another buffer, independent of the 's' or
7601 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007602 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007603
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007604 *'tabline'* *'tal'*
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007605'tabline' 'tal' string (default empty)
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007606 global
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007607 When nonempty, this option determines the content of the tab pages
7608 line at the top of the Vim window. When empty Vim will use a default
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007609 tab pages line. See |setting-tabline| for more info.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007610
7611 The tab pages line only appears as specified with the 'showtabline'
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00007612 option and only when there is no GUI tab line. When 'e' is in
7613 'guioptions' and the GUI supports a tab line 'guitablabel' is used
Bram Moolenaar7f036442010-08-15 15:24:20 +02007614 instead. Note that the two tab pages lines are very different.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007615
7616 The value is evaluated like with 'statusline'. You can use
7617 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007618 the text to be displayed. Use "%1T" for the first label, "%2T" for
7619 the second one, etc. Use "%X" items for closing labels.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007620
Bram Moolenaare12bab32019-01-08 22:02:56 +01007621 When changing something that is used in 'tabline' that does not
7622 trigger it to be updated, use |:redrawtabline|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02007623 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaare12bab32019-01-08 22:02:56 +01007624
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007625 Keep in mind that only one of the tab pages is the current one, others
7626 are invisible and you can't jump to their windows.
7627
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007628
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007629 *'tabpagemax'* *'tpm'*
7630'tabpagemax' 'tpm' number (default 10)
7631 global
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007632 Maximum number of tab pages to be opened by the |-p| command line
7633 argument or the ":tab all" command. |tabpage|
7634
7635
7636 *'tabstop'* *'ts'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007637'tabstop' 'ts' number (default 8)
7638 local to buffer
7639 Number of spaces that a <Tab> in the file counts for. Also see
7640 |:retab| command, and 'softtabstop' option.
7641
7642 Note: Setting 'tabstop' to any other value than 8 can make your file
7643 appear wrong in many places (e.g., when printing it).
7644
7645 There are four main ways to use tabs in Vim:
7646 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
7647 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007648 will use a mix of tabs and spaces, but typing <Tab> and <BS> will
Bram Moolenaar071d4272004-06-13 20:20:40 +00007649 behave like a tab appears every 4 (or 3) characters.
7650 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
7651 'expandtab'. This way you will always insert spaces. The
7652 formatting will never be messed up when 'tabstop' is changed.
7653 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007654 |modeline| to set these values when editing the file again. Only
Bram Moolenaar071d4272004-06-13 20:20:40 +00007655 works when using Vim to edit the file.
7656 4. Always set 'tabstop' and 'shiftwidth' to the same value, and
7657 'noexpandtab'. This should then work (for initial indents only)
7658 for any tabstop setting that people use. It might be nice to have
7659 tabs after the first non-blank inserted as spaces if you do this
7660 though. Otherwise aligned comments will be wrong when 'tabstop' is
7661 changed.
7662
Bram Moolenaar04958cb2018-06-23 19:23:02 +02007663 If Vim is compiled with the |+vartabs| feature then the value of
7664 'tabstop' will be ignored if |'vartabstop'| is set to anything other
7665 than an empty string.
7666
Bram Moolenaar071d4272004-06-13 20:20:40 +00007667 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
7668'tagbsearch' 'tbs' boolean (default on)
7669 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007670 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007671 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00007672 searching makes searching for a tag a LOT faster, but a linear search
7673 will find more tags if the tags file wasn't properly sorted.
7674 Vim normally assumes that your tags files are sorted, or indicate that
7675 they are not sorted. Only when this is not the case does the
7676 'tagbsearch' option need to be switched off.
7677
7678 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007679 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00007680 certain files, or retry all files with a linear search. When
7681 'tagbsearch' is off, only a linear search is done.
7682
7683 Linear searching is done anyway, for one file, when Vim finds a line
7684 at the start of the file indicating that it's not sorted: >
Bram Moolenaar446cb832008-06-24 21:56:24 +00007685 !_TAG_FILE_SORTED 0 /some comment/
Bram Moolenaar071d4272004-06-13 20:20:40 +00007686< [The whitespace before and after the '0' must be a single <Tab>]
7687
7688 When a binary search was done and no match was found in any of the
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007689 files listed in 'tags', and case is ignored or a pattern is used
Bram Moolenaar071d4272004-06-13 20:20:40 +00007690 instead of a normal tag name, a retry is done with a linear search.
7691 Tags in unsorted tags files, and matches with different case will only
7692 be found in the retry.
7693
Bram Moolenaard4755bb2004-09-02 19:12:26 +00007694 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007695 linear search can be avoided when case is ignored. Use a value of '2'
7696 in the "!_TAG_FILE_SORTED" line for this. A tag file can be case-fold
7697 sorted with the -f switch to "sort" in most unices, as in the command:
7698 "sort -f -o tags tags". For "Exuberant ctags" version 5.x or higher
7699 (at least 5.5) the --sort=foldcase switch can be used for this as
7700 well. Note that case must be folded to uppercase for this to work.
7701
7702 By default, tag searches are case-sensitive. Case is ignored when
7703 'ignorecase' is set and 'tagcase' is "followic", or when 'tagcase' is
7704 "ignore".
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007705 Also when 'tagcase' is "followscs" and 'smartcase' is set, or
7706 'tagcase' is "smart", and the pattern contains only lowercase
7707 characters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007708
7709 When 'tagbsearch' is off, tags searching is slower when a full match
7710 exists, but faster when no full match exists. Tags in unsorted tags
7711 files may only be found with 'tagbsearch' off.
7712 When the tags file is not sorted, or sorted in a wrong way (not on
7713 ASCII byte value), 'tagbsearch' should be off, or the line given above
7714 must be included in the tags file.
7715 This option doesn't affect commands that find all matching tags (e.g.,
7716 command-line completion and ":help").
Bram Moolenaar071d4272004-06-13 20:20:40 +00007717
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007718 *'tagcase'* *'tc'*
7719'tagcase' 'tc' string (default "followic")
7720 global or local to buffer |global-local|
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007721 This option specifies how case is handled when searching the tags
7722 file:
7723 followic Follow the 'ignorecase' option
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007724 followscs Follow the 'smartcase' and 'ignorecase' options
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007725 ignore Ignore case
7726 match Match case
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007727 smart Ignore case unless an upper case letter is used
Bram Moolenaar036986f2017-03-16 17:41:02 +01007728 NOTE: This option is set to the Vi default value when 'compatible' is
7729 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007730
Bram Moolenaar45e18cb2019-04-28 18:05:35 +02007731 *'tagfunc'* *'tfu'*
7732'tagfunc' 'tfu' string (default: empty)
7733 local to buffer
7734 {not available when compiled without the |+eval|
7735 feature}
7736 This option specifies a function to be used to perform tag searches.
7737 The function gets the tag pattern and should return a List of matching
7738 tags. See |tag-function| for an explanation of how to write the
7739 function and an example.
7740
Bram Moolenaar071d4272004-06-13 20:20:40 +00007741 *'taglength'* *'tl'*
7742'taglength' 'tl' number (default 0)
7743 global
7744 If non-zero, tags are significant up to this number of characters.
7745
7746 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
7747'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
7748 global
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00007749 If on and using a tags file in another directory, file names in that
7750 tags file are relative to the directory where the tags file is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007751 NOTE: This option is set to the Vi default value when 'compatible' is
7752 set and to the Vim default value when 'compatible' is reset.
7753
7754 *'tags'* *'tag'* *E433*
7755'tags' 'tag' string (default "./tags,tags", when compiled with
7756 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
7757 global or local to buffer |global-local|
7758 Filenames for the tag command, separated by spaces or commas. To
7759 include a space or comma in a file name, precede it with a backslash
7760 (see |option-backslash| about including spaces and backslashes).
7761 When a file name starts with "./", the '.' is replaced with the path
7762 of the current file. But only when the 'd' flag is not included in
7763 'cpoptions'. Environment variables are expanded |:set_env|. Also see
7764 |tags-option|.
7765 "*", "**" and other wildcards can be used to search for tags files in
Bram Moolenaare2b590e2010-08-08 18:29:48 +02007766 a directory tree. See |file-searching|. E.g., "/lib/**/tags" will
7767 find all files named "tags" below "/lib". The filename itself cannot
7768 contain wildcards, it is used as-is. E.g., "/lib/**/tags?" will find
7769 files called "tags?". {not available when compiled without the
7770 |+path_extra| feature}
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00007771 The |tagfiles()| function can be used to get a list of the file names
7772 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007773 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
7774 files are also supported. They are automatically recognized. The
7775 default value becomes "./tags,./TAGS,tags,TAGS", unless case
7776 differences are ignored (MS-Windows). |emacs-tags|
7777 The use of |:set+=| and |:set-=| is preferred when adding or removing
7778 file names from the list. This avoids problems when a future version
7779 uses another default.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007780
7781 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
7782'tagstack' 'tgst' boolean (default on)
7783 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007784 When on, the |tagstack| is used normally. When off, a ":tag" or
7785 ":tselect" command with an argument will not push the tag onto the
7786 tagstack. A following ":tag" without an argument, a ":pop" command or
7787 any other command that uses the tagstack will use the unmodified
7788 tagstack, but does change the pointer to the active entry.
7789 Resetting this option is useful when using a ":tag" command in a
7790 mapping which should not change the tagstack.
7791
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007792 *'tcldll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01007793'tcldll' string (default depends on the build)
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007794 global
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007795 {only available when compiled with the |+tcl/dyn|
7796 feature}
7797 Specifies the name of the Tcl shared library. The default is
7798 DYNAMIC_TCL_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02007799 Environment variables are expanded |:set_env|.
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007800 This option cannot be set from a |modeline| or in the |sandbox|, for
7801 security reasons.
7802
Bram Moolenaar071d4272004-06-13 20:20:40 +00007803 *'term'* *E529* *E530* *E531*
7804'term' string (default is $TERM, if that fails:
7805 in the GUI: "builtin_gui"
7806 on Amiga: "amiga"
Bram Moolenaarb3f74062020-02-26 16:16:53 +01007807 on Haiku: "xterm"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007808 on Mac: "mac-ansi"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007809 on Unix: "ansi"
7810 on VMS: "ansi"
7811 on Win 32: "win32")
7812 global
7813 Name of the terminal. Used for choosing the terminal control
7814 characters. Environment variables are expanded |:set_env|.
7815 For example: >
7816 :set term=$TERM
7817< See |termcap|.
7818
7819 *'termbidi'* *'tbidi'*
7820 *'notermbidi'* *'notbidi'*
7821'termbidi' 'tbidi' boolean (default off, on for "mlterm")
7822 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007823 {only available when compiled with the |+arabic|
7824 feature}
7825 The terminal is in charge of Bi-directionality of text (as specified
7826 by Unicode). The terminal is also expected to do the required shaping
7827 that some languages (such as Arabic) require.
7828 Setting this option implies that 'rightleft' will not be set when
7829 'arabic' is set and the value of 'arabicshape' will be ignored.
7830 Note that setting 'termbidi' has the immediate effect that
7831 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
7832 This option is reset when the GUI is started.
7833 For further details see |arabic.txt|.
7834
7835 *'termencoding'* *'tenc'*
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02007836'termencoding' 'tenc' string (default ""; with GTK+ GUI: "utf-8")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007837 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007838 Encoding used for the terminal. This specifies what character
7839 encoding the keyboard produces and the display will understand. For
Bram Moolenaar3848e002016-03-19 18:42:29 +01007840 the GUI it only applies to the keyboard ('encoding' is used for the
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02007841 display).
Bram Moolenaar4b7cdca2020-01-01 16:18:38 +01007842 *E617* *E950*
Bram Moolenaar3df01732017-02-17 22:47:16 +01007843 Note: This does not apply to the GTK+ GUI. After the GUI has been
Bram Moolenaar071d4272004-06-13 20:20:40 +00007844 successfully initialized, 'termencoding' is forcibly set to "utf-8".
7845 Any attempts to set a different value will be rejected, and an error
7846 message is shown.
Bram Moolenaarac360bf2015-09-01 20:31:20 +02007847 For the Win32 GUI and console versions 'termencoding' is not used,
Bram Moolenaar071d4272004-06-13 20:20:40 +00007848 because the Win32 system always passes Unicode characters.
7849 When empty, the same encoding is used as for the 'encoding' option.
7850 This is the normal value.
7851 Not all combinations for 'termencoding' and 'encoding' are valid. See
7852 |encoding-table|.
7853 The value for this option must be supported by internal conversions or
7854 iconv(). When this is not possible no conversion will be done and you
7855 will probably experience problems with non-ASCII characters.
7856 Example: You are working with the locale set to euc-jp (Japanese) and
7857 want to edit a UTF-8 file: >
7858 :let &termencoding = &encoding
7859 :set encoding=utf-8
7860< You need to do this when your system has no locale support for UTF-8.
7861
Bram Moolenaarcafafb32018-02-22 21:07:09 +01007862 *'termguicolors'* *'tgc'* *E954*
Bram Moolenaar61be73b2016-04-29 22:59:22 +02007863'termguicolors' 'tgc' boolean (default off)
7864 global
Bram Moolenaar61be73b2016-04-29 22:59:22 +02007865 {not available when compiled without the
7866 |+termguicolors| feature}
7867 When on, uses |highlight-guifg| and |highlight-guibg| attributes in
Bram Moolenaarcafafb32018-02-22 21:07:09 +01007868 the terminal (thus using 24-bit color).
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01007869
Bram Moolenaarcafafb32018-02-22 21:07:09 +01007870 Requires a ISO-8613-3 compatible terminal. If setting this option
7871 does not work (produces a colorless UI) reading |xterm-true-color|
7872 might help.
7873
7874 For Win32 console, Windows 10 version 1703 (Creators Update) or later
7875 is required. Use this check to find out: >
7876 if has('vcon')
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01007877< This requires Vim to be built with the |+vtp| feature.
7878
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +02007879 Note that the "cterm" attributes are still used, not the "gui" ones.
Bram Moolenaar036986f2017-03-16 17:41:02 +01007880 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar61be73b2016-04-29 22:59:22 +02007881
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02007882 *'termwinkey'* *'twk'*
7883'termwinkey' 'twk' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02007884 local to window
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007885 The key that starts a CTRL-W command in a terminal window. Other keys
Bram Moolenaar74675a62017-07-15 13:53:23 +02007886 are sent to the job running in the window.
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007887 The <> notation can be used, e.g.: >
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02007888 :set termwinkey=<C-L>
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007889< The string must be one key stroke but can be multiple bytes.
7890 When not set CTRL-W is used, so that CTRL-W : gets you to the command
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02007891 line. If 'termwinkey' is set to CTRL-L then CTRL-L : gets you to the
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007892 command line.
Bram Moolenaar74675a62017-07-15 13:53:23 +02007893
Bram Moolenaar6c60f472019-04-28 16:00:35 +02007894 *'termwinscroll'* *'twsl'*
7895'termwinscroll' 'twsl' number (default 10000)
7896 local to buffer
7897 {not available when compiled without the
7898 |+terminal| feature}
7899 Number of scrollback lines to keep. When going over this limit the
7900 first 10% of the scrollback lines are deleted. This is just to reduce
7901 the memory usage. See |Terminal-Normal|.
7902
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02007903 *'termwinsize'* *'tws'*
7904'termwinsize' 'tws' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02007905 local to window
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02007906 Size used when opening the |terminal| window. Format:
7907 {rows}x{columns} or {rows}*{columns}.
Bram Moolenaar74675a62017-07-15 13:53:23 +02007908 - When empty the terminal gets the size from the window.
Bram Moolenaar498c2562018-04-15 23:45:15 +02007909 - When set with a "x" (e.g., "24x80") the terminal size is not
7910 adjusted to the window size. If the window is smaller only the
7911 top-left part is displayed.
7912 - When set with a "*" (e.g., "10*50") the terminal size follows the
7913 window size, but will not be smaller than the specified rows and/or
7914 columns.
7915 - When rows is zero then use the height of the window.
7916 - When columns is zero then use the width of the window.
7917 - Using "0x0" or "0*0" is the same as empty.
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02007918 - Can be overruled in the |term_start()| options with "term_rows" and
7919 "term_cols".
Bram Moolenaar498c2562018-04-15 23:45:15 +02007920
7921 Examples:
7922 "30x0" uses 30 rows and the current window width.
7923 "20*0" uses at least 20 rows and the current window width.
7924 "0*40" uses the current window height and at least 40 columns.
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02007925 Note that the command running in the terminal window may still change
7926 the size of the terminal. In that case the Vim window will be
7927 adjusted to that size, if possible.
Bram Moolenaar74675a62017-07-15 13:53:23 +02007928
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01007929 *'termwintype'* *'twt'*
7930'termwintype' 'twt' string (default "")
7931 global
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01007932 {only available when compiled with the |terminal|
7933 feature on MS-Windows}
7934 Specify the virtual console (pty) used when opening the terminal
7935 window.
7936
7937 Possible values are:
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01007938 "" use ConPTY if it is stable, winpty otherwise
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01007939 "winpty" use winpty, fail if not supported
7940 "conpty" use |ConPTY|, fail if not supported
7941
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01007942 |ConPTY| support depends on the platform. Windows 10 October 2018
7943 Update is the first version that supports ConPTY, however it is still
7944 considered unstable. ConPTY might become stable in the next release
7945 of Windows 10. winpty support needs to be installed. If neither is
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01007946 supported then you cannot open a terminal window.
7947
Bram Moolenaar071d4272004-06-13 20:20:40 +00007948 *'terse'* *'noterse'*
7949'terse' boolean (default off)
7950 global
7951 When set: Add 's' flag to 'shortmess' option (this makes the message
7952 for a search that hits the start or end of the file not being
7953 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
7954 shortens a lot of messages}
7955
7956 *'textauto'* *'ta'* *'notextauto'* *'nota'*
7957'textauto' 'ta' boolean (Vim default: on, Vi default: off)
7958 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007959 This option is obsolete. Use 'fileformats'.
7960 For backwards compatibility, when 'textauto' is set, 'fileformats' is
7961 set to the default value for the current system. When 'textauto' is
7962 reset, 'fileformats' is made empty.
7963 NOTE: This option is set to the Vi default value when 'compatible' is
7964 set and to the Vim default value when 'compatible' is reset.
7965
7966 *'textmode'* *'tx'* *'notextmode'* *'notx'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01007967'textmode' 'tx' boolean (Win32: default on,
Bram Moolenaar071d4272004-06-13 20:20:40 +00007968 others: default off)
7969 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007970 This option is obsolete. Use 'fileformat'.
7971 For backwards compatibility, when 'textmode' is set, 'fileformat' is
7972 set to "dos". When 'textmode' is reset, 'fileformat' is set to
7973 "unix".
7974
7975 *'textwidth'* *'tw'*
7976'textwidth' 'tw' number (default 0)
7977 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007978 Maximum width of text that is being inserted. A longer line will be
7979 broken after white space to get this width. A zero value disables
Bram Moolenaarca635012015-09-25 20:34:21 +02007980 this.
7981 'textwidth' is set to 0 when the 'paste' option is set and restored
7982 when 'paste' is reset.
7983 When 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00007984 'formatoptions' and |ins-textwidth|.
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00007985 When 'formatexpr' is set it will be used to break the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007986 NOTE: This option is set to 0 when 'compatible' is set.
7987
7988 *'thesaurus'* *'tsr'*
7989'thesaurus' 'tsr' string (default "")
7990 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007991 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01007992 for thesaurus completion commands |i_CTRL-X_CTRL-T|.
7993
7994 Each line in the file should contain words with similar meaning,
7995 separated by non-keyword characters (white space is preferred).
7996 Maximum line length is 510 bytes.
7997
Bram Moolenaard47d5222018-12-09 20:43:55 +01007998 An English word list was added to this github issue:
7999 https://github.com/vim/vim/issues/629#issuecomment-443293282
8000 Unpack thesaurus_pkg.zip, put the thesaurus.txt file somewhere, e.g.
8001 ~/.vim/thesaurus/english.txt, and the 'thesaurus' option to this file
8002 name.
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01008003
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008004 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00008005 after a comma are ignored, otherwise spaces are included in the file
8006 name. See |option-backslash| about using backslashes.
8007 The use of |:set+=| and |:set-=| is preferred when adding or removing
8008 directories from the list. This avoids problems when a future version
8009 uses another default.
8010 Backticks cannot be used in this option for security reasons.
8011
8012 *'tildeop'* *'top'* *'notildeop'* *'notop'*
8013'tildeop' 'top' boolean (default off)
8014 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008015 When on: The tilde command "~" behaves like an operator.
8016 NOTE: This option is reset when 'compatible' is set.
8017
8018 *'timeout'* *'to'* *'notimeout'* *'noto'*
8019'timeout' 'to' boolean (default on)
8020 global
8021 *'ttimeout'* *'nottimeout'*
Bram Moolenaar94237492017-04-23 18:40:21 +02008022'ttimeout' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008023 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008024 These two options together determine the behavior when part of a
8025 mapped key sequence or keyboard code has been received:
8026
8027 'timeout' 'ttimeout' action ~
8028 off off do not time out
8029 on on or off time out on :mappings and key codes
8030 off on time out on key codes
8031
8032 If both options are off, Vim will wait until either the complete
8033 mapping or key sequence has been received, or it is clear that there
8034 is no mapping or key sequence for the received characters. For
8035 example: if you have mapped "vl" and Vim has received 'v', the next
8036 character is needed to see if the 'v' is followed by an 'l'.
8037 When one of the options is on, Vim will wait for about 1 second for
8038 the next character to arrive. After that the already received
8039 characters are interpreted as single characters. The waiting time can
8040 be changed with the 'timeoutlen' option.
8041 On slow terminals or very busy systems timing out may cause
8042 malfunctioning cursor keys. If both options are off, Vim waits
8043 forever after an entered <Esc> if there are key codes that start
8044 with <Esc>. You will have to type <Esc> twice. If you do not have
8045 problems with key codes, but would like to have :mapped key
8046 sequences not timing out in 1 second, set the 'ttimeout' option and
8047 reset the 'timeout' option.
8048
8049 NOTE: 'ttimeout' is reset when 'compatible' is set.
8050
8051 *'timeoutlen'* *'tm'*
8052'timeoutlen' 'tm' number (default 1000)
8053 global
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008054
Bram Moolenaar071d4272004-06-13 20:20:40 +00008055 *'ttimeoutlen'* *'ttm'*
Bram Moolenaar94237492017-04-23 18:40:21 +02008056'ttimeoutlen' 'ttm' number (default -1, set to 100 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008057 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008058 The time in milliseconds that is waited for a key code or mapped key
8059 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
8060 when part of a command has been typed.
8061 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
8062 different timeout value for key codes is desired set 'ttimeoutlen' to
8063 a non-negative number.
8064
8065 ttimeoutlen mapping delay key code delay ~
8066 < 0 'timeoutlen' 'timeoutlen'
8067 >= 0 'timeoutlen' 'ttimeoutlen'
8068
8069 The timeout only happens when the 'timeout' and 'ttimeout' options
8070 tell so. A useful setting would be >
8071 :set timeout timeoutlen=3000 ttimeoutlen=100
8072< (time out on mapping after three seconds, time out on key codes after
8073 a tenth of a second).
8074
8075 *'title'* *'notitle'*
8076'title' boolean (default off, on when title can be restored)
8077 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008078 {not available when compiled without the |+title|
8079 feature}
8080 When on, the title of the window will be set to the value of
8081 'titlestring' (if it is not empty), or to:
8082 filename [+=-] (path) - VIM
8083 Where:
8084 filename the name of the file being edited
8085 - indicates the file cannot be modified, 'ma' off
8086 + indicates the file was modified
8087 = indicates the file is read-only
8088 =+ indicates the file is read-only and modified
8089 (path) is the path of the file being edited
8090 - VIM the server name |v:servername| or "VIM"
8091 Only works if the terminal supports setting window titles
8092 (currently Amiga console, Win32 console, all GUI versions and
Bram Moolenaard1caa942020-04-10 22:10:56 +02008093 terminals with a non-empty 't_ts' option - these are Unix xterm and
Bram Moolenaar071d4272004-06-13 20:20:40 +00008094 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
8095 *X11*
8096 When Vim was compiled with HAVE_X11 defined, the original title will
8097 be restored if possible. The output of ":version" will include "+X11"
8098 when HAVE_X11 was defined, otherwise it will be "-X11". This also
8099 works for the icon name |'icon'|.
8100 But: When Vim was started with the |-X| argument, restoring the title
8101 will not work (except in the GUI).
8102 If the title cannot be restored, it is set to the value of 'titleold'.
8103 You might want to restore the title outside of Vim then.
8104 When using an xterm from a remote machine you can use this command:
8105 rsh machine_name xterm -display $DISPLAY &
8106 then the WINDOWID environment variable should be inherited and the
8107 title of the window should change back to what it should be after
8108 exiting Vim.
8109
8110 *'titlelen'*
8111'titlelen' number (default 85)
8112 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008113 {not available when compiled without the |+title|
8114 feature}
8115 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008116 title. When the title is longer, only the end of the path name is
8117 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008118 Using a percentage makes this adapt to the width of the window. But
8119 it won't work perfectly, because the actual number of characters
8120 available also depends on the font used and other things in the title
8121 bar. When 'titlelen' is zero the full path is used. Otherwise,
8122 values from 1 to 30000 percent can be used.
8123 'titlelen' is also used for the 'titlestring' option.
8124
8125 *'titleold'*
8126'titleold' string (default "Thanks for flying Vim")
8127 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008128 {only available when compiled with the |+title|
8129 feature}
8130 This option will be used for the window title when exiting Vim if the
8131 original title cannot be restored. Only happens if 'title' is on or
8132 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00008133 This option cannot be set from a |modeline| or in the |sandbox|, for
8134 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008135 *'titlestring'*
8136'titlestring' string (default "")
8137 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008138 {not available when compiled without the |+title|
8139 feature}
8140 When this option is not empty, it will be used for the title of the
8141 window. This happens only when the 'title' option is on.
8142 Only works if the terminal supports setting window titles (currently
8143 Amiga console, Win32 console, all GUI versions and terminals with a
8144 non-empty 't_ts' option).
8145 When Vim was compiled with HAVE_X11 defined, the original title will
Bram Moolenaar51628222016-12-01 23:03:28 +01008146 be restored if possible, see |X11|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008147
Bram Moolenaar071d4272004-06-13 20:20:40 +00008148 When this option contains printf-style '%' items, they will be
8149 expanded according to the rules used for 'statusline'.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008150 This option cannot be set in a modeline when 'modelineexpr' is off.
8151
Bram Moolenaar071d4272004-06-13 20:20:40 +00008152 Example: >
8153 :auto BufEnter * let &titlestring = hostname() . "/" . expand("%:p")
8154 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
8155< The value of 'titlelen' is used to align items in the middle or right
8156 of the available space.
8157 Some people prefer to have the file name first: >
8158 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
8159< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008160 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00008161 separating space only when needed.
8162 NOTE: Use of special characters in 'titlestring' may cause the display
8163 to be garbled (e.g., when it contains a CR or NL character).
8164 {not available when compiled without the |+statusline| feature}
8165
8166 *'toolbar'* *'tb'*
8167'toolbar' 'tb' string (default "icons,tooltips")
8168 global
8169 {only for |+GUI_GTK|, |+GUI_Athena|, |+GUI_Motif| and
8170 |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008171 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00008172 possible values are:
8173 icons Toolbar buttons are shown with icons.
8174 text Toolbar buttons shown with text.
8175 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008176 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008177 tooltips Tooltips are active for toolbar buttons.
8178 Tooltips refer to the popup help text which appears after the mouse
8179 cursor is placed over a toolbar button for a brief moment.
8180
8181 If you want the toolbar to be shown with icons as well as text, do the
8182 following: >
8183 :set tb=icons,text
8184< Motif and Athena cannot display icons and text at the same time. They
8185 will show icons if both are requested.
8186
8187 If none of the strings specified in 'toolbar' are valid or if
8188 'toolbar' is empty, this option is ignored. If you want to disable
8189 the toolbar, you need to set the 'guioptions' option. For example: >
8190 :set guioptions-=T
8191< Also see |gui-toolbar|.
8192
8193 *'toolbariconsize'* *'tbis'*
8194'toolbariconsize' 'tbis' string (default "small")
8195 global
Bram Moolenaar3df01732017-02-17 22:47:16 +01008196 {only in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008197 Controls the size of toolbar icons. The possible values are:
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008198 tiny Use tiny icons.
8199 small Use small icons (default).
8200 medium Use medium-sized icons.
8201 large Use large icons.
8202 huge Use even larger icons.
8203 giant Use very big icons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008204 The exact dimensions in pixels of the various icon sizes depend on
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008205 the current theme. Common dimensions are giant=48x48, huge=32x32,
8206 large=24x24, medium=24x24, small=20x20 and tiny=16x16.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008207
8208 If 'toolbariconsize' is empty, the global default size as determined
8209 by user preferences or the current theme is used.
8210
8211 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
8212'ttybuiltin' 'tbi' boolean (default on)
8213 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008214 When on, the builtin termcaps are searched before the external ones.
8215 When off the builtin termcaps are searched after the external ones.
8216 When this option is changed, you should set the 'term' option next for
8217 the change to take effect, for example: >
8218 :set notbi term=$TERM
8219< See also |termcap|.
8220 Rationale: The default for this option is "on", because the builtin
8221 termcap entries are generally better (many systems contain faulty
8222 xterm entries...).
8223
8224 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
8225'ttyfast' 'tf' boolean (default off, on when 'term' is xterm, hpterm,
8226 sun-cmd, screen, rxvt, dtterm or
8227 iris-ansi; also on when running Vim in
8228 a DOS console)
8229 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008230 Indicates a fast terminal connection. More characters will be sent to
8231 the screen for redrawing, instead of using insert/delete line
8232 commands. Improves smoothness of redrawing when there are multiple
8233 windows and the terminal does not support a scrolling region.
8234 Also enables the extra writing of characters at the end of each screen
8235 line for lines that wrap. This helps when using copy/paste with the
8236 mouse in an xterm and other terminals.
8237
8238 *'ttymouse'* *'ttym'*
8239'ttymouse' 'ttym' string (default depends on 'term')
8240 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008241 {only in Unix and VMS, doesn't work in the GUI; not
8242 available when compiled without |+mouse|}
8243 Name of the terminal type for which mouse codes are to be recognized.
Bram Moolenaar2c7a7632007-05-10 18:19:11 +00008244 Currently these strings are valid:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008245 *xterm-mouse*
8246 xterm xterm-like mouse handling. The mouse generates
8247 "<Esc>[Mscr", where "scr" is three bytes:
8248 "s" = button state
8249 "c" = column plus 33
8250 "r" = row plus 33
Bram Moolenaare968e362014-05-13 20:23:24 +02008251 This only works up to 223 columns! See "dec",
8252 "urxvt", and "sgr" for solutions.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008253 xterm2 Works like "xterm", but with the xterm reporting the
8254 mouse position while the mouse is dragged. This works
8255 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00008256 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00008257 work. See below for how Vim detects this
8258 automatically.
8259 *netterm-mouse*
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008260 netterm NetTerm mouse handling. A left mouse click generates
Bram Moolenaar071d4272004-06-13 20:20:40 +00008261 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008262 for the row and column. No other mouse events are
8263 supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008264 *dec-mouse*
8265 dec DEC terminal mouse handling. The mouse generates a
8266 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00008267 This is also available for an Xterm, if it was
8268 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00008269 *jsbterm-mouse*
8270 jsbterm JSB term mouse handling.
8271 *pterm-mouse*
8272 pterm QNX pterm mouse handling.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008273 *urxvt-mouse*
8274 urxvt Mouse handling for the urxvt (rxvt-unicode) terminal.
Bram Moolenaare968e362014-05-13 20:23:24 +02008275 The mouse works only if the terminal supports this
8276 encoding style, but it does not have 223 columns limit
8277 unlike "xterm" or "xterm2".
Bram Moolenaar9b451252012-08-15 17:43:31 +02008278 *sgr-mouse*
8279 sgr Mouse handling for the terminal that emits SGR-styled
Bram Moolenaare968e362014-05-13 20:23:24 +02008280 mouse reporting. The mouse works even in columns
8281 beyond 223. This option is backward compatible with
8282 "xterm2" because it can also decode "xterm2" style
8283 mouse codes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008284
8285 The mouse handling must be enabled at compile time |+mouse_xterm|
Bram Moolenaare968e362014-05-13 20:23:24 +02008286 |+mouse_dec| |+mouse_netterm| |+mouse_jsbterm| |+mouse_urxvt|
8287 |+mouse_sgr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008288 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
8289 recognized, if enabled at compile time. DEC terminal mouse codes
8290 are recognized if enabled at compile time, and 'ttymouse' is not
Bram Moolenaare968e362014-05-13 20:23:24 +02008291 "xterm", "xterm2", "urxvt" or "sgr" (because dec mouse codes conflict
8292 with them).
Bram Moolenaar071d4272004-06-13 20:20:40 +00008293 This option is automatically set to "xterm", when the 'term' option is
Bram Moolenaar45758762016-10-12 23:08:06 +02008294 set to a name that starts with "xterm", "mlterm", "screen", "tmux",
8295 "st" (full match only), "st-" or "stterm", and 'ttymouse' is not set
8296 already.
Bram Moolenaare968e362014-05-13 20:23:24 +02008297 Additionally, if vim is compiled with the |+termresponse| feature and
8298 |t_RV| is set to the escape sequence to request the xterm version
Bram Moolenaarf8a07122019-07-01 22:06:07 +02008299 number, more intelligent detection is done.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008300 The "xterm2" value will be set if the xterm version is reported to be
Bram Moolenaard47d5222018-12-09 20:43:55 +01008301 from 95 to 276. The "sgr" value will be set if Vim detects Mac
8302 Terminal.app, iTerm2 or mintty, and when the xterm version is 277 or
8303 higher.
Bram Moolenaare968e362014-05-13 20:23:24 +02008304 If you do not want 'ttymouse' to be set to "xterm2" or "sgr"
8305 automatically, set t_RV to an empty string: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008306 :set t_RV=
8307<
8308 *'ttyscroll'* *'tsl'*
8309'ttyscroll' 'tsl' number (default 999)
8310 global
8311 Maximum number of lines to scroll the screen. If there are more lines
8312 to scroll the window is redrawn. For terminals where scrolling is
8313 very slow and redrawing is not slow this can be set to a small number,
8314 e.g., 3, to speed up displaying.
8315
8316 *'ttytype'* *'tty'*
8317'ttytype' 'tty' string (default from $TERM)
8318 global
8319 Alias for 'term', see above.
8320
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008321 *'undodir'* *'udir'*
8322'undodir' 'udir' string (default ".")
8323 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008324 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008325 List of directory names for undo files, separated with commas.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008326 See |'backupdir'| for details of the format.
Bram Moolenaar6a244fe2010-05-24 22:02:24 +02008327 "." means using the directory of the file. The undo file name for
8328 "file.txt" is ".file.txt.un~".
8329 For other directories the file name is the full path of the edited
8330 file, with path separators replaced with "%".
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008331 When writing: The first directory that exists is used. "." always
8332 works, no directories after "." will be used for writing.
8333 When reading all entries are tried to find an undo file. The first
8334 undo file that exists is used. When it cannot be read an error is
8335 given, no further entry is used.
8336 See |undo-persistence|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008337 This option cannot be set from a |modeline| or in the |sandbox|, for
8338 security reasons.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008339
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02008340 *'undofile'* *'noundofile'* *'udf'* *'noudf'*
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008341'undofile' 'udf' boolean (default off)
8342 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02008343 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008344 When on, Vim automatically saves undo history to an undo file when
8345 writing a buffer to a file, and restores undo history from the same
8346 file on buffer read.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008347 The directory where the undo file is stored is specified by 'undodir'.
8348 For more information about this feature see |undo-persistence|.
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008349 The undo file is not read when 'undoreload' causes the buffer from
8350 before a reload to be saved for undo.
Bram Moolenaar97d62492012-11-15 21:28:22 +01008351 When 'undofile' is turned off the undo file is NOT deleted.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008352 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008353
Bram Moolenaar071d4272004-06-13 20:20:40 +00008354 *'undolevels'* *'ul'*
Bram Moolenaar8024f932020-01-14 19:29:13 +01008355'undolevels' 'ul' number (default 100, 1000 for Unix, VMS and Win32)
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008356 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008357 Maximum number of changes that can be undone. Since undo information
Bram Moolenaar5be4cee2019-09-27 19:34:08 +02008358 is kept in memory, higher numbers will cause more memory to be used.
8359 Nevertheless, a single change can already use a large amount of memory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008360 Set to 0 for Vi compatibility: One level of undo and "u" undoes
8361 itself: >
8362 set ul=0
8363< But you can also get Vi compatibility by including the 'u' flag in
8364 'cpoptions', and still be able to use CTRL-R to repeat undo.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008365 Also see |undo-two-ways|.
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008366 Set to -1 for no undo at all. You might want to do this only for the
8367 current buffer: >
8368 setlocal ul=-1
Bram Moolenaar071d4272004-06-13 20:20:40 +00008369< This helps when you run out of memory for a single change.
Bram Moolenaar32efaf62014-11-05 17:02:17 +01008370
8371 The local value is set to -123456 when the global value is to be used.
8372
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008373 Also see |clear-undo|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008374
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008375 *'undoreload'* *'ur'*
8376'undoreload' 'ur' number (default 10000)
8377 global
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008378 Save the whole buffer for undo when reloading it. This applies to the
8379 ":e!" command and reloading for when the buffer changed outside of
8380 Vim. |FileChangedShell|
Bram Moolenaar24a98a02017-09-27 22:23:55 +02008381 The save only happens when this option is negative or when the number
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008382 of lines is smaller than the value of this option.
8383 Set this option to zero to disable undo for a reload.
8384
8385 When saving undo for a reload, any undo file is not read.
8386
8387 Note that this causes the whole buffer to be stored in memory. Set
8388 this option to a lower value if you run out of memory.
8389
Bram Moolenaar071d4272004-06-13 20:20:40 +00008390 *'updatecount'* *'uc'*
8391'updatecount' 'uc' number (default: 200)
8392 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008393 After typing this many characters the swap file will be written to
8394 disk. When zero, no swap file will be created at all (see chapter on
8395 recovery |crash-recovery|). 'updatecount' is set to zero by starting
8396 Vim with the "-n" option, see |startup|. When editing in readonly
8397 mode this option will be initialized to 10000.
8398 The swapfile can be disabled per buffer with |'swapfile'|.
8399 When 'updatecount' is set from zero to non-zero, swap files are
8400 created for all buffers that have 'swapfile' set. When 'updatecount'
8401 is set to zero, existing swap files are not deleted.
8402 Also see |'swapsync'|.
8403 This option has no meaning in buffers where |'buftype'| is "nofile"
8404 or "nowrite".
8405
8406 *'updatetime'* *'ut'*
8407'updatetime' 'ut' number (default 4000)
8408 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008409 If this many milliseconds nothing is typed the swap file will be
8410 written to disk (see |crash-recovery|). Also used for the
8411 |CursorHold| autocommand event.
8412
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008413 *'varsofttabstop'* *'vsts'*
8414'varsofttabstop' 'vsts' string (default "")
8415 local to buffer
8416 {only available when compiled with the |+vartabs|
8417 feature}
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008418 A list of the number of spaces that a <Tab> counts for while editing,
8419 such as inserting a <Tab> or using <BS>. It "feels" like variable-
8420 width <Tab>s are being inserted, while in fact a mixture of spaces
8421 and <Tab>s is used. Tab widths are separated with commas, with the
8422 final value applying to all subsequent tabs.
8423
8424 For example, when editing assembly language files where statements
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02008425 start in the 9th column and comments in the 41st, it may be useful
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008426 to use the following: >
8427 :set varsofttabstop=8,32,8
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02008428< This will set soft tabstops with 8 and 8 + 32 spaces, and 8 more
8429 for every column thereafter.
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008430
8431 Note that the value of |'softtabstop'| will be ignored while
8432 'varsofttabstop' is set.
8433
8434 *'vartabstop'* *'vts'*
8435'vartabstop' 'vts' string (default "")
8436 local to buffer
8437 {only available when compiled with the |+vartabs|
8438 feature}
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008439 A list of the number of spaces that a <Tab> in the file counts for,
8440 separated by commas. Each value corresponds to one tab, with the
8441 final value applying to all subsequent tabs. For example: >
8442 :set vartabstop=4,20,10,8
8443< This will make the first tab 4 spaces wide, the second 20 spaces,
8444 the third 10 spaces, and all following tabs 8 spaces.
8445
8446 Note that the value of |'tabstop'| will be ignored while 'vartabstop'
8447 is set.
8448
Bram Moolenaar071d4272004-06-13 20:20:40 +00008449 *'verbose'* *'vbs'*
8450'verbose' 'vbs' number (default 0)
8451 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008452 When bigger than zero, Vim will give messages about what it is doing.
8453 Currently, these messages are given:
8454 >= 1 When the viminfo file is read or written.
8455 >= 2 When a file is ":source"'ed.
Bram Moolenaar647a5302020-05-03 17:01:24 +02008456 >= 4 Shell commands.
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008457 >= 5 Every searched tags file and include file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008458 >= 8 Files for which a group of autocommands is executed.
8459 >= 9 Every executed autocommand.
Bram Moolenaar647a5302020-05-03 17:01:24 +02008460 >= 11 Finding items in a path
Bram Moolenaar071d4272004-06-13 20:20:40 +00008461 >= 12 Every executed function.
8462 >= 13 When an exception is thrown, caught, finished, or discarded.
8463 >= 14 Anything pending in a ":finally" clause.
Bram Moolenaar823654b2020-05-29 23:03:09 +02008464 >= 15 Every executed Ex command from a script (truncated at 200
8465 characters).
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02008466 >= 16 Every executed Ex command.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008467
8468 This option can also be set with the "-V" argument. See |-V|.
8469 This option is also set by the |:verbose| command.
8470
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008471 When the 'verbosefile' option is set then the verbose messages are not
8472 displayed.
8473
8474 *'verbosefile'* *'vfile'*
8475'verbosefile' 'vfile' string (default empty)
8476 global
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008477 When not empty all messages are written in a file with this name.
8478 When the file exists messages are appended.
8479 Writing to the file ends when Vim exits or when 'verbosefile' is made
Bram Moolenaar80794b12010-06-13 05:20:42 +02008480 empty. Writes are buffered, thus may not show up for some time.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008481 Setting 'verbosefile' to a new value is like making it empty first.
8482 The difference with |:redir| is that verbose messages are not
8483 displayed when 'verbosefile' is set.
8484
Bram Moolenaar071d4272004-06-13 20:20:40 +00008485 *'viewdir'* *'vdir'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008486'viewdir' 'vdir' string (default for Amiga and Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008487 "$VIM/vimfiles/view",
8488 for Unix: "~/.vim/view",
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02008489 for macOS: "$VIM:vimfiles:view"
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01008490 for VMS: "sys$login:vimfiles/view")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008491 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008492 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008493 feature}
8494 Name of the directory where to store files for |:mkview|.
8495 This option cannot be set from a |modeline| or in the |sandbox|, for
8496 security reasons.
8497
8498 *'viewoptions'* *'vop'*
Bram Moolenaar13e90412017-11-11 18:16:48 +01008499'viewoptions' 'vop' string (default: "folds,options,cursor,curdir")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008500 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008501 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008502 feature}
8503 Changes the effect of the |:mkview| command. It is a comma separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008504 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008505 word save and restore ~
8506 cursor cursor position in file and in window
8507 folds manually created folds, opened/closed folds and local
8508 fold options
8509 options options and mappings local to a window or buffer (not
8510 global values for local options)
Bram Moolenaar6e932462014-09-09 18:48:09 +02008511 localoptions same as "options"
Bram Moolenaar071d4272004-06-13 20:20:40 +00008512 slash backslashes in file names replaced with forward
8513 slashes
8514 unix with Unix end-of-line format (single <NL>), even when
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008515 on MS-Windows
Bram Moolenaar13e90412017-11-11 18:16:48 +01008516 curdir the window-local directory, if set with `:lcd`
Bram Moolenaar071d4272004-06-13 20:20:40 +00008517
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008518 "slash" and "unix" are useful on MS-Windows when sharing view files
Bram Moolenaar071d4272004-06-13 20:20:40 +00008519 with Unix. The Unix version of Vim cannot source dos format scripts,
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008520 but the MS-Windows version of Vim can source unix format scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008521
8522 *'viminfo'* *'vi'* *E526* *E527* *E528*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008523'viminfo' 'vi' string (Vi default: "", Vim default for
8524 MS-Windows: '100,<50,s10,h,rA:,rB:,
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01008525 for Amiga: '100,<50,s10,h,rdf0:,rdf1:,rdf2:
8526 for others: '100,<50,s10,h)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008527 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008528 {not available when compiled without the |+viminfo|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008529 feature}
8530 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008531 when exiting Vim (see |viminfo-file|). Except when 'viminfofile' is
8532 "NONE".
8533 The string should be a comma separated list of parameters, each
8534 consisting of a single character identifying the particular parameter,
8535 followed by a number or string which specifies the value of that
8536 parameter. If a particular character is left out, then the default
8537 value is used for that parameter. The following is a list of the
8538 identifying characters and the effect of their value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008539 CHAR VALUE ~
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008540 *viminfo-!*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008541 ! When included, save and restore global variables that start
8542 with an uppercase letter, and don't contain a lowercase
8543 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar680eeca2010-10-20 17:44:42 +02008544 and "_K_L_M" are not. Nested List and Dict items may not be
Bram Moolenaar166af9b2010-11-16 20:34:40 +01008545 read back correctly, you end up with an empty item.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008546 *viminfo-quote*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008547 " Maximum number of lines saved for each register. Old name of
8548 the '<' item, with the disadvantage that you need to put a
8549 backslash before the ", otherwise it will be recognized as the
8550 start of a comment!
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008551 *viminfo-%*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008552 % When included, save and restore the buffer list. If Vim is
8553 started with a file name argument, the buffer list is not
8554 restored. If Vim is started without a file name argument, the
Bram Moolenaard042dc82015-11-24 19:18:36 +01008555 buffer list is restored from the viminfo file. Quickfix
8556 ('buftype'), unlisted ('buflisted'), unnamed and buffers on
8557 removable media (|viminfo-r|) are not saved.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00008558 When followed by a number, the number specifies the maximum
8559 number of buffers that are stored. Without a number all
8560 buffers are stored.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008561 *viminfo-'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008562 ' Maximum number of previously edited files for which the marks
8563 are remembered. This parameter must always be included when
8564 'viminfo' is non-empty.
8565 Including this item also means that the |jumplist| and the
8566 |changelist| are stored in the viminfo file.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008567 *viminfo-/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008568 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008569 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00008570 patterns are also saved. When not included, the value of
8571 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008572 *viminfo-:*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008573 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008574 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008575 *viminfo-<*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008576 < Maximum number of lines saved for each register. If zero then
8577 registers are not saved. When not included, all lines are
8578 saved. '"' is the old name for this item.
8579 Also see the 's' item below: limit specified in Kbyte.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008580 *viminfo-@*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008581 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008582 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008583 *viminfo-c*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008584 c When included, convert the text in the viminfo file from the
8585 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00008586 'encoding'. See |viminfo-encoding|.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008587 *viminfo-f*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008588 f Whether file marks need to be stored. If zero, file marks ('0
8589 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008590 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00008591 cursor position (when exiting or when doing ":wviminfo").
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008592 *viminfo-h*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008593 h Disable the effect of 'hlsearch' when loading the viminfo
8594 file. When not included, it depends on whether ":nohlsearch"
8595 has been used since the last search command.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008596 *viminfo-n*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008597 n Name of the viminfo file. The name must immediately follow
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008598 the 'n'. Must be at the end of the option! If the
8599 'viminfofile' option is set, that file name overrides the one
8600 given here with 'viminfo'. Environment variables are
Bram Moolenaar063b9d12016-07-09 20:21:48 +02008601 expanded when opening the file, not when setting the option.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008602 *viminfo-r*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008603 r Removable media. The argument is a string (up to the next
8604 ','). This parameter can be given several times. Each
8605 specifies the start of a path for which no marks will be
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01008606 stored. This is to avoid removable media. For MS-Windows you
Bram Moolenaar071d4272004-06-13 20:20:40 +00008607 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
8608 also use it for temp files, e.g., for Unix: "r/tmp". Case is
8609 ignored. Maximum length of each 'r' argument is 50
8610 characters.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008611 *viminfo-s*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008612 s Maximum size of an item in Kbyte. If zero then registers are
8613 not saved. Currently only applies to registers. The default
8614 "s10" will exclude registers with more than 10 Kbyte of text.
8615 Also see the '<' item above: line count limit.
8616
8617 Example: >
8618 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
8619<
8620 '50 Marks will be remembered for the last 50 files you
8621 edited.
8622 <1000 Contents of registers (up to 1000 lines each) will be
8623 remembered.
8624 s100 Registers with more than 100 Kbyte text are skipped.
8625 :0 Command-line history will not be saved.
8626 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
8627 no / Since '/' is not specified, the default will be used,
8628 that is, save all of the search history, and also the
8629 previous search and substitute patterns.
8630 no % The buffer list will not be saved nor read back.
8631 no h 'hlsearch' highlighting will be restored.
8632
8633 When setting 'viminfo' from an empty value you can use |:rviminfo| to
8634 load the contents of the file, this is not done automatically.
8635
8636 This option cannot be set from a |modeline| or in the |sandbox|, for
8637 security reasons.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008638 NOTE: This option is set to the Vim default value when 'compatible'
8639 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008640
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008641 *'viminfofile'* *'vif'*
8642'viminfofile' 'vif' string (default: "")
8643 global
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008644 {not available when compiled without the |+viminfo|
8645 feature}
8646 When non-empty, overrides the file name used for viminfo.
8647 When equal to "NONE" no viminfo file will be read or written.
8648 This option can be set with the |-i| command line flag. The |--clean|
8649 command line flag sets it to "NONE".
Bram Moolenaar110289e2019-05-23 15:38:06 +02008650 This option cannot be set from a |modeline| or in the |sandbox|, for
8651 security reasons.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008652
Bram Moolenaar071d4272004-06-13 20:20:40 +00008653 *'virtualedit'* *'ve'*
8654'virtualedit' 've' string (default "")
Gary Johnson51ad8502021-08-03 18:33:08 +02008655 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008656 A comma separated list of these words:
8657 block Allow virtual editing in Visual block mode.
8658 insert Allow virtual editing in Insert mode.
8659 all Allow virtual editing in all modes.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008660 onemore Allow the cursor to move just past the end of the line
Gary Johnson53ba05b2021-07-26 22:19:10 +02008661 none When used as the local value, do not allow virtual
8662 editing even when the global value is set. When used
8663 as the global value, "none" is the same as "".
8664 NONE Alternative spelling of "none".
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008665
Bram Moolenaar071d4272004-06-13 20:20:40 +00008666 Virtual editing means that the cursor can be positioned where there is
Bram Moolenaarebcbd022007-05-12 14:28:25 +00008667 no actual character. This can be halfway into a tab or beyond the end
Bram Moolenaar071d4272004-06-13 20:20:40 +00008668 of the line. Useful for selecting a rectangle in Visual mode and
8669 editing a table.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008670 "onemore" is not the same, it will only allow moving the cursor just
8671 after the last character of the line. This makes some commands more
8672 consistent. Previously the cursor was always past the end of the line
8673 if the line was empty. But it is far from Vi compatible. It may also
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008674 break some plugins or Vim scripts. For example because |l| can move
8675 the cursor after the last character. Use with care!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02008676 Using the `$` command will move to the last character in the line, not
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008677 past it. This may actually move the cursor to the left!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02008678 The `g$` command will move to the end of the screen line.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008679 It doesn't make sense to combine "all" with "onemore", but you will
8680 not get a warning for it.
Bram Moolenaar53f7fcc2021-07-28 20:10:16 +02008681 When combined with other words, "none" is ignored.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008682 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008683
8684 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
8685'visualbell' 'vb' boolean (default off)
8686 global
Bram Moolenaar74675a62017-07-15 13:53:23 +02008687 Use a visual bell instead of beeping. The terminal code to display the
Bram Moolenaar071d4272004-06-13 20:20:40 +00008688 visual bell is given with 't_vb'. When no beep or flash is wanted,
Bram Moolenaar74675a62017-07-15 13:53:23 +02008689 use: >
8690 :set vb t_vb=
8691< If you want a short flash, you can use this on many terminals: >
8692 :set vb t_vb=[?5h$<100>[?5l
8693< Here $<100> specifies the time, you can use a smaller or bigger value
8694 to get a shorter or longer flash.
8695
8696 Note: Vim will limit the bell to once per half a second. This avoids
8697 having to wait for the flashing to finish when there are lots of
8698 bells, e.g. on key repeat. This also happens without 'visualbell'
8699 set.
8700
Bram Moolenaar071d4272004-06-13 20:20:40 +00008701 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
8702 for 20 msec. If you want to use a different time, use "<Esc>|40f",
8703 where 40 is the time in msec.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008704
8705 Note: When the GUI starts, 't_vb' is reset to its default value. You
8706 might want to set it again in your |gvimrc|.
8707
Bram Moolenaar071d4272004-06-13 20:20:40 +00008708 Does not work on the Amiga, you always get a screen flash.
8709 Also see 'errorbells'.
8710
8711 *'warn'* *'nowarn'*
8712'warn' boolean (default on)
8713 global
8714 Give a warning message when a shell command is used while the buffer
8715 has been changed.
8716
8717 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
8718'weirdinvert' 'wiv' boolean (default off)
8719 global
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00008720 This option has the same effect as the 't_xs' terminal option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008721 It is provided for backwards compatibility with version 4.x.
8722 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
8723 vice versa. Has no effect when the GUI is running.
8724
8725 *'whichwrap'* *'ww'*
8726'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
8727 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008728 Allow specified keys that move the cursor left/right to move to the
8729 previous/next line when the cursor is on the first/last character in
8730 the line. Concatenate characters to allow this for these keys:
8731 char key mode ~
8732 b <BS> Normal and Visual
8733 s <Space> Normal and Visual
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008734 h "h" Normal and Visual (not recommended)
8735 l "l" Normal and Visual (not recommended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008736 < <Left> Normal and Visual
8737 > <Right> Normal and Visual
8738 ~ "~" Normal
8739 [ <Left> Insert and Replace
8740 ] <Right> Insert and Replace
8741 For example: >
8742 :set ww=<,>,[,]
8743< allows wrap only when cursor keys are used.
8744 When the movement keys are used in combination with a delete or change
8745 operator, the <EOL> also counts for a character. This makes "3h"
8746 different from "3dh" when the cursor crosses the end of a line. This
8747 is also true for "x" and "X", because they do the same as "dl" and
8748 "dh". If you use this, you may also want to use the mapping
8749 ":map <BS> X" to make backspace delete the character in front of the
8750 cursor.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00008751 When 'l' is included and it is used after an operator at the end of a
Bram Moolenaar589edb32019-09-20 14:38:13 +02008752 line (not an empty line) then it will not move to the next line. This
8753 makes "dl", "cl", "yl" etc. work normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008754 NOTE: This option is set to the Vi default value when 'compatible' is
8755 set and to the Vim default value when 'compatible' is reset.
8756
8757 *'wildchar'* *'wc'*
8758'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
8759 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008760 Character you have to type to start wildcard expansion in the
8761 command-line, as specified with 'wildmode'.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008762 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008763 The character is not recognized when used inside a macro. See
8764 'wildcharm' for that.
8765 Although 'wc' is a number option, you can set it to a special key: >
8766 :set wc=<Esc>
8767< NOTE: This option is set to the Vi default value when 'compatible' is
8768 set and to the Vim default value when 'compatible' is reset.
8769
8770 *'wildcharm'* *'wcm'*
8771'wildcharm' 'wcm' number (default: none (0))
8772 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008773 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00008774 recognized when used inside a macro. You can find "spare" command-line
8775 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00008776 you'll never actually type 'wildcharm', just use it in mappings that
8777 automatically invoke completion mode, e.g.: >
8778 :set wcm=<C-Z>
Bram Moolenaar446cb832008-06-24 21:56:24 +00008779 :cnoremap ss so $vim/sessions/*.vim<C-Z>
Bram Moolenaar071d4272004-06-13 20:20:40 +00008780< Then after typing :ss you can use CTRL-P & CTRL-N.
8781
8782 *'wildignore'* *'wig'*
8783'wildignore' 'wig' string (default "")
8784 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008785 {not available when compiled without the |+wildignore|
8786 feature}
8787 A list of file patterns. A file that matches with one of these
Bram Moolenaar30b65812012-07-12 22:01:11 +02008788 patterns is ignored when expanding |wildcards|, completing file or
8789 directory names, and influences the result of |expand()|, |glob()| and
8790 |globpath()| unless a flag is passed to disable this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008791 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
8792 Also see 'suffixes'.
8793 Example: >
8794 :set wildignore=*.o,*.obj
8795< The use of |:set+=| and |:set-=| is preferred when adding or removing
8796 a pattern from the list. This avoids problems when a future version
8797 uses another default.
8798
Bram Moolenaar94950a92010-12-02 16:01:29 +01008799
Bram Moolenaar81af9252010-12-10 20:35:50 +01008800 *'wildignorecase'* *'wic'* *'nowildignorecase'* *'nowic'*
Bram Moolenaar94950a92010-12-02 16:01:29 +01008801'wildignorecase' 'wic' boolean (default off)
8802 global
Bram Moolenaar94950a92010-12-02 16:01:29 +01008803 When set case is ignored when completing file names and directories.
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01008804 Has no effect when 'fileignorecase' is set.
Bram Moolenaar94950a92010-12-02 16:01:29 +01008805 Does not apply when the shell is used to expand wildcards, which
8806 happens when there are special characters.
8807
8808
Bram Moolenaar071d4272004-06-13 20:20:40 +00008809 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02008810'wildmenu' 'wmnu' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008811 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008812 {not available if compiled without the |+wildmenu|
8813 feature}
8814 When 'wildmenu' is on, command-line completion operates in an enhanced
8815 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
8816 the possible matches are shown just above the command line, with the
8817 first match highlighted (overwriting the status line, if there is
8818 one). Keys that show the previous/next match, such as <Tab> or
8819 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
8820 When 'wildmode' is used, "wildmenu" mode is used where "full" is
8821 specified. "longest" and "list" do not start "wildmenu" mode.
Bram Moolenaar26402cb2013-02-20 21:26:00 +01008822 You can check the current mode with |wildmenumode()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008823 If there are more matches than can fit in the line, a ">" is shown on
8824 the right and/or a "<" is shown on the left. The status line scrolls
8825 as needed.
8826 The "wildmenu" mode is abandoned when a key is hit that is not used
8827 for selecting a completion.
8828 While the "wildmenu" is active the following keys have special
8829 meanings:
8830
8831 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
8832 <Down> - in filename/menu name completion: move into a
8833 subdirectory or submenu.
8834 <CR> - in menu completion, when the cursor is just after a
8835 dot: move into a submenu.
8836 <Up> - in filename/menu name completion: move up into
8837 parent directory or parent menu.
8838
8839 This makes the menus accessible from the console |console-menus|.
8840
8841 If you prefer the <Left> and <Right> keys to move the cursor instead
8842 of selecting a different match, use this: >
8843 :cnoremap <Left> <Space><BS><Left>
8844 :cnoremap <Right> <Space><BS><Right>
8845<
8846 The "WildMenu" highlighting is used for displaying the current match
8847 |hl-WildMenu|.
8848
8849 *'wildmode'* *'wim'*
8850'wildmode' 'wim' string (Vim default: "full")
8851 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008852 Completion mode that is used for the character specified with
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008853 'wildchar'. It is a comma separated list of up to four parts. Each
Bram Moolenaar02467872007-05-06 13:22:01 +00008854 part specifies what to do for each consecutive use of 'wildchar'. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00008855 first part specifies the behavior for the first use of 'wildchar',
8856 The second part for the second use, etc.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02008857
8858 Each part consists of a colon separated list consisting of the
8859 following possible values:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008860 "" Complete only the first match.
8861 "full" Complete the next full match. After the last match,
8862 the original string is used and then the first match
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02008863 again. Will also start 'wildmenu' if it is enabled.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008864 "longest" Complete till longest common string. If this doesn't
8865 result in a longer string, use the next part.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008866 "list" When more than one match, list all matches.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02008867 "lastused" When completing buffer names and more than one buffer
8868 matches, sort buffers by time last used (other than
8869 the current buffer).
8870 When there is only a single match, it is fully completed in all cases.
8871
8872 Examples of useful colon-separated values:
8873 "longest:full" Like "longest", but also start 'wildmenu' if it is
8874 enabled. Will not complete to the next full match.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008875 "list:full" When more than one match, list all matches and
8876 complete first match.
8877 "list:longest" When more than one match, list all matches and
8878 complete till longest common string.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02008879 "list:lastused" When more than one buffer matches, list all matches
8880 and sort buffers by time last used (other than the
8881 current buffer).
Bram Moolenaar071d4272004-06-13 20:20:40 +00008882
8883 Examples: >
8884 :set wildmode=full
Bram Moolenaar582fd852005-03-28 20:58:01 +00008885< Complete first full match, next match, etc. (the default) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008886 :set wildmode=longest,full
8887< Complete longest common string, then each full match >
8888 :set wildmode=list:full
8889< List all matches and complete each full match >
8890 :set wildmode=list,full
8891< List all matches without completing, then each full match >
8892 :set wildmode=longest,list
8893< Complete longest common string, then list alternatives.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008894 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008895
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00008896 *'wildoptions'* *'wop'*
8897'wildoptions' 'wop' string (default "")
8898 global
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00008899 {not available when compiled without the |+wildignore|
8900 feature}
8901 A list of words that change how command line completion is done.
8902 Currently only one word is allowed:
8903 tagfile When using CTRL-D to list matching tags, the kind of
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00008904 tag and the file of the tag is listed. Only one match
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00008905 is displayed per line. Often used tag kinds are:
8906 d #define
8907 f function
8908 Also see |cmdline-completion|.
8909
Bram Moolenaar071d4272004-06-13 20:20:40 +00008910 *'winaltkeys'* *'wak'*
8911'winaltkeys' 'wak' string (default "menu")
8912 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008913 {only used in Win32, Motif, GTK and Photon GUI}
8914 Some GUI versions allow the access to menu entries by using the ALT
8915 key in combination with a character that appears underlined in the
8916 menu. This conflicts with the use of the ALT key for mappings and
8917 entering special characters. This option tells what to do:
8918 no Don't use ALT keys for menus. ALT key combinations can be
8919 mapped, but there is no automatic handling. This can then be
8920 done with the |:simalt| command.
8921 yes ALT key handling is done by the windowing system. ALT key
8922 combinations cannot be mapped.
8923 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008924 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00008925 keys can be mapped.
8926 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
8927 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00008928 This option is not used for <F10>; on Win32 and with GTK <F10> will
8929 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008930
Bram Moolenaar4d784b22019-05-25 19:51:39 +02008931 *'wincolor'* *'wcr'*
8932'wincolor' 'wcr' string (default empty)
8933 local to window
8934 Highlight group name to use for this window instead of the Normal
8935 color |hl-Normal|.
8936
Bram Moolenaar4399ef42005-02-12 14:29:27 +00008937 *'window'* *'wi'*
8938'window' 'wi' number (default screen height - 1)
8939 global
Bram Moolenaardad44732021-03-31 20:07:33 +02008940 Window height used for |CTRL-F| and |CTRL-B| when there is only one
8941 window and the value is smaller than 'lines' minus one. The screen
8942 will scroll 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00008943 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
8944 in a much smarter way, taking care of wrapping lines.
8945 When resizing the Vim window, the value is smaller than 1 or more than
8946 or equal to 'lines' it will be set to 'lines' minus 1.
Bram Moolenaardad44732021-03-31 20:07:33 +02008947 Note: Do not confuse this with the height of the Vim window, use
8948 'lines' for that.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00008949
Bram Moolenaar071d4272004-06-13 20:20:40 +00008950 *'winheight'* *'wh'* *E591*
8951'winheight' 'wh' number (default 1)
8952 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008953 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008954 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar446cb832008-06-24 21:56:24 +00008955 focus goes to a window that is smaller, its size is increased, at the
8956 cost of the height of other windows.
8957 Set 'winheight' to a small number for normal editing.
8958 Set it to 999 to make the current window fill most of the screen.
8959 Other windows will be only 'winminheight' high. This has the drawback
8960 that ":all" will create only two windows. To avoid "vim -o 1 2 3 4"
8961 to create only two windows, set the option after startup is done,
8962 using the |VimEnter| event: >
8963 au VimEnter * set winheight=999
8964< Minimum value is 1.
8965 The height is not adjusted after one of the commands that change the
Bram Moolenaar071d4272004-06-13 20:20:40 +00008966 height of the current window.
8967 'winheight' applies to the current window. Use 'winminheight' to set
8968 the minimal height for other windows.
8969
8970 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
8971'winfixheight' 'wfh' boolean (default off)
8972 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00008973 Keep the window height when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00008974 'equalalways' is set. Also for |CTRL-W_=|. Set by default for the
8975 |preview-window| and |quickfix-window|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008976 The height may be changed anyway when running out of room.
8977
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008978 *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'*
8979'winfixwidth' 'wfw' boolean (default off)
8980 local to window
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008981 Keep the window width when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00008982 'equalalways' is set. Also for |CTRL-W_=|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008983 The width may be changed anyway when running out of room.
8984
Bram Moolenaar071d4272004-06-13 20:20:40 +00008985 *'winminheight'* *'wmh'*
8986'winminheight' 'wmh' number (default 1)
8987 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008988 The minimal height of a window, when it's not the current window.
8989 This is a hard minimum, windows will never become smaller.
8990 When set to zero, windows may be "squashed" to zero lines (i.e. just a
8991 status bar) if necessary. They will return to at least one line when
8992 they become active (since the cursor has to have somewhere to go.)
8993 Use 'winheight' to set the minimal height of the current window.
8994 This option is only checked when making a window smaller. Don't use a
8995 large number, it will cause errors when opening more than a few
8996 windows. A value of 0 to 3 is reasonable.
8997
8998 *'winminwidth'* *'wmw'*
8999'winminwidth' 'wmw' number (default 1)
9000 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009001 The minimal width of a window, when it's not the current window.
9002 This is a hard minimum, windows will never become smaller.
9003 When set to zero, windows may be "squashed" to zero columns (i.e. just
9004 a vertical separator) if necessary. They will return to at least one
9005 line when they become active (since the cursor has to have somewhere
9006 to go.)
9007 Use 'winwidth' to set the minimal width of the current window.
9008 This option is only checked when making a window smaller. Don't use a
9009 large number, it will cause errors when opening more than a few
9010 windows. A value of 0 to 12 is reasonable.
9011
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009012 *'winptydll'*
9013'winptydll' string (default "winpty32.dll" or "winpty64.dll")
9014 global
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009015 {only available when compiled with the |terminal|
9016 feature on MS-Windows}
9017 Specifies the name of the winpty shared library, used for the
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02009018 |:terminal| command. The default depends on whether Vim was built as a
Bram Moolenaarc572da52017-08-27 16:52:01 +02009019 32-bit or 64-bit executable. If not found, "winpty.dll" is tried as
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009020 a fallback.
9021 Environment variables are expanded |:set_env|.
9022 This option cannot be set from a |modeline| or in the |sandbox|, for
9023 security reasons.
9024
Bram Moolenaar071d4272004-06-13 20:20:40 +00009025 *'winwidth'* *'wiw'* *E592*
9026'winwidth' 'wiw' number (default 20)
9027 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009028 Minimal number of columns for the current window. This is not a hard
9029 minimum, Vim will use fewer columns if there is not enough room. If
9030 the current window is smaller, its size is increased, at the cost of
9031 the width of other windows. Set it to 999 to make the current window
9032 always fill the screen. Set it to a small number for normal editing.
9033 The width is not adjusted after one of the commands to change the
9034 width of the current window.
9035 'winwidth' applies to the current window. Use 'winminwidth' to set
9036 the minimal width for other windows.
9037
9038 *'wrap'* *'nowrap'*
9039'wrap' boolean (default on)
9040 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00009041 This option changes how text is displayed. It doesn't change the text
9042 in the buffer, see 'textwidth' for that.
9043 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009044 displaying continues on the next line. When off lines will not wrap
9045 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00009046 moved to a part that is not shown, the screen will scroll
9047 horizontally.
9048 The line will be broken in the middle of a word if necessary. See
9049 'linebreak' to get the break at a word boundary.
9050 To make scrolling horizontally a bit more useful, try this: >
9051 :set sidescroll=5
9052 :set listchars+=precedes:<,extends:>
9053< See 'sidescroll', 'listchars' and |wrap-off|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01009054 This option can't be set from a |modeline| when the 'diff' option is
9055 on.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009056
9057 *'wrapmargin'* *'wm'*
9058'wrapmargin' 'wm' number (default 0)
9059 local to buffer
9060 Number of characters from the right window border where wrapping
9061 starts. When typing text beyond this limit, an <EOL> will be inserted
9062 and inserting continues on the next line.
9063 Options that add a margin, such as 'number' and 'foldcolumn', cause
9064 the text width to be further reduced. This is Vi compatible.
9065 When 'textwidth' is non-zero, this option is not used.
Bram Moolenaarca635012015-09-25 20:34:21 +02009066 This option is set to 0 when 'paste' is set and restored when 'paste'
9067 is reset.
Bram Moolenaara6c27c42019-05-09 19:16:22 +02009068 See also 'formatoptions' and |ins-textwidth|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009069
9070 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
9071'wrapscan' 'ws' boolean (default on) *E384* *E385*
9072 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00009073 Searches wrap around the end of the file. Also applies to |]s| and
9074 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009075
9076 *'write'* *'nowrite'*
9077'write' boolean (default on)
9078 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009079 Allows writing files. When not set, writing a file is not allowed.
9080 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009081 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00009082 argument. Filtering text is still possible, even though this requires
9083 writing a temporary file.
9084
9085 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
9086'writeany' 'wa' boolean (default off)
9087 global
9088 Allows writing to any file with no need for "!" override.
9089
9090 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
9091'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
9092 otherwise)
9093 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009094 Make a backup before overwriting a file. The backup is removed after
9095 the file was successfully written, unless the 'backup' option is
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02009096 also on.
9097 WARNING: Switching this option off means that when Vim fails to write
9098 your buffer correctly and then, for whatever reason, Vim exits, you
9099 lose both the original file and what you were writing. Only reset
9100 this option if your file system is almost full and it makes the write
9101 fail (and make sure not to exit Vim until the write was successful).
9102 See |backup-table| for another explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009103 When the 'backupskip' pattern matches, a backup is not made anyway.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01009104 Depending on 'backupcopy' the backup is a new file or the original
9105 file renamed (and a new file is written).
Bram Moolenaar071d4272004-06-13 20:20:40 +00009106 NOTE: This option is set to the default value when 'compatible' is
9107 set.
9108
9109 *'writedelay'* *'wd'*
9110'writedelay' 'wd' number (default 0)
9111 global
Bram Moolenaar802a0d92016-06-26 16:17:58 +02009112 The number of milliseconds to wait for each character sent to the
Bram Moolenaar071d4272004-06-13 20:20:40 +00009113 screen. When non-zero, characters are sent to the terminal one by
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01009114 one. For debugging purposes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009115
Bram Moolenaar91f84f62018-07-29 15:07:52 +02009116 vim:tw=78:ts=8:noet:ft=help:norl: