blob: ee03570ba86d821782b1198a3e2dcb7d981c51dc [file] [log] [blame]
Bram Moolenaar47003982021-12-05 21:54:04 +00001*options.txt* For Vim version 8.2. Last change: 2021 Dec 03
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
Bram Moolenaar47003982021-12-05 21:54:04 +000038:se[t]! termcap Idem, but don't use multiple columns.
39
Bram Moolenaar071d4272004-06-13 20:20:40 +000040 *E518* *E519*
41:se[t] {option}? Show value of {option}.
42
43:se[t] {option} Toggle option: set, switch it on.
44 Number option: show value.
45 String option: show value.
46
47:se[t] no{option} Toggle option: Reset, switch it off.
48
Bram Moolenaar00a927d2010-05-14 23:24:24 +020049 *:set-!* *:set-inv*
Bram Moolenaar071d4272004-06-13 20:20:40 +000050:se[t] {option}! or
Bram Moolenaar6c60f472019-04-28 16:00:35 +020051:se[t] inv{option} Toggle option: Invert value.
Bram Moolenaar071d4272004-06-13 20:20:40 +000052
53 *:set-default* *:set-&* *:set-&vi* *:set-&vim*
54:se[t] {option}& Reset option to its default value. May depend on the
Bram Moolenaar6c60f472019-04-28 16:00:35 +020055 current value of 'compatible'.
56:se[t] {option}&vi Reset option to its Vi default value.
57:se[t] {option}&vim Reset option to its Vim default value.
Bram Moolenaar071d4272004-06-13 20:20:40 +000058
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +010059:se[t] all& Set all options to their default value. The values of
Bram Moolenaar88774fd2015-08-25 19:52:04 +020060 these options are not changed:
61 all terminal options, starting with t_
62 'columns'
63 'cryptmethod'
64 'encoding'
65 'key'
66 'lines'
67 'term'
68 'ttymouse'
69 'ttytype'
70 Warning: This may have a lot of side effects.
Bram Moolenaar071d4272004-06-13 20:20:40 +000071
72 *:set-args* *E487* *E521*
73:se[t] {option}={value} or
74:se[t] {option}:{value}
75 Set string or number option to {value}.
76 For numeric options the value can be given in decimal,
Bram Moolenaar3848e002016-03-19 18:42:29 +010077 hex (preceded with 0x) or octal (preceded with '0').
Bram Moolenaar071d4272004-06-13 20:20:40 +000078 The old value can be inserted by typing 'wildchar' (by
79 default this is a <Tab> or CTRL-E if 'compatible' is
80 set). See |cmdline-completion|.
81 White space between {option} and '=' is allowed and
82 will be ignored. White space between '=' and {value}
83 is not allowed.
84 See |option-backslash| for using white space and
85 backslashes in {value}.
86
87:se[t] {option}+={value} *:set+=*
88 Add the {value} to a number option, or append the
89 {value} to a string option. When the option is a
90 comma separated list, a comma is added, unless the
91 value was empty.
92 If the option is a list of flags, superfluous flags
Bram Moolenaara5792f52005-11-23 21:25:05 +000093 are removed. When adding a flag that was already
94 present the option value doesn't change.
Bram Moolenaar899dddf2006-03-26 21:06:50 +000095 Also see |:set-args| above.
Bram Moolenaar071d4272004-06-13 20:20:40 +000096
97:se[t] {option}^={value} *:set^=*
98 Multiply the {value} to a number option, or prepend
99 the {value} to a string option. When the option is a
100 comma separated list, a comma is added, unless the
101 value was empty.
102 Also see |:set-args| above.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000103
104:se[t] {option}-={value} *:set-=*
105 Subtract the {value} from a number option, or remove
106 the {value} from a string option, if it is there.
107 If the {value} is not found in a string option, there
108 is no error or warning. When the option is a comma
109 separated list, a comma is deleted, unless the option
110 becomes empty.
111 When the option is a list of flags, {value} must be
112 exactly as they appear in the option. Remove flags
113 one by one to avoid problems.
114 Also see |:set-args| above.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000115
116The {option} arguments to ":set" may be repeated. For example: >
117 :set ai nosi sw=3 ts=3
118If you make an error in one of the arguments, an error message will be given
119and the following arguments will be ignored.
120
121 *:set-verbose*
122When 'verbose' is non-zero, displaying an option value will also tell where it
123was last set. Example: >
124 :verbose set shiftwidth cindent?
Bram Moolenaar95bafa22018-10-02 13:26:25 +0200125< shiftwidth=4 ~
126 Last set from modeline line 1 ~
127 cindent ~
128 Last set from /usr/local/share/vim/vim60/ftplugin/c.vim line 30 ~
Bram Moolenaar446cb832008-06-24 21:56:24 +0000129This is only done when specific option values are requested, not for ":verbose
130set all" or ":verbose set" without an argument.
131When the option was set by hand there is no "Last set" message.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000132When the option was set while executing a function, user command or
133autocommand, the script in which it was defined is reported.
134Note that an option may also have been set as a side effect of setting
135'compatible'.
Bram Moolenaar446cb832008-06-24 21:56:24 +0000136A few special texts:
Bram Moolenaar95bafa22018-10-02 13:26:25 +0200137 Last set from modeline line 1 ~
Bram Moolenaar446cb832008-06-24 21:56:24 +0000138 Option was set in a |modeline|.
139 Last set from --cmd argument ~
140 Option was set with command line argument |--cmd| or +.
141 Last set from -c argument ~
142 Option was set with command line argument |-c|, +, |-S| or
143 |-q|.
144 Last set from environment variable ~
145 Option was set from an environment variable, $VIMINIT,
146 $GVIMINIT or $EXINIT.
147 Last set from error handler ~
148 Option was cleared when evaluating it resulted in an error.
149
Bram Moolenaardb84e452010-08-15 13:50:43 +0200150{not available when compiled without the |+eval| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000151
152 *:set-termcap* *E522*
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +0000153For {option} the form "t_xx" may be used to set a terminal option. This will
Bram Moolenaar071d4272004-06-13 20:20:40 +0000154override the value from the termcap. You can then use it in a mapping. If
155the "xx" part contains special characters, use the <t_xx> form: >
156 :set <t_#4>=^[Ot
157This can also be used to translate a special code for a normal key. For
158example, if Alt-b produces <Esc>b, use this: >
159 :set <M-b>=^[b
160(the ^[ is a real <Esc> here, use CTRL-V <Esc> to enter it)
161The advantage over a mapping is that it works in all situations.
162
Bram Moolenaar0b2f94d2011-03-22 14:35:05 +0100163You can define any key codes, e.g.: >
164 :set t_xy=^[foo;
165There is no warning for using a name that isn't recognized. You can map these
166codes as you like: >
167 :map <t_xy> something
168< *E846*
169When a key code is not set, it's like it does not exist. Trying to get its
170value will result in an error: >
171 :set t_kb=
172 :set t_kb
173 E846: Key code not set: t_kb
174
Bram Moolenaar293ee4d2004-12-09 21:34:53 +0000175The t_xx options cannot be set from a |modeline| or in the |sandbox|, for
176security reasons.
177
Bram Moolenaar071d4272004-06-13 20:20:40 +0000178The listing from ":set" looks different from Vi. Long string options are put
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000179at the end of the list. The number of options is quite large. The output of
Bram Moolenaar071d4272004-06-13 20:20:40 +0000180"set all" probably does not fit on the screen, causing Vim to give the
181|more-prompt|.
182
183 *option-backslash*
184To include white space in a string option value it has to be preceded with a
185backslash. To include a backslash you have to use two. Effectively this
186means that the number of backslashes in an option value is halved (rounded
187down).
188A few examples: >
189 :set tags=tags\ /usr/tags results in "tags /usr/tags"
190 :set tags=tags\\,file results in "tags\,file"
191 :set tags=tags\\\ file results in "tags\ file"
192
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000193The "|" character separates a ":set" command from a following command. To
194include the "|" in the option value, use "\|" instead. This example sets the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000195'titlestring' option to "hi|there": >
196 :set titlestring=hi\|there
197This sets the 'titlestring' option to "hi" and 'iconstring' to "there": >
198 :set titlestring=hi|set iconstring=there
199
Bram Moolenaar89a9c152021-08-29 21:55:35 +0200200Similarly, in legacy script the double quote character starts a comment. To
201include the '"' in the option value, use '\"' instead. This example sets the
202'titlestring' option to 'hi "there"': >
Bram Moolenaar7df351e2006-01-23 22:30:28 +0000203 :set titlestring=hi\ \"there\"
204
Bram Moolenaar89a9c152021-08-29 21:55:35 +0200205In |Vim9| script it's simpler, comments start with a '#' character, and only
206when preceded by white space. A backslash is needed less often: >
207 vim9script
208 set titlestring=hi\ "there"
209 set titlestring=hi#there#
210 set titlestring=hi\ \#there#
211
Bram Moolenaar5666fcd2019-12-26 14:35:26 +0100212For Win32 backslashes in file names are mostly not removed. More precise: For
213options that expect a file name (those where environment variables are
214expanded) a backslash before a normal file name character is not removed. But
215a backslash before a special character (space, backslash, comma, etc.) is used
216like explained above.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000217There is one special situation, when the value starts with "\\": >
218 :set dir=\\machine\path results in "\\machine\path"
219 :set dir=\\\\machine\\path results in "\\machine\path"
220 :set dir=\\path\\file results in "\\path\file" (wrong!)
221For the first one the start is kept, but for the second one the backslashes
222are halved. This makes sure it works both when you expect backslashes to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000223halved and when you expect the backslashes to be kept. The third gives a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000224result which is probably not what you want. Avoid it.
225
226 *add-option-flags* *remove-option-flags*
227 *E539* *E550* *E551* *E552*
228Some options are a list of flags. When you want to add a flag to such an
229option, without changing the existing ones, you can do it like this: >
230 :set guioptions+=a
231Remove a flag from an option like this: >
232 :set guioptions-=a
233This removes the 'a' flag from 'guioptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000234Note that you should add or remove one flag at a time. If 'guioptions' has
Bram Moolenaar071d4272004-06-13 20:20:40 +0000235the value "ab", using "set guioptions-=ba" won't work, because the string "ba"
236doesn't appear.
237
238 *:set_env* *expand-env* *expand-environment-var*
Bram Moolenaard4755bb2004-09-02 19:12:26 +0000239Environment variables in specific string options will be expanded. If the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000240environment variable exists the '$' and the following environment variable
241name is replaced with its value. If it does not exist the '$' and the name
242are not modified. Any non-id character (not a letter, digit or '_') may
243follow the environment variable name. That character and what follows is
244appended to the value of the environment variable. Examples: >
245 :set term=$TERM.new
246 :set path=/usr/$INCLUDE,$HOME/include,.
247When adding or removing a string from an option with ":set opt-=val" or ":set
248opt+=val" the expansion is done before the adding or removing.
249
250
251Handling of local options *local-options*
252
253Some of the options only apply to a window or buffer. Each window or buffer
Bram Moolenaar51628222016-12-01 23:03:28 +0100254has its own copy of this option, thus each can have its own value. This
Bram Moolenaar071d4272004-06-13 20:20:40 +0000255allows you to set 'list' in one window but not in another. And set
256'shiftwidth' to 3 in one buffer and 4 in another.
257
258The following explains what happens to these local options in specific
259situations. You don't really need to know all of this, since Vim mostly uses
260the option values you would expect. Unfortunately, doing what the user
261expects is a bit complicated...
262
263When splitting a window, the local options are copied to the new window. Thus
264right after the split the contents of the two windows look the same.
265
266When editing a new buffer, its local option values must be initialized. Since
267the local options of the current buffer might be specifically for that buffer,
268these are not used. Instead, for each buffer-local option there also is a
269global value, which is used for new buffers. With ":set" both the local and
270global value is changed. With "setlocal" only the local value is changed,
271thus this value is not used when editing a new buffer.
272
Bram Moolenaar95ec9d62016-08-12 18:29:59 +0200273When editing a buffer that has been edited before, the options from the window
274that was last closed are used again. If this buffer has been edited in this
275window, the values from back then are used. Otherwise the values from the
276last closed window where the buffer was edited last are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000277
278It's possible to set a local window option specifically for a type of buffer.
279When you edit another buffer in the same window, you don't want to keep
280using these local window options. Therefore Vim keeps a global value of the
281local window options, which is used when editing another buffer. Each window
282has its own copy of these values. Thus these are local to the window, but
283global to all buffers in the window. With this you can do: >
284 :e one
285 :set list
286 :e two
287Now the 'list' option will also be set in "two", since with the ":set list"
288command you have also set the global value. >
289 :set nolist
290 :e one
291 :setlocal list
292 :e two
293Now the 'list' option is not set, because ":set nolist" resets the global
294value, ":setlocal list" only changes the local value and ":e two" gets the
295global value. Note that if you do this next: >
296 :e one
Bram Moolenaar531da592013-05-06 05:58:55 +0200297You will get back the 'list' value as it was the last time you edited "one".
298The options local to a window are remembered for each buffer. This also
299happens when the buffer is not loaded, but they are lost when the buffer is
300wiped out |:bwipe|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000301
302 *:setl* *:setlocal*
Bram Moolenaar6b915c02020-01-18 15:53:19 +0100303:setl[ocal][!] ... Like ":set" but set only the value local to the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000304 current buffer or window. Not all options have a
305 local value. If the option does not have a local
306 value the global value is set.
Bram Moolenaarc3301872010-07-25 20:53:06 +0200307 With the "all" argument: display local values for all
308 local options.
309 Without argument: Display local values for all local
310 options which are different from the default.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000311 When displaying a specific local option, show the
Bram Moolenaar446cb832008-06-24 21:56:24 +0000312 local value. For a global/local boolean option, when
313 the global value is being used, "--" is displayed
314 before the option name.
315 For a global option the global value is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000316 shown (but that might change in the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000317
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000318:setl[ocal] {option}< Set the local value of {option} to its global value by
319 copying the value.
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000320
Bram Moolenaar6be7f872012-01-20 21:08:56 +0100321:se[t] {option}< For |global-local| options: Remove the local value of
322 {option}, so that the global value will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000323
324 *:setg* *:setglobal*
Bram Moolenaar6b915c02020-01-18 15:53:19 +0100325:setg[lobal][!] ... Like ":set" but set only the global value for a local
Bram Moolenaar071d4272004-06-13 20:20:40 +0000326 option without changing the local value.
327 When displaying an option, the global value is shown.
Bram Moolenaarc3301872010-07-25 20:53:06 +0200328 With the "all" argument: display global values for all
329 local options.
330 Without argument: display global values for all local
331 options which are different from the default.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000332
333For buffer-local and window-local options:
334 Command global value local value ~
335 :set option=value set set
336 :setlocal option=value - set
337:setglobal option=value set -
338 :set option? - display
339 :setlocal option? - display
340:setglobal option? display -
341
342
343Global options with a local value *global-local*
344
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +0000345Options are global when you mostly use one value for all buffers and windows.
346For some global options it's useful to sometimes have a different local value.
347You can set the local value with ":setlocal". That buffer or window will then
348use the local value, while other buffers and windows continue using the global
349value.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000350
351For example, you have two windows, both on C source code. They use the global
352'makeprg' option. If you do this in one of the two windows: >
353 :set makeprg=gmake
354then the other window will switch to the same value. There is no need to set
355the 'makeprg' option in the other C source window too.
356However, if you start editing a Perl file in a new window, you want to use
Bram Moolenaar02467872007-05-06 13:22:01 +0000357another 'makeprg' for it, without changing the value used for the C source
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000358files. You use this command: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000359 :setlocal makeprg=perlmake
360You can switch back to using the global value by making the local value empty: >
361 :setlocal makeprg=
Bram Moolenaar314dd792019-02-03 15:27:20 +0100362This only works for a string option. For a number or boolean option you need
363to use the "<" flag, like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000364 :setlocal autoread<
Bram Moolenaar314dd792019-02-03 15:27:20 +0100365Note that for non-boolean and non-number options using "<" copies the global
366value to the local value, it doesn't switch back to using the global value
367(that matters when the global value changes later). You can also use: >
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000368 :set path<
369This will make the local value of 'path' empty, so that the global value is
370used. Thus it does the same as: >
371 :setlocal path=
Bram Moolenaar071d4272004-06-13 20:20:40 +0000372Note: In the future more global options can be made global-local. Using
373":setlocal" on a global option might work differently then.
374
375
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +0000376 *option-value-function*
377Some options ('completefunc', 'imactivatefunc', 'imstatusfunc', 'omnifunc',
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +0000378'operatorfunc', 'quickfixtextfunc', 'tagfunc' and 'thesaurusfunc') are set to
379a function name or a function reference or a lambda function. Examples:
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +0000380>
381 set opfunc=MyOpFunc
Yegappan Lakshmanan19916a82021-11-24 16:32:55 +0000382 set opfunc=function('MyOpFunc')
383 set opfunc=funcref('MyOpFunc')
Yegappan Lakshmanan05e59e32021-12-01 10:30:07 +0000384 set opfunc={a\ ->\ MyOpFunc(a)}
385 " set using a funcref variable
386 let Fn = function('MyTagFunc')
387 let &tagfunc = string(Fn)
388 " set using a lambda expression
389 let &tagfunc = "{t -> MyTagFunc(t)}"
390 " set using a variable with lambda expression
391 let L = {a, b, c -> MyTagFunc(a, b , c)}
392 let &tagfunc = string(L)
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +0000393<
394
Bram Moolenaar071d4272004-06-13 20:20:40 +0000395Setting the filetype
396
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200397:setf[iletype] [FALLBACK] {filetype} *:setf* *:setfiletype*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000398 Set the 'filetype' option to {filetype}, but only if
399 not done yet in a sequence of (nested) autocommands.
400 This is short for: >
401 :if !did_filetype()
402 : setlocal filetype={filetype}
403 :endif
404< This command is used in a filetype.vim file to avoid
405 setting the 'filetype' option twice, causing different
406 settings and syntax files to be loaded.
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200407
408 When the optional FALLBACK argument is present, a
409 later :setfiletype command will override the
Bram Moolenaar26967612019-03-17 17:13:16 +0100410 'filetype'. This is to be used for filetype
411 detections that are just a guess. |did_filetype()|
412 will return false after this command.
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200413
Bram Moolenaard58e9292011-02-09 17:07:58 +0100414 *option-window* *optwin*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000415:bro[wse] se[t] *:set-browse* *:browse-set* *:opt* *:options*
416:opt[ions] Open a window for viewing and setting all options.
417 Options are grouped by function.
418 Offers short help for each option. Hit <CR> on the
419 short help to open a help window with more help for
420 the option.
421 Modify the value of the option and hit <CR> on the
422 "set" line to set the new value. For window and
423 buffer specific options, the last accessed window is
424 used to set the option value in, unless this is a help
425 window, in which case the window below help window is
426 used (skipping the option-window).
Bram Moolenaarb5b75622018-03-09 22:22:21 +0100427 {not available when compiled without the |+eval|
428 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000429
430 *$HOME*
431Using "~" is like using "$HOME", but it is only recognized at the start of an
432option and after a space or comma.
433
434On Unix systems "~user" can be used too. It is replaced by the home directory
435of user "user". Example: >
436 :set path=~mool/include,/usr/include,.
437
438On Unix systems the form "${HOME}" can be used too. The name between {} can
439contain non-id characters then. Note that if you want to use this for the
440"gf" command, you need to add the '{' and '}' characters to 'isfname'.
441
442NOTE: expanding environment variables and "~/" is only done with the ":set"
443command, not when assigning a value to an option with ":let".
444
Bram Moolenaarc572da52017-08-27 16:52:01 +0200445 *$HOME-windows*
446On MS-Windows, if $HOME is not defined as an environment variable, then
447at runtime Vim will set it to the expansion of $HOMEDRIVE$HOMEPATH.
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200448If $HOMEDRIVE is not set then $USERPROFILE is used.
449
450This expanded value is not exported to the environment, this matters when
451running an external command: >
452 :echo system('set | findstr ^HOME=')
453and >
454 :echo luaeval('os.getenv("HOME")')
455should echo nothing (an empty string) despite exists('$HOME') being true.
456When setting $HOME to a non-empty string it will be exported to the
457subprocesses.
Bram Moolenaarc572da52017-08-27 16:52:01 +0200458
Bram Moolenaar071d4272004-06-13 20:20:40 +0000459
460Note the maximum length of an expanded option is limited. How much depends on
461the system, mostly it is something like 256 or 1024 characters.
462
463 *:fix* *:fixdel*
464:fix[del] Set the value of 't_kD':
465 't_kb' is 't_kD' becomes ~
466 CTRL-? CTRL-H
467 not CTRL-? CTRL-?
468
Bram Moolenaar82be4842021-01-11 19:40:15 +0100469 (CTRL-? is 0o177 octal, 0x7f hex)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000470
471 If your delete key terminal code is wrong, but the
472 code for backspace is alright, you can put this in
473 your .vimrc: >
474 :fixdel
475< This works no matter what the actual code for
476 backspace is.
477
478 If the backspace key terminal code is wrong you can
479 use this: >
480 :if &term == "termname"
481 : set t_kb=^V<BS>
482 : fixdel
483 :endif
484< Where "^V" is CTRL-V and "<BS>" is the backspace key
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000485 (don't type four characters!). Replace "termname"
Bram Moolenaar071d4272004-06-13 20:20:40 +0000486 with your terminal name.
487
488 If your <Delete> key sends a strange key sequence (not
489 CTRL-? or CTRL-H) you cannot use ":fixdel". Then use: >
490 :if &term == "termname"
491 : set t_kD=^V<Delete>
492 :endif
493< Where "^V" is CTRL-V and "<Delete>" is the delete key
494 (don't type eight characters!). Replace "termname"
495 with your terminal name.
496
497 *Linux-backspace*
498 Note about Linux: By default the backspace key
499 produces CTRL-?, which is wrong. You can fix it by
500 putting this line in your rc.local: >
501 echo "keycode 14 = BackSpace" | loadkeys
502<
503 *NetBSD-backspace*
504 Note about NetBSD: If your backspace doesn't produce
505 the right code, try this: >
506 xmodmap -e "keycode 22 = BackSpace"
507< If this works, add this in your .Xmodmap file: >
508 keysym 22 = BackSpace
509< You need to restart for this to take effect.
510
511==============================================================================
5122. Automatically setting options *auto-setting*
513
514Besides changing options with the ":set" command, there are three alternatives
515to set options automatically for one or more files:
516
5171. When starting Vim initializations are read from various places. See
518 |initialization|. Most of them are performed for all editing sessions,
519 and some of them depend on the directory where Vim is started.
520 You can create an initialization file with |:mkvimrc|, |:mkview| and
521 |:mksession|.
5222. If you start editing a new file, the automatic commands are executed.
523 This can be used to set options for files matching a particular pattern and
524 many other things. See |autocommand|.
5253. If you start editing a new file, and the 'modeline' option is on, a
526 number of lines at the beginning and end of the file are checked for
527 modelines. This is explained here.
528
529 *modeline* *vim:* *vi:* *ex:* *E520*
530There are two forms of modelines. The first form:
Bram Moolenaar664f3cf2019-12-07 16:03:51 +0100531 [text{white}]{vi:|vim:|ex:}[white]{options}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000532
Bram Moolenaar664f3cf2019-12-07 16:03:51 +0100533[text{white}] empty or any text followed by at least one blank
534 character (<Space> or <Tab>); "ex:" always requires at
535 least one blank character
Bram Moolenaar14b69452013-06-29 23:05:20 +0200536{vi:|vim:|ex:} the string "vi:", "vim:" or "ex:"
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200537[white] optional white space
538{options} a list of option settings, separated with white space
539 or ':', where each part between ':' is the argument
540 for a ":set" command (can be empty)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000541
Bram Moolenaar14b69452013-06-29 23:05:20 +0200542Examples:
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000543 vi:noai:sw=3 ts=6 ~
Bram Moolenaar14b69452013-06-29 23:05:20 +0200544 vim: tw=77 ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000545
546The second form (this is compatible with some versions of Vi):
547
Bram Moolenaarade0d392020-01-21 22:33:58 +0100548 [text{white}]{vi:|vim:|Vim:|ex:}[white]se[t] {options}:[text]
Bram Moolenaar071d4272004-06-13 20:20:40 +0000549
Bram Moolenaarade0d392020-01-21 22:33:58 +0100550[text{white}] empty or any text followed by at least one blank
551 character (<Space> or <Tab>); "ex:" always requires at
552 least one blank character
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200553{vi:|vim:|Vim:|ex:} the string "vi:", "vim:", "Vim:" or "ex:"
554[white] optional white space
Bram Moolenaar14b69452013-06-29 23:05:20 +0200555se[t] the string "set " or "se " (note the space); When
556 "Vim" is used it must be "set".
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200557{options} a list of options, separated with white space, which
558 is the argument for a ":set" command
559: a colon
560[text] any text or empty
Bram Moolenaar071d4272004-06-13 20:20:40 +0000561
Bram Moolenaar14b69452013-06-29 23:05:20 +0200562Examples:
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000563 /* vim: set ai tw=75: */ ~
Bram Moolenaar14b69452013-06-29 23:05:20 +0200564 /* Vim: set ai tw=75: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000565
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200566The white space before {vi:|vim:|Vim:|ex:} is required. This minimizes the
567chance that a normal word like "lex:" is caught. There is one exception:
568"vi:" and "vim:" can also be at the start of the line (for compatibility with
569version 3.0). Using "ex:" at the start of the line will be ignored (this
570could be short for "example:").
Bram Moolenaar071d4272004-06-13 20:20:40 +0000571
Hu Jialun9dcd3492021-08-28 20:42:50 +0200572If the modeline is disabled within a modeline, subsequent modelines will be
573ignored. This is to allow turning off modeline on a per-file basis. This is
574useful when a line looks like a modeline but isn't. For example, it would be
575good to start a YAML file containing strings like "vim:" with
576 # vim: nomodeline ~
577so as to avoid modeline misdetection. Following options on the same line
578after modeline deactivation, if any, are still evaluated (but you would
579normally not have any).
580
Bram Moolenaar071d4272004-06-13 20:20:40 +0000581 *modeline-local*
582The options are set like with ":setlocal": The new value only applies to the
Bram Moolenaar843ee412004-06-30 16:16:41 +0000583buffer and window that contain the file. Although it's possible to set global
584options from a modeline, this is unusual. If you have two windows open and
585the files in it set the same global option to a different value, the result
586depends on which one was opened last.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000587
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +0000588When editing a file that was already loaded, only the window-local options
589from the modeline are used. Thus if you manually changed a buffer-local
590option after opening the file, it won't be changed if you edit the same buffer
591in another window. But window-local options will be set.
592
Bram Moolenaar071d4272004-06-13 20:20:40 +0000593 *modeline-version*
594If the modeline is only to be used for some versions of Vim, the version
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200595number can be specified where "vim:" or "Vim:" is used:
Bram Moolenaar071d4272004-06-13 20:20:40 +0000596 vim{vers}: version {vers} or later
597 vim<{vers}: version before {vers}
598 vim={vers}: version {vers}
599 vim>{vers}: version after {vers}
Bram Moolenaar2b8388b2015-02-28 13:11:45 +0100600{vers} is 700 for Vim 7.0 (hundred times the major version plus minor).
601For example, to use a modeline only for Vim 7.0:
602 /* vim700: set foldmethod=marker */ ~
603To use a modeline for Vim after version 7.2:
604 /* vim>702: set cole=2: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000605There can be no blanks between "vim" and the ":".
606
607
608The number of lines that are checked can be set with the 'modelines' option.
609If 'modeline' is off or 'modelines' is 0 no lines are checked.
610
611Note that for the first form all of the rest of the line is used, thus a line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000612like:
613 /* vi:ts=4: */ ~
614will give an error message for the trailing "*/". This line is OK:
615 /* vi:set ts=4: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000616
617If an error is detected the rest of the line is skipped.
618
619If you want to include a ':' in a set command precede it with a '\'. The
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000620backslash in front of the ':' will be removed. Example:
Bram Moolenaar95a9dd12019-12-19 22:12:03 +0100621 /* vi:set fillchars=stl\:^,vert\:\|: */ ~
622This sets the 'fillchars' option to "stl:^,vert:\|". Only a single backslash
623before the ':' is removed. Thus to include "\:" you have to specify "\\:".
Bram Moolenaar110289e2019-05-23 15:38:06 +0200624 *E992*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000625No other commands than "set" are supported, for security reasons (somebody
Bram Moolenaar8243a792007-05-01 17:05:03 +0000626might create a Trojan horse text file with modelines). And not all options
Bram Moolenaar110289e2019-05-23 15:38:06 +0200627can be set. For some options a flag is set, so that when the value is used
628the |sandbox| is effective. Some options can only be set from the modeline
629when 'modelineexpr' is set (the default is off).
630
631Still, there is always a small risk that a modeline causes trouble. E.g.,
632when some joker sets 'textwidth' to 5 all your lines are wrapped unexpectedly.
633So disable modelines before editing untrusted text. The mail ftplugin does
634this, for example.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000635
636Hint: If you would like to do something else than setting an option, you could
637define an autocommand that checks the file for a specific string. For
638example: >
639 au BufReadPost * if getline(1) =~ "VAR" | call SetVar() | endif
640And define a function SetVar() that does something with the line containing
641"VAR".
642
643==============================================================================
6443. Options summary *option-summary*
645
646In the list below all the options are mentioned with their full name and with
647an abbreviation if there is one. Both forms may be used.
648
649In this document when a boolean option is "set" that means that ":set option"
650is entered. When an option is "reset", ":set nooption" is used.
651
652For some options there are two default values: The "Vim default", which is
653used when 'compatible' is not set, and the "Vi default", which is used when
654'compatible' is set.
655
656Most options are the same in all windows and buffers. There are a few that
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000657are specific to how the text is presented in a window. These can be set to a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000658different value in each window. For example the 'list' option can be set in
659one window and reset in another for the same text, giving both types of view
660at the same time. There are a few options that are specific to a certain
661file. These can have a different value for each file or buffer. For example
662the 'textwidth' option can be 78 for a normal text file and 0 for a C
663program.
664
665 global one option for all buffers and windows
666 local to window each window has its own copy of this option
667 local to buffer each buffer has its own copy of this option
668
669When creating a new window the option values from the currently active window
670are used as a default value for the window-specific options. For the
671buffer-specific options this depends on the 's' and 'S' flags in the
672'cpoptions' option. If 's' is included (which is the default) the values for
673buffer options are copied from the currently active buffer when a buffer is
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000674first entered. If 'S' is present the options are copied each time the buffer
675is entered, this is almost like having global options. If 's' and 'S' are not
Bram Moolenaar071d4272004-06-13 20:20:40 +0000676present, the options are copied from the currently active buffer when the
677buffer is created.
678
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000679Hidden options *hidden-options*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000680
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000681Not all options are supported in all versions. This depends on the supported
682features and sometimes on the system. A remark about this is in curly braces
683below. When an option is not supported it may still be set without getting an
684error, this is called a hidden option. You can't get the value of a hidden
685option though, it is not stored.
686
687To test if option "foo" can be used with ":set" use something like this: >
688 if exists('&foo')
689This also returns true for a hidden option. To test if option "foo" is really
690supported use something like this: >
691 if exists('+foo')
692<
Bram Moolenaar071d4272004-06-13 20:20:40 +0000693 *E355*
694A jump table for the options with a short description can be found at |Q_op|.
695
696 *'aleph'* *'al'* *aleph* *Aleph*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +0100697'aleph' 'al' number (default 128 for MS-Windows, 224 otherwise)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000698 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000699 {only available when compiled with the |+rightleft|
700 feature}
701 The ASCII code for the first letter of the Hebrew alphabet. The
702 routine that maps the keyboard in Hebrew mode, both in Insert mode
703 (when hkmap is set) and on the command-line (when hitting CTRL-_)
704 outputs the Hebrew characters in the range [aleph..aleph+26].
705 aleph=128 applies to PC code, and aleph=224 applies to ISO 8859-8.
706 See |rileft.txt|.
707
708 *'allowrevins'* *'ari'* *'noallowrevins'* *'noari'*
709'allowrevins' 'ari' boolean (default off)
710 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000711 {only available when compiled with the |+rightleft|
712 feature}
713 Allow CTRL-_ in Insert and Command-line mode. This is default off, to
714 avoid that users that accidentally type CTRL-_ instead of SHIFT-_ get
715 into reverse Insert mode, and don't know how to get out. See
716 'revins'.
717 NOTE: This option is reset when 'compatible' is set.
718
719 *'altkeymap'* *'akm'* *'noaltkeymap'* *'noakm'*
720'altkeymap' 'akm' boolean (default off)
721 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000722 {only available when compiled with the |+farsi|
723 feature}
Bram Moolenaar14184a32019-02-16 15:10:30 +0100724 This option was for using Farsi, which has been removed. See
725 |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000726
727 *'ambiwidth'* *'ambw'*
728'ambiwidth' 'ambw' string (default: "single")
729 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000730 Only effective when 'encoding' is "utf-8" or another Unicode encoding.
731 Tells Vim what to do with characters with East Asian Width Class
732 Ambiguous (such as Euro, Registered Sign, Copyright Sign, Greek
733 letters, Cyrillic letters).
734
735 There are currently two possible values:
Bram Moolenaar582fd852005-03-28 20:58:01 +0000736 "single": Use the same width as characters in US-ASCII. This is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000737 expected by most users.
738 "double": Use twice the width of ASCII characters.
Bram Moolenaar5c3bd0a2010-08-04 20:55:44 +0200739 *E834* *E835*
740 The value "double" cannot be used if 'listchars' or 'fillchars'
Bram Moolenaar079ba762021-10-23 12:08:41 +0100741 contains a character that would be double width. These errors may
742 also be given when calling setcellwidths().
Bram Moolenaar08aac3c2020-08-28 21:04:24 +0200743
744 The values are overruled for characters specified with
745 |setcellwidths()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000746
747 There are a number of CJK fonts for which the width of glyphs for
748 those characters are solely based on how many octets they take in
749 legacy/traditional CJK encodings. In those encodings, Euro,
750 Registered sign, Greek/Cyrillic letters are represented by two octets,
Bram Moolenaar582fd852005-03-28 20:58:01 +0000751 therefore those fonts have "wide" glyphs for them. This is also
Bram Moolenaar071d4272004-06-13 20:20:40 +0000752 true of some line drawing characters used to make tables in text
Bram Moolenaar582fd852005-03-28 20:58:01 +0000753 file. Therefore, when a CJK font is used for GUI Vim or
Bram Moolenaar071d4272004-06-13 20:20:40 +0000754 Vim is running inside a terminal (emulators) that uses a CJK font
755 (or Vim is run inside an xterm invoked with "-cjkwidth" option.),
756 this option should be set to "double" to match the width perceived
757 by Vim with the width of glyphs in the font. Perhaps it also has
Bram Moolenaar8024f932020-01-14 19:29:13 +0100758 to be set to "double" under CJK MS-Windows when the system locale is
759 set to one of CJK locales. See Unicode Standard Annex #11
760 (http://www.unicode.org/reports/tr11).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000761
Bram Moolenaarac7bd632013-03-19 11:35:58 +0100762 Vim may set this option automatically at startup time when Vim is
763 compiled with the |+termresponse| feature and if |t_u7| is set to the
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200764 escape sequence to request cursor position report. The response can
765 be found in |v:termu7resp|.
Bram Moolenaarac7bd632013-03-19 11:35:58 +0100766
Bram Moolenaar071d4272004-06-13 20:20:40 +0000767 *'antialias'* *'anti'* *'noantialias'* *'noanti'*
768'antialias' 'anti' boolean (default: off)
769 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000770 {only available when compiled with GUI enabled
Bram Moolenaar3d1cde82020-08-15 18:55:18 +0200771 on macOS}
772 This option only has an effect in the GUI version of Vim on macOS
Bram Moolenaar071d4272004-06-13 20:20:40 +0000773 v10.2 or later. When on, Vim will use smooth ("antialiased") fonts,
774 which can be easier to read at certain sizes on certain displays.
775 Setting this option can sometimes cause problems if 'guifont' is set
776 to its default (empty string).
Bram Moolenaar036986f2017-03-16 17:41:02 +0100777 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000778
779 *'autochdir'* *'acd'* *'noautochdir'* *'noacd'*
780'autochdir' 'acd' boolean (default off)
781 global
Bram Moolenaar00a927d2010-05-14 23:24:24 +0200782 {only available when compiled with it, use
783 exists("+autochdir") to check}
Bram Moolenaard8c00872005-07-22 21:52:15 +0000784 When on, Vim will change the current working directory whenever you
785 open a file, switch buffers, delete a buffer or open/close a window.
786 It will change to the directory containing the file which was opened
787 or selected.
Bram Moolenaar910f66f2006-04-05 20:41:53 +0000788 Note: When this option is on some plugins may not work.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000789
Bram Moolenaar8b9abfd2021-03-29 20:49:05 +0200790 *'autoshelldir'* *'asd'* *'noautoshelldir'* *'noasd'*
791'autoshelldir' 'asd' boolean (default off)
792 global
793 When on, Vim will change the current working directory whenever you
794 change the directory of the shell running in a terminal window. You
795 need proper setting-up, so whenever the shell's pwd changes an OSC 7
796 escape sequence will be emitted. For example, on Linux, you can source
797 /etc/profile.d/vte.sh in your shell profile if you use bash or zsh.
798
Bram Moolenaar071d4272004-06-13 20:20:40 +0000799 *'arabic'* *'arab'* *'noarabic'* *'noarab'*
800'arabic' 'arab' boolean (default off)
801 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +0000802 {only available when compiled with the |+arabic|
803 feature}
804 This option can be set to start editing Arabic text.
805 Setting this option will:
806 - Set the 'rightleft' option, unless 'termbidi' is set.
807 - Set the 'arabicshape' option, unless 'termbidi' is set.
808 - Set the 'keymap' option to "arabic"; in Insert mode CTRL-^ toggles
809 between typing English and Arabic key mapping.
810 - Set the 'delcombine' option
811 Note that 'encoding' must be "utf-8" for working with Arabic text.
812
813 Resetting this option will:
814 - Reset the 'rightleft' option.
815 - Disable the use of 'keymap' (without changing its value).
816 Note that 'arabicshape' and 'delcombine' are not reset (it is a global
Bram Moolenaarc8734422012-06-01 22:38:45 +0200817 option).
Bram Moolenaar036986f2017-03-16 17:41:02 +0100818 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000819 Also see |arabic.txt|.
820
821 *'arabicshape'* *'arshape'*
822 *'noarabicshape'* *'noarshape'*
823'arabicshape' 'arshape' boolean (default on)
824 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000825 {only available when compiled with the |+arabic|
826 feature}
827 When on and 'termbidi' is off, the required visual character
828 corrections that need to take place for displaying the Arabic language
Bram Moolenaar3a0d8092012-10-21 03:02:54 +0200829 take effect. Shaping, in essence, gets enabled; the term is a broad
Bram Moolenaar071d4272004-06-13 20:20:40 +0000830 one which encompasses:
831 a) the changing/morphing of characters based on their location
832 within a word (initial, medial, final and stand-alone).
833 b) the enabling of the ability to compose characters
834 c) the enabling of the required combining of some characters
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100835 When disabled the display shows each character's true stand-alone
836 form.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000837 Arabic is a complex language which requires other settings, for
838 further details see |arabic.txt|.
Bram Moolenaar036986f2017-03-16 17:41:02 +0100839 NOTE: This option is set when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000840
841 *'autoindent'* *'ai'* *'noautoindent'* *'noai'*
842'autoindent' 'ai' boolean (default off)
843 local to buffer
844 Copy indent from current line when starting a new line (typing <CR>
845 in Insert mode or when using the "o" or "O" command). If you do not
846 type anything on the new line except <BS> or CTRL-D and then type
Bram Moolenaar02467872007-05-06 13:22:01 +0000847 <Esc>, CTRL-O or <CR>, the indent is deleted again. Moving the cursor
848 to another line has the same effect, unless the 'I' flag is included
849 in 'cpoptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000850 When autoindent is on, formatting (with the "gq" command or when you
851 reach 'textwidth' in Insert mode) uses the indentation of the first
852 line.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000853 When 'smartindent' or 'cindent' is on the indent is changed in
854 a different way.
Bram Moolenaarca635012015-09-25 20:34:21 +0200855 The 'autoindent' option is reset when the 'paste' option is set and
856 restored when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000857
858 *'autoread'* *'ar'* *'noautoread'* *'noar'*
859'autoread' 'ar' boolean (default off)
860 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000861 When a file has been detected to have been changed outside of Vim and
862 it has not been changed inside of Vim, automatically read it again.
Bram Moolenaarfd358112018-07-07 23:21:31 +0200863 When the file has been deleted this is not done, so you have the text
864 from before it was deleted. When it appears again then it is read.
865 |timestamp|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000866 If this option has a local value, use this command to switch back to
867 using the global value: >
868 :set autoread<
869<
870 *'autowrite'* *'aw'* *'noautowrite'* *'noaw'*
871'autowrite' 'aw' boolean (default off)
872 global
873 Write the contents of the file, if it has been modified, on each
Bram Moolenaar47003982021-12-05 21:54:04 +0000874 `:next`, `:rewind`, `:last`, `:first`, `:previous`, `:stop`,
875 `:suspend`, `:tag, `:!`, ``:make`, CTRL-] and CTRL-^ command; and when
876 a :buffer, CTRL-O, CTRL-I, '{A-Z0-9}, or `{A-Z0-9} command takes one
877 to another file.
878 A buffer is not written if it becomes hidden, e.g. when 'bufhidden' is
879 set to "hide" and `:next` is used
Bram Moolenaar071d4272004-06-13 20:20:40 +0000880 Note that for some commands the 'autowrite' option is not used, see
881 'autowriteall' for that.
Bram Moolenaar93a1df22018-09-10 11:51:50 +0200882 Some buffers will not be written, specifically when 'buftype' is
Bram Moolenaar20aac6c2018-09-02 21:07:30 +0200883 "nowrite", "nofile", "terminal" or "prompt".
Bram Moolenaar071d4272004-06-13 20:20:40 +0000884
885 *'autowriteall'* *'awa'* *'noautowriteall'* *'noawa'*
886'autowriteall' 'awa' boolean (default off)
887 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000888 Like 'autowrite', but also used for commands ":edit", ":enew", ":quit",
889 ":qall", ":exit", ":xit", ":recover" and closing the Vim window.
890 Setting this option also implies that Vim behaves like 'autowrite' has
891 been set.
892
893 *'background'* *'bg'*
Bram Moolenaar446beb42011-05-10 17:18:44 +0200894'background' 'bg' string (default "dark" or "light", see below)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000895 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000896 When set to "dark", Vim will try to use colors that look good on a
897 dark background. When set to "light", Vim will try to use colors that
898 look good on a light background. Any other value is illegal.
899 Vim tries to set the default value according to the terminal used.
900 This will not always be correct.
901 Setting this option does not change the background color, it tells Vim
902 what the background color looks like. For changing the background
903 color, see |:hi-normal|.
904
905 When 'background' is set Vim will adjust the default color groups for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000906 the new value. But the colors used for syntax highlighting will not
Bram Moolenaar446cb832008-06-24 21:56:24 +0000907 change. *g:colors_name*
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100908 When a color scheme is loaded (the "g:colors_name" variable is set)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000909 setting 'background' will cause the color scheme to be reloaded. If
910 the color scheme adjusts to the value of 'background' this will work.
911 However, if the color scheme sets 'background' itself the effect may
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100912 be undone. First delete the "g:colors_name" variable when needed.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000913
914 When setting 'background' to the default value with: >
915 :set background&
916< Vim will guess the value. In the GUI this should work correctly,
917 in other cases Vim might not be able to guess the right value.
Bram Moolenaar2e693a82019-10-16 22:35:02 +0200918 If the GUI supports a dark theme, you can use the "d" flag in
Bram Moolenaar50bf7ce2019-09-15 13:17:00 +0200919 'guioptions', see 'go-d'.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000920
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200921 When the |t_RB| option is set, Vim will use it to request the background
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +0200922 color from the terminal. If the returned RGB value is dark/light and
923 'background' is not dark/light, 'background' will be set and the
924 screen is redrawn. This may have side effects, make t_BG empty in
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200925 your .vimrc if you suspect this problem. The response to |t_RB| can
Bram Moolenaar01164a62017-11-02 22:58:42 +0100926 be found in |v:termrbgresp|.
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +0200927
Bram Moolenaar071d4272004-06-13 20:20:40 +0000928 When starting the GUI, the default value for 'background' will be
929 "light". When the value is not set in the .gvimrc, and Vim detects
930 that the background is actually quite dark, 'background' is set to
931 "dark". But this happens only AFTER the .gvimrc file has been read
932 (because the window needs to be opened to find the actual background
933 color). To get around this, force the GUI window to be opened by
934 putting a ":gui" command in the .gvimrc file, before where the value
935 of 'background' is used (e.g., before ":syntax on").
Bram Moolenaar446beb42011-05-10 17:18:44 +0200936
Bram Moolenaar6f345a12019-12-17 21:27:18 +0100937 For MS-Windows the default is "dark".
Bram Moolenaar446beb42011-05-10 17:18:44 +0200938 For other systems "dark" is used when 'term' is "linux",
939 "screen.linux", "cygwin" or "putty", or $COLORFGBG suggests a dark
940 background. Otherwise the default is "light".
941
Bram Moolenaarc572da52017-08-27 16:52:01 +0200942 The |:terminal| command and the |term_start()| function use the
943 'background' value to decide whether the terminal window will start
944 with a white or black background.
945
Bram Moolenaar071d4272004-06-13 20:20:40 +0000946 Normally this option would be set in the .vimrc file. Possibly
947 depending on the terminal name. Example: >
948 :if &term == "pcterm"
949 : set background=dark
950 :endif
951< When this option is set, the default settings for the highlight groups
952 will change. To use other settings, place ":highlight" commands AFTER
953 the setting of the 'background' option.
954 This option is also used in the "$VIMRUNTIME/syntax/syntax.vim" file
955 to select the colors for syntax highlighting. After changing this
956 option, you must load syntax.vim again to see the result. This can be
957 done with ":syntax on".
958
959 *'backspace'* *'bs'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +0200960'backspace' 'bs' string (default "", set to "indent,eol,start"
961 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000962 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000963 Influences the working of <BS>, <Del>, CTRL-W and CTRL-U in Insert
964 mode. This is a list of items, separated by commas. Each item allows
965 a way to backspace over something:
966 value effect ~
967 indent allow backspacing over autoindent
968 eol allow backspacing over line breaks (join lines)
969 start allow backspacing over the start of insert; CTRL-W and CTRL-U
970 stop once at the start of insert.
Bram Moolenaaraa0489e2020-04-17 19:41:21 +0200971 nostop like start, except CTRL-W and CTRL-U do not stop at the start of
972 insert.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000973
974 When the value is empty, Vi compatible backspacing is used.
975
976 For backwards compatibility with version 5.4 and earlier:
977 value effect ~
978 0 same as ":set backspace=" (Vi compatible)
979 1 same as ":set backspace=indent,eol"
980 2 same as ":set backspace=indent,eol,start"
Bram Moolenaaraa0489e2020-04-17 19:41:21 +0200981 3 same as ":set backspace=indent,eol,nostop"
Bram Moolenaar071d4272004-06-13 20:20:40 +0000982
983 See |:fixdel| if your <BS> or <Del> key does not do what you want.
984 NOTE: This option is set to "" when 'compatible' is set.
985
986 *'backup'* *'bk'* *'nobackup'* *'nobk'*
987'backup' 'bk' boolean (default off)
988 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000989 Make a backup before overwriting a file. Leave it around after the
990 file has been successfully written. If you do not want to keep the
991 backup file, but you do want a backup while the file is being
992 written, reset this option and set the 'writebackup' option (this is
993 the default). If you do not want a backup file at all reset both
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000994 options (use this if your file system is almost full). See the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000995 |backup-table| for more explanations.
996 When the 'backupskip' pattern matches, a backup is not made anyway.
997 When 'patchmode' is set, the backup may be renamed to become the
998 oldest version of a file.
999 NOTE: This option is reset when 'compatible' is set.
1000
1001 *'backupcopy'* *'bkc'*
1002'backupcopy' 'bkc' string (Vi default for Unix: "yes", otherwise: "auto")
Bram Moolenaarb8ee25a2014-09-23 15:45:08 +02001003 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001004 When writing a file and a backup is made, this option tells how it's
1005 done. This is a comma separated list of words.
1006
1007 The main values are:
1008 "yes" make a copy of the file and overwrite the original one
1009 "no" rename the file and write a new one
1010 "auto" one of the previous, what works best
1011
1012 Extra values that can be combined with the ones above are:
1013 "breaksymlink" always break symlinks when writing
1014 "breakhardlink" always break hardlinks when writing
1015
1016 Making a copy and overwriting the original file:
1017 - Takes extra time to copy the file.
1018 + When the file has special attributes, is a (hard/symbolic) link or
1019 has a resource fork, all this is preserved.
1020 - When the file is a link the backup will have the name of the link,
1021 not of the real file.
1022
1023 Renaming the file and writing a new one:
1024 + It's fast.
1025 - Sometimes not all attributes of the file can be copied to the new
1026 file.
1027 - When the file is a link the new file will not be a link.
1028
1029 The "auto" value is the middle way: When Vim sees that renaming file
1030 is possible without side effects (the attributes can be passed on and
Bram Moolenaar02467872007-05-06 13:22:01 +00001031 the file is not a link) that is used. When problems are expected, a
1032 copy will be made.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001033
1034 The "breaksymlink" and "breakhardlink" values can be used in
1035 combination with any of "yes", "no" and "auto". When included, they
1036 force Vim to always break either symbolic or hard links by doing
1037 exactly what the "no" option does, renaming the original file to
1038 become the backup and writing a new file in its place. This can be
1039 useful for example in source trees where all the files are symbolic or
1040 hard links and any changes should stay in the local source tree, not
1041 be propagated back to the original source.
1042 *crontab*
1043 One situation where "no" and "auto" will cause problems: A program
1044 that opens a file, invokes Vim to edit that file, and then tests if
1045 the open file was changed (through the file descriptor) will check the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001046 backup file instead of the newly created file. "crontab -e" is an
Bram Moolenaar071d4272004-06-13 20:20:40 +00001047 example.
1048
1049 When a copy is made, the original file is truncated and then filled
1050 with the new text. This means that protection bits, owner and
1051 symbolic links of the original file are unmodified. The backup file
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001052 however, is a new file, owned by the user who edited the file. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00001053 group of the backup is set to the group of the original file. If this
1054 fails, the protection bits for the group are made the same as for
1055 others.
1056
1057 When the file is renamed this is the other way around: The backup has
1058 the same attributes of the original file, and the newly written file
1059 is owned by the current user. When the file was a (hard/symbolic)
1060 link, the new file will not! That's why the "auto" value doesn't
1061 rename when the file is a link. The owner and group of the newly
1062 written file will be set to the same ones as the original file, but
1063 the system may refuse to do this. In that case the "auto" value will
1064 again not rename the file.
1065
Bram Moolenaar036986f2017-03-16 17:41:02 +01001066 NOTE: This option is set to the Vi default value when 'compatible' is
1067 set and to the Vim default value when 'compatible' is reset.
1068
Bram Moolenaar071d4272004-06-13 20:20:40 +00001069 *'backupdir'* *'bdir'*
1070'backupdir' 'bdir' string (default for Amiga: ".,t:",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01001071 for Win32: ".,$TEMP,c:/tmp,c:/temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001072 for Unix: ".,~/tmp,~/")
1073 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001074 List of directories for the backup file, separated with commas.
1075 - The backup file will be created in the first directory in the list
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001076 where this is possible. The directory must exist, Vim will not
1077 create it for you.
Bram Moolenaar3848e002016-03-19 18:42:29 +01001078 - Empty means that no backup file will be created ('patchmode' is
Bram Moolenaar071d4272004-06-13 20:20:40 +00001079 impossible!). Writing may fail because of this.
1080 - A directory "." means to put the backup file in the same directory
1081 as the edited file.
Bram Moolenaar8024f932020-01-14 19:29:13 +01001082 - A directory starting with "./" (or ".\" for MS-Windows) means to put
1083 the backup file relative to where the edited file is. The leading
1084 "." is replaced with the path name of the edited file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001085 ("." inside a directory name has no special meaning).
1086 - Spaces after the comma are ignored, other spaces are considered part
1087 of the directory name. To have a space at the start of a directory
1088 name, precede it with a backslash.
1089 - To include a comma in a directory name precede it with a backslash.
1090 - A directory name may end in an '/'.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02001091 - For Unix and Win32, if a directory ends in two path separators "//",
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01001092 the backup file name will be built from the complete path to the
1093 file with all path separators changed to percent '%' signs. This
1094 will ensure file name uniqueness in the backup directory.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02001095 On Win32, it is also possible to end with "\\". However, When a
1096 separating comma is following, you must use "//", since "\\" will
1097 include the comma in the file name. Therefore it is recommended to
1098 use '//', instead of '\\'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001099 - Environment variables are expanded |:set_env|.
1100 - Careful with '\' characters, type one before a space, type two to
1101 get one in the option (see |option-backslash|), for example: >
1102 :set bdir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
1103< - For backwards compatibility with Vim version 3.0 a '>' at the start
1104 of the option is removed.
1105 See also 'backup' and 'writebackup' options.
1106 If you want to hide your backup files on Unix, consider this value: >
1107 :set backupdir=./.backup,~/.backup,.,/tmp
1108< You must create a ".backup" directory in each directory and in your
1109 home directory for this to work properly.
1110 The use of |:set+=| and |:set-=| is preferred when adding or removing
1111 directories from the list. This avoids problems when a future version
1112 uses another default.
1113 This option cannot be set from a |modeline| or in the |sandbox|, for
1114 security reasons.
1115
1116 *'backupext'* *'bex'* *E589*
1117'backupext' 'bex' string (default "~", for VMS: "_")
1118 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001119 String which is appended to a file name to make the name of the
1120 backup file. The default is quite unusual, because this avoids
1121 accidentally overwriting existing files with a backup file. You might
1122 prefer using ".bak", but make sure that you don't have files with
1123 ".bak" that you want to keep.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001124 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001125
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001126 If you like to keep a lot of backups, you could use a BufWritePre
1127 autocommand to change 'backupext' just before writing the file to
1128 include a timestamp. >
1129 :au BufWritePre * let &bex = '-' . strftime("%Y%b%d%X") . '~'
1130< Use 'backupdir' to put the backup in a different directory.
1131
Bram Moolenaar071d4272004-06-13 20:20:40 +00001132 *'backupskip'* *'bsk'*
Bram Moolenaarb8e22a02018-04-12 21:37:34 +02001133'backupskip' 'bsk' string (default: "$TMPDIR/*,$TMP/*,$TEMP/*"
1134 Unix: "/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*"
1135 Mac: "/private/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001136 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001137 {not available when compiled without the |+wildignore|
1138 feature}
1139 A list of file patterns. When one of the patterns matches with the
1140 name of the file which is written, no backup file is created. Both
1141 the specified file name and the full path name of the file are used.
1142 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
1143 Watch out for special characters, see |option-backslash|.
1144 When $TMPDIR, $TMP or $TEMP is not defined, it is not used for the
Bram Moolenaar582fd852005-03-28 20:58:01 +00001145 default value. "/tmp/*" is only used for Unix.
Bram Moolenaar02467872007-05-06 13:22:01 +00001146
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02001147 WARNING: Not having a backup file means that when Vim fails to write
1148 your buffer correctly and then, for whatever reason, Vim exits, you
1149 lose both the original file and what you were writing. Only disable
1150 backups if you don't care about losing the file.
1151
Bram Moolenaar02467872007-05-06 13:22:01 +00001152 Note that environment variables are not expanded. If you want to use
1153 $HOME you must expand it explicitly, e.g.: >
Bram Moolenaar7c1c6db2016-04-03 22:08:05 +02001154 :let &backupskip = escape(expand('$HOME'), '\') . '/tmp/*'
Bram Moolenaar02467872007-05-06 13:22:01 +00001155
1156< Note that the default also makes sure that "crontab -e" works (when a
Bram Moolenaara5792f52005-11-23 21:25:05 +00001157 backup would be made by renaming the original file crontab won't see
1158 the newly created file). Also see 'backupcopy' and |crontab|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001159
1160 *'balloondelay'* *'bdlay'*
1161'balloondelay' 'bdlay' number (default: 600)
1162 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001163 {only available when compiled with the |+balloon_eval|
1164 feature}
1165 Delay in milliseconds before a balloon may pop up. See |balloon-eval|.
1166
1167 *'ballooneval'* *'beval'* *'noballooneval'* *'nobeval'*
1168'ballooneval' 'beval' boolean (default off)
1169 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001170 {only available when compiled with the |+balloon_eval|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001171 feature}
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001172 Switch on the |balloon-eval| functionality for the GUI.
1173
1174 *'balloonevalterm'* *'bevalterm'* *'noballoonevalterm'*
1175 *'nobevalterm'*
1176'balloonevalterm' 'bevalterm' boolean (default off)
1177 global
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001178 {only available when compiled with the
1179 |+balloon_eval_term| feature}
1180 Switch on the |balloon-eval| functionality for the terminal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001181
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001182 *'balloonexpr'* *'bexpr'*
1183'balloonexpr' 'bexpr' string (default "")
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00001184 global or local to buffer |global-local|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001185 {only available when compiled with the |+balloon_eval|
1186 feature}
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00001187 Expression for text to show in evaluation balloon. It is only used
Bram Moolenaara6c27c42019-05-09 19:16:22 +02001188 when 'ballooneval' or 'balloonevalterm' is on. These variables can be
1189 used:
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001190
1191 v:beval_bufnr number of the buffer in which balloon is going to show
1192 v:beval_winnr number of the window
Bram Moolenaar82af8712016-06-04 20:20:29 +02001193 v:beval_winid ID of the window
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001194 v:beval_lnum line number
1195 v:beval_col column number (byte index)
1196 v:beval_text word under or after the mouse pointer
1197
Bram Moolenaar54775062019-07-31 21:07:14 +02001198 Instead of showing a balloon, which is limited to plain text, consider
1199 using a popup window, see |popup_beval_example|. A popup window can
1200 use highlighting and show a border.
1201
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001202 The evaluation of the expression must not have side effects!
1203 Example: >
Bram Moolenaara6c27c42019-05-09 19:16:22 +02001204 function MyBalloonExpr()
Bram Moolenaar45360022005-07-21 21:08:21 +00001205 return 'Cursor is at line ' . v:beval_lnum .
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001206 \', column ' . v:beval_col .
1207 \ ' of file ' . bufname(v:beval_bufnr) .
1208 \ ' on word "' . v:beval_text . '"'
1209 endfunction
1210 set bexpr=MyBalloonExpr()
1211 set ballooneval
1212<
Bram Moolenaar396e8292019-07-13 23:04:31 +02001213 Also see |balloon_show()|, it can be used if the content of the balloon
1214 is to be fetched asynchronously. In that case evaluating
1215 'balloonexpr' should result in an empty string. If you get a balloon
1216 with only "0" you probably didn't return anything from your function.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001217
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001218 NOTE: The balloon is displayed only if the cursor is on a text
1219 character. If the result of evaluating 'balloonexpr' is not empty,
1220 Vim does not try to send a message to an external debugger (Netbeans
1221 or Sun Workshop).
1222
Bram Moolenaar30b65812012-07-12 22:01:11 +02001223 The expression will be evaluated in the |sandbox| when set from a
1224 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02001225 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001226
1227 It is not allowed to change text or jump to another window while
Bram Moolenaar396e8292019-07-13 23:04:31 +02001228 evaluating 'balloonexpr', see |textlock|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001229
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001230 To check whether line breaks in the balloon text work use this check: >
Bram Moolenaar45360022005-07-21 21:08:21 +00001231 if has("balloon_multiline")
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001232< When they are supported "\n" characters will start a new line. If the
1233 expression evaluates to a |List| this is equal to using each List item
1234 as a string and putting "\n" in between them.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001235 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001236
Bram Moolenaar165bc692015-07-21 17:53:25 +02001237 *'belloff'* *'bo'*
1238'belloff' 'bo' string (default "")
1239 global
Bram Moolenaar165bc692015-07-21 17:53:25 +02001240 Specifies for which events the bell will not be rung. It is a comma
1241 separated list of items. For each item that is present, the bell
1242 will be silenced. This is most useful to specify specific events in
1243 insert mode to be silenced.
1244
1245 item meaning when present ~
1246 all All events.
1247 backspace When hitting <BS> or <Del> and deleting results in an
1248 error.
1249 cursor Fail to move around using the cursor keys or
1250 <PageUp>/<PageDown> in |Insert-mode|.
1251 complete Error occurred when using |i_CTRL-X_CTRL-K| or
1252 |i_CTRL-X_CTRL-T|.
1253 copy Cannot copy char from insert mode using |i_CTRL-Y| or
1254 |i_CTRL-E|.
1255 ctrlg Unknown Char after <C-G> in Insert mode.
1256 error Other Error occurred (e.g. try to join last line)
1257 (mostly used in |Normal-mode| or |Cmdline-mode|).
1258 esc hitting <Esc> in |Normal-mode|.
1259 ex In |Visual-mode|, hitting |Q| results in an error.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01001260 hangul Ignored.
Bram Moolenaar165bc692015-07-21 17:53:25 +02001261 insertmode Pressing <Esc> in 'insertmode'.
1262 lang Calling the beep module for Lua/Mzscheme/TCL.
1263 mess No output available for |g<|.
1264 showmatch Error occurred for 'showmatch' function.
1265 operator Empty region error |cpo-E|.
1266 register Unknown register after <C-R> in |Insert-mode|.
1267 shell Bell from shell output |:!|.
1268 spell Error happened on spell suggest.
1269 wildmode More matches in |cmdline-completion| available
1270 (depends on the 'wildmode' setting).
1271
Bram Moolenaar036986f2017-03-16 17:41:02 +01001272 This is most useful to fine tune when in Insert mode the bell should
1273 be rung. For Normal mode and Ex commands, the bell is often rung to
Bram Moolenaar165bc692015-07-21 17:53:25 +02001274 indicate that an error occurred. It can be silenced by adding the
1275 "error" keyword.
1276
Bram Moolenaar071d4272004-06-13 20:20:40 +00001277 *'binary'* *'bin'* *'nobinary'* *'nobin'*
1278'binary' 'bin' boolean (default off)
1279 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001280 This option should be set before editing a binary file. You can also
1281 use the |-b| Vim argument. When this option is switched on a few
1282 options will be changed (also when it already was on):
1283 'textwidth' will be set to 0
1284 'wrapmargin' will be set to 0
1285 'modeline' will be off
1286 'expandtab' will be off
1287 Also, 'fileformat' and 'fileformats' options will not be used, the
1288 file is read and written like 'fileformat' was "unix" (a single <NL>
1289 separates lines).
1290 The 'fileencoding' and 'fileencodings' options will not be used, the
1291 file is read without conversion.
1292 NOTE: When you start editing a(nother) file while the 'bin' option is
1293 on, settings from autocommands may change the settings again (e.g.,
1294 'textwidth'), causing trouble when editing. You might want to set
1295 'bin' again when the file has been loaded.
1296 The previous values of these options are remembered and restored when
1297 'bin' is switched from on to off. Each buffer has its own set of
1298 saved option values.
1299 To edit a file with 'binary' set you can use the |++bin| argument.
1300 This avoids you have to do ":set bin", which would have effect for all
1301 files you edit.
1302 When writing a file the <EOL> for the last line is only written if
1303 there was one in the original file (normally Vim appends an <EOL> to
1304 the last line if there is none; this would make the file longer). See
1305 the 'endofline' option.
1306
1307 *'bioskey'* *'biosk'* *'nobioskey'* *'nobiosk'*
1308'bioskey' 'biosk' boolean (default on)
1309 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02001310 {only for MS-DOS}
Bram Moolenaarf3913272016-02-25 00:00:01 +01001311 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001312
1313 *'bomb'* *'nobomb'*
1314'bomb' boolean (default off)
1315 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001316 When writing a file and the following conditions are met, a BOM (Byte
1317 Order Mark) is prepended to the file:
1318 - this option is on
1319 - the 'binary' option is off
1320 - 'fileencoding' is "utf-8", "ucs-2", "ucs-4" or one of the little/big
1321 endian variants.
1322 Some applications use the BOM to recognize the encoding of the file.
1323 Often used for UCS-2 files on MS-Windows. For other applications it
1324 causes trouble, for example: "cat file1 file2" makes the BOM of file2
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001325 appear halfway the resulting file. Gcc doesn't accept a BOM.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001326 When Vim reads a file and 'fileencodings' starts with "ucs-bom", a
1327 check for the presence of the BOM is done and 'bomb' set accordingly.
1328 Unless 'binary' is set, it is removed from the first line, so that you
1329 don't see it when editing. When you don't change the options, the BOM
1330 will be restored when writing the file.
1331
1332 *'breakat'* *'brk'*
1333'breakat' 'brk' string (default " ^I!@*-+;:,./?")
1334 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02001335 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001336 feature}
1337 This option lets you choose which characters might cause a line
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00001338 break if 'linebreak' is on. Only works for ASCII and also for 8-bit
1339 characters when 'encoding' is an 8-bit encoding.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001340
Bram Moolenaar7c1c6db2016-04-03 22:08:05 +02001341 *'breakindent'* *'bri'* *'nobreakindent'* *'nobri'*
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001342'breakindent' 'bri' boolean (default off)
1343 local to window
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001344 {not available when compiled without the |+linebreak|
1345 feature}
1346 Every wrapped line will continue visually indented (same amount of
1347 space as the beginning of that line), thus preserving horizontal blocks
1348 of text.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001349 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001350
1351 *'breakindentopt'* *'briopt'*
1352'breakindentopt' 'briopt' string (default empty)
1353 local to window
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001354 {not available when compiled without the |+linebreak|
1355 feature}
1356 Settings for 'breakindent'. It can consist of the following optional
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001357 items and must be separated by a comma:
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001358 min:{n} Minimum text width that will be kept after
1359 applying 'breakindent', even if the resulting
1360 text should normally be narrower. This prevents
1361 text indented almost to the right window border
1362 occupying lot of vertical space when broken.
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001363 shift:{n} After applying 'breakindent', the wrapped line's
1364 beginning will be shifted by the given number of
1365 characters. It permits dynamic French paragraph
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001366 indentation (negative) or emphasizing the line
1367 continuation (positive).
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01001368 sbr Display the 'showbreak' value before applying the
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001369 additional indent.
Maxim Kimf674b352021-07-22 11:46:59 +02001370 list:{n} Adds an additional indent for lines that match a
Christian Brabandt4a0b85a2021-07-14 20:00:27 +02001371 numbered or bulleted list (using the
1372 'formatlistpat' setting).
Maxim Kimf674b352021-07-22 11:46:59 +02001373 list:-1 Uses the length of a match with 'formatlistpat'
1374 for indentation.
Christian Brabandt4a0b85a2021-07-14 20:00:27 +02001375 The default value for min is 20, shift and list is 0.
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001376
Bram Moolenaar071d4272004-06-13 20:20:40 +00001377 *'browsedir'* *'bsdir'*
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001378'browsedir' 'bsdir' string (default: "last")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001379 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02001380 {only for Motif, Athena, GTK, Mac and Win32 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001381 Which directory to use for the file browser:
Bram Moolenaar446cb832008-06-24 21:56:24 +00001382 last Use same directory as with last file browser, where a
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02001383 file was opened or saved.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001384 buffer Use the directory of the related buffer.
1385 current Use the current directory.
1386 {path} Use the specified directory
1387
1388 *'bufhidden'* *'bh'*
1389'bufhidden' 'bh' string (default: "")
1390 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001391 This option specifies what happens when a buffer is no longer
1392 displayed in a window:
1393 <empty> follow the global 'hidden' option
1394 hide hide the buffer (don't unload it), also when 'hidden'
1395 is not set
1396 unload unload the buffer, also when 'hidden' is set or using
1397 |:hide|
1398 delete delete the buffer from the buffer list, also when
1399 'hidden' is set or using |:hide|, like using
1400 |:bdelete|
1401 wipe wipe out the buffer from the buffer list, also when
1402 'hidden' is set or using |:hide|, like using
1403 |:bwipeout|
1404
Bram Moolenaara14de3d2005-01-07 21:48:26 +00001405 CAREFUL: when "unload", "delete" or "wipe" is used changes in a buffer
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01001406 are lost without a warning. Also, these values may break autocommands
1407 that switch between buffers temporarily.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001408 This option is used together with 'buftype' and 'swapfile' to specify
1409 special kinds of buffers. See |special-buffers|.
1410
1411 *'buflisted'* *'bl'* *'nobuflisted'* *'nobl'* *E85*
1412'buflisted' 'bl' boolean (default: on)
1413 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001414 When this option is set, the buffer shows up in the buffer list. If
1415 it is reset it is not used for ":bnext", "ls", the Buffers menu, etc.
1416 This option is reset by Vim for buffers that are only used to remember
1417 a file name or marks. Vim sets it when starting to edit a buffer.
1418 But not when moving to a buffer with ":buffer".
1419
1420 *'buftype'* *'bt'* *E382*
1421'buftype' 'bt' string (default: "")
1422 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001423 The value of this option specifies the type of a buffer:
1424 <empty> normal buffer
1425 nofile buffer which is not related to a file and will not be
1426 written
1427 nowrite buffer which will not be written
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001428 acwrite buffer which will always be written with BufWriteCmd
Bram Moolenaarb5b75622018-03-09 22:22:21 +01001429 autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001430 quickfix quickfix buffer, contains list of errors |:cwindow|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001431 or list of locations |:lwindow|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001432 help help buffer (you are not supposed to set this
1433 manually)
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02001434 terminal buffer for a |terminal| (you are not supposed to set
1435 this manually)
Bram Moolenaarf2732452018-06-03 14:47:35 +02001436 prompt buffer where only the last line can be edited, meant
1437 to be used by a plugin, see |prompt-buffer|
1438 {only when compiled with the |+channel| feature}
Bram Moolenaar4d784b22019-05-25 19:51:39 +02001439 popup buffer used in a popup window, see |popup|.
1440 {only when compiled with the |+textprop| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001441
1442 This option is used together with 'bufhidden' and 'swapfile' to
1443 specify special kinds of buffers. See |special-buffers|.
Bram Moolenaarebdf3c92020-02-15 21:41:42 +01001444 Also see |win_gettype()|, which returns the type of the window.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001445
1446 Be careful with changing this option, it can have many side effects!
Bram Moolenaar113cb512021-11-07 20:27:04 +00001447 One such effect is that Vim will not check the timestamp of the file,
1448 if the file is changed by another program this will not be noticed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001449
Bram Moolenaar280f1262006-01-30 00:14:18 +00001450 A "quickfix" buffer is only used for the error list and the location
1451 list. This value is set by the |:cwindow| and |:lwindow| commands and
1452 you are not supposed to change it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001453
1454 "nofile" and "nowrite" buffers are similar:
1455 both: The buffer is not to be written to disk, ":w" doesn't
1456 work (":w filename" does work though).
1457 both: The buffer is never considered to be |'modified'|.
1458 There is no warning when the changes will be lost, for
1459 example when you quit Vim.
1460 both: A swap file is only created when using too much memory
1461 (when 'swapfile' has been reset there is never a swap
1462 file).
1463 nofile only: The buffer name is fixed, it is not handled like a
1464 file name. It is not modified in response to a |:cd|
1465 command.
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01001466 both: When using ":e bufname" and already editing "bufname"
1467 the buffer is made empty and autocommands are
1468 triggered as usual for |:edit|.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001469 *E676*
1470 "acwrite" implies that the buffer name is not related to a file, like
1471 "nofile", but it will be written. Thus, in contrast to "nofile" and
1472 "nowrite", ":w" does work and a modified buffer can't be abandoned
1473 without saving. For writing there must be matching |BufWriteCmd|,
1474 |FileWriteCmd| or |FileAppendCmd| autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001475
1476 *'casemap'* *'cmp'*
1477'casemap' 'cmp' string (default: "internal,keepascii")
1478 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001479 Specifies details about changing the case of letters. It may contain
1480 these words, separated by a comma:
1481 internal Use internal case mapping functions, the current
1482 locale does not change the case mapping. This only
Bram Moolenaar6f16eb82005-08-23 21:02:42 +00001483 matters when 'encoding' is a Unicode encoding,
1484 "latin1" or "iso-8859-15". When "internal" is
1485 omitted, the towupper() and towlower() system library
1486 functions are used when available.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001487 keepascii For the ASCII characters (0x00 to 0x7f) use the US
1488 case mapping, the current locale is not effective.
1489 This probably only matters for Turkish.
1490
1491 *'cdpath'* *'cd'* *E344* *E346*
1492'cdpath' 'cd' string (default: equivalent to $CDPATH or ",,")
1493 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001494 {not available when compiled without the
1495 |+file_in_path| feature}
1496 This is a list of directories which will be searched when using the
Bram Moolenaar00aa0692019-04-27 20:37:57 +02001497 |:cd|, |:tcd| and |:lcd| commands, provided that the directory being
1498 searched for has a relative path, not an absolute part starting with
1499 "/", "./" or "../", the 'cdpath' option is not used then.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001500 The 'cdpath' option's value has the same form and semantics as
1501 |'path'|. Also see |file-searching|.
1502 The default value is taken from $CDPATH, with a "," prepended to look
1503 in the current directory first.
1504 If the default value taken from $CDPATH is not what you want, include
1505 a modified version of the following command in your vimrc file to
1506 override it: >
1507 :let &cdpath = ',' . substitute(substitute($CDPATH, '[, ]', '\\\0', 'g'), ':', ',', 'g')
1508< This option cannot be set from a |modeline| or in the |sandbox|, for
1509 security reasons.
1510 (parts of 'cdpath' can be passed to the shell to expand file names).
1511
1512 *'cedit'*
1513'cedit' string (Vi default: "", Vim default: CTRL-F)
1514 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001515 The key used in Command-line Mode to open the command-line window.
1516 The default is CTRL-F when 'compatible' is off.
1517 Only non-printable keys are allowed.
1518 The key can be specified as a single character, but it is difficult to
1519 type. The preferred way is to use the <> notation. Examples: >
Bram Moolenaare18dbe82016-07-02 21:42:23 +02001520 :exe "set cedit=\<C-Y>"
1521 :exe "set cedit=\<Esc>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001522< |Nvi| also has this option, but it only uses the first character.
1523 See |cmdwin|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001524 NOTE: This option is set to the Vim default value when 'compatible'
1525 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001526
1527 *'charconvert'* *'ccv'* *E202* *E214* *E513*
1528'charconvert' 'ccv' string (default "")
1529 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01001530 {only available when compiled with the |+eval| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001531 An expression that is used for character encoding conversion. It is
1532 evaluated when a file that is to be read or has been written has a
1533 different encoding from what is desired.
1534 'charconvert' is not used when the internal iconv() function is
1535 supported and is able to do the conversion. Using iconv() is
1536 preferred, because it is much faster.
1537 'charconvert' is not used when reading stdin |--|, because there is no
1538 file to convert from. You will have to save the text in a file first.
1539 The expression must return zero or an empty string for success,
1540 non-zero for failure.
1541 The possible encoding names encountered are in 'encoding'.
1542 Additionally, names given in 'fileencodings' and 'fileencoding' are
1543 used.
1544 Conversion between "latin1", "unicode", "ucs-2", "ucs-4" and "utf-8"
1545 is done internally by Vim, 'charconvert' is not used for this.
1546 'charconvert' is also used to convert the viminfo file, if the 'c'
1547 flag is present in 'viminfo'. Also used for Unicode conversion.
1548 Example: >
1549 set charconvert=CharConvert()
1550 fun CharConvert()
1551 system("recode "
1552 \ . v:charconvert_from . ".." . v:charconvert_to
1553 \ . " <" . v:fname_in . " >" v:fname_out)
1554 return v:shell_error
1555 endfun
1556< The related Vim variables are:
1557 v:charconvert_from name of the current encoding
1558 v:charconvert_to name of the desired encoding
1559 v:fname_in name of the input file
1560 v:fname_out name of the output file
1561 Note that v:fname_in and v:fname_out will never be the same.
1562 Note that v:charconvert_from and v:charconvert_to may be different
1563 from 'encoding'. Vim internally uses UTF-8 instead of UCS-2 or UCS-4.
1564 Encryption is not done by Vim when using 'charconvert'. If you want
1565 to encrypt the file after conversion, 'charconvert' should take care
1566 of this.
1567 This option cannot be set from a |modeline| or in the |sandbox|, for
1568 security reasons.
1569
1570 *'cindent'* *'cin'* *'nocindent'* *'nocin'*
1571'cindent' 'cin' boolean (default off)
1572 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001573 {not available when compiled without the |+cindent|
1574 feature}
Bram Moolenaar446cb832008-06-24 21:56:24 +00001575 Enables automatic C program indenting. See 'cinkeys' to set the keys
Bram Moolenaar071d4272004-06-13 20:20:40 +00001576 that trigger reindenting in insert mode and 'cinoptions' to set your
1577 preferred indent style.
1578 If 'indentexpr' is not empty, it overrules 'cindent'.
1579 If 'lisp' is not on and both 'indentexpr' and 'equalprg' are empty,
1580 the "=" operator indents using this algorithm rather than calling an
1581 external program.
1582 See |C-indenting|.
1583 When you don't like the way 'cindent' works, try the 'smartindent'
1584 option or 'indentexpr'.
1585 This option is not used when 'paste' is set.
1586 NOTE: This option is reset when 'compatible' is set.
1587
1588 *'cinkeys'* *'cink'*
Bram Moolenaarce655742019-01-31 14:12:57 +01001589'cinkeys' 'cink' string (default "0{,0},0),0],:,0#,!^F,o,O,e")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001590 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001591 {not available when compiled without the |+cindent|
1592 feature}
1593 A list of keys that, when typed in Insert mode, cause reindenting of
1594 the current line. Only used if 'cindent' is on and 'indentexpr' is
1595 empty.
1596 For the format of this option see |cinkeys-format|.
1597 See |C-indenting|.
1598
1599 *'cinoptions'* *'cino'*
1600'cinoptions' 'cino' string (default "")
1601 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001602 {not available when compiled without the |+cindent|
1603 feature}
1604 The 'cinoptions' affect the way 'cindent' reindents lines in a C
1605 program. See |cinoptions-values| for the values of this option, and
1606 |C-indenting| for info on C indenting in general.
1607
1608
1609 *'cinwords'* *'cinw'*
1610'cinwords' 'cinw' string (default "if,else,while,do,for,switch")
1611 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001612 {not available when compiled without both the
1613 |+cindent| and the |+smartindent| features}
1614 These keywords start an extra indent in the next line when
1615 'smartindent' or 'cindent' is set. For 'cindent' this is only done at
1616 an appropriate place (inside {}).
1617 Note that 'ignorecase' isn't used for 'cinwords'. If case doesn't
1618 matter, include the keyword both the uppercase and lowercase:
1619 "if,If,IF".
1620
1621 *'clipboard'* *'cb'*
1622'clipboard' 'cb' string (default "autoselect,exclude:cons\|linux"
1623 for X-windows, "" otherwise)
1624 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001625 {only in GUI versions or when the |+xterm_clipboard|
1626 feature is included}
1627 This option is a list of comma separated names.
Bram Moolenaar942db232021-02-13 18:14:48 +01001628 Note: if one of the items is "exclude:", then you can't add an item
1629 after that. Therefore do append an item with += but use ^= to
1630 prepend, e.g.: >
1631 set clipboard^=unnamed
1632< These names are recognized:
Bram Moolenaar071d4272004-06-13 20:20:40 +00001633
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001634 *clipboard-unnamed*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001635 unnamed When included, Vim will use the clipboard register '*'
1636 for all yank, delete, change and put operations which
1637 would normally go to the unnamed register. When a
1638 register is explicitly specified, it will always be
1639 used regardless of whether "unnamed" is in 'clipboard'
1640 or not. The clipboard register can always be
1641 explicitly accessed using the "* notation. Also see
1642 |gui-clipboard|.
1643
Bram Moolenaar30b65812012-07-12 22:01:11 +02001644 *clipboard-unnamedplus*
Bram Moolenaar00154502013-02-13 16:15:55 +01001645 unnamedplus A variant of the "unnamed" flag which uses the
1646 clipboard register '+' (|quoteplus|) instead of
1647 register '*' for all yank, delete, change and put
1648 operations which would normally go to the unnamed
1649 register. When "unnamed" is also included to the
1650 option, yank operations (but not delete, change or
1651 put) will additionally copy the text into register
1652 '*'.
Bram Moolenaar81af9252010-12-10 20:35:50 +01001653 Only available with the |+X11| feature.
Bram Moolenaarbf9680e2010-12-02 21:43:16 +01001654 Availability can be checked with: >
1655 if has('unnamedplus')
1656<
Bram Moolenaar30b65812012-07-12 22:01:11 +02001657 *clipboard-autoselect*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001658 autoselect Works like the 'a' flag in 'guioptions': If present,
1659 then whenever Visual mode is started, or the Visual
1660 area extended, Vim tries to become the owner of the
1661 windowing system's global selection or put the
1662 selected text on the clipboard used by the selection
Bram Moolenaarba3ff532018-11-04 14:45:49 +01001663 register "*. See |'go-a'| and |quotestar| for details.
1664 When the GUI is active, the 'a' flag in 'guioptions'
1665 is used, when the GUI is not active, this "autoselect"
1666 flag is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001667 Also applies to the modeless selection.
1668
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001669 *clipboard-autoselectplus*
1670 autoselectplus Like "autoselect" but using the + register instead of
1671 the * register. Compare to the 'P' flag in
1672 'guioptions'.
1673
1674 *clipboard-autoselectml*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001675 autoselectml Like "autoselect", but for the modeless selection
1676 only. Compare to the 'A' flag in 'guioptions'.
1677
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001678 *clipboard-html*
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001679 html When the clipboard contains HTML, use this when
1680 pasting. When putting text on the clipboard, mark it
1681 as HTML. This works to copy rendered HTML from
1682 Firefox, paste it as raw HTML in Vim, select the HTML
1683 in Vim and paste it in a rich edit box in Firefox.
Bram Moolenaar20a825a2010-05-31 21:27:30 +02001684 You probably want to add this only temporarily,
1685 possibly use BufEnter autocommands.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001686 Only supported for GTK version 2 and later.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001687
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001688 *clipboard-exclude*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001689 exclude:{pattern}
1690 Defines a pattern that is matched against the name of
1691 the terminal 'term'. If there is a match, no
1692 connection will be made to the X server. This is
1693 useful in this situation:
1694 - Running Vim in a console.
1695 - $DISPLAY is set to start applications on another
1696 display.
1697 - You do not want to connect to the X server in the
1698 console, but do want this in a terminal emulator.
1699 To never connect to the X server use: >
1700 exclude:.*
1701< This has the same effect as using the |-X| argument.
1702 Note that when there is no connection to the X server
1703 the window title won't be restored and the clipboard
1704 cannot be accessed.
1705 The value of 'magic' is ignored, {pattern} is
1706 interpreted as if 'magic' was on.
1707 The rest of the option value will be used for
1708 {pattern}, this must be the last entry.
1709
1710 *'cmdheight'* *'ch'*
1711'cmdheight' 'ch' number (default 1)
1712 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001713 Number of screen lines to use for the command-line. Helps avoiding
1714 |hit-enter| prompts.
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00001715 The value of this option is stored with the tab page, so that each tab
1716 page can have a different value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001717
1718 *'cmdwinheight'* *'cwh'*
1719'cmdwinheight' 'cwh' number (default 7)
1720 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001721 Number of screen lines to use for the command-line window. |cmdwin|
1722
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001723 *'colorcolumn'* *'cc'*
1724'colorcolumn' 'cc' string (default "")
1725 local to window
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001726 {not available when compiled without the |+syntax|
1727 feature}
1728 'colorcolumn' is a comma separated list of screen columns that are
1729 highlighted with ColorColumn |hl-ColorColumn|. Useful to align
1730 text. Will make screen redrawing slower.
1731 The screen column can be an absolute number, or a number preceded with
1732 '+' or '-', which is added to or subtracted from 'textwidth'. >
1733
1734 :set cc=+1 " highlight column after 'textwidth'
1735 :set cc=+1,+2,+3 " highlight three columns after 'textwidth'
1736 :hi ColorColumn ctermbg=lightgrey guibg=lightgrey
1737<
1738 When 'textwidth' is zero then the items with '-' and '+' are not used.
1739 A maximum of 256 columns are highlighted.
1740
Bram Moolenaar071d4272004-06-13 20:20:40 +00001741 *'columns'* *'co'* *E594*
1742'columns' 'co' number (default 80 or terminal width)
1743 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001744 Number of columns of the screen. Normally this is set by the terminal
Bram Moolenaar7c626922005-02-07 22:01:03 +00001745 initialization and does not have to be set by hand. Also see
1746 |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001747 When Vim is running in the GUI or in a resizable window, setting this
1748 option will cause the window size to be changed. When you only want
1749 to use the size for the GUI, put the command in your |gvimrc| file.
1750 When you set this option and Vim is unable to change the physical
Bram Moolenaar02467872007-05-06 13:22:01 +00001751 number of columns of the display, the display may be messed up. For
1752 the GUI it is always possible and Vim limits the number of columns to
1753 what fits on the screen. You can use this command to get the widest
1754 window possible: >
1755 :set columns=9999
1756< Minimum value is 12, maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001757
1758 *'comments'* *'com'* *E524* *E525*
1759'comments' 'com' string (default
1760 "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-")
1761 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001762 A comma separated list of strings that can start a comment line. See
1763 |format-comments|. See |option-backslash| about using backslashes to
1764 insert a space.
1765
1766 *'commentstring'* *'cms'* *E537*
1767'commentstring' 'cms' string (default "/*%s*/")
1768 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001769 {not available when compiled without the |+folding|
1770 feature}
1771 A template for a comment. The "%s" in the value is replaced with the
1772 comment text. Currently only used to add markers for folding, see
1773 |fold-marker|.
1774
1775 *'compatible'* *'cp'* *'nocompatible'* *'nocp'*
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001776'compatible' 'cp' boolean (default on, off when a |vimrc| or |gvimrc|
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02001777 file is found, reset in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001778 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001779 This option has the effect of making Vim either more Vi-compatible, or
1780 make Vim behave in a more useful way.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001781
Bram Moolenaar071d4272004-06-13 20:20:40 +00001782 This is a special kind of option, because when it's set or reset,
Bram Moolenaar214641f2017-03-05 17:04:09 +01001783 other options are also changed as a side effect.
1784 NOTE: Setting or resetting this option can have a lot of unexpected
1785 effects: Mappings are interpreted in another way, undo behaves
1786 differently, etc. If you set this option in your vimrc file, you
1787 should probably put it at the very start.
1788
Bram Moolenaar071d4272004-06-13 20:20:40 +00001789 By default this option is on and the Vi defaults are used for the
1790 options. This default was chosen for those people who want to use Vim
1791 just like Vi, and don't even (want to) know about the 'compatible'
1792 option.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001793 When a |vimrc| or |gvimrc| file is found while Vim is starting up,
Bram Moolenaard042c562005-06-30 22:04:15 +00001794 this option is switched off, and all options that have not been
1795 modified will be set to the Vim defaults. Effectively, this means
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001796 that when a |vimrc| or |gvimrc| file exists, Vim will use the Vim
Bram Moolenaard042c562005-06-30 22:04:15 +00001797 defaults, otherwise it will use the Vi defaults. (Note: This doesn't
Bram Moolenaar02467872007-05-06 13:22:01 +00001798 happen for the system-wide vimrc or gvimrc file, nor for a file given
1799 with the |-u| argument). Also see |compatible-default| and
1800 |posix-compliance|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001801 You can also set this option with the "-C" argument, and reset it with
1802 "-N". See |-C| and |-N|.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001803 See 'cpoptions' for more fine tuning of Vi compatibility.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001804
Bram Moolenaar214641f2017-03-05 17:04:09 +01001805 When this option is set, numerous other options are set to make Vim as
1806 Vi-compatible as possible. When this option is unset, various options
1807 are set to make Vim more useful. The table below lists all the
1808 options affected.
1809 The {?} column indicates when the options are affected:
1810 + Means that the option is set to the value given in {set value} when
1811 'compatible' is set.
1812 & Means that the option is set to the value given in {set value} when
1813 'compatible' is set AND is set to its Vim default value when
1814 'compatible' is unset.
1815 - Means the option is NOT changed when setting 'compatible' but IS
1816 set to its Vim default when 'compatible' is unset.
1817 The {effect} column summarises the change when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001818
Bram Moolenaar036986f2017-03-16 17:41:02 +01001819 option ? set value effect ~
Bram Moolenaar214641f2017-03-05 17:04:09 +01001820
1821 'allowrevins' + off no CTRL-_ command
1822 'antialias' + off don't use antialiased fonts
1823 'arabic' + off reset arabic-related options
1824 'arabicshape' + on correct character shapes
1825 'backspace' + "" normal backspace
1826 'backup' + off no backup file
1827 'backupcopy' & Unix: "yes" backup file is a copy
1828 else: "auto" copy or rename backup file
1829 'balloonexpr' + "" text to show in evaluation balloon
1830 'breakindent' + off don't indent when wrapping lines
1831 'cedit' - {unchanged} {set vim default only on resetting 'cp'}
1832 'cindent' + off no C code indentation
1833 'compatible' - {unchanged} {set vim default only on resetting 'cp'}
1834 'copyindent' + off don't copy indent structure
1835 'cpoptions' & (all flags) Vi-compatible flags
1836 'cscopepathcomp'+ 0 don't show directories in tags list
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01001837 'cscoperelative'+ off don't use basename of path as prefix
Bram Moolenaar214641f2017-03-05 17:04:09 +01001838 'cscopetag' + off don't use cscope for ":tag"
Bram Moolenaar036986f2017-03-16 17:41:02 +01001839 'cscopetagorder'+ 0 see |cscopetagorder|
Bram Moolenaar214641f2017-03-05 17:04:09 +01001840 'cscopeverbose' + off see |cscopeverbose|
1841 'delcombine' + off unicode: delete whole char combination
1842 'digraph' + off no digraphs
1843 'esckeys' & off no <Esc>-keys in Insert mode
1844 'expandtab' + off tabs not expanded to spaces
1845 'fileformats' & "" no automatic file format detection,
Bram Moolenaar6f345a12019-12-17 21:27:18 +01001846 "dos,unix" except for MS-Windows
Bram Moolenaar214641f2017-03-05 17:04:09 +01001847 'formatexpr' + "" use 'formatprg' for auto-formatting
1848 'formatoptions' & "vt" Vi compatible formatting
1849 'gdefault' + off no default 'g' flag for ":s"
1850 'history' & 0 no commandline history
1851 'hkmap' + off no Hebrew keyboard mapping
1852 'hkmapp' + off no phonetic Hebrew keyboard mapping
1853 'hlsearch' + off no highlighting of search matches
1854 'incsearch' + off no incremental searching
1855 'indentexpr' + "" no indenting by expression
1856 'insertmode' + off do not start in Insert mode
1857 'iskeyword' & "@,48-57,_" keywords contain alphanumeric
Bram Moolenaar071d4272004-06-13 20:20:40 +00001858 characters and '_'
Bram Moolenaar214641f2017-03-05 17:04:09 +01001859 'joinspaces' + on insert 2 spaces after period
1860 'modeline' & off no modelines
1861 'more' & off no pauses in listings
1862 'mzquantum' - {unchanged} {set vim default only on resetting 'cp'}
1863 'numberwidth' & 8 min number of columns for line number
1864 'preserveindent'+ off don't preserve current indent structure
1865 when changing it
1866 'revins' + off no reverse insert
1867 'ruler' + off no ruler
1868 'scrolljump' + 1 no jump scroll
1869 'scrolloff' + 0 no scroll offset
1870 'shelltemp' - {unchanged} {set vim default only on resetting 'cp'}
1871 'shiftround' + off indent not rounded to shiftwidth
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02001872 'shortmess' & "S" no shortening of messages
Bram Moolenaar214641f2017-03-05 17:04:09 +01001873 'showcmd' & off command characters not shown
1874 'showmode' & off current mode not shown
1875 'sidescrolloff' + 0 cursor moves to edge of screen in scroll
1876 'smartcase' + off no automatic ignore case switch
1877 'smartindent' + off no smart indentation
1878 'smarttab' + off no smart tab size
1879 'softtabstop' + 0 tabs are always 'tabstop' positions
1880 'startofline' + on goto startofline with some commands
1881 'tagcase' & "followic" 'ignorecase' when searching tags file
1882 'tagrelative' & off tag file names are not relative
1883 'termguicolors' + off don't use highlight-(guifg|guibg)
1884 'textauto' & off no automatic textmode detection
1885 'textwidth' + 0 no automatic line wrap
1886 'tildeop' + off tilde is not an operator
1887 'ttimeout' + off no terminal timeout
1888 'undofile' + off don't use an undo file
Bram Moolenaar036986f2017-03-16 17:41:02 +01001889 'viminfo' - {unchanged} {set Vim default only on resetting 'cp'}
Bram Moolenaar214641f2017-03-05 17:04:09 +01001890 'virtualedit' + "" cursor can only be placed on characters
1891 'whichwrap' & "" left-right movements don't wrap
1892 'wildchar' & CTRL-E only when the current value is <Tab>
Bram Moolenaar071d4272004-06-13 20:20:40 +00001893 use CTRL-E for cmdline completion
Bram Moolenaar214641f2017-03-05 17:04:09 +01001894 'writebackup' + on or off depends on the |+writebackup| feature
Bram Moolenaar071d4272004-06-13 20:20:40 +00001895
1896 *'complete'* *'cpt'* *E535*
1897'complete' 'cpt' string (default: ".,w,b,u,t,i")
1898 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001899 This option specifies how keyword completion |ins-completion| works
1900 when CTRL-P or CTRL-N are used. It is also used for whole-line
1901 completion |i_CTRL-X_CTRL-L|. It indicates the type of completion
1902 and the places to scan. It is a comma separated list of flags:
Bram Moolenaar3848e002016-03-19 18:42:29 +01001903 . scan the current buffer ('wrapscan' is ignored)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001904 w scan buffers from other windows
1905 b scan other loaded buffers that are in the buffer list
1906 u scan the unloaded buffers that are in the buffer list
1907 U scan the buffers that are not in the buffer list
1908 k scan the files given with the 'dictionary' option
Bram Moolenaar0b238792006-03-02 22:49:12 +00001909 kspell use the currently active spell checking |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001910 k{dict} scan the file {dict}. Several "k" flags can be given,
1911 patterns are valid too. For example: >
1912 :set cpt=k/usr/dict/*,k~/spanish
1913< s scan the files given with the 'thesaurus' option
1914 s{tsr} scan the file {tsr}. Several "s" flags can be given, patterns
1915 are valid too.
1916 i scan current and included files
1917 d scan current and included files for defined name or macro
1918 |i_CTRL-X_CTRL-D|
1919 ] tag completion
1920 t same as "]"
1921
1922 Unloaded buffers are not loaded, thus their autocmds |:autocmd| are
1923 not executed, this may lead to unexpected completions from some files
1924 (gzipped files for example). Unloaded buffers are not scanned for
1925 whole-line completion.
1926
1927 The default is ".,w,b,u,t,i", which means to scan:
1928 1. the current buffer
1929 2. buffers in other windows
1930 3. other loaded buffers
1931 4. unloaded buffers
1932 5. tags
1933 6. included files
1934
1935 As you can see, CTRL-N and CTRL-P can be used to do any 'iskeyword'-
Bram Moolenaar582fd852005-03-28 20:58:01 +00001936 based expansion (e.g., dictionary |i_CTRL-X_CTRL-K|, included patterns
1937 |i_CTRL-X_CTRL-I|, tags |i_CTRL-X_CTRL-]| and normal expansions).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001938
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001939 *'completefunc'* *'cfu'*
1940'completefunc' 'cfu' string (default: empty)
1941 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02001942 {not available when compiled without the |+eval|
Bram Moolenaare2c453d2019-08-21 14:37:09 +02001943 feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00001944 This option specifies a function to be used for Insert mode completion
1945 with CTRL-X CTRL-U. |i_CTRL-X_CTRL-U|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001946 See |complete-functions| for an explanation of how the function is
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00001947 invoked and what it should return. The value can be the name of a
1948 function, a |lambda| or a |Funcref|. See |option-value-function| for
1949 more information.
Bram Moolenaar166af9b2010-11-16 20:34:40 +01001950 This option cannot be set from a |modeline| or in the |sandbox|, for
1951 security reasons.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00001952
Bram Moolenaarac3150d2019-07-28 16:36:39 +02001953 *'completeslash'* *'csl'*
1954'completeslash' 'csl' string (default: "")
1955 local to buffer
Bram Moolenaar2e693a82019-10-16 22:35:02 +02001956 {only for MS-Windows}
Bram Moolenaarac3150d2019-07-28 16:36:39 +02001957 When this option is set it overrules 'shellslash' for completion:
1958 - When this option is set to "slash", a forward slash is used for path
1959 completion in insert mode. This is useful when editing HTML tag, or
Bram Moolenaar6f345a12019-12-17 21:27:18 +01001960 Makefile with 'noshellslash' on MS-Windows.
Bram Moolenaarac3150d2019-07-28 16:36:39 +02001961 - When this option is set to "backslash", backslash is used. This is
Bram Moolenaar6f345a12019-12-17 21:27:18 +01001962 useful when editing a batch file with 'shellslash' set on MS-Windows.
Bram Moolenaarac3150d2019-07-28 16:36:39 +02001963 - When this option is empty, same character is used as for
1964 'shellslash'.
1965 For Insert mode completion the buffer-local value is used. For
1966 command line completion the global value is used.
1967
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001968 *'completeopt'* *'cot'*
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001969'completeopt' 'cot' string (default: "menu,preview")
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001970 global
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001971 A comma separated list of options for Insert mode completion
1972 |ins-completion|. The supported values are:
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001973
1974 menu Use a popup menu to show the possible completions. The
1975 menu is only shown when there is more than one match and
1976 sufficient colors are available. |ins-completion-menu|
1977
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001978 menuone Use the popup menu also when there is only one match.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00001979 Useful when there is additional information about the
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001980 match, e.g., what file it comes from.
1981
Bram Moolenaarc1e37902006-04-18 21:55:01 +00001982 longest Only insert the longest common text of the matches. If
1983 the menu is displayed you can use CTRL-L to add more
1984 characters. Whether case is ignored depends on the kind
1985 of completion. For buffer text the 'ignorecase' option is
1986 used.
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001987
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001988 preview Show extra information about the currently selected
Bram Moolenaar02467872007-05-06 13:22:01 +00001989 completion in the preview window. Only works in
1990 combination with "menu" or "menuone".
1991
Bram Moolenaar576a4a62019-08-18 15:25:17 +02001992 popup Show extra information about the currently selected
1993 completion in a popup window. Only works in combination
1994 with "menu" or "menuone". Overrides "preview".
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02001995 See |'completepopup'| for specifying properties.
Bram Moolenaar2e693a82019-10-16 22:35:02 +02001996 {only works when compiled with the |+textprop| feature}
Bram Moolenaar576a4a62019-08-18 15:25:17 +02001997
Bram Moolenaardca7abe2019-10-20 18:17:57 +02001998 popuphidden
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01001999 Just like "popup" but initially hide the popup. Use a
Bram Moolenaardca7abe2019-10-20 18:17:57 +02002000 |CompleteChanged| autocommand to fetch the info and call
2001 |popup_show()| once the popup has been filled.
2002 See the example at |complete-popuphidden|.
2003 {only works when compiled with the |+textprop| feature}
2004
Bram Moolenaarb6be1e22015-07-10 18:18:40 +02002005 noinsert Do not insert any text for a match until the user selects
2006 a match from the menu. Only works in combination with
2007 "menu" or "menuone". No effect if "longest" is present.
2008
2009 noselect Do not select a match in the menu, force the user to
2010 select one from the menu. Only works in combination with
2011 "menu" or "menuone".
2012
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00002013
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002014 *'completepopup'* *'cpp'*
2015'completepopup' 'cpp' string (default empty)
2016 global
2017 {not available when compiled without the |+textprop|
2018 or |+quickfix| feature}
2019 When 'completeopt' contains "popup" then this option is used for the
Bram Moolenaar447bfba2020-07-18 16:07:16 +02002020 properties of the info popup when it is created. If an info popup
2021 window already exists it is closed, so that the option value is
2022 applied when it is created again.
2023 You can also use |popup_findinfo()| and then set properties for an
2024 existing info popup with |popup_setoptions()|. See |complete-popup|.
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002025
2026
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002027 *'concealcursor'* *'cocu'*
2028'concealcursor' 'cocu' string (default: "")
2029 local to window
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002030 {not available when compiled without the |+conceal|
2031 feature}
2032 Sets the modes in which text in the cursor line can also be concealed.
2033 When the current mode is listed then concealing happens just like in
2034 other lines.
2035 n Normal mode
2036 v Visual mode
2037 i Insert mode
Bram Moolenaarca8c9862010-07-24 15:00:38 +02002038 c Command line editing, for 'incsearch'
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002039
Bram Moolenaare6dc5732010-07-24 23:52:26 +02002040 'v' applies to all lines in the Visual area, not only the cursor.
Bram Moolenaarca8c9862010-07-24 15:00:38 +02002041 A useful value is "nc". This is used in help files. So long as you
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002042 are moving around text is concealed, but when starting to insert text
2043 or selecting a Visual area the concealed text is displayed, so that
2044 you can see what you are doing.
Bram Moolenaarf70e3d62010-07-24 13:15:07 +02002045 Keep in mind that the cursor position is not always where it's
2046 displayed. E.g., when moving vertically it may change column.
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002047
2048
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002049 *'conceallevel'* *'cole'*
2050'conceallevel' 'cole' number (default 0)
Bram Moolenaar860cae12010-06-05 23:22:07 +02002051 local to window
Bram Moolenaar860cae12010-06-05 23:22:07 +02002052 {not available when compiled without the |+conceal|
2053 feature}
Bram Moolenaar6df6f472010-07-18 18:04:50 +02002054 Determine how text with the "conceal" syntax attribute |:syn-conceal|
2055 is shown:
Bram Moolenaar860cae12010-06-05 23:22:07 +02002056
Bram Moolenaar6df6f472010-07-18 18:04:50 +02002057 Value Effect ~
Bram Moolenaar860cae12010-06-05 23:22:07 +02002058 0 Text is shown normally
Bram Moolenaar477db062010-07-28 18:17:41 +02002059 1 Each block of concealed text is replaced with one
2060 character. If the syntax item does not have a custom
2061 replacement character defined (see |:syn-cchar|) the
2062 character defined in 'listchars' is used (default is a
2063 space).
2064 It is highlighted with the "Conceal" highlight group.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002065 2 Concealed text is completely hidden unless it has a
2066 custom replacement character defined (see
Bram Moolenaar477db062010-07-28 18:17:41 +02002067 |:syn-cchar|).
Bram Moolenaara7781e02010-07-19 20:13:22 +02002068 3 Concealed text is completely hidden.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002069
Bram Moolenaara7781e02010-07-19 20:13:22 +02002070 Note: in the cursor line concealed text is not hidden, so that you can
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002071 edit and copy the text. This can be changed with the 'concealcursor'
2072 option.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002073
Bram Moolenaar071d4272004-06-13 20:20:40 +00002074 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
2075'confirm' 'cf' boolean (default off)
2076 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002077 When 'confirm' is on, certain operations that would normally
2078 fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
2079 instead raise a |dialog| asking if you wish to save the current
2080 file(s). You can still use a ! to unconditionally |abandon| a buffer.
2081 If 'confirm' is off you can still activate confirmation for one
2082 command only (this is most useful in mappings) with the |:confirm|
2083 command.
2084 Also see the |confirm()| function and the 'v' flag in 'guioptions'.
2085
2086 *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
2087'conskey' 'consk' boolean (default off)
2088 global
Bram Moolenaarf3913272016-02-25 00:00:01 +01002089 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002090
2091 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
2092'copyindent' 'ci' boolean (default off)
2093 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002094 Copy the structure of the existing lines indent when autoindenting a
2095 new line. Normally the new indent is reconstructed by a series of
2096 tabs followed by spaces as required (unless |'expandtab'| is enabled,
2097 in which case only spaces are used). Enabling this option makes the
2098 new line copy whatever characters were used for indenting on the
Bram Moolenaar446cb832008-06-24 21:56:24 +00002099 existing line. 'expandtab' has no effect on these characters, a Tab
2100 remains a Tab. If the new indent is greater than on the existing
Bram Moolenaar071d4272004-06-13 20:20:40 +00002101 line, the remaining space is filled in the normal manner.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002102 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002103 Also see 'preserveindent'.
2104
Bram Moolenaare0fa3742016-02-20 15:47:01 +01002105 *'cpoptions'* *'cpo'* *cpo*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002106'cpoptions' 'cpo' string (Vim default: "aABceFs",
2107 Vi default: all flags)
2108 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002109 A sequence of single character flags. When a character is present
Bram Moolenaar7cba6c02013-09-05 22:13:31 +02002110 this indicates Vi-compatible behavior. This is used for things where
2111 not being Vi-compatible is mostly or sometimes preferred.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002112 'cpoptions' stands for "compatible-options".
2113 Commas can be added for readability.
2114 To avoid problems with flags that are added in the future, use the
2115 "+=" and "-=" feature of ":set" |add-option-flags|.
2116 NOTE: This option is set to the Vi default value when 'compatible' is
2117 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002118 NOTE: This option is set to the POSIX default value at startup when
2119 the Vi default value would be used and the $VIM_POSIX environment
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002120 variable exists |posix|. This means Vim tries to behave like the
2121 POSIX specification.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002122
2123 contains behavior ~
2124 *cpo-a*
2125 a When included, a ":read" command with a file name
2126 argument will set the alternate file name for the
2127 current window.
2128 *cpo-A*
2129 A When included, a ":write" command with a file name
2130 argument will set the alternate file name for the
2131 current window.
2132 *cpo-b*
2133 b "\|" in a ":map" command is recognized as the end of
2134 the map command. The '\' is included in the mapping,
2135 the text after the '|' is interpreted as the next
2136 command. Use a CTRL-V instead of a backslash to
2137 include the '|' in the mapping. Applies to all
2138 mapping, abbreviation, menu and autocmd commands.
2139 See also |map_bar|.
2140 *cpo-B*
2141 B A backslash has no special meaning in mappings,
Bram Moolenaara9604e62018-07-21 05:56:22 +02002142 abbreviations, user commands and the "to" part of the
2143 menu commands. Remove this flag to be able to use a
2144 backslash like a CTRL-V. For example, the command
2145 ":map X \<Esc>" results in X being mapped to:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002146 'B' included: "\^[" (^[ is a real <Esc>)
2147 'B' excluded: "<Esc>" (5 characters)
2148 ('<' excluded in both cases)
2149 *cpo-c*
2150 c Searching continues at the end of any match at the
2151 cursor position, but not further than the start of the
2152 next line. When not present searching continues
2153 one character from the cursor position. With 'c'
2154 "abababababab" only gets three matches when repeating
2155 "/abab", without 'c' there are five matches.
2156 *cpo-C*
2157 C Do not concatenate sourced lines that start with a
2158 backslash. See |line-continuation|.
2159 *cpo-d*
2160 d Using "./" in the 'tags' option doesn't mean to use
2161 the tags file relative to the current file, but the
2162 tags file in the current directory.
2163 *cpo-D*
2164 D Can't use CTRL-K to enter a digraph after Normal mode
2165 commands with a character argument, like |r|, |f| and
2166 |t|.
2167 *cpo-e*
2168 e When executing a register with ":@r", always add a
2169 <CR> to the last line, also when the register is not
2170 linewise. If this flag is not present, the register
2171 is not linewise and the last line does not end in a
2172 <CR>, then the last line is put on the command-line
2173 and can be edited before hitting <CR>.
2174 *cpo-E*
2175 E It is an error when using "y", "d", "c", "g~", "gu" or
2176 "gU" on an Empty region. The operators only work when
Bram Moolenaar15142e22018-04-30 22:19:58 +02002177 at least one character is to be operated on. Example:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002178 This makes "y0" fail in the first column.
2179 *cpo-f*
2180 f When included, a ":read" command with a file name
2181 argument will set the file name for the current buffer,
2182 if the current buffer doesn't have a file name yet.
2183 *cpo-F*
2184 F When included, a ":write" command with a file name
2185 argument will set the file name for the current
2186 buffer, if the current buffer doesn't have a file name
Bram Moolenaarb3480382005-12-11 21:33:32 +00002187 yet. Also see |cpo-P|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002188 *cpo-g*
2189 g Goto line 1 when using ":edit" without argument.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002190 *cpo-H*
2191 H When using "I" on a line with only blanks, insert
2192 before the last blank. Without this flag insert after
2193 the last blank.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002194 *cpo-i*
2195 i When included, interrupting the reading of a file will
2196 leave it modified.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002197 *cpo-I*
2198 I When moving the cursor up or down just after inserting
2199 indent for 'autoindent', do not delete the indent.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002200 *cpo-j*
2201 j When joining lines, only add two spaces after a '.',
2202 not after '!' or '?'. Also see 'joinspaces'.
2203 *cpo-J*
2204 J A |sentence| has to be followed by two spaces after
Bram Moolenaar582fd852005-03-28 20:58:01 +00002205 the '.', '!' or '?'. A <Tab> is not recognized as
Bram Moolenaar071d4272004-06-13 20:20:40 +00002206 white space.
2207 *cpo-k*
2208 k Disable the recognition of raw key codes in
2209 mappings, abbreviations, and the "to" part of menu
2210 commands. For example, if <Key> sends ^[OA (where ^[
2211 is <Esc>), the command ":map X ^[OA" results in X
2212 being mapped to:
2213 'k' included: "^[OA" (3 characters)
2214 'k' excluded: "<Key>" (one key code)
2215 Also see the '<' flag below.
2216 *cpo-K*
2217 K Don't wait for a key code to complete when it is
2218 halfway a mapping. This breaks mapping <F1><F1> when
2219 only part of the second <F1> has been read. It
2220 enables cancelling the mapping by typing <F1><Esc>.
2221 *cpo-l*
2222 l Backslash in a [] range in a search pattern is taken
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002223 literally, only "\]", "\^", "\-" and "\\" are special.
2224 See |/[]|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002225 'l' included: "/[ \t]" finds <Space>, '\' and 't'
2226 'l' excluded: "/[ \t]" finds <Space> and <Tab>
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002227 Also see |cpo-\|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002228 *cpo-L*
2229 L When the 'list' option is set, 'wrapmargin',
2230 'textwidth', 'softtabstop' and Virtual Replace mode
2231 (see |gR|) count a <Tab> as two characters, instead of
2232 the normal behavior of a <Tab>.
2233 *cpo-m*
2234 m When included, a showmatch will always wait half a
2235 second. When not included, a showmatch will wait half
2236 a second or until a character is typed. |'showmatch'|
2237 *cpo-M*
2238 M When excluded, "%" matching will take backslashes into
2239 account. Thus in "( \( )" and "\( ( \)" the outer
2240 parenthesis match. When included "%" ignores
2241 backslashes, which is Vi compatible.
2242 *cpo-n*
Bram Moolenaar64486672010-05-16 15:46:46 +02002243 n When included, the column used for 'number' and
2244 'relativenumber' will also be used for text of wrapped
2245 lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002246 *cpo-o*
2247 o Line offset to search command is not remembered for
2248 next search.
2249 *cpo-O*
2250 O Don't complain if a file is being overwritten, even
2251 when it didn't exist when editing it. This is a
2252 protection against a file unexpectedly created by
2253 someone else. Vi didn't complain about this.
2254 *cpo-p*
2255 p Vi compatible Lisp indenting. When not present, a
2256 slightly better algorithm is used.
Bram Moolenaarb3480382005-12-11 21:33:32 +00002257 *cpo-P*
2258 P When included, a ":write" command that appends to a
2259 file will set the file name for the current buffer, if
2260 the current buffer doesn't have a file name yet and
2261 the 'F' flag is also included |cpo-F|.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002262 *cpo-q*
2263 q When joining multiple lines leave the cursor at the
2264 position where it would be when joining two lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002265 *cpo-r*
2266 r Redo ("." command) uses "/" to repeat a search
2267 command, instead of the actually used search string.
2268 *cpo-R*
2269 R Remove marks from filtered lines. Without this flag
2270 marks are kept like |:keepmarks| was used.
2271 *cpo-s*
2272 s Set buffer options when entering the buffer for the
2273 first time. This is like it is in Vim version 3.0.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002274 And it is the default. If not present the options are
Bram Moolenaar071d4272004-06-13 20:20:40 +00002275 set when the buffer is created.
2276 *cpo-S*
2277 S Set buffer options always when entering a buffer
2278 (except 'readonly', 'fileformat', 'filetype' and
2279 'syntax'). This is the (most) Vi compatible setting.
2280 The options are set to the values in the current
2281 buffer. When you change an option and go to another
2282 buffer, the value is copied. Effectively makes the
2283 buffer options global to all buffers.
2284
2285 's' 'S' copy buffer options
2286 no no when buffer created
2287 yes no when buffer first entered (default)
2288 X yes each time when buffer entered (vi comp.)
2289 *cpo-t*
2290 t Search pattern for the tag command is remembered for
2291 "n" command. Otherwise Vim only puts the pattern in
2292 the history for search pattern, but doesn't change the
2293 last used search pattern.
2294 *cpo-u*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002295 u Undo is Vi compatible. See |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002296 *cpo-v*
2297 v Backspaced characters remain visible on the screen in
2298 Insert mode. Without this flag the characters are
2299 erased from the screen right away. With this flag the
2300 screen newly typed text overwrites backspaced
2301 characters.
2302 *cpo-w*
2303 w When using "cw" on a blank character, only change one
2304 character and not all blanks until the start of the
2305 next word.
2306 *cpo-W*
2307 W Don't overwrite a readonly file. When omitted, ":w!"
2308 overwrites a readonly file, if possible.
2309 *cpo-x*
2310 x <Esc> on the command-line executes the command-line.
2311 The default in Vim is to abandon the command-line,
2312 because <Esc> normally aborts a command. |c_<Esc>|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002313 *cpo-X*
2314 X When using a count with "R" the replaced text is
2315 deleted only once. Also when repeating "R" with "."
2316 and a count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002317 *cpo-y*
Bram Moolenaard09091d2019-01-17 16:07:22 +01002318 y A yank command can be redone with ".". Think twice if
2319 you really want to use this, it may break some
2320 plugins, since most people expect "." to only repeat a
2321 change.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002322 *cpo-Z*
2323 Z When using "w!" while the 'readonly' option is set,
2324 don't reset 'readonly'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002325 *cpo-!*
2326 ! When redoing a filter command, use the last used
2327 external command, whatever it was. Otherwise the last
2328 used -filter- command is used.
2329 *cpo-$*
2330 $ When making a change to one line, don't redisplay the
2331 line, but put a '$' at the end of the changed text.
2332 The changed text will be overwritten when you type the
2333 new text. The line is redisplayed if you type any
2334 command that moves the cursor from the insertion
2335 point.
2336 *cpo-%*
2337 % Vi-compatible matching is done for the "%" command.
2338 Does not recognize "#if", "#endif", etc.
2339 Does not recognize "/*" and "*/".
2340 Parens inside single and double quotes are also
2341 counted, causing a string that contains a paren to
2342 disturb the matching. For example, in a line like
2343 "if (strcmp("foo(", s))" the first paren does not
2344 match the last one. When this flag is not included,
2345 parens inside single and double quotes are treated
2346 specially. When matching a paren outside of quotes,
2347 everything inside quotes is ignored. When matching a
2348 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002349 there is one). This works very well for C programs.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002350 This flag is also used for other features, such as
2351 C-indenting.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002352 *cpo--*
2353 - When included, a vertical movement command fails when
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002354 it would go above the first line or below the last
2355 line. Without it the cursor moves to the first or
2356 last line, unless it already was in that line.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002357 Applies to the commands "-", "k", CTRL-P, "+", "j",
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002358 CTRL-N, CTRL-J and ":1234".
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002359 *cpo-+*
2360 + When included, a ":write file" command will reset the
2361 'modified' flag of the buffer, even though the buffer
2362 itself may still be different from its file.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002363 *cpo-star*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002364 * Use ":*" in the same way as ":@". When not included,
2365 ":*" is an alias for ":'<,'>", select the Visual area.
2366 *cpo-<*
2367 < Disable the recognition of special key codes in |<>|
2368 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002369 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00002370 ":map X <Tab>" results in X being mapped to:
2371 '<' included: "<Tab>" (5 characters)
2372 '<' excluded: "^I" (^I is a real <Tab>)
2373 Also see the 'k' flag above.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002374 *cpo->*
2375 > When appending to a register, put a line break before
2376 the appended text.
Bram Moolenaar8b3e0332011-06-26 05:36:34 +02002377 *cpo-;*
2378 ; When using |,| or |;| to repeat the last |t| search
2379 and the cursor is right in front of the searched
2380 character, the cursor won't move. When not included,
2381 the cursor would skip over it and jump to the
Bram Moolenaarc8734422012-06-01 22:38:45 +02002382 following occurrence.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002383
2384 POSIX flags. These are not included in the Vi default value, except
2385 when $VIM_POSIX was set on startup. |posix|
2386
2387 contains behavior ~
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002388 *cpo-#*
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002389 # A count before "D", "o" and "O" has no effect.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002390 *cpo-&*
2391 & When ":preserve" was used keep the swap file when
2392 exiting normally while this buffer is still loaded.
2393 This flag is tested when exiting.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002394 *cpo-\*
2395 \ Backslash in a [] range in a search pattern is taken
2396 literally, only "\]" is special See |/[]|
Bram Moolenaar90915b52005-08-21 22:17:52 +00002397 '\' included: "/[ \-]" finds <Space>, '\' and '-'
2398 '\' excluded: "/[ \-]" finds <Space> and '-'
2399 Also see |cpo-l|.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002400 *cpo-/*
2401 / When "%" is used as the replacement string in a |:s|
2402 command, use the previous replacement string. |:s%|
2403 *cpo-{*
2404 { The |{| and |}| commands also stop at a "{" character
2405 at the start of a line.
2406 *cpo-.*
2407 . The ":chdir" and ":cd" commands fail if the current
2408 buffer is modified, unless ! is used. Vim doesn't
2409 need this, since it remembers the full path of an
2410 opened file.
2411 *cpo-bar*
2412 | The value of the $LINES and $COLUMNS environment
2413 variables overrule the terminal size values obtained
2414 with system specific functions.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002415
Bram Moolenaar071d4272004-06-13 20:20:40 +00002416
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002417 *'cryptmethod'* *'cm'*
Bram Moolenaara86187b2018-12-16 18:20:00 +01002418'cryptmethod' 'cm' string (default "blowfish2")
Bram Moolenaar49771f42010-07-20 17:32:38 +02002419 global or local to buffer |global-local|
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002420 Method used for encryption when the buffer is written to a file:
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002421 *pkzip*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002422 zip PkZip compatible method. A weak kind of encryption.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002423 Backwards compatible with Vim 7.2 and older.
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002424 *blowfish*
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002425 blowfish Blowfish method. Medium strong encryption but it has
2426 an implementation flaw. Requires Vim 7.3 or later,
2427 files can NOT be read by Vim 7.2 and older. This adds
2428 a "seed" to the file, every time you write the file
2429 the encrypted bytes will be different.
2430 *blowfish2*
2431 blowfish2 Blowfish method. Medium strong encryption. Requires
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01002432 Vim 7.4.401 or later, files can NOT be read by Vim 7.3
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002433 and older. This adds a "seed" to the file, every time
2434 you write the file the encrypted bytes will be
2435 different. The whole undo file is encrypted, not just
2436 the pieces of text.
Christian Brabandtf573c6e2021-06-20 14:02:16 +02002437 *E1193* *E1194* *E1195* *E1196*
2438 *E1197* *E1198* *E1199* *E1200* *E1201*
2439 xchacha20 XChaCha20 Cipher with Poly1305 Message Authentication
2440 Code. Medium strong till strong encryption.
2441 Encryption is provided by the libsodium library, it
Bram Moolenaar22863042021-10-16 15:23:36 +01002442 requires Vim to be built with |+sodium|.
Christian Brabandtf573c6e2021-06-20 14:02:16 +02002443 It adds a seed and a message authentication code (MAC)
2444 to the file. This needs at least a Vim 8.2.3022 to
2445 read the encrypted file.
2446 Encryption of swap files is not supported, therefore
2447 no swap file will be used when xchacha20 encryption is
2448 enabled.
2449 Encryption of undo files is not yet supported,
2450 therefore no undo file will currently be written.
2451 CURRENTLY EXPERIMENTAL: Files written with this method
2452 might have to be read back with the same version of
2453 Vim if the binary format changes later.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002454
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01002455 You should use "blowfish2", also to re-encrypt older files.
2456
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002457 When reading an encrypted file 'cryptmethod' will be set automatically
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002458 to the detected method of the file being read. Thus if you write it
2459 without changing 'cryptmethod' the same method will be used.
2460 Changing 'cryptmethod' does not mark the file as modified, you have to
Bram Moolenaar49771f42010-07-20 17:32:38 +02002461 explicitly write it, you don't get a warning unless there are other
2462 modifications. Also see |:X|.
2463
2464 When setting the global value to an empty string, it will end up with
Bram Moolenaara86187b2018-12-16 18:20:00 +01002465 the value "blowfish2". When setting the local value to an empty
2466 string the buffer will use the global value.
Bram Moolenaar49771f42010-07-20 17:32:38 +02002467
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002468 When a new encryption method is added in a later version of Vim, and
2469 the current version does not recognize it, you will get *E821* .
Bram Moolenaar49771f42010-07-20 17:32:38 +02002470 You need to edit this file with the later version of Vim.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002471
2472
Bram Moolenaar071d4272004-06-13 20:20:40 +00002473 *'cscopepathcomp'* *'cspc'*
2474'cscopepathcomp' 'cspc' number (default 0)
2475 global
2476 {not available when compiled without the |+cscope|
2477 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002478 Determines how many components of the path to show in a list of tags.
2479 See |cscopepathcomp|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002480 NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002481
2482 *'cscopeprg'* *'csprg'*
2483'cscopeprg' 'csprg' string (default "cscope")
2484 global
2485 {not available when compiled without the |+cscope|
2486 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002487 Specifies the command to execute cscope. See |cscopeprg|.
2488 This option cannot be set from a |modeline| or in the |sandbox|, for
2489 security reasons.
2490
2491 *'cscopequickfix'* *'csqf'*
2492'cscopequickfix' 'csqf' string (default "")
2493 global
2494 {not available when compiled without the |+cscope|
2495 or |+quickfix| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002496 Specifies whether to use quickfix window to show cscope results.
2497 See |cscopequickfix|.
2498
Bram Moolenaarec7944a2013-06-12 21:29:15 +02002499 *'cscoperelative'* *'csre'* *'nocscoperelative'* *'nocsre'*
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002500'cscoperelative' 'csre' boolean (default off)
2501 global
2502 {not available when compiled without the |+cscope|
2503 feature}
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002504 In the absence of a prefix (-P) for cscope. setting this option enables
2505 to use the basename of cscope.out path as the prefix.
2506 See |cscoperelative|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002507 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002508
Bram Moolenaar071d4272004-06-13 20:20:40 +00002509 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
2510'cscopetag' 'cst' boolean (default off)
2511 global
2512 {not available when compiled without the |+cscope|
2513 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002514 Use cscope for tag commands. See |cscope-options|.
2515 NOTE: This option is reset when 'compatible' is set.
2516
2517 *'cscopetagorder'* *'csto'*
2518'cscopetagorder' 'csto' number (default 0)
2519 global
2520 {not available when compiled without the |+cscope|
2521 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002522 Determines the order in which ":cstag" performs a search. See
2523 |cscopetagorder|.
2524 NOTE: This option is set to 0 when 'compatible' is set.
2525
2526 *'cscopeverbose'* *'csverb'*
2527 *'nocscopeverbose'* *'nocsverb'*
2528'cscopeverbose' 'csverb' boolean (default off)
2529 global
2530 {not available when compiled without the |+cscope|
2531 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002532 Give messages when adding a cscope database. See |cscopeverbose|.
2533 NOTE: This option is reset when 'compatible' is set.
2534
Bram Moolenaar860cae12010-06-05 23:22:07 +02002535 *'cursorbind'* *'crb'* *'nocursorbind'* *'nocrb'*
2536'cursorbind' 'crb' boolean (default off)
2537 local to window
Bram Moolenaar860cae12010-06-05 23:22:07 +02002538 When this option is set, as the cursor in the current
2539 window moves other cursorbound windows (windows that also have
2540 this option set) move their cursors to the corresponding line and
2541 column. This option is useful for viewing the
2542 differences between two versions of a file (see 'diff'); in diff mode,
2543 inserted and deleted lines (though not characters within a line) are
Bram Moolenaar1a384422010-07-14 19:53:30 +02002544 taken into account.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002545
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002546
2547 *'cursorcolumn'* *'cuc'* *'nocursorcolumn'* *'nocuc'*
2548'cursorcolumn' 'cuc' boolean (default off)
2549 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02002550 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002551 feature}
2552 Highlight the screen column of the cursor with CursorColumn
2553 |hl-CursorColumn|. Useful to align text. Will make screen redrawing
2554 slower.
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00002555 If you only want the highlighting in the current window you can use
2556 these autocommands: >
2557 au WinLeave * set nocursorline nocursorcolumn
2558 au WinEnter * set cursorline cursorcolumn
2559<
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002560
2561 *'cursorline'* *'cul'* *'nocursorline'* *'nocul'*
2562'cursorline' 'cul' boolean (default off)
2563 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02002564 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002565 feature}
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002566 Highlight the text line of the cursor with CursorLine |hl-CursorLine|.
2567 Useful to easily spot the cursor. Will make screen redrawing slower.
Bram Moolenaare2f98b92006-03-29 21:18:24 +00002568 When Visual mode is active the highlighting isn't used to make it
Bram Moolenaar779b74b2006-04-10 14:55:34 +00002569 easier to see the selected text.
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002570
2571
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002572 *'cursorlineopt'* *'culopt'*
Bram Moolenaar017ba072019-09-14 21:01:23 +02002573'cursorlineopt' 'culopt' string (default: "number,line")
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002574 local to window
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002575 {not available when compiled without the |+syntax|
2576 feature}
Bram Moolenaar017ba072019-09-14 21:01:23 +02002577 Comma separated list of settings for how 'cursorline' is displayed.
2578 Valid values:
2579 "line" Highlight the text line of the cursor with
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002580 CursorLine |hl-CursorLine|.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002581 "screenline" Highlight only the screen line of the cursor with
2582 CursorLine |hl-CursorLine|.
2583 "number" Highlight the line number of the cursor with
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002584 CursorLineNr |hl-CursorLineNr|.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002585
2586 Special value:
2587 "both" Alias for the values "line,number".
2588
2589 "line" and "screenline" cannot be used together.
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002590
2591
Bram Moolenaar071d4272004-06-13 20:20:40 +00002592 *'debug'*
2593'debug' string (default "")
2594 global
Bram Moolenaar57657d82006-04-21 22:12:41 +00002595 These values can be used:
2596 msg Error messages that would otherwise be omitted will be given
2597 anyway.
2598 throw Error messages that would otherwise be omitted will be given
2599 anyway and also throw an exception and set |v:errmsg|.
2600 beep A message will be given when otherwise only a beep would be
2601 produced.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002602 The values can be combined, separated by a comma.
Bram Moolenaar57657d82006-04-21 22:12:41 +00002603 "msg" and "throw" are useful for debugging 'foldexpr', 'formatexpr' or
2604 'indentexpr'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002605
2606 *'define'* *'def'*
2607'define' 'def' string (default "^\s*#\s*define")
2608 global or local to buffer |global-local|
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002609 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002610 pattern, just like for the "/" command. This option is used for the
2611 commands like "[i" and "[d" |include-search|. The 'isident' option is
2612 used to recognize the defined name after the match:
2613 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2614 See |option-backslash| about inserting backslashes to include a space
2615 or backslash.
2616 The default value is for C programs. For C++ this value would be
2617 useful, to include const type declarations: >
2618 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
Bram Moolenaar63b74a82019-03-24 15:09:13 +01002619< You can also use "\ze" just before the name and continue the pattern
2620 to check what is following. E.g. for Javascript, if a function is
2621 defined with "func_name = function(args)": >
2622 ^\s*\ze\i\+\s*=\s*function(
2623< If the function is defined with "func_name : function() {...": >
2624 ^\s*\ze\i\+\s*[:]\s*(*function\s*(
Bram Moolenaar071d4272004-06-13 20:20:40 +00002625< When using the ":set" command, you need to double the backslashes!
Bram Moolenaar63b74a82019-03-24 15:09:13 +01002626 To avoid that use `:let` with a single quote string: >
2627 let &l:define = '^\s*\ze\k\+\s*=\s*function('
Bram Moolenaar911ead12019-04-21 00:03:35 +02002628<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002629
2630 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2631'delcombine' 'deco' boolean (default off)
2632 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002633 If editing Unicode and this option is set, backspace and Normal mode
2634 "x" delete each combining character on its own. When it is off (the
2635 default) the character along with its combining characters are
2636 deleted.
Bram Moolenaar4f4d51a2020-10-11 13:57:40 +02002637 Note: When 'delcombine' is set "xx" may work differently from "2x"!
Bram Moolenaar071d4272004-06-13 20:20:40 +00002638
2639 This is useful for Arabic, Hebrew and many other languages where one
2640 may have combining characters overtop of base characters, and want
2641 to remove only the combining ones.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002642 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002643
2644 *'dictionary'* *'dict'*
2645'dictionary' 'dict' string (default "")
2646 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002647 List of file names, separated by commas, that are used to lookup words
2648 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2649 contain a list of words. This can be one word per line, or several
2650 words per line, separated by non-keyword characters (white space is
2651 preferred). Maximum line length is 510 bytes.
Bram Moolenaar259f26a2018-05-15 22:25:40 +02002652
2653 When this option is empty or an entry "spell" is present, and spell
2654 checking is enabled, words in the word lists for the currently active
2655 'spelllang' are used. See |spell|.
2656
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002657 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002658 after a comma are ignored, otherwise spaces are included in the file
2659 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002660 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002661 Where to find a list of words?
2662 - On FreeBSD, there is the file "/usr/share/dict/words".
2663 - In the Simtel archive, look in the "msdos/linguist" directory.
2664 - In "miscfiles" of the GNU collection.
2665 The use of |:set+=| and |:set-=| is preferred when adding or removing
2666 directories from the list. This avoids problems when a future version
2667 uses another default.
2668 Backticks cannot be used in this option for security reasons.
2669
2670 *'diff'* *'nodiff'*
2671'diff' boolean (default off)
2672 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00002673 {not available when compiled without the |+diff|
2674 feature}
2675 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002676 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002677
2678 *'dex'* *'diffexpr'*
2679'diffexpr' 'dex' string (default "")
2680 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002681 {not available when compiled without the |+diff|
2682 feature}
Bram Moolenaare828b762018-09-10 17:51:58 +02002683 Expression which is evaluated to obtain a diff file (either ed-style
2684 or unified-style) from two versions of a file. See |diff-diffexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002685 This option cannot be set from a |modeline| or in the |sandbox|, for
2686 security reasons.
2687
2688 *'dip'* *'diffopt'*
Bram Moolenaarc8234772019-11-10 21:00:27 +01002689'diffopt' 'dip' string (default "internal,filler,closeoff")
Bram Moolenaar071d4272004-06-13 20:20:40 +00002690 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002691 {not available when compiled without the |+diff|
2692 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002693 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002694 All are optional. Items must be separated by a comma.
2695
2696 filler Show filler lines, to keep the text
2697 synchronized with a window that has inserted
2698 lines at the same position. Mostly useful
2699 when windows are side-by-side and 'scrollbind'
2700 is set.
2701
2702 context:{n} Use a context of {n} lines between a change
2703 and a fold that contains unchanged lines.
2704 When omitted a context of six lines is used.
Bram Moolenaarf6b40102019-02-22 15:24:03 +01002705 When using zero the context is actually one,
2706 since folds require a line in between, also
2707 for a deleted line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002708 See |fold-diff|.
2709
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002710 iblank Ignore changes where lines are all blank. Adds
2711 the "-B" flag to the "diff" command if
2712 'diffexpr' is empty. Check the documentation
2713 of the "diff" command for what this does
2714 exactly.
2715 NOTE: the diff windows will get out of sync,
2716 because no differences between blank lines are
2717 taken into account.
2718
Bram Moolenaar071d4272004-06-13 20:20:40 +00002719 icase Ignore changes in case of text. "a" and "A"
2720 are considered the same. Adds the "-i" flag
2721 to the "diff" command if 'diffexpr' is empty.
2722
2723 iwhite Ignore changes in amount of white space. Adds
2724 the "-b" flag to the "diff" command if
2725 'diffexpr' is empty. Check the documentation
2726 of the "diff" command for what this does
2727 exactly. It should ignore adding trailing
2728 white space, but not leading white space.
2729
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002730 iwhiteall Ignore all white space changes. Adds
2731 the "-w" flag to the "diff" command if
2732 'diffexpr' is empty. Check the documentation
2733 of the "diff" command for what this does
2734 exactly.
2735
2736 iwhiteeol Ignore white space changes at end of line.
2737 Adds the "-Z" flag to the "diff" command if
2738 'diffexpr' is empty. Check the documentation
2739 of the "diff" command for what this does
2740 exactly.
2741
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002742 horizontal Start diff mode with horizontal splits (unless
2743 explicitly specified otherwise).
2744
2745 vertical Start diff mode with vertical splits (unless
2746 explicitly specified otherwise).
2747
Bram Moolenaarc8234772019-11-10 21:00:27 +01002748 closeoff When a window is closed where 'diff' is set
2749 and there is only one window remaining in the
2750 same tab page with 'diff' set, execute
2751 `:diffoff` in that window. This undoes a
2752 `:diffsplit` command.
2753
Bram Moolenaar97ce4192017-12-01 20:35:58 +01002754 hiddenoff Do not use diff mode for a buffer when it
2755 becomes hidden.
2756
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002757 foldcolumn:{n} Set the 'foldcolumn' option to {n} when
2758 starting diff mode. Without this 2 is used.
2759
Bram Moolenaar4223d432021-02-10 13:18:17 +01002760 followwrap Follow the 'wrap' option and leave as it is.
2761
Bram Moolenaare828b762018-09-10 17:51:58 +02002762 internal Use the internal diff library. This is
2763 ignored when 'diffexpr' is set. *E960*
2764 When running out of memory when writing a
2765 buffer this item will be ignored for diffs
2766 involving that buffer. Set the 'verbose'
2767 option to see when this happens.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002768
Bram Moolenaare828b762018-09-10 17:51:58 +02002769 indent-heuristic
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01002770 Use the indent heuristic for the internal
2771 diff library.
Bram Moolenaare828b762018-09-10 17:51:58 +02002772
2773 algorithm:{text} Use the specified diff algorithm with the
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01002774 internal diff engine. Currently supported
Bram Moolenaare828b762018-09-10 17:51:58 +02002775 algorithms are:
2776 myers the default algorithm
2777 minimal spend extra time to generate the
2778 smallest possible diff
2779 patience patience diff algorithm
2780 histogram histogram diff algorithm
2781
2782 Examples: >
2783 :set diffopt=internal,filler,context:4
Bram Moolenaar071d4272004-06-13 20:20:40 +00002784 :set diffopt=
Bram Moolenaare828b762018-09-10 17:51:58 +02002785 :set diffopt=internal,filler,foldcolumn:3
2786 :set diffopt-=internal " do NOT use the internal diff parser
Bram Moolenaar071d4272004-06-13 20:20:40 +00002787<
2788 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
2789'digraph' 'dg' boolean (default off)
2790 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002791 {not available when compiled without the |+digraphs|
2792 feature}
2793 Enable the entering of digraphs in Insert mode with {char1} <BS>
2794 {char2}. See |digraphs|.
2795 NOTE: This option is reset when 'compatible' is set.
2796
2797 *'directory'* *'dir'*
2798'directory' 'dir' string (default for Amiga: ".,t:",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01002799 for Win32: ".,$TEMP,c:\tmp,c:\temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00002800 for Unix: ".,~/tmp,/var/tmp,/tmp")
2801 global
2802 List of directory names for the swap file, separated with commas.
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02002803 Recommended value: ".,~/vimswap//" - this will put the swap file next
2804 to the edited file if possible, and in your personal swap directory
2805 otherwise. Make sure "~/vimswap//" is only readable for you.
2806
2807 Possible items:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002808 - The swap file will be created in the first directory where this is
2809 possible.
2810 - Empty means that no swap file will be used (recovery is
Bram Moolenaar00e192b2019-10-19 17:01:28 +02002811 impossible!) and no |E303| error will be given.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002812 - A directory "." means to put the swap file in the same directory as
2813 the edited file. On Unix, a dot is prepended to the file name, so
2814 it doesn't show in a directory listing. On MS-Windows the "hidden"
2815 attribute is set and a dot prepended if possible.
Bram Moolenaar8024f932020-01-14 19:29:13 +01002816 - A directory starting with "./" (or ".\" for MS-Windows) means to put
2817 the swap file relative to where the edited file is. The leading "."
2818 is replaced with the path name of the edited file.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02002819 - For Unix and Win32, if a directory ends in two path separators "//",
2820 the swap file name will be built from the complete path to the file
Bram Moolenaar207f0092020-08-30 17:20:20 +02002821 with all path separators replaced by percent '%' signs (including
2822 the colon following the drive letter on Win32). This will ensure
2823 file name uniqueness in the preserve directory.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02002824 On Win32, it is also possible to end with "\\". However, When a
2825 separating comma is following, you must use "//", since "\\" will
2826 include the comma in the file name. Therefore it is recommended to
2827 use '//', instead of '\\'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002828 - Spaces after the comma are ignored, other spaces are considered part
2829 of the directory name. To have a space at the start of a directory
2830 name, precede it with a backslash.
2831 - To include a comma in a directory name precede it with a backslash.
2832 - A directory name may end in an ':' or '/'.
2833 - Environment variables are expanded |:set_env|.
2834 - Careful with '\' characters, type one before a space, type two to
2835 get one in the option (see |option-backslash|), for example: >
2836 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
2837< - For backwards compatibility with Vim version 3.0 a '>' at the start
2838 of the option is removed.
2839 Using "." first in the list is recommended. This means that editing
2840 the same file twice will result in a warning. Using "/tmp" on Unix is
2841 discouraged: When the system crashes you lose the swap file.
2842 "/var/tmp" is often not cleared when rebooting, thus is a better
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02002843 choice than "/tmp". But others on the computer may be able to see the
2844 files, and it can contain a lot of files, your swap files get lost in
2845 the crowd. That is why a "tmp" directory in your home directory is
2846 tried first.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002847 The use of |:set+=| and |:set-=| is preferred when adding or removing
2848 directories from the list. This avoids problems when a future version
2849 uses another default.
2850 This option cannot be set from a |modeline| or in the |sandbox|, for
2851 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002852
2853 *'display'* *'dy'*
Bram Moolenaarbc8801c2016-08-02 21:04:33 +02002854'display' 'dy' string (default "", set to "truncate" in
2855 |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002856 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002857 Change the way text is displayed. This is comma separated list of
2858 flags:
2859 lastline When included, as much as possible of the last line
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02002860 in a window will be displayed. "@@@" is put in the
2861 last columns of the last screen line to indicate the
2862 rest of the line is not displayed.
2863 truncate Like "lastline", but "@@@" is displayed in the first
2864 column of the last screen line. Overrules "lastline".
Bram Moolenaar071d4272004-06-13 20:20:40 +00002865 uhex Show unprintable characters hexadecimal as <xx>
2866 instead of using ^C and ~C.
2867
Bram Moolenaard0796902016-09-16 20:02:31 +02002868 When neither "lastline" nor "truncate" is included, a last line that
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02002869 doesn't fit is replaced with "@" lines.
2870
Bram Moolenaar071d4272004-06-13 20:20:40 +00002871 *'eadirection'* *'ead'*
2872'eadirection' 'ead' string (default "both")
2873 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002874 Tells when the 'equalalways' option applies:
2875 ver vertically, width of windows is not affected
2876 hor horizontally, height of windows is not affected
2877 both width and height of windows is affected
2878
2879 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
2880'edcompatible' 'ed' boolean (default off)
2881 global
2882 Makes the 'g' and 'c' flags of the ":substitute" command to be
2883 toggled each time the flag is given. See |complex-change|. See
2884 also 'gdefault' option.
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +02002885 Switching this option on may break plugins!
Bram Moolenaar4072ba52020-12-23 13:56:35 +01002886 This option is not used in |Vim9| script.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002887
Bram Moolenaar03413f42016-04-12 21:07:15 +02002888 *'emoji'* *'emo'* *'noemoji'* *'noemo'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01002889'emoji' 'emo' boolean (default: on)
2890 global
Bram Moolenaar3848e002016-03-19 18:42:29 +01002891 When on all Unicode emoji characters are considered to be full width.
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02002892 This excludes "text emoji" characters, which are normally displayed as
2893 single width. Unfortunately there is no good specification for this
2894 and it has been determined on trial-and-error basis. Use the
2895 |setcellwidths()| function to change the behavior.
Bram Moolenaar3848e002016-03-19 18:42:29 +01002896
Bram Moolenaar071d4272004-06-13 20:20:40 +00002897 *'encoding'* *'enc'* *E543*
K.Takataf883d902021-05-30 18:04:19 +02002898'encoding' 'enc' string (default for MS-Windows: "utf-8",
2899 otherwise: value from $LANG or "latin1")
Bram Moolenaar071d4272004-06-13 20:20:40 +00002900 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002901 Sets the character encoding used inside Vim. It applies to text in
2902 the buffers, registers, Strings in expressions, text stored in the
2903 viminfo file, etc. It sets the kind of characters which Vim can work
2904 with. See |encoding-names| for the possible values.
2905
2906 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002907 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002908 It should normally be kept at its default value, or set when Vim
Bram Moolenaar02467872007-05-06 13:22:01 +00002909 starts up. See |multibyte|. To reload the menus see |:menutrans|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002910
Bram Moolenaar865242e2010-07-14 21:12:05 +02002911 This option cannot be set from a |modeline|. It would most likely
2912 corrupt the text.
2913
Bram Moolenaar3df01732017-02-17 22:47:16 +01002914 NOTE: For GTK+ 2 or later, it is highly recommended to set 'encoding'
2915 to "utf-8". Although care has been taken to allow different values of
Bram Moolenaar071d4272004-06-13 20:20:40 +00002916 'encoding', "utf-8" is the natural choice for the environment and
2917 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002918 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00002919 versions, and to avoid changing the encoding of newly created files
2920 without your knowledge (in case 'fileencodings' is empty).
2921
2922 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002923 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00002924 iconv() or as specified with 'charconvert'.
2925
Bram Moolenaar207f0092020-08-30 17:20:20 +02002926 If you need to know whether 'encoding' is a multibyte encoding, you
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002927 can use: >
2928 if has("multi_byte_encoding")
2929<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002930 Normally 'encoding' will be equal to your current locale. This will
2931 be the default if Vim recognizes your environment settings. If
2932 'encoding' is not set to the current locale, 'termencoding' must be
2933 set to convert typed and displayed text. See |encoding-table|.
2934
2935 When you set this option, it fires the |EncodingChanged| autocommand
2936 event so that you can set up fonts if necessary.
2937
2938 When the option is set, the value is converted to lowercase. Thus
2939 you can set it with uppercase values too. Underscores are translated
2940 to '-' signs.
2941 When the encoding is recognized, it is changed to the standard name.
2942 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
2943 "iso-8859-2" and "utf8" becomes "utf-8".
2944
2945 Note: "latin1" is also used when the encoding could not be detected.
2946 This only works when editing files in the same encoding! When the
2947 actual character set is not latin1, make sure 'fileencoding' and
2948 'fileencodings' are empty. When conversion is needed, switch to using
2949 utf-8.
2950
2951 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
2952 You don't notice this while editing, but it does matter for the
2953 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
2954 setting 'encoding' to one of these values instead of utf-8 only has
2955 effect for encoding used for files when 'fileencoding' is empty.
2956
Bram Moolenaar661b1822005-07-28 22:36:45 +00002957 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
2958 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002959
2960 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
2961'endofline' 'eol' boolean (default on)
2962 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002963 When writing a file and this option is off and the 'binary' option
Bram Moolenaar34d72d42015-07-17 14:18:08 +02002964 is on, or 'fixeol' option is off, no <EOL> will be written for the
2965 last line in the file. This option is automatically set or reset when
2966 starting to edit a new file, depending on whether file has an <EOL>
2967 for the last line in the file. Normally you don't have to set or
2968 reset this option.
2969 When 'binary' is off and 'fixeol' is on the value is not used when
2970 writing the file. When 'binary' is on or 'fixeol' is off it is used
2971 to remember the presence of a <EOL> for the last line in the file, so
2972 that when you write the file the situation from the original file can
2973 be kept. But you can change it if you want to.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002974
2975 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
2976'equalalways' 'ea' boolean (default on)
2977 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002978 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00002979 splitting or closing a window. This also happens the moment the
2980 option is switched on. When off, splitting a window will reduce the
2981 size of the current window and leave the other windows the same. When
2982 closing a window the extra lines are given to the window next to it
2983 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00002984 When mixing vertically and horizontally split windows, a minimal size
2985 is computed and some windows may be larger if there is room. The
2986 'eadirection' option tells in which direction the size is affected.
Bram Moolenaar67f71312007-08-12 14:55:56 +00002987 Changing the height and width of a window can be avoided by setting
2988 'winfixheight' and 'winfixwidth', respectively.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002989 If a window size is specified when creating a new window sizes are
2990 currently not equalized (it's complicated, but may be implemented in
2991 the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002992
2993 *'equalprg'* *'ep'*
2994'equalprg' 'ep' string (default "")
2995 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002996 External program to use for "=" command. When this option is empty
Bram Moolenaar446cb832008-06-24 21:56:24 +00002997 the internal formatting functions are used; either 'lisp', 'cindent'
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002998 or 'indentexpr'. When Vim was compiled without internal formatting,
2999 the "indent" program is used.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003000 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003001 about including spaces and backslashes.
3002 This option cannot be set from a |modeline| or in the |sandbox|, for
3003 security reasons.
3004
3005 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
3006'errorbells' 'eb' boolean (default off)
3007 global
3008 Ring the bell (beep or screen flash) for error messages. This only
3009 makes a difference for error messages, the bell will be used always
3010 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003011 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar165bc692015-07-21 17:53:25 +02003012 screen flash or do nothing. See 'belloff' to finetune when to ring the
3013 bell.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003014
3015 *'errorfile'* *'ef'*
3016'errorfile' 'ef' string (Amiga default: "AztecC.Err",
3017 others: "errors.err")
3018 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003019 {not available when compiled without the |+quickfix|
3020 feature}
3021 Name of the errorfile for the QuickFix mode (see |:cf|).
3022 When the "-q" command-line argument is used, 'errorfile' is set to the
3023 following argument. See |-q|.
3024 NOT used for the ":make" command. See 'makeef' for that.
3025 Environment variables are expanded |:set_env|.
3026 See |option-backslash| about including spaces and backslashes.
3027 This option cannot be set from a |modeline| or in the |sandbox|, for
3028 security reasons.
3029
3030 *'errorformat'* *'efm'*
3031'errorformat' 'efm' string (default is very long)
3032 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003033 {not available when compiled without the |+quickfix|
3034 feature}
3035 Scanf-like description of the format for the lines in the error file
3036 (see |errorformat|).
3037
3038 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
3039'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
3040 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003041 Function keys that start with an <Esc> are recognized in Insert
3042 mode. When this option is off, the cursor and function keys cannot be
3043 used in Insert mode if they start with an <Esc>. The advantage of
3044 this is that the single <Esc> is recognized immediately, instead of
3045 after one second. Instead of resetting this option, you might want to
3046 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
3047 when 'esckeys' is off, you can still map anything, but the cursor keys
3048 won't work by default.
3049 NOTE: This option is set to the Vi default value when 'compatible' is
3050 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaarc8234772019-11-10 21:00:27 +01003051 NOTE: when this option is off then the |modifyOtherKeys| functionality
3052 is disabled while in Insert mode to avoid ending Insert mode with any
3053 key that has a modifier.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003054
3055 *'eventignore'* *'ei'*
3056'eventignore' 'ei' string (default "")
3057 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003058 A list of autocommand event names, which are to be ignored.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00003059 When set to "all" or when "all" is one of the items, all autocommand
3060 events are ignored, autocommands will not be executed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003061 Otherwise this is a comma separated list of event names. Example: >
3062 :set ei=WinEnter,WinLeave
3063<
3064 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
3065'expandtab' 'et' boolean (default off)
3066 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003067 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003068 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00003069 when 'autoindent' is on. To insert a real tab when 'expandtab' is
3070 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
Bram Moolenaarca635012015-09-25 20:34:21 +02003071 This option is reset when the 'paste' option is set and restored when
3072 the 'paste' option is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003073 NOTE: This option is reset when 'compatible' is set.
3074
3075 *'exrc'* *'ex'* *'noexrc'* *'noex'*
3076'exrc' 'ex' boolean (default off)
3077 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003078 Enables the reading of .vimrc, .exrc and .gvimrc in the current
Bram Moolenaar36f44c22016-08-28 18:17:20 +02003079 directory.
3080
3081 Setting this option is a potential security leak. E.g., consider
3082 unpacking a package or fetching files from github, a .vimrc in there
3083 might be a trojan horse. BETTER NOT SET THIS OPTION!
3084 Instead, define an autocommand in your .vimrc to set options for a
3085 matching directory.
3086
3087 If you do switch this option on you should also consider setting the
3088 'secure' option (see |initialization|).
3089 Also see |.vimrc| and |gui-init|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003090 This option cannot be set from a |modeline| or in the |sandbox|, for
3091 security reasons.
3092
3093 *'fileencoding'* *'fenc'* *E213*
3094'fileencoding' 'fenc' string (default: "")
3095 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003096 Sets the character encoding for the file of this buffer.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003097
Bram Moolenaar071d4272004-06-13 20:20:40 +00003098 When 'fileencoding' is different from 'encoding', conversion will be
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003099 done when writing the file. For reading see below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003100 When 'fileencoding' is empty, the same value as 'encoding' will be
3101 used (no conversion when reading or writing a file).
Bram Moolenaar214641f2017-03-05 17:04:09 +01003102 No error will be given when the value is set, only when it is used,
3103 only when writing a file.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003104 Conversion will also be done when 'encoding' and 'fileencoding' are
3105 both a Unicode encoding and 'fileencoding' is not utf-8. That's
3106 because internally Unicode is always stored as utf-8.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003107 WARNING: Conversion can cause loss of information! When
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003108 'encoding' is "utf-8" or another Unicode encoding, conversion
3109 is most likely done in a way that the reverse conversion
3110 results in the same text. When 'encoding' is not "utf-8" some
3111 characters may be lost!
Bram Moolenaar865242e2010-07-14 21:12:05 +02003112
Bram Moolenaar071d4272004-06-13 20:20:40 +00003113 See 'encoding' for the possible values. Additionally, values may be
3114 specified that can be handled by the converter, see
3115 |mbyte-conversion|.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003116
Bram Moolenaar071d4272004-06-13 20:20:40 +00003117 When reading a file 'fileencoding' will be set from 'fileencodings'.
3118 To read a file in a certain encoding it won't work by setting
Bram Moolenaar02467872007-05-06 13:22:01 +00003119 'fileencoding', use the |++enc| argument. One exception: when
3120 'fileencodings' is empty the value of 'fileencoding' is used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003121 For a new file the global value of 'fileencoding' is used.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003122
Bram Moolenaar071d4272004-06-13 20:20:40 +00003123 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
3124 When the option is set, the value is converted to lowercase. Thus
3125 you can set it with uppercase values too. '_' characters are
3126 replaced with '-'. If a name is recognized from the list for
3127 'encoding', it is replaced by the standard name. For example
3128 "ISO8859-2" becomes "iso-8859-2".
Bram Moolenaar865242e2010-07-14 21:12:05 +02003129
Bram Moolenaar071d4272004-06-13 20:20:40 +00003130 When this option is set, after starting to edit a file, the 'modified'
3131 option is set, because the file would be different when written.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003132
3133 Keep in mind that changing 'fenc' from a modeline happens
3134 AFTER the text has been read, thus it applies to when the file will be
3135 written. If you do set 'fenc' in a modeline, you might want to set
3136 'nomodified' to avoid not being able to ":q".
3137
Bram Moolenaar071d4272004-06-13 20:20:40 +00003138 This option can not be changed when 'modifiable' is off.
3139
3140 *'fe'*
3141 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003142 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003143 old short name was 'fe', which is no longer used.
3144
3145 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003146'fileencodings' 'fencs' string (default: "ucs-bom",
3147 "ucs-bom,utf-8,default,latin1" when
3148 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003149 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003150 This is a list of character encodings considered when starting to edit
3151 an existing file. When a file is read, Vim tries to use the first
3152 mentioned character encoding. If an error is detected, the next one
3153 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003154 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00003155 an empty string, which means the value of 'encoding' is used.
3156 WARNING: Conversion can cause loss of information! When
3157 'encoding' is "utf-8" (or one of the other Unicode variants)
3158 conversion is most likely done in a way that the reverse
3159 conversion results in the same text. When 'encoding' is not
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003160 "utf-8" some non-ASCII characters may be lost! You can use
3161 the |++bad| argument to specify what is done with characters
3162 that can't be converted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003163 For an empty file or a file with only ASCII characters most encodings
3164 will work and the first entry of 'fileencodings' will be used (except
3165 "ucs-bom", which requires the BOM to be present). If you prefer
3166 another encoding use an BufReadPost autocommand event to test if your
3167 preferred encoding is to be used. Example: >
3168 au BufReadPost * if search('\S', 'w') == 0 |
3169 \ set fenc=iso-2022-jp | endif
3170< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
3171 non-blank characters.
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003172 When the |++enc| argument is used then the value of 'fileencodings' is
3173 not used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003174 Note that 'fileencodings' is not used for a new file, the global value
3175 of 'fileencoding' is used instead. You can set it with: >
3176 :setglobal fenc=iso-8859-2
3177< This means that a non-existing file may get a different encoding than
3178 an empty file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003179 The special value "ucs-bom" can be used to check for a Unicode BOM
3180 (Byte Order Mark) at the start of the file. It must not be preceded
3181 by "utf-8" or another Unicode encoding for this to work properly.
3182 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
3183 because Vim cannot detect an error, thus the encoding is always
3184 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003185 The special value "default" can be used for the encoding from the
K.Takataef8706f2021-05-31 18:40:49 +02003186 environment. On MS-Windows this is the system encoding. Otherwise
3187 this is the default value for 'encoding'. It is useful when
3188 'encoding' is set to "utf-8" and your environment uses a non-latin1
3189 encoding, such as Russian.
Bram Moolenaarca003e12006-03-17 23:19:38 +00003190 When 'encoding' is "utf-8" and a file contains an illegal byte
3191 sequence it won't be recognized as UTF-8. You can use the |8g8|
3192 command to find the illegal byte sequence.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003193 WRONG VALUES: WHAT'S WRONG:
3194 latin1,utf-8 "latin1" will always be used
3195 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
3196 file
3197 cp1250,latin1 "cp1250" will always be used
3198 If 'fileencodings' is empty, 'fileencoding' is not modified.
3199 See 'fileencoding' for the possible values.
3200 Setting this option does not have an effect until the next time a file
3201 is read.
3202
3203 *'fileformat'* *'ff'*
Bram Moolenaar00590742019-02-15 21:06:09 +01003204'fileformat' 'ff' string (MS-Windows default: "dos",
3205 Unix, macOS default: "unix")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003206 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003207 This gives the <EOL> of the current buffer, which is used for
3208 reading/writing the buffer from/to a file:
Bram Moolenaar4072ba52020-12-23 13:56:35 +01003209 dos <CR><NL>
Bram Moolenaar071d4272004-06-13 20:20:40 +00003210 unix <NL>
3211 mac <CR>
3212 When "dos" is used, CTRL-Z at the end of a file is ignored.
3213 See |file-formats| and |file-read|.
3214 For the character encoding of the file see 'fileencoding'.
3215 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
Bram Moolenaarbf884932013-04-05 22:26:15 +02003216 works like it was set to "unix".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003217 This option is set automatically when starting to edit a file and
3218 'fileformats' is not empty and 'binary' is off.
3219 When this option is set, after starting to edit a file, the 'modified'
3220 option is set, because the file would be different when written.
3221 This option can not be changed when 'modifiable' is off.
3222 For backwards compatibility: When this option is set to "dos",
3223 'textmode' is set, otherwise 'textmode' is reset.
3224
3225 *'fileformats'* *'ffs'*
3226'fileformats' 'ffs' string (default:
Bram Moolenaar00590742019-02-15 21:06:09 +01003227 Vim+Vi MS-Windows: "dos,unix",
3228 Vim Unix, macOS: "unix,dos",
Bram Moolenaar071d4272004-06-13 20:20:40 +00003229 Vi Cygwin: "unix,dos",
3230 Vi others: "")
3231 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003232 This gives the end-of-line (<EOL>) formats that will be tried when
3233 starting to edit a new buffer and when reading a file into an existing
3234 buffer:
3235 - When empty, the format defined with 'fileformat' will be used
3236 always. It is not set automatically.
3237 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003238 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003239 'fileformats' name will be used when a file is read into an existing
3240 buffer, no matter what 'fileformat' for that buffer is set to.
3241 - When more than one name is present, separated by commas, automatic
3242 <EOL> detection will be done when reading a file. When starting to
3243 edit a file, a check is done for the <EOL>:
3244 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
3245 'fileformat' is set to "dos".
3246 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003247 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003248 preceding <CR>, "unix" is preferred over "dos".
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01003249 3. If 'fileformat' has not yet been set, and if a <CR> is found, and
3250 if 'fileformats' includes "mac", 'fileformat' is set to "mac".
Bram Moolenaar00659062010-09-21 22:34:02 +02003251 This means that "mac" is only chosen when:
3252 "unix" is not present or no <NL> is found in the file, and
3253 "dos" is not present or no <CR><NL> is found in the file.
3254 Except: if "unix" was chosen, but there is a <CR> before
3255 the first <NL>, and there appear to be more <CR>s than <NL>s in
Bram Moolenaar166af9b2010-11-16 20:34:40 +01003256 the first few lines, "mac" is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003257 4. If 'fileformat' is still not set, the first name from
3258 'fileformats' is used.
3259 When reading a file into an existing buffer, the same is done, but
3260 this happens like 'fileformat' has been set appropriately for that
3261 file only, the option is not changed.
3262 When 'binary' is set, the value of 'fileformats' is not used.
3263
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01003264 When Vim starts up with an empty buffer the first item is used. You
3265 can overrule this by setting 'fileformat' in your .vimrc.
Bram Moolenaar81af9252010-12-10 20:35:50 +01003266
Bram Moolenaar071d4272004-06-13 20:20:40 +00003267 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
3268 are ":source"ed and for vimrc files, automatic <EOL> detection may be
3269 done:
3270 - When 'fileformats' is empty, there is no automatic detection. Dos
3271 format will be used.
3272 - When 'fileformats' is set to one or more names, automatic detection
3273 is done. This is based on the first <NL> in the file: If there is a
3274 <CR> in front of it, Dos format is used, otherwise Unix format is
3275 used.
3276 Also see |file-formats|.
3277 For backwards compatibility: When this option is set to an empty
3278 string or one format (no comma is included), 'textauto' is reset,
3279 otherwise 'textauto' is set.
3280 NOTE: This option is set to the Vi default value when 'compatible' is
3281 set and to the Vim default value when 'compatible' is reset.
3282
Bram Moolenaarbf884932013-04-05 22:26:15 +02003283 *'fileignorecase'* *'fic'* *'nofileignorecase'* *'nofic'*
3284'fileignorecase' 'fic' boolean (default on for systems where case in file
3285 names is normally ignored)
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003286 global
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003287 When set case is ignored when using file names and directories.
3288 See 'wildignorecase' for only ignoring case when doing completion.
3289
Bram Moolenaar071d4272004-06-13 20:20:40 +00003290 *'filetype'* *'ft'*
3291'filetype' 'ft' string (default: "")
3292 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003293 When this option is set, the FileType autocommand event is triggered.
3294 All autocommands that match with the value of this option will be
3295 executed. Thus the value of 'filetype' is used in place of the file
3296 name.
3297 Otherwise this option does not always reflect the current file type.
3298 This option is normally set when the file type is detected. To enable
3299 this use the ":filetype on" command. |:filetype|
3300 Setting this option to a different value is most useful in a modeline,
3301 for a file for which the file type is not automatically recognized.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003302 Example, for in an IDL file:
3303 /* vim: set filetype=idl : */ ~
3304 |FileType| |filetypes|
3305 When a dot appears in the value then this separates two filetype
3306 names. Example:
3307 /* vim: set filetype=c.doxygen : */ ~
3308 This will use the "c" filetype first, then the "doxygen" filetype.
3309 This works both for filetype plugins and for syntax files. More than
3310 one dot may appear.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003311 This option is not copied to another buffer, independent of the 's' or
3312 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003313 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003314
3315 *'fillchars'* *'fcs'*
Bram Moolenaara98f8a22021-02-13 18:24:23 +01003316'fillchars' 'fcs' string (default "vert:|,fold:-,eob:~")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003317 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02003318 {not available when compiled without the |+folding|
3319 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003320 Characters to fill the statuslines and vertical separators.
3321 It is a comma separated list of items:
3322
3323 item default Used for ~
3324 stl:c ' ' or '^' statusline of the current window
Bram Moolenaar38a55632016-02-15 22:07:32 +01003325 stlnc:c ' ' or '=' statusline of the non-current windows
Bram Moolenaar071d4272004-06-13 20:20:40 +00003326 vert:c '|' vertical separators |:vsplit|
3327 fold:c '-' filling 'foldtext'
Bram Moolenaar3aca5a62021-02-17 13:14:07 +01003328 foldopen:c '-' mark the beginning of a fold
3329 foldclose:c '+' show a closed fold
3330 foldsep:c '|' open fold middle character
Bram Moolenaar071d4272004-06-13 20:20:40 +00003331 diff:c '-' deleted lines of the 'diff' option
Bram Moolenaara98f8a22021-02-13 18:24:23 +01003332 eob:c '~' empty lines below the end of a buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003333
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003334 Any one that is omitted will fall back to the default. For "stl" and
Bram Moolenaar38a55632016-02-15 22:07:32 +01003335 "stlnc" the space will be used when there is highlighting, '^' or '='
Bram Moolenaar071d4272004-06-13 20:20:40 +00003336 otherwise.
3337
3338 Example: >
Bram Moolenaar38a55632016-02-15 22:07:32 +01003339 :set fillchars=stl:^,stlnc:=,vert:\|,fold:-,diff:-
Bram Moolenaar071d4272004-06-13 20:20:40 +00003340< This is similar to the default, except that these characters will also
3341 be used when there is highlighting.
3342
Bram Moolenaar008bff92021-03-04 21:55:58 +01003343 For "stl" and "stlnc" single-byte and multibyte characters are
3344 supported. But double-width characters are not supported.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003345
Bram Moolenaar071d4272004-06-13 20:20:40 +00003346 The highlighting used for these items:
3347 item highlight group ~
3348 stl:c StatusLine |hl-StatusLine|
3349 stlnc:c StatusLineNC |hl-StatusLineNC|
3350 vert:c VertSplit |hl-VertSplit|
3351 fold:c Folded |hl-Folded|
3352 diff:c DiffDelete |hl-DiffDelete|
Bram Moolenaara98f8a22021-02-13 18:24:23 +01003353 eob:c EndOfBuffer |hl-EndOfBuffer|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003354
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003355 *'fixendofline'* *'fixeol'* *'nofixendofline'* *'nofixeol'*
3356'fixendofline' 'fixeol' boolean (default on)
3357 local to buffer
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003358 When writing a file and this option is on, <EOL> at the end of file
3359 will be restored if missing. Turn this option off if you want to
3360 preserve the situation from the original file.
3361 When the 'binary' option is set the value of this option doesn't
3362 matter.
3363 See the 'endofline' option.
3364
Bram Moolenaar071d4272004-06-13 20:20:40 +00003365 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
Bram Moolenaar98a29d02021-01-18 19:55:44 +01003366'fkmap' 'fk' boolean (default off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003367 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003368 {only available when compiled with the |+rightleft|
3369 feature}
Bram Moolenaar14184a32019-02-16 15:10:30 +01003370 This option was for using Farsi, which has been removed. See
3371 |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003372
3373 *'foldclose'* *'fcl'*
3374'foldclose' 'fcl' string (default "")
3375 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003376 {not available when compiled without the |+folding|
3377 feature}
3378 When set to "all", a fold is closed when the cursor isn't in it and
3379 its level is higher than 'foldlevel'. Useful if you want folds to
3380 automatically close when moving out of them.
3381
3382 *'foldcolumn'* *'fdc'*
3383'foldcolumn' 'fdc' number (default 0)
3384 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003385 {not available when compiled without the |+folding|
3386 feature}
3387 When non-zero, a column with the specified width is shown at the side
3388 of the window which indicates open and closed folds. The maximum
3389 value is 12.
3390 See |folding|.
3391
3392 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
3393'foldenable' 'fen' boolean (default on)
3394 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003395 {not available when compiled without the |+folding|
3396 feature}
3397 When off, all folds are open. This option can be used to quickly
3398 switch between showing all text unfolded and viewing the text with
3399 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003400 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00003401 'foldenable' is off.
3402 This option is set by commands that create a new fold or close a fold.
3403 See |folding|.
3404
3405 *'foldexpr'* *'fde'*
3406'foldexpr' 'fde' string (default: "0")
3407 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003408 {not available when compiled without the |+folding|
Bram Moolenaardb84e452010-08-15 13:50:43 +02003409 or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003410 The expression used for when 'foldmethod' is "expr". It is evaluated
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003411 for each line to obtain its fold level. See |fold-expr|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003412
Bram Moolenaar30b65812012-07-12 22:01:11 +02003413 The expression will be evaluated in the |sandbox| if set from a
3414 modeline, see |sandbox-option|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003415 This option can't be set from a |modeline| when the 'diff' option is
Bram Moolenaar110289e2019-05-23 15:38:06 +02003416 on or the 'modelineexpr' option is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003417
3418 It is not allowed to change text or jump to another window while
3419 evaluating 'foldexpr' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003420
3421 *'foldignore'* *'fdi'*
3422'foldignore' 'fdi' string (default: "#")
3423 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003424 {not available when compiled without the |+folding|
3425 feature}
3426 Used only when 'foldmethod' is "indent". Lines starting with
3427 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003428 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003429 The default "#" works well for C programs. See |fold-indent|.
3430
3431 *'foldlevel'* *'fdl'*
3432'foldlevel' 'fdl' number (default: 0)
3433 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003434 {not available when compiled without the |+folding|
3435 feature}
3436 Sets the fold level: Folds with a higher level will be closed.
3437 Setting this option to zero will close all folds. Higher numbers will
3438 close fewer folds.
3439 This option is set by commands like |zm|, |zM| and |zR|.
3440 See |fold-foldlevel|.
3441
3442 *'foldlevelstart'* *'fdls'*
3443'foldlevelstart' 'fdls' number (default: -1)
3444 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003445 {not available when compiled without the |+folding|
3446 feature}
3447 Sets 'foldlevel' when starting to edit another buffer in a window.
3448 Useful to always start editing with all folds closed (value zero),
3449 some folds closed (one) or no folds closed (99).
3450 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003451 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00003452 ignores this option and closes all folds.
3453 It is also done before BufReadPre autocommands, to allow an autocmd to
3454 overrule the 'foldlevel' value for specific files.
3455 When the value is negative, it is not used.
3456
3457 *'foldmarker'* *'fmr'* *E536*
3458'foldmarker' 'fmr' string (default: "{{{,}}}")
3459 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003460 {not available when compiled without the |+folding|
3461 feature}
3462 The start and end marker used when 'foldmethod' is "marker". There
3463 must be one comma, which separates the start and end marker. The
3464 marker is a literal string (a regular expression would be too slow).
3465 See |fold-marker|.
3466
3467 *'foldmethod'* *'fdm'*
3468'foldmethod' 'fdm' string (default: "manual")
3469 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003470 {not available when compiled without the |+folding|
3471 feature}
3472 The kind of folding used for the current window. Possible values:
3473 |fold-manual| manual Folds are created manually.
3474 |fold-indent| indent Lines with equal indent form a fold.
3475 |fold-expr| expr 'foldexpr' gives the fold level of a line.
3476 |fold-marker| marker Markers are used to specify folds.
3477 |fold-syntax| syntax Syntax highlighting items specify folds.
3478 |fold-diff| diff Fold text that is not changed.
3479
3480 *'foldminlines'* *'fml'*
3481'foldminlines' 'fml' number (default: 1)
3482 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003483 {not available when compiled without the |+folding|
3484 feature}
Bram Moolenaar00654022011-02-25 14:42:19 +01003485 Sets the number of screen lines above which a fold can be displayed
3486 closed. Also for manually closed folds. With the default value of
3487 one a fold can only be closed if it takes up two or more screen lines.
3488 Set to zero to be able to close folds of just one screen line.
Bram Moolenaar446beb42011-05-10 17:18:44 +02003489 Note that this only has an effect on what is displayed. After using
Bram Moolenaar071d4272004-06-13 20:20:40 +00003490 "zc" to close a fold, which is displayed open because it's smaller
3491 than 'foldminlines', a following "zc" may close a containing fold.
3492
3493 *'foldnestmax'* *'fdn'*
3494'foldnestmax' 'fdn' number (default: 20)
3495 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003496 {not available when compiled without the |+folding|
3497 feature}
3498 Sets the maximum nesting of folds for the "indent" and "syntax"
3499 methods. This avoids that too many folds will be created. Using more
3500 than 20 doesn't work, because the internal limit is 20.
3501
3502 *'foldopen'* *'fdo'*
3503'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
3504 search,tag,undo")
3505 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003506 {not available when compiled without the |+folding|
3507 feature}
3508 Specifies for which type of commands folds will be opened, if the
3509 command moves the cursor into a closed fold. It is a comma separated
3510 list of items.
Bram Moolenaar05365702010-10-27 18:34:44 +02003511 NOTE: When the command is part of a mapping this option is not used.
3512 Add the |zv| command to the mapping to get the same effect.
3513 (rationale: the mapping may want to control opening folds itself)
3514
Bram Moolenaar071d4272004-06-13 20:20:40 +00003515 item commands ~
3516 all any
3517 block "(", "{", "[[", "[{", etc.
3518 hor horizontal movements: "l", "w", "fx", etc.
3519 insert any command in Insert mode
3520 jump far jumps: "G", "gg", etc.
3521 mark jumping to a mark: "'m", CTRL-O, etc.
3522 percent "%"
3523 quickfix ":cn", ":crew", ":make", etc.
3524 search search for a pattern: "/", "n", "*", "gd", etc.
3525 (not for a search pattern in a ":" command)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003526 Also for |[s| and |]s|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003527 tag jumping to a tag: ":ta", CTRL-T, etc.
3528 undo undo or redo: "u" and CTRL-R
Bram Moolenaar071d4272004-06-13 20:20:40 +00003529 When a movement command is used for an operator (e.g., "dl" or "y%")
3530 this option is not used. This means the operator will include the
3531 whole closed fold.
3532 Note that vertical movements are not here, because it would make it
3533 very difficult to move onto a closed fold.
3534 In insert mode the folds containing the cursor will always be open
3535 when text is inserted.
3536 To close folds you can re-apply 'foldlevel' with the |zx| command or
3537 set the 'foldclose' option to "all".
3538
3539 *'foldtext'* *'fdt'*
3540'foldtext' 'fdt' string (default: "foldtext()")
3541 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003542 {not available when compiled without the |+folding|
3543 feature}
3544 An expression which is used to specify the text displayed for a closed
3545 fold. See |fold-foldtext|.
3546
Bram Moolenaar30b65812012-07-12 22:01:11 +02003547 The expression will be evaluated in the |sandbox| if set from a
3548 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003549 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003550
3551 It is not allowed to change text or jump to another window while
3552 evaluating 'foldtext' |textlock|.
3553
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003554 *'formatexpr'* *'fex'*
3555'formatexpr' 'fex' string (default "")
3556 local to buffer
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003557 {not available when compiled without the |+eval|
3558 feature}
3559 Expression which is evaluated to format a range of lines for the |gq|
3560 operator or automatic formatting (see 'formatoptions'). When this
3561 option is empty 'formatprg' is used.
3562
3563 The |v:lnum| variable holds the first line to be formatted.
3564 The |v:count| variable holds the number of lines to be formatted.
3565 The |v:char| variable holds the character that is going to be
3566 inserted if the expression is being evaluated due to
3567 automatic formatting. This can be empty. Don't insert
3568 it yet!
3569
3570 Example: >
3571 :set formatexpr=mylang#Format()
3572< This will invoke the mylang#Format() function in the
3573 autoload/mylang.vim file in 'runtimepath'. |autoload|
3574
3575 The expression is also evaluated when 'textwidth' is set and adding
3576 text beyond that limit. This happens under the same conditions as
3577 when internal formatting is used. Make sure the cursor is kept in the
3578 same spot relative to the text then! The |mode()| function will
3579 return "i" or "R" in this situation.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01003580
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003581 When the expression evaluates to non-zero Vim will fall back to using
3582 the internal format mechanism.
3583
3584 The expression will be evaluated in the |sandbox| when set from a
3585 modeline, see |sandbox-option|. That stops the option from working,
3586 since changing the buffer text is not allowed.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003587 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaar036986f2017-03-16 17:41:02 +01003588 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003589
Bram Moolenaar86b68352004-12-27 21:59:20 +00003590 *'formatlistpat'* *'flp'*
3591'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
3592 local to buffer
Bram Moolenaar86b68352004-12-27 21:59:20 +00003593 A pattern that is used to recognize a list header. This is used for
3594 the "n" flag in 'formatoptions'.
3595 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00003596 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00003597 while still checking more characters. There must be a character
3598 following the pattern, when it matches the whole line it is handled
3599 like there is no match.
3600 The default recognizes a number, followed by an optional punctuation
3601 character and white space.
3602
Bram Moolenaar6c60f472019-04-28 16:00:35 +02003603 *'formatoptions'* *'fo'*
3604'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
3605 local to buffer
3606 This is a sequence of letters which describes how automatic
3607 formatting is to be done. See |fo-table|. When the 'paste' option is
3608 on, no formatting is done (like 'formatoptions' is empty). Commas can
3609 be inserted for readability.
3610 To avoid problems with flags that are added in the future, use the
3611 "+=" and "-=" feature of ":set" |add-option-flags|.
3612 NOTE: This option is set to the Vi default value when 'compatible' is
3613 set and to the Vim default value when 'compatible' is reset.
3614
Bram Moolenaar071d4272004-06-13 20:20:40 +00003615 *'formatprg'* *'fp'*
3616'formatprg' 'fp' string (default "")
Bram Moolenaar9be7c042017-01-14 14:28:30 +01003617 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003618 The name of an external program that will be used to format the lines
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003619 selected with the |gq| operator. The program must take the input on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003620 stdin and produce the output on stdout. The Unix program "fmt" is
Bram Moolenaara5792f52005-11-23 21:25:05 +00003621 such a program.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003622 If the 'formatexpr' option is not empty it will be used instead.
3623 Otherwise, if 'formatprg' option is an empty string, the internal
3624 format function will be used |C-indenting|.
Bram Moolenaara5792f52005-11-23 21:25:05 +00003625 Environment variables are expanded |:set_env|. See |option-backslash|
3626 about including spaces and backslashes.
Bram Moolenaar30b65812012-07-12 22:01:11 +02003627 This option cannot be set from a |modeline| or in the |sandbox|, for
3628 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003629
Bram Moolenaard94464e2015-11-02 15:28:18 +01003630 *'fsync'* *'fs'* *'nofsync'* *'nofs'*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003631'fsync' 'fs' boolean (default on)
3632 global
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003633 When on, the library function fsync() will be called after writing a
3634 file. This will flush a file to disk, ensuring that it is safely
3635 written even on filesystems which do metadata-only journaling. This
3636 will force the harddrive to spin up on Linux systems running in laptop
3637 mode, so it may be undesirable in some situations. Be warned that
3638 turning this off increases the chances of data loss after a crash. On
3639 systems without an fsync() implementation, this variable is always
3640 off.
3641 Also see 'swapsync' for controlling fsync() on swap files.
Bram Moolenaar340dd0f2021-10-14 17:52:23 +01003642 'fsync' also applies to |writefile()| (unless a flag is used to
3643 overrule it) and when writing undo files (see |undo-persistence|).
Bram Moolenaar110289e2019-05-23 15:38:06 +02003644 This option cannot be set from a |modeline| or in the |sandbox|, for
3645 security reasons.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003646
Bram Moolenaar071d4272004-06-13 20:20:40 +00003647 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
3648'gdefault' 'gd' boolean (default off)
3649 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003650 When on, the ":substitute" flag 'g' is default on. This means that
3651 all matches in a line are substituted instead of one. When a 'g' flag
3652 is given to a ":substitute" command, this will toggle the substitution
3653 of all or one match. See |complex-change|.
3654
3655 command 'gdefault' on 'gdefault' off ~
3656 :s/// subst. all subst. one
3657 :s///g subst. one subst. all
3658 :s///gg subst. all subst. one
3659
3660 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar21020352017-06-13 17:21:04 +02003661 DEPRECATED: Setting this option may break plugins that are not aware
3662 of this option. Also, many users get confused that adding the /g flag
3663 has the opposite effect of that it normally does.
Bram Moolenaar4072ba52020-12-23 13:56:35 +01003664 This option is not used in |Vim9| script.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003665
3666 *'grepformat'* *'gfm'*
Bram Moolenaar6e932462014-09-09 18:48:09 +02003667'grepformat' 'gfm' string (default "%f:%l:%m,%f:%l%m,%f %l%m")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003668 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003669 Format to recognize for the ":grep" command output.
3670 This is a scanf-like string that uses the same format as the
3671 'errorformat' option: see |errorformat|.
3672
3673 *'grepprg'* *'gp'*
3674'grepprg' 'gp' string (default "grep -n ",
3675 Unix: "grep -n $* /dev/null",
3676 Win32: "findstr /n" or "grep -n",
3677 VMS: "SEARCH/NUMBERS ")
3678 global or local to buffer |global-local|
Bram Moolenaar582fd852005-03-28 20:58:01 +00003679 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003680 and '#' characters, which are expanded like when used in a command-
3681 line. The placeholder "$*" is allowed to specify where the arguments
3682 will be included. Environment variables are expanded |:set_env|. See
3683 |option-backslash| about including spaces and backslashes.
3684 When your "grep" accepts the "-H" argument, use this to make ":grep"
3685 also work well with a single file: >
3686 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00003687< Special value: When 'grepprg' is set to "internal" the |:grep| command
Bram Moolenaara6557602006-02-04 22:43:20 +00003688 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like
3689 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00003690 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00003691 apply equally to 'grepprg'.
3692 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
3693 otherwise it's "grep -n".
3694 This option cannot be set from a |modeline| or in the |sandbox|, for
3695 security reasons.
3696
3697 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
3698'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
3699 ve:ver35-Cursor,
3700 o:hor50-Cursor,
3701 i-ci:ver25-Cursor/lCursor,
3702 r-cr:hor20-Cursor/lCursor,
3703 sm:block-Cursor
3704 -blinkwait175-blinkoff150-blinkon175",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003705 for Win32 console:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003706 "n-v-c:block,o:hor50,i-ci:hor15,
3707 r-cr:hor30,sm:block")
3708 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003709 {only available when compiled with GUI enabled, and
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003710 for Win32 console}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003711 This option tells Vim what the cursor should look like in different
Bram Moolenaar8024f932020-01-14 19:29:13 +01003712 modes. It fully works in the GUI. In a Win32 console, only the
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003713 height of the cursor can be changed. This can be done by specifying a
3714 block cursor, or a percentage for a vertical or horizontal cursor.
Bram Moolenaar1e7813a2015-03-31 18:31:03 +02003715 For a console the 't_SI', 't_SR', and 't_EI' escape sequences are
3716 used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003717
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003718 The option is a comma separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003719 mode-list and an argument-list:
3720 mode-list:argument-list,mode-list:argument-list,..
3721 The mode-list is a dash separated list of these modes:
3722 n Normal mode
3723 v Visual mode
3724 ve Visual mode with 'selection' "exclusive" (same as 'v',
3725 if not specified)
3726 o Operator-pending mode
3727 i Insert mode
3728 r Replace mode
3729 c Command-line Normal (append) mode
3730 ci Command-line Insert mode
3731 cr Command-line Replace mode
3732 sm showmatch in Insert mode
3733 a all modes
3734 The argument-list is a dash separated list of these arguments:
3735 hor{N} horizontal bar, {N} percent of the character height
3736 ver{N} vertical bar, {N} percent of the character width
3737 block block cursor, fills the whole character
3738 [only one of the above three should be present]
3739 blinkwait{N} *cursor-blinking*
3740 blinkon{N}
3741 blinkoff{N}
3742 blink times for cursor: blinkwait is the delay before
3743 the cursor starts blinking, blinkon is the time that
3744 the cursor is shown and blinkoff is the time that the
3745 cursor is not shown. The times are in msec. When one
3746 of the numbers is zero, there is no blinking. The
3747 default is: "blinkwait700-blinkon400-blinkoff250".
3748 These numbers are used for a missing entry. This
3749 means that blinking is enabled by default. To switch
3750 blinking off you can use "blinkon0". The cursor only
3751 blinks when Vim is waiting for input, not while
3752 executing a command.
3753 To make the cursor blink in an xterm, see
3754 |xterm-blink|.
3755 {group-name}
3756 a highlight group name, that sets the color and font
3757 for the cursor
3758 {group-name}/{group-name}
3759 Two highlight group names, the first is used when
3760 no language mappings are used, the other when they
3761 are. |language-mapping|
3762
3763 Examples of parts:
3764 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
3765 block cursor with colors from the "nCursor"
3766 highlight group
3767 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
3768 In Insert and Command-line Insert mode, use a
3769 30% vertical bar cursor with colors from the
3770 "iCursor" highlight group. Blink a bit
3771 faster.
3772
3773 The 'a' mode is different. It will set the given argument-list for
3774 all modes. It does not reset anything to defaults. This can be used
3775 to do a common setting for all modes. For example, to switch off
3776 blinking: "a:blinkon0"
3777
3778 Examples of cursor highlighting: >
3779 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
3780 :highlight Cursor gui=NONE guifg=bg guibg=fg
3781<
3782 *'guifont'* *'gfn'*
Bram Moolenaar251e1912011-06-19 05:09:16 +02003783 *E235* *E596*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003784'guifont' 'gfn' string (default "")
3785 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003786 {only available when compiled with GUI enabled}
3787 This is a list of fonts which will be used for the GUI version of Vim.
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003788 In its simplest form the value is just one font name.
3789 See |gui-font| for the details.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003790
3791 *'guifontset'* *'gfs'*
3792 *E250* *E252* *E234* *E597* *E598*
3793'guifontset' 'gfs' string (default "")
3794 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003795 {only available when compiled with GUI enabled and
3796 with the |+xfontset| feature}
Bram Moolenaar3df01732017-02-17 22:47:16 +01003797 {not available in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003798 When not empty, specifies two (or more) fonts to be used. The first
3799 one for normal English, the second one for your special language. See
3800 |xfontset|.
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003801
Bram Moolenaar071d4272004-06-13 20:20:40 +00003802 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
3803'guifontwide' 'gfw' string (default "")
3804 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003805 {only available when compiled with GUI enabled}
3806 When not empty, specifies a comma-separated list of fonts to be used
3807 for double-width characters. The first font that can be loaded is
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003808 used. See |gui-fontwide|.
Bram Moolenaar0f272122013-01-23 18:37:40 +01003809
Bram Moolenaar071d4272004-06-13 20:20:40 +00003810 *'guiheadroom'* *'ghr'*
3811'guiheadroom' 'ghr' number (default 50)
3812 global
Bram Moolenaar110289e2019-05-23 15:38:06 +02003813 {only for GTK and X11 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003814 The number of pixels subtracted from the screen height when fitting
3815 the GUI window on the screen. Set this before the GUI is started,
3816 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003817 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00003818 lines will be left for window decorations and other items on the
3819 screen. Set it to a negative value to allow windows taller than the
3820 screen.
3821
Dusan Popovic4eeedc02021-10-16 20:52:05 +01003822 *'guiligatures'* *'gli'* *E1243*
3823'guiligatures' 'gli' string (default "")
3824 global
3825 {only for GTK GUI}
3826 List of ASCII characters that, when combined together, can create more
3827 complex shapes. Each character must be a printable ASCII character
3828 with a value in the 32-127 range.
3829 Example: >
3830 :set guiligatures=!\"#$%&()*+-./:<=>?@[]^_{\|~
3831< Changing this option updates screen output immediately. Set it to an
3832 empty string to disable ligatures.
3833
Bram Moolenaar071d4272004-06-13 20:20:40 +00003834 *'guioptions'* *'go'*
Bram Moolenaar2c64ca12018-10-19 16:22:31 +02003835'guioptions' 'go' string (default "egmrLtT" (MS-Windows,
3836 "t" is removed in |defaults.vim|),
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02003837 "aegimrLtT" (GTK, Motif and Athena),
3838 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00003839 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003840 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00003841 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003842 sequence of letters which describes what components and options of the
3843 GUI should be used.
3844 To avoid problems with flags that are added in the future, use the
3845 "+=" and "-=" feature of ":set" |add-option-flags|.
3846
Bram Moolenaar13568252018-03-16 20:46:58 +01003847 Valid characters are as follows:
3848 *'go-!'*
3849 '!' External commands are executed in a terminal window. Without
3850 this flag the MS-Windows GUI will open a console window to
3851 execute the command. The Unix GUI will simulate a dumb
3852 terminal to list the command output.
3853 The terminal window will be positioned at the bottom, and grow
3854 upwards as needed.
Bram Moolenaarba3ff532018-11-04 14:45:49 +01003855 *'go-a'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003856 'a' Autoselect: If present, then whenever VISUAL mode is started,
3857 or the Visual area extended, Vim tries to become the owner of
3858 the windowing system's global selection. This means that the
3859 Visually highlighted text is available for pasting into other
3860 applications as well as into Vim itself. When the Visual mode
3861 ends, possibly due to an operation on the text, or when an
3862 application wants to paste the selection, the highlighted text
3863 is automatically yanked into the "* selection register.
3864 Thus the selection is still available for pasting into other
3865 applications after the VISUAL mode has ended.
3866 If not present, then Vim won't become the owner of the
3867 windowing system's global selection unless explicitly told to
3868 by a yank or delete operation for the "* register.
3869 The same applies to the modeless selection.
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02003870 *'go-P'*
3871 'P' Like autoselect but using the "+ register instead of the "*
Bram Moolenaar3848e002016-03-19 18:42:29 +01003872 register.
Bram Moolenaar02467872007-05-06 13:22:01 +00003873 *'go-A'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003874 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003875 applies to the modeless selection.
3876
3877 'guioptions' autoselect Visual autoselect modeless ~
3878 "" - -
3879 "a" yes yes
3880 "A" - yes
3881 "aA" yes yes
3882
Bram Moolenaar02467872007-05-06 13:22:01 +00003883 *'go-c'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003884 'c' Use console dialogs instead of popup dialogs for simple
3885 choices.
Bram Moolenaar50bf7ce2019-09-15 13:17:00 +02003886 *'go-d'*
3887 'd' Use dark theme variant if available. Currently only works for
3888 GTK+ GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00003889 *'go-e'*
Bram Moolenaare224ffa2006-03-01 00:01:28 +00003890 'e' Add tab pages when indicated with 'showtabline'.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003891 'guitablabel' can be used to change the text in the labels.
3892 When 'e' is missing a non-GUI tab pages line may be used.
Bram Moolenaard68071d2006-05-02 22:08:30 +00003893 The GUI tabs are only supported on some systems, currently
Bram Moolenaarb3f74062020-02-26 16:16:53 +01003894 GTK, Motif, Mac OS/X, Haiku, and MS-Windows.
Bram Moolenaar02467872007-05-06 13:22:01 +00003895 *'go-f'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003896 'f' Foreground: Don't use fork() to detach the GUI from the shell
3897 where it was started. Use this for programs that wait for the
3898 editor to finish (e.g., an e-mail program). Alternatively you
3899 can use "gvim -f" or ":gui -f" to start the GUI in the
3900 foreground. |gui-fork|
3901 Note: Set this option in the vimrc file. The forking may have
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003902 happened already when the |gvimrc| file is read.
Bram Moolenaar02467872007-05-06 13:22:01 +00003903 *'go-i'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003904 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
3905 corner of the window. It's black&white on non-GTK, because of
3906 limitations of X11. For a color icon, see |X11-icon|.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003907 *'go-m'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003908 'm' Menu bar is present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003909 *'go-M'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003910 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00003911 that this flag must be added in the .vimrc file, before
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003912 switching on syntax or filetype recognition (when the |gvimrc|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003913 file is sourced the system menu has already been loaded; the
Bram Moolenaar01164a62017-11-02 22:58:42 +01003914 `:syntax on` and `:filetype on` commands load the menu too).
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003915 *'go-g'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003916 'g' Grey menu items: Make menu items that are not active grey. If
3917 'g' is not included inactive menu items are not shown at all.
3918 Exception: Athena will always use grey menu items.
Bram Moolenaar02467872007-05-06 13:22:01 +00003919 *'go-t'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003920 't' Include tearoff menu items. Currently only works for Win32,
3921 GTK+, and Motif 1.2 GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00003922 *'go-T'*
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00003923 'T' Include Toolbar. Currently only in Win32, GTK+, Motif, Photon
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00003924 and Athena GUIs.
Bram Moolenaar02467872007-05-06 13:22:01 +00003925 *'go-r'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003926 'r' Right-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003927 *'go-R'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003928 'R' Right-hand scrollbar is present when there is a vertically
3929 split window.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003930 *'go-l'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003931 'l' Left-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003932 *'go-L'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003933 'L' Left-hand scrollbar is present when there is a vertically
3934 split window.
Bram Moolenaar02467872007-05-06 13:22:01 +00003935 *'go-b'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003936 'b' Bottom (horizontal) scrollbar is present. Its size depends on
3937 the longest visible line, or on the cursor line if the 'h'
3938 flag is included. |gui-horiz-scroll|
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003939 *'go-h'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003940 'h' Limit horizontal scrollbar size to the length of the cursor
3941 line. Reduces computations. |gui-horiz-scroll|
3942
3943 And yes, you may even have scrollbars on the left AND the right if
3944 you really want to :-). See |gui-scrollbars| for more information.
3945
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003946 *'go-v'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003947 'v' Use a vertical button layout for dialogs. When not included,
3948 a horizontal layout is preferred, but when it doesn't fit a
Bram Moolenaardad44732021-03-31 20:07:33 +02003949 vertical layout is used anyway. Not supported in GTK 3.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003950 *'go-p'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003951 'p' Use Pointer callbacks for X11 GUI. This is required for some
3952 window managers. If the cursor is not blinking or hollow at
3953 the right moment, try adding this flag. This must be done
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003954 before starting the GUI. Set it in your |gvimrc|. Adding or
Bram Moolenaar071d4272004-06-13 20:20:40 +00003955 removing it after the GUI has started has no effect.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003956 *'go-F'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003957 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar8ac44152017-11-09 18:33:29 +01003958 *'go-k'*
3959 'k' Keep the GUI window size when adding/removing a scrollbar, or
3960 toolbar, tabline, etc. Instead, the behavior is similar to
3961 when the window is maximized and will adjust 'lines' and
3962 'columns' to fit to the window. Without the 'k' flag Vim will
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003963 try to keep 'lines' and 'columns' the same when adding and
Bram Moolenaar8ac44152017-11-09 18:33:29 +01003964 removing GUI components.
Bram Moolenaar02467872007-05-06 13:22:01 +00003965
Bram Moolenaar071d4272004-06-13 20:20:40 +00003966 *'guipty'* *'noguipty'*
3967'guipty' boolean (default on)
3968 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003969 {only available when compiled with GUI enabled}
3970 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
3971 I/O to/from shell commands. See |gui-pty|.
3972
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003973 *'guitablabel'* *'gtl'*
3974'guitablabel' 'gtl' string (default empty)
3975 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02003976 {only available when compiled with GUI enabled}
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003977 When nonempty describes the text to use in a label of the GUI tab
Bram Moolenaard68071d2006-05-02 22:08:30 +00003978 pages line. When empty and when the result is empty Vim will use a
3979 default label. See |setting-guitablabel| for more info.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003980
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003981 The format of this option is like that of 'statusline'.
Bram Moolenaar57657d82006-04-21 22:12:41 +00003982 'guitabtooltip' is used for the tooltip, see below.
Bram Moolenaar51628222016-12-01 23:03:28 +01003983 The expression will be evaluated in the |sandbox| when set from a
3984 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003985 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003986
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003987 Only used when the GUI tab pages line is displayed. 'e' must be
3988 present in 'guioptions'. For the non-GUI tab pages line 'tabline' is
3989 used.
3990
Bram Moolenaar57657d82006-04-21 22:12:41 +00003991 *'guitabtooltip'* *'gtt'*
3992'guitabtooltip' 'gtt' string (default empty)
3993 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02003994 {only available when compiled with GUI enabled}
Bram Moolenaar57657d82006-04-21 22:12:41 +00003995 When nonempty describes the text to use in a tooltip for the GUI tab
3996 pages line. When empty Vim will use a default tooltip.
3997 This option is otherwise just like 'guitablabel' above.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003998 You can include a line break. Simplest method is to use |:let|: >
3999 :let &guitabtooltip = "line one\nline two"
4000<
Bram Moolenaar57657d82006-04-21 22:12:41 +00004001
Bram Moolenaar071d4272004-06-13 20:20:40 +00004002 *'helpfile'* *'hf'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01004003'helpfile' 'hf' string (default (MS-Windows) "$VIMRUNTIME\doc\help.txt"
Bram Moolenaar071d4272004-06-13 20:20:40 +00004004 (others) "$VIMRUNTIME/doc/help.txt")
4005 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004006 Name of the main help file. All distributed help files should be
4007 placed together in one directory. Additionally, all "doc" directories
4008 in 'runtimepath' will be used.
4009 Environment variables are expanded |:set_env|. For example:
4010 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004011 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00004012 spaces and backslashes.
4013 This option cannot be set from a |modeline| or in the |sandbox|, for
4014 security reasons.
4015
4016 *'helpheight'* *'hh'*
4017'helpheight' 'hh' number (default 20)
4018 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004019 Minimal initial height of the help window when it is opened with the
4020 ":help" command. The initial height of the help window is half of the
4021 current window, or (when the 'ea' option is on) the same as other
4022 windows. When the height is less than 'helpheight', the height is
4023 set to 'helpheight'. Set to zero to disable.
4024
4025 *'helplang'* *'hlg'*
4026'helplang' 'hlg' string (default: messages language or empty)
4027 global
4028 {only available when compiled with the |+multi_lang|
4029 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004030 Comma separated list of languages. Vim will use the first language
4031 for which the desired help can be found. The English help will always
4032 be used as a last resort. You can add "en" to prefer English over
4033 another language, but that will only find tags that exist in that
4034 language and not in the English help.
4035 Example: >
4036 :set helplang=de,it
4037< This will first search German, then Italian and finally English help
4038 files.
4039 When using |CTRL-]| and ":help!" in a non-English help file Vim will
4040 try to find the tag in the current language before using this option.
4041 See |help-translated|.
4042
4043 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
4044'hidden' 'hid' boolean (default off)
4045 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004046 When off a buffer is unloaded when it is |abandon|ed. When on a
4047 buffer becomes hidden when it is |abandon|ed. If the buffer is still
4048 displayed in another window, it does not become hidden, of course.
4049 The commands that move through the buffer list sometimes make a buffer
4050 hidden although the 'hidden' option is off: When the buffer is
4051 modified, 'autowrite' is off or writing is not possible, and the '!'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004052 flag was used. See also |windows.txt|.
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004053 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004054 This option is set for one command with ":hide {command}" |:hide|.
4055 WARNING: It's easy to forget that you have changes in hidden buffers.
4056 Think twice when using ":q!" or ":qa!".
4057
4058 *'highlight'* *'hl'*
4059'highlight' 'hl' string (default (as a single string):
Bram Moolenaar58b85342016-08-14 19:54:54 +02004060 "8:SpecialKey,~:EndOfBuffer,@:NonText,
4061 d:Directory,e:ErrorMsg,i:IncSearch,
4062 l:Search,m:MoreMsg,M:ModeMsg,n:LineNr,
Bram Moolenaarefae76a2019-10-27 22:54:58 +01004063 a:LineNrAbove,b:LineNrBelow,
Bram Moolenaar58b85342016-08-14 19:54:54 +02004064 N:CursorLineNr,r:Question,s:StatusLine,
4065 S:StatusLineNC,c:VertSplit,t:Title,
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004066 v:Visual,V:VisualNOS,w:WarningMsg,
4067 W:WildMenu,f:Folded,F:FoldColumn,
4068 A:DiffAdd,C:DiffChange,D:DiffDelete,
4069 T:DiffText,>:SignColumn,-:Conceal,
Bram Moolenaarc8c88492018-12-27 23:59:26 +01004070 B:SpellBad,P:SpellCap,R:SpellRare,
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004071 L:SpellLocal,+:Pmenu,=:PmenuSel,
Bram Moolenaar21020352017-06-13 17:21:04 +02004072 x:PmenuSbar,X:PmenuThumb,*:TabLine,
4073 #:TabLineSel,_:TabLineFill,!:CursorColumn,
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02004074 .:CursorLine,o:ColorColumn,q:QuickFixLine,
Bram Moolenaarc572da52017-08-27 16:52:01 +02004075 z:StatusLineTerm,Z:StatusLineTermNC")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004076 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004077 This option can be used to set highlighting mode for various
4078 occasions. It is a comma separated list of character pairs. The
4079 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004080 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004081 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
Bram Moolenaar58b85342016-08-14 19:54:54 +02004082 |hl-EndOfBuffer| ~ lines after the last line in the buffer
4083 |hl-NonText| @ '@' at the end of the window and
Bram Moolenaar071d4272004-06-13 20:20:40 +00004084 characters from 'showbreak'
4085 |hl-Directory| d directories in CTRL-D listing and other special
4086 things in listings
4087 |hl-ErrorMsg| e error messages
4088 h (obsolete, ignored)
4089 |hl-IncSearch| i 'incsearch' highlighting
4090 |hl-Search| l last search pattern highlighting (see 'hlsearch')
4091 |hl-MoreMsg| m |more-prompt|
4092 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
Bram Moolenaar64486672010-05-16 15:46:46 +02004093 |hl-LineNr| n line number for ":number" and ":#" commands, and
4094 when 'number' or 'relativenumber' option is set.
Bram Moolenaarefae76a2019-10-27 22:54:58 +01004095 |hl-LineNrAbove| a line number above the cursor for when the
4096 'relativenumber' option is set.
4097 |hl-LineNrBelow| b line number below the cursor for when the
4098 'relativenumber' option is set.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01004099 |hl-CursorLineNr| N like n for when 'cursorline' or 'relativenumber' is
4100 set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004101 |hl-Question| r |hit-enter| prompt and yes/no questions
4102 |hl-StatusLine| s status line of current window |status-line|
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01004103 |hl-StatusLineNC| S status lines of not-current windows
Bram Moolenaar071d4272004-06-13 20:20:40 +00004104 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
4105 |hl-VertSplit| c column used to separate vertically split windows
4106 |hl-Visual| v Visual mode
4107 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
4108 Selection" Only X11 Gui's |gui-x11| and
4109 |xterm-clipboard|.
4110 |hl-WarningMsg| w warning messages
4111 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
4112 |hl-Folded| f line used for closed folds
4113 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00004114 |hl-DiffAdd| A added line in diff mode
4115 |hl-DiffChange| C changed line in diff mode
4116 |hl-DiffDelete| D deleted line in diff mode
4117 |hl-DiffText| T inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00004118 |hl-SignColumn| > column used for |signs|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004119 |hl-Conceal| - the placeholders used for concealed characters
4120 (see 'conceallevel')
Bram Moolenaar217ad922005-03-20 22:37:15 +00004121 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02004122 |hl-SpellCap| P word that should start with capital |spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00004123 |hl-SpellRare| R rare word |spell|
4124 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004125 |hl-Pmenu| + popup menu normal line
4126 |hl-PmenuSel| = popup menu selected line
4127 |hl-PmenuSbar| x popup menu scrollbar
4128 |hl-PmenuThumb| X popup menu scrollbar thumb
Bram Moolenaar071d4272004-06-13 20:20:40 +00004129
4130 The display modes are:
4131 r reverse (termcap entry "mr" and "me")
4132 i italic (termcap entry "ZH" and "ZR")
4133 b bold (termcap entry "md" and "me")
4134 s standout (termcap entry "so" and "se")
4135 u underline (termcap entry "us" and "ue")
Bram Moolenaare2cc9702005-03-15 22:43:58 +00004136 c undercurl (termcap entry "Cs" and "Ce")
Bram Moolenaarcf4b00c2017-09-02 18:33:56 +02004137 t strikethrough (termcap entry "Ts" and "Te")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004138 n no highlighting
4139 - no highlighting
4140 : use a highlight group
4141 The default is used for occasions that are not included.
4142 If you want to change what the display modes do, see |dos-colors|
4143 for an example.
4144 When using the ':' display mode, this must be followed by the name of
4145 a highlight group. A highlight group can be used to define any type
4146 of highlighting, including using color. See |:highlight| on how to
4147 define one. The default uses a different group for each occasion.
4148 See |highlight-default| for the default highlight groups.
4149
Bram Moolenaar071d4272004-06-13 20:20:40 +00004150 *'history'* *'hi'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004151'history' 'hi' number (Vim default: 50, Vi default: 0,
4152 set to 200 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004153 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004154 A history of ":" commands, and a history of previous search patterns
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004155 is remembered. This option decides how many entries may be stored in
Bram Moolenaar071d4272004-06-13 20:20:40 +00004156 each of these histories (see |cmdline-editing|).
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004157 The maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004158 NOTE: This option is set to the Vi default value when 'compatible' is
4159 set and to the Vim default value when 'compatible' is reset.
4160
4161 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
4162'hkmap' 'hk' boolean (default off)
4163 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004164 {only available when compiled with the |+rightleft|
4165 feature}
4166 When on, the keyboard is mapped for the Hebrew character set.
4167 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
4168 toggle this option. See |rileft.txt|.
4169 NOTE: This option is reset when 'compatible' is set.
4170
4171 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
4172'hkmapp' 'hkp' boolean (default off)
4173 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004174 {only available when compiled with the |+rightleft|
4175 feature}
4176 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
4177 This is useful if you have a non-Hebrew keyboard.
4178 See |rileft.txt|.
4179 NOTE: This option is reset when 'compatible' is set.
4180
Bram Moolenaar036986f2017-03-16 17:41:02 +01004181 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
4182'hlsearch' 'hls' boolean (default off)
4183 global
Bram Moolenaar036986f2017-03-16 17:41:02 +01004184 {not available when compiled without the
4185 |+extra_search| feature}
4186 When there is a previous search pattern, highlight all its matches.
4187 The type of highlighting used can be set with the 'l' occasion in the
4188 'highlight' option. This uses the "Search" highlight group by
4189 default. Note that only the matching text is highlighted, any offsets
4190 are not applied.
4191 See also: 'incsearch' and |:match|.
4192 When you get bored looking at the highlighted matches, you can turn it
4193 off with |:nohlsearch|. This does not change the option value, as
4194 soon as you use a search command, the highlighting comes back.
4195 'redrawtime' specifies the maximum time spent on finding matches.
4196 When the search pattern can match an end-of-line, Vim will try to
4197 highlight all of the matched text. However, this depends on where the
4198 search starts. This will be the first line in the window or the first
4199 line below a closed fold. A match in a previous line which is not
4200 drawn may not continue in a newly drawn line.
4201 You can specify whether the highlight status is restored on startup
4202 with the 'h' flag in 'viminfo' |viminfo-h|.
4203 NOTE: This option is reset when 'compatible' is set.
4204
Bram Moolenaar071d4272004-06-13 20:20:40 +00004205 *'icon'* *'noicon'*
4206'icon' boolean (default off, on when title can be restored)
4207 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004208 When on, the icon text of the window will be set to the value of
4209 'iconstring' (if it is not empty), or to the name of the file
4210 currently being edited. Only the last part of the name is used.
4211 Overridden by the 'iconstring' option.
4212 Only works if the terminal supports setting window icons (currently
4213 only X11 GUI and terminals with a non-empty 't_IS' option - these are
4214 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
4215 builtin termcap).
4216 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00004217 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00004218 X11.
Bram Moolenaar3a991dd2014-10-02 01:41:41 +02004219 For MS-Windows the icon can be changed, see |windows-icon|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004220
4221 *'iconstring'*
4222'iconstring' string (default "")
4223 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004224 When this option is not empty, it will be used for the icon text of
4225 the window. This happens only when the 'icon' option is on.
4226 Only works if the terminal supports setting window icon text
4227 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02004228 Does not work for MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004229 When Vim was compiled with HAVE_X11 defined, the original icon will be
4230 restored if possible |X11|.
4231 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004232 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004233 'titlestring' for example settings.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004234 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004235 {not available when compiled without the |+statusline| feature}
4236
4237 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
4238'ignorecase' 'ic' boolean (default off)
4239 global
4240 Ignore case in search patterns. Also used when searching in the tags
4241 file.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01004242 Also see 'smartcase' and 'tagcase'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004243 Can be overruled by using "\c" or "\C" in the pattern, see
4244 |/ignorecase|.
4245
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004246 *'imactivatefunc'* *'imaf'*
4247'imactivatefunc' 'imaf' string (default "")
4248 global
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004249 This option specifies a function that will be called to
Yegappan Lakshmanan7645da52021-12-04 14:02:30 +00004250 activate or deactivate the Input Method. The value can be the name of
4251 a function, a |lambda| or a |Funcref|. See |option-value-function| for
4252 more information.
Bram Moolenaaref8c6172020-07-01 15:12:44 +02004253 It is not used in the MS-Windows GUI version.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004254 The expression will be evaluated in the |sandbox| when set from a
4255 modeline, see |sandbox-option|.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004256
4257 Example: >
4258 function ImActivateFunc(active)
4259 if a:active
4260 ... do something
4261 else
4262 ... do something
4263 endif
4264 " return value is not used
4265 endfunction
4266 set imactivatefunc=ImActivateFunc
4267<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004268 *'imactivatekey'* *'imak'*
4269'imactivatekey' 'imak' string (default "")
4270 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004271 {only available when compiled with |+xim| and
Bram Moolenaar67c53842010-05-22 18:28:27 +02004272 |+GUI_GTK|} *E599*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004273 Specifies the key that your Input Method in X-Windows uses for
4274 activation. When this is specified correctly, vim can fully control
4275 IM with 'imcmdline', 'iminsert' and 'imsearch'.
4276 You can't use this option to change the activation key, the option
4277 tells Vim what the key is.
4278 Format:
4279 [MODIFIER_FLAG-]KEY_STRING
4280
4281 These characters can be used for MODIFIER_FLAG (case is ignored):
4282 S Shift key
4283 L Lock key
4284 C Control key
4285 1 Mod1 key
4286 2 Mod2 key
4287 3 Mod3 key
4288 4 Mod4 key
4289 5 Mod5 key
4290 Combinations are allowed, for example "S-C-space" or "SC-space" are
4291 both shift+ctrl+space.
4292 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
4293
4294 Example: >
4295 :set imactivatekey=S-space
4296< "S-space" means shift+space. This is the activation key for kinput2 +
4297 canna (Japanese), and ami (Korean).
4298
4299 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
4300'imcmdline' 'imc' boolean (default off)
4301 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004302 When set the Input Method is always on when starting to edit a command
4303 line, unless entering a search pattern (see 'imsearch' for that).
4304 Setting this option is useful when your input method allows entering
4305 English characters directly, e.g., when it's used to type accented
4306 characters with dead keys.
4307
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004308 *'imdisable'* *'imd'* *'noimdisable'* *'noimd'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004309'imdisable' 'imd' boolean (default off, on for some systems (SGI))
4310 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004311 When set the Input Method is never used. This is useful to disable
4312 the IM when it doesn't work properly.
4313 Currently this option is on by default for SGI/IRIX machines. This
4314 may change in later releases.
4315
4316 *'iminsert'* *'imi'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004317'iminsert' 'imi' number (default 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004318 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004319 Specifies whether :lmap or an Input Method (IM) is to be used in
4320 Insert mode. Valid values:
4321 0 :lmap is off and IM is off
4322 1 :lmap is ON and IM is off
4323 2 :lmap is off and IM is ON
Bram Moolenaar071d4272004-06-13 20:20:40 +00004324 To always reset the option to zero when leaving Insert mode with <Esc>
4325 this can be used: >
4326 :inoremap <ESC> <ESC>:set iminsert=0<CR>
4327< This makes :lmap and IM turn off automatically when leaving Insert
4328 mode.
4329 Note that this option changes when using CTRL-^ in Insert mode
4330 |i_CTRL-^|.
4331 The value is set to 1 when setting 'keymap' to a valid keymap name.
4332 It is also used for the argument of commands like "r" and "f".
4333 The value 0 may not work correctly with Athena and Motif with some XIM
4334 methods. Use 'imdisable' to disable XIM then.
4335
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004336 You can set 'imactivatefunc' and 'imstatusfunc' to handle IME/XIM
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004337 via external command if Vim is not compiled with the |+xim|,
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004338 |+multi_byte_ime| or |global-ime|.
4339
Bram Moolenaar071d4272004-06-13 20:20:40 +00004340 *'imsearch'* *'ims'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004341'imsearch' 'ims' number (default -1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004342 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004343 Specifies whether :lmap or an Input Method (IM) is to be used when
4344 entering a search pattern. Valid values:
4345 -1 the value of 'iminsert' is used, makes it look like
4346 'iminsert' is also used when typing a search pattern
4347 0 :lmap is off and IM is off
4348 1 :lmap is ON and IM is off
4349 2 :lmap is off and IM is ON
4350 Note that this option changes when using CTRL-^ in Command-line mode
4351 |c_CTRL-^|.
4352 The value is set to 1 when it is not -1 and setting the 'keymap'
4353 option to a valid keymap name.
4354 The value 0 may not work correctly with Athena and Motif with some XIM
4355 methods. Use 'imdisable' to disable XIM then.
4356
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004357 *'imstatusfunc'* *'imsf'*
4358'imstatusfunc' 'imsf' string (default "")
4359 global
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004360 This option specifies a function that is called to obtain the status
4361 of Input Method. It must return a positive number when IME is active.
Yegappan Lakshmanan7645da52021-12-04 14:02:30 +00004362 The value can be the name of a function, a |lambda| or a |Funcref|.
4363 See |option-value-function| for more information.
Bram Moolenaaref8c6172020-07-01 15:12:44 +02004364 It is not used in the MS-Windows GUI version.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004365
4366 Example: >
4367 function ImStatusFunc()
4368 let is_active = ...do something
4369 return is_active ? 1 : 0
4370 endfunction
4371 set imstatusfunc=ImStatusFunc
4372<
4373 NOTE: This function is invoked very often. Keep it fast.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004374 The expression will be evaluated in the |sandbox| when set from a
4375 modeline, see |sandbox-option|.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004376
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004377 *'imstyle'* *'imst'*
4378'imstyle' 'imst' number (default 1)
4379 global
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004380 {only available when compiled with |+xim| and
4381 |+GUI_GTK|}
Bram Moolenaar37c64c72017-09-19 22:06:03 +02004382 This option specifies the input style of Input Method:
4383 0 use on-the-spot style
4384 1 over-the-spot style
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004385 See: |xim-input-style|
4386
Bram Moolenaar24a98a02017-09-27 22:23:55 +02004387 For a long time on-the-spot style had been used in the GTK version of
4388 vim, however, it is known that it causes troubles when using mappings,
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004389 |single-repeat|, etc. Therefore over-the-spot style becomes the
4390 default now. This should work fine for most people, however if you
4391 have any problem with it, try using on-the-spot style.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004392 The expression will be evaluated in the |sandbox| when set from a
4393 modeline, see |sandbox-option|.
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004394
Bram Moolenaar071d4272004-06-13 20:20:40 +00004395 *'include'* *'inc'*
4396'include' 'inc' string (default "^\s*#\s*include")
4397 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004398 {not available when compiled without the
4399 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004400 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00004401 pattern, just like for the "/" command (See |pattern|). The default
4402 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar1e015462005-09-25 22:16:38 +00004403 "]I", "[d", etc.
4404 Normally the 'isfname' option is used to recognize the file name that
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004405 comes after the matched pattern. But if "\zs" appears in the pattern
4406 then the text matched from "\zs" to the end, or until "\ze" if it
4407 appears, is used as the file name. Use this to include characters
4408 that are not in 'isfname', such as a space. You can then use
4409 'includeexpr' to process the matched text.
Bram Moolenaar1e015462005-09-25 22:16:38 +00004410 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004411
4412 *'includeexpr'* *'inex'*
4413'includeexpr' 'inex' string (default "")
4414 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004415 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004416 |+find_in_path| or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004417 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004418 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004419 :set includeexpr=substitute(v:fname,'\\.','/','g')
4420< The "v:fname" variable will be set to the file name that was detected.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004421
Bram Moolenaar071d4272004-06-13 20:20:40 +00004422 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004423 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004424 Also used for |<cfile>|.
4425
Bram Moolenaar30b65812012-07-12 22:01:11 +02004426 The expression will be evaluated in the |sandbox| when set from a
4427 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004428 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004429
4430 It is not allowed to change text or jump to another window while
4431 evaluating 'includeexpr' |textlock|.
4432
Bram Moolenaar071d4272004-06-13 20:20:40 +00004433 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004434'incsearch' 'is' boolean (default off, set in |defaults.vim| if the
4435 +reltime feature is supported)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004436 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004437 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004438 |+extra_search| features}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004439 While typing a search command, show where the pattern, as it was typed
4440 so far, matches. The matched string is highlighted. If the pattern
4441 is invalid or not found, nothing is shown. The screen will be updated
4442 often, this is only useful on fast terminals.
Bram Moolenaarfc65cab2018-08-28 22:58:02 +02004443 Also applies to the pattern in commands: >
4444 :global
4445 :lvimgrep
4446 :lvimgrepadd
4447 :smagic
4448 :snomagic
4449 :sort
4450 :substitute
4451 :vglobal
4452 :vimgrep
4453 :vimgrepadd
4454< Note that the match will be shown, but the cursor will return to its
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004455 original position when no match is found and when pressing <Esc>. You
4456 still need to finish the search command with <Enter> to move the
4457 cursor to the match.
Bram Moolenaardc083282016-10-11 08:57:33 +02004458 You can use the CTRL-G and CTRL-T keys to move to the next and
4459 previous match. |c_CTRL-G| |c_CTRL-T|
Bram Moolenaar91a4e822008-01-19 14:59:58 +00004460 When compiled with the |+reltime| feature Vim only searches for about
4461 half a second. With a complicated pattern and/or a lot of text the
4462 match may not be found. This is to avoid that Vim hangs while you
4463 are typing the pattern.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004464 The highlighting can be set with the 'i' flag in 'highlight'.
Bram Moolenaar2f058492017-11-30 20:27:52 +01004465 When 'hlsearch' is on, all matched strings are highlighted too while
4466 typing a search command. See also: 'hlsearch'.
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004467 If you don't want to turn 'hlsearch' on, but want to highlight all
4468 matches while searching, you can turn on and off 'hlsearch' with
4469 autocmd. Example: >
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004470 augroup vimrc-incsearch-highlight
4471 autocmd!
Bram Moolenaarf8f8b2e2017-11-02 19:08:48 +01004472 autocmd CmdlineEnter /,\? :set hlsearch
4473 autocmd CmdlineLeave /,\? :set nohlsearch
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004474 augroup END
4475<
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004476 CTRL-L can be used to add one character from after the current match
Bram Moolenaara9dc3752010-07-11 20:46:53 +02004477 to the command line. If 'ignorecase' and 'smartcase' are set and the
4478 command line has no uppercase characters, the added character is
4479 converted to lowercase.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004480 CTRL-R CTRL-W can be used to add the word at the end of the current
4481 match, excluding the characters that were already typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004482 NOTE: This option is reset when 'compatible' is set.
4483
4484 *'indentexpr'* *'inde'*
4485'indentexpr' 'inde' string (default "")
4486 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004487 {not available when compiled without the |+cindent|
4488 or |+eval| features}
4489 Expression which is evaluated to obtain the proper indent for a line.
4490 It is used when a new line is created, for the |=| operator and
4491 in Insert mode as specified with the 'indentkeys' option.
4492 When this option is not empty, it overrules the 'cindent' and
Bram Moolenaar20f90cf2011-05-19 12:22:51 +02004493 'smartindent' indenting. When 'lisp' is set, this option is
4494 overridden by the Lisp indentation algorithm.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004495 When 'paste' is set this option is not used for indenting.
4496 The expression is evaluated with |v:lnum| set to the line number for
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004497 which the indent is to be computed. The cursor is also in this line
Bram Moolenaar071d4272004-06-13 20:20:40 +00004498 when the expression is evaluated (but it may be moved around).
4499 The expression must return the number of spaces worth of indent. It
4500 can return "-1" to keep the current indent (this means 'autoindent' is
4501 used for the indent).
4502 Functions useful for computing the indent are |indent()|, |cindent()|
4503 and |lispindent()|.
4504 The evaluation of the expression must not have side effects! It must
4505 not change the text, jump to another window, etc. Afterwards the
4506 cursor position is always restored, thus the cursor may be moved.
4507 Normally this option would be set to call a function: >
4508 :set indentexpr=GetMyIndent()
4509< Error messages will be suppressed, unless the 'debug' option contains
4510 "msg".
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004511 See |indent-expression|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01004512 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004513
Bram Moolenaar30b65812012-07-12 22:01:11 +02004514 The expression will be evaluated in the |sandbox| when set from a
4515 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004516 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004517
4518 It is not allowed to change text or jump to another window while
4519 evaluating 'indentexpr' |textlock|.
4520
4521
Bram Moolenaar071d4272004-06-13 20:20:40 +00004522 *'indentkeys'* *'indk'*
Bram Moolenaarce655742019-01-31 14:12:57 +01004523'indentkeys' 'indk' string (default "0{,0},0),0],:,0#,!^F,o,O,e")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004524 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004525 {not available when compiled without the |+cindent|
4526 feature}
4527 A list of keys that, when typed in Insert mode, cause reindenting of
4528 the current line. Only happens if 'indentexpr' isn't empty.
4529 The format is identical to 'cinkeys', see |indentkeys-format|.
4530 See |C-indenting| and |indent-expression|.
4531
4532 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
4533'infercase' 'inf' boolean (default off)
4534 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004535 When doing keyword completion in insert mode |ins-completion|, and
Bram Moolenaar446cb832008-06-24 21:56:24 +00004536 'ignorecase' is also on, the case of the match is adjusted depending
4537 on the typed text. If the typed text contains a lowercase letter
4538 where the match has an upper case letter, the completed part is made
4539 lowercase. If the typed text has no lowercase letters and the match
4540 has a lowercase letter where the typed text has an uppercase letter,
4541 and there is a letter before it, the completed part is made uppercase.
4542 With 'noinfercase' the match is used as-is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004543
4544 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
4545'insertmode' 'im' boolean (default off)
4546 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004547 Makes Vim work in a way that Insert mode is the default mode. Useful
4548 if you want to use Vim as a modeless editor. Used for |evim|.
4549 These Insert mode commands will be useful:
4550 - Use the cursor keys to move around.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02004551 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|. When
Bram Moolenaar071d4272004-06-13 20:20:40 +00004552 this is a mapping, it is executed as if 'insertmode' was off.
4553 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004554 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00004555 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
4556 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004557
4558 These items change when 'insertmode' is set:
4559 - when starting to edit of a file, Vim goes to Insert mode.
4560 - <Esc> in Insert mode is a no-op and beeps.
4561 - <Esc> in Normal mode makes Vim go to Insert mode.
4562 - CTRL-L in Insert mode is a command, it is not inserted.
4563 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
4564 However, when <Esc> is used inside a mapping, it behaves like
4565 'insertmode' was not set. This was done to be able to use the same
4566 mappings with 'insertmode' set or not set.
4567 When executing commands with |:normal| 'insertmode' is not used.
4568
4569 NOTE: This option is reset when 'compatible' is set.
4570
4571 *'isfname'* *'isf'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004572'isfname' 'isf' string (default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004573 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
4574 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
4575 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
4576 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
4577 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
4578 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004579 The characters specified by this option are included in file names and
4580 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004581 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004582 Multi-byte characters 256 and above are always included, only the
4583 characters up to 255 are specified with this option.
4584 For UTF-8 the characters 0xa0 to 0xff are included as well.
Bram Moolenaar446cb832008-06-24 21:56:24 +00004585 Think twice before adding white space to this option. Although a
4586 space may appear inside a file name, the effect will be that Vim
4587 doesn't know where a file name starts or ends when doing completion.
4588 It most likely works better without a space in 'isfname'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004589
4590 Note that on systems using a backslash as path separator, Vim tries to
4591 do its best to make it work as you would expect. That is a bit
4592 tricky, since Vi originally used the backslash to escape special
4593 characters. Vim will not remove a backslash in front of a normal file
4594 name character on these systems, but it will on Unix and alikes. The
4595 '&' and '^' are not included by default, because these are special for
4596 cmd.exe.
4597
4598 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004599 Each part can be a single character number or a range. A range is two
4600 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004601 decimal number between 0 and 255 or the ASCII character itself (does
4602 not work for digits). Example:
4603 "_,-,128-140,#-43" (include '_' and '-' and the range
4604 128 to 140 and '#' to 43)
4605 If a part starts with '^', the following character number or range
4606 will be excluded from the option. The option is interpreted from left
4607 to right. Put the excluded character after the range where it is
4608 included. To include '^' itself use it as the last character of the
4609 option or the end of a range. Example:
4610 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
4611 If the character is '@', all characters where isalpha() returns TRUE
4612 are included. Normally these are the characters a to z and A to Z,
4613 plus accented characters. To include '@' itself use "@-@". Examples:
4614 "@,^a-z" All alphabetic characters, excluding lower
Bram Moolenaar446cb832008-06-24 21:56:24 +00004615 case ASCII letters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004616 "a-z,A-Z,@-@" All letters plus the '@' character.
4617 A comma can be included by using it where a character number is
4618 expected. Example:
4619 "48-57,,,_" Digits, comma and underscore.
4620 A comma can be excluded by prepending a '^'. Example:
4621 " -~,^,,9" All characters from space to '~', excluding
4622 comma, plus <Tab>.
4623 See |option-backslash| about including spaces and backslashes.
4624
4625 *'isident'* *'isi'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004626'isident' 'isi' string (default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004627 "@,48-57,_,128-167,224-235"
4628 otherwise: "@,48-57,_,192-255")
4629 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004630 The characters given by this option are included in identifiers.
4631 Identifiers are used in recognizing environment variables and after a
4632 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00004633 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004634 option. For '@' only characters up to 255 are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004635 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004636 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00004637 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
4638
4639 *'iskeyword'* *'isk'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004640'iskeyword' 'isk' string (Vim default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004641 "@,48-57,_,128-167,224-235"
4642 otherwise: "@,48-57,_,192-255"
4643 Vi default: "@,48-57,_")
4644 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004645 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004646 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004647 'isfname' for a description of the format of this option. For '@'
Bram Moolenaar4c295022021-05-02 17:19:11 +02004648 characters above 255 check the "word" character class (any character
4649 that is not white space or punctuation).
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004650 For C programs you could use "a-z,A-Z,48-57,_,.,-,>".
Bram Moolenaar071d4272004-06-13 20:20:40 +00004651 For a help file it is set to all non-blank printable characters except
4652 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
4653 command).
4654 When the 'lisp' option is on the '-' character is always included.
Bram Moolenaarb8060fe2016-01-19 22:29:28 +01004655 This option also influences syntax highlighting, unless the syntax
4656 uses |:syn-iskeyword|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004657 NOTE: This option is set to the Vi default value when 'compatible' is
4658 set and to the Vim default value when 'compatible' is reset.
4659
4660 *'isprint'* *'isp'*
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02004661'isprint' 'isp' string (default for Win32 and macOS:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004662 "@,~-255"; otherwise: "@,161-255")
4663 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004664 The characters given by this option are displayed directly on the
4665 screen. It is also used for "\p" in a |pattern|. The characters from
4666 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
4667 even when they are not included in 'isprint' or excluded. See
4668 'isfname' for a description of the format of this option.
4669
4670 Non-printable characters are displayed with two characters:
4671 0 - 31 "^@" - "^_"
4672 32 - 126 always single characters
4673 127 "^?"
4674 128 - 159 "~@" - "~_"
4675 160 - 254 "| " - "|~"
4676 255 "~?"
4677 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
4678 displayed as <xx>, with the hexadecimal value of the byte.
4679 When 'display' contains "uhex" all unprintable characters are
4680 displayed as <xx>.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004681 The SpecialKey highlighting will be used for unprintable characters.
4682 |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004683
4684 Multi-byte characters 256 and above are always included, only the
4685 characters up to 255 are specified with this option. When a character
4686 is printable but it is not available in the current font, a
4687 replacement character will be shown.
4688 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
4689 There is no option to specify these characters.
4690
4691 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
4692'joinspaces' 'js' boolean (default on)
4693 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004694 Insert two spaces after a '.', '?' and '!' with a join command.
4695 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
4696 Otherwise only one space is inserted.
4697 NOTE: This option is set when 'compatible' is set.
4698
4699 *'key'*
4700'key' string (default "")
4701 local to buffer
Bram Moolenaar996343d2010-07-04 22:20:21 +02004702 {only available when compiled with the |+cryptv|
4703 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004704 The key that is used for encrypting and decrypting the current buffer.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02004705 See |encryption| and 'cryptmethod'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004706 Careful: Do not set the key value by hand, someone might see the typed
4707 key. Use the |:X| command. But you can make 'key' empty: >
4708 :set key=
4709< It is not possible to get the value of this option with ":set key" or
4710 "echo &key". This is to avoid showing it to someone who shouldn't
4711 know. It also means you cannot see it yourself once you have set it,
4712 be careful not to make a typing error!
Bram Moolenaard58e9292011-02-09 17:07:58 +01004713 You can use "&key" in an expression to detect whether encryption is
4714 enabled. When 'key' is set it returns "*****" (five stars).
Bram Moolenaar071d4272004-06-13 20:20:40 +00004715
4716 *'keymap'* *'kmp'* *E544*
4717'keymap' 'kmp' string (default "")
4718 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004719 {only available when compiled with the |+keymap|
4720 feature}
4721 Name of a keyboard mapping. See |mbyte-keymap|.
4722 Setting this option to a valid keymap name has the side effect of
4723 setting 'iminsert' to one, so that the keymap becomes effective.
4724 'imsearch' is also set to one, unless it was -1
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004725 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004726
4727 *'keymodel'* *'km'*
4728'keymodel' 'km' string (default "")
4729 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004730 List of comma separated words, which enable special things that keys
4731 can do. These values can be used:
4732 startsel Using a shifted special key starts selection (either
4733 Select mode or Visual mode, depending on "key" being
4734 present in 'selectmode').
4735 stopsel Using a not-shifted special key stops selection.
4736 Special keys in this context are the cursor keys, <End>, <Home>,
4737 <PageUp> and <PageDown>.
4738 The 'keymodel' option is set by the |:behave| command.
4739
4740 *'keywordprg'* *'kp'*
4741'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02004742 VMS: "help")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004743 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004744 Program to use for the |K| command. Environment variables are
4745 expanded |:set_env|. ":help" may be used to access the Vim internal
4746 help. (Note that previously setting the global option to the empty
4747 value did this, which is now deprecated.)
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02004748 When the first character is ":", the command is invoked as a Vim
4749 Ex command prefixed with [count].
4750 When "man", "man -s" or an Ex command is used, Vim will automatically
4751 translate a count for the "K" command and pass it as the first
4752 argument. For "man -s" the "-s" is removed when there is no count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004753 See |option-backslash| about including spaces and backslashes.
4754 Example: >
4755 :set keywordprg=man\ -s
4756< This option cannot be set from a |modeline| or in the |sandbox|, for
4757 security reasons.
4758
4759 *'langmap'* *'lmap'* *E357* *E358*
4760'langmap' 'lmap' string (default "")
4761 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004762 {only available when compiled with the |+langmap|
4763 feature}
4764 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004765 mode. When you are typing text in Insert mode the characters are
Bram Moolenaarfa735342016-01-03 22:14:44 +01004766 inserted directly. When in Normal mode the 'langmap' option takes
Bram Moolenaar071d4272004-06-13 20:20:40 +00004767 care of translating these special characters to the original meaning
4768 of the key. This means you don't have to change the keyboard mode to
4769 be able to execute Normal mode commands.
4770 This is the opposite of the 'keymap' option, where characters are
4771 mapped in Insert mode.
Bram Moolenaarb17893a2020-03-14 08:19:51 +01004772 Also consider setting 'langremap' to off, to prevent 'langmap' from
4773 applying to characters resulting from a mapping.
Bram Moolenaare968e362014-05-13 20:23:24 +02004774 This option cannot be set from a |modeline| or in the |sandbox|, for
4775 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004776
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00004777 Example (for Greek, in UTF-8): *greek* >
4778 :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 +00004779< Example (exchanges meaning of z and y for commands): >
4780 :set langmap=zy,yz,ZY,YZ
4781<
4782 The 'langmap' option is a list of parts, separated with commas. Each
4783 part can be in one of two forms:
4784 1. A list of pairs. Each pair is a "from" character immediately
4785 followed by the "to" character. Examples: "aA", "aAbBcC".
4786 2. A list of "from" characters, a semi-colon and a list of "to"
4787 characters. Example: "abc;ABC"
4788 Example: "aA,fgh;FGH,cCdDeE"
4789 Special characters need to be preceded with a backslash. These are
Bram Moolenaar4f4d51a2020-10-11 13:57:40 +02004790 ";", ',', '"', '|' and backslash itself.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004791
4792 This will allow you to activate vim actions without having to switch
4793 back and forth between the languages. Your language characters will
4794 be understood as normal vim English characters (according to the
4795 langmap mappings) in the following cases:
4796 o Normal/Visual mode (commands, buffer/register names, user mappings)
4797 o Insert/Replace Mode: Register names after CTRL-R
4798 o Insert/Replace Mode: Mappings
4799 Characters entered in Command-line mode will NOT be affected by
4800 this option. Note that this option can be changed at any time
4801 allowing to switch between mappings for different languages/encodings.
4802 Use a mapping to avoid having to type it each time!
4803
4804 *'langmenu'* *'lm'*
4805'langmenu' 'lm' string (default "")
4806 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004807 {only available when compiled with the |+menu| and
4808 |+multi_lang| features}
4809 Language to use for menu translation. Tells which file is loaded
4810 from the "lang" directory in 'runtimepath': >
4811 "lang/menu_" . &langmenu . ".vim"
4812< (without the spaces). For example, to always use the Dutch menus, no
4813 matter what $LANG is set to: >
4814 :set langmenu=nl_NL.ISO_8859-1
4815< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004816 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004817 If your $LANG is set to a non-English language but you do want to use
4818 the English menus: >
4819 :set langmenu=none
4820< This option must be set before loading menus, switching on filetype
4821 detection or syntax highlighting. Once the menus are defined setting
4822 this option has no effect. But you could do this: >
4823 :source $VIMRUNTIME/delmenu.vim
4824 :set langmenu=de_DE.ISO_8859-1
4825 :source $VIMRUNTIME/menu.vim
4826< Warning: This deletes all menus that you defined yourself!
4827
Bram Moolenaard94464e2015-11-02 15:28:18 +01004828 *'langnoremap'* *'lnr'* *'nolangnoremap'* *'nolnr'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004829'langnoremap' 'lnr' boolean (default off, set in |defaults.vim|)
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004830 global
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004831 {only available when compiled with the |+langmap|
4832 feature}
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004833 This is just like 'langremap' but with the value inverted. It only
4834 exists for backwards compatibility. When setting 'langremap' then
4835 'langnoremap' is set to the inverted value, and the other way around.
4836
4837 *'langremap'* *'lrm'* *'nolangremap'* *'nolrm'*
Bram Moolenaarb17893a2020-03-14 08:19:51 +01004838'langremap' 'lrm' boolean (default on, set to off in |defaults.vim|)
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004839 global
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004840 {only available when compiled with the |+langmap|
4841 feature}
4842 When off, setting 'langmap' does not apply to characters resulting from
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004843 a mapping. This basically means, if you noticed that setting
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004844 'langmap' disables some of your mappings, try resetting this option.
4845 This option defaults to on for backwards compatibility. Set it off if
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004846 that works for you to avoid mappings to break.
4847
Bram Moolenaar071d4272004-06-13 20:20:40 +00004848 *'laststatus'* *'ls'*
4849'laststatus' 'ls' number (default 1)
4850 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004851 The value of this option influences when the last window will have a
4852 status line:
4853 0: never
4854 1: only if there are at least two windows
4855 2: always
4856 The screen looks nicer with a status line if you have several
4857 windows, but it takes another screen line. |status-line|
4858
4859 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
4860'lazyredraw' 'lz' boolean (default off)
4861 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004862 When this option is set, the screen will not be redrawn while
4863 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004864 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00004865 update use |:redraw|.
4866
4867 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
4868'linebreak' 'lbr' boolean (default off)
4869 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02004870 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004871 feature}
Bram Moolenaar946e27a2014-06-25 18:50:27 +02004872 If on, Vim will wrap long lines at a character in 'breakat' rather
Bram Moolenaar071d4272004-06-13 20:20:40 +00004873 than at the last character that fits on the screen. Unlike
4874 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
Bram Moolenaar946e27a2014-06-25 18:50:27 +02004875 it only affects the way the file is displayed, not its contents.
4876 If 'breakindent' is set, line is visually indented. Then, the value
4877 of 'showbreak' is used to put in front of wrapped lines. This option
Bram Moolenaar86b17e92014-07-02 20:00:47 +02004878 is not used when the 'wrap' option is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004879 Note that <Tab> characters after an <EOL> are mostly not displayed
4880 with the right amount of white space.
4881
4882 *'lines'* *E593*
4883'lines' number (default 24 or terminal height)
4884 global
4885 Number of lines of the Vim window.
4886 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00004887 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004888 When Vim is running in the GUI or in a resizable window, setting this
4889 option will cause the window size to be changed. When you only want
4890 to use the size for the GUI, put the command in your |gvimrc| file.
4891 Vim limits the number of lines to what fits on the screen. You can
4892 use this command to get the tallest window possible: >
4893 :set lines=999
Bram Moolenaarf4d11452005-12-02 00:46:37 +00004894< Minimum value is 2, maximum value is 1000.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02004895 If you get fewer lines than expected, check the 'guiheadroom' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004896 When you set this option and Vim is unable to change the physical
4897 number of lines of the display, the display may be messed up.
4898
4899 *'linespace'* *'lsp'*
4900'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
4901 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004902 {only in the GUI}
4903 Number of pixel lines inserted between characters. Useful if the font
4904 uses the full character cell height, making lines touch each other.
4905 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004906 With some fonts there can be too much room between lines (to have
4907 space for ascents and descents). Then it makes sense to set
4908 'linespace' to a negative value. This may cause display problems
4909 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00004910
4911 *'lisp'* *'nolisp'*
4912'lisp' boolean (default off)
4913 local to buffer
4914 {not available when compiled without the |+lispindent|
4915 feature}
4916 Lisp mode: When <Enter> is typed in insert mode set the indent for
4917 the next line to Lisp standards (well, sort of). Also happens with
4918 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
4919 flag in 'cpoptions' changes the method of indenting: Vi compatible or
4920 better. Also see 'lispwords'.
4921 The '-' character is included in keyword characters. Redefines the
4922 "=" operator to use this same indentation algorithm rather than
4923 calling an external program if 'equalprg' is empty.
4924 This option is not used when 'paste' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004925
4926 *'lispwords'* *'lw'*
4927'lispwords' 'lw' string (default is very long)
Bram Moolenaaraf6c1312014-03-12 18:55:58 +01004928 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004929 {not available when compiled without the |+lispindent|
4930 feature}
4931 Comma separated list of words that influence the Lisp indenting.
4932 |'lisp'|
4933
4934 *'list'* *'nolist'*
4935'list' boolean (default off)
4936 local to window
Bram Moolenaar113cb512021-11-07 20:27:04 +00004937 List mode: By default show tabs as CTRL-I is displayed, display $
4938 after end of line. Useful to see the difference between tabs and
4939 spaces and for trailing blanks. Further changed by the 'listchars'
4940 option.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004941
4942 The cursor is displayed at the start of the space a Tab character
4943 occupies, not at the end as usual in Normal mode. To get this cursor
4944 position while displaying Tabs with spaces, use: >
Bram Moolenaardd007ed2013-07-09 15:44:17 +02004945 :set list lcs=tab:\ \
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004946<
4947 Note that list mode will also affect formatting (set with 'textwidth'
4948 or 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
Bram Moolenaar071d4272004-06-13 20:20:40 +00004949 changing the way tabs are displayed.
4950
4951 *'listchars'* *'lcs'*
4952'listchars' 'lcs' string (default "eol:$")
Bram Moolenaareed9d462021-02-15 20:38:25 +01004953 global or local to window |global-local|
Bram Moolenaarf9d5ca12010-08-01 16:13:51 +02004954 Strings to use in 'list' mode and for the |:list| command. It is a
4955 comma separated list of string settings.
Bram Moolenaar79278362015-04-21 18:33:48 +02004956 *lcs-eol*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004957 eol:c Character to show at the end of each line. When
4958 omitted, there is no extra character at the end of the
4959 line.
Bram Moolenaar79278362015-04-21 18:33:48 +02004960 *lcs-tab*
Bram Moolenaar83a52172019-01-16 22:41:54 +01004961 tab:xy[z] Two or three characters to be used to show a tab.
4962 The third character is optional.
4963
4964 tab:xy The 'x' is always used, then 'y' as many times as will
4965 fit. Thus "tab:>-" displays:
4966 >
4967 >-
4968 >--
4969 etc.
4970
4971 tab:xyz The 'z' is always used, then 'x' is prepended, and
4972 then 'y' is used as many times as will fit. Thus
4973 "tab:<->" displays:
4974 >
4975 <>
4976 <->
4977 <-->
4978 etc.
4979
4980 When "tab:" is omitted, a tab is shown as ^I.
Bram Moolenaar79278362015-04-21 18:33:48 +02004981 *lcs-space*
4982 space:c Character to show for a space. When omitted, spaces
4983 are left blank.
zeertzjqf14b8ba2021-09-10 16:58:30 +02004984 *lcs-multispace*
4985 multispace:c...
4986 One or more characters to use cyclically to show for
4987 multiple consecutive spaces. Overrides the "space"
4988 setting, except for single spaces. When omitted, the
4989 "space" setting is used. For example,
4990 `:set listchars=multispace:---+` shows ten consecutive
4991 spaces as:
4992 ---+---+--
Bram Moolenaar91478ae2021-02-03 15:58:13 +01004993 *lcs-lead*
4994 lead:c Character to show for leading spaces. When omitted,
zeertzjqf14b8ba2021-09-10 16:58:30 +02004995 leading spaces are blank. Overrides the "space" and
4996 "multispace" settings for leading spaces. You can
4997 combine it with "tab:", for example: >
Bram Moolenaar942db232021-02-13 18:14:48 +01004998 :set listchars+=tab:>-,lead:.
4999< *lcs-trail*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005000 trail:c Character to show for trailing spaces. When omitted,
zeertzjqf14b8ba2021-09-10 16:58:30 +02005001 trailing spaces are blank. Overrides the "space" and
5002 "multispace" settings for trailing spaces.
Bram Moolenaar79278362015-04-21 18:33:48 +02005003 *lcs-extends*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005004 extends:c Character to show in the last column, when 'wrap' is
5005 off and the line continues beyond the right of the
5006 screen.
Bram Moolenaar79278362015-04-21 18:33:48 +02005007 *lcs-precedes*
Bram Moolenaarbffba7f2019-09-20 17:00:17 +02005008 precedes:c Character to show in the first visible column of the
5009 physical line, when there is text preceding the
5010 character visible in the first column.
Bram Moolenaar79278362015-04-21 18:33:48 +02005011 *lcs-conceal*
Bram Moolenaar860cae12010-06-05 23:22:07 +02005012 conceal:c Character to show in place of concealed text, when
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02005013 'conceallevel' is set to 1.
Bram Moolenaar79278362015-04-21 18:33:48 +02005014 *lcs-nbsp*
Bram Moolenaar73284b92015-05-04 17:28:22 +02005015 nbsp:c Character to show for a non-breakable space character
5016 (0xA0 (160 decimal) and U+202F). Left blank when
5017 omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005018
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005019 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00005020 be used when 'encoding' is "utf-8", otherwise only printable
Bram Moolenaar910f66f2006-04-05 20:41:53 +00005021 characters are allowed. All characters must be single width.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005022
Bram Moolenaar93ff6722021-10-16 17:51:40 +01005023 Each character can be specified as hex: >
5024 set listchars=eol:\\x24
5025 set listchars=eol:\\u21b5
5026 set listchars=eol:\\U000021b5
5027< Note that a double backslash is used. The number of hex characters
5028 must be exactly 2 for \\x, 4 for \\u and 8 for \\U.
5029
Bram Moolenaar071d4272004-06-13 20:20:40 +00005030 Examples: >
5031 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005032 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00005033 :set lcs=extends:>,precedes:<
5034< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaar34cc7d82021-09-21 20:09:51 +02005035 "precedes". "SpecialKey" will be used for "tab", "nbsp", "space",
5036 "multispace", "lead" and "trail".
Bram Moolenaar02467872007-05-06 13:22:01 +00005037 |hl-NonText| |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005038
5039 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
5040'loadplugins' 'lpl' boolean (default on)
5041 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005042 When on the plugin scripts are loaded when starting up |load-plugins|.
5043 This option can be reset in your |vimrc| file to disable the loading
5044 of plugins.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02005045 Note that using the "-u NONE", "-u DEFAULTS" and "--noplugin" command
5046 line arguments reset this option. See |-u| and |--noplugin|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005047
Bram Moolenaard94464e2015-11-02 15:28:18 +01005048 *'luadll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01005049'luadll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01005050 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01005051 {only available when compiled with the |+lua/dyn|
5052 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005053 Specifies the name of the Lua shared library. The default is
5054 DYNAMIC_LUA_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005055 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01005056 This option cannot be set from a |modeline| or in the |sandbox|, for
5057 security reasons.
5058
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00005059 *'macatsui'* *'nomacatsui'*
5060'macatsui' boolean (default on)
5061 global
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02005062 {not supported}
5063 No longer supported, as the Mac OS X GUI code was removed.
Bram Moolenaar02467872007-05-06 13:22:01 +00005064
Bram Moolenaar071d4272004-06-13 20:20:40 +00005065 *'magic'* *'nomagic'*
5066'magic' boolean (default on)
5067 global
5068 Changes the special characters that can be used in search patterns.
5069 See |pattern|.
Bram Moolenaar64d8e252016-09-06 22:12:34 +02005070 WARNING: Switching this option off most likely breaks plugins! That
5071 is because many patterns assume it's on and will fail when it's off.
5072 Only switch it off when working with old Vi scripts. In any other
5073 situation write patterns that work when 'magic' is on. Include "\M"
5074 when you want to |/\M|.
Bram Moolenaar4072ba52020-12-23 13:56:35 +01005075 In |Vim9| script the value of 'magic' is ignored, patterns behave like
5076 it is always set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005077
5078 *'makeef'* *'mef'*
5079'makeef' 'mef' string (default: "")
5080 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005081 {not available when compiled without the |+quickfix|
5082 feature}
5083 Name of the errorfile for the |:make| command (see |:make_makeprg|)
5084 and the |:grep| command.
5085 When it is empty, an internally generated temp file will be used.
5086 When "##" is included, it is replaced by a number to make the name
5087 unique. This makes sure that the ":make" command doesn't overwrite an
5088 existing file.
5089 NOT used for the ":cf" command. See 'errorfile' for that.
5090 Environment variables are expanded |:set_env|.
5091 See |option-backslash| about including spaces and backslashes.
5092 This option cannot be set from a |modeline| or in the |sandbox|, for
5093 security reasons.
5094
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01005095 *'makeencoding'* *'menc'*
5096'makeencoding' 'menc' string (default "")
5097 global or local to buffer |global-local|
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01005098 Encoding used for reading the output of external commands. When empty,
5099 encoding is not converted.
5100 This is used for `:make`, `:lmake`, `:grep`, `:lgrep`, `:grepadd`,
5101 `:lgrepadd`, `:cfile`, `:cgetfile`, `:caddfile`, `:lfile`, `:lgetfile`,
5102 and `:laddfile`.
5103
5104 This would be mostly useful when you use MS-Windows and set 'encoding'
5105 to "utf-8". If |+iconv| is enabled and GNU libiconv is used, setting
5106 'makeencoding' to "char" has the same effect as setting to the system
5107 locale encoding. Example: >
5108 :set encoding=utf-8
5109 :set makeencoding=char " system locale is used
5110<
Bram Moolenaar071d4272004-06-13 20:20:40 +00005111 *'makeprg'* *'mp'*
5112'makeprg' 'mp' string (default "make", VMS: "MMS")
5113 global or local to buffer |global-local|
Bram Moolenaar02467872007-05-06 13:22:01 +00005114 Program to use for the ":make" command. See |:make_makeprg|.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01005115 This option may contain '%' and '#' characters (see |:_%| and |:_#|),
5116 which are expanded to the current and alternate file name. Use |::S|
Bram Moolenaar26df0922014-02-23 23:39:13 +01005117 to escape file names in case they contain special characters.
Bram Moolenaar02467872007-05-06 13:22:01 +00005118 Environment variables are expanded |:set_env|. See |option-backslash|
5119 about including spaces and backslashes.
5120 Note that a '|' must be escaped twice: once for ":set" and once for
5121 the interpretation of a command. When you use a filter called
5122 "myfilter" do it like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005123 :set makeprg=gmake\ \\\|\ myfilter
5124< The placeholder "$*" can be given (even multiple times) to specify
5125 where the arguments will be included, for example: >
5126 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
5127< This option cannot be set from a |modeline| or in the |sandbox|, for
5128 security reasons.
5129
5130 *'matchpairs'* *'mps'*
5131'matchpairs' 'mps' string (default "(:),{:},[:]")
5132 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005133 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01005134 other.
5135 Only character pairs are allowed that are different, thus you cannot
5136 jump between two double quotes.
5137 The characters must be separated by a colon.
Bram Moolenaar02467872007-05-06 13:22:01 +00005138 The pairs must be separated by a comma. Example for including '<' and
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02005139 '>' (for HTML): >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005140 :set mps+=<:>
5141
5142< A more exotic example, to jump between the '=' and ';' in an
5143 assignment, useful for languages like C and Java: >
5144 :au FileType c,cpp,java set mps+==:;
5145
5146< For a more advanced way of using "%", see the matchit.vim plugin in
Bram Moolenaar01164a62017-11-02 22:58:42 +01005147 the $VIMRUNTIME/pack/dist/opt/matchit directory. |add-local-help|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005148
5149 *'matchtime'* *'mat'*
5150'matchtime' 'mat' number (default 5)
5151 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005152 Tenths of a second to show the matching paren, when 'showmatch' is
5153 set. Note that this is not in milliseconds, like other options that
5154 set a time. This is to be compatible with Nvi.
5155
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005156 *'maxcombine'* *'mco'*
5157'maxcombine' 'mco' number (default 2)
5158 global
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005159 The maximum number of combining characters supported for displaying.
5160 Only used when 'encoding' is "utf-8".
5161 The default is OK for most languages. Hebrew may require 4.
5162 Maximum value is 6.
5163 Even when this option is set to 2 you can still edit text with more
5164 combining characters, you just can't see them. Use |g8| or |ga|.
5165 See |mbyte-combining|.
5166
Bram Moolenaar071d4272004-06-13 20:20:40 +00005167 *'maxfuncdepth'* *'mfd'*
5168'maxfuncdepth' 'mfd' number (default 100)
5169 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02005170 {not available when compiled without the |+eval|
Bram Moolenaar02467872007-05-06 13:22:01 +00005171 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005172 Maximum depth of function calls for user functions. This normally
5173 catches endless recursion. When using a recursive function with
5174 more depth, set 'maxfuncdepth' to a bigger number. But this will use
5175 more memory, there is the danger of failing when memory is exhausted.
Bram Moolenaarbc2eada2017-01-02 21:27:47 +01005176 Increasing this limit above 200 also changes the maximum for Ex
Bram Moolenaar0b0f0992018-05-22 21:41:30 +02005177 command recursion, see |E169|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005178 See also |:function|.
5179
5180 *'maxmapdepth'* *'mmd'* *E223*
5181'maxmapdepth' 'mmd' number (default 1000)
5182 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005183 Maximum number of times a mapping is done without resulting in a
5184 character to be used. This normally catches endless mappings, like
5185 ":map x y" with ":map y x". It still does not catch ":map g wg",
5186 because the 'w' is used before the next mapping is done. See also
5187 |key-mapping|.
5188
5189 *'maxmem'* *'mm'*
5190'maxmem' 'mm' number (default between 256 to 5120 (system
5191 dependent) or half the amount of memory
5192 available)
5193 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005194 Maximum amount of memory (in Kbyte) to use for one buffer. When this
5195 limit is reached allocating extra memory for a buffer will cause
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005196 other memory to be freed.
5197 The maximum usable value is about 2000000. Use this to work without a
5198 limit.
5199 The value is ignored when 'swapfile' is off.
5200 Also see 'maxmemtot'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005201
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005202 *'maxmempattern'* *'mmp'*
5203'maxmempattern' 'mmp' number (default 1000)
5204 global
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005205 Maximum amount of memory (in Kbyte) to use for pattern matching.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005206 The maximum value is about 2000000. Use this to work without a limit.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005207 *E363*
Bram Moolenaar02467872007-05-06 13:22:01 +00005208 When Vim runs into the limit it gives an error message and mostly
5209 behaves like CTRL-C was typed.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005210 Running into the limit often means that the pattern is very
5211 inefficient or too complex. This may already happen with the pattern
5212 "\(.\)*" on a very long line. ".*" works much better.
Bram Moolenaarfd358112018-07-07 23:21:31 +02005213 Might also happen on redraw, when syntax rules try to match a complex
5214 text structure.
5215 Vim may run out of memory before hitting the 'maxmempattern' limit, in
5216 which case you get an "Out of memory" error instead.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005217
Bram Moolenaar071d4272004-06-13 20:20:40 +00005218 *'maxmemtot'* *'mmt'*
5219'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
5220 dependent) or half the amount of memory
5221 available)
5222 global
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005223 Maximum amount of memory in Kbyte to use for all buffers together.
5224 The maximum usable value is about 2000000 (2 Gbyte). Use this to work
Bram Moolenaarfa735342016-01-03 22:14:44 +01005225 without a limit.
5226 On 64 bit machines higher values might work. But hey, do you really
5227 need more than 2 Gbyte for text editing? Keep in mind that text is
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005228 stored in the swap file, one can edit files > 2 Gbyte anyway. We do
Bram Moolenaarfa735342016-01-03 22:14:44 +01005229 need the memory to store undo info.
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005230 Buffers with 'swapfile' off still count to the total amount of memory
5231 used.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005232 Also see 'maxmem'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005233
5234 *'menuitems'* *'mis'*
5235'menuitems' 'mis' number (default 25)
5236 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005237 {not available when compiled without the |+menu|
5238 feature}
5239 Maximum number of items to use in a menu. Used for menus that are
5240 generated from a list of items, e.g., the Buffers menu. Changing this
5241 option has no direct effect, the menu must be refreshed first.
5242
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005243 *'mkspellmem'* *'msm'*
5244'mkspellmem' 'msm' string (default "460000,2000,500")
5245 global
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005246 {not available when compiled without the |+syntax|
5247 feature}
5248 Parameters for |:mkspell|. This tunes when to start compressing the
5249 word tree. Compression can be slow when there are many words, but
5250 it's needed to avoid running out of memory. The amount of memory used
5251 per word depends very much on how similar the words are, that's why
5252 this tuning is complicated.
5253
5254 There are three numbers, separated by commas:
5255 {start},{inc},{added}
5256
5257 For most languages the uncompressed word tree fits in memory. {start}
5258 gives the amount of memory in Kbyte that can be used before any
5259 compression is done. It should be a bit smaller than the amount of
5260 memory that is available to Vim.
5261
5262 When going over the {start} limit the {inc} number specifies the
5263 amount of memory in Kbyte that can be allocated before another
5264 compression is done. A low number means compression is done after
5265 less words are added, which is slow. A high number means more memory
5266 will be allocated.
5267
5268 After doing compression, {added} times 1024 words can be added before
5269 the {inc} limit is ignored and compression is done when any extra
5270 amount of memory is needed. A low number means there is a smaller
5271 chance of hitting the {inc} limit, less memory is used but it's
5272 slower.
5273
5274 The languages for which these numbers are important are Italian and
5275 Hungarian. The default works for when you have about 512 Mbyte. If
5276 you have 1 Gbyte you could use: >
5277 :set mkspellmem=900000,3000,800
5278< If you have less than 512 Mbyte |:mkspell| may fail for some
5279 languages, no matter what you set 'mkspellmem' to.
5280
Bram Moolenaar07607392019-05-26 19:20:43 +02005281 This option cannot be set from a |modeline| or in the |sandbox|.
5282
Bram Moolenaar071d4272004-06-13 20:20:40 +00005283 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
Bram Moolenaar8243a792007-05-01 17:05:03 +00005284'modeline' 'ml' boolean (Vim default: on (off for root),
5285 Vi default: off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005286 local to buffer
Bram Moolenaar110289e2019-05-23 15:38:06 +02005287 If 'modeline' is on 'modelines' gives the number of lines that is
5288 checked for set commands. If 'modeline' is off or 'modelines' is zero
5289 no lines are checked. See |modeline|.
5290
5291 *'modelineexpr'* *'mle'* *'nomodelineexpr'* *'nomle'*
5292'modelineexpr' 'mle' boolean (default: off)
5293 global
5294 When on allow some options that are an expression to be set in the
5295 modeline. Check the option for whether it is affected by
5296 'modelineexpr'. Also see |modeline|.
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02005297 This option cannot be set from a |modeline| or in the |sandbox|, for
5298 security reasons.
Bram Moolenaar110289e2019-05-23 15:38:06 +02005299
Bram Moolenaar071d4272004-06-13 20:20:40 +00005300 *'modelines'* *'mls'*
5301'modelines' 'mls' number (default 5)
5302 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005303 If 'modeline' is on 'modelines' gives the number of lines that is
5304 checked for set commands. If 'modeline' is off or 'modelines' is zero
5305 no lines are checked. See |modeline|.
5306 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
5307 set and to the Vim default value when 'compatible' is reset.
5308
5309 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
Bram Moolenaar110289e2019-05-23 15:38:06 +02005310 *E21*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005311'modifiable' 'ma' boolean (default on)
5312 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005313 When off the buffer contents cannot be changed. The 'fileformat' and
5314 'fileencoding' options also can't be changed.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01005315 Can be reset on startup with the |-M| command line argument.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005316
5317 *'modified'* *'mod'* *'nomodified'* *'nomod'*
5318'modified' 'mod' boolean (default off)
5319 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005320 When on, the buffer is considered to be modified. This option is set
5321 when:
5322 1. A change was made to the text since it was last written. Using the
5323 |undo| command to go back to the original text will reset the
5324 option. But undoing changes that were made before writing the
5325 buffer will set the option again, since the text is different from
5326 when it was written.
5327 2. 'fileformat' or 'fileencoding' is different from its original
5328 value. The original value is set when the buffer is read or
5329 written. A ":set nomodified" command also resets the original
5330 values to the current values and the 'modified' option will be
5331 reset.
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01005332 Similarly for 'eol' and 'bomb'.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02005333 This option is not set when a change is made to the buffer as the
5334 result of a BufNewFile, BufRead/BufReadPost, BufWritePost,
5335 FileAppendPost or VimLeave autocommand event. See |gzip-example| for
5336 an explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005337 When 'buftype' is "nowrite" or "nofile" this option may be set, but
5338 will be ignored.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01005339 Note that the text may actually be the same, e.g. 'modified' is set
5340 when using "rA" on an "A".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005341
5342 *'more'* *'nomore'*
5343'more' boolean (Vim default: on, Vi default: off)
5344 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005345 When on, listings pause when the whole screen is filled. You will get
5346 the |more-prompt|. When this option is off there are no pauses, the
5347 listing continues until finished.
5348 NOTE: This option is set to the Vi default value when 'compatible' is
5349 set and to the Vim default value when 'compatible' is reset.
5350
Bram Moolenaar98a29d02021-01-18 19:55:44 +01005351 *'mouse'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005352'mouse' string (default "", "a" for GUI and Win32,
Bram Moolenaar5b418992019-10-27 18:50:25 +01005353 set to "a" or "nvi" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005354 global
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005355 Enable the use of the mouse. Works for most terminals (xterm, Win32
5356 |win32-mouse|, QNX pterm, *BSD console with sysmouse and Linux console
5357 with gpm). For using the mouse in the GUI, see |gui-mouse|. The
5358 mouse can be enabled for different modes:
Bram Moolenaar7f2e9d72017-11-11 20:58:53 +01005359 n Normal mode and Terminal modes
Bram Moolenaar071d4272004-06-13 20:20:40 +00005360 v Visual mode
5361 i Insert mode
5362 c Command-line mode
5363 h all previous modes when editing a help file
5364 a all previous modes
5365 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005366 Normally you would enable the mouse in all five modes with: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005367 :set mouse=a
Bram Moolenaar5b418992019-10-27 18:50:25 +01005368< If your terminal can't overrule the mouse events going to the
5369 application, use: >
5370 :set mouse=nvi
Bram Moolenaar65e0d772020-06-14 17:29:55 +02005371< Then you can press ":", select text for the system, and press Esc to go
Bram Moolenaar5b418992019-10-27 18:50:25 +01005372 back to Vim using the mouse events.
5373 In |defaults.vim| "nvi" is used if the 'term' option is not matching
5374 "xterm".
5375
5376 When the mouse is not enabled, the GUI will still use the mouse for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005377 modeless selection. This doesn't move the text cursor.
5378
5379 See |mouse-using|. Also see |'clipboard'|.
5380
5381 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005382 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005383 the mouse buttons can still be used by keeping the shift key pressed.
5384 Also see the 'clipboard' option.
5385
5386 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
5387'mousefocus' 'mousef' boolean (default off)
5388 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005389 {only works in the GUI}
5390 The window that the mouse pointer is on is automatically activated.
5391 When changing the window layout or window focus in another way, the
5392 mouse pointer is moved to the window with keyboard focus. Off is the
5393 default because it makes using the pull down menus a little goofy, as
5394 a pointer transit may activate a window unintentionally.
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01005395 MS-Windows: Also see 'scrollfocus' for what window is scrolled when
Bram Moolenaar1d9215b2020-01-25 13:27:42 +01005396 using the mouse scroll wheel.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005397
5398 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
5399'mousehide' 'mh' boolean (default on)
5400 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005401 {only works in the GUI}
5402 When on, the mouse pointer is hidden when characters are typed.
5403 The mouse pointer is restored when the mouse is moved.
5404
5405 *'mousemodel'* *'mousem'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005406'mousemodel' 'mousem' string (default "extend", "popup" for Win32)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005407 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005408 Sets the model to use for the mouse. The name mostly specifies what
5409 the right mouse button is used for:
5410 extend Right mouse button extends a selection. This works
5411 like in an xterm.
5412 popup Right mouse button pops up a menu. The shifted left
5413 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00005414 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005415 popup_setpos Like "popup", but the cursor will be moved to the
5416 position where the mouse was clicked, and thus the
5417 selected operation will act upon the clicked object.
5418 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00005419 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005420 course, that right clicking outside a selection will
5421 end Visual mode.
5422 Overview of what button does what for each model:
5423 mouse extend popup(_setpos) ~
5424 left click place cursor place cursor
5425 left drag start selection start selection
5426 shift-left search word extend selection
5427 right click extend selection popup menu (place cursor)
5428 right drag extend selection -
5429 middle click paste paste
5430
5431 In the "popup" model the right mouse button produces a pop-up menu.
5432 You need to define this first, see |popup-menu|.
5433
5434 Note that you can further refine the meaning of buttons with mappings.
5435 See |gui-mouse-mapping|. But mappings are NOT used for modeless
5436 selection (because that's handled in the GUI code directly).
5437
5438 The 'mousemodel' option is set by the |:behave| command.
5439
5440 *'mouseshape'* *'mouses'* *E547*
Bram Moolenaarf6b40102019-02-22 15:24:03 +01005441'mouseshape' 'mouses' string (default "i-r:beam,s:updown,sd:udsizing,
5442 vs:leftright,vd:lrsizing,m:no,
5443 ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005444 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005445 {only available when compiled with the |+mouseshape|
5446 feature}
5447 This option tells Vim what the mouse pointer should look like in
5448 different modes. The option is a comma separated list of parts, much
5449 like used for 'guicursor'. Each part consist of a mode/location-list
5450 and an argument-list:
5451 mode-list:shape,mode-list:shape,..
5452 The mode-list is a dash separated list of these modes/locations:
5453 In a normal window: ~
5454 n Normal mode
5455 v Visual mode
5456 ve Visual mode with 'selection' "exclusive" (same as 'v',
5457 if not specified)
5458 o Operator-pending mode
5459 i Insert mode
5460 r Replace mode
5461
5462 Others: ~
5463 c appending to the command-line
5464 ci inserting in the command-line
5465 cr replacing in the command-line
5466 m at the 'Hit ENTER' or 'More' prompts
5467 ml idem, but cursor in the last line
5468 e any mode, pointer below last window
5469 s any mode, pointer on a status line
5470 sd any mode, while dragging a status line
5471 vs any mode, pointer on a vertical separator line
5472 vd any mode, while dragging a vertical separator line
5473 a everywhere
5474
5475 The shape is one of the following:
5476 avail name looks like ~
5477 w x arrow Normal mouse pointer
5478 w x blank no pointer at all (use with care!)
5479 w x beam I-beam
5480 w x updown up-down sizing arrows
5481 w x leftright left-right sizing arrows
5482 w x busy The system's usual busy pointer
5483 w x no The system's usual 'no input' pointer
5484 x udsizing indicates up-down resizing
5485 x lrsizing indicates left-right resizing
5486 x crosshair like a big thin +
5487 x hand1 black hand
5488 x hand2 white hand
5489 x pencil what you write with
5490 x question big ?
5491 x rightup-arrow arrow pointing right-up
5492 w x up-arrow arrow pointing up
5493 x <number> any X11 pointer number (see X11/cursorfont.h)
5494
5495 The "avail" column contains a 'w' if the shape is available for Win32,
5496 x for X11.
5497 Any modes not specified or shapes not available use the normal mouse
5498 pointer.
5499
5500 Example: >
5501 :set mouseshape=s:udsizing,m:no
5502< will make the mouse turn to a sizing arrow over the status lines and
5503 indicate no input when the hit-enter prompt is displayed (since
5504 clicking the mouse has no effect in this state.)
5505
5506 *'mousetime'* *'mouset'*
5507'mousetime' 'mouset' number (default 500)
5508 global
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005509 Only for GUI, Win32 and Unix with xterm. Defines the maximum
Bram Moolenaar071d4272004-06-13 20:20:40 +00005510 time in msec between two mouse clicks for the second click to be
5511 recognized as a multi click.
5512
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005513 *'mzschemedll'*
5514'mzschemedll' string (default depends on the build)
5515 global
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005516 {only available when compiled with the |+mzscheme/dyn|
5517 feature}
5518 Specifies the name of the MzScheme shared library. The default is
5519 DYNAMIC_MZSCH_DLL which was specified at compile time.
5520 Environment variables are expanded |:set_env|.
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01005521 The value must be set in the |vimrc| script or earlier. In the
Bram Moolenaar01164a62017-11-02 22:58:42 +01005522 startup, before the |load-plugins| step.
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005523 This option cannot be set from a |modeline| or in the |sandbox|, for
5524 security reasons.
5525
5526 *'mzschemegcdll'*
5527'mzschemegcdll' string (default depends on the build)
5528 global
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005529 {only available when compiled with the |+mzscheme/dyn|
5530 feature}
5531 Specifies the name of the MzScheme GC shared library. The default is
5532 DYNAMIC_MZGC_DLL which was specified at compile time.
5533 The value can be equal to 'mzschemedll' if it includes the GC code.
5534 Environment variables are expanded |:set_env|.
5535 This option cannot be set from a |modeline| or in the |sandbox|, for
5536 security reasons.
5537
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005538 *'mzquantum'* *'mzq'*
5539'mzquantum' 'mzq' number (default 100)
5540 global
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005541 {not available when compiled without the |+mzscheme|
5542 feature}
5543 The number of milliseconds between polls for MzScheme threads.
5544 Negative or zero value means no thread scheduling.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005545 NOTE: This option is set to the Vim default value when 'compatible'
5546 is reset.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005547
Bram Moolenaar071d4272004-06-13 20:20:40 +00005548 *'nrformats'* *'nf'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02005549'nrformats' 'nf' string (default "bin,octal,hex",
5550 set to "bin,hex" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005551 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005552 This defines what bases Vim will consider for numbers when using the
5553 CTRL-A and CTRL-X commands for adding to and subtracting from a number
5554 respectively; see |CTRL-A| for more info on these commands.
Bram Moolenaar4770d092006-01-12 23:22:24 +00005555 alpha If included, single alphabetical characters will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005556 incremented or decremented. This is useful for a list with a
Bram Moolenaar3848e002016-03-19 18:42:29 +01005557 letter index a), b), etc. *octal-nrformats*
Bram Moolenaar4770d092006-01-12 23:22:24 +00005558 octal If included, numbers that start with a zero will be considered
Bram Moolenaar071d4272004-06-13 20:20:40 +00005559 to be octal. Example: Using CTRL-A on "007" results in "010".
Bram Moolenaar4770d092006-01-12 23:22:24 +00005560 hex If included, numbers starting with "0x" or "0X" will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005561 considered to be hexadecimal. Example: Using CTRL-X on
5562 "0x100" results in "0x0ff".
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005563 bin If included, numbers starting with "0b" or "0B" will be
5564 considered to be binary. Example: Using CTRL-X on
5565 "0b1000" subtracts one, resulting in "0b0111".
Bram Moolenaaraaad9952020-05-31 15:08:59 +02005566 unsigned If included, numbers are recognized as unsigned. Thus a
5567 leading dash or negative sign won't be considered as part of
5568 the number. Examples:
5569 Using CTRL-X on "2020" in "9-2020" results in "9-2019"
5570 (without "unsigned" it would become "9-2021").
5571 Using CTRL-A on "2020" in "9-2020" results in "9-2021"
5572 (without "unsigned" it would become "9-2019").
Bram Moolenaaracc22402020-06-07 21:07:18 +02005573 Using CTRL-X on "0" or CTRL-A on "18446744073709551615"
5574 (2^64 - 1) has no effect, overflow is prevented.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005575 Numbers which simply begin with a digit in the range 1-9 are always
5576 considered decimal. This also happens for numbers that are not
5577 recognized as octal or hex.
5578
5579 *'number'* *'nu'* *'nonumber'* *'nonu'*
5580'number' 'nu' boolean (default off)
5581 local to window
5582 Print the line number in front of each line. When the 'n' option is
5583 excluded from 'cpoptions' a wrapped line will not use the column of
5584 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005585 The 'numberwidth' option can be used to set the room used for the line
5586 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005587 When a long, wrapped line doesn't start with the first character, '-'
5588 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02005589 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
5590 the number.
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005591 *number_relativenumber*
5592 The 'relativenumber' option changes the displayed number to be
5593 relative to the cursor. Together with 'number' there are these
5594 four combinations (cursor in line 3):
5595
Bram Moolenaar3848e002016-03-19 18:42:29 +01005596 'nonu' 'nu' 'nonu' 'nu'
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005597 'nornu' 'nornu' 'rnu' 'rnu'
5598
5599 |apple | 1 apple | 2 apple | 2 apple
5600 |pear | 2 pear | 1 pear | 1 pear
5601 |nobody | 3 nobody | 0 nobody |3 nobody
5602 |there | 4 there | 1 there | 1 there
Bram Moolenaar071d4272004-06-13 20:20:40 +00005603
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005604 *'numberwidth'* *'nuw'*
5605'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
5606 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005607 {only available when compiled with the |+linebreak|
5608 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005609 Minimal number of columns to use for the line number. Only relevant
Bram Moolenaar64486672010-05-16 15:46:46 +02005610 when the 'number' or 'relativenumber' option is set or printing lines
5611 with a line number. Since one space is always between the number and
5612 the text, there is one less character for the number itself.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005613 The value is the minimum width. A bigger width is used when needed to
Bram Moolenaar64486672010-05-16 15:46:46 +02005614 fit the highest line number in the buffer respectively the number of
5615 rows in the window, depending on whether 'number' or 'relativenumber'
5616 is set. Thus with the Vim default of 4 there is room for a line number
5617 up to 999. When the buffer has 1000 lines five columns will be used.
Bram Moolenaarf8a07122019-07-01 22:06:07 +02005618 The minimum value is 1, the maximum value is 20.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005619 NOTE: This option is set to the Vi default value when 'compatible' is
5620 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005621
Bram Moolenaarf75a9632005-09-13 21:20:47 +00005622 *'omnifunc'* *'ofu'*
5623'omnifunc' 'ofu' string (default: empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00005624 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02005625 {not available when compiled without the |+eval|
Bram Moolenaare2c453d2019-08-21 14:37:09 +02005626 feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00005627 This option specifies a function to be used for Insert mode omni
5628 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
Bram Moolenaar280f1262006-01-30 00:14:18 +00005629 See |complete-functions| for an explanation of how the function is
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00005630 invoked and what it should return. The value can be the name of a
5631 function, a |lambda| or a |Funcref|. See |option-value-function| for
5632 more information.
Bram Moolenaar043545e2006-10-10 16:44:07 +00005633 This option is usually set by a filetype plugin:
Bram Moolenaar9c102382006-05-03 21:26:49 +00005634 |:filetype-plugin-on|
Bram Moolenaar30b65812012-07-12 22:01:11 +02005635 This option cannot be set from a |modeline| or in the |sandbox|, for
5636 security reasons.
Bram Moolenaare344bea2005-09-01 20:46:49 +00005637
5638
Bram Moolenaar02467872007-05-06 13:22:01 +00005639 *'opendevice'* *'odev'* *'noopendevice'* *'noodev'*
Bram Moolenaar043545e2006-10-10 16:44:07 +00005640'opendevice' 'odev' boolean (default off)
5641 global
Bram Moolenaar6f345a12019-12-17 21:27:18 +01005642 {only for MS-Windows}
Bram Moolenaar043545e2006-10-10 16:44:07 +00005643 Enable reading and writing from devices. This may get Vim stuck on a
5644 device that can be opened but doesn't actually do the I/O. Therefore
5645 it is off by default.
5646 Note that on MS-Windows editing "aux.h", "lpt1.txt" and the like also
5647 result in editing a device.
5648
5649
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005650 *'operatorfunc'* *'opfunc'*
5651'operatorfunc' 'opfunc' string (default: empty)
5652 global
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005653 This option specifies a function to be called by the |g@| operator.
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +00005654 See |:map-operator| for more info and an example. The value can be
5655 the name of a function, a |lambda| or a |Funcref|. See
5656 |option-value-function| for more information.
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005657
5658 This option cannot be set from a |modeline| or in the |sandbox|, for
5659 security reasons.
5660
5661
Bram Moolenaar251e1912011-06-19 05:09:16 +02005662 *'osfiletype'* *'oft'*
5663'osfiletype' 'oft' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005664 local to buffer
Bram Moolenaar251e1912011-06-19 05:09:16 +02005665 This option was supported on RISC OS, which has been removed.
5666
Bram Moolenaar071d4272004-06-13 20:20:40 +00005667
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005668 *'packpath'* *'pp'*
5669'packpath' 'pp' string (default: see 'runtimepath')
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005670 Directories used to find packages. See |packages|.
5671
5672
Bram Moolenaar071d4272004-06-13 20:20:40 +00005673 *'paragraphs'* *'para'*
Bram Moolenaar57e48462008-03-12 16:38:55 +00005674'paragraphs' 'para' string (default "IPLPPPQPP TPHPLIPpLpItpplpipbp")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005675 global
5676 Specifies the nroff macros that separate paragraphs. These are pairs
5677 of two letters (see |object-motions|).
5678
5679 *'paste'* *'nopaste'*
5680'paste' boolean (default off)
5681 global
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005682 Put Vim in Paste mode. This is useful if you want to cut or copy
5683 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005684 unexpected effects.
5685 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005686 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00005687 knows about pasting and will mostly do the right thing without 'paste'
5688 being set. The same is true for a terminal where Vim handles the
5689 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00005690 This option is reset when starting the GUI. Thus if you set it in
5691 your .vimrc it will work in a terminal, but not in the GUI. Setting
5692 'paste' in the GUI has side effects: e.g., the Paste toolbar button
5693 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005694 When the 'paste' option is switched on (also when it was already on):
5695 - mapping in Insert mode and Command-line mode is disabled
5696 - abbreviations are disabled
Bram Moolenaar071d4272004-06-13 20:20:40 +00005697 - 'autoindent' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02005698 - 'expandtab' is reset
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02005699 - 'hkmap' is reset
Bram Moolenaar071d4272004-06-13 20:20:40 +00005700 - 'revins' is reset
5701 - 'ruler' is reset
5702 - 'showmatch' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02005703 - 'smarttab' is reset
5704 - 'softtabstop' is set to 0
5705 - 'textwidth' is set to 0
5706 - 'wrapmargin' is set to 0
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02005707 - 'varsofttabstop' is made empty
Bram Moolenaar071d4272004-06-13 20:20:40 +00005708 These options keep their value, but their effect is disabled:
Bram Moolenaar071d4272004-06-13 20:20:40 +00005709 - 'cindent'
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02005710 - 'formatoptions' is used like it is empty
Bram Moolenaarca635012015-09-25 20:34:21 +02005711 - 'indentexpr'
5712 - 'lisp'
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02005713 - 'smartindent'
Bram Moolenaar071d4272004-06-13 20:20:40 +00005714 NOTE: When you start editing another file while the 'paste' option is
5715 on, settings from the modelines or autocommands may change the
5716 settings again, causing trouble when pasting text. You might want to
5717 set the 'paste' option again.
5718 When the 'paste' option is reset the mentioned options are restored to
5719 the value before the moment 'paste' was switched from off to on.
5720 Resetting 'paste' before ever setting it does not have any effect.
5721 Since mapping doesn't work while 'paste' is active, you need to use
5722 the 'pastetoggle' option to toggle the 'paste' option with some key.
5723
5724 *'pastetoggle'* *'pt'*
5725'pastetoggle' 'pt' string (default "")
5726 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005727 When non-empty, specifies the key sequence that toggles the 'paste'
5728 option. This is like specifying a mapping: >
5729 :map {keys} :set invpaste<CR>
5730< Where {keys} is the value of 'pastetoggle'.
5731 The difference is that it will work even when 'paste' is set.
5732 'pastetoggle' works in Insert mode and Normal mode, but not in
5733 Command-line mode.
5734 Mappings are checked first, thus overrule 'pastetoggle'. However,
5735 when 'paste' is on mappings are ignored in Insert mode, thus you can do
5736 this: >
5737 :map <F10> :set paste<CR>
5738 :map <F11> :set nopaste<CR>
5739 :imap <F10> <C-O>:set paste<CR>
5740 :imap <F11> <nop>
5741 :set pastetoggle=<F11>
5742< This will make <F10> start paste mode and <F11> stop paste mode.
5743 Note that typing <F10> in paste mode inserts "<F10>", since in paste
5744 mode everything is inserted literally, except the 'pastetoggle' key
5745 sequence.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005746 When the value has several bytes 'ttimeoutlen' applies.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005747
5748 *'pex'* *'patchexpr'*
5749'patchexpr' 'pex' string (default "")
5750 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005751 {not available when compiled without the |+diff|
5752 feature}
5753 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005754 the resulting new version of the file. See |diff-patchexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005755
Bram Moolenaardbc28022014-07-26 13:40:44 +02005756 *'patchmode'* *'pm'* *E205* *E206*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005757'patchmode' 'pm' string (default "")
5758 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005759 When non-empty the oldest version of a file is kept. This can be used
5760 to keep the original version of a file if you are changing files in a
5761 source distribution. Only the first time that a file is written a
5762 copy of the original file will be kept. The name of the copy is the
5763 name of the original file with the string in the 'patchmode' option
5764 appended. This option should start with a dot. Use a string like
Bram Moolenaardf980db2017-12-24 13:22:00 +01005765 ".orig" or ".org". 'backupdir' must not be empty for this to work
5766 (Detail: The backup file is renamed to the patchmode file after the
5767 new file has been successfully written, that's why it must be possible
5768 to write a backup file). If there was no file to be backed up, an
5769 empty file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005770 When the 'backupskip' pattern matches, a patchmode file is not made.
5771 Using 'patchmode' for compressed files appends the extension at the
5772 end (e.g., "file.gz.orig"), thus the resulting name isn't always
5773 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005774 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005775
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01005776 *'path'* *'pa'* *E343* *E345* *E347* *E854*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005777'path' 'pa' string (default on Unix: ".,/usr/include,,"
Bram Moolenaar071d4272004-06-13 20:20:40 +00005778 other systems: ".,,")
5779 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005780 This is a list of directories which will be searched when using the
Bram Moolenaarc236c162008-07-13 17:41:49 +00005781 |gf|, [f, ]f, ^Wf, |:find|, |:sfind|, |:tabfind| and other commands,
5782 provided that the file being searched for has a relative path (not
5783 starting with "/", "./" or "../"). The directories in the 'path'
5784 option may be relative or absolute.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005785 - Use commas to separate directory names: >
5786 :set path=.,/usr/local/include,/usr/include
5787< - Spaces can also be used to separate directory names (for backwards
5788 compatibility with version 3.0). To have a space in a directory
5789 name, precede it with an extra backslash, and escape the space: >
5790 :set path=.,/dir/with\\\ space
5791< - To include a comma in a directory name precede it with an extra
5792 backslash: >
5793 :set path=.,/dir/with\\,comma
5794< - To search relative to the directory of the current file, use: >
5795 :set path=.
5796< - To search in the current directory use an empty string between two
5797 commas: >
5798 :set path=,,
5799< - A directory name may end in a ':' or '/'.
5800 - Environment variables are expanded |:set_env|.
5801 - When using |netrw.vim| URLs can be used. For example, adding
5802 "http://www.vim.org" will make ":find index.html" work.
Bram Moolenaarc236c162008-07-13 17:41:49 +00005803 - Search upwards and downwards in a directory tree using "*", "**" and
5804 ";". See |file-searching| for info and syntax.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005805 {not available when compiled without the |+path_extra| feature}
5806 - Careful with '\' characters, type two to get one in the option: >
5807 :set path=.,c:\\include
5808< Or just use '/' instead: >
5809 :set path=.,c:/include
5810< Don't forget "." or files won't even be found in the same directory as
5811 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005812 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00005813 it is something like 256 or 1024 characters.
5814 You can check if all the include files are found, using the value of
5815 'path', see |:checkpath|.
5816 The use of |:set+=| and |:set-=| is preferred when adding or removing
5817 directories from the list. This avoids problems when a future version
5818 uses another default. To remove the current directory use: >
5819 :set path-=
5820< To add the current directory use: >
5821 :set path+=
5822< To use an environment variable, you probably need to replace the
5823 separator. Here is an example to append $INCL, in which directory
5824 names are separated with a semi-colon: >
5825 :let &path = &path . "," . substitute($INCL, ';', ',', 'g')
5826< Replace the ';' with a ':' or whatever separator is used. Note that
5827 this doesn't work when $INCL contains a comma or white space.
5828
Bram Moolenaar37c64c72017-09-19 22:06:03 +02005829 *'perldll'*
5830'perldll' string (default depends on the build)
5831 global
Bram Moolenaar37c64c72017-09-19 22:06:03 +02005832 {only available when compiled with the |+perl/dyn|
5833 feature}
5834 Specifies the name of the Perl shared library. The default is
5835 DYNAMIC_PERL_DLL, which was specified at compile time.
5836 Environment variables are expanded |:set_env|.
5837 This option cannot be set from a |modeline| or in the |sandbox|, for
5838 security reasons.
5839
Bram Moolenaar071d4272004-06-13 20:20:40 +00005840 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
5841'preserveindent' 'pi' boolean (default off)
5842 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005843 When changing the indent of the current line, preserve as much of the
5844 indent structure as possible. Normally the indent is replaced by a
5845 series of tabs followed by spaces as required (unless |'expandtab'| is
5846 enabled, in which case only spaces are used). Enabling this option
5847 means the indent will preserve as many existing characters as possible
5848 for indenting, and only add additional tabs or spaces as required.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005849 'expandtab' does not apply to the preserved white space, a Tab remains
5850 a Tab.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005851 NOTE: When using ">>" multiple times the resulting indent is a mix of
5852 tabs and spaces. You might not like this.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005853 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005854 Also see 'copyindent'.
5855 Use |:retab| to clean up white space.
5856
5857 *'previewheight'* *'pvh'*
5858'previewheight' 'pvh' number (default 12)
5859 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02005860 {not available when compiled without the |+quickfix|
5861 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005862 Default height for a preview window. Used for |:ptag| and associated
Bram Moolenaar79648732019-07-18 21:43:07 +02005863 commands. Used for |CTRL-W_}| when no count is given. Not used when
5864 'previewpopup' is set.
5865
5866 *'previewpopup'* *'pvp'*
5867'previewpopup' 'pvp' string (default empty)
5868 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02005869 {not available when compiled without the |+textprop|
5870 or |+quickfix| feature}
Bram Moolenaar79648732019-07-18 21:43:07 +02005871 When not empty a popup window is used for commands that would open a
5872 preview window. See |preview-popup|.
Bram Moolenaar576a4a62019-08-18 15:25:17 +02005873 Not used for the insert completion info, add "popup" to
5874 'completeopt' for that.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005875
5876 *'previewwindow'* *'nopreviewwindow'*
5877 *'pvw'* *'nopvw'* *E590*
5878'previewwindow' 'pvw' boolean (default off)
5879 local to window
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02005880 {not available when compiled without the |+quickfix|
5881 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005882 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00005883 set. It's normally not set directly, but by using one of the commands
5884 |:ptag|, |:pedit|, etc.
5885
5886 *'printdevice'* *'pdev'*
5887'printdevice' 'pdev' string (default empty)
5888 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005889 {only available when compiled with the |+printer|
5890 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005891 The name of the printer to be used for |:hardcopy|.
5892 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005893 This option cannot be set from a |modeline| or in the |sandbox|, for
5894 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005895
Bram Moolenaar8299df92004-07-10 09:47:34 +00005896 *'printencoding'* *'penc'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005897'printencoding' 'penc' string (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005898 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005899 {only available when compiled with the |+printer|
5900 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005901 Sets the character encoding used when printing.
5902 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005903
5904 *'printexpr'* *'pexpr'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005905'printexpr' 'pexpr' string (default: see below)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005906 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005907 {only available when compiled with the |+printer|
5908 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005909 Expression used to print the PostScript produced with |:hardcopy|.
5910 See |pexpr-option|.
Bram Moolenaar51628222016-12-01 23:03:28 +01005911 This option cannot be set from a |modeline| or in the |sandbox|, for
5912 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005913
Bram Moolenaar8299df92004-07-10 09:47:34 +00005914 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005915'printfont' 'pfn' string (default "courier")
5916 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005917 {only available when compiled with the |+printer|
5918 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005919 The name of the font that will be used for |:hardcopy|.
5920 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005921
5922 *'printheader'* *'pheader'*
5923'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
5924 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005925 {only available when compiled with the |+printer|
5926 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005927 The format of the header produced in |:hardcopy| output.
5928 See |pheader-option|.
5929
5930 *'printmbcharset'* *'pmbcs'*
5931'printmbcharset' 'pmbcs' string (default "")
5932 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01005933 {only available when compiled with the |+printer|
5934 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005935 The CJK character set to be used for CJK output from |:hardcopy|.
5936 See |pmbcs-option|.
5937
5938 *'printmbfont'* *'pmbfn'*
5939'printmbfont' 'pmbfn' string (default "")
5940 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01005941 {only available when compiled with the |+printer|
5942 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005943 List of font names to be used for CJK output from |:hardcopy|.
5944 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005945
5946 *'printoptions'* *'popt'*
5947'printoptions' 'popt' string (default "")
5948 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005949 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005950 List of items that control the format of the output of |:hardcopy|.
5951 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005952
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005953 *'prompt'* *'noprompt'*
5954'prompt' boolean (default on)
5955 global
5956 When on a ":" prompt is used in Ex mode.
5957
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005958 *'pumheight'* *'ph'*
5959'pumheight' 'ph' number (default 0)
5960 global
Bram Moolenaar06a89a52006-04-29 22:01:03 +00005961 Determines the maximum number of items to show in the popup menu for
5962 Insert mode completion. When zero as much space as available is used.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005963 |ins-completion-menu|.
5964
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01005965 *'pumwidth'* *'pw'*
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005966'pumwidth' 'pw' number (default 15)
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01005967 global
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01005968 Determines the minimum width to use for the popup menu for Insert mode
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005969 completion. |ins-completion-menu|.
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01005970
Bram Moolenaard94464e2015-11-02 15:28:18 +01005971 *'pythondll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01005972'pythondll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01005973 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01005974 {only available when compiled with the |+python/dyn|
5975 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005976 Specifies the name of the Python 2.x shared library. The default is
5977 DYNAMIC_PYTHON_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005978 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01005979 This option cannot be set from a |modeline| or in the |sandbox|, for
5980 security reasons.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005981
Bram Moolenaar94073162018-01-31 21:49:05 +01005982 *'pythonhome'*
5983'pythonhome' string (default "")
5984 global
Bram Moolenaar94073162018-01-31 21:49:05 +01005985 {only available when compiled with the |+python/dyn|
5986 feature}
5987 Specifies the name of the Python 2.x home directory. When 'pythonhome'
5988 and the PYTHONHOME environment variable are not set, PYTHON_HOME,
5989 which was specified at compile time, will be used for the Python 2.x
5990 home directory.
5991 Environment variables are expanded |:set_env|.
5992 This option cannot be set from a |modeline| or in the |sandbox|, for
5993 security reasons.
5994
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005995 *'pythonthreedll'*
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005996'pythonthreedll' string (default depends on the build)
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005997 global
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005998 {only available when compiled with the |+python3/dyn|
5999 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006000 Specifies the name of the Python 3 shared library. The default is
6001 DYNAMIC_PYTHON3_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006002 Environment variables are expanded |:set_env|.
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006003 This option cannot be set from a |modeline| or in the |sandbox|, for
6004 security reasons.
6005
Bram Moolenaar94073162018-01-31 21:49:05 +01006006 *'pythonthreehome'*
6007'pythonthreehome' string (default "")
6008 global
Bram Moolenaar94073162018-01-31 21:49:05 +01006009 {only available when compiled with the |+python3/dyn|
6010 feature}
6011 Specifies the name of the Python 3 home directory. When
6012 'pythonthreehome' and the PYTHONHOME environment variable are not set,
6013 PYTHON3_HOME, which was specified at compile time, will be used for
6014 the Python 3 home directory.
6015 Environment variables are expanded |:set_env|.
6016 This option cannot be set from a |modeline| or in the |sandbox|, for
6017 security reasons.
6018
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01006019 *'pyxversion'* *'pyx'*
6020'pyxversion' 'pyx' number (default depends on the build)
6021 global
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01006022 {only available when compiled with the |+python| or
6023 the |+python3| feature}
6024 Specifies the python version used for pyx* functions and commands
6025 |python_x|. The default value is as follows:
6026
6027 Compiled with Default ~
6028 |+python| and |+python3| 0
6029 only |+python| 2
6030 only |+python3| 3
6031
6032 Available values are 0, 2 and 3.
6033 If 'pyxversion' is 0, it is set to 2 or 3 after the first execution of
6034 any python2/3 commands or functions. E.g. `:py` sets to 2, and `:py3`
6035 sets to 3. `:pyx` sets it to 3 if Python 3 is available, otherwise sets
6036 to 2 if Python 2 is available.
6037 See also: |has-pythonx|
6038
6039 If Vim is compiled with only |+python| or |+python3| setting
6040 'pyxversion' has no effect. The pyx* functions and commands are
6041 always the same as the compiled version.
6042
6043 This option cannot be set from a |modeline| or in the |sandbox|, for
6044 security reasons.
6045
Bram Moolenaar858ba062020-05-31 23:11:59 +02006046 *'quickfixtextfunc'* *'qftf'*
6047'quickfixtextfunc' 'qftf' string (default "")
6048 global
6049 {only available when compiled with the |+quickfix|
6050 feature}
6051 This option specifies a function to be used to get the text to display
6052 in the quickfix and location list windows. This can be used to
6053 customize the information displayed in the quickfix or location window
6054 for each entry in the corresponding quickfix or location list. See
6055 |quickfix-window-function| for an explanation of how to write the
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +00006056 function and an example. The value can be the name of a function, a
6057 |lambda| or a |Funcref|. See |option-value-function| for more
6058 information.
Bram Moolenaar858ba062020-05-31 23:11:59 +02006059
6060 This option cannot be set from a |modeline| or in the |sandbox|, for
6061 security reasons.
6062
Bram Moolenaar677ee682005-01-27 14:41:15 +00006063 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00006064'quoteescape' 'qe' string (default "\")
6065 local to buffer
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00006066 The characters that are used to escape quotes in a string. Used for
6067 objects like a', a" and a` |a'|.
6068 When one of the characters in this option is found inside a string,
6069 the following character will be skipped. The default value makes the
6070 text "foo\"bar\\" considered to be one string.
6071
Bram Moolenaar071d4272004-06-13 20:20:40 +00006072 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
6073'readonly' 'ro' boolean (default off)
6074 local to buffer
6075 If on, writes fail unless you use a '!'. Protects you from
6076 accidentally overwriting a file. Default on when Vim is started
6077 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006078 When using ":w!" the 'readonly' option is reset for the current
6079 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar6c60f472019-04-28 16:00:35 +02006080 When using the ":view" command the 'readonly' option is set for the
6081 newly edited buffer.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01006082 See 'modifiable' for disallowing changes to the buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006083
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006084 *'redrawtime'* *'rdt'*
6085'redrawtime' 'rdt' number (default 2000)
6086 global
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006087 {only available when compiled with the |+reltime|
6088 feature}
6089 The time in milliseconds for redrawing the display. This applies to
Bram Moolenaar15142e22018-04-30 22:19:58 +02006090 searching for patterns for 'hlsearch', |:match| highlighting and syntax
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02006091 highlighting.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006092 When redrawing takes more than this many milliseconds no further
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02006093 matches will be highlighted.
6094 For syntax highlighting the time applies per window. When over the
6095 limit syntax highlighting is disabled until |CTRL-L| is used.
6096 This is used to avoid that Vim hangs when using a very complicated
6097 pattern.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006098
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02006099 *'regexpengine'* *'re'*
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006100'regexpengine' 're' number (default 0)
6101 global
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006102 This selects the default regexp engine. |two-engines|
6103 The possible values are:
6104 0 automatic selection
6105 1 old engine
6106 2 NFA engine
6107 Note that when using the NFA engine and the pattern contains something
6108 that is not supported the pattern will not match. This is only useful
6109 for debugging the regexp engine.
Bram Moolenaarfda37292014-11-05 14:27:36 +01006110 Using automatic selection enables Vim to switch the engine, if the
6111 default engine becomes too costly. E.g., when the NFA engine uses too
6112 many states. This should prevent Vim from hanging on a combination of
6113 a complex pattern with long text.
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006114
Bram Moolenaar64486672010-05-16 15:46:46 +02006115 *'relativenumber'* *'rnu'* *'norelativenumber'* *'nornu'*
6116'relativenumber' 'rnu' boolean (default off)
6117 local to window
Bram Moolenaar64486672010-05-16 15:46:46 +02006118 Show the line number relative to the line with the cursor in front of
Bram Moolenaar06b5d512010-05-22 15:37:44 +02006119 each line. Relative line numbers help you use the |count| you can
Bram Moolenaar64486672010-05-16 15:46:46 +02006120 precede some vertical motion commands (e.g. j k + -) with, without
6121 having to calculate it yourself. Especially useful in combination with
6122 other commands (e.g. y d c < > gq gw =).
6123 When the 'n' option is excluded from 'cpoptions' a wrapped
6124 line will not use the column of line numbers (this is the default when
6125 'compatible' isn't set).
6126 The 'numberwidth' option can be used to set the room used for the line
6127 number.
6128 When a long, wrapped line doesn't start with the first character, '-'
6129 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02006130 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
6131 the number.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01006132
Bram Moolenaar203d04d2013-06-06 21:36:40 +02006133 The number in front of the cursor line also depends on the value of
6134 'number', see |number_relativenumber| for all combinations of the two
6135 options.
Bram Moolenaar64486672010-05-16 15:46:46 +02006136
Bram Moolenaar071d4272004-06-13 20:20:40 +00006137 *'remap'* *'noremap'*
6138'remap' boolean (default on)
6139 global
6140 Allows for mappings to work recursively. If you do not want this for
6141 a single entry, use the :noremap[!] command.
Bram Moolenaara3227e22006-03-08 21:32:40 +00006142 NOTE: To avoid portability problems with Vim scripts, always keep
6143 this option at the default "on". Only switch it off when working with
6144 old Vi scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006145
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006146 *'renderoptions'* *'rop'*
6147'renderoptions' 'rop' string (default: empty)
6148 global
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006149 {only available when compiled with GUI and DIRECTX on
6150 MS-Windows}
6151 Select a text renderer and set its options. The options depend on the
6152 renderer.
6153
6154 Syntax: >
6155 set rop=type:{renderer}(,{name}:{value})*
6156<
6157 Currently, only one optional renderer is available.
6158
6159 render behavior ~
6160 directx Vim will draw text using DirectX (DirectWrite). It makes
6161 drawn glyphs more beautiful than default GDI.
6162 It requires 'encoding' is "utf-8", and only works on
6163 MS-Windows Vista or newer version.
6164
6165 Options:
6166 name meaning type value ~
6167 gamma gamma float 1.0 - 2.2 (maybe)
6168 contrast enhancedContrast float (unknown)
6169 level clearTypeLevel float (unknown)
6170 geom pixelGeometry int 0 - 2 (see below)
6171 renmode renderingMode int 0 - 6 (see below)
6172 taamode textAntialiasMode int 0 - 3 (see below)
Bram Moolenaara338adc2018-01-31 20:51:47 +01006173 scrlines Scroll Lines int (deprecated)
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006174
Bram Moolenaar92467d32017-12-05 13:22:16 +01006175 See this URL for detail (except for scrlines):
6176 https://msdn.microsoft.com/en-us/library/dd368190.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006177
6178 For geom: structure of a device pixel.
6179 0 - DWRITE_PIXEL_GEOMETRY_FLAT
6180 1 - DWRITE_PIXEL_GEOMETRY_RGB
6181 2 - DWRITE_PIXEL_GEOMETRY_BGR
6182
6183 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006184 https://msdn.microsoft.com/en-us/library/dd368114.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006185
6186 For renmode: method of rendering glyphs.
6187 0 - DWRITE_RENDERING_MODE_DEFAULT
6188 1 - DWRITE_RENDERING_MODE_ALIASED
6189 2 - DWRITE_RENDERING_MODE_GDI_CLASSIC
6190 3 - DWRITE_RENDERING_MODE_GDI_NATURAL
6191 4 - DWRITE_RENDERING_MODE_NATURAL
6192 5 - DWRITE_RENDERING_MODE_NATURAL_SYMMETRIC
6193 6 - DWRITE_RENDERING_MODE_OUTLINE
6194
6195 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006196 https://msdn.microsoft.com/en-us/library/dd368118.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006197
6198 For taamode: antialiasing mode used for drawing text.
6199 0 - D2D1_TEXT_ANTIALIAS_MODE_DEFAULT
6200 1 - D2D1_TEXT_ANTIALIAS_MODE_CLEARTYPE
6201 2 - D2D1_TEXT_ANTIALIAS_MODE_GRAYSCALE
6202 3 - D2D1_TEXT_ANTIALIAS_MODE_ALIASED
6203
6204 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006205 https://msdn.microsoft.com/en-us/library/dd368170.aspx
6206
Bram Moolenaara338adc2018-01-31 20:51:47 +01006207 For scrlines:
6208 This was used for optimizing scrolling behavior, however this
6209 is now deprecated. If specified, it is simply ignored.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006210
6211 Example: >
6212 set encoding=utf-8
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006213 set gfn=Ricty_Diminished:h12
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006214 set rop=type:directx
6215<
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006216 If select a raster font (Courier, Terminal or FixedSys which
6217 have ".fon" extension in file name) to 'guifont', it will be
Bram Moolenaar92467d32017-12-05 13:22:16 +01006218 drawn by GDI as a fallback.
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006219
6220 NOTE: It is known that some fonts and options combination
6221 causes trouble on drawing glyphs.
6222
Bram Moolenaar92467d32017-12-05 13:22:16 +01006223 - 'renmode:5' and 'renmode:6' will not work with some
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006224 special made fonts (True-Type fonts which includes only
6225 bitmap glyphs).
6226 - 'taamode:3' will not work with some vector fonts.
6227
6228 NOTE: With this option, you can display colored emoji
6229 (emoticon) in Windows 8.1 or later. To display colored emoji,
6230 there are some conditions which you should notice.
6231
6232 - If your font includes non-colored emoji already, it will
6233 be used.
6234 - If your font doesn't have emoji, the system chooses an
6235 alternative symbol font. On Windows 10, "Segoe UI Emoji"
6236 will be used.
6237 - When this alternative font didn't have fixed width glyph,
6238 emoji might be rendered beyond the bounding box of drawing
6239 cell.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006240
6241 Other render types are currently not supported.
6242
Bram Moolenaar071d4272004-06-13 20:20:40 +00006243 *'report'*
6244'report' number (default 2)
6245 global
6246 Threshold for reporting number of lines changed. When the number of
6247 changed lines is more than 'report' a message will be given for most
6248 ":" commands. If you want it always, set 'report' to 0.
6249 For the ":substitute" command the number of substitutions is used
6250 instead of the number of lines.
6251
6252 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
6253'restorescreen' 'rs' boolean (default on)
6254 global
Bram Moolenaar8024f932020-01-14 19:29:13 +01006255 {only in MS-Windows console version}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006256 When set, the screen contents is restored when exiting Vim. This also
6257 happens when executing external commands.
6258
6259 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
6260 options in your .vimrc. To disable restoring:
6261 set t_ti= t_te=
6262 To enable restoring (for an xterm):
6263 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
6264 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
6265
6266 *'revins'* *'ri'* *'norevins'* *'nori'*
6267'revins' 'ri' boolean (default off)
6268 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006269 {only available when compiled with the |+rightleft|
6270 feature}
6271 Inserting characters in Insert mode will work backwards. See "typing
6272 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
6273 command in Insert mode, when 'allowrevins' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02006274 NOTE: This option is reset when 'compatible' is set.
6275 This option is reset when 'paste' is set and restored when 'paste' is
6276 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006277
6278 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
6279'rightleft' 'rl' boolean (default off)
6280 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006281 {only available when compiled with the |+rightleft|
6282 feature}
6283 When on, display orientation becomes right-to-left, i.e., characters
6284 that are stored in the file appear from the right to the left.
6285 Using this option, it is possible to edit files for languages that
6286 are written from the right to the left such as Hebrew and Arabic.
6287 This option is per window, so it is possible to edit mixed files
6288 simultaneously, or to view the same file in both ways (this is
6289 useful whenever you have a mixed text file with both right-to-left
6290 and left-to-right strings so that both sets are displayed properly
6291 in different windows). Also see |rileft.txt|.
6292
Bram Moolenaar607cc1e2010-07-18 18:47:44 +02006293 *'rightleftcmd'* *'rlc'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006294'rightleftcmd' 'rlc' string (default "search")
6295 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006296 {only available when compiled with the |+rightleft|
6297 feature}
6298 Each word in this option enables the command line editing to work in
6299 right-to-left mode for a group of commands:
6300
6301 search "/" and "?" commands
6302
6303 This is useful for languages such as Hebrew, Arabic and Farsi.
6304 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
6305
Bram Moolenaard94464e2015-11-02 15:28:18 +01006306 *'rubydll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01006307'rubydll' string (default: depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01006308 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01006309 {only available when compiled with the |+ruby/dyn|
6310 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006311 Specifies the name of the Ruby shared library. The default is
6312 DYNAMIC_RUBY_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006313 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01006314 This option cannot be set from a |modeline| or in the |sandbox|, for
6315 security reasons.
6316
Bram Moolenaar071d4272004-06-13 20:20:40 +00006317 *'ruler'* *'ru'* *'noruler'* *'noru'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02006318'ruler' 'ru' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006319 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006320 {not available when compiled without the
6321 |+cmdline_info| feature}
6322 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006323 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00006324 text in the file is shown on the far right:
6325 Top first line is visible
6326 Bot last line is visible
6327 All first and last line are visible
6328 45% relative position in the file
6329 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006330 Each window has its own ruler. If a window has a status line, the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006331 ruler is shown there. Otherwise it is shown in the last line of the
Bram Moolenaar582fd852005-03-28 20:58:01 +00006332 screen. If the statusline is given by 'statusline' (i.e. not empty),
Bram Moolenaar071d4272004-06-13 20:20:40 +00006333 this option takes precedence over 'ruler' and 'rulerformat'
6334 If the number of characters displayed is different from the number of
Bram Moolenaar207f0092020-08-30 17:20:20 +02006335 bytes in the text (e.g., for a TAB or a multibyte character), both
Bram Moolenaar071d4272004-06-13 20:20:40 +00006336 the text column (byte number) and the screen column are shown,
6337 separated with a dash.
6338 For an empty line "0-1" is shown.
6339 For an empty buffer the line number will also be zero: "0,0-1".
Bram Moolenaarca635012015-09-25 20:34:21 +02006340 This option is reset when 'paste' is set and restored when 'paste' is
6341 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006342 If you don't want to see the ruler all the time but want to know where
6343 you are, use "g CTRL-G" |g_CTRL-G|.
6344 NOTE: This option is reset when 'compatible' is set.
6345
6346 *'rulerformat'* *'ruf'*
6347'rulerformat' 'ruf' string (default empty)
6348 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006349 {not available when compiled without the |+statusline|
6350 feature}
6351 When this option is not empty, it determines the content of the ruler
6352 string, as displayed for the 'ruler' option.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00006353 The format of this option is like that of 'statusline'.
Bram Moolenaar110289e2019-05-23 15:38:06 +02006354 This option cannot be set in a modeline when 'modelineexpr' is off.
6355
Bram Moolenaar071d4272004-06-13 20:20:40 +00006356 The default ruler width is 17 characters. To make the ruler 15
6357 characters wide, put "%15(" at the start and "%)" at the end.
6358 Example: >
6359 :set rulerformat=%15(%c%V\ %p%%%)
6360<
6361 *'runtimepath'* *'rtp'* *vimfiles*
6362'runtimepath' 'rtp' string (default:
Bram Moolenaar942db232021-02-13 18:14:48 +01006363 Unix: "$HOME/.vim,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006364 $VIM/vimfiles,
6365 $VIMRUNTIME,
6366 $VIM/vimfiles/after,
6367 $HOME/.vim/after"
6368 Amiga: "home:vimfiles,
6369 $VIM/vimfiles,
6370 $VIMRUNTIME,
6371 $VIM/vimfiles/after,
6372 home:vimfiles/after"
Bram Moolenaar942db232021-02-13 18:14:48 +01006373 MS-Windows: "$HOME/vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006374 $VIM/vimfiles,
6375 $VIMRUNTIME,
6376 $VIM/vimfiles/after,
6377 $HOME/vimfiles/after"
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02006378 macOS: "$VIM:vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006379 $VIMRUNTIME,
6380 $VIM:vimfiles:after"
Bram Moolenaarb3f74062020-02-26 16:16:53 +01006381 Haiku: "$BE_USER_SETTINGS/vim,
6382 $VIM/vimfiles,
6383 $VIMRUNTIME,
6384 $VIM/vimfiles/after,
Bram Moolenaar942db232021-02-13 18:14:48 +01006385 $BE_USER_SETTINGS/vim/after"
6386 VMS: "sys$login:vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006387 $VIM/vimfiles,
6388 $VIMRUNTIME,
6389 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00006390 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006391 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006392 This is a list of directories which will be searched for runtime
6393 files:
6394 filetype.vim filetypes by file name |new-filetype|
6395 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006396 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006397 colors/ color scheme files |:colorscheme|
6398 compiler/ compiler files |:compiler|
6399 doc/ documentation |write-local-help|
6400 ftplugin/ filetype plugins |write-filetype-plugin|
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01006401 import/ files that are found by `:import`
Bram Moolenaar071d4272004-06-13 20:20:40 +00006402 indent/ indent scripts |indent-expression|
6403 keymap/ key mapping files |mbyte-keymap|
6404 lang/ menu translations |:menutrans|
6405 menu.vim GUI menus |menu.vim|
Bram Moolenaar26852122016-05-24 20:02:38 +02006406 pack/ packages |:packadd|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006407 plugin/ plugin scripts |write-plugin|
6408 print/ files for printing |postscript-print-encoding|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006409 spell/ spell checking files |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006410 syntax/ syntax files |mysyntaxfile|
6411 tutor/ files for vimtutor |tutor|
6412
6413 And any other file searched for with the |:runtime| command.
6414
6415 The defaults for most systems are setup to search five locations:
6416 1. In your home directory, for your personal preferences.
6417 2. In a system-wide Vim directory, for preferences from the system
6418 administrator.
6419 3. In $VIMRUNTIME, for files distributed with Vim.
6420 *after-directory*
6421 4. In the "after" directory in the system-wide Vim directory. This is
6422 for the system administrator to overrule or add to the distributed
6423 defaults (rarely needed)
6424 5. In the "after" directory in your home directory. This is for
6425 personal preferences to overrule or add to the distributed defaults
6426 or system-wide settings (rarely needed).
6427
Bram Moolenaard0796902016-09-16 20:02:31 +02006428 More entries are added when using |packages|. If it gets very long
6429 then `:set rtp` will be truncated, use `:echo &rtp` to see the full
6430 string.
Bram Moolenaar26852122016-05-24 20:02:38 +02006431
Bram Moolenaar071d4272004-06-13 20:20:40 +00006432 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
6433 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006434 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00006435 wildcards.
6436 See |:runtime|.
6437 Example: >
6438 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
6439< This will use the directory "~/vimruntime" first (containing your
6440 personal Vim runtime files), then "/mygroup/vim" (shared between a
6441 group of people) and finally "$VIMRUNTIME" (the distributed runtime
6442 files).
6443 You probably should always include $VIMRUNTIME somewhere, to use the
6444 distributed runtime files. You can put a directory before $VIMRUNTIME
6445 to find files which replace a distributed runtime files. You can put
6446 a directory after $VIMRUNTIME to find files which add to distributed
6447 runtime files.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006448 When Vim is started with |--clean| the home directory entries are not
6449 included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006450 This option cannot be set from a |modeline| or in the |sandbox|, for
6451 security reasons.
6452
6453 *'scroll'* *'scr'*
6454'scroll' 'scr' number (default: half the window height)
6455 local to window
6456 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
6457 set to half the number of lines in the window when the window size
Bram Moolenaar74667062020-12-28 15:41:41 +01006458 changes. This may happen when enabling the |status-line| or
6459 'tabline' option after setting the 'scroll' option.
6460 If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006461 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar25c9c682019-05-05 18:13:34 +02006462 height with ":set scroll=0".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006463
6464 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
6465'scrollbind' 'scb' boolean (default off)
6466 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006467 See also |scroll-binding|. When this option is set, the current
6468 window scrolls as other scrollbind windows (windows that also have
6469 this option set) scroll. This option is useful for viewing the
6470 differences between two versions of a file, see 'diff'.
6471 See |'scrollopt'| for options that determine how this option should be
6472 interpreted.
6473 This option is mostly reset when splitting a window to edit another
6474 file. This means that ":split | edit file" results in two windows
6475 with scroll-binding, but ":split file" does not.
6476
Bram Moolenaarae20f342019-11-05 21:09:23 +01006477 *'scrollfocus'* *'scf'* *'noscrollfocus'* *'noscf'*
6478'scrollfocus' 'scf' boolean (default off)
6479 global
6480 {only for MS-Windows GUI}
6481 When using the scroll wheel and this option is set, the window under
6482 the mouse pointer is scrolled. With this option off the current
6483 window is scrolled.
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01006484 Systems other than MS-Windows always behave like this option is on.
Bram Moolenaarae20f342019-11-05 21:09:23 +01006485
Bram Moolenaar071d4272004-06-13 20:20:40 +00006486 *'scrolljump'* *'sj'*
6487'scrolljump' 'sj' number (default 1)
6488 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006489 Minimal number of lines to scroll when the cursor gets off the
6490 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
6491 CTRL-D). Useful if your terminal scrolls very slowly.
Bram Moolenaar1e015462005-09-25 22:16:38 +00006492 When set to a negative number from -1 to -100 this is used as the
6493 percentage of the window height. Thus -50 scrolls half the window
6494 height.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006495 NOTE: This option is set to 1 when 'compatible' is set.
6496
6497 *'scrolloff'* *'so'*
Bram Moolenaar50ba5262016-09-22 22:33:02 +02006498'scrolloff' 'so' number (default 0, set to 5 in |defaults.vim|)
Bram Moolenaar375e3392019-01-31 18:26:10 +01006499 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006500 Minimal number of screen lines to keep above and below the cursor.
6501 This will make some context visible around where you are working. If
6502 you set it to a very large value (999) the cursor line will always be
6503 in the middle of the window (except at the start or end of the file or
6504 when long lines wrap).
Bram Moolenaar375e3392019-01-31 18:26:10 +01006505 After using the local value, go back the global value with one of
6506 these two: >
6507 setlocal scrolloff<
6508 setlocal scrolloff=-1
6509< For scrolling horizontally see 'sidescrolloff'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006510 NOTE: This option is set to 0 when 'compatible' is set.
6511
6512 *'scrollopt'* *'sbo'*
6513'scrollopt' 'sbo' string (default "ver,jump")
6514 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006515 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006516 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
6517 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006518 The following words are available:
6519 ver Bind vertical scrolling for 'scrollbind' windows
6520 hor Bind horizontal scrolling for 'scrollbind' windows
6521 jump Applies to the offset between two windows for vertical
6522 scrolling. This offset is the difference in the first
6523 displayed line of the bound windows. When moving
6524 around in a window, another 'scrollbind' window may
6525 reach a position before the start or after the end of
6526 the buffer. The offset is not changed though, when
6527 moving back the 'scrollbind' window will try to scroll
6528 to the desired position when possible.
6529 When now making that window the current one, two
6530 things can be done with the relative offset:
6531 1. When "jump" is not included, the relative offset is
6532 adjusted for the scroll position in the new current
6533 window. When going back to the other window, the
Bram Moolenaar02467872007-05-06 13:22:01 +00006534 new relative offset will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006535 2. When "jump" is included, the other windows are
6536 scrolled to keep the same relative offset. When
6537 going back to the other window, it still uses the
6538 same relative offset.
6539 Also see |scroll-binding|.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006540 When 'diff' mode is active there always is vertical scroll binding,
6541 even when "ver" isn't there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006542
6543 *'sections'* *'sect'*
6544'sections' 'sect' string (default "SHNHH HUnhsh")
6545 global
6546 Specifies the nroff macros that separate sections. These are pairs of
6547 two letters (See |object-motions|). The default makes a section start
6548 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
6549
6550 *'secure'* *'nosecure'* *E523*
6551'secure' boolean (default off)
6552 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006553 When on, ":autocmd", shell and write commands are not allowed in
6554 ".vimrc" and ".exrc" in the current directory and map commands are
6555 displayed. Switch it off only if you know that you will not run into
6556 problems, or when the 'exrc' option is off. On Unix this option is
6557 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006558 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00006559 'secure' at the end of your ~/.vimrc then.
6560 This option cannot be set from a |modeline| or in the |sandbox|, for
6561 security reasons.
6562
6563 *'selection'* *'sel'*
6564'selection' 'sel' string (default "inclusive")
6565 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006566 This option defines the behavior of the selection. It is only used
6567 in Visual and Select mode.
6568 Possible values:
6569 value past line inclusive ~
6570 old no yes
6571 inclusive yes yes
6572 exclusive yes no
6573 "past line" means that the cursor is allowed to be positioned one
6574 character past the line.
6575 "inclusive" means that the last character of the selection is included
6576 in an operation. For example, when "x" is used to delete the
6577 selection.
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02006578 When "old" is used and 'virtualedit' allows the cursor to move past
6579 the end of line the line break still isn't included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006580 Note that when "exclusive" is used and selecting from the end
6581 backwards, you cannot include the last character of a line, when
6582 starting in Normal mode and 'virtualedit' empty.
6583
6584 The 'selection' option is set by the |:behave| command.
6585
6586 *'selectmode'* *'slm'*
6587'selectmode' 'slm' string (default "")
6588 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006589 This is a comma separated list of words, which specifies when to start
6590 Select mode instead of Visual mode, when a selection is started.
6591 Possible values:
6592 mouse when using the mouse
6593 key when using shifted special keys
6594 cmd when using "v", "V" or CTRL-V
6595 See |Select-mode|.
6596 The 'selectmode' option is set by the |:behave| command.
6597
6598 *'sessionoptions'* *'ssop'*
6599'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006600 help,options,tabpages,winsize,terminal")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006601 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02006602 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006603 feature}
6604 Changes the effect of the |:mksession| command. It is a comma
6605 separated list of words. Each word enables saving and restoring
6606 something:
6607 word save and restore ~
6608 blank empty windows
6609 buffers hidden and unloaded buffers, not just those in windows
6610 curdir the current directory
6611 folds manually created folds, opened/closed folds and local
6612 fold options
6613 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00006614 and contain at least one lowercase letter. Only
6615 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006616 help the help window
6617 localoptions options and mappings local to a window or buffer (not
6618 global values for local options)
6619 options all options and mappings (also global values for local
6620 options)
Bram Moolenaard23b7142021-04-17 21:04:34 +02006621 skiprtp exclude 'runtimepath' and 'packpath' from the options
Bram Moolenaar071d4272004-06-13 20:20:40 +00006622 resize size of the Vim window: 'lines' and 'columns'
6623 sesdir the directory in which the session file is located
6624 will become the current directory (useful with
6625 projects accessed over a network from different
6626 systems)
6627 slash backslashes in file names replaced with forward
6628 slashes
Bram Moolenaar18144c82006-04-12 21:52:12 +00006629 tabpages all tab pages; without this only the current tab page
6630 is restored, so that you can make a session for each
6631 tab page separately
Bram Moolenaard473c8c2018-08-11 18:00:22 +02006632 terminal include terminal windows where the command can be
6633 restored
Bram Moolenaar071d4272004-06-13 20:20:40 +00006634 unix with Unix end-of-line format (single <NL>), even when
6635 on Windows or DOS
6636 winpos position of the whole Vim window
6637 winsize window sizes
6638
6639 Don't include both "curdir" and "sesdir".
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006640 When neither "curdir" nor "sesdir" is included, file names are stored
6641 with absolute paths.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006642 "slash" and "unix" are useful on Windows when sharing session files
6643 with Unix. The Unix version of Vim cannot source dos format scripts,
6644 but the Windows version of Vim can source unix format scripts.
6645
6646 *'shell'* *'sh'* *E91*
Bram Moolenaar95a9dd12019-12-19 22:12:03 +01006647'shell' 'sh' string (default $SHELL or "sh", Win32: "cmd.exe")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006648 global
6649 Name of the shell to use for ! and :! commands. When changing the
6650 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
6651 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006652 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006653 See |option-backslash| about including spaces and backslashes.
6654 Environment variables are expanded |:set_env|.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006655
Bram Moolenaar1ff14ba2019-11-02 14:09:23 +01006656 If the name of the shell contains a space, you need to enclose it in
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01006657 quotes and escape the space. Example with quotes: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006658 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
6659< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006660 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006661 "-f" is not inside the quotes, because it is not part of the command
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006662 name. Vim automagically recognizes the backslashes that are path
Bram Moolenaar071d4272004-06-13 20:20:40 +00006663 separators.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006664 Example with escaped space (Vim will do this when initializing the
6665 option from $SHELL): >
6666 :set shell=/bin/with\\\ space/sh
Bram Moolenaard473c8c2018-08-11 18:00:22 +02006667< The resulting value of 'shell' is "/bin/with\ space/sh", two
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006668 backslashes are consumed by `:set`.
6669
Bram Moolenaar071d4272004-06-13 20:20:40 +00006670 Under MS-Windows, when the executable ends in ".com" it must be
6671 included. Thus setting the shell to "command.com" or "4dos.com"
6672 works, but "command" and "4dos" do not work for all commands (e.g.,
6673 filtering).
6674 For unknown reasons, when using "4dos.com" the current directory is
6675 changed to "C:\". To avoid this set 'shell' like this: >
6676 :set shell=command.com\ /c\ 4dos
6677< This option cannot be set from a |modeline| or in the |sandbox|, for
6678 security reasons.
6679
6680 *'shellcmdflag'* *'shcf'*
Bram Moolenaar5dc62522012-02-13 00:05:22 +01006681'shellcmdflag' 'shcf' string (default: "-c";
Mike Williams12795022021-06-28 20:53:58 +02006682 Win32, when 'shell' contains "powershell":
6683 "-Command", or when it does not contain "sh"
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006684 somewhere: "/c")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006685 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006686 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
Mike Williams12795022021-06-28 20:53:58 +02006687 "bash.exe -c ls", "powershell.exe -Command dir", or "cmd.exe /c dir".
6688 For MS-Windows, the default is set according to the value of 'shell',
6689 to reduce the need to set this option by the user.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02006690 On Unix it can have more than one flag. Each white space separated
6691 part is passed as an argument to the shell command.
6692 See |option-backslash| about including spaces and backslashes.
Mike Williams12795022021-06-28 20:53:58 +02006693 Also see |dos-shell| and |dos-powershell| for MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006694 This option cannot be set from a |modeline| or in the |sandbox|, for
6695 security reasons.
6696
6697 *'shellpipe'* *'sp'*
Mike Williams12795022021-06-28 20:53:58 +02006698'shellpipe' 'sp' string (default ">", ">%s 2>&1", "| tee", "|& tee"
6699 "2>&1| tee", or
6700 "2>&1 | Out-File -Encoding default")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006701 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006702 {not available when compiled without the |+quickfix|
6703 feature}
6704 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006705 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00006706 including spaces and backslashes.
6707 The name of the temporary file can be represented by "%s" if necessary
6708 (the file name is appended automatically if no %s appears in the value
6709 of this option).
Mike Williams12795022021-06-28 20:53:58 +02006710 For the Amiga the default is ">". For MS-Windows using powershell the
6711 default is "2>&1 | Out-File -Encoding default", otherwise the default
6712 is ">%s 2>&1". The output is directly saved in a file and not echoed
6713 to the screen.
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02006714 For Unix the default is "| tee". The stdout of the compiler is saved
Bram Moolenaar071d4272004-06-13 20:20:40 +00006715 in a file and echoed to the screen. If the 'shell' option is "csh" or
6716 "tcsh" after initializations, the default becomes "|& tee". If the
Bram Moolenaar96f45c02019-10-26 19:53:45 +02006717 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh", "zsh-beta",
Natanael Copa56318362021-05-06 18:46:35 +02006718 "bash", "fish", "ash" or "dash" the default becomes "2>&1| tee". This
6719 means that stderr is also included. Before using the 'shell' option a
6720 path is removed, thus "/bin/sh" uses "sh".
Mike Williamsa3d1b292021-06-30 20:56:00 +02006721 For Unix and MS-Windows, when the 'shell' option is "pwsh" the default
6722 becomes ">%s 2>&1" and the output is not echoed to the screen.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006723 The initialization of this option is done after reading the ".vimrc"
6724 and the other initializations, so that when the 'shell' option is set
6725 there, the 'shellpipe' option changes automatically, unless it was
6726 explicitly set before.
6727 When 'shellpipe' is set to an empty string, no redirection of the
6728 ":make" output will be done. This is useful if you use a 'makeprg'
6729 that writes to 'makeef' by itself. If you want no piping, but do
6730 want to include the 'makeef', set 'shellpipe' to a single space.
6731 Don't forget to precede the space with a backslash: ":set sp=\ ".
6732 In the future pipes may be used for filtering and this option will
6733 become obsolete (at least for Unix).
6734 This option cannot be set from a |modeline| or in the |sandbox|, for
6735 security reasons.
6736
6737 *'shellquote'* *'shq'*
Mike Williamsa3d1b292021-06-30 20:56:00 +02006738'shellquote' 'shq' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006739 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006740 Quoting character(s), put around the command passed to the shell, for
6741 the "!" and ":!" commands. The redirection is kept outside of the
6742 quoting. See 'shellxquote' to include the redirection. It's
6743 probably not useful to set both options.
6744 This is an empty string by default. Only known to be useful for
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006745 third-party shells on MS-Windows-like systems, such as the MKS Korn
Mike Williamsa3d1b292021-06-30 20:56:00 +02006746 Shell or bash, where it should be "\"". See |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006747 This option cannot be set from a |modeline| or in the |sandbox|, for
6748 security reasons.
6749
6750 *'shellredir'* *'srr'*
Mike Williams12795022021-06-28 20:53:58 +02006751'shellredir' 'srr' string (default ">", ">&", ">%s 2>&1", or
6752 "2>&1 | Out-File -Encoding default")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006753 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006754 String to be used to put the output of a filter command in a temporary
6755 file. See also |:!|. See |option-backslash| about including spaces
6756 and backslashes.
6757 The name of the temporary file can be represented by "%s" if necessary
6758 (the file name is appended automatically if no %s appears in the value
6759 of this option).
Bram Moolenaar96f45c02019-10-26 19:53:45 +02006760 The default is ">". For Unix, if the 'shell' option is "csh" or
6761 "tcsh" during initializations, the default becomes ">&". If the
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01006762 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh", "zsh-beta",
Mike Williamsa3d1b292021-06-30 20:56:00 +02006763 "bash", "fish", or "pwsh", the default becomes ">%s 2>&1". This means
6764 that stderr is also included. For Win32, the Unix checks are done and
Mike Williams12795022021-06-28 20:53:58 +02006765 additionally "cmd" is checked for, which makes the default ">%s 2>&1",
6766 and "powershell" is checked for which makes the default
Mike Williamsa3d1b292021-06-30 20:56:00 +02006767 "2>&1 | Out-File -Encoding default" (see |dos-powershell|). Also, the
6768 same names with ".exe" appended are checked for.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006769 The initialization of this option is done after reading the ".vimrc"
6770 and the other initializations, so that when the 'shell' option is set
6771 there, the 'shellredir' option changes automatically unless it was
6772 explicitly set before.
6773 In the future pipes may be used for filtering and this option will
6774 become obsolete (at least for Unix).
6775 This option cannot be set from a |modeline| or in the |sandbox|, for
6776 security reasons.
6777
6778 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
6779'shellslash' 'ssl' boolean (default off)
6780 global
Bram Moolenaar6f345a12019-12-17 21:27:18 +01006781 {only for MS-Windows}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006782 When set, a forward slash is used when expanding file names. This is
Mike Williamsa3d1b292021-06-30 20:56:00 +02006783 useful when a Unix-like shell is used instead of cmd.exe, pwsh.exe, or
Mike Williams12795022021-06-28 20:53:58 +02006784 powershell.exe. Backward slashes can still be typed, but they are
6785 changed to forward slashes by Vim.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006786 Note that setting or resetting this option has no effect for some
6787 existing file names, thus this option needs to be set before opening
6788 any file for best results. This might change in the future.
6789 'shellslash' only works when a backslash can be used as a path
6790 separator. To test if this is so use: >
6791 if exists('+shellslash')
Bram Moolenaarac3150d2019-07-28 16:36:39 +02006792< Also see 'completeslash'.
6793
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006794 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
6795'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
6796 global
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006797 When on, use temp files for shell commands. When off use a pipe.
6798 When using a pipe is not possible temp files are used anyway.
Bram Moolenaar97293012011-07-18 19:40:27 +02006799 Currently a pipe is only supported on Unix and MS-Windows 2K and
6800 later. You can check it with: >
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006801 :if has("filterpipe")
6802< The advantage of using a pipe is that nobody can read the temp file
6803 and the 'shell' command does not need to support redirection.
6804 The advantage of using a temp file is that the file type and encoding
6805 can be detected.
6806 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
6807 |FilterWritePost| autocommands event are not triggered when
6808 'shelltemp' is off.
Bram Moolenaar269f5952016-07-15 22:54:41 +02006809 The `system()` function does not respect this option and always uses
6810 temp files.
Bram Moolenaar036986f2017-03-16 17:41:02 +01006811 NOTE: This option is set to the Vim default value when 'compatible'
6812 is reset.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006813
Bram Moolenaar071d4272004-06-13 20:20:40 +00006814 *'shelltype'* *'st'*
6815'shelltype' 'st' number (default 0)
6816 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02006817 {only for the Amiga}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006818 On the Amiga this option influences the way how the commands work
6819 which use a shell.
6820 0 and 1: always use the shell
6821 2 and 3: use the shell only to filter lines
6822 4 and 5: use shell only for ':sh' command
6823 When not using the shell, the command is executed directly.
6824
6825 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
6826 1 and 3: use "shell cmd" to start external commands
6827
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006828 *'shellxescape'* *'sxe'*
6829'shellxescape' 'sxe' string (default: "";
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006830 for MS-Windows: "\"&|<>()@^")
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006831 global
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006832 When 'shellxquote' is set to "(" then the characters listed in this
6833 option will be escaped with a '^' character. This makes it possible
6834 to execute most external commands with cmd.exe.
6835
Bram Moolenaar071d4272004-06-13 20:20:40 +00006836 *'shellxquote'* *'sxq'*
6837'shellxquote' 'sxq' string (default: "";
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006838 for Win32, when 'shell' is cmd.exe: "("
Mike Williams12795022021-06-28 20:53:58 +02006839 for Win32, when 'shell' is
6840 powershell.exe: "\""
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006841 for Win32, when 'shell' contains "sh"
6842 somewhere: "\""
Bram Moolenaar071d4272004-06-13 20:20:40 +00006843 for Unix, when using system(): "\"")
6844 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006845 Quoting character(s), put around the command passed to the shell, for
6846 the "!" and ":!" commands. Includes the redirection. See
6847 'shellquote' to exclude the redirection. It's probably not useful
6848 to set both options.
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006849 When the value is '(' then ')' is appended. When the value is '"('
6850 then ')"' is appended.
6851 When the value is '(' then also see 'shellxescape'.
Bram Moolenaara64ba222012-02-12 23:23:31 +01006852 This is an empty string by default on most systems, but is known to be
Mike Williamsa3d1b292021-06-30 20:56:00 +02006853 useful for on Win32 version, either for cmd.exe, powershell.exe, or
6854 pwsh.exe which automatically strips off the first and last quote on a
6855 command, or 3rd-party shells such as the MKS Korn Shell or bash, where
6856 it should be "\"". The default is adjusted according the value of
Mike Williams12795022021-06-28 20:53:58 +02006857 'shell', to reduce the need to set this option by the user. See
6858 |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006859 This option cannot be set from a |modeline| or in the |sandbox|, for
6860 security reasons.
6861
6862 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
6863'shiftround' 'sr' boolean (default off)
6864 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006865 Round indent to multiple of 'shiftwidth'. Applies to > and <
6866 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
6867 a multiple of 'shiftwidth' (this is Vi compatible).
6868 NOTE: This option is reset when 'compatible' is set.
6869
6870 *'shiftwidth'* *'sw'*
6871'shiftwidth' 'sw' number (default 8)
6872 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006873 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00006874 |'cindent'|, |>>|, |<<|, etc.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02006875 When zero the 'ts' value will be used. Use the |shiftwidth()|
6876 function to get the effective shiftwidth value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006877
6878 *'shortmess'* *'shm'*
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02006879'shortmess' 'shm' string (Vim default "filnxtToOS", Vi default: "S",
6880 POSIX default: "AS")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006881 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006882 This option helps to avoid all the |hit-enter| prompts caused by file
6883 messages, for example with CTRL-G, and to avoid some other messages.
6884 It is a list of flags:
6885 flag meaning when present ~
6886 f use "(3 of 5)" instead of "(file 3 of 5)"
6887 i use "[noeol]" instead of "[Incomplete last line]"
Bram Moolenaar3f40ce72020-07-05 14:10:13 +02006888 l use "999L, 888B" instead of "999 lines, 888 bytes"
Bram Moolenaar071d4272004-06-13 20:20:40 +00006889 m use "[+]" instead of "[Modified]"
6890 n use "[New]" instead of "[New File]"
6891 r use "[RO]" instead of "[readonly]"
6892 w use "[w]" instead of "written" for file write message
6893 and "[a]" instead of "appended" for ':w >> file' command
6894 x use "[dos]" instead of "[dos format]", "[unix]" instead of
6895 "[unix format]" and "[mac]" instead of "[mac format]".
6896 a all of the above abbreviations
6897
6898 o overwrite message for writing a file with subsequent message
6899 for reading a file (useful for ":wn" or when 'autowrite' on)
6900 O message for reading a file overwrites any previous message.
6901 Also for quickfix message (e.g., ":cn").
6902 s don't give "search hit BOTTOM, continuing at TOP" or "search
Bram Moolenaara6c27c42019-05-09 19:16:22 +02006903 hit TOP, continuing at BOTTOM" messages; when using the search
6904 count do not show "W" after the count message (see S below)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006905 t truncate file message at the start if it is too long to fit
6906 on the command-line, "<" will appear in the left most column.
6907 Ignored in Ex mode.
6908 T truncate other messages in the middle if they are too long to
Bram Moolenaar582fd852005-03-28 20:58:01 +00006909 fit on the command line. "..." will appear in the middle.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006910 Ignored in Ex mode.
6911 W don't give "written" or "[w]" when writing a file
6912 A don't give the "ATTENTION" message when an existing swap file
6913 is found.
6914 I don't give the intro message when starting Vim |:intro|.
Bram Moolenaarea389e92014-05-28 21:40:52 +02006915 c don't give |ins-completion-menu| messages. For example,
6916 "-- XXX completion (YYY)", "match 1 of 2", "The only match",
6917 "Pattern not found", "Back at original", etc.
Bram Moolenaar426dd022016-03-15 15:09:29 +01006918 q use "recording" instead of "recording @a"
6919 F don't give the file info when editing a file, like `:silent`
Bram Moolenaar110289e2019-05-23 15:38:06 +02006920 was used for the command; note that this also affects messages
6921 from autocommands
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02006922 S do not show search count message when searching, e.g.
6923 "[1/5]"
Bram Moolenaar071d4272004-06-13 20:20:40 +00006924
6925 This gives you the opportunity to avoid that a change between buffers
6926 requires you to hit <Enter>, but still gives as useful a message as
6927 possible for the space available. To get the whole message that you
6928 would have got with 'shm' empty, use ":file!"
6929 Useful values:
6930 shm= No abbreviation of message.
6931 shm=a Abbreviation, but no loss of information.
6932 shm=at Abbreviation, and truncate message when necessary.
6933
6934 NOTE: This option is set to the Vi default value when 'compatible' is
6935 set and to the Vim default value when 'compatible' is reset.
6936
6937 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
6938'shortname' 'sn' boolean (default off)
6939 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00006940 Filenames are assumed to be 8 characters plus one extension of 3
6941 characters. Multiple dots in file names are not allowed. When this
6942 option is on, dots in file names are replaced with underscores when
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006943 adding an extension (".~" or ".swp"). This option is useful
Bram Moolenaar071d4272004-06-13 20:20:40 +00006944 when editing files on an MS-DOS compatible filesystem, e.g., messydos
Bram Moolenaarade0d392020-01-21 22:33:58 +01006945 or crossdos.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006946
6947 *'showbreak'* *'sbr'* *E595*
6948'showbreak' 'sbr' string (default "")
Bram Moolenaaree857022019-11-09 23:26:40 +01006949 global or local to window |global-local|
Bram Moolenaardb84e452010-08-15 13:50:43 +02006950 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006951 feature}
6952 String to put at the start of lines that have been wrapped. Useful
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006953 values are "> " or "+++ ": >
6954 :set showbreak=>\
6955< Note the backslash to escape the trailing space. It's easier like
6956 this: >
Bram Moolenaar1a384422010-07-14 19:53:30 +02006957 :let &showbreak = '+++ '
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006958< Only printable single-cell characters are allowed, excluding <Tab> and
Bram Moolenaar071d4272004-06-13 20:20:40 +00006959 comma (in a future version the comma might be used to separate the
6960 part that is shown at the end and at the start of a line).
6961 The characters are highlighted according to the '@' flag in
6962 'highlight'.
6963 Note that tabs after the showbreak will be displayed differently.
6964 If you want the 'showbreak' to appear in between line numbers, add the
6965 "n" flag to 'cpoptions'.
Bram Moolenaaree857022019-11-09 23:26:40 +01006966 A window-local value overrules a global value. If the global value is
6967 set and you want no value in the current window use NONE: >
6968 :setlocal showbreak=NONE
6969<
Bram Moolenaar071d4272004-06-13 20:20:40 +00006970 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02006971'showcmd' 'sc' boolean (Vim default: on, off for Unix,
6972 Vi default: off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006973 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006974 {not available when compiled without the
6975 |+cmdline_info| feature}
Bram Moolenaar02467872007-05-06 13:22:01 +00006976 Show (partial) command in the last line of the screen. Set this
6977 option off if your terminal is slow.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006978 In Visual mode the size of the selected area is shown:
6979 - When selecting characters within a line, the number of characters.
Bram Moolenaarf91787c2010-07-17 12:47:16 +02006980 If the number of bytes is different it is also displayed: "2-6"
6981 means two characters and six bytes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006982 - When selecting more than one line, the number of lines.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006983 - When selecting a block, the size in screen characters:
6984 {lines}x{columns}.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006985 NOTE: This option is set to the Vi default value when 'compatible' is
6986 set and to the Vim default value when 'compatible' is reset.
6987
6988 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
6989'showfulltag' 'sft' boolean (default off)
6990 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006991 When completing a word in insert mode (see |ins-completion|) from the
6992 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006993 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00006994 matched a C function, you can see a template for what arguments are
6995 required (coding style permitting).
Bram Moolenaar446cb832008-06-24 21:56:24 +00006996 Note that this doesn't work well together with having "longest" in
6997 'completeopt', because the completion from the search pattern may not
6998 match the typed text.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006999
7000 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
7001'showmatch' 'sm' boolean (default off)
7002 global
7003 When a bracket is inserted, briefly jump to the matching one. The
7004 jump is only done if the match can be seen on the screen. The time to
7005 show the match can be set with 'matchtime'.
7006 A Beep is given if there is no match (no matter if the match can be
Bram Moolenaarca635012015-09-25 20:34:21 +02007007 seen or not).
7008 This option is reset when 'paste' is set and restored when 'paste' is
7009 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007010 When the 'm' flag is not included in 'cpoptions', typing a character
7011 will immediately move the cursor back to where it belongs.
7012 See the "sm" field in 'guicursor' for setting the cursor shape and
7013 blinking when showing the match.
7014 The 'matchpairs' option can be used to specify the characters to show
7015 matches for. 'rightleft' and 'revins' are used to look for opposite
7016 matches.
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007017 Also see the matchparen plugin for highlighting the match when moving
7018 around |pi_paren.txt|.
7019 Note: Use of the short form is rated PG.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007020
7021 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
7022'showmode' 'smd' boolean (Vim default: on, Vi default: off)
7023 global
7024 If in Insert, Replace or Visual mode put a message on the last line.
7025 Use the 'M' flag in 'highlight' to set the type of highlighting for
7026 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007027 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00007028 doesn't mean XIM is really active, especially when 'imactivatekey' is
7029 not set.
7030 NOTE: This option is set to the Vi default value when 'compatible' is
7031 set and to the Vim default value when 'compatible' is reset.
7032
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007033 *'showtabline'* *'stal'*
7034'showtabline' 'stal' number (default 1)
7035 global
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007036 The value of this option specifies when the line with tab page labels
7037 will be displayed:
7038 0: never
7039 1: only if there are at least two tab pages
7040 2: always
7041 This is both for the GUI and non-GUI implementation of the tab pages
7042 line.
7043 See |tab-page| for more information about tab pages.
7044
Bram Moolenaar071d4272004-06-13 20:20:40 +00007045 *'sidescroll'* *'ss'*
7046'sidescroll' 'ss' number (default 0)
7047 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007048 The minimal number of columns to scroll horizontally. Used only when
7049 the 'wrap' option is off and the cursor is moved off of the screen.
7050 When it is zero the cursor will be put in the middle of the screen.
7051 When using a slow terminal set it to a large number or 0. When using
7052 a fast terminal use a small number or 1. Not used for "zh" and "zl"
7053 commands.
7054
7055 *'sidescrolloff'* *'siso'*
7056'sidescrolloff' 'siso' number (default 0)
Bram Moolenaar375e3392019-01-31 18:26:10 +01007057 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007058 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00007059 right of the cursor if 'nowrap' is set. Setting this option to a
7060 value greater than 0 while having |'sidescroll'| also at a non-zero
7061 value makes some context visible in the line you are scrolling in
7062 horizontally (except at beginning of the line). Setting this option
7063 to a large value (like 999) has the effect of keeping the cursor
7064 horizontally centered in the window, as long as one does not come too
7065 close to the beginning of the line.
Bram Moolenaar375e3392019-01-31 18:26:10 +01007066 After using the local value, go back the global value with one of
7067 these two: >
7068 setlocal sidescrolloff<
7069 setlocal sidescrolloff=-1
7070< NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007071
7072 Example: Try this together with 'sidescroll' and 'listchars' as
7073 in the following example to never allow the cursor to move
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007074 onto the "extends" character: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007075
7076 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
7077 :set sidescrolloff=1
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007078<
7079 *'signcolumn'* *'scl'*
7080'signcolumn' 'scl' string (default "auto")
7081 local to window
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007082 {not available when compiled without the |+signs|
7083 feature}
Bram Moolenaar09521312016-08-12 22:54:35 +02007084 Whether or not to draw the signcolumn. Valid values are:
7085 "auto" only when there is a sign to display
7086 "no" never
7087 "yes" always
Bram Moolenaar394c5d82019-06-17 21:48:05 +02007088 "number" display signs in the 'number' column. If the number
Bram Moolenaar6c1e1572019-06-22 02:13:00 +02007089 column is not present, then behaves like "auto".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007090
7091
7092 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
7093'smartcase' 'scs' boolean (default off)
7094 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007095 Override the 'ignorecase' option if the search pattern contains upper
7096 case characters. Only used when the search pattern is typed and
7097 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarc8734422012-06-01 22:38:45 +02007098 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00007099 "*" and "#" you can make 'smartcase' used by doing a "/" command,
7100 recalling the search pattern from history and hitting <Enter>.
7101 NOTE: This option is reset when 'compatible' is set.
7102
7103 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
7104'smartindent' 'si' boolean (default off)
7105 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007106 {not available when compiled without the
7107 |+smartindent| feature}
7108 Do smart autoindenting when starting a new line. Works for C-like
7109 programs, but can also be used for other languages. 'cindent' does
7110 something like this, works better in most cases, but is more strict,
Bram Moolenaar81af9252010-12-10 20:35:50 +01007111 see |C-indenting|. When 'cindent' is on or 'indentexpr' is set,
Bram Moolenaar166af9b2010-11-16 20:34:40 +01007112 setting 'si' has no effect. 'indentexpr' is a more advanced
7113 alternative.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007114 Normally 'autoindent' should also be on when using 'smartindent'.
7115 An indent is automatically inserted:
7116 - After a line ending in '{'.
7117 - After a line starting with a keyword from 'cinwords'.
7118 - Before a line starting with '}' (only with the "O" command).
7119 When typing '}' as the first character in a new line, that line is
7120 given the same indent as the matching '{'.
7121 When typing '#' as the first character in a new line, the indent for
7122 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007123 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00007124 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
7125 When using the ">>" command, lines starting with '#' are not shifted
7126 right.
Bram Moolenaar036986f2017-03-16 17:41:02 +01007127 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02007128 This option is reset when 'paste' is set and restored when 'paste' is
7129 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007130
7131 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
7132'smarttab' 'sta' boolean (default off)
7133 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007134 When on, a <Tab> in front of a line inserts blanks according to
Bram Moolenaar280f1262006-01-30 00:14:18 +00007135 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A
7136 <BS> will delete a 'shiftwidth' worth of space at the start of the
7137 line.
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00007138 When off, a <Tab> always inserts blanks according to 'tabstop' or
Bram Moolenaar280f1262006-01-30 00:14:18 +00007139 'softtabstop'. 'shiftwidth' is only used for shifting text left or
7140 right |shift-left-right|.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007141 What gets inserted (a <Tab> or spaces) depends on the 'expandtab'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007142 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00007143 number of spaces is minimized by using <Tab>s.
Bram Moolenaarca635012015-09-25 20:34:21 +02007144 This option is reset when 'paste' is set and restored when 'paste' is
7145 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007146 NOTE: This option is reset when 'compatible' is set.
7147
7148 *'softtabstop'* *'sts'*
7149'softtabstop' 'sts' number (default 0)
7150 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007151 Number of spaces that a <Tab> counts for while performing editing
7152 operations, like inserting a <Tab> or using <BS>. It "feels" like
7153 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
7154 used. This is useful to keep the 'ts' setting at its standard value
7155 of 8, while being able to edit like it is set to 'sts'. However,
7156 commands like "x" still work on the actual characters.
7157 When 'sts' is zero, this feature is off.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02007158 When 'sts' is negative, the value of 'shiftwidth' is used.
Bram Moolenaarca635012015-09-25 20:34:21 +02007159 'softtabstop' is set to 0 when the 'paste' option is set and restored
7160 when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007161 See also |ins-expandtab|. When 'expandtab' is not set, the number of
7162 spaces is minimized by using <Tab>s.
7163 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
7164 set.
7165 NOTE: This option is set to 0 when 'compatible' is set.
7166
Bram Moolenaar04958cb2018-06-23 19:23:02 +02007167 If Vim is compiled with the |+vartabs| feature then the value of
7168 'softtabstop' will be ignored if |'varsofttabstop'| is set to
7169 anything other than an empty string.
7170
Bram Moolenaar217ad922005-03-20 22:37:15 +00007171 *'spell'* *'nospell'*
7172'spell' boolean (default off)
7173 local to window
Bram Moolenaar217ad922005-03-20 22:37:15 +00007174 {not available when compiled without the |+syntax|
7175 feature}
7176 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007177 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007178
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007179 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00007180'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007181 local to buffer
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007182 {not available when compiled without the |+syntax|
7183 feature}
7184 Pattern to locate the end of a sentence. The following word will be
7185 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007186 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007187 When this check is not wanted make this option empty.
7188 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00007189 Be careful with special characters, see |option-backslash| about
7190 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007191 To set this option automatically depending on the language, see
7192 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007193
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007194 *'spellfile'* *'spf'*
7195'spellfile' 'spf' string (default empty)
7196 local to buffer
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007197 {not available when compiled without the |+syntax|
7198 feature}
7199 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00007200 commands. It must end in ".{encoding}.add". You need to include the
7201 path, otherwise the file is placed in the current directory.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007202 *E765*
7203 It may also be a comma separated list of names. A count before the
7204 |zg| and |zw| commands can be used to access each. This allows using
7205 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007206 When a word is added while this option is empty Vim will set it for
Bram Moolenaar910f66f2006-04-05 20:41:53 +00007207 you: Using the first directory in 'runtimepath' that is writable. If
7208 there is no "spell" directory yet it will be created. For the file
7209 name the first language name that appears in 'spelllang' is used,
Bram Moolenaar3b506942005-06-23 22:36:45 +00007210 ignoring the region.
7211 The resulting ".spl" file will be used for spell checking, it does not
7212 have to appear in 'spelllang'.
7213 Normally one file is used for all regions, but you can add the region
7214 name if you want to. However, it will then only be used when
7215 'spellfile' is set to it, for entries in 'spelllang' only files
7216 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00007217 This option cannot be set from a |modeline| or in the |sandbox|, for
7218 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007219
Bram Moolenaar217ad922005-03-20 22:37:15 +00007220 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007221'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00007222 local to buffer
Bram Moolenaar217ad922005-03-20 22:37:15 +00007223 {not available when compiled without the |+syntax|
7224 feature}
Bram Moolenaar3b506942005-06-23 22:36:45 +00007225 A comma separated list of word list names. When the 'spell' option is
7226 on spellchecking will be done for these languages. Example: >
7227 set spelllang=en_us,nl,medical
7228< This means US English, Dutch and medical words are recognized. Words
7229 that are not recognized will be highlighted.
Bram Moolenaar911ead12019-04-21 00:03:35 +02007230 The word list name must consist of alphanumeric characters, a dash or
7231 an underscore. It should not include a comma or dot. Using a dash is
Bram Moolenaar3b506942005-06-23 22:36:45 +00007232 recommended to separate the two letter language name from a
7233 specification. Thus "en-rare" is used for rare English words.
7234 A region name must come last and have the form "_xx", where "xx" is
7235 the two-letter, lower case region name. You can use more than one
7236 region by listing them: "en_us,en_ca" supports both US and Canadian
7237 English, but not words specific for Australia, New Zealand or Great
Bram Moolenaarfa735342016-01-03 22:14:44 +01007238 Britain. (Note: currently en_au and en_nz dictionaries are older than
7239 en_ca, en_gb and en_us).
Bram Moolenaarcc63c642013-11-12 04:44:01 +01007240 If the name "cjk" is included East Asian characters are excluded from
7241 spell checking. This is useful when editing text that also has Asian
7242 words.
Bram Moolenaar6c391a72021-09-09 21:55:11 +02007243 Note that the "medical" dictionary does not exist, it is just an
7244 example of a longer name.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007245 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007246 As a special case the name of a .spl file can be given as-is. The
7247 first "_xx" in the name is removed and used as the region name
7248 (_xx is an underscore, two letters and followed by a non-letter).
7249 This is mainly for testing purposes. You must make sure the correct
7250 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007251 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007252 idea to set 'spelllang' after setting 'encoding' to avoid loading the
7253 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00007254 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007255
Bram Moolenaar98692072006-02-04 00:57:42 +00007256 If the |spellfile.vim| plugin is active and you use a language name
7257 for which Vim cannot find the .spl file in 'runtimepath' the plugin
7258 will ask you if you want to download the file.
7259
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007260 After this option has been set successfully, Vim will source the files
7261 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
Bram Moolenaarb730f0c2018-11-25 03:56:26 +01007262 up to the first character that is not an ASCII letter or number and
7263 not a dash. Also see |set-spc-auto|.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007264
Bram Moolenaar362b44b2020-06-10 21:47:00 +02007265 *'spelloptions'* *'spo'*
7266'spelloptions' 'spo' string (default "")
7267 local to buffer
7268 {not available when compiled without the |+syntax|
7269 feature}
7270 A comma separated list of options for spell checking:
7271 camel When a word is CamelCased, assume "Cased" is a
7272 separate word: every upper-case character in a word
7273 that comes after a lower case character indicates the
7274 start of a new word.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007275
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007276 *'spellsuggest'* *'sps'*
7277'spellsuggest' 'sps' string (default "best")
7278 global
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007279 {not available when compiled without the |+syntax|
7280 feature}
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007281 Methods used for spelling suggestions. Both for the |z=| command and
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007282 the |spellsuggest()| function. This is a comma-separated list of
7283 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007284
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007285 best Internal method that works best for English. Finds
7286 changes like "fast" and uses a bit of sound-a-like
7287 scoring to improve the ordering.
7288
7289 double Internal method that uses two methods and mixes the
7290 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007291 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007292 word. That only works when the language specifies
7293 sound folding. Can be slow and doesn't always give
7294 better results.
7295
7296 fast Internal method that only checks for simple changes:
7297 character inserts/deletes/swaps. Works well for
7298 simple typing mistakes.
7299
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007300 {number} The maximum number of suggestions listed for |z=|.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007301 Not used for |spellsuggest()|. The number of
7302 suggestions is never more than the value of 'lines'
7303 minus two.
7304
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007305 file:{filename} Read file {filename}, which must have two columns,
7306 separated by a slash. The first column contains the
7307 bad word, the second column the suggested good word.
7308 Example:
7309 theribal/terrible ~
7310 Use this for common mistakes that do not appear at the
7311 top of the suggestion list with the internal methods.
7312 Lines without a slash are ignored, use this for
7313 comments.
Bram Moolenaarbcb98982014-05-01 14:08:19 +02007314 The word in the second column must be correct,
7315 otherwise it will not be used. Add the word to an
7316 ".add" file if it is currently flagged as a spelling
7317 mistake.
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007318 The file is used for all languages.
7319
7320 expr:{expr} Evaluate expression {expr}. Use a function to avoid
7321 trouble with spaces. |v:val| holds the badly spelled
7322 word. The expression must evaluate to a List of
7323 Lists, each with a suggestion and a score.
7324 Example:
Bram Moolenaar214641f2017-03-05 17:04:09 +01007325 [['the', 33], ['that', 44]] ~
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007326 Set 'verbose' and use |z=| to see the scores that the
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007327 internal methods use. A lower score is better.
7328 This may invoke |spellsuggest()| if you temporarily
7329 set 'spellsuggest' to exclude the "expr:" part.
7330 Errors are silently ignored, unless you set the
7331 'verbose' option to a non-zero value.
7332
7333 Only one of "best", "double" or "fast" may be used. The others may
7334 appear several times in any order. Example: >
7335 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
7336<
7337 This option cannot be set from a |modeline| or in the |sandbox|, for
7338 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007339
7340
Bram Moolenaar071d4272004-06-13 20:20:40 +00007341 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
7342'splitbelow' 'sb' boolean (default off)
7343 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007344 When on, splitting a window will put the new window below the current
7345 one. |:split|
7346
7347 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
7348'splitright' 'spr' boolean (default off)
7349 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007350 When on, splitting a window will put the new window right of the
7351 current one. |:vsplit|
7352
7353 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
7354'startofline' 'sol' boolean (default on)
7355 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007356 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00007357 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007358 (if possible). This applies to the commands: CTRL-D, CTRL-U, CTRL-B,
Bram Moolenaar843ee412004-06-30 16:16:41 +00007359 CTRL-F, "G", "H", "M", "L", gg, and to the commands "d", "<<" and ">>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007360 with a linewise operator, with "%" with a count and to buffer changing
7361 commands (CTRL-^, :bnext, :bNext, etc.). Also for an Ex command that
7362 only has a line number, e.g., ":25" or ":+".
7363 In case of buffer changing commands the cursor is placed at the column
7364 where it was the last time the buffer was edited.
7365 NOTE: This option is set when 'compatible' is set.
7366
Bram Moolenaar00654022011-02-25 14:42:19 +01007367 *'statusline'* *'stl'* *E540* *E542*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007368'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007369 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007370 {not available when compiled without the |+statusline|
7371 feature}
7372 When nonempty, this option determines the content of the status line.
7373 Also see |status-line|.
7374
7375 The option consists of printf style '%' items interspersed with
7376 normal text. Each status line item is of the form:
7377 %-0{minwid}.{maxwid}{item}
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01007378 All fields except the {item} are optional. A single percent sign can
Bram Moolenaar8133cc62020-10-26 21:05:27 +01007379 be given as "%%".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007380
Bram Moolenaar238a5642006-02-21 22:12:05 +00007381 When the option starts with "%!" then it is used as an expression,
7382 evaluated and the result is used as the option value. Example: >
7383 :set statusline=%!MyStatusLine()
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02007384< The *g:statusline_winid* variable will be set to the |window-ID| of the
7385 window that the status line belongs to.
7386 The result can contain %{} items that will be evaluated too.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02007387 Note that the "%!" expression is evaluated in the context of the
7388 current window and buffer, while %{} items are evaluated in the
7389 context of the window that the statusline belongs to.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007390
7391 When there is error while evaluating the option then it will be made
7392 empty to avoid further errors. Otherwise screen updating would loop.
7393
Bram Moolenaar071d4272004-06-13 20:20:40 +00007394 Note that the only effect of 'ruler' when this option is set (and
7395 'laststatus' is 2) is controlling the output of |CTRL-G|.
7396
7397 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00007398 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00007399 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007400 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007401 minwid Minimum width of the item, padding as set by '-' & '0'.
7402 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007403 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007404 on the left for text items. Numeric items will be
7405 shifted down to maxwid-2 digits followed by '>'number
7406 where number is the amount of missing digits, much like
7407 an exponential notation.
7408 item A one letter code as described below.
7409
7410 Following is a description of the possible statusline items. The
7411 second character in "item" is the type:
7412 N for number
7413 S for string
7414 F for flags as described below
7415 - not applicable
7416
7417 item meaning ~
Bram Moolenaar02467872007-05-06 13:22:01 +00007418 f S Path to the file in the buffer, as typed or relative to current
7419 directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007420 F S Full path to the file in the buffer.
7421 t S File name (tail) of file in the buffer.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007422 m F Modified flag, text is "[+]"; "[-]" if 'modifiable' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007423 M F Modified flag, text is ",+" or ",-".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007424 r F Readonly flag, text is "[RO]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007425 R F Readonly flag, text is ",RO".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007426 h F Help buffer flag, text is "[help]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007427 H F Help buffer flag, text is ",HLP".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007428 w F Preview window flag, text is "[Preview]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007429 W F Preview window flag, text is ",PRV".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007430 y F Type of file in the buffer, e.g., "[vim]". See 'filetype'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007431 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
Bram Moolenaar7fd73202010-07-25 16:58:46 +02007432 q S "[Quickfix List]", "[Location List]" or empty.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007433 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
7434 being used: "<keymap>"
7435 n N Buffer number.
Bram Moolenaar00654022011-02-25 14:42:19 +01007436 b N Value of character under cursor.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007437 B N As above, in hexadecimal.
7438 o N Byte number in file of byte under cursor, first byte is 1.
7439 Mnemonic: Offset from start of file (with one added)
7440 {not available when compiled without |+byte_offset| feature}
7441 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007442 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007443 l N Line number.
7444 L N Number of lines in buffer.
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02007445 c N Column number (byte index).
7446 v N Virtual column number (screen column).
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007447 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007448 p N Percentage through file in lines as in |CTRL-G|.
7449 P S Percentage through file of displayed window. This is like the
Bram Moolenaar14b69452013-06-29 23:05:20 +02007450 percentage described for 'ruler'. Always 3 in length, unless
7451 translated.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007452 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00007453 Empty if the argument file count is zero or one.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007454 { NF Evaluate expression between '%{' and '}' and substitute result.
Bram Moolenaar6d150f72018-04-21 20:03:20 +02007455 Note that there is no '%' before the closing '}'. The
7456 expression cannot contain a '}' character, call a function to
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007457 work around that. See |stl-%{| below.
shadmansaleh30e3de22021-05-15 17:23:28 +02007458 {% - This is almost same as { except the result of the expression is
7459 re-evaluated as a statusline format string. Thus if the
7460 return value of expr contains % items they will get expanded.
7461 The expression can contain the } character, the end of
7462 expression is denoted by %}.
Bram Moolenaar22863042021-10-16 15:23:36 +01007463 For example: >
shadmansaleh30e3de22021-05-15 17:23:28 +02007464 func! Stl_filename() abort
7465 return "%t"
7466 endfunc
7467< `stl=%{Stl_filename()}` results in `"%t"`
7468 `stl=%{%Stl_filename()%}` results in `"Name of current file"`
Bram Moolenaar22863042021-10-16 15:23:36 +01007469 %} - End of `{%` expression
Bram Moolenaar071d4272004-06-13 20:20:40 +00007470 ( - Start of item group. Can be used for setting the width and
7471 alignment of a section. Must be followed by %) somewhere.
7472 ) - End of item group. No width fields allowed.
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007473 T N For 'tabline': start of tab page N label. Use %T after the last
7474 label. This information is used for mouse clicks.
7475 X N For 'tabline': start of close tab N label. Use %X after the
7476 label, e.g.: %3Xclose%X. Use %999X for a "close current tab"
7477 mark. This information is used for mouse clicks.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007478 < - Where to truncate line if too long. Default is at the start.
7479 No width fields allowed.
7480 = - Separation point between left and right aligned items.
7481 No width fields allowed.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007482 # - Set highlight group. The name must follow and then a # again.
7483 Thus use %#HLname# for highlight group HLname. The same
7484 highlighting is used, also for the statusline of non-current
7485 windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007486 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00007487 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007488 The difference between User{N} and StatusLine will be applied
7489 to StatusLineNC for the statusline of non-current windows.
7490 The number N must be between 1 and 9. See |hl-User1..9|
7491
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007492 When displaying a flag, Vim removes the leading comma, if any, when
7493 that flag comes right after plaintext. This will make a nice display
7494 when flags are used like in the examples below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007495
Bram Moolenaar582fd852005-03-28 20:58:01 +00007496 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00007497 not set) and a minwid is not set for the group, the whole group will
7498 become empty. This will make a group like the following disappear
7499 completely from the statusline when none of the flags are set. >
7500 :set statusline=...%(\ [%M%R%H]%)...
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02007501< Beware that an expression is evaluated each and every time the status
7502 line is displayed.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007503 *stl-%{* *g:actual_curbuf* *g:actual_curwin*
Bram Moolenaarade0d392020-01-21 22:33:58 +01007504 While evaluating %{} the current buffer and current window will be set
7505 temporarily to that of the window (and buffer) whose statusline is
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007506 currently being drawn. The expression will evaluate in this context.
7507 The variable "g:actual_curbuf" is set to the `bufnr()` number of the
7508 real current buffer and "g:actual_curwin" to the |window-ID| of the
7509 real current window. These values are strings.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007510
Bram Moolenaar30b65812012-07-12 22:01:11 +02007511 The 'statusline' option will be evaluated in the |sandbox| if set from
7512 a modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02007513 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007514
7515 It is not allowed to change text or jump to another window while
7516 evaluating 'statusline' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007517
7518 If the statusline is not updated when you want it (e.g., after setting
7519 a variable that's used in an expression), you can force an update by
7520 setting an option without changing its value. Example: >
7521 :let &ro = &ro
7522
7523< A result of all digits is regarded a number for display purposes.
7524 Otherwise the result is taken as flag text and applied to the rules
7525 described above.
7526
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00007527 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00007528 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
Bram Moolenaarc4da1132017-07-15 19:39:43 +02007529 edit your .vimrc or whatever with "vim --clean" to get it right.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007530
7531 Examples:
7532 Emulate standard status line with 'ruler' set >
7533 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
7534< Similar, but add ASCII value of char under the cursor (like "ga") >
7535 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
7536< Display byte count and byte value, modified flag in red. >
7537 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
7538 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
7539< Display a ,GZ flag if a compressed file is loaded >
7540 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
7541< In the |:autocmd|'s: >
7542 :let b:gzflag = 1
7543< And: >
7544 :unlet b:gzflag
7545< And define this function: >
7546 :function VarExists(var, val)
7547 : if exists(a:var) | return a:val | else | return '' | endif
7548 :endfunction
7549<
7550 *'suffixes'* *'su'*
7551'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
7552 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007553 Files with these suffixes get a lower priority when multiple files
7554 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007555 suffixes. Spaces after the comma are ignored. A dot is also seen as
7556 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007557 separator, precede it with a backslash (see |option-backslash| about
7558 including spaces and backslashes).
7559 See 'wildignore' for completely ignoring files.
7560 The use of |:set+=| and |:set-=| is preferred when adding or removing
7561 suffixes from the list. This avoids problems when a future version
7562 uses another default.
7563
7564 *'suffixesadd'* *'sua'*
7565'suffixesadd' 'sua' string (default "")
7566 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007567 {not available when compiled without the
7568 |+file_in_path| feature}
7569 Comma separated list of suffixes, which are used when searching for a
7570 file for the "gf", "[I", etc. commands. Example: >
7571 :set suffixesadd=.java
7572<
7573 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
7574'swapfile' 'swf' boolean (default on)
7575 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007576 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007577 swapfile is not wanted for a specific buffer. For example, with
7578 confidential information that even root must not be able to access.
7579 Careful: All text will be in memory:
7580 - Don't use this for big files.
7581 - Recovery will be impossible!
7582 A swapfile will only be present when |'updatecount'| is non-zero and
7583 'swapfile' is set.
7584 When 'swapfile' is reset, the swap file for the current buffer is
7585 immediately deleted. When 'swapfile' is set, and 'updatecount' is
7586 non-zero, a swap file is immediately created.
7587 Also see |swap-file| and |'swapsync'|.
Bram Moolenaar76f3b1a2014-03-27 22:30:07 +01007588 If you want to open a new buffer without creating a swap file for it,
7589 use the |:noswapfile| modifier.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01007590 See 'directory' for where the swap file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007591
7592 This option is used together with 'bufhidden' and 'buftype' to
7593 specify special kinds of buffers. See |special-buffers|.
7594
7595 *'swapsync'* *'sws'*
7596'swapsync' 'sws' string (default "fsync")
7597 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007598 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007599 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007600 When this option is empty parts of the swap file may be in memory and
7601 not written to disk. When the system crashes you may lose more work.
7602 On Unix the system does a sync now and then without Vim asking for it,
7603 so the disadvantage of setting this option off is small. On some
7604 systems the swap file will not be written at all. For a unix system
7605 setting it to "sync" will use the sync() call instead of the default
7606 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007607 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007608
7609 *'switchbuf'* *'swb'*
7610'switchbuf' 'swb' string (default "")
7611 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007612 This option controls the behavior when switching between buffers.
Bram Moolenaard2ea7cf2021-05-30 20:54:13 +02007613 Mostly for |quickfix| commands some values are also used for other
7614 commands, as mentioned below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007615 Possible values (comma separated list):
7616 useopen If included, jump to the first open window that
7617 contains the specified buffer (if there is one).
7618 Otherwise: Do not examine other windows.
7619 This setting is checked with |quickfix| commands, when
7620 jumping to errors (":cc", ":cn", "cp", etc.). It is
7621 also used in all buffer related split commands, for
7622 example ":sbuffer", ":sbnext", or ":sbrewind".
Bram Moolenaar779b74b2006-04-10 14:55:34 +00007623 usetab Like "useopen", but also consider windows in other tab
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00007624 pages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007625 split If included, split the current window before loading
Bram Moolenaar15146672011-10-20 22:22:38 +02007626 a buffer for a |quickfix| command that display errors.
Bram Moolenaar63b74a82019-03-24 15:09:13 +01007627 Otherwise: do not split, use current window (when used
7628 in the quickfix window: the previously used window or
7629 split if there is no other window).
Bram Moolenaara594d772015-06-19 14:41:49 +02007630 vsplit Just like "split" but split vertically.
Bram Moolenaar446cb832008-06-24 21:56:24 +00007631 newtab Like "split", but open a new tab page. Overrules
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02007632 "split" when both are present.
Bram Moolenaar539aa6b2019-11-17 18:09:38 +01007633 uselast If included, jump to the previously used window when
7634 jumping to errors with |quickfix| commands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007635
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007636 *'synmaxcol'* *'smc'*
7637'synmaxcol' 'smc' number (default 3000)
7638 local to buffer
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007639 {not available when compiled without the |+syntax|
7640 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007641 Maximum column in which to search for syntax items. In long lines the
7642 text after this column is not highlighted and following lines may not
7643 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007644 This helps to avoid very slow redrawing for an XML file that is one
7645 long line.
7646 Set to zero to remove the limit.
7647
Bram Moolenaar071d4272004-06-13 20:20:40 +00007648 *'syntax'* *'syn'*
7649'syntax' 'syn' string (default empty)
7650 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007651 {not available when compiled without the |+syntax|
7652 feature}
7653 When this option is set, the syntax with this name is loaded, unless
7654 syntax highlighting has been switched off with ":syntax off".
7655 Otherwise this option does not always reflect the current syntax (the
7656 b:current_syntax variable does).
7657 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007658 not automatically recognized. Example, in an IDL file:
7659 /* vim: set syntax=idl : */ ~
7660 When a dot appears in the value then this separates two filetype
7661 names. Example:
7662 /* vim: set syntax=c.doxygen : */ ~
7663 This will use the "c" syntax first, then the "doxygen" syntax.
7664 Note that the second one must be prepared to be loaded as an addition,
7665 otherwise it will be skipped. More than one dot may appear.
7666 To switch off syntax highlighting for the current file, use: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007667 :set syntax=OFF
7668< To switch syntax highlighting on according to the current value of the
7669 'filetype' option: >
7670 :set syntax=ON
7671< What actually happens when setting the 'syntax' option is that the
7672 Syntax autocommand event is triggered with the value as argument.
7673 This option is not copied to another buffer, independent of the 's' or
7674 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007675 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007676
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007677 *'tabline'* *'tal'*
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007678'tabline' 'tal' string (default empty)
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007679 global
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007680 When nonempty, this option determines the content of the tab pages
7681 line at the top of the Vim window. When empty Vim will use a default
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007682 tab pages line. See |setting-tabline| for more info.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007683
7684 The tab pages line only appears as specified with the 'showtabline'
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00007685 option and only when there is no GUI tab line. When 'e' is in
7686 'guioptions' and the GUI supports a tab line 'guitablabel' is used
Bram Moolenaar7f036442010-08-15 15:24:20 +02007687 instead. Note that the two tab pages lines are very different.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007688
7689 The value is evaluated like with 'statusline'. You can use
7690 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007691 the text to be displayed. Use "%1T" for the first label, "%2T" for
7692 the second one, etc. Use "%X" items for closing labels.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007693
Bram Moolenaare12bab32019-01-08 22:02:56 +01007694 When changing something that is used in 'tabline' that does not
7695 trigger it to be updated, use |:redrawtabline|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02007696 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaare12bab32019-01-08 22:02:56 +01007697
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007698 Keep in mind that only one of the tab pages is the current one, others
7699 are invisible and you can't jump to their windows.
7700
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007701
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007702 *'tabpagemax'* *'tpm'*
7703'tabpagemax' 'tpm' number (default 10)
7704 global
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007705 Maximum number of tab pages to be opened by the |-p| command line
7706 argument or the ":tab all" command. |tabpage|
7707
7708
7709 *'tabstop'* *'ts'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007710'tabstop' 'ts' number (default 8)
7711 local to buffer
7712 Number of spaces that a <Tab> in the file counts for. Also see
7713 |:retab| command, and 'softtabstop' option.
7714
7715 Note: Setting 'tabstop' to any other value than 8 can make your file
7716 appear wrong in many places (e.g., when printing it).
7717
7718 There are four main ways to use tabs in Vim:
7719 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
7720 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007721 will use a mix of tabs and spaces, but typing <Tab> and <BS> will
Bram Moolenaar071d4272004-06-13 20:20:40 +00007722 behave like a tab appears every 4 (or 3) characters.
7723 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
7724 'expandtab'. This way you will always insert spaces. The
7725 formatting will never be messed up when 'tabstop' is changed.
7726 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007727 |modeline| to set these values when editing the file again. Only
Bram Moolenaar071d4272004-06-13 20:20:40 +00007728 works when using Vim to edit the file.
7729 4. Always set 'tabstop' and 'shiftwidth' to the same value, and
7730 'noexpandtab'. This should then work (for initial indents only)
7731 for any tabstop setting that people use. It might be nice to have
7732 tabs after the first non-blank inserted as spaces if you do this
7733 though. Otherwise aligned comments will be wrong when 'tabstop' is
7734 changed.
7735
Bram Moolenaar04958cb2018-06-23 19:23:02 +02007736 If Vim is compiled with the |+vartabs| feature then the value of
7737 'tabstop' will be ignored if |'vartabstop'| is set to anything other
7738 than an empty string.
7739
Bram Moolenaar071d4272004-06-13 20:20:40 +00007740 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
7741'tagbsearch' 'tbs' boolean (default on)
7742 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007743 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007744 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00007745 searching makes searching for a tag a LOT faster, but a linear search
7746 will find more tags if the tags file wasn't properly sorted.
7747 Vim normally assumes that your tags files are sorted, or indicate that
7748 they are not sorted. Only when this is not the case does the
7749 'tagbsearch' option need to be switched off.
7750
7751 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007752 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00007753 certain files, or retry all files with a linear search. When
7754 'tagbsearch' is off, only a linear search is done.
7755
7756 Linear searching is done anyway, for one file, when Vim finds a line
7757 at the start of the file indicating that it's not sorted: >
Bram Moolenaar446cb832008-06-24 21:56:24 +00007758 !_TAG_FILE_SORTED 0 /some comment/
Bram Moolenaar071d4272004-06-13 20:20:40 +00007759< [The whitespace before and after the '0' must be a single <Tab>]
7760
7761 When a binary search was done and no match was found in any of the
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007762 files listed in 'tags', and case is ignored or a pattern is used
Bram Moolenaar071d4272004-06-13 20:20:40 +00007763 instead of a normal tag name, a retry is done with a linear search.
7764 Tags in unsorted tags files, and matches with different case will only
7765 be found in the retry.
7766
Bram Moolenaard4755bb2004-09-02 19:12:26 +00007767 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007768 linear search can be avoided when case is ignored. Use a value of '2'
7769 in the "!_TAG_FILE_SORTED" line for this. A tag file can be case-fold
7770 sorted with the -f switch to "sort" in most unices, as in the command:
7771 "sort -f -o tags tags". For "Exuberant ctags" version 5.x or higher
7772 (at least 5.5) the --sort=foldcase switch can be used for this as
7773 well. Note that case must be folded to uppercase for this to work.
7774
7775 By default, tag searches are case-sensitive. Case is ignored when
7776 'ignorecase' is set and 'tagcase' is "followic", or when 'tagcase' is
7777 "ignore".
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007778 Also when 'tagcase' is "followscs" and 'smartcase' is set, or
7779 'tagcase' is "smart", and the pattern contains only lowercase
7780 characters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007781
7782 When 'tagbsearch' is off, tags searching is slower when a full match
7783 exists, but faster when no full match exists. Tags in unsorted tags
7784 files may only be found with 'tagbsearch' off.
7785 When the tags file is not sorted, or sorted in a wrong way (not on
7786 ASCII byte value), 'tagbsearch' should be off, or the line given above
7787 must be included in the tags file.
7788 This option doesn't affect commands that find all matching tags (e.g.,
7789 command-line completion and ":help").
Bram Moolenaar071d4272004-06-13 20:20:40 +00007790
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007791 *'tagcase'* *'tc'*
7792'tagcase' 'tc' string (default "followic")
7793 global or local to buffer |global-local|
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007794 This option specifies how case is handled when searching the tags
7795 file:
7796 followic Follow the 'ignorecase' option
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007797 followscs Follow the 'smartcase' and 'ignorecase' options
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007798 ignore Ignore case
7799 match Match case
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007800 smart Ignore case unless an upper case letter is used
Bram Moolenaar036986f2017-03-16 17:41:02 +01007801 NOTE: This option is set to the Vi default value when 'compatible' is
7802 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007803
Bram Moolenaar45e18cb2019-04-28 18:05:35 +02007804 *'tagfunc'* *'tfu'*
7805'tagfunc' 'tfu' string (default: empty)
7806 local to buffer
7807 {not available when compiled without the |+eval|
7808 feature}
7809 This option specifies a function to be used to perform tag searches.
7810 The function gets the tag pattern and should return a List of matching
7811 tags. See |tag-function| for an explanation of how to write the
Yegappan Lakshmanan19916a82021-11-24 16:32:55 +00007812 function and an example. The value can be the name of a function, a
7813 |lambda| or a |Funcref|. See |option-value-function| for more
7814 information.
Bram Moolenaar45e18cb2019-04-28 18:05:35 +02007815
Bram Moolenaar071d4272004-06-13 20:20:40 +00007816 *'taglength'* *'tl'*
7817'taglength' 'tl' number (default 0)
7818 global
7819 If non-zero, tags are significant up to this number of characters.
7820
7821 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
7822'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
7823 global
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00007824 If on and using a tags file in another directory, file names in that
7825 tags file are relative to the directory where the tags file is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007826 NOTE: This option is set to the Vi default value when 'compatible' is
7827 set and to the Vim default value when 'compatible' is reset.
7828
7829 *'tags'* *'tag'* *E433*
7830'tags' 'tag' string (default "./tags,tags", when compiled with
7831 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
7832 global or local to buffer |global-local|
7833 Filenames for the tag command, separated by spaces or commas. To
7834 include a space or comma in a file name, precede it with a backslash
7835 (see |option-backslash| about including spaces and backslashes).
7836 When a file name starts with "./", the '.' is replaced with the path
7837 of the current file. But only when the 'd' flag is not included in
7838 'cpoptions'. Environment variables are expanded |:set_env|. Also see
7839 |tags-option|.
7840 "*", "**" and other wildcards can be used to search for tags files in
Bram Moolenaare2b590e2010-08-08 18:29:48 +02007841 a directory tree. See |file-searching|. E.g., "/lib/**/tags" will
7842 find all files named "tags" below "/lib". The filename itself cannot
7843 contain wildcards, it is used as-is. E.g., "/lib/**/tags?" will find
7844 files called "tags?". {not available when compiled without the
7845 |+path_extra| feature}
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00007846 The |tagfiles()| function can be used to get a list of the file names
7847 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007848 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
7849 files are also supported. They are automatically recognized. The
7850 default value becomes "./tags,./TAGS,tags,TAGS", unless case
7851 differences are ignored (MS-Windows). |emacs-tags|
7852 The use of |:set+=| and |:set-=| is preferred when adding or removing
7853 file names from the list. This avoids problems when a future version
7854 uses another default.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007855
7856 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
7857'tagstack' 'tgst' boolean (default on)
7858 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007859 When on, the |tagstack| is used normally. When off, a ":tag" or
7860 ":tselect" command with an argument will not push the tag onto the
7861 tagstack. A following ":tag" without an argument, a ":pop" command or
7862 any other command that uses the tagstack will use the unmodified
7863 tagstack, but does change the pointer to the active entry.
7864 Resetting this option is useful when using a ":tag" command in a
7865 mapping which should not change the tagstack.
7866
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007867 *'tcldll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01007868'tcldll' string (default depends on the build)
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007869 global
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007870 {only available when compiled with the |+tcl/dyn|
7871 feature}
7872 Specifies the name of the Tcl shared library. The default is
7873 DYNAMIC_TCL_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02007874 Environment variables are expanded |:set_env|.
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007875 This option cannot be set from a |modeline| or in the |sandbox|, for
7876 security reasons.
7877
Bram Moolenaar071d4272004-06-13 20:20:40 +00007878 *'term'* *E529* *E530* *E531*
7879'term' string (default is $TERM, if that fails:
7880 in the GUI: "builtin_gui"
7881 on Amiga: "amiga"
Bram Moolenaarb3f74062020-02-26 16:16:53 +01007882 on Haiku: "xterm"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007883 on Mac: "mac-ansi"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007884 on Unix: "ansi"
7885 on VMS: "ansi"
7886 on Win 32: "win32")
7887 global
7888 Name of the terminal. Used for choosing the terminal control
7889 characters. Environment variables are expanded |:set_env|.
7890 For example: >
7891 :set term=$TERM
7892< See |termcap|.
7893
7894 *'termbidi'* *'tbidi'*
7895 *'notermbidi'* *'notbidi'*
7896'termbidi' 'tbidi' boolean (default off, on for "mlterm")
7897 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007898 {only available when compiled with the |+arabic|
7899 feature}
7900 The terminal is in charge of Bi-directionality of text (as specified
7901 by Unicode). The terminal is also expected to do the required shaping
7902 that some languages (such as Arabic) require.
7903 Setting this option implies that 'rightleft' will not be set when
7904 'arabic' is set and the value of 'arabicshape' will be ignored.
7905 Note that setting 'termbidi' has the immediate effect that
7906 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
7907 This option is reset when the GUI is started.
7908 For further details see |arabic.txt|.
7909
7910 *'termencoding'* *'tenc'*
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02007911'termencoding' 'tenc' string (default ""; with GTK+ GUI: "utf-8")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007912 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007913 Encoding used for the terminal. This specifies what character
7914 encoding the keyboard produces and the display will understand. For
Bram Moolenaar3848e002016-03-19 18:42:29 +01007915 the GUI it only applies to the keyboard ('encoding' is used for the
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02007916 display).
Bram Moolenaar4b7cdca2020-01-01 16:18:38 +01007917 *E617* *E950*
Bram Moolenaar3df01732017-02-17 22:47:16 +01007918 Note: This does not apply to the GTK+ GUI. After the GUI has been
Bram Moolenaar071d4272004-06-13 20:20:40 +00007919 successfully initialized, 'termencoding' is forcibly set to "utf-8".
7920 Any attempts to set a different value will be rejected, and an error
7921 message is shown.
Bram Moolenaarac360bf2015-09-01 20:31:20 +02007922 For the Win32 GUI and console versions 'termencoding' is not used,
Bram Moolenaar071d4272004-06-13 20:20:40 +00007923 because the Win32 system always passes Unicode characters.
7924 When empty, the same encoding is used as for the 'encoding' option.
7925 This is the normal value.
7926 Not all combinations for 'termencoding' and 'encoding' are valid. See
7927 |encoding-table|.
7928 The value for this option must be supported by internal conversions or
7929 iconv(). When this is not possible no conversion will be done and you
7930 will probably experience problems with non-ASCII characters.
7931 Example: You are working with the locale set to euc-jp (Japanese) and
7932 want to edit a UTF-8 file: >
7933 :let &termencoding = &encoding
7934 :set encoding=utf-8
7935< You need to do this when your system has no locale support for UTF-8.
7936
Bram Moolenaarcafafb32018-02-22 21:07:09 +01007937 *'termguicolors'* *'tgc'* *E954*
Bram Moolenaar61be73b2016-04-29 22:59:22 +02007938'termguicolors' 'tgc' boolean (default off)
7939 global
Bram Moolenaar61be73b2016-04-29 22:59:22 +02007940 {not available when compiled without the
7941 |+termguicolors| feature}
7942 When on, uses |highlight-guifg| and |highlight-guibg| attributes in
Bram Moolenaarcafafb32018-02-22 21:07:09 +01007943 the terminal (thus using 24-bit color).
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01007944
Bram Moolenaarcafafb32018-02-22 21:07:09 +01007945 Requires a ISO-8613-3 compatible terminal. If setting this option
7946 does not work (produces a colorless UI) reading |xterm-true-color|
7947 might help.
7948
7949 For Win32 console, Windows 10 version 1703 (Creators Update) or later
7950 is required. Use this check to find out: >
7951 if has('vcon')
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01007952< This requires Vim to be built with the |+vtp| feature.
7953
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +02007954 Note that the "cterm" attributes are still used, not the "gui" ones.
Bram Moolenaar036986f2017-03-16 17:41:02 +01007955 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar61be73b2016-04-29 22:59:22 +02007956
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02007957 *'termwinkey'* *'twk'*
7958'termwinkey' 'twk' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02007959 local to window
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007960 The key that starts a CTRL-W command in a terminal window. Other keys
Bram Moolenaar74675a62017-07-15 13:53:23 +02007961 are sent to the job running in the window.
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007962 The <> notation can be used, e.g.: >
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02007963 :set termwinkey=<C-L>
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007964< The string must be one key stroke but can be multiple bytes.
7965 When not set CTRL-W is used, so that CTRL-W : gets you to the command
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02007966 line. If 'termwinkey' is set to CTRL-L then CTRL-L : gets you to the
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007967 command line.
Bram Moolenaar74675a62017-07-15 13:53:23 +02007968
Bram Moolenaar6c60f472019-04-28 16:00:35 +02007969 *'termwinscroll'* *'twsl'*
7970'termwinscroll' 'twsl' number (default 10000)
7971 local to buffer
7972 {not available when compiled without the
7973 |+terminal| feature}
7974 Number of scrollback lines to keep. When going over this limit the
7975 first 10% of the scrollback lines are deleted. This is just to reduce
7976 the memory usage. See |Terminal-Normal|.
Bram Moolenaar36968af2021-11-15 17:13:11 +00007977 Also used as a limit for text sent to the terminal in one write,
7978 multiplied by the number of columns times 3 (average number of bytes
7979 per cell).
Bram Moolenaar6c60f472019-04-28 16:00:35 +02007980
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02007981 *'termwinsize'* *'tws'*
7982'termwinsize' 'tws' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02007983 local to window
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02007984 Size used when opening the |terminal| window. Format:
7985 {rows}x{columns} or {rows}*{columns}.
Bram Moolenaar74675a62017-07-15 13:53:23 +02007986 - When empty the terminal gets the size from the window.
Bram Moolenaar498c2562018-04-15 23:45:15 +02007987 - When set with a "x" (e.g., "24x80") the terminal size is not
7988 adjusted to the window size. If the window is smaller only the
7989 top-left part is displayed.
7990 - When set with a "*" (e.g., "10*50") the terminal size follows the
7991 window size, but will not be smaller than the specified rows and/or
7992 columns.
7993 - When rows is zero then use the height of the window.
7994 - When columns is zero then use the width of the window.
7995 - Using "0x0" or "0*0" is the same as empty.
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02007996 - Can be overruled in the |term_start()| options with "term_rows" and
7997 "term_cols".
Bram Moolenaar498c2562018-04-15 23:45:15 +02007998
7999 Examples:
8000 "30x0" uses 30 rows and the current window width.
8001 "20*0" uses at least 20 rows and the current window width.
8002 "0*40" uses the current window height and at least 40 columns.
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02008003 Note that the command running in the terminal window may still change
8004 the size of the terminal. In that case the Vim window will be
8005 adjusted to that size, if possible.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008006
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008007 *'termwintype'* *'twt'*
8008'termwintype' 'twt' string (default "")
8009 global
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008010 {only available when compiled with the |terminal|
8011 feature on MS-Windows}
8012 Specify the virtual console (pty) used when opening the terminal
8013 window.
8014
8015 Possible values are:
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01008016 "" use ConPTY if it is stable, winpty otherwise
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008017 "winpty" use winpty, fail if not supported
8018 "conpty" use |ConPTY|, fail if not supported
8019
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01008020 |ConPTY| support depends on the platform. Windows 10 October 2018
8021 Update is the first version that supports ConPTY, however it is still
8022 considered unstable. ConPTY might become stable in the next release
8023 of Windows 10. winpty support needs to be installed. If neither is
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008024 supported then you cannot open a terminal window.
8025
Bram Moolenaar071d4272004-06-13 20:20:40 +00008026 *'terse'* *'noterse'*
8027'terse' boolean (default off)
8028 global
8029 When set: Add 's' flag to 'shortmess' option (this makes the message
8030 for a search that hits the start or end of the file not being
8031 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
8032 shortens a lot of messages}
8033
8034 *'textauto'* *'ta'* *'notextauto'* *'nota'*
8035'textauto' 'ta' boolean (Vim default: on, Vi default: off)
8036 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008037 This option is obsolete. Use 'fileformats'.
8038 For backwards compatibility, when 'textauto' is set, 'fileformats' is
8039 set to the default value for the current system. When 'textauto' is
8040 reset, 'fileformats' is made empty.
8041 NOTE: This option is set to the Vi default value when 'compatible' is
8042 set and to the Vim default value when 'compatible' is reset.
8043
8044 *'textmode'* *'tx'* *'notextmode'* *'notx'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008045'textmode' 'tx' boolean (Win32: default on,
Bram Moolenaar071d4272004-06-13 20:20:40 +00008046 others: default off)
8047 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00008048 This option is obsolete. Use 'fileformat'.
8049 For backwards compatibility, when 'textmode' is set, 'fileformat' is
8050 set to "dos". When 'textmode' is reset, 'fileformat' is set to
8051 "unix".
8052
8053 *'textwidth'* *'tw'*
8054'textwidth' 'tw' number (default 0)
8055 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00008056 Maximum width of text that is being inserted. A longer line will be
8057 broken after white space to get this width. A zero value disables
Bram Moolenaarca635012015-09-25 20:34:21 +02008058 this.
8059 'textwidth' is set to 0 when the 'paste' option is set and restored
8060 when 'paste' is reset.
8061 When 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00008062 'formatoptions' and |ins-textwidth|.
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00008063 When 'formatexpr' is set it will be used to break the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008064 NOTE: This option is set to 0 when 'compatible' is set.
8065
8066 *'thesaurus'* *'tsr'*
8067'thesaurus' 'tsr' string (default "")
8068 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008069 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008070 for thesaurus completion commands |i_CTRL-X_CTRL-T|. See
8071 |compl-thesaurus|.
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01008072
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008073 This option is not used if 'thesaurusfunc' is set, either for the
8074 buffer or globally.
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01008075
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008076 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00008077 after a comma are ignored, otherwise spaces are included in the file
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008078 name. See |option-backslash| about using backslashes. The use of
8079 |:set+=| and |:set-=| is preferred when adding or removing directories
8080 from the list. This avoids problems when a future version uses
8081 another default. Backticks cannot be used in this option for security
8082 reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008083
Yegappan Lakshmanan160e9942021-10-16 15:41:29 +01008084 *'thesaurusfunc'* *tsrfu'*
8085'thesaurusfunc' 'tsrfu' string (default: empty)
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008086 global or local to buffer |global-local|
Yegappan Lakshmanan160e9942021-10-16 15:41:29 +01008087 {not available when compiled without the |+eval|
8088 feature}
8089 This option specifies a function to be used for thesaurus completion
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008090 with CTRL-X CTRL-T. |i_CTRL-X_CTRL-T| See |compl-thesaurusfunc|.
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00008091 The value can be the name of a function, a |lambda| or a |Funcref|.
8092 See |option-value-function| for more information.
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008093
Yegappan Lakshmanan160e9942021-10-16 15:41:29 +01008094 This option cannot be set from a |modeline| or in the |sandbox|, for
8095 security reasons.
8096
Bram Moolenaar071d4272004-06-13 20:20:40 +00008097 *'tildeop'* *'top'* *'notildeop'* *'notop'*
8098'tildeop' 'top' boolean (default off)
8099 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008100 When on: The tilde command "~" behaves like an operator.
8101 NOTE: This option is reset when 'compatible' is set.
8102
8103 *'timeout'* *'to'* *'notimeout'* *'noto'*
8104'timeout' 'to' boolean (default on)
8105 global
8106 *'ttimeout'* *'nottimeout'*
Bram Moolenaar94237492017-04-23 18:40:21 +02008107'ttimeout' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008108 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008109 These two options together determine the behavior when part of a
8110 mapped key sequence or keyboard code has been received:
8111
8112 'timeout' 'ttimeout' action ~
8113 off off do not time out
8114 on on or off time out on :mappings and key codes
8115 off on time out on key codes
8116
8117 If both options are off, Vim will wait until either the complete
8118 mapping or key sequence has been received, or it is clear that there
8119 is no mapping or key sequence for the received characters. For
8120 example: if you have mapped "vl" and Vim has received 'v', the next
8121 character is needed to see if the 'v' is followed by an 'l'.
8122 When one of the options is on, Vim will wait for about 1 second for
8123 the next character to arrive. After that the already received
8124 characters are interpreted as single characters. The waiting time can
8125 be changed with the 'timeoutlen' option.
8126 On slow terminals or very busy systems timing out may cause
8127 malfunctioning cursor keys. If both options are off, Vim waits
8128 forever after an entered <Esc> if there are key codes that start
8129 with <Esc>. You will have to type <Esc> twice. If you do not have
8130 problems with key codes, but would like to have :mapped key
8131 sequences not timing out in 1 second, set the 'ttimeout' option and
8132 reset the 'timeout' option.
8133
8134 NOTE: 'ttimeout' is reset when 'compatible' is set.
8135
8136 *'timeoutlen'* *'tm'*
8137'timeoutlen' 'tm' number (default 1000)
8138 global
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008139
Bram Moolenaar071d4272004-06-13 20:20:40 +00008140 *'ttimeoutlen'* *'ttm'*
Bram Moolenaar94237492017-04-23 18:40:21 +02008141'ttimeoutlen' 'ttm' number (default -1, set to 100 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008142 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008143 The time in milliseconds that is waited for a key code or mapped key
8144 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
8145 when part of a command has been typed.
8146 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
8147 different timeout value for key codes is desired set 'ttimeoutlen' to
8148 a non-negative number.
8149
8150 ttimeoutlen mapping delay key code delay ~
8151 < 0 'timeoutlen' 'timeoutlen'
8152 >= 0 'timeoutlen' 'ttimeoutlen'
8153
8154 The timeout only happens when the 'timeout' and 'ttimeout' options
8155 tell so. A useful setting would be >
8156 :set timeout timeoutlen=3000 ttimeoutlen=100
8157< (time out on mapping after three seconds, time out on key codes after
8158 a tenth of a second).
8159
8160 *'title'* *'notitle'*
8161'title' boolean (default off, on when title can be restored)
8162 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008163 When on, the title of the window will be set to the value of
8164 'titlestring' (if it is not empty), or to:
8165 filename [+=-] (path) - VIM
8166 Where:
8167 filename the name of the file being edited
8168 - indicates the file cannot be modified, 'ma' off
8169 + indicates the file was modified
8170 = indicates the file is read-only
8171 =+ indicates the file is read-only and modified
8172 (path) is the path of the file being edited
8173 - VIM the server name |v:servername| or "VIM"
8174 Only works if the terminal supports setting window titles
8175 (currently Amiga console, Win32 console, all GUI versions and
Bram Moolenaard1caa942020-04-10 22:10:56 +02008176 terminals with a non-empty 't_ts' option - these are Unix xterm and
Bram Moolenaar071d4272004-06-13 20:20:40 +00008177 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
8178 *X11*
8179 When Vim was compiled with HAVE_X11 defined, the original title will
8180 be restored if possible. The output of ":version" will include "+X11"
8181 when HAVE_X11 was defined, otherwise it will be "-X11". This also
8182 works for the icon name |'icon'|.
8183 But: When Vim was started with the |-X| argument, restoring the title
8184 will not work (except in the GUI).
8185 If the title cannot be restored, it is set to the value of 'titleold'.
8186 You might want to restore the title outside of Vim then.
8187 When using an xterm from a remote machine you can use this command:
8188 rsh machine_name xterm -display $DISPLAY &
8189 then the WINDOWID environment variable should be inherited and the
8190 title of the window should change back to what it should be after
8191 exiting Vim.
8192
8193 *'titlelen'*
8194'titlelen' number (default 85)
8195 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008196 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008197 title. When the title is longer, only the end of the path name is
8198 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008199 Using a percentage makes this adapt to the width of the window. But
8200 it won't work perfectly, because the actual number of characters
8201 available also depends on the font used and other things in the title
8202 bar. When 'titlelen' is zero the full path is used. Otherwise,
8203 values from 1 to 30000 percent can be used.
8204 'titlelen' is also used for the 'titlestring' option.
8205
8206 *'titleold'*
8207'titleold' string (default "Thanks for flying Vim")
8208 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008209 This option will be used for the window title when exiting Vim if the
8210 original title cannot be restored. Only happens if 'title' is on or
8211 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00008212 This option cannot be set from a |modeline| or in the |sandbox|, for
8213 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008214 *'titlestring'*
8215'titlestring' string (default "")
8216 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008217 When this option is not empty, it will be used for the title of the
8218 window. This happens only when the 'title' option is on.
8219 Only works if the terminal supports setting window titles (currently
8220 Amiga console, Win32 console, all GUI versions and terminals with a
8221 non-empty 't_ts' option).
8222 When Vim was compiled with HAVE_X11 defined, the original title will
Bram Moolenaar51628222016-12-01 23:03:28 +01008223 be restored if possible, see |X11|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008224
Bram Moolenaar071d4272004-06-13 20:20:40 +00008225 When this option contains printf-style '%' items, they will be
8226 expanded according to the rules used for 'statusline'.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008227 This option cannot be set in a modeline when 'modelineexpr' is off.
8228
Bram Moolenaar071d4272004-06-13 20:20:40 +00008229 Example: >
8230 :auto BufEnter * let &titlestring = hostname() . "/" . expand("%:p")
8231 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
8232< The value of 'titlelen' is used to align items in the middle or right
8233 of the available space.
8234 Some people prefer to have the file name first: >
8235 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
8236< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008237 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00008238 separating space only when needed.
8239 NOTE: Use of special characters in 'titlestring' may cause the display
8240 to be garbled (e.g., when it contains a CR or NL character).
8241 {not available when compiled without the |+statusline| feature}
8242
8243 *'toolbar'* *'tb'*
8244'toolbar' 'tb' string (default "icons,tooltips")
8245 global
8246 {only for |+GUI_GTK|, |+GUI_Athena|, |+GUI_Motif| and
8247 |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008248 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00008249 possible values are:
8250 icons Toolbar buttons are shown with icons.
8251 text Toolbar buttons shown with text.
8252 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008253 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008254 tooltips Tooltips are active for toolbar buttons.
8255 Tooltips refer to the popup help text which appears after the mouse
8256 cursor is placed over a toolbar button for a brief moment.
8257
8258 If you want the toolbar to be shown with icons as well as text, do the
8259 following: >
8260 :set tb=icons,text
8261< Motif and Athena cannot display icons and text at the same time. They
8262 will show icons if both are requested.
8263
8264 If none of the strings specified in 'toolbar' are valid or if
8265 'toolbar' is empty, this option is ignored. If you want to disable
8266 the toolbar, you need to set the 'guioptions' option. For example: >
8267 :set guioptions-=T
8268< Also see |gui-toolbar|.
8269
8270 *'toolbariconsize'* *'tbis'*
8271'toolbariconsize' 'tbis' string (default "small")
8272 global
Bram Moolenaar3df01732017-02-17 22:47:16 +01008273 {only in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008274 Controls the size of toolbar icons. The possible values are:
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008275 tiny Use tiny icons.
8276 small Use small icons (default).
8277 medium Use medium-sized icons.
8278 large Use large icons.
8279 huge Use even larger icons.
8280 giant Use very big icons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008281 The exact dimensions in pixels of the various icon sizes depend on
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008282 the current theme. Common dimensions are giant=48x48, huge=32x32,
8283 large=24x24, medium=24x24, small=20x20 and tiny=16x16.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008284
8285 If 'toolbariconsize' is empty, the global default size as determined
8286 by user preferences or the current theme is used.
8287
8288 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
8289'ttybuiltin' 'tbi' boolean (default on)
8290 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008291 When on, the builtin termcaps are searched before the external ones.
8292 When off the builtin termcaps are searched after the external ones.
8293 When this option is changed, you should set the 'term' option next for
8294 the change to take effect, for example: >
8295 :set notbi term=$TERM
8296< See also |termcap|.
8297 Rationale: The default for this option is "on", because the builtin
8298 termcap entries are generally better (many systems contain faulty
8299 xterm entries...).
8300
8301 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
8302'ttyfast' 'tf' boolean (default off, on when 'term' is xterm, hpterm,
8303 sun-cmd, screen, rxvt, dtterm or
8304 iris-ansi; also on when running Vim in
8305 a DOS console)
8306 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008307 Indicates a fast terminal connection. More characters will be sent to
8308 the screen for redrawing, instead of using insert/delete line
8309 commands. Improves smoothness of redrawing when there are multiple
8310 windows and the terminal does not support a scrolling region.
8311 Also enables the extra writing of characters at the end of each screen
8312 line for lines that wrap. This helps when using copy/paste with the
8313 mouse in an xterm and other terminals.
8314
8315 *'ttymouse'* *'ttym'*
8316'ttymouse' 'ttym' string (default depends on 'term')
8317 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008318 {only in Unix and VMS, doesn't work in the GUI; not
8319 available when compiled without |+mouse|}
8320 Name of the terminal type for which mouse codes are to be recognized.
Bram Moolenaar2c7a7632007-05-10 18:19:11 +00008321 Currently these strings are valid:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008322 *xterm-mouse*
8323 xterm xterm-like mouse handling. The mouse generates
8324 "<Esc>[Mscr", where "scr" is three bytes:
8325 "s" = button state
8326 "c" = column plus 33
8327 "r" = row plus 33
Bram Moolenaare968e362014-05-13 20:23:24 +02008328 This only works up to 223 columns! See "dec",
8329 "urxvt", and "sgr" for solutions.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008330 xterm2 Works like "xterm", but with the xterm reporting the
8331 mouse position while the mouse is dragged. This works
8332 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00008333 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00008334 work. See below for how Vim detects this
8335 automatically.
8336 *netterm-mouse*
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008337 netterm NetTerm mouse handling. A left mouse click generates
Bram Moolenaar071d4272004-06-13 20:20:40 +00008338 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008339 for the row and column. No other mouse events are
8340 supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008341 *dec-mouse*
8342 dec DEC terminal mouse handling. The mouse generates a
8343 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00008344 This is also available for an Xterm, if it was
8345 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00008346 *jsbterm-mouse*
8347 jsbterm JSB term mouse handling.
8348 *pterm-mouse*
8349 pterm QNX pterm mouse handling.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008350 *urxvt-mouse*
8351 urxvt Mouse handling for the urxvt (rxvt-unicode) terminal.
Bram Moolenaare968e362014-05-13 20:23:24 +02008352 The mouse works only if the terminal supports this
8353 encoding style, but it does not have 223 columns limit
8354 unlike "xterm" or "xterm2".
Bram Moolenaar9b451252012-08-15 17:43:31 +02008355 *sgr-mouse*
8356 sgr Mouse handling for the terminal that emits SGR-styled
Bram Moolenaare968e362014-05-13 20:23:24 +02008357 mouse reporting. The mouse works even in columns
8358 beyond 223. This option is backward compatible with
8359 "xterm2" because it can also decode "xterm2" style
8360 mouse codes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008361
8362 The mouse handling must be enabled at compile time |+mouse_xterm|
Bram Moolenaare968e362014-05-13 20:23:24 +02008363 |+mouse_dec| |+mouse_netterm| |+mouse_jsbterm| |+mouse_urxvt|
8364 |+mouse_sgr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008365 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
8366 recognized, if enabled at compile time. DEC terminal mouse codes
8367 are recognized if enabled at compile time, and 'ttymouse' is not
Bram Moolenaare968e362014-05-13 20:23:24 +02008368 "xterm", "xterm2", "urxvt" or "sgr" (because dec mouse codes conflict
8369 with them).
Bram Moolenaar071d4272004-06-13 20:20:40 +00008370 This option is automatically set to "xterm", when the 'term' option is
Bram Moolenaar45758762016-10-12 23:08:06 +02008371 set to a name that starts with "xterm", "mlterm", "screen", "tmux",
8372 "st" (full match only), "st-" or "stterm", and 'ttymouse' is not set
8373 already.
Bram Moolenaare968e362014-05-13 20:23:24 +02008374 Additionally, if vim is compiled with the |+termresponse| feature and
8375 |t_RV| is set to the escape sequence to request the xterm version
Bram Moolenaarf8a07122019-07-01 22:06:07 +02008376 number, more intelligent detection is done.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008377 The "xterm2" value will be set if the xterm version is reported to be
Bram Moolenaard47d5222018-12-09 20:43:55 +01008378 from 95 to 276. The "sgr" value will be set if Vim detects Mac
8379 Terminal.app, iTerm2 or mintty, and when the xterm version is 277 or
8380 higher.
Bram Moolenaare968e362014-05-13 20:23:24 +02008381 If you do not want 'ttymouse' to be set to "xterm2" or "sgr"
8382 automatically, set t_RV to an empty string: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008383 :set t_RV=
8384<
8385 *'ttyscroll'* *'tsl'*
8386'ttyscroll' 'tsl' number (default 999)
8387 global
8388 Maximum number of lines to scroll the screen. If there are more lines
8389 to scroll the window is redrawn. For terminals where scrolling is
8390 very slow and redrawing is not slow this can be set to a small number,
8391 e.g., 3, to speed up displaying.
8392
8393 *'ttytype'* *'tty'*
8394'ttytype' 'tty' string (default from $TERM)
8395 global
8396 Alias for 'term', see above.
8397
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008398 *'undodir'* *'udir'*
8399'undodir' 'udir' string (default ".")
8400 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008401 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008402 List of directory names for undo files, separated with commas.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008403 See |'backupdir'| for details of the format.
Bram Moolenaar6a244fe2010-05-24 22:02:24 +02008404 "." means using the directory of the file. The undo file name for
8405 "file.txt" is ".file.txt.un~".
8406 For other directories the file name is the full path of the edited
8407 file, with path separators replaced with "%".
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008408 When writing: The first directory that exists is used. "." always
8409 works, no directories after "." will be used for writing.
8410 When reading all entries are tried to find an undo file. The first
8411 undo file that exists is used. When it cannot be read an error is
8412 given, no further entry is used.
8413 See |undo-persistence|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008414 This option cannot be set from a |modeline| or in the |sandbox|, for
8415 security reasons.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008416
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02008417 *'undofile'* *'noundofile'* *'udf'* *'noudf'*
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008418'undofile' 'udf' boolean (default off)
8419 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02008420 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008421 When on, Vim automatically saves undo history to an undo file when
8422 writing a buffer to a file, and restores undo history from the same
8423 file on buffer read.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008424 The directory where the undo file is stored is specified by 'undodir'.
8425 For more information about this feature see |undo-persistence|.
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008426 The undo file is not read when 'undoreload' causes the buffer from
8427 before a reload to be saved for undo.
Bram Moolenaar97d62492012-11-15 21:28:22 +01008428 When 'undofile' is turned off the undo file is NOT deleted.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008429 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008430
Bram Moolenaar071d4272004-06-13 20:20:40 +00008431 *'undolevels'* *'ul'*
Bram Moolenaar8024f932020-01-14 19:29:13 +01008432'undolevels' 'ul' number (default 100, 1000 for Unix, VMS and Win32)
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008433 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008434 Maximum number of changes that can be undone. Since undo information
Bram Moolenaar5be4cee2019-09-27 19:34:08 +02008435 is kept in memory, higher numbers will cause more memory to be used.
8436 Nevertheless, a single change can already use a large amount of memory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008437 Set to 0 for Vi compatibility: One level of undo and "u" undoes
8438 itself: >
8439 set ul=0
8440< But you can also get Vi compatibility by including the 'u' flag in
8441 'cpoptions', and still be able to use CTRL-R to repeat undo.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008442 Also see |undo-two-ways|.
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008443 Set to -1 for no undo at all. You might want to do this only for the
8444 current buffer: >
8445 setlocal ul=-1
Bram Moolenaar071d4272004-06-13 20:20:40 +00008446< This helps when you run out of memory for a single change.
Bram Moolenaar32efaf62014-11-05 17:02:17 +01008447
8448 The local value is set to -123456 when the global value is to be used.
8449
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008450 Also see |clear-undo|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008451
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008452 *'undoreload'* *'ur'*
8453'undoreload' 'ur' number (default 10000)
8454 global
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008455 Save the whole buffer for undo when reloading it. This applies to the
8456 ":e!" command and reloading for when the buffer changed outside of
8457 Vim. |FileChangedShell|
Bram Moolenaar24a98a02017-09-27 22:23:55 +02008458 The save only happens when this option is negative or when the number
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008459 of lines is smaller than the value of this option.
8460 Set this option to zero to disable undo for a reload.
8461
8462 When saving undo for a reload, any undo file is not read.
8463
8464 Note that this causes the whole buffer to be stored in memory. Set
8465 this option to a lower value if you run out of memory.
8466
Bram Moolenaar071d4272004-06-13 20:20:40 +00008467 *'updatecount'* *'uc'*
8468'updatecount' 'uc' number (default: 200)
8469 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008470 After typing this many characters the swap file will be written to
8471 disk. When zero, no swap file will be created at all (see chapter on
8472 recovery |crash-recovery|). 'updatecount' is set to zero by starting
8473 Vim with the "-n" option, see |startup|. When editing in readonly
8474 mode this option will be initialized to 10000.
8475 The swapfile can be disabled per buffer with |'swapfile'|.
8476 When 'updatecount' is set from zero to non-zero, swap files are
8477 created for all buffers that have 'swapfile' set. When 'updatecount'
8478 is set to zero, existing swap files are not deleted.
8479 Also see |'swapsync'|.
8480 This option has no meaning in buffers where |'buftype'| is "nofile"
8481 or "nowrite".
8482
8483 *'updatetime'* *'ut'*
8484'updatetime' 'ut' number (default 4000)
8485 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008486 If this many milliseconds nothing is typed the swap file will be
8487 written to disk (see |crash-recovery|). Also used for the
8488 |CursorHold| autocommand event.
8489
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008490 *'varsofttabstop'* *'vsts'*
8491'varsofttabstop' 'vsts' string (default "")
8492 local to buffer
8493 {only available when compiled with the |+vartabs|
8494 feature}
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008495 A list of the number of spaces that a <Tab> counts for while editing,
8496 such as inserting a <Tab> or using <BS>. It "feels" like variable-
8497 width <Tab>s are being inserted, while in fact a mixture of spaces
8498 and <Tab>s is used. Tab widths are separated with commas, with the
8499 final value applying to all subsequent tabs.
8500
8501 For example, when editing assembly language files where statements
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02008502 start in the 9th column and comments in the 41st, it may be useful
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008503 to use the following: >
8504 :set varsofttabstop=8,32,8
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02008505< This will set soft tabstops with 8 and 8 + 32 spaces, and 8 more
8506 for every column thereafter.
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008507
8508 Note that the value of |'softtabstop'| will be ignored while
8509 'varsofttabstop' is set.
8510
8511 *'vartabstop'* *'vts'*
8512'vartabstop' 'vts' string (default "")
8513 local to buffer
8514 {only available when compiled with the |+vartabs|
8515 feature}
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008516 A list of the number of spaces that a <Tab> in the file counts for,
8517 separated by commas. Each value corresponds to one tab, with the
8518 final value applying to all subsequent tabs. For example: >
8519 :set vartabstop=4,20,10,8
8520< This will make the first tab 4 spaces wide, the second 20 spaces,
8521 the third 10 spaces, and all following tabs 8 spaces.
8522
8523 Note that the value of |'tabstop'| will be ignored while 'vartabstop'
8524 is set.
8525
Bram Moolenaar071d4272004-06-13 20:20:40 +00008526 *'verbose'* *'vbs'*
8527'verbose' 'vbs' number (default 0)
8528 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008529 When bigger than zero, Vim will give messages about what it is doing.
8530 Currently, these messages are given:
8531 >= 1 When the viminfo file is read or written.
8532 >= 2 When a file is ":source"'ed.
Bram Moolenaar647a5302020-05-03 17:01:24 +02008533 >= 4 Shell commands.
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008534 >= 5 Every searched tags file and include file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008535 >= 8 Files for which a group of autocommands is executed.
8536 >= 9 Every executed autocommand.
Bram Moolenaar647a5302020-05-03 17:01:24 +02008537 >= 11 Finding items in a path
Bram Moolenaar071d4272004-06-13 20:20:40 +00008538 >= 12 Every executed function.
8539 >= 13 When an exception is thrown, caught, finished, or discarded.
8540 >= 14 Anything pending in a ":finally" clause.
Bram Moolenaar823654b2020-05-29 23:03:09 +02008541 >= 15 Every executed Ex command from a script (truncated at 200
8542 characters).
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02008543 >= 16 Every executed Ex command.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008544
8545 This option can also be set with the "-V" argument. See |-V|.
8546 This option is also set by the |:verbose| command.
8547
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008548 When the 'verbosefile' option is set then the verbose messages are not
8549 displayed.
8550
8551 *'verbosefile'* *'vfile'*
8552'verbosefile' 'vfile' string (default empty)
8553 global
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008554 When not empty all messages are written in a file with this name.
8555 When the file exists messages are appended.
8556 Writing to the file ends when Vim exits or when 'verbosefile' is made
Bram Moolenaar80794b12010-06-13 05:20:42 +02008557 empty. Writes are buffered, thus may not show up for some time.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008558 Setting 'verbosefile' to a new value is like making it empty first.
8559 The difference with |:redir| is that verbose messages are not
8560 displayed when 'verbosefile' is set.
8561
Bram Moolenaar071d4272004-06-13 20:20:40 +00008562 *'viewdir'* *'vdir'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008563'viewdir' 'vdir' string (default for Amiga and Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008564 "$VIM/vimfiles/view",
8565 for Unix: "~/.vim/view",
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02008566 for macOS: "$VIM:vimfiles:view"
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01008567 for VMS: "sys$login:vimfiles/view")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008568 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008569 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008570 feature}
8571 Name of the directory where to store files for |:mkview|.
8572 This option cannot be set from a |modeline| or in the |sandbox|, for
8573 security reasons.
8574
8575 *'viewoptions'* *'vop'*
Bram Moolenaar13e90412017-11-11 18:16:48 +01008576'viewoptions' 'vop' string (default: "folds,options,cursor,curdir")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008577 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008578 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008579 feature}
8580 Changes the effect of the |:mkview| command. It is a comma separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008581 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008582 word save and restore ~
8583 cursor cursor position in file and in window
8584 folds manually created folds, opened/closed folds and local
8585 fold options
8586 options options and mappings local to a window or buffer (not
8587 global values for local options)
Bram Moolenaar6e932462014-09-09 18:48:09 +02008588 localoptions same as "options"
Bram Moolenaar071d4272004-06-13 20:20:40 +00008589 slash backslashes in file names replaced with forward
8590 slashes
8591 unix with Unix end-of-line format (single <NL>), even when
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008592 on MS-Windows
Bram Moolenaar13e90412017-11-11 18:16:48 +01008593 curdir the window-local directory, if set with `:lcd`
Bram Moolenaar071d4272004-06-13 20:20:40 +00008594
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008595 "slash" and "unix" are useful on MS-Windows when sharing view files
Bram Moolenaar071d4272004-06-13 20:20:40 +00008596 with Unix. The Unix version of Vim cannot source dos format scripts,
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008597 but the MS-Windows version of Vim can source unix format scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008598
8599 *'viminfo'* *'vi'* *E526* *E527* *E528*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008600'viminfo' 'vi' string (Vi default: "", Vim default for
8601 MS-Windows: '100,<50,s10,h,rA:,rB:,
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01008602 for Amiga: '100,<50,s10,h,rdf0:,rdf1:,rdf2:
8603 for others: '100,<50,s10,h)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008604 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008605 {not available when compiled without the |+viminfo|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008606 feature}
8607 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008608 when exiting Vim (see |viminfo-file|). Except when 'viminfofile' is
8609 "NONE".
8610 The string should be a comma separated list of parameters, each
8611 consisting of a single character identifying the particular parameter,
8612 followed by a number or string which specifies the value of that
8613 parameter. If a particular character is left out, then the default
8614 value is used for that parameter. The following is a list of the
8615 identifying characters and the effect of their value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008616 CHAR VALUE ~
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008617 *viminfo-!*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008618 ! When included, save and restore global variables that start
8619 with an uppercase letter, and don't contain a lowercase
8620 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar680eeca2010-10-20 17:44:42 +02008621 and "_K_L_M" are not. Nested List and Dict items may not be
Bram Moolenaar166af9b2010-11-16 20:34:40 +01008622 read back correctly, you end up with an empty item.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008623 *viminfo-quote*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008624 " Maximum number of lines saved for each register. Old name of
8625 the '<' item, with the disadvantage that you need to put a
8626 backslash before the ", otherwise it will be recognized as the
8627 start of a comment!
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008628 *viminfo-%*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008629 % When included, save and restore the buffer list. If Vim is
8630 started with a file name argument, the buffer list is not
8631 restored. If Vim is started without a file name argument, the
Bram Moolenaard042dc82015-11-24 19:18:36 +01008632 buffer list is restored from the viminfo file. Quickfix
8633 ('buftype'), unlisted ('buflisted'), unnamed and buffers on
8634 removable media (|viminfo-r|) are not saved.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00008635 When followed by a number, the number specifies the maximum
8636 number of buffers that are stored. Without a number all
8637 buffers are stored.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008638 *viminfo-'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008639 ' Maximum number of previously edited files for which the marks
8640 are remembered. This parameter must always be included when
8641 'viminfo' is non-empty.
8642 Including this item also means that the |jumplist| and the
8643 |changelist| are stored in the viminfo file.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008644 *viminfo-/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008645 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008646 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00008647 patterns are also saved. When not included, the value of
8648 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008649 *viminfo-:*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008650 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008651 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008652 *viminfo-<*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008653 < Maximum number of lines saved for each register. If zero then
8654 registers are not saved. When not included, all lines are
8655 saved. '"' is the old name for this item.
8656 Also see the 's' item below: limit specified in Kbyte.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008657 *viminfo-@*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008658 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008659 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008660 *viminfo-c*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008661 c When included, convert the text in the viminfo file from the
8662 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00008663 'encoding'. See |viminfo-encoding|.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008664 *viminfo-f*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008665 f Whether file marks need to be stored. If zero, file marks ('0
8666 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008667 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00008668 cursor position (when exiting or when doing ":wviminfo").
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008669 *viminfo-h*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008670 h Disable the effect of 'hlsearch' when loading the viminfo
8671 file. When not included, it depends on whether ":nohlsearch"
8672 has been used since the last search command.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008673 *viminfo-n*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008674 n Name of the viminfo file. The name must immediately follow
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008675 the 'n'. Must be at the end of the option! If the
8676 'viminfofile' option is set, that file name overrides the one
8677 given here with 'viminfo'. Environment variables are
Bram Moolenaar063b9d12016-07-09 20:21:48 +02008678 expanded when opening the file, not when setting the option.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008679 *viminfo-r*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008680 r Removable media. The argument is a string (up to the next
8681 ','). This parameter can be given several times. Each
8682 specifies the start of a path for which no marks will be
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01008683 stored. This is to avoid removable media. For MS-Windows you
Bram Moolenaar071d4272004-06-13 20:20:40 +00008684 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
8685 also use it for temp files, e.g., for Unix: "r/tmp". Case is
8686 ignored. Maximum length of each 'r' argument is 50
8687 characters.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008688 *viminfo-s*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008689 s Maximum size of an item in Kbyte. If zero then registers are
8690 not saved. Currently only applies to registers. The default
8691 "s10" will exclude registers with more than 10 Kbyte of text.
8692 Also see the '<' item above: line count limit.
8693
8694 Example: >
8695 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
8696<
8697 '50 Marks will be remembered for the last 50 files you
8698 edited.
8699 <1000 Contents of registers (up to 1000 lines each) will be
8700 remembered.
8701 s100 Registers with more than 100 Kbyte text are skipped.
8702 :0 Command-line history will not be saved.
8703 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
8704 no / Since '/' is not specified, the default will be used,
8705 that is, save all of the search history, and also the
8706 previous search and substitute patterns.
8707 no % The buffer list will not be saved nor read back.
8708 no h 'hlsearch' highlighting will be restored.
8709
8710 When setting 'viminfo' from an empty value you can use |:rviminfo| to
8711 load the contents of the file, this is not done automatically.
8712
8713 This option cannot be set from a |modeline| or in the |sandbox|, for
8714 security reasons.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008715 NOTE: This option is set to the Vim default value when 'compatible'
8716 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008717
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008718 *'viminfofile'* *'vif'*
8719'viminfofile' 'vif' string (default: "")
8720 global
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008721 {not available when compiled without the |+viminfo|
8722 feature}
8723 When non-empty, overrides the file name used for viminfo.
8724 When equal to "NONE" no viminfo file will be read or written.
8725 This option can be set with the |-i| command line flag. The |--clean|
8726 command line flag sets it to "NONE".
Bram Moolenaar110289e2019-05-23 15:38:06 +02008727 This option cannot be set from a |modeline| or in the |sandbox|, for
8728 security reasons.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008729
Bram Moolenaar071d4272004-06-13 20:20:40 +00008730 *'virtualedit'* *'ve'*
8731'virtualedit' 've' string (default "")
Gary Johnson51ad8502021-08-03 18:33:08 +02008732 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008733 A comma separated list of these words:
8734 block Allow virtual editing in Visual block mode.
8735 insert Allow virtual editing in Insert mode.
8736 all Allow virtual editing in all modes.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008737 onemore Allow the cursor to move just past the end of the line
Gary Johnson53ba05b2021-07-26 22:19:10 +02008738 none When used as the local value, do not allow virtual
8739 editing even when the global value is set. When used
8740 as the global value, "none" is the same as "".
8741 NONE Alternative spelling of "none".
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008742
Bram Moolenaar071d4272004-06-13 20:20:40 +00008743 Virtual editing means that the cursor can be positioned where there is
Bram Moolenaarebcbd022007-05-12 14:28:25 +00008744 no actual character. This can be halfway into a tab or beyond the end
Bram Moolenaar071d4272004-06-13 20:20:40 +00008745 of the line. Useful for selecting a rectangle in Visual mode and
8746 editing a table.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008747 "onemore" is not the same, it will only allow moving the cursor just
8748 after the last character of the line. This makes some commands more
8749 consistent. Previously the cursor was always past the end of the line
8750 if the line was empty. But it is far from Vi compatible. It may also
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008751 break some plugins or Vim scripts. For example because |l| can move
8752 the cursor after the last character. Use with care!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02008753 Using the `$` command will move to the last character in the line, not
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008754 past it. This may actually move the cursor to the left!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02008755 The `g$` command will move to the end of the screen line.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008756 It doesn't make sense to combine "all" with "onemore", but you will
8757 not get a warning for it.
Bram Moolenaar53f7fcc2021-07-28 20:10:16 +02008758 When combined with other words, "none" is ignored.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008759 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008760
8761 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
8762'visualbell' 'vb' boolean (default off)
8763 global
Bram Moolenaar74675a62017-07-15 13:53:23 +02008764 Use a visual bell instead of beeping. The terminal code to display the
Bram Moolenaar071d4272004-06-13 20:20:40 +00008765 visual bell is given with 't_vb'. When no beep or flash is wanted,
Bram Moolenaar74675a62017-07-15 13:53:23 +02008766 use: >
8767 :set vb t_vb=
8768< If you want a short flash, you can use this on many terminals: >
8769 :set vb t_vb=[?5h$<100>[?5l
8770< Here $<100> specifies the time, you can use a smaller or bigger value
8771 to get a shorter or longer flash.
8772
8773 Note: Vim will limit the bell to once per half a second. This avoids
8774 having to wait for the flashing to finish when there are lots of
8775 bells, e.g. on key repeat. This also happens without 'visualbell'
8776 set.
8777
Bram Moolenaar071d4272004-06-13 20:20:40 +00008778 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
8779 for 20 msec. If you want to use a different time, use "<Esc>|40f",
8780 where 40 is the time in msec.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008781
8782 Note: When the GUI starts, 't_vb' is reset to its default value. You
8783 might want to set it again in your |gvimrc|.
8784
Bram Moolenaar071d4272004-06-13 20:20:40 +00008785 Does not work on the Amiga, you always get a screen flash.
8786 Also see 'errorbells'.
8787
8788 *'warn'* *'nowarn'*
8789'warn' boolean (default on)
8790 global
8791 Give a warning message when a shell command is used while the buffer
8792 has been changed.
8793
8794 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
8795'weirdinvert' 'wiv' boolean (default off)
8796 global
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00008797 This option has the same effect as the 't_xs' terminal option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008798 It is provided for backwards compatibility with version 4.x.
8799 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
8800 vice versa. Has no effect when the GUI is running.
8801
8802 *'whichwrap'* *'ww'*
8803'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
8804 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008805 Allow specified keys that move the cursor left/right to move to the
8806 previous/next line when the cursor is on the first/last character in
8807 the line. Concatenate characters to allow this for these keys:
8808 char key mode ~
8809 b <BS> Normal and Visual
8810 s <Space> Normal and Visual
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008811 h "h" Normal and Visual (not recommended)
8812 l "l" Normal and Visual (not recommended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008813 < <Left> Normal and Visual
8814 > <Right> Normal and Visual
8815 ~ "~" Normal
8816 [ <Left> Insert and Replace
8817 ] <Right> Insert and Replace
8818 For example: >
8819 :set ww=<,>,[,]
8820< allows wrap only when cursor keys are used.
8821 When the movement keys are used in combination with a delete or change
8822 operator, the <EOL> also counts for a character. This makes "3h"
8823 different from "3dh" when the cursor crosses the end of a line. This
8824 is also true for "x" and "X", because they do the same as "dl" and
8825 "dh". If you use this, you may also want to use the mapping
8826 ":map <BS> X" to make backspace delete the character in front of the
8827 cursor.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00008828 When 'l' is included and it is used after an operator at the end of a
Bram Moolenaar589edb32019-09-20 14:38:13 +02008829 line (not an empty line) then it will not move to the next line. This
8830 makes "dl", "cl", "yl" etc. work normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008831 NOTE: This option is set to the Vi default value when 'compatible' is
8832 set and to the Vim default value when 'compatible' is reset.
8833
8834 *'wildchar'* *'wc'*
8835'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
8836 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008837 Character you have to type to start wildcard expansion in the
8838 command-line, as specified with 'wildmode'.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008839 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008840 The character is not recognized when used inside a macro. See
8841 'wildcharm' for that.
Bram Moolenaar34cc7d82021-09-21 20:09:51 +02008842 Some keys will not work, such as CTRL-C, <CR> and Enter.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008843 Although 'wc' is a number option, you can set it to a special key: >
Bram Moolenaar34cc7d82021-09-21 20:09:51 +02008844 :set wc=<Tab>
Bram Moolenaar071d4272004-06-13 20:20:40 +00008845< NOTE: This option is set to the Vi default value when 'compatible' is
8846 set and to the Vim default value when 'compatible' is reset.
8847
8848 *'wildcharm'* *'wcm'*
8849'wildcharm' 'wcm' number (default: none (0))
8850 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008851 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00008852 recognized when used inside a macro. You can find "spare" command-line
8853 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00008854 you'll never actually type 'wildcharm', just use it in mappings that
8855 automatically invoke completion mode, e.g.: >
8856 :set wcm=<C-Z>
Bram Moolenaar446cb832008-06-24 21:56:24 +00008857 :cnoremap ss so $vim/sessions/*.vim<C-Z>
Bram Moolenaar071d4272004-06-13 20:20:40 +00008858< Then after typing :ss you can use CTRL-P & CTRL-N.
8859
8860 *'wildignore'* *'wig'*
8861'wildignore' 'wig' string (default "")
8862 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008863 {not available when compiled without the |+wildignore|
8864 feature}
8865 A list of file patterns. A file that matches with one of these
Bram Moolenaar30b65812012-07-12 22:01:11 +02008866 patterns is ignored when expanding |wildcards|, completing file or
8867 directory names, and influences the result of |expand()|, |glob()| and
8868 |globpath()| unless a flag is passed to disable this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008869 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
8870 Also see 'suffixes'.
8871 Example: >
8872 :set wildignore=*.o,*.obj
8873< The use of |:set+=| and |:set-=| is preferred when adding or removing
8874 a pattern from the list. This avoids problems when a future version
8875 uses another default.
8876
Bram Moolenaar94950a92010-12-02 16:01:29 +01008877
Bram Moolenaar81af9252010-12-10 20:35:50 +01008878 *'wildignorecase'* *'wic'* *'nowildignorecase'* *'nowic'*
Bram Moolenaar94950a92010-12-02 16:01:29 +01008879'wildignorecase' 'wic' boolean (default off)
8880 global
Bram Moolenaar94950a92010-12-02 16:01:29 +01008881 When set case is ignored when completing file names and directories.
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01008882 Has no effect when 'fileignorecase' is set.
Bram Moolenaar94950a92010-12-02 16:01:29 +01008883 Does not apply when the shell is used to expand wildcards, which
8884 happens when there are special characters.
8885
8886
Bram Moolenaar071d4272004-06-13 20:20:40 +00008887 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02008888'wildmenu' 'wmnu' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008889 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008890 {not available if compiled without the |+wildmenu|
8891 feature}
8892 When 'wildmenu' is on, command-line completion operates in an enhanced
8893 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
8894 the possible matches are shown just above the command line, with the
8895 first match highlighted (overwriting the status line, if there is
8896 one). Keys that show the previous/next match, such as <Tab> or
8897 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
8898 When 'wildmode' is used, "wildmenu" mode is used where "full" is
8899 specified. "longest" and "list" do not start "wildmenu" mode.
Bram Moolenaar26402cb2013-02-20 21:26:00 +01008900 You can check the current mode with |wildmenumode()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008901 If there are more matches than can fit in the line, a ">" is shown on
8902 the right and/or a "<" is shown on the left. The status line scrolls
8903 as needed.
8904 The "wildmenu" mode is abandoned when a key is hit that is not used
8905 for selecting a completion.
8906 While the "wildmenu" is active the following keys have special
8907 meanings:
8908
8909 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
8910 <Down> - in filename/menu name completion: move into a
8911 subdirectory or submenu.
8912 <CR> - in menu completion, when the cursor is just after a
8913 dot: move into a submenu.
8914 <Up> - in filename/menu name completion: move up into
8915 parent directory or parent menu.
8916
8917 This makes the menus accessible from the console |console-menus|.
8918
8919 If you prefer the <Left> and <Right> keys to move the cursor instead
8920 of selecting a different match, use this: >
8921 :cnoremap <Left> <Space><BS><Left>
8922 :cnoremap <Right> <Space><BS><Right>
8923<
8924 The "WildMenu" highlighting is used for displaying the current match
8925 |hl-WildMenu|.
8926
8927 *'wildmode'* *'wim'*
8928'wildmode' 'wim' string (Vim default: "full")
8929 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008930 Completion mode that is used for the character specified with
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008931 'wildchar'. It is a comma separated list of up to four parts. Each
Bram Moolenaar02467872007-05-06 13:22:01 +00008932 part specifies what to do for each consecutive use of 'wildchar'. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00008933 first part specifies the behavior for the first use of 'wildchar',
8934 The second part for the second use, etc.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02008935
8936 Each part consists of a colon separated list consisting of the
8937 following possible values:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008938 "" Complete only the first match.
8939 "full" Complete the next full match. After the last match,
8940 the original string is used and then the first match
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02008941 again. Will also start 'wildmenu' if it is enabled.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008942 "longest" Complete till longest common string. If this doesn't
8943 result in a longer string, use the next part.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008944 "list" When more than one match, list all matches.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02008945 "lastused" When completing buffer names and more than one buffer
8946 matches, sort buffers by time last used (other than
8947 the current buffer).
8948 When there is only a single match, it is fully completed in all cases.
8949
8950 Examples of useful colon-separated values:
8951 "longest:full" Like "longest", but also start 'wildmenu' if it is
8952 enabled. Will not complete to the next full match.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008953 "list:full" When more than one match, list all matches and
8954 complete first match.
8955 "list:longest" When more than one match, list all matches and
8956 complete till longest common string.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02008957 "list:lastused" When more than one buffer matches, list all matches
8958 and sort buffers by time last used (other than the
8959 current buffer).
Bram Moolenaar071d4272004-06-13 20:20:40 +00008960
8961 Examples: >
8962 :set wildmode=full
Bram Moolenaar582fd852005-03-28 20:58:01 +00008963< Complete first full match, next match, etc. (the default) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008964 :set wildmode=longest,full
8965< Complete longest common string, then each full match >
8966 :set wildmode=list:full
8967< List all matches and complete each full match >
8968 :set wildmode=list,full
8969< List all matches without completing, then each full match >
8970 :set wildmode=longest,list
8971< Complete longest common string, then list alternatives.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008972 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008973
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00008974 *'wildoptions'* *'wop'*
8975'wildoptions' 'wop' string (default "")
8976 global
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00008977 {not available when compiled without the |+wildignore|
8978 feature}
8979 A list of words that change how command line completion is done.
8980 Currently only one word is allowed:
8981 tagfile When using CTRL-D to list matching tags, the kind of
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00008982 tag and the file of the tag is listed. Only one match
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00008983 is displayed per line. Often used tag kinds are:
8984 d #define
8985 f function
8986 Also see |cmdline-completion|.
8987
Bram Moolenaar071d4272004-06-13 20:20:40 +00008988 *'winaltkeys'* *'wak'*
8989'winaltkeys' 'wak' string (default "menu")
8990 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008991 {only used in Win32, Motif, GTK and Photon GUI}
8992 Some GUI versions allow the access to menu entries by using the ALT
8993 key in combination with a character that appears underlined in the
8994 menu. This conflicts with the use of the ALT key for mappings and
8995 entering special characters. This option tells what to do:
8996 no Don't use ALT keys for menus. ALT key combinations can be
8997 mapped, but there is no automatic handling. This can then be
8998 done with the |:simalt| command.
8999 yes ALT key handling is done by the windowing system. ALT key
9000 combinations cannot be mapped.
9001 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009002 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00009003 keys can be mapped.
9004 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
9005 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00009006 This option is not used for <F10>; on Win32 and with GTK <F10> will
9007 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009008
Bram Moolenaar4d784b22019-05-25 19:51:39 +02009009 *'wincolor'* *'wcr'*
9010'wincolor' 'wcr' string (default empty)
9011 local to window
9012 Highlight group name to use for this window instead of the Normal
9013 color |hl-Normal|.
9014
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009015 *'window'* *'wi'*
9016'window' 'wi' number (default screen height - 1)
9017 global
Bram Moolenaardad44732021-03-31 20:07:33 +02009018 Window height used for |CTRL-F| and |CTRL-B| when there is only one
9019 window and the value is smaller than 'lines' minus one. The screen
9020 will scroll 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009021 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
9022 in a much smarter way, taking care of wrapping lines.
9023 When resizing the Vim window, the value is smaller than 1 or more than
9024 or equal to 'lines' it will be set to 'lines' minus 1.
Bram Moolenaardad44732021-03-31 20:07:33 +02009025 Note: Do not confuse this with the height of the Vim window, use
9026 'lines' for that.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009027
Bram Moolenaar071d4272004-06-13 20:20:40 +00009028 *'winheight'* *'wh'* *E591*
9029'winheight' 'wh' number (default 1)
9030 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009031 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009032 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar446cb832008-06-24 21:56:24 +00009033 focus goes to a window that is smaller, its size is increased, at the
9034 cost of the height of other windows.
9035 Set 'winheight' to a small number for normal editing.
9036 Set it to 999 to make the current window fill most of the screen.
9037 Other windows will be only 'winminheight' high. This has the drawback
9038 that ":all" will create only two windows. To avoid "vim -o 1 2 3 4"
9039 to create only two windows, set the option after startup is done,
9040 using the |VimEnter| event: >
9041 au VimEnter * set winheight=999
9042< Minimum value is 1.
9043 The height is not adjusted after one of the commands that change the
Bram Moolenaar071d4272004-06-13 20:20:40 +00009044 height of the current window.
9045 'winheight' applies to the current window. Use 'winminheight' to set
9046 the minimal height for other windows.
9047
9048 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
9049'winfixheight' 'wfh' boolean (default off)
9050 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00009051 Keep the window height when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00009052 'equalalways' is set. Also for |CTRL-W_=|. Set by default for the
9053 |preview-window| and |quickfix-window|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009054 The height may be changed anyway when running out of room.
9055
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009056 *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'*
9057'winfixwidth' 'wfw' boolean (default off)
9058 local to window
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009059 Keep the window width when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00009060 'equalalways' is set. Also for |CTRL-W_=|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009061 The width may be changed anyway when running out of room.
9062
Bram Moolenaar071d4272004-06-13 20:20:40 +00009063 *'winminheight'* *'wmh'*
9064'winminheight' 'wmh' number (default 1)
9065 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009066 The minimal height of a window, when it's not the current window.
9067 This is a hard minimum, windows will never become smaller.
9068 When set to zero, windows may be "squashed" to zero lines (i.e. just a
9069 status bar) if necessary. They will return to at least one line when
9070 they become active (since the cursor has to have somewhere to go.)
9071 Use 'winheight' to set the minimal height of the current window.
9072 This option is only checked when making a window smaller. Don't use a
9073 large number, it will cause errors when opening more than a few
9074 windows. A value of 0 to 3 is reasonable.
9075
9076 *'winminwidth'* *'wmw'*
9077'winminwidth' 'wmw' number (default 1)
9078 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009079 The minimal width of a window, when it's not the current window.
9080 This is a hard minimum, windows will never become smaller.
9081 When set to zero, windows may be "squashed" to zero columns (i.e. just
9082 a vertical separator) if necessary. They will return to at least one
9083 line when they become active (since the cursor has to have somewhere
9084 to go.)
9085 Use 'winwidth' to set the minimal width of the current window.
9086 This option is only checked when making a window smaller. Don't use a
9087 large number, it will cause errors when opening more than a few
9088 windows. A value of 0 to 12 is reasonable.
9089
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009090 *'winptydll'*
9091'winptydll' string (default "winpty32.dll" or "winpty64.dll")
9092 global
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009093 {only available when compiled with the |terminal|
9094 feature on MS-Windows}
9095 Specifies the name of the winpty shared library, used for the
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02009096 |:terminal| command. The default depends on whether Vim was built as a
Bram Moolenaarc572da52017-08-27 16:52:01 +02009097 32-bit or 64-bit executable. If not found, "winpty.dll" is tried as
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009098 a fallback.
9099 Environment variables are expanded |:set_env|.
9100 This option cannot be set from a |modeline| or in the |sandbox|, for
9101 security reasons.
9102
Bram Moolenaar071d4272004-06-13 20:20:40 +00009103 *'winwidth'* *'wiw'* *E592*
9104'winwidth' 'wiw' number (default 20)
9105 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009106 Minimal number of columns for the current window. This is not a hard
9107 minimum, Vim will use fewer columns if there is not enough room. If
9108 the current window is smaller, its size is increased, at the cost of
9109 the width of other windows. Set it to 999 to make the current window
9110 always fill the screen. Set it to a small number for normal editing.
9111 The width is not adjusted after one of the commands to change the
9112 width of the current window.
9113 'winwidth' applies to the current window. Use 'winminwidth' to set
9114 the minimal width for other windows.
9115
9116 *'wrap'* *'nowrap'*
9117'wrap' boolean (default on)
9118 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00009119 This option changes how text is displayed. It doesn't change the text
9120 in the buffer, see 'textwidth' for that.
9121 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009122 displaying continues on the next line. When off lines will not wrap
9123 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00009124 moved to a part that is not shown, the screen will scroll
9125 horizontally.
9126 The line will be broken in the middle of a word if necessary. See
9127 'linebreak' to get the break at a word boundary.
9128 To make scrolling horizontally a bit more useful, try this: >
9129 :set sidescroll=5
9130 :set listchars+=precedes:<,extends:>
9131< See 'sidescroll', 'listchars' and |wrap-off|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01009132 This option can't be set from a |modeline| when the 'diff' option is
9133 on.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009134
9135 *'wrapmargin'* *'wm'*
9136'wrapmargin' 'wm' number (default 0)
9137 local to buffer
9138 Number of characters from the right window border where wrapping
9139 starts. When typing text beyond this limit, an <EOL> will be inserted
9140 and inserting continues on the next line.
9141 Options that add a margin, such as 'number' and 'foldcolumn', cause
9142 the text width to be further reduced. This is Vi compatible.
9143 When 'textwidth' is non-zero, this option is not used.
Bram Moolenaarca635012015-09-25 20:34:21 +02009144 This option is set to 0 when 'paste' is set and restored when 'paste'
9145 is reset.
Bram Moolenaara6c27c42019-05-09 19:16:22 +02009146 See also 'formatoptions' and |ins-textwidth|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009147
9148 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
9149'wrapscan' 'ws' boolean (default on) *E384* *E385*
9150 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00009151 Searches wrap around the end of the file. Also applies to |]s| and
9152 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009153
9154 *'write'* *'nowrite'*
9155'write' boolean (default on)
9156 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009157 Allows writing files. When not set, writing a file is not allowed.
9158 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009159 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00009160 argument. Filtering text is still possible, even though this requires
9161 writing a temporary file.
9162
9163 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
9164'writeany' 'wa' boolean (default off)
9165 global
9166 Allows writing to any file with no need for "!" override.
9167
9168 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
9169'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
9170 otherwise)
9171 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009172 Make a backup before overwriting a file. The backup is removed after
9173 the file was successfully written, unless the 'backup' option is
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02009174 also on.
9175 WARNING: Switching this option off means that when Vim fails to write
9176 your buffer correctly and then, for whatever reason, Vim exits, you
9177 lose both the original file and what you were writing. Only reset
9178 this option if your file system is almost full and it makes the write
9179 fail (and make sure not to exit Vim until the write was successful).
9180 See |backup-table| for another explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009181 When the 'backupskip' pattern matches, a backup is not made anyway.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01009182 Depending on 'backupcopy' the backup is a new file or the original
9183 file renamed (and a new file is written).
Bram Moolenaar071d4272004-06-13 20:20:40 +00009184 NOTE: This option is set to the default value when 'compatible' is
9185 set.
9186
9187 *'writedelay'* *'wd'*
9188'writedelay' 'wd' number (default 0)
9189 global
Bram Moolenaar802a0d92016-06-26 16:17:58 +02009190 The number of milliseconds to wait for each character sent to the
Bram Moolenaar071d4272004-06-13 20:20:40 +00009191 screen. When non-zero, characters are sent to the terminal one by
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01009192 one. For debugging purposes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009193
Bram Moolenaar91f84f62018-07-29 15:07:52 +02009194 vim:tw=78:ts=8:noet:ft=help:norl: