blob: 8c9ff3d43f81c6923e823f3d67f77b07ed85521b [file] [log] [blame]
Bram Moolenaarf10911e2022-01-29 22:20:48 +00001*options.txt* For Vim version 8.2. Last change: 2022 Jan 29
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
Bram Moolenaar6f4754b2022-01-23 12:07:04 +0000173< E846: Key code not set: t_kb ~
Bram Moolenaar0b2f94d2011-03-22 14:35:05 +0100174
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 Moolenaar2f0936c2022-01-08 21:51:59 +0000372Note: In the future more global options can be made |global-local|. Using
Bram Moolenaar071d4272004-06-13 20:20:40 +0000373":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
Yegappan Lakshmanan64095532021-12-06 11:03:55 +0000379a function name or a function reference or a lambda function. When using a
380lambda it will be converted to the name, e.g. "<lambda>123". Examples:
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +0000381>
382 set opfunc=MyOpFunc
Yegappan Lakshmanan19916a82021-11-24 16:32:55 +0000383 set opfunc=function('MyOpFunc')
384 set opfunc=funcref('MyOpFunc')
Yegappan Lakshmanan05e59e32021-12-01 10:30:07 +0000385 set opfunc={a\ ->\ MyOpFunc(a)}
386 " set using a funcref variable
387 let Fn = function('MyTagFunc')
Bram Moolenaarfa3b7232021-12-24 13:18:38 +0000388 let &tagfunc = Fn
Yegappan Lakshmanan05e59e32021-12-01 10:30:07 +0000389 " set using a lambda expression
Yegappan Lakshmanan64095532021-12-06 11:03:55 +0000390 let &tagfunc = {t -> MyTagFunc(t)}
Yegappan Lakshmanan05e59e32021-12-01 10:30:07 +0000391 " set using a variable with lambda expression
392 let L = {a, b, c -> MyTagFunc(a, b , c)}
Yegappan Lakshmanan64095532021-12-06 11:03:55 +0000393 let &tagfunc = L
Bram Moolenaar7b1463b2021-12-11 17:24:39 +0000394
395In Vim9 script, in a compiled function, you can use a lambda, but a
396closured does not work, because the function will be called without the
397context of where it was defined.
398
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +0000399
Bram Moolenaar071d4272004-06-13 20:20:40 +0000400Setting the filetype
401
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200402:setf[iletype] [FALLBACK] {filetype} *:setf* *:setfiletype*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000403 Set the 'filetype' option to {filetype}, but only if
404 not done yet in a sequence of (nested) autocommands.
405 This is short for: >
406 :if !did_filetype()
407 : setlocal filetype={filetype}
408 :endif
409< This command is used in a filetype.vim file to avoid
410 setting the 'filetype' option twice, causing different
411 settings and syntax files to be loaded.
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200412
413 When the optional FALLBACK argument is present, a
414 later :setfiletype command will override the
Bram Moolenaar26967612019-03-17 17:13:16 +0100415 'filetype'. This is to be used for filetype
416 detections that are just a guess. |did_filetype()|
417 will return false after this command.
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200418
Bram Moolenaard58e9292011-02-09 17:07:58 +0100419 *option-window* *optwin*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000420:bro[wse] se[t] *:set-browse* *:browse-set* *:opt* *:options*
421:opt[ions] Open a window for viewing and setting all options.
422 Options are grouped by function.
423 Offers short help for each option. Hit <CR> on the
424 short help to open a help window with more help for
425 the option.
426 Modify the value of the option and hit <CR> on the
427 "set" line to set the new value. For window and
428 buffer specific options, the last accessed window is
429 used to set the option value in, unless this is a help
430 window, in which case the window below help window is
431 used (skipping the option-window).
Bram Moolenaarb5b75622018-03-09 22:22:21 +0100432 {not available when compiled without the |+eval|
433 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000434
435 *$HOME*
436Using "~" is like using "$HOME", but it is only recognized at the start of an
437option and after a space or comma.
438
439On Unix systems "~user" can be used too. It is replaced by the home directory
440of user "user". Example: >
441 :set path=~mool/include,/usr/include,.
442
443On Unix systems the form "${HOME}" can be used too. The name between {} can
444contain non-id characters then. Note that if you want to use this for the
445"gf" command, you need to add the '{' and '}' characters to 'isfname'.
446
447NOTE: expanding environment variables and "~/" is only done with the ":set"
448command, not when assigning a value to an option with ":let".
449
Bram Moolenaarc572da52017-08-27 16:52:01 +0200450 *$HOME-windows*
451On MS-Windows, if $HOME is not defined as an environment variable, then
452at runtime Vim will set it to the expansion of $HOMEDRIVE$HOMEPATH.
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200453If $HOMEDRIVE is not set then $USERPROFILE is used.
454
455This expanded value is not exported to the environment, this matters when
456running an external command: >
457 :echo system('set | findstr ^HOME=')
458and >
459 :echo luaeval('os.getenv("HOME")')
460should echo nothing (an empty string) despite exists('$HOME') being true.
461When setting $HOME to a non-empty string it will be exported to the
462subprocesses.
Bram Moolenaarc572da52017-08-27 16:52:01 +0200463
Bram Moolenaar071d4272004-06-13 20:20:40 +0000464
465Note the maximum length of an expanded option is limited. How much depends on
466the system, mostly it is something like 256 or 1024 characters.
467
468 *:fix* *:fixdel*
469:fix[del] Set the value of 't_kD':
470 't_kb' is 't_kD' becomes ~
471 CTRL-? CTRL-H
472 not CTRL-? CTRL-?
473
Bram Moolenaar82be4842021-01-11 19:40:15 +0100474 (CTRL-? is 0o177 octal, 0x7f hex)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000475
476 If your delete key terminal code is wrong, but the
477 code for backspace is alright, you can put this in
478 your .vimrc: >
479 :fixdel
480< This works no matter what the actual code for
481 backspace is.
482
483 If the backspace key terminal code is wrong you can
484 use this: >
485 :if &term == "termname"
486 : set t_kb=^V<BS>
487 : fixdel
488 :endif
489< Where "^V" is CTRL-V and "<BS>" is the backspace key
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000490 (don't type four characters!). Replace "termname"
Bram Moolenaar071d4272004-06-13 20:20:40 +0000491 with your terminal name.
492
493 If your <Delete> key sends a strange key sequence (not
494 CTRL-? or CTRL-H) you cannot use ":fixdel". Then use: >
495 :if &term == "termname"
496 : set t_kD=^V<Delete>
497 :endif
498< Where "^V" is CTRL-V and "<Delete>" is the delete key
499 (don't type eight characters!). Replace "termname"
500 with your terminal name.
501
502 *Linux-backspace*
503 Note about Linux: By default the backspace key
504 produces CTRL-?, which is wrong. You can fix it by
505 putting this line in your rc.local: >
506 echo "keycode 14 = BackSpace" | loadkeys
507<
508 *NetBSD-backspace*
509 Note about NetBSD: If your backspace doesn't produce
510 the right code, try this: >
511 xmodmap -e "keycode 22 = BackSpace"
512< If this works, add this in your .Xmodmap file: >
513 keysym 22 = BackSpace
514< You need to restart for this to take effect.
515
516==============================================================================
5172. Automatically setting options *auto-setting*
518
519Besides changing options with the ":set" command, there are three alternatives
520to set options automatically for one or more files:
521
5221. When starting Vim initializations are read from various places. See
523 |initialization|. Most of them are performed for all editing sessions,
524 and some of them depend on the directory where Vim is started.
525 You can create an initialization file with |:mkvimrc|, |:mkview| and
526 |:mksession|.
5272. If you start editing a new file, the automatic commands are executed.
528 This can be used to set options for files matching a particular pattern and
529 many other things. See |autocommand|.
5303. If you start editing a new file, and the 'modeline' option is on, a
531 number of lines at the beginning and end of the file are checked for
532 modelines. This is explained here.
533
534 *modeline* *vim:* *vi:* *ex:* *E520*
535There are two forms of modelines. The first form:
Bram Moolenaar664f3cf2019-12-07 16:03:51 +0100536 [text{white}]{vi:|vim:|ex:}[white]{options}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000537
Bram Moolenaar664f3cf2019-12-07 16:03:51 +0100538[text{white}] empty or any text followed by at least one blank
539 character (<Space> or <Tab>); "ex:" always requires at
540 least one blank character
Bram Moolenaar14b69452013-06-29 23:05:20 +0200541{vi:|vim:|ex:} the string "vi:", "vim:" or "ex:"
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200542[white] optional white space
543{options} a list of option settings, separated with white space
544 or ':', where each part between ':' is the argument
545 for a ":set" command (can be empty)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000546
Bram Moolenaar14b69452013-06-29 23:05:20 +0200547Examples:
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000548 vi:noai:sw=3 ts=6 ~
Bram Moolenaar14b69452013-06-29 23:05:20 +0200549 vim: tw=77 ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000550
551The second form (this is compatible with some versions of Vi):
552
Bram Moolenaarade0d392020-01-21 22:33:58 +0100553 [text{white}]{vi:|vim:|Vim:|ex:}[white]se[t] {options}:[text]
Bram Moolenaar071d4272004-06-13 20:20:40 +0000554
Bram Moolenaarade0d392020-01-21 22:33:58 +0100555[text{white}] empty or any text followed by at least one blank
556 character (<Space> or <Tab>); "ex:" always requires at
557 least one blank character
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200558{vi:|vim:|Vim:|ex:} the string "vi:", "vim:", "Vim:" or "ex:"
559[white] optional white space
Bram Moolenaar14b69452013-06-29 23:05:20 +0200560se[t] the string "set " or "se " (note the space); When
561 "Vim" is used it must be "set".
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200562{options} a list of options, separated with white space, which
563 is the argument for a ":set" command
564: a colon
565[text] any text or empty
Bram Moolenaar071d4272004-06-13 20:20:40 +0000566
Bram Moolenaar14b69452013-06-29 23:05:20 +0200567Examples:
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000568 /* vim: set ai tw=75: */ ~
Bram Moolenaar14b69452013-06-29 23:05:20 +0200569 /* Vim: set ai tw=75: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000570
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200571The white space before {vi:|vim:|Vim:|ex:} is required. This minimizes the
572chance that a normal word like "lex:" is caught. There is one exception:
573"vi:" and "vim:" can also be at the start of the line (for compatibility with
574version 3.0). Using "ex:" at the start of the line will be ignored (this
575could be short for "example:").
Bram Moolenaar071d4272004-06-13 20:20:40 +0000576
Hu Jialun9dcd3492021-08-28 20:42:50 +0200577If the modeline is disabled within a modeline, subsequent modelines will be
578ignored. This is to allow turning off modeline on a per-file basis. This is
579useful when a line looks like a modeline but isn't. For example, it would be
580good to start a YAML file containing strings like "vim:" with
581 # vim: nomodeline ~
582so as to avoid modeline misdetection. Following options on the same line
583after modeline deactivation, if any, are still evaluated (but you would
584normally not have any).
585
Bram Moolenaar071d4272004-06-13 20:20:40 +0000586 *modeline-local*
587The options are set like with ":setlocal": The new value only applies to the
Bram Moolenaar843ee412004-06-30 16:16:41 +0000588buffer and window that contain the file. Although it's possible to set global
589options from a modeline, this is unusual. If you have two windows open and
590the files in it set the same global option to a different value, the result
591depends on which one was opened last.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000592
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +0000593When editing a file that was already loaded, only the window-local options
594from the modeline are used. Thus if you manually changed a buffer-local
595option after opening the file, it won't be changed if you edit the same buffer
596in another window. But window-local options will be set.
597
Bram Moolenaar071d4272004-06-13 20:20:40 +0000598 *modeline-version*
599If the modeline is only to be used for some versions of Vim, the version
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200600number can be specified where "vim:" or "Vim:" is used:
Bram Moolenaar071d4272004-06-13 20:20:40 +0000601 vim{vers}: version {vers} or later
602 vim<{vers}: version before {vers}
603 vim={vers}: version {vers}
604 vim>{vers}: version after {vers}
Bram Moolenaar2b8388b2015-02-28 13:11:45 +0100605{vers} is 700 for Vim 7.0 (hundred times the major version plus minor).
606For example, to use a modeline only for Vim 7.0:
607 /* vim700: set foldmethod=marker */ ~
608To use a modeline for Vim after version 7.2:
609 /* vim>702: set cole=2: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000610There can be no blanks between "vim" and the ":".
611
612
613The number of lines that are checked can be set with the 'modelines' option.
614If 'modeline' is off or 'modelines' is 0 no lines are checked.
615
616Note that for the first form all of the rest of the line is used, thus a line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000617like:
618 /* vi:ts=4: */ ~
619will give an error message for the trailing "*/". This line is OK:
620 /* vi:set ts=4: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000621
622If an error is detected the rest of the line is skipped.
623
624If you want to include a ':' in a set command precede it with a '\'. The
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000625backslash in front of the ':' will be removed. Example:
Bram Moolenaar95a9dd12019-12-19 22:12:03 +0100626 /* vi:set fillchars=stl\:^,vert\:\|: */ ~
627This sets the 'fillchars' option to "stl:^,vert:\|". Only a single backslash
628before the ':' is removed. Thus to include "\:" you have to specify "\\:".
Bram Moolenaar110289e2019-05-23 15:38:06 +0200629 *E992*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000630No other commands than "set" are supported, for security reasons (somebody
Bram Moolenaar8243a792007-05-01 17:05:03 +0000631might create a Trojan horse text file with modelines). And not all options
Bram Moolenaar110289e2019-05-23 15:38:06 +0200632can be set. For some options a flag is set, so that when the value is used
633the |sandbox| is effective. Some options can only be set from the modeline
634when 'modelineexpr' is set (the default is off).
635
636Still, there is always a small risk that a modeline causes trouble. E.g.,
637when some joker sets 'textwidth' to 5 all your lines are wrapped unexpectedly.
638So disable modelines before editing untrusted text. The mail ftplugin does
639this, for example.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000640
641Hint: If you would like to do something else than setting an option, you could
642define an autocommand that checks the file for a specific string. For
643example: >
644 au BufReadPost * if getline(1) =~ "VAR" | call SetVar() | endif
645And define a function SetVar() that does something with the line containing
646"VAR".
647
648==============================================================================
6493. Options summary *option-summary*
650
651In the list below all the options are mentioned with their full name and with
652an abbreviation if there is one. Both forms may be used.
653
654In this document when a boolean option is "set" that means that ":set option"
655is entered. When an option is "reset", ":set nooption" is used.
656
657For some options there are two default values: The "Vim default", which is
658used when 'compatible' is not set, and the "Vi default", which is used when
659'compatible' is set.
660
661Most options are the same in all windows and buffers. There are a few that
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000662are specific to how the text is presented in a window. These can be set to a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000663different value in each window. For example the 'list' option can be set in
664one window and reset in another for the same text, giving both types of view
665at the same time. There are a few options that are specific to a certain
666file. These can have a different value for each file or buffer. For example
667the 'textwidth' option can be 78 for a normal text file and 0 for a C
668program.
669
670 global one option for all buffers and windows
671 local to window each window has its own copy of this option
672 local to buffer each buffer has its own copy of this option
673
674When creating a new window the option values from the currently active window
675are used as a default value for the window-specific options. For the
676buffer-specific options this depends on the 's' and 'S' flags in the
677'cpoptions' option. If 's' is included (which is the default) the values for
678buffer options are copied from the currently active buffer when a buffer is
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000679first entered. If 'S' is present the options are copied each time the buffer
680is entered, this is almost like having global options. If 's' and 'S' are not
Bram Moolenaar071d4272004-06-13 20:20:40 +0000681present, the options are copied from the currently active buffer when the
682buffer is created.
683
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000684Hidden options *hidden-options*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000685
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000686Not all options are supported in all versions. This depends on the supported
687features and sometimes on the system. A remark about this is in curly braces
688below. When an option is not supported it may still be set without getting an
689error, this is called a hidden option. You can't get the value of a hidden
690option though, it is not stored.
691
692To test if option "foo" can be used with ":set" use something like this: >
693 if exists('&foo')
694This also returns true for a hidden option. To test if option "foo" is really
695supported use something like this: >
696 if exists('+foo')
697<
Bram Moolenaar071d4272004-06-13 20:20:40 +0000698 *E355*
699A jump table for the options with a short description can be found at |Q_op|.
700
701 *'aleph'* *'al'* *aleph* *Aleph*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +0100702'aleph' 'al' number (default 128 for MS-Windows, 224 otherwise)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000703 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000704 {only available when compiled with the |+rightleft|
705 feature}
706 The ASCII code for the first letter of the Hebrew alphabet. The
707 routine that maps the keyboard in Hebrew mode, both in Insert mode
708 (when hkmap is set) and on the command-line (when hitting CTRL-_)
709 outputs the Hebrew characters in the range [aleph..aleph+26].
710 aleph=128 applies to PC code, and aleph=224 applies to ISO 8859-8.
711 See |rileft.txt|.
712
713 *'allowrevins'* *'ari'* *'noallowrevins'* *'noari'*
714'allowrevins' 'ari' boolean (default off)
715 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000716 {only available when compiled with the |+rightleft|
717 feature}
718 Allow CTRL-_ in Insert and Command-line mode. This is default off, to
719 avoid that users that accidentally type CTRL-_ instead of SHIFT-_ get
720 into reverse Insert mode, and don't know how to get out. See
721 'revins'.
722 NOTE: This option is reset when 'compatible' is set.
723
724 *'altkeymap'* *'akm'* *'noaltkeymap'* *'noakm'*
725'altkeymap' 'akm' boolean (default off)
726 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000727 {only available when compiled with the |+farsi|
728 feature}
Bram Moolenaar14184a32019-02-16 15:10:30 +0100729 This option was for using Farsi, which has been removed. See
730 |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000731
732 *'ambiwidth'* *'ambw'*
733'ambiwidth' 'ambw' string (default: "single")
734 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000735 Only effective when 'encoding' is "utf-8" or another Unicode encoding.
736 Tells Vim what to do with characters with East Asian Width Class
737 Ambiguous (such as Euro, Registered Sign, Copyright Sign, Greek
738 letters, Cyrillic letters).
739
740 There are currently two possible values:
Bram Moolenaar582fd852005-03-28 20:58:01 +0000741 "single": Use the same width as characters in US-ASCII. This is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000742 expected by most users.
743 "double": Use twice the width of ASCII characters.
Bram Moolenaar5c3bd0a2010-08-04 20:55:44 +0200744 *E834* *E835*
745 The value "double" cannot be used if 'listchars' or 'fillchars'
Bram Moolenaar079ba762021-10-23 12:08:41 +0100746 contains a character that would be double width. These errors may
747 also be given when calling setcellwidths().
Bram Moolenaar08aac3c2020-08-28 21:04:24 +0200748
749 The values are overruled for characters specified with
750 |setcellwidths()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000751
752 There are a number of CJK fonts for which the width of glyphs for
753 those characters are solely based on how many octets they take in
754 legacy/traditional CJK encodings. In those encodings, Euro,
755 Registered sign, Greek/Cyrillic letters are represented by two octets,
Bram Moolenaar582fd852005-03-28 20:58:01 +0000756 therefore those fonts have "wide" glyphs for them. This is also
Bram Moolenaar071d4272004-06-13 20:20:40 +0000757 true of some line drawing characters used to make tables in text
Bram Moolenaar582fd852005-03-28 20:58:01 +0000758 file. Therefore, when a CJK font is used for GUI Vim or
Bram Moolenaar071d4272004-06-13 20:20:40 +0000759 Vim is running inside a terminal (emulators) that uses a CJK font
760 (or Vim is run inside an xterm invoked with "-cjkwidth" option.),
761 this option should be set to "double" to match the width perceived
762 by Vim with the width of glyphs in the font. Perhaps it also has
Bram Moolenaar8024f932020-01-14 19:29:13 +0100763 to be set to "double" under CJK MS-Windows when the system locale is
764 set to one of CJK locales. See Unicode Standard Annex #11
765 (http://www.unicode.org/reports/tr11).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000766
Bram Moolenaarac7bd632013-03-19 11:35:58 +0100767 Vim may set this option automatically at startup time when Vim is
768 compiled with the |+termresponse| feature and if |t_u7| is set to the
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200769 escape sequence to request cursor position report. The response can
770 be found in |v:termu7resp|.
Bram Moolenaarac7bd632013-03-19 11:35:58 +0100771
Bram Moolenaar071d4272004-06-13 20:20:40 +0000772 *'antialias'* *'anti'* *'noantialias'* *'noanti'*
773'antialias' 'anti' boolean (default: off)
774 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000775 {only available when compiled with GUI enabled
Bram Moolenaar3d1cde82020-08-15 18:55:18 +0200776 on macOS}
777 This option only has an effect in the GUI version of Vim on macOS
Bram Moolenaar071d4272004-06-13 20:20:40 +0000778 v10.2 or later. When on, Vim will use smooth ("antialiased") fonts,
779 which can be easier to read at certain sizes on certain displays.
780 Setting this option can sometimes cause problems if 'guifont' is set
781 to its default (empty string).
Bram Moolenaar036986f2017-03-16 17:41:02 +0100782 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000783
784 *'autochdir'* *'acd'* *'noautochdir'* *'noacd'*
785'autochdir' 'acd' boolean (default off)
786 global
Bram Moolenaar00a927d2010-05-14 23:24:24 +0200787 {only available when compiled with it, use
788 exists("+autochdir") to check}
Bram Moolenaard8c00872005-07-22 21:52:15 +0000789 When on, Vim will change the current working directory whenever you
790 open a file, switch buffers, delete a buffer or open/close a window.
791 It will change to the directory containing the file which was opened
792 or selected.
Bram Moolenaar910f66f2006-04-05 20:41:53 +0000793 Note: When this option is on some plugins may not work.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000794
Bram Moolenaar8b9abfd2021-03-29 20:49:05 +0200795 *'autoshelldir'* *'asd'* *'noautoshelldir'* *'noasd'*
796'autoshelldir' 'asd' boolean (default off)
797 global
798 When on, Vim will change the current working directory whenever you
799 change the directory of the shell running in a terminal window. You
800 need proper setting-up, so whenever the shell's pwd changes an OSC 7
801 escape sequence will be emitted. For example, on Linux, you can source
802 /etc/profile.d/vte.sh in your shell profile if you use bash or zsh.
803
Bram Moolenaar071d4272004-06-13 20:20:40 +0000804 *'arabic'* *'arab'* *'noarabic'* *'noarab'*
805'arabic' 'arab' boolean (default off)
806 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +0000807 {only available when compiled with the |+arabic|
808 feature}
809 This option can be set to start editing Arabic text.
810 Setting this option will:
811 - Set the 'rightleft' option, unless 'termbidi' is set.
812 - Set the 'arabicshape' option, unless 'termbidi' is set.
813 - Set the 'keymap' option to "arabic"; in Insert mode CTRL-^ toggles
814 between typing English and Arabic key mapping.
815 - Set the 'delcombine' option
816 Note that 'encoding' must be "utf-8" for working with Arabic text.
817
818 Resetting this option will:
819 - Reset the 'rightleft' option.
820 - Disable the use of 'keymap' (without changing its value).
821 Note that 'arabicshape' and 'delcombine' are not reset (it is a global
Bram Moolenaarc8734422012-06-01 22:38:45 +0200822 option).
Bram Moolenaar036986f2017-03-16 17:41:02 +0100823 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000824 Also see |arabic.txt|.
825
826 *'arabicshape'* *'arshape'*
827 *'noarabicshape'* *'noarshape'*
828'arabicshape' 'arshape' boolean (default on)
829 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000830 {only available when compiled with the |+arabic|
831 feature}
832 When on and 'termbidi' is off, the required visual character
833 corrections that need to take place for displaying the Arabic language
Bram Moolenaar3a0d8092012-10-21 03:02:54 +0200834 take effect. Shaping, in essence, gets enabled; the term is a broad
Bram Moolenaar071d4272004-06-13 20:20:40 +0000835 one which encompasses:
836 a) the changing/morphing of characters based on their location
837 within a word (initial, medial, final and stand-alone).
838 b) the enabling of the ability to compose characters
839 c) the enabling of the required combining of some characters
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100840 When disabled the display shows each character's true stand-alone
841 form.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000842 Arabic is a complex language which requires other settings, for
843 further details see |arabic.txt|.
Bram Moolenaar036986f2017-03-16 17:41:02 +0100844 NOTE: This option is set when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000845
846 *'autoindent'* *'ai'* *'noautoindent'* *'noai'*
847'autoindent' 'ai' boolean (default off)
848 local to buffer
849 Copy indent from current line when starting a new line (typing <CR>
850 in Insert mode or when using the "o" or "O" command). If you do not
851 type anything on the new line except <BS> or CTRL-D and then type
Bram Moolenaar02467872007-05-06 13:22:01 +0000852 <Esc>, CTRL-O or <CR>, the indent is deleted again. Moving the cursor
853 to another line has the same effect, unless the 'I' flag is included
854 in 'cpoptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000855 When autoindent is on, formatting (with the "gq" command or when you
856 reach 'textwidth' in Insert mode) uses the indentation of the first
857 line.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000858 When 'smartindent' or 'cindent' is on the indent is changed in
859 a different way.
Bram Moolenaarca635012015-09-25 20:34:21 +0200860 The 'autoindent' option is reset when the 'paste' option is set and
861 restored when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000862
863 *'autoread'* *'ar'* *'noautoread'* *'noar'*
864'autoread' 'ar' boolean (default off)
865 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000866 When a file has been detected to have been changed outside of Vim and
867 it has not been changed inside of Vim, automatically read it again.
Bram Moolenaarfd358112018-07-07 23:21:31 +0200868 When the file has been deleted this is not done, so you have the text
869 from before it was deleted. When it appears again then it is read.
870 |timestamp|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000871 If this option has a local value, use this command to switch back to
872 using the global value: >
873 :set autoread<
874<
875 *'autowrite'* *'aw'* *'noautowrite'* *'noaw'*
876'autowrite' 'aw' boolean (default off)
877 global
878 Write the contents of the file, if it has been modified, on each
Bram Moolenaar47003982021-12-05 21:54:04 +0000879 `:next`, `:rewind`, `:last`, `:first`, `:previous`, `:stop`,
Bram Moolenaar2f0936c2022-01-08 21:51:59 +0000880 `:suspend`, `:tag`, `:!`, `:make`, CTRL-] and CTRL-^ command; and when
881 a `:buffer`, CTRL-O, CTRL-I, '{A-Z0-9}, or `{A-Z0-9} command takes one
Bram Moolenaar47003982021-12-05 21:54:04 +0000882 to another file.
883 A buffer is not written if it becomes hidden, e.g. when 'bufhidden' is
Bram Moolenaar2f0936c2022-01-08 21:51:59 +0000884 set to "hide" and `:next` is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000885 Note that for some commands the 'autowrite' option is not used, see
886 'autowriteall' for that.
Bram Moolenaar93a1df22018-09-10 11:51:50 +0200887 Some buffers will not be written, specifically when 'buftype' is
Bram Moolenaar20aac6c2018-09-02 21:07:30 +0200888 "nowrite", "nofile", "terminal" or "prompt".
Bram Moolenaar071d4272004-06-13 20:20:40 +0000889
890 *'autowriteall'* *'awa'* *'noautowriteall'* *'noawa'*
891'autowriteall' 'awa' boolean (default off)
892 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000893 Like 'autowrite', but also used for commands ":edit", ":enew", ":quit",
894 ":qall", ":exit", ":xit", ":recover" and closing the Vim window.
895 Setting this option also implies that Vim behaves like 'autowrite' has
896 been set.
897
898 *'background'* *'bg'*
Bram Moolenaar446beb42011-05-10 17:18:44 +0200899'background' 'bg' string (default "dark" or "light", see below)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000900 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000901 When set to "dark", Vim will try to use colors that look good on a
902 dark background. When set to "light", Vim will try to use colors that
903 look good on a light background. Any other value is illegal.
904 Vim tries to set the default value according to the terminal used.
905 This will not always be correct.
906 Setting this option does not change the background color, it tells Vim
907 what the background color looks like. For changing the background
908 color, see |:hi-normal|.
909
910 When 'background' is set Vim will adjust the default color groups for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000911 the new value. But the colors used for syntax highlighting will not
Bram Moolenaar446cb832008-06-24 21:56:24 +0000912 change. *g:colors_name*
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100913 When a color scheme is loaded (the "g:colors_name" variable is set)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000914 setting 'background' will cause the color scheme to be reloaded. If
915 the color scheme adjusts to the value of 'background' this will work.
916 However, if the color scheme sets 'background' itself the effect may
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100917 be undone. First delete the "g:colors_name" variable when needed.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000918
919 When setting 'background' to the default value with: >
920 :set background&
921< Vim will guess the value. In the GUI this should work correctly,
922 in other cases Vim might not be able to guess the right value.
Bram Moolenaar2e693a82019-10-16 22:35:02 +0200923 If the GUI supports a dark theme, you can use the "d" flag in
Bram Moolenaar50bf7ce2019-09-15 13:17:00 +0200924 'guioptions', see 'go-d'.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000925
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200926 When the |t_RB| option is set, Vim will use it to request the background
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +0200927 color from the terminal. If the returned RGB value is dark/light and
928 'background' is not dark/light, 'background' will be set and the
929 screen is redrawn. This may have side effects, make t_BG empty in
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200930 your .vimrc if you suspect this problem. The response to |t_RB| can
Bram Moolenaar01164a62017-11-02 22:58:42 +0100931 be found in |v:termrbgresp|.
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +0200932
Bram Moolenaar071d4272004-06-13 20:20:40 +0000933 When starting the GUI, the default value for 'background' will be
934 "light". When the value is not set in the .gvimrc, and Vim detects
935 that the background is actually quite dark, 'background' is set to
936 "dark". But this happens only AFTER the .gvimrc file has been read
937 (because the window needs to be opened to find the actual background
938 color). To get around this, force the GUI window to be opened by
939 putting a ":gui" command in the .gvimrc file, before where the value
940 of 'background' is used (e.g., before ":syntax on").
Bram Moolenaar446beb42011-05-10 17:18:44 +0200941
Bram Moolenaar6f345a12019-12-17 21:27:18 +0100942 For MS-Windows the default is "dark".
Bram Moolenaar446beb42011-05-10 17:18:44 +0200943 For other systems "dark" is used when 'term' is "linux",
944 "screen.linux", "cygwin" or "putty", or $COLORFGBG suggests a dark
945 background. Otherwise the default is "light".
946
Bram Moolenaarc572da52017-08-27 16:52:01 +0200947 The |:terminal| command and the |term_start()| function use the
948 'background' value to decide whether the terminal window will start
949 with a white or black background.
950
Bram Moolenaar071d4272004-06-13 20:20:40 +0000951 Normally this option would be set in the .vimrc file. Possibly
952 depending on the terminal name. Example: >
953 :if &term == "pcterm"
954 : set background=dark
955 :endif
956< When this option is set, the default settings for the highlight groups
957 will change. To use other settings, place ":highlight" commands AFTER
958 the setting of the 'background' option.
959 This option is also used in the "$VIMRUNTIME/syntax/syntax.vim" file
960 to select the colors for syntax highlighting. After changing this
961 option, you must load syntax.vim again to see the result. This can be
962 done with ":syntax on".
963
964 *'backspace'* *'bs'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +0200965'backspace' 'bs' string (default "", set to "indent,eol,start"
966 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000967 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000968 Influences the working of <BS>, <Del>, CTRL-W and CTRL-U in Insert
969 mode. This is a list of items, separated by commas. Each item allows
970 a way to backspace over something:
971 value effect ~
972 indent allow backspacing over autoindent
973 eol allow backspacing over line breaks (join lines)
974 start allow backspacing over the start of insert; CTRL-W and CTRL-U
975 stop once at the start of insert.
Bram Moolenaaraa0489e2020-04-17 19:41:21 +0200976 nostop like start, except CTRL-W and CTRL-U do not stop at the start of
977 insert.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000978
979 When the value is empty, Vi compatible backspacing is used.
980
981 For backwards compatibility with version 5.4 and earlier:
982 value effect ~
983 0 same as ":set backspace=" (Vi compatible)
984 1 same as ":set backspace=indent,eol"
985 2 same as ":set backspace=indent,eol,start"
Bram Moolenaaraa0489e2020-04-17 19:41:21 +0200986 3 same as ":set backspace=indent,eol,nostop"
Bram Moolenaar071d4272004-06-13 20:20:40 +0000987
988 See |:fixdel| if your <BS> or <Del> key does not do what you want.
989 NOTE: This option is set to "" when 'compatible' is set.
990
991 *'backup'* *'bk'* *'nobackup'* *'nobk'*
992'backup' 'bk' boolean (default off)
993 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000994 Make a backup before overwriting a file. Leave it around after the
995 file has been successfully written. If you do not want to keep the
996 backup file, but you do want a backup while the file is being
997 written, reset this option and set the 'writebackup' option (this is
998 the default). If you do not want a backup file at all reset both
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000999 options (use this if your file system is almost full). See the
Bram Moolenaar071d4272004-06-13 20:20:40 +00001000 |backup-table| for more explanations.
1001 When the 'backupskip' pattern matches, a backup is not made anyway.
1002 When 'patchmode' is set, the backup may be renamed to become the
1003 oldest version of a file.
1004 NOTE: This option is reset when 'compatible' is set.
1005
1006 *'backupcopy'* *'bkc'*
1007'backupcopy' 'bkc' string (Vi default for Unix: "yes", otherwise: "auto")
Bram Moolenaarb8ee25a2014-09-23 15:45:08 +02001008 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001009 When writing a file and a backup is made, this option tells how it's
1010 done. This is a comma separated list of words.
1011
1012 The main values are:
1013 "yes" make a copy of the file and overwrite the original one
1014 "no" rename the file and write a new one
1015 "auto" one of the previous, what works best
1016
1017 Extra values that can be combined with the ones above are:
1018 "breaksymlink" always break symlinks when writing
1019 "breakhardlink" always break hardlinks when writing
1020
1021 Making a copy and overwriting the original file:
1022 - Takes extra time to copy the file.
1023 + When the file has special attributes, is a (hard/symbolic) link or
1024 has a resource fork, all this is preserved.
1025 - When the file is a link the backup will have the name of the link,
1026 not of the real file.
1027
1028 Renaming the file and writing a new one:
1029 + It's fast.
1030 - Sometimes not all attributes of the file can be copied to the new
1031 file.
1032 - When the file is a link the new file will not be a link.
1033
1034 The "auto" value is the middle way: When Vim sees that renaming file
1035 is possible without side effects (the attributes can be passed on and
Bram Moolenaar02467872007-05-06 13:22:01 +00001036 the file is not a link) that is used. When problems are expected, a
1037 copy will be made.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001038
1039 The "breaksymlink" and "breakhardlink" values can be used in
1040 combination with any of "yes", "no" and "auto". When included, they
1041 force Vim to always break either symbolic or hard links by doing
1042 exactly what the "no" option does, renaming the original file to
1043 become the backup and writing a new file in its place. This can be
1044 useful for example in source trees where all the files are symbolic or
1045 hard links and any changes should stay in the local source tree, not
1046 be propagated back to the original source.
1047 *crontab*
1048 One situation where "no" and "auto" will cause problems: A program
1049 that opens a file, invokes Vim to edit that file, and then tests if
1050 the open file was changed (through the file descriptor) will check the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001051 backup file instead of the newly created file. "crontab -e" is an
Bram Moolenaar071d4272004-06-13 20:20:40 +00001052 example.
1053
1054 When a copy is made, the original file is truncated and then filled
1055 with the new text. This means that protection bits, owner and
1056 symbolic links of the original file are unmodified. The backup file
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001057 however, is a new file, owned by the user who edited the file. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00001058 group of the backup is set to the group of the original file. If this
1059 fails, the protection bits for the group are made the same as for
1060 others.
1061
1062 When the file is renamed this is the other way around: The backup has
1063 the same attributes of the original file, and the newly written file
1064 is owned by the current user. When the file was a (hard/symbolic)
1065 link, the new file will not! That's why the "auto" value doesn't
1066 rename when the file is a link. The owner and group of the newly
1067 written file will be set to the same ones as the original file, but
1068 the system may refuse to do this. In that case the "auto" value will
1069 again not rename the file.
1070
Bram Moolenaar036986f2017-03-16 17:41:02 +01001071 NOTE: This option is set to the Vi default value when 'compatible' is
1072 set and to the Vim default value when 'compatible' is reset.
1073
Bram Moolenaar071d4272004-06-13 20:20:40 +00001074 *'backupdir'* *'bdir'*
1075'backupdir' 'bdir' string (default for Amiga: ".,t:",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01001076 for Win32: ".,$TEMP,c:/tmp,c:/temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001077 for Unix: ".,~/tmp,~/")
1078 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001079 List of directories for the backup file, separated with commas.
1080 - The backup file will be created in the first directory in the list
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001081 where this is possible. The directory must exist, Vim will not
1082 create it for you.
Bram Moolenaar3848e002016-03-19 18:42:29 +01001083 - Empty means that no backup file will be created ('patchmode' is
Bram Moolenaar071d4272004-06-13 20:20:40 +00001084 impossible!). Writing may fail because of this.
1085 - A directory "." means to put the backup file in the same directory
1086 as the edited file.
Bram Moolenaar8024f932020-01-14 19:29:13 +01001087 - A directory starting with "./" (or ".\" for MS-Windows) means to put
1088 the backup file relative to where the edited file is. The leading
1089 "." is replaced with the path name of the edited file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001090 ("." inside a directory name has no special meaning).
1091 - Spaces after the comma are ignored, other spaces are considered part
1092 of the directory name. To have a space at the start of a directory
1093 name, precede it with a backslash.
1094 - To include a comma in a directory name precede it with a backslash.
1095 - A directory name may end in an '/'.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02001096 - For Unix and Win32, if a directory ends in two path separators "//",
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01001097 the backup file name will be built from the complete path to the
1098 file with all path separators changed to percent '%' signs. This
1099 will ensure file name uniqueness in the backup directory.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02001100 On Win32, it is also possible to end with "\\". However, When a
1101 separating comma is following, you must use "//", since "\\" will
1102 include the comma in the file name. Therefore it is recommended to
1103 use '//', instead of '\\'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001104 - Environment variables are expanded |:set_env|.
1105 - Careful with '\' characters, type one before a space, type two to
1106 get one in the option (see |option-backslash|), for example: >
1107 :set bdir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
1108< - For backwards compatibility with Vim version 3.0 a '>' at the start
1109 of the option is removed.
1110 See also 'backup' and 'writebackup' options.
1111 If you want to hide your backup files on Unix, consider this value: >
1112 :set backupdir=./.backup,~/.backup,.,/tmp
1113< You must create a ".backup" directory in each directory and in your
1114 home directory for this to work properly.
1115 The use of |:set+=| and |:set-=| is preferred when adding or removing
1116 directories from the list. This avoids problems when a future version
1117 uses another default.
1118 This option cannot be set from a |modeline| or in the |sandbox|, for
1119 security reasons.
1120
1121 *'backupext'* *'bex'* *E589*
1122'backupext' 'bex' string (default "~", for VMS: "_")
1123 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001124 String which is appended to a file name to make the name of the
1125 backup file. The default is quite unusual, because this avoids
1126 accidentally overwriting existing files with a backup file. You might
1127 prefer using ".bak", but make sure that you don't have files with
1128 ".bak" that you want to keep.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001129 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001130
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001131 If you like to keep a lot of backups, you could use a BufWritePre
1132 autocommand to change 'backupext' just before writing the file to
1133 include a timestamp. >
1134 :au BufWritePre * let &bex = '-' . strftime("%Y%b%d%X") . '~'
1135< Use 'backupdir' to put the backup in a different directory.
1136
Bram Moolenaar071d4272004-06-13 20:20:40 +00001137 *'backupskip'* *'bsk'*
Bram Moolenaarb8e22a02018-04-12 21:37:34 +02001138'backupskip' 'bsk' string (default: "$TMPDIR/*,$TMP/*,$TEMP/*"
1139 Unix: "/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*"
1140 Mac: "/private/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001141 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001142 {not available when compiled without the |+wildignore|
1143 feature}
1144 A list of file patterns. When one of the patterns matches with the
1145 name of the file which is written, no backup file is created. Both
1146 the specified file name and the full path name of the file are used.
1147 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
1148 Watch out for special characters, see |option-backslash|.
1149 When $TMPDIR, $TMP or $TEMP is not defined, it is not used for the
Bram Moolenaar582fd852005-03-28 20:58:01 +00001150 default value. "/tmp/*" is only used for Unix.
Bram Moolenaar02467872007-05-06 13:22:01 +00001151
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02001152 WARNING: Not having a backup file means that when Vim fails to write
1153 your buffer correctly and then, for whatever reason, Vim exits, you
1154 lose both the original file and what you were writing. Only disable
1155 backups if you don't care about losing the file.
1156
Bram Moolenaar02467872007-05-06 13:22:01 +00001157 Note that environment variables are not expanded. If you want to use
1158 $HOME you must expand it explicitly, e.g.: >
Bram Moolenaar7c1c6db2016-04-03 22:08:05 +02001159 :let &backupskip = escape(expand('$HOME'), '\') . '/tmp/*'
Bram Moolenaar02467872007-05-06 13:22:01 +00001160
1161< Note that the default also makes sure that "crontab -e" works (when a
Bram Moolenaara5792f52005-11-23 21:25:05 +00001162 backup would be made by renaming the original file crontab won't see
1163 the newly created file). Also see 'backupcopy' and |crontab|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001164
1165 *'balloondelay'* *'bdlay'*
1166'balloondelay' 'bdlay' number (default: 600)
1167 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001168 {only available when compiled with the |+balloon_eval|
1169 feature}
1170 Delay in milliseconds before a balloon may pop up. See |balloon-eval|.
1171
1172 *'ballooneval'* *'beval'* *'noballooneval'* *'nobeval'*
1173'ballooneval' 'beval' boolean (default off)
1174 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001175 {only available when compiled with the |+balloon_eval|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001176 feature}
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001177 Switch on the |balloon-eval| functionality for the GUI.
1178
1179 *'balloonevalterm'* *'bevalterm'* *'noballoonevalterm'*
1180 *'nobevalterm'*
1181'balloonevalterm' 'bevalterm' boolean (default off)
1182 global
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001183 {only available when compiled with the
1184 |+balloon_eval_term| feature}
1185 Switch on the |balloon-eval| functionality for the terminal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001186
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001187 *'balloonexpr'* *'bexpr'*
1188'balloonexpr' 'bexpr' string (default "")
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00001189 global or local to buffer |global-local|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001190 {only available when compiled with the |+balloon_eval|
1191 feature}
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00001192 Expression for text to show in evaluation balloon. It is only used
Bram Moolenaara6c27c42019-05-09 19:16:22 +02001193 when 'ballooneval' or 'balloonevalterm' is on. These variables can be
1194 used:
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001195
1196 v:beval_bufnr number of the buffer in which balloon is going to show
1197 v:beval_winnr number of the window
Bram Moolenaar82af8712016-06-04 20:20:29 +02001198 v:beval_winid ID of the window
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001199 v:beval_lnum line number
1200 v:beval_col column number (byte index)
1201 v:beval_text word under or after the mouse pointer
1202
Bram Moolenaar54775062019-07-31 21:07:14 +02001203 Instead of showing a balloon, which is limited to plain text, consider
1204 using a popup window, see |popup_beval_example|. A popup window can
1205 use highlighting and show a border.
1206
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001207 The evaluation of the expression must not have side effects!
1208 Example: >
Bram Moolenaara6c27c42019-05-09 19:16:22 +02001209 function MyBalloonExpr()
Bram Moolenaar45360022005-07-21 21:08:21 +00001210 return 'Cursor is at line ' . v:beval_lnum .
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001211 \', column ' . v:beval_col .
1212 \ ' of file ' . bufname(v:beval_bufnr) .
1213 \ ' on word "' . v:beval_text . '"'
1214 endfunction
1215 set bexpr=MyBalloonExpr()
1216 set ballooneval
1217<
Bram Moolenaar396e8292019-07-13 23:04:31 +02001218 Also see |balloon_show()|, it can be used if the content of the balloon
1219 is to be fetched asynchronously. In that case evaluating
1220 'balloonexpr' should result in an empty string. If you get a balloon
1221 with only "0" you probably didn't return anything from your function.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001222
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001223 NOTE: The balloon is displayed only if the cursor is on a text
1224 character. If the result of evaluating 'balloonexpr' is not empty,
1225 Vim does not try to send a message to an external debugger (Netbeans
1226 or Sun Workshop).
1227
Yegappan Lakshmanan8bb65f22021-12-26 10:51:39 +00001228 If the expression starts with s: or |<SID>|, then it is replaced with
1229 the script ID (|local-function|). Example: >
1230 set bexpr=s:MyBalloonExpr()
1231 set bexpr=<SID>SomeBalloonExpr()
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00001232< Otherwise, the expression is evaluated in the context of the script
1233 where the option was set, thus script-local items are available.
1234
Bram Moolenaar30b65812012-07-12 22:01:11 +02001235 The expression will be evaluated in the |sandbox| when set from a
1236 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02001237 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001238
1239 It is not allowed to change text or jump to another window while
Bram Moolenaar396e8292019-07-13 23:04:31 +02001240 evaluating 'balloonexpr', see |textlock|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001241
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001242 To check whether line breaks in the balloon text work use this check: >
Bram Moolenaar45360022005-07-21 21:08:21 +00001243 if has("balloon_multiline")
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001244< When they are supported "\n" characters will start a new line. If the
1245 expression evaluates to a |List| this is equal to using each List item
1246 as a string and putting "\n" in between them.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001247 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001248
Bram Moolenaar165bc692015-07-21 17:53:25 +02001249 *'belloff'* *'bo'*
1250'belloff' 'bo' string (default "")
1251 global
Bram Moolenaar165bc692015-07-21 17:53:25 +02001252 Specifies for which events the bell will not be rung. It is a comma
1253 separated list of items. For each item that is present, the bell
1254 will be silenced. This is most useful to specify specific events in
1255 insert mode to be silenced.
1256
1257 item meaning when present ~
1258 all All events.
1259 backspace When hitting <BS> or <Del> and deleting results in an
1260 error.
1261 cursor Fail to move around using the cursor keys or
1262 <PageUp>/<PageDown> in |Insert-mode|.
1263 complete Error occurred when using |i_CTRL-X_CTRL-K| or
1264 |i_CTRL-X_CTRL-T|.
1265 copy Cannot copy char from insert mode using |i_CTRL-Y| or
1266 |i_CTRL-E|.
1267 ctrlg Unknown Char after <C-G> in Insert mode.
1268 error Other Error occurred (e.g. try to join last line)
1269 (mostly used in |Normal-mode| or |Cmdline-mode|).
1270 esc hitting <Esc> in |Normal-mode|.
1271 ex In |Visual-mode|, hitting |Q| results in an error.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01001272 hangul Ignored.
Bram Moolenaar165bc692015-07-21 17:53:25 +02001273 insertmode Pressing <Esc> in 'insertmode'.
1274 lang Calling the beep module for Lua/Mzscheme/TCL.
1275 mess No output available for |g<|.
1276 showmatch Error occurred for 'showmatch' function.
1277 operator Empty region error |cpo-E|.
1278 register Unknown register after <C-R> in |Insert-mode|.
1279 shell Bell from shell output |:!|.
1280 spell Error happened on spell suggest.
1281 wildmode More matches in |cmdline-completion| available
1282 (depends on the 'wildmode' setting).
1283
Bram Moolenaar036986f2017-03-16 17:41:02 +01001284 This is most useful to fine tune when in Insert mode the bell should
1285 be rung. For Normal mode and Ex commands, the bell is often rung to
Bram Moolenaar165bc692015-07-21 17:53:25 +02001286 indicate that an error occurred. It can be silenced by adding the
1287 "error" keyword.
1288
Bram Moolenaar071d4272004-06-13 20:20:40 +00001289 *'binary'* *'bin'* *'nobinary'* *'nobin'*
1290'binary' 'bin' boolean (default off)
1291 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001292 This option should be set before editing a binary file. You can also
1293 use the |-b| Vim argument. When this option is switched on a few
1294 options will be changed (also when it already was on):
1295 'textwidth' will be set to 0
1296 'wrapmargin' will be set to 0
1297 'modeline' will be off
1298 'expandtab' will be off
1299 Also, 'fileformat' and 'fileformats' options will not be used, the
1300 file is read and written like 'fileformat' was "unix" (a single <NL>
1301 separates lines).
1302 The 'fileencoding' and 'fileencodings' options will not be used, the
1303 file is read without conversion.
1304 NOTE: When you start editing a(nother) file while the 'bin' option is
1305 on, settings from autocommands may change the settings again (e.g.,
1306 'textwidth'), causing trouble when editing. You might want to set
1307 'bin' again when the file has been loaded.
1308 The previous values of these options are remembered and restored when
1309 'bin' is switched from on to off. Each buffer has its own set of
1310 saved option values.
1311 To edit a file with 'binary' set you can use the |++bin| argument.
1312 This avoids you have to do ":set bin", which would have effect for all
1313 files you edit.
1314 When writing a file the <EOL> for the last line is only written if
1315 there was one in the original file (normally Vim appends an <EOL> to
1316 the last line if there is none; this would make the file longer). See
1317 the 'endofline' option.
1318
1319 *'bioskey'* *'biosk'* *'nobioskey'* *'nobiosk'*
1320'bioskey' 'biosk' boolean (default on)
1321 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02001322 {only for MS-DOS}
Bram Moolenaarf3913272016-02-25 00:00:01 +01001323 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001324
1325 *'bomb'* *'nobomb'*
1326'bomb' boolean (default off)
1327 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001328 When writing a file and the following conditions are met, a BOM (Byte
1329 Order Mark) is prepended to the file:
1330 - this option is on
1331 - the 'binary' option is off
1332 - 'fileencoding' is "utf-8", "ucs-2", "ucs-4" or one of the little/big
1333 endian variants.
1334 Some applications use the BOM to recognize the encoding of the file.
1335 Often used for UCS-2 files on MS-Windows. For other applications it
1336 causes trouble, for example: "cat file1 file2" makes the BOM of file2
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001337 appear halfway the resulting file. Gcc doesn't accept a BOM.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001338 When Vim reads a file and 'fileencodings' starts with "ucs-bom", a
1339 check for the presence of the BOM is done and 'bomb' set accordingly.
1340 Unless 'binary' is set, it is removed from the first line, so that you
1341 don't see it when editing. When you don't change the options, the BOM
1342 will be restored when writing the file.
1343
1344 *'breakat'* *'brk'*
1345'breakat' 'brk' string (default " ^I!@*-+;:,./?")
1346 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02001347 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001348 feature}
1349 This option lets you choose which characters might cause a line
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00001350 break if 'linebreak' is on. Only works for ASCII and also for 8-bit
1351 characters when 'encoding' is an 8-bit encoding.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001352
Bram Moolenaar7c1c6db2016-04-03 22:08:05 +02001353 *'breakindent'* *'bri'* *'nobreakindent'* *'nobri'*
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001354'breakindent' 'bri' boolean (default off)
1355 local to window
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001356 {not available when compiled without the |+linebreak|
1357 feature}
1358 Every wrapped line will continue visually indented (same amount of
1359 space as the beginning of that line), thus preserving horizontal blocks
1360 of text.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001361 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001362
1363 *'breakindentopt'* *'briopt'*
1364'breakindentopt' 'briopt' string (default empty)
1365 local to window
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001366 {not available when compiled without the |+linebreak|
1367 feature}
1368 Settings for 'breakindent'. It can consist of the following optional
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001369 items and must be separated by a comma:
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001370 min:{n} Minimum text width that will be kept after
1371 applying 'breakindent', even if the resulting
1372 text should normally be narrower. This prevents
1373 text indented almost to the right window border
1374 occupying lot of vertical space when broken.
Christian Brabandtc53b4672022-01-15 10:01:05 +00001375 (default: 20)
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001376 shift:{n} After applying 'breakindent', the wrapped line's
1377 beginning will be shifted by the given number of
1378 characters. It permits dynamic French paragraph
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001379 indentation (negative) or emphasizing the line
1380 continuation (positive).
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01001381 sbr Display the 'showbreak' value before applying the
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001382 additional indent.
Maxim Kimf674b352021-07-22 11:46:59 +02001383 list:{n} Adds an additional indent for lines that match a
Christian Brabandt4a0b85a2021-07-14 20:00:27 +02001384 numbered or bulleted list (using the
1385 'formatlistpat' setting).
Maxim Kimf674b352021-07-22 11:46:59 +02001386 list:-1 Uses the length of a match with 'formatlistpat'
1387 for indentation.
Christian Brabandt4a0b85a2021-07-14 20:00:27 +02001388 The default value for min is 20, shift and list is 0.
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001389
Bram Moolenaar071d4272004-06-13 20:20:40 +00001390 *'browsedir'* *'bsdir'*
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001391'browsedir' 'bsdir' string (default: "last")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001392 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02001393 {only for Motif, Athena, GTK, Mac and Win32 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001394 Which directory to use for the file browser:
Bram Moolenaar446cb832008-06-24 21:56:24 +00001395 last Use same directory as with last file browser, where a
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02001396 file was opened or saved.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001397 buffer Use the directory of the related buffer.
1398 current Use the current directory.
1399 {path} Use the specified directory
1400
1401 *'bufhidden'* *'bh'*
1402'bufhidden' 'bh' string (default: "")
1403 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001404 This option specifies what happens when a buffer is no longer
1405 displayed in a window:
1406 <empty> follow the global 'hidden' option
1407 hide hide the buffer (don't unload it), also when 'hidden'
1408 is not set
1409 unload unload the buffer, also when 'hidden' is set or using
1410 |:hide|
1411 delete delete the buffer from the buffer list, also when
1412 'hidden' is set or using |:hide|, like using
1413 |:bdelete|
1414 wipe wipe out the buffer from the buffer list, also when
1415 'hidden' is set or using |:hide|, like using
1416 |:bwipeout|
1417
Bram Moolenaara14de3d2005-01-07 21:48:26 +00001418 CAREFUL: when "unload", "delete" or "wipe" is used changes in a buffer
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01001419 are lost without a warning. Also, these values may break autocommands
1420 that switch between buffers temporarily.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001421 This option is used together with 'buftype' and 'swapfile' to specify
1422 special kinds of buffers. See |special-buffers|.
1423
1424 *'buflisted'* *'bl'* *'nobuflisted'* *'nobl'* *E85*
1425'buflisted' 'bl' boolean (default: on)
1426 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001427 When this option is set, the buffer shows up in the buffer list. If
1428 it is reset it is not used for ":bnext", "ls", the Buffers menu, etc.
1429 This option is reset by Vim for buffers that are only used to remember
1430 a file name or marks. Vim sets it when starting to edit a buffer.
1431 But not when moving to a buffer with ":buffer".
1432
1433 *'buftype'* *'bt'* *E382*
1434'buftype' 'bt' string (default: "")
1435 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001436 The value of this option specifies the type of a buffer:
1437 <empty> normal buffer
1438 nofile buffer which is not related to a file and will not be
1439 written
1440 nowrite buffer which will not be written
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001441 acwrite buffer which will always be written with BufWriteCmd
Bram Moolenaarb5b75622018-03-09 22:22:21 +01001442 autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001443 quickfix quickfix buffer, contains list of errors |:cwindow|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001444 or list of locations |:lwindow|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001445 help help buffer (you are not supposed to set this
1446 manually)
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02001447 terminal buffer for a |terminal| (you are not supposed to set
1448 this manually)
Bram Moolenaarf2732452018-06-03 14:47:35 +02001449 prompt buffer where only the last line can be edited, meant
1450 to be used by a plugin, see |prompt-buffer|
1451 {only when compiled with the |+channel| feature}
Bram Moolenaar4d784b22019-05-25 19:51:39 +02001452 popup buffer used in a popup window, see |popup|.
1453 {only when compiled with the |+textprop| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001454
1455 This option is used together with 'bufhidden' and 'swapfile' to
1456 specify special kinds of buffers. See |special-buffers|.
Bram Moolenaarebdf3c92020-02-15 21:41:42 +01001457 Also see |win_gettype()|, which returns the type of the window.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001458
1459 Be careful with changing this option, it can have many side effects!
Bram Moolenaar113cb512021-11-07 20:27:04 +00001460 One such effect is that Vim will not check the timestamp of the file,
1461 if the file is changed by another program this will not be noticed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001462
Bram Moolenaar280f1262006-01-30 00:14:18 +00001463 A "quickfix" buffer is only used for the error list and the location
1464 list. This value is set by the |:cwindow| and |:lwindow| commands and
1465 you are not supposed to change it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001466
1467 "nofile" and "nowrite" buffers are similar:
1468 both: The buffer is not to be written to disk, ":w" doesn't
1469 work (":w filename" does work though).
1470 both: The buffer is never considered to be |'modified'|.
1471 There is no warning when the changes will be lost, for
1472 example when you quit Vim.
1473 both: A swap file is only created when using too much memory
1474 (when 'swapfile' has been reset there is never a swap
1475 file).
1476 nofile only: The buffer name is fixed, it is not handled like a
1477 file name. It is not modified in response to a |:cd|
1478 command.
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01001479 both: When using ":e bufname" and already editing "bufname"
1480 the buffer is made empty and autocommands are
1481 triggered as usual for |:edit|.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001482 *E676*
1483 "acwrite" implies that the buffer name is not related to a file, like
1484 "nofile", but it will be written. Thus, in contrast to "nofile" and
1485 "nowrite", ":w" does work and a modified buffer can't be abandoned
1486 without saving. For writing there must be matching |BufWriteCmd|,
1487 |FileWriteCmd| or |FileAppendCmd| autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001488
1489 *'casemap'* *'cmp'*
1490'casemap' 'cmp' string (default: "internal,keepascii")
1491 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001492 Specifies details about changing the case of letters. It may contain
1493 these words, separated by a comma:
1494 internal Use internal case mapping functions, the current
1495 locale does not change the case mapping. This only
Bram Moolenaar6f16eb82005-08-23 21:02:42 +00001496 matters when 'encoding' is a Unicode encoding,
1497 "latin1" or "iso-8859-15". When "internal" is
1498 omitted, the towupper() and towlower() system library
1499 functions are used when available.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001500 keepascii For the ASCII characters (0x00 to 0x7f) use the US
1501 case mapping, the current locale is not effective.
1502 This probably only matters for Turkish.
1503
Bram Moolenaar7b1463b2021-12-11 17:24:39 +00001504 *'cdhome'* *'cdh'*
1505'cdhome' 'cdh' boolean (default: off)
1506 global
1507 When on, |:cd|, |:tcd| and |:lcd| without an argument changes the
1508 current working directory to the |$HOME| directory like in Unix.
1509 When off, those commands just print the current directory name.
1510 On Unix this option has no effect.
1511 NOTE: This option is reset when 'compatible' is set.
1512
Bram Moolenaar071d4272004-06-13 20:20:40 +00001513 *'cdpath'* *'cd'* *E344* *E346*
1514'cdpath' 'cd' string (default: equivalent to $CDPATH or ",,")
1515 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001516 {not available when compiled without the
1517 |+file_in_path| feature}
1518 This is a list of directories which will be searched when using the
Bram Moolenaar00aa0692019-04-27 20:37:57 +02001519 |:cd|, |:tcd| and |:lcd| commands, provided that the directory being
1520 searched for has a relative path, not an absolute part starting with
1521 "/", "./" or "../", the 'cdpath' option is not used then.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001522 The 'cdpath' option's value has the same form and semantics as
1523 |'path'|. Also see |file-searching|.
1524 The default value is taken from $CDPATH, with a "," prepended to look
1525 in the current directory first.
1526 If the default value taken from $CDPATH is not what you want, include
1527 a modified version of the following command in your vimrc file to
1528 override it: >
1529 :let &cdpath = ',' . substitute(substitute($CDPATH, '[, ]', '\\\0', 'g'), ':', ',', 'g')
1530< This option cannot be set from a |modeline| or in the |sandbox|, for
1531 security reasons.
1532 (parts of 'cdpath' can be passed to the shell to expand file names).
1533
1534 *'cedit'*
1535'cedit' string (Vi default: "", Vim default: CTRL-F)
1536 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001537 The key used in Command-line Mode to open the command-line window.
1538 The default is CTRL-F when 'compatible' is off.
1539 Only non-printable keys are allowed.
1540 The key can be specified as a single character, but it is difficult to
1541 type. The preferred way is to use the <> notation. Examples: >
Bram Moolenaare18dbe82016-07-02 21:42:23 +02001542 :exe "set cedit=\<C-Y>"
1543 :exe "set cedit=\<Esc>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001544< |Nvi| also has this option, but it only uses the first character.
1545 See |cmdwin|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001546 NOTE: This option is set to the Vim default value when 'compatible'
1547 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001548
1549 *'charconvert'* *'ccv'* *E202* *E214* *E513*
1550'charconvert' 'ccv' string (default "")
1551 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01001552 {only available when compiled with the |+eval| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001553 An expression that is used for character encoding conversion. It is
1554 evaluated when a file that is to be read or has been written has a
1555 different encoding from what is desired.
1556 'charconvert' is not used when the internal iconv() function is
1557 supported and is able to do the conversion. Using iconv() is
1558 preferred, because it is much faster.
1559 'charconvert' is not used when reading stdin |--|, because there is no
1560 file to convert from. You will have to save the text in a file first.
Bram Moolenaarf10911e2022-01-29 22:20:48 +00001561 The expression must return zero, false or an empty string for success,
1562 non-zero or true for failure.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001563 The possible encoding names encountered are in 'encoding'.
1564 Additionally, names given in 'fileencodings' and 'fileencoding' are
1565 used.
1566 Conversion between "latin1", "unicode", "ucs-2", "ucs-4" and "utf-8"
1567 is done internally by Vim, 'charconvert' is not used for this.
1568 'charconvert' is also used to convert the viminfo file, if the 'c'
1569 flag is present in 'viminfo'. Also used for Unicode conversion.
1570 Example: >
1571 set charconvert=CharConvert()
1572 fun CharConvert()
1573 system("recode "
1574 \ . v:charconvert_from . ".." . v:charconvert_to
1575 \ . " <" . v:fname_in . " >" v:fname_out)
1576 return v:shell_error
1577 endfun
1578< The related Vim variables are:
1579 v:charconvert_from name of the current encoding
1580 v:charconvert_to name of the desired encoding
1581 v:fname_in name of the input file
1582 v:fname_out name of the output file
1583 Note that v:fname_in and v:fname_out will never be the same.
1584 Note that v:charconvert_from and v:charconvert_to may be different
1585 from 'encoding'. Vim internally uses UTF-8 instead of UCS-2 or UCS-4.
Bram Moolenaarf10911e2022-01-29 22:20:48 +00001586
Bram Moolenaar071d4272004-06-13 20:20:40 +00001587 Encryption is not done by Vim when using 'charconvert'. If you want
1588 to encrypt the file after conversion, 'charconvert' should take care
1589 of this.
Bram Moolenaarf10911e2022-01-29 22:20:48 +00001590
1591 If the 'charconvert' expression starts with s: or |<SID>|, then it is
1592 replaced with the script ID (|local-function|). Example: >
1593 set charconvert=s:MyConvert()
1594 set charconvert=<SID>SomeConvert()
1595< Otherwise the expression is evaluated in the context of the script
1596 where the option was set, thus script-local items are available.
1597
Bram Moolenaar071d4272004-06-13 20:20:40 +00001598 This option cannot be set from a |modeline| or in the |sandbox|, for
1599 security reasons.
1600
1601 *'cindent'* *'cin'* *'nocindent'* *'nocin'*
1602'cindent' 'cin' boolean (default off)
1603 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001604 {not available when compiled without the |+cindent|
1605 feature}
Bram Moolenaar446cb832008-06-24 21:56:24 +00001606 Enables automatic C program indenting. See 'cinkeys' to set the keys
Bram Moolenaar071d4272004-06-13 20:20:40 +00001607 that trigger reindenting in insert mode and 'cinoptions' to set your
1608 preferred indent style.
1609 If 'indentexpr' is not empty, it overrules 'cindent'.
1610 If 'lisp' is not on and both 'indentexpr' and 'equalprg' are empty,
1611 the "=" operator indents using this algorithm rather than calling an
1612 external program.
1613 See |C-indenting|.
1614 When you don't like the way 'cindent' works, try the 'smartindent'
1615 option or 'indentexpr'.
1616 This option is not used when 'paste' is set.
1617 NOTE: This option is reset when 'compatible' is set.
1618
1619 *'cinkeys'* *'cink'*
Bram Moolenaarce655742019-01-31 14:12:57 +01001620'cinkeys' 'cink' string (default "0{,0},0),0],:,0#,!^F,o,O,e")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001621 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001622 {not available when compiled without the |+cindent|
1623 feature}
1624 A list of keys that, when typed in Insert mode, cause reindenting of
1625 the current line. Only used if 'cindent' is on and 'indentexpr' is
1626 empty.
1627 For the format of this option see |cinkeys-format|.
1628 See |C-indenting|.
1629
1630 *'cinoptions'* *'cino'*
1631'cinoptions' 'cino' string (default "")
1632 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001633 {not available when compiled without the |+cindent|
1634 feature}
1635 The 'cinoptions' affect the way 'cindent' reindents lines in a C
1636 program. See |cinoptions-values| for the values of this option, and
1637 |C-indenting| for info on C indenting in general.
1638
1639
1640 *'cinwords'* *'cinw'*
1641'cinwords' 'cinw' string (default "if,else,while,do,for,switch")
1642 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001643 {not available when compiled without both the
1644 |+cindent| and the |+smartindent| features}
1645 These keywords start an extra indent in the next line when
1646 'smartindent' or 'cindent' is set. For 'cindent' this is only done at
1647 an appropriate place (inside {}).
1648 Note that 'ignorecase' isn't used for 'cinwords'. If case doesn't
1649 matter, include the keyword both the uppercase and lowercase:
1650 "if,If,IF".
1651
1652 *'clipboard'* *'cb'*
1653'clipboard' 'cb' string (default "autoselect,exclude:cons\|linux"
1654 for X-windows, "" otherwise)
1655 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001656 {only in GUI versions or when the |+xterm_clipboard|
1657 feature is included}
1658 This option is a list of comma separated names.
Bram Moolenaar942db232021-02-13 18:14:48 +01001659 Note: if one of the items is "exclude:", then you can't add an item
1660 after that. Therefore do append an item with += but use ^= to
1661 prepend, e.g.: >
1662 set clipboard^=unnamed
1663< These names are recognized:
Bram Moolenaar071d4272004-06-13 20:20:40 +00001664
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001665 *clipboard-unnamed*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001666 unnamed When included, Vim will use the clipboard register '*'
1667 for all yank, delete, change and put operations which
1668 would normally go to the unnamed register. When a
1669 register is explicitly specified, it will always be
1670 used regardless of whether "unnamed" is in 'clipboard'
1671 or not. The clipboard register can always be
1672 explicitly accessed using the "* notation. Also see
1673 |gui-clipboard|.
1674
Bram Moolenaar30b65812012-07-12 22:01:11 +02001675 *clipboard-unnamedplus*
Bram Moolenaar00154502013-02-13 16:15:55 +01001676 unnamedplus A variant of the "unnamed" flag which uses the
1677 clipboard register '+' (|quoteplus|) instead of
1678 register '*' for all yank, delete, change and put
1679 operations which would normally go to the unnamed
1680 register. When "unnamed" is also included to the
1681 option, yank operations (but not delete, change or
1682 put) will additionally copy the text into register
1683 '*'.
Bram Moolenaar81af9252010-12-10 20:35:50 +01001684 Only available with the |+X11| feature.
Bram Moolenaarbf9680e2010-12-02 21:43:16 +01001685 Availability can be checked with: >
1686 if has('unnamedplus')
1687<
Bram Moolenaar30b65812012-07-12 22:01:11 +02001688 *clipboard-autoselect*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001689 autoselect Works like the 'a' flag in 'guioptions': If present,
1690 then whenever Visual mode is started, or the Visual
1691 area extended, Vim tries to become the owner of the
1692 windowing system's global selection or put the
1693 selected text on the clipboard used by the selection
Bram Moolenaarba3ff532018-11-04 14:45:49 +01001694 register "*. See |'go-a'| and |quotestar| for details.
1695 When the GUI is active, the 'a' flag in 'guioptions'
1696 is used, when the GUI is not active, this "autoselect"
1697 flag is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001698 Also applies to the modeless selection.
1699
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001700 *clipboard-autoselectplus*
1701 autoselectplus Like "autoselect" but using the + register instead of
1702 the * register. Compare to the 'P' flag in
1703 'guioptions'.
1704
1705 *clipboard-autoselectml*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001706 autoselectml Like "autoselect", but for the modeless selection
1707 only. Compare to the 'A' flag in 'guioptions'.
1708
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001709 *clipboard-html*
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001710 html When the clipboard contains HTML, use this when
1711 pasting. When putting text on the clipboard, mark it
1712 as HTML. This works to copy rendered HTML from
1713 Firefox, paste it as raw HTML in Vim, select the HTML
1714 in Vim and paste it in a rich edit box in Firefox.
Bram Moolenaar20a825a2010-05-31 21:27:30 +02001715 You probably want to add this only temporarily,
1716 possibly use BufEnter autocommands.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001717 Only supported for GTK version 2 and later.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001718
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001719 *clipboard-exclude*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001720 exclude:{pattern}
1721 Defines a pattern that is matched against the name of
1722 the terminal 'term'. If there is a match, no
1723 connection will be made to the X server. This is
1724 useful in this situation:
1725 - Running Vim in a console.
1726 - $DISPLAY is set to start applications on another
1727 display.
1728 - You do not want to connect to the X server in the
1729 console, but do want this in a terminal emulator.
1730 To never connect to the X server use: >
1731 exclude:.*
1732< This has the same effect as using the |-X| argument.
1733 Note that when there is no connection to the X server
1734 the window title won't be restored and the clipboard
1735 cannot be accessed.
1736 The value of 'magic' is ignored, {pattern} is
1737 interpreted as if 'magic' was on.
1738 The rest of the option value will be used for
1739 {pattern}, this must be the last entry.
1740
1741 *'cmdheight'* *'ch'*
1742'cmdheight' 'ch' number (default 1)
1743 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001744 Number of screen lines to use for the command-line. Helps avoiding
1745 |hit-enter| prompts.
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00001746 The value of this option is stored with the tab page, so that each tab
1747 page can have a different value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001748
1749 *'cmdwinheight'* *'cwh'*
1750'cmdwinheight' 'cwh' number (default 7)
1751 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001752 Number of screen lines to use for the command-line window. |cmdwin|
1753
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001754 *'colorcolumn'* *'cc'*
1755'colorcolumn' 'cc' string (default "")
1756 local to window
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001757 {not available when compiled without the |+syntax|
1758 feature}
1759 'colorcolumn' is a comma separated list of screen columns that are
1760 highlighted with ColorColumn |hl-ColorColumn|. Useful to align
1761 text. Will make screen redrawing slower.
1762 The screen column can be an absolute number, or a number preceded with
1763 '+' or '-', which is added to or subtracted from 'textwidth'. >
1764
1765 :set cc=+1 " highlight column after 'textwidth'
1766 :set cc=+1,+2,+3 " highlight three columns after 'textwidth'
1767 :hi ColorColumn ctermbg=lightgrey guibg=lightgrey
1768<
1769 When 'textwidth' is zero then the items with '-' and '+' are not used.
1770 A maximum of 256 columns are highlighted.
1771
Bram Moolenaar071d4272004-06-13 20:20:40 +00001772 *'columns'* *'co'* *E594*
1773'columns' 'co' number (default 80 or terminal width)
1774 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001775 Number of columns of the screen. Normally this is set by the terminal
Bram Moolenaar7c626922005-02-07 22:01:03 +00001776 initialization and does not have to be set by hand. Also see
1777 |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001778 When Vim is running in the GUI or in a resizable window, setting this
1779 option will cause the window size to be changed. When you only want
1780 to use the size for the GUI, put the command in your |gvimrc| file.
1781 When you set this option and Vim is unable to change the physical
Bram Moolenaar02467872007-05-06 13:22:01 +00001782 number of columns of the display, the display may be messed up. For
1783 the GUI it is always possible and Vim limits the number of columns to
1784 what fits on the screen. You can use this command to get the widest
1785 window possible: >
1786 :set columns=9999
1787< Minimum value is 12, maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001788
1789 *'comments'* *'com'* *E524* *E525*
1790'comments' 'com' string (default
1791 "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-")
1792 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001793 A comma separated list of strings that can start a comment line. See
1794 |format-comments|. See |option-backslash| about using backslashes to
1795 insert a space.
1796
1797 *'commentstring'* *'cms'* *E537*
1798'commentstring' 'cms' string (default "/*%s*/")
1799 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001800 {not available when compiled without the |+folding|
1801 feature}
1802 A template for a comment. The "%s" in the value is replaced with the
1803 comment text. Currently only used to add markers for folding, see
1804 |fold-marker|.
1805
1806 *'compatible'* *'cp'* *'nocompatible'* *'nocp'*
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001807'compatible' 'cp' boolean (default on, off when a |vimrc| or |gvimrc|
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02001808 file is found, reset in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001809 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001810 This option has the effect of making Vim either more Vi-compatible, or
1811 make Vim behave in a more useful way.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001812
Bram Moolenaar071d4272004-06-13 20:20:40 +00001813 This is a special kind of option, because when it's set or reset,
Bram Moolenaar214641f2017-03-05 17:04:09 +01001814 other options are also changed as a side effect.
1815 NOTE: Setting or resetting this option can have a lot of unexpected
1816 effects: Mappings are interpreted in another way, undo behaves
1817 differently, etc. If you set this option in your vimrc file, you
1818 should probably put it at the very start.
1819
Bram Moolenaar071d4272004-06-13 20:20:40 +00001820 By default this option is on and the Vi defaults are used for the
1821 options. This default was chosen for those people who want to use Vim
1822 just like Vi, and don't even (want to) know about the 'compatible'
1823 option.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001824 When a |vimrc| or |gvimrc| file is found while Vim is starting up,
Bram Moolenaard042c562005-06-30 22:04:15 +00001825 this option is switched off, and all options that have not been
1826 modified will be set to the Vim defaults. Effectively, this means
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001827 that when a |vimrc| or |gvimrc| file exists, Vim will use the Vim
Bram Moolenaard042c562005-06-30 22:04:15 +00001828 defaults, otherwise it will use the Vi defaults. (Note: This doesn't
Bram Moolenaar02467872007-05-06 13:22:01 +00001829 happen for the system-wide vimrc or gvimrc file, nor for a file given
1830 with the |-u| argument). Also see |compatible-default| and
1831 |posix-compliance|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001832 You can also set this option with the "-C" argument, and reset it with
1833 "-N". See |-C| and |-N|.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001834 See 'cpoptions' for more fine tuning of Vi compatibility.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001835
Bram Moolenaar214641f2017-03-05 17:04:09 +01001836 When this option is set, numerous other options are set to make Vim as
1837 Vi-compatible as possible. When this option is unset, various options
1838 are set to make Vim more useful. The table below lists all the
1839 options affected.
1840 The {?} column indicates when the options are affected:
1841 + Means that the option is set to the value given in {set value} when
1842 'compatible' is set.
1843 & Means that the option is set to the value given in {set value} when
1844 'compatible' is set AND is set to its Vim default value when
1845 'compatible' is unset.
1846 - Means the option is NOT changed when setting 'compatible' but IS
1847 set to its Vim default when 'compatible' is unset.
1848 The {effect} column summarises the change when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001849
Bram Moolenaar036986f2017-03-16 17:41:02 +01001850 option ? set value effect ~
Bram Moolenaar214641f2017-03-05 17:04:09 +01001851
1852 'allowrevins' + off no CTRL-_ command
1853 'antialias' + off don't use antialiased fonts
1854 'arabic' + off reset arabic-related options
1855 'arabicshape' + on correct character shapes
1856 'backspace' + "" normal backspace
1857 'backup' + off no backup file
1858 'backupcopy' & Unix: "yes" backup file is a copy
1859 else: "auto" copy or rename backup file
1860 'balloonexpr' + "" text to show in evaluation balloon
1861 'breakindent' + off don't indent when wrapping lines
1862 'cedit' - {unchanged} {set vim default only on resetting 'cp'}
Bram Moolenaar7b1463b2021-12-11 17:24:39 +00001863 'cdhome' + off ":cd" don't chdir to home on non-Unix
Bram Moolenaar214641f2017-03-05 17:04:09 +01001864 'cindent' + off no C code indentation
1865 'compatible' - {unchanged} {set vim default only on resetting 'cp'}
1866 'copyindent' + off don't copy indent structure
1867 'cpoptions' & (all flags) Vi-compatible flags
1868 'cscopepathcomp'+ 0 don't show directories in tags list
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01001869 'cscoperelative'+ off don't use basename of path as prefix
Bram Moolenaar214641f2017-03-05 17:04:09 +01001870 'cscopetag' + off don't use cscope for ":tag"
Bram Moolenaar036986f2017-03-16 17:41:02 +01001871 'cscopetagorder'+ 0 see |cscopetagorder|
Bram Moolenaar214641f2017-03-05 17:04:09 +01001872 'cscopeverbose' + off see |cscopeverbose|
1873 'delcombine' + off unicode: delete whole char combination
1874 'digraph' + off no digraphs
1875 'esckeys' & off no <Esc>-keys in Insert mode
1876 'expandtab' + off tabs not expanded to spaces
1877 'fileformats' & "" no automatic file format detection,
Bram Moolenaar6f345a12019-12-17 21:27:18 +01001878 "dos,unix" except for MS-Windows
Bram Moolenaar214641f2017-03-05 17:04:09 +01001879 'formatexpr' + "" use 'formatprg' for auto-formatting
1880 'formatoptions' & "vt" Vi compatible formatting
1881 'gdefault' + off no default 'g' flag for ":s"
1882 'history' & 0 no commandline history
1883 'hkmap' + off no Hebrew keyboard mapping
1884 'hkmapp' + off no phonetic Hebrew keyboard mapping
1885 'hlsearch' + off no highlighting of search matches
1886 'incsearch' + off no incremental searching
1887 'indentexpr' + "" no indenting by expression
1888 'insertmode' + off do not start in Insert mode
1889 'iskeyword' & "@,48-57,_" keywords contain alphanumeric
Bram Moolenaar071d4272004-06-13 20:20:40 +00001890 characters and '_'
Bram Moolenaar214641f2017-03-05 17:04:09 +01001891 'joinspaces' + on insert 2 spaces after period
1892 'modeline' & off no modelines
1893 'more' & off no pauses in listings
1894 'mzquantum' - {unchanged} {set vim default only on resetting 'cp'}
1895 'numberwidth' & 8 min number of columns for line number
1896 'preserveindent'+ off don't preserve current indent structure
1897 when changing it
1898 'revins' + off no reverse insert
1899 'ruler' + off no ruler
1900 'scrolljump' + 1 no jump scroll
1901 'scrolloff' + 0 no scroll offset
1902 'shelltemp' - {unchanged} {set vim default only on resetting 'cp'}
1903 'shiftround' + off indent not rounded to shiftwidth
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02001904 'shortmess' & "S" no shortening of messages
Bram Moolenaar214641f2017-03-05 17:04:09 +01001905 'showcmd' & off command characters not shown
1906 'showmode' & off current mode not shown
1907 'sidescrolloff' + 0 cursor moves to edge of screen in scroll
1908 'smartcase' + off no automatic ignore case switch
1909 'smartindent' + off no smart indentation
1910 'smarttab' + off no smart tab size
1911 'softtabstop' + 0 tabs are always 'tabstop' positions
1912 'startofline' + on goto startofline with some commands
1913 'tagcase' & "followic" 'ignorecase' when searching tags file
1914 'tagrelative' & off tag file names are not relative
1915 'termguicolors' + off don't use highlight-(guifg|guibg)
1916 'textauto' & off no automatic textmode detection
1917 'textwidth' + 0 no automatic line wrap
1918 'tildeop' + off tilde is not an operator
1919 'ttimeout' + off no terminal timeout
1920 'undofile' + off don't use an undo file
Bram Moolenaar036986f2017-03-16 17:41:02 +01001921 'viminfo' - {unchanged} {set Vim default only on resetting 'cp'}
Bram Moolenaar214641f2017-03-05 17:04:09 +01001922 'virtualedit' + "" cursor can only be placed on characters
1923 'whichwrap' & "" left-right movements don't wrap
1924 'wildchar' & CTRL-E only when the current value is <Tab>
Bram Moolenaar071d4272004-06-13 20:20:40 +00001925 use CTRL-E for cmdline completion
Bram Moolenaar214641f2017-03-05 17:04:09 +01001926 'writebackup' + on or off depends on the |+writebackup| feature
Bram Moolenaar071d4272004-06-13 20:20:40 +00001927
1928 *'complete'* *'cpt'* *E535*
1929'complete' 'cpt' string (default: ".,w,b,u,t,i")
1930 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001931 This option specifies how keyword completion |ins-completion| works
1932 when CTRL-P or CTRL-N are used. It is also used for whole-line
1933 completion |i_CTRL-X_CTRL-L|. It indicates the type of completion
1934 and the places to scan. It is a comma separated list of flags:
Bram Moolenaar3848e002016-03-19 18:42:29 +01001935 . scan the current buffer ('wrapscan' is ignored)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001936 w scan buffers from other windows
1937 b scan other loaded buffers that are in the buffer list
1938 u scan the unloaded buffers that are in the buffer list
1939 U scan the buffers that are not in the buffer list
1940 k scan the files given with the 'dictionary' option
Bram Moolenaar0b238792006-03-02 22:49:12 +00001941 kspell use the currently active spell checking |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001942 k{dict} scan the file {dict}. Several "k" flags can be given,
1943 patterns are valid too. For example: >
1944 :set cpt=k/usr/dict/*,k~/spanish
1945< s scan the files given with the 'thesaurus' option
1946 s{tsr} scan the file {tsr}. Several "s" flags can be given, patterns
1947 are valid too.
1948 i scan current and included files
1949 d scan current and included files for defined name or macro
1950 |i_CTRL-X_CTRL-D|
1951 ] tag completion
1952 t same as "]"
1953
1954 Unloaded buffers are not loaded, thus their autocmds |:autocmd| are
1955 not executed, this may lead to unexpected completions from some files
1956 (gzipped files for example). Unloaded buffers are not scanned for
1957 whole-line completion.
1958
1959 The default is ".,w,b,u,t,i", which means to scan:
1960 1. the current buffer
1961 2. buffers in other windows
1962 3. other loaded buffers
1963 4. unloaded buffers
1964 5. tags
1965 6. included files
1966
1967 As you can see, CTRL-N and CTRL-P can be used to do any 'iskeyword'-
Bram Moolenaar582fd852005-03-28 20:58:01 +00001968 based expansion (e.g., dictionary |i_CTRL-X_CTRL-K|, included patterns
1969 |i_CTRL-X_CTRL-I|, tags |i_CTRL-X_CTRL-]| and normal expansions).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001970
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001971 *'completefunc'* *'cfu'*
1972'completefunc' 'cfu' string (default: empty)
1973 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02001974 {not available when compiled without the |+eval|
Bram Moolenaare2c453d2019-08-21 14:37:09 +02001975 feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00001976 This option specifies a function to be used for Insert mode completion
1977 with CTRL-X CTRL-U. |i_CTRL-X_CTRL-U|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001978 See |complete-functions| for an explanation of how the function is
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00001979 invoked and what it should return. The value can be the name of a
1980 function, a |lambda| or a |Funcref|. See |option-value-function| for
1981 more information.
Bram Moolenaar166af9b2010-11-16 20:34:40 +01001982 This option cannot be set from a |modeline| or in the |sandbox|, for
1983 security reasons.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00001984
Bram Moolenaarac3150d2019-07-28 16:36:39 +02001985 *'completeslash'* *'csl'*
1986'completeslash' 'csl' string (default: "")
1987 local to buffer
Bram Moolenaar2e693a82019-10-16 22:35:02 +02001988 {only for MS-Windows}
Bram Moolenaarac3150d2019-07-28 16:36:39 +02001989 When this option is set it overrules 'shellslash' for completion:
1990 - When this option is set to "slash", a forward slash is used for path
1991 completion in insert mode. This is useful when editing HTML tag, or
Bram Moolenaar6f345a12019-12-17 21:27:18 +01001992 Makefile with 'noshellslash' on MS-Windows.
Bram Moolenaarac3150d2019-07-28 16:36:39 +02001993 - When this option is set to "backslash", backslash is used. This is
Bram Moolenaar6f345a12019-12-17 21:27:18 +01001994 useful when editing a batch file with 'shellslash' set on MS-Windows.
Bram Moolenaarac3150d2019-07-28 16:36:39 +02001995 - When this option is empty, same character is used as for
1996 'shellslash'.
1997 For Insert mode completion the buffer-local value is used. For
1998 command line completion the global value is used.
1999
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00002000 *'completeopt'* *'cot'*
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00002001'completeopt' 'cot' string (default: "menu,preview")
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00002002 global
Bram Moolenaarc7453f52006-02-10 23:20:28 +00002003 A comma separated list of options for Insert mode completion
2004 |ins-completion|. The supported values are:
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00002005
2006 menu Use a popup menu to show the possible completions. The
2007 menu is only shown when there is more than one match and
2008 sufficient colors are available. |ins-completion-menu|
2009
Bram Moolenaar65c923a2006-03-03 22:56:30 +00002010 menuone Use the popup menu also when there is only one match.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002011 Useful when there is additional information about the
Bram Moolenaar65c923a2006-03-03 22:56:30 +00002012 match, e.g., what file it comes from.
2013
Bram Moolenaarc1e37902006-04-18 21:55:01 +00002014 longest Only insert the longest common text of the matches. If
2015 the menu is displayed you can use CTRL-L to add more
2016 characters. Whether case is ignored depends on the kind
2017 of completion. For buffer text the 'ignorecase' option is
2018 used.
Bram Moolenaarc7453f52006-02-10 23:20:28 +00002019
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00002020 preview Show extra information about the currently selected
Bram Moolenaar02467872007-05-06 13:22:01 +00002021 completion in the preview window. Only works in
2022 combination with "menu" or "menuone".
2023
Bram Moolenaar576a4a62019-08-18 15:25:17 +02002024 popup Show extra information about the currently selected
2025 completion in a popup window. Only works in combination
2026 with "menu" or "menuone". Overrides "preview".
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002027 See |'completepopup'| for specifying properties.
Bram Moolenaar2e693a82019-10-16 22:35:02 +02002028 {only works when compiled with the |+textprop| feature}
Bram Moolenaar576a4a62019-08-18 15:25:17 +02002029
Bram Moolenaardca7abe2019-10-20 18:17:57 +02002030 popuphidden
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01002031 Just like "popup" but initially hide the popup. Use a
Bram Moolenaardca7abe2019-10-20 18:17:57 +02002032 |CompleteChanged| autocommand to fetch the info and call
2033 |popup_show()| once the popup has been filled.
2034 See the example at |complete-popuphidden|.
2035 {only works when compiled with the |+textprop| feature}
2036
Bram Moolenaarb6be1e22015-07-10 18:18:40 +02002037 noinsert Do not insert any text for a match until the user selects
2038 a match from the menu. Only works in combination with
2039 "menu" or "menuone". No effect if "longest" is present.
2040
2041 noselect Do not select a match in the menu, force the user to
2042 select one from the menu. Only works in combination with
2043 "menu" or "menuone".
2044
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00002045
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002046 *'completepopup'* *'cpp'*
2047'completepopup' 'cpp' string (default empty)
2048 global
2049 {not available when compiled without the |+textprop|
2050 or |+quickfix| feature}
2051 When 'completeopt' contains "popup" then this option is used for the
Bram Moolenaar447bfba2020-07-18 16:07:16 +02002052 properties of the info popup when it is created. If an info popup
2053 window already exists it is closed, so that the option value is
2054 applied when it is created again.
2055 You can also use |popup_findinfo()| and then set properties for an
2056 existing info popup with |popup_setoptions()|. See |complete-popup|.
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002057
2058
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002059 *'concealcursor'* *'cocu'*
2060'concealcursor' 'cocu' string (default: "")
2061 local to window
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002062 {not available when compiled without the |+conceal|
2063 feature}
2064 Sets the modes in which text in the cursor line can also be concealed.
2065 When the current mode is listed then concealing happens just like in
2066 other lines.
2067 n Normal mode
2068 v Visual mode
2069 i Insert mode
Bram Moolenaarca8c9862010-07-24 15:00:38 +02002070 c Command line editing, for 'incsearch'
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002071
Bram Moolenaare6dc5732010-07-24 23:52:26 +02002072 'v' applies to all lines in the Visual area, not only the cursor.
Bram Moolenaarca8c9862010-07-24 15:00:38 +02002073 A useful value is "nc". This is used in help files. So long as you
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002074 are moving around text is concealed, but when starting to insert text
2075 or selecting a Visual area the concealed text is displayed, so that
2076 you can see what you are doing.
Bram Moolenaarf70e3d62010-07-24 13:15:07 +02002077 Keep in mind that the cursor position is not always where it's
2078 displayed. E.g., when moving vertically it may change column.
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002079
2080
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002081 *'conceallevel'* *'cole'*
2082'conceallevel' 'cole' number (default 0)
Bram Moolenaar860cae12010-06-05 23:22:07 +02002083 local to window
Bram Moolenaar860cae12010-06-05 23:22:07 +02002084 {not available when compiled without the |+conceal|
2085 feature}
Bram Moolenaar6df6f472010-07-18 18:04:50 +02002086 Determine how text with the "conceal" syntax attribute |:syn-conceal|
2087 is shown:
Bram Moolenaar860cae12010-06-05 23:22:07 +02002088
Bram Moolenaar6df6f472010-07-18 18:04:50 +02002089 Value Effect ~
Bram Moolenaar860cae12010-06-05 23:22:07 +02002090 0 Text is shown normally
Bram Moolenaar477db062010-07-28 18:17:41 +02002091 1 Each block of concealed text is replaced with one
2092 character. If the syntax item does not have a custom
2093 replacement character defined (see |:syn-cchar|) the
2094 character defined in 'listchars' is used (default is a
2095 space).
2096 It is highlighted with the "Conceal" highlight group.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002097 2 Concealed text is completely hidden unless it has a
2098 custom replacement character defined (see
Bram Moolenaar477db062010-07-28 18:17:41 +02002099 |:syn-cchar|).
Bram Moolenaara7781e02010-07-19 20:13:22 +02002100 3 Concealed text is completely hidden.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002101
Bram Moolenaara7781e02010-07-19 20:13:22 +02002102 Note: in the cursor line concealed text is not hidden, so that you can
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002103 edit and copy the text. This can be changed with the 'concealcursor'
2104 option.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002105
Bram Moolenaar071d4272004-06-13 20:20:40 +00002106 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
2107'confirm' 'cf' boolean (default off)
2108 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002109 When 'confirm' is on, certain operations that would normally
2110 fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
2111 instead raise a |dialog| asking if you wish to save the current
2112 file(s). You can still use a ! to unconditionally |abandon| a buffer.
2113 If 'confirm' is off you can still activate confirmation for one
2114 command only (this is most useful in mappings) with the |:confirm|
2115 command.
2116 Also see the |confirm()| function and the 'v' flag in 'guioptions'.
2117
2118 *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
2119'conskey' 'consk' boolean (default off)
2120 global
Bram Moolenaarf3913272016-02-25 00:00:01 +01002121 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002122
2123 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
2124'copyindent' 'ci' boolean (default off)
2125 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002126 Copy the structure of the existing lines indent when autoindenting a
2127 new line. Normally the new indent is reconstructed by a series of
2128 tabs followed by spaces as required (unless |'expandtab'| is enabled,
2129 in which case only spaces are used). Enabling this option makes the
2130 new line copy whatever characters were used for indenting on the
Bram Moolenaar446cb832008-06-24 21:56:24 +00002131 existing line. 'expandtab' has no effect on these characters, a Tab
2132 remains a Tab. If the new indent is greater than on the existing
Bram Moolenaar071d4272004-06-13 20:20:40 +00002133 line, the remaining space is filled in the normal manner.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002134 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002135 Also see 'preserveindent'.
2136
Bram Moolenaare0fa3742016-02-20 15:47:01 +01002137 *'cpoptions'* *'cpo'* *cpo*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002138'cpoptions' 'cpo' string (Vim default: "aABceFs",
2139 Vi default: all flags)
2140 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002141 A sequence of single character flags. When a character is present
Bram Moolenaar7cba6c02013-09-05 22:13:31 +02002142 this indicates Vi-compatible behavior. This is used for things where
2143 not being Vi-compatible is mostly or sometimes preferred.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002144 'cpoptions' stands for "compatible-options".
2145 Commas can be added for readability.
2146 To avoid problems with flags that are added in the future, use the
2147 "+=" and "-=" feature of ":set" |add-option-flags|.
Bram Moolenaar71eb3ad2021-12-26 12:07:30 +00002148
Bram Moolenaar071d4272004-06-13 20:20:40 +00002149 NOTE: This option is set to the Vi default value when 'compatible' is
2150 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar71eb3ad2021-12-26 12:07:30 +00002151
2152 NOTE: In a |Vim9| script, when `vim9script` is encountered, the value
2153 is saved, 'cpoptions' is set to the Vim default, and the saved value
2154 is restored at the end of the script. Changes to the value of
2155 'cpoptions' will be applied to the saved value, but keep in mind that
2156 removing a flag that is not present when 'cpoptions' is changed has no
2157 effect. In the |.vimrc| file the value is not restored, thus using
2158 `vim9script` in the |.vimrc| file results in using the Vim default.
2159
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002160 NOTE: This option is set to the POSIX default value at startup when
2161 the Vi default value would be used and the $VIM_POSIX environment
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002162 variable exists |posix|. This means Vim tries to behave like the
2163 POSIX specification.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002164
2165 contains behavior ~
2166 *cpo-a*
2167 a When included, a ":read" command with a file name
2168 argument will set the alternate file name for the
2169 current window.
2170 *cpo-A*
2171 A When included, a ":write" command with a file name
2172 argument will set the alternate file name for the
2173 current window.
2174 *cpo-b*
2175 b "\|" in a ":map" command is recognized as the end of
2176 the map command. The '\' is included in the mapping,
2177 the text after the '|' is interpreted as the next
2178 command. Use a CTRL-V instead of a backslash to
2179 include the '|' in the mapping. Applies to all
2180 mapping, abbreviation, menu and autocmd commands.
2181 See also |map_bar|.
2182 *cpo-B*
2183 B A backslash has no special meaning in mappings,
Bram Moolenaara9604e62018-07-21 05:56:22 +02002184 abbreviations, user commands and the "to" part of the
2185 menu commands. Remove this flag to be able to use a
2186 backslash like a CTRL-V. For example, the command
2187 ":map X \<Esc>" results in X being mapped to:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002188 'B' included: "\^[" (^[ is a real <Esc>)
2189 'B' excluded: "<Esc>" (5 characters)
2190 ('<' excluded in both cases)
2191 *cpo-c*
2192 c Searching continues at the end of any match at the
2193 cursor position, but not further than the start of the
2194 next line. When not present searching continues
2195 one character from the cursor position. With 'c'
2196 "abababababab" only gets three matches when repeating
2197 "/abab", without 'c' there are five matches.
2198 *cpo-C*
2199 C Do not concatenate sourced lines that start with a
2200 backslash. See |line-continuation|.
2201 *cpo-d*
2202 d Using "./" in the 'tags' option doesn't mean to use
2203 the tags file relative to the current file, but the
2204 tags file in the current directory.
2205 *cpo-D*
2206 D Can't use CTRL-K to enter a digraph after Normal mode
2207 commands with a character argument, like |r|, |f| and
2208 |t|.
2209 *cpo-e*
2210 e When executing a register with ":@r", always add a
2211 <CR> to the last line, also when the register is not
2212 linewise. If this flag is not present, the register
2213 is not linewise and the last line does not end in a
2214 <CR>, then the last line is put on the command-line
2215 and can be edited before hitting <CR>.
2216 *cpo-E*
2217 E It is an error when using "y", "d", "c", "g~", "gu" or
2218 "gU" on an Empty region. The operators only work when
Bram Moolenaar15142e22018-04-30 22:19:58 +02002219 at least one character is to be operated on. Example:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002220 This makes "y0" fail in the first column.
2221 *cpo-f*
2222 f When included, a ":read" command with a file name
2223 argument will set the file name for the current buffer,
2224 if the current buffer doesn't have a file name yet.
2225 *cpo-F*
2226 F When included, a ":write" command with a file name
2227 argument will set the file name for the current
2228 buffer, if the current buffer doesn't have a file name
Bram Moolenaarb3480382005-12-11 21:33:32 +00002229 yet. Also see |cpo-P|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002230 *cpo-g*
2231 g Goto line 1 when using ":edit" without argument.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002232 *cpo-H*
2233 H When using "I" on a line with only blanks, insert
2234 before the last blank. Without this flag insert after
2235 the last blank.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002236 *cpo-i*
2237 i When included, interrupting the reading of a file will
2238 leave it modified.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002239 *cpo-I*
2240 I When moving the cursor up or down just after inserting
2241 indent for 'autoindent', do not delete the indent.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002242 *cpo-j*
2243 j When joining lines, only add two spaces after a '.',
2244 not after '!' or '?'. Also see 'joinspaces'.
2245 *cpo-J*
2246 J A |sentence| has to be followed by two spaces after
Bram Moolenaar582fd852005-03-28 20:58:01 +00002247 the '.', '!' or '?'. A <Tab> is not recognized as
Bram Moolenaar071d4272004-06-13 20:20:40 +00002248 white space.
2249 *cpo-k*
2250 k Disable the recognition of raw key codes in
2251 mappings, abbreviations, and the "to" part of menu
2252 commands. For example, if <Key> sends ^[OA (where ^[
2253 is <Esc>), the command ":map X ^[OA" results in X
2254 being mapped to:
2255 'k' included: "^[OA" (3 characters)
2256 'k' excluded: "<Key>" (one key code)
2257 Also see the '<' flag below.
2258 *cpo-K*
2259 K Don't wait for a key code to complete when it is
2260 halfway a mapping. This breaks mapping <F1><F1> when
2261 only part of the second <F1> has been read. It
2262 enables cancelling the mapping by typing <F1><Esc>.
2263 *cpo-l*
2264 l Backslash in a [] range in a search pattern is taken
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002265 literally, only "\]", "\^", "\-" and "\\" are special.
2266 See |/[]|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002267 'l' included: "/[ \t]" finds <Space>, '\' and 't'
2268 'l' excluded: "/[ \t]" finds <Space> and <Tab>
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002269 Also see |cpo-\|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002270 *cpo-L*
2271 L When the 'list' option is set, 'wrapmargin',
2272 'textwidth', 'softtabstop' and Virtual Replace mode
2273 (see |gR|) count a <Tab> as two characters, instead of
2274 the normal behavior of a <Tab>.
2275 *cpo-m*
2276 m When included, a showmatch will always wait half a
2277 second. When not included, a showmatch will wait half
2278 a second or until a character is typed. |'showmatch'|
2279 *cpo-M*
2280 M When excluded, "%" matching will take backslashes into
2281 account. Thus in "( \( )" and "\( ( \)" the outer
2282 parenthesis match. When included "%" ignores
2283 backslashes, which is Vi compatible.
2284 *cpo-n*
Bram Moolenaar64486672010-05-16 15:46:46 +02002285 n When included, the column used for 'number' and
2286 'relativenumber' will also be used for text of wrapped
2287 lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002288 *cpo-o*
2289 o Line offset to search command is not remembered for
2290 next search.
2291 *cpo-O*
2292 O Don't complain if a file is being overwritten, even
2293 when it didn't exist when editing it. This is a
2294 protection against a file unexpectedly created by
2295 someone else. Vi didn't complain about this.
2296 *cpo-p*
2297 p Vi compatible Lisp indenting. When not present, a
2298 slightly better algorithm is used.
Bram Moolenaarb3480382005-12-11 21:33:32 +00002299 *cpo-P*
2300 P When included, a ":write" command that appends to a
2301 file will set the file name for the current buffer, if
2302 the current buffer doesn't have a file name yet and
2303 the 'F' flag is also included |cpo-F|.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002304 *cpo-q*
2305 q When joining multiple lines leave the cursor at the
2306 position where it would be when joining two lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002307 *cpo-r*
2308 r Redo ("." command) uses "/" to repeat a search
2309 command, instead of the actually used search string.
2310 *cpo-R*
2311 R Remove marks from filtered lines. Without this flag
2312 marks are kept like |:keepmarks| was used.
2313 *cpo-s*
2314 s Set buffer options when entering the buffer for the
2315 first time. This is like it is in Vim version 3.0.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002316 And it is the default. If not present the options are
Bram Moolenaar071d4272004-06-13 20:20:40 +00002317 set when the buffer is created.
2318 *cpo-S*
2319 S Set buffer options always when entering a buffer
2320 (except 'readonly', 'fileformat', 'filetype' and
2321 'syntax'). This is the (most) Vi compatible setting.
2322 The options are set to the values in the current
2323 buffer. When you change an option and go to another
2324 buffer, the value is copied. Effectively makes the
2325 buffer options global to all buffers.
2326
2327 's' 'S' copy buffer options
2328 no no when buffer created
2329 yes no when buffer first entered (default)
2330 X yes each time when buffer entered (vi comp.)
2331 *cpo-t*
2332 t Search pattern for the tag command is remembered for
2333 "n" command. Otherwise Vim only puts the pattern in
2334 the history for search pattern, but doesn't change the
2335 last used search pattern.
2336 *cpo-u*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002337 u Undo is Vi compatible. See |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002338 *cpo-v*
2339 v Backspaced characters remain visible on the screen in
2340 Insert mode. Without this flag the characters are
2341 erased from the screen right away. With this flag the
2342 screen newly typed text overwrites backspaced
2343 characters.
2344 *cpo-w*
2345 w When using "cw" on a blank character, only change one
2346 character and not all blanks until the start of the
2347 next word.
2348 *cpo-W*
2349 W Don't overwrite a readonly file. When omitted, ":w!"
2350 overwrites a readonly file, if possible.
2351 *cpo-x*
2352 x <Esc> on the command-line executes the command-line.
2353 The default in Vim is to abandon the command-line,
2354 because <Esc> normally aborts a command. |c_<Esc>|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002355 *cpo-X*
2356 X When using a count with "R" the replaced text is
2357 deleted only once. Also when repeating "R" with "."
2358 and a count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002359 *cpo-y*
Bram Moolenaard09091d2019-01-17 16:07:22 +01002360 y A yank command can be redone with ".". Think twice if
2361 you really want to use this, it may break some
2362 plugins, since most people expect "." to only repeat a
2363 change.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002364 *cpo-Z*
2365 Z When using "w!" while the 'readonly' option is set,
2366 don't reset 'readonly'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002367 *cpo-!*
2368 ! When redoing a filter command, use the last used
2369 external command, whatever it was. Otherwise the last
2370 used -filter- command is used.
2371 *cpo-$*
2372 $ When making a change to one line, don't redisplay the
2373 line, but put a '$' at the end of the changed text.
2374 The changed text will be overwritten when you type the
2375 new text. The line is redisplayed if you type any
2376 command that moves the cursor from the insertion
2377 point.
2378 *cpo-%*
2379 % Vi-compatible matching is done for the "%" command.
2380 Does not recognize "#if", "#endif", etc.
2381 Does not recognize "/*" and "*/".
2382 Parens inside single and double quotes are also
2383 counted, causing a string that contains a paren to
2384 disturb the matching. For example, in a line like
2385 "if (strcmp("foo(", s))" the first paren does not
2386 match the last one. When this flag is not included,
2387 parens inside single and double quotes are treated
2388 specially. When matching a paren outside of quotes,
2389 everything inside quotes is ignored. When matching a
2390 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002391 there is one). This works very well for C programs.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002392 This flag is also used for other features, such as
2393 C-indenting.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002394 *cpo--*
2395 - When included, a vertical movement command fails when
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002396 it would go above the first line or below the last
2397 line. Without it the cursor moves to the first or
2398 last line, unless it already was in that line.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002399 Applies to the commands "-", "k", CTRL-P, "+", "j",
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002400 CTRL-N, CTRL-J and ":1234".
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002401 *cpo-+*
2402 + When included, a ":write file" command will reset the
2403 'modified' flag of the buffer, even though the buffer
2404 itself may still be different from its file.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002405 *cpo-star*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002406 * Use ":*" in the same way as ":@". When not included,
2407 ":*" is an alias for ":'<,'>", select the Visual area.
2408 *cpo-<*
2409 < Disable the recognition of special key codes in |<>|
2410 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002411 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00002412 ":map X <Tab>" results in X being mapped to:
2413 '<' included: "<Tab>" (5 characters)
2414 '<' excluded: "^I" (^I is a real <Tab>)
2415 Also see the 'k' flag above.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002416 *cpo->*
2417 > When appending to a register, put a line break before
2418 the appended text.
Bram Moolenaar8b3e0332011-06-26 05:36:34 +02002419 *cpo-;*
2420 ; When using |,| or |;| to repeat the last |t| search
2421 and the cursor is right in front of the searched
2422 character, the cursor won't move. When not included,
2423 the cursor would skip over it and jump to the
Bram Moolenaarc8734422012-06-01 22:38:45 +02002424 following occurrence.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002425
2426 POSIX flags. These are not included in the Vi default value, except
2427 when $VIM_POSIX was set on startup. |posix|
2428
2429 contains behavior ~
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002430 *cpo-#*
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002431 # A count before "D", "o" and "O" has no effect.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002432 *cpo-&*
2433 & When ":preserve" was used keep the swap file when
2434 exiting normally while this buffer is still loaded.
2435 This flag is tested when exiting.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002436 *cpo-\*
2437 \ Backslash in a [] range in a search pattern is taken
2438 literally, only "\]" is special See |/[]|
Bram Moolenaar90915b52005-08-21 22:17:52 +00002439 '\' included: "/[ \-]" finds <Space>, '\' and '-'
2440 '\' excluded: "/[ \-]" finds <Space> and '-'
2441 Also see |cpo-l|.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002442 *cpo-/*
2443 / When "%" is used as the replacement string in a |:s|
2444 command, use the previous replacement string. |:s%|
2445 *cpo-{*
2446 { The |{| and |}| commands also stop at a "{" character
2447 at the start of a line.
2448 *cpo-.*
2449 . The ":chdir" and ":cd" commands fail if the current
2450 buffer is modified, unless ! is used. Vim doesn't
2451 need this, since it remembers the full path of an
2452 opened file.
2453 *cpo-bar*
2454 | The value of the $LINES and $COLUMNS environment
2455 variables overrule the terminal size values obtained
2456 with system specific functions.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002457
Bram Moolenaar071d4272004-06-13 20:20:40 +00002458
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002459 *'cryptmethod'* *'cm'*
Bram Moolenaara86187b2018-12-16 18:20:00 +01002460'cryptmethod' 'cm' string (default "blowfish2")
Bram Moolenaar49771f42010-07-20 17:32:38 +02002461 global or local to buffer |global-local|
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002462 Method used for encryption when the buffer is written to a file:
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002463 *pkzip*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002464 zip PkZip compatible method. A weak kind of encryption.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002465 Backwards compatible with Vim 7.2 and older.
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002466 *blowfish*
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002467 blowfish Blowfish method. Medium strong encryption but it has
2468 an implementation flaw. Requires Vim 7.3 or later,
2469 files can NOT be read by Vim 7.2 and older. This adds
2470 a "seed" to the file, every time you write the file
2471 the encrypted bytes will be different.
2472 *blowfish2*
2473 blowfish2 Blowfish method. Medium strong encryption. Requires
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01002474 Vim 7.4.401 or later, files can NOT be read by Vim 7.3
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002475 and older. This adds a "seed" to the file, every time
2476 you write the file the encrypted bytes will be
2477 different. The whole undo file is encrypted, not just
2478 the pieces of text.
Christian Brabandtf573c6e2021-06-20 14:02:16 +02002479 *E1193* *E1194* *E1195* *E1196*
2480 *E1197* *E1198* *E1199* *E1200* *E1201*
2481 xchacha20 XChaCha20 Cipher with Poly1305 Message Authentication
2482 Code. Medium strong till strong encryption.
2483 Encryption is provided by the libsodium library, it
Bram Moolenaar22863042021-10-16 15:23:36 +01002484 requires Vim to be built with |+sodium|.
Christian Brabandtf573c6e2021-06-20 14:02:16 +02002485 It adds a seed and a message authentication code (MAC)
2486 to the file. This needs at least a Vim 8.2.3022 to
2487 read the encrypted file.
2488 Encryption of swap files is not supported, therefore
2489 no swap file will be used when xchacha20 encryption is
2490 enabled.
2491 Encryption of undo files is not yet supported,
2492 therefore no undo file will currently be written.
2493 CURRENTLY EXPERIMENTAL: Files written with this method
2494 might have to be read back with the same version of
2495 Vim if the binary format changes later.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002496
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01002497 You should use "blowfish2", also to re-encrypt older files.
2498
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002499 When reading an encrypted file 'cryptmethod' will be set automatically
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002500 to the detected method of the file being read. Thus if you write it
2501 without changing 'cryptmethod' the same method will be used.
2502 Changing 'cryptmethod' does not mark the file as modified, you have to
Bram Moolenaar49771f42010-07-20 17:32:38 +02002503 explicitly write it, you don't get a warning unless there are other
2504 modifications. Also see |:X|.
2505
2506 When setting the global value to an empty string, it will end up with
Bram Moolenaara86187b2018-12-16 18:20:00 +01002507 the value "blowfish2". When setting the local value to an empty
2508 string the buffer will use the global value.
Bram Moolenaar49771f42010-07-20 17:32:38 +02002509
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002510 When a new encryption method is added in a later version of Vim, and
2511 the current version does not recognize it, you will get *E821* .
Bram Moolenaar49771f42010-07-20 17:32:38 +02002512 You need to edit this file with the later version of Vim.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002513
2514
Bram Moolenaar071d4272004-06-13 20:20:40 +00002515 *'cscopepathcomp'* *'cspc'*
2516'cscopepathcomp' 'cspc' number (default 0)
2517 global
2518 {not available when compiled without the |+cscope|
2519 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002520 Determines how many components of the path to show in a list of tags.
2521 See |cscopepathcomp|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002522 NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002523
2524 *'cscopeprg'* *'csprg'*
2525'cscopeprg' 'csprg' string (default "cscope")
2526 global
2527 {not available when compiled without the |+cscope|
2528 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002529 Specifies the command to execute cscope. See |cscopeprg|.
2530 This option cannot be set from a |modeline| or in the |sandbox|, for
2531 security reasons.
2532
2533 *'cscopequickfix'* *'csqf'*
2534'cscopequickfix' 'csqf' string (default "")
2535 global
2536 {not available when compiled without the |+cscope|
2537 or |+quickfix| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002538 Specifies whether to use quickfix window to show cscope results.
2539 See |cscopequickfix|.
2540
Bram Moolenaarec7944a2013-06-12 21:29:15 +02002541 *'cscoperelative'* *'csre'* *'nocscoperelative'* *'nocsre'*
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002542'cscoperelative' 'csre' boolean (default off)
2543 global
2544 {not available when compiled without the |+cscope|
2545 feature}
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002546 In the absence of a prefix (-P) for cscope. setting this option enables
2547 to use the basename of cscope.out path as the prefix.
2548 See |cscoperelative|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002549 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002550
Bram Moolenaar071d4272004-06-13 20:20:40 +00002551 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
2552'cscopetag' 'cst' boolean (default off)
2553 global
2554 {not available when compiled without the |+cscope|
2555 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002556 Use cscope for tag commands. See |cscope-options|.
2557 NOTE: This option is reset when 'compatible' is set.
2558
2559 *'cscopetagorder'* *'csto'*
2560'cscopetagorder' 'csto' number (default 0)
2561 global
2562 {not available when compiled without the |+cscope|
2563 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002564 Determines the order in which ":cstag" performs a search. See
2565 |cscopetagorder|.
2566 NOTE: This option is set to 0 when 'compatible' is set.
2567
2568 *'cscopeverbose'* *'csverb'*
2569 *'nocscopeverbose'* *'nocsverb'*
2570'cscopeverbose' 'csverb' boolean (default off)
2571 global
2572 {not available when compiled without the |+cscope|
2573 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002574 Give messages when adding a cscope database. See |cscopeverbose|.
2575 NOTE: This option is reset when 'compatible' is set.
2576
Bram Moolenaar860cae12010-06-05 23:22:07 +02002577 *'cursorbind'* *'crb'* *'nocursorbind'* *'nocrb'*
2578'cursorbind' 'crb' boolean (default off)
2579 local to window
Bram Moolenaar860cae12010-06-05 23:22:07 +02002580 When this option is set, as the cursor in the current
2581 window moves other cursorbound windows (windows that also have
2582 this option set) move their cursors to the corresponding line and
2583 column. This option is useful for viewing the
2584 differences between two versions of a file (see 'diff'); in diff mode,
2585 inserted and deleted lines (though not characters within a line) are
Bram Moolenaar1a384422010-07-14 19:53:30 +02002586 taken into account.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002587
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002588
2589 *'cursorcolumn'* *'cuc'* *'nocursorcolumn'* *'nocuc'*
2590'cursorcolumn' 'cuc' boolean (default off)
2591 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02002592 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002593 feature}
2594 Highlight the screen column of the cursor with CursorColumn
2595 |hl-CursorColumn|. Useful to align text. Will make screen redrawing
2596 slower.
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00002597 If you only want the highlighting in the current window you can use
2598 these autocommands: >
2599 au WinLeave * set nocursorline nocursorcolumn
2600 au WinEnter * set cursorline cursorcolumn
2601<
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002602
2603 *'cursorline'* *'cul'* *'nocursorline'* *'nocul'*
2604'cursorline' 'cul' boolean (default off)
2605 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02002606 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002607 feature}
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002608 Highlight the text line of the cursor with CursorLine |hl-CursorLine|.
2609 Useful to easily spot the cursor. Will make screen redrawing slower.
Bram Moolenaare2f98b92006-03-29 21:18:24 +00002610 When Visual mode is active the highlighting isn't used to make it
Bram Moolenaar779b74b2006-04-10 14:55:34 +00002611 easier to see the selected text.
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002612
2613
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002614 *'cursorlineopt'* *'culopt'*
Bram Moolenaar017ba072019-09-14 21:01:23 +02002615'cursorlineopt' 'culopt' string (default: "number,line")
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002616 local to window
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002617 {not available when compiled without the |+syntax|
2618 feature}
Bram Moolenaar017ba072019-09-14 21:01:23 +02002619 Comma separated list of settings for how 'cursorline' is displayed.
2620 Valid values:
2621 "line" Highlight the text line of the cursor with
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002622 CursorLine |hl-CursorLine|.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002623 "screenline" Highlight only the screen line of the cursor with
2624 CursorLine |hl-CursorLine|.
2625 "number" Highlight the line number of the cursor with
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002626 CursorLineNr |hl-CursorLineNr|.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002627
2628 Special value:
2629 "both" Alias for the values "line,number".
2630
2631 "line" and "screenline" cannot be used together.
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002632
2633
Bram Moolenaar071d4272004-06-13 20:20:40 +00002634 *'debug'*
2635'debug' string (default "")
2636 global
Bram Moolenaar57657d82006-04-21 22:12:41 +00002637 These values can be used:
2638 msg Error messages that would otherwise be omitted will be given
2639 anyway.
2640 throw Error messages that would otherwise be omitted will be given
2641 anyway and also throw an exception and set |v:errmsg|.
2642 beep A message will be given when otherwise only a beep would be
2643 produced.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002644 The values can be combined, separated by a comma.
Bram Moolenaar57657d82006-04-21 22:12:41 +00002645 "msg" and "throw" are useful for debugging 'foldexpr', 'formatexpr' or
2646 'indentexpr'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002647
2648 *'define'* *'def'*
2649'define' 'def' string (default "^\s*#\s*define")
2650 global or local to buffer |global-local|
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002651 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002652 pattern, just like for the "/" command. This option is used for the
2653 commands like "[i" and "[d" |include-search|. The 'isident' option is
2654 used to recognize the defined name after the match:
2655 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2656 See |option-backslash| about inserting backslashes to include a space
2657 or backslash.
2658 The default value is for C programs. For C++ this value would be
2659 useful, to include const type declarations: >
2660 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
Bram Moolenaar63b74a82019-03-24 15:09:13 +01002661< You can also use "\ze" just before the name and continue the pattern
2662 to check what is following. E.g. for Javascript, if a function is
2663 defined with "func_name = function(args)": >
2664 ^\s*\ze\i\+\s*=\s*function(
2665< If the function is defined with "func_name : function() {...": >
2666 ^\s*\ze\i\+\s*[:]\s*(*function\s*(
Bram Moolenaar071d4272004-06-13 20:20:40 +00002667< When using the ":set" command, you need to double the backslashes!
Bram Moolenaar63b74a82019-03-24 15:09:13 +01002668 To avoid that use `:let` with a single quote string: >
2669 let &l:define = '^\s*\ze\k\+\s*=\s*function('
Bram Moolenaar911ead12019-04-21 00:03:35 +02002670<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002671
2672 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2673'delcombine' 'deco' boolean (default off)
2674 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002675 If editing Unicode and this option is set, backspace and Normal mode
2676 "x" delete each combining character on its own. When it is off (the
2677 default) the character along with its combining characters are
2678 deleted.
Bram Moolenaar4f4d51a2020-10-11 13:57:40 +02002679 Note: When 'delcombine' is set "xx" may work differently from "2x"!
Bram Moolenaar071d4272004-06-13 20:20:40 +00002680
2681 This is useful for Arabic, Hebrew and many other languages where one
2682 may have combining characters overtop of base characters, and want
2683 to remove only the combining ones.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002684 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002685
2686 *'dictionary'* *'dict'*
2687'dictionary' 'dict' string (default "")
2688 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002689 List of file names, separated by commas, that are used to lookup words
2690 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2691 contain a list of words. This can be one word per line, or several
2692 words per line, separated by non-keyword characters (white space is
2693 preferred). Maximum line length is 510 bytes.
Bram Moolenaar259f26a2018-05-15 22:25:40 +02002694
2695 When this option is empty or an entry "spell" is present, and spell
2696 checking is enabled, words in the word lists for the currently active
2697 'spelllang' are used. See |spell|.
2698
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002699 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002700 after a comma are ignored, otherwise spaces are included in the file
2701 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002702 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002703 Where to find a list of words?
2704 - On FreeBSD, there is the file "/usr/share/dict/words".
2705 - In the Simtel archive, look in the "msdos/linguist" directory.
2706 - In "miscfiles" of the GNU collection.
2707 The use of |:set+=| and |:set-=| is preferred when adding or removing
2708 directories from the list. This avoids problems when a future version
2709 uses another default.
2710 Backticks cannot be used in this option for security reasons.
2711
2712 *'diff'* *'nodiff'*
2713'diff' boolean (default off)
2714 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00002715 {not available when compiled without the |+diff|
2716 feature}
2717 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002718 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002719
2720 *'dex'* *'diffexpr'*
2721'diffexpr' 'dex' string (default "")
2722 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002723 {not available when compiled without the |+diff|
2724 feature}
Bram Moolenaare828b762018-09-10 17:51:58 +02002725 Expression which is evaluated to obtain a diff file (either ed-style
2726 or unified-style) from two versions of a file. See |diff-diffexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002727 This option cannot be set from a |modeline| or in the |sandbox|, for
2728 security reasons.
2729
2730 *'dip'* *'diffopt'*
Bram Moolenaarc8234772019-11-10 21:00:27 +01002731'diffopt' 'dip' string (default "internal,filler,closeoff")
Bram Moolenaar071d4272004-06-13 20:20:40 +00002732 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002733 {not available when compiled without the |+diff|
2734 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002735 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002736 All are optional. Items must be separated by a comma.
2737
2738 filler Show filler lines, to keep the text
2739 synchronized with a window that has inserted
2740 lines at the same position. Mostly useful
2741 when windows are side-by-side and 'scrollbind'
2742 is set.
2743
2744 context:{n} Use a context of {n} lines between a change
2745 and a fold that contains unchanged lines.
2746 When omitted a context of six lines is used.
Bram Moolenaarf6b40102019-02-22 15:24:03 +01002747 When using zero the context is actually one,
2748 since folds require a line in between, also
2749 for a deleted line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002750 See |fold-diff|.
2751
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002752 iblank Ignore changes where lines are all blank. Adds
2753 the "-B" flag to the "diff" command if
2754 'diffexpr' is empty. Check the documentation
2755 of the "diff" command for what this does
2756 exactly.
2757 NOTE: the diff windows will get out of sync,
2758 because no differences between blank lines are
2759 taken into account.
2760
Bram Moolenaar071d4272004-06-13 20:20:40 +00002761 icase Ignore changes in case of text. "a" and "A"
2762 are considered the same. Adds the "-i" flag
2763 to the "diff" command if 'diffexpr' is empty.
2764
2765 iwhite Ignore changes in amount of white space. Adds
2766 the "-b" flag to the "diff" command if
2767 'diffexpr' is empty. Check the documentation
2768 of the "diff" command for what this does
2769 exactly. It should ignore adding trailing
2770 white space, but not leading white space.
2771
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002772 iwhiteall Ignore all white space changes. Adds
2773 the "-w" flag to the "diff" command if
2774 'diffexpr' is empty. Check the documentation
2775 of the "diff" command for what this does
2776 exactly.
2777
2778 iwhiteeol Ignore white space changes at end of line.
2779 Adds the "-Z" flag to the "diff" command if
2780 'diffexpr' is empty. Check the documentation
2781 of the "diff" command for what this does
2782 exactly.
2783
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002784 horizontal Start diff mode with horizontal splits (unless
2785 explicitly specified otherwise).
2786
2787 vertical Start diff mode with vertical splits (unless
2788 explicitly specified otherwise).
2789
Bram Moolenaarc8234772019-11-10 21:00:27 +01002790 closeoff When a window is closed where 'diff' is set
2791 and there is only one window remaining in the
2792 same tab page with 'diff' set, execute
2793 `:diffoff` in that window. This undoes a
2794 `:diffsplit` command.
2795
Bram Moolenaar97ce4192017-12-01 20:35:58 +01002796 hiddenoff Do not use diff mode for a buffer when it
2797 becomes hidden.
2798
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002799 foldcolumn:{n} Set the 'foldcolumn' option to {n} when
2800 starting diff mode. Without this 2 is used.
2801
Bram Moolenaar4223d432021-02-10 13:18:17 +01002802 followwrap Follow the 'wrap' option and leave as it is.
2803
Bram Moolenaare828b762018-09-10 17:51:58 +02002804 internal Use the internal diff library. This is
2805 ignored when 'diffexpr' is set. *E960*
2806 When running out of memory when writing a
2807 buffer this item will be ignored for diffs
2808 involving that buffer. Set the 'verbose'
2809 option to see when this happens.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002810
Bram Moolenaare828b762018-09-10 17:51:58 +02002811 indent-heuristic
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01002812 Use the indent heuristic for the internal
2813 diff library.
Bram Moolenaare828b762018-09-10 17:51:58 +02002814
2815 algorithm:{text} Use the specified diff algorithm with the
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01002816 internal diff engine. Currently supported
Bram Moolenaare828b762018-09-10 17:51:58 +02002817 algorithms are:
2818 myers the default algorithm
2819 minimal spend extra time to generate the
2820 smallest possible diff
2821 patience patience diff algorithm
2822 histogram histogram diff algorithm
2823
2824 Examples: >
2825 :set diffopt=internal,filler,context:4
Bram Moolenaar071d4272004-06-13 20:20:40 +00002826 :set diffopt=
Bram Moolenaare828b762018-09-10 17:51:58 +02002827 :set diffopt=internal,filler,foldcolumn:3
2828 :set diffopt-=internal " do NOT use the internal diff parser
Bram Moolenaar071d4272004-06-13 20:20:40 +00002829<
2830 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
2831'digraph' 'dg' boolean (default off)
2832 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002833 {not available when compiled without the |+digraphs|
2834 feature}
2835 Enable the entering of digraphs in Insert mode with {char1} <BS>
2836 {char2}. See |digraphs|.
2837 NOTE: This option is reset when 'compatible' is set.
2838
2839 *'directory'* *'dir'*
2840'directory' 'dir' string (default for Amiga: ".,t:",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01002841 for Win32: ".,$TEMP,c:\tmp,c:\temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00002842 for Unix: ".,~/tmp,/var/tmp,/tmp")
2843 global
2844 List of directory names for the swap file, separated with commas.
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02002845 Recommended value: ".,~/vimswap//" - this will put the swap file next
2846 to the edited file if possible, and in your personal swap directory
2847 otherwise. Make sure "~/vimswap//" is only readable for you.
2848
2849 Possible items:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002850 - The swap file will be created in the first directory where this is
2851 possible.
2852 - Empty means that no swap file will be used (recovery is
Bram Moolenaar00e192b2019-10-19 17:01:28 +02002853 impossible!) and no |E303| error will be given.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002854 - A directory "." means to put the swap file in the same directory as
2855 the edited file. On Unix, a dot is prepended to the file name, so
2856 it doesn't show in a directory listing. On MS-Windows the "hidden"
2857 attribute is set and a dot prepended if possible.
Bram Moolenaar8024f932020-01-14 19:29:13 +01002858 - A directory starting with "./" (or ".\" for MS-Windows) means to put
2859 the swap file relative to where the edited file is. The leading "."
2860 is replaced with the path name of the edited file.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02002861 - For Unix and Win32, if a directory ends in two path separators "//",
2862 the swap file name will be built from the complete path to the file
Bram Moolenaar207f0092020-08-30 17:20:20 +02002863 with all path separators replaced by percent '%' signs (including
2864 the colon following the drive letter on Win32). This will ensure
2865 file name uniqueness in the preserve directory.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02002866 On Win32, it is also possible to end with "\\". However, When a
2867 separating comma is following, you must use "//", since "\\" will
2868 include the comma in the file name. Therefore it is recommended to
2869 use '//', instead of '\\'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002870 - Spaces after the comma are ignored, other spaces are considered part
2871 of the directory name. To have a space at the start of a directory
2872 name, precede it with a backslash.
2873 - To include a comma in a directory name precede it with a backslash.
2874 - A directory name may end in an ':' or '/'.
2875 - Environment variables are expanded |:set_env|.
2876 - Careful with '\' characters, type one before a space, type two to
2877 get one in the option (see |option-backslash|), for example: >
2878 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
2879< - For backwards compatibility with Vim version 3.0 a '>' at the start
2880 of the option is removed.
2881 Using "." first in the list is recommended. This means that editing
2882 the same file twice will result in a warning. Using "/tmp" on Unix is
2883 discouraged: When the system crashes you lose the swap file.
2884 "/var/tmp" is often not cleared when rebooting, thus is a better
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02002885 choice than "/tmp". But others on the computer may be able to see the
2886 files, and it can contain a lot of files, your swap files get lost in
2887 the crowd. That is why a "tmp" directory in your home directory is
2888 tried first.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002889 The use of |:set+=| and |:set-=| is preferred when adding or removing
2890 directories from the list. This avoids problems when a future version
2891 uses another default.
2892 This option cannot be set from a |modeline| or in the |sandbox|, for
2893 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002894
2895 *'display'* *'dy'*
Bram Moolenaarbc8801c2016-08-02 21:04:33 +02002896'display' 'dy' string (default "", set to "truncate" in
2897 |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002898 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002899 Change the way text is displayed. This is comma separated list of
2900 flags:
2901 lastline When included, as much as possible of the last line
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02002902 in a window will be displayed. "@@@" is put in the
2903 last columns of the last screen line to indicate the
2904 rest of the line is not displayed.
2905 truncate Like "lastline", but "@@@" is displayed in the first
2906 column of the last screen line. Overrules "lastline".
Bram Moolenaar071d4272004-06-13 20:20:40 +00002907 uhex Show unprintable characters hexadecimal as <xx>
2908 instead of using ^C and ~C.
2909
Bram Moolenaard0796902016-09-16 20:02:31 +02002910 When neither "lastline" nor "truncate" is included, a last line that
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02002911 doesn't fit is replaced with "@" lines.
2912
Bram Moolenaar071d4272004-06-13 20:20:40 +00002913 *'eadirection'* *'ead'*
2914'eadirection' 'ead' string (default "both")
2915 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002916 Tells when the 'equalalways' option applies:
2917 ver vertically, width of windows is not affected
2918 hor horizontally, height of windows is not affected
2919 both width and height of windows is affected
2920
2921 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
2922'edcompatible' 'ed' boolean (default off)
2923 global
2924 Makes the 'g' and 'c' flags of the ":substitute" command to be
2925 toggled each time the flag is given. See |complex-change|. See
2926 also 'gdefault' option.
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +02002927 Switching this option on may break plugins!
Bram Moolenaar4072ba52020-12-23 13:56:35 +01002928 This option is not used in |Vim9| script.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002929
Bram Moolenaar03413f42016-04-12 21:07:15 +02002930 *'emoji'* *'emo'* *'noemoji'* *'noemo'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01002931'emoji' 'emo' boolean (default: on)
2932 global
Bram Moolenaar3848e002016-03-19 18:42:29 +01002933 When on all Unicode emoji characters are considered to be full width.
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02002934 This excludes "text emoji" characters, which are normally displayed as
2935 single width. Unfortunately there is no good specification for this
2936 and it has been determined on trial-and-error basis. Use the
2937 |setcellwidths()| function to change the behavior.
Bram Moolenaar3848e002016-03-19 18:42:29 +01002938
Bram Moolenaar071d4272004-06-13 20:20:40 +00002939 *'encoding'* *'enc'* *E543*
K.Takataf883d902021-05-30 18:04:19 +02002940'encoding' 'enc' string (default for MS-Windows: "utf-8",
2941 otherwise: value from $LANG or "latin1")
Bram Moolenaar071d4272004-06-13 20:20:40 +00002942 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002943 Sets the character encoding used inside Vim. It applies to text in
2944 the buffers, registers, Strings in expressions, text stored in the
2945 viminfo file, etc. It sets the kind of characters which Vim can work
2946 with. See |encoding-names| for the possible values.
2947
2948 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002949 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002950 It should normally be kept at its default value, or set when Vim
Bram Moolenaar02467872007-05-06 13:22:01 +00002951 starts up. See |multibyte|. To reload the menus see |:menutrans|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002952
Bram Moolenaar865242e2010-07-14 21:12:05 +02002953 This option cannot be set from a |modeline|. It would most likely
2954 corrupt the text.
2955
Bram Moolenaar3df01732017-02-17 22:47:16 +01002956 NOTE: For GTK+ 2 or later, it is highly recommended to set 'encoding'
2957 to "utf-8". Although care has been taken to allow different values of
Bram Moolenaar071d4272004-06-13 20:20:40 +00002958 'encoding', "utf-8" is the natural choice for the environment and
2959 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002960 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00002961 versions, and to avoid changing the encoding of newly created files
2962 without your knowledge (in case 'fileencodings' is empty).
2963
2964 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002965 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00002966 iconv() or as specified with 'charconvert'.
2967
Bram Moolenaar207f0092020-08-30 17:20:20 +02002968 If you need to know whether 'encoding' is a multibyte encoding, you
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002969 can use: >
2970 if has("multi_byte_encoding")
2971<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002972 Normally 'encoding' will be equal to your current locale. This will
2973 be the default if Vim recognizes your environment settings. If
2974 'encoding' is not set to the current locale, 'termencoding' must be
2975 set to convert typed and displayed text. See |encoding-table|.
2976
2977 When you set this option, it fires the |EncodingChanged| autocommand
2978 event so that you can set up fonts if necessary.
2979
2980 When the option is set, the value is converted to lowercase. Thus
2981 you can set it with uppercase values too. Underscores are translated
2982 to '-' signs.
2983 When the encoding is recognized, it is changed to the standard name.
2984 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
2985 "iso-8859-2" and "utf8" becomes "utf-8".
2986
2987 Note: "latin1" is also used when the encoding could not be detected.
2988 This only works when editing files in the same encoding! When the
2989 actual character set is not latin1, make sure 'fileencoding' and
2990 'fileencodings' are empty. When conversion is needed, switch to using
2991 utf-8.
2992
2993 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
2994 You don't notice this while editing, but it does matter for the
2995 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
2996 setting 'encoding' to one of these values instead of utf-8 only has
2997 effect for encoding used for files when 'fileencoding' is empty.
2998
Bram Moolenaar661b1822005-07-28 22:36:45 +00002999 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
3000 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003001
3002 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
3003'endofline' 'eol' boolean (default on)
3004 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003005 When writing a file and this option is off and the 'binary' option
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003006 is on, or 'fixeol' option is off, no <EOL> will be written for the
3007 last line in the file. This option is automatically set or reset when
3008 starting to edit a new file, depending on whether file has an <EOL>
3009 for the last line in the file. Normally you don't have to set or
3010 reset this option.
3011 When 'binary' is off and 'fixeol' is on the value is not used when
3012 writing the file. When 'binary' is on or 'fixeol' is off it is used
3013 to remember the presence of a <EOL> for the last line in the file, so
3014 that when you write the file the situation from the original file can
3015 be kept. But you can change it if you want to.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003016
3017 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
3018'equalalways' 'ea' boolean (default on)
3019 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003020 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00003021 splitting or closing a window. This also happens the moment the
3022 option is switched on. When off, splitting a window will reduce the
3023 size of the current window and leave the other windows the same. When
3024 closing a window the extra lines are given to the window next to it
3025 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00003026 When mixing vertically and horizontally split windows, a minimal size
3027 is computed and some windows may be larger if there is room. The
3028 'eadirection' option tells in which direction the size is affected.
Bram Moolenaar67f71312007-08-12 14:55:56 +00003029 Changing the height and width of a window can be avoided by setting
3030 'winfixheight' and 'winfixwidth', respectively.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003031 If a window size is specified when creating a new window sizes are
3032 currently not equalized (it's complicated, but may be implemented in
3033 the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +00003034
3035 *'equalprg'* *'ep'*
3036'equalprg' 'ep' string (default "")
3037 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003038 External program to use for "=" command. When this option is empty
Bram Moolenaar446cb832008-06-24 21:56:24 +00003039 the internal formatting functions are used; either 'lisp', 'cindent'
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003040 or 'indentexpr'. When Vim was compiled without internal formatting,
3041 the "indent" program is used.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003042 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003043 about including spaces and backslashes.
3044 This option cannot be set from a |modeline| or in the |sandbox|, for
3045 security reasons.
3046
3047 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
3048'errorbells' 'eb' boolean (default off)
3049 global
3050 Ring the bell (beep or screen flash) for error messages. This only
3051 makes a difference for error messages, the bell will be used always
3052 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003053 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar165bc692015-07-21 17:53:25 +02003054 screen flash or do nothing. See 'belloff' to finetune when to ring the
3055 bell.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003056
3057 *'errorfile'* *'ef'*
3058'errorfile' 'ef' string (Amiga default: "AztecC.Err",
3059 others: "errors.err")
3060 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003061 {not available when compiled without the |+quickfix|
3062 feature}
3063 Name of the errorfile for the QuickFix mode (see |:cf|).
3064 When the "-q" command-line argument is used, 'errorfile' is set to the
3065 following argument. See |-q|.
3066 NOT used for the ":make" command. See 'makeef' for that.
3067 Environment variables are expanded |:set_env|.
3068 See |option-backslash| about including spaces and backslashes.
3069 This option cannot be set from a |modeline| or in the |sandbox|, for
3070 security reasons.
3071
3072 *'errorformat'* *'efm'*
3073'errorformat' 'efm' string (default is very long)
3074 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003075 {not available when compiled without the |+quickfix|
3076 feature}
3077 Scanf-like description of the format for the lines in the error file
3078 (see |errorformat|).
3079
3080 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
3081'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
3082 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003083 Function keys that start with an <Esc> are recognized in Insert
3084 mode. When this option is off, the cursor and function keys cannot be
3085 used in Insert mode if they start with an <Esc>. The advantage of
3086 this is that the single <Esc> is recognized immediately, instead of
3087 after one second. Instead of resetting this option, you might want to
3088 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
3089 when 'esckeys' is off, you can still map anything, but the cursor keys
3090 won't work by default.
3091 NOTE: This option is set to the Vi default value when 'compatible' is
3092 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaarc8234772019-11-10 21:00:27 +01003093 NOTE: when this option is off then the |modifyOtherKeys| functionality
3094 is disabled while in Insert mode to avoid ending Insert mode with any
3095 key that has a modifier.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003096
3097 *'eventignore'* *'ei'*
3098'eventignore' 'ei' string (default "")
3099 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003100 A list of autocommand event names, which are to be ignored.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00003101 When set to "all" or when "all" is one of the items, all autocommand
3102 events are ignored, autocommands will not be executed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003103 Otherwise this is a comma separated list of event names. Example: >
3104 :set ei=WinEnter,WinLeave
3105<
3106 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
3107'expandtab' 'et' boolean (default off)
3108 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003109 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003110 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00003111 when 'autoindent' is on. To insert a real tab when 'expandtab' is
3112 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
Bram Moolenaarca635012015-09-25 20:34:21 +02003113 This option is reset when the 'paste' option is set and restored when
3114 the 'paste' option is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003115 NOTE: This option is reset when 'compatible' is set.
3116
3117 *'exrc'* *'ex'* *'noexrc'* *'noex'*
3118'exrc' 'ex' boolean (default off)
3119 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003120 Enables the reading of .vimrc, .exrc and .gvimrc in the current
Bram Moolenaar36f44c22016-08-28 18:17:20 +02003121 directory.
3122
3123 Setting this option is a potential security leak. E.g., consider
3124 unpacking a package or fetching files from github, a .vimrc in there
3125 might be a trojan horse. BETTER NOT SET THIS OPTION!
3126 Instead, define an autocommand in your .vimrc to set options for a
3127 matching directory.
3128
3129 If you do switch this option on you should also consider setting the
3130 'secure' option (see |initialization|).
3131 Also see |.vimrc| and |gui-init|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003132 This option cannot be set from a |modeline| or in the |sandbox|, for
3133 security reasons.
3134
3135 *'fileencoding'* *'fenc'* *E213*
3136'fileencoding' 'fenc' string (default: "")
3137 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003138 Sets the character encoding for the file of this buffer.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003139
Bram Moolenaar071d4272004-06-13 20:20:40 +00003140 When 'fileencoding' is different from 'encoding', conversion will be
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003141 done when writing the file. For reading see below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003142 When 'fileencoding' is empty, the same value as 'encoding' will be
3143 used (no conversion when reading or writing a file).
Bram Moolenaar214641f2017-03-05 17:04:09 +01003144 No error will be given when the value is set, only when it is used,
3145 only when writing a file.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003146 Conversion will also be done when 'encoding' and 'fileencoding' are
3147 both a Unicode encoding and 'fileencoding' is not utf-8. That's
3148 because internally Unicode is always stored as utf-8.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003149 WARNING: Conversion can cause loss of information! When
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003150 'encoding' is "utf-8" or another Unicode encoding, conversion
3151 is most likely done in a way that the reverse conversion
3152 results in the same text. When 'encoding' is not "utf-8" some
3153 characters may be lost!
Bram Moolenaar865242e2010-07-14 21:12:05 +02003154
Bram Moolenaar071d4272004-06-13 20:20:40 +00003155 See 'encoding' for the possible values. Additionally, values may be
3156 specified that can be handled by the converter, see
3157 |mbyte-conversion|.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003158
Bram Moolenaar071d4272004-06-13 20:20:40 +00003159 When reading a file 'fileencoding' will be set from 'fileencodings'.
3160 To read a file in a certain encoding it won't work by setting
Bram Moolenaar02467872007-05-06 13:22:01 +00003161 'fileencoding', use the |++enc| argument. One exception: when
3162 'fileencodings' is empty the value of 'fileencoding' is used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003163 For a new file the global value of 'fileencoding' is used.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003164
Bram Moolenaar071d4272004-06-13 20:20:40 +00003165 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
3166 When the option is set, the value is converted to lowercase. Thus
3167 you can set it with uppercase values too. '_' characters are
3168 replaced with '-'. If a name is recognized from the list for
3169 'encoding', it is replaced by the standard name. For example
3170 "ISO8859-2" becomes "iso-8859-2".
Bram Moolenaar865242e2010-07-14 21:12:05 +02003171
Bram Moolenaar071d4272004-06-13 20:20:40 +00003172 When this option is set, after starting to edit a file, the 'modified'
3173 option is set, because the file would be different when written.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003174
3175 Keep in mind that changing 'fenc' from a modeline happens
3176 AFTER the text has been read, thus it applies to when the file will be
3177 written. If you do set 'fenc' in a modeline, you might want to set
3178 'nomodified' to avoid not being able to ":q".
3179
Bram Moolenaar071d4272004-06-13 20:20:40 +00003180 This option can not be changed when 'modifiable' is off.
3181
3182 *'fe'*
3183 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003184 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003185 old short name was 'fe', which is no longer used.
3186
3187 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003188'fileencodings' 'fencs' string (default: "ucs-bom",
3189 "ucs-bom,utf-8,default,latin1" when
3190 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003191 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003192 This is a list of character encodings considered when starting to edit
3193 an existing file. When a file is read, Vim tries to use the first
3194 mentioned character encoding. If an error is detected, the next one
3195 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003196 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00003197 an empty string, which means the value of 'encoding' is used.
3198 WARNING: Conversion can cause loss of information! When
3199 'encoding' is "utf-8" (or one of the other Unicode variants)
3200 conversion is most likely done in a way that the reverse
3201 conversion results in the same text. When 'encoding' is not
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003202 "utf-8" some non-ASCII characters may be lost! You can use
3203 the |++bad| argument to specify what is done with characters
3204 that can't be converted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003205 For an empty file or a file with only ASCII characters most encodings
3206 will work and the first entry of 'fileencodings' will be used (except
3207 "ucs-bom", which requires the BOM to be present). If you prefer
3208 another encoding use an BufReadPost autocommand event to test if your
3209 preferred encoding is to be used. Example: >
3210 au BufReadPost * if search('\S', 'w') == 0 |
3211 \ set fenc=iso-2022-jp | endif
3212< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
3213 non-blank characters.
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003214 When the |++enc| argument is used then the value of 'fileencodings' is
3215 not used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003216 Note that 'fileencodings' is not used for a new file, the global value
3217 of 'fileencoding' is used instead. You can set it with: >
3218 :setglobal fenc=iso-8859-2
3219< This means that a non-existing file may get a different encoding than
3220 an empty file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003221 The special value "ucs-bom" can be used to check for a Unicode BOM
3222 (Byte Order Mark) at the start of the file. It must not be preceded
3223 by "utf-8" or another Unicode encoding for this to work properly.
3224 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
3225 because Vim cannot detect an error, thus the encoding is always
3226 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003227 The special value "default" can be used for the encoding from the
K.Takataef8706f2021-05-31 18:40:49 +02003228 environment. On MS-Windows this is the system encoding. Otherwise
3229 this is the default value for 'encoding'. It is useful when
3230 'encoding' is set to "utf-8" and your environment uses a non-latin1
3231 encoding, such as Russian.
Bram Moolenaarca003e12006-03-17 23:19:38 +00003232 When 'encoding' is "utf-8" and a file contains an illegal byte
3233 sequence it won't be recognized as UTF-8. You can use the |8g8|
3234 command to find the illegal byte sequence.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003235 WRONG VALUES: WHAT'S WRONG:
3236 latin1,utf-8 "latin1" will always be used
3237 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
3238 file
3239 cp1250,latin1 "cp1250" will always be used
3240 If 'fileencodings' is empty, 'fileencoding' is not modified.
3241 See 'fileencoding' for the possible values.
3242 Setting this option does not have an effect until the next time a file
3243 is read.
3244
3245 *'fileformat'* *'ff'*
Bram Moolenaar00590742019-02-15 21:06:09 +01003246'fileformat' 'ff' string (MS-Windows default: "dos",
3247 Unix, macOS default: "unix")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003248 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003249 This gives the <EOL> of the current buffer, which is used for
3250 reading/writing the buffer from/to a file:
Bram Moolenaar4072ba52020-12-23 13:56:35 +01003251 dos <CR><NL>
Bram Moolenaar071d4272004-06-13 20:20:40 +00003252 unix <NL>
3253 mac <CR>
3254 When "dos" is used, CTRL-Z at the end of a file is ignored.
3255 See |file-formats| and |file-read|.
3256 For the character encoding of the file see 'fileencoding'.
3257 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
Bram Moolenaarbf884932013-04-05 22:26:15 +02003258 works like it was set to "unix".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003259 This option is set automatically when starting to edit a file and
3260 'fileformats' is not empty and 'binary' is off.
3261 When this option is set, after starting to edit a file, the 'modified'
3262 option is set, because the file would be different when written.
3263 This option can not be changed when 'modifiable' is off.
3264 For backwards compatibility: When this option is set to "dos",
3265 'textmode' is set, otherwise 'textmode' is reset.
3266
3267 *'fileformats'* *'ffs'*
3268'fileformats' 'ffs' string (default:
Bram Moolenaar00590742019-02-15 21:06:09 +01003269 Vim+Vi MS-Windows: "dos,unix",
3270 Vim Unix, macOS: "unix,dos",
Bram Moolenaar071d4272004-06-13 20:20:40 +00003271 Vi Cygwin: "unix,dos",
3272 Vi others: "")
3273 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003274 This gives the end-of-line (<EOL>) formats that will be tried when
3275 starting to edit a new buffer and when reading a file into an existing
3276 buffer:
3277 - When empty, the format defined with 'fileformat' will be used
3278 always. It is not set automatically.
3279 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003280 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003281 'fileformats' name will be used when a file is read into an existing
3282 buffer, no matter what 'fileformat' for that buffer is set to.
3283 - When more than one name is present, separated by commas, automatic
3284 <EOL> detection will be done when reading a file. When starting to
3285 edit a file, a check is done for the <EOL>:
3286 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
3287 'fileformat' is set to "dos".
3288 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003289 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003290 preceding <CR>, "unix" is preferred over "dos".
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01003291 3. If 'fileformat' has not yet been set, and if a <CR> is found, and
3292 if 'fileformats' includes "mac", 'fileformat' is set to "mac".
Bram Moolenaar00659062010-09-21 22:34:02 +02003293 This means that "mac" is only chosen when:
3294 "unix" is not present or no <NL> is found in the file, and
3295 "dos" is not present or no <CR><NL> is found in the file.
3296 Except: if "unix" was chosen, but there is a <CR> before
3297 the first <NL>, and there appear to be more <CR>s than <NL>s in
Bram Moolenaar166af9b2010-11-16 20:34:40 +01003298 the first few lines, "mac" is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003299 4. If 'fileformat' is still not set, the first name from
3300 'fileformats' is used.
3301 When reading a file into an existing buffer, the same is done, but
3302 this happens like 'fileformat' has been set appropriately for that
3303 file only, the option is not changed.
3304 When 'binary' is set, the value of 'fileformats' is not used.
3305
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01003306 When Vim starts up with an empty buffer the first item is used. You
3307 can overrule this by setting 'fileformat' in your .vimrc.
Bram Moolenaar81af9252010-12-10 20:35:50 +01003308
Bram Moolenaar071d4272004-06-13 20:20:40 +00003309 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
3310 are ":source"ed and for vimrc files, automatic <EOL> detection may be
3311 done:
3312 - When 'fileformats' is empty, there is no automatic detection. Dos
3313 format will be used.
3314 - When 'fileformats' is set to one or more names, automatic detection
3315 is done. This is based on the first <NL> in the file: If there is a
3316 <CR> in front of it, Dos format is used, otherwise Unix format is
3317 used.
3318 Also see |file-formats|.
3319 For backwards compatibility: When this option is set to an empty
3320 string or one format (no comma is included), 'textauto' is reset,
3321 otherwise 'textauto' is set.
3322 NOTE: This option is set to the Vi default value when 'compatible' is
3323 set and to the Vim default value when 'compatible' is reset.
3324
Bram Moolenaarbf884932013-04-05 22:26:15 +02003325 *'fileignorecase'* *'fic'* *'nofileignorecase'* *'nofic'*
3326'fileignorecase' 'fic' boolean (default on for systems where case in file
3327 names is normally ignored)
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003328 global
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003329 When set case is ignored when using file names and directories.
3330 See 'wildignorecase' for only ignoring case when doing completion.
3331
Bram Moolenaar071d4272004-06-13 20:20:40 +00003332 *'filetype'* *'ft'*
3333'filetype' 'ft' string (default: "")
3334 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003335 When this option is set, the FileType autocommand event is triggered.
3336 All autocommands that match with the value of this option will be
3337 executed. Thus the value of 'filetype' is used in place of the file
3338 name.
3339 Otherwise this option does not always reflect the current file type.
3340 This option is normally set when the file type is detected. To enable
3341 this use the ":filetype on" command. |:filetype|
3342 Setting this option to a different value is most useful in a modeline,
3343 for a file for which the file type is not automatically recognized.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003344 Example, for in an IDL file:
3345 /* vim: set filetype=idl : */ ~
3346 |FileType| |filetypes|
3347 When a dot appears in the value then this separates two filetype
3348 names. Example:
3349 /* vim: set filetype=c.doxygen : */ ~
3350 This will use the "c" filetype first, then the "doxygen" filetype.
3351 This works both for filetype plugins and for syntax files. More than
3352 one dot may appear.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003353 This option is not copied to another buffer, independent of the 's' or
3354 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003355 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003356
3357 *'fillchars'* *'fcs'*
Bram Moolenaara98f8a22021-02-13 18:24:23 +01003358'fillchars' 'fcs' string (default "vert:|,fold:-,eob:~")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003359 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02003360 {not available when compiled without the |+folding|
3361 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003362 Characters to fill the statuslines and vertical separators.
3363 It is a comma separated list of items:
3364
3365 item default Used for ~
3366 stl:c ' ' or '^' statusline of the current window
Bram Moolenaar38a55632016-02-15 22:07:32 +01003367 stlnc:c ' ' or '=' statusline of the non-current windows
Bram Moolenaar071d4272004-06-13 20:20:40 +00003368 vert:c '|' vertical separators |:vsplit|
3369 fold:c '-' filling 'foldtext'
Bram Moolenaar3aca5a62021-02-17 13:14:07 +01003370 foldopen:c '-' mark the beginning of a fold
3371 foldclose:c '+' show a closed fold
3372 foldsep:c '|' open fold middle character
Bram Moolenaar071d4272004-06-13 20:20:40 +00003373 diff:c '-' deleted lines of the 'diff' option
Bram Moolenaara98f8a22021-02-13 18:24:23 +01003374 eob:c '~' empty lines below the end of a buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003375
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003376 Any one that is omitted will fall back to the default. For "stl" and
Bram Moolenaar38a55632016-02-15 22:07:32 +01003377 "stlnc" the space will be used when there is highlighting, '^' or '='
Bram Moolenaar071d4272004-06-13 20:20:40 +00003378 otherwise.
3379
3380 Example: >
Bram Moolenaar38a55632016-02-15 22:07:32 +01003381 :set fillchars=stl:^,stlnc:=,vert:\|,fold:-,diff:-
Bram Moolenaar071d4272004-06-13 20:20:40 +00003382< This is similar to the default, except that these characters will also
3383 be used when there is highlighting.
3384
Bram Moolenaar008bff92021-03-04 21:55:58 +01003385 For "stl" and "stlnc" single-byte and multibyte characters are
3386 supported. But double-width characters are not supported.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003387
Bram Moolenaar071d4272004-06-13 20:20:40 +00003388 The highlighting used for these items:
3389 item highlight group ~
3390 stl:c StatusLine |hl-StatusLine|
3391 stlnc:c StatusLineNC |hl-StatusLineNC|
3392 vert:c VertSplit |hl-VertSplit|
3393 fold:c Folded |hl-Folded|
3394 diff:c DiffDelete |hl-DiffDelete|
Bram Moolenaara98f8a22021-02-13 18:24:23 +01003395 eob:c EndOfBuffer |hl-EndOfBuffer|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003396
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003397 *'fixendofline'* *'fixeol'* *'nofixendofline'* *'nofixeol'*
3398'fixendofline' 'fixeol' boolean (default on)
3399 local to buffer
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003400 When writing a file and this option is on, <EOL> at the end of file
3401 will be restored if missing. Turn this option off if you want to
3402 preserve the situation from the original file.
3403 When the 'binary' option is set the value of this option doesn't
3404 matter.
3405 See the 'endofline' option.
3406
Bram Moolenaar071d4272004-06-13 20:20:40 +00003407 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
Bram Moolenaar98a29d02021-01-18 19:55:44 +01003408'fkmap' 'fk' boolean (default off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003409 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003410 {only available when compiled with the |+rightleft|
3411 feature}
Bram Moolenaar14184a32019-02-16 15:10:30 +01003412 This option was for using Farsi, which has been removed. See
3413 |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003414
3415 *'foldclose'* *'fcl'*
3416'foldclose' 'fcl' string (default "")
3417 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003418 {not available when compiled without the |+folding|
3419 feature}
3420 When set to "all", a fold is closed when the cursor isn't in it and
3421 its level is higher than 'foldlevel'. Useful if you want folds to
3422 automatically close when moving out of them.
3423
3424 *'foldcolumn'* *'fdc'*
3425'foldcolumn' 'fdc' number (default 0)
3426 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003427 {not available when compiled without the |+folding|
3428 feature}
3429 When non-zero, a column with the specified width is shown at the side
3430 of the window which indicates open and closed folds. The maximum
3431 value is 12.
3432 See |folding|.
3433
3434 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
3435'foldenable' 'fen' boolean (default on)
3436 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003437 {not available when compiled without the |+folding|
3438 feature}
3439 When off, all folds are open. This option can be used to quickly
3440 switch between showing all text unfolded and viewing the text with
3441 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003442 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00003443 'foldenable' is off.
3444 This option is set by commands that create a new fold or close a fold.
3445 See |folding|.
3446
3447 *'foldexpr'* *'fde'*
3448'foldexpr' 'fde' string (default: "0")
3449 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003450 {not available when compiled without the |+folding|
Bram Moolenaardb84e452010-08-15 13:50:43 +02003451 or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003452 The expression used for when 'foldmethod' is "expr". It is evaluated
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00003453 for each line to obtain its fold level. The context is set to the
3454 script where 'foldexpr' was set, script-local items can be accessed.
3455 See |fold-expr| for the usage.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003456
Bram Moolenaar30b65812012-07-12 22:01:11 +02003457 The expression will be evaluated in the |sandbox| if set from a
3458 modeline, see |sandbox-option|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003459 This option can't be set from a |modeline| when the 'diff' option is
Bram Moolenaar110289e2019-05-23 15:38:06 +02003460 on or the 'modelineexpr' option is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003461
3462 It is not allowed to change text or jump to another window while
3463 evaluating 'foldexpr' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003464
3465 *'foldignore'* *'fdi'*
3466'foldignore' 'fdi' string (default: "#")
3467 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003468 {not available when compiled without the |+folding|
3469 feature}
3470 Used only when 'foldmethod' is "indent". Lines starting with
3471 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003472 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003473 The default "#" works well for C programs. See |fold-indent|.
3474
3475 *'foldlevel'* *'fdl'*
3476'foldlevel' 'fdl' number (default: 0)
3477 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003478 {not available when compiled without the |+folding|
3479 feature}
3480 Sets the fold level: Folds with a higher level will be closed.
3481 Setting this option to zero will close all folds. Higher numbers will
3482 close fewer folds.
3483 This option is set by commands like |zm|, |zM| and |zR|.
3484 See |fold-foldlevel|.
3485
3486 *'foldlevelstart'* *'fdls'*
3487'foldlevelstart' 'fdls' number (default: -1)
3488 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003489 {not available when compiled without the |+folding|
3490 feature}
3491 Sets 'foldlevel' when starting to edit another buffer in a window.
3492 Useful to always start editing with all folds closed (value zero),
3493 some folds closed (one) or no folds closed (99).
3494 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003495 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00003496 ignores this option and closes all folds.
3497 It is also done before BufReadPre autocommands, to allow an autocmd to
3498 overrule the 'foldlevel' value for specific files.
3499 When the value is negative, it is not used.
3500
3501 *'foldmarker'* *'fmr'* *E536*
3502'foldmarker' 'fmr' string (default: "{{{,}}}")
3503 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003504 {not available when compiled without the |+folding|
3505 feature}
3506 The start and end marker used when 'foldmethod' is "marker". There
3507 must be one comma, which separates the start and end marker. The
3508 marker is a literal string (a regular expression would be too slow).
3509 See |fold-marker|.
3510
3511 *'foldmethod'* *'fdm'*
3512'foldmethod' 'fdm' string (default: "manual")
3513 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003514 {not available when compiled without the |+folding|
3515 feature}
3516 The kind of folding used for the current window. Possible values:
3517 |fold-manual| manual Folds are created manually.
3518 |fold-indent| indent Lines with equal indent form a fold.
3519 |fold-expr| expr 'foldexpr' gives the fold level of a line.
3520 |fold-marker| marker Markers are used to specify folds.
3521 |fold-syntax| syntax Syntax highlighting items specify folds.
3522 |fold-diff| diff Fold text that is not changed.
3523
3524 *'foldminlines'* *'fml'*
3525'foldminlines' 'fml' number (default: 1)
3526 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003527 {not available when compiled without the |+folding|
3528 feature}
Bram Moolenaar00654022011-02-25 14:42:19 +01003529 Sets the number of screen lines above which a fold can be displayed
3530 closed. Also for manually closed folds. With the default value of
3531 one a fold can only be closed if it takes up two or more screen lines.
3532 Set to zero to be able to close folds of just one screen line.
Bram Moolenaar446beb42011-05-10 17:18:44 +02003533 Note that this only has an effect on what is displayed. After using
Bram Moolenaar071d4272004-06-13 20:20:40 +00003534 "zc" to close a fold, which is displayed open because it's smaller
3535 than 'foldminlines', a following "zc" may close a containing fold.
3536
3537 *'foldnestmax'* *'fdn'*
3538'foldnestmax' 'fdn' number (default: 20)
3539 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003540 {not available when compiled without the |+folding|
3541 feature}
3542 Sets the maximum nesting of folds for the "indent" and "syntax"
3543 methods. This avoids that too many folds will be created. Using more
3544 than 20 doesn't work, because the internal limit is 20.
3545
3546 *'foldopen'* *'fdo'*
3547'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
3548 search,tag,undo")
3549 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003550 {not available when compiled without the |+folding|
3551 feature}
3552 Specifies for which type of commands folds will be opened, if the
3553 command moves the cursor into a closed fold. It is a comma separated
3554 list of items.
Bram Moolenaar05365702010-10-27 18:34:44 +02003555 NOTE: When the command is part of a mapping this option is not used.
3556 Add the |zv| command to the mapping to get the same effect.
3557 (rationale: the mapping may want to control opening folds itself)
3558
Bram Moolenaar071d4272004-06-13 20:20:40 +00003559 item commands ~
3560 all any
3561 block "(", "{", "[[", "[{", etc.
3562 hor horizontal movements: "l", "w", "fx", etc.
3563 insert any command in Insert mode
3564 jump far jumps: "G", "gg", etc.
3565 mark jumping to a mark: "'m", CTRL-O, etc.
3566 percent "%"
3567 quickfix ":cn", ":crew", ":make", etc.
3568 search search for a pattern: "/", "n", "*", "gd", etc.
3569 (not for a search pattern in a ":" command)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003570 Also for |[s| and |]s|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003571 tag jumping to a tag: ":ta", CTRL-T, etc.
3572 undo undo or redo: "u" and CTRL-R
Bram Moolenaar071d4272004-06-13 20:20:40 +00003573 When a movement command is used for an operator (e.g., "dl" or "y%")
3574 this option is not used. This means the operator will include the
3575 whole closed fold.
3576 Note that vertical movements are not here, because it would make it
3577 very difficult to move onto a closed fold.
3578 In insert mode the folds containing the cursor will always be open
3579 when text is inserted.
3580 To close folds you can re-apply 'foldlevel' with the |zx| command or
3581 set the 'foldclose' option to "all".
3582
3583 *'foldtext'* *'fdt'*
3584'foldtext' 'fdt' string (default: "foldtext()")
3585 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003586 {not available when compiled without the |+folding|
3587 feature}
3588 An expression which is used to specify the text displayed for a closed
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00003589 fold. The context is set to the script where 'foldexpr' was set,
3590 script-local items can be accessed. See |fold-foldtext| for the
3591 usage.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003592
Bram Moolenaar30b65812012-07-12 22:01:11 +02003593 The expression will be evaluated in the |sandbox| if set from a
3594 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003595 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003596
3597 It is not allowed to change text or jump to another window while
3598 evaluating 'foldtext' |textlock|.
3599
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003600 *'formatexpr'* *'fex'*
3601'formatexpr' 'fex' string (default "")
3602 local to buffer
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003603 {not available when compiled without the |+eval|
3604 feature}
3605 Expression which is evaluated to format a range of lines for the |gq|
3606 operator or automatic formatting (see 'formatoptions'). When this
3607 option is empty 'formatprg' is used.
3608
3609 The |v:lnum| variable holds the first line to be formatted.
3610 The |v:count| variable holds the number of lines to be formatted.
3611 The |v:char| variable holds the character that is going to be
3612 inserted if the expression is being evaluated due to
3613 automatic formatting. This can be empty. Don't insert
3614 it yet!
3615
3616 Example: >
3617 :set formatexpr=mylang#Format()
3618< This will invoke the mylang#Format() function in the
3619 autoload/mylang.vim file in 'runtimepath'. |autoload|
3620
3621 The expression is also evaluated when 'textwidth' is set and adding
3622 text beyond that limit. This happens under the same conditions as
3623 when internal formatting is used. Make sure the cursor is kept in the
3624 same spot relative to the text then! The |mode()| function will
3625 return "i" or "R" in this situation.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01003626
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003627 When the expression evaluates to non-zero Vim will fall back to using
3628 the internal format mechanism.
3629
Yegappan Lakshmanan8bb65f22021-12-26 10:51:39 +00003630 If the expression starts with s: or |<SID>|, then it is replaced with
3631 the script ID (|local-function|). Example: >
3632 set formatexpr=s:MyFormatExpr()
3633 set formatexpr=<SID>SomeFormatExpr()
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00003634< Otherwise, the expression is evaluated in the context of the script
3635 where the option was set, thus script-local items are available.
3636
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003637 The expression will be evaluated in the |sandbox| when set from a
3638 modeline, see |sandbox-option|. That stops the option from working,
3639 since changing the buffer text is not allowed.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003640 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaar036986f2017-03-16 17:41:02 +01003641 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003642
Bram Moolenaar86b68352004-12-27 21:59:20 +00003643 *'formatlistpat'* *'flp'*
3644'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
3645 local to buffer
Bram Moolenaar86b68352004-12-27 21:59:20 +00003646 A pattern that is used to recognize a list header. This is used for
3647 the "n" flag in 'formatoptions'.
3648 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00003649 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00003650 while still checking more characters. There must be a character
3651 following the pattern, when it matches the whole line it is handled
3652 like there is no match.
3653 The default recognizes a number, followed by an optional punctuation
3654 character and white space.
3655
Bram Moolenaar6c60f472019-04-28 16:00:35 +02003656 *'formatoptions'* *'fo'*
3657'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
3658 local to buffer
3659 This is a sequence of letters which describes how automatic
3660 formatting is to be done. See |fo-table|. When the 'paste' option is
3661 on, no formatting is done (like 'formatoptions' is empty). Commas can
3662 be inserted for readability.
3663 To avoid problems with flags that are added in the future, use the
3664 "+=" and "-=" feature of ":set" |add-option-flags|.
3665 NOTE: This option is set to the Vi default value when 'compatible' is
3666 set and to the Vim default value when 'compatible' is reset.
3667
Bram Moolenaar071d4272004-06-13 20:20:40 +00003668 *'formatprg'* *'fp'*
3669'formatprg' 'fp' string (default "")
Bram Moolenaar9be7c042017-01-14 14:28:30 +01003670 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003671 The name of an external program that will be used to format the lines
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003672 selected with the |gq| operator. The program must take the input on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003673 stdin and produce the output on stdout. The Unix program "fmt" is
Bram Moolenaara5792f52005-11-23 21:25:05 +00003674 such a program.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003675 If the 'formatexpr' option is not empty it will be used instead.
3676 Otherwise, if 'formatprg' option is an empty string, the internal
3677 format function will be used |C-indenting|.
Bram Moolenaara5792f52005-11-23 21:25:05 +00003678 Environment variables are expanded |:set_env|. See |option-backslash|
3679 about including spaces and backslashes.
Bram Moolenaar30b65812012-07-12 22:01:11 +02003680 This option cannot be set from a |modeline| or in the |sandbox|, for
3681 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003682
Bram Moolenaard94464e2015-11-02 15:28:18 +01003683 *'fsync'* *'fs'* *'nofsync'* *'nofs'*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003684'fsync' 'fs' boolean (default on)
3685 global
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003686 When on, the library function fsync() will be called after writing a
3687 file. This will flush a file to disk, ensuring that it is safely
3688 written even on filesystems which do metadata-only journaling. This
3689 will force the harddrive to spin up on Linux systems running in laptop
3690 mode, so it may be undesirable in some situations. Be warned that
3691 turning this off increases the chances of data loss after a crash. On
3692 systems without an fsync() implementation, this variable is always
3693 off.
3694 Also see 'swapsync' for controlling fsync() on swap files.
Bram Moolenaar340dd0f2021-10-14 17:52:23 +01003695 'fsync' also applies to |writefile()| (unless a flag is used to
3696 overrule it) and when writing undo files (see |undo-persistence|).
Bram Moolenaar110289e2019-05-23 15:38:06 +02003697 This option cannot be set from a |modeline| or in the |sandbox|, for
3698 security reasons.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003699
Bram Moolenaar071d4272004-06-13 20:20:40 +00003700 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
3701'gdefault' 'gd' boolean (default off)
3702 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003703 When on, the ":substitute" flag 'g' is default on. This means that
3704 all matches in a line are substituted instead of one. When a 'g' flag
3705 is given to a ":substitute" command, this will toggle the substitution
3706 of all or one match. See |complex-change|.
3707
3708 command 'gdefault' on 'gdefault' off ~
3709 :s/// subst. all subst. one
3710 :s///g subst. one subst. all
3711 :s///gg subst. all subst. one
3712
3713 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar21020352017-06-13 17:21:04 +02003714 DEPRECATED: Setting this option may break plugins that are not aware
3715 of this option. Also, many users get confused that adding the /g flag
3716 has the opposite effect of that it normally does.
Bram Moolenaar4072ba52020-12-23 13:56:35 +01003717 This option is not used in |Vim9| script.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003718
3719 *'grepformat'* *'gfm'*
Bram Moolenaar6e932462014-09-09 18:48:09 +02003720'grepformat' 'gfm' string (default "%f:%l:%m,%f:%l%m,%f %l%m")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003721 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003722 Format to recognize for the ":grep" command output.
3723 This is a scanf-like string that uses the same format as the
3724 'errorformat' option: see |errorformat|.
3725
3726 *'grepprg'* *'gp'*
3727'grepprg' 'gp' string (default "grep -n ",
3728 Unix: "grep -n $* /dev/null",
3729 Win32: "findstr /n" or "grep -n",
3730 VMS: "SEARCH/NUMBERS ")
3731 global or local to buffer |global-local|
Bram Moolenaar582fd852005-03-28 20:58:01 +00003732 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003733 and '#' characters, which are expanded like when used in a command-
3734 line. The placeholder "$*" is allowed to specify where the arguments
3735 will be included. Environment variables are expanded |:set_env|. See
3736 |option-backslash| about including spaces and backslashes.
3737 When your "grep" accepts the "-H" argument, use this to make ":grep"
3738 also work well with a single file: >
3739 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00003740< Special value: When 'grepprg' is set to "internal" the |:grep| command
Bram Moolenaara6557602006-02-04 22:43:20 +00003741 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like
3742 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00003743 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00003744 apply equally to 'grepprg'.
3745 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
3746 otherwise it's "grep -n".
3747 This option cannot be set from a |modeline| or in the |sandbox|, for
3748 security reasons.
3749
3750 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
3751'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
3752 ve:ver35-Cursor,
3753 o:hor50-Cursor,
3754 i-ci:ver25-Cursor/lCursor,
3755 r-cr:hor20-Cursor/lCursor,
3756 sm:block-Cursor
3757 -blinkwait175-blinkoff150-blinkon175",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003758 for Win32 console:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003759 "n-v-c:block,o:hor50,i-ci:hor15,
3760 r-cr:hor30,sm:block")
3761 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003762 {only available when compiled with GUI enabled, and
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003763 for Win32 console}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003764 This option tells Vim what the cursor should look like in different
Bram Moolenaar8024f932020-01-14 19:29:13 +01003765 modes. It fully works in the GUI. In a Win32 console, only the
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003766 height of the cursor can be changed. This can be done by specifying a
3767 block cursor, or a percentage for a vertical or horizontal cursor.
Bram Moolenaar1e7813a2015-03-31 18:31:03 +02003768 For a console the 't_SI', 't_SR', and 't_EI' escape sequences are
3769 used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003770
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003771 The option is a comma separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003772 mode-list and an argument-list:
3773 mode-list:argument-list,mode-list:argument-list,..
3774 The mode-list is a dash separated list of these modes:
3775 n Normal mode
3776 v Visual mode
3777 ve Visual mode with 'selection' "exclusive" (same as 'v',
3778 if not specified)
3779 o Operator-pending mode
3780 i Insert mode
3781 r Replace mode
3782 c Command-line Normal (append) mode
3783 ci Command-line Insert mode
3784 cr Command-line Replace mode
3785 sm showmatch in Insert mode
3786 a all modes
3787 The argument-list is a dash separated list of these arguments:
3788 hor{N} horizontal bar, {N} percent of the character height
3789 ver{N} vertical bar, {N} percent of the character width
3790 block block cursor, fills the whole character
3791 [only one of the above three should be present]
3792 blinkwait{N} *cursor-blinking*
3793 blinkon{N}
3794 blinkoff{N}
3795 blink times for cursor: blinkwait is the delay before
3796 the cursor starts blinking, blinkon is the time that
3797 the cursor is shown and blinkoff is the time that the
3798 cursor is not shown. The times are in msec. When one
3799 of the numbers is zero, there is no blinking. The
3800 default is: "blinkwait700-blinkon400-blinkoff250".
3801 These numbers are used for a missing entry. This
3802 means that blinking is enabled by default. To switch
3803 blinking off you can use "blinkon0". The cursor only
3804 blinks when Vim is waiting for input, not while
3805 executing a command.
3806 To make the cursor blink in an xterm, see
3807 |xterm-blink|.
3808 {group-name}
3809 a highlight group name, that sets the color and font
3810 for the cursor
3811 {group-name}/{group-name}
3812 Two highlight group names, the first is used when
3813 no language mappings are used, the other when they
3814 are. |language-mapping|
3815
3816 Examples of parts:
3817 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
3818 block cursor with colors from the "nCursor"
3819 highlight group
3820 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
3821 In Insert and Command-line Insert mode, use a
3822 30% vertical bar cursor with colors from the
3823 "iCursor" highlight group. Blink a bit
3824 faster.
3825
3826 The 'a' mode is different. It will set the given argument-list for
3827 all modes. It does not reset anything to defaults. This can be used
3828 to do a common setting for all modes. For example, to switch off
3829 blinking: "a:blinkon0"
3830
3831 Examples of cursor highlighting: >
3832 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
3833 :highlight Cursor gui=NONE guifg=bg guibg=fg
3834<
3835 *'guifont'* *'gfn'*
Bram Moolenaar251e1912011-06-19 05:09:16 +02003836 *E235* *E596*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003837'guifont' 'gfn' string (default "")
3838 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003839 {only available when compiled with GUI enabled}
3840 This is a list of fonts which will be used for the GUI version of Vim.
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003841 In its simplest form the value is just one font name.
3842 See |gui-font| for the details.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003843
3844 *'guifontset'* *'gfs'*
3845 *E250* *E252* *E234* *E597* *E598*
3846'guifontset' 'gfs' string (default "")
3847 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003848 {only available when compiled with GUI enabled and
3849 with the |+xfontset| feature}
Bram Moolenaar3df01732017-02-17 22:47:16 +01003850 {not available in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003851 When not empty, specifies two (or more) fonts to be used. The first
3852 one for normal English, the second one for your special language. See
3853 |xfontset|.
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003854
Bram Moolenaar071d4272004-06-13 20:20:40 +00003855 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
3856'guifontwide' 'gfw' string (default "")
3857 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003858 {only available when compiled with GUI enabled}
3859 When not empty, specifies a comma-separated list of fonts to be used
3860 for double-width characters. The first font that can be loaded is
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003861 used. See |gui-fontwide|.
Bram Moolenaar0f272122013-01-23 18:37:40 +01003862
Bram Moolenaar071d4272004-06-13 20:20:40 +00003863 *'guiheadroom'* *'ghr'*
3864'guiheadroom' 'ghr' number (default 50)
3865 global
Bram Moolenaar110289e2019-05-23 15:38:06 +02003866 {only for GTK and X11 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003867 The number of pixels subtracted from the screen height when fitting
3868 the GUI window on the screen. Set this before the GUI is started,
3869 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003870 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00003871 lines will be left for window decorations and other items on the
3872 screen. Set it to a negative value to allow windows taller than the
3873 screen.
3874
Dusan Popovic4eeedc02021-10-16 20:52:05 +01003875 *'guiligatures'* *'gli'* *E1243*
3876'guiligatures' 'gli' string (default "")
3877 global
3878 {only for GTK GUI}
3879 List of ASCII characters that, when combined together, can create more
3880 complex shapes. Each character must be a printable ASCII character
3881 with a value in the 32-127 range.
3882 Example: >
3883 :set guiligatures=!\"#$%&()*+-./:<=>?@[]^_{\|~
3884< Changing this option updates screen output immediately. Set it to an
3885 empty string to disable ligatures.
3886
Bram Moolenaar071d4272004-06-13 20:20:40 +00003887 *'guioptions'* *'go'*
Bram Moolenaar2c64ca12018-10-19 16:22:31 +02003888'guioptions' 'go' string (default "egmrLtT" (MS-Windows,
3889 "t" is removed in |defaults.vim|),
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02003890 "aegimrLtT" (GTK, Motif and Athena),
3891 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00003892 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003893 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00003894 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003895 sequence of letters which describes what components and options of the
3896 GUI should be used.
3897 To avoid problems with flags that are added in the future, use the
3898 "+=" and "-=" feature of ":set" |add-option-flags|.
3899
Bram Moolenaar13568252018-03-16 20:46:58 +01003900 Valid characters are as follows:
3901 *'go-!'*
3902 '!' External commands are executed in a terminal window. Without
3903 this flag the MS-Windows GUI will open a console window to
3904 execute the command. The Unix GUI will simulate a dumb
3905 terminal to list the command output.
3906 The terminal window will be positioned at the bottom, and grow
3907 upwards as needed.
Bram Moolenaarba3ff532018-11-04 14:45:49 +01003908 *'go-a'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003909 'a' Autoselect: If present, then whenever VISUAL mode is started,
3910 or the Visual area extended, Vim tries to become the owner of
3911 the windowing system's global selection. This means that the
3912 Visually highlighted text is available for pasting into other
3913 applications as well as into Vim itself. When the Visual mode
3914 ends, possibly due to an operation on the text, or when an
3915 application wants to paste the selection, the highlighted text
3916 is automatically yanked into the "* selection register.
3917 Thus the selection is still available for pasting into other
3918 applications after the VISUAL mode has ended.
3919 If not present, then Vim won't become the owner of the
3920 windowing system's global selection unless explicitly told to
3921 by a yank or delete operation for the "* register.
3922 The same applies to the modeless selection.
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02003923 *'go-P'*
3924 'P' Like autoselect but using the "+ register instead of the "*
Bram Moolenaar3848e002016-03-19 18:42:29 +01003925 register.
Bram Moolenaar02467872007-05-06 13:22:01 +00003926 *'go-A'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003927 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003928 applies to the modeless selection.
3929
3930 'guioptions' autoselect Visual autoselect modeless ~
3931 "" - -
3932 "a" yes yes
3933 "A" - yes
3934 "aA" yes yes
3935
Bram Moolenaar02467872007-05-06 13:22:01 +00003936 *'go-c'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003937 'c' Use console dialogs instead of popup dialogs for simple
3938 choices.
Bram Moolenaar50bf7ce2019-09-15 13:17:00 +02003939 *'go-d'*
3940 'd' Use dark theme variant if available. Currently only works for
3941 GTK+ GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00003942 *'go-e'*
Bram Moolenaare224ffa2006-03-01 00:01:28 +00003943 'e' Add tab pages when indicated with 'showtabline'.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003944 'guitablabel' can be used to change the text in the labels.
3945 When 'e' is missing a non-GUI tab pages line may be used.
Bram Moolenaard68071d2006-05-02 22:08:30 +00003946 The GUI tabs are only supported on some systems, currently
Bram Moolenaarb3f74062020-02-26 16:16:53 +01003947 GTK, Motif, Mac OS/X, Haiku, and MS-Windows.
Bram Moolenaar02467872007-05-06 13:22:01 +00003948 *'go-f'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003949 'f' Foreground: Don't use fork() to detach the GUI from the shell
3950 where it was started. Use this for programs that wait for the
3951 editor to finish (e.g., an e-mail program). Alternatively you
3952 can use "gvim -f" or ":gui -f" to start the GUI in the
3953 foreground. |gui-fork|
3954 Note: Set this option in the vimrc file. The forking may have
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003955 happened already when the |gvimrc| file is read.
Bram Moolenaar02467872007-05-06 13:22:01 +00003956 *'go-i'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003957 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
3958 corner of the window. It's black&white on non-GTK, because of
3959 limitations of X11. For a color icon, see |X11-icon|.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003960 *'go-m'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003961 'm' Menu bar is present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003962 *'go-M'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003963 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00003964 that this flag must be added in the .vimrc file, before
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003965 switching on syntax or filetype recognition (when the |gvimrc|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003966 file is sourced the system menu has already been loaded; the
Bram Moolenaar01164a62017-11-02 22:58:42 +01003967 `:syntax on` and `:filetype on` commands load the menu too).
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003968 *'go-g'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003969 'g' Grey menu items: Make menu items that are not active grey. If
3970 'g' is not included inactive menu items are not shown at all.
3971 Exception: Athena will always use grey menu items.
Bram Moolenaar02467872007-05-06 13:22:01 +00003972 *'go-t'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003973 't' Include tearoff menu items. Currently only works for Win32,
3974 GTK+, and Motif 1.2 GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00003975 *'go-T'*
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00003976 'T' Include Toolbar. Currently only in Win32, GTK+, Motif, Photon
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00003977 and Athena GUIs.
Bram Moolenaar02467872007-05-06 13:22:01 +00003978 *'go-r'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003979 'r' Right-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003980 *'go-R'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003981 'R' Right-hand scrollbar is present when there is a vertically
3982 split window.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003983 *'go-l'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003984 'l' Left-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003985 *'go-L'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003986 'L' Left-hand scrollbar is present when there is a vertically
3987 split window.
Bram Moolenaar02467872007-05-06 13:22:01 +00003988 *'go-b'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003989 'b' Bottom (horizontal) scrollbar is present. Its size depends on
3990 the longest visible line, or on the cursor line if the 'h'
3991 flag is included. |gui-horiz-scroll|
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003992 *'go-h'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003993 'h' Limit horizontal scrollbar size to the length of the cursor
3994 line. Reduces computations. |gui-horiz-scroll|
3995
3996 And yes, you may even have scrollbars on the left AND the right if
3997 you really want to :-). See |gui-scrollbars| for more information.
3998
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003999 *'go-v'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004000 'v' Use a vertical button layout for dialogs. When not included,
4001 a horizontal layout is preferred, but when it doesn't fit a
Bram Moolenaardad44732021-03-31 20:07:33 +02004002 vertical layout is used anyway. Not supported in GTK 3.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004003 *'go-p'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004004 'p' Use Pointer callbacks for X11 GUI. This is required for some
4005 window managers. If the cursor is not blinking or hollow at
4006 the right moment, try adding this flag. This must be done
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004007 before starting the GUI. Set it in your |gvimrc|. Adding or
Bram Moolenaar071d4272004-06-13 20:20:40 +00004008 removing it after the GUI has started has no effect.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004009 *'go-F'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004010 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar8ac44152017-11-09 18:33:29 +01004011 *'go-k'*
4012 'k' Keep the GUI window size when adding/removing a scrollbar, or
4013 toolbar, tabline, etc. Instead, the behavior is similar to
4014 when the window is maximized and will adjust 'lines' and
4015 'columns' to fit to the window. Without the 'k' flag Vim will
Bram Moolenaar51b0f372017-11-18 18:52:04 +01004016 try to keep 'lines' and 'columns' the same when adding and
Bram Moolenaar8ac44152017-11-09 18:33:29 +01004017 removing GUI components.
Bram Moolenaar02467872007-05-06 13:22:01 +00004018
Bram Moolenaar071d4272004-06-13 20:20:40 +00004019 *'guipty'* *'noguipty'*
4020'guipty' boolean (default on)
4021 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004022 {only available when compiled with GUI enabled}
4023 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
4024 I/O to/from shell commands. See |gui-pty|.
4025
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004026 *'guitablabel'* *'gtl'*
4027'guitablabel' 'gtl' string (default empty)
4028 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02004029 {only available when compiled with GUI enabled}
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004030 When nonempty describes the text to use in a label of the GUI tab
Bram Moolenaard68071d2006-05-02 22:08:30 +00004031 pages line. When empty and when the result is empty Vim will use a
4032 default label. See |setting-guitablabel| for more info.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004033
Bram Moolenaara23ccb82006-02-27 00:08:02 +00004034 The format of this option is like that of 'statusline'.
Bram Moolenaar57657d82006-04-21 22:12:41 +00004035 'guitabtooltip' is used for the tooltip, see below.
Bram Moolenaar51628222016-12-01 23:03:28 +01004036 The expression will be evaluated in the |sandbox| when set from a
4037 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004038 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00004039
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004040 Only used when the GUI tab pages line is displayed. 'e' must be
4041 present in 'guioptions'. For the non-GUI tab pages line 'tabline' is
4042 used.
4043
Bram Moolenaar57657d82006-04-21 22:12:41 +00004044 *'guitabtooltip'* *'gtt'*
4045'guitabtooltip' 'gtt' string (default empty)
4046 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02004047 {only available when compiled with GUI enabled}
Bram Moolenaar57657d82006-04-21 22:12:41 +00004048 When nonempty describes the text to use in a tooltip for the GUI tab
4049 pages line. When empty Vim will use a default tooltip.
4050 This option is otherwise just like 'guitablabel' above.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004051 You can include a line break. Simplest method is to use |:let|: >
4052 :let &guitabtooltip = "line one\nline two"
4053<
Bram Moolenaar57657d82006-04-21 22:12:41 +00004054
Bram Moolenaar071d4272004-06-13 20:20:40 +00004055 *'helpfile'* *'hf'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01004056'helpfile' 'hf' string (default (MS-Windows) "$VIMRUNTIME\doc\help.txt"
Bram Moolenaar071d4272004-06-13 20:20:40 +00004057 (others) "$VIMRUNTIME/doc/help.txt")
4058 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004059 Name of the main help file. All distributed help files should be
4060 placed together in one directory. Additionally, all "doc" directories
4061 in 'runtimepath' will be used.
4062 Environment variables are expanded |:set_env|. For example:
4063 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004064 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00004065 spaces and backslashes.
4066 This option cannot be set from a |modeline| or in the |sandbox|, for
4067 security reasons.
4068
4069 *'helpheight'* *'hh'*
4070'helpheight' 'hh' number (default 20)
4071 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004072 Minimal initial height of the help window when it is opened with the
4073 ":help" command. The initial height of the help window is half of the
4074 current window, or (when the 'ea' option is on) the same as other
4075 windows. When the height is less than 'helpheight', the height is
4076 set to 'helpheight'. Set to zero to disable.
4077
4078 *'helplang'* *'hlg'*
4079'helplang' 'hlg' string (default: messages language or empty)
4080 global
4081 {only available when compiled with the |+multi_lang|
4082 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004083 Comma separated list of languages. Vim will use the first language
4084 for which the desired help can be found. The English help will always
4085 be used as a last resort. You can add "en" to prefer English over
4086 another language, but that will only find tags that exist in that
4087 language and not in the English help.
4088 Example: >
4089 :set helplang=de,it
4090< This will first search German, then Italian and finally English help
4091 files.
4092 When using |CTRL-]| and ":help!" in a non-English help file Vim will
4093 try to find the tag in the current language before using this option.
4094 See |help-translated|.
4095
4096 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
4097'hidden' 'hid' boolean (default off)
4098 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004099 When off a buffer is unloaded when it is |abandon|ed. When on a
4100 buffer becomes hidden when it is |abandon|ed. If the buffer is still
4101 displayed in another window, it does not become hidden, of course.
4102 The commands that move through the buffer list sometimes make a buffer
4103 hidden although the 'hidden' option is off: When the buffer is
4104 modified, 'autowrite' is off or writing is not possible, and the '!'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004105 flag was used. See also |windows.txt|.
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004106 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004107 This option is set for one command with ":hide {command}" |:hide|.
4108 WARNING: It's easy to forget that you have changes in hidden buffers.
4109 Think twice when using ":q!" or ":qa!".
4110
4111 *'highlight'* *'hl'*
4112'highlight' 'hl' string (default (as a single string):
Bram Moolenaar58b85342016-08-14 19:54:54 +02004113 "8:SpecialKey,~:EndOfBuffer,@:NonText,
4114 d:Directory,e:ErrorMsg,i:IncSearch,
4115 l:Search,m:MoreMsg,M:ModeMsg,n:LineNr,
Bram Moolenaarefae76a2019-10-27 22:54:58 +01004116 a:LineNrAbove,b:LineNrBelow,
Bram Moolenaar58b85342016-08-14 19:54:54 +02004117 N:CursorLineNr,r:Question,s:StatusLine,
4118 S:StatusLineNC,c:VertSplit,t:Title,
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004119 v:Visual,V:VisualNOS,w:WarningMsg,
4120 W:WildMenu,f:Folded,F:FoldColumn,
4121 A:DiffAdd,C:DiffChange,D:DiffDelete,
4122 T:DiffText,>:SignColumn,-:Conceal,
Bram Moolenaarc8c88492018-12-27 23:59:26 +01004123 B:SpellBad,P:SpellCap,R:SpellRare,
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004124 L:SpellLocal,+:Pmenu,=:PmenuSel,
Bram Moolenaar21020352017-06-13 17:21:04 +02004125 x:PmenuSbar,X:PmenuThumb,*:TabLine,
4126 #:TabLineSel,_:TabLineFill,!:CursorColumn,
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02004127 .:CursorLine,o:ColorColumn,q:QuickFixLine,
Bram Moolenaarc572da52017-08-27 16:52:01 +02004128 z:StatusLineTerm,Z:StatusLineTermNC")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004129 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004130 This option can be used to set highlighting mode for various
4131 occasions. It is a comma separated list of character pairs. The
4132 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004133 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004134 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
Bram Moolenaar58b85342016-08-14 19:54:54 +02004135 |hl-EndOfBuffer| ~ lines after the last line in the buffer
4136 |hl-NonText| @ '@' at the end of the window and
Bram Moolenaar071d4272004-06-13 20:20:40 +00004137 characters from 'showbreak'
4138 |hl-Directory| d directories in CTRL-D listing and other special
4139 things in listings
4140 |hl-ErrorMsg| e error messages
4141 h (obsolete, ignored)
4142 |hl-IncSearch| i 'incsearch' highlighting
4143 |hl-Search| l last search pattern highlighting (see 'hlsearch')
4144 |hl-MoreMsg| m |more-prompt|
4145 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
Bram Moolenaar64486672010-05-16 15:46:46 +02004146 |hl-LineNr| n line number for ":number" and ":#" commands, and
4147 when 'number' or 'relativenumber' option is set.
Bram Moolenaarefae76a2019-10-27 22:54:58 +01004148 |hl-LineNrAbove| a line number above the cursor for when the
4149 'relativenumber' option is set.
4150 |hl-LineNrBelow| b line number below the cursor for when the
4151 'relativenumber' option is set.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01004152 |hl-CursorLineNr| N like n for when 'cursorline' or 'relativenumber' is
4153 set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004154 |hl-Question| r |hit-enter| prompt and yes/no questions
4155 |hl-StatusLine| s status line of current window |status-line|
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01004156 |hl-StatusLineNC| S status lines of not-current windows
Bram Moolenaar071d4272004-06-13 20:20:40 +00004157 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
4158 |hl-VertSplit| c column used to separate vertically split windows
4159 |hl-Visual| v Visual mode
4160 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
4161 Selection" Only X11 Gui's |gui-x11| and
4162 |xterm-clipboard|.
4163 |hl-WarningMsg| w warning messages
4164 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
4165 |hl-Folded| f line used for closed folds
4166 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00004167 |hl-DiffAdd| A added line in diff mode
4168 |hl-DiffChange| C changed line in diff mode
4169 |hl-DiffDelete| D deleted line in diff mode
4170 |hl-DiffText| T inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00004171 |hl-SignColumn| > column used for |signs|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004172 |hl-Conceal| - the placeholders used for concealed characters
4173 (see 'conceallevel')
Bram Moolenaar217ad922005-03-20 22:37:15 +00004174 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02004175 |hl-SpellCap| P word that should start with capital |spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00004176 |hl-SpellRare| R rare word |spell|
4177 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004178 |hl-Pmenu| + popup menu normal line
4179 |hl-PmenuSel| = popup menu selected line
4180 |hl-PmenuSbar| x popup menu scrollbar
4181 |hl-PmenuThumb| X popup menu scrollbar thumb
Bram Moolenaar071d4272004-06-13 20:20:40 +00004182
4183 The display modes are:
4184 r reverse (termcap entry "mr" and "me")
4185 i italic (termcap entry "ZH" and "ZR")
4186 b bold (termcap entry "md" and "me")
4187 s standout (termcap entry "so" and "se")
4188 u underline (termcap entry "us" and "ue")
Bram Moolenaare2cc9702005-03-15 22:43:58 +00004189 c undercurl (termcap entry "Cs" and "Ce")
Bram Moolenaarcf4b00c2017-09-02 18:33:56 +02004190 t strikethrough (termcap entry "Ts" and "Te")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004191 n no highlighting
4192 - no highlighting
4193 : use a highlight group
4194 The default is used for occasions that are not included.
4195 If you want to change what the display modes do, see |dos-colors|
4196 for an example.
4197 When using the ':' display mode, this must be followed by the name of
4198 a highlight group. A highlight group can be used to define any type
4199 of highlighting, including using color. See |:highlight| on how to
4200 define one. The default uses a different group for each occasion.
4201 See |highlight-default| for the default highlight groups.
4202
Bram Moolenaar071d4272004-06-13 20:20:40 +00004203 *'history'* *'hi'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004204'history' 'hi' number (Vim default: 50, Vi default: 0,
4205 set to 200 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004206 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004207 A history of ":" commands, and a history of previous search patterns
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004208 is remembered. This option decides how many entries may be stored in
Bram Moolenaar071d4272004-06-13 20:20:40 +00004209 each of these histories (see |cmdline-editing|).
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004210 The maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004211 NOTE: This option is set to the Vi default value when 'compatible' is
4212 set and to the Vim default value when 'compatible' is reset.
4213
4214 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
4215'hkmap' 'hk' boolean (default off)
4216 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004217 {only available when compiled with the |+rightleft|
4218 feature}
4219 When on, the keyboard is mapped for the Hebrew character set.
4220 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
4221 toggle this option. See |rileft.txt|.
4222 NOTE: This option is reset when 'compatible' is set.
4223
4224 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
4225'hkmapp' 'hkp' boolean (default off)
4226 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004227 {only available when compiled with the |+rightleft|
4228 feature}
4229 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
4230 This is useful if you have a non-Hebrew keyboard.
4231 See |rileft.txt|.
4232 NOTE: This option is reset when 'compatible' is set.
4233
Bram Moolenaar036986f2017-03-16 17:41:02 +01004234 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
4235'hlsearch' 'hls' boolean (default off)
4236 global
Bram Moolenaar036986f2017-03-16 17:41:02 +01004237 {not available when compiled without the
4238 |+extra_search| feature}
4239 When there is a previous search pattern, highlight all its matches.
4240 The type of highlighting used can be set with the 'l' occasion in the
4241 'highlight' option. This uses the "Search" highlight group by
4242 default. Note that only the matching text is highlighted, any offsets
4243 are not applied.
4244 See also: 'incsearch' and |:match|.
4245 When you get bored looking at the highlighted matches, you can turn it
4246 off with |:nohlsearch|. This does not change the option value, as
4247 soon as you use a search command, the highlighting comes back.
4248 'redrawtime' specifies the maximum time spent on finding matches.
4249 When the search pattern can match an end-of-line, Vim will try to
4250 highlight all of the matched text. However, this depends on where the
4251 search starts. This will be the first line in the window or the first
4252 line below a closed fold. A match in a previous line which is not
4253 drawn may not continue in a newly drawn line.
4254 You can specify whether the highlight status is restored on startup
4255 with the 'h' flag in 'viminfo' |viminfo-h|.
4256 NOTE: This option is reset when 'compatible' is set.
4257
Bram Moolenaar071d4272004-06-13 20:20:40 +00004258 *'icon'* *'noicon'*
4259'icon' boolean (default off, on when title can be restored)
4260 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004261 When on, the icon text of the window will be set to the value of
4262 'iconstring' (if it is not empty), or to the name of the file
4263 currently being edited. Only the last part of the name is used.
4264 Overridden by the 'iconstring' option.
4265 Only works if the terminal supports setting window icons (currently
4266 only X11 GUI and terminals with a non-empty 't_IS' option - these are
4267 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
4268 builtin termcap).
4269 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00004270 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00004271 X11.
Bram Moolenaar3a991dd2014-10-02 01:41:41 +02004272 For MS-Windows the icon can be changed, see |windows-icon|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004273
4274 *'iconstring'*
4275'iconstring' string (default "")
4276 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004277 When this option is not empty, it will be used for the icon text of
4278 the window. This happens only when the 'icon' option is on.
4279 Only works if the terminal supports setting window icon text
4280 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02004281 Does not work for MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004282 When Vim was compiled with HAVE_X11 defined, the original icon will be
4283 restored if possible |X11|.
4284 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004285 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004286 'titlestring' for example settings.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004287 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004288 {not available when compiled without the |+statusline| feature}
4289
4290 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
4291'ignorecase' 'ic' boolean (default off)
4292 global
4293 Ignore case in search patterns. Also used when searching in the tags
4294 file.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01004295 Also see 'smartcase' and 'tagcase'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004296 Can be overruled by using "\c" or "\C" in the pattern, see
4297 |/ignorecase|.
4298
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004299 *'imactivatefunc'* *'imaf'*
4300'imactivatefunc' 'imaf' string (default "")
4301 global
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004302 This option specifies a function that will be called to
Yegappan Lakshmanan7645da52021-12-04 14:02:30 +00004303 activate or deactivate the Input Method. The value can be the name of
4304 a function, a |lambda| or a |Funcref|. See |option-value-function| for
4305 more information.
Bram Moolenaaref8c6172020-07-01 15:12:44 +02004306 It is not used in the MS-Windows GUI version.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004307 The expression will be evaluated in the |sandbox| when set from a
4308 modeline, see |sandbox-option|.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004309
4310 Example: >
4311 function ImActivateFunc(active)
4312 if a:active
4313 ... do something
4314 else
4315 ... do something
4316 endif
4317 " return value is not used
4318 endfunction
4319 set imactivatefunc=ImActivateFunc
4320<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004321 *'imactivatekey'* *'imak'*
4322'imactivatekey' 'imak' string (default "")
4323 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004324 {only available when compiled with |+xim| and
Bram Moolenaar67c53842010-05-22 18:28:27 +02004325 |+GUI_GTK|} *E599*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004326 Specifies the key that your Input Method in X-Windows uses for
4327 activation. When this is specified correctly, vim can fully control
4328 IM with 'imcmdline', 'iminsert' and 'imsearch'.
4329 You can't use this option to change the activation key, the option
4330 tells Vim what the key is.
4331 Format:
4332 [MODIFIER_FLAG-]KEY_STRING
4333
4334 These characters can be used for MODIFIER_FLAG (case is ignored):
4335 S Shift key
4336 L Lock key
4337 C Control key
4338 1 Mod1 key
4339 2 Mod2 key
4340 3 Mod3 key
4341 4 Mod4 key
4342 5 Mod5 key
4343 Combinations are allowed, for example "S-C-space" or "SC-space" are
4344 both shift+ctrl+space.
4345 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
4346
4347 Example: >
4348 :set imactivatekey=S-space
4349< "S-space" means shift+space. This is the activation key for kinput2 +
4350 canna (Japanese), and ami (Korean).
4351
4352 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
4353'imcmdline' 'imc' boolean (default off)
4354 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004355 When set the Input Method is always on when starting to edit a command
4356 line, unless entering a search pattern (see 'imsearch' for that).
4357 Setting this option is useful when your input method allows entering
4358 English characters directly, e.g., when it's used to type accented
4359 characters with dead keys.
4360
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004361 *'imdisable'* *'imd'* *'noimdisable'* *'noimd'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004362'imdisable' 'imd' boolean (default off, on for some systems (SGI))
4363 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004364 When set the Input Method is never used. This is useful to disable
4365 the IM when it doesn't work properly.
4366 Currently this option is on by default for SGI/IRIX machines. This
4367 may change in later releases.
4368
4369 *'iminsert'* *'imi'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004370'iminsert' 'imi' number (default 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004371 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004372 Specifies whether :lmap or an Input Method (IM) is to be used in
4373 Insert mode. Valid values:
4374 0 :lmap is off and IM is off
4375 1 :lmap is ON and IM is off
4376 2 :lmap is off and IM is ON
Bram Moolenaar071d4272004-06-13 20:20:40 +00004377 To always reset the option to zero when leaving Insert mode with <Esc>
4378 this can be used: >
4379 :inoremap <ESC> <ESC>:set iminsert=0<CR>
4380< This makes :lmap and IM turn off automatically when leaving Insert
4381 mode.
4382 Note that this option changes when using CTRL-^ in Insert mode
4383 |i_CTRL-^|.
4384 The value is set to 1 when setting 'keymap' to a valid keymap name.
4385 It is also used for the argument of commands like "r" and "f".
4386 The value 0 may not work correctly with Athena and Motif with some XIM
4387 methods. Use 'imdisable' to disable XIM then.
4388
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004389 You can set 'imactivatefunc' and 'imstatusfunc' to handle IME/XIM
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004390 via external command if Vim is not compiled with the |+xim|,
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004391 |+multi_byte_ime| or |global-ime|.
4392
Bram Moolenaar071d4272004-06-13 20:20:40 +00004393 *'imsearch'* *'ims'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004394'imsearch' 'ims' number (default -1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004395 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004396 Specifies whether :lmap or an Input Method (IM) is to be used when
4397 entering a search pattern. Valid values:
4398 -1 the value of 'iminsert' is used, makes it look like
4399 'iminsert' is also used when typing a search pattern
4400 0 :lmap is off and IM is off
4401 1 :lmap is ON and IM is off
4402 2 :lmap is off and IM is ON
4403 Note that this option changes when using CTRL-^ in Command-line mode
4404 |c_CTRL-^|.
4405 The value is set to 1 when it is not -1 and setting the 'keymap'
4406 option to a valid keymap name.
4407 The value 0 may not work correctly with Athena and Motif with some XIM
4408 methods. Use 'imdisable' to disable XIM then.
4409
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004410 *'imstatusfunc'* *'imsf'*
4411'imstatusfunc' 'imsf' string (default "")
4412 global
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004413 This option specifies a function that is called to obtain the status
4414 of Input Method. It must return a positive number when IME is active.
Yegappan Lakshmanan7645da52021-12-04 14:02:30 +00004415 The value can be the name of a function, a |lambda| or a |Funcref|.
4416 See |option-value-function| for more information.
Bram Moolenaaref8c6172020-07-01 15:12:44 +02004417 It is not used in the MS-Windows GUI version.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004418
4419 Example: >
4420 function ImStatusFunc()
4421 let is_active = ...do something
4422 return is_active ? 1 : 0
4423 endfunction
4424 set imstatusfunc=ImStatusFunc
4425<
4426 NOTE: This function is invoked very often. Keep it fast.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004427 The expression will be evaluated in the |sandbox| when set from a
4428 modeline, see |sandbox-option|.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004429
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004430 *'imstyle'* *'imst'*
4431'imstyle' 'imst' number (default 1)
4432 global
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004433 {only available when compiled with |+xim| and
4434 |+GUI_GTK|}
Bram Moolenaar37c64c72017-09-19 22:06:03 +02004435 This option specifies the input style of Input Method:
4436 0 use on-the-spot style
4437 1 over-the-spot style
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004438 See: |xim-input-style|
4439
Bram Moolenaar24a98a02017-09-27 22:23:55 +02004440 For a long time on-the-spot style had been used in the GTK version of
4441 vim, however, it is known that it causes troubles when using mappings,
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004442 |single-repeat|, etc. Therefore over-the-spot style becomes the
4443 default now. This should work fine for most people, however if you
4444 have any problem with it, try using on-the-spot style.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004445 The expression will be evaluated in the |sandbox| when set from a
4446 modeline, see |sandbox-option|.
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004447
Bram Moolenaar071d4272004-06-13 20:20:40 +00004448 *'include'* *'inc'*
4449'include' 'inc' string (default "^\s*#\s*include")
4450 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004451 {not available when compiled without the
4452 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004453 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00004454 pattern, just like for the "/" command (See |pattern|). The default
4455 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar1e015462005-09-25 22:16:38 +00004456 "]I", "[d", etc.
4457 Normally the 'isfname' option is used to recognize the file name that
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004458 comes after the matched pattern. But if "\zs" appears in the pattern
4459 then the text matched from "\zs" to the end, or until "\ze" if it
4460 appears, is used as the file name. Use this to include characters
4461 that are not in 'isfname', such as a space. You can then use
4462 'includeexpr' to process the matched text.
Bram Moolenaar1e015462005-09-25 22:16:38 +00004463 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004464
4465 *'includeexpr'* *'inex'*
4466'includeexpr' 'inex' string (default "")
4467 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004468 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004469 |+find_in_path| or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004470 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004471 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004472 :set includeexpr=substitute(v:fname,'\\.','/','g')
4473< The "v:fname" variable will be set to the file name that was detected.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004474
Bram Moolenaar071d4272004-06-13 20:20:40 +00004475 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004476 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004477 Also used for |<cfile>|.
4478
Yegappan Lakshmanan8bb65f22021-12-26 10:51:39 +00004479 If the expression starts with s: or |<SID>|, then it is replaced with
4480 the script ID (|local-function|). Example: >
4481 set includeexpr=s:MyIncludeExpr(v:fname)
4482 set includeexpr=<SID>SomeIncludeExpr(v:fname)
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00004483< Otherwise, the expression is evaluated in the context of the script
4484 where the option was set, thus script-local items are available.
4485
Bram Moolenaar30b65812012-07-12 22:01:11 +02004486 The expression will be evaluated in the |sandbox| when set from a
4487 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004488 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004489
4490 It is not allowed to change text or jump to another window while
4491 evaluating 'includeexpr' |textlock|.
4492
Bram Moolenaar071d4272004-06-13 20:20:40 +00004493 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004494'incsearch' 'is' boolean (default off, set in |defaults.vim| if the
4495 +reltime feature is supported)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004496 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004497 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004498 |+extra_search| features}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004499 While typing a search command, show where the pattern, as it was typed
4500 so far, matches. The matched string is highlighted. If the pattern
4501 is invalid or not found, nothing is shown. The screen will be updated
4502 often, this is only useful on fast terminals.
Bram Moolenaarfc65cab2018-08-28 22:58:02 +02004503 Also applies to the pattern in commands: >
4504 :global
4505 :lvimgrep
4506 :lvimgrepadd
4507 :smagic
4508 :snomagic
4509 :sort
4510 :substitute
4511 :vglobal
4512 :vimgrep
4513 :vimgrepadd
4514< Note that the match will be shown, but the cursor will return to its
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004515 original position when no match is found and when pressing <Esc>. You
4516 still need to finish the search command with <Enter> to move the
4517 cursor to the match.
Bram Moolenaardc083282016-10-11 08:57:33 +02004518 You can use the CTRL-G and CTRL-T keys to move to the next and
4519 previous match. |c_CTRL-G| |c_CTRL-T|
Bram Moolenaar91a4e822008-01-19 14:59:58 +00004520 When compiled with the |+reltime| feature Vim only searches for about
4521 half a second. With a complicated pattern and/or a lot of text the
4522 match may not be found. This is to avoid that Vim hangs while you
4523 are typing the pattern.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004524 The highlighting can be set with the 'i' flag in 'highlight'.
Bram Moolenaar2f058492017-11-30 20:27:52 +01004525 When 'hlsearch' is on, all matched strings are highlighted too while
4526 typing a search command. See also: 'hlsearch'.
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004527 If you don't want to turn 'hlsearch' on, but want to highlight all
4528 matches while searching, you can turn on and off 'hlsearch' with
4529 autocmd. Example: >
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004530 augroup vimrc-incsearch-highlight
4531 autocmd!
Bram Moolenaarf8f8b2e2017-11-02 19:08:48 +01004532 autocmd CmdlineEnter /,\? :set hlsearch
4533 autocmd CmdlineLeave /,\? :set nohlsearch
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004534 augroup END
4535<
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004536 CTRL-L can be used to add one character from after the current match
Bram Moolenaara9dc3752010-07-11 20:46:53 +02004537 to the command line. If 'ignorecase' and 'smartcase' are set and the
4538 command line has no uppercase characters, the added character is
4539 converted to lowercase.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004540 CTRL-R CTRL-W can be used to add the word at the end of the current
4541 match, excluding the characters that were already typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004542 NOTE: This option is reset when 'compatible' is set.
4543
4544 *'indentexpr'* *'inde'*
4545'indentexpr' 'inde' string (default "")
4546 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004547 {not available when compiled without the |+cindent|
4548 or |+eval| features}
4549 Expression which is evaluated to obtain the proper indent for a line.
4550 It is used when a new line is created, for the |=| operator and
4551 in Insert mode as specified with the 'indentkeys' option.
4552 When this option is not empty, it overrules the 'cindent' and
Bram Moolenaar20f90cf2011-05-19 12:22:51 +02004553 'smartindent' indenting. When 'lisp' is set, this option is
4554 overridden by the Lisp indentation algorithm.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004555 When 'paste' is set this option is not used for indenting.
4556 The expression is evaluated with |v:lnum| set to the line number for
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004557 which the indent is to be computed. The cursor is also in this line
Bram Moolenaar071d4272004-06-13 20:20:40 +00004558 when the expression is evaluated (but it may be moved around).
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00004559
Yegappan Lakshmanan8bb65f22021-12-26 10:51:39 +00004560 If the expression starts with s: or |<SID>|, then it is replaced with
4561 the script ID (|local-function|). Example: >
4562 set indentexpr=s:MyIndentExpr()
4563 set indentexpr=<SID>SomeIndentExpr()
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00004564< Otherwise, the expression is evaluated in the context of the script
4565 where the option was set, thus script-local items are available.
4566
Bram Moolenaar071d4272004-06-13 20:20:40 +00004567 The expression must return the number of spaces worth of indent. It
4568 can return "-1" to keep the current indent (this means 'autoindent' is
4569 used for the indent).
4570 Functions useful for computing the indent are |indent()|, |cindent()|
4571 and |lispindent()|.
4572 The evaluation of the expression must not have side effects! It must
4573 not change the text, jump to another window, etc. Afterwards the
4574 cursor position is always restored, thus the cursor may be moved.
4575 Normally this option would be set to call a function: >
4576 :set indentexpr=GetMyIndent()
4577< Error messages will be suppressed, unless the 'debug' option contains
4578 "msg".
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004579 See |indent-expression|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01004580 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004581
Bram Moolenaar30b65812012-07-12 22:01:11 +02004582 The expression will be evaluated in the |sandbox| when set from a
4583 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004584 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004585
4586 It is not allowed to change text or jump to another window while
4587 evaluating 'indentexpr' |textlock|.
4588
4589
Bram Moolenaar071d4272004-06-13 20:20:40 +00004590 *'indentkeys'* *'indk'*
Bram Moolenaarce655742019-01-31 14:12:57 +01004591'indentkeys' 'indk' string (default "0{,0},0),0],:,0#,!^F,o,O,e")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004592 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004593 {not available when compiled without the |+cindent|
4594 feature}
4595 A list of keys that, when typed in Insert mode, cause reindenting of
4596 the current line. Only happens if 'indentexpr' isn't empty.
4597 The format is identical to 'cinkeys', see |indentkeys-format|.
4598 See |C-indenting| and |indent-expression|.
4599
4600 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
4601'infercase' 'inf' boolean (default off)
4602 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004603 When doing keyword completion in insert mode |ins-completion|, and
Bram Moolenaar446cb832008-06-24 21:56:24 +00004604 'ignorecase' is also on, the case of the match is adjusted depending
4605 on the typed text. If the typed text contains a lowercase letter
4606 where the match has an upper case letter, the completed part is made
4607 lowercase. If the typed text has no lowercase letters and the match
4608 has a lowercase letter where the typed text has an uppercase letter,
4609 and there is a letter before it, the completed part is made uppercase.
4610 With 'noinfercase' the match is used as-is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004611
4612 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
4613'insertmode' 'im' boolean (default off)
4614 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004615 Makes Vim work in a way that Insert mode is the default mode. Useful
4616 if you want to use Vim as a modeless editor. Used for |evim|.
4617 These Insert mode commands will be useful:
4618 - Use the cursor keys to move around.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02004619 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|. When
Bram Moolenaar071d4272004-06-13 20:20:40 +00004620 this is a mapping, it is executed as if 'insertmode' was off.
4621 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004622 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00004623 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
4624 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004625
4626 These items change when 'insertmode' is set:
4627 - when starting to edit of a file, Vim goes to Insert mode.
4628 - <Esc> in Insert mode is a no-op and beeps.
4629 - <Esc> in Normal mode makes Vim go to Insert mode.
4630 - CTRL-L in Insert mode is a command, it is not inserted.
4631 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
4632 However, when <Esc> is used inside a mapping, it behaves like
4633 'insertmode' was not set. This was done to be able to use the same
4634 mappings with 'insertmode' set or not set.
4635 When executing commands with |:normal| 'insertmode' is not used.
4636
4637 NOTE: This option is reset when 'compatible' is set.
4638
4639 *'isfname'* *'isf'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004640'isfname' 'isf' string (default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004641 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
4642 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
4643 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
4644 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
4645 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
4646 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004647 The characters specified by this option are included in file names and
4648 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004649 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004650 Multi-byte characters 256 and above are always included, only the
4651 characters up to 255 are specified with this option.
4652 For UTF-8 the characters 0xa0 to 0xff are included as well.
Bram Moolenaar446cb832008-06-24 21:56:24 +00004653 Think twice before adding white space to this option. Although a
4654 space may appear inside a file name, the effect will be that Vim
4655 doesn't know where a file name starts or ends when doing completion.
4656 It most likely works better without a space in 'isfname'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004657
4658 Note that on systems using a backslash as path separator, Vim tries to
4659 do its best to make it work as you would expect. That is a bit
4660 tricky, since Vi originally used the backslash to escape special
4661 characters. Vim will not remove a backslash in front of a normal file
4662 name character on these systems, but it will on Unix and alikes. The
4663 '&' and '^' are not included by default, because these are special for
4664 cmd.exe.
4665
4666 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004667 Each part can be a single character number or a range. A range is two
4668 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004669 decimal number between 0 and 255 or the ASCII character itself (does
4670 not work for digits). Example:
4671 "_,-,128-140,#-43" (include '_' and '-' and the range
4672 128 to 140 and '#' to 43)
4673 If a part starts with '^', the following character number or range
4674 will be excluded from the option. The option is interpreted from left
4675 to right. Put the excluded character after the range where it is
4676 included. To include '^' itself use it as the last character of the
4677 option or the end of a range. Example:
4678 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
4679 If the character is '@', all characters where isalpha() returns TRUE
4680 are included. Normally these are the characters a to z and A to Z,
4681 plus accented characters. To include '@' itself use "@-@". Examples:
4682 "@,^a-z" All alphabetic characters, excluding lower
Bram Moolenaar446cb832008-06-24 21:56:24 +00004683 case ASCII letters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004684 "a-z,A-Z,@-@" All letters plus the '@' character.
4685 A comma can be included by using it where a character number is
4686 expected. Example:
4687 "48-57,,,_" Digits, comma and underscore.
4688 A comma can be excluded by prepending a '^'. Example:
4689 " -~,^,,9" All characters from space to '~', excluding
4690 comma, plus <Tab>.
4691 See |option-backslash| about including spaces and backslashes.
4692
4693 *'isident'* *'isi'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004694'isident' 'isi' string (default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004695 "@,48-57,_,128-167,224-235"
4696 otherwise: "@,48-57,_,192-255")
4697 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004698 The characters given by this option are included in identifiers.
4699 Identifiers are used in recognizing environment variables and after a
4700 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00004701 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004702 option. For '@' only characters up to 255 are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004703 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004704 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00004705 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
4706
4707 *'iskeyword'* *'isk'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004708'iskeyword' 'isk' string (Vim default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004709 "@,48-57,_,128-167,224-235"
4710 otherwise: "@,48-57,_,192-255"
4711 Vi default: "@,48-57,_")
4712 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004713 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004714 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004715 'isfname' for a description of the format of this option. For '@'
Bram Moolenaar4c295022021-05-02 17:19:11 +02004716 characters above 255 check the "word" character class (any character
4717 that is not white space or punctuation).
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004718 For C programs you could use "a-z,A-Z,48-57,_,.,-,>".
Bram Moolenaar071d4272004-06-13 20:20:40 +00004719 For a help file it is set to all non-blank printable characters except
4720 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
4721 command).
4722 When the 'lisp' option is on the '-' character is always included.
Bram Moolenaarb8060fe2016-01-19 22:29:28 +01004723 This option also influences syntax highlighting, unless the syntax
4724 uses |:syn-iskeyword|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004725 NOTE: This option is set to the Vi default value when 'compatible' is
4726 set and to the Vim default value when 'compatible' is reset.
4727
4728 *'isprint'* *'isp'*
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02004729'isprint' 'isp' string (default for Win32 and macOS:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004730 "@,~-255"; otherwise: "@,161-255")
4731 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004732 The characters given by this option are displayed directly on the
4733 screen. It is also used for "\p" in a |pattern|. The characters from
4734 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
4735 even when they are not included in 'isprint' or excluded. See
4736 'isfname' for a description of the format of this option.
4737
4738 Non-printable characters are displayed with two characters:
4739 0 - 31 "^@" - "^_"
4740 32 - 126 always single characters
4741 127 "^?"
4742 128 - 159 "~@" - "~_"
4743 160 - 254 "| " - "|~"
4744 255 "~?"
4745 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
4746 displayed as <xx>, with the hexadecimal value of the byte.
4747 When 'display' contains "uhex" all unprintable characters are
4748 displayed as <xx>.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004749 The SpecialKey highlighting will be used for unprintable characters.
4750 |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004751
4752 Multi-byte characters 256 and above are always included, only the
4753 characters up to 255 are specified with this option. When a character
4754 is printable but it is not available in the current font, a
4755 replacement character will be shown.
4756 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
4757 There is no option to specify these characters.
4758
4759 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
4760'joinspaces' 'js' boolean (default on)
4761 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004762 Insert two spaces after a '.', '?' and '!' with a join command.
4763 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
4764 Otherwise only one space is inserted.
4765 NOTE: This option is set when 'compatible' is set.
4766
4767 *'key'*
4768'key' string (default "")
4769 local to buffer
Bram Moolenaar996343d2010-07-04 22:20:21 +02004770 {only available when compiled with the |+cryptv|
4771 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004772 The key that is used for encrypting and decrypting the current buffer.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02004773 See |encryption| and 'cryptmethod'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004774 Careful: Do not set the key value by hand, someone might see the typed
4775 key. Use the |:X| command. But you can make 'key' empty: >
4776 :set key=
4777< It is not possible to get the value of this option with ":set key" or
4778 "echo &key". This is to avoid showing it to someone who shouldn't
4779 know. It also means you cannot see it yourself once you have set it,
4780 be careful not to make a typing error!
Bram Moolenaard58e9292011-02-09 17:07:58 +01004781 You can use "&key" in an expression to detect whether encryption is
4782 enabled. When 'key' is set it returns "*****" (five stars).
Bram Moolenaar071d4272004-06-13 20:20:40 +00004783
4784 *'keymap'* *'kmp'* *E544*
4785'keymap' 'kmp' string (default "")
4786 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004787 {only available when compiled with the |+keymap|
4788 feature}
4789 Name of a keyboard mapping. See |mbyte-keymap|.
4790 Setting this option to a valid keymap name has the side effect of
4791 setting 'iminsert' to one, so that the keymap becomes effective.
4792 'imsearch' is also set to one, unless it was -1
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004793 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004794
4795 *'keymodel'* *'km'*
4796'keymodel' 'km' string (default "")
4797 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004798 List of comma separated words, which enable special things that keys
4799 can do. These values can be used:
4800 startsel Using a shifted special key starts selection (either
4801 Select mode or Visual mode, depending on "key" being
4802 present in 'selectmode').
4803 stopsel Using a not-shifted special key stops selection.
4804 Special keys in this context are the cursor keys, <End>, <Home>,
4805 <PageUp> and <PageDown>.
4806 The 'keymodel' option is set by the |:behave| command.
4807
4808 *'keywordprg'* *'kp'*
4809'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02004810 VMS: "help")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004811 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004812 Program to use for the |K| command. Environment variables are
4813 expanded |:set_env|. ":help" may be used to access the Vim internal
4814 help. (Note that previously setting the global option to the empty
4815 value did this, which is now deprecated.)
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02004816 When the first character is ":", the command is invoked as a Vim
4817 Ex command prefixed with [count].
4818 When "man", "man -s" or an Ex command is used, Vim will automatically
4819 translate a count for the "K" command and pass it as the first
4820 argument. For "man -s" the "-s" is removed when there is no count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004821 See |option-backslash| about including spaces and backslashes.
4822 Example: >
4823 :set keywordprg=man\ -s
4824< This option cannot be set from a |modeline| or in the |sandbox|, for
4825 security reasons.
4826
4827 *'langmap'* *'lmap'* *E357* *E358*
4828'langmap' 'lmap' string (default "")
4829 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004830 {only available when compiled with the |+langmap|
4831 feature}
4832 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004833 mode. When you are typing text in Insert mode the characters are
Bram Moolenaarfa735342016-01-03 22:14:44 +01004834 inserted directly. When in Normal mode the 'langmap' option takes
Bram Moolenaar071d4272004-06-13 20:20:40 +00004835 care of translating these special characters to the original meaning
4836 of the key. This means you don't have to change the keyboard mode to
4837 be able to execute Normal mode commands.
4838 This is the opposite of the 'keymap' option, where characters are
4839 mapped in Insert mode.
Bram Moolenaarb17893a2020-03-14 08:19:51 +01004840 Also consider setting 'langremap' to off, to prevent 'langmap' from
4841 applying to characters resulting from a mapping.
Bram Moolenaare968e362014-05-13 20:23:24 +02004842 This option cannot be set from a |modeline| or in the |sandbox|, for
4843 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004844
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00004845 Example (for Greek, in UTF-8): *greek* >
4846 :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 +00004847< Example (exchanges meaning of z and y for commands): >
4848 :set langmap=zy,yz,ZY,YZ
4849<
4850 The 'langmap' option is a list of parts, separated with commas. Each
4851 part can be in one of two forms:
4852 1. A list of pairs. Each pair is a "from" character immediately
4853 followed by the "to" character. Examples: "aA", "aAbBcC".
4854 2. A list of "from" characters, a semi-colon and a list of "to"
4855 characters. Example: "abc;ABC"
4856 Example: "aA,fgh;FGH,cCdDeE"
4857 Special characters need to be preceded with a backslash. These are
Bram Moolenaar4f4d51a2020-10-11 13:57:40 +02004858 ";", ',', '"', '|' and backslash itself.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004859
4860 This will allow you to activate vim actions without having to switch
4861 back and forth between the languages. Your language characters will
4862 be understood as normal vim English characters (according to the
4863 langmap mappings) in the following cases:
4864 o Normal/Visual mode (commands, buffer/register names, user mappings)
4865 o Insert/Replace Mode: Register names after CTRL-R
4866 o Insert/Replace Mode: Mappings
4867 Characters entered in Command-line mode will NOT be affected by
4868 this option. Note that this option can be changed at any time
4869 allowing to switch between mappings for different languages/encodings.
4870 Use a mapping to avoid having to type it each time!
4871
4872 *'langmenu'* *'lm'*
4873'langmenu' 'lm' string (default "")
4874 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004875 {only available when compiled with the |+menu| and
4876 |+multi_lang| features}
4877 Language to use for menu translation. Tells which file is loaded
4878 from the "lang" directory in 'runtimepath': >
4879 "lang/menu_" . &langmenu . ".vim"
4880< (without the spaces). For example, to always use the Dutch menus, no
4881 matter what $LANG is set to: >
4882 :set langmenu=nl_NL.ISO_8859-1
4883< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004884 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004885 If your $LANG is set to a non-English language but you do want to use
4886 the English menus: >
4887 :set langmenu=none
4888< This option must be set before loading menus, switching on filetype
4889 detection or syntax highlighting. Once the menus are defined setting
4890 this option has no effect. But you could do this: >
4891 :source $VIMRUNTIME/delmenu.vim
4892 :set langmenu=de_DE.ISO_8859-1
4893 :source $VIMRUNTIME/menu.vim
4894< Warning: This deletes all menus that you defined yourself!
4895
Bram Moolenaard94464e2015-11-02 15:28:18 +01004896 *'langnoremap'* *'lnr'* *'nolangnoremap'* *'nolnr'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004897'langnoremap' 'lnr' boolean (default off, set in |defaults.vim|)
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004898 global
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004899 {only available when compiled with the |+langmap|
4900 feature}
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004901 This is just like 'langremap' but with the value inverted. It only
4902 exists for backwards compatibility. When setting 'langremap' then
4903 'langnoremap' is set to the inverted value, and the other way around.
4904
4905 *'langremap'* *'lrm'* *'nolangremap'* *'nolrm'*
Bram Moolenaarb17893a2020-03-14 08:19:51 +01004906'langremap' 'lrm' boolean (default on, set to off in |defaults.vim|)
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004907 global
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004908 {only available when compiled with the |+langmap|
4909 feature}
4910 When off, setting 'langmap' does not apply to characters resulting from
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004911 a mapping. This basically means, if you noticed that setting
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004912 'langmap' disables some of your mappings, try resetting this option.
4913 This option defaults to on for backwards compatibility. Set it off if
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004914 that works for you to avoid mappings to break.
4915
Bram Moolenaar071d4272004-06-13 20:20:40 +00004916 *'laststatus'* *'ls'*
4917'laststatus' 'ls' number (default 1)
4918 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004919 The value of this option influences when the last window will have a
4920 status line:
4921 0: never
4922 1: only if there are at least two windows
4923 2: always
4924 The screen looks nicer with a status line if you have several
4925 windows, but it takes another screen line. |status-line|
4926
4927 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
4928'lazyredraw' 'lz' boolean (default off)
4929 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004930 When this option is set, the screen will not be redrawn while
4931 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004932 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00004933 update use |:redraw|.
4934
4935 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
4936'linebreak' 'lbr' boolean (default off)
4937 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02004938 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004939 feature}
Bram Moolenaar946e27a2014-06-25 18:50:27 +02004940 If on, Vim will wrap long lines at a character in 'breakat' rather
Bram Moolenaar071d4272004-06-13 20:20:40 +00004941 than at the last character that fits on the screen. Unlike
4942 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
Bram Moolenaar946e27a2014-06-25 18:50:27 +02004943 it only affects the way the file is displayed, not its contents.
4944 If 'breakindent' is set, line is visually indented. Then, the value
4945 of 'showbreak' is used to put in front of wrapped lines. This option
Bram Moolenaar86b17e92014-07-02 20:00:47 +02004946 is not used when the 'wrap' option is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004947 Note that <Tab> characters after an <EOL> are mostly not displayed
4948 with the right amount of white space.
4949
4950 *'lines'* *E593*
4951'lines' number (default 24 or terminal height)
4952 global
4953 Number of lines of the Vim window.
4954 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00004955 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004956 When Vim is running in the GUI or in a resizable window, setting this
4957 option will cause the window size to be changed. When you only want
4958 to use the size for the GUI, put the command in your |gvimrc| file.
4959 Vim limits the number of lines to what fits on the screen. You can
4960 use this command to get the tallest window possible: >
4961 :set lines=999
Bram Moolenaarf4d11452005-12-02 00:46:37 +00004962< Minimum value is 2, maximum value is 1000.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02004963 If you get fewer lines than expected, check the 'guiheadroom' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004964 When you set this option and Vim is unable to change the physical
4965 number of lines of the display, the display may be messed up.
4966
4967 *'linespace'* *'lsp'*
4968'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
4969 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004970 {only in the GUI}
4971 Number of pixel lines inserted between characters. Useful if the font
4972 uses the full character cell height, making lines touch each other.
4973 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004974 With some fonts there can be too much room between lines (to have
4975 space for ascents and descents). Then it makes sense to set
4976 'linespace' to a negative value. This may cause display problems
4977 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00004978
4979 *'lisp'* *'nolisp'*
4980'lisp' boolean (default off)
4981 local to buffer
4982 {not available when compiled without the |+lispindent|
4983 feature}
4984 Lisp mode: When <Enter> is typed in insert mode set the indent for
4985 the next line to Lisp standards (well, sort of). Also happens with
4986 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
4987 flag in 'cpoptions' changes the method of indenting: Vi compatible or
4988 better. Also see 'lispwords'.
4989 The '-' character is included in keyword characters. Redefines the
4990 "=" operator to use this same indentation algorithm rather than
4991 calling an external program if 'equalprg' is empty.
4992 This option is not used when 'paste' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004993
4994 *'lispwords'* *'lw'*
4995'lispwords' 'lw' string (default is very long)
Bram Moolenaaraf6c1312014-03-12 18:55:58 +01004996 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004997 {not available when compiled without the |+lispindent|
4998 feature}
4999 Comma separated list of words that influence the Lisp indenting.
5000 |'lisp'|
5001
5002 *'list'* *'nolist'*
5003'list' boolean (default off)
5004 local to window
Bram Moolenaar113cb512021-11-07 20:27:04 +00005005 List mode: By default show tabs as CTRL-I is displayed, display $
5006 after end of line. Useful to see the difference between tabs and
5007 spaces and for trailing blanks. Further changed by the 'listchars'
5008 option.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005009
5010 The cursor is displayed at the start of the space a Tab character
5011 occupies, not at the end as usual in Normal mode. To get this cursor
5012 position while displaying Tabs with spaces, use: >
Bram Moolenaardd007ed2013-07-09 15:44:17 +02005013 :set list lcs=tab:\ \
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005014<
5015 Note that list mode will also affect formatting (set with 'textwidth'
5016 or 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005017 changing the way tabs are displayed.
5018
5019 *'listchars'* *'lcs'*
5020'listchars' 'lcs' string (default "eol:$")
Bram Moolenaareed9d462021-02-15 20:38:25 +01005021 global or local to window |global-local|
Bram Moolenaarf9d5ca12010-08-01 16:13:51 +02005022 Strings to use in 'list' mode and for the |:list| command. It is a
5023 comma separated list of string settings.
Bram Moolenaar79278362015-04-21 18:33:48 +02005024 *lcs-eol*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005025 eol:c Character to show at the end of each line. When
5026 omitted, there is no extra character at the end of the
5027 line.
Bram Moolenaar79278362015-04-21 18:33:48 +02005028 *lcs-tab*
Bram Moolenaar83a52172019-01-16 22:41:54 +01005029 tab:xy[z] Two or three characters to be used to show a tab.
5030 The third character is optional.
5031
5032 tab:xy The 'x' is always used, then 'y' as many times as will
5033 fit. Thus "tab:>-" displays:
5034 >
5035 >-
5036 >--
5037 etc.
5038
5039 tab:xyz The 'z' is always used, then 'x' is prepended, and
5040 then 'y' is used as many times as will fit. Thus
5041 "tab:<->" displays:
5042 >
5043 <>
5044 <->
5045 <-->
5046 etc.
5047
5048 When "tab:" is omitted, a tab is shown as ^I.
Bram Moolenaar79278362015-04-21 18:33:48 +02005049 *lcs-space*
5050 space:c Character to show for a space. When omitted, spaces
5051 are left blank.
zeertzjqf14b8ba2021-09-10 16:58:30 +02005052 *lcs-multispace*
5053 multispace:c...
5054 One or more characters to use cyclically to show for
5055 multiple consecutive spaces. Overrides the "space"
5056 setting, except for single spaces. When omitted, the
5057 "space" setting is used. For example,
5058 `:set listchars=multispace:---+` shows ten consecutive
5059 spaces as:
5060 ---+---+--
Bram Moolenaar91478ae2021-02-03 15:58:13 +01005061 *lcs-lead*
5062 lead:c Character to show for leading spaces. When omitted,
zeertzjqf14b8ba2021-09-10 16:58:30 +02005063 leading spaces are blank. Overrides the "space" and
5064 "multispace" settings for leading spaces. You can
5065 combine it with "tab:", for example: >
Bram Moolenaar942db232021-02-13 18:14:48 +01005066 :set listchars+=tab:>-,lead:.
5067< *lcs-trail*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005068 trail:c Character to show for trailing spaces. When omitted,
zeertzjqf14b8ba2021-09-10 16:58:30 +02005069 trailing spaces are blank. Overrides the "space" and
5070 "multispace" settings for trailing spaces.
Bram Moolenaar79278362015-04-21 18:33:48 +02005071 *lcs-extends*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005072 extends:c Character to show in the last column, when 'wrap' is
5073 off and the line continues beyond the right of the
5074 screen.
Bram Moolenaar79278362015-04-21 18:33:48 +02005075 *lcs-precedes*
Bram Moolenaarbffba7f2019-09-20 17:00:17 +02005076 precedes:c Character to show in the first visible column of the
5077 physical line, when there is text preceding the
5078 character visible in the first column.
Bram Moolenaar79278362015-04-21 18:33:48 +02005079 *lcs-conceal*
Bram Moolenaar860cae12010-06-05 23:22:07 +02005080 conceal:c Character to show in place of concealed text, when
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02005081 'conceallevel' is set to 1.
Bram Moolenaar79278362015-04-21 18:33:48 +02005082 *lcs-nbsp*
Bram Moolenaar73284b92015-05-04 17:28:22 +02005083 nbsp:c Character to show for a non-breakable space character
5084 (0xA0 (160 decimal) and U+202F). Left blank when
5085 omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005086
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005087 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00005088 be used when 'encoding' is "utf-8", otherwise only printable
Bram Moolenaar910f66f2006-04-05 20:41:53 +00005089 characters are allowed. All characters must be single width.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005090
Bram Moolenaar93ff6722021-10-16 17:51:40 +01005091 Each character can be specified as hex: >
5092 set listchars=eol:\\x24
5093 set listchars=eol:\\u21b5
5094 set listchars=eol:\\U000021b5
5095< Note that a double backslash is used. The number of hex characters
5096 must be exactly 2 for \\x, 4 for \\u and 8 for \\U.
5097
Bram Moolenaar071d4272004-06-13 20:20:40 +00005098 Examples: >
5099 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005100 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00005101 :set lcs=extends:>,precedes:<
5102< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaar34cc7d82021-09-21 20:09:51 +02005103 "precedes". "SpecialKey" will be used for "tab", "nbsp", "space",
5104 "multispace", "lead" and "trail".
Bram Moolenaar02467872007-05-06 13:22:01 +00005105 |hl-NonText| |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005106
5107 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
5108'loadplugins' 'lpl' boolean (default on)
5109 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005110 When on the plugin scripts are loaded when starting up |load-plugins|.
5111 This option can be reset in your |vimrc| file to disable the loading
5112 of plugins.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02005113 Note that using the "-u NONE", "-u DEFAULTS" and "--noplugin" command
5114 line arguments reset this option. See |-u| and |--noplugin|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005115
Bram Moolenaard94464e2015-11-02 15:28:18 +01005116 *'luadll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01005117'luadll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01005118 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01005119 {only available when compiled with the |+lua/dyn|
5120 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005121 Specifies the name of the Lua shared library. The default is
5122 DYNAMIC_LUA_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005123 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01005124 This option cannot be set from a |modeline| or in the |sandbox|, for
5125 security reasons.
5126
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00005127 *'macatsui'* *'nomacatsui'*
5128'macatsui' boolean (default on)
5129 global
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02005130 {not supported}
5131 No longer supported, as the Mac OS X GUI code was removed.
Bram Moolenaar02467872007-05-06 13:22:01 +00005132
Bram Moolenaar071d4272004-06-13 20:20:40 +00005133 *'magic'* *'nomagic'*
5134'magic' boolean (default on)
5135 global
5136 Changes the special characters that can be used in search patterns.
5137 See |pattern|.
Bram Moolenaar64d8e252016-09-06 22:12:34 +02005138 WARNING: Switching this option off most likely breaks plugins! That
5139 is because many patterns assume it's on and will fail when it's off.
5140 Only switch it off when working with old Vi scripts. In any other
5141 situation write patterns that work when 'magic' is on. Include "\M"
5142 when you want to |/\M|.
Bram Moolenaar4072ba52020-12-23 13:56:35 +01005143 In |Vim9| script the value of 'magic' is ignored, patterns behave like
5144 it is always set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005145
5146 *'makeef'* *'mef'*
5147'makeef' 'mef' string (default: "")
5148 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005149 {not available when compiled without the |+quickfix|
5150 feature}
5151 Name of the errorfile for the |:make| command (see |:make_makeprg|)
5152 and the |:grep| command.
5153 When it is empty, an internally generated temp file will be used.
5154 When "##" is included, it is replaced by a number to make the name
5155 unique. This makes sure that the ":make" command doesn't overwrite an
5156 existing file.
5157 NOT used for the ":cf" command. See 'errorfile' for that.
5158 Environment variables are expanded |:set_env|.
5159 See |option-backslash| about including spaces and backslashes.
5160 This option cannot be set from a |modeline| or in the |sandbox|, for
5161 security reasons.
5162
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01005163 *'makeencoding'* *'menc'*
5164'makeencoding' 'menc' string (default "")
5165 global or local to buffer |global-local|
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01005166 Encoding used for reading the output of external commands. When empty,
5167 encoding is not converted.
5168 This is used for `:make`, `:lmake`, `:grep`, `:lgrep`, `:grepadd`,
5169 `:lgrepadd`, `:cfile`, `:cgetfile`, `:caddfile`, `:lfile`, `:lgetfile`,
5170 and `:laddfile`.
5171
5172 This would be mostly useful when you use MS-Windows and set 'encoding'
5173 to "utf-8". If |+iconv| is enabled and GNU libiconv is used, setting
5174 'makeencoding' to "char" has the same effect as setting to the system
5175 locale encoding. Example: >
5176 :set encoding=utf-8
5177 :set makeencoding=char " system locale is used
5178<
Bram Moolenaar071d4272004-06-13 20:20:40 +00005179 *'makeprg'* *'mp'*
5180'makeprg' 'mp' string (default "make", VMS: "MMS")
5181 global or local to buffer |global-local|
Bram Moolenaar02467872007-05-06 13:22:01 +00005182 Program to use for the ":make" command. See |:make_makeprg|.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01005183 This option may contain '%' and '#' characters (see |:_%| and |:_#|),
5184 which are expanded to the current and alternate file name. Use |::S|
Bram Moolenaar26df0922014-02-23 23:39:13 +01005185 to escape file names in case they contain special characters.
Bram Moolenaar02467872007-05-06 13:22:01 +00005186 Environment variables are expanded |:set_env|. See |option-backslash|
5187 about including spaces and backslashes.
5188 Note that a '|' must be escaped twice: once for ":set" and once for
5189 the interpretation of a command. When you use a filter called
5190 "myfilter" do it like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005191 :set makeprg=gmake\ \\\|\ myfilter
5192< The placeholder "$*" can be given (even multiple times) to specify
5193 where the arguments will be included, for example: >
5194 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
5195< This option cannot be set from a |modeline| or in the |sandbox|, for
5196 security reasons.
5197
5198 *'matchpairs'* *'mps'*
5199'matchpairs' 'mps' string (default "(:),{:},[:]")
5200 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005201 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01005202 other.
5203 Only character pairs are allowed that are different, thus you cannot
5204 jump between two double quotes.
5205 The characters must be separated by a colon.
Bram Moolenaar02467872007-05-06 13:22:01 +00005206 The pairs must be separated by a comma. Example for including '<' and
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02005207 '>' (for HTML): >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005208 :set mps+=<:>
5209
5210< A more exotic example, to jump between the '=' and ';' in an
5211 assignment, useful for languages like C and Java: >
5212 :au FileType c,cpp,java set mps+==:;
5213
5214< For a more advanced way of using "%", see the matchit.vim plugin in
Bram Moolenaar01164a62017-11-02 22:58:42 +01005215 the $VIMRUNTIME/pack/dist/opt/matchit directory. |add-local-help|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005216
5217 *'matchtime'* *'mat'*
5218'matchtime' 'mat' number (default 5)
5219 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005220 Tenths of a second to show the matching paren, when 'showmatch' is
5221 set. Note that this is not in milliseconds, like other options that
5222 set a time. This is to be compatible with Nvi.
5223
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005224 *'maxcombine'* *'mco'*
5225'maxcombine' 'mco' number (default 2)
5226 global
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005227 The maximum number of combining characters supported for displaying.
5228 Only used when 'encoding' is "utf-8".
5229 The default is OK for most languages. Hebrew may require 4.
5230 Maximum value is 6.
5231 Even when this option is set to 2 you can still edit text with more
5232 combining characters, you just can't see them. Use |g8| or |ga|.
5233 See |mbyte-combining|.
5234
Bram Moolenaar071d4272004-06-13 20:20:40 +00005235 *'maxfuncdepth'* *'mfd'*
5236'maxfuncdepth' 'mfd' number (default 100)
5237 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02005238 {not available when compiled without the |+eval|
Bram Moolenaar02467872007-05-06 13:22:01 +00005239 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005240 Maximum depth of function calls for user functions. This normally
5241 catches endless recursion. When using a recursive function with
5242 more depth, set 'maxfuncdepth' to a bigger number. But this will use
5243 more memory, there is the danger of failing when memory is exhausted.
Bram Moolenaarbc2eada2017-01-02 21:27:47 +01005244 Increasing this limit above 200 also changes the maximum for Ex
Bram Moolenaar0b0f0992018-05-22 21:41:30 +02005245 command recursion, see |E169|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005246 See also |:function|.
5247
5248 *'maxmapdepth'* *'mmd'* *E223*
5249'maxmapdepth' 'mmd' number (default 1000)
5250 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005251 Maximum number of times a mapping is done without resulting in a
5252 character to be used. This normally catches endless mappings, like
5253 ":map x y" with ":map y x". It still does not catch ":map g wg",
5254 because the 'w' is used before the next mapping is done. See also
5255 |key-mapping|.
5256
5257 *'maxmem'* *'mm'*
5258'maxmem' 'mm' number (default between 256 to 5120 (system
5259 dependent) or half the amount of memory
5260 available)
5261 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005262 Maximum amount of memory (in Kbyte) to use for one buffer. When this
5263 limit is reached allocating extra memory for a buffer will cause
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005264 other memory to be freed.
5265 The maximum usable value is about 2000000. Use this to work without a
5266 limit.
5267 The value is ignored when 'swapfile' is off.
5268 Also see 'maxmemtot'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005269
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005270 *'maxmempattern'* *'mmp'*
5271'maxmempattern' 'mmp' number (default 1000)
5272 global
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005273 Maximum amount of memory (in Kbyte) to use for pattern matching.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005274 The maximum value is about 2000000. Use this to work without a limit.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005275 *E363*
Bram Moolenaar02467872007-05-06 13:22:01 +00005276 When Vim runs into the limit it gives an error message and mostly
5277 behaves like CTRL-C was typed.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005278 Running into the limit often means that the pattern is very
5279 inefficient or too complex. This may already happen with the pattern
5280 "\(.\)*" on a very long line. ".*" works much better.
Bram Moolenaarfd358112018-07-07 23:21:31 +02005281 Might also happen on redraw, when syntax rules try to match a complex
5282 text structure.
5283 Vim may run out of memory before hitting the 'maxmempattern' limit, in
5284 which case you get an "Out of memory" error instead.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005285
Bram Moolenaar071d4272004-06-13 20:20:40 +00005286 *'maxmemtot'* *'mmt'*
5287'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
5288 dependent) or half the amount of memory
5289 available)
5290 global
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005291 Maximum amount of memory in Kbyte to use for all buffers together.
5292 The maximum usable value is about 2000000 (2 Gbyte). Use this to work
Bram Moolenaarfa735342016-01-03 22:14:44 +01005293 without a limit.
5294 On 64 bit machines higher values might work. But hey, do you really
5295 need more than 2 Gbyte for text editing? Keep in mind that text is
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005296 stored in the swap file, one can edit files > 2 Gbyte anyway. We do
Bram Moolenaarfa735342016-01-03 22:14:44 +01005297 need the memory to store undo info.
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005298 Buffers with 'swapfile' off still count to the total amount of memory
5299 used.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005300 Also see 'maxmem'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005301
5302 *'menuitems'* *'mis'*
5303'menuitems' 'mis' number (default 25)
5304 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005305 {not available when compiled without the |+menu|
5306 feature}
5307 Maximum number of items to use in a menu. Used for menus that are
5308 generated from a list of items, e.g., the Buffers menu. Changing this
5309 option has no direct effect, the menu must be refreshed first.
5310
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005311 *'mkspellmem'* *'msm'*
5312'mkspellmem' 'msm' string (default "460000,2000,500")
5313 global
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005314 {not available when compiled without the |+syntax|
5315 feature}
5316 Parameters for |:mkspell|. This tunes when to start compressing the
5317 word tree. Compression can be slow when there are many words, but
5318 it's needed to avoid running out of memory. The amount of memory used
5319 per word depends very much on how similar the words are, that's why
5320 this tuning is complicated.
5321
5322 There are three numbers, separated by commas:
5323 {start},{inc},{added}
5324
5325 For most languages the uncompressed word tree fits in memory. {start}
5326 gives the amount of memory in Kbyte that can be used before any
5327 compression is done. It should be a bit smaller than the amount of
5328 memory that is available to Vim.
5329
5330 When going over the {start} limit the {inc} number specifies the
5331 amount of memory in Kbyte that can be allocated before another
5332 compression is done. A low number means compression is done after
5333 less words are added, which is slow. A high number means more memory
5334 will be allocated.
5335
5336 After doing compression, {added} times 1024 words can be added before
5337 the {inc} limit is ignored and compression is done when any extra
5338 amount of memory is needed. A low number means there is a smaller
5339 chance of hitting the {inc} limit, less memory is used but it's
5340 slower.
5341
5342 The languages for which these numbers are important are Italian and
5343 Hungarian. The default works for when you have about 512 Mbyte. If
5344 you have 1 Gbyte you could use: >
5345 :set mkspellmem=900000,3000,800
5346< If you have less than 512 Mbyte |:mkspell| may fail for some
5347 languages, no matter what you set 'mkspellmem' to.
5348
Bram Moolenaar07607392019-05-26 19:20:43 +02005349 This option cannot be set from a |modeline| or in the |sandbox|.
5350
Bram Moolenaar071d4272004-06-13 20:20:40 +00005351 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
Bram Moolenaar8243a792007-05-01 17:05:03 +00005352'modeline' 'ml' boolean (Vim default: on (off for root),
5353 Vi default: off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005354 local to buffer
Bram Moolenaar110289e2019-05-23 15:38:06 +02005355 If 'modeline' is on 'modelines' gives the number of lines that is
5356 checked for set commands. If 'modeline' is off or 'modelines' is zero
5357 no lines are checked. See |modeline|.
5358
5359 *'modelineexpr'* *'mle'* *'nomodelineexpr'* *'nomle'*
5360'modelineexpr' 'mle' boolean (default: off)
5361 global
5362 When on allow some options that are an expression to be set in the
5363 modeline. Check the option for whether it is affected by
5364 'modelineexpr'. Also see |modeline|.
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02005365 This option cannot be set from a |modeline| or in the |sandbox|, for
5366 security reasons.
Bram Moolenaar110289e2019-05-23 15:38:06 +02005367
Bram Moolenaar071d4272004-06-13 20:20:40 +00005368 *'modelines'* *'mls'*
5369'modelines' 'mls' number (default 5)
5370 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005371 If 'modeline' is on 'modelines' gives the number of lines that is
5372 checked for set commands. If 'modeline' is off or 'modelines' is zero
5373 no lines are checked. See |modeline|.
5374 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
5375 set and to the Vim default value when 'compatible' is reset.
5376
5377 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
Bram Moolenaar110289e2019-05-23 15:38:06 +02005378 *E21*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005379'modifiable' 'ma' boolean (default on)
5380 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005381 When off the buffer contents cannot be changed. The 'fileformat' and
5382 'fileencoding' options also can't be changed.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01005383 Can be reset on startup with the |-M| command line argument.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005384
5385 *'modified'* *'mod'* *'nomodified'* *'nomod'*
5386'modified' 'mod' boolean (default off)
5387 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005388 When on, the buffer is considered to be modified. This option is set
5389 when:
5390 1. A change was made to the text since it was last written. Using the
5391 |undo| command to go back to the original text will reset the
5392 option. But undoing changes that were made before writing the
5393 buffer will set the option again, since the text is different from
5394 when it was written.
5395 2. 'fileformat' or 'fileencoding' is different from its original
5396 value. The original value is set when the buffer is read or
5397 written. A ":set nomodified" command also resets the original
5398 values to the current values and the 'modified' option will be
5399 reset.
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01005400 Similarly for 'eol' and 'bomb'.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02005401 This option is not set when a change is made to the buffer as the
5402 result of a BufNewFile, BufRead/BufReadPost, BufWritePost,
5403 FileAppendPost or VimLeave autocommand event. See |gzip-example| for
5404 an explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005405 When 'buftype' is "nowrite" or "nofile" this option may be set, but
5406 will be ignored.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01005407 Note that the text may actually be the same, e.g. 'modified' is set
5408 when using "rA" on an "A".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005409
5410 *'more'* *'nomore'*
5411'more' boolean (Vim default: on, Vi default: off)
5412 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005413 When on, listings pause when the whole screen is filled. You will get
5414 the |more-prompt|. When this option is off there are no pauses, the
5415 listing continues until finished.
5416 NOTE: This option is set to the Vi default value when 'compatible' is
5417 set and to the Vim default value when 'compatible' is reset.
5418
Bram Moolenaar98a29d02021-01-18 19:55:44 +01005419 *'mouse'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005420'mouse' string (default "", "a" for GUI and Win32,
Bram Moolenaar5b418992019-10-27 18:50:25 +01005421 set to "a" or "nvi" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005422 global
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005423 Enable the use of the mouse. Works for most terminals (xterm, Win32
5424 |win32-mouse|, QNX pterm, *BSD console with sysmouse and Linux console
5425 with gpm). For using the mouse in the GUI, see |gui-mouse|. The
5426 mouse can be enabled for different modes:
Bram Moolenaar7f2e9d72017-11-11 20:58:53 +01005427 n Normal mode and Terminal modes
Bram Moolenaar071d4272004-06-13 20:20:40 +00005428 v Visual mode
5429 i Insert mode
5430 c Command-line mode
5431 h all previous modes when editing a help file
5432 a all previous modes
5433 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005434 Normally you would enable the mouse in all five modes with: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005435 :set mouse=a
Bram Moolenaar5b418992019-10-27 18:50:25 +01005436< If your terminal can't overrule the mouse events going to the
5437 application, use: >
5438 :set mouse=nvi
Bram Moolenaar65e0d772020-06-14 17:29:55 +02005439< Then you can press ":", select text for the system, and press Esc to go
Bram Moolenaar5b418992019-10-27 18:50:25 +01005440 back to Vim using the mouse events.
5441 In |defaults.vim| "nvi" is used if the 'term' option is not matching
5442 "xterm".
5443
5444 When the mouse is not enabled, the GUI will still use the mouse for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005445 modeless selection. This doesn't move the text cursor.
5446
5447 See |mouse-using|. Also see |'clipboard'|.
5448
5449 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005450 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005451 the mouse buttons can still be used by keeping the shift key pressed.
5452 Also see the 'clipboard' option.
5453
5454 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
5455'mousefocus' 'mousef' boolean (default off)
5456 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005457 {only works in the GUI}
5458 The window that the mouse pointer is on is automatically activated.
5459 When changing the window layout or window focus in another way, the
5460 mouse pointer is moved to the window with keyboard focus. Off is the
5461 default because it makes using the pull down menus a little goofy, as
5462 a pointer transit may activate a window unintentionally.
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01005463 MS-Windows: Also see 'scrollfocus' for what window is scrolled when
Bram Moolenaar1d9215b2020-01-25 13:27:42 +01005464 using the mouse scroll wheel.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005465
5466 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
5467'mousehide' 'mh' boolean (default on)
5468 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005469 {only works in the GUI}
5470 When on, the mouse pointer is hidden when characters are typed.
5471 The mouse pointer is restored when the mouse is moved.
5472
5473 *'mousemodel'* *'mousem'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005474'mousemodel' 'mousem' string (default "extend", "popup" for Win32)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005475 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005476 Sets the model to use for the mouse. The name mostly specifies what
5477 the right mouse button is used for:
5478 extend Right mouse button extends a selection. This works
5479 like in an xterm.
5480 popup Right mouse button pops up a menu. The shifted left
5481 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00005482 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005483 popup_setpos Like "popup", but the cursor will be moved to the
5484 position where the mouse was clicked, and thus the
5485 selected operation will act upon the clicked object.
5486 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00005487 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005488 course, that right clicking outside a selection will
5489 end Visual mode.
5490 Overview of what button does what for each model:
5491 mouse extend popup(_setpos) ~
5492 left click place cursor place cursor
5493 left drag start selection start selection
5494 shift-left search word extend selection
5495 right click extend selection popup menu (place cursor)
5496 right drag extend selection -
5497 middle click paste paste
5498
5499 In the "popup" model the right mouse button produces a pop-up menu.
5500 You need to define this first, see |popup-menu|.
5501
5502 Note that you can further refine the meaning of buttons with mappings.
5503 See |gui-mouse-mapping|. But mappings are NOT used for modeless
5504 selection (because that's handled in the GUI code directly).
5505
5506 The 'mousemodel' option is set by the |:behave| command.
5507
5508 *'mouseshape'* *'mouses'* *E547*
Bram Moolenaarf6b40102019-02-22 15:24:03 +01005509'mouseshape' 'mouses' string (default "i-r:beam,s:updown,sd:udsizing,
5510 vs:leftright,vd:lrsizing,m:no,
5511 ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005512 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005513 {only available when compiled with the |+mouseshape|
5514 feature}
5515 This option tells Vim what the mouse pointer should look like in
5516 different modes. The option is a comma separated list of parts, much
5517 like used for 'guicursor'. Each part consist of a mode/location-list
5518 and an argument-list:
5519 mode-list:shape,mode-list:shape,..
5520 The mode-list is a dash separated list of these modes/locations:
5521 In a normal window: ~
5522 n Normal mode
5523 v Visual mode
5524 ve Visual mode with 'selection' "exclusive" (same as 'v',
5525 if not specified)
5526 o Operator-pending mode
5527 i Insert mode
5528 r Replace mode
5529
5530 Others: ~
5531 c appending to the command-line
5532 ci inserting in the command-line
5533 cr replacing in the command-line
5534 m at the 'Hit ENTER' or 'More' prompts
5535 ml idem, but cursor in the last line
5536 e any mode, pointer below last window
5537 s any mode, pointer on a status line
5538 sd any mode, while dragging a status line
5539 vs any mode, pointer on a vertical separator line
5540 vd any mode, while dragging a vertical separator line
5541 a everywhere
5542
5543 The shape is one of the following:
5544 avail name looks like ~
5545 w x arrow Normal mouse pointer
5546 w x blank no pointer at all (use with care!)
5547 w x beam I-beam
5548 w x updown up-down sizing arrows
5549 w x leftright left-right sizing arrows
5550 w x busy The system's usual busy pointer
5551 w x no The system's usual 'no input' pointer
5552 x udsizing indicates up-down resizing
5553 x lrsizing indicates left-right resizing
5554 x crosshair like a big thin +
5555 x hand1 black hand
5556 x hand2 white hand
5557 x pencil what you write with
5558 x question big ?
5559 x rightup-arrow arrow pointing right-up
5560 w x up-arrow arrow pointing up
5561 x <number> any X11 pointer number (see X11/cursorfont.h)
5562
5563 The "avail" column contains a 'w' if the shape is available for Win32,
5564 x for X11.
5565 Any modes not specified or shapes not available use the normal mouse
5566 pointer.
5567
5568 Example: >
5569 :set mouseshape=s:udsizing,m:no
5570< will make the mouse turn to a sizing arrow over the status lines and
5571 indicate no input when the hit-enter prompt is displayed (since
5572 clicking the mouse has no effect in this state.)
5573
5574 *'mousetime'* *'mouset'*
5575'mousetime' 'mouset' number (default 500)
5576 global
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005577 Only for GUI, Win32 and Unix with xterm. Defines the maximum
Bram Moolenaar071d4272004-06-13 20:20:40 +00005578 time in msec between two mouse clicks for the second click to be
5579 recognized as a multi click.
5580
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005581 *'mzschemedll'*
5582'mzschemedll' string (default depends on the build)
5583 global
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005584 {only available when compiled with the |+mzscheme/dyn|
5585 feature}
5586 Specifies the name of the MzScheme shared library. The default is
5587 DYNAMIC_MZSCH_DLL which was specified at compile time.
5588 Environment variables are expanded |:set_env|.
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01005589 The value must be set in the |vimrc| script or earlier. In the
Bram Moolenaar01164a62017-11-02 22:58:42 +01005590 startup, before the |load-plugins| step.
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005591 This option cannot be set from a |modeline| or in the |sandbox|, for
5592 security reasons.
5593
5594 *'mzschemegcdll'*
5595'mzschemegcdll' string (default depends on the build)
5596 global
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005597 {only available when compiled with the |+mzscheme/dyn|
5598 feature}
5599 Specifies the name of the MzScheme GC shared library. The default is
5600 DYNAMIC_MZGC_DLL which was specified at compile time.
5601 The value can be equal to 'mzschemedll' if it includes the GC code.
5602 Environment variables are expanded |:set_env|.
5603 This option cannot be set from a |modeline| or in the |sandbox|, for
5604 security reasons.
5605
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005606 *'mzquantum'* *'mzq'*
5607'mzquantum' 'mzq' number (default 100)
5608 global
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005609 {not available when compiled without the |+mzscheme|
5610 feature}
5611 The number of milliseconds between polls for MzScheme threads.
5612 Negative or zero value means no thread scheduling.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005613 NOTE: This option is set to the Vim default value when 'compatible'
5614 is reset.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005615
Bram Moolenaar071d4272004-06-13 20:20:40 +00005616 *'nrformats'* *'nf'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02005617'nrformats' 'nf' string (default "bin,octal,hex",
5618 set to "bin,hex" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005619 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005620 This defines what bases Vim will consider for numbers when using the
5621 CTRL-A and CTRL-X commands for adding to and subtracting from a number
5622 respectively; see |CTRL-A| for more info on these commands.
Bram Moolenaar4770d092006-01-12 23:22:24 +00005623 alpha If included, single alphabetical characters will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005624 incremented or decremented. This is useful for a list with a
Bram Moolenaar3848e002016-03-19 18:42:29 +01005625 letter index a), b), etc. *octal-nrformats*
Bram Moolenaar4770d092006-01-12 23:22:24 +00005626 octal If included, numbers that start with a zero will be considered
Bram Moolenaar071d4272004-06-13 20:20:40 +00005627 to be octal. Example: Using CTRL-A on "007" results in "010".
Bram Moolenaar4770d092006-01-12 23:22:24 +00005628 hex If included, numbers starting with "0x" or "0X" will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005629 considered to be hexadecimal. Example: Using CTRL-X on
5630 "0x100" results in "0x0ff".
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005631 bin If included, numbers starting with "0b" or "0B" will be
5632 considered to be binary. Example: Using CTRL-X on
5633 "0b1000" subtracts one, resulting in "0b0111".
Bram Moolenaaraaad9952020-05-31 15:08:59 +02005634 unsigned If included, numbers are recognized as unsigned. Thus a
5635 leading dash or negative sign won't be considered as part of
5636 the number. Examples:
5637 Using CTRL-X on "2020" in "9-2020" results in "9-2019"
5638 (without "unsigned" it would become "9-2021").
5639 Using CTRL-A on "2020" in "9-2020" results in "9-2021"
5640 (without "unsigned" it would become "9-2019").
Bram Moolenaaracc22402020-06-07 21:07:18 +02005641 Using CTRL-X on "0" or CTRL-A on "18446744073709551615"
5642 (2^64 - 1) has no effect, overflow is prevented.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005643 Numbers which simply begin with a digit in the range 1-9 are always
5644 considered decimal. This also happens for numbers that are not
5645 recognized as octal or hex.
5646
5647 *'number'* *'nu'* *'nonumber'* *'nonu'*
5648'number' 'nu' boolean (default off)
5649 local to window
5650 Print the line number in front of each line. When the 'n' option is
5651 excluded from 'cpoptions' a wrapped line will not use the column of
5652 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005653 The 'numberwidth' option can be used to set the room used for the line
5654 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005655 When a long, wrapped line doesn't start with the first character, '-'
5656 characters are put before the number.
James McCoya80aad72021-12-22 19:45:28 +00005657 For highlighting see |hl-LineNr|, and |hl-CursorLineNr|, and the
5658 |:sign-define| "numhl" argument.
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005659 *number_relativenumber*
5660 The 'relativenumber' option changes the displayed number to be
5661 relative to the cursor. Together with 'number' there are these
5662 four combinations (cursor in line 3):
5663
Bram Moolenaar3848e002016-03-19 18:42:29 +01005664 'nonu' 'nu' 'nonu' 'nu'
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005665 'nornu' 'nornu' 'rnu' 'rnu'
5666
5667 |apple | 1 apple | 2 apple | 2 apple
5668 |pear | 2 pear | 1 pear | 1 pear
5669 |nobody | 3 nobody | 0 nobody |3 nobody
5670 |there | 4 there | 1 there | 1 there
Bram Moolenaar071d4272004-06-13 20:20:40 +00005671
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005672 *'numberwidth'* *'nuw'*
5673'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
5674 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005675 {only available when compiled with the |+linebreak|
5676 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005677 Minimal number of columns to use for the line number. Only relevant
Bram Moolenaar64486672010-05-16 15:46:46 +02005678 when the 'number' or 'relativenumber' option is set or printing lines
5679 with a line number. Since one space is always between the number and
5680 the text, there is one less character for the number itself.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005681 The value is the minimum width. A bigger width is used when needed to
Bram Moolenaar64486672010-05-16 15:46:46 +02005682 fit the highest line number in the buffer respectively the number of
5683 rows in the window, depending on whether 'number' or 'relativenumber'
5684 is set. Thus with the Vim default of 4 there is room for a line number
5685 up to 999. When the buffer has 1000 lines five columns will be used.
Bram Moolenaarf8a07122019-07-01 22:06:07 +02005686 The minimum value is 1, the maximum value is 20.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005687 NOTE: This option is set to the Vi default value when 'compatible' is
5688 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005689
Bram Moolenaarf75a9632005-09-13 21:20:47 +00005690 *'omnifunc'* *'ofu'*
5691'omnifunc' 'ofu' string (default: empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00005692 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02005693 {not available when compiled without the |+eval|
Bram Moolenaare2c453d2019-08-21 14:37:09 +02005694 feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00005695 This option specifies a function to be used for Insert mode omni
5696 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
Bram Moolenaar280f1262006-01-30 00:14:18 +00005697 See |complete-functions| for an explanation of how the function is
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00005698 invoked and what it should return. The value can be the name of a
5699 function, a |lambda| or a |Funcref|. See |option-value-function| for
5700 more information.
Bram Moolenaar043545e2006-10-10 16:44:07 +00005701 This option is usually set by a filetype plugin:
Bram Moolenaar9c102382006-05-03 21:26:49 +00005702 |:filetype-plugin-on|
Bram Moolenaar30b65812012-07-12 22:01:11 +02005703 This option cannot be set from a |modeline| or in the |sandbox|, for
5704 security reasons.
Bram Moolenaare344bea2005-09-01 20:46:49 +00005705
5706
Bram Moolenaar02467872007-05-06 13:22:01 +00005707 *'opendevice'* *'odev'* *'noopendevice'* *'noodev'*
Bram Moolenaar043545e2006-10-10 16:44:07 +00005708'opendevice' 'odev' boolean (default off)
5709 global
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00005710 {only for MS-Windows} *E796*
Bram Moolenaar043545e2006-10-10 16:44:07 +00005711 Enable reading and writing from devices. This may get Vim stuck on a
5712 device that can be opened but doesn't actually do the I/O. Therefore
5713 it is off by default.
5714 Note that on MS-Windows editing "aux.h", "lpt1.txt" and the like also
5715 result in editing a device.
5716
5717
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005718 *'operatorfunc'* *'opfunc'*
5719'operatorfunc' 'opfunc' string (default: empty)
5720 global
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005721 This option specifies a function to be called by the |g@| operator.
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +00005722 See |:map-operator| for more info and an example. The value can be
5723 the name of a function, a |lambda| or a |Funcref|. See
5724 |option-value-function| for more information.
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005725
5726 This option cannot be set from a |modeline| or in the |sandbox|, for
5727 security reasons.
5728
5729
Bram Moolenaar251e1912011-06-19 05:09:16 +02005730 *'osfiletype'* *'oft'*
5731'osfiletype' 'oft' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005732 local to buffer
Bram Moolenaar251e1912011-06-19 05:09:16 +02005733 This option was supported on RISC OS, which has been removed.
5734
Bram Moolenaar071d4272004-06-13 20:20:40 +00005735
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005736 *'packpath'* *'pp'*
5737'packpath' 'pp' string (default: see 'runtimepath')
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005738 Directories used to find packages. See |packages|.
5739
5740
Bram Moolenaar071d4272004-06-13 20:20:40 +00005741 *'paragraphs'* *'para'*
Bram Moolenaar57e48462008-03-12 16:38:55 +00005742'paragraphs' 'para' string (default "IPLPPPQPP TPHPLIPpLpItpplpipbp")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005743 global
5744 Specifies the nroff macros that separate paragraphs. These are pairs
5745 of two letters (see |object-motions|).
5746
5747 *'paste'* *'nopaste'*
5748'paste' boolean (default off)
5749 global
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005750 Put Vim in Paste mode. This is useful if you want to cut or copy
5751 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005752 unexpected effects.
5753 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005754 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00005755 knows about pasting and will mostly do the right thing without 'paste'
5756 being set. The same is true for a terminal where Vim handles the
5757 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00005758 This option is reset when starting the GUI. Thus if you set it in
5759 your .vimrc it will work in a terminal, but not in the GUI. Setting
5760 'paste' in the GUI has side effects: e.g., the Paste toolbar button
5761 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005762 When the 'paste' option is switched on (also when it was already on):
5763 - mapping in Insert mode and Command-line mode is disabled
5764 - abbreviations are disabled
Bram Moolenaar071d4272004-06-13 20:20:40 +00005765 - 'autoindent' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02005766 - 'expandtab' is reset
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02005767 - 'hkmap' is reset
Bram Moolenaar071d4272004-06-13 20:20:40 +00005768 - 'revins' is reset
5769 - 'ruler' is reset
5770 - 'showmatch' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02005771 - 'smarttab' is reset
5772 - 'softtabstop' is set to 0
5773 - 'textwidth' is set to 0
5774 - 'wrapmargin' is set to 0
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02005775 - 'varsofttabstop' is made empty
Bram Moolenaar071d4272004-06-13 20:20:40 +00005776 These options keep their value, but their effect is disabled:
Bram Moolenaar071d4272004-06-13 20:20:40 +00005777 - 'cindent'
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02005778 - 'formatoptions' is used like it is empty
Bram Moolenaarca635012015-09-25 20:34:21 +02005779 - 'indentexpr'
5780 - 'lisp'
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02005781 - 'smartindent'
Bram Moolenaar071d4272004-06-13 20:20:40 +00005782 NOTE: When you start editing another file while the 'paste' option is
5783 on, settings from the modelines or autocommands may change the
5784 settings again, causing trouble when pasting text. You might want to
5785 set the 'paste' option again.
5786 When the 'paste' option is reset the mentioned options are restored to
5787 the value before the moment 'paste' was switched from off to on.
5788 Resetting 'paste' before ever setting it does not have any effect.
5789 Since mapping doesn't work while 'paste' is active, you need to use
5790 the 'pastetoggle' option to toggle the 'paste' option with some key.
5791
5792 *'pastetoggle'* *'pt'*
5793'pastetoggle' 'pt' string (default "")
5794 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005795 When non-empty, specifies the key sequence that toggles the 'paste'
5796 option. This is like specifying a mapping: >
5797 :map {keys} :set invpaste<CR>
5798< Where {keys} is the value of 'pastetoggle'.
5799 The difference is that it will work even when 'paste' is set.
5800 'pastetoggle' works in Insert mode and Normal mode, but not in
5801 Command-line mode.
5802 Mappings are checked first, thus overrule 'pastetoggle'. However,
5803 when 'paste' is on mappings are ignored in Insert mode, thus you can do
5804 this: >
5805 :map <F10> :set paste<CR>
5806 :map <F11> :set nopaste<CR>
5807 :imap <F10> <C-O>:set paste<CR>
5808 :imap <F11> <nop>
5809 :set pastetoggle=<F11>
5810< This will make <F10> start paste mode and <F11> stop paste mode.
5811 Note that typing <F10> in paste mode inserts "<F10>", since in paste
5812 mode everything is inserted literally, except the 'pastetoggle' key
5813 sequence.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005814 When the value has several bytes 'ttimeoutlen' applies.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005815
5816 *'pex'* *'patchexpr'*
5817'patchexpr' 'pex' string (default "")
5818 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005819 {not available when compiled without the |+diff|
5820 feature}
5821 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005822 the resulting new version of the file. See |diff-patchexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005823
Bram Moolenaardbc28022014-07-26 13:40:44 +02005824 *'patchmode'* *'pm'* *E205* *E206*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005825'patchmode' 'pm' string (default "")
5826 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005827 When non-empty the oldest version of a file is kept. This can be used
5828 to keep the original version of a file if you are changing files in a
5829 source distribution. Only the first time that a file is written a
5830 copy of the original file will be kept. The name of the copy is the
5831 name of the original file with the string in the 'patchmode' option
5832 appended. This option should start with a dot. Use a string like
Bram Moolenaardf980db2017-12-24 13:22:00 +01005833 ".orig" or ".org". 'backupdir' must not be empty for this to work
5834 (Detail: The backup file is renamed to the patchmode file after the
5835 new file has been successfully written, that's why it must be possible
5836 to write a backup file). If there was no file to be backed up, an
5837 empty file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005838 When the 'backupskip' pattern matches, a patchmode file is not made.
5839 Using 'patchmode' for compressed files appends the extension at the
5840 end (e.g., "file.gz.orig"), thus the resulting name isn't always
5841 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005842 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005843
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01005844 *'path'* *'pa'* *E343* *E345* *E347* *E854*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005845'path' 'pa' string (default on Unix: ".,/usr/include,,"
Bram Moolenaar071d4272004-06-13 20:20:40 +00005846 other systems: ".,,")
5847 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005848 This is a list of directories which will be searched when using the
Bram Moolenaarc236c162008-07-13 17:41:49 +00005849 |gf|, [f, ]f, ^Wf, |:find|, |:sfind|, |:tabfind| and other commands,
5850 provided that the file being searched for has a relative path (not
5851 starting with "/", "./" or "../"). The directories in the 'path'
5852 option may be relative or absolute.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005853 - Use commas to separate directory names: >
5854 :set path=.,/usr/local/include,/usr/include
5855< - Spaces can also be used to separate directory names (for backwards
5856 compatibility with version 3.0). To have a space in a directory
5857 name, precede it with an extra backslash, and escape the space: >
5858 :set path=.,/dir/with\\\ space
5859< - To include a comma in a directory name precede it with an extra
5860 backslash: >
5861 :set path=.,/dir/with\\,comma
5862< - To search relative to the directory of the current file, use: >
5863 :set path=.
5864< - To search in the current directory use an empty string between two
5865 commas: >
5866 :set path=,,
5867< - A directory name may end in a ':' or '/'.
5868 - Environment variables are expanded |:set_env|.
5869 - When using |netrw.vim| URLs can be used. For example, adding
5870 "http://www.vim.org" will make ":find index.html" work.
Bram Moolenaarc236c162008-07-13 17:41:49 +00005871 - Search upwards and downwards in a directory tree using "*", "**" and
5872 ";". See |file-searching| for info and syntax.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005873 {not available when compiled without the |+path_extra| feature}
5874 - Careful with '\' characters, type two to get one in the option: >
5875 :set path=.,c:\\include
5876< Or just use '/' instead: >
5877 :set path=.,c:/include
5878< Don't forget "." or files won't even be found in the same directory as
5879 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005880 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00005881 it is something like 256 or 1024 characters.
5882 You can check if all the include files are found, using the value of
5883 'path', see |:checkpath|.
5884 The use of |:set+=| and |:set-=| is preferred when adding or removing
5885 directories from the list. This avoids problems when a future version
5886 uses another default. To remove the current directory use: >
5887 :set path-=
5888< To add the current directory use: >
5889 :set path+=
5890< To use an environment variable, you probably need to replace the
5891 separator. Here is an example to append $INCL, in which directory
5892 names are separated with a semi-colon: >
5893 :let &path = &path . "," . substitute($INCL, ';', ',', 'g')
5894< Replace the ';' with a ':' or whatever separator is used. Note that
5895 this doesn't work when $INCL contains a comma or white space.
5896
Bram Moolenaar37c64c72017-09-19 22:06:03 +02005897 *'perldll'*
5898'perldll' string (default depends on the build)
5899 global
Bram Moolenaar37c64c72017-09-19 22:06:03 +02005900 {only available when compiled with the |+perl/dyn|
5901 feature}
5902 Specifies the name of the Perl shared library. The default is
5903 DYNAMIC_PERL_DLL, which was specified at compile time.
5904 Environment variables are expanded |:set_env|.
5905 This option cannot be set from a |modeline| or in the |sandbox|, for
5906 security reasons.
5907
Bram Moolenaar071d4272004-06-13 20:20:40 +00005908 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
5909'preserveindent' 'pi' boolean (default off)
5910 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005911 When changing the indent of the current line, preserve as much of the
5912 indent structure as possible. Normally the indent is replaced by a
5913 series of tabs followed by spaces as required (unless |'expandtab'| is
5914 enabled, in which case only spaces are used). Enabling this option
5915 means the indent will preserve as many existing characters as possible
5916 for indenting, and only add additional tabs or spaces as required.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005917 'expandtab' does not apply to the preserved white space, a Tab remains
5918 a Tab.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005919 NOTE: When using ">>" multiple times the resulting indent is a mix of
5920 tabs and spaces. You might not like this.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005921 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005922 Also see 'copyindent'.
5923 Use |:retab| to clean up white space.
5924
5925 *'previewheight'* *'pvh'*
5926'previewheight' 'pvh' number (default 12)
5927 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02005928 {not available when compiled without the |+quickfix|
5929 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005930 Default height for a preview window. Used for |:ptag| and associated
Bram Moolenaar79648732019-07-18 21:43:07 +02005931 commands. Used for |CTRL-W_}| when no count is given. Not used when
5932 'previewpopup' is set.
5933
5934 *'previewpopup'* *'pvp'*
5935'previewpopup' 'pvp' string (default empty)
5936 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02005937 {not available when compiled without the |+textprop|
5938 or |+quickfix| feature}
Bram Moolenaar79648732019-07-18 21:43:07 +02005939 When not empty a popup window is used for commands that would open a
5940 preview window. See |preview-popup|.
Bram Moolenaar576a4a62019-08-18 15:25:17 +02005941 Not used for the insert completion info, add "popup" to
5942 'completeopt' for that.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005943
5944 *'previewwindow'* *'nopreviewwindow'*
5945 *'pvw'* *'nopvw'* *E590*
5946'previewwindow' 'pvw' boolean (default off)
5947 local to window
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02005948 {not available when compiled without the |+quickfix|
5949 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005950 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00005951 set. It's normally not set directly, but by using one of the commands
5952 |:ptag|, |:pedit|, etc.
5953
5954 *'printdevice'* *'pdev'*
5955'printdevice' 'pdev' string (default empty)
5956 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005957 {only available when compiled with the |+printer|
5958 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005959 The name of the printer to be used for |:hardcopy|.
5960 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005961 This option cannot be set from a |modeline| or in the |sandbox|, for
5962 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005963
Bram Moolenaar8299df92004-07-10 09:47:34 +00005964 *'printencoding'* *'penc'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005965'printencoding' 'penc' string (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005966 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005967 {only available when compiled with the |+printer|
5968 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005969 Sets the character encoding used when printing.
5970 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005971
5972 *'printexpr'* *'pexpr'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005973'printexpr' 'pexpr' string (default: see below)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005974 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005975 {only available when compiled with the |+printer|
5976 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005977 Expression used to print the PostScript produced with |:hardcopy|.
5978 See |pexpr-option|.
Bram Moolenaar51628222016-12-01 23:03:28 +01005979 This option cannot be set from a |modeline| or in the |sandbox|, for
5980 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005981
Bram Moolenaar8299df92004-07-10 09:47:34 +00005982 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005983'printfont' 'pfn' string (default "courier")
5984 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005985 {only available when compiled with the |+printer|
5986 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005987 The name of the font that will be used for |:hardcopy|.
5988 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005989
5990 *'printheader'* *'pheader'*
5991'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
5992 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005993 {only available when compiled with the |+printer|
5994 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005995 The format of the header produced in |:hardcopy| output.
5996 See |pheader-option|.
5997
5998 *'printmbcharset'* *'pmbcs'*
5999'printmbcharset' 'pmbcs' string (default "")
6000 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01006001 {only available when compiled with the |+printer|
6002 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006003 The CJK character set to be used for CJK output from |:hardcopy|.
6004 See |pmbcs-option|.
6005
6006 *'printmbfont'* *'pmbfn'*
6007'printmbfont' 'pmbfn' string (default "")
6008 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01006009 {only available when compiled with the |+printer|
6010 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006011 List of font names to be used for CJK output from |:hardcopy|.
6012 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006013
6014 *'printoptions'* *'popt'*
6015'printoptions' 'popt' string (default "")
6016 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006017 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006018 List of items that control the format of the output of |:hardcopy|.
6019 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006020
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006021 *'prompt'* *'noprompt'*
6022'prompt' boolean (default on)
6023 global
6024 When on a ":" prompt is used in Ex mode.
6025
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00006026 *'pumheight'* *'ph'*
6027'pumheight' 'ph' number (default 0)
6028 global
Bram Moolenaar06a89a52006-04-29 22:01:03 +00006029 Determines the maximum number of items to show in the popup menu for
6030 Insert mode completion. When zero as much space as available is used.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00006031 |ins-completion-menu|.
6032
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01006033 *'pumwidth'* *'pw'*
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006034'pumwidth' 'pw' number (default 15)
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01006035 global
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01006036 Determines the minimum width to use for the popup menu for Insert mode
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006037 completion. |ins-completion-menu|.
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01006038
Bram Moolenaard94464e2015-11-02 15:28:18 +01006039 *'pythondll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01006040'pythondll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01006041 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01006042 {only available when compiled with the |+python/dyn|
6043 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006044 Specifies the name of the Python 2.x shared library. The default is
6045 DYNAMIC_PYTHON_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006046 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01006047 This option cannot be set from a |modeline| or in the |sandbox|, for
6048 security reasons.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00006049
Bram Moolenaar94073162018-01-31 21:49:05 +01006050 *'pythonhome'*
6051'pythonhome' string (default "")
6052 global
Bram Moolenaar94073162018-01-31 21:49:05 +01006053 {only available when compiled with the |+python/dyn|
6054 feature}
6055 Specifies the name of the Python 2.x home directory. When 'pythonhome'
6056 and the PYTHONHOME environment variable are not set, PYTHON_HOME,
6057 which was specified at compile time, will be used for the Python 2.x
6058 home directory.
6059 Environment variables are expanded |:set_env|.
6060 This option cannot be set from a |modeline| or in the |sandbox|, for
6061 security reasons.
6062
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006063 *'pythonthreedll'*
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006064'pythonthreedll' string (default depends on the build)
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006065 global
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006066 {only available when compiled with the |+python3/dyn|
6067 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006068 Specifies the name of the Python 3 shared library. The default is
6069 DYNAMIC_PYTHON3_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006070 Environment variables are expanded |:set_env|.
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006071 This option cannot be set from a |modeline| or in the |sandbox|, for
6072 security reasons.
6073
Bram Moolenaar94073162018-01-31 21:49:05 +01006074 *'pythonthreehome'*
6075'pythonthreehome' string (default "")
6076 global
Bram Moolenaar94073162018-01-31 21:49:05 +01006077 {only available when compiled with the |+python3/dyn|
6078 feature}
6079 Specifies the name of the Python 3 home directory. When
6080 'pythonthreehome' and the PYTHONHOME environment variable are not set,
6081 PYTHON3_HOME, which was specified at compile time, will be used for
6082 the Python 3 home directory.
6083 Environment variables are expanded |:set_env|.
6084 This option cannot be set from a |modeline| or in the |sandbox|, for
6085 security reasons.
6086
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01006087 *'pyxversion'* *'pyx'*
6088'pyxversion' 'pyx' number (default depends on the build)
6089 global
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01006090 {only available when compiled with the |+python| or
6091 the |+python3| feature}
6092 Specifies the python version used for pyx* functions and commands
6093 |python_x|. The default value is as follows:
6094
6095 Compiled with Default ~
6096 |+python| and |+python3| 0
6097 only |+python| 2
6098 only |+python3| 3
6099
6100 Available values are 0, 2 and 3.
6101 If 'pyxversion' is 0, it is set to 2 or 3 after the first execution of
6102 any python2/3 commands or functions. E.g. `:py` sets to 2, and `:py3`
6103 sets to 3. `:pyx` sets it to 3 if Python 3 is available, otherwise sets
6104 to 2 if Python 2 is available.
6105 See also: |has-pythonx|
6106
6107 If Vim is compiled with only |+python| or |+python3| setting
6108 'pyxversion' has no effect. The pyx* functions and commands are
6109 always the same as the compiled version.
6110
6111 This option cannot be set from a |modeline| or in the |sandbox|, for
6112 security reasons.
6113
Bram Moolenaar858ba062020-05-31 23:11:59 +02006114 *'quickfixtextfunc'* *'qftf'*
6115'quickfixtextfunc' 'qftf' string (default "")
6116 global
6117 {only available when compiled with the |+quickfix|
6118 feature}
6119 This option specifies a function to be used to get the text to display
6120 in the quickfix and location list windows. This can be used to
6121 customize the information displayed in the quickfix or location window
6122 for each entry in the corresponding quickfix or location list. See
6123 |quickfix-window-function| for an explanation of how to write the
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +00006124 function and an example. The value can be the name of a function, a
6125 |lambda| or a |Funcref|. See |option-value-function| for more
6126 information.
Bram Moolenaar858ba062020-05-31 23:11:59 +02006127
6128 This option cannot be set from a |modeline| or in the |sandbox|, for
6129 security reasons.
6130
Bram Moolenaar677ee682005-01-27 14:41:15 +00006131 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00006132'quoteescape' 'qe' string (default "\")
6133 local to buffer
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00006134 The characters that are used to escape quotes in a string. Used for
6135 objects like a', a" and a` |a'|.
6136 When one of the characters in this option is found inside a string,
6137 the following character will be skipped. The default value makes the
6138 text "foo\"bar\\" considered to be one string.
6139
Bram Moolenaar071d4272004-06-13 20:20:40 +00006140 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
6141'readonly' 'ro' boolean (default off)
6142 local to buffer
6143 If on, writes fail unless you use a '!'. Protects you from
6144 accidentally overwriting a file. Default on when Vim is started
6145 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006146 When using ":w!" the 'readonly' option is reset for the current
6147 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar6c60f472019-04-28 16:00:35 +02006148 When using the ":view" command the 'readonly' option is set for the
6149 newly edited buffer.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01006150 See 'modifiable' for disallowing changes to the buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006151
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006152 *'redrawtime'* *'rdt'*
6153'redrawtime' 'rdt' number (default 2000)
6154 global
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006155 {only available when compiled with the |+reltime|
6156 feature}
6157 The time in milliseconds for redrawing the display. This applies to
Bram Moolenaar15142e22018-04-30 22:19:58 +02006158 searching for patterns for 'hlsearch', |:match| highlighting and syntax
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02006159 highlighting.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006160 When redrawing takes more than this many milliseconds no further
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02006161 matches will be highlighted.
6162 For syntax highlighting the time applies per window. When over the
6163 limit syntax highlighting is disabled until |CTRL-L| is used.
6164 This is used to avoid that Vim hangs when using a very complicated
6165 pattern.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006166
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02006167 *'regexpengine'* *'re'*
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006168'regexpengine' 're' number (default 0)
6169 global
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006170 This selects the default regexp engine. |two-engines|
6171 The possible values are:
6172 0 automatic selection
6173 1 old engine
6174 2 NFA engine
6175 Note that when using the NFA engine and the pattern contains something
6176 that is not supported the pattern will not match. This is only useful
6177 for debugging the regexp engine.
Bram Moolenaarfda37292014-11-05 14:27:36 +01006178 Using automatic selection enables Vim to switch the engine, if the
6179 default engine becomes too costly. E.g., when the NFA engine uses too
6180 many states. This should prevent Vim from hanging on a combination of
6181 a complex pattern with long text.
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006182
Bram Moolenaar64486672010-05-16 15:46:46 +02006183 *'relativenumber'* *'rnu'* *'norelativenumber'* *'nornu'*
6184'relativenumber' 'rnu' boolean (default off)
6185 local to window
Bram Moolenaar64486672010-05-16 15:46:46 +02006186 Show the line number relative to the line with the cursor in front of
Bram Moolenaar06b5d512010-05-22 15:37:44 +02006187 each line. Relative line numbers help you use the |count| you can
Bram Moolenaar64486672010-05-16 15:46:46 +02006188 precede some vertical motion commands (e.g. j k + -) with, without
6189 having to calculate it yourself. Especially useful in combination with
6190 other commands (e.g. y d c < > gq gw =).
6191 When the 'n' option is excluded from 'cpoptions' a wrapped
6192 line will not use the column of line numbers (this is the default when
6193 'compatible' isn't set).
6194 The 'numberwidth' option can be used to set the room used for the line
6195 number.
6196 When a long, wrapped line doesn't start with the first character, '-'
6197 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02006198 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
6199 the number.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01006200
Bram Moolenaar203d04d2013-06-06 21:36:40 +02006201 The number in front of the cursor line also depends on the value of
6202 'number', see |number_relativenumber| for all combinations of the two
6203 options.
Bram Moolenaar64486672010-05-16 15:46:46 +02006204
Bram Moolenaar071d4272004-06-13 20:20:40 +00006205 *'remap'* *'noremap'*
6206'remap' boolean (default on)
6207 global
6208 Allows for mappings to work recursively. If you do not want this for
6209 a single entry, use the :noremap[!] command.
Bram Moolenaara3227e22006-03-08 21:32:40 +00006210 NOTE: To avoid portability problems with Vim scripts, always keep
6211 this option at the default "on". Only switch it off when working with
6212 old Vi scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006213
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006214 *'renderoptions'* *'rop'*
6215'renderoptions' 'rop' string (default: empty)
6216 global
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006217 {only available when compiled with GUI and DIRECTX on
6218 MS-Windows}
6219 Select a text renderer and set its options. The options depend on the
6220 renderer.
6221
6222 Syntax: >
6223 set rop=type:{renderer}(,{name}:{value})*
6224<
6225 Currently, only one optional renderer is available.
6226
6227 render behavior ~
6228 directx Vim will draw text using DirectX (DirectWrite). It makes
6229 drawn glyphs more beautiful than default GDI.
6230 It requires 'encoding' is "utf-8", and only works on
6231 MS-Windows Vista or newer version.
6232
6233 Options:
6234 name meaning type value ~
6235 gamma gamma float 1.0 - 2.2 (maybe)
6236 contrast enhancedContrast float (unknown)
6237 level clearTypeLevel float (unknown)
6238 geom pixelGeometry int 0 - 2 (see below)
6239 renmode renderingMode int 0 - 6 (see below)
6240 taamode textAntialiasMode int 0 - 3 (see below)
Bram Moolenaara338adc2018-01-31 20:51:47 +01006241 scrlines Scroll Lines int (deprecated)
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006242
Bram Moolenaar92467d32017-12-05 13:22:16 +01006243 See this URL for detail (except for scrlines):
6244 https://msdn.microsoft.com/en-us/library/dd368190.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006245
6246 For geom: structure of a device pixel.
6247 0 - DWRITE_PIXEL_GEOMETRY_FLAT
6248 1 - DWRITE_PIXEL_GEOMETRY_RGB
6249 2 - DWRITE_PIXEL_GEOMETRY_BGR
6250
6251 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006252 https://msdn.microsoft.com/en-us/library/dd368114.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006253
6254 For renmode: method of rendering glyphs.
6255 0 - DWRITE_RENDERING_MODE_DEFAULT
6256 1 - DWRITE_RENDERING_MODE_ALIASED
6257 2 - DWRITE_RENDERING_MODE_GDI_CLASSIC
6258 3 - DWRITE_RENDERING_MODE_GDI_NATURAL
6259 4 - DWRITE_RENDERING_MODE_NATURAL
6260 5 - DWRITE_RENDERING_MODE_NATURAL_SYMMETRIC
6261 6 - DWRITE_RENDERING_MODE_OUTLINE
6262
6263 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006264 https://msdn.microsoft.com/en-us/library/dd368118.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006265
6266 For taamode: antialiasing mode used for drawing text.
6267 0 - D2D1_TEXT_ANTIALIAS_MODE_DEFAULT
6268 1 - D2D1_TEXT_ANTIALIAS_MODE_CLEARTYPE
6269 2 - D2D1_TEXT_ANTIALIAS_MODE_GRAYSCALE
6270 3 - D2D1_TEXT_ANTIALIAS_MODE_ALIASED
6271
6272 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006273 https://msdn.microsoft.com/en-us/library/dd368170.aspx
6274
Bram Moolenaara338adc2018-01-31 20:51:47 +01006275 For scrlines:
6276 This was used for optimizing scrolling behavior, however this
6277 is now deprecated. If specified, it is simply ignored.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006278
6279 Example: >
6280 set encoding=utf-8
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006281 set gfn=Ricty_Diminished:h12
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006282 set rop=type:directx
6283<
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006284 If select a raster font (Courier, Terminal or FixedSys which
6285 have ".fon" extension in file name) to 'guifont', it will be
Bram Moolenaar92467d32017-12-05 13:22:16 +01006286 drawn by GDI as a fallback.
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006287
6288 NOTE: It is known that some fonts and options combination
6289 causes trouble on drawing glyphs.
6290
Bram Moolenaar92467d32017-12-05 13:22:16 +01006291 - 'renmode:5' and 'renmode:6' will not work with some
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006292 special made fonts (True-Type fonts which includes only
6293 bitmap glyphs).
6294 - 'taamode:3' will not work with some vector fonts.
6295
6296 NOTE: With this option, you can display colored emoji
6297 (emoticon) in Windows 8.1 or later. To display colored emoji,
6298 there are some conditions which you should notice.
6299
6300 - If your font includes non-colored emoji already, it will
6301 be used.
6302 - If your font doesn't have emoji, the system chooses an
6303 alternative symbol font. On Windows 10, "Segoe UI Emoji"
6304 will be used.
6305 - When this alternative font didn't have fixed width glyph,
6306 emoji might be rendered beyond the bounding box of drawing
6307 cell.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006308
6309 Other render types are currently not supported.
6310
Bram Moolenaar071d4272004-06-13 20:20:40 +00006311 *'report'*
6312'report' number (default 2)
6313 global
6314 Threshold for reporting number of lines changed. When the number of
6315 changed lines is more than 'report' a message will be given for most
6316 ":" commands. If you want it always, set 'report' to 0.
6317 For the ":substitute" command the number of substitutions is used
6318 instead of the number of lines.
6319
6320 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
6321'restorescreen' 'rs' boolean (default on)
6322 global
Bram Moolenaar8024f932020-01-14 19:29:13 +01006323 {only in MS-Windows console version}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006324 When set, the screen contents is restored when exiting Vim. This also
6325 happens when executing external commands.
6326
6327 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
6328 options in your .vimrc. To disable restoring:
6329 set t_ti= t_te=
6330 To enable restoring (for an xterm):
6331 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
6332 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
6333
6334 *'revins'* *'ri'* *'norevins'* *'nori'*
6335'revins' 'ri' boolean (default off)
6336 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006337 {only available when compiled with the |+rightleft|
6338 feature}
6339 Inserting characters in Insert mode will work backwards. See "typing
6340 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
6341 command in Insert mode, when 'allowrevins' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02006342 NOTE: This option is reset when 'compatible' is set.
6343 This option is reset when 'paste' is set and restored when 'paste' is
6344 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006345
6346 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
6347'rightleft' 'rl' boolean (default off)
6348 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006349 {only available when compiled with the |+rightleft|
6350 feature}
6351 When on, display orientation becomes right-to-left, i.e., characters
6352 that are stored in the file appear from the right to the left.
6353 Using this option, it is possible to edit files for languages that
6354 are written from the right to the left such as Hebrew and Arabic.
6355 This option is per window, so it is possible to edit mixed files
6356 simultaneously, or to view the same file in both ways (this is
6357 useful whenever you have a mixed text file with both right-to-left
6358 and left-to-right strings so that both sets are displayed properly
6359 in different windows). Also see |rileft.txt|.
6360
Bram Moolenaar607cc1e2010-07-18 18:47:44 +02006361 *'rightleftcmd'* *'rlc'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006362'rightleftcmd' 'rlc' string (default "search")
6363 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006364 {only available when compiled with the |+rightleft|
6365 feature}
6366 Each word in this option enables the command line editing to work in
6367 right-to-left mode for a group of commands:
6368
6369 search "/" and "?" commands
6370
6371 This is useful for languages such as Hebrew, Arabic and Farsi.
6372 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
6373
Bram Moolenaard94464e2015-11-02 15:28:18 +01006374 *'rubydll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01006375'rubydll' string (default: depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01006376 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01006377 {only available when compiled with the |+ruby/dyn|
6378 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006379 Specifies the name of the Ruby shared library. The default is
6380 DYNAMIC_RUBY_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006381 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01006382 This option cannot be set from a |modeline| or in the |sandbox|, for
6383 security reasons.
6384
Bram Moolenaar071d4272004-06-13 20:20:40 +00006385 *'ruler'* *'ru'* *'noruler'* *'noru'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02006386'ruler' 'ru' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006387 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006388 {not available when compiled without the
6389 |+cmdline_info| feature}
6390 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006391 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00006392 text in the file is shown on the far right:
6393 Top first line is visible
6394 Bot last line is visible
6395 All first and last line are visible
6396 45% relative position in the file
6397 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006398 Each window has its own ruler. If a window has a status line, the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006399 ruler is shown there. Otherwise it is shown in the last line of the
Bram Moolenaar582fd852005-03-28 20:58:01 +00006400 screen. If the statusline is given by 'statusline' (i.e. not empty),
Bram Moolenaar071d4272004-06-13 20:20:40 +00006401 this option takes precedence over 'ruler' and 'rulerformat'
6402 If the number of characters displayed is different from the number of
Bram Moolenaar207f0092020-08-30 17:20:20 +02006403 bytes in the text (e.g., for a TAB or a multibyte character), both
Bram Moolenaar071d4272004-06-13 20:20:40 +00006404 the text column (byte number) and the screen column are shown,
6405 separated with a dash.
6406 For an empty line "0-1" is shown.
6407 For an empty buffer the line number will also be zero: "0,0-1".
Bram Moolenaarca635012015-09-25 20:34:21 +02006408 This option is reset when 'paste' is set and restored when 'paste' is
6409 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006410 If you don't want to see the ruler all the time but want to know where
6411 you are, use "g CTRL-G" |g_CTRL-G|.
6412 NOTE: This option is reset when 'compatible' is set.
6413
6414 *'rulerformat'* *'ruf'*
6415'rulerformat' 'ruf' string (default empty)
6416 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006417 {not available when compiled without the |+statusline|
6418 feature}
6419 When this option is not empty, it determines the content of the ruler
6420 string, as displayed for the 'ruler' option.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00006421 The format of this option is like that of 'statusline'.
Bram Moolenaar110289e2019-05-23 15:38:06 +02006422 This option cannot be set in a modeline when 'modelineexpr' is off.
6423
Bram Moolenaar071d4272004-06-13 20:20:40 +00006424 The default ruler width is 17 characters. To make the ruler 15
6425 characters wide, put "%15(" at the start and "%)" at the end.
6426 Example: >
6427 :set rulerformat=%15(%c%V\ %p%%%)
6428<
6429 *'runtimepath'* *'rtp'* *vimfiles*
6430'runtimepath' 'rtp' string (default:
Bram Moolenaar942db232021-02-13 18:14:48 +01006431 Unix: "$HOME/.vim,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006432 $VIM/vimfiles,
6433 $VIMRUNTIME,
6434 $VIM/vimfiles/after,
6435 $HOME/.vim/after"
6436 Amiga: "home:vimfiles,
6437 $VIM/vimfiles,
6438 $VIMRUNTIME,
6439 $VIM/vimfiles/after,
6440 home:vimfiles/after"
Bram Moolenaar942db232021-02-13 18:14:48 +01006441 MS-Windows: "$HOME/vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006442 $VIM/vimfiles,
6443 $VIMRUNTIME,
6444 $VIM/vimfiles/after,
6445 $HOME/vimfiles/after"
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02006446 macOS: "$VIM:vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006447 $VIMRUNTIME,
6448 $VIM:vimfiles:after"
Bram Moolenaarb3f74062020-02-26 16:16:53 +01006449 Haiku: "$BE_USER_SETTINGS/vim,
6450 $VIM/vimfiles,
6451 $VIMRUNTIME,
6452 $VIM/vimfiles/after,
Bram Moolenaar942db232021-02-13 18:14:48 +01006453 $BE_USER_SETTINGS/vim/after"
6454 VMS: "sys$login:vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006455 $VIM/vimfiles,
6456 $VIMRUNTIME,
6457 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00006458 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006459 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006460 This is a list of directories which will be searched for runtime
6461 files:
6462 filetype.vim filetypes by file name |new-filetype|
6463 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006464 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006465 colors/ color scheme files |:colorscheme|
6466 compiler/ compiler files |:compiler|
6467 doc/ documentation |write-local-help|
6468 ftplugin/ filetype plugins |write-filetype-plugin|
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01006469 import/ files that are found by `:import`
Bram Moolenaar071d4272004-06-13 20:20:40 +00006470 indent/ indent scripts |indent-expression|
6471 keymap/ key mapping files |mbyte-keymap|
6472 lang/ menu translations |:menutrans|
6473 menu.vim GUI menus |menu.vim|
Bram Moolenaar26852122016-05-24 20:02:38 +02006474 pack/ packages |:packadd|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006475 plugin/ plugin scripts |write-plugin|
6476 print/ files for printing |postscript-print-encoding|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006477 spell/ spell checking files |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006478 syntax/ syntax files |mysyntaxfile|
6479 tutor/ files for vimtutor |tutor|
6480
6481 And any other file searched for with the |:runtime| command.
6482
6483 The defaults for most systems are setup to search five locations:
6484 1. In your home directory, for your personal preferences.
6485 2. In a system-wide Vim directory, for preferences from the system
6486 administrator.
6487 3. In $VIMRUNTIME, for files distributed with Vim.
6488 *after-directory*
6489 4. In the "after" directory in the system-wide Vim directory. This is
6490 for the system administrator to overrule or add to the distributed
6491 defaults (rarely needed)
6492 5. In the "after" directory in your home directory. This is for
6493 personal preferences to overrule or add to the distributed defaults
6494 or system-wide settings (rarely needed).
6495
Bram Moolenaard0796902016-09-16 20:02:31 +02006496 More entries are added when using |packages|. If it gets very long
6497 then `:set rtp` will be truncated, use `:echo &rtp` to see the full
6498 string.
Bram Moolenaar26852122016-05-24 20:02:38 +02006499
Bram Moolenaar071d4272004-06-13 20:20:40 +00006500 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
6501 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006502 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00006503 wildcards.
6504 See |:runtime|.
6505 Example: >
6506 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
6507< This will use the directory "~/vimruntime" first (containing your
6508 personal Vim runtime files), then "/mygroup/vim" (shared between a
6509 group of people) and finally "$VIMRUNTIME" (the distributed runtime
6510 files).
6511 You probably should always include $VIMRUNTIME somewhere, to use the
6512 distributed runtime files. You can put a directory before $VIMRUNTIME
6513 to find files which replace a distributed runtime files. You can put
6514 a directory after $VIMRUNTIME to find files which add to distributed
6515 runtime files.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006516 When Vim is started with |--clean| the home directory entries are not
6517 included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006518 This option cannot be set from a |modeline| or in the |sandbox|, for
6519 security reasons.
6520
6521 *'scroll'* *'scr'*
6522'scroll' 'scr' number (default: half the window height)
6523 local to window
6524 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
6525 set to half the number of lines in the window when the window size
Bram Moolenaar74667062020-12-28 15:41:41 +01006526 changes. This may happen when enabling the |status-line| or
6527 'tabline' option after setting the 'scroll' option.
6528 If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006529 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar25c9c682019-05-05 18:13:34 +02006530 height with ":set scroll=0".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006531
6532 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
6533'scrollbind' 'scb' boolean (default off)
6534 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006535 See also |scroll-binding|. When this option is set, the current
6536 window scrolls as other scrollbind windows (windows that also have
6537 this option set) scroll. This option is useful for viewing the
6538 differences between two versions of a file, see 'diff'.
6539 See |'scrollopt'| for options that determine how this option should be
6540 interpreted.
6541 This option is mostly reset when splitting a window to edit another
6542 file. This means that ":split | edit file" results in two windows
6543 with scroll-binding, but ":split file" does not.
6544
Bram Moolenaarae20f342019-11-05 21:09:23 +01006545 *'scrollfocus'* *'scf'* *'noscrollfocus'* *'noscf'*
6546'scrollfocus' 'scf' boolean (default off)
6547 global
6548 {only for MS-Windows GUI}
6549 When using the scroll wheel and this option is set, the window under
6550 the mouse pointer is scrolled. With this option off the current
6551 window is scrolled.
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01006552 Systems other than MS-Windows always behave like this option is on.
Bram Moolenaarae20f342019-11-05 21:09:23 +01006553
Bram Moolenaar071d4272004-06-13 20:20:40 +00006554 *'scrolljump'* *'sj'*
6555'scrolljump' 'sj' number (default 1)
6556 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006557 Minimal number of lines to scroll when the cursor gets off the
6558 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
6559 CTRL-D). Useful if your terminal scrolls very slowly.
Bram Moolenaar1e015462005-09-25 22:16:38 +00006560 When set to a negative number from -1 to -100 this is used as the
6561 percentage of the window height. Thus -50 scrolls half the window
6562 height.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006563 NOTE: This option is set to 1 when 'compatible' is set.
6564
6565 *'scrolloff'* *'so'*
Bram Moolenaar50ba5262016-09-22 22:33:02 +02006566'scrolloff' 'so' number (default 0, set to 5 in |defaults.vim|)
Bram Moolenaar375e3392019-01-31 18:26:10 +01006567 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006568 Minimal number of screen lines to keep above and below the cursor.
6569 This will make some context visible around where you are working. If
6570 you set it to a very large value (999) the cursor line will always be
6571 in the middle of the window (except at the start or end of the file or
6572 when long lines wrap).
Bram Moolenaar375e3392019-01-31 18:26:10 +01006573 After using the local value, go back the global value with one of
6574 these two: >
6575 setlocal scrolloff<
6576 setlocal scrolloff=-1
6577< For scrolling horizontally see 'sidescrolloff'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006578 NOTE: This option is set to 0 when 'compatible' is set.
6579
6580 *'scrollopt'* *'sbo'*
6581'scrollopt' 'sbo' string (default "ver,jump")
6582 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006583 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006584 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
6585 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006586 The following words are available:
6587 ver Bind vertical scrolling for 'scrollbind' windows
6588 hor Bind horizontal scrolling for 'scrollbind' windows
6589 jump Applies to the offset between two windows for vertical
6590 scrolling. This offset is the difference in the first
6591 displayed line of the bound windows. When moving
6592 around in a window, another 'scrollbind' window may
6593 reach a position before the start or after the end of
6594 the buffer. The offset is not changed though, when
6595 moving back the 'scrollbind' window will try to scroll
6596 to the desired position when possible.
6597 When now making that window the current one, two
6598 things can be done with the relative offset:
6599 1. When "jump" is not included, the relative offset is
6600 adjusted for the scroll position in the new current
6601 window. When going back to the other window, the
Bram Moolenaar02467872007-05-06 13:22:01 +00006602 new relative offset will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006603 2. When "jump" is included, the other windows are
6604 scrolled to keep the same relative offset. When
6605 going back to the other window, it still uses the
6606 same relative offset.
6607 Also see |scroll-binding|.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006608 When 'diff' mode is active there always is vertical scroll binding,
6609 even when "ver" isn't there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006610
6611 *'sections'* *'sect'*
6612'sections' 'sect' string (default "SHNHH HUnhsh")
6613 global
6614 Specifies the nroff macros that separate sections. These are pairs of
6615 two letters (See |object-motions|). The default makes a section start
6616 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
6617
6618 *'secure'* *'nosecure'* *E523*
6619'secure' boolean (default off)
6620 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006621 When on, ":autocmd", shell and write commands are not allowed in
6622 ".vimrc" and ".exrc" in the current directory and map commands are
6623 displayed. Switch it off only if you know that you will not run into
6624 problems, or when the 'exrc' option is off. On Unix this option is
6625 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006626 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00006627 'secure' at the end of your ~/.vimrc then.
6628 This option cannot be set from a |modeline| or in the |sandbox|, for
6629 security reasons.
6630
6631 *'selection'* *'sel'*
6632'selection' 'sel' string (default "inclusive")
6633 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006634 This option defines the behavior of the selection. It is only used
6635 in Visual and Select mode.
6636 Possible values:
6637 value past line inclusive ~
6638 old no yes
6639 inclusive yes yes
6640 exclusive yes no
6641 "past line" means that the cursor is allowed to be positioned one
6642 character past the line.
6643 "inclusive" means that the last character of the selection is included
6644 in an operation. For example, when "x" is used to delete the
6645 selection.
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02006646 When "old" is used and 'virtualedit' allows the cursor to move past
6647 the end of line the line break still isn't included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006648 Note that when "exclusive" is used and selecting from the end
6649 backwards, you cannot include the last character of a line, when
6650 starting in Normal mode and 'virtualedit' empty.
6651
6652 The 'selection' option is set by the |:behave| command.
6653
6654 *'selectmode'* *'slm'*
6655'selectmode' 'slm' string (default "")
6656 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006657 This is a comma separated list of words, which specifies when to start
6658 Select mode instead of Visual mode, when a selection is started.
6659 Possible values:
6660 mouse when using the mouse
6661 key when using shifted special keys
6662 cmd when using "v", "V" or CTRL-V
6663 See |Select-mode|.
6664 The 'selectmode' option is set by the |:behave| command.
6665
6666 *'sessionoptions'* *'ssop'*
6667'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006668 help,options,tabpages,winsize,terminal")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006669 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02006670 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006671 feature}
6672 Changes the effect of the |:mksession| command. It is a comma
6673 separated list of words. Each word enables saving and restoring
6674 something:
6675 word save and restore ~
6676 blank empty windows
6677 buffers hidden and unloaded buffers, not just those in windows
6678 curdir the current directory
6679 folds manually created folds, opened/closed folds and local
6680 fold options
6681 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00006682 and contain at least one lowercase letter. Only
6683 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006684 help the help window
6685 localoptions options and mappings local to a window or buffer (not
6686 global values for local options)
6687 options all options and mappings (also global values for local
6688 options)
Bram Moolenaard23b7142021-04-17 21:04:34 +02006689 skiprtp exclude 'runtimepath' and 'packpath' from the options
Bram Moolenaar071d4272004-06-13 20:20:40 +00006690 resize size of the Vim window: 'lines' and 'columns'
6691 sesdir the directory in which the session file is located
6692 will become the current directory (useful with
6693 projects accessed over a network from different
6694 systems)
6695 slash backslashes in file names replaced with forward
6696 slashes
Bram Moolenaar18144c82006-04-12 21:52:12 +00006697 tabpages all tab pages; without this only the current tab page
6698 is restored, so that you can make a session for each
6699 tab page separately
Bram Moolenaard473c8c2018-08-11 18:00:22 +02006700 terminal include terminal windows where the command can be
6701 restored
Bram Moolenaar071d4272004-06-13 20:20:40 +00006702 unix with Unix end-of-line format (single <NL>), even when
6703 on Windows or DOS
6704 winpos position of the whole Vim window
6705 winsize window sizes
6706
6707 Don't include both "curdir" and "sesdir".
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006708 When neither "curdir" nor "sesdir" is included, file names are stored
6709 with absolute paths.
Bram Moolenaar2f0936c2022-01-08 21:51:59 +00006710 If you leave out "options" many things won't work well after restoring
6711 the session.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006712 "slash" and "unix" are useful on Windows when sharing session files
6713 with Unix. The Unix version of Vim cannot source dos format scripts,
6714 but the Windows version of Vim can source unix format scripts.
6715
6716 *'shell'* *'sh'* *E91*
Bram Moolenaar95a9dd12019-12-19 22:12:03 +01006717'shell' 'sh' string (default $SHELL or "sh", Win32: "cmd.exe")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006718 global
6719 Name of the shell to use for ! and :! commands. When changing the
6720 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
6721 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006722 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006723 See |option-backslash| about including spaces and backslashes.
6724 Environment variables are expanded |:set_env|.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006725
Bram Moolenaar1ff14ba2019-11-02 14:09:23 +01006726 If the name of the shell contains a space, you need to enclose it in
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01006727 quotes and escape the space. Example with quotes: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006728 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
6729< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006730 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006731 "-f" is not inside the quotes, because it is not part of the command
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006732 name. Vim automagically recognizes the backslashes that are path
Bram Moolenaar071d4272004-06-13 20:20:40 +00006733 separators.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006734 Example with escaped space (Vim will do this when initializing the
6735 option from $SHELL): >
6736 :set shell=/bin/with\\\ space/sh
Bram Moolenaard473c8c2018-08-11 18:00:22 +02006737< The resulting value of 'shell' is "/bin/with\ space/sh", two
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006738 backslashes are consumed by `:set`.
6739
Bram Moolenaar071d4272004-06-13 20:20:40 +00006740 Under MS-Windows, when the executable ends in ".com" it must be
6741 included. Thus setting the shell to "command.com" or "4dos.com"
6742 works, but "command" and "4dos" do not work for all commands (e.g.,
6743 filtering).
6744 For unknown reasons, when using "4dos.com" the current directory is
6745 changed to "C:\". To avoid this set 'shell' like this: >
6746 :set shell=command.com\ /c\ 4dos
6747< This option cannot be set from a |modeline| or in the |sandbox|, for
6748 security reasons.
6749
6750 *'shellcmdflag'* *'shcf'*
Bram Moolenaar5dc62522012-02-13 00:05:22 +01006751'shellcmdflag' 'shcf' string (default: "-c";
Mike Williams12795022021-06-28 20:53:58 +02006752 Win32, when 'shell' contains "powershell":
6753 "-Command", or when it does not contain "sh"
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006754 somewhere: "/c")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006755 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006756 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
Mike Williams12795022021-06-28 20:53:58 +02006757 "bash.exe -c ls", "powershell.exe -Command dir", or "cmd.exe /c dir".
6758 For MS-Windows, the default is set according to the value of 'shell',
6759 to reduce the need to set this option by the user.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02006760 On Unix it can have more than one flag. Each white space separated
6761 part is passed as an argument to the shell command.
6762 See |option-backslash| about including spaces and backslashes.
Mike Williams12795022021-06-28 20:53:58 +02006763 Also see |dos-shell| and |dos-powershell| for MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006764 This option cannot be set from a |modeline| or in the |sandbox|, for
6765 security reasons.
6766
6767 *'shellpipe'* *'sp'*
Mike Williams12795022021-06-28 20:53:58 +02006768'shellpipe' 'sp' string (default ">", ">%s 2>&1", "| tee", "|& tee"
6769 "2>&1| tee", or
6770 "2>&1 | Out-File -Encoding default")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006771 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006772 {not available when compiled without the |+quickfix|
6773 feature}
6774 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006775 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00006776 including spaces and backslashes.
6777 The name of the temporary file can be represented by "%s" if necessary
6778 (the file name is appended automatically if no %s appears in the value
6779 of this option).
Mike Williams12795022021-06-28 20:53:58 +02006780 For the Amiga the default is ">". For MS-Windows using powershell the
6781 default is "2>&1 | Out-File -Encoding default", otherwise the default
6782 is ">%s 2>&1". The output is directly saved in a file and not echoed
6783 to the screen.
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02006784 For Unix the default is "| tee". The stdout of the compiler is saved
Bram Moolenaar071d4272004-06-13 20:20:40 +00006785 in a file and echoed to the screen. If the 'shell' option is "csh" or
6786 "tcsh" after initializations, the default becomes "|& tee". If the
Bram Moolenaar96f45c02019-10-26 19:53:45 +02006787 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh", "zsh-beta",
Natanael Copa56318362021-05-06 18:46:35 +02006788 "bash", "fish", "ash" or "dash" the default becomes "2>&1| tee". This
6789 means that stderr is also included. Before using the 'shell' option a
6790 path is removed, thus "/bin/sh" uses "sh".
Mike Williamsa3d1b292021-06-30 20:56:00 +02006791 For Unix and MS-Windows, when the 'shell' option is "pwsh" the default
6792 becomes ">%s 2>&1" and the output is not echoed to the screen.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006793 The initialization of this option is done after reading the ".vimrc"
6794 and the other initializations, so that when the 'shell' option is set
6795 there, the 'shellpipe' option changes automatically, unless it was
6796 explicitly set before.
6797 When 'shellpipe' is set to an empty string, no redirection of the
6798 ":make" output will be done. This is useful if you use a 'makeprg'
6799 that writes to 'makeef' by itself. If you want no piping, but do
6800 want to include the 'makeef', set 'shellpipe' to a single space.
6801 Don't forget to precede the space with a backslash: ":set sp=\ ".
6802 In the future pipes may be used for filtering and this option will
6803 become obsolete (at least for Unix).
6804 This option cannot be set from a |modeline| or in the |sandbox|, for
6805 security reasons.
6806
6807 *'shellquote'* *'shq'*
Mike Williamsa3d1b292021-06-30 20:56:00 +02006808'shellquote' 'shq' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006809 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006810 Quoting character(s), put around the command passed to the shell, for
6811 the "!" and ":!" commands. The redirection is kept outside of the
6812 quoting. See 'shellxquote' to include the redirection. It's
6813 probably not useful to set both options.
6814 This is an empty string by default. Only known to be useful for
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006815 third-party shells on MS-Windows-like systems, such as the MKS Korn
Mike Williamsa3d1b292021-06-30 20:56:00 +02006816 Shell or bash, where it should be "\"". See |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006817 This option cannot be set from a |modeline| or in the |sandbox|, for
6818 security reasons.
6819
6820 *'shellredir'* *'srr'*
Mike Williams12795022021-06-28 20:53:58 +02006821'shellredir' 'srr' string (default ">", ">&", ">%s 2>&1", or
6822 "2>&1 | Out-File -Encoding default")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006823 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006824 String to be used to put the output of a filter command in a temporary
6825 file. See also |:!|. See |option-backslash| about including spaces
6826 and backslashes.
6827 The name of the temporary file can be represented by "%s" if necessary
6828 (the file name is appended automatically if no %s appears in the value
6829 of this option).
Bram Moolenaar96f45c02019-10-26 19:53:45 +02006830 The default is ">". For Unix, if the 'shell' option is "csh" or
6831 "tcsh" during initializations, the default becomes ">&". If the
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01006832 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh", "zsh-beta",
Mike Williamsa3d1b292021-06-30 20:56:00 +02006833 "bash", "fish", or "pwsh", the default becomes ">%s 2>&1". This means
6834 that stderr is also included. For Win32, the Unix checks are done and
Mike Williams12795022021-06-28 20:53:58 +02006835 additionally "cmd" is checked for, which makes the default ">%s 2>&1",
6836 and "powershell" is checked for which makes the default
Mike Williamsa3d1b292021-06-30 20:56:00 +02006837 "2>&1 | Out-File -Encoding default" (see |dos-powershell|). Also, the
6838 same names with ".exe" appended are checked for.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006839 The initialization of this option is done after reading the ".vimrc"
6840 and the other initializations, so that when the 'shell' option is set
6841 there, the 'shellredir' option changes automatically unless it was
6842 explicitly set before.
6843 In the future pipes may be used for filtering and this option will
6844 become obsolete (at least for Unix).
6845 This option cannot be set from a |modeline| or in the |sandbox|, for
6846 security reasons.
6847
6848 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
6849'shellslash' 'ssl' boolean (default off)
6850 global
Bram Moolenaar6f345a12019-12-17 21:27:18 +01006851 {only for MS-Windows}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006852 When set, a forward slash is used when expanding file names. This is
Mike Williamsa3d1b292021-06-30 20:56:00 +02006853 useful when a Unix-like shell is used instead of cmd.exe, pwsh.exe, or
Mike Williams12795022021-06-28 20:53:58 +02006854 powershell.exe. Backward slashes can still be typed, but they are
6855 changed to forward slashes by Vim.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006856 Note that setting or resetting this option has no effect for some
6857 existing file names, thus this option needs to be set before opening
6858 any file for best results. This might change in the future.
6859 'shellslash' only works when a backslash can be used as a path
6860 separator. To test if this is so use: >
6861 if exists('+shellslash')
Bram Moolenaarac3150d2019-07-28 16:36:39 +02006862< Also see 'completeslash'.
6863
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006864 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
6865'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
6866 global
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006867 When on, use temp files for shell commands. When off use a pipe.
6868 When using a pipe is not possible temp files are used anyway.
Bram Moolenaar97293012011-07-18 19:40:27 +02006869 Currently a pipe is only supported on Unix and MS-Windows 2K and
6870 later. You can check it with: >
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006871 :if has("filterpipe")
6872< The advantage of using a pipe is that nobody can read the temp file
6873 and the 'shell' command does not need to support redirection.
6874 The advantage of using a temp file is that the file type and encoding
6875 can be detected.
6876 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
6877 |FilterWritePost| autocommands event are not triggered when
6878 'shelltemp' is off.
Bram Moolenaar269f5952016-07-15 22:54:41 +02006879 The `system()` function does not respect this option and always uses
6880 temp files.
Bram Moolenaar036986f2017-03-16 17:41:02 +01006881 NOTE: This option is set to the Vim default value when 'compatible'
6882 is reset.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006883
Bram Moolenaar071d4272004-06-13 20:20:40 +00006884 *'shelltype'* *'st'*
6885'shelltype' 'st' number (default 0)
6886 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02006887 {only for the Amiga}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006888 On the Amiga this option influences the way how the commands work
6889 which use a shell.
6890 0 and 1: always use the shell
6891 2 and 3: use the shell only to filter lines
6892 4 and 5: use shell only for ':sh' command
6893 When not using the shell, the command is executed directly.
6894
6895 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
6896 1 and 3: use "shell cmd" to start external commands
6897
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006898 *'shellxescape'* *'sxe'*
6899'shellxescape' 'sxe' string (default: "";
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006900 for MS-Windows: "\"&|<>()@^")
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006901 global
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006902 When 'shellxquote' is set to "(" then the characters listed in this
6903 option will be escaped with a '^' character. This makes it possible
6904 to execute most external commands with cmd.exe.
6905
Bram Moolenaar071d4272004-06-13 20:20:40 +00006906 *'shellxquote'* *'sxq'*
6907'shellxquote' 'sxq' string (default: "";
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006908 for Win32, when 'shell' is cmd.exe: "("
Mike Williams12795022021-06-28 20:53:58 +02006909 for Win32, when 'shell' is
6910 powershell.exe: "\""
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006911 for Win32, when 'shell' contains "sh"
6912 somewhere: "\""
Bram Moolenaar071d4272004-06-13 20:20:40 +00006913 for Unix, when using system(): "\"")
6914 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006915 Quoting character(s), put around the command passed to the shell, for
6916 the "!" and ":!" commands. Includes the redirection. See
6917 'shellquote' to exclude the redirection. It's probably not useful
6918 to set both options.
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006919 When the value is '(' then ')' is appended. When the value is '"('
6920 then ')"' is appended.
6921 When the value is '(' then also see 'shellxescape'.
Bram Moolenaara64ba222012-02-12 23:23:31 +01006922 This is an empty string by default on most systems, but is known to be
Mike Williamsa3d1b292021-06-30 20:56:00 +02006923 useful for on Win32 version, either for cmd.exe, powershell.exe, or
6924 pwsh.exe which automatically strips off the first and last quote on a
6925 command, or 3rd-party shells such as the MKS Korn Shell or bash, where
6926 it should be "\"". The default is adjusted according the value of
Mike Williams12795022021-06-28 20:53:58 +02006927 'shell', to reduce the need to set this option by the user. See
6928 |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006929 This option cannot be set from a |modeline| or in the |sandbox|, for
6930 security reasons.
6931
6932 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
6933'shiftround' 'sr' boolean (default off)
6934 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006935 Round indent to multiple of 'shiftwidth'. Applies to > and <
6936 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
6937 a multiple of 'shiftwidth' (this is Vi compatible).
6938 NOTE: This option is reset when 'compatible' is set.
6939
6940 *'shiftwidth'* *'sw'*
6941'shiftwidth' 'sw' number (default 8)
6942 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006943 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00006944 |'cindent'|, |>>|, |<<|, etc.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02006945 When zero the 'ts' value will be used. Use the |shiftwidth()|
6946 function to get the effective shiftwidth value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006947
6948 *'shortmess'* *'shm'*
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02006949'shortmess' 'shm' string (Vim default "filnxtToOS", Vi default: "S",
6950 POSIX default: "AS")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006951 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006952 This option helps to avoid all the |hit-enter| prompts caused by file
6953 messages, for example with CTRL-G, and to avoid some other messages.
6954 It is a list of flags:
6955 flag meaning when present ~
6956 f use "(3 of 5)" instead of "(file 3 of 5)"
6957 i use "[noeol]" instead of "[Incomplete last line]"
Bram Moolenaar3f40ce72020-07-05 14:10:13 +02006958 l use "999L, 888B" instead of "999 lines, 888 bytes"
Bram Moolenaar071d4272004-06-13 20:20:40 +00006959 m use "[+]" instead of "[Modified]"
6960 n use "[New]" instead of "[New File]"
6961 r use "[RO]" instead of "[readonly]"
6962 w use "[w]" instead of "written" for file write message
6963 and "[a]" instead of "appended" for ':w >> file' command
6964 x use "[dos]" instead of "[dos format]", "[unix]" instead of
6965 "[unix format]" and "[mac]" instead of "[mac format]".
6966 a all of the above abbreviations
6967
6968 o overwrite message for writing a file with subsequent message
6969 for reading a file (useful for ":wn" or when 'autowrite' on)
6970 O message for reading a file overwrites any previous message.
6971 Also for quickfix message (e.g., ":cn").
6972 s don't give "search hit BOTTOM, continuing at TOP" or "search
Bram Moolenaara6c27c42019-05-09 19:16:22 +02006973 hit TOP, continuing at BOTTOM" messages; when using the search
6974 count do not show "W" after the count message (see S below)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006975 t truncate file message at the start if it is too long to fit
6976 on the command-line, "<" will appear in the left most column.
6977 Ignored in Ex mode.
6978 T truncate other messages in the middle if they are too long to
Bram Moolenaar582fd852005-03-28 20:58:01 +00006979 fit on the command line. "..." will appear in the middle.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006980 Ignored in Ex mode.
6981 W don't give "written" or "[w]" when writing a file
6982 A don't give the "ATTENTION" message when an existing swap file
6983 is found.
6984 I don't give the intro message when starting Vim |:intro|.
Bram Moolenaarea389e92014-05-28 21:40:52 +02006985 c don't give |ins-completion-menu| messages. For example,
6986 "-- XXX completion (YYY)", "match 1 of 2", "The only match",
6987 "Pattern not found", "Back at original", etc.
Bram Moolenaar426dd022016-03-15 15:09:29 +01006988 q use "recording" instead of "recording @a"
6989 F don't give the file info when editing a file, like `:silent`
Bram Moolenaar110289e2019-05-23 15:38:06 +02006990 was used for the command; note that this also affects messages
6991 from autocommands
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02006992 S do not show search count message when searching, e.g.
6993 "[1/5]"
Bram Moolenaar071d4272004-06-13 20:20:40 +00006994
6995 This gives you the opportunity to avoid that a change between buffers
6996 requires you to hit <Enter>, but still gives as useful a message as
6997 possible for the space available. To get the whole message that you
6998 would have got with 'shm' empty, use ":file!"
6999 Useful values:
7000 shm= No abbreviation of message.
7001 shm=a Abbreviation, but no loss of information.
7002 shm=at Abbreviation, and truncate message when necessary.
7003
7004 NOTE: This option is set to the Vi default value when 'compatible' is
7005 set and to the Vim default value when 'compatible' is reset.
7006
7007 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
7008'shortname' 'sn' boolean (default off)
7009 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007010 Filenames are assumed to be 8 characters plus one extension of 3
7011 characters. Multiple dots in file names are not allowed. When this
7012 option is on, dots in file names are replaced with underscores when
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01007013 adding an extension (".~" or ".swp"). This option is useful
Bram Moolenaar071d4272004-06-13 20:20:40 +00007014 when editing files on an MS-DOS compatible filesystem, e.g., messydos
Bram Moolenaarade0d392020-01-21 22:33:58 +01007015 or crossdos.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007016
7017 *'showbreak'* *'sbr'* *E595*
7018'showbreak' 'sbr' string (default "")
Bram Moolenaaree857022019-11-09 23:26:40 +01007019 global or local to window |global-local|
Bram Moolenaardb84e452010-08-15 13:50:43 +02007020 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007021 feature}
7022 String to put at the start of lines that have been wrapped. Useful
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007023 values are "> " or "+++ ": >
7024 :set showbreak=>\
7025< Note the backslash to escape the trailing space. It's easier like
7026 this: >
Bram Moolenaar1a384422010-07-14 19:53:30 +02007027 :let &showbreak = '+++ '
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007028< Only printable single-cell characters are allowed, excluding <Tab> and
Bram Moolenaar071d4272004-06-13 20:20:40 +00007029 comma (in a future version the comma might be used to separate the
7030 part that is shown at the end and at the start of a line).
7031 The characters are highlighted according to the '@' flag in
7032 'highlight'.
7033 Note that tabs after the showbreak will be displayed differently.
7034 If you want the 'showbreak' to appear in between line numbers, add the
7035 "n" flag to 'cpoptions'.
Bram Moolenaaree857022019-11-09 23:26:40 +01007036 A window-local value overrules a global value. If the global value is
7037 set and you want no value in the current window use NONE: >
7038 :setlocal showbreak=NONE
7039<
Bram Moolenaar071d4272004-06-13 20:20:40 +00007040 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02007041'showcmd' 'sc' boolean (Vim default: on, off for Unix,
7042 Vi default: off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007043 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007044 {not available when compiled without the
7045 |+cmdline_info| feature}
Bram Moolenaar02467872007-05-06 13:22:01 +00007046 Show (partial) command in the last line of the screen. Set this
7047 option off if your terminal is slow.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007048 In Visual mode the size of the selected area is shown:
7049 - When selecting characters within a line, the number of characters.
Bram Moolenaarf91787c2010-07-17 12:47:16 +02007050 If the number of bytes is different it is also displayed: "2-6"
7051 means two characters and six bytes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007052 - When selecting more than one line, the number of lines.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007053 - When selecting a block, the size in screen characters:
7054 {lines}x{columns}.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007055 NOTE: This option is set to the Vi default value when 'compatible' is
7056 set and to the Vim default value when 'compatible' is reset.
7057
7058 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
7059'showfulltag' 'sft' boolean (default off)
7060 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007061 When completing a word in insert mode (see |ins-completion|) from the
7062 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007063 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00007064 matched a C function, you can see a template for what arguments are
7065 required (coding style permitting).
Bram Moolenaar446cb832008-06-24 21:56:24 +00007066 Note that this doesn't work well together with having "longest" in
7067 'completeopt', because the completion from the search pattern may not
7068 match the typed text.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007069
7070 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
7071'showmatch' 'sm' boolean (default off)
7072 global
7073 When a bracket is inserted, briefly jump to the matching one. The
7074 jump is only done if the match can be seen on the screen. The time to
7075 show the match can be set with 'matchtime'.
7076 A Beep is given if there is no match (no matter if the match can be
Bram Moolenaarca635012015-09-25 20:34:21 +02007077 seen or not).
7078 This option is reset when 'paste' is set and restored when 'paste' is
7079 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007080 When the 'm' flag is not included in 'cpoptions', typing a character
7081 will immediately move the cursor back to where it belongs.
7082 See the "sm" field in 'guicursor' for setting the cursor shape and
7083 blinking when showing the match.
7084 The 'matchpairs' option can be used to specify the characters to show
7085 matches for. 'rightleft' and 'revins' are used to look for opposite
7086 matches.
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007087 Also see the matchparen plugin for highlighting the match when moving
7088 around |pi_paren.txt|.
7089 Note: Use of the short form is rated PG.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007090
7091 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
7092'showmode' 'smd' boolean (Vim default: on, Vi default: off)
7093 global
7094 If in Insert, Replace or Visual mode put a message on the last line.
7095 Use the 'M' flag in 'highlight' to set the type of highlighting for
7096 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007097 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00007098 doesn't mean XIM is really active, especially when 'imactivatekey' is
7099 not set.
7100 NOTE: This option is set to the Vi default value when 'compatible' is
7101 set and to the Vim default value when 'compatible' is reset.
7102
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007103 *'showtabline'* *'stal'*
7104'showtabline' 'stal' number (default 1)
7105 global
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007106 The value of this option specifies when the line with tab page labels
7107 will be displayed:
7108 0: never
7109 1: only if there are at least two tab pages
7110 2: always
7111 This is both for the GUI and non-GUI implementation of the tab pages
7112 line.
7113 See |tab-page| for more information about tab pages.
7114
Bram Moolenaar071d4272004-06-13 20:20:40 +00007115 *'sidescroll'* *'ss'*
7116'sidescroll' 'ss' number (default 0)
7117 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007118 The minimal number of columns to scroll horizontally. Used only when
7119 the 'wrap' option is off and the cursor is moved off of the screen.
7120 When it is zero the cursor will be put in the middle of the screen.
7121 When using a slow terminal set it to a large number or 0. When using
7122 a fast terminal use a small number or 1. Not used for "zh" and "zl"
7123 commands.
7124
7125 *'sidescrolloff'* *'siso'*
7126'sidescrolloff' 'siso' number (default 0)
Bram Moolenaar375e3392019-01-31 18:26:10 +01007127 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007128 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00007129 right of the cursor if 'nowrap' is set. Setting this option to a
7130 value greater than 0 while having |'sidescroll'| also at a non-zero
7131 value makes some context visible in the line you are scrolling in
7132 horizontally (except at beginning of the line). Setting this option
7133 to a large value (like 999) has the effect of keeping the cursor
7134 horizontally centered in the window, as long as one does not come too
7135 close to the beginning of the line.
Bram Moolenaar375e3392019-01-31 18:26:10 +01007136 After using the local value, go back the global value with one of
7137 these two: >
7138 setlocal sidescrolloff<
7139 setlocal sidescrolloff=-1
7140< NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007141
7142 Example: Try this together with 'sidescroll' and 'listchars' as
7143 in the following example to never allow the cursor to move
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007144 onto the "extends" character: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007145
7146 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
7147 :set sidescrolloff=1
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007148<
7149 *'signcolumn'* *'scl'*
7150'signcolumn' 'scl' string (default "auto")
7151 local to window
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007152 {not available when compiled without the |+signs|
7153 feature}
Bram Moolenaar09521312016-08-12 22:54:35 +02007154 Whether or not to draw the signcolumn. Valid values are:
7155 "auto" only when there is a sign to display
7156 "no" never
7157 "yes" always
Bram Moolenaar394c5d82019-06-17 21:48:05 +02007158 "number" display signs in the 'number' column. If the number
Bram Moolenaar6c1e1572019-06-22 02:13:00 +02007159 column is not present, then behaves like "auto".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007160
7161
7162 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
7163'smartcase' 'scs' boolean (default off)
7164 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007165 Override the 'ignorecase' option if the search pattern contains upper
7166 case characters. Only used when the search pattern is typed and
7167 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarc8734422012-06-01 22:38:45 +02007168 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00007169 "*" and "#" you can make 'smartcase' used by doing a "/" command,
7170 recalling the search pattern from history and hitting <Enter>.
7171 NOTE: This option is reset when 'compatible' is set.
7172
7173 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
7174'smartindent' 'si' boolean (default off)
7175 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007176 {not available when compiled without the
7177 |+smartindent| feature}
7178 Do smart autoindenting when starting a new line. Works for C-like
7179 programs, but can also be used for other languages. 'cindent' does
7180 something like this, works better in most cases, but is more strict,
Bram Moolenaar81af9252010-12-10 20:35:50 +01007181 see |C-indenting|. When 'cindent' is on or 'indentexpr' is set,
Bram Moolenaar166af9b2010-11-16 20:34:40 +01007182 setting 'si' has no effect. 'indentexpr' is a more advanced
7183 alternative.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007184 Normally 'autoindent' should also be on when using 'smartindent'.
7185 An indent is automatically inserted:
7186 - After a line ending in '{'.
7187 - After a line starting with a keyword from 'cinwords'.
7188 - Before a line starting with '}' (only with the "O" command).
7189 When typing '}' as the first character in a new line, that line is
7190 given the same indent as the matching '{'.
7191 When typing '#' as the first character in a new line, the indent for
7192 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007193 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00007194 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
7195 When using the ">>" command, lines starting with '#' are not shifted
7196 right.
Bram Moolenaar036986f2017-03-16 17:41:02 +01007197 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02007198 This option is reset when 'paste' is set and restored when 'paste' is
7199 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007200
7201 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
7202'smarttab' 'sta' boolean (default off)
7203 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007204 When on, a <Tab> in front of a line inserts blanks according to
Bram Moolenaar280f1262006-01-30 00:14:18 +00007205 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A
7206 <BS> will delete a 'shiftwidth' worth of space at the start of the
7207 line.
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00007208 When off, a <Tab> always inserts blanks according to 'tabstop' or
Bram Moolenaar280f1262006-01-30 00:14:18 +00007209 'softtabstop'. 'shiftwidth' is only used for shifting text left or
7210 right |shift-left-right|.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007211 What gets inserted (a <Tab> or spaces) depends on the 'expandtab'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007212 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00007213 number of spaces is minimized by using <Tab>s.
Bram Moolenaarca635012015-09-25 20:34:21 +02007214 This option is reset when 'paste' is set and restored when 'paste' is
7215 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007216 NOTE: This option is reset when 'compatible' is set.
7217
7218 *'softtabstop'* *'sts'*
7219'softtabstop' 'sts' number (default 0)
7220 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007221 Number of spaces that a <Tab> counts for while performing editing
7222 operations, like inserting a <Tab> or using <BS>. It "feels" like
7223 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
7224 used. This is useful to keep the 'ts' setting at its standard value
7225 of 8, while being able to edit like it is set to 'sts'. However,
7226 commands like "x" still work on the actual characters.
7227 When 'sts' is zero, this feature is off.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02007228 When 'sts' is negative, the value of 'shiftwidth' is used.
Bram Moolenaarca635012015-09-25 20:34:21 +02007229 'softtabstop' is set to 0 when the 'paste' option is set and restored
7230 when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007231 See also |ins-expandtab|. When 'expandtab' is not set, the number of
7232 spaces is minimized by using <Tab>s.
7233 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
7234 set.
7235 NOTE: This option is set to 0 when 'compatible' is set.
7236
Bram Moolenaar04958cb2018-06-23 19:23:02 +02007237 If Vim is compiled with the |+vartabs| feature then the value of
7238 'softtabstop' will be ignored if |'varsofttabstop'| is set to
7239 anything other than an empty string.
7240
Bram Moolenaar217ad922005-03-20 22:37:15 +00007241 *'spell'* *'nospell'*
7242'spell' boolean (default off)
7243 local to window
Bram Moolenaar217ad922005-03-20 22:37:15 +00007244 {not available when compiled without the |+syntax|
7245 feature}
7246 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007247 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007248
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007249 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00007250'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007251 local to buffer
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007252 {not available when compiled without the |+syntax|
7253 feature}
7254 Pattern to locate the end of a sentence. The following word will be
7255 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007256 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007257 When this check is not wanted make this option empty.
7258 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00007259 Be careful with special characters, see |option-backslash| about
7260 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007261 To set this option automatically depending on the language, see
7262 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007263
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007264 *'spellfile'* *'spf'*
7265'spellfile' 'spf' string (default empty)
7266 local to buffer
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007267 {not available when compiled without the |+syntax|
7268 feature}
7269 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00007270 commands. It must end in ".{encoding}.add". You need to include the
7271 path, otherwise the file is placed in the current directory.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007272 *E765*
7273 It may also be a comma separated list of names. A count before the
7274 |zg| and |zw| commands can be used to access each. This allows using
7275 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007276 When a word is added while this option is empty Vim will set it for
Bram Moolenaar910f66f2006-04-05 20:41:53 +00007277 you: Using the first directory in 'runtimepath' that is writable. If
7278 there is no "spell" directory yet it will be created. For the file
7279 name the first language name that appears in 'spelllang' is used,
Bram Moolenaar3b506942005-06-23 22:36:45 +00007280 ignoring the region.
7281 The resulting ".spl" file will be used for spell checking, it does not
7282 have to appear in 'spelllang'.
7283 Normally one file is used for all regions, but you can add the region
7284 name if you want to. However, it will then only be used when
7285 'spellfile' is set to it, for entries in 'spelllang' only files
7286 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00007287 This option cannot be set from a |modeline| or in the |sandbox|, for
7288 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007289
Bram Moolenaar217ad922005-03-20 22:37:15 +00007290 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007291'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00007292 local to buffer
Bram Moolenaar217ad922005-03-20 22:37:15 +00007293 {not available when compiled without the |+syntax|
7294 feature}
Bram Moolenaar3b506942005-06-23 22:36:45 +00007295 A comma separated list of word list names. When the 'spell' option is
7296 on spellchecking will be done for these languages. Example: >
7297 set spelllang=en_us,nl,medical
7298< This means US English, Dutch and medical words are recognized. Words
7299 that are not recognized will be highlighted.
Bram Moolenaar911ead12019-04-21 00:03:35 +02007300 The word list name must consist of alphanumeric characters, a dash or
7301 an underscore. It should not include a comma or dot. Using a dash is
Bram Moolenaar3b506942005-06-23 22:36:45 +00007302 recommended to separate the two letter language name from a
7303 specification. Thus "en-rare" is used for rare English words.
7304 A region name must come last and have the form "_xx", where "xx" is
7305 the two-letter, lower case region name. You can use more than one
7306 region by listing them: "en_us,en_ca" supports both US and Canadian
7307 English, but not words specific for Australia, New Zealand or Great
Bram Moolenaarfa735342016-01-03 22:14:44 +01007308 Britain. (Note: currently en_au and en_nz dictionaries are older than
7309 en_ca, en_gb and en_us).
Bram Moolenaarcc63c642013-11-12 04:44:01 +01007310 If the name "cjk" is included East Asian characters are excluded from
7311 spell checking. This is useful when editing text that also has Asian
7312 words.
Bram Moolenaar6c391a72021-09-09 21:55:11 +02007313 Note that the "medical" dictionary does not exist, it is just an
7314 example of a longer name.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007315 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007316 As a special case the name of a .spl file can be given as-is. The
7317 first "_xx" in the name is removed and used as the region name
7318 (_xx is an underscore, two letters and followed by a non-letter).
7319 This is mainly for testing purposes. You must make sure the correct
7320 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007321 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007322 idea to set 'spelllang' after setting 'encoding' to avoid loading the
7323 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00007324 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007325
Bram Moolenaar98692072006-02-04 00:57:42 +00007326 If the |spellfile.vim| plugin is active and you use a language name
7327 for which Vim cannot find the .spl file in 'runtimepath' the plugin
7328 will ask you if you want to download the file.
7329
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007330 After this option has been set successfully, Vim will source the files
7331 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
Bram Moolenaarb730f0c2018-11-25 03:56:26 +01007332 up to the first character that is not an ASCII letter or number and
7333 not a dash. Also see |set-spc-auto|.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007334
Bram Moolenaar362b44b2020-06-10 21:47:00 +02007335 *'spelloptions'* *'spo'*
7336'spelloptions' 'spo' string (default "")
7337 local to buffer
7338 {not available when compiled without the |+syntax|
7339 feature}
7340 A comma separated list of options for spell checking:
7341 camel When a word is CamelCased, assume "Cased" is a
7342 separate word: every upper-case character in a word
7343 that comes after a lower case character indicates the
7344 start of a new word.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007345
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007346 *'spellsuggest'* *'sps'*
7347'spellsuggest' 'sps' string (default "best")
7348 global
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007349 {not available when compiled without the |+syntax|
7350 feature}
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007351 Methods used for spelling suggestions. Both for the |z=| command and
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007352 the |spellsuggest()| function. This is a comma-separated list of
7353 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007354
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007355 best Internal method that works best for English. Finds
7356 changes like "fast" and uses a bit of sound-a-like
7357 scoring to improve the ordering.
7358
7359 double Internal method that uses two methods and mixes the
7360 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007361 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007362 word. That only works when the language specifies
7363 sound folding. Can be slow and doesn't always give
7364 better results.
7365
7366 fast Internal method that only checks for simple changes:
7367 character inserts/deletes/swaps. Works well for
7368 simple typing mistakes.
7369
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007370 {number} The maximum number of suggestions listed for |z=|.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007371 Not used for |spellsuggest()|. The number of
7372 suggestions is never more than the value of 'lines'
7373 minus two.
7374
Bram Moolenaar585ee072022-01-29 11:22:17 +00007375 timeout:{millisec} Limit the time searching for suggestions to
7376 {millisec} milli seconds. Applies to the following
7377 methods. When omitted the limit is 5000. When
7378 negative there is no limit. {only works when built
7379 with the +reltime feature}
7380
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007381 file:{filename} Read file {filename}, which must have two columns,
7382 separated by a slash. The first column contains the
7383 bad word, the second column the suggested good word.
7384 Example:
7385 theribal/terrible ~
7386 Use this for common mistakes that do not appear at the
7387 top of the suggestion list with the internal methods.
7388 Lines without a slash are ignored, use this for
7389 comments.
Bram Moolenaarbcb98982014-05-01 14:08:19 +02007390 The word in the second column must be correct,
7391 otherwise it will not be used. Add the word to an
7392 ".add" file if it is currently flagged as a spelling
7393 mistake.
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007394 The file is used for all languages.
7395
7396 expr:{expr} Evaluate expression {expr}. Use a function to avoid
7397 trouble with spaces. |v:val| holds the badly spelled
7398 word. The expression must evaluate to a List of
7399 Lists, each with a suggestion and a score.
7400 Example:
Bram Moolenaar214641f2017-03-05 17:04:09 +01007401 [['the', 33], ['that', 44]] ~
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007402 Set 'verbose' and use |z=| to see the scores that the
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007403 internal methods use. A lower score is better.
7404 This may invoke |spellsuggest()| if you temporarily
7405 set 'spellsuggest' to exclude the "expr:" part.
7406 Errors are silently ignored, unless you set the
7407 'verbose' option to a non-zero value.
7408
7409 Only one of "best", "double" or "fast" may be used. The others may
7410 appear several times in any order. Example: >
7411 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
7412<
7413 This option cannot be set from a |modeline| or in the |sandbox|, for
7414 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007415
7416
Bram Moolenaar071d4272004-06-13 20:20:40 +00007417 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
7418'splitbelow' 'sb' boolean (default off)
7419 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007420 When on, splitting a window will put the new window below the current
7421 one. |:split|
7422
7423 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
7424'splitright' 'spr' boolean (default off)
7425 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007426 When on, splitting a window will put the new window right of the
7427 current one. |:vsplit|
7428
7429 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
7430'startofline' 'sol' boolean (default on)
7431 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007432 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00007433 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007434 (if possible). This applies to the commands: CTRL-D, CTRL-U, CTRL-B,
Bram Moolenaar843ee412004-06-30 16:16:41 +00007435 CTRL-F, "G", "H", "M", "L", gg, and to the commands "d", "<<" and ">>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007436 with a linewise operator, with "%" with a count and to buffer changing
7437 commands (CTRL-^, :bnext, :bNext, etc.). Also for an Ex command that
7438 only has a line number, e.g., ":25" or ":+".
7439 In case of buffer changing commands the cursor is placed at the column
7440 where it was the last time the buffer was edited.
7441 NOTE: This option is set when 'compatible' is set.
7442
Bram Moolenaar00654022011-02-25 14:42:19 +01007443 *'statusline'* *'stl'* *E540* *E542*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007444'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007445 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007446 {not available when compiled without the |+statusline|
7447 feature}
7448 When nonempty, this option determines the content of the status line.
7449 Also see |status-line|.
7450
7451 The option consists of printf style '%' items interspersed with
7452 normal text. Each status line item is of the form:
7453 %-0{minwid}.{maxwid}{item}
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01007454 All fields except the {item} are optional. A single percent sign can
Bram Moolenaar8133cc62020-10-26 21:05:27 +01007455 be given as "%%".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007456
Bram Moolenaar238a5642006-02-21 22:12:05 +00007457 When the option starts with "%!" then it is used as an expression,
7458 evaluated and the result is used as the option value. Example: >
7459 :set statusline=%!MyStatusLine()
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02007460< The *g:statusline_winid* variable will be set to the |window-ID| of the
7461 window that the status line belongs to.
7462 The result can contain %{} items that will be evaluated too.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02007463 Note that the "%!" expression is evaluated in the context of the
7464 current window and buffer, while %{} items are evaluated in the
7465 context of the window that the statusline belongs to.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007466
7467 When there is error while evaluating the option then it will be made
7468 empty to avoid further errors. Otherwise screen updating would loop.
7469
Bram Moolenaar071d4272004-06-13 20:20:40 +00007470 Note that the only effect of 'ruler' when this option is set (and
7471 'laststatus' is 2) is controlling the output of |CTRL-G|.
7472
7473 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00007474 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00007475 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007476 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007477 minwid Minimum width of the item, padding as set by '-' & '0'.
7478 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007479 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007480 on the left for text items. Numeric items will be
7481 shifted down to maxwid-2 digits followed by '>'number
7482 where number is the amount of missing digits, much like
7483 an exponential notation.
7484 item A one letter code as described below.
7485
7486 Following is a description of the possible statusline items. The
7487 second character in "item" is the type:
7488 N for number
7489 S for string
7490 F for flags as described below
7491 - not applicable
7492
7493 item meaning ~
Bram Moolenaar02467872007-05-06 13:22:01 +00007494 f S Path to the file in the buffer, as typed or relative to current
7495 directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007496 F S Full path to the file in the buffer.
7497 t S File name (tail) of file in the buffer.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007498 m F Modified flag, text is "[+]"; "[-]" if 'modifiable' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007499 M F Modified flag, text is ",+" or ",-".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007500 r F Readonly flag, text is "[RO]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007501 R F Readonly flag, text is ",RO".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007502 h F Help buffer flag, text is "[help]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007503 H F Help buffer flag, text is ",HLP".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007504 w F Preview window flag, text is "[Preview]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007505 W F Preview window flag, text is ",PRV".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007506 y F Type of file in the buffer, e.g., "[vim]". See 'filetype'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007507 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
Bram Moolenaar7fd73202010-07-25 16:58:46 +02007508 q S "[Quickfix List]", "[Location List]" or empty.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007509 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
7510 being used: "<keymap>"
7511 n N Buffer number.
Bram Moolenaar00654022011-02-25 14:42:19 +01007512 b N Value of character under cursor.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007513 B N As above, in hexadecimal.
7514 o N Byte number in file of byte under cursor, first byte is 1.
7515 Mnemonic: Offset from start of file (with one added)
7516 {not available when compiled without |+byte_offset| feature}
7517 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007518 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007519 l N Line number.
7520 L N Number of lines in buffer.
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02007521 c N Column number (byte index).
7522 v N Virtual column number (screen column).
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007523 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007524 p N Percentage through file in lines as in |CTRL-G|.
7525 P S Percentage through file of displayed window. This is like the
Bram Moolenaar14b69452013-06-29 23:05:20 +02007526 percentage described for 'ruler'. Always 3 in length, unless
7527 translated.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007528 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00007529 Empty if the argument file count is zero or one.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007530 { NF Evaluate expression between '%{' and '}' and substitute result.
Bram Moolenaar6d150f72018-04-21 20:03:20 +02007531 Note that there is no '%' before the closing '}'. The
7532 expression cannot contain a '}' character, call a function to
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007533 work around that. See |stl-%{| below.
shadmansaleh30e3de22021-05-15 17:23:28 +02007534 {% - This is almost same as { except the result of the expression is
7535 re-evaluated as a statusline format string. Thus if the
7536 return value of expr contains % items they will get expanded.
7537 The expression can contain the } character, the end of
7538 expression is denoted by %}.
Bram Moolenaar22863042021-10-16 15:23:36 +01007539 For example: >
shadmansaleh30e3de22021-05-15 17:23:28 +02007540 func! Stl_filename() abort
7541 return "%t"
7542 endfunc
7543< `stl=%{Stl_filename()}` results in `"%t"`
7544 `stl=%{%Stl_filename()%}` results in `"Name of current file"`
Bram Moolenaar22863042021-10-16 15:23:36 +01007545 %} - End of `{%` expression
Bram Moolenaar071d4272004-06-13 20:20:40 +00007546 ( - Start of item group. Can be used for setting the width and
7547 alignment of a section. Must be followed by %) somewhere.
7548 ) - End of item group. No width fields allowed.
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007549 T N For 'tabline': start of tab page N label. Use %T after the last
7550 label. This information is used for mouse clicks.
7551 X N For 'tabline': start of close tab N label. Use %X after the
7552 label, e.g.: %3Xclose%X. Use %999X for a "close current tab"
7553 mark. This information is used for mouse clicks.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007554 < - Where to truncate line if too long. Default is at the start.
7555 No width fields allowed.
7556 = - Separation point between left and right aligned items.
7557 No width fields allowed.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007558 # - Set highlight group. The name must follow and then a # again.
7559 Thus use %#HLname# for highlight group HLname. The same
7560 highlighting is used, also for the statusline of non-current
7561 windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007562 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00007563 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007564 The difference between User{N} and StatusLine will be applied
7565 to StatusLineNC for the statusline of non-current windows.
7566 The number N must be between 1 and 9. See |hl-User1..9|
7567
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007568 When displaying a flag, Vim removes the leading comma, if any, when
7569 that flag comes right after plaintext. This will make a nice display
7570 when flags are used like in the examples below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007571
Bram Moolenaar582fd852005-03-28 20:58:01 +00007572 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00007573 not set) and a minwid is not set for the group, the whole group will
7574 become empty. This will make a group like the following disappear
7575 completely from the statusline when none of the flags are set. >
7576 :set statusline=...%(\ [%M%R%H]%)...
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02007577< Beware that an expression is evaluated each and every time the status
7578 line is displayed.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007579 *stl-%{* *g:actual_curbuf* *g:actual_curwin*
Bram Moolenaarade0d392020-01-21 22:33:58 +01007580 While evaluating %{} the current buffer and current window will be set
7581 temporarily to that of the window (and buffer) whose statusline is
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007582 currently being drawn. The expression will evaluate in this context.
7583 The variable "g:actual_curbuf" is set to the `bufnr()` number of the
7584 real current buffer and "g:actual_curwin" to the |window-ID| of the
7585 real current window. These values are strings.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007586
Bram Moolenaar30b65812012-07-12 22:01:11 +02007587 The 'statusline' option will be evaluated in the |sandbox| if set from
7588 a modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02007589 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007590
7591 It is not allowed to change text or jump to another window while
7592 evaluating 'statusline' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007593
7594 If the statusline is not updated when you want it (e.g., after setting
7595 a variable that's used in an expression), you can force an update by
7596 setting an option without changing its value. Example: >
7597 :let &ro = &ro
7598
7599< A result of all digits is regarded a number for display purposes.
7600 Otherwise the result is taken as flag text and applied to the rules
7601 described above.
7602
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00007603 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00007604 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
Bram Moolenaarc4da1132017-07-15 19:39:43 +02007605 edit your .vimrc or whatever with "vim --clean" to get it right.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007606
7607 Examples:
7608 Emulate standard status line with 'ruler' set >
7609 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
7610< Similar, but add ASCII value of char under the cursor (like "ga") >
7611 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
7612< Display byte count and byte value, modified flag in red. >
7613 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
7614 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
7615< Display a ,GZ flag if a compressed file is loaded >
7616 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
7617< In the |:autocmd|'s: >
7618 :let b:gzflag = 1
7619< And: >
7620 :unlet b:gzflag
7621< And define this function: >
7622 :function VarExists(var, val)
7623 : if exists(a:var) | return a:val | else | return '' | endif
7624 :endfunction
7625<
7626 *'suffixes'* *'su'*
7627'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
7628 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007629 Files with these suffixes get a lower priority when multiple files
7630 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007631 suffixes. Spaces after the comma are ignored. A dot is also seen as
7632 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007633 separator, precede it with a backslash (see |option-backslash| about
7634 including spaces and backslashes).
7635 See 'wildignore' for completely ignoring files.
7636 The use of |:set+=| and |:set-=| is preferred when adding or removing
7637 suffixes from the list. This avoids problems when a future version
7638 uses another default.
7639
7640 *'suffixesadd'* *'sua'*
7641'suffixesadd' 'sua' string (default "")
7642 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007643 {not available when compiled without the
7644 |+file_in_path| feature}
7645 Comma separated list of suffixes, which are used when searching for a
7646 file for the "gf", "[I", etc. commands. Example: >
7647 :set suffixesadd=.java
7648<
7649 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
7650'swapfile' 'swf' boolean (default on)
7651 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007652 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007653 swapfile is not wanted for a specific buffer. For example, with
7654 confidential information that even root must not be able to access.
7655 Careful: All text will be in memory:
7656 - Don't use this for big files.
7657 - Recovery will be impossible!
7658 A swapfile will only be present when |'updatecount'| is non-zero and
7659 'swapfile' is set.
7660 When 'swapfile' is reset, the swap file for the current buffer is
7661 immediately deleted. When 'swapfile' is set, and 'updatecount' is
7662 non-zero, a swap file is immediately created.
7663 Also see |swap-file| and |'swapsync'|.
Bram Moolenaar76f3b1a2014-03-27 22:30:07 +01007664 If you want to open a new buffer without creating a swap file for it,
7665 use the |:noswapfile| modifier.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01007666 See 'directory' for where the swap file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007667
7668 This option is used together with 'bufhidden' and 'buftype' to
7669 specify special kinds of buffers. See |special-buffers|.
7670
7671 *'swapsync'* *'sws'*
7672'swapsync' 'sws' string (default "fsync")
7673 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007674 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007675 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007676 When this option is empty parts of the swap file may be in memory and
7677 not written to disk. When the system crashes you may lose more work.
7678 On Unix the system does a sync now and then without Vim asking for it,
7679 so the disadvantage of setting this option off is small. On some
7680 systems the swap file will not be written at all. For a unix system
7681 setting it to "sync" will use the sync() call instead of the default
7682 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007683 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007684
7685 *'switchbuf'* *'swb'*
7686'switchbuf' 'swb' string (default "")
7687 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007688 This option controls the behavior when switching between buffers.
Bram Moolenaard2ea7cf2021-05-30 20:54:13 +02007689 Mostly for |quickfix| commands some values are also used for other
7690 commands, as mentioned below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007691 Possible values (comma separated list):
7692 useopen If included, jump to the first open window that
7693 contains the specified buffer (if there is one).
7694 Otherwise: Do not examine other windows.
7695 This setting is checked with |quickfix| commands, when
7696 jumping to errors (":cc", ":cn", "cp", etc.). It is
7697 also used in all buffer related split commands, for
7698 example ":sbuffer", ":sbnext", or ":sbrewind".
Bram Moolenaar779b74b2006-04-10 14:55:34 +00007699 usetab Like "useopen", but also consider windows in other tab
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00007700 pages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007701 split If included, split the current window before loading
Bram Moolenaar15146672011-10-20 22:22:38 +02007702 a buffer for a |quickfix| command that display errors.
Bram Moolenaar63b74a82019-03-24 15:09:13 +01007703 Otherwise: do not split, use current window (when used
7704 in the quickfix window: the previously used window or
7705 split if there is no other window).
Bram Moolenaara594d772015-06-19 14:41:49 +02007706 vsplit Just like "split" but split vertically.
Bram Moolenaar446cb832008-06-24 21:56:24 +00007707 newtab Like "split", but open a new tab page. Overrules
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02007708 "split" when both are present.
Bram Moolenaar539aa6b2019-11-17 18:09:38 +01007709 uselast If included, jump to the previously used window when
7710 jumping to errors with |quickfix| commands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007711
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007712 *'synmaxcol'* *'smc'*
7713'synmaxcol' 'smc' number (default 3000)
7714 local to buffer
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007715 {not available when compiled without the |+syntax|
7716 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007717 Maximum column in which to search for syntax items. In long lines the
7718 text after this column is not highlighted and following lines may not
7719 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007720 This helps to avoid very slow redrawing for an XML file that is one
7721 long line.
7722 Set to zero to remove the limit.
7723
Bram Moolenaar071d4272004-06-13 20:20:40 +00007724 *'syntax'* *'syn'*
7725'syntax' 'syn' string (default empty)
7726 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007727 {not available when compiled without the |+syntax|
7728 feature}
7729 When this option is set, the syntax with this name is loaded, unless
7730 syntax highlighting has been switched off with ":syntax off".
7731 Otherwise this option does not always reflect the current syntax (the
7732 b:current_syntax variable does).
7733 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007734 not automatically recognized. Example, in an IDL file:
7735 /* vim: set syntax=idl : */ ~
7736 When a dot appears in the value then this separates two filetype
7737 names. Example:
7738 /* vim: set syntax=c.doxygen : */ ~
7739 This will use the "c" syntax first, then the "doxygen" syntax.
7740 Note that the second one must be prepared to be loaded as an addition,
7741 otherwise it will be skipped. More than one dot may appear.
7742 To switch off syntax highlighting for the current file, use: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007743 :set syntax=OFF
7744< To switch syntax highlighting on according to the current value of the
7745 'filetype' option: >
7746 :set syntax=ON
7747< What actually happens when setting the 'syntax' option is that the
7748 Syntax autocommand event is triggered with the value as argument.
7749 This option is not copied to another buffer, independent of the 's' or
7750 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007751 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007752
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007753 *'tabline'* *'tal'*
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007754'tabline' 'tal' string (default empty)
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007755 global
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007756 When nonempty, this option determines the content of the tab pages
7757 line at the top of the Vim window. When empty Vim will use a default
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007758 tab pages line. See |setting-tabline| for more info.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007759
7760 The tab pages line only appears as specified with the 'showtabline'
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00007761 option and only when there is no GUI tab line. When 'e' is in
7762 'guioptions' and the GUI supports a tab line 'guitablabel' is used
Bram Moolenaar7f036442010-08-15 15:24:20 +02007763 instead. Note that the two tab pages lines are very different.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007764
7765 The value is evaluated like with 'statusline'. You can use
7766 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007767 the text to be displayed. Use "%1T" for the first label, "%2T" for
7768 the second one, etc. Use "%X" items for closing labels.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007769
Bram Moolenaare12bab32019-01-08 22:02:56 +01007770 When changing something that is used in 'tabline' that does not
7771 trigger it to be updated, use |:redrawtabline|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02007772 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaare12bab32019-01-08 22:02:56 +01007773
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007774 Keep in mind that only one of the tab pages is the current one, others
7775 are invisible and you can't jump to their windows.
7776
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007777
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007778 *'tabpagemax'* *'tpm'*
7779'tabpagemax' 'tpm' number (default 10)
7780 global
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007781 Maximum number of tab pages to be opened by the |-p| command line
7782 argument or the ":tab all" command. |tabpage|
7783
7784
7785 *'tabstop'* *'ts'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007786'tabstop' 'ts' number (default 8)
7787 local to buffer
7788 Number of spaces that a <Tab> in the file counts for. Also see
Bram Moolenaarf10911e2022-01-29 22:20:48 +00007789 the |:retab| command, and the 'softtabstop' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007790
7791 Note: Setting 'tabstop' to any other value than 8 can make your file
Bram Moolenaarf10911e2022-01-29 22:20:48 +00007792 appear wrong in many places, e.g., when printing it.
7793 The value must be more than 0 and less than 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007794
7795 There are four main ways to use tabs in Vim:
7796 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
7797 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007798 will use a mix of tabs and spaces, but typing <Tab> and <BS> will
Bram Moolenaar071d4272004-06-13 20:20:40 +00007799 behave like a tab appears every 4 (or 3) characters.
7800 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
7801 'expandtab'. This way you will always insert spaces. The
7802 formatting will never be messed up when 'tabstop' is changed.
7803 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007804 |modeline| to set these values when editing the file again. Only
Bram Moolenaar071d4272004-06-13 20:20:40 +00007805 works when using Vim to edit the file.
7806 4. Always set 'tabstop' and 'shiftwidth' to the same value, and
7807 'noexpandtab'. This should then work (for initial indents only)
7808 for any tabstop setting that people use. It might be nice to have
7809 tabs after the first non-blank inserted as spaces if you do this
7810 though. Otherwise aligned comments will be wrong when 'tabstop' is
7811 changed.
7812
Bram Moolenaar04958cb2018-06-23 19:23:02 +02007813 If Vim is compiled with the |+vartabs| feature then the value of
7814 'tabstop' will be ignored if |'vartabstop'| is set to anything other
7815 than an empty string.
7816
Bram Moolenaar071d4272004-06-13 20:20:40 +00007817 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
7818'tagbsearch' 'tbs' boolean (default on)
7819 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007820 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007821 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00007822 searching makes searching for a tag a LOT faster, but a linear search
7823 will find more tags if the tags file wasn't properly sorted.
7824 Vim normally assumes that your tags files are sorted, or indicate that
7825 they are not sorted. Only when this is not the case does the
7826 'tagbsearch' option need to be switched off.
7827
7828 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007829 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00007830 certain files, or retry all files with a linear search. When
7831 'tagbsearch' is off, only a linear search is done.
7832
7833 Linear searching is done anyway, for one file, when Vim finds a line
7834 at the start of the file indicating that it's not sorted: >
Bram Moolenaar446cb832008-06-24 21:56:24 +00007835 !_TAG_FILE_SORTED 0 /some comment/
Bram Moolenaar071d4272004-06-13 20:20:40 +00007836< [The whitespace before and after the '0' must be a single <Tab>]
7837
7838 When a binary search was done and no match was found in any of the
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007839 files listed in 'tags', and case is ignored or a pattern is used
Bram Moolenaar071d4272004-06-13 20:20:40 +00007840 instead of a normal tag name, a retry is done with a linear search.
7841 Tags in unsorted tags files, and matches with different case will only
7842 be found in the retry.
7843
Bram Moolenaard4755bb2004-09-02 19:12:26 +00007844 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007845 linear search can be avoided when case is ignored. Use a value of '2'
7846 in the "!_TAG_FILE_SORTED" line for this. A tag file can be case-fold
7847 sorted with the -f switch to "sort" in most unices, as in the command:
7848 "sort -f -o tags tags". For "Exuberant ctags" version 5.x or higher
7849 (at least 5.5) the --sort=foldcase switch can be used for this as
7850 well. Note that case must be folded to uppercase for this to work.
7851
7852 By default, tag searches are case-sensitive. Case is ignored when
7853 'ignorecase' is set and 'tagcase' is "followic", or when 'tagcase' is
7854 "ignore".
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007855 Also when 'tagcase' is "followscs" and 'smartcase' is set, or
7856 'tagcase' is "smart", and the pattern contains only lowercase
7857 characters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007858
7859 When 'tagbsearch' is off, tags searching is slower when a full match
7860 exists, but faster when no full match exists. Tags in unsorted tags
7861 files may only be found with 'tagbsearch' off.
7862 When the tags file is not sorted, or sorted in a wrong way (not on
7863 ASCII byte value), 'tagbsearch' should be off, or the line given above
7864 must be included in the tags file.
7865 This option doesn't affect commands that find all matching tags (e.g.,
7866 command-line completion and ":help").
Bram Moolenaar071d4272004-06-13 20:20:40 +00007867
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007868 *'tagcase'* *'tc'*
7869'tagcase' 'tc' string (default "followic")
7870 global or local to buffer |global-local|
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007871 This option specifies how case is handled when searching the tags
7872 file:
7873 followic Follow the 'ignorecase' option
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007874 followscs Follow the 'smartcase' and 'ignorecase' options
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007875 ignore Ignore case
7876 match Match case
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007877 smart Ignore case unless an upper case letter is used
Bram Moolenaar036986f2017-03-16 17:41:02 +01007878 NOTE: This option is set to the Vi default value when 'compatible' is
7879 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007880
Bram Moolenaar45e18cb2019-04-28 18:05:35 +02007881 *'tagfunc'* *'tfu'*
7882'tagfunc' 'tfu' string (default: empty)
7883 local to buffer
7884 {not available when compiled without the |+eval|
7885 feature}
7886 This option specifies a function to be used to perform tag searches.
7887 The function gets the tag pattern and should return a List of matching
7888 tags. See |tag-function| for an explanation of how to write the
Yegappan Lakshmanan19916a82021-11-24 16:32:55 +00007889 function and an example. The value can be the name of a function, a
7890 |lambda| or a |Funcref|. See |option-value-function| for more
7891 information.
Bram Moolenaar45e18cb2019-04-28 18:05:35 +02007892
Bram Moolenaar071d4272004-06-13 20:20:40 +00007893 *'taglength'* *'tl'*
7894'taglength' 'tl' number (default 0)
7895 global
7896 If non-zero, tags are significant up to this number of characters.
7897
7898 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
7899'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
7900 global
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00007901 If on and using a tags file in another directory, file names in that
7902 tags file are relative to the directory where the tags file is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007903 NOTE: This option is set to the Vi default value when 'compatible' is
7904 set and to the Vim default value when 'compatible' is reset.
7905
7906 *'tags'* *'tag'* *E433*
7907'tags' 'tag' string (default "./tags,tags", when compiled with
7908 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
7909 global or local to buffer |global-local|
7910 Filenames for the tag command, separated by spaces or commas. To
7911 include a space or comma in a file name, precede it with a backslash
7912 (see |option-backslash| about including spaces and backslashes).
7913 When a file name starts with "./", the '.' is replaced with the path
7914 of the current file. But only when the 'd' flag is not included in
7915 'cpoptions'. Environment variables are expanded |:set_env|. Also see
7916 |tags-option|.
7917 "*", "**" and other wildcards can be used to search for tags files in
Bram Moolenaare2b590e2010-08-08 18:29:48 +02007918 a directory tree. See |file-searching|. E.g., "/lib/**/tags" will
7919 find all files named "tags" below "/lib". The filename itself cannot
7920 contain wildcards, it is used as-is. E.g., "/lib/**/tags?" will find
7921 files called "tags?". {not available when compiled without the
7922 |+path_extra| feature}
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00007923 The |tagfiles()| function can be used to get a list of the file names
7924 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007925 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
7926 files are also supported. They are automatically recognized. The
7927 default value becomes "./tags,./TAGS,tags,TAGS", unless case
7928 differences are ignored (MS-Windows). |emacs-tags|
7929 The use of |:set+=| and |:set-=| is preferred when adding or removing
7930 file names from the list. This avoids problems when a future version
7931 uses another default.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007932
7933 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
7934'tagstack' 'tgst' boolean (default on)
7935 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007936 When on, the |tagstack| is used normally. When off, a ":tag" or
7937 ":tselect" command with an argument will not push the tag onto the
7938 tagstack. A following ":tag" without an argument, a ":pop" command or
7939 any other command that uses the tagstack will use the unmodified
7940 tagstack, but does change the pointer to the active entry.
7941 Resetting this option is useful when using a ":tag" command in a
7942 mapping which should not change the tagstack.
7943
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007944 *'tcldll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01007945'tcldll' string (default depends on the build)
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007946 global
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007947 {only available when compiled with the |+tcl/dyn|
7948 feature}
7949 Specifies the name of the Tcl shared library. The default is
7950 DYNAMIC_TCL_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02007951 Environment variables are expanded |:set_env|.
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007952 This option cannot be set from a |modeline| or in the |sandbox|, for
7953 security reasons.
7954
Bram Moolenaar071d4272004-06-13 20:20:40 +00007955 *'term'* *E529* *E530* *E531*
7956'term' string (default is $TERM, if that fails:
7957 in the GUI: "builtin_gui"
7958 on Amiga: "amiga"
Bram Moolenaarb3f74062020-02-26 16:16:53 +01007959 on Haiku: "xterm"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007960 on Mac: "mac-ansi"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007961 on Unix: "ansi"
7962 on VMS: "ansi"
7963 on Win 32: "win32")
7964 global
7965 Name of the terminal. Used for choosing the terminal control
7966 characters. Environment variables are expanded |:set_env|.
7967 For example: >
7968 :set term=$TERM
7969< See |termcap|.
7970
7971 *'termbidi'* *'tbidi'*
7972 *'notermbidi'* *'notbidi'*
7973'termbidi' 'tbidi' boolean (default off, on for "mlterm")
7974 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007975 {only available when compiled with the |+arabic|
7976 feature}
7977 The terminal is in charge of Bi-directionality of text (as specified
7978 by Unicode). The terminal is also expected to do the required shaping
7979 that some languages (such as Arabic) require.
7980 Setting this option implies that 'rightleft' will not be set when
7981 'arabic' is set and the value of 'arabicshape' will be ignored.
7982 Note that setting 'termbidi' has the immediate effect that
7983 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
7984 This option is reset when the GUI is started.
7985 For further details see |arabic.txt|.
7986
7987 *'termencoding'* *'tenc'*
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02007988'termencoding' 'tenc' string (default ""; with GTK+ GUI: "utf-8")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007989 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007990 Encoding used for the terminal. This specifies what character
7991 encoding the keyboard produces and the display will understand. For
Bram Moolenaar3848e002016-03-19 18:42:29 +01007992 the GUI it only applies to the keyboard ('encoding' is used for the
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02007993 display).
Bram Moolenaar4b7cdca2020-01-01 16:18:38 +01007994 *E617* *E950*
Bram Moolenaar3df01732017-02-17 22:47:16 +01007995 Note: This does not apply to the GTK+ GUI. After the GUI has been
Bram Moolenaar071d4272004-06-13 20:20:40 +00007996 successfully initialized, 'termencoding' is forcibly set to "utf-8".
7997 Any attempts to set a different value will be rejected, and an error
7998 message is shown.
Bram Moolenaarac360bf2015-09-01 20:31:20 +02007999 For the Win32 GUI and console versions 'termencoding' is not used,
Bram Moolenaar071d4272004-06-13 20:20:40 +00008000 because the Win32 system always passes Unicode characters.
8001 When empty, the same encoding is used as for the 'encoding' option.
8002 This is the normal value.
8003 Not all combinations for 'termencoding' and 'encoding' are valid. See
8004 |encoding-table|.
8005 The value for this option must be supported by internal conversions or
8006 iconv(). When this is not possible no conversion will be done and you
8007 will probably experience problems with non-ASCII characters.
8008 Example: You are working with the locale set to euc-jp (Japanese) and
8009 want to edit a UTF-8 file: >
8010 :let &termencoding = &encoding
8011 :set encoding=utf-8
8012< You need to do this when your system has no locale support for UTF-8.
8013
Bram Moolenaarcafafb32018-02-22 21:07:09 +01008014 *'termguicolors'* *'tgc'* *E954*
Bram Moolenaar61be73b2016-04-29 22:59:22 +02008015'termguicolors' 'tgc' boolean (default off)
8016 global
Bram Moolenaar61be73b2016-04-29 22:59:22 +02008017 {not available when compiled without the
8018 |+termguicolors| feature}
8019 When on, uses |highlight-guifg| and |highlight-guibg| attributes in
Bram Moolenaarcafafb32018-02-22 21:07:09 +01008020 the terminal (thus using 24-bit color).
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01008021
Bram Moolenaarcafafb32018-02-22 21:07:09 +01008022 Requires a ISO-8613-3 compatible terminal. If setting this option
8023 does not work (produces a colorless UI) reading |xterm-true-color|
8024 might help.
8025
8026 For Win32 console, Windows 10 version 1703 (Creators Update) or later
8027 is required. Use this check to find out: >
8028 if has('vcon')
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01008029< This requires Vim to be built with the |+vtp| feature.
8030
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +02008031 Note that the "cterm" attributes are still used, not the "gui" ones.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008032 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar61be73b2016-04-29 22:59:22 +02008033
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008034 *'termwinkey'* *'twk'*
8035'termwinkey' 'twk' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02008036 local to window
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008037 The key that starts a CTRL-W command in a terminal window. Other keys
Bram Moolenaar74675a62017-07-15 13:53:23 +02008038 are sent to the job running in the window.
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008039 The <> notation can be used, e.g.: >
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008040 :set termwinkey=<C-L>
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008041< The string must be one key stroke but can be multiple bytes.
8042 When not set CTRL-W is used, so that CTRL-W : gets you to the command
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008043 line. If 'termwinkey' is set to CTRL-L then CTRL-L : gets you to the
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008044 command line.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008045
Bram Moolenaar6c60f472019-04-28 16:00:35 +02008046 *'termwinscroll'* *'twsl'*
8047'termwinscroll' 'twsl' number (default 10000)
8048 local to buffer
8049 {not available when compiled without the
8050 |+terminal| feature}
8051 Number of scrollback lines to keep. When going over this limit the
8052 first 10% of the scrollback lines are deleted. This is just to reduce
8053 the memory usage. See |Terminal-Normal|.
Bram Moolenaar36968af2021-11-15 17:13:11 +00008054 Also used as a limit for text sent to the terminal in one write,
8055 multiplied by the number of columns times 3 (average number of bytes
8056 per cell).
Bram Moolenaar6c60f472019-04-28 16:00:35 +02008057
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008058 *'termwinsize'* *'tws'*
8059'termwinsize' 'tws' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02008060 local to window
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02008061 Size used when opening the |terminal| window. Format:
8062 {rows}x{columns} or {rows}*{columns}.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008063 - When empty the terminal gets the size from the window.
Bram Moolenaar498c2562018-04-15 23:45:15 +02008064 - When set with a "x" (e.g., "24x80") the terminal size is not
8065 adjusted to the window size. If the window is smaller only the
8066 top-left part is displayed.
8067 - When set with a "*" (e.g., "10*50") the terminal size follows the
8068 window size, but will not be smaller than the specified rows and/or
8069 columns.
8070 - When rows is zero then use the height of the window.
8071 - When columns is zero then use the width of the window.
8072 - Using "0x0" or "0*0" is the same as empty.
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02008073 - Can be overruled in the |term_start()| options with "term_rows" and
8074 "term_cols".
Bram Moolenaar498c2562018-04-15 23:45:15 +02008075
8076 Examples:
8077 "30x0" uses 30 rows and the current window width.
8078 "20*0" uses at least 20 rows and the current window width.
8079 "0*40" uses the current window height and at least 40 columns.
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02008080 Note that the command running in the terminal window may still change
8081 the size of the terminal. In that case the Vim window will be
8082 adjusted to that size, if possible.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008083
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008084 *'termwintype'* *'twt'*
8085'termwintype' 'twt' string (default "")
8086 global
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008087 {only available when compiled with the |terminal|
8088 feature on MS-Windows}
8089 Specify the virtual console (pty) used when opening the terminal
8090 window.
8091
8092 Possible values are:
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01008093 "" use ConPTY if it is stable, winpty otherwise
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008094 "winpty" use winpty, fail if not supported
8095 "conpty" use |ConPTY|, fail if not supported
8096
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01008097 |ConPTY| support depends on the platform. Windows 10 October 2018
8098 Update is the first version that supports ConPTY, however it is still
8099 considered unstable. ConPTY might become stable in the next release
8100 of Windows 10. winpty support needs to be installed. If neither is
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008101 supported then you cannot open a terminal window.
8102
Bram Moolenaar071d4272004-06-13 20:20:40 +00008103 *'terse'* *'noterse'*
8104'terse' boolean (default off)
8105 global
8106 When set: Add 's' flag to 'shortmess' option (this makes the message
8107 for a search that hits the start or end of the file not being
8108 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
8109 shortens a lot of messages}
8110
8111 *'textauto'* *'ta'* *'notextauto'* *'nota'*
8112'textauto' 'ta' boolean (Vim default: on, Vi default: off)
8113 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008114 This option is obsolete. Use 'fileformats'.
8115 For backwards compatibility, when 'textauto' is set, 'fileformats' is
8116 set to the default value for the current system. When 'textauto' is
8117 reset, 'fileformats' is made empty.
8118 NOTE: This option is set to the Vi default value when 'compatible' is
8119 set and to the Vim default value when 'compatible' is reset.
8120
8121 *'textmode'* *'tx'* *'notextmode'* *'notx'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008122'textmode' 'tx' boolean (Win32: default on,
Bram Moolenaar071d4272004-06-13 20:20:40 +00008123 others: default off)
8124 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00008125 This option is obsolete. Use 'fileformat'.
8126 For backwards compatibility, when 'textmode' is set, 'fileformat' is
8127 set to "dos". When 'textmode' is reset, 'fileformat' is set to
8128 "unix".
8129
8130 *'textwidth'* *'tw'*
8131'textwidth' 'tw' number (default 0)
8132 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00008133 Maximum width of text that is being inserted. A longer line will be
8134 broken after white space to get this width. A zero value disables
Bram Moolenaarca635012015-09-25 20:34:21 +02008135 this.
8136 'textwidth' is set to 0 when the 'paste' option is set and restored
8137 when 'paste' is reset.
8138 When 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00008139 'formatoptions' and |ins-textwidth|.
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00008140 When 'formatexpr' is set it will be used to break the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008141 NOTE: This option is set to 0 when 'compatible' is set.
8142
8143 *'thesaurus'* *'tsr'*
8144'thesaurus' 'tsr' string (default "")
8145 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008146 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008147 for thesaurus completion commands |i_CTRL-X_CTRL-T|. See
8148 |compl-thesaurus|.
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01008149
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008150 This option is not used if 'thesaurusfunc' is set, either for the
8151 buffer or globally.
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01008152
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008153 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00008154 after a comma are ignored, otherwise spaces are included in the file
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008155 name. See |option-backslash| about using backslashes. The use of
8156 |:set+=| and |:set-=| is preferred when adding or removing directories
8157 from the list. This avoids problems when a future version uses
8158 another default. Backticks cannot be used in this option for security
8159 reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008160
Bram Moolenaar2f0936c2022-01-08 21:51:59 +00008161 *'thesaurusfunc'* *'tsrfu'*
Yegappan Lakshmanan160e9942021-10-16 15:41:29 +01008162'thesaurusfunc' 'tsrfu' string (default: empty)
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008163 global or local to buffer |global-local|
Yegappan Lakshmanan160e9942021-10-16 15:41:29 +01008164 {not available when compiled without the |+eval|
8165 feature}
8166 This option specifies a function to be used for thesaurus completion
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008167 with CTRL-X CTRL-T. |i_CTRL-X_CTRL-T| See |compl-thesaurusfunc|.
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00008168 The value can be the name of a function, a |lambda| or a |Funcref|.
8169 See |option-value-function| for more information.
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008170
Yegappan Lakshmanan160e9942021-10-16 15:41:29 +01008171 This option cannot be set from a |modeline| or in the |sandbox|, for
8172 security reasons.
8173
Bram Moolenaar071d4272004-06-13 20:20:40 +00008174 *'tildeop'* *'top'* *'notildeop'* *'notop'*
8175'tildeop' 'top' boolean (default off)
8176 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008177 When on: The tilde command "~" behaves like an operator.
8178 NOTE: This option is reset when 'compatible' is set.
8179
8180 *'timeout'* *'to'* *'notimeout'* *'noto'*
8181'timeout' 'to' boolean (default on)
8182 global
8183 *'ttimeout'* *'nottimeout'*
Bram Moolenaar94237492017-04-23 18:40:21 +02008184'ttimeout' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008185 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008186 These two options together determine the behavior when part of a
8187 mapped key sequence or keyboard code has been received:
8188
8189 'timeout' 'ttimeout' action ~
8190 off off do not time out
8191 on on or off time out on :mappings and key codes
8192 off on time out on key codes
8193
8194 If both options are off, Vim will wait until either the complete
8195 mapping or key sequence has been received, or it is clear that there
8196 is no mapping or key sequence for the received characters. For
8197 example: if you have mapped "vl" and Vim has received 'v', the next
8198 character is needed to see if the 'v' is followed by an 'l'.
8199 When one of the options is on, Vim will wait for about 1 second for
8200 the next character to arrive. After that the already received
8201 characters are interpreted as single characters. The waiting time can
8202 be changed with the 'timeoutlen' option.
8203 On slow terminals or very busy systems timing out may cause
8204 malfunctioning cursor keys. If both options are off, Vim waits
8205 forever after an entered <Esc> if there are key codes that start
8206 with <Esc>. You will have to type <Esc> twice. If you do not have
8207 problems with key codes, but would like to have :mapped key
8208 sequences not timing out in 1 second, set the 'ttimeout' option and
8209 reset the 'timeout' option.
8210
8211 NOTE: 'ttimeout' is reset when 'compatible' is set.
8212
8213 *'timeoutlen'* *'tm'*
8214'timeoutlen' 'tm' number (default 1000)
8215 global
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008216
Bram Moolenaar071d4272004-06-13 20:20:40 +00008217 *'ttimeoutlen'* *'ttm'*
Bram Moolenaar94237492017-04-23 18:40:21 +02008218'ttimeoutlen' 'ttm' number (default -1, set to 100 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008219 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008220 The time in milliseconds that is waited for a key code or mapped key
8221 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
8222 when part of a command has been typed.
8223 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
8224 different timeout value for key codes is desired set 'ttimeoutlen' to
8225 a non-negative number.
8226
8227 ttimeoutlen mapping delay key code delay ~
8228 < 0 'timeoutlen' 'timeoutlen'
8229 >= 0 'timeoutlen' 'ttimeoutlen'
8230
8231 The timeout only happens when the 'timeout' and 'ttimeout' options
8232 tell so. A useful setting would be >
8233 :set timeout timeoutlen=3000 ttimeoutlen=100
8234< (time out on mapping after three seconds, time out on key codes after
8235 a tenth of a second).
8236
8237 *'title'* *'notitle'*
8238'title' boolean (default off, on when title can be restored)
8239 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008240 When on, the title of the window will be set to the value of
8241 'titlestring' (if it is not empty), or to:
8242 filename [+=-] (path) - VIM
8243 Where:
8244 filename the name of the file being edited
8245 - indicates the file cannot be modified, 'ma' off
8246 + indicates the file was modified
8247 = indicates the file is read-only
8248 =+ indicates the file is read-only and modified
8249 (path) is the path of the file being edited
8250 - VIM the server name |v:servername| or "VIM"
8251 Only works if the terminal supports setting window titles
8252 (currently Amiga console, Win32 console, all GUI versions and
Bram Moolenaard1caa942020-04-10 22:10:56 +02008253 terminals with a non-empty 't_ts' option - these are Unix xterm and
Bram Moolenaar071d4272004-06-13 20:20:40 +00008254 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
8255 *X11*
8256 When Vim was compiled with HAVE_X11 defined, the original title will
8257 be restored if possible. The output of ":version" will include "+X11"
8258 when HAVE_X11 was defined, otherwise it will be "-X11". This also
8259 works for the icon name |'icon'|.
8260 But: When Vim was started with the |-X| argument, restoring the title
8261 will not work (except in the GUI).
8262 If the title cannot be restored, it is set to the value of 'titleold'.
8263 You might want to restore the title outside of Vim then.
8264 When using an xterm from a remote machine you can use this command:
8265 rsh machine_name xterm -display $DISPLAY &
8266 then the WINDOWID environment variable should be inherited and the
8267 title of the window should change back to what it should be after
8268 exiting Vim.
8269
8270 *'titlelen'*
8271'titlelen' number (default 85)
8272 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008273 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008274 title. When the title is longer, only the end of the path name is
8275 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008276 Using a percentage makes this adapt to the width of the window. But
8277 it won't work perfectly, because the actual number of characters
8278 available also depends on the font used and other things in the title
8279 bar. When 'titlelen' is zero the full path is used. Otherwise,
8280 values from 1 to 30000 percent can be used.
8281 'titlelen' is also used for the 'titlestring' option.
8282
8283 *'titleold'*
8284'titleold' string (default "Thanks for flying Vim")
8285 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008286 This option will be used for the window title when exiting Vim if the
8287 original title cannot be restored. Only happens if 'title' is on or
8288 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00008289 This option cannot be set from a |modeline| or in the |sandbox|, for
8290 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008291 *'titlestring'*
8292'titlestring' string (default "")
8293 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008294 When this option is not empty, it will be used for the title of the
8295 window. This happens only when the 'title' option is on.
8296 Only works if the terminal supports setting window titles (currently
8297 Amiga console, Win32 console, all GUI versions and terminals with a
8298 non-empty 't_ts' option).
8299 When Vim was compiled with HAVE_X11 defined, the original title will
Bram Moolenaar51628222016-12-01 23:03:28 +01008300 be restored if possible, see |X11|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008301
Bram Moolenaar071d4272004-06-13 20:20:40 +00008302 When this option contains printf-style '%' items, they will be
8303 expanded according to the rules used for 'statusline'.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008304 This option cannot be set in a modeline when 'modelineexpr' is off.
8305
Bram Moolenaar071d4272004-06-13 20:20:40 +00008306 Example: >
8307 :auto BufEnter * let &titlestring = hostname() . "/" . expand("%:p")
8308 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
8309< The value of 'titlelen' is used to align items in the middle or right
8310 of the available space.
8311 Some people prefer to have the file name first: >
8312 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
8313< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008314 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00008315 separating space only when needed.
8316 NOTE: Use of special characters in 'titlestring' may cause the display
8317 to be garbled (e.g., when it contains a CR or NL character).
8318 {not available when compiled without the |+statusline| feature}
8319
8320 *'toolbar'* *'tb'*
8321'toolbar' 'tb' string (default "icons,tooltips")
8322 global
8323 {only for |+GUI_GTK|, |+GUI_Athena|, |+GUI_Motif| and
8324 |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008325 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00008326 possible values are:
8327 icons Toolbar buttons are shown with icons.
8328 text Toolbar buttons shown with text.
8329 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008330 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008331 tooltips Tooltips are active for toolbar buttons.
8332 Tooltips refer to the popup help text which appears after the mouse
8333 cursor is placed over a toolbar button for a brief moment.
8334
8335 If you want the toolbar to be shown with icons as well as text, do the
8336 following: >
8337 :set tb=icons,text
8338< Motif and Athena cannot display icons and text at the same time. They
8339 will show icons if both are requested.
8340
8341 If none of the strings specified in 'toolbar' are valid or if
8342 'toolbar' is empty, this option is ignored. If you want to disable
8343 the toolbar, you need to set the 'guioptions' option. For example: >
8344 :set guioptions-=T
8345< Also see |gui-toolbar|.
8346
8347 *'toolbariconsize'* *'tbis'*
8348'toolbariconsize' 'tbis' string (default "small")
8349 global
Bram Moolenaar3df01732017-02-17 22:47:16 +01008350 {only in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008351 Controls the size of toolbar icons. The possible values are:
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008352 tiny Use tiny icons.
8353 small Use small icons (default).
8354 medium Use medium-sized icons.
8355 large Use large icons.
8356 huge Use even larger icons.
8357 giant Use very big icons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008358 The exact dimensions in pixels of the various icon sizes depend on
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008359 the current theme. Common dimensions are giant=48x48, huge=32x32,
8360 large=24x24, medium=24x24, small=20x20 and tiny=16x16.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008361
8362 If 'toolbariconsize' is empty, the global default size as determined
8363 by user preferences or the current theme is used.
8364
8365 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
8366'ttybuiltin' 'tbi' boolean (default on)
8367 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008368 When on, the builtin termcaps are searched before the external ones.
8369 When off the builtin termcaps are searched after the external ones.
8370 When this option is changed, you should set the 'term' option next for
8371 the change to take effect, for example: >
8372 :set notbi term=$TERM
8373< See also |termcap|.
8374 Rationale: The default for this option is "on", because the builtin
8375 termcap entries are generally better (many systems contain faulty
8376 xterm entries...).
8377
8378 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
8379'ttyfast' 'tf' boolean (default off, on when 'term' is xterm, hpterm,
8380 sun-cmd, screen, rxvt, dtterm or
8381 iris-ansi; also on when running Vim in
8382 a DOS console)
8383 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008384 Indicates a fast terminal connection. More characters will be sent to
8385 the screen for redrawing, instead of using insert/delete line
8386 commands. Improves smoothness of redrawing when there are multiple
8387 windows and the terminal does not support a scrolling region.
8388 Also enables the extra writing of characters at the end of each screen
8389 line for lines that wrap. This helps when using copy/paste with the
8390 mouse in an xterm and other terminals.
8391
8392 *'ttymouse'* *'ttym'*
8393'ttymouse' 'ttym' string (default depends on 'term')
8394 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008395 {only in Unix and VMS, doesn't work in the GUI; not
8396 available when compiled without |+mouse|}
8397 Name of the terminal type for which mouse codes are to be recognized.
Bram Moolenaar2c7a7632007-05-10 18:19:11 +00008398 Currently these strings are valid:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008399 *xterm-mouse*
8400 xterm xterm-like mouse handling. The mouse generates
8401 "<Esc>[Mscr", where "scr" is three bytes:
8402 "s" = button state
8403 "c" = column plus 33
8404 "r" = row plus 33
Bram Moolenaare968e362014-05-13 20:23:24 +02008405 This only works up to 223 columns! See "dec",
8406 "urxvt", and "sgr" for solutions.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008407 xterm2 Works like "xterm", but with the xterm reporting the
8408 mouse position while the mouse is dragged. This works
8409 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00008410 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00008411 work. See below for how Vim detects this
8412 automatically.
8413 *netterm-mouse*
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008414 netterm NetTerm mouse handling. A left mouse click generates
Bram Moolenaar071d4272004-06-13 20:20:40 +00008415 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008416 for the row and column. No other mouse events are
8417 supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008418 *dec-mouse*
8419 dec DEC terminal mouse handling. The mouse generates a
8420 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00008421 This is also available for an Xterm, if it was
8422 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00008423 *jsbterm-mouse*
8424 jsbterm JSB term mouse handling.
8425 *pterm-mouse*
8426 pterm QNX pterm mouse handling.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008427 *urxvt-mouse*
8428 urxvt Mouse handling for the urxvt (rxvt-unicode) terminal.
Bram Moolenaare968e362014-05-13 20:23:24 +02008429 The mouse works only if the terminal supports this
8430 encoding style, but it does not have 223 columns limit
8431 unlike "xterm" or "xterm2".
Bram Moolenaar9b451252012-08-15 17:43:31 +02008432 *sgr-mouse*
8433 sgr Mouse handling for the terminal that emits SGR-styled
Bram Moolenaare968e362014-05-13 20:23:24 +02008434 mouse reporting. The mouse works even in columns
8435 beyond 223. This option is backward compatible with
8436 "xterm2" because it can also decode "xterm2" style
8437 mouse codes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008438
8439 The mouse handling must be enabled at compile time |+mouse_xterm|
Bram Moolenaare968e362014-05-13 20:23:24 +02008440 |+mouse_dec| |+mouse_netterm| |+mouse_jsbterm| |+mouse_urxvt|
8441 |+mouse_sgr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008442 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
8443 recognized, if enabled at compile time. DEC terminal mouse codes
8444 are recognized if enabled at compile time, and 'ttymouse' is not
Bram Moolenaare968e362014-05-13 20:23:24 +02008445 "xterm", "xterm2", "urxvt" or "sgr" (because dec mouse codes conflict
8446 with them).
Bram Moolenaar071d4272004-06-13 20:20:40 +00008447 This option is automatically set to "xterm", when the 'term' option is
Bram Moolenaar45758762016-10-12 23:08:06 +02008448 set to a name that starts with "xterm", "mlterm", "screen", "tmux",
8449 "st" (full match only), "st-" or "stterm", and 'ttymouse' is not set
8450 already.
Bram Moolenaare968e362014-05-13 20:23:24 +02008451 Additionally, if vim is compiled with the |+termresponse| feature and
8452 |t_RV| is set to the escape sequence to request the xterm version
Bram Moolenaarf8a07122019-07-01 22:06:07 +02008453 number, more intelligent detection is done.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008454 The "xterm2" value will be set if the xterm version is reported to be
Bram Moolenaard47d5222018-12-09 20:43:55 +01008455 from 95 to 276. The "sgr" value will be set if Vim detects Mac
8456 Terminal.app, iTerm2 or mintty, and when the xterm version is 277 or
8457 higher.
Bram Moolenaare968e362014-05-13 20:23:24 +02008458 If you do not want 'ttymouse' to be set to "xterm2" or "sgr"
8459 automatically, set t_RV to an empty string: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008460 :set t_RV=
8461<
8462 *'ttyscroll'* *'tsl'*
8463'ttyscroll' 'tsl' number (default 999)
8464 global
8465 Maximum number of lines to scroll the screen. If there are more lines
8466 to scroll the window is redrawn. For terminals where scrolling is
8467 very slow and redrawing is not slow this can be set to a small number,
8468 e.g., 3, to speed up displaying.
8469
8470 *'ttytype'* *'tty'*
8471'ttytype' 'tty' string (default from $TERM)
8472 global
8473 Alias for 'term', see above.
8474
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008475 *'undodir'* *'udir'*
8476'undodir' 'udir' string (default ".")
8477 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008478 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008479 List of directory names for undo files, separated with commas.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008480 See |'backupdir'| for details of the format.
Bram Moolenaar6a244fe2010-05-24 22:02:24 +02008481 "." means using the directory of the file. The undo file name for
8482 "file.txt" is ".file.txt.un~".
8483 For other directories the file name is the full path of the edited
8484 file, with path separators replaced with "%".
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008485 When writing: The first directory that exists is used. "." always
8486 works, no directories after "." will be used for writing.
8487 When reading all entries are tried to find an undo file. The first
8488 undo file that exists is used. When it cannot be read an error is
8489 given, no further entry is used.
8490 See |undo-persistence|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008491 This option cannot be set from a |modeline| or in the |sandbox|, for
8492 security reasons.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008493
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02008494 *'undofile'* *'noundofile'* *'udf'* *'noudf'*
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008495'undofile' 'udf' boolean (default off)
8496 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02008497 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008498 When on, Vim automatically saves undo history to an undo file when
8499 writing a buffer to a file, and restores undo history from the same
8500 file on buffer read.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008501 The directory where the undo file is stored is specified by 'undodir'.
8502 For more information about this feature see |undo-persistence|.
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008503 The undo file is not read when 'undoreload' causes the buffer from
8504 before a reload to be saved for undo.
Bram Moolenaar97d62492012-11-15 21:28:22 +01008505 When 'undofile' is turned off the undo file is NOT deleted.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008506 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008507
Bram Moolenaar071d4272004-06-13 20:20:40 +00008508 *'undolevels'* *'ul'*
Bram Moolenaar8024f932020-01-14 19:29:13 +01008509'undolevels' 'ul' number (default 100, 1000 for Unix, VMS and Win32)
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008510 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008511 Maximum number of changes that can be undone. Since undo information
Bram Moolenaar5be4cee2019-09-27 19:34:08 +02008512 is kept in memory, higher numbers will cause more memory to be used.
8513 Nevertheless, a single change can already use a large amount of memory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008514 Set to 0 for Vi compatibility: One level of undo and "u" undoes
8515 itself: >
8516 set ul=0
8517< But you can also get Vi compatibility by including the 'u' flag in
8518 'cpoptions', and still be able to use CTRL-R to repeat undo.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008519 Also see |undo-two-ways|.
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008520 Set to -1 for no undo at all. You might want to do this only for the
8521 current buffer: >
8522 setlocal ul=-1
Bram Moolenaar071d4272004-06-13 20:20:40 +00008523< This helps when you run out of memory for a single change.
Bram Moolenaar32efaf62014-11-05 17:02:17 +01008524
8525 The local value is set to -123456 when the global value is to be used.
8526
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008527 Also see |clear-undo|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008528
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008529 *'undoreload'* *'ur'*
8530'undoreload' 'ur' number (default 10000)
8531 global
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008532 Save the whole buffer for undo when reloading it. This applies to the
8533 ":e!" command and reloading for when the buffer changed outside of
8534 Vim. |FileChangedShell|
Bram Moolenaar24a98a02017-09-27 22:23:55 +02008535 The save only happens when this option is negative or when the number
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008536 of lines is smaller than the value of this option.
8537 Set this option to zero to disable undo for a reload.
8538
8539 When saving undo for a reload, any undo file is not read.
8540
8541 Note that this causes the whole buffer to be stored in memory. Set
8542 this option to a lower value if you run out of memory.
8543
Bram Moolenaar071d4272004-06-13 20:20:40 +00008544 *'updatecount'* *'uc'*
8545'updatecount' 'uc' number (default: 200)
8546 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008547 After typing this many characters the swap file will be written to
8548 disk. When zero, no swap file will be created at all (see chapter on
8549 recovery |crash-recovery|). 'updatecount' is set to zero by starting
8550 Vim with the "-n" option, see |startup|. When editing in readonly
8551 mode this option will be initialized to 10000.
8552 The swapfile can be disabled per buffer with |'swapfile'|.
8553 When 'updatecount' is set from zero to non-zero, swap files are
8554 created for all buffers that have 'swapfile' set. When 'updatecount'
8555 is set to zero, existing swap files are not deleted.
8556 Also see |'swapsync'|.
8557 This option has no meaning in buffers where |'buftype'| is "nofile"
8558 or "nowrite".
8559
8560 *'updatetime'* *'ut'*
8561'updatetime' 'ut' number (default 4000)
8562 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008563 If this many milliseconds nothing is typed the swap file will be
8564 written to disk (see |crash-recovery|). Also used for the
8565 |CursorHold| autocommand event.
8566
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008567 *'varsofttabstop'* *'vsts'*
8568'varsofttabstop' 'vsts' string (default "")
8569 local to buffer
8570 {only available when compiled with the |+vartabs|
8571 feature}
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008572 A list of the number of spaces that a <Tab> counts for while editing,
8573 such as inserting a <Tab> or using <BS>. It "feels" like variable-
8574 width <Tab>s are being inserted, while in fact a mixture of spaces
8575 and <Tab>s is used. Tab widths are separated with commas, with the
8576 final value applying to all subsequent tabs.
8577
8578 For example, when editing assembly language files where statements
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02008579 start in the 9th column and comments in the 41st, it may be useful
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008580 to use the following: >
8581 :set varsofttabstop=8,32,8
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02008582< This will set soft tabstops with 8 and 8 + 32 spaces, and 8 more
8583 for every column thereafter.
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008584
8585 Note that the value of |'softtabstop'| will be ignored while
8586 'varsofttabstop' is set.
8587
8588 *'vartabstop'* *'vts'*
8589'vartabstop' 'vts' string (default "")
8590 local to buffer
8591 {only available when compiled with the |+vartabs|
8592 feature}
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008593 A list of the number of spaces that a <Tab> in the file counts for,
8594 separated by commas. Each value corresponds to one tab, with the
8595 final value applying to all subsequent tabs. For example: >
8596 :set vartabstop=4,20,10,8
8597< This will make the first tab 4 spaces wide, the second 20 spaces,
8598 the third 10 spaces, and all following tabs 8 spaces.
8599
8600 Note that the value of |'tabstop'| will be ignored while 'vartabstop'
8601 is set.
8602
Bram Moolenaar071d4272004-06-13 20:20:40 +00008603 *'verbose'* *'vbs'*
8604'verbose' 'vbs' number (default 0)
8605 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008606 When bigger than zero, Vim will give messages about what it is doing.
8607 Currently, these messages are given:
8608 >= 1 When the viminfo file is read or written.
8609 >= 2 When a file is ":source"'ed.
Bram Moolenaar647a5302020-05-03 17:01:24 +02008610 >= 4 Shell commands.
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008611 >= 5 Every searched tags file and include file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008612 >= 8 Files for which a group of autocommands is executed.
8613 >= 9 Every executed autocommand.
Bram Moolenaar647a5302020-05-03 17:01:24 +02008614 >= 11 Finding items in a path
Bram Moolenaar071d4272004-06-13 20:20:40 +00008615 >= 12 Every executed function.
8616 >= 13 When an exception is thrown, caught, finished, or discarded.
8617 >= 14 Anything pending in a ":finally" clause.
Bram Moolenaar823654b2020-05-29 23:03:09 +02008618 >= 15 Every executed Ex command from a script (truncated at 200
8619 characters).
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02008620 >= 16 Every executed Ex command.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008621
8622 This option can also be set with the "-V" argument. See |-V|.
8623 This option is also set by the |:verbose| command.
8624
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008625 When the 'verbosefile' option is set then the verbose messages are not
8626 displayed.
8627
8628 *'verbosefile'* *'vfile'*
8629'verbosefile' 'vfile' string (default empty)
8630 global
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008631 When not empty all messages are written in a file with this name.
8632 When the file exists messages are appended.
8633 Writing to the file ends when Vim exits or when 'verbosefile' is made
Bram Moolenaar80794b12010-06-13 05:20:42 +02008634 empty. Writes are buffered, thus may not show up for some time.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008635 Setting 'verbosefile' to a new value is like making it empty first.
8636 The difference with |:redir| is that verbose messages are not
8637 displayed when 'verbosefile' is set.
8638
Bram Moolenaar071d4272004-06-13 20:20:40 +00008639 *'viewdir'* *'vdir'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008640'viewdir' 'vdir' string (default for Amiga and Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008641 "$VIM/vimfiles/view",
8642 for Unix: "~/.vim/view",
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02008643 for macOS: "$VIM:vimfiles:view"
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01008644 for VMS: "sys$login:vimfiles/view")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008645 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008646 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008647 feature}
8648 Name of the directory where to store files for |:mkview|.
8649 This option cannot be set from a |modeline| or in the |sandbox|, for
8650 security reasons.
8651
8652 *'viewoptions'* *'vop'*
Bram Moolenaar13e90412017-11-11 18:16:48 +01008653'viewoptions' 'vop' string (default: "folds,options,cursor,curdir")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008654 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008655 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008656 feature}
8657 Changes the effect of the |:mkview| command. It is a comma separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008658 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008659 word save and restore ~
8660 cursor cursor position in file and in window
8661 folds manually created folds, opened/closed folds and local
8662 fold options
8663 options options and mappings local to a window or buffer (not
8664 global values for local options)
Bram Moolenaar6e932462014-09-09 18:48:09 +02008665 localoptions same as "options"
Bram Moolenaar071d4272004-06-13 20:20:40 +00008666 slash backslashes in file names replaced with forward
8667 slashes
8668 unix with Unix end-of-line format (single <NL>), even when
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008669 on MS-Windows
Bram Moolenaar13e90412017-11-11 18:16:48 +01008670 curdir the window-local directory, if set with `:lcd`
Bram Moolenaar071d4272004-06-13 20:20:40 +00008671
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008672 "slash" and "unix" are useful on MS-Windows when sharing view files
Bram Moolenaar071d4272004-06-13 20:20:40 +00008673 with Unix. The Unix version of Vim cannot source dos format scripts,
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008674 but the MS-Windows version of Vim can source unix format scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008675
8676 *'viminfo'* *'vi'* *E526* *E527* *E528*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008677'viminfo' 'vi' string (Vi default: "", Vim default for
8678 MS-Windows: '100,<50,s10,h,rA:,rB:,
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01008679 for Amiga: '100,<50,s10,h,rdf0:,rdf1:,rdf2:
8680 for others: '100,<50,s10,h)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008681 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008682 {not available when compiled without the |+viminfo|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008683 feature}
8684 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008685 when exiting Vim (see |viminfo-file|). Except when 'viminfofile' is
8686 "NONE".
8687 The string should be a comma separated list of parameters, each
8688 consisting of a single character identifying the particular parameter,
8689 followed by a number or string which specifies the value of that
8690 parameter. If a particular character is left out, then the default
8691 value is used for that parameter. The following is a list of the
8692 identifying characters and the effect of their value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008693 CHAR VALUE ~
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008694 *viminfo-!*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008695 ! When included, save and restore global variables that start
8696 with an uppercase letter, and don't contain a lowercase
8697 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar680eeca2010-10-20 17:44:42 +02008698 and "_K_L_M" are not. Nested List and Dict items may not be
Bram Moolenaar166af9b2010-11-16 20:34:40 +01008699 read back correctly, you end up with an empty item.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008700 *viminfo-quote*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008701 " Maximum number of lines saved for each register. Old name of
8702 the '<' item, with the disadvantage that you need to put a
8703 backslash before the ", otherwise it will be recognized as the
8704 start of a comment!
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008705 *viminfo-%*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008706 % When included, save and restore the buffer list. If Vim is
8707 started with a file name argument, the buffer list is not
8708 restored. If Vim is started without a file name argument, the
Bram Moolenaard042dc82015-11-24 19:18:36 +01008709 buffer list is restored from the viminfo file. Quickfix
8710 ('buftype'), unlisted ('buflisted'), unnamed and buffers on
8711 removable media (|viminfo-r|) are not saved.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00008712 When followed by a number, the number specifies the maximum
8713 number of buffers that are stored. Without a number all
8714 buffers are stored.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008715 *viminfo-'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008716 ' Maximum number of previously edited files for which the marks
8717 are remembered. This parameter must always be included when
8718 'viminfo' is non-empty.
8719 Including this item also means that the |jumplist| and the
8720 |changelist| are stored in the viminfo file.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008721 *viminfo-/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008722 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008723 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00008724 patterns are also saved. When not included, the value of
8725 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008726 *viminfo-:*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008727 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008728 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008729 *viminfo-<*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008730 < Maximum number of lines saved for each register. If zero then
8731 registers are not saved. When not included, all lines are
8732 saved. '"' is the old name for this item.
8733 Also see the 's' item below: limit specified in Kbyte.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008734 *viminfo-@*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008735 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008736 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008737 *viminfo-c*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008738 c When included, convert the text in the viminfo file from the
8739 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00008740 'encoding'. See |viminfo-encoding|.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008741 *viminfo-f*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008742 f Whether file marks need to be stored. If zero, file marks ('0
8743 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008744 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00008745 cursor position (when exiting or when doing ":wviminfo").
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008746 *viminfo-h*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008747 h Disable the effect of 'hlsearch' when loading the viminfo
8748 file. When not included, it depends on whether ":nohlsearch"
8749 has been used since the last search command.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008750 *viminfo-n*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008751 n Name of the viminfo file. The name must immediately follow
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008752 the 'n'. Must be at the end of the option! If the
8753 'viminfofile' option is set, that file name overrides the one
8754 given here with 'viminfo'. Environment variables are
Bram Moolenaar063b9d12016-07-09 20:21:48 +02008755 expanded when opening the file, not when setting the option.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008756 *viminfo-r*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008757 r Removable media. The argument is a string (up to the next
8758 ','). This parameter can be given several times. Each
8759 specifies the start of a path for which no marks will be
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01008760 stored. This is to avoid removable media. For MS-Windows you
Bram Moolenaar071d4272004-06-13 20:20:40 +00008761 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
8762 also use it for temp files, e.g., for Unix: "r/tmp". Case is
8763 ignored. Maximum length of each 'r' argument is 50
8764 characters.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008765 *viminfo-s*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008766 s Maximum size of an item in Kbyte. If zero then registers are
8767 not saved. Currently only applies to registers. The default
8768 "s10" will exclude registers with more than 10 Kbyte of text.
8769 Also see the '<' item above: line count limit.
8770
8771 Example: >
8772 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
8773<
8774 '50 Marks will be remembered for the last 50 files you
8775 edited.
8776 <1000 Contents of registers (up to 1000 lines each) will be
8777 remembered.
8778 s100 Registers with more than 100 Kbyte text are skipped.
8779 :0 Command-line history will not be saved.
8780 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
8781 no / Since '/' is not specified, the default will be used,
8782 that is, save all of the search history, and also the
8783 previous search and substitute patterns.
8784 no % The buffer list will not be saved nor read back.
8785 no h 'hlsearch' highlighting will be restored.
8786
8787 When setting 'viminfo' from an empty value you can use |:rviminfo| to
8788 load the contents of the file, this is not done automatically.
8789
8790 This option cannot be set from a |modeline| or in the |sandbox|, for
8791 security reasons.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008792 NOTE: This option is set to the Vim default value when 'compatible'
8793 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008794
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008795 *'viminfofile'* *'vif'*
8796'viminfofile' 'vif' string (default: "")
8797 global
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008798 {not available when compiled without the |+viminfo|
8799 feature}
8800 When non-empty, overrides the file name used for viminfo.
8801 When equal to "NONE" no viminfo file will be read or written.
8802 This option can be set with the |-i| command line flag. The |--clean|
8803 command line flag sets it to "NONE".
Bram Moolenaar110289e2019-05-23 15:38:06 +02008804 This option cannot be set from a |modeline| or in the |sandbox|, for
8805 security reasons.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008806
Bram Moolenaar071d4272004-06-13 20:20:40 +00008807 *'virtualedit'* *'ve'*
8808'virtualedit' 've' string (default "")
Gary Johnson51ad8502021-08-03 18:33:08 +02008809 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008810 A comma separated list of these words:
8811 block Allow virtual editing in Visual block mode.
8812 insert Allow virtual editing in Insert mode.
8813 all Allow virtual editing in all modes.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008814 onemore Allow the cursor to move just past the end of the line
Gary Johnson53ba05b2021-07-26 22:19:10 +02008815 none When used as the local value, do not allow virtual
8816 editing even when the global value is set. When used
8817 as the global value, "none" is the same as "".
8818 NONE Alternative spelling of "none".
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008819
Bram Moolenaar071d4272004-06-13 20:20:40 +00008820 Virtual editing means that the cursor can be positioned where there is
Bram Moolenaarebcbd022007-05-12 14:28:25 +00008821 no actual character. This can be halfway into a tab or beyond the end
Bram Moolenaar071d4272004-06-13 20:20:40 +00008822 of the line. Useful for selecting a rectangle in Visual mode and
8823 editing a table.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008824 "onemore" is not the same, it will only allow moving the cursor just
8825 after the last character of the line. This makes some commands more
8826 consistent. Previously the cursor was always past the end of the line
8827 if the line was empty. But it is far from Vi compatible. It may also
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008828 break some plugins or Vim scripts. For example because |l| can move
8829 the cursor after the last character. Use with care!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02008830 Using the `$` command will move to the last character in the line, not
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008831 past it. This may actually move the cursor to the left!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02008832 The `g$` command will move to the end of the screen line.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008833 It doesn't make sense to combine "all" with "onemore", but you will
8834 not get a warning for it.
Bram Moolenaar53f7fcc2021-07-28 20:10:16 +02008835 When combined with other words, "none" is ignored.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008836 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008837
8838 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
8839'visualbell' 'vb' boolean (default off)
8840 global
Bram Moolenaar74675a62017-07-15 13:53:23 +02008841 Use a visual bell instead of beeping. The terminal code to display the
Bram Moolenaar071d4272004-06-13 20:20:40 +00008842 visual bell is given with 't_vb'. When no beep or flash is wanted,
Bram Moolenaar74675a62017-07-15 13:53:23 +02008843 use: >
8844 :set vb t_vb=
8845< If you want a short flash, you can use this on many terminals: >
8846 :set vb t_vb=[?5h$<100>[?5l
8847< Here $<100> specifies the time, you can use a smaller or bigger value
8848 to get a shorter or longer flash.
8849
8850 Note: Vim will limit the bell to once per half a second. This avoids
8851 having to wait for the flashing to finish when there are lots of
8852 bells, e.g. on key repeat. This also happens without 'visualbell'
8853 set.
8854
Bram Moolenaar071d4272004-06-13 20:20:40 +00008855 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
8856 for 20 msec. If you want to use a different time, use "<Esc>|40f",
8857 where 40 is the time in msec.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008858
8859 Note: When the GUI starts, 't_vb' is reset to its default value. You
8860 might want to set it again in your |gvimrc|.
8861
Bram Moolenaar071d4272004-06-13 20:20:40 +00008862 Does not work on the Amiga, you always get a screen flash.
8863 Also see 'errorbells'.
8864
8865 *'warn'* *'nowarn'*
8866'warn' boolean (default on)
8867 global
8868 Give a warning message when a shell command is used while the buffer
8869 has been changed.
8870
8871 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
8872'weirdinvert' 'wiv' boolean (default off)
8873 global
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00008874 This option has the same effect as the 't_xs' terminal option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008875 It is provided for backwards compatibility with version 4.x.
8876 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
8877 vice versa. Has no effect when the GUI is running.
8878
8879 *'whichwrap'* *'ww'*
8880'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
8881 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008882 Allow specified keys that move the cursor left/right to move to the
8883 previous/next line when the cursor is on the first/last character in
8884 the line. Concatenate characters to allow this for these keys:
8885 char key mode ~
8886 b <BS> Normal and Visual
8887 s <Space> Normal and Visual
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008888 h "h" Normal and Visual (not recommended)
8889 l "l" Normal and Visual (not recommended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008890 < <Left> Normal and Visual
8891 > <Right> Normal and Visual
8892 ~ "~" Normal
8893 [ <Left> Insert and Replace
8894 ] <Right> Insert and Replace
8895 For example: >
8896 :set ww=<,>,[,]
8897< allows wrap only when cursor keys are used.
8898 When the movement keys are used in combination with a delete or change
8899 operator, the <EOL> also counts for a character. This makes "3h"
8900 different from "3dh" when the cursor crosses the end of a line. This
8901 is also true for "x" and "X", because they do the same as "dl" and
8902 "dh". If you use this, you may also want to use the mapping
8903 ":map <BS> X" to make backspace delete the character in front of the
8904 cursor.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00008905 When 'l' is included and it is used after an operator at the end of a
Bram Moolenaar589edb32019-09-20 14:38:13 +02008906 line (not an empty line) then it will not move to the next line. This
8907 makes "dl", "cl", "yl" etc. work normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008908 NOTE: This option is set to the Vi default value when 'compatible' is
8909 set and to the Vim default value when 'compatible' is reset.
8910
8911 *'wildchar'* *'wc'*
8912'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
8913 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008914 Character you have to type to start wildcard expansion in the
8915 command-line, as specified with 'wildmode'.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008916 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008917 The character is not recognized when used inside a macro. See
8918 'wildcharm' for that.
Bram Moolenaar34cc7d82021-09-21 20:09:51 +02008919 Some keys will not work, such as CTRL-C, <CR> and Enter.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008920 Although 'wc' is a number option, you can set it to a special key: >
Bram Moolenaar34cc7d82021-09-21 20:09:51 +02008921 :set wc=<Tab>
Bram Moolenaar071d4272004-06-13 20:20:40 +00008922< NOTE: This option is set to the Vi default value when 'compatible' is
8923 set and to the Vim default value when 'compatible' is reset.
8924
8925 *'wildcharm'* *'wcm'*
8926'wildcharm' 'wcm' number (default: none (0))
8927 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008928 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00008929 recognized when used inside a macro. You can find "spare" command-line
8930 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00008931 you'll never actually type 'wildcharm', just use it in mappings that
8932 automatically invoke completion mode, e.g.: >
8933 :set wcm=<C-Z>
Bram Moolenaar446cb832008-06-24 21:56:24 +00008934 :cnoremap ss so $vim/sessions/*.vim<C-Z>
Bram Moolenaar071d4272004-06-13 20:20:40 +00008935< Then after typing :ss you can use CTRL-P & CTRL-N.
8936
8937 *'wildignore'* *'wig'*
8938'wildignore' 'wig' string (default "")
8939 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008940 {not available when compiled without the |+wildignore|
8941 feature}
8942 A list of file patterns. A file that matches with one of these
Bram Moolenaar30b65812012-07-12 22:01:11 +02008943 patterns is ignored when expanding |wildcards|, completing file or
8944 directory names, and influences the result of |expand()|, |glob()| and
8945 |globpath()| unless a flag is passed to disable this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008946 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
8947 Also see 'suffixes'.
8948 Example: >
8949 :set wildignore=*.o,*.obj
8950< The use of |:set+=| and |:set-=| is preferred when adding or removing
8951 a pattern from the list. This avoids problems when a future version
8952 uses another default.
8953
Bram Moolenaar94950a92010-12-02 16:01:29 +01008954
Bram Moolenaar81af9252010-12-10 20:35:50 +01008955 *'wildignorecase'* *'wic'* *'nowildignorecase'* *'nowic'*
Bram Moolenaar94950a92010-12-02 16:01:29 +01008956'wildignorecase' 'wic' boolean (default off)
8957 global
Bram Moolenaar94950a92010-12-02 16:01:29 +01008958 When set case is ignored when completing file names and directories.
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01008959 Has no effect when 'fileignorecase' is set.
Bram Moolenaar94950a92010-12-02 16:01:29 +01008960 Does not apply when the shell is used to expand wildcards, which
8961 happens when there are special characters.
8962
8963
Bram Moolenaar071d4272004-06-13 20:20:40 +00008964 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02008965'wildmenu' 'wmnu' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008966 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008967 {not available if compiled without the |+wildmenu|
8968 feature}
8969 When 'wildmenu' is on, command-line completion operates in an enhanced
8970 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
8971 the possible matches are shown just above the command line, with the
8972 first match highlighted (overwriting the status line, if there is
8973 one). Keys that show the previous/next match, such as <Tab> or
8974 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
8975 When 'wildmode' is used, "wildmenu" mode is used where "full" is
8976 specified. "longest" and "list" do not start "wildmenu" mode.
Bram Moolenaar26402cb2013-02-20 21:26:00 +01008977 You can check the current mode with |wildmenumode()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008978 If there are more matches than can fit in the line, a ">" is shown on
8979 the right and/or a "<" is shown on the left. The status line scrolls
8980 as needed.
8981 The "wildmenu" mode is abandoned when a key is hit that is not used
8982 for selecting a completion.
8983 While the "wildmenu" is active the following keys have special
8984 meanings:
8985
8986 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
8987 <Down> - in filename/menu name completion: move into a
8988 subdirectory or submenu.
8989 <CR> - in menu completion, when the cursor is just after a
8990 dot: move into a submenu.
8991 <Up> - in filename/menu name completion: move up into
8992 parent directory or parent menu.
8993
8994 This makes the menus accessible from the console |console-menus|.
8995
8996 If you prefer the <Left> and <Right> keys to move the cursor instead
8997 of selecting a different match, use this: >
8998 :cnoremap <Left> <Space><BS><Left>
8999 :cnoremap <Right> <Space><BS><Right>
9000<
9001 The "WildMenu" highlighting is used for displaying the current match
9002 |hl-WildMenu|.
9003
9004 *'wildmode'* *'wim'*
9005'wildmode' 'wim' string (Vim default: "full")
9006 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009007 Completion mode that is used for the character specified with
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009008 'wildchar'. It is a comma separated list of up to four parts. Each
Bram Moolenaar02467872007-05-06 13:22:01 +00009009 part specifies what to do for each consecutive use of 'wildchar'. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00009010 first part specifies the behavior for the first use of 'wildchar',
9011 The second part for the second use, etc.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009012
9013 Each part consists of a colon separated list consisting of the
9014 following possible values:
Bram Moolenaar071d4272004-06-13 20:20:40 +00009015 "" Complete only the first match.
9016 "full" Complete the next full match. After the last match,
9017 the original string is used and then the first match
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009018 again. Will also start 'wildmenu' if it is enabled.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009019 "longest" Complete till longest common string. If this doesn't
9020 result in a longer string, use the next part.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009021 "list" When more than one match, list all matches.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009022 "lastused" When completing buffer names and more than one buffer
9023 matches, sort buffers by time last used (other than
9024 the current buffer).
9025 When there is only a single match, it is fully completed in all cases.
9026
9027 Examples of useful colon-separated values:
9028 "longest:full" Like "longest", but also start 'wildmenu' if it is
9029 enabled. Will not complete to the next full match.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009030 "list:full" When more than one match, list all matches and
9031 complete first match.
9032 "list:longest" When more than one match, list all matches and
9033 complete till longest common string.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009034 "list:lastused" When more than one buffer matches, list all matches
9035 and sort buffers by time last used (other than the
9036 current buffer).
Bram Moolenaar071d4272004-06-13 20:20:40 +00009037
9038 Examples: >
9039 :set wildmode=full
Bram Moolenaar582fd852005-03-28 20:58:01 +00009040< Complete first full match, next match, etc. (the default) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00009041 :set wildmode=longest,full
9042< Complete longest common string, then each full match >
9043 :set wildmode=list:full
9044< List all matches and complete each full match >
9045 :set wildmode=list,full
9046< List all matches without completing, then each full match >
9047 :set wildmode=longest,list
9048< Complete longest common string, then list alternatives.
Bram Moolenaar446cb832008-06-24 21:56:24 +00009049 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009050
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009051 *'wildoptions'* *'wop'*
9052'wildoptions' 'wop' string (default "")
9053 global
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009054 {not available when compiled without the |+wildignore|
9055 feature}
9056 A list of words that change how command line completion is done.
9057 Currently only one word is allowed:
9058 tagfile When using CTRL-D to list matching tags, the kind of
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00009059 tag and the file of the tag is listed. Only one match
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009060 is displayed per line. Often used tag kinds are:
9061 d #define
9062 f function
9063 Also see |cmdline-completion|.
9064
Bram Moolenaar071d4272004-06-13 20:20:40 +00009065 *'winaltkeys'* *'wak'*
9066'winaltkeys' 'wak' string (default "menu")
9067 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009068 {only used in Win32, Motif, GTK and Photon GUI}
9069 Some GUI versions allow the access to menu entries by using the ALT
9070 key in combination with a character that appears underlined in the
9071 menu. This conflicts with the use of the ALT key for mappings and
9072 entering special characters. This option tells what to do:
9073 no Don't use ALT keys for menus. ALT key combinations can be
9074 mapped, but there is no automatic handling. This can then be
9075 done with the |:simalt| command.
9076 yes ALT key handling is done by the windowing system. ALT key
9077 combinations cannot be mapped.
9078 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009079 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00009080 keys can be mapped.
9081 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
9082 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00009083 This option is not used for <F10>; on Win32 and with GTK <F10> will
9084 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009085
Bram Moolenaar4d784b22019-05-25 19:51:39 +02009086 *'wincolor'* *'wcr'*
9087'wincolor' 'wcr' string (default empty)
9088 local to window
9089 Highlight group name to use for this window instead of the Normal
9090 color |hl-Normal|.
9091
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009092 *'window'* *'wi'*
9093'window' 'wi' number (default screen height - 1)
9094 global
Bram Moolenaardad44732021-03-31 20:07:33 +02009095 Window height used for |CTRL-F| and |CTRL-B| when there is only one
9096 window and the value is smaller than 'lines' minus one. The screen
9097 will scroll 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009098 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
9099 in a much smarter way, taking care of wrapping lines.
9100 When resizing the Vim window, the value is smaller than 1 or more than
9101 or equal to 'lines' it will be set to 'lines' minus 1.
Bram Moolenaardad44732021-03-31 20:07:33 +02009102 Note: Do not confuse this with the height of the Vim window, use
9103 'lines' for that.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009104
Bram Moolenaar071d4272004-06-13 20:20:40 +00009105 *'winheight'* *'wh'* *E591*
9106'winheight' 'wh' number (default 1)
9107 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009108 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009109 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar446cb832008-06-24 21:56:24 +00009110 focus goes to a window that is smaller, its size is increased, at the
9111 cost of the height of other windows.
9112 Set 'winheight' to a small number for normal editing.
9113 Set it to 999 to make the current window fill most of the screen.
9114 Other windows will be only 'winminheight' high. This has the drawback
9115 that ":all" will create only two windows. To avoid "vim -o 1 2 3 4"
9116 to create only two windows, set the option after startup is done,
9117 using the |VimEnter| event: >
9118 au VimEnter * set winheight=999
9119< Minimum value is 1.
9120 The height is not adjusted after one of the commands that change the
Bram Moolenaar071d4272004-06-13 20:20:40 +00009121 height of the current window.
9122 'winheight' applies to the current window. Use 'winminheight' to set
9123 the minimal height for other windows.
9124
9125 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
9126'winfixheight' 'wfh' boolean (default off)
9127 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00009128 Keep the window height when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00009129 'equalalways' is set. Also for |CTRL-W_=|. Set by default for the
9130 |preview-window| and |quickfix-window|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009131 The height may be changed anyway when running out of room.
9132
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009133 *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'*
9134'winfixwidth' 'wfw' boolean (default off)
9135 local to window
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009136 Keep the window width when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00009137 'equalalways' is set. Also for |CTRL-W_=|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009138 The width may be changed anyway when running out of room.
9139
Bram Moolenaar071d4272004-06-13 20:20:40 +00009140 *'winminheight'* *'wmh'*
9141'winminheight' 'wmh' number (default 1)
9142 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009143 The minimal height of a window, when it's not the current window.
9144 This is a hard minimum, windows will never become smaller.
9145 When set to zero, windows may be "squashed" to zero lines (i.e. just a
9146 status bar) if necessary. They will return to at least one line when
9147 they become active (since the cursor has to have somewhere to go.)
9148 Use 'winheight' to set the minimal height of the current window.
9149 This option is only checked when making a window smaller. Don't use a
9150 large number, it will cause errors when opening more than a few
9151 windows. A value of 0 to 3 is reasonable.
9152
9153 *'winminwidth'* *'wmw'*
9154'winminwidth' 'wmw' number (default 1)
9155 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009156 The minimal width of a window, when it's not the current window.
9157 This is a hard minimum, windows will never become smaller.
9158 When set to zero, windows may be "squashed" to zero columns (i.e. just
9159 a vertical separator) if necessary. They will return to at least one
9160 line when they become active (since the cursor has to have somewhere
9161 to go.)
9162 Use 'winwidth' to set the minimal width of the current window.
9163 This option is only checked when making a window smaller. Don't use a
9164 large number, it will cause errors when opening more than a few
9165 windows. A value of 0 to 12 is reasonable.
9166
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009167 *'winptydll'*
9168'winptydll' string (default "winpty32.dll" or "winpty64.dll")
9169 global
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009170 {only available when compiled with the |terminal|
9171 feature on MS-Windows}
9172 Specifies the name of the winpty shared library, used for the
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02009173 |:terminal| command. The default depends on whether Vim was built as a
Bram Moolenaarc572da52017-08-27 16:52:01 +02009174 32-bit or 64-bit executable. If not found, "winpty.dll" is tried as
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009175 a fallback.
9176 Environment variables are expanded |:set_env|.
9177 This option cannot be set from a |modeline| or in the |sandbox|, for
9178 security reasons.
9179
Bram Moolenaar071d4272004-06-13 20:20:40 +00009180 *'winwidth'* *'wiw'* *E592*
9181'winwidth' 'wiw' number (default 20)
9182 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009183 Minimal number of columns for the current window. This is not a hard
9184 minimum, Vim will use fewer columns if there is not enough room. If
9185 the current window is smaller, its size is increased, at the cost of
9186 the width of other windows. Set it to 999 to make the current window
9187 always fill the screen. Set it to a small number for normal editing.
9188 The width is not adjusted after one of the commands to change the
9189 width of the current window.
9190 'winwidth' applies to the current window. Use 'winminwidth' to set
9191 the minimal width for other windows.
9192
9193 *'wrap'* *'nowrap'*
9194'wrap' boolean (default on)
9195 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00009196 This option changes how text is displayed. It doesn't change the text
9197 in the buffer, see 'textwidth' for that.
9198 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009199 displaying continues on the next line. When off lines will not wrap
9200 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00009201 moved to a part that is not shown, the screen will scroll
9202 horizontally.
9203 The line will be broken in the middle of a word if necessary. See
9204 'linebreak' to get the break at a word boundary.
9205 To make scrolling horizontally a bit more useful, try this: >
9206 :set sidescroll=5
9207 :set listchars+=precedes:<,extends:>
9208< See 'sidescroll', 'listchars' and |wrap-off|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01009209 This option can't be set from a |modeline| when the 'diff' option is
9210 on.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009211
9212 *'wrapmargin'* *'wm'*
9213'wrapmargin' 'wm' number (default 0)
9214 local to buffer
9215 Number of characters from the right window border where wrapping
9216 starts. When typing text beyond this limit, an <EOL> will be inserted
9217 and inserting continues on the next line.
9218 Options that add a margin, such as 'number' and 'foldcolumn', cause
9219 the text width to be further reduced. This is Vi compatible.
9220 When 'textwidth' is non-zero, this option is not used.
Bram Moolenaarca635012015-09-25 20:34:21 +02009221 This option is set to 0 when 'paste' is set and restored when 'paste'
9222 is reset.
Bram Moolenaara6c27c42019-05-09 19:16:22 +02009223 See also 'formatoptions' and |ins-textwidth|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009224
9225 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
9226'wrapscan' 'ws' boolean (default on) *E384* *E385*
9227 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00009228 Searches wrap around the end of the file. Also applies to |]s| and
9229 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009230
9231 *'write'* *'nowrite'*
9232'write' boolean (default on)
9233 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009234 Allows writing files. When not set, writing a file is not allowed.
9235 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009236 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00009237 argument. Filtering text is still possible, even though this requires
9238 writing a temporary file.
9239
9240 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
9241'writeany' 'wa' boolean (default off)
9242 global
9243 Allows writing to any file with no need for "!" override.
9244
9245 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
9246'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
9247 otherwise)
9248 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009249 Make a backup before overwriting a file. The backup is removed after
9250 the file was successfully written, unless the 'backup' option is
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02009251 also on.
9252 WARNING: Switching this option off means that when Vim fails to write
9253 your buffer correctly and then, for whatever reason, Vim exits, you
9254 lose both the original file and what you were writing. Only reset
9255 this option if your file system is almost full and it makes the write
9256 fail (and make sure not to exit Vim until the write was successful).
9257 See |backup-table| for another explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009258 When the 'backupskip' pattern matches, a backup is not made anyway.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01009259 Depending on 'backupcopy' the backup is a new file or the original
9260 file renamed (and a new file is written).
Bram Moolenaar071d4272004-06-13 20:20:40 +00009261 NOTE: This option is set to the default value when 'compatible' is
9262 set.
9263
9264 *'writedelay'* *'wd'*
9265'writedelay' 'wd' number (default 0)
9266 global
Bram Moolenaar802a0d92016-06-26 16:17:58 +02009267 The number of milliseconds to wait for each character sent to the
Bram Moolenaar071d4272004-06-13 20:20:40 +00009268 screen. When non-zero, characters are sent to the terminal one by
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01009269 one. For debugging purposes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009270
Bram Moolenaar6f79e612021-12-21 09:12:23 +00009271 *'xtermcodes'* *'noxtermcodes'*
9272'xtermcodes' boolean (default on)
9273 global
9274 When detecting xterm patchlevel 141 or higher with the termresponse
Bram Moolenaarfa3b7232021-12-24 13:18:38 +00009275 mechanism and this option is set, Vim will request the actual terminal
Bram Moolenaar6f79e612021-12-21 09:12:23 +00009276 key codes and number of colors from the terminal. This takes care of
9277 various configuration options of the terminal that cannot be obtained
9278 from the termlib/terminfo entry, see |xterm-codes|.
9279 A side effect may be that t_Co changes and Vim will redraw the
9280 display.
9281
9282
Bram Moolenaar91f84f62018-07-29 15:07:52 +02009283 vim:tw=78:ts=8:noet:ft=help:norl: