blob: 65ed54f046a352411a6f1920d2ae9b091c1b0e6a [file] [log] [blame]
Bram Moolenaar2f0936c2022-01-08 21:51:59 +00001*options.txt* For Vim version 8.2. Last change: 2022 Jan 02
Bram Moolenaar071d4272004-06-13 20:20:40 +00002
3
4 VIM REFERENCE MANUAL by Bram Moolenaar
5
6
7Options *options*
8
91. Setting options |set-option|
102. Automatically setting options |auto-setting|
113. Options summary |option-summary|
12
Bram Moolenaar2ec618c2016-10-01 14:47:05 +020013For an overview of options see quickref.txt |option-list|.
Bram Moolenaar071d4272004-06-13 20:20:40 +000014
15Vim has a number of internal variables and switches which can be set to
16achieve special effects. These options come in three forms:
17 boolean can only be on or off *boolean* *toggle*
18 number has a numeric value
19 string has a string value
20
21==============================================================================
Bram Moolenaarf75a9632005-09-13 21:20:47 +0000221. Setting options *set-option* *E764*
Bram Moolenaar071d4272004-06-13 20:20:40 +000023
24 *:se* *:set*
Bram Moolenaar6b915c02020-01-18 15:53:19 +010025:se[t][!] Show all options that differ from their default value.
26 When [!] is present every option is on a separate
27 line.
Bram Moolenaar071d4272004-06-13 20:20:40 +000028
Bram Moolenaar6b915c02020-01-18 15:53:19 +010029:se[t][!] all Show all but terminal options.
30 When [!] is present every option is on a separate
31 line.
Bram Moolenaar071d4272004-06-13 20:20:40 +000032
33:se[t] termcap Show all terminal options. Note that in the GUI the
34 key codes are not shown, because they are generated
35 internally and can't be changed. Changing the terminal
36 codes in the GUI is not useful either...
37
Bram Moolenaar47003982021-12-05 21:54:04 +000038:se[t]! termcap Idem, but don't use multiple columns.
39
Bram Moolenaar071d4272004-06-13 20:20:40 +000040 *E518* *E519*
41:se[t] {option}? Show value of {option}.
42
43:se[t] {option} Toggle option: set, switch it on.
44 Number option: show value.
45 String option: show value.
46
47:se[t] no{option} Toggle option: Reset, switch it off.
48
Bram Moolenaar00a927d2010-05-14 23:24:24 +020049 *:set-!* *:set-inv*
Bram Moolenaar071d4272004-06-13 20:20:40 +000050:se[t] {option}! or
Bram Moolenaar6c60f472019-04-28 16:00:35 +020051:se[t] inv{option} Toggle option: Invert value.
Bram Moolenaar071d4272004-06-13 20:20:40 +000052
53 *:set-default* *:set-&* *:set-&vi* *:set-&vim*
54:se[t] {option}& Reset option to its default value. May depend on the
Bram Moolenaar6c60f472019-04-28 16:00:35 +020055 current value of 'compatible'.
56:se[t] {option}&vi Reset option to its Vi default value.
57:se[t] {option}&vim Reset option to its Vim default value.
Bram Moolenaar071d4272004-06-13 20:20:40 +000058
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +010059:se[t] all& Set all options to their default value. The values of
Bram Moolenaar88774fd2015-08-25 19:52:04 +020060 these options are not changed:
61 all terminal options, starting with t_
62 'columns'
63 'cryptmethod'
64 'encoding'
65 'key'
66 'lines'
67 'term'
68 'ttymouse'
69 'ttytype'
70 Warning: This may have a lot of side effects.
Bram Moolenaar071d4272004-06-13 20:20:40 +000071
72 *:set-args* *E487* *E521*
73:se[t] {option}={value} or
74:se[t] {option}:{value}
75 Set string or number option to {value}.
76 For numeric options the value can be given in decimal,
Bram Moolenaar3848e002016-03-19 18:42:29 +010077 hex (preceded with 0x) or octal (preceded with '0').
Bram Moolenaar071d4272004-06-13 20:20:40 +000078 The old value can be inserted by typing 'wildchar' (by
79 default this is a <Tab> or CTRL-E if 'compatible' is
80 set). See |cmdline-completion|.
81 White space between {option} and '=' is allowed and
82 will be ignored. White space between '=' and {value}
83 is not allowed.
84 See |option-backslash| for using white space and
85 backslashes in {value}.
86
87:se[t] {option}+={value} *:set+=*
88 Add the {value} to a number option, or append the
89 {value} to a string option. When the option is a
90 comma separated list, a comma is added, unless the
91 value was empty.
92 If the option is a list of flags, superfluous flags
Bram Moolenaara5792f52005-11-23 21:25:05 +000093 are removed. When adding a flag that was already
94 present the option value doesn't change.
Bram Moolenaar899dddf2006-03-26 21:06:50 +000095 Also see |:set-args| above.
Bram Moolenaar071d4272004-06-13 20:20:40 +000096
97:se[t] {option}^={value} *:set^=*
98 Multiply the {value} to a number option, or prepend
99 the {value} to a string option. When the option is a
100 comma separated list, a comma is added, unless the
101 value was empty.
102 Also see |:set-args| above.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000103
104:se[t] {option}-={value} *:set-=*
105 Subtract the {value} from a number option, or remove
106 the {value} from a string option, if it is there.
107 If the {value} is not found in a string option, there
108 is no error or warning. When the option is a comma
109 separated list, a comma is deleted, unless the option
110 becomes empty.
111 When the option is a list of flags, {value} must be
112 exactly as they appear in the option. Remove flags
113 one by one to avoid problems.
114 Also see |:set-args| above.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000115
116The {option} arguments to ":set" may be repeated. For example: >
117 :set ai nosi sw=3 ts=3
118If you make an error in one of the arguments, an error message will be given
119and the following arguments will be ignored.
120
121 *:set-verbose*
122When 'verbose' is non-zero, displaying an option value will also tell where it
123was last set. Example: >
124 :verbose set shiftwidth cindent?
Bram Moolenaar95bafa22018-10-02 13:26:25 +0200125< shiftwidth=4 ~
126 Last set from modeline line 1 ~
127 cindent ~
128 Last set from /usr/local/share/vim/vim60/ftplugin/c.vim line 30 ~
Bram Moolenaar446cb832008-06-24 21:56:24 +0000129This is only done when specific option values are requested, not for ":verbose
130set all" or ":verbose set" without an argument.
131When the option was set by hand there is no "Last set" message.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000132When the option was set while executing a function, user command or
133autocommand, the script in which it was defined is reported.
134Note that an option may also have been set as a side effect of setting
135'compatible'.
Bram Moolenaar446cb832008-06-24 21:56:24 +0000136A few special texts:
Bram Moolenaar95bafa22018-10-02 13:26:25 +0200137 Last set from modeline line 1 ~
Bram Moolenaar446cb832008-06-24 21:56:24 +0000138 Option was set in a |modeline|.
139 Last set from --cmd argument ~
140 Option was set with command line argument |--cmd| or +.
141 Last set from -c argument ~
142 Option was set with command line argument |-c|, +, |-S| or
143 |-q|.
144 Last set from environment variable ~
145 Option was set from an environment variable, $VIMINIT,
146 $GVIMINIT or $EXINIT.
147 Last set from error handler ~
148 Option was cleared when evaluating it resulted in an error.
149
Bram Moolenaardb84e452010-08-15 13:50:43 +0200150{not available when compiled without the |+eval| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000151
152 *:set-termcap* *E522*
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +0000153For {option} the form "t_xx" may be used to set a terminal option. This will
Bram Moolenaar071d4272004-06-13 20:20:40 +0000154override the value from the termcap. You can then use it in a mapping. If
155the "xx" part contains special characters, use the <t_xx> form: >
156 :set <t_#4>=^[Ot
157This can also be used to translate a special code for a normal key. For
158example, if Alt-b produces <Esc>b, use this: >
159 :set <M-b>=^[b
160(the ^[ is a real <Esc> here, use CTRL-V <Esc> to enter it)
161The advantage over a mapping is that it works in all situations.
162
Bram Moolenaar0b2f94d2011-03-22 14:35:05 +0100163You can define any key codes, e.g.: >
164 :set t_xy=^[foo;
165There is no warning for using a name that isn't recognized. You can map these
166codes as you like: >
167 :map <t_xy> something
168< *E846*
169When a key code is not set, it's like it does not exist. Trying to get its
170value will result in an error: >
171 :set t_kb=
172 :set t_kb
173 E846: Key code not set: t_kb
174
Bram Moolenaar293ee4d2004-12-09 21:34:53 +0000175The t_xx options cannot be set from a |modeline| or in the |sandbox|, for
176security reasons.
177
Bram Moolenaar071d4272004-06-13 20:20:40 +0000178The listing from ":set" looks different from Vi. Long string options are put
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000179at the end of the list. The number of options is quite large. The output of
Bram Moolenaar071d4272004-06-13 20:20:40 +0000180"set all" probably does not fit on the screen, causing Vim to give the
181|more-prompt|.
182
183 *option-backslash*
184To include white space in a string option value it has to be preceded with a
185backslash. To include a backslash you have to use two. Effectively this
186means that the number of backslashes in an option value is halved (rounded
187down).
188A few examples: >
189 :set tags=tags\ /usr/tags results in "tags /usr/tags"
190 :set tags=tags\\,file results in "tags\,file"
191 :set tags=tags\\\ file results in "tags\ file"
192
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000193The "|" character separates a ":set" command from a following command. To
194include the "|" in the option value, use "\|" instead. This example sets the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000195'titlestring' option to "hi|there": >
196 :set titlestring=hi\|there
197This sets the 'titlestring' option to "hi" and 'iconstring' to "there": >
198 :set titlestring=hi|set iconstring=there
199
Bram Moolenaar89a9c152021-08-29 21:55:35 +0200200Similarly, in legacy script the double quote character starts a comment. To
201include the '"' in the option value, use '\"' instead. This example sets the
202'titlestring' option to 'hi "there"': >
Bram Moolenaar7df351e2006-01-23 22:30:28 +0000203 :set titlestring=hi\ \"there\"
204
Bram Moolenaar89a9c152021-08-29 21:55:35 +0200205In |Vim9| script it's simpler, comments start with a '#' character, and only
206when preceded by white space. A backslash is needed less often: >
207 vim9script
208 set titlestring=hi\ "there"
209 set titlestring=hi#there#
210 set titlestring=hi\ \#there#
211
Bram Moolenaar5666fcd2019-12-26 14:35:26 +0100212For Win32 backslashes in file names are mostly not removed. More precise: For
213options that expect a file name (those where environment variables are
214expanded) a backslash before a normal file name character is not removed. But
215a backslash before a special character (space, backslash, comma, etc.) is used
216like explained above.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000217There is one special situation, when the value starts with "\\": >
218 :set dir=\\machine\path results in "\\machine\path"
219 :set dir=\\\\machine\\path results in "\\machine\path"
220 :set dir=\\path\\file results in "\\path\file" (wrong!)
221For the first one the start is kept, but for the second one the backslashes
222are halved. This makes sure it works both when you expect backslashes to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000223halved and when you expect the backslashes to be kept. The third gives a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000224result which is probably not what you want. Avoid it.
225
226 *add-option-flags* *remove-option-flags*
227 *E539* *E550* *E551* *E552*
228Some options are a list of flags. When you want to add a flag to such an
229option, without changing the existing ones, you can do it like this: >
230 :set guioptions+=a
231Remove a flag from an option like this: >
232 :set guioptions-=a
233This removes the 'a' flag from 'guioptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000234Note that you should add or remove one flag at a time. If 'guioptions' has
Bram Moolenaar071d4272004-06-13 20:20:40 +0000235the value "ab", using "set guioptions-=ba" won't work, because the string "ba"
236doesn't appear.
237
238 *:set_env* *expand-env* *expand-environment-var*
Bram Moolenaard4755bb2004-09-02 19:12:26 +0000239Environment variables in specific string options will be expanded. If the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000240environment variable exists the '$' and the following environment variable
241name is replaced with its value. If it does not exist the '$' and the name
242are not modified. Any non-id character (not a letter, digit or '_') may
243follow the environment variable name. That character and what follows is
244appended to the value of the environment variable. Examples: >
245 :set term=$TERM.new
246 :set path=/usr/$INCLUDE,$HOME/include,.
247When adding or removing a string from an option with ":set opt-=val" or ":set
248opt+=val" the expansion is done before the adding or removing.
249
250
251Handling of local options *local-options*
252
253Some of the options only apply to a window or buffer. Each window or buffer
Bram Moolenaar51628222016-12-01 23:03:28 +0100254has its own copy of this option, thus each can have its own value. This
Bram Moolenaar071d4272004-06-13 20:20:40 +0000255allows you to set 'list' in one window but not in another. And set
256'shiftwidth' to 3 in one buffer and 4 in another.
257
258The following explains what happens to these local options in specific
259situations. You don't really need to know all of this, since Vim mostly uses
260the option values you would expect. Unfortunately, doing what the user
261expects is a bit complicated...
262
263When splitting a window, the local options are copied to the new window. Thus
264right after the split the contents of the two windows look the same.
265
266When editing a new buffer, its local option values must be initialized. Since
267the local options of the current buffer might be specifically for that buffer,
268these are not used. Instead, for each buffer-local option there also is a
269global value, which is used for new buffers. With ":set" both the local and
270global value is changed. With "setlocal" only the local value is changed,
271thus this value is not used when editing a new buffer.
272
Bram Moolenaar95ec9d62016-08-12 18:29:59 +0200273When editing a buffer that has been edited before, the options from the window
274that was last closed are used again. If this buffer has been edited in this
275window, the values from back then are used. Otherwise the values from the
276last closed window where the buffer was edited last are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000277
278It's possible to set a local window option specifically for a type of buffer.
279When you edit another buffer in the same window, you don't want to keep
280using these local window options. Therefore Vim keeps a global value of the
281local window options, which is used when editing another buffer. Each window
282has its own copy of these values. Thus these are local to the window, but
283global to all buffers in the window. With this you can do: >
284 :e one
285 :set list
286 :e two
287Now the 'list' option will also be set in "two", since with the ":set list"
288command you have also set the global value. >
289 :set nolist
290 :e one
291 :setlocal list
292 :e two
293Now the 'list' option is not set, because ":set nolist" resets the global
294value, ":setlocal list" only changes the local value and ":e two" gets the
295global value. Note that if you do this next: >
296 :e one
Bram Moolenaar531da592013-05-06 05:58:55 +0200297You will get back the 'list' value as it was the last time you edited "one".
298The options local to a window are remembered for each buffer. This also
299happens when the buffer is not loaded, but they are lost when the buffer is
300wiped out |:bwipe|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000301
302 *:setl* *:setlocal*
Bram Moolenaar6b915c02020-01-18 15:53:19 +0100303:setl[ocal][!] ... Like ":set" but set only the value local to the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000304 current buffer or window. Not all options have a
305 local value. If the option does not have a local
306 value the global value is set.
Bram Moolenaarc3301872010-07-25 20:53:06 +0200307 With the "all" argument: display local values for all
308 local options.
309 Without argument: Display local values for all local
310 options which are different from the default.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000311 When displaying a specific local option, show the
Bram Moolenaar446cb832008-06-24 21:56:24 +0000312 local value. For a global/local boolean option, when
313 the global value is being used, "--" is displayed
314 before the option name.
315 For a global option the global value is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000316 shown (but that might change in the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000317
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000318:setl[ocal] {option}< Set the local value of {option} to its global value by
319 copying the value.
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000320
Bram Moolenaar6be7f872012-01-20 21:08:56 +0100321:se[t] {option}< For |global-local| options: Remove the local value of
322 {option}, so that the global value will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000323
324 *:setg* *:setglobal*
Bram Moolenaar6b915c02020-01-18 15:53:19 +0100325:setg[lobal][!] ... Like ":set" but set only the global value for a local
Bram Moolenaar071d4272004-06-13 20:20:40 +0000326 option without changing the local value.
327 When displaying an option, the global value is shown.
Bram Moolenaarc3301872010-07-25 20:53:06 +0200328 With the "all" argument: display global values for all
329 local options.
330 Without argument: display global values for all local
331 options which are different from the default.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000332
333For buffer-local and window-local options:
334 Command global value local value ~
335 :set option=value set set
336 :setlocal option=value - set
337:setglobal option=value set -
338 :set option? - display
339 :setlocal option? - display
340:setglobal option? display -
341
342
343Global options with a local value *global-local*
344
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +0000345Options are global when you mostly use one value for all buffers and windows.
346For some global options it's useful to sometimes have a different local value.
347You can set the local value with ":setlocal". That buffer or window will then
348use the local value, while other buffers and windows continue using the global
349value.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000350
351For example, you have two windows, both on C source code. They use the global
352'makeprg' option. If you do this in one of the two windows: >
353 :set makeprg=gmake
354then the other window will switch to the same value. There is no need to set
355the 'makeprg' option in the other C source window too.
356However, if you start editing a Perl file in a new window, you want to use
Bram Moolenaar02467872007-05-06 13:22:01 +0000357another 'makeprg' for it, without changing the value used for the C source
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000358files. You use this command: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000359 :setlocal makeprg=perlmake
360You can switch back to using the global value by making the local value empty: >
361 :setlocal makeprg=
Bram Moolenaar314dd792019-02-03 15:27:20 +0100362This only works for a string option. For a number or boolean option you need
363to use the "<" flag, like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000364 :setlocal autoread<
Bram Moolenaar314dd792019-02-03 15:27:20 +0100365Note that for non-boolean and non-number options using "<" copies the global
366value to the local value, it doesn't switch back to using the global value
367(that matters when the global value changes later). You can also use: >
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000368 :set path<
369This will make the local value of 'path' empty, so that the global value is
370used. Thus it does the same as: >
371 :setlocal path=
Bram 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()
1232<
Bram Moolenaar30b65812012-07-12 22:01:11 +02001233 The expression will be evaluated in the |sandbox| when set from a
1234 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02001235 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001236
1237 It is not allowed to change text or jump to another window while
Bram Moolenaar396e8292019-07-13 23:04:31 +02001238 evaluating 'balloonexpr', see |textlock|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001239
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001240 To check whether line breaks in the balloon text work use this check: >
Bram Moolenaar45360022005-07-21 21:08:21 +00001241 if has("balloon_multiline")
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001242< When they are supported "\n" characters will start a new line. If the
1243 expression evaluates to a |List| this is equal to using each List item
1244 as a string and putting "\n" in between them.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001245 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001246
Bram Moolenaar165bc692015-07-21 17:53:25 +02001247 *'belloff'* *'bo'*
1248'belloff' 'bo' string (default "")
1249 global
Bram Moolenaar165bc692015-07-21 17:53:25 +02001250 Specifies for which events the bell will not be rung. It is a comma
1251 separated list of items. For each item that is present, the bell
1252 will be silenced. This is most useful to specify specific events in
1253 insert mode to be silenced.
1254
1255 item meaning when present ~
1256 all All events.
1257 backspace When hitting <BS> or <Del> and deleting results in an
1258 error.
1259 cursor Fail to move around using the cursor keys or
1260 <PageUp>/<PageDown> in |Insert-mode|.
1261 complete Error occurred when using |i_CTRL-X_CTRL-K| or
1262 |i_CTRL-X_CTRL-T|.
1263 copy Cannot copy char from insert mode using |i_CTRL-Y| or
1264 |i_CTRL-E|.
1265 ctrlg Unknown Char after <C-G> in Insert mode.
1266 error Other Error occurred (e.g. try to join last line)
1267 (mostly used in |Normal-mode| or |Cmdline-mode|).
1268 esc hitting <Esc> in |Normal-mode|.
1269 ex In |Visual-mode|, hitting |Q| results in an error.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01001270 hangul Ignored.
Bram Moolenaar165bc692015-07-21 17:53:25 +02001271 insertmode Pressing <Esc> in 'insertmode'.
1272 lang Calling the beep module for Lua/Mzscheme/TCL.
1273 mess No output available for |g<|.
1274 showmatch Error occurred for 'showmatch' function.
1275 operator Empty region error |cpo-E|.
1276 register Unknown register after <C-R> in |Insert-mode|.
1277 shell Bell from shell output |:!|.
1278 spell Error happened on spell suggest.
1279 wildmode More matches in |cmdline-completion| available
1280 (depends on the 'wildmode' setting).
1281
Bram Moolenaar036986f2017-03-16 17:41:02 +01001282 This is most useful to fine tune when in Insert mode the bell should
1283 be rung. For Normal mode and Ex commands, the bell is often rung to
Bram Moolenaar165bc692015-07-21 17:53:25 +02001284 indicate that an error occurred. It can be silenced by adding the
1285 "error" keyword.
1286
Bram Moolenaar071d4272004-06-13 20:20:40 +00001287 *'binary'* *'bin'* *'nobinary'* *'nobin'*
1288'binary' 'bin' boolean (default off)
1289 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001290 This option should be set before editing a binary file. You can also
1291 use the |-b| Vim argument. When this option is switched on a few
1292 options will be changed (also when it already was on):
1293 'textwidth' will be set to 0
1294 'wrapmargin' will be set to 0
1295 'modeline' will be off
1296 'expandtab' will be off
1297 Also, 'fileformat' and 'fileformats' options will not be used, the
1298 file is read and written like 'fileformat' was "unix" (a single <NL>
1299 separates lines).
1300 The 'fileencoding' and 'fileencodings' options will not be used, the
1301 file is read without conversion.
1302 NOTE: When you start editing a(nother) file while the 'bin' option is
1303 on, settings from autocommands may change the settings again (e.g.,
1304 'textwidth'), causing trouble when editing. You might want to set
1305 'bin' again when the file has been loaded.
1306 The previous values of these options are remembered and restored when
1307 'bin' is switched from on to off. Each buffer has its own set of
1308 saved option values.
1309 To edit a file with 'binary' set you can use the |++bin| argument.
1310 This avoids you have to do ":set bin", which would have effect for all
1311 files you edit.
1312 When writing a file the <EOL> for the last line is only written if
1313 there was one in the original file (normally Vim appends an <EOL> to
1314 the last line if there is none; this would make the file longer). See
1315 the 'endofline' option.
1316
1317 *'bioskey'* *'biosk'* *'nobioskey'* *'nobiosk'*
1318'bioskey' 'biosk' boolean (default on)
1319 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02001320 {only for MS-DOS}
Bram Moolenaarf3913272016-02-25 00:00:01 +01001321 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001322
1323 *'bomb'* *'nobomb'*
1324'bomb' boolean (default off)
1325 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001326 When writing a file and the following conditions are met, a BOM (Byte
1327 Order Mark) is prepended to the file:
1328 - this option is on
1329 - the 'binary' option is off
1330 - 'fileencoding' is "utf-8", "ucs-2", "ucs-4" or one of the little/big
1331 endian variants.
1332 Some applications use the BOM to recognize the encoding of the file.
1333 Often used for UCS-2 files on MS-Windows. For other applications it
1334 causes trouble, for example: "cat file1 file2" makes the BOM of file2
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001335 appear halfway the resulting file. Gcc doesn't accept a BOM.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001336 When Vim reads a file and 'fileencodings' starts with "ucs-bom", a
1337 check for the presence of the BOM is done and 'bomb' set accordingly.
1338 Unless 'binary' is set, it is removed from the first line, so that you
1339 don't see it when editing. When you don't change the options, the BOM
1340 will be restored when writing the file.
1341
1342 *'breakat'* *'brk'*
1343'breakat' 'brk' string (default " ^I!@*-+;:,./?")
1344 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02001345 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001346 feature}
1347 This option lets you choose which characters might cause a line
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00001348 break if 'linebreak' is on. Only works for ASCII and also for 8-bit
1349 characters when 'encoding' is an 8-bit encoding.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001350
Bram Moolenaar7c1c6db2016-04-03 22:08:05 +02001351 *'breakindent'* *'bri'* *'nobreakindent'* *'nobri'*
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001352'breakindent' 'bri' boolean (default off)
1353 local to window
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001354 {not available when compiled without the |+linebreak|
1355 feature}
1356 Every wrapped line will continue visually indented (same amount of
1357 space as the beginning of that line), thus preserving horizontal blocks
1358 of text.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001359 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001360
1361 *'breakindentopt'* *'briopt'*
1362'breakindentopt' 'briopt' string (default empty)
1363 local to window
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001364 {not available when compiled without the |+linebreak|
1365 feature}
1366 Settings for 'breakindent'. It can consist of the following optional
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001367 items and must be separated by a comma:
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001368 min:{n} Minimum text width that will be kept after
1369 applying 'breakindent', even if the resulting
1370 text should normally be narrower. This prevents
1371 text indented almost to the right window border
1372 occupying lot of vertical space when broken.
Christian Brabandtc53b4672022-01-15 10:01:05 +00001373 (default: 20)
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001374 shift:{n} After applying 'breakindent', the wrapped line's
1375 beginning will be shifted by the given number of
1376 characters. It permits dynamic French paragraph
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001377 indentation (negative) or emphasizing the line
1378 continuation (positive).
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01001379 sbr Display the 'showbreak' value before applying the
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001380 additional indent.
Maxim Kimf674b352021-07-22 11:46:59 +02001381 list:{n} Adds an additional indent for lines that match a
Christian Brabandt4a0b85a2021-07-14 20:00:27 +02001382 numbered or bulleted list (using the
1383 'formatlistpat' setting).
Maxim Kimf674b352021-07-22 11:46:59 +02001384 list:-1 Uses the length of a match with 'formatlistpat'
1385 for indentation.
Christian Brabandt4a0b85a2021-07-14 20:00:27 +02001386 The default value for min is 20, shift and list is 0.
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001387
Bram Moolenaar071d4272004-06-13 20:20:40 +00001388 *'browsedir'* *'bsdir'*
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001389'browsedir' 'bsdir' string (default: "last")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001390 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02001391 {only for Motif, Athena, GTK, Mac and Win32 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001392 Which directory to use for the file browser:
Bram Moolenaar446cb832008-06-24 21:56:24 +00001393 last Use same directory as with last file browser, where a
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02001394 file was opened or saved.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001395 buffer Use the directory of the related buffer.
1396 current Use the current directory.
1397 {path} Use the specified directory
1398
1399 *'bufhidden'* *'bh'*
1400'bufhidden' 'bh' string (default: "")
1401 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001402 This option specifies what happens when a buffer is no longer
1403 displayed in a window:
1404 <empty> follow the global 'hidden' option
1405 hide hide the buffer (don't unload it), also when 'hidden'
1406 is not set
1407 unload unload the buffer, also when 'hidden' is set or using
1408 |:hide|
1409 delete delete the buffer from the buffer list, also when
1410 'hidden' is set or using |:hide|, like using
1411 |:bdelete|
1412 wipe wipe out the buffer from the buffer list, also when
1413 'hidden' is set or using |:hide|, like using
1414 |:bwipeout|
1415
Bram Moolenaara14de3d2005-01-07 21:48:26 +00001416 CAREFUL: when "unload", "delete" or "wipe" is used changes in a buffer
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01001417 are lost without a warning. Also, these values may break autocommands
1418 that switch between buffers temporarily.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001419 This option is used together with 'buftype' and 'swapfile' to specify
1420 special kinds of buffers. See |special-buffers|.
1421
1422 *'buflisted'* *'bl'* *'nobuflisted'* *'nobl'* *E85*
1423'buflisted' 'bl' boolean (default: on)
1424 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001425 When this option is set, the buffer shows up in the buffer list. If
1426 it is reset it is not used for ":bnext", "ls", the Buffers menu, etc.
1427 This option is reset by Vim for buffers that are only used to remember
1428 a file name or marks. Vim sets it when starting to edit a buffer.
1429 But not when moving to a buffer with ":buffer".
1430
1431 *'buftype'* *'bt'* *E382*
1432'buftype' 'bt' string (default: "")
1433 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001434 The value of this option specifies the type of a buffer:
1435 <empty> normal buffer
1436 nofile buffer which is not related to a file and will not be
1437 written
1438 nowrite buffer which will not be written
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001439 acwrite buffer which will always be written with BufWriteCmd
Bram Moolenaarb5b75622018-03-09 22:22:21 +01001440 autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001441 quickfix quickfix buffer, contains list of errors |:cwindow|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001442 or list of locations |:lwindow|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001443 help help buffer (you are not supposed to set this
1444 manually)
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02001445 terminal buffer for a |terminal| (you are not supposed to set
1446 this manually)
Bram Moolenaarf2732452018-06-03 14:47:35 +02001447 prompt buffer where only the last line can be edited, meant
1448 to be used by a plugin, see |prompt-buffer|
1449 {only when compiled with the |+channel| feature}
Bram Moolenaar4d784b22019-05-25 19:51:39 +02001450 popup buffer used in a popup window, see |popup|.
1451 {only when compiled with the |+textprop| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001452
1453 This option is used together with 'bufhidden' and 'swapfile' to
1454 specify special kinds of buffers. See |special-buffers|.
Bram Moolenaarebdf3c92020-02-15 21:41:42 +01001455 Also see |win_gettype()|, which returns the type of the window.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001456
1457 Be careful with changing this option, it can have many side effects!
Bram Moolenaar113cb512021-11-07 20:27:04 +00001458 One such effect is that Vim will not check the timestamp of the file,
1459 if the file is changed by another program this will not be noticed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001460
Bram Moolenaar280f1262006-01-30 00:14:18 +00001461 A "quickfix" buffer is only used for the error list and the location
1462 list. This value is set by the |:cwindow| and |:lwindow| commands and
1463 you are not supposed to change it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001464
1465 "nofile" and "nowrite" buffers are similar:
1466 both: The buffer is not to be written to disk, ":w" doesn't
1467 work (":w filename" does work though).
1468 both: The buffer is never considered to be |'modified'|.
1469 There is no warning when the changes will be lost, for
1470 example when you quit Vim.
1471 both: A swap file is only created when using too much memory
1472 (when 'swapfile' has been reset there is never a swap
1473 file).
1474 nofile only: The buffer name is fixed, it is not handled like a
1475 file name. It is not modified in response to a |:cd|
1476 command.
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01001477 both: When using ":e bufname" and already editing "bufname"
1478 the buffer is made empty and autocommands are
1479 triggered as usual for |:edit|.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001480 *E676*
1481 "acwrite" implies that the buffer name is not related to a file, like
1482 "nofile", but it will be written. Thus, in contrast to "nofile" and
1483 "nowrite", ":w" does work and a modified buffer can't be abandoned
1484 without saving. For writing there must be matching |BufWriteCmd|,
1485 |FileWriteCmd| or |FileAppendCmd| autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001486
1487 *'casemap'* *'cmp'*
1488'casemap' 'cmp' string (default: "internal,keepascii")
1489 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001490 Specifies details about changing the case of letters. It may contain
1491 these words, separated by a comma:
1492 internal Use internal case mapping functions, the current
1493 locale does not change the case mapping. This only
Bram Moolenaar6f16eb82005-08-23 21:02:42 +00001494 matters when 'encoding' is a Unicode encoding,
1495 "latin1" or "iso-8859-15". When "internal" is
1496 omitted, the towupper() and towlower() system library
1497 functions are used when available.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001498 keepascii For the ASCII characters (0x00 to 0x7f) use the US
1499 case mapping, the current locale is not effective.
1500 This probably only matters for Turkish.
1501
Bram Moolenaar7b1463b2021-12-11 17:24:39 +00001502 *'cdhome'* *'cdh'*
1503'cdhome' 'cdh' boolean (default: off)
1504 global
1505 When on, |:cd|, |:tcd| and |:lcd| without an argument changes the
1506 current working directory to the |$HOME| directory like in Unix.
1507 When off, those commands just print the current directory name.
1508 On Unix this option has no effect.
1509 NOTE: This option is reset when 'compatible' is set.
1510
Bram Moolenaar071d4272004-06-13 20:20:40 +00001511 *'cdpath'* *'cd'* *E344* *E346*
1512'cdpath' 'cd' string (default: equivalent to $CDPATH or ",,")
1513 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001514 {not available when compiled without the
1515 |+file_in_path| feature}
1516 This is a list of directories which will be searched when using the
Bram Moolenaar00aa0692019-04-27 20:37:57 +02001517 |:cd|, |:tcd| and |:lcd| commands, provided that the directory being
1518 searched for has a relative path, not an absolute part starting with
1519 "/", "./" or "../", the 'cdpath' option is not used then.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001520 The 'cdpath' option's value has the same form and semantics as
1521 |'path'|. Also see |file-searching|.
1522 The default value is taken from $CDPATH, with a "," prepended to look
1523 in the current directory first.
1524 If the default value taken from $CDPATH is not what you want, include
1525 a modified version of the following command in your vimrc file to
1526 override it: >
1527 :let &cdpath = ',' . substitute(substitute($CDPATH, '[, ]', '\\\0', 'g'), ':', ',', 'g')
1528< This option cannot be set from a |modeline| or in the |sandbox|, for
1529 security reasons.
1530 (parts of 'cdpath' can be passed to the shell to expand file names).
1531
1532 *'cedit'*
1533'cedit' string (Vi default: "", Vim default: CTRL-F)
1534 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001535 The key used in Command-line Mode to open the command-line window.
1536 The default is CTRL-F when 'compatible' is off.
1537 Only non-printable keys are allowed.
1538 The key can be specified as a single character, but it is difficult to
1539 type. The preferred way is to use the <> notation. Examples: >
Bram Moolenaare18dbe82016-07-02 21:42:23 +02001540 :exe "set cedit=\<C-Y>"
1541 :exe "set cedit=\<Esc>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001542< |Nvi| also has this option, but it only uses the first character.
1543 See |cmdwin|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001544 NOTE: This option is set to the Vim default value when 'compatible'
1545 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001546
1547 *'charconvert'* *'ccv'* *E202* *E214* *E513*
1548'charconvert' 'ccv' string (default "")
1549 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01001550 {only available when compiled with the |+eval| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001551 An expression that is used for character encoding conversion. It is
1552 evaluated when a file that is to be read or has been written has a
1553 different encoding from what is desired.
1554 'charconvert' is not used when the internal iconv() function is
1555 supported and is able to do the conversion. Using iconv() is
1556 preferred, because it is much faster.
1557 'charconvert' is not used when reading stdin |--|, because there is no
1558 file to convert from. You will have to save the text in a file first.
1559 The expression must return zero or an empty string for success,
1560 non-zero for failure.
1561 The possible encoding names encountered are in 'encoding'.
1562 Additionally, names given in 'fileencodings' and 'fileencoding' are
1563 used.
1564 Conversion between "latin1", "unicode", "ucs-2", "ucs-4" and "utf-8"
1565 is done internally by Vim, 'charconvert' is not used for this.
1566 'charconvert' is also used to convert the viminfo file, if the 'c'
1567 flag is present in 'viminfo'. Also used for Unicode conversion.
1568 Example: >
1569 set charconvert=CharConvert()
1570 fun CharConvert()
1571 system("recode "
1572 \ . v:charconvert_from . ".." . v:charconvert_to
1573 \ . " <" . v:fname_in . " >" v:fname_out)
1574 return v:shell_error
1575 endfun
1576< The related Vim variables are:
1577 v:charconvert_from name of the current encoding
1578 v:charconvert_to name of the desired encoding
1579 v:fname_in name of the input file
1580 v:fname_out name of the output file
1581 Note that v:fname_in and v:fname_out will never be the same.
1582 Note that v:charconvert_from and v:charconvert_to may be different
1583 from 'encoding'. Vim internally uses UTF-8 instead of UCS-2 or UCS-4.
1584 Encryption is not done by Vim when using 'charconvert'. If you want
1585 to encrypt the file after conversion, 'charconvert' should take care
1586 of this.
1587 This option cannot be set from a |modeline| or in the |sandbox|, for
1588 security reasons.
1589
1590 *'cindent'* *'cin'* *'nocindent'* *'nocin'*
1591'cindent' 'cin' boolean (default off)
1592 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001593 {not available when compiled without the |+cindent|
1594 feature}
Bram Moolenaar446cb832008-06-24 21:56:24 +00001595 Enables automatic C program indenting. See 'cinkeys' to set the keys
Bram Moolenaar071d4272004-06-13 20:20:40 +00001596 that trigger reindenting in insert mode and 'cinoptions' to set your
1597 preferred indent style.
1598 If 'indentexpr' is not empty, it overrules 'cindent'.
1599 If 'lisp' is not on and both 'indentexpr' and 'equalprg' are empty,
1600 the "=" operator indents using this algorithm rather than calling an
1601 external program.
1602 See |C-indenting|.
1603 When you don't like the way 'cindent' works, try the 'smartindent'
1604 option or 'indentexpr'.
1605 This option is not used when 'paste' is set.
1606 NOTE: This option is reset when 'compatible' is set.
1607
1608 *'cinkeys'* *'cink'*
Bram Moolenaarce655742019-01-31 14:12:57 +01001609'cinkeys' 'cink' string (default "0{,0},0),0],:,0#,!^F,o,O,e")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001610 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001611 {not available when compiled without the |+cindent|
1612 feature}
1613 A list of keys that, when typed in Insert mode, cause reindenting of
1614 the current line. Only used if 'cindent' is on and 'indentexpr' is
1615 empty.
1616 For the format of this option see |cinkeys-format|.
1617 See |C-indenting|.
1618
1619 *'cinoptions'* *'cino'*
1620'cinoptions' 'cino' string (default "")
1621 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001622 {not available when compiled without the |+cindent|
1623 feature}
1624 The 'cinoptions' affect the way 'cindent' reindents lines in a C
1625 program. See |cinoptions-values| for the values of this option, and
1626 |C-indenting| for info on C indenting in general.
1627
1628
1629 *'cinwords'* *'cinw'*
1630'cinwords' 'cinw' string (default "if,else,while,do,for,switch")
1631 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001632 {not available when compiled without both the
1633 |+cindent| and the |+smartindent| features}
1634 These keywords start an extra indent in the next line when
1635 'smartindent' or 'cindent' is set. For 'cindent' this is only done at
1636 an appropriate place (inside {}).
1637 Note that 'ignorecase' isn't used for 'cinwords'. If case doesn't
1638 matter, include the keyword both the uppercase and lowercase:
1639 "if,If,IF".
1640
1641 *'clipboard'* *'cb'*
1642'clipboard' 'cb' string (default "autoselect,exclude:cons\|linux"
1643 for X-windows, "" otherwise)
1644 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001645 {only in GUI versions or when the |+xterm_clipboard|
1646 feature is included}
1647 This option is a list of comma separated names.
Bram Moolenaar942db232021-02-13 18:14:48 +01001648 Note: if one of the items is "exclude:", then you can't add an item
1649 after that. Therefore do append an item with += but use ^= to
1650 prepend, e.g.: >
1651 set clipboard^=unnamed
1652< These names are recognized:
Bram Moolenaar071d4272004-06-13 20:20:40 +00001653
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001654 *clipboard-unnamed*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001655 unnamed When included, Vim will use the clipboard register '*'
1656 for all yank, delete, change and put operations which
1657 would normally go to the unnamed register. When a
1658 register is explicitly specified, it will always be
1659 used regardless of whether "unnamed" is in 'clipboard'
1660 or not. The clipboard register can always be
1661 explicitly accessed using the "* notation. Also see
1662 |gui-clipboard|.
1663
Bram Moolenaar30b65812012-07-12 22:01:11 +02001664 *clipboard-unnamedplus*
Bram Moolenaar00154502013-02-13 16:15:55 +01001665 unnamedplus A variant of the "unnamed" flag which uses the
1666 clipboard register '+' (|quoteplus|) instead of
1667 register '*' for all yank, delete, change and put
1668 operations which would normally go to the unnamed
1669 register. When "unnamed" is also included to the
1670 option, yank operations (but not delete, change or
1671 put) will additionally copy the text into register
1672 '*'.
Bram Moolenaar81af9252010-12-10 20:35:50 +01001673 Only available with the |+X11| feature.
Bram Moolenaarbf9680e2010-12-02 21:43:16 +01001674 Availability can be checked with: >
1675 if has('unnamedplus')
1676<
Bram Moolenaar30b65812012-07-12 22:01:11 +02001677 *clipboard-autoselect*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001678 autoselect Works like the 'a' flag in 'guioptions': If present,
1679 then whenever Visual mode is started, or the Visual
1680 area extended, Vim tries to become the owner of the
1681 windowing system's global selection or put the
1682 selected text on the clipboard used by the selection
Bram Moolenaarba3ff532018-11-04 14:45:49 +01001683 register "*. See |'go-a'| and |quotestar| for details.
1684 When the GUI is active, the 'a' flag in 'guioptions'
1685 is used, when the GUI is not active, this "autoselect"
1686 flag is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001687 Also applies to the modeless selection.
1688
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001689 *clipboard-autoselectplus*
1690 autoselectplus Like "autoselect" but using the + register instead of
1691 the * register. Compare to the 'P' flag in
1692 'guioptions'.
1693
1694 *clipboard-autoselectml*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001695 autoselectml Like "autoselect", but for the modeless selection
1696 only. Compare to the 'A' flag in 'guioptions'.
1697
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001698 *clipboard-html*
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001699 html When the clipboard contains HTML, use this when
1700 pasting. When putting text on the clipboard, mark it
1701 as HTML. This works to copy rendered HTML from
1702 Firefox, paste it as raw HTML in Vim, select the HTML
1703 in Vim and paste it in a rich edit box in Firefox.
Bram Moolenaar20a825a2010-05-31 21:27:30 +02001704 You probably want to add this only temporarily,
1705 possibly use BufEnter autocommands.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001706 Only supported for GTK version 2 and later.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001707
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001708 *clipboard-exclude*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001709 exclude:{pattern}
1710 Defines a pattern that is matched against the name of
1711 the terminal 'term'. If there is a match, no
1712 connection will be made to the X server. This is
1713 useful in this situation:
1714 - Running Vim in a console.
1715 - $DISPLAY is set to start applications on another
1716 display.
1717 - You do not want to connect to the X server in the
1718 console, but do want this in a terminal emulator.
1719 To never connect to the X server use: >
1720 exclude:.*
1721< This has the same effect as using the |-X| argument.
1722 Note that when there is no connection to the X server
1723 the window title won't be restored and the clipboard
1724 cannot be accessed.
1725 The value of 'magic' is ignored, {pattern} is
1726 interpreted as if 'magic' was on.
1727 The rest of the option value will be used for
1728 {pattern}, this must be the last entry.
1729
1730 *'cmdheight'* *'ch'*
1731'cmdheight' 'ch' number (default 1)
1732 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001733 Number of screen lines to use for the command-line. Helps avoiding
1734 |hit-enter| prompts.
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00001735 The value of this option is stored with the tab page, so that each tab
1736 page can have a different value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001737
1738 *'cmdwinheight'* *'cwh'*
1739'cmdwinheight' 'cwh' number (default 7)
1740 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001741 Number of screen lines to use for the command-line window. |cmdwin|
1742
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001743 *'colorcolumn'* *'cc'*
1744'colorcolumn' 'cc' string (default "")
1745 local to window
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001746 {not available when compiled without the |+syntax|
1747 feature}
1748 'colorcolumn' is a comma separated list of screen columns that are
1749 highlighted with ColorColumn |hl-ColorColumn|. Useful to align
1750 text. Will make screen redrawing slower.
1751 The screen column can be an absolute number, or a number preceded with
1752 '+' or '-', which is added to or subtracted from 'textwidth'. >
1753
1754 :set cc=+1 " highlight column after 'textwidth'
1755 :set cc=+1,+2,+3 " highlight three columns after 'textwidth'
1756 :hi ColorColumn ctermbg=lightgrey guibg=lightgrey
1757<
1758 When 'textwidth' is zero then the items with '-' and '+' are not used.
1759 A maximum of 256 columns are highlighted.
1760
Bram Moolenaar071d4272004-06-13 20:20:40 +00001761 *'columns'* *'co'* *E594*
1762'columns' 'co' number (default 80 or terminal width)
1763 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001764 Number of columns of the screen. Normally this is set by the terminal
Bram Moolenaar7c626922005-02-07 22:01:03 +00001765 initialization and does not have to be set by hand. Also see
1766 |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001767 When Vim is running in the GUI or in a resizable window, setting this
1768 option will cause the window size to be changed. When you only want
1769 to use the size for the GUI, put the command in your |gvimrc| file.
1770 When you set this option and Vim is unable to change the physical
Bram Moolenaar02467872007-05-06 13:22:01 +00001771 number of columns of the display, the display may be messed up. For
1772 the GUI it is always possible and Vim limits the number of columns to
1773 what fits on the screen. You can use this command to get the widest
1774 window possible: >
1775 :set columns=9999
1776< Minimum value is 12, maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001777
1778 *'comments'* *'com'* *E524* *E525*
1779'comments' 'com' string (default
1780 "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-")
1781 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001782 A comma separated list of strings that can start a comment line. See
1783 |format-comments|. See |option-backslash| about using backslashes to
1784 insert a space.
1785
1786 *'commentstring'* *'cms'* *E537*
1787'commentstring' 'cms' string (default "/*%s*/")
1788 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001789 {not available when compiled without the |+folding|
1790 feature}
1791 A template for a comment. The "%s" in the value is replaced with the
1792 comment text. Currently only used to add markers for folding, see
1793 |fold-marker|.
1794
1795 *'compatible'* *'cp'* *'nocompatible'* *'nocp'*
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001796'compatible' 'cp' boolean (default on, off when a |vimrc| or |gvimrc|
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02001797 file is found, reset in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001798 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001799 This option has the effect of making Vim either more Vi-compatible, or
1800 make Vim behave in a more useful way.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001801
Bram Moolenaar071d4272004-06-13 20:20:40 +00001802 This is a special kind of option, because when it's set or reset,
Bram Moolenaar214641f2017-03-05 17:04:09 +01001803 other options are also changed as a side effect.
1804 NOTE: Setting or resetting this option can have a lot of unexpected
1805 effects: Mappings are interpreted in another way, undo behaves
1806 differently, etc. If you set this option in your vimrc file, you
1807 should probably put it at the very start.
1808
Bram Moolenaar071d4272004-06-13 20:20:40 +00001809 By default this option is on and the Vi defaults are used for the
1810 options. This default was chosen for those people who want to use Vim
1811 just like Vi, and don't even (want to) know about the 'compatible'
1812 option.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001813 When a |vimrc| or |gvimrc| file is found while Vim is starting up,
Bram Moolenaard042c562005-06-30 22:04:15 +00001814 this option is switched off, and all options that have not been
1815 modified will be set to the Vim defaults. Effectively, this means
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001816 that when a |vimrc| or |gvimrc| file exists, Vim will use the Vim
Bram Moolenaard042c562005-06-30 22:04:15 +00001817 defaults, otherwise it will use the Vi defaults. (Note: This doesn't
Bram Moolenaar02467872007-05-06 13:22:01 +00001818 happen for the system-wide vimrc or gvimrc file, nor for a file given
1819 with the |-u| argument). Also see |compatible-default| and
1820 |posix-compliance|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001821 You can also set this option with the "-C" argument, and reset it with
1822 "-N". See |-C| and |-N|.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001823 See 'cpoptions' for more fine tuning of Vi compatibility.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001824
Bram Moolenaar214641f2017-03-05 17:04:09 +01001825 When this option is set, numerous other options are set to make Vim as
1826 Vi-compatible as possible. When this option is unset, various options
1827 are set to make Vim more useful. The table below lists all the
1828 options affected.
1829 The {?} column indicates when the options are affected:
1830 + Means that the option is set to the value given in {set value} when
1831 'compatible' is set.
1832 & Means that the option is set to the value given in {set value} when
1833 'compatible' is set AND is set to its Vim default value when
1834 'compatible' is unset.
1835 - Means the option is NOT changed when setting 'compatible' but IS
1836 set to its Vim default when 'compatible' is unset.
1837 The {effect} column summarises the change when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001838
Bram Moolenaar036986f2017-03-16 17:41:02 +01001839 option ? set value effect ~
Bram Moolenaar214641f2017-03-05 17:04:09 +01001840
1841 'allowrevins' + off no CTRL-_ command
1842 'antialias' + off don't use antialiased fonts
1843 'arabic' + off reset arabic-related options
1844 'arabicshape' + on correct character shapes
1845 'backspace' + "" normal backspace
1846 'backup' + off no backup file
1847 'backupcopy' & Unix: "yes" backup file is a copy
1848 else: "auto" copy or rename backup file
1849 'balloonexpr' + "" text to show in evaluation balloon
1850 'breakindent' + off don't indent when wrapping lines
1851 'cedit' - {unchanged} {set vim default only on resetting 'cp'}
Bram Moolenaar7b1463b2021-12-11 17:24:39 +00001852 'cdhome' + off ":cd" don't chdir to home on non-Unix
Bram Moolenaar214641f2017-03-05 17:04:09 +01001853 'cindent' + off no C code indentation
1854 'compatible' - {unchanged} {set vim default only on resetting 'cp'}
1855 'copyindent' + off don't copy indent structure
1856 'cpoptions' & (all flags) Vi-compatible flags
1857 'cscopepathcomp'+ 0 don't show directories in tags list
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01001858 'cscoperelative'+ off don't use basename of path as prefix
Bram Moolenaar214641f2017-03-05 17:04:09 +01001859 'cscopetag' + off don't use cscope for ":tag"
Bram Moolenaar036986f2017-03-16 17:41:02 +01001860 'cscopetagorder'+ 0 see |cscopetagorder|
Bram Moolenaar214641f2017-03-05 17:04:09 +01001861 'cscopeverbose' + off see |cscopeverbose|
1862 'delcombine' + off unicode: delete whole char combination
1863 'digraph' + off no digraphs
1864 'esckeys' & off no <Esc>-keys in Insert mode
1865 'expandtab' + off tabs not expanded to spaces
1866 'fileformats' & "" no automatic file format detection,
Bram Moolenaar6f345a12019-12-17 21:27:18 +01001867 "dos,unix" except for MS-Windows
Bram Moolenaar214641f2017-03-05 17:04:09 +01001868 'formatexpr' + "" use 'formatprg' for auto-formatting
1869 'formatoptions' & "vt" Vi compatible formatting
1870 'gdefault' + off no default 'g' flag for ":s"
1871 'history' & 0 no commandline history
1872 'hkmap' + off no Hebrew keyboard mapping
1873 'hkmapp' + off no phonetic Hebrew keyboard mapping
1874 'hlsearch' + off no highlighting of search matches
1875 'incsearch' + off no incremental searching
1876 'indentexpr' + "" no indenting by expression
1877 'insertmode' + off do not start in Insert mode
1878 'iskeyword' & "@,48-57,_" keywords contain alphanumeric
Bram Moolenaar071d4272004-06-13 20:20:40 +00001879 characters and '_'
Bram Moolenaar214641f2017-03-05 17:04:09 +01001880 'joinspaces' + on insert 2 spaces after period
1881 'modeline' & off no modelines
1882 'more' & off no pauses in listings
1883 'mzquantum' - {unchanged} {set vim default only on resetting 'cp'}
1884 'numberwidth' & 8 min number of columns for line number
1885 'preserveindent'+ off don't preserve current indent structure
1886 when changing it
1887 'revins' + off no reverse insert
1888 'ruler' + off no ruler
1889 'scrolljump' + 1 no jump scroll
1890 'scrolloff' + 0 no scroll offset
1891 'shelltemp' - {unchanged} {set vim default only on resetting 'cp'}
1892 'shiftround' + off indent not rounded to shiftwidth
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02001893 'shortmess' & "S" no shortening of messages
Bram Moolenaar214641f2017-03-05 17:04:09 +01001894 'showcmd' & off command characters not shown
1895 'showmode' & off current mode not shown
1896 'sidescrolloff' + 0 cursor moves to edge of screen in scroll
1897 'smartcase' + off no automatic ignore case switch
1898 'smartindent' + off no smart indentation
1899 'smarttab' + off no smart tab size
1900 'softtabstop' + 0 tabs are always 'tabstop' positions
1901 'startofline' + on goto startofline with some commands
1902 'tagcase' & "followic" 'ignorecase' when searching tags file
1903 'tagrelative' & off tag file names are not relative
1904 'termguicolors' + off don't use highlight-(guifg|guibg)
1905 'textauto' & off no automatic textmode detection
1906 'textwidth' + 0 no automatic line wrap
1907 'tildeop' + off tilde is not an operator
1908 'ttimeout' + off no terminal timeout
1909 'undofile' + off don't use an undo file
Bram Moolenaar036986f2017-03-16 17:41:02 +01001910 'viminfo' - {unchanged} {set Vim default only on resetting 'cp'}
Bram Moolenaar214641f2017-03-05 17:04:09 +01001911 'virtualedit' + "" cursor can only be placed on characters
1912 'whichwrap' & "" left-right movements don't wrap
1913 'wildchar' & CTRL-E only when the current value is <Tab>
Bram Moolenaar071d4272004-06-13 20:20:40 +00001914 use CTRL-E for cmdline completion
Bram Moolenaar214641f2017-03-05 17:04:09 +01001915 'writebackup' + on or off depends on the |+writebackup| feature
Bram Moolenaar071d4272004-06-13 20:20:40 +00001916
1917 *'complete'* *'cpt'* *E535*
1918'complete' 'cpt' string (default: ".,w,b,u,t,i")
1919 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001920 This option specifies how keyword completion |ins-completion| works
1921 when CTRL-P or CTRL-N are used. It is also used for whole-line
1922 completion |i_CTRL-X_CTRL-L|. It indicates the type of completion
1923 and the places to scan. It is a comma separated list of flags:
Bram Moolenaar3848e002016-03-19 18:42:29 +01001924 . scan the current buffer ('wrapscan' is ignored)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001925 w scan buffers from other windows
1926 b scan other loaded buffers that are in the buffer list
1927 u scan the unloaded buffers that are in the buffer list
1928 U scan the buffers that are not in the buffer list
1929 k scan the files given with the 'dictionary' option
Bram Moolenaar0b238792006-03-02 22:49:12 +00001930 kspell use the currently active spell checking |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001931 k{dict} scan the file {dict}. Several "k" flags can be given,
1932 patterns are valid too. For example: >
1933 :set cpt=k/usr/dict/*,k~/spanish
1934< s scan the files given with the 'thesaurus' option
1935 s{tsr} scan the file {tsr}. Several "s" flags can be given, patterns
1936 are valid too.
1937 i scan current and included files
1938 d scan current and included files for defined name or macro
1939 |i_CTRL-X_CTRL-D|
1940 ] tag completion
1941 t same as "]"
1942
1943 Unloaded buffers are not loaded, thus their autocmds |:autocmd| are
1944 not executed, this may lead to unexpected completions from some files
1945 (gzipped files for example). Unloaded buffers are not scanned for
1946 whole-line completion.
1947
1948 The default is ".,w,b,u,t,i", which means to scan:
1949 1. the current buffer
1950 2. buffers in other windows
1951 3. other loaded buffers
1952 4. unloaded buffers
1953 5. tags
1954 6. included files
1955
1956 As you can see, CTRL-N and CTRL-P can be used to do any 'iskeyword'-
Bram Moolenaar582fd852005-03-28 20:58:01 +00001957 based expansion (e.g., dictionary |i_CTRL-X_CTRL-K|, included patterns
1958 |i_CTRL-X_CTRL-I|, tags |i_CTRL-X_CTRL-]| and normal expansions).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001959
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001960 *'completefunc'* *'cfu'*
1961'completefunc' 'cfu' string (default: empty)
1962 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02001963 {not available when compiled without the |+eval|
Bram Moolenaare2c453d2019-08-21 14:37:09 +02001964 feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00001965 This option specifies a function to be used for Insert mode completion
1966 with CTRL-X CTRL-U. |i_CTRL-X_CTRL-U|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001967 See |complete-functions| for an explanation of how the function is
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00001968 invoked and what it should return. The value can be the name of a
1969 function, a |lambda| or a |Funcref|. See |option-value-function| for
1970 more information.
Bram Moolenaar166af9b2010-11-16 20:34:40 +01001971 This option cannot be set from a |modeline| or in the |sandbox|, for
1972 security reasons.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00001973
Bram Moolenaarac3150d2019-07-28 16:36:39 +02001974 *'completeslash'* *'csl'*
1975'completeslash' 'csl' string (default: "")
1976 local to buffer
Bram Moolenaar2e693a82019-10-16 22:35:02 +02001977 {only for MS-Windows}
Bram Moolenaarac3150d2019-07-28 16:36:39 +02001978 When this option is set it overrules 'shellslash' for completion:
1979 - When this option is set to "slash", a forward slash is used for path
1980 completion in insert mode. This is useful when editing HTML tag, or
Bram Moolenaar6f345a12019-12-17 21:27:18 +01001981 Makefile with 'noshellslash' on MS-Windows.
Bram Moolenaarac3150d2019-07-28 16:36:39 +02001982 - When this option is set to "backslash", backslash is used. This is
Bram Moolenaar6f345a12019-12-17 21:27:18 +01001983 useful when editing a batch file with 'shellslash' set on MS-Windows.
Bram Moolenaarac3150d2019-07-28 16:36:39 +02001984 - When this option is empty, same character is used as for
1985 'shellslash'.
1986 For Insert mode completion the buffer-local value is used. For
1987 command line completion the global value is used.
1988
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001989 *'completeopt'* *'cot'*
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001990'completeopt' 'cot' string (default: "menu,preview")
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001991 global
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001992 A comma separated list of options for Insert mode completion
1993 |ins-completion|. The supported values are:
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001994
1995 menu Use a popup menu to show the possible completions. The
1996 menu is only shown when there is more than one match and
1997 sufficient colors are available. |ins-completion-menu|
1998
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001999 menuone Use the popup menu also when there is only one match.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002000 Useful when there is additional information about the
Bram Moolenaar65c923a2006-03-03 22:56:30 +00002001 match, e.g., what file it comes from.
2002
Bram Moolenaarc1e37902006-04-18 21:55:01 +00002003 longest Only insert the longest common text of the matches. If
2004 the menu is displayed you can use CTRL-L to add more
2005 characters. Whether case is ignored depends on the kind
2006 of completion. For buffer text the 'ignorecase' option is
2007 used.
Bram Moolenaarc7453f52006-02-10 23:20:28 +00002008
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00002009 preview Show extra information about the currently selected
Bram Moolenaar02467872007-05-06 13:22:01 +00002010 completion in the preview window. Only works in
2011 combination with "menu" or "menuone".
2012
Bram Moolenaar576a4a62019-08-18 15:25:17 +02002013 popup Show extra information about the currently selected
2014 completion in a popup window. Only works in combination
2015 with "menu" or "menuone". Overrides "preview".
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002016 See |'completepopup'| for specifying properties.
Bram Moolenaar2e693a82019-10-16 22:35:02 +02002017 {only works when compiled with the |+textprop| feature}
Bram Moolenaar576a4a62019-08-18 15:25:17 +02002018
Bram Moolenaardca7abe2019-10-20 18:17:57 +02002019 popuphidden
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01002020 Just like "popup" but initially hide the popup. Use a
Bram Moolenaardca7abe2019-10-20 18:17:57 +02002021 |CompleteChanged| autocommand to fetch the info and call
2022 |popup_show()| once the popup has been filled.
2023 See the example at |complete-popuphidden|.
2024 {only works when compiled with the |+textprop| feature}
2025
Bram Moolenaarb6be1e22015-07-10 18:18:40 +02002026 noinsert Do not insert any text for a match until the user selects
2027 a match from the menu. Only works in combination with
2028 "menu" or "menuone". No effect if "longest" is present.
2029
2030 noselect Do not select a match in the menu, force the user to
2031 select one from the menu. Only works in combination with
2032 "menu" or "menuone".
2033
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00002034
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002035 *'completepopup'* *'cpp'*
2036'completepopup' 'cpp' string (default empty)
2037 global
2038 {not available when compiled without the |+textprop|
2039 or |+quickfix| feature}
2040 When 'completeopt' contains "popup" then this option is used for the
Bram Moolenaar447bfba2020-07-18 16:07:16 +02002041 properties of the info popup when it is created. If an info popup
2042 window already exists it is closed, so that the option value is
2043 applied when it is created again.
2044 You can also use |popup_findinfo()| and then set properties for an
2045 existing info popup with |popup_setoptions()|. See |complete-popup|.
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002046
2047
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002048 *'concealcursor'* *'cocu'*
2049'concealcursor' 'cocu' string (default: "")
2050 local to window
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002051 {not available when compiled without the |+conceal|
2052 feature}
2053 Sets the modes in which text in the cursor line can also be concealed.
2054 When the current mode is listed then concealing happens just like in
2055 other lines.
2056 n Normal mode
2057 v Visual mode
2058 i Insert mode
Bram Moolenaarca8c9862010-07-24 15:00:38 +02002059 c Command line editing, for 'incsearch'
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002060
Bram Moolenaare6dc5732010-07-24 23:52:26 +02002061 'v' applies to all lines in the Visual area, not only the cursor.
Bram Moolenaarca8c9862010-07-24 15:00:38 +02002062 A useful value is "nc". This is used in help files. So long as you
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002063 are moving around text is concealed, but when starting to insert text
2064 or selecting a Visual area the concealed text is displayed, so that
2065 you can see what you are doing.
Bram Moolenaarf70e3d62010-07-24 13:15:07 +02002066 Keep in mind that the cursor position is not always where it's
2067 displayed. E.g., when moving vertically it may change column.
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002068
2069
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002070 *'conceallevel'* *'cole'*
2071'conceallevel' 'cole' number (default 0)
Bram Moolenaar860cae12010-06-05 23:22:07 +02002072 local to window
Bram Moolenaar860cae12010-06-05 23:22:07 +02002073 {not available when compiled without the |+conceal|
2074 feature}
Bram Moolenaar6df6f472010-07-18 18:04:50 +02002075 Determine how text with the "conceal" syntax attribute |:syn-conceal|
2076 is shown:
Bram Moolenaar860cae12010-06-05 23:22:07 +02002077
Bram Moolenaar6df6f472010-07-18 18:04:50 +02002078 Value Effect ~
Bram Moolenaar860cae12010-06-05 23:22:07 +02002079 0 Text is shown normally
Bram Moolenaar477db062010-07-28 18:17:41 +02002080 1 Each block of concealed text is replaced with one
2081 character. If the syntax item does not have a custom
2082 replacement character defined (see |:syn-cchar|) the
2083 character defined in 'listchars' is used (default is a
2084 space).
2085 It is highlighted with the "Conceal" highlight group.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002086 2 Concealed text is completely hidden unless it has a
2087 custom replacement character defined (see
Bram Moolenaar477db062010-07-28 18:17:41 +02002088 |:syn-cchar|).
Bram Moolenaara7781e02010-07-19 20:13:22 +02002089 3 Concealed text is completely hidden.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002090
Bram Moolenaara7781e02010-07-19 20:13:22 +02002091 Note: in the cursor line concealed text is not hidden, so that you can
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002092 edit and copy the text. This can be changed with the 'concealcursor'
2093 option.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002094
Bram Moolenaar071d4272004-06-13 20:20:40 +00002095 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
2096'confirm' 'cf' boolean (default off)
2097 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002098 When 'confirm' is on, certain operations that would normally
2099 fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
2100 instead raise a |dialog| asking if you wish to save the current
2101 file(s). You can still use a ! to unconditionally |abandon| a buffer.
2102 If 'confirm' is off you can still activate confirmation for one
2103 command only (this is most useful in mappings) with the |:confirm|
2104 command.
2105 Also see the |confirm()| function and the 'v' flag in 'guioptions'.
2106
2107 *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
2108'conskey' 'consk' boolean (default off)
2109 global
Bram Moolenaarf3913272016-02-25 00:00:01 +01002110 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002111
2112 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
2113'copyindent' 'ci' boolean (default off)
2114 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002115 Copy the structure of the existing lines indent when autoindenting a
2116 new line. Normally the new indent is reconstructed by a series of
2117 tabs followed by spaces as required (unless |'expandtab'| is enabled,
2118 in which case only spaces are used). Enabling this option makes the
2119 new line copy whatever characters were used for indenting on the
Bram Moolenaar446cb832008-06-24 21:56:24 +00002120 existing line. 'expandtab' has no effect on these characters, a Tab
2121 remains a Tab. If the new indent is greater than on the existing
Bram Moolenaar071d4272004-06-13 20:20:40 +00002122 line, the remaining space is filled in the normal manner.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002123 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002124 Also see 'preserveindent'.
2125
Bram Moolenaare0fa3742016-02-20 15:47:01 +01002126 *'cpoptions'* *'cpo'* *cpo*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002127'cpoptions' 'cpo' string (Vim default: "aABceFs",
2128 Vi default: all flags)
2129 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002130 A sequence of single character flags. When a character is present
Bram Moolenaar7cba6c02013-09-05 22:13:31 +02002131 this indicates Vi-compatible behavior. This is used for things where
2132 not being Vi-compatible is mostly or sometimes preferred.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002133 'cpoptions' stands for "compatible-options".
2134 Commas can be added for readability.
2135 To avoid problems with flags that are added in the future, use the
2136 "+=" and "-=" feature of ":set" |add-option-flags|.
Bram Moolenaar71eb3ad2021-12-26 12:07:30 +00002137
Bram Moolenaar071d4272004-06-13 20:20:40 +00002138 NOTE: This option is set to the Vi default value when 'compatible' is
2139 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar71eb3ad2021-12-26 12:07:30 +00002140
2141 NOTE: In a |Vim9| script, when `vim9script` is encountered, the value
2142 is saved, 'cpoptions' is set to the Vim default, and the saved value
2143 is restored at the end of the script. Changes to the value of
2144 'cpoptions' will be applied to the saved value, but keep in mind that
2145 removing a flag that is not present when 'cpoptions' is changed has no
2146 effect. In the |.vimrc| file the value is not restored, thus using
2147 `vim9script` in the |.vimrc| file results in using the Vim default.
2148
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002149 NOTE: This option is set to the POSIX default value at startup when
2150 the Vi default value would be used and the $VIM_POSIX environment
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002151 variable exists |posix|. This means Vim tries to behave like the
2152 POSIX specification.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002153
2154 contains behavior ~
2155 *cpo-a*
2156 a When included, a ":read" command with a file name
2157 argument will set the alternate file name for the
2158 current window.
2159 *cpo-A*
2160 A When included, a ":write" command with a file name
2161 argument will set the alternate file name for the
2162 current window.
2163 *cpo-b*
2164 b "\|" in a ":map" command is recognized as the end of
2165 the map command. The '\' is included in the mapping,
2166 the text after the '|' is interpreted as the next
2167 command. Use a CTRL-V instead of a backslash to
2168 include the '|' in the mapping. Applies to all
2169 mapping, abbreviation, menu and autocmd commands.
2170 See also |map_bar|.
2171 *cpo-B*
2172 B A backslash has no special meaning in mappings,
Bram Moolenaara9604e62018-07-21 05:56:22 +02002173 abbreviations, user commands and the "to" part of the
2174 menu commands. Remove this flag to be able to use a
2175 backslash like a CTRL-V. For example, the command
2176 ":map X \<Esc>" results in X being mapped to:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002177 'B' included: "\^[" (^[ is a real <Esc>)
2178 'B' excluded: "<Esc>" (5 characters)
2179 ('<' excluded in both cases)
2180 *cpo-c*
2181 c Searching continues at the end of any match at the
2182 cursor position, but not further than the start of the
2183 next line. When not present searching continues
2184 one character from the cursor position. With 'c'
2185 "abababababab" only gets three matches when repeating
2186 "/abab", without 'c' there are five matches.
2187 *cpo-C*
2188 C Do not concatenate sourced lines that start with a
2189 backslash. See |line-continuation|.
2190 *cpo-d*
2191 d Using "./" in the 'tags' option doesn't mean to use
2192 the tags file relative to the current file, but the
2193 tags file in the current directory.
2194 *cpo-D*
2195 D Can't use CTRL-K to enter a digraph after Normal mode
2196 commands with a character argument, like |r|, |f| and
2197 |t|.
2198 *cpo-e*
2199 e When executing a register with ":@r", always add a
2200 <CR> to the last line, also when the register is not
2201 linewise. If this flag is not present, the register
2202 is not linewise and the last line does not end in a
2203 <CR>, then the last line is put on the command-line
2204 and can be edited before hitting <CR>.
2205 *cpo-E*
2206 E It is an error when using "y", "d", "c", "g~", "gu" or
2207 "gU" on an Empty region. The operators only work when
Bram Moolenaar15142e22018-04-30 22:19:58 +02002208 at least one character is to be operated on. Example:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002209 This makes "y0" fail in the first column.
2210 *cpo-f*
2211 f When included, a ":read" command with a file name
2212 argument will set the file name for the current buffer,
2213 if the current buffer doesn't have a file name yet.
2214 *cpo-F*
2215 F When included, a ":write" command with a file name
2216 argument will set the file name for the current
2217 buffer, if the current buffer doesn't have a file name
Bram Moolenaarb3480382005-12-11 21:33:32 +00002218 yet. Also see |cpo-P|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002219 *cpo-g*
2220 g Goto line 1 when using ":edit" without argument.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002221 *cpo-H*
2222 H When using "I" on a line with only blanks, insert
2223 before the last blank. Without this flag insert after
2224 the last blank.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002225 *cpo-i*
2226 i When included, interrupting the reading of a file will
2227 leave it modified.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002228 *cpo-I*
2229 I When moving the cursor up or down just after inserting
2230 indent for 'autoindent', do not delete the indent.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002231 *cpo-j*
2232 j When joining lines, only add two spaces after a '.',
2233 not after '!' or '?'. Also see 'joinspaces'.
2234 *cpo-J*
2235 J A |sentence| has to be followed by two spaces after
Bram Moolenaar582fd852005-03-28 20:58:01 +00002236 the '.', '!' or '?'. A <Tab> is not recognized as
Bram Moolenaar071d4272004-06-13 20:20:40 +00002237 white space.
2238 *cpo-k*
2239 k Disable the recognition of raw key codes in
2240 mappings, abbreviations, and the "to" part of menu
2241 commands. For example, if <Key> sends ^[OA (where ^[
2242 is <Esc>), the command ":map X ^[OA" results in X
2243 being mapped to:
2244 'k' included: "^[OA" (3 characters)
2245 'k' excluded: "<Key>" (one key code)
2246 Also see the '<' flag below.
2247 *cpo-K*
2248 K Don't wait for a key code to complete when it is
2249 halfway a mapping. This breaks mapping <F1><F1> when
2250 only part of the second <F1> has been read. It
2251 enables cancelling the mapping by typing <F1><Esc>.
2252 *cpo-l*
2253 l Backslash in a [] range in a search pattern is taken
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002254 literally, only "\]", "\^", "\-" and "\\" are special.
2255 See |/[]|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002256 'l' included: "/[ \t]" finds <Space>, '\' and 't'
2257 'l' excluded: "/[ \t]" finds <Space> and <Tab>
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002258 Also see |cpo-\|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002259 *cpo-L*
2260 L When the 'list' option is set, 'wrapmargin',
2261 'textwidth', 'softtabstop' and Virtual Replace mode
2262 (see |gR|) count a <Tab> as two characters, instead of
2263 the normal behavior of a <Tab>.
2264 *cpo-m*
2265 m When included, a showmatch will always wait half a
2266 second. When not included, a showmatch will wait half
2267 a second or until a character is typed. |'showmatch'|
2268 *cpo-M*
2269 M When excluded, "%" matching will take backslashes into
2270 account. Thus in "( \( )" and "\( ( \)" the outer
2271 parenthesis match. When included "%" ignores
2272 backslashes, which is Vi compatible.
2273 *cpo-n*
Bram Moolenaar64486672010-05-16 15:46:46 +02002274 n When included, the column used for 'number' and
2275 'relativenumber' will also be used for text of wrapped
2276 lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002277 *cpo-o*
2278 o Line offset to search command is not remembered for
2279 next search.
2280 *cpo-O*
2281 O Don't complain if a file is being overwritten, even
2282 when it didn't exist when editing it. This is a
2283 protection against a file unexpectedly created by
2284 someone else. Vi didn't complain about this.
2285 *cpo-p*
2286 p Vi compatible Lisp indenting. When not present, a
2287 slightly better algorithm is used.
Bram Moolenaarb3480382005-12-11 21:33:32 +00002288 *cpo-P*
2289 P When included, a ":write" command that appends to a
2290 file will set the file name for the current buffer, if
2291 the current buffer doesn't have a file name yet and
2292 the 'F' flag is also included |cpo-F|.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002293 *cpo-q*
2294 q When joining multiple lines leave the cursor at the
2295 position where it would be when joining two lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002296 *cpo-r*
2297 r Redo ("." command) uses "/" to repeat a search
2298 command, instead of the actually used search string.
2299 *cpo-R*
2300 R Remove marks from filtered lines. Without this flag
2301 marks are kept like |:keepmarks| was used.
2302 *cpo-s*
2303 s Set buffer options when entering the buffer for the
2304 first time. This is like it is in Vim version 3.0.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002305 And it is the default. If not present the options are
Bram Moolenaar071d4272004-06-13 20:20:40 +00002306 set when the buffer is created.
2307 *cpo-S*
2308 S Set buffer options always when entering a buffer
2309 (except 'readonly', 'fileformat', 'filetype' and
2310 'syntax'). This is the (most) Vi compatible setting.
2311 The options are set to the values in the current
2312 buffer. When you change an option and go to another
2313 buffer, the value is copied. Effectively makes the
2314 buffer options global to all buffers.
2315
2316 's' 'S' copy buffer options
2317 no no when buffer created
2318 yes no when buffer first entered (default)
2319 X yes each time when buffer entered (vi comp.)
2320 *cpo-t*
2321 t Search pattern for the tag command is remembered for
2322 "n" command. Otherwise Vim only puts the pattern in
2323 the history for search pattern, but doesn't change the
2324 last used search pattern.
2325 *cpo-u*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002326 u Undo is Vi compatible. See |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002327 *cpo-v*
2328 v Backspaced characters remain visible on the screen in
2329 Insert mode. Without this flag the characters are
2330 erased from the screen right away. With this flag the
2331 screen newly typed text overwrites backspaced
2332 characters.
2333 *cpo-w*
2334 w When using "cw" on a blank character, only change one
2335 character and not all blanks until the start of the
2336 next word.
2337 *cpo-W*
2338 W Don't overwrite a readonly file. When omitted, ":w!"
2339 overwrites a readonly file, if possible.
2340 *cpo-x*
2341 x <Esc> on the command-line executes the command-line.
2342 The default in Vim is to abandon the command-line,
2343 because <Esc> normally aborts a command. |c_<Esc>|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002344 *cpo-X*
2345 X When using a count with "R" the replaced text is
2346 deleted only once. Also when repeating "R" with "."
2347 and a count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002348 *cpo-y*
Bram Moolenaard09091d2019-01-17 16:07:22 +01002349 y A yank command can be redone with ".". Think twice if
2350 you really want to use this, it may break some
2351 plugins, since most people expect "." to only repeat a
2352 change.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002353 *cpo-Z*
2354 Z When using "w!" while the 'readonly' option is set,
2355 don't reset 'readonly'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002356 *cpo-!*
2357 ! When redoing a filter command, use the last used
2358 external command, whatever it was. Otherwise the last
2359 used -filter- command is used.
2360 *cpo-$*
2361 $ When making a change to one line, don't redisplay the
2362 line, but put a '$' at the end of the changed text.
2363 The changed text will be overwritten when you type the
2364 new text. The line is redisplayed if you type any
2365 command that moves the cursor from the insertion
2366 point.
2367 *cpo-%*
2368 % Vi-compatible matching is done for the "%" command.
2369 Does not recognize "#if", "#endif", etc.
2370 Does not recognize "/*" and "*/".
2371 Parens inside single and double quotes are also
2372 counted, causing a string that contains a paren to
2373 disturb the matching. For example, in a line like
2374 "if (strcmp("foo(", s))" the first paren does not
2375 match the last one. When this flag is not included,
2376 parens inside single and double quotes are treated
2377 specially. When matching a paren outside of quotes,
2378 everything inside quotes is ignored. When matching a
2379 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002380 there is one). This works very well for C programs.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002381 This flag is also used for other features, such as
2382 C-indenting.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002383 *cpo--*
2384 - When included, a vertical movement command fails when
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002385 it would go above the first line or below the last
2386 line. Without it the cursor moves to the first or
2387 last line, unless it already was in that line.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002388 Applies to the commands "-", "k", CTRL-P, "+", "j",
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002389 CTRL-N, CTRL-J and ":1234".
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002390 *cpo-+*
2391 + When included, a ":write file" command will reset the
2392 'modified' flag of the buffer, even though the buffer
2393 itself may still be different from its file.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002394 *cpo-star*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002395 * Use ":*" in the same way as ":@". When not included,
2396 ":*" is an alias for ":'<,'>", select the Visual area.
2397 *cpo-<*
2398 < Disable the recognition of special key codes in |<>|
2399 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002400 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00002401 ":map X <Tab>" results in X being mapped to:
2402 '<' included: "<Tab>" (5 characters)
2403 '<' excluded: "^I" (^I is a real <Tab>)
2404 Also see the 'k' flag above.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002405 *cpo->*
2406 > When appending to a register, put a line break before
2407 the appended text.
Bram Moolenaar8b3e0332011-06-26 05:36:34 +02002408 *cpo-;*
2409 ; When using |,| or |;| to repeat the last |t| search
2410 and the cursor is right in front of the searched
2411 character, the cursor won't move. When not included,
2412 the cursor would skip over it and jump to the
Bram Moolenaarc8734422012-06-01 22:38:45 +02002413 following occurrence.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002414
2415 POSIX flags. These are not included in the Vi default value, except
2416 when $VIM_POSIX was set on startup. |posix|
2417
2418 contains behavior ~
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002419 *cpo-#*
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002420 # A count before "D", "o" and "O" has no effect.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002421 *cpo-&*
2422 & When ":preserve" was used keep the swap file when
2423 exiting normally while this buffer is still loaded.
2424 This flag is tested when exiting.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002425 *cpo-\*
2426 \ Backslash in a [] range in a search pattern is taken
2427 literally, only "\]" is special See |/[]|
Bram Moolenaar90915b52005-08-21 22:17:52 +00002428 '\' included: "/[ \-]" finds <Space>, '\' and '-'
2429 '\' excluded: "/[ \-]" finds <Space> and '-'
2430 Also see |cpo-l|.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002431 *cpo-/*
2432 / When "%" is used as the replacement string in a |:s|
2433 command, use the previous replacement string. |:s%|
2434 *cpo-{*
2435 { The |{| and |}| commands also stop at a "{" character
2436 at the start of a line.
2437 *cpo-.*
2438 . The ":chdir" and ":cd" commands fail if the current
2439 buffer is modified, unless ! is used. Vim doesn't
2440 need this, since it remembers the full path of an
2441 opened file.
2442 *cpo-bar*
2443 | The value of the $LINES and $COLUMNS environment
2444 variables overrule the terminal size values obtained
2445 with system specific functions.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002446
Bram Moolenaar071d4272004-06-13 20:20:40 +00002447
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002448 *'cryptmethod'* *'cm'*
Bram Moolenaara86187b2018-12-16 18:20:00 +01002449'cryptmethod' 'cm' string (default "blowfish2")
Bram Moolenaar49771f42010-07-20 17:32:38 +02002450 global or local to buffer |global-local|
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002451 Method used for encryption when the buffer is written to a file:
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002452 *pkzip*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002453 zip PkZip compatible method. A weak kind of encryption.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002454 Backwards compatible with Vim 7.2 and older.
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002455 *blowfish*
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002456 blowfish Blowfish method. Medium strong encryption but it has
2457 an implementation flaw. Requires Vim 7.3 or later,
2458 files can NOT be read by Vim 7.2 and older. This adds
2459 a "seed" to the file, every time you write the file
2460 the encrypted bytes will be different.
2461 *blowfish2*
2462 blowfish2 Blowfish method. Medium strong encryption. Requires
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01002463 Vim 7.4.401 or later, files can NOT be read by Vim 7.3
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002464 and older. This adds a "seed" to the file, every time
2465 you write the file the encrypted bytes will be
2466 different. The whole undo file is encrypted, not just
2467 the pieces of text.
Christian Brabandtf573c6e2021-06-20 14:02:16 +02002468 *E1193* *E1194* *E1195* *E1196*
2469 *E1197* *E1198* *E1199* *E1200* *E1201*
2470 xchacha20 XChaCha20 Cipher with Poly1305 Message Authentication
2471 Code. Medium strong till strong encryption.
2472 Encryption is provided by the libsodium library, it
Bram Moolenaar22863042021-10-16 15:23:36 +01002473 requires Vim to be built with |+sodium|.
Christian Brabandtf573c6e2021-06-20 14:02:16 +02002474 It adds a seed and a message authentication code (MAC)
2475 to the file. This needs at least a Vim 8.2.3022 to
2476 read the encrypted file.
2477 Encryption of swap files is not supported, therefore
2478 no swap file will be used when xchacha20 encryption is
2479 enabled.
2480 Encryption of undo files is not yet supported,
2481 therefore no undo file will currently be written.
2482 CURRENTLY EXPERIMENTAL: Files written with this method
2483 might have to be read back with the same version of
2484 Vim if the binary format changes later.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002485
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01002486 You should use "blowfish2", also to re-encrypt older files.
2487
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002488 When reading an encrypted file 'cryptmethod' will be set automatically
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002489 to the detected method of the file being read. Thus if you write it
2490 without changing 'cryptmethod' the same method will be used.
2491 Changing 'cryptmethod' does not mark the file as modified, you have to
Bram Moolenaar49771f42010-07-20 17:32:38 +02002492 explicitly write it, you don't get a warning unless there are other
2493 modifications. Also see |:X|.
2494
2495 When setting the global value to an empty string, it will end up with
Bram Moolenaara86187b2018-12-16 18:20:00 +01002496 the value "blowfish2". When setting the local value to an empty
2497 string the buffer will use the global value.
Bram Moolenaar49771f42010-07-20 17:32:38 +02002498
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002499 When a new encryption method is added in a later version of Vim, and
2500 the current version does not recognize it, you will get *E821* .
Bram Moolenaar49771f42010-07-20 17:32:38 +02002501 You need to edit this file with the later version of Vim.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002502
2503
Bram Moolenaar071d4272004-06-13 20:20:40 +00002504 *'cscopepathcomp'* *'cspc'*
2505'cscopepathcomp' 'cspc' number (default 0)
2506 global
2507 {not available when compiled without the |+cscope|
2508 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002509 Determines how many components of the path to show in a list of tags.
2510 See |cscopepathcomp|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002511 NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002512
2513 *'cscopeprg'* *'csprg'*
2514'cscopeprg' 'csprg' string (default "cscope")
2515 global
2516 {not available when compiled without the |+cscope|
2517 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002518 Specifies the command to execute cscope. See |cscopeprg|.
2519 This option cannot be set from a |modeline| or in the |sandbox|, for
2520 security reasons.
2521
2522 *'cscopequickfix'* *'csqf'*
2523'cscopequickfix' 'csqf' string (default "")
2524 global
2525 {not available when compiled without the |+cscope|
2526 or |+quickfix| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002527 Specifies whether to use quickfix window to show cscope results.
2528 See |cscopequickfix|.
2529
Bram Moolenaarec7944a2013-06-12 21:29:15 +02002530 *'cscoperelative'* *'csre'* *'nocscoperelative'* *'nocsre'*
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002531'cscoperelative' 'csre' boolean (default off)
2532 global
2533 {not available when compiled without the |+cscope|
2534 feature}
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002535 In the absence of a prefix (-P) for cscope. setting this option enables
2536 to use the basename of cscope.out path as the prefix.
2537 See |cscoperelative|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002538 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002539
Bram Moolenaar071d4272004-06-13 20:20:40 +00002540 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
2541'cscopetag' 'cst' boolean (default off)
2542 global
2543 {not available when compiled without the |+cscope|
2544 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002545 Use cscope for tag commands. See |cscope-options|.
2546 NOTE: This option is reset when 'compatible' is set.
2547
2548 *'cscopetagorder'* *'csto'*
2549'cscopetagorder' 'csto' number (default 0)
2550 global
2551 {not available when compiled without the |+cscope|
2552 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002553 Determines the order in which ":cstag" performs a search. See
2554 |cscopetagorder|.
2555 NOTE: This option is set to 0 when 'compatible' is set.
2556
2557 *'cscopeverbose'* *'csverb'*
2558 *'nocscopeverbose'* *'nocsverb'*
2559'cscopeverbose' 'csverb' boolean (default off)
2560 global
2561 {not available when compiled without the |+cscope|
2562 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002563 Give messages when adding a cscope database. See |cscopeverbose|.
2564 NOTE: This option is reset when 'compatible' is set.
2565
Bram Moolenaar860cae12010-06-05 23:22:07 +02002566 *'cursorbind'* *'crb'* *'nocursorbind'* *'nocrb'*
2567'cursorbind' 'crb' boolean (default off)
2568 local to window
Bram Moolenaar860cae12010-06-05 23:22:07 +02002569 When this option is set, as the cursor in the current
2570 window moves other cursorbound windows (windows that also have
2571 this option set) move their cursors to the corresponding line and
2572 column. This option is useful for viewing the
2573 differences between two versions of a file (see 'diff'); in diff mode,
2574 inserted and deleted lines (though not characters within a line) are
Bram Moolenaar1a384422010-07-14 19:53:30 +02002575 taken into account.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002576
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002577
2578 *'cursorcolumn'* *'cuc'* *'nocursorcolumn'* *'nocuc'*
2579'cursorcolumn' 'cuc' boolean (default off)
2580 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02002581 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002582 feature}
2583 Highlight the screen column of the cursor with CursorColumn
2584 |hl-CursorColumn|. Useful to align text. Will make screen redrawing
2585 slower.
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00002586 If you only want the highlighting in the current window you can use
2587 these autocommands: >
2588 au WinLeave * set nocursorline nocursorcolumn
2589 au WinEnter * set cursorline cursorcolumn
2590<
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002591
2592 *'cursorline'* *'cul'* *'nocursorline'* *'nocul'*
2593'cursorline' 'cul' boolean (default off)
2594 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02002595 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002596 feature}
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002597 Highlight the text line of the cursor with CursorLine |hl-CursorLine|.
2598 Useful to easily spot the cursor. Will make screen redrawing slower.
Bram Moolenaare2f98b92006-03-29 21:18:24 +00002599 When Visual mode is active the highlighting isn't used to make it
Bram Moolenaar779b74b2006-04-10 14:55:34 +00002600 easier to see the selected text.
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002601
2602
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002603 *'cursorlineopt'* *'culopt'*
Bram Moolenaar017ba072019-09-14 21:01:23 +02002604'cursorlineopt' 'culopt' string (default: "number,line")
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002605 local to window
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002606 {not available when compiled without the |+syntax|
2607 feature}
Bram Moolenaar017ba072019-09-14 21:01:23 +02002608 Comma separated list of settings for how 'cursorline' is displayed.
2609 Valid values:
2610 "line" Highlight the text line of the cursor with
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002611 CursorLine |hl-CursorLine|.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002612 "screenline" Highlight only the screen line of the cursor with
2613 CursorLine |hl-CursorLine|.
2614 "number" Highlight the line number of the cursor with
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002615 CursorLineNr |hl-CursorLineNr|.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002616
2617 Special value:
2618 "both" Alias for the values "line,number".
2619
2620 "line" and "screenline" cannot be used together.
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002621
2622
Bram Moolenaar071d4272004-06-13 20:20:40 +00002623 *'debug'*
2624'debug' string (default "")
2625 global
Bram Moolenaar57657d82006-04-21 22:12:41 +00002626 These values can be used:
2627 msg Error messages that would otherwise be omitted will be given
2628 anyway.
2629 throw Error messages that would otherwise be omitted will be given
2630 anyway and also throw an exception and set |v:errmsg|.
2631 beep A message will be given when otherwise only a beep would be
2632 produced.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002633 The values can be combined, separated by a comma.
Bram Moolenaar57657d82006-04-21 22:12:41 +00002634 "msg" and "throw" are useful for debugging 'foldexpr', 'formatexpr' or
2635 'indentexpr'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002636
2637 *'define'* *'def'*
2638'define' 'def' string (default "^\s*#\s*define")
2639 global or local to buffer |global-local|
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002640 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002641 pattern, just like for the "/" command. This option is used for the
2642 commands like "[i" and "[d" |include-search|. The 'isident' option is
2643 used to recognize the defined name after the match:
2644 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2645 See |option-backslash| about inserting backslashes to include a space
2646 or backslash.
2647 The default value is for C programs. For C++ this value would be
2648 useful, to include const type declarations: >
2649 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
Bram Moolenaar63b74a82019-03-24 15:09:13 +01002650< You can also use "\ze" just before the name and continue the pattern
2651 to check what is following. E.g. for Javascript, if a function is
2652 defined with "func_name = function(args)": >
2653 ^\s*\ze\i\+\s*=\s*function(
2654< If the function is defined with "func_name : function() {...": >
2655 ^\s*\ze\i\+\s*[:]\s*(*function\s*(
Bram Moolenaar071d4272004-06-13 20:20:40 +00002656< When using the ":set" command, you need to double the backslashes!
Bram Moolenaar63b74a82019-03-24 15:09:13 +01002657 To avoid that use `:let` with a single quote string: >
2658 let &l:define = '^\s*\ze\k\+\s*=\s*function('
Bram Moolenaar911ead12019-04-21 00:03:35 +02002659<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002660
2661 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2662'delcombine' 'deco' boolean (default off)
2663 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002664 If editing Unicode and this option is set, backspace and Normal mode
2665 "x" delete each combining character on its own. When it is off (the
2666 default) the character along with its combining characters are
2667 deleted.
Bram Moolenaar4f4d51a2020-10-11 13:57:40 +02002668 Note: When 'delcombine' is set "xx" may work differently from "2x"!
Bram Moolenaar071d4272004-06-13 20:20:40 +00002669
2670 This is useful for Arabic, Hebrew and many other languages where one
2671 may have combining characters overtop of base characters, and want
2672 to remove only the combining ones.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002673 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002674
2675 *'dictionary'* *'dict'*
2676'dictionary' 'dict' string (default "")
2677 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002678 List of file names, separated by commas, that are used to lookup words
2679 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2680 contain a list of words. This can be one word per line, or several
2681 words per line, separated by non-keyword characters (white space is
2682 preferred). Maximum line length is 510 bytes.
Bram Moolenaar259f26a2018-05-15 22:25:40 +02002683
2684 When this option is empty or an entry "spell" is present, and spell
2685 checking is enabled, words in the word lists for the currently active
2686 'spelllang' are used. See |spell|.
2687
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002688 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002689 after a comma are ignored, otherwise spaces are included in the file
2690 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002691 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002692 Where to find a list of words?
2693 - On FreeBSD, there is the file "/usr/share/dict/words".
2694 - In the Simtel archive, look in the "msdos/linguist" directory.
2695 - In "miscfiles" of the GNU collection.
2696 The use of |:set+=| and |:set-=| is preferred when adding or removing
2697 directories from the list. This avoids problems when a future version
2698 uses another default.
2699 Backticks cannot be used in this option for security reasons.
2700
2701 *'diff'* *'nodiff'*
2702'diff' boolean (default off)
2703 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00002704 {not available when compiled without the |+diff|
2705 feature}
2706 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002707 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002708
2709 *'dex'* *'diffexpr'*
2710'diffexpr' 'dex' string (default "")
2711 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002712 {not available when compiled without the |+diff|
2713 feature}
Bram Moolenaare828b762018-09-10 17:51:58 +02002714 Expression which is evaluated to obtain a diff file (either ed-style
2715 or unified-style) from two versions of a file. See |diff-diffexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002716 This option cannot be set from a |modeline| or in the |sandbox|, for
2717 security reasons.
2718
2719 *'dip'* *'diffopt'*
Bram Moolenaarc8234772019-11-10 21:00:27 +01002720'diffopt' 'dip' string (default "internal,filler,closeoff")
Bram Moolenaar071d4272004-06-13 20:20:40 +00002721 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002722 {not available when compiled without the |+diff|
2723 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002724 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002725 All are optional. Items must be separated by a comma.
2726
2727 filler Show filler lines, to keep the text
2728 synchronized with a window that has inserted
2729 lines at the same position. Mostly useful
2730 when windows are side-by-side and 'scrollbind'
2731 is set.
2732
2733 context:{n} Use a context of {n} lines between a change
2734 and a fold that contains unchanged lines.
2735 When omitted a context of six lines is used.
Bram Moolenaarf6b40102019-02-22 15:24:03 +01002736 When using zero the context is actually one,
2737 since folds require a line in between, also
2738 for a deleted line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002739 See |fold-diff|.
2740
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002741 iblank Ignore changes where lines are all blank. Adds
2742 the "-B" flag to the "diff" command if
2743 'diffexpr' is empty. Check the documentation
2744 of the "diff" command for what this does
2745 exactly.
2746 NOTE: the diff windows will get out of sync,
2747 because no differences between blank lines are
2748 taken into account.
2749
Bram Moolenaar071d4272004-06-13 20:20:40 +00002750 icase Ignore changes in case of text. "a" and "A"
2751 are considered the same. Adds the "-i" flag
2752 to the "diff" command if 'diffexpr' is empty.
2753
2754 iwhite Ignore changes in amount of white space. Adds
2755 the "-b" flag to the "diff" command if
2756 'diffexpr' is empty. Check the documentation
2757 of the "diff" command for what this does
2758 exactly. It should ignore adding trailing
2759 white space, but not leading white space.
2760
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002761 iwhiteall Ignore all white space changes. Adds
2762 the "-w" flag to the "diff" command if
2763 'diffexpr' is empty. Check the documentation
2764 of the "diff" command for what this does
2765 exactly.
2766
2767 iwhiteeol Ignore white space changes at end of line.
2768 Adds the "-Z" flag to the "diff" command if
2769 'diffexpr' is empty. Check the documentation
2770 of the "diff" command for what this does
2771 exactly.
2772
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002773 horizontal Start diff mode with horizontal splits (unless
2774 explicitly specified otherwise).
2775
2776 vertical Start diff mode with vertical splits (unless
2777 explicitly specified otherwise).
2778
Bram Moolenaarc8234772019-11-10 21:00:27 +01002779 closeoff When a window is closed where 'diff' is set
2780 and there is only one window remaining in the
2781 same tab page with 'diff' set, execute
2782 `:diffoff` in that window. This undoes a
2783 `:diffsplit` command.
2784
Bram Moolenaar97ce4192017-12-01 20:35:58 +01002785 hiddenoff Do not use diff mode for a buffer when it
2786 becomes hidden.
2787
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002788 foldcolumn:{n} Set the 'foldcolumn' option to {n} when
2789 starting diff mode. Without this 2 is used.
2790
Bram Moolenaar4223d432021-02-10 13:18:17 +01002791 followwrap Follow the 'wrap' option and leave as it is.
2792
Bram Moolenaare828b762018-09-10 17:51:58 +02002793 internal Use the internal diff library. This is
2794 ignored when 'diffexpr' is set. *E960*
2795 When running out of memory when writing a
2796 buffer this item will be ignored for diffs
2797 involving that buffer. Set the 'verbose'
2798 option to see when this happens.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002799
Bram Moolenaare828b762018-09-10 17:51:58 +02002800 indent-heuristic
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01002801 Use the indent heuristic for the internal
2802 diff library.
Bram Moolenaare828b762018-09-10 17:51:58 +02002803
2804 algorithm:{text} Use the specified diff algorithm with the
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01002805 internal diff engine. Currently supported
Bram Moolenaare828b762018-09-10 17:51:58 +02002806 algorithms are:
2807 myers the default algorithm
2808 minimal spend extra time to generate the
2809 smallest possible diff
2810 patience patience diff algorithm
2811 histogram histogram diff algorithm
2812
2813 Examples: >
2814 :set diffopt=internal,filler,context:4
Bram Moolenaar071d4272004-06-13 20:20:40 +00002815 :set diffopt=
Bram Moolenaare828b762018-09-10 17:51:58 +02002816 :set diffopt=internal,filler,foldcolumn:3
2817 :set diffopt-=internal " do NOT use the internal diff parser
Bram Moolenaar071d4272004-06-13 20:20:40 +00002818<
2819 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
2820'digraph' 'dg' boolean (default off)
2821 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002822 {not available when compiled without the |+digraphs|
2823 feature}
2824 Enable the entering of digraphs in Insert mode with {char1} <BS>
2825 {char2}. See |digraphs|.
2826 NOTE: This option is reset when 'compatible' is set.
2827
2828 *'directory'* *'dir'*
2829'directory' 'dir' string (default for Amiga: ".,t:",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01002830 for Win32: ".,$TEMP,c:\tmp,c:\temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00002831 for Unix: ".,~/tmp,/var/tmp,/tmp")
2832 global
2833 List of directory names for the swap file, separated with commas.
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02002834 Recommended value: ".,~/vimswap//" - this will put the swap file next
2835 to the edited file if possible, and in your personal swap directory
2836 otherwise. Make sure "~/vimswap//" is only readable for you.
2837
2838 Possible items:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002839 - The swap file will be created in the first directory where this is
2840 possible.
2841 - Empty means that no swap file will be used (recovery is
Bram Moolenaar00e192b2019-10-19 17:01:28 +02002842 impossible!) and no |E303| error will be given.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002843 - A directory "." means to put the swap file in the same directory as
2844 the edited file. On Unix, a dot is prepended to the file name, so
2845 it doesn't show in a directory listing. On MS-Windows the "hidden"
2846 attribute is set and a dot prepended if possible.
Bram Moolenaar8024f932020-01-14 19:29:13 +01002847 - A directory starting with "./" (or ".\" for MS-Windows) means to put
2848 the swap file relative to where the edited file is. The leading "."
2849 is replaced with the path name of the edited file.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02002850 - For Unix and Win32, if a directory ends in two path separators "//",
2851 the swap file name will be built from the complete path to the file
Bram Moolenaar207f0092020-08-30 17:20:20 +02002852 with all path separators replaced by percent '%' signs (including
2853 the colon following the drive letter on Win32). This will ensure
2854 file name uniqueness in the preserve directory.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02002855 On Win32, it is also possible to end with "\\". However, When a
2856 separating comma is following, you must use "//", since "\\" will
2857 include the comma in the file name. Therefore it is recommended to
2858 use '//', instead of '\\'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002859 - Spaces after the comma are ignored, other spaces are considered part
2860 of the directory name. To have a space at the start of a directory
2861 name, precede it with a backslash.
2862 - To include a comma in a directory name precede it with a backslash.
2863 - A directory name may end in an ':' or '/'.
2864 - Environment variables are expanded |:set_env|.
2865 - Careful with '\' characters, type one before a space, type two to
2866 get one in the option (see |option-backslash|), for example: >
2867 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
2868< - For backwards compatibility with Vim version 3.0 a '>' at the start
2869 of the option is removed.
2870 Using "." first in the list is recommended. This means that editing
2871 the same file twice will result in a warning. Using "/tmp" on Unix is
2872 discouraged: When the system crashes you lose the swap file.
2873 "/var/tmp" is often not cleared when rebooting, thus is a better
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02002874 choice than "/tmp". But others on the computer may be able to see the
2875 files, and it can contain a lot of files, your swap files get lost in
2876 the crowd. That is why a "tmp" directory in your home directory is
2877 tried first.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002878 The use of |:set+=| and |:set-=| is preferred when adding or removing
2879 directories from the list. This avoids problems when a future version
2880 uses another default.
2881 This option cannot be set from a |modeline| or in the |sandbox|, for
2882 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002883
2884 *'display'* *'dy'*
Bram Moolenaarbc8801c2016-08-02 21:04:33 +02002885'display' 'dy' string (default "", set to "truncate" in
2886 |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002887 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002888 Change the way text is displayed. This is comma separated list of
2889 flags:
2890 lastline When included, as much as possible of the last line
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02002891 in a window will be displayed. "@@@" is put in the
2892 last columns of the last screen line to indicate the
2893 rest of the line is not displayed.
2894 truncate Like "lastline", but "@@@" is displayed in the first
2895 column of the last screen line. Overrules "lastline".
Bram Moolenaar071d4272004-06-13 20:20:40 +00002896 uhex Show unprintable characters hexadecimal as <xx>
2897 instead of using ^C and ~C.
2898
Bram Moolenaard0796902016-09-16 20:02:31 +02002899 When neither "lastline" nor "truncate" is included, a last line that
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02002900 doesn't fit is replaced with "@" lines.
2901
Bram Moolenaar071d4272004-06-13 20:20:40 +00002902 *'eadirection'* *'ead'*
2903'eadirection' 'ead' string (default "both")
2904 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002905 Tells when the 'equalalways' option applies:
2906 ver vertically, width of windows is not affected
2907 hor horizontally, height of windows is not affected
2908 both width and height of windows is affected
2909
2910 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
2911'edcompatible' 'ed' boolean (default off)
2912 global
2913 Makes the 'g' and 'c' flags of the ":substitute" command to be
2914 toggled each time the flag is given. See |complex-change|. See
2915 also 'gdefault' option.
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +02002916 Switching this option on may break plugins!
Bram Moolenaar4072ba52020-12-23 13:56:35 +01002917 This option is not used in |Vim9| script.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002918
Bram Moolenaar03413f42016-04-12 21:07:15 +02002919 *'emoji'* *'emo'* *'noemoji'* *'noemo'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01002920'emoji' 'emo' boolean (default: on)
2921 global
Bram Moolenaar3848e002016-03-19 18:42:29 +01002922 When on all Unicode emoji characters are considered to be full width.
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02002923 This excludes "text emoji" characters, which are normally displayed as
2924 single width. Unfortunately there is no good specification for this
2925 and it has been determined on trial-and-error basis. Use the
2926 |setcellwidths()| function to change the behavior.
Bram Moolenaar3848e002016-03-19 18:42:29 +01002927
Bram Moolenaar071d4272004-06-13 20:20:40 +00002928 *'encoding'* *'enc'* *E543*
K.Takataf883d902021-05-30 18:04:19 +02002929'encoding' 'enc' string (default for MS-Windows: "utf-8",
2930 otherwise: value from $LANG or "latin1")
Bram Moolenaar071d4272004-06-13 20:20:40 +00002931 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002932 Sets the character encoding used inside Vim. It applies to text in
2933 the buffers, registers, Strings in expressions, text stored in the
2934 viminfo file, etc. It sets the kind of characters which Vim can work
2935 with. See |encoding-names| for the possible values.
2936
2937 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002938 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002939 It should normally be kept at its default value, or set when Vim
Bram Moolenaar02467872007-05-06 13:22:01 +00002940 starts up. See |multibyte|. To reload the menus see |:menutrans|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002941
Bram Moolenaar865242e2010-07-14 21:12:05 +02002942 This option cannot be set from a |modeline|. It would most likely
2943 corrupt the text.
2944
Bram Moolenaar3df01732017-02-17 22:47:16 +01002945 NOTE: For GTK+ 2 or later, it is highly recommended to set 'encoding'
2946 to "utf-8". Although care has been taken to allow different values of
Bram Moolenaar071d4272004-06-13 20:20:40 +00002947 'encoding', "utf-8" is the natural choice for the environment and
2948 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002949 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00002950 versions, and to avoid changing the encoding of newly created files
2951 without your knowledge (in case 'fileencodings' is empty).
2952
2953 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002954 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00002955 iconv() or as specified with 'charconvert'.
2956
Bram Moolenaar207f0092020-08-30 17:20:20 +02002957 If you need to know whether 'encoding' is a multibyte encoding, you
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002958 can use: >
2959 if has("multi_byte_encoding")
2960<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002961 Normally 'encoding' will be equal to your current locale. This will
2962 be the default if Vim recognizes your environment settings. If
2963 'encoding' is not set to the current locale, 'termencoding' must be
2964 set to convert typed and displayed text. See |encoding-table|.
2965
2966 When you set this option, it fires the |EncodingChanged| autocommand
2967 event so that you can set up fonts if necessary.
2968
2969 When the option is set, the value is converted to lowercase. Thus
2970 you can set it with uppercase values too. Underscores are translated
2971 to '-' signs.
2972 When the encoding is recognized, it is changed to the standard name.
2973 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
2974 "iso-8859-2" and "utf8" becomes "utf-8".
2975
2976 Note: "latin1" is also used when the encoding could not be detected.
2977 This only works when editing files in the same encoding! When the
2978 actual character set is not latin1, make sure 'fileencoding' and
2979 'fileencodings' are empty. When conversion is needed, switch to using
2980 utf-8.
2981
2982 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
2983 You don't notice this while editing, but it does matter for the
2984 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
2985 setting 'encoding' to one of these values instead of utf-8 only has
2986 effect for encoding used for files when 'fileencoding' is empty.
2987
Bram Moolenaar661b1822005-07-28 22:36:45 +00002988 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
2989 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002990
2991 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
2992'endofline' 'eol' boolean (default on)
2993 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002994 When writing a file and this option is off and the 'binary' option
Bram Moolenaar34d72d42015-07-17 14:18:08 +02002995 is on, or 'fixeol' option is off, no <EOL> will be written for the
2996 last line in the file. This option is automatically set or reset when
2997 starting to edit a new file, depending on whether file has an <EOL>
2998 for the last line in the file. Normally you don't have to set or
2999 reset this option.
3000 When 'binary' is off and 'fixeol' is on the value is not used when
3001 writing the file. When 'binary' is on or 'fixeol' is off it is used
3002 to remember the presence of a <EOL> for the last line in the file, so
3003 that when you write the file the situation from the original file can
3004 be kept. But you can change it if you want to.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003005
3006 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
3007'equalalways' 'ea' boolean (default on)
3008 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003009 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00003010 splitting or closing a window. This also happens the moment the
3011 option is switched on. When off, splitting a window will reduce the
3012 size of the current window and leave the other windows the same. When
3013 closing a window the extra lines are given to the window next to it
3014 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00003015 When mixing vertically and horizontally split windows, a minimal size
3016 is computed and some windows may be larger if there is room. The
3017 'eadirection' option tells in which direction the size is affected.
Bram Moolenaar67f71312007-08-12 14:55:56 +00003018 Changing the height and width of a window can be avoided by setting
3019 'winfixheight' and 'winfixwidth', respectively.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003020 If a window size is specified when creating a new window sizes are
3021 currently not equalized (it's complicated, but may be implemented in
3022 the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +00003023
3024 *'equalprg'* *'ep'*
3025'equalprg' 'ep' string (default "")
3026 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003027 External program to use for "=" command. When this option is empty
Bram Moolenaar446cb832008-06-24 21:56:24 +00003028 the internal formatting functions are used; either 'lisp', 'cindent'
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003029 or 'indentexpr'. When Vim was compiled without internal formatting,
3030 the "indent" program is used.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003031 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003032 about including spaces and backslashes.
3033 This option cannot be set from a |modeline| or in the |sandbox|, for
3034 security reasons.
3035
3036 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
3037'errorbells' 'eb' boolean (default off)
3038 global
3039 Ring the bell (beep or screen flash) for error messages. This only
3040 makes a difference for error messages, the bell will be used always
3041 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003042 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar165bc692015-07-21 17:53:25 +02003043 screen flash or do nothing. See 'belloff' to finetune when to ring the
3044 bell.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003045
3046 *'errorfile'* *'ef'*
3047'errorfile' 'ef' string (Amiga default: "AztecC.Err",
3048 others: "errors.err")
3049 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003050 {not available when compiled without the |+quickfix|
3051 feature}
3052 Name of the errorfile for the QuickFix mode (see |:cf|).
3053 When the "-q" command-line argument is used, 'errorfile' is set to the
3054 following argument. See |-q|.
3055 NOT used for the ":make" command. See 'makeef' for that.
3056 Environment variables are expanded |:set_env|.
3057 See |option-backslash| about including spaces and backslashes.
3058 This option cannot be set from a |modeline| or in the |sandbox|, for
3059 security reasons.
3060
3061 *'errorformat'* *'efm'*
3062'errorformat' 'efm' string (default is very long)
3063 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003064 {not available when compiled without the |+quickfix|
3065 feature}
3066 Scanf-like description of the format for the lines in the error file
3067 (see |errorformat|).
3068
3069 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
3070'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
3071 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003072 Function keys that start with an <Esc> are recognized in Insert
3073 mode. When this option is off, the cursor and function keys cannot be
3074 used in Insert mode if they start with an <Esc>. The advantage of
3075 this is that the single <Esc> is recognized immediately, instead of
3076 after one second. Instead of resetting this option, you might want to
3077 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
3078 when 'esckeys' is off, you can still map anything, but the cursor keys
3079 won't work by default.
3080 NOTE: This option is set to the Vi default value when 'compatible' is
3081 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaarc8234772019-11-10 21:00:27 +01003082 NOTE: when this option is off then the |modifyOtherKeys| functionality
3083 is disabled while in Insert mode to avoid ending Insert mode with any
3084 key that has a modifier.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003085
3086 *'eventignore'* *'ei'*
3087'eventignore' 'ei' string (default "")
3088 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003089 A list of autocommand event names, which are to be ignored.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00003090 When set to "all" or when "all" is one of the items, all autocommand
3091 events are ignored, autocommands will not be executed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003092 Otherwise this is a comma separated list of event names. Example: >
3093 :set ei=WinEnter,WinLeave
3094<
3095 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
3096'expandtab' 'et' boolean (default off)
3097 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003098 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003099 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00003100 when 'autoindent' is on. To insert a real tab when 'expandtab' is
3101 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
Bram Moolenaarca635012015-09-25 20:34:21 +02003102 This option is reset when the 'paste' option is set and restored when
3103 the 'paste' option is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003104 NOTE: This option is reset when 'compatible' is set.
3105
3106 *'exrc'* *'ex'* *'noexrc'* *'noex'*
3107'exrc' 'ex' boolean (default off)
3108 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003109 Enables the reading of .vimrc, .exrc and .gvimrc in the current
Bram Moolenaar36f44c22016-08-28 18:17:20 +02003110 directory.
3111
3112 Setting this option is a potential security leak. E.g., consider
3113 unpacking a package or fetching files from github, a .vimrc in there
3114 might be a trojan horse. BETTER NOT SET THIS OPTION!
3115 Instead, define an autocommand in your .vimrc to set options for a
3116 matching directory.
3117
3118 If you do switch this option on you should also consider setting the
3119 'secure' option (see |initialization|).
3120 Also see |.vimrc| and |gui-init|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003121 This option cannot be set from a |modeline| or in the |sandbox|, for
3122 security reasons.
3123
3124 *'fileencoding'* *'fenc'* *E213*
3125'fileencoding' 'fenc' string (default: "")
3126 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003127 Sets the character encoding for the file of this buffer.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003128
Bram Moolenaar071d4272004-06-13 20:20:40 +00003129 When 'fileencoding' is different from 'encoding', conversion will be
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003130 done when writing the file. For reading see below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003131 When 'fileencoding' is empty, the same value as 'encoding' will be
3132 used (no conversion when reading or writing a file).
Bram Moolenaar214641f2017-03-05 17:04:09 +01003133 No error will be given when the value is set, only when it is used,
3134 only when writing a file.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003135 Conversion will also be done when 'encoding' and 'fileencoding' are
3136 both a Unicode encoding and 'fileencoding' is not utf-8. That's
3137 because internally Unicode is always stored as utf-8.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003138 WARNING: Conversion can cause loss of information! When
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003139 'encoding' is "utf-8" or another Unicode encoding, conversion
3140 is most likely done in a way that the reverse conversion
3141 results in the same text. When 'encoding' is not "utf-8" some
3142 characters may be lost!
Bram Moolenaar865242e2010-07-14 21:12:05 +02003143
Bram Moolenaar071d4272004-06-13 20:20:40 +00003144 See 'encoding' for the possible values. Additionally, values may be
3145 specified that can be handled by the converter, see
3146 |mbyte-conversion|.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003147
Bram Moolenaar071d4272004-06-13 20:20:40 +00003148 When reading a file 'fileencoding' will be set from 'fileencodings'.
3149 To read a file in a certain encoding it won't work by setting
Bram Moolenaar02467872007-05-06 13:22:01 +00003150 'fileencoding', use the |++enc| argument. One exception: when
3151 'fileencodings' is empty the value of 'fileencoding' is used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003152 For a new file the global value of 'fileencoding' is used.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003153
Bram Moolenaar071d4272004-06-13 20:20:40 +00003154 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
3155 When the option is set, the value is converted to lowercase. Thus
3156 you can set it with uppercase values too. '_' characters are
3157 replaced with '-'. If a name is recognized from the list for
3158 'encoding', it is replaced by the standard name. For example
3159 "ISO8859-2" becomes "iso-8859-2".
Bram Moolenaar865242e2010-07-14 21:12:05 +02003160
Bram Moolenaar071d4272004-06-13 20:20:40 +00003161 When this option is set, after starting to edit a file, the 'modified'
3162 option is set, because the file would be different when written.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003163
3164 Keep in mind that changing 'fenc' from a modeline happens
3165 AFTER the text has been read, thus it applies to when the file will be
3166 written. If you do set 'fenc' in a modeline, you might want to set
3167 'nomodified' to avoid not being able to ":q".
3168
Bram Moolenaar071d4272004-06-13 20:20:40 +00003169 This option can not be changed when 'modifiable' is off.
3170
3171 *'fe'*
3172 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003173 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003174 old short name was 'fe', which is no longer used.
3175
3176 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003177'fileencodings' 'fencs' string (default: "ucs-bom",
3178 "ucs-bom,utf-8,default,latin1" when
3179 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003180 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003181 This is a list of character encodings considered when starting to edit
3182 an existing file. When a file is read, Vim tries to use the first
3183 mentioned character encoding. If an error is detected, the next one
3184 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003185 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00003186 an empty string, which means the value of 'encoding' is used.
3187 WARNING: Conversion can cause loss of information! When
3188 'encoding' is "utf-8" (or one of the other Unicode variants)
3189 conversion is most likely done in a way that the reverse
3190 conversion results in the same text. When 'encoding' is not
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003191 "utf-8" some non-ASCII characters may be lost! You can use
3192 the |++bad| argument to specify what is done with characters
3193 that can't be converted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003194 For an empty file or a file with only ASCII characters most encodings
3195 will work and the first entry of 'fileencodings' will be used (except
3196 "ucs-bom", which requires the BOM to be present). If you prefer
3197 another encoding use an BufReadPost autocommand event to test if your
3198 preferred encoding is to be used. Example: >
3199 au BufReadPost * if search('\S', 'w') == 0 |
3200 \ set fenc=iso-2022-jp | endif
3201< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
3202 non-blank characters.
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003203 When the |++enc| argument is used then the value of 'fileencodings' is
3204 not used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003205 Note that 'fileencodings' is not used for a new file, the global value
3206 of 'fileencoding' is used instead. You can set it with: >
3207 :setglobal fenc=iso-8859-2
3208< This means that a non-existing file may get a different encoding than
3209 an empty file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003210 The special value "ucs-bom" can be used to check for a Unicode BOM
3211 (Byte Order Mark) at the start of the file. It must not be preceded
3212 by "utf-8" or another Unicode encoding for this to work properly.
3213 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
3214 because Vim cannot detect an error, thus the encoding is always
3215 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003216 The special value "default" can be used for the encoding from the
K.Takataef8706f2021-05-31 18:40:49 +02003217 environment. On MS-Windows this is the system encoding. Otherwise
3218 this is the default value for 'encoding'. It is useful when
3219 'encoding' is set to "utf-8" and your environment uses a non-latin1
3220 encoding, such as Russian.
Bram Moolenaarca003e12006-03-17 23:19:38 +00003221 When 'encoding' is "utf-8" and a file contains an illegal byte
3222 sequence it won't be recognized as UTF-8. You can use the |8g8|
3223 command to find the illegal byte sequence.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003224 WRONG VALUES: WHAT'S WRONG:
3225 latin1,utf-8 "latin1" will always be used
3226 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
3227 file
3228 cp1250,latin1 "cp1250" will always be used
3229 If 'fileencodings' is empty, 'fileencoding' is not modified.
3230 See 'fileencoding' for the possible values.
3231 Setting this option does not have an effect until the next time a file
3232 is read.
3233
3234 *'fileformat'* *'ff'*
Bram Moolenaar00590742019-02-15 21:06:09 +01003235'fileformat' 'ff' string (MS-Windows default: "dos",
3236 Unix, macOS default: "unix")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003237 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003238 This gives the <EOL> of the current buffer, which is used for
3239 reading/writing the buffer from/to a file:
Bram Moolenaar4072ba52020-12-23 13:56:35 +01003240 dos <CR><NL>
Bram Moolenaar071d4272004-06-13 20:20:40 +00003241 unix <NL>
3242 mac <CR>
3243 When "dos" is used, CTRL-Z at the end of a file is ignored.
3244 See |file-formats| and |file-read|.
3245 For the character encoding of the file see 'fileencoding'.
3246 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
Bram Moolenaarbf884932013-04-05 22:26:15 +02003247 works like it was set to "unix".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003248 This option is set automatically when starting to edit a file and
3249 'fileformats' is not empty and 'binary' is off.
3250 When this option is set, after starting to edit a file, the 'modified'
3251 option is set, because the file would be different when written.
3252 This option can not be changed when 'modifiable' is off.
3253 For backwards compatibility: When this option is set to "dos",
3254 'textmode' is set, otherwise 'textmode' is reset.
3255
3256 *'fileformats'* *'ffs'*
3257'fileformats' 'ffs' string (default:
Bram Moolenaar00590742019-02-15 21:06:09 +01003258 Vim+Vi MS-Windows: "dos,unix",
3259 Vim Unix, macOS: "unix,dos",
Bram Moolenaar071d4272004-06-13 20:20:40 +00003260 Vi Cygwin: "unix,dos",
3261 Vi others: "")
3262 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003263 This gives the end-of-line (<EOL>) formats that will be tried when
3264 starting to edit a new buffer and when reading a file into an existing
3265 buffer:
3266 - When empty, the format defined with 'fileformat' will be used
3267 always. It is not set automatically.
3268 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003269 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003270 'fileformats' name will be used when a file is read into an existing
3271 buffer, no matter what 'fileformat' for that buffer is set to.
3272 - When more than one name is present, separated by commas, automatic
3273 <EOL> detection will be done when reading a file. When starting to
3274 edit a file, a check is done for the <EOL>:
3275 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
3276 'fileformat' is set to "dos".
3277 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003278 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003279 preceding <CR>, "unix" is preferred over "dos".
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01003280 3. If 'fileformat' has not yet been set, and if a <CR> is found, and
3281 if 'fileformats' includes "mac", 'fileformat' is set to "mac".
Bram Moolenaar00659062010-09-21 22:34:02 +02003282 This means that "mac" is only chosen when:
3283 "unix" is not present or no <NL> is found in the file, and
3284 "dos" is not present or no <CR><NL> is found in the file.
3285 Except: if "unix" was chosen, but there is a <CR> before
3286 the first <NL>, and there appear to be more <CR>s than <NL>s in
Bram Moolenaar166af9b2010-11-16 20:34:40 +01003287 the first few lines, "mac" is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003288 4. If 'fileformat' is still not set, the first name from
3289 'fileformats' is used.
3290 When reading a file into an existing buffer, the same is done, but
3291 this happens like 'fileformat' has been set appropriately for that
3292 file only, the option is not changed.
3293 When 'binary' is set, the value of 'fileformats' is not used.
3294
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01003295 When Vim starts up with an empty buffer the first item is used. You
3296 can overrule this by setting 'fileformat' in your .vimrc.
Bram Moolenaar81af9252010-12-10 20:35:50 +01003297
Bram Moolenaar071d4272004-06-13 20:20:40 +00003298 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
3299 are ":source"ed and for vimrc files, automatic <EOL> detection may be
3300 done:
3301 - When 'fileformats' is empty, there is no automatic detection. Dos
3302 format will be used.
3303 - When 'fileformats' is set to one or more names, automatic detection
3304 is done. This is based on the first <NL> in the file: If there is a
3305 <CR> in front of it, Dos format is used, otherwise Unix format is
3306 used.
3307 Also see |file-formats|.
3308 For backwards compatibility: When this option is set to an empty
3309 string or one format (no comma is included), 'textauto' is reset,
3310 otherwise 'textauto' is set.
3311 NOTE: This option is set to the Vi default value when 'compatible' is
3312 set and to the Vim default value when 'compatible' is reset.
3313
Bram Moolenaarbf884932013-04-05 22:26:15 +02003314 *'fileignorecase'* *'fic'* *'nofileignorecase'* *'nofic'*
3315'fileignorecase' 'fic' boolean (default on for systems where case in file
3316 names is normally ignored)
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003317 global
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003318 When set case is ignored when using file names and directories.
3319 See 'wildignorecase' for only ignoring case when doing completion.
3320
Bram Moolenaar071d4272004-06-13 20:20:40 +00003321 *'filetype'* *'ft'*
3322'filetype' 'ft' string (default: "")
3323 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003324 When this option is set, the FileType autocommand event is triggered.
3325 All autocommands that match with the value of this option will be
3326 executed. Thus the value of 'filetype' is used in place of the file
3327 name.
3328 Otherwise this option does not always reflect the current file type.
3329 This option is normally set when the file type is detected. To enable
3330 this use the ":filetype on" command. |:filetype|
3331 Setting this option to a different value is most useful in a modeline,
3332 for a file for which the file type is not automatically recognized.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003333 Example, for in an IDL file:
3334 /* vim: set filetype=idl : */ ~
3335 |FileType| |filetypes|
3336 When a dot appears in the value then this separates two filetype
3337 names. Example:
3338 /* vim: set filetype=c.doxygen : */ ~
3339 This will use the "c" filetype first, then the "doxygen" filetype.
3340 This works both for filetype plugins and for syntax files. More than
3341 one dot may appear.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003342 This option is not copied to another buffer, independent of the 's' or
3343 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003344 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003345
3346 *'fillchars'* *'fcs'*
Bram Moolenaara98f8a22021-02-13 18:24:23 +01003347'fillchars' 'fcs' string (default "vert:|,fold:-,eob:~")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003348 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02003349 {not available when compiled without the |+folding|
3350 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003351 Characters to fill the statuslines and vertical separators.
3352 It is a comma separated list of items:
3353
3354 item default Used for ~
3355 stl:c ' ' or '^' statusline of the current window
Bram Moolenaar38a55632016-02-15 22:07:32 +01003356 stlnc:c ' ' or '=' statusline of the non-current windows
Bram Moolenaar071d4272004-06-13 20:20:40 +00003357 vert:c '|' vertical separators |:vsplit|
3358 fold:c '-' filling 'foldtext'
Bram Moolenaar3aca5a62021-02-17 13:14:07 +01003359 foldopen:c '-' mark the beginning of a fold
3360 foldclose:c '+' show a closed fold
3361 foldsep:c '|' open fold middle character
Bram Moolenaar071d4272004-06-13 20:20:40 +00003362 diff:c '-' deleted lines of the 'diff' option
Bram Moolenaara98f8a22021-02-13 18:24:23 +01003363 eob:c '~' empty lines below the end of a buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003364
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003365 Any one that is omitted will fall back to the default. For "stl" and
Bram Moolenaar38a55632016-02-15 22:07:32 +01003366 "stlnc" the space will be used when there is highlighting, '^' or '='
Bram Moolenaar071d4272004-06-13 20:20:40 +00003367 otherwise.
3368
3369 Example: >
Bram Moolenaar38a55632016-02-15 22:07:32 +01003370 :set fillchars=stl:^,stlnc:=,vert:\|,fold:-,diff:-
Bram Moolenaar071d4272004-06-13 20:20:40 +00003371< This is similar to the default, except that these characters will also
3372 be used when there is highlighting.
3373
Bram Moolenaar008bff92021-03-04 21:55:58 +01003374 For "stl" and "stlnc" single-byte and multibyte characters are
3375 supported. But double-width characters are not supported.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003376
Bram Moolenaar071d4272004-06-13 20:20:40 +00003377 The highlighting used for these items:
3378 item highlight group ~
3379 stl:c StatusLine |hl-StatusLine|
3380 stlnc:c StatusLineNC |hl-StatusLineNC|
3381 vert:c VertSplit |hl-VertSplit|
3382 fold:c Folded |hl-Folded|
3383 diff:c DiffDelete |hl-DiffDelete|
Bram Moolenaara98f8a22021-02-13 18:24:23 +01003384 eob:c EndOfBuffer |hl-EndOfBuffer|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003385
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003386 *'fixendofline'* *'fixeol'* *'nofixendofline'* *'nofixeol'*
3387'fixendofline' 'fixeol' boolean (default on)
3388 local to buffer
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003389 When writing a file and this option is on, <EOL> at the end of file
3390 will be restored if missing. Turn this option off if you want to
3391 preserve the situation from the original file.
3392 When the 'binary' option is set the value of this option doesn't
3393 matter.
3394 See the 'endofline' option.
3395
Bram Moolenaar071d4272004-06-13 20:20:40 +00003396 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
Bram Moolenaar98a29d02021-01-18 19:55:44 +01003397'fkmap' 'fk' boolean (default off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003398 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003399 {only available when compiled with the |+rightleft|
3400 feature}
Bram Moolenaar14184a32019-02-16 15:10:30 +01003401 This option was for using Farsi, which has been removed. See
3402 |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003403
3404 *'foldclose'* *'fcl'*
3405'foldclose' 'fcl' string (default "")
3406 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003407 {not available when compiled without the |+folding|
3408 feature}
3409 When set to "all", a fold is closed when the cursor isn't in it and
3410 its level is higher than 'foldlevel'. Useful if you want folds to
3411 automatically close when moving out of them.
3412
3413 *'foldcolumn'* *'fdc'*
3414'foldcolumn' 'fdc' number (default 0)
3415 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003416 {not available when compiled without the |+folding|
3417 feature}
3418 When non-zero, a column with the specified width is shown at the side
3419 of the window which indicates open and closed folds. The maximum
3420 value is 12.
3421 See |folding|.
3422
3423 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
3424'foldenable' 'fen' boolean (default on)
3425 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003426 {not available when compiled without the |+folding|
3427 feature}
3428 When off, all folds are open. This option can be used to quickly
3429 switch between showing all text unfolded and viewing the text with
3430 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003431 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00003432 'foldenable' is off.
3433 This option is set by commands that create a new fold or close a fold.
3434 See |folding|.
3435
3436 *'foldexpr'* *'fde'*
3437'foldexpr' 'fde' string (default: "0")
3438 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003439 {not available when compiled without the |+folding|
Bram Moolenaardb84e452010-08-15 13:50:43 +02003440 or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003441 The expression used for when 'foldmethod' is "expr". It is evaluated
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003442 for each line to obtain its fold level. See |fold-expr|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003443
Bram Moolenaar30b65812012-07-12 22:01:11 +02003444 The expression will be evaluated in the |sandbox| if set from a
3445 modeline, see |sandbox-option|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003446 This option can't be set from a |modeline| when the 'diff' option is
Bram Moolenaar110289e2019-05-23 15:38:06 +02003447 on or the 'modelineexpr' option is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003448
3449 It is not allowed to change text or jump to another window while
3450 evaluating 'foldexpr' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003451
3452 *'foldignore'* *'fdi'*
3453'foldignore' 'fdi' string (default: "#")
3454 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003455 {not available when compiled without the |+folding|
3456 feature}
3457 Used only when 'foldmethod' is "indent". Lines starting with
3458 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003459 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003460 The default "#" works well for C programs. See |fold-indent|.
3461
3462 *'foldlevel'* *'fdl'*
3463'foldlevel' 'fdl' number (default: 0)
3464 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003465 {not available when compiled without the |+folding|
3466 feature}
3467 Sets the fold level: Folds with a higher level will be closed.
3468 Setting this option to zero will close all folds. Higher numbers will
3469 close fewer folds.
3470 This option is set by commands like |zm|, |zM| and |zR|.
3471 See |fold-foldlevel|.
3472
3473 *'foldlevelstart'* *'fdls'*
3474'foldlevelstart' 'fdls' number (default: -1)
3475 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003476 {not available when compiled without the |+folding|
3477 feature}
3478 Sets 'foldlevel' when starting to edit another buffer in a window.
3479 Useful to always start editing with all folds closed (value zero),
3480 some folds closed (one) or no folds closed (99).
3481 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003482 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00003483 ignores this option and closes all folds.
3484 It is also done before BufReadPre autocommands, to allow an autocmd to
3485 overrule the 'foldlevel' value for specific files.
3486 When the value is negative, it is not used.
3487
3488 *'foldmarker'* *'fmr'* *E536*
3489'foldmarker' 'fmr' string (default: "{{{,}}}")
3490 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003491 {not available when compiled without the |+folding|
3492 feature}
3493 The start and end marker used when 'foldmethod' is "marker". There
3494 must be one comma, which separates the start and end marker. The
3495 marker is a literal string (a regular expression would be too slow).
3496 See |fold-marker|.
3497
3498 *'foldmethod'* *'fdm'*
3499'foldmethod' 'fdm' string (default: "manual")
3500 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003501 {not available when compiled without the |+folding|
3502 feature}
3503 The kind of folding used for the current window. Possible values:
3504 |fold-manual| manual Folds are created manually.
3505 |fold-indent| indent Lines with equal indent form a fold.
3506 |fold-expr| expr 'foldexpr' gives the fold level of a line.
3507 |fold-marker| marker Markers are used to specify folds.
3508 |fold-syntax| syntax Syntax highlighting items specify folds.
3509 |fold-diff| diff Fold text that is not changed.
3510
3511 *'foldminlines'* *'fml'*
3512'foldminlines' 'fml' number (default: 1)
3513 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003514 {not available when compiled without the |+folding|
3515 feature}
Bram Moolenaar00654022011-02-25 14:42:19 +01003516 Sets the number of screen lines above which a fold can be displayed
3517 closed. Also for manually closed folds. With the default value of
3518 one a fold can only be closed if it takes up two or more screen lines.
3519 Set to zero to be able to close folds of just one screen line.
Bram Moolenaar446beb42011-05-10 17:18:44 +02003520 Note that this only has an effect on what is displayed. After using
Bram Moolenaar071d4272004-06-13 20:20:40 +00003521 "zc" to close a fold, which is displayed open because it's smaller
3522 than 'foldminlines', a following "zc" may close a containing fold.
3523
3524 *'foldnestmax'* *'fdn'*
3525'foldnestmax' 'fdn' number (default: 20)
3526 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003527 {not available when compiled without the |+folding|
3528 feature}
3529 Sets the maximum nesting of folds for the "indent" and "syntax"
3530 methods. This avoids that too many folds will be created. Using more
3531 than 20 doesn't work, because the internal limit is 20.
3532
3533 *'foldopen'* *'fdo'*
3534'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
3535 search,tag,undo")
3536 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003537 {not available when compiled without the |+folding|
3538 feature}
3539 Specifies for which type of commands folds will be opened, if the
3540 command moves the cursor into a closed fold. It is a comma separated
3541 list of items.
Bram Moolenaar05365702010-10-27 18:34:44 +02003542 NOTE: When the command is part of a mapping this option is not used.
3543 Add the |zv| command to the mapping to get the same effect.
3544 (rationale: the mapping may want to control opening folds itself)
3545
Bram Moolenaar071d4272004-06-13 20:20:40 +00003546 item commands ~
3547 all any
3548 block "(", "{", "[[", "[{", etc.
3549 hor horizontal movements: "l", "w", "fx", etc.
3550 insert any command in Insert mode
3551 jump far jumps: "G", "gg", etc.
3552 mark jumping to a mark: "'m", CTRL-O, etc.
3553 percent "%"
3554 quickfix ":cn", ":crew", ":make", etc.
3555 search search for a pattern: "/", "n", "*", "gd", etc.
3556 (not for a search pattern in a ":" command)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003557 Also for |[s| and |]s|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003558 tag jumping to a tag: ":ta", CTRL-T, etc.
3559 undo undo or redo: "u" and CTRL-R
Bram Moolenaar071d4272004-06-13 20:20:40 +00003560 When a movement command is used for an operator (e.g., "dl" or "y%")
3561 this option is not used. This means the operator will include the
3562 whole closed fold.
3563 Note that vertical movements are not here, because it would make it
3564 very difficult to move onto a closed fold.
3565 In insert mode the folds containing the cursor will always be open
3566 when text is inserted.
3567 To close folds you can re-apply 'foldlevel' with the |zx| command or
3568 set the 'foldclose' option to "all".
3569
3570 *'foldtext'* *'fdt'*
3571'foldtext' 'fdt' string (default: "foldtext()")
3572 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003573 {not available when compiled without the |+folding|
3574 feature}
3575 An expression which is used to specify the text displayed for a closed
3576 fold. See |fold-foldtext|.
3577
Bram Moolenaar30b65812012-07-12 22:01:11 +02003578 The expression will be evaluated in the |sandbox| if set from a
3579 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003580 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003581
3582 It is not allowed to change text or jump to another window while
3583 evaluating 'foldtext' |textlock|.
3584
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003585 *'formatexpr'* *'fex'*
3586'formatexpr' 'fex' string (default "")
3587 local to buffer
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003588 {not available when compiled without the |+eval|
3589 feature}
3590 Expression which is evaluated to format a range of lines for the |gq|
3591 operator or automatic formatting (see 'formatoptions'). When this
3592 option is empty 'formatprg' is used.
3593
3594 The |v:lnum| variable holds the first line to be formatted.
3595 The |v:count| variable holds the number of lines to be formatted.
3596 The |v:char| variable holds the character that is going to be
3597 inserted if the expression is being evaluated due to
3598 automatic formatting. This can be empty. Don't insert
3599 it yet!
3600
3601 Example: >
3602 :set formatexpr=mylang#Format()
3603< This will invoke the mylang#Format() function in the
3604 autoload/mylang.vim file in 'runtimepath'. |autoload|
3605
3606 The expression is also evaluated when 'textwidth' is set and adding
3607 text beyond that limit. This happens under the same conditions as
3608 when internal formatting is used. Make sure the cursor is kept in the
3609 same spot relative to the text then! The |mode()| function will
3610 return "i" or "R" in this situation.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01003611
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003612 When the expression evaluates to non-zero Vim will fall back to using
3613 the internal format mechanism.
3614
Yegappan Lakshmanan8bb65f22021-12-26 10:51:39 +00003615 If the expression starts with s: or |<SID>|, then it is replaced with
3616 the script ID (|local-function|). Example: >
3617 set formatexpr=s:MyFormatExpr()
3618 set formatexpr=<SID>SomeFormatExpr()
3619<
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003620 The expression will be evaluated in the |sandbox| when set from a
3621 modeline, see |sandbox-option|. That stops the option from working,
3622 since changing the buffer text is not allowed.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003623 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaar036986f2017-03-16 17:41:02 +01003624 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003625
Bram Moolenaar86b68352004-12-27 21:59:20 +00003626 *'formatlistpat'* *'flp'*
3627'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
3628 local to buffer
Bram Moolenaar86b68352004-12-27 21:59:20 +00003629 A pattern that is used to recognize a list header. This is used for
3630 the "n" flag in 'formatoptions'.
3631 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00003632 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00003633 while still checking more characters. There must be a character
3634 following the pattern, when it matches the whole line it is handled
3635 like there is no match.
3636 The default recognizes a number, followed by an optional punctuation
3637 character and white space.
3638
Bram Moolenaar6c60f472019-04-28 16:00:35 +02003639 *'formatoptions'* *'fo'*
3640'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
3641 local to buffer
3642 This is a sequence of letters which describes how automatic
3643 formatting is to be done. See |fo-table|. When the 'paste' option is
3644 on, no formatting is done (like 'formatoptions' is empty). Commas can
3645 be inserted for readability.
3646 To avoid problems with flags that are added in the future, use the
3647 "+=" and "-=" feature of ":set" |add-option-flags|.
3648 NOTE: This option is set to the Vi default value when 'compatible' is
3649 set and to the Vim default value when 'compatible' is reset.
3650
Bram Moolenaar071d4272004-06-13 20:20:40 +00003651 *'formatprg'* *'fp'*
3652'formatprg' 'fp' string (default "")
Bram Moolenaar9be7c042017-01-14 14:28:30 +01003653 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003654 The name of an external program that will be used to format the lines
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003655 selected with the |gq| operator. The program must take the input on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003656 stdin and produce the output on stdout. The Unix program "fmt" is
Bram Moolenaara5792f52005-11-23 21:25:05 +00003657 such a program.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003658 If the 'formatexpr' option is not empty it will be used instead.
3659 Otherwise, if 'formatprg' option is an empty string, the internal
3660 format function will be used |C-indenting|.
Bram Moolenaara5792f52005-11-23 21:25:05 +00003661 Environment variables are expanded |:set_env|. See |option-backslash|
3662 about including spaces and backslashes.
Bram Moolenaar30b65812012-07-12 22:01:11 +02003663 This option cannot be set from a |modeline| or in the |sandbox|, for
3664 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003665
Bram Moolenaard94464e2015-11-02 15:28:18 +01003666 *'fsync'* *'fs'* *'nofsync'* *'nofs'*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003667'fsync' 'fs' boolean (default on)
3668 global
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003669 When on, the library function fsync() will be called after writing a
3670 file. This will flush a file to disk, ensuring that it is safely
3671 written even on filesystems which do metadata-only journaling. This
3672 will force the harddrive to spin up on Linux systems running in laptop
3673 mode, so it may be undesirable in some situations. Be warned that
3674 turning this off increases the chances of data loss after a crash. On
3675 systems without an fsync() implementation, this variable is always
3676 off.
3677 Also see 'swapsync' for controlling fsync() on swap files.
Bram Moolenaar340dd0f2021-10-14 17:52:23 +01003678 'fsync' also applies to |writefile()| (unless a flag is used to
3679 overrule it) and when writing undo files (see |undo-persistence|).
Bram Moolenaar110289e2019-05-23 15:38:06 +02003680 This option cannot be set from a |modeline| or in the |sandbox|, for
3681 security reasons.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003682
Bram Moolenaar071d4272004-06-13 20:20:40 +00003683 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
3684'gdefault' 'gd' boolean (default off)
3685 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003686 When on, the ":substitute" flag 'g' is default on. This means that
3687 all matches in a line are substituted instead of one. When a 'g' flag
3688 is given to a ":substitute" command, this will toggle the substitution
3689 of all or one match. See |complex-change|.
3690
3691 command 'gdefault' on 'gdefault' off ~
3692 :s/// subst. all subst. one
3693 :s///g subst. one subst. all
3694 :s///gg subst. all subst. one
3695
3696 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar21020352017-06-13 17:21:04 +02003697 DEPRECATED: Setting this option may break plugins that are not aware
3698 of this option. Also, many users get confused that adding the /g flag
3699 has the opposite effect of that it normally does.
Bram Moolenaar4072ba52020-12-23 13:56:35 +01003700 This option is not used in |Vim9| script.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003701
3702 *'grepformat'* *'gfm'*
Bram Moolenaar6e932462014-09-09 18:48:09 +02003703'grepformat' 'gfm' string (default "%f:%l:%m,%f:%l%m,%f %l%m")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003704 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003705 Format to recognize for the ":grep" command output.
3706 This is a scanf-like string that uses the same format as the
3707 'errorformat' option: see |errorformat|.
3708
3709 *'grepprg'* *'gp'*
3710'grepprg' 'gp' string (default "grep -n ",
3711 Unix: "grep -n $* /dev/null",
3712 Win32: "findstr /n" or "grep -n",
3713 VMS: "SEARCH/NUMBERS ")
3714 global or local to buffer |global-local|
Bram Moolenaar582fd852005-03-28 20:58:01 +00003715 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003716 and '#' characters, which are expanded like when used in a command-
3717 line. The placeholder "$*" is allowed to specify where the arguments
3718 will be included. Environment variables are expanded |:set_env|. See
3719 |option-backslash| about including spaces and backslashes.
3720 When your "grep" accepts the "-H" argument, use this to make ":grep"
3721 also work well with a single file: >
3722 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00003723< Special value: When 'grepprg' is set to "internal" the |:grep| command
Bram Moolenaara6557602006-02-04 22:43:20 +00003724 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like
3725 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00003726 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00003727 apply equally to 'grepprg'.
3728 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
3729 otherwise it's "grep -n".
3730 This option cannot be set from a |modeline| or in the |sandbox|, for
3731 security reasons.
3732
3733 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
3734'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
3735 ve:ver35-Cursor,
3736 o:hor50-Cursor,
3737 i-ci:ver25-Cursor/lCursor,
3738 r-cr:hor20-Cursor/lCursor,
3739 sm:block-Cursor
3740 -blinkwait175-blinkoff150-blinkon175",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003741 for Win32 console:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003742 "n-v-c:block,o:hor50,i-ci:hor15,
3743 r-cr:hor30,sm:block")
3744 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003745 {only available when compiled with GUI enabled, and
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003746 for Win32 console}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003747 This option tells Vim what the cursor should look like in different
Bram Moolenaar8024f932020-01-14 19:29:13 +01003748 modes. It fully works in the GUI. In a Win32 console, only the
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003749 height of the cursor can be changed. This can be done by specifying a
3750 block cursor, or a percentage for a vertical or horizontal cursor.
Bram Moolenaar1e7813a2015-03-31 18:31:03 +02003751 For a console the 't_SI', 't_SR', and 't_EI' escape sequences are
3752 used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003753
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003754 The option is a comma separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003755 mode-list and an argument-list:
3756 mode-list:argument-list,mode-list:argument-list,..
3757 The mode-list is a dash separated list of these modes:
3758 n Normal mode
3759 v Visual mode
3760 ve Visual mode with 'selection' "exclusive" (same as 'v',
3761 if not specified)
3762 o Operator-pending mode
3763 i Insert mode
3764 r Replace mode
3765 c Command-line Normal (append) mode
3766 ci Command-line Insert mode
3767 cr Command-line Replace mode
3768 sm showmatch in Insert mode
3769 a all modes
3770 The argument-list is a dash separated list of these arguments:
3771 hor{N} horizontal bar, {N} percent of the character height
3772 ver{N} vertical bar, {N} percent of the character width
3773 block block cursor, fills the whole character
3774 [only one of the above three should be present]
3775 blinkwait{N} *cursor-blinking*
3776 blinkon{N}
3777 blinkoff{N}
3778 blink times for cursor: blinkwait is the delay before
3779 the cursor starts blinking, blinkon is the time that
3780 the cursor is shown and blinkoff is the time that the
3781 cursor is not shown. The times are in msec. When one
3782 of the numbers is zero, there is no blinking. The
3783 default is: "blinkwait700-blinkon400-blinkoff250".
3784 These numbers are used for a missing entry. This
3785 means that blinking is enabled by default. To switch
3786 blinking off you can use "blinkon0". The cursor only
3787 blinks when Vim is waiting for input, not while
3788 executing a command.
3789 To make the cursor blink in an xterm, see
3790 |xterm-blink|.
3791 {group-name}
3792 a highlight group name, that sets the color and font
3793 for the cursor
3794 {group-name}/{group-name}
3795 Two highlight group names, the first is used when
3796 no language mappings are used, the other when they
3797 are. |language-mapping|
3798
3799 Examples of parts:
3800 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
3801 block cursor with colors from the "nCursor"
3802 highlight group
3803 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
3804 In Insert and Command-line Insert mode, use a
3805 30% vertical bar cursor with colors from the
3806 "iCursor" highlight group. Blink a bit
3807 faster.
3808
3809 The 'a' mode is different. It will set the given argument-list for
3810 all modes. It does not reset anything to defaults. This can be used
3811 to do a common setting for all modes. For example, to switch off
3812 blinking: "a:blinkon0"
3813
3814 Examples of cursor highlighting: >
3815 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
3816 :highlight Cursor gui=NONE guifg=bg guibg=fg
3817<
3818 *'guifont'* *'gfn'*
Bram Moolenaar251e1912011-06-19 05:09:16 +02003819 *E235* *E596*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003820'guifont' 'gfn' string (default "")
3821 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003822 {only available when compiled with GUI enabled}
3823 This is a list of fonts which will be used for the GUI version of Vim.
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003824 In its simplest form the value is just one font name.
3825 See |gui-font| for the details.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003826
3827 *'guifontset'* *'gfs'*
3828 *E250* *E252* *E234* *E597* *E598*
3829'guifontset' 'gfs' string (default "")
3830 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003831 {only available when compiled with GUI enabled and
3832 with the |+xfontset| feature}
Bram Moolenaar3df01732017-02-17 22:47:16 +01003833 {not available in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003834 When not empty, specifies two (or more) fonts to be used. The first
3835 one for normal English, the second one for your special language. See
3836 |xfontset|.
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003837
Bram Moolenaar071d4272004-06-13 20:20:40 +00003838 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
3839'guifontwide' 'gfw' string (default "")
3840 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003841 {only available when compiled with GUI enabled}
3842 When not empty, specifies a comma-separated list of fonts to be used
3843 for double-width characters. The first font that can be loaded is
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003844 used. See |gui-fontwide|.
Bram Moolenaar0f272122013-01-23 18:37:40 +01003845
Bram Moolenaar071d4272004-06-13 20:20:40 +00003846 *'guiheadroom'* *'ghr'*
3847'guiheadroom' 'ghr' number (default 50)
3848 global
Bram Moolenaar110289e2019-05-23 15:38:06 +02003849 {only for GTK and X11 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003850 The number of pixels subtracted from the screen height when fitting
3851 the GUI window on the screen. Set this before the GUI is started,
3852 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003853 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00003854 lines will be left for window decorations and other items on the
3855 screen. Set it to a negative value to allow windows taller than the
3856 screen.
3857
Dusan Popovic4eeedc02021-10-16 20:52:05 +01003858 *'guiligatures'* *'gli'* *E1243*
3859'guiligatures' 'gli' string (default "")
3860 global
3861 {only for GTK GUI}
3862 List of ASCII characters that, when combined together, can create more
3863 complex shapes. Each character must be a printable ASCII character
3864 with a value in the 32-127 range.
3865 Example: >
3866 :set guiligatures=!\"#$%&()*+-./:<=>?@[]^_{\|~
3867< Changing this option updates screen output immediately. Set it to an
3868 empty string to disable ligatures.
3869
Bram Moolenaar071d4272004-06-13 20:20:40 +00003870 *'guioptions'* *'go'*
Bram Moolenaar2c64ca12018-10-19 16:22:31 +02003871'guioptions' 'go' string (default "egmrLtT" (MS-Windows,
3872 "t" is removed in |defaults.vim|),
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02003873 "aegimrLtT" (GTK, Motif and Athena),
3874 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00003875 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003876 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00003877 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003878 sequence of letters which describes what components and options of the
3879 GUI should be used.
3880 To avoid problems with flags that are added in the future, use the
3881 "+=" and "-=" feature of ":set" |add-option-flags|.
3882
Bram Moolenaar13568252018-03-16 20:46:58 +01003883 Valid characters are as follows:
3884 *'go-!'*
3885 '!' External commands are executed in a terminal window. Without
3886 this flag the MS-Windows GUI will open a console window to
3887 execute the command. The Unix GUI will simulate a dumb
3888 terminal to list the command output.
3889 The terminal window will be positioned at the bottom, and grow
3890 upwards as needed.
Bram Moolenaarba3ff532018-11-04 14:45:49 +01003891 *'go-a'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003892 'a' Autoselect: If present, then whenever VISUAL mode is started,
3893 or the Visual area extended, Vim tries to become the owner of
3894 the windowing system's global selection. This means that the
3895 Visually highlighted text is available for pasting into other
3896 applications as well as into Vim itself. When the Visual mode
3897 ends, possibly due to an operation on the text, or when an
3898 application wants to paste the selection, the highlighted text
3899 is automatically yanked into the "* selection register.
3900 Thus the selection is still available for pasting into other
3901 applications after the VISUAL mode has ended.
3902 If not present, then Vim won't become the owner of the
3903 windowing system's global selection unless explicitly told to
3904 by a yank or delete operation for the "* register.
3905 The same applies to the modeless selection.
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02003906 *'go-P'*
3907 'P' Like autoselect but using the "+ register instead of the "*
Bram Moolenaar3848e002016-03-19 18:42:29 +01003908 register.
Bram Moolenaar02467872007-05-06 13:22:01 +00003909 *'go-A'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003910 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003911 applies to the modeless selection.
3912
3913 'guioptions' autoselect Visual autoselect modeless ~
3914 "" - -
3915 "a" yes yes
3916 "A" - yes
3917 "aA" yes yes
3918
Bram Moolenaar02467872007-05-06 13:22:01 +00003919 *'go-c'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003920 'c' Use console dialogs instead of popup dialogs for simple
3921 choices.
Bram Moolenaar50bf7ce2019-09-15 13:17:00 +02003922 *'go-d'*
3923 'd' Use dark theme variant if available. Currently only works for
3924 GTK+ GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00003925 *'go-e'*
Bram Moolenaare224ffa2006-03-01 00:01:28 +00003926 'e' Add tab pages when indicated with 'showtabline'.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003927 'guitablabel' can be used to change the text in the labels.
3928 When 'e' is missing a non-GUI tab pages line may be used.
Bram Moolenaard68071d2006-05-02 22:08:30 +00003929 The GUI tabs are only supported on some systems, currently
Bram Moolenaarb3f74062020-02-26 16:16:53 +01003930 GTK, Motif, Mac OS/X, Haiku, and MS-Windows.
Bram Moolenaar02467872007-05-06 13:22:01 +00003931 *'go-f'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003932 'f' Foreground: Don't use fork() to detach the GUI from the shell
3933 where it was started. Use this for programs that wait for the
3934 editor to finish (e.g., an e-mail program). Alternatively you
3935 can use "gvim -f" or ":gui -f" to start the GUI in the
3936 foreground. |gui-fork|
3937 Note: Set this option in the vimrc file. The forking may have
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003938 happened already when the |gvimrc| file is read.
Bram Moolenaar02467872007-05-06 13:22:01 +00003939 *'go-i'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003940 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
3941 corner of the window. It's black&white on non-GTK, because of
3942 limitations of X11. For a color icon, see |X11-icon|.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003943 *'go-m'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003944 'm' Menu bar is present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003945 *'go-M'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003946 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00003947 that this flag must be added in the .vimrc file, before
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003948 switching on syntax or filetype recognition (when the |gvimrc|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003949 file is sourced the system menu has already been loaded; the
Bram Moolenaar01164a62017-11-02 22:58:42 +01003950 `:syntax on` and `:filetype on` commands load the menu too).
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003951 *'go-g'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003952 'g' Grey menu items: Make menu items that are not active grey. If
3953 'g' is not included inactive menu items are not shown at all.
3954 Exception: Athena will always use grey menu items.
Bram Moolenaar02467872007-05-06 13:22:01 +00003955 *'go-t'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003956 't' Include tearoff menu items. Currently only works for Win32,
3957 GTK+, and Motif 1.2 GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00003958 *'go-T'*
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00003959 'T' Include Toolbar. Currently only in Win32, GTK+, Motif, Photon
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00003960 and Athena GUIs.
Bram Moolenaar02467872007-05-06 13:22:01 +00003961 *'go-r'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003962 'r' Right-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003963 *'go-R'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003964 'R' Right-hand scrollbar is present when there is a vertically
3965 split window.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003966 *'go-l'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003967 'l' Left-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003968 *'go-L'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003969 'L' Left-hand scrollbar is present when there is a vertically
3970 split window.
Bram Moolenaar02467872007-05-06 13:22:01 +00003971 *'go-b'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003972 'b' Bottom (horizontal) scrollbar is present. Its size depends on
3973 the longest visible line, or on the cursor line if the 'h'
3974 flag is included. |gui-horiz-scroll|
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003975 *'go-h'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003976 'h' Limit horizontal scrollbar size to the length of the cursor
3977 line. Reduces computations. |gui-horiz-scroll|
3978
3979 And yes, you may even have scrollbars on the left AND the right if
3980 you really want to :-). See |gui-scrollbars| for more information.
3981
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003982 *'go-v'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003983 'v' Use a vertical button layout for dialogs. When not included,
3984 a horizontal layout is preferred, but when it doesn't fit a
Bram Moolenaardad44732021-03-31 20:07:33 +02003985 vertical layout is used anyway. Not supported in GTK 3.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003986 *'go-p'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003987 'p' Use Pointer callbacks for X11 GUI. This is required for some
3988 window managers. If the cursor is not blinking or hollow at
3989 the right moment, try adding this flag. This must be done
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003990 before starting the GUI. Set it in your |gvimrc|. Adding or
Bram Moolenaar071d4272004-06-13 20:20:40 +00003991 removing it after the GUI has started has no effect.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003992 *'go-F'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003993 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar8ac44152017-11-09 18:33:29 +01003994 *'go-k'*
3995 'k' Keep the GUI window size when adding/removing a scrollbar, or
3996 toolbar, tabline, etc. Instead, the behavior is similar to
3997 when the window is maximized and will adjust 'lines' and
3998 'columns' to fit to the window. Without the 'k' flag Vim will
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003999 try to keep 'lines' and 'columns' the same when adding and
Bram Moolenaar8ac44152017-11-09 18:33:29 +01004000 removing GUI components.
Bram Moolenaar02467872007-05-06 13:22:01 +00004001
Bram Moolenaar071d4272004-06-13 20:20:40 +00004002 *'guipty'* *'noguipty'*
4003'guipty' boolean (default on)
4004 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004005 {only available when compiled with GUI enabled}
4006 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
4007 I/O to/from shell commands. See |gui-pty|.
4008
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004009 *'guitablabel'* *'gtl'*
4010'guitablabel' 'gtl' string (default empty)
4011 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02004012 {only available when compiled with GUI enabled}
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004013 When nonempty describes the text to use in a label of the GUI tab
Bram Moolenaard68071d2006-05-02 22:08:30 +00004014 pages line. When empty and when the result is empty Vim will use a
4015 default label. See |setting-guitablabel| for more info.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004016
Bram Moolenaara23ccb82006-02-27 00:08:02 +00004017 The format of this option is like that of 'statusline'.
Bram Moolenaar57657d82006-04-21 22:12:41 +00004018 'guitabtooltip' is used for the tooltip, see below.
Bram Moolenaar51628222016-12-01 23:03:28 +01004019 The expression will be evaluated in the |sandbox| when set from a
4020 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004021 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00004022
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004023 Only used when the GUI tab pages line is displayed. 'e' must be
4024 present in 'guioptions'. For the non-GUI tab pages line 'tabline' is
4025 used.
4026
Bram Moolenaar57657d82006-04-21 22:12:41 +00004027 *'guitabtooltip'* *'gtt'*
4028'guitabtooltip' 'gtt' string (default empty)
4029 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02004030 {only available when compiled with GUI enabled}
Bram Moolenaar57657d82006-04-21 22:12:41 +00004031 When nonempty describes the text to use in a tooltip for the GUI tab
4032 pages line. When empty Vim will use a default tooltip.
4033 This option is otherwise just like 'guitablabel' above.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004034 You can include a line break. Simplest method is to use |:let|: >
4035 :let &guitabtooltip = "line one\nline two"
4036<
Bram Moolenaar57657d82006-04-21 22:12:41 +00004037
Bram Moolenaar071d4272004-06-13 20:20:40 +00004038 *'helpfile'* *'hf'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01004039'helpfile' 'hf' string (default (MS-Windows) "$VIMRUNTIME\doc\help.txt"
Bram Moolenaar071d4272004-06-13 20:20:40 +00004040 (others) "$VIMRUNTIME/doc/help.txt")
4041 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004042 Name of the main help file. All distributed help files should be
4043 placed together in one directory. Additionally, all "doc" directories
4044 in 'runtimepath' will be used.
4045 Environment variables are expanded |:set_env|. For example:
4046 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004047 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00004048 spaces and backslashes.
4049 This option cannot be set from a |modeline| or in the |sandbox|, for
4050 security reasons.
4051
4052 *'helpheight'* *'hh'*
4053'helpheight' 'hh' number (default 20)
4054 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004055 Minimal initial height of the help window when it is opened with the
4056 ":help" command. The initial height of the help window is half of the
4057 current window, or (when the 'ea' option is on) the same as other
4058 windows. When the height is less than 'helpheight', the height is
4059 set to 'helpheight'. Set to zero to disable.
4060
4061 *'helplang'* *'hlg'*
4062'helplang' 'hlg' string (default: messages language or empty)
4063 global
4064 {only available when compiled with the |+multi_lang|
4065 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004066 Comma separated list of languages. Vim will use the first language
4067 for which the desired help can be found. The English help will always
4068 be used as a last resort. You can add "en" to prefer English over
4069 another language, but that will only find tags that exist in that
4070 language and not in the English help.
4071 Example: >
4072 :set helplang=de,it
4073< This will first search German, then Italian and finally English help
4074 files.
4075 When using |CTRL-]| and ":help!" in a non-English help file Vim will
4076 try to find the tag in the current language before using this option.
4077 See |help-translated|.
4078
4079 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
4080'hidden' 'hid' boolean (default off)
4081 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004082 When off a buffer is unloaded when it is |abandon|ed. When on a
4083 buffer becomes hidden when it is |abandon|ed. If the buffer is still
4084 displayed in another window, it does not become hidden, of course.
4085 The commands that move through the buffer list sometimes make a buffer
4086 hidden although the 'hidden' option is off: When the buffer is
4087 modified, 'autowrite' is off or writing is not possible, and the '!'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004088 flag was used. See also |windows.txt|.
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004089 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004090 This option is set for one command with ":hide {command}" |:hide|.
4091 WARNING: It's easy to forget that you have changes in hidden buffers.
4092 Think twice when using ":q!" or ":qa!".
4093
4094 *'highlight'* *'hl'*
4095'highlight' 'hl' string (default (as a single string):
Bram Moolenaar58b85342016-08-14 19:54:54 +02004096 "8:SpecialKey,~:EndOfBuffer,@:NonText,
4097 d:Directory,e:ErrorMsg,i:IncSearch,
4098 l:Search,m:MoreMsg,M:ModeMsg,n:LineNr,
Bram Moolenaarefae76a2019-10-27 22:54:58 +01004099 a:LineNrAbove,b:LineNrBelow,
Bram Moolenaar58b85342016-08-14 19:54:54 +02004100 N:CursorLineNr,r:Question,s:StatusLine,
4101 S:StatusLineNC,c:VertSplit,t:Title,
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004102 v:Visual,V:VisualNOS,w:WarningMsg,
4103 W:WildMenu,f:Folded,F:FoldColumn,
4104 A:DiffAdd,C:DiffChange,D:DiffDelete,
4105 T:DiffText,>:SignColumn,-:Conceal,
Bram Moolenaarc8c88492018-12-27 23:59:26 +01004106 B:SpellBad,P:SpellCap,R:SpellRare,
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004107 L:SpellLocal,+:Pmenu,=:PmenuSel,
Bram Moolenaar21020352017-06-13 17:21:04 +02004108 x:PmenuSbar,X:PmenuThumb,*:TabLine,
4109 #:TabLineSel,_:TabLineFill,!:CursorColumn,
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02004110 .:CursorLine,o:ColorColumn,q:QuickFixLine,
Bram Moolenaarc572da52017-08-27 16:52:01 +02004111 z:StatusLineTerm,Z:StatusLineTermNC")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004112 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004113 This option can be used to set highlighting mode for various
4114 occasions. It is a comma separated list of character pairs. The
4115 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004116 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004117 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
Bram Moolenaar58b85342016-08-14 19:54:54 +02004118 |hl-EndOfBuffer| ~ lines after the last line in the buffer
4119 |hl-NonText| @ '@' at the end of the window and
Bram Moolenaar071d4272004-06-13 20:20:40 +00004120 characters from 'showbreak'
4121 |hl-Directory| d directories in CTRL-D listing and other special
4122 things in listings
4123 |hl-ErrorMsg| e error messages
4124 h (obsolete, ignored)
4125 |hl-IncSearch| i 'incsearch' highlighting
4126 |hl-Search| l last search pattern highlighting (see 'hlsearch')
4127 |hl-MoreMsg| m |more-prompt|
4128 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
Bram Moolenaar64486672010-05-16 15:46:46 +02004129 |hl-LineNr| n line number for ":number" and ":#" commands, and
4130 when 'number' or 'relativenumber' option is set.
Bram Moolenaarefae76a2019-10-27 22:54:58 +01004131 |hl-LineNrAbove| a line number above the cursor for when the
4132 'relativenumber' option is set.
4133 |hl-LineNrBelow| b line number below the cursor for when the
4134 'relativenumber' option is set.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01004135 |hl-CursorLineNr| N like n for when 'cursorline' or 'relativenumber' is
4136 set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004137 |hl-Question| r |hit-enter| prompt and yes/no questions
4138 |hl-StatusLine| s status line of current window |status-line|
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01004139 |hl-StatusLineNC| S status lines of not-current windows
Bram Moolenaar071d4272004-06-13 20:20:40 +00004140 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
4141 |hl-VertSplit| c column used to separate vertically split windows
4142 |hl-Visual| v Visual mode
4143 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
4144 Selection" Only X11 Gui's |gui-x11| and
4145 |xterm-clipboard|.
4146 |hl-WarningMsg| w warning messages
4147 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
4148 |hl-Folded| f line used for closed folds
4149 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00004150 |hl-DiffAdd| A added line in diff mode
4151 |hl-DiffChange| C changed line in diff mode
4152 |hl-DiffDelete| D deleted line in diff mode
4153 |hl-DiffText| T inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00004154 |hl-SignColumn| > column used for |signs|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004155 |hl-Conceal| - the placeholders used for concealed characters
4156 (see 'conceallevel')
Bram Moolenaar217ad922005-03-20 22:37:15 +00004157 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02004158 |hl-SpellCap| P word that should start with capital |spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00004159 |hl-SpellRare| R rare word |spell|
4160 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004161 |hl-Pmenu| + popup menu normal line
4162 |hl-PmenuSel| = popup menu selected line
4163 |hl-PmenuSbar| x popup menu scrollbar
4164 |hl-PmenuThumb| X popup menu scrollbar thumb
Bram Moolenaar071d4272004-06-13 20:20:40 +00004165
4166 The display modes are:
4167 r reverse (termcap entry "mr" and "me")
4168 i italic (termcap entry "ZH" and "ZR")
4169 b bold (termcap entry "md" and "me")
4170 s standout (termcap entry "so" and "se")
4171 u underline (termcap entry "us" and "ue")
Bram Moolenaare2cc9702005-03-15 22:43:58 +00004172 c undercurl (termcap entry "Cs" and "Ce")
Bram Moolenaarcf4b00c2017-09-02 18:33:56 +02004173 t strikethrough (termcap entry "Ts" and "Te")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004174 n no highlighting
4175 - no highlighting
4176 : use a highlight group
4177 The default is used for occasions that are not included.
4178 If you want to change what the display modes do, see |dos-colors|
4179 for an example.
4180 When using the ':' display mode, this must be followed by the name of
4181 a highlight group. A highlight group can be used to define any type
4182 of highlighting, including using color. See |:highlight| on how to
4183 define one. The default uses a different group for each occasion.
4184 See |highlight-default| for the default highlight groups.
4185
Bram Moolenaar071d4272004-06-13 20:20:40 +00004186 *'history'* *'hi'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004187'history' 'hi' number (Vim default: 50, Vi default: 0,
4188 set to 200 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004189 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004190 A history of ":" commands, and a history of previous search patterns
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004191 is remembered. This option decides how many entries may be stored in
Bram Moolenaar071d4272004-06-13 20:20:40 +00004192 each of these histories (see |cmdline-editing|).
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004193 The maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004194 NOTE: This option is set to the Vi default value when 'compatible' is
4195 set and to the Vim default value when 'compatible' is reset.
4196
4197 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
4198'hkmap' 'hk' boolean (default off)
4199 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004200 {only available when compiled with the |+rightleft|
4201 feature}
4202 When on, the keyboard is mapped for the Hebrew character set.
4203 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
4204 toggle this option. See |rileft.txt|.
4205 NOTE: This option is reset when 'compatible' is set.
4206
4207 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
4208'hkmapp' 'hkp' boolean (default off)
4209 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004210 {only available when compiled with the |+rightleft|
4211 feature}
4212 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
4213 This is useful if you have a non-Hebrew keyboard.
4214 See |rileft.txt|.
4215 NOTE: This option is reset when 'compatible' is set.
4216
Bram Moolenaar036986f2017-03-16 17:41:02 +01004217 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
4218'hlsearch' 'hls' boolean (default off)
4219 global
Bram Moolenaar036986f2017-03-16 17:41:02 +01004220 {not available when compiled without the
4221 |+extra_search| feature}
4222 When there is a previous search pattern, highlight all its matches.
4223 The type of highlighting used can be set with the 'l' occasion in the
4224 'highlight' option. This uses the "Search" highlight group by
4225 default. Note that only the matching text is highlighted, any offsets
4226 are not applied.
4227 See also: 'incsearch' and |:match|.
4228 When you get bored looking at the highlighted matches, you can turn it
4229 off with |:nohlsearch|. This does not change the option value, as
4230 soon as you use a search command, the highlighting comes back.
4231 'redrawtime' specifies the maximum time spent on finding matches.
4232 When the search pattern can match an end-of-line, Vim will try to
4233 highlight all of the matched text. However, this depends on where the
4234 search starts. This will be the first line in the window or the first
4235 line below a closed fold. A match in a previous line which is not
4236 drawn may not continue in a newly drawn line.
4237 You can specify whether the highlight status is restored on startup
4238 with the 'h' flag in 'viminfo' |viminfo-h|.
4239 NOTE: This option is reset when 'compatible' is set.
4240
Bram Moolenaar071d4272004-06-13 20:20:40 +00004241 *'icon'* *'noicon'*
4242'icon' boolean (default off, on when title can be restored)
4243 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004244 When on, the icon text of the window will be set to the value of
4245 'iconstring' (if it is not empty), or to the name of the file
4246 currently being edited. Only the last part of the name is used.
4247 Overridden by the 'iconstring' option.
4248 Only works if the terminal supports setting window icons (currently
4249 only X11 GUI and terminals with a non-empty 't_IS' option - these are
4250 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
4251 builtin termcap).
4252 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00004253 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00004254 X11.
Bram Moolenaar3a991dd2014-10-02 01:41:41 +02004255 For MS-Windows the icon can be changed, see |windows-icon|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004256
4257 *'iconstring'*
4258'iconstring' string (default "")
4259 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004260 When this option is not empty, it will be used for the icon text of
4261 the window. This happens only when the 'icon' option is on.
4262 Only works if the terminal supports setting window icon text
4263 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02004264 Does not work for MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004265 When Vim was compiled with HAVE_X11 defined, the original icon will be
4266 restored if possible |X11|.
4267 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004268 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004269 'titlestring' for example settings.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004270 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004271 {not available when compiled without the |+statusline| feature}
4272
4273 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
4274'ignorecase' 'ic' boolean (default off)
4275 global
4276 Ignore case in search patterns. Also used when searching in the tags
4277 file.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01004278 Also see 'smartcase' and 'tagcase'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004279 Can be overruled by using "\c" or "\C" in the pattern, see
4280 |/ignorecase|.
4281
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004282 *'imactivatefunc'* *'imaf'*
4283'imactivatefunc' 'imaf' string (default "")
4284 global
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004285 This option specifies a function that will be called to
Yegappan Lakshmanan7645da52021-12-04 14:02:30 +00004286 activate or deactivate the Input Method. The value can be the name of
4287 a function, a |lambda| or a |Funcref|. See |option-value-function| for
4288 more information.
Bram Moolenaaref8c6172020-07-01 15:12:44 +02004289 It is not used in the MS-Windows GUI version.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004290 The expression will be evaluated in the |sandbox| when set from a
4291 modeline, see |sandbox-option|.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004292
4293 Example: >
4294 function ImActivateFunc(active)
4295 if a:active
4296 ... do something
4297 else
4298 ... do something
4299 endif
4300 " return value is not used
4301 endfunction
4302 set imactivatefunc=ImActivateFunc
4303<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004304 *'imactivatekey'* *'imak'*
4305'imactivatekey' 'imak' string (default "")
4306 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004307 {only available when compiled with |+xim| and
Bram Moolenaar67c53842010-05-22 18:28:27 +02004308 |+GUI_GTK|} *E599*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004309 Specifies the key that your Input Method in X-Windows uses for
4310 activation. When this is specified correctly, vim can fully control
4311 IM with 'imcmdline', 'iminsert' and 'imsearch'.
4312 You can't use this option to change the activation key, the option
4313 tells Vim what the key is.
4314 Format:
4315 [MODIFIER_FLAG-]KEY_STRING
4316
4317 These characters can be used for MODIFIER_FLAG (case is ignored):
4318 S Shift key
4319 L Lock key
4320 C Control key
4321 1 Mod1 key
4322 2 Mod2 key
4323 3 Mod3 key
4324 4 Mod4 key
4325 5 Mod5 key
4326 Combinations are allowed, for example "S-C-space" or "SC-space" are
4327 both shift+ctrl+space.
4328 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
4329
4330 Example: >
4331 :set imactivatekey=S-space
4332< "S-space" means shift+space. This is the activation key for kinput2 +
4333 canna (Japanese), and ami (Korean).
4334
4335 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
4336'imcmdline' 'imc' boolean (default off)
4337 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004338 When set the Input Method is always on when starting to edit a command
4339 line, unless entering a search pattern (see 'imsearch' for that).
4340 Setting this option is useful when your input method allows entering
4341 English characters directly, e.g., when it's used to type accented
4342 characters with dead keys.
4343
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004344 *'imdisable'* *'imd'* *'noimdisable'* *'noimd'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004345'imdisable' 'imd' boolean (default off, on for some systems (SGI))
4346 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004347 When set the Input Method is never used. This is useful to disable
4348 the IM when it doesn't work properly.
4349 Currently this option is on by default for SGI/IRIX machines. This
4350 may change in later releases.
4351
4352 *'iminsert'* *'imi'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004353'iminsert' 'imi' number (default 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004354 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004355 Specifies whether :lmap or an Input Method (IM) is to be used in
4356 Insert mode. Valid values:
4357 0 :lmap is off and IM is off
4358 1 :lmap is ON and IM is off
4359 2 :lmap is off and IM is ON
Bram Moolenaar071d4272004-06-13 20:20:40 +00004360 To always reset the option to zero when leaving Insert mode with <Esc>
4361 this can be used: >
4362 :inoremap <ESC> <ESC>:set iminsert=0<CR>
4363< This makes :lmap and IM turn off automatically when leaving Insert
4364 mode.
4365 Note that this option changes when using CTRL-^ in Insert mode
4366 |i_CTRL-^|.
4367 The value is set to 1 when setting 'keymap' to a valid keymap name.
4368 It is also used for the argument of commands like "r" and "f".
4369 The value 0 may not work correctly with Athena and Motif with some XIM
4370 methods. Use 'imdisable' to disable XIM then.
4371
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004372 You can set 'imactivatefunc' and 'imstatusfunc' to handle IME/XIM
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004373 via external command if Vim is not compiled with the |+xim|,
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004374 |+multi_byte_ime| or |global-ime|.
4375
Bram Moolenaar071d4272004-06-13 20:20:40 +00004376 *'imsearch'* *'ims'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004377'imsearch' 'ims' number (default -1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004378 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004379 Specifies whether :lmap or an Input Method (IM) is to be used when
4380 entering a search pattern. Valid values:
4381 -1 the value of 'iminsert' is used, makes it look like
4382 'iminsert' is also used when typing a search pattern
4383 0 :lmap is off and IM is off
4384 1 :lmap is ON and IM is off
4385 2 :lmap is off and IM is ON
4386 Note that this option changes when using CTRL-^ in Command-line mode
4387 |c_CTRL-^|.
4388 The value is set to 1 when it is not -1 and setting the 'keymap'
4389 option to a valid keymap name.
4390 The value 0 may not work correctly with Athena and Motif with some XIM
4391 methods. Use 'imdisable' to disable XIM then.
4392
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004393 *'imstatusfunc'* *'imsf'*
4394'imstatusfunc' 'imsf' string (default "")
4395 global
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004396 This option specifies a function that is called to obtain the status
4397 of Input Method. It must return a positive number when IME is active.
Yegappan Lakshmanan7645da52021-12-04 14:02:30 +00004398 The value can be the name of a function, a |lambda| or a |Funcref|.
4399 See |option-value-function| for more information.
Bram Moolenaaref8c6172020-07-01 15:12:44 +02004400 It is not used in the MS-Windows GUI version.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004401
4402 Example: >
4403 function ImStatusFunc()
4404 let is_active = ...do something
4405 return is_active ? 1 : 0
4406 endfunction
4407 set imstatusfunc=ImStatusFunc
4408<
4409 NOTE: This function is invoked very often. Keep it fast.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004410 The expression will be evaluated in the |sandbox| when set from a
4411 modeline, see |sandbox-option|.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004412
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004413 *'imstyle'* *'imst'*
4414'imstyle' 'imst' number (default 1)
4415 global
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004416 {only available when compiled with |+xim| and
4417 |+GUI_GTK|}
Bram Moolenaar37c64c72017-09-19 22:06:03 +02004418 This option specifies the input style of Input Method:
4419 0 use on-the-spot style
4420 1 over-the-spot style
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004421 See: |xim-input-style|
4422
Bram Moolenaar24a98a02017-09-27 22:23:55 +02004423 For a long time on-the-spot style had been used in the GTK version of
4424 vim, however, it is known that it causes troubles when using mappings,
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004425 |single-repeat|, etc. Therefore over-the-spot style becomes the
4426 default now. This should work fine for most people, however if you
4427 have any problem with it, try using on-the-spot style.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004428 The expression will be evaluated in the |sandbox| when set from a
4429 modeline, see |sandbox-option|.
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004430
Bram Moolenaar071d4272004-06-13 20:20:40 +00004431 *'include'* *'inc'*
4432'include' 'inc' string (default "^\s*#\s*include")
4433 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004434 {not available when compiled without the
4435 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004436 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00004437 pattern, just like for the "/" command (See |pattern|). The default
4438 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar1e015462005-09-25 22:16:38 +00004439 "]I", "[d", etc.
4440 Normally the 'isfname' option is used to recognize the file name that
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004441 comes after the matched pattern. But if "\zs" appears in the pattern
4442 then the text matched from "\zs" to the end, or until "\ze" if it
4443 appears, is used as the file name. Use this to include characters
4444 that are not in 'isfname', such as a space. You can then use
4445 'includeexpr' to process the matched text.
Bram Moolenaar1e015462005-09-25 22:16:38 +00004446 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004447
4448 *'includeexpr'* *'inex'*
4449'includeexpr' 'inex' string (default "")
4450 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004451 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004452 |+find_in_path| or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004453 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004454 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004455 :set includeexpr=substitute(v:fname,'\\.','/','g')
4456< The "v:fname" variable will be set to the file name that was detected.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004457
Bram Moolenaar071d4272004-06-13 20:20:40 +00004458 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004459 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004460 Also used for |<cfile>|.
4461
Yegappan Lakshmanan8bb65f22021-12-26 10:51:39 +00004462 If the expression starts with s: or |<SID>|, then it is replaced with
4463 the script ID (|local-function|). Example: >
4464 set includeexpr=s:MyIncludeExpr(v:fname)
4465 set includeexpr=<SID>SomeIncludeExpr(v:fname)
4466<
Bram Moolenaar30b65812012-07-12 22:01:11 +02004467 The expression will be evaluated in the |sandbox| when set from a
4468 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004469 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004470
4471 It is not allowed to change text or jump to another window while
4472 evaluating 'includeexpr' |textlock|.
4473
Bram Moolenaar071d4272004-06-13 20:20:40 +00004474 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004475'incsearch' 'is' boolean (default off, set in |defaults.vim| if the
4476 +reltime feature is supported)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004477 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004478 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004479 |+extra_search| features}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004480 While typing a search command, show where the pattern, as it was typed
4481 so far, matches. The matched string is highlighted. If the pattern
4482 is invalid or not found, nothing is shown. The screen will be updated
4483 often, this is only useful on fast terminals.
Bram Moolenaarfc65cab2018-08-28 22:58:02 +02004484 Also applies to the pattern in commands: >
4485 :global
4486 :lvimgrep
4487 :lvimgrepadd
4488 :smagic
4489 :snomagic
4490 :sort
4491 :substitute
4492 :vglobal
4493 :vimgrep
4494 :vimgrepadd
4495< Note that the match will be shown, but the cursor will return to its
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004496 original position when no match is found and when pressing <Esc>. You
4497 still need to finish the search command with <Enter> to move the
4498 cursor to the match.
Bram Moolenaardc083282016-10-11 08:57:33 +02004499 You can use the CTRL-G and CTRL-T keys to move to the next and
4500 previous match. |c_CTRL-G| |c_CTRL-T|
Bram Moolenaar91a4e822008-01-19 14:59:58 +00004501 When compiled with the |+reltime| feature Vim only searches for about
4502 half a second. With a complicated pattern and/or a lot of text the
4503 match may not be found. This is to avoid that Vim hangs while you
4504 are typing the pattern.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004505 The highlighting can be set with the 'i' flag in 'highlight'.
Bram Moolenaar2f058492017-11-30 20:27:52 +01004506 When 'hlsearch' is on, all matched strings are highlighted too while
4507 typing a search command. See also: 'hlsearch'.
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004508 If you don't want to turn 'hlsearch' on, but want to highlight all
4509 matches while searching, you can turn on and off 'hlsearch' with
4510 autocmd. Example: >
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004511 augroup vimrc-incsearch-highlight
4512 autocmd!
Bram Moolenaarf8f8b2e2017-11-02 19:08:48 +01004513 autocmd CmdlineEnter /,\? :set hlsearch
4514 autocmd CmdlineLeave /,\? :set nohlsearch
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004515 augroup END
4516<
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004517 CTRL-L can be used to add one character from after the current match
Bram Moolenaara9dc3752010-07-11 20:46:53 +02004518 to the command line. If 'ignorecase' and 'smartcase' are set and the
4519 command line has no uppercase characters, the added character is
4520 converted to lowercase.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004521 CTRL-R CTRL-W can be used to add the word at the end of the current
4522 match, excluding the characters that were already typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004523 NOTE: This option is reset when 'compatible' is set.
4524
4525 *'indentexpr'* *'inde'*
4526'indentexpr' 'inde' string (default "")
4527 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004528 {not available when compiled without the |+cindent|
4529 or |+eval| features}
4530 Expression which is evaluated to obtain the proper indent for a line.
4531 It is used when a new line is created, for the |=| operator and
4532 in Insert mode as specified with the 'indentkeys' option.
4533 When this option is not empty, it overrules the 'cindent' and
Bram Moolenaar20f90cf2011-05-19 12:22:51 +02004534 'smartindent' indenting. When 'lisp' is set, this option is
4535 overridden by the Lisp indentation algorithm.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004536 When 'paste' is set this option is not used for indenting.
4537 The expression is evaluated with |v:lnum| set to the line number for
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004538 which the indent is to be computed. The cursor is also in this line
Bram Moolenaar071d4272004-06-13 20:20:40 +00004539 when the expression is evaluated (but it may be moved around).
Yegappan Lakshmanan8bb65f22021-12-26 10:51:39 +00004540 If the expression starts with s: or |<SID>|, then it is replaced with
4541 the script ID (|local-function|). Example: >
4542 set indentexpr=s:MyIndentExpr()
4543 set indentexpr=<SID>SomeIndentExpr()
4544<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004545 The expression must return the number of spaces worth of indent. It
4546 can return "-1" to keep the current indent (this means 'autoindent' is
4547 used for the indent).
4548 Functions useful for computing the indent are |indent()|, |cindent()|
4549 and |lispindent()|.
4550 The evaluation of the expression must not have side effects! It must
4551 not change the text, jump to another window, etc. Afterwards the
4552 cursor position is always restored, thus the cursor may be moved.
4553 Normally this option would be set to call a function: >
4554 :set indentexpr=GetMyIndent()
4555< Error messages will be suppressed, unless the 'debug' option contains
4556 "msg".
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004557 See |indent-expression|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01004558 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004559
Bram Moolenaar30b65812012-07-12 22:01:11 +02004560 The expression will be evaluated in the |sandbox| when set from a
4561 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004562 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004563
4564 It is not allowed to change text or jump to another window while
4565 evaluating 'indentexpr' |textlock|.
4566
4567
Bram Moolenaar071d4272004-06-13 20:20:40 +00004568 *'indentkeys'* *'indk'*
Bram Moolenaarce655742019-01-31 14:12:57 +01004569'indentkeys' 'indk' string (default "0{,0},0),0],:,0#,!^F,o,O,e")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004570 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004571 {not available when compiled without the |+cindent|
4572 feature}
4573 A list of keys that, when typed in Insert mode, cause reindenting of
4574 the current line. Only happens if 'indentexpr' isn't empty.
4575 The format is identical to 'cinkeys', see |indentkeys-format|.
4576 See |C-indenting| and |indent-expression|.
4577
4578 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
4579'infercase' 'inf' boolean (default off)
4580 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004581 When doing keyword completion in insert mode |ins-completion|, and
Bram Moolenaar446cb832008-06-24 21:56:24 +00004582 'ignorecase' is also on, the case of the match is adjusted depending
4583 on the typed text. If the typed text contains a lowercase letter
4584 where the match has an upper case letter, the completed part is made
4585 lowercase. If the typed text has no lowercase letters and the match
4586 has a lowercase letter where the typed text has an uppercase letter,
4587 and there is a letter before it, the completed part is made uppercase.
4588 With 'noinfercase' the match is used as-is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004589
4590 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
4591'insertmode' 'im' boolean (default off)
4592 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004593 Makes Vim work in a way that Insert mode is the default mode. Useful
4594 if you want to use Vim as a modeless editor. Used for |evim|.
4595 These Insert mode commands will be useful:
4596 - Use the cursor keys to move around.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02004597 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|. When
Bram Moolenaar071d4272004-06-13 20:20:40 +00004598 this is a mapping, it is executed as if 'insertmode' was off.
4599 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004600 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00004601 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
4602 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004603
4604 These items change when 'insertmode' is set:
4605 - when starting to edit of a file, Vim goes to Insert mode.
4606 - <Esc> in Insert mode is a no-op and beeps.
4607 - <Esc> in Normal mode makes Vim go to Insert mode.
4608 - CTRL-L in Insert mode is a command, it is not inserted.
4609 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
4610 However, when <Esc> is used inside a mapping, it behaves like
4611 'insertmode' was not set. This was done to be able to use the same
4612 mappings with 'insertmode' set or not set.
4613 When executing commands with |:normal| 'insertmode' is not used.
4614
4615 NOTE: This option is reset when 'compatible' is set.
4616
4617 *'isfname'* *'isf'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004618'isfname' 'isf' string (default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004619 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
4620 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
4621 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
4622 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
4623 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
4624 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004625 The characters specified by this option are included in file names and
4626 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004627 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004628 Multi-byte characters 256 and above are always included, only the
4629 characters up to 255 are specified with this option.
4630 For UTF-8 the characters 0xa0 to 0xff are included as well.
Bram Moolenaar446cb832008-06-24 21:56:24 +00004631 Think twice before adding white space to this option. Although a
4632 space may appear inside a file name, the effect will be that Vim
4633 doesn't know where a file name starts or ends when doing completion.
4634 It most likely works better without a space in 'isfname'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004635
4636 Note that on systems using a backslash as path separator, Vim tries to
4637 do its best to make it work as you would expect. That is a bit
4638 tricky, since Vi originally used the backslash to escape special
4639 characters. Vim will not remove a backslash in front of a normal file
4640 name character on these systems, but it will on Unix and alikes. The
4641 '&' and '^' are not included by default, because these are special for
4642 cmd.exe.
4643
4644 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004645 Each part can be a single character number or a range. A range is two
4646 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004647 decimal number between 0 and 255 or the ASCII character itself (does
4648 not work for digits). Example:
4649 "_,-,128-140,#-43" (include '_' and '-' and the range
4650 128 to 140 and '#' to 43)
4651 If a part starts with '^', the following character number or range
4652 will be excluded from the option. The option is interpreted from left
4653 to right. Put the excluded character after the range where it is
4654 included. To include '^' itself use it as the last character of the
4655 option or the end of a range. Example:
4656 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
4657 If the character is '@', all characters where isalpha() returns TRUE
4658 are included. Normally these are the characters a to z and A to Z,
4659 plus accented characters. To include '@' itself use "@-@". Examples:
4660 "@,^a-z" All alphabetic characters, excluding lower
Bram Moolenaar446cb832008-06-24 21:56:24 +00004661 case ASCII letters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004662 "a-z,A-Z,@-@" All letters plus the '@' character.
4663 A comma can be included by using it where a character number is
4664 expected. Example:
4665 "48-57,,,_" Digits, comma and underscore.
4666 A comma can be excluded by prepending a '^'. Example:
4667 " -~,^,,9" All characters from space to '~', excluding
4668 comma, plus <Tab>.
4669 See |option-backslash| about including spaces and backslashes.
4670
4671 *'isident'* *'isi'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004672'isident' 'isi' string (default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004673 "@,48-57,_,128-167,224-235"
4674 otherwise: "@,48-57,_,192-255")
4675 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004676 The characters given by this option are included in identifiers.
4677 Identifiers are used in recognizing environment variables and after a
4678 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00004679 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004680 option. For '@' only characters up to 255 are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004681 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004682 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00004683 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
4684
4685 *'iskeyword'* *'isk'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004686'iskeyword' 'isk' string (Vim default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004687 "@,48-57,_,128-167,224-235"
4688 otherwise: "@,48-57,_,192-255"
4689 Vi default: "@,48-57,_")
4690 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004691 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004692 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004693 'isfname' for a description of the format of this option. For '@'
Bram Moolenaar4c295022021-05-02 17:19:11 +02004694 characters above 255 check the "word" character class (any character
4695 that is not white space or punctuation).
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004696 For C programs you could use "a-z,A-Z,48-57,_,.,-,>".
Bram Moolenaar071d4272004-06-13 20:20:40 +00004697 For a help file it is set to all non-blank printable characters except
4698 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
4699 command).
4700 When the 'lisp' option is on the '-' character is always included.
Bram Moolenaarb8060fe2016-01-19 22:29:28 +01004701 This option also influences syntax highlighting, unless the syntax
4702 uses |:syn-iskeyword|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004703 NOTE: This option is set to the Vi default value when 'compatible' is
4704 set and to the Vim default value when 'compatible' is reset.
4705
4706 *'isprint'* *'isp'*
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02004707'isprint' 'isp' string (default for Win32 and macOS:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004708 "@,~-255"; otherwise: "@,161-255")
4709 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004710 The characters given by this option are displayed directly on the
4711 screen. It is also used for "\p" in a |pattern|. The characters from
4712 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
4713 even when they are not included in 'isprint' or excluded. See
4714 'isfname' for a description of the format of this option.
4715
4716 Non-printable characters are displayed with two characters:
4717 0 - 31 "^@" - "^_"
4718 32 - 126 always single characters
4719 127 "^?"
4720 128 - 159 "~@" - "~_"
4721 160 - 254 "| " - "|~"
4722 255 "~?"
4723 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
4724 displayed as <xx>, with the hexadecimal value of the byte.
4725 When 'display' contains "uhex" all unprintable characters are
4726 displayed as <xx>.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004727 The SpecialKey highlighting will be used for unprintable characters.
4728 |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004729
4730 Multi-byte characters 256 and above are always included, only the
4731 characters up to 255 are specified with this option. When a character
4732 is printable but it is not available in the current font, a
4733 replacement character will be shown.
4734 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
4735 There is no option to specify these characters.
4736
4737 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
4738'joinspaces' 'js' boolean (default on)
4739 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004740 Insert two spaces after a '.', '?' and '!' with a join command.
4741 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
4742 Otherwise only one space is inserted.
4743 NOTE: This option is set when 'compatible' is set.
4744
4745 *'key'*
4746'key' string (default "")
4747 local to buffer
Bram Moolenaar996343d2010-07-04 22:20:21 +02004748 {only available when compiled with the |+cryptv|
4749 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004750 The key that is used for encrypting and decrypting the current buffer.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02004751 See |encryption| and 'cryptmethod'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004752 Careful: Do not set the key value by hand, someone might see the typed
4753 key. Use the |:X| command. But you can make 'key' empty: >
4754 :set key=
4755< It is not possible to get the value of this option with ":set key" or
4756 "echo &key". This is to avoid showing it to someone who shouldn't
4757 know. It also means you cannot see it yourself once you have set it,
4758 be careful not to make a typing error!
Bram Moolenaard58e9292011-02-09 17:07:58 +01004759 You can use "&key" in an expression to detect whether encryption is
4760 enabled. When 'key' is set it returns "*****" (five stars).
Bram Moolenaar071d4272004-06-13 20:20:40 +00004761
4762 *'keymap'* *'kmp'* *E544*
4763'keymap' 'kmp' string (default "")
4764 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004765 {only available when compiled with the |+keymap|
4766 feature}
4767 Name of a keyboard mapping. See |mbyte-keymap|.
4768 Setting this option to a valid keymap name has the side effect of
4769 setting 'iminsert' to one, so that the keymap becomes effective.
4770 'imsearch' is also set to one, unless it was -1
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004771 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004772
4773 *'keymodel'* *'km'*
4774'keymodel' 'km' string (default "")
4775 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004776 List of comma separated words, which enable special things that keys
4777 can do. These values can be used:
4778 startsel Using a shifted special key starts selection (either
4779 Select mode or Visual mode, depending on "key" being
4780 present in 'selectmode').
4781 stopsel Using a not-shifted special key stops selection.
4782 Special keys in this context are the cursor keys, <End>, <Home>,
4783 <PageUp> and <PageDown>.
4784 The 'keymodel' option is set by the |:behave| command.
4785
4786 *'keywordprg'* *'kp'*
4787'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02004788 VMS: "help")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004789 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004790 Program to use for the |K| command. Environment variables are
4791 expanded |:set_env|. ":help" may be used to access the Vim internal
4792 help. (Note that previously setting the global option to the empty
4793 value did this, which is now deprecated.)
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02004794 When the first character is ":", the command is invoked as a Vim
4795 Ex command prefixed with [count].
4796 When "man", "man -s" or an Ex command is used, Vim will automatically
4797 translate a count for the "K" command and pass it as the first
4798 argument. For "man -s" the "-s" is removed when there is no count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004799 See |option-backslash| about including spaces and backslashes.
4800 Example: >
4801 :set keywordprg=man\ -s
4802< This option cannot be set from a |modeline| or in the |sandbox|, for
4803 security reasons.
4804
4805 *'langmap'* *'lmap'* *E357* *E358*
4806'langmap' 'lmap' string (default "")
4807 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004808 {only available when compiled with the |+langmap|
4809 feature}
4810 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004811 mode. When you are typing text in Insert mode the characters are
Bram Moolenaarfa735342016-01-03 22:14:44 +01004812 inserted directly. When in Normal mode the 'langmap' option takes
Bram Moolenaar071d4272004-06-13 20:20:40 +00004813 care of translating these special characters to the original meaning
4814 of the key. This means you don't have to change the keyboard mode to
4815 be able to execute Normal mode commands.
4816 This is the opposite of the 'keymap' option, where characters are
4817 mapped in Insert mode.
Bram Moolenaarb17893a2020-03-14 08:19:51 +01004818 Also consider setting 'langremap' to off, to prevent 'langmap' from
4819 applying to characters resulting from a mapping.
Bram Moolenaare968e362014-05-13 20:23:24 +02004820 This option cannot be set from a |modeline| or in the |sandbox|, for
4821 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004822
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00004823 Example (for Greek, in UTF-8): *greek* >
4824 :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 +00004825< Example (exchanges meaning of z and y for commands): >
4826 :set langmap=zy,yz,ZY,YZ
4827<
4828 The 'langmap' option is a list of parts, separated with commas. Each
4829 part can be in one of two forms:
4830 1. A list of pairs. Each pair is a "from" character immediately
4831 followed by the "to" character. Examples: "aA", "aAbBcC".
4832 2. A list of "from" characters, a semi-colon and a list of "to"
4833 characters. Example: "abc;ABC"
4834 Example: "aA,fgh;FGH,cCdDeE"
4835 Special characters need to be preceded with a backslash. These are
Bram Moolenaar4f4d51a2020-10-11 13:57:40 +02004836 ";", ',', '"', '|' and backslash itself.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004837
4838 This will allow you to activate vim actions without having to switch
4839 back and forth between the languages. Your language characters will
4840 be understood as normal vim English characters (according to the
4841 langmap mappings) in the following cases:
4842 o Normal/Visual mode (commands, buffer/register names, user mappings)
4843 o Insert/Replace Mode: Register names after CTRL-R
4844 o Insert/Replace Mode: Mappings
4845 Characters entered in Command-line mode will NOT be affected by
4846 this option. Note that this option can be changed at any time
4847 allowing to switch between mappings for different languages/encodings.
4848 Use a mapping to avoid having to type it each time!
4849
4850 *'langmenu'* *'lm'*
4851'langmenu' 'lm' string (default "")
4852 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004853 {only available when compiled with the |+menu| and
4854 |+multi_lang| features}
4855 Language to use for menu translation. Tells which file is loaded
4856 from the "lang" directory in 'runtimepath': >
4857 "lang/menu_" . &langmenu . ".vim"
4858< (without the spaces). For example, to always use the Dutch menus, no
4859 matter what $LANG is set to: >
4860 :set langmenu=nl_NL.ISO_8859-1
4861< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004862 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004863 If your $LANG is set to a non-English language but you do want to use
4864 the English menus: >
4865 :set langmenu=none
4866< This option must be set before loading menus, switching on filetype
4867 detection or syntax highlighting. Once the menus are defined setting
4868 this option has no effect. But you could do this: >
4869 :source $VIMRUNTIME/delmenu.vim
4870 :set langmenu=de_DE.ISO_8859-1
4871 :source $VIMRUNTIME/menu.vim
4872< Warning: This deletes all menus that you defined yourself!
4873
Bram Moolenaard94464e2015-11-02 15:28:18 +01004874 *'langnoremap'* *'lnr'* *'nolangnoremap'* *'nolnr'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004875'langnoremap' 'lnr' boolean (default off, set in |defaults.vim|)
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004876 global
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004877 {only available when compiled with the |+langmap|
4878 feature}
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004879 This is just like 'langremap' but with the value inverted. It only
4880 exists for backwards compatibility. When setting 'langremap' then
4881 'langnoremap' is set to the inverted value, and the other way around.
4882
4883 *'langremap'* *'lrm'* *'nolangremap'* *'nolrm'*
Bram Moolenaarb17893a2020-03-14 08:19:51 +01004884'langremap' 'lrm' boolean (default on, set to off in |defaults.vim|)
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004885 global
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004886 {only available when compiled with the |+langmap|
4887 feature}
4888 When off, setting 'langmap' does not apply to characters resulting from
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004889 a mapping. This basically means, if you noticed that setting
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004890 'langmap' disables some of your mappings, try resetting this option.
4891 This option defaults to on for backwards compatibility. Set it off if
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004892 that works for you to avoid mappings to break.
4893
Bram Moolenaar071d4272004-06-13 20:20:40 +00004894 *'laststatus'* *'ls'*
4895'laststatus' 'ls' number (default 1)
4896 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004897 The value of this option influences when the last window will have a
4898 status line:
4899 0: never
4900 1: only if there are at least two windows
4901 2: always
4902 The screen looks nicer with a status line if you have several
4903 windows, but it takes another screen line. |status-line|
4904
4905 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
4906'lazyredraw' 'lz' boolean (default off)
4907 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004908 When this option is set, the screen will not be redrawn while
4909 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004910 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00004911 update use |:redraw|.
4912
4913 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
4914'linebreak' 'lbr' boolean (default off)
4915 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02004916 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004917 feature}
Bram Moolenaar946e27a2014-06-25 18:50:27 +02004918 If on, Vim will wrap long lines at a character in 'breakat' rather
Bram Moolenaar071d4272004-06-13 20:20:40 +00004919 than at the last character that fits on the screen. Unlike
4920 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
Bram Moolenaar946e27a2014-06-25 18:50:27 +02004921 it only affects the way the file is displayed, not its contents.
4922 If 'breakindent' is set, line is visually indented. Then, the value
4923 of 'showbreak' is used to put in front of wrapped lines. This option
Bram Moolenaar86b17e92014-07-02 20:00:47 +02004924 is not used when the 'wrap' option is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004925 Note that <Tab> characters after an <EOL> are mostly not displayed
4926 with the right amount of white space.
4927
4928 *'lines'* *E593*
4929'lines' number (default 24 or terminal height)
4930 global
4931 Number of lines of the Vim window.
4932 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00004933 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004934 When Vim is running in the GUI or in a resizable window, setting this
4935 option will cause the window size to be changed. When you only want
4936 to use the size for the GUI, put the command in your |gvimrc| file.
4937 Vim limits the number of lines to what fits on the screen. You can
4938 use this command to get the tallest window possible: >
4939 :set lines=999
Bram Moolenaarf4d11452005-12-02 00:46:37 +00004940< Minimum value is 2, maximum value is 1000.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02004941 If you get fewer lines than expected, check the 'guiheadroom' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004942 When you set this option and Vim is unable to change the physical
4943 number of lines of the display, the display may be messed up.
4944
4945 *'linespace'* *'lsp'*
4946'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
4947 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004948 {only in the GUI}
4949 Number of pixel lines inserted between characters. Useful if the font
4950 uses the full character cell height, making lines touch each other.
4951 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004952 With some fonts there can be too much room between lines (to have
4953 space for ascents and descents). Then it makes sense to set
4954 'linespace' to a negative value. This may cause display problems
4955 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00004956
4957 *'lisp'* *'nolisp'*
4958'lisp' boolean (default off)
4959 local to buffer
4960 {not available when compiled without the |+lispindent|
4961 feature}
4962 Lisp mode: When <Enter> is typed in insert mode set the indent for
4963 the next line to Lisp standards (well, sort of). Also happens with
4964 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
4965 flag in 'cpoptions' changes the method of indenting: Vi compatible or
4966 better. Also see 'lispwords'.
4967 The '-' character is included in keyword characters. Redefines the
4968 "=" operator to use this same indentation algorithm rather than
4969 calling an external program if 'equalprg' is empty.
4970 This option is not used when 'paste' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004971
4972 *'lispwords'* *'lw'*
4973'lispwords' 'lw' string (default is very long)
Bram Moolenaaraf6c1312014-03-12 18:55:58 +01004974 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004975 {not available when compiled without the |+lispindent|
4976 feature}
4977 Comma separated list of words that influence the Lisp indenting.
4978 |'lisp'|
4979
4980 *'list'* *'nolist'*
4981'list' boolean (default off)
4982 local to window
Bram Moolenaar113cb512021-11-07 20:27:04 +00004983 List mode: By default show tabs as CTRL-I is displayed, display $
4984 after end of line. Useful to see the difference between tabs and
4985 spaces and for trailing blanks. Further changed by the 'listchars'
4986 option.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004987
4988 The cursor is displayed at the start of the space a Tab character
4989 occupies, not at the end as usual in Normal mode. To get this cursor
4990 position while displaying Tabs with spaces, use: >
Bram Moolenaardd007ed2013-07-09 15:44:17 +02004991 :set list lcs=tab:\ \
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004992<
4993 Note that list mode will also affect formatting (set with 'textwidth'
4994 or 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
Bram Moolenaar071d4272004-06-13 20:20:40 +00004995 changing the way tabs are displayed.
4996
4997 *'listchars'* *'lcs'*
4998'listchars' 'lcs' string (default "eol:$")
Bram Moolenaareed9d462021-02-15 20:38:25 +01004999 global or local to window |global-local|
Bram Moolenaarf9d5ca12010-08-01 16:13:51 +02005000 Strings to use in 'list' mode and for the |:list| command. It is a
5001 comma separated list of string settings.
Bram Moolenaar79278362015-04-21 18:33:48 +02005002 *lcs-eol*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005003 eol:c Character to show at the end of each line. When
5004 omitted, there is no extra character at the end of the
5005 line.
Bram Moolenaar79278362015-04-21 18:33:48 +02005006 *lcs-tab*
Bram Moolenaar83a52172019-01-16 22:41:54 +01005007 tab:xy[z] Two or three characters to be used to show a tab.
5008 The third character is optional.
5009
5010 tab:xy The 'x' is always used, then 'y' as many times as will
5011 fit. Thus "tab:>-" displays:
5012 >
5013 >-
5014 >--
5015 etc.
5016
5017 tab:xyz The 'z' is always used, then 'x' is prepended, and
5018 then 'y' is used as many times as will fit. Thus
5019 "tab:<->" displays:
5020 >
5021 <>
5022 <->
5023 <-->
5024 etc.
5025
5026 When "tab:" is omitted, a tab is shown as ^I.
Bram Moolenaar79278362015-04-21 18:33:48 +02005027 *lcs-space*
5028 space:c Character to show for a space. When omitted, spaces
5029 are left blank.
zeertzjqf14b8ba2021-09-10 16:58:30 +02005030 *lcs-multispace*
5031 multispace:c...
5032 One or more characters to use cyclically to show for
5033 multiple consecutive spaces. Overrides the "space"
5034 setting, except for single spaces. When omitted, the
5035 "space" setting is used. For example,
5036 `:set listchars=multispace:---+` shows ten consecutive
5037 spaces as:
5038 ---+---+--
Bram Moolenaar91478ae2021-02-03 15:58:13 +01005039 *lcs-lead*
5040 lead:c Character to show for leading spaces. When omitted,
zeertzjqf14b8ba2021-09-10 16:58:30 +02005041 leading spaces are blank. Overrides the "space" and
5042 "multispace" settings for leading spaces. You can
5043 combine it with "tab:", for example: >
Bram Moolenaar942db232021-02-13 18:14:48 +01005044 :set listchars+=tab:>-,lead:.
5045< *lcs-trail*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005046 trail:c Character to show for trailing spaces. When omitted,
zeertzjqf14b8ba2021-09-10 16:58:30 +02005047 trailing spaces are blank. Overrides the "space" and
5048 "multispace" settings for trailing spaces.
Bram Moolenaar79278362015-04-21 18:33:48 +02005049 *lcs-extends*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005050 extends:c Character to show in the last column, when 'wrap' is
5051 off and the line continues beyond the right of the
5052 screen.
Bram Moolenaar79278362015-04-21 18:33:48 +02005053 *lcs-precedes*
Bram Moolenaarbffba7f2019-09-20 17:00:17 +02005054 precedes:c Character to show in the first visible column of the
5055 physical line, when there is text preceding the
5056 character visible in the first column.
Bram Moolenaar79278362015-04-21 18:33:48 +02005057 *lcs-conceal*
Bram Moolenaar860cae12010-06-05 23:22:07 +02005058 conceal:c Character to show in place of concealed text, when
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02005059 'conceallevel' is set to 1.
Bram Moolenaar79278362015-04-21 18:33:48 +02005060 *lcs-nbsp*
Bram Moolenaar73284b92015-05-04 17:28:22 +02005061 nbsp:c Character to show for a non-breakable space character
5062 (0xA0 (160 decimal) and U+202F). Left blank when
5063 omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005064
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005065 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00005066 be used when 'encoding' is "utf-8", otherwise only printable
Bram Moolenaar910f66f2006-04-05 20:41:53 +00005067 characters are allowed. All characters must be single width.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005068
Bram Moolenaar93ff6722021-10-16 17:51:40 +01005069 Each character can be specified as hex: >
5070 set listchars=eol:\\x24
5071 set listchars=eol:\\u21b5
5072 set listchars=eol:\\U000021b5
5073< Note that a double backslash is used. The number of hex characters
5074 must be exactly 2 for \\x, 4 for \\u and 8 for \\U.
5075
Bram Moolenaar071d4272004-06-13 20:20:40 +00005076 Examples: >
5077 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005078 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00005079 :set lcs=extends:>,precedes:<
5080< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaar34cc7d82021-09-21 20:09:51 +02005081 "precedes". "SpecialKey" will be used for "tab", "nbsp", "space",
5082 "multispace", "lead" and "trail".
Bram Moolenaar02467872007-05-06 13:22:01 +00005083 |hl-NonText| |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005084
5085 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
5086'loadplugins' 'lpl' boolean (default on)
5087 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005088 When on the plugin scripts are loaded when starting up |load-plugins|.
5089 This option can be reset in your |vimrc| file to disable the loading
5090 of plugins.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02005091 Note that using the "-u NONE", "-u DEFAULTS" and "--noplugin" command
5092 line arguments reset this option. See |-u| and |--noplugin|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005093
Bram Moolenaard94464e2015-11-02 15:28:18 +01005094 *'luadll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01005095'luadll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01005096 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01005097 {only available when compiled with the |+lua/dyn|
5098 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005099 Specifies the name of the Lua shared library. The default is
5100 DYNAMIC_LUA_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005101 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01005102 This option cannot be set from a |modeline| or in the |sandbox|, for
5103 security reasons.
5104
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00005105 *'macatsui'* *'nomacatsui'*
5106'macatsui' boolean (default on)
5107 global
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02005108 {not supported}
5109 No longer supported, as the Mac OS X GUI code was removed.
Bram Moolenaar02467872007-05-06 13:22:01 +00005110
Bram Moolenaar071d4272004-06-13 20:20:40 +00005111 *'magic'* *'nomagic'*
5112'magic' boolean (default on)
5113 global
5114 Changes the special characters that can be used in search patterns.
5115 See |pattern|.
Bram Moolenaar64d8e252016-09-06 22:12:34 +02005116 WARNING: Switching this option off most likely breaks plugins! That
5117 is because many patterns assume it's on and will fail when it's off.
5118 Only switch it off when working with old Vi scripts. In any other
5119 situation write patterns that work when 'magic' is on. Include "\M"
5120 when you want to |/\M|.
Bram Moolenaar4072ba52020-12-23 13:56:35 +01005121 In |Vim9| script the value of 'magic' is ignored, patterns behave like
5122 it is always set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005123
5124 *'makeef'* *'mef'*
5125'makeef' 'mef' string (default: "")
5126 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005127 {not available when compiled without the |+quickfix|
5128 feature}
5129 Name of the errorfile for the |:make| command (see |:make_makeprg|)
5130 and the |:grep| command.
5131 When it is empty, an internally generated temp file will be used.
5132 When "##" is included, it is replaced by a number to make the name
5133 unique. This makes sure that the ":make" command doesn't overwrite an
5134 existing file.
5135 NOT used for the ":cf" command. See 'errorfile' for that.
5136 Environment variables are expanded |:set_env|.
5137 See |option-backslash| about including spaces and backslashes.
5138 This option cannot be set from a |modeline| or in the |sandbox|, for
5139 security reasons.
5140
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01005141 *'makeencoding'* *'menc'*
5142'makeencoding' 'menc' string (default "")
5143 global or local to buffer |global-local|
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01005144 Encoding used for reading the output of external commands. When empty,
5145 encoding is not converted.
5146 This is used for `:make`, `:lmake`, `:grep`, `:lgrep`, `:grepadd`,
5147 `:lgrepadd`, `:cfile`, `:cgetfile`, `:caddfile`, `:lfile`, `:lgetfile`,
5148 and `:laddfile`.
5149
5150 This would be mostly useful when you use MS-Windows and set 'encoding'
5151 to "utf-8". If |+iconv| is enabled and GNU libiconv is used, setting
5152 'makeencoding' to "char" has the same effect as setting to the system
5153 locale encoding. Example: >
5154 :set encoding=utf-8
5155 :set makeencoding=char " system locale is used
5156<
Bram Moolenaar071d4272004-06-13 20:20:40 +00005157 *'makeprg'* *'mp'*
5158'makeprg' 'mp' string (default "make", VMS: "MMS")
5159 global or local to buffer |global-local|
Bram Moolenaar02467872007-05-06 13:22:01 +00005160 Program to use for the ":make" command. See |:make_makeprg|.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01005161 This option may contain '%' and '#' characters (see |:_%| and |:_#|),
5162 which are expanded to the current and alternate file name. Use |::S|
Bram Moolenaar26df0922014-02-23 23:39:13 +01005163 to escape file names in case they contain special characters.
Bram Moolenaar02467872007-05-06 13:22:01 +00005164 Environment variables are expanded |:set_env|. See |option-backslash|
5165 about including spaces and backslashes.
5166 Note that a '|' must be escaped twice: once for ":set" and once for
5167 the interpretation of a command. When you use a filter called
5168 "myfilter" do it like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005169 :set makeprg=gmake\ \\\|\ myfilter
5170< The placeholder "$*" can be given (even multiple times) to specify
5171 where the arguments will be included, for example: >
5172 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
5173< This option cannot be set from a |modeline| or in the |sandbox|, for
5174 security reasons.
5175
5176 *'matchpairs'* *'mps'*
5177'matchpairs' 'mps' string (default "(:),{:},[:]")
5178 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005179 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01005180 other.
5181 Only character pairs are allowed that are different, thus you cannot
5182 jump between two double quotes.
5183 The characters must be separated by a colon.
Bram Moolenaar02467872007-05-06 13:22:01 +00005184 The pairs must be separated by a comma. Example for including '<' and
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02005185 '>' (for HTML): >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005186 :set mps+=<:>
5187
5188< A more exotic example, to jump between the '=' and ';' in an
5189 assignment, useful for languages like C and Java: >
5190 :au FileType c,cpp,java set mps+==:;
5191
5192< For a more advanced way of using "%", see the matchit.vim plugin in
Bram Moolenaar01164a62017-11-02 22:58:42 +01005193 the $VIMRUNTIME/pack/dist/opt/matchit directory. |add-local-help|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005194
5195 *'matchtime'* *'mat'*
5196'matchtime' 'mat' number (default 5)
5197 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005198 Tenths of a second to show the matching paren, when 'showmatch' is
5199 set. Note that this is not in milliseconds, like other options that
5200 set a time. This is to be compatible with Nvi.
5201
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005202 *'maxcombine'* *'mco'*
5203'maxcombine' 'mco' number (default 2)
5204 global
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005205 The maximum number of combining characters supported for displaying.
5206 Only used when 'encoding' is "utf-8".
5207 The default is OK for most languages. Hebrew may require 4.
5208 Maximum value is 6.
5209 Even when this option is set to 2 you can still edit text with more
5210 combining characters, you just can't see them. Use |g8| or |ga|.
5211 See |mbyte-combining|.
5212
Bram Moolenaar071d4272004-06-13 20:20:40 +00005213 *'maxfuncdepth'* *'mfd'*
5214'maxfuncdepth' 'mfd' number (default 100)
5215 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02005216 {not available when compiled without the |+eval|
Bram Moolenaar02467872007-05-06 13:22:01 +00005217 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005218 Maximum depth of function calls for user functions. This normally
5219 catches endless recursion. When using a recursive function with
5220 more depth, set 'maxfuncdepth' to a bigger number. But this will use
5221 more memory, there is the danger of failing when memory is exhausted.
Bram Moolenaarbc2eada2017-01-02 21:27:47 +01005222 Increasing this limit above 200 also changes the maximum for Ex
Bram Moolenaar0b0f0992018-05-22 21:41:30 +02005223 command recursion, see |E169|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005224 See also |:function|.
5225
5226 *'maxmapdepth'* *'mmd'* *E223*
5227'maxmapdepth' 'mmd' number (default 1000)
5228 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005229 Maximum number of times a mapping is done without resulting in a
5230 character to be used. This normally catches endless mappings, like
5231 ":map x y" with ":map y x". It still does not catch ":map g wg",
5232 because the 'w' is used before the next mapping is done. See also
5233 |key-mapping|.
5234
5235 *'maxmem'* *'mm'*
5236'maxmem' 'mm' number (default between 256 to 5120 (system
5237 dependent) or half the amount of memory
5238 available)
5239 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005240 Maximum amount of memory (in Kbyte) to use for one buffer. When this
5241 limit is reached allocating extra memory for a buffer will cause
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005242 other memory to be freed.
5243 The maximum usable value is about 2000000. Use this to work without a
5244 limit.
5245 The value is ignored when 'swapfile' is off.
5246 Also see 'maxmemtot'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005247
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005248 *'maxmempattern'* *'mmp'*
5249'maxmempattern' 'mmp' number (default 1000)
5250 global
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005251 Maximum amount of memory (in Kbyte) to use for pattern matching.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005252 The maximum value is about 2000000. Use this to work without a limit.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005253 *E363*
Bram Moolenaar02467872007-05-06 13:22:01 +00005254 When Vim runs into the limit it gives an error message and mostly
5255 behaves like CTRL-C was typed.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005256 Running into the limit often means that the pattern is very
5257 inefficient or too complex. This may already happen with the pattern
5258 "\(.\)*" on a very long line. ".*" works much better.
Bram Moolenaarfd358112018-07-07 23:21:31 +02005259 Might also happen on redraw, when syntax rules try to match a complex
5260 text structure.
5261 Vim may run out of memory before hitting the 'maxmempattern' limit, in
5262 which case you get an "Out of memory" error instead.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005263
Bram Moolenaar071d4272004-06-13 20:20:40 +00005264 *'maxmemtot'* *'mmt'*
5265'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
5266 dependent) or half the amount of memory
5267 available)
5268 global
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005269 Maximum amount of memory in Kbyte to use for all buffers together.
5270 The maximum usable value is about 2000000 (2 Gbyte). Use this to work
Bram Moolenaarfa735342016-01-03 22:14:44 +01005271 without a limit.
5272 On 64 bit machines higher values might work. But hey, do you really
5273 need more than 2 Gbyte for text editing? Keep in mind that text is
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005274 stored in the swap file, one can edit files > 2 Gbyte anyway. We do
Bram Moolenaarfa735342016-01-03 22:14:44 +01005275 need the memory to store undo info.
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005276 Buffers with 'swapfile' off still count to the total amount of memory
5277 used.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005278 Also see 'maxmem'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005279
5280 *'menuitems'* *'mis'*
5281'menuitems' 'mis' number (default 25)
5282 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005283 {not available when compiled without the |+menu|
5284 feature}
5285 Maximum number of items to use in a menu. Used for menus that are
5286 generated from a list of items, e.g., the Buffers menu. Changing this
5287 option has no direct effect, the menu must be refreshed first.
5288
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005289 *'mkspellmem'* *'msm'*
5290'mkspellmem' 'msm' string (default "460000,2000,500")
5291 global
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005292 {not available when compiled without the |+syntax|
5293 feature}
5294 Parameters for |:mkspell|. This tunes when to start compressing the
5295 word tree. Compression can be slow when there are many words, but
5296 it's needed to avoid running out of memory. The amount of memory used
5297 per word depends very much on how similar the words are, that's why
5298 this tuning is complicated.
5299
5300 There are three numbers, separated by commas:
5301 {start},{inc},{added}
5302
5303 For most languages the uncompressed word tree fits in memory. {start}
5304 gives the amount of memory in Kbyte that can be used before any
5305 compression is done. It should be a bit smaller than the amount of
5306 memory that is available to Vim.
5307
5308 When going over the {start} limit the {inc} number specifies the
5309 amount of memory in Kbyte that can be allocated before another
5310 compression is done. A low number means compression is done after
5311 less words are added, which is slow. A high number means more memory
5312 will be allocated.
5313
5314 After doing compression, {added} times 1024 words can be added before
5315 the {inc} limit is ignored and compression is done when any extra
5316 amount of memory is needed. A low number means there is a smaller
5317 chance of hitting the {inc} limit, less memory is used but it's
5318 slower.
5319
5320 The languages for which these numbers are important are Italian and
5321 Hungarian. The default works for when you have about 512 Mbyte. If
5322 you have 1 Gbyte you could use: >
5323 :set mkspellmem=900000,3000,800
5324< If you have less than 512 Mbyte |:mkspell| may fail for some
5325 languages, no matter what you set 'mkspellmem' to.
5326
Bram Moolenaar07607392019-05-26 19:20:43 +02005327 This option cannot be set from a |modeline| or in the |sandbox|.
5328
Bram Moolenaar071d4272004-06-13 20:20:40 +00005329 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
Bram Moolenaar8243a792007-05-01 17:05:03 +00005330'modeline' 'ml' boolean (Vim default: on (off for root),
5331 Vi default: off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005332 local to buffer
Bram Moolenaar110289e2019-05-23 15:38:06 +02005333 If 'modeline' is on 'modelines' gives the number of lines that is
5334 checked for set commands. If 'modeline' is off or 'modelines' is zero
5335 no lines are checked. See |modeline|.
5336
5337 *'modelineexpr'* *'mle'* *'nomodelineexpr'* *'nomle'*
5338'modelineexpr' 'mle' boolean (default: off)
5339 global
5340 When on allow some options that are an expression to be set in the
5341 modeline. Check the option for whether it is affected by
5342 'modelineexpr'. Also see |modeline|.
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02005343 This option cannot be set from a |modeline| or in the |sandbox|, for
5344 security reasons.
Bram Moolenaar110289e2019-05-23 15:38:06 +02005345
Bram Moolenaar071d4272004-06-13 20:20:40 +00005346 *'modelines'* *'mls'*
5347'modelines' 'mls' number (default 5)
5348 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005349 If 'modeline' is on 'modelines' gives the number of lines that is
5350 checked for set commands. If 'modeline' is off or 'modelines' is zero
5351 no lines are checked. See |modeline|.
5352 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
5353 set and to the Vim default value when 'compatible' is reset.
5354
5355 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
Bram Moolenaar110289e2019-05-23 15:38:06 +02005356 *E21*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005357'modifiable' 'ma' boolean (default on)
5358 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005359 When off the buffer contents cannot be changed. The 'fileformat' and
5360 'fileencoding' options also can't be changed.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01005361 Can be reset on startup with the |-M| command line argument.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005362
5363 *'modified'* *'mod'* *'nomodified'* *'nomod'*
5364'modified' 'mod' boolean (default off)
5365 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005366 When on, the buffer is considered to be modified. This option is set
5367 when:
5368 1. A change was made to the text since it was last written. Using the
5369 |undo| command to go back to the original text will reset the
5370 option. But undoing changes that were made before writing the
5371 buffer will set the option again, since the text is different from
5372 when it was written.
5373 2. 'fileformat' or 'fileencoding' is different from its original
5374 value. The original value is set when the buffer is read or
5375 written. A ":set nomodified" command also resets the original
5376 values to the current values and the 'modified' option will be
5377 reset.
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01005378 Similarly for 'eol' and 'bomb'.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02005379 This option is not set when a change is made to the buffer as the
5380 result of a BufNewFile, BufRead/BufReadPost, BufWritePost,
5381 FileAppendPost or VimLeave autocommand event. See |gzip-example| for
5382 an explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005383 When 'buftype' is "nowrite" or "nofile" this option may be set, but
5384 will be ignored.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01005385 Note that the text may actually be the same, e.g. 'modified' is set
5386 when using "rA" on an "A".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005387
5388 *'more'* *'nomore'*
5389'more' boolean (Vim default: on, Vi default: off)
5390 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005391 When on, listings pause when the whole screen is filled. You will get
5392 the |more-prompt|. When this option is off there are no pauses, the
5393 listing continues until finished.
5394 NOTE: This option is set to the Vi default value when 'compatible' is
5395 set and to the Vim default value when 'compatible' is reset.
5396
Bram Moolenaar98a29d02021-01-18 19:55:44 +01005397 *'mouse'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005398'mouse' string (default "", "a" for GUI and Win32,
Bram Moolenaar5b418992019-10-27 18:50:25 +01005399 set to "a" or "nvi" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005400 global
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005401 Enable the use of the mouse. Works for most terminals (xterm, Win32
5402 |win32-mouse|, QNX pterm, *BSD console with sysmouse and Linux console
5403 with gpm). For using the mouse in the GUI, see |gui-mouse|. The
5404 mouse can be enabled for different modes:
Bram Moolenaar7f2e9d72017-11-11 20:58:53 +01005405 n Normal mode and Terminal modes
Bram Moolenaar071d4272004-06-13 20:20:40 +00005406 v Visual mode
5407 i Insert mode
5408 c Command-line mode
5409 h all previous modes when editing a help file
5410 a all previous modes
5411 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005412 Normally you would enable the mouse in all five modes with: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005413 :set mouse=a
Bram Moolenaar5b418992019-10-27 18:50:25 +01005414< If your terminal can't overrule the mouse events going to the
5415 application, use: >
5416 :set mouse=nvi
Bram Moolenaar65e0d772020-06-14 17:29:55 +02005417< Then you can press ":", select text for the system, and press Esc to go
Bram Moolenaar5b418992019-10-27 18:50:25 +01005418 back to Vim using the mouse events.
5419 In |defaults.vim| "nvi" is used if the 'term' option is not matching
5420 "xterm".
5421
5422 When the mouse is not enabled, the GUI will still use the mouse for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005423 modeless selection. This doesn't move the text cursor.
5424
5425 See |mouse-using|. Also see |'clipboard'|.
5426
5427 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005428 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005429 the mouse buttons can still be used by keeping the shift key pressed.
5430 Also see the 'clipboard' option.
5431
5432 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
5433'mousefocus' 'mousef' boolean (default off)
5434 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005435 {only works in the GUI}
5436 The window that the mouse pointer is on is automatically activated.
5437 When changing the window layout or window focus in another way, the
5438 mouse pointer is moved to the window with keyboard focus. Off is the
5439 default because it makes using the pull down menus a little goofy, as
5440 a pointer transit may activate a window unintentionally.
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01005441 MS-Windows: Also see 'scrollfocus' for what window is scrolled when
Bram Moolenaar1d9215b2020-01-25 13:27:42 +01005442 using the mouse scroll wheel.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005443
5444 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
5445'mousehide' 'mh' boolean (default on)
5446 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005447 {only works in the GUI}
5448 When on, the mouse pointer is hidden when characters are typed.
5449 The mouse pointer is restored when the mouse is moved.
5450
5451 *'mousemodel'* *'mousem'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005452'mousemodel' 'mousem' string (default "extend", "popup" for Win32)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005453 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005454 Sets the model to use for the mouse. The name mostly specifies what
5455 the right mouse button is used for:
5456 extend Right mouse button extends a selection. This works
5457 like in an xterm.
5458 popup Right mouse button pops up a menu. The shifted left
5459 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00005460 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005461 popup_setpos Like "popup", but the cursor will be moved to the
5462 position where the mouse was clicked, and thus the
5463 selected operation will act upon the clicked object.
5464 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00005465 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005466 course, that right clicking outside a selection will
5467 end Visual mode.
5468 Overview of what button does what for each model:
5469 mouse extend popup(_setpos) ~
5470 left click place cursor place cursor
5471 left drag start selection start selection
5472 shift-left search word extend selection
5473 right click extend selection popup menu (place cursor)
5474 right drag extend selection -
5475 middle click paste paste
5476
5477 In the "popup" model the right mouse button produces a pop-up menu.
5478 You need to define this first, see |popup-menu|.
5479
5480 Note that you can further refine the meaning of buttons with mappings.
5481 See |gui-mouse-mapping|. But mappings are NOT used for modeless
5482 selection (because that's handled in the GUI code directly).
5483
5484 The 'mousemodel' option is set by the |:behave| command.
5485
5486 *'mouseshape'* *'mouses'* *E547*
Bram Moolenaarf6b40102019-02-22 15:24:03 +01005487'mouseshape' 'mouses' string (default "i-r:beam,s:updown,sd:udsizing,
5488 vs:leftright,vd:lrsizing,m:no,
5489 ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005490 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005491 {only available when compiled with the |+mouseshape|
5492 feature}
5493 This option tells Vim what the mouse pointer should look like in
5494 different modes. The option is a comma separated list of parts, much
5495 like used for 'guicursor'. Each part consist of a mode/location-list
5496 and an argument-list:
5497 mode-list:shape,mode-list:shape,..
5498 The mode-list is a dash separated list of these modes/locations:
5499 In a normal window: ~
5500 n Normal mode
5501 v Visual mode
5502 ve Visual mode with 'selection' "exclusive" (same as 'v',
5503 if not specified)
5504 o Operator-pending mode
5505 i Insert mode
5506 r Replace mode
5507
5508 Others: ~
5509 c appending to the command-line
5510 ci inserting in the command-line
5511 cr replacing in the command-line
5512 m at the 'Hit ENTER' or 'More' prompts
5513 ml idem, but cursor in the last line
5514 e any mode, pointer below last window
5515 s any mode, pointer on a status line
5516 sd any mode, while dragging a status line
5517 vs any mode, pointer on a vertical separator line
5518 vd any mode, while dragging a vertical separator line
5519 a everywhere
5520
5521 The shape is one of the following:
5522 avail name looks like ~
5523 w x arrow Normal mouse pointer
5524 w x blank no pointer at all (use with care!)
5525 w x beam I-beam
5526 w x updown up-down sizing arrows
5527 w x leftright left-right sizing arrows
5528 w x busy The system's usual busy pointer
5529 w x no The system's usual 'no input' pointer
5530 x udsizing indicates up-down resizing
5531 x lrsizing indicates left-right resizing
5532 x crosshair like a big thin +
5533 x hand1 black hand
5534 x hand2 white hand
5535 x pencil what you write with
5536 x question big ?
5537 x rightup-arrow arrow pointing right-up
5538 w x up-arrow arrow pointing up
5539 x <number> any X11 pointer number (see X11/cursorfont.h)
5540
5541 The "avail" column contains a 'w' if the shape is available for Win32,
5542 x for X11.
5543 Any modes not specified or shapes not available use the normal mouse
5544 pointer.
5545
5546 Example: >
5547 :set mouseshape=s:udsizing,m:no
5548< will make the mouse turn to a sizing arrow over the status lines and
5549 indicate no input when the hit-enter prompt is displayed (since
5550 clicking the mouse has no effect in this state.)
5551
5552 *'mousetime'* *'mouset'*
5553'mousetime' 'mouset' number (default 500)
5554 global
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005555 Only for GUI, Win32 and Unix with xterm. Defines the maximum
Bram Moolenaar071d4272004-06-13 20:20:40 +00005556 time in msec between two mouse clicks for the second click to be
5557 recognized as a multi click.
5558
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005559 *'mzschemedll'*
5560'mzschemedll' string (default depends on the build)
5561 global
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005562 {only available when compiled with the |+mzscheme/dyn|
5563 feature}
5564 Specifies the name of the MzScheme shared library. The default is
5565 DYNAMIC_MZSCH_DLL which was specified at compile time.
5566 Environment variables are expanded |:set_env|.
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01005567 The value must be set in the |vimrc| script or earlier. In the
Bram Moolenaar01164a62017-11-02 22:58:42 +01005568 startup, before the |load-plugins| step.
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005569 This option cannot be set from a |modeline| or in the |sandbox|, for
5570 security reasons.
5571
5572 *'mzschemegcdll'*
5573'mzschemegcdll' string (default depends on the build)
5574 global
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005575 {only available when compiled with the |+mzscheme/dyn|
5576 feature}
5577 Specifies the name of the MzScheme GC shared library. The default is
5578 DYNAMIC_MZGC_DLL which was specified at compile time.
5579 The value can be equal to 'mzschemedll' if it includes the GC code.
5580 Environment variables are expanded |:set_env|.
5581 This option cannot be set from a |modeline| or in the |sandbox|, for
5582 security reasons.
5583
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005584 *'mzquantum'* *'mzq'*
5585'mzquantum' 'mzq' number (default 100)
5586 global
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005587 {not available when compiled without the |+mzscheme|
5588 feature}
5589 The number of milliseconds between polls for MzScheme threads.
5590 Negative or zero value means no thread scheduling.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005591 NOTE: This option is set to the Vim default value when 'compatible'
5592 is reset.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005593
Bram Moolenaar071d4272004-06-13 20:20:40 +00005594 *'nrformats'* *'nf'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02005595'nrformats' 'nf' string (default "bin,octal,hex",
5596 set to "bin,hex" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005597 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005598 This defines what bases Vim will consider for numbers when using the
5599 CTRL-A and CTRL-X commands for adding to and subtracting from a number
5600 respectively; see |CTRL-A| for more info on these commands.
Bram Moolenaar4770d092006-01-12 23:22:24 +00005601 alpha If included, single alphabetical characters will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005602 incremented or decremented. This is useful for a list with a
Bram Moolenaar3848e002016-03-19 18:42:29 +01005603 letter index a), b), etc. *octal-nrformats*
Bram Moolenaar4770d092006-01-12 23:22:24 +00005604 octal If included, numbers that start with a zero will be considered
Bram Moolenaar071d4272004-06-13 20:20:40 +00005605 to be octal. Example: Using CTRL-A on "007" results in "010".
Bram Moolenaar4770d092006-01-12 23:22:24 +00005606 hex If included, numbers starting with "0x" or "0X" will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005607 considered to be hexadecimal. Example: Using CTRL-X on
5608 "0x100" results in "0x0ff".
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005609 bin If included, numbers starting with "0b" or "0B" will be
5610 considered to be binary. Example: Using CTRL-X on
5611 "0b1000" subtracts one, resulting in "0b0111".
Bram Moolenaaraaad9952020-05-31 15:08:59 +02005612 unsigned If included, numbers are recognized as unsigned. Thus a
5613 leading dash or negative sign won't be considered as part of
5614 the number. Examples:
5615 Using CTRL-X on "2020" in "9-2020" results in "9-2019"
5616 (without "unsigned" it would become "9-2021").
5617 Using CTRL-A on "2020" in "9-2020" results in "9-2021"
5618 (without "unsigned" it would become "9-2019").
Bram Moolenaaracc22402020-06-07 21:07:18 +02005619 Using CTRL-X on "0" or CTRL-A on "18446744073709551615"
5620 (2^64 - 1) has no effect, overflow is prevented.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005621 Numbers which simply begin with a digit in the range 1-9 are always
5622 considered decimal. This also happens for numbers that are not
5623 recognized as octal or hex.
5624
5625 *'number'* *'nu'* *'nonumber'* *'nonu'*
5626'number' 'nu' boolean (default off)
5627 local to window
5628 Print the line number in front of each line. When the 'n' option is
5629 excluded from 'cpoptions' a wrapped line will not use the column of
5630 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005631 The 'numberwidth' option can be used to set the room used for the line
5632 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005633 When a long, wrapped line doesn't start with the first character, '-'
5634 characters are put before the number.
James McCoya80aad72021-12-22 19:45:28 +00005635 For highlighting see |hl-LineNr|, and |hl-CursorLineNr|, and the
5636 |:sign-define| "numhl" argument.
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005637 *number_relativenumber*
5638 The 'relativenumber' option changes the displayed number to be
5639 relative to the cursor. Together with 'number' there are these
5640 four combinations (cursor in line 3):
5641
Bram Moolenaar3848e002016-03-19 18:42:29 +01005642 'nonu' 'nu' 'nonu' 'nu'
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005643 'nornu' 'nornu' 'rnu' 'rnu'
5644
5645 |apple | 1 apple | 2 apple | 2 apple
5646 |pear | 2 pear | 1 pear | 1 pear
5647 |nobody | 3 nobody | 0 nobody |3 nobody
5648 |there | 4 there | 1 there | 1 there
Bram Moolenaar071d4272004-06-13 20:20:40 +00005649
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005650 *'numberwidth'* *'nuw'*
5651'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
5652 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005653 {only available when compiled with the |+linebreak|
5654 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005655 Minimal number of columns to use for the line number. Only relevant
Bram Moolenaar64486672010-05-16 15:46:46 +02005656 when the 'number' or 'relativenumber' option is set or printing lines
5657 with a line number. Since one space is always between the number and
5658 the text, there is one less character for the number itself.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005659 The value is the minimum width. A bigger width is used when needed to
Bram Moolenaar64486672010-05-16 15:46:46 +02005660 fit the highest line number in the buffer respectively the number of
5661 rows in the window, depending on whether 'number' or 'relativenumber'
5662 is set. Thus with the Vim default of 4 there is room for a line number
5663 up to 999. When the buffer has 1000 lines five columns will be used.
Bram Moolenaarf8a07122019-07-01 22:06:07 +02005664 The minimum value is 1, the maximum value is 20.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005665 NOTE: This option is set to the Vi default value when 'compatible' is
5666 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005667
Bram Moolenaarf75a9632005-09-13 21:20:47 +00005668 *'omnifunc'* *'ofu'*
5669'omnifunc' 'ofu' string (default: empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00005670 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02005671 {not available when compiled without the |+eval|
Bram Moolenaare2c453d2019-08-21 14:37:09 +02005672 feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00005673 This option specifies a function to be used for Insert mode omni
5674 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
Bram Moolenaar280f1262006-01-30 00:14:18 +00005675 See |complete-functions| for an explanation of how the function is
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00005676 invoked and what it should return. The value can be the name of a
5677 function, a |lambda| or a |Funcref|. See |option-value-function| for
5678 more information.
Bram Moolenaar043545e2006-10-10 16:44:07 +00005679 This option is usually set by a filetype plugin:
Bram Moolenaar9c102382006-05-03 21:26:49 +00005680 |:filetype-plugin-on|
Bram Moolenaar30b65812012-07-12 22:01:11 +02005681 This option cannot be set from a |modeline| or in the |sandbox|, for
5682 security reasons.
Bram Moolenaare344bea2005-09-01 20:46:49 +00005683
5684
Bram Moolenaar02467872007-05-06 13:22:01 +00005685 *'opendevice'* *'odev'* *'noopendevice'* *'noodev'*
Bram Moolenaar043545e2006-10-10 16:44:07 +00005686'opendevice' 'odev' boolean (default off)
5687 global
Bram Moolenaar6f345a12019-12-17 21:27:18 +01005688 {only for MS-Windows}
Bram Moolenaar043545e2006-10-10 16:44:07 +00005689 Enable reading and writing from devices. This may get Vim stuck on a
5690 device that can be opened but doesn't actually do the I/O. Therefore
5691 it is off by default.
5692 Note that on MS-Windows editing "aux.h", "lpt1.txt" and the like also
5693 result in editing a device.
5694
5695
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005696 *'operatorfunc'* *'opfunc'*
5697'operatorfunc' 'opfunc' string (default: empty)
5698 global
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005699 This option specifies a function to be called by the |g@| operator.
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +00005700 See |:map-operator| for more info and an example. The value can be
5701 the name of a function, a |lambda| or a |Funcref|. See
5702 |option-value-function| for more information.
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005703
5704 This option cannot be set from a |modeline| or in the |sandbox|, for
5705 security reasons.
5706
5707
Bram Moolenaar251e1912011-06-19 05:09:16 +02005708 *'osfiletype'* *'oft'*
5709'osfiletype' 'oft' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005710 local to buffer
Bram Moolenaar251e1912011-06-19 05:09:16 +02005711 This option was supported on RISC OS, which has been removed.
5712
Bram Moolenaar071d4272004-06-13 20:20:40 +00005713
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005714 *'packpath'* *'pp'*
5715'packpath' 'pp' string (default: see 'runtimepath')
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005716 Directories used to find packages. See |packages|.
5717
5718
Bram Moolenaar071d4272004-06-13 20:20:40 +00005719 *'paragraphs'* *'para'*
Bram Moolenaar57e48462008-03-12 16:38:55 +00005720'paragraphs' 'para' string (default "IPLPPPQPP TPHPLIPpLpItpplpipbp")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005721 global
5722 Specifies the nroff macros that separate paragraphs. These are pairs
5723 of two letters (see |object-motions|).
5724
5725 *'paste'* *'nopaste'*
5726'paste' boolean (default off)
5727 global
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005728 Put Vim in Paste mode. This is useful if you want to cut or copy
5729 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005730 unexpected effects.
5731 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005732 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00005733 knows about pasting and will mostly do the right thing without 'paste'
5734 being set. The same is true for a terminal where Vim handles the
5735 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00005736 This option is reset when starting the GUI. Thus if you set it in
5737 your .vimrc it will work in a terminal, but not in the GUI. Setting
5738 'paste' in the GUI has side effects: e.g., the Paste toolbar button
5739 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005740 When the 'paste' option is switched on (also when it was already on):
5741 - mapping in Insert mode and Command-line mode is disabled
5742 - abbreviations are disabled
Bram Moolenaar071d4272004-06-13 20:20:40 +00005743 - 'autoindent' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02005744 - 'expandtab' is reset
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02005745 - 'hkmap' is reset
Bram Moolenaar071d4272004-06-13 20:20:40 +00005746 - 'revins' is reset
5747 - 'ruler' is reset
5748 - 'showmatch' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02005749 - 'smarttab' is reset
5750 - 'softtabstop' is set to 0
5751 - 'textwidth' is set to 0
5752 - 'wrapmargin' is set to 0
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02005753 - 'varsofttabstop' is made empty
Bram Moolenaar071d4272004-06-13 20:20:40 +00005754 These options keep their value, but their effect is disabled:
Bram Moolenaar071d4272004-06-13 20:20:40 +00005755 - 'cindent'
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02005756 - 'formatoptions' is used like it is empty
Bram Moolenaarca635012015-09-25 20:34:21 +02005757 - 'indentexpr'
5758 - 'lisp'
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02005759 - 'smartindent'
Bram Moolenaar071d4272004-06-13 20:20:40 +00005760 NOTE: When you start editing another file while the 'paste' option is
5761 on, settings from the modelines or autocommands may change the
5762 settings again, causing trouble when pasting text. You might want to
5763 set the 'paste' option again.
5764 When the 'paste' option is reset the mentioned options are restored to
5765 the value before the moment 'paste' was switched from off to on.
5766 Resetting 'paste' before ever setting it does not have any effect.
5767 Since mapping doesn't work while 'paste' is active, you need to use
5768 the 'pastetoggle' option to toggle the 'paste' option with some key.
5769
5770 *'pastetoggle'* *'pt'*
5771'pastetoggle' 'pt' string (default "")
5772 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005773 When non-empty, specifies the key sequence that toggles the 'paste'
5774 option. This is like specifying a mapping: >
5775 :map {keys} :set invpaste<CR>
5776< Where {keys} is the value of 'pastetoggle'.
5777 The difference is that it will work even when 'paste' is set.
5778 'pastetoggle' works in Insert mode and Normal mode, but not in
5779 Command-line mode.
5780 Mappings are checked first, thus overrule 'pastetoggle'. However,
5781 when 'paste' is on mappings are ignored in Insert mode, thus you can do
5782 this: >
5783 :map <F10> :set paste<CR>
5784 :map <F11> :set nopaste<CR>
5785 :imap <F10> <C-O>:set paste<CR>
5786 :imap <F11> <nop>
5787 :set pastetoggle=<F11>
5788< This will make <F10> start paste mode and <F11> stop paste mode.
5789 Note that typing <F10> in paste mode inserts "<F10>", since in paste
5790 mode everything is inserted literally, except the 'pastetoggle' key
5791 sequence.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005792 When the value has several bytes 'ttimeoutlen' applies.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005793
5794 *'pex'* *'patchexpr'*
5795'patchexpr' 'pex' string (default "")
5796 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005797 {not available when compiled without the |+diff|
5798 feature}
5799 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005800 the resulting new version of the file. See |diff-patchexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005801
Bram Moolenaardbc28022014-07-26 13:40:44 +02005802 *'patchmode'* *'pm'* *E205* *E206*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005803'patchmode' 'pm' string (default "")
5804 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005805 When non-empty the oldest version of a file is kept. This can be used
5806 to keep the original version of a file if you are changing files in a
5807 source distribution. Only the first time that a file is written a
5808 copy of the original file will be kept. The name of the copy is the
5809 name of the original file with the string in the 'patchmode' option
5810 appended. This option should start with a dot. Use a string like
Bram Moolenaardf980db2017-12-24 13:22:00 +01005811 ".orig" or ".org". 'backupdir' must not be empty for this to work
5812 (Detail: The backup file is renamed to the patchmode file after the
5813 new file has been successfully written, that's why it must be possible
5814 to write a backup file). If there was no file to be backed up, an
5815 empty file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005816 When the 'backupskip' pattern matches, a patchmode file is not made.
5817 Using 'patchmode' for compressed files appends the extension at the
5818 end (e.g., "file.gz.orig"), thus the resulting name isn't always
5819 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005820 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005821
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01005822 *'path'* *'pa'* *E343* *E345* *E347* *E854*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005823'path' 'pa' string (default on Unix: ".,/usr/include,,"
Bram Moolenaar071d4272004-06-13 20:20:40 +00005824 other systems: ".,,")
5825 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005826 This is a list of directories which will be searched when using the
Bram Moolenaarc236c162008-07-13 17:41:49 +00005827 |gf|, [f, ]f, ^Wf, |:find|, |:sfind|, |:tabfind| and other commands,
5828 provided that the file being searched for has a relative path (not
5829 starting with "/", "./" or "../"). The directories in the 'path'
5830 option may be relative or absolute.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005831 - Use commas to separate directory names: >
5832 :set path=.,/usr/local/include,/usr/include
5833< - Spaces can also be used to separate directory names (for backwards
5834 compatibility with version 3.0). To have a space in a directory
5835 name, precede it with an extra backslash, and escape the space: >
5836 :set path=.,/dir/with\\\ space
5837< - To include a comma in a directory name precede it with an extra
5838 backslash: >
5839 :set path=.,/dir/with\\,comma
5840< - To search relative to the directory of the current file, use: >
5841 :set path=.
5842< - To search in the current directory use an empty string between two
5843 commas: >
5844 :set path=,,
5845< - A directory name may end in a ':' or '/'.
5846 - Environment variables are expanded |:set_env|.
5847 - When using |netrw.vim| URLs can be used. For example, adding
5848 "http://www.vim.org" will make ":find index.html" work.
Bram Moolenaarc236c162008-07-13 17:41:49 +00005849 - Search upwards and downwards in a directory tree using "*", "**" and
5850 ";". See |file-searching| for info and syntax.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005851 {not available when compiled without the |+path_extra| feature}
5852 - Careful with '\' characters, type two to get one in the option: >
5853 :set path=.,c:\\include
5854< Or just use '/' instead: >
5855 :set path=.,c:/include
5856< Don't forget "." or files won't even be found in the same directory as
5857 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005858 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00005859 it is something like 256 or 1024 characters.
5860 You can check if all the include files are found, using the value of
5861 'path', see |:checkpath|.
5862 The use of |:set+=| and |:set-=| is preferred when adding or removing
5863 directories from the list. This avoids problems when a future version
5864 uses another default. To remove the current directory use: >
5865 :set path-=
5866< To add the current directory use: >
5867 :set path+=
5868< To use an environment variable, you probably need to replace the
5869 separator. Here is an example to append $INCL, in which directory
5870 names are separated with a semi-colon: >
5871 :let &path = &path . "," . substitute($INCL, ';', ',', 'g')
5872< Replace the ';' with a ':' or whatever separator is used. Note that
5873 this doesn't work when $INCL contains a comma or white space.
5874
Bram Moolenaar37c64c72017-09-19 22:06:03 +02005875 *'perldll'*
5876'perldll' string (default depends on the build)
5877 global
Bram Moolenaar37c64c72017-09-19 22:06:03 +02005878 {only available when compiled with the |+perl/dyn|
5879 feature}
5880 Specifies the name of the Perl shared library. The default is
5881 DYNAMIC_PERL_DLL, which was specified at compile time.
5882 Environment variables are expanded |:set_env|.
5883 This option cannot be set from a |modeline| or in the |sandbox|, for
5884 security reasons.
5885
Bram Moolenaar071d4272004-06-13 20:20:40 +00005886 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
5887'preserveindent' 'pi' boolean (default off)
5888 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005889 When changing the indent of the current line, preserve as much of the
5890 indent structure as possible. Normally the indent is replaced by a
5891 series of tabs followed by spaces as required (unless |'expandtab'| is
5892 enabled, in which case only spaces are used). Enabling this option
5893 means the indent will preserve as many existing characters as possible
5894 for indenting, and only add additional tabs or spaces as required.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005895 'expandtab' does not apply to the preserved white space, a Tab remains
5896 a Tab.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005897 NOTE: When using ">>" multiple times the resulting indent is a mix of
5898 tabs and spaces. You might not like this.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005899 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005900 Also see 'copyindent'.
5901 Use |:retab| to clean up white space.
5902
5903 *'previewheight'* *'pvh'*
5904'previewheight' 'pvh' number (default 12)
5905 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02005906 {not available when compiled without the |+quickfix|
5907 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005908 Default height for a preview window. Used for |:ptag| and associated
Bram Moolenaar79648732019-07-18 21:43:07 +02005909 commands. Used for |CTRL-W_}| when no count is given. Not used when
5910 'previewpopup' is set.
5911
5912 *'previewpopup'* *'pvp'*
5913'previewpopup' 'pvp' string (default empty)
5914 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02005915 {not available when compiled without the |+textprop|
5916 or |+quickfix| feature}
Bram Moolenaar79648732019-07-18 21:43:07 +02005917 When not empty a popup window is used for commands that would open a
5918 preview window. See |preview-popup|.
Bram Moolenaar576a4a62019-08-18 15:25:17 +02005919 Not used for the insert completion info, add "popup" to
5920 'completeopt' for that.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005921
5922 *'previewwindow'* *'nopreviewwindow'*
5923 *'pvw'* *'nopvw'* *E590*
5924'previewwindow' 'pvw' boolean (default off)
5925 local to window
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02005926 {not available when compiled without the |+quickfix|
5927 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005928 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00005929 set. It's normally not set directly, but by using one of the commands
5930 |:ptag|, |:pedit|, etc.
5931
5932 *'printdevice'* *'pdev'*
5933'printdevice' 'pdev' string (default empty)
5934 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005935 {only available when compiled with the |+printer|
5936 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005937 The name of the printer to be used for |:hardcopy|.
5938 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005939 This option cannot be set from a |modeline| or in the |sandbox|, for
5940 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005941
Bram Moolenaar8299df92004-07-10 09:47:34 +00005942 *'printencoding'* *'penc'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005943'printencoding' 'penc' string (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005944 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005945 {only available when compiled with the |+printer|
5946 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005947 Sets the character encoding used when printing.
5948 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005949
5950 *'printexpr'* *'pexpr'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005951'printexpr' 'pexpr' string (default: see below)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005952 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005953 {only available when compiled with the |+printer|
5954 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005955 Expression used to print the PostScript produced with |:hardcopy|.
5956 See |pexpr-option|.
Bram Moolenaar51628222016-12-01 23:03:28 +01005957 This option cannot be set from a |modeline| or in the |sandbox|, for
5958 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005959
Bram Moolenaar8299df92004-07-10 09:47:34 +00005960 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005961'printfont' 'pfn' string (default "courier")
5962 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005963 {only available when compiled with the |+printer|
5964 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005965 The name of the font that will be used for |:hardcopy|.
5966 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005967
5968 *'printheader'* *'pheader'*
5969'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
5970 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005971 {only available when compiled with the |+printer|
5972 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005973 The format of the header produced in |:hardcopy| output.
5974 See |pheader-option|.
5975
5976 *'printmbcharset'* *'pmbcs'*
5977'printmbcharset' 'pmbcs' string (default "")
5978 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01005979 {only available when compiled with the |+printer|
5980 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005981 The CJK character set to be used for CJK output from |:hardcopy|.
5982 See |pmbcs-option|.
5983
5984 *'printmbfont'* *'pmbfn'*
5985'printmbfont' 'pmbfn' string (default "")
5986 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01005987 {only available when compiled with the |+printer|
5988 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005989 List of font names to be used for CJK output from |:hardcopy|.
5990 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005991
5992 *'printoptions'* *'popt'*
5993'printoptions' 'popt' string (default "")
5994 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005995 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005996 List of items that control the format of the output of |:hardcopy|.
5997 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005998
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005999 *'prompt'* *'noprompt'*
6000'prompt' boolean (default on)
6001 global
6002 When on a ":" prompt is used in Ex mode.
6003
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00006004 *'pumheight'* *'ph'*
6005'pumheight' 'ph' number (default 0)
6006 global
Bram Moolenaar06a89a52006-04-29 22:01:03 +00006007 Determines the maximum number of items to show in the popup menu for
6008 Insert mode completion. When zero as much space as available is used.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00006009 |ins-completion-menu|.
6010
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01006011 *'pumwidth'* *'pw'*
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006012'pumwidth' 'pw' number (default 15)
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01006013 global
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01006014 Determines the minimum width to use for the popup menu for Insert mode
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006015 completion. |ins-completion-menu|.
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01006016
Bram Moolenaard94464e2015-11-02 15:28:18 +01006017 *'pythondll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01006018'pythondll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01006019 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01006020 {only available when compiled with the |+python/dyn|
6021 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006022 Specifies the name of the Python 2.x shared library. The default is
6023 DYNAMIC_PYTHON_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006024 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01006025 This option cannot be set from a |modeline| or in the |sandbox|, for
6026 security reasons.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00006027
Bram Moolenaar94073162018-01-31 21:49:05 +01006028 *'pythonhome'*
6029'pythonhome' string (default "")
6030 global
Bram Moolenaar94073162018-01-31 21:49:05 +01006031 {only available when compiled with the |+python/dyn|
6032 feature}
6033 Specifies the name of the Python 2.x home directory. When 'pythonhome'
6034 and the PYTHONHOME environment variable are not set, PYTHON_HOME,
6035 which was specified at compile time, will be used for the Python 2.x
6036 home directory.
6037 Environment variables are expanded |:set_env|.
6038 This option cannot be set from a |modeline| or in the |sandbox|, for
6039 security reasons.
6040
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006041 *'pythonthreedll'*
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006042'pythonthreedll' string (default depends on the build)
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006043 global
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006044 {only available when compiled with the |+python3/dyn|
6045 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006046 Specifies the name of the Python 3 shared library. The default is
6047 DYNAMIC_PYTHON3_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006048 Environment variables are expanded |:set_env|.
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006049 This option cannot be set from a |modeline| or in the |sandbox|, for
6050 security reasons.
6051
Bram Moolenaar94073162018-01-31 21:49:05 +01006052 *'pythonthreehome'*
6053'pythonthreehome' string (default "")
6054 global
Bram Moolenaar94073162018-01-31 21:49:05 +01006055 {only available when compiled with the |+python3/dyn|
6056 feature}
6057 Specifies the name of the Python 3 home directory. When
6058 'pythonthreehome' and the PYTHONHOME environment variable are not set,
6059 PYTHON3_HOME, which was specified at compile time, will be used for
6060 the Python 3 home directory.
6061 Environment variables are expanded |:set_env|.
6062 This option cannot be set from a |modeline| or in the |sandbox|, for
6063 security reasons.
6064
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01006065 *'pyxversion'* *'pyx'*
6066'pyxversion' 'pyx' number (default depends on the build)
6067 global
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01006068 {only available when compiled with the |+python| or
6069 the |+python3| feature}
6070 Specifies the python version used for pyx* functions and commands
6071 |python_x|. The default value is as follows:
6072
6073 Compiled with Default ~
6074 |+python| and |+python3| 0
6075 only |+python| 2
6076 only |+python3| 3
6077
6078 Available values are 0, 2 and 3.
6079 If 'pyxversion' is 0, it is set to 2 or 3 after the first execution of
6080 any python2/3 commands or functions. E.g. `:py` sets to 2, and `:py3`
6081 sets to 3. `:pyx` sets it to 3 if Python 3 is available, otherwise sets
6082 to 2 if Python 2 is available.
6083 See also: |has-pythonx|
6084
6085 If Vim is compiled with only |+python| or |+python3| setting
6086 'pyxversion' has no effect. The pyx* functions and commands are
6087 always the same as the compiled version.
6088
6089 This option cannot be set from a |modeline| or in the |sandbox|, for
6090 security reasons.
6091
Bram Moolenaar858ba062020-05-31 23:11:59 +02006092 *'quickfixtextfunc'* *'qftf'*
6093'quickfixtextfunc' 'qftf' string (default "")
6094 global
6095 {only available when compiled with the |+quickfix|
6096 feature}
6097 This option specifies a function to be used to get the text to display
6098 in the quickfix and location list windows. This can be used to
6099 customize the information displayed in the quickfix or location window
6100 for each entry in the corresponding quickfix or location list. See
6101 |quickfix-window-function| for an explanation of how to write the
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +00006102 function and an example. The value can be the name of a function, a
6103 |lambda| or a |Funcref|. See |option-value-function| for more
6104 information.
Bram Moolenaar858ba062020-05-31 23:11:59 +02006105
6106 This option cannot be set from a |modeline| or in the |sandbox|, for
6107 security reasons.
6108
Bram Moolenaar677ee682005-01-27 14:41:15 +00006109 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00006110'quoteescape' 'qe' string (default "\")
6111 local to buffer
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00006112 The characters that are used to escape quotes in a string. Used for
6113 objects like a', a" and a` |a'|.
6114 When one of the characters in this option is found inside a string,
6115 the following character will be skipped. The default value makes the
6116 text "foo\"bar\\" considered to be one string.
6117
Bram Moolenaar071d4272004-06-13 20:20:40 +00006118 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
6119'readonly' 'ro' boolean (default off)
6120 local to buffer
6121 If on, writes fail unless you use a '!'. Protects you from
6122 accidentally overwriting a file. Default on when Vim is started
6123 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006124 When using ":w!" the 'readonly' option is reset for the current
6125 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar6c60f472019-04-28 16:00:35 +02006126 When using the ":view" command the 'readonly' option is set for the
6127 newly edited buffer.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01006128 See 'modifiable' for disallowing changes to the buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006129
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006130 *'redrawtime'* *'rdt'*
6131'redrawtime' 'rdt' number (default 2000)
6132 global
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006133 {only available when compiled with the |+reltime|
6134 feature}
6135 The time in milliseconds for redrawing the display. This applies to
Bram Moolenaar15142e22018-04-30 22:19:58 +02006136 searching for patterns for 'hlsearch', |:match| highlighting and syntax
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02006137 highlighting.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006138 When redrawing takes more than this many milliseconds no further
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02006139 matches will be highlighted.
6140 For syntax highlighting the time applies per window. When over the
6141 limit syntax highlighting is disabled until |CTRL-L| is used.
6142 This is used to avoid that Vim hangs when using a very complicated
6143 pattern.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006144
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02006145 *'regexpengine'* *'re'*
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006146'regexpengine' 're' number (default 0)
6147 global
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006148 This selects the default regexp engine. |two-engines|
6149 The possible values are:
6150 0 automatic selection
6151 1 old engine
6152 2 NFA engine
6153 Note that when using the NFA engine and the pattern contains something
6154 that is not supported the pattern will not match. This is only useful
6155 for debugging the regexp engine.
Bram Moolenaarfda37292014-11-05 14:27:36 +01006156 Using automatic selection enables Vim to switch the engine, if the
6157 default engine becomes too costly. E.g., when the NFA engine uses too
6158 many states. This should prevent Vim from hanging on a combination of
6159 a complex pattern with long text.
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006160
Bram Moolenaar64486672010-05-16 15:46:46 +02006161 *'relativenumber'* *'rnu'* *'norelativenumber'* *'nornu'*
6162'relativenumber' 'rnu' boolean (default off)
6163 local to window
Bram Moolenaar64486672010-05-16 15:46:46 +02006164 Show the line number relative to the line with the cursor in front of
Bram Moolenaar06b5d512010-05-22 15:37:44 +02006165 each line. Relative line numbers help you use the |count| you can
Bram Moolenaar64486672010-05-16 15:46:46 +02006166 precede some vertical motion commands (e.g. j k + -) with, without
6167 having to calculate it yourself. Especially useful in combination with
6168 other commands (e.g. y d c < > gq gw =).
6169 When the 'n' option is excluded from 'cpoptions' a wrapped
6170 line will not use the column of line numbers (this is the default when
6171 'compatible' isn't set).
6172 The 'numberwidth' option can be used to set the room used for the line
6173 number.
6174 When a long, wrapped line doesn't start with the first character, '-'
6175 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02006176 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
6177 the number.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01006178
Bram Moolenaar203d04d2013-06-06 21:36:40 +02006179 The number in front of the cursor line also depends on the value of
6180 'number', see |number_relativenumber| for all combinations of the two
6181 options.
Bram Moolenaar64486672010-05-16 15:46:46 +02006182
Bram Moolenaar071d4272004-06-13 20:20:40 +00006183 *'remap'* *'noremap'*
6184'remap' boolean (default on)
6185 global
6186 Allows for mappings to work recursively. If you do not want this for
6187 a single entry, use the :noremap[!] command.
Bram Moolenaara3227e22006-03-08 21:32:40 +00006188 NOTE: To avoid portability problems with Vim scripts, always keep
6189 this option at the default "on". Only switch it off when working with
6190 old Vi scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006191
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006192 *'renderoptions'* *'rop'*
6193'renderoptions' 'rop' string (default: empty)
6194 global
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006195 {only available when compiled with GUI and DIRECTX on
6196 MS-Windows}
6197 Select a text renderer and set its options. The options depend on the
6198 renderer.
6199
6200 Syntax: >
6201 set rop=type:{renderer}(,{name}:{value})*
6202<
6203 Currently, only one optional renderer is available.
6204
6205 render behavior ~
6206 directx Vim will draw text using DirectX (DirectWrite). It makes
6207 drawn glyphs more beautiful than default GDI.
6208 It requires 'encoding' is "utf-8", and only works on
6209 MS-Windows Vista or newer version.
6210
6211 Options:
6212 name meaning type value ~
6213 gamma gamma float 1.0 - 2.2 (maybe)
6214 contrast enhancedContrast float (unknown)
6215 level clearTypeLevel float (unknown)
6216 geom pixelGeometry int 0 - 2 (see below)
6217 renmode renderingMode int 0 - 6 (see below)
6218 taamode textAntialiasMode int 0 - 3 (see below)
Bram Moolenaara338adc2018-01-31 20:51:47 +01006219 scrlines Scroll Lines int (deprecated)
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006220
Bram Moolenaar92467d32017-12-05 13:22:16 +01006221 See this URL for detail (except for scrlines):
6222 https://msdn.microsoft.com/en-us/library/dd368190.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006223
6224 For geom: structure of a device pixel.
6225 0 - DWRITE_PIXEL_GEOMETRY_FLAT
6226 1 - DWRITE_PIXEL_GEOMETRY_RGB
6227 2 - DWRITE_PIXEL_GEOMETRY_BGR
6228
6229 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006230 https://msdn.microsoft.com/en-us/library/dd368114.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006231
6232 For renmode: method of rendering glyphs.
6233 0 - DWRITE_RENDERING_MODE_DEFAULT
6234 1 - DWRITE_RENDERING_MODE_ALIASED
6235 2 - DWRITE_RENDERING_MODE_GDI_CLASSIC
6236 3 - DWRITE_RENDERING_MODE_GDI_NATURAL
6237 4 - DWRITE_RENDERING_MODE_NATURAL
6238 5 - DWRITE_RENDERING_MODE_NATURAL_SYMMETRIC
6239 6 - DWRITE_RENDERING_MODE_OUTLINE
6240
6241 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006242 https://msdn.microsoft.com/en-us/library/dd368118.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006243
6244 For taamode: antialiasing mode used for drawing text.
6245 0 - D2D1_TEXT_ANTIALIAS_MODE_DEFAULT
6246 1 - D2D1_TEXT_ANTIALIAS_MODE_CLEARTYPE
6247 2 - D2D1_TEXT_ANTIALIAS_MODE_GRAYSCALE
6248 3 - D2D1_TEXT_ANTIALIAS_MODE_ALIASED
6249
6250 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006251 https://msdn.microsoft.com/en-us/library/dd368170.aspx
6252
Bram Moolenaara338adc2018-01-31 20:51:47 +01006253 For scrlines:
6254 This was used for optimizing scrolling behavior, however this
6255 is now deprecated. If specified, it is simply ignored.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006256
6257 Example: >
6258 set encoding=utf-8
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006259 set gfn=Ricty_Diminished:h12
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006260 set rop=type:directx
6261<
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006262 If select a raster font (Courier, Terminal or FixedSys which
6263 have ".fon" extension in file name) to 'guifont', it will be
Bram Moolenaar92467d32017-12-05 13:22:16 +01006264 drawn by GDI as a fallback.
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006265
6266 NOTE: It is known that some fonts and options combination
6267 causes trouble on drawing glyphs.
6268
Bram Moolenaar92467d32017-12-05 13:22:16 +01006269 - 'renmode:5' and 'renmode:6' will not work with some
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006270 special made fonts (True-Type fonts which includes only
6271 bitmap glyphs).
6272 - 'taamode:3' will not work with some vector fonts.
6273
6274 NOTE: With this option, you can display colored emoji
6275 (emoticon) in Windows 8.1 or later. To display colored emoji,
6276 there are some conditions which you should notice.
6277
6278 - If your font includes non-colored emoji already, it will
6279 be used.
6280 - If your font doesn't have emoji, the system chooses an
6281 alternative symbol font. On Windows 10, "Segoe UI Emoji"
6282 will be used.
6283 - When this alternative font didn't have fixed width glyph,
6284 emoji might be rendered beyond the bounding box of drawing
6285 cell.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006286
6287 Other render types are currently not supported.
6288
Bram Moolenaar071d4272004-06-13 20:20:40 +00006289 *'report'*
6290'report' number (default 2)
6291 global
6292 Threshold for reporting number of lines changed. When the number of
6293 changed lines is more than 'report' a message will be given for most
6294 ":" commands. If you want it always, set 'report' to 0.
6295 For the ":substitute" command the number of substitutions is used
6296 instead of the number of lines.
6297
6298 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
6299'restorescreen' 'rs' boolean (default on)
6300 global
Bram Moolenaar8024f932020-01-14 19:29:13 +01006301 {only in MS-Windows console version}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006302 When set, the screen contents is restored when exiting Vim. This also
6303 happens when executing external commands.
6304
6305 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
6306 options in your .vimrc. To disable restoring:
6307 set t_ti= t_te=
6308 To enable restoring (for an xterm):
6309 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
6310 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
6311
6312 *'revins'* *'ri'* *'norevins'* *'nori'*
6313'revins' 'ri' boolean (default off)
6314 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006315 {only available when compiled with the |+rightleft|
6316 feature}
6317 Inserting characters in Insert mode will work backwards. See "typing
6318 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
6319 command in Insert mode, when 'allowrevins' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02006320 NOTE: This option is reset when 'compatible' is set.
6321 This option is reset when 'paste' is set and restored when 'paste' is
6322 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006323
6324 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
6325'rightleft' 'rl' boolean (default off)
6326 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006327 {only available when compiled with the |+rightleft|
6328 feature}
6329 When on, display orientation becomes right-to-left, i.e., characters
6330 that are stored in the file appear from the right to the left.
6331 Using this option, it is possible to edit files for languages that
6332 are written from the right to the left such as Hebrew and Arabic.
6333 This option is per window, so it is possible to edit mixed files
6334 simultaneously, or to view the same file in both ways (this is
6335 useful whenever you have a mixed text file with both right-to-left
6336 and left-to-right strings so that both sets are displayed properly
6337 in different windows). Also see |rileft.txt|.
6338
Bram Moolenaar607cc1e2010-07-18 18:47:44 +02006339 *'rightleftcmd'* *'rlc'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006340'rightleftcmd' 'rlc' string (default "search")
6341 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006342 {only available when compiled with the |+rightleft|
6343 feature}
6344 Each word in this option enables the command line editing to work in
6345 right-to-left mode for a group of commands:
6346
6347 search "/" and "?" commands
6348
6349 This is useful for languages such as Hebrew, Arabic and Farsi.
6350 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
6351
Bram Moolenaard94464e2015-11-02 15:28:18 +01006352 *'rubydll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01006353'rubydll' string (default: depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01006354 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01006355 {only available when compiled with the |+ruby/dyn|
6356 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006357 Specifies the name of the Ruby shared library. The default is
6358 DYNAMIC_RUBY_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006359 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01006360 This option cannot be set from a |modeline| or in the |sandbox|, for
6361 security reasons.
6362
Bram Moolenaar071d4272004-06-13 20:20:40 +00006363 *'ruler'* *'ru'* *'noruler'* *'noru'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02006364'ruler' 'ru' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006365 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006366 {not available when compiled without the
6367 |+cmdline_info| feature}
6368 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006369 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00006370 text in the file is shown on the far right:
6371 Top first line is visible
6372 Bot last line is visible
6373 All first and last line are visible
6374 45% relative position in the file
6375 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006376 Each window has its own ruler. If a window has a status line, the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006377 ruler is shown there. Otherwise it is shown in the last line of the
Bram Moolenaar582fd852005-03-28 20:58:01 +00006378 screen. If the statusline is given by 'statusline' (i.e. not empty),
Bram Moolenaar071d4272004-06-13 20:20:40 +00006379 this option takes precedence over 'ruler' and 'rulerformat'
6380 If the number of characters displayed is different from the number of
Bram Moolenaar207f0092020-08-30 17:20:20 +02006381 bytes in the text (e.g., for a TAB or a multibyte character), both
Bram Moolenaar071d4272004-06-13 20:20:40 +00006382 the text column (byte number) and the screen column are shown,
6383 separated with a dash.
6384 For an empty line "0-1" is shown.
6385 For an empty buffer the line number will also be zero: "0,0-1".
Bram Moolenaarca635012015-09-25 20:34:21 +02006386 This option is reset when 'paste' is set and restored when 'paste' is
6387 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006388 If you don't want to see the ruler all the time but want to know where
6389 you are, use "g CTRL-G" |g_CTRL-G|.
6390 NOTE: This option is reset when 'compatible' is set.
6391
6392 *'rulerformat'* *'ruf'*
6393'rulerformat' 'ruf' string (default empty)
6394 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006395 {not available when compiled without the |+statusline|
6396 feature}
6397 When this option is not empty, it determines the content of the ruler
6398 string, as displayed for the 'ruler' option.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00006399 The format of this option is like that of 'statusline'.
Bram Moolenaar110289e2019-05-23 15:38:06 +02006400 This option cannot be set in a modeline when 'modelineexpr' is off.
6401
Bram Moolenaar071d4272004-06-13 20:20:40 +00006402 The default ruler width is 17 characters. To make the ruler 15
6403 characters wide, put "%15(" at the start and "%)" at the end.
6404 Example: >
6405 :set rulerformat=%15(%c%V\ %p%%%)
6406<
6407 *'runtimepath'* *'rtp'* *vimfiles*
6408'runtimepath' 'rtp' string (default:
Bram Moolenaar942db232021-02-13 18:14:48 +01006409 Unix: "$HOME/.vim,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006410 $VIM/vimfiles,
6411 $VIMRUNTIME,
6412 $VIM/vimfiles/after,
6413 $HOME/.vim/after"
6414 Amiga: "home:vimfiles,
6415 $VIM/vimfiles,
6416 $VIMRUNTIME,
6417 $VIM/vimfiles/after,
6418 home:vimfiles/after"
Bram Moolenaar942db232021-02-13 18:14:48 +01006419 MS-Windows: "$HOME/vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006420 $VIM/vimfiles,
6421 $VIMRUNTIME,
6422 $VIM/vimfiles/after,
6423 $HOME/vimfiles/after"
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02006424 macOS: "$VIM:vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006425 $VIMRUNTIME,
6426 $VIM:vimfiles:after"
Bram Moolenaarb3f74062020-02-26 16:16:53 +01006427 Haiku: "$BE_USER_SETTINGS/vim,
6428 $VIM/vimfiles,
6429 $VIMRUNTIME,
6430 $VIM/vimfiles/after,
Bram Moolenaar942db232021-02-13 18:14:48 +01006431 $BE_USER_SETTINGS/vim/after"
6432 VMS: "sys$login:vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006433 $VIM/vimfiles,
6434 $VIMRUNTIME,
6435 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00006436 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006437 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006438 This is a list of directories which will be searched for runtime
6439 files:
6440 filetype.vim filetypes by file name |new-filetype|
6441 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006442 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006443 colors/ color scheme files |:colorscheme|
6444 compiler/ compiler files |:compiler|
6445 doc/ documentation |write-local-help|
6446 ftplugin/ filetype plugins |write-filetype-plugin|
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01006447 import/ files that are found by `:import`
Bram Moolenaar071d4272004-06-13 20:20:40 +00006448 indent/ indent scripts |indent-expression|
6449 keymap/ key mapping files |mbyte-keymap|
6450 lang/ menu translations |:menutrans|
6451 menu.vim GUI menus |menu.vim|
Bram Moolenaar26852122016-05-24 20:02:38 +02006452 pack/ packages |:packadd|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006453 plugin/ plugin scripts |write-plugin|
6454 print/ files for printing |postscript-print-encoding|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006455 spell/ spell checking files |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006456 syntax/ syntax files |mysyntaxfile|
6457 tutor/ files for vimtutor |tutor|
6458
6459 And any other file searched for with the |:runtime| command.
6460
6461 The defaults for most systems are setup to search five locations:
6462 1. In your home directory, for your personal preferences.
6463 2. In a system-wide Vim directory, for preferences from the system
6464 administrator.
6465 3. In $VIMRUNTIME, for files distributed with Vim.
6466 *after-directory*
6467 4. In the "after" directory in the system-wide Vim directory. This is
6468 for the system administrator to overrule or add to the distributed
6469 defaults (rarely needed)
6470 5. In the "after" directory in your home directory. This is for
6471 personal preferences to overrule or add to the distributed defaults
6472 or system-wide settings (rarely needed).
6473
Bram Moolenaard0796902016-09-16 20:02:31 +02006474 More entries are added when using |packages|. If it gets very long
6475 then `:set rtp` will be truncated, use `:echo &rtp` to see the full
6476 string.
Bram Moolenaar26852122016-05-24 20:02:38 +02006477
Bram Moolenaar071d4272004-06-13 20:20:40 +00006478 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
6479 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006480 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00006481 wildcards.
6482 See |:runtime|.
6483 Example: >
6484 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
6485< This will use the directory "~/vimruntime" first (containing your
6486 personal Vim runtime files), then "/mygroup/vim" (shared between a
6487 group of people) and finally "$VIMRUNTIME" (the distributed runtime
6488 files).
6489 You probably should always include $VIMRUNTIME somewhere, to use the
6490 distributed runtime files. You can put a directory before $VIMRUNTIME
6491 to find files which replace a distributed runtime files. You can put
6492 a directory after $VIMRUNTIME to find files which add to distributed
6493 runtime files.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006494 When Vim is started with |--clean| the home directory entries are not
6495 included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006496 This option cannot be set from a |modeline| or in the |sandbox|, for
6497 security reasons.
6498
6499 *'scroll'* *'scr'*
6500'scroll' 'scr' number (default: half the window height)
6501 local to window
6502 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
6503 set to half the number of lines in the window when the window size
Bram Moolenaar74667062020-12-28 15:41:41 +01006504 changes. This may happen when enabling the |status-line| or
6505 'tabline' option after setting the 'scroll' option.
6506 If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006507 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar25c9c682019-05-05 18:13:34 +02006508 height with ":set scroll=0".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006509
6510 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
6511'scrollbind' 'scb' boolean (default off)
6512 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006513 See also |scroll-binding|. When this option is set, the current
6514 window scrolls as other scrollbind windows (windows that also have
6515 this option set) scroll. This option is useful for viewing the
6516 differences between two versions of a file, see 'diff'.
6517 See |'scrollopt'| for options that determine how this option should be
6518 interpreted.
6519 This option is mostly reset when splitting a window to edit another
6520 file. This means that ":split | edit file" results in two windows
6521 with scroll-binding, but ":split file" does not.
6522
Bram Moolenaarae20f342019-11-05 21:09:23 +01006523 *'scrollfocus'* *'scf'* *'noscrollfocus'* *'noscf'*
6524'scrollfocus' 'scf' boolean (default off)
6525 global
6526 {only for MS-Windows GUI}
6527 When using the scroll wheel and this option is set, the window under
6528 the mouse pointer is scrolled. With this option off the current
6529 window is scrolled.
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01006530 Systems other than MS-Windows always behave like this option is on.
Bram Moolenaarae20f342019-11-05 21:09:23 +01006531
Bram Moolenaar071d4272004-06-13 20:20:40 +00006532 *'scrolljump'* *'sj'*
6533'scrolljump' 'sj' number (default 1)
6534 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006535 Minimal number of lines to scroll when the cursor gets off the
6536 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
6537 CTRL-D). Useful if your terminal scrolls very slowly.
Bram Moolenaar1e015462005-09-25 22:16:38 +00006538 When set to a negative number from -1 to -100 this is used as the
6539 percentage of the window height. Thus -50 scrolls half the window
6540 height.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006541 NOTE: This option is set to 1 when 'compatible' is set.
6542
6543 *'scrolloff'* *'so'*
Bram Moolenaar50ba5262016-09-22 22:33:02 +02006544'scrolloff' 'so' number (default 0, set to 5 in |defaults.vim|)
Bram Moolenaar375e3392019-01-31 18:26:10 +01006545 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006546 Minimal number of screen lines to keep above and below the cursor.
6547 This will make some context visible around where you are working. If
6548 you set it to a very large value (999) the cursor line will always be
6549 in the middle of the window (except at the start or end of the file or
6550 when long lines wrap).
Bram Moolenaar375e3392019-01-31 18:26:10 +01006551 After using the local value, go back the global value with one of
6552 these two: >
6553 setlocal scrolloff<
6554 setlocal scrolloff=-1
6555< For scrolling horizontally see 'sidescrolloff'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006556 NOTE: This option is set to 0 when 'compatible' is set.
6557
6558 *'scrollopt'* *'sbo'*
6559'scrollopt' 'sbo' string (default "ver,jump")
6560 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006561 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006562 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
6563 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006564 The following words are available:
6565 ver Bind vertical scrolling for 'scrollbind' windows
6566 hor Bind horizontal scrolling for 'scrollbind' windows
6567 jump Applies to the offset between two windows for vertical
6568 scrolling. This offset is the difference in the first
6569 displayed line of the bound windows. When moving
6570 around in a window, another 'scrollbind' window may
6571 reach a position before the start or after the end of
6572 the buffer. The offset is not changed though, when
6573 moving back the 'scrollbind' window will try to scroll
6574 to the desired position when possible.
6575 When now making that window the current one, two
6576 things can be done with the relative offset:
6577 1. When "jump" is not included, the relative offset is
6578 adjusted for the scroll position in the new current
6579 window. When going back to the other window, the
Bram Moolenaar02467872007-05-06 13:22:01 +00006580 new relative offset will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006581 2. When "jump" is included, the other windows are
6582 scrolled to keep the same relative offset. When
6583 going back to the other window, it still uses the
6584 same relative offset.
6585 Also see |scroll-binding|.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006586 When 'diff' mode is active there always is vertical scroll binding,
6587 even when "ver" isn't there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006588
6589 *'sections'* *'sect'*
6590'sections' 'sect' string (default "SHNHH HUnhsh")
6591 global
6592 Specifies the nroff macros that separate sections. These are pairs of
6593 two letters (See |object-motions|). The default makes a section start
6594 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
6595
6596 *'secure'* *'nosecure'* *E523*
6597'secure' boolean (default off)
6598 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006599 When on, ":autocmd", shell and write commands are not allowed in
6600 ".vimrc" and ".exrc" in the current directory and map commands are
6601 displayed. Switch it off only if you know that you will not run into
6602 problems, or when the 'exrc' option is off. On Unix this option is
6603 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006604 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00006605 'secure' at the end of your ~/.vimrc then.
6606 This option cannot be set from a |modeline| or in the |sandbox|, for
6607 security reasons.
6608
6609 *'selection'* *'sel'*
6610'selection' 'sel' string (default "inclusive")
6611 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006612 This option defines the behavior of the selection. It is only used
6613 in Visual and Select mode.
6614 Possible values:
6615 value past line inclusive ~
6616 old no yes
6617 inclusive yes yes
6618 exclusive yes no
6619 "past line" means that the cursor is allowed to be positioned one
6620 character past the line.
6621 "inclusive" means that the last character of the selection is included
6622 in an operation. For example, when "x" is used to delete the
6623 selection.
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02006624 When "old" is used and 'virtualedit' allows the cursor to move past
6625 the end of line the line break still isn't included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006626 Note that when "exclusive" is used and selecting from the end
6627 backwards, you cannot include the last character of a line, when
6628 starting in Normal mode and 'virtualedit' empty.
6629
6630 The 'selection' option is set by the |:behave| command.
6631
6632 *'selectmode'* *'slm'*
6633'selectmode' 'slm' string (default "")
6634 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006635 This is a comma separated list of words, which specifies when to start
6636 Select mode instead of Visual mode, when a selection is started.
6637 Possible values:
6638 mouse when using the mouse
6639 key when using shifted special keys
6640 cmd when using "v", "V" or CTRL-V
6641 See |Select-mode|.
6642 The 'selectmode' option is set by the |:behave| command.
6643
6644 *'sessionoptions'* *'ssop'*
6645'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006646 help,options,tabpages,winsize,terminal")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006647 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02006648 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006649 feature}
6650 Changes the effect of the |:mksession| command. It is a comma
6651 separated list of words. Each word enables saving and restoring
6652 something:
6653 word save and restore ~
6654 blank empty windows
6655 buffers hidden and unloaded buffers, not just those in windows
6656 curdir the current directory
6657 folds manually created folds, opened/closed folds and local
6658 fold options
6659 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00006660 and contain at least one lowercase letter. Only
6661 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006662 help the help window
6663 localoptions options and mappings local to a window or buffer (not
6664 global values for local options)
6665 options all options and mappings (also global values for local
6666 options)
Bram Moolenaard23b7142021-04-17 21:04:34 +02006667 skiprtp exclude 'runtimepath' and 'packpath' from the options
Bram Moolenaar071d4272004-06-13 20:20:40 +00006668 resize size of the Vim window: 'lines' and 'columns'
6669 sesdir the directory in which the session file is located
6670 will become the current directory (useful with
6671 projects accessed over a network from different
6672 systems)
6673 slash backslashes in file names replaced with forward
6674 slashes
Bram Moolenaar18144c82006-04-12 21:52:12 +00006675 tabpages all tab pages; without this only the current tab page
6676 is restored, so that you can make a session for each
6677 tab page separately
Bram Moolenaard473c8c2018-08-11 18:00:22 +02006678 terminal include terminal windows where the command can be
6679 restored
Bram Moolenaar071d4272004-06-13 20:20:40 +00006680 unix with Unix end-of-line format (single <NL>), even when
6681 on Windows or DOS
6682 winpos position of the whole Vim window
6683 winsize window sizes
6684
6685 Don't include both "curdir" and "sesdir".
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006686 When neither "curdir" nor "sesdir" is included, file names are stored
6687 with absolute paths.
Bram Moolenaar2f0936c2022-01-08 21:51:59 +00006688 If you leave out "options" many things won't work well after restoring
6689 the session.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006690 "slash" and "unix" are useful on Windows when sharing session files
6691 with Unix. The Unix version of Vim cannot source dos format scripts,
6692 but the Windows version of Vim can source unix format scripts.
6693
6694 *'shell'* *'sh'* *E91*
Bram Moolenaar95a9dd12019-12-19 22:12:03 +01006695'shell' 'sh' string (default $SHELL or "sh", Win32: "cmd.exe")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006696 global
6697 Name of the shell to use for ! and :! commands. When changing the
6698 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
6699 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006700 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006701 See |option-backslash| about including spaces and backslashes.
6702 Environment variables are expanded |:set_env|.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006703
Bram Moolenaar1ff14ba2019-11-02 14:09:23 +01006704 If the name of the shell contains a space, you need to enclose it in
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01006705 quotes and escape the space. Example with quotes: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006706 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
6707< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006708 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006709 "-f" is not inside the quotes, because it is not part of the command
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006710 name. Vim automagically recognizes the backslashes that are path
Bram Moolenaar071d4272004-06-13 20:20:40 +00006711 separators.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006712 Example with escaped space (Vim will do this when initializing the
6713 option from $SHELL): >
6714 :set shell=/bin/with\\\ space/sh
Bram Moolenaard473c8c2018-08-11 18:00:22 +02006715< The resulting value of 'shell' is "/bin/with\ space/sh", two
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006716 backslashes are consumed by `:set`.
6717
Bram Moolenaar071d4272004-06-13 20:20:40 +00006718 Under MS-Windows, when the executable ends in ".com" it must be
6719 included. Thus setting the shell to "command.com" or "4dos.com"
6720 works, but "command" and "4dos" do not work for all commands (e.g.,
6721 filtering).
6722 For unknown reasons, when using "4dos.com" the current directory is
6723 changed to "C:\". To avoid this set 'shell' like this: >
6724 :set shell=command.com\ /c\ 4dos
6725< This option cannot be set from a |modeline| or in the |sandbox|, for
6726 security reasons.
6727
6728 *'shellcmdflag'* *'shcf'*
Bram Moolenaar5dc62522012-02-13 00:05:22 +01006729'shellcmdflag' 'shcf' string (default: "-c";
Mike Williams12795022021-06-28 20:53:58 +02006730 Win32, when 'shell' contains "powershell":
6731 "-Command", or when it does not contain "sh"
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006732 somewhere: "/c")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006733 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006734 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
Mike Williams12795022021-06-28 20:53:58 +02006735 "bash.exe -c ls", "powershell.exe -Command dir", or "cmd.exe /c dir".
6736 For MS-Windows, the default is set according to the value of 'shell',
6737 to reduce the need to set this option by the user.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02006738 On Unix it can have more than one flag. Each white space separated
6739 part is passed as an argument to the shell command.
6740 See |option-backslash| about including spaces and backslashes.
Mike Williams12795022021-06-28 20:53:58 +02006741 Also see |dos-shell| and |dos-powershell| for MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006742 This option cannot be set from a |modeline| or in the |sandbox|, for
6743 security reasons.
6744
6745 *'shellpipe'* *'sp'*
Mike Williams12795022021-06-28 20:53:58 +02006746'shellpipe' 'sp' string (default ">", ">%s 2>&1", "| tee", "|& tee"
6747 "2>&1| tee", or
6748 "2>&1 | Out-File -Encoding default")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006749 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006750 {not available when compiled without the |+quickfix|
6751 feature}
6752 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006753 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00006754 including spaces and backslashes.
6755 The name of the temporary file can be represented by "%s" if necessary
6756 (the file name is appended automatically if no %s appears in the value
6757 of this option).
Mike Williams12795022021-06-28 20:53:58 +02006758 For the Amiga the default is ">". For MS-Windows using powershell the
6759 default is "2>&1 | Out-File -Encoding default", otherwise the default
6760 is ">%s 2>&1". The output is directly saved in a file and not echoed
6761 to the screen.
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02006762 For Unix the default is "| tee". The stdout of the compiler is saved
Bram Moolenaar071d4272004-06-13 20:20:40 +00006763 in a file and echoed to the screen. If the 'shell' option is "csh" or
6764 "tcsh" after initializations, the default becomes "|& tee". If the
Bram Moolenaar96f45c02019-10-26 19:53:45 +02006765 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh", "zsh-beta",
Natanael Copa56318362021-05-06 18:46:35 +02006766 "bash", "fish", "ash" or "dash" the default becomes "2>&1| tee". This
6767 means that stderr is also included. Before using the 'shell' option a
6768 path is removed, thus "/bin/sh" uses "sh".
Mike Williamsa3d1b292021-06-30 20:56:00 +02006769 For Unix and MS-Windows, when the 'shell' option is "pwsh" the default
6770 becomes ">%s 2>&1" and the output is not echoed to the screen.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006771 The initialization of this option is done after reading the ".vimrc"
6772 and the other initializations, so that when the 'shell' option is set
6773 there, the 'shellpipe' option changes automatically, unless it was
6774 explicitly set before.
6775 When 'shellpipe' is set to an empty string, no redirection of the
6776 ":make" output will be done. This is useful if you use a 'makeprg'
6777 that writes to 'makeef' by itself. If you want no piping, but do
6778 want to include the 'makeef', set 'shellpipe' to a single space.
6779 Don't forget to precede the space with a backslash: ":set sp=\ ".
6780 In the future pipes may be used for filtering and this option will
6781 become obsolete (at least for Unix).
6782 This option cannot be set from a |modeline| or in the |sandbox|, for
6783 security reasons.
6784
6785 *'shellquote'* *'shq'*
Mike Williamsa3d1b292021-06-30 20:56:00 +02006786'shellquote' 'shq' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006787 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006788 Quoting character(s), put around the command passed to the shell, for
6789 the "!" and ":!" commands. The redirection is kept outside of the
6790 quoting. See 'shellxquote' to include the redirection. It's
6791 probably not useful to set both options.
6792 This is an empty string by default. Only known to be useful for
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006793 third-party shells on MS-Windows-like systems, such as the MKS Korn
Mike Williamsa3d1b292021-06-30 20:56:00 +02006794 Shell or bash, where it should be "\"". See |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006795 This option cannot be set from a |modeline| or in the |sandbox|, for
6796 security reasons.
6797
6798 *'shellredir'* *'srr'*
Mike Williams12795022021-06-28 20:53:58 +02006799'shellredir' 'srr' string (default ">", ">&", ">%s 2>&1", or
6800 "2>&1 | Out-File -Encoding default")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006801 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006802 String to be used to put the output of a filter command in a temporary
6803 file. See also |:!|. See |option-backslash| about including spaces
6804 and backslashes.
6805 The name of the temporary file can be represented by "%s" if necessary
6806 (the file name is appended automatically if no %s appears in the value
6807 of this option).
Bram Moolenaar96f45c02019-10-26 19:53:45 +02006808 The default is ">". For Unix, if the 'shell' option is "csh" or
6809 "tcsh" during initializations, the default becomes ">&". If the
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01006810 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh", "zsh-beta",
Mike Williamsa3d1b292021-06-30 20:56:00 +02006811 "bash", "fish", or "pwsh", the default becomes ">%s 2>&1". This means
6812 that stderr is also included. For Win32, the Unix checks are done and
Mike Williams12795022021-06-28 20:53:58 +02006813 additionally "cmd" is checked for, which makes the default ">%s 2>&1",
6814 and "powershell" is checked for which makes the default
Mike Williamsa3d1b292021-06-30 20:56:00 +02006815 "2>&1 | Out-File -Encoding default" (see |dos-powershell|). Also, the
6816 same names with ".exe" appended are checked for.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006817 The initialization of this option is done after reading the ".vimrc"
6818 and the other initializations, so that when the 'shell' option is set
6819 there, the 'shellredir' option changes automatically unless it was
6820 explicitly set before.
6821 In the future pipes may be used for filtering and this option will
6822 become obsolete (at least for Unix).
6823 This option cannot be set from a |modeline| or in the |sandbox|, for
6824 security reasons.
6825
6826 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
6827'shellslash' 'ssl' boolean (default off)
6828 global
Bram Moolenaar6f345a12019-12-17 21:27:18 +01006829 {only for MS-Windows}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006830 When set, a forward slash is used when expanding file names. This is
Mike Williamsa3d1b292021-06-30 20:56:00 +02006831 useful when a Unix-like shell is used instead of cmd.exe, pwsh.exe, or
Mike Williams12795022021-06-28 20:53:58 +02006832 powershell.exe. Backward slashes can still be typed, but they are
6833 changed to forward slashes by Vim.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006834 Note that setting or resetting this option has no effect for some
6835 existing file names, thus this option needs to be set before opening
6836 any file for best results. This might change in the future.
6837 'shellslash' only works when a backslash can be used as a path
6838 separator. To test if this is so use: >
6839 if exists('+shellslash')
Bram Moolenaarac3150d2019-07-28 16:36:39 +02006840< Also see 'completeslash'.
6841
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006842 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
6843'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
6844 global
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006845 When on, use temp files for shell commands. When off use a pipe.
6846 When using a pipe is not possible temp files are used anyway.
Bram Moolenaar97293012011-07-18 19:40:27 +02006847 Currently a pipe is only supported on Unix and MS-Windows 2K and
6848 later. You can check it with: >
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006849 :if has("filterpipe")
6850< The advantage of using a pipe is that nobody can read the temp file
6851 and the 'shell' command does not need to support redirection.
6852 The advantage of using a temp file is that the file type and encoding
6853 can be detected.
6854 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
6855 |FilterWritePost| autocommands event are not triggered when
6856 'shelltemp' is off.
Bram Moolenaar269f5952016-07-15 22:54:41 +02006857 The `system()` function does not respect this option and always uses
6858 temp files.
Bram Moolenaar036986f2017-03-16 17:41:02 +01006859 NOTE: This option is set to the Vim default value when 'compatible'
6860 is reset.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006861
Bram Moolenaar071d4272004-06-13 20:20:40 +00006862 *'shelltype'* *'st'*
6863'shelltype' 'st' number (default 0)
6864 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02006865 {only for the Amiga}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006866 On the Amiga this option influences the way how the commands work
6867 which use a shell.
6868 0 and 1: always use the shell
6869 2 and 3: use the shell only to filter lines
6870 4 and 5: use shell only for ':sh' command
6871 When not using the shell, the command is executed directly.
6872
6873 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
6874 1 and 3: use "shell cmd" to start external commands
6875
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006876 *'shellxescape'* *'sxe'*
6877'shellxescape' 'sxe' string (default: "";
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006878 for MS-Windows: "\"&|<>()@^")
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006879 global
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006880 When 'shellxquote' is set to "(" then the characters listed in this
6881 option will be escaped with a '^' character. This makes it possible
6882 to execute most external commands with cmd.exe.
6883
Bram Moolenaar071d4272004-06-13 20:20:40 +00006884 *'shellxquote'* *'sxq'*
6885'shellxquote' 'sxq' string (default: "";
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006886 for Win32, when 'shell' is cmd.exe: "("
Mike Williams12795022021-06-28 20:53:58 +02006887 for Win32, when 'shell' is
6888 powershell.exe: "\""
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006889 for Win32, when 'shell' contains "sh"
6890 somewhere: "\""
Bram Moolenaar071d4272004-06-13 20:20:40 +00006891 for Unix, when using system(): "\"")
6892 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006893 Quoting character(s), put around the command passed to the shell, for
6894 the "!" and ":!" commands. Includes the redirection. See
6895 'shellquote' to exclude the redirection. It's probably not useful
6896 to set both options.
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006897 When the value is '(' then ')' is appended. When the value is '"('
6898 then ')"' is appended.
6899 When the value is '(' then also see 'shellxescape'.
Bram Moolenaara64ba222012-02-12 23:23:31 +01006900 This is an empty string by default on most systems, but is known to be
Mike Williamsa3d1b292021-06-30 20:56:00 +02006901 useful for on Win32 version, either for cmd.exe, powershell.exe, or
6902 pwsh.exe which automatically strips off the first and last quote on a
6903 command, or 3rd-party shells such as the MKS Korn Shell or bash, where
6904 it should be "\"". The default is adjusted according the value of
Mike Williams12795022021-06-28 20:53:58 +02006905 'shell', to reduce the need to set this option by the user. See
6906 |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006907 This option cannot be set from a |modeline| or in the |sandbox|, for
6908 security reasons.
6909
6910 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
6911'shiftround' 'sr' boolean (default off)
6912 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006913 Round indent to multiple of 'shiftwidth'. Applies to > and <
6914 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
6915 a multiple of 'shiftwidth' (this is Vi compatible).
6916 NOTE: This option is reset when 'compatible' is set.
6917
6918 *'shiftwidth'* *'sw'*
6919'shiftwidth' 'sw' number (default 8)
6920 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006921 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00006922 |'cindent'|, |>>|, |<<|, etc.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02006923 When zero the 'ts' value will be used. Use the |shiftwidth()|
6924 function to get the effective shiftwidth value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006925
6926 *'shortmess'* *'shm'*
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02006927'shortmess' 'shm' string (Vim default "filnxtToOS", Vi default: "S",
6928 POSIX default: "AS")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006929 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006930 This option helps to avoid all the |hit-enter| prompts caused by file
6931 messages, for example with CTRL-G, and to avoid some other messages.
6932 It is a list of flags:
6933 flag meaning when present ~
6934 f use "(3 of 5)" instead of "(file 3 of 5)"
6935 i use "[noeol]" instead of "[Incomplete last line]"
Bram Moolenaar3f40ce72020-07-05 14:10:13 +02006936 l use "999L, 888B" instead of "999 lines, 888 bytes"
Bram Moolenaar071d4272004-06-13 20:20:40 +00006937 m use "[+]" instead of "[Modified]"
6938 n use "[New]" instead of "[New File]"
6939 r use "[RO]" instead of "[readonly]"
6940 w use "[w]" instead of "written" for file write message
6941 and "[a]" instead of "appended" for ':w >> file' command
6942 x use "[dos]" instead of "[dos format]", "[unix]" instead of
6943 "[unix format]" and "[mac]" instead of "[mac format]".
6944 a all of the above abbreviations
6945
6946 o overwrite message for writing a file with subsequent message
6947 for reading a file (useful for ":wn" or when 'autowrite' on)
6948 O message for reading a file overwrites any previous message.
6949 Also for quickfix message (e.g., ":cn").
6950 s don't give "search hit BOTTOM, continuing at TOP" or "search
Bram Moolenaara6c27c42019-05-09 19:16:22 +02006951 hit TOP, continuing at BOTTOM" messages; when using the search
6952 count do not show "W" after the count message (see S below)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006953 t truncate file message at the start if it is too long to fit
6954 on the command-line, "<" will appear in the left most column.
6955 Ignored in Ex mode.
6956 T truncate other messages in the middle if they are too long to
Bram Moolenaar582fd852005-03-28 20:58:01 +00006957 fit on the command line. "..." will appear in the middle.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006958 Ignored in Ex mode.
6959 W don't give "written" or "[w]" when writing a file
6960 A don't give the "ATTENTION" message when an existing swap file
6961 is found.
6962 I don't give the intro message when starting Vim |:intro|.
Bram Moolenaarea389e92014-05-28 21:40:52 +02006963 c don't give |ins-completion-menu| messages. For example,
6964 "-- XXX completion (YYY)", "match 1 of 2", "The only match",
6965 "Pattern not found", "Back at original", etc.
Bram Moolenaar426dd022016-03-15 15:09:29 +01006966 q use "recording" instead of "recording @a"
6967 F don't give the file info when editing a file, like `:silent`
Bram Moolenaar110289e2019-05-23 15:38:06 +02006968 was used for the command; note that this also affects messages
6969 from autocommands
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02006970 S do not show search count message when searching, e.g.
6971 "[1/5]"
Bram Moolenaar071d4272004-06-13 20:20:40 +00006972
6973 This gives you the opportunity to avoid that a change between buffers
6974 requires you to hit <Enter>, but still gives as useful a message as
6975 possible for the space available. To get the whole message that you
6976 would have got with 'shm' empty, use ":file!"
6977 Useful values:
6978 shm= No abbreviation of message.
6979 shm=a Abbreviation, but no loss of information.
6980 shm=at Abbreviation, and truncate message when necessary.
6981
6982 NOTE: This option is set to the Vi default value when 'compatible' is
6983 set and to the Vim default value when 'compatible' is reset.
6984
6985 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
6986'shortname' 'sn' boolean (default off)
6987 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00006988 Filenames are assumed to be 8 characters plus one extension of 3
6989 characters. Multiple dots in file names are not allowed. When this
6990 option is on, dots in file names are replaced with underscores when
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006991 adding an extension (".~" or ".swp"). This option is useful
Bram Moolenaar071d4272004-06-13 20:20:40 +00006992 when editing files on an MS-DOS compatible filesystem, e.g., messydos
Bram Moolenaarade0d392020-01-21 22:33:58 +01006993 or crossdos.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006994
6995 *'showbreak'* *'sbr'* *E595*
6996'showbreak' 'sbr' string (default "")
Bram Moolenaaree857022019-11-09 23:26:40 +01006997 global or local to window |global-local|
Bram Moolenaardb84e452010-08-15 13:50:43 +02006998 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006999 feature}
7000 String to put at the start of lines that have been wrapped. Useful
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007001 values are "> " or "+++ ": >
7002 :set showbreak=>\
7003< Note the backslash to escape the trailing space. It's easier like
7004 this: >
Bram Moolenaar1a384422010-07-14 19:53:30 +02007005 :let &showbreak = '+++ '
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007006< Only printable single-cell characters are allowed, excluding <Tab> and
Bram Moolenaar071d4272004-06-13 20:20:40 +00007007 comma (in a future version the comma might be used to separate the
7008 part that is shown at the end and at the start of a line).
7009 The characters are highlighted according to the '@' flag in
7010 'highlight'.
7011 Note that tabs after the showbreak will be displayed differently.
7012 If you want the 'showbreak' to appear in between line numbers, add the
7013 "n" flag to 'cpoptions'.
Bram Moolenaaree857022019-11-09 23:26:40 +01007014 A window-local value overrules a global value. If the global value is
7015 set and you want no value in the current window use NONE: >
7016 :setlocal showbreak=NONE
7017<
Bram Moolenaar071d4272004-06-13 20:20:40 +00007018 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02007019'showcmd' 'sc' boolean (Vim default: on, off for Unix,
7020 Vi default: off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007021 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007022 {not available when compiled without the
7023 |+cmdline_info| feature}
Bram Moolenaar02467872007-05-06 13:22:01 +00007024 Show (partial) command in the last line of the screen. Set this
7025 option off if your terminal is slow.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007026 In Visual mode the size of the selected area is shown:
7027 - When selecting characters within a line, the number of characters.
Bram Moolenaarf91787c2010-07-17 12:47:16 +02007028 If the number of bytes is different it is also displayed: "2-6"
7029 means two characters and six bytes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007030 - When selecting more than one line, the number of lines.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007031 - When selecting a block, the size in screen characters:
7032 {lines}x{columns}.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007033 NOTE: This option is set to the Vi default value when 'compatible' is
7034 set and to the Vim default value when 'compatible' is reset.
7035
7036 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
7037'showfulltag' 'sft' boolean (default off)
7038 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007039 When completing a word in insert mode (see |ins-completion|) from the
7040 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007041 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00007042 matched a C function, you can see a template for what arguments are
7043 required (coding style permitting).
Bram Moolenaar446cb832008-06-24 21:56:24 +00007044 Note that this doesn't work well together with having "longest" in
7045 'completeopt', because the completion from the search pattern may not
7046 match the typed text.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007047
7048 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
7049'showmatch' 'sm' boolean (default off)
7050 global
7051 When a bracket is inserted, briefly jump to the matching one. The
7052 jump is only done if the match can be seen on the screen. The time to
7053 show the match can be set with 'matchtime'.
7054 A Beep is given if there is no match (no matter if the match can be
Bram Moolenaarca635012015-09-25 20:34:21 +02007055 seen or not).
7056 This option is reset when 'paste' is set and restored when 'paste' is
7057 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007058 When the 'm' flag is not included in 'cpoptions', typing a character
7059 will immediately move the cursor back to where it belongs.
7060 See the "sm" field in 'guicursor' for setting the cursor shape and
7061 blinking when showing the match.
7062 The 'matchpairs' option can be used to specify the characters to show
7063 matches for. 'rightleft' and 'revins' are used to look for opposite
7064 matches.
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007065 Also see the matchparen plugin for highlighting the match when moving
7066 around |pi_paren.txt|.
7067 Note: Use of the short form is rated PG.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007068
7069 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
7070'showmode' 'smd' boolean (Vim default: on, Vi default: off)
7071 global
7072 If in Insert, Replace or Visual mode put a message on the last line.
7073 Use the 'M' flag in 'highlight' to set the type of highlighting for
7074 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007075 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00007076 doesn't mean XIM is really active, especially when 'imactivatekey' is
7077 not set.
7078 NOTE: This option is set to the Vi default value when 'compatible' is
7079 set and to the Vim default value when 'compatible' is reset.
7080
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007081 *'showtabline'* *'stal'*
7082'showtabline' 'stal' number (default 1)
7083 global
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007084 The value of this option specifies when the line with tab page labels
7085 will be displayed:
7086 0: never
7087 1: only if there are at least two tab pages
7088 2: always
7089 This is both for the GUI and non-GUI implementation of the tab pages
7090 line.
7091 See |tab-page| for more information about tab pages.
7092
Bram Moolenaar071d4272004-06-13 20:20:40 +00007093 *'sidescroll'* *'ss'*
7094'sidescroll' 'ss' number (default 0)
7095 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007096 The minimal number of columns to scroll horizontally. Used only when
7097 the 'wrap' option is off and the cursor is moved off of the screen.
7098 When it is zero the cursor will be put in the middle of the screen.
7099 When using a slow terminal set it to a large number or 0. When using
7100 a fast terminal use a small number or 1. Not used for "zh" and "zl"
7101 commands.
7102
7103 *'sidescrolloff'* *'siso'*
7104'sidescrolloff' 'siso' number (default 0)
Bram Moolenaar375e3392019-01-31 18:26:10 +01007105 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007106 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00007107 right of the cursor if 'nowrap' is set. Setting this option to a
7108 value greater than 0 while having |'sidescroll'| also at a non-zero
7109 value makes some context visible in the line you are scrolling in
7110 horizontally (except at beginning of the line). Setting this option
7111 to a large value (like 999) has the effect of keeping the cursor
7112 horizontally centered in the window, as long as one does not come too
7113 close to the beginning of the line.
Bram Moolenaar375e3392019-01-31 18:26:10 +01007114 After using the local value, go back the global value with one of
7115 these two: >
7116 setlocal sidescrolloff<
7117 setlocal sidescrolloff=-1
7118< NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007119
7120 Example: Try this together with 'sidescroll' and 'listchars' as
7121 in the following example to never allow the cursor to move
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007122 onto the "extends" character: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007123
7124 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
7125 :set sidescrolloff=1
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007126<
7127 *'signcolumn'* *'scl'*
7128'signcolumn' 'scl' string (default "auto")
7129 local to window
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007130 {not available when compiled without the |+signs|
7131 feature}
Bram Moolenaar09521312016-08-12 22:54:35 +02007132 Whether or not to draw the signcolumn. Valid values are:
7133 "auto" only when there is a sign to display
7134 "no" never
7135 "yes" always
Bram Moolenaar394c5d82019-06-17 21:48:05 +02007136 "number" display signs in the 'number' column. If the number
Bram Moolenaar6c1e1572019-06-22 02:13:00 +02007137 column is not present, then behaves like "auto".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007138
7139
7140 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
7141'smartcase' 'scs' boolean (default off)
7142 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007143 Override the 'ignorecase' option if the search pattern contains upper
7144 case characters. Only used when the search pattern is typed and
7145 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarc8734422012-06-01 22:38:45 +02007146 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00007147 "*" and "#" you can make 'smartcase' used by doing a "/" command,
7148 recalling the search pattern from history and hitting <Enter>.
7149 NOTE: This option is reset when 'compatible' is set.
7150
7151 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
7152'smartindent' 'si' boolean (default off)
7153 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007154 {not available when compiled without the
7155 |+smartindent| feature}
7156 Do smart autoindenting when starting a new line. Works for C-like
7157 programs, but can also be used for other languages. 'cindent' does
7158 something like this, works better in most cases, but is more strict,
Bram Moolenaar81af9252010-12-10 20:35:50 +01007159 see |C-indenting|. When 'cindent' is on or 'indentexpr' is set,
Bram Moolenaar166af9b2010-11-16 20:34:40 +01007160 setting 'si' has no effect. 'indentexpr' is a more advanced
7161 alternative.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007162 Normally 'autoindent' should also be on when using 'smartindent'.
7163 An indent is automatically inserted:
7164 - After a line ending in '{'.
7165 - After a line starting with a keyword from 'cinwords'.
7166 - Before a line starting with '}' (only with the "O" command).
7167 When typing '}' as the first character in a new line, that line is
7168 given the same indent as the matching '{'.
7169 When typing '#' as the first character in a new line, the indent for
7170 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007171 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00007172 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
7173 When using the ">>" command, lines starting with '#' are not shifted
7174 right.
Bram Moolenaar036986f2017-03-16 17:41:02 +01007175 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02007176 This option is reset when 'paste' is set and restored when 'paste' is
7177 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007178
7179 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
7180'smarttab' 'sta' boolean (default off)
7181 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007182 When on, a <Tab> in front of a line inserts blanks according to
Bram Moolenaar280f1262006-01-30 00:14:18 +00007183 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A
7184 <BS> will delete a 'shiftwidth' worth of space at the start of the
7185 line.
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00007186 When off, a <Tab> always inserts blanks according to 'tabstop' or
Bram Moolenaar280f1262006-01-30 00:14:18 +00007187 'softtabstop'. 'shiftwidth' is only used for shifting text left or
7188 right |shift-left-right|.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007189 What gets inserted (a <Tab> or spaces) depends on the 'expandtab'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007190 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00007191 number of spaces is minimized by using <Tab>s.
Bram Moolenaarca635012015-09-25 20:34:21 +02007192 This option is reset when 'paste' is set and restored when 'paste' is
7193 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007194 NOTE: This option is reset when 'compatible' is set.
7195
7196 *'softtabstop'* *'sts'*
7197'softtabstop' 'sts' number (default 0)
7198 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007199 Number of spaces that a <Tab> counts for while performing editing
7200 operations, like inserting a <Tab> or using <BS>. It "feels" like
7201 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
7202 used. This is useful to keep the 'ts' setting at its standard value
7203 of 8, while being able to edit like it is set to 'sts'. However,
7204 commands like "x" still work on the actual characters.
7205 When 'sts' is zero, this feature is off.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02007206 When 'sts' is negative, the value of 'shiftwidth' is used.
Bram Moolenaarca635012015-09-25 20:34:21 +02007207 'softtabstop' is set to 0 when the 'paste' option is set and restored
7208 when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007209 See also |ins-expandtab|. When 'expandtab' is not set, the number of
7210 spaces is minimized by using <Tab>s.
7211 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
7212 set.
7213 NOTE: This option is set to 0 when 'compatible' is set.
7214
Bram Moolenaar04958cb2018-06-23 19:23:02 +02007215 If Vim is compiled with the |+vartabs| feature then the value of
7216 'softtabstop' will be ignored if |'varsofttabstop'| is set to
7217 anything other than an empty string.
7218
Bram Moolenaar217ad922005-03-20 22:37:15 +00007219 *'spell'* *'nospell'*
7220'spell' boolean (default off)
7221 local to window
Bram Moolenaar217ad922005-03-20 22:37:15 +00007222 {not available when compiled without the |+syntax|
7223 feature}
7224 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007225 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007226
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007227 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00007228'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007229 local to buffer
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007230 {not available when compiled without the |+syntax|
7231 feature}
7232 Pattern to locate the end of a sentence. The following word will be
7233 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007234 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007235 When this check is not wanted make this option empty.
7236 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00007237 Be careful with special characters, see |option-backslash| about
7238 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007239 To set this option automatically depending on the language, see
7240 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007241
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007242 *'spellfile'* *'spf'*
7243'spellfile' 'spf' string (default empty)
7244 local to buffer
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007245 {not available when compiled without the |+syntax|
7246 feature}
7247 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00007248 commands. It must end in ".{encoding}.add". You need to include the
7249 path, otherwise the file is placed in the current directory.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007250 *E765*
7251 It may also be a comma separated list of names. A count before the
7252 |zg| and |zw| commands can be used to access each. This allows using
7253 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007254 When a word is added while this option is empty Vim will set it for
Bram Moolenaar910f66f2006-04-05 20:41:53 +00007255 you: Using the first directory in 'runtimepath' that is writable. If
7256 there is no "spell" directory yet it will be created. For the file
7257 name the first language name that appears in 'spelllang' is used,
Bram Moolenaar3b506942005-06-23 22:36:45 +00007258 ignoring the region.
7259 The resulting ".spl" file will be used for spell checking, it does not
7260 have to appear in 'spelllang'.
7261 Normally one file is used for all regions, but you can add the region
7262 name if you want to. However, it will then only be used when
7263 'spellfile' is set to it, for entries in 'spelllang' only files
7264 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00007265 This option cannot be set from a |modeline| or in the |sandbox|, for
7266 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007267
Bram Moolenaar217ad922005-03-20 22:37:15 +00007268 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007269'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00007270 local to buffer
Bram Moolenaar217ad922005-03-20 22:37:15 +00007271 {not available when compiled without the |+syntax|
7272 feature}
Bram Moolenaar3b506942005-06-23 22:36:45 +00007273 A comma separated list of word list names. When the 'spell' option is
7274 on spellchecking will be done for these languages. Example: >
7275 set spelllang=en_us,nl,medical
7276< This means US English, Dutch and medical words are recognized. Words
7277 that are not recognized will be highlighted.
Bram Moolenaar911ead12019-04-21 00:03:35 +02007278 The word list name must consist of alphanumeric characters, a dash or
7279 an underscore. It should not include a comma or dot. Using a dash is
Bram Moolenaar3b506942005-06-23 22:36:45 +00007280 recommended to separate the two letter language name from a
7281 specification. Thus "en-rare" is used for rare English words.
7282 A region name must come last and have the form "_xx", where "xx" is
7283 the two-letter, lower case region name. You can use more than one
7284 region by listing them: "en_us,en_ca" supports both US and Canadian
7285 English, but not words specific for Australia, New Zealand or Great
Bram Moolenaarfa735342016-01-03 22:14:44 +01007286 Britain. (Note: currently en_au and en_nz dictionaries are older than
7287 en_ca, en_gb and en_us).
Bram Moolenaarcc63c642013-11-12 04:44:01 +01007288 If the name "cjk" is included East Asian characters are excluded from
7289 spell checking. This is useful when editing text that also has Asian
7290 words.
Bram Moolenaar6c391a72021-09-09 21:55:11 +02007291 Note that the "medical" dictionary does not exist, it is just an
7292 example of a longer name.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007293 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007294 As a special case the name of a .spl file can be given as-is. The
7295 first "_xx" in the name is removed and used as the region name
7296 (_xx is an underscore, two letters and followed by a non-letter).
7297 This is mainly for testing purposes. You must make sure the correct
7298 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007299 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007300 idea to set 'spelllang' after setting 'encoding' to avoid loading the
7301 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00007302 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007303
Bram Moolenaar98692072006-02-04 00:57:42 +00007304 If the |spellfile.vim| plugin is active and you use a language name
7305 for which Vim cannot find the .spl file in 'runtimepath' the plugin
7306 will ask you if you want to download the file.
7307
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007308 After this option has been set successfully, Vim will source the files
7309 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
Bram Moolenaarb730f0c2018-11-25 03:56:26 +01007310 up to the first character that is not an ASCII letter or number and
7311 not a dash. Also see |set-spc-auto|.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007312
Bram Moolenaar362b44b2020-06-10 21:47:00 +02007313 *'spelloptions'* *'spo'*
7314'spelloptions' 'spo' string (default "")
7315 local to buffer
7316 {not available when compiled without the |+syntax|
7317 feature}
7318 A comma separated list of options for spell checking:
7319 camel When a word is CamelCased, assume "Cased" is a
7320 separate word: every upper-case character in a word
7321 that comes after a lower case character indicates the
7322 start of a new word.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007323
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007324 *'spellsuggest'* *'sps'*
7325'spellsuggest' 'sps' string (default "best")
7326 global
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007327 {not available when compiled without the |+syntax|
7328 feature}
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007329 Methods used for spelling suggestions. Both for the |z=| command and
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007330 the |spellsuggest()| function. This is a comma-separated list of
7331 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007332
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007333 best Internal method that works best for English. Finds
7334 changes like "fast" and uses a bit of sound-a-like
7335 scoring to improve the ordering.
7336
7337 double Internal method that uses two methods and mixes the
7338 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007339 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007340 word. That only works when the language specifies
7341 sound folding. Can be slow and doesn't always give
7342 better results.
7343
7344 fast Internal method that only checks for simple changes:
7345 character inserts/deletes/swaps. Works well for
7346 simple typing mistakes.
7347
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007348 {number} The maximum number of suggestions listed for |z=|.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007349 Not used for |spellsuggest()|. The number of
7350 suggestions is never more than the value of 'lines'
7351 minus two.
7352
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007353 file:{filename} Read file {filename}, which must have two columns,
7354 separated by a slash. The first column contains the
7355 bad word, the second column the suggested good word.
7356 Example:
7357 theribal/terrible ~
7358 Use this for common mistakes that do not appear at the
7359 top of the suggestion list with the internal methods.
7360 Lines without a slash are ignored, use this for
7361 comments.
Bram Moolenaarbcb98982014-05-01 14:08:19 +02007362 The word in the second column must be correct,
7363 otherwise it will not be used. Add the word to an
7364 ".add" file if it is currently flagged as a spelling
7365 mistake.
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007366 The file is used for all languages.
7367
7368 expr:{expr} Evaluate expression {expr}. Use a function to avoid
7369 trouble with spaces. |v:val| holds the badly spelled
7370 word. The expression must evaluate to a List of
7371 Lists, each with a suggestion and a score.
7372 Example:
Bram Moolenaar214641f2017-03-05 17:04:09 +01007373 [['the', 33], ['that', 44]] ~
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007374 Set 'verbose' and use |z=| to see the scores that the
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007375 internal methods use. A lower score is better.
7376 This may invoke |spellsuggest()| if you temporarily
7377 set 'spellsuggest' to exclude the "expr:" part.
7378 Errors are silently ignored, unless you set the
7379 'verbose' option to a non-zero value.
7380
7381 Only one of "best", "double" or "fast" may be used. The others may
7382 appear several times in any order. Example: >
7383 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
7384<
7385 This option cannot be set from a |modeline| or in the |sandbox|, for
7386 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007387
7388
Bram Moolenaar071d4272004-06-13 20:20:40 +00007389 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
7390'splitbelow' 'sb' boolean (default off)
7391 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007392 When on, splitting a window will put the new window below the current
7393 one. |:split|
7394
7395 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
7396'splitright' 'spr' boolean (default off)
7397 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007398 When on, splitting a window will put the new window right of the
7399 current one. |:vsplit|
7400
7401 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
7402'startofline' 'sol' boolean (default on)
7403 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007404 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00007405 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007406 (if possible). This applies to the commands: CTRL-D, CTRL-U, CTRL-B,
Bram Moolenaar843ee412004-06-30 16:16:41 +00007407 CTRL-F, "G", "H", "M", "L", gg, and to the commands "d", "<<" and ">>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007408 with a linewise operator, with "%" with a count and to buffer changing
7409 commands (CTRL-^, :bnext, :bNext, etc.). Also for an Ex command that
7410 only has a line number, e.g., ":25" or ":+".
7411 In case of buffer changing commands the cursor is placed at the column
7412 where it was the last time the buffer was edited.
7413 NOTE: This option is set when 'compatible' is set.
7414
Bram Moolenaar00654022011-02-25 14:42:19 +01007415 *'statusline'* *'stl'* *E540* *E542*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007416'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007417 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007418 {not available when compiled without the |+statusline|
7419 feature}
7420 When nonempty, this option determines the content of the status line.
7421 Also see |status-line|.
7422
7423 The option consists of printf style '%' items interspersed with
7424 normal text. Each status line item is of the form:
7425 %-0{minwid}.{maxwid}{item}
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01007426 All fields except the {item} are optional. A single percent sign can
Bram Moolenaar8133cc62020-10-26 21:05:27 +01007427 be given as "%%".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007428
Bram Moolenaar238a5642006-02-21 22:12:05 +00007429 When the option starts with "%!" then it is used as an expression,
7430 evaluated and the result is used as the option value. Example: >
7431 :set statusline=%!MyStatusLine()
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02007432< The *g:statusline_winid* variable will be set to the |window-ID| of the
7433 window that the status line belongs to.
7434 The result can contain %{} items that will be evaluated too.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02007435 Note that the "%!" expression is evaluated in the context of the
7436 current window and buffer, while %{} items are evaluated in the
7437 context of the window that the statusline belongs to.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007438
7439 When there is error while evaluating the option then it will be made
7440 empty to avoid further errors. Otherwise screen updating would loop.
7441
Bram Moolenaar071d4272004-06-13 20:20:40 +00007442 Note that the only effect of 'ruler' when this option is set (and
7443 'laststatus' is 2) is controlling the output of |CTRL-G|.
7444
7445 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00007446 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00007447 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007448 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007449 minwid Minimum width of the item, padding as set by '-' & '0'.
7450 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007451 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007452 on the left for text items. Numeric items will be
7453 shifted down to maxwid-2 digits followed by '>'number
7454 where number is the amount of missing digits, much like
7455 an exponential notation.
7456 item A one letter code as described below.
7457
7458 Following is a description of the possible statusline items. The
7459 second character in "item" is the type:
7460 N for number
7461 S for string
7462 F for flags as described below
7463 - not applicable
7464
7465 item meaning ~
Bram Moolenaar02467872007-05-06 13:22:01 +00007466 f S Path to the file in the buffer, as typed or relative to current
7467 directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007468 F S Full path to the file in the buffer.
7469 t S File name (tail) of file in the buffer.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007470 m F Modified flag, text is "[+]"; "[-]" if 'modifiable' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007471 M F Modified flag, text is ",+" or ",-".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007472 r F Readonly flag, text is "[RO]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007473 R F Readonly flag, text is ",RO".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007474 h F Help buffer flag, text is "[help]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007475 H F Help buffer flag, text is ",HLP".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007476 w F Preview window flag, text is "[Preview]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007477 W F Preview window flag, text is ",PRV".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007478 y F Type of file in the buffer, e.g., "[vim]". See 'filetype'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007479 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
Bram Moolenaar7fd73202010-07-25 16:58:46 +02007480 q S "[Quickfix List]", "[Location List]" or empty.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007481 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
7482 being used: "<keymap>"
7483 n N Buffer number.
Bram Moolenaar00654022011-02-25 14:42:19 +01007484 b N Value of character under cursor.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007485 B N As above, in hexadecimal.
7486 o N Byte number in file of byte under cursor, first byte is 1.
7487 Mnemonic: Offset from start of file (with one added)
7488 {not available when compiled without |+byte_offset| feature}
7489 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007490 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007491 l N Line number.
7492 L N Number of lines in buffer.
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02007493 c N Column number (byte index).
7494 v N Virtual column number (screen column).
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007495 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007496 p N Percentage through file in lines as in |CTRL-G|.
7497 P S Percentage through file of displayed window. This is like the
Bram Moolenaar14b69452013-06-29 23:05:20 +02007498 percentage described for 'ruler'. Always 3 in length, unless
7499 translated.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007500 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00007501 Empty if the argument file count is zero or one.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007502 { NF Evaluate expression between '%{' and '}' and substitute result.
Bram Moolenaar6d150f72018-04-21 20:03:20 +02007503 Note that there is no '%' before the closing '}'. The
7504 expression cannot contain a '}' character, call a function to
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007505 work around that. See |stl-%{| below.
shadmansaleh30e3de22021-05-15 17:23:28 +02007506 {% - This is almost same as { except the result of the expression is
7507 re-evaluated as a statusline format string. Thus if the
7508 return value of expr contains % items they will get expanded.
7509 The expression can contain the } character, the end of
7510 expression is denoted by %}.
Bram Moolenaar22863042021-10-16 15:23:36 +01007511 For example: >
shadmansaleh30e3de22021-05-15 17:23:28 +02007512 func! Stl_filename() abort
7513 return "%t"
7514 endfunc
7515< `stl=%{Stl_filename()}` results in `"%t"`
7516 `stl=%{%Stl_filename()%}` results in `"Name of current file"`
Bram Moolenaar22863042021-10-16 15:23:36 +01007517 %} - End of `{%` expression
Bram Moolenaar071d4272004-06-13 20:20:40 +00007518 ( - Start of item group. Can be used for setting the width and
7519 alignment of a section. Must be followed by %) somewhere.
7520 ) - End of item group. No width fields allowed.
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007521 T N For 'tabline': start of tab page N label. Use %T after the last
7522 label. This information is used for mouse clicks.
7523 X N For 'tabline': start of close tab N label. Use %X after the
7524 label, e.g.: %3Xclose%X. Use %999X for a "close current tab"
7525 mark. This information is used for mouse clicks.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007526 < - Where to truncate line if too long. Default is at the start.
7527 No width fields allowed.
7528 = - Separation point between left and right aligned items.
7529 No width fields allowed.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007530 # - Set highlight group. The name must follow and then a # again.
7531 Thus use %#HLname# for highlight group HLname. The same
7532 highlighting is used, also for the statusline of non-current
7533 windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007534 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00007535 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007536 The difference between User{N} and StatusLine will be applied
7537 to StatusLineNC for the statusline of non-current windows.
7538 The number N must be between 1 and 9. See |hl-User1..9|
7539
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007540 When displaying a flag, Vim removes the leading comma, if any, when
7541 that flag comes right after plaintext. This will make a nice display
7542 when flags are used like in the examples below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007543
Bram Moolenaar582fd852005-03-28 20:58:01 +00007544 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00007545 not set) and a minwid is not set for the group, the whole group will
7546 become empty. This will make a group like the following disappear
7547 completely from the statusline when none of the flags are set. >
7548 :set statusline=...%(\ [%M%R%H]%)...
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02007549< Beware that an expression is evaluated each and every time the status
7550 line is displayed.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007551 *stl-%{* *g:actual_curbuf* *g:actual_curwin*
Bram Moolenaarade0d392020-01-21 22:33:58 +01007552 While evaluating %{} the current buffer and current window will be set
7553 temporarily to that of the window (and buffer) whose statusline is
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007554 currently being drawn. The expression will evaluate in this context.
7555 The variable "g:actual_curbuf" is set to the `bufnr()` number of the
7556 real current buffer and "g:actual_curwin" to the |window-ID| of the
7557 real current window. These values are strings.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007558
Bram Moolenaar30b65812012-07-12 22:01:11 +02007559 The 'statusline' option will be evaluated in the |sandbox| if set from
7560 a modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02007561 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007562
7563 It is not allowed to change text or jump to another window while
7564 evaluating 'statusline' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007565
7566 If the statusline is not updated when you want it (e.g., after setting
7567 a variable that's used in an expression), you can force an update by
7568 setting an option without changing its value. Example: >
7569 :let &ro = &ro
7570
7571< A result of all digits is regarded a number for display purposes.
7572 Otherwise the result is taken as flag text and applied to the rules
7573 described above.
7574
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00007575 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00007576 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
Bram Moolenaarc4da1132017-07-15 19:39:43 +02007577 edit your .vimrc or whatever with "vim --clean" to get it right.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007578
7579 Examples:
7580 Emulate standard status line with 'ruler' set >
7581 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
7582< Similar, but add ASCII value of char under the cursor (like "ga") >
7583 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
7584< Display byte count and byte value, modified flag in red. >
7585 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
7586 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
7587< Display a ,GZ flag if a compressed file is loaded >
7588 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
7589< In the |:autocmd|'s: >
7590 :let b:gzflag = 1
7591< And: >
7592 :unlet b:gzflag
7593< And define this function: >
7594 :function VarExists(var, val)
7595 : if exists(a:var) | return a:val | else | return '' | endif
7596 :endfunction
7597<
7598 *'suffixes'* *'su'*
7599'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
7600 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007601 Files with these suffixes get a lower priority when multiple files
7602 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007603 suffixes. Spaces after the comma are ignored. A dot is also seen as
7604 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007605 separator, precede it with a backslash (see |option-backslash| about
7606 including spaces and backslashes).
7607 See 'wildignore' for completely ignoring files.
7608 The use of |:set+=| and |:set-=| is preferred when adding or removing
7609 suffixes from the list. This avoids problems when a future version
7610 uses another default.
7611
7612 *'suffixesadd'* *'sua'*
7613'suffixesadd' 'sua' string (default "")
7614 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007615 {not available when compiled without the
7616 |+file_in_path| feature}
7617 Comma separated list of suffixes, which are used when searching for a
7618 file for the "gf", "[I", etc. commands. Example: >
7619 :set suffixesadd=.java
7620<
7621 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
7622'swapfile' 'swf' boolean (default on)
7623 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007624 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007625 swapfile is not wanted for a specific buffer. For example, with
7626 confidential information that even root must not be able to access.
7627 Careful: All text will be in memory:
7628 - Don't use this for big files.
7629 - Recovery will be impossible!
7630 A swapfile will only be present when |'updatecount'| is non-zero and
7631 'swapfile' is set.
7632 When 'swapfile' is reset, the swap file for the current buffer is
7633 immediately deleted. When 'swapfile' is set, and 'updatecount' is
7634 non-zero, a swap file is immediately created.
7635 Also see |swap-file| and |'swapsync'|.
Bram Moolenaar76f3b1a2014-03-27 22:30:07 +01007636 If you want to open a new buffer without creating a swap file for it,
7637 use the |:noswapfile| modifier.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01007638 See 'directory' for where the swap file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007639
7640 This option is used together with 'bufhidden' and 'buftype' to
7641 specify special kinds of buffers. See |special-buffers|.
7642
7643 *'swapsync'* *'sws'*
7644'swapsync' 'sws' string (default "fsync")
7645 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007646 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007647 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007648 When this option is empty parts of the swap file may be in memory and
7649 not written to disk. When the system crashes you may lose more work.
7650 On Unix the system does a sync now and then without Vim asking for it,
7651 so the disadvantage of setting this option off is small. On some
7652 systems the swap file will not be written at all. For a unix system
7653 setting it to "sync" will use the sync() call instead of the default
7654 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007655 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007656
7657 *'switchbuf'* *'swb'*
7658'switchbuf' 'swb' string (default "")
7659 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007660 This option controls the behavior when switching between buffers.
Bram Moolenaard2ea7cf2021-05-30 20:54:13 +02007661 Mostly for |quickfix| commands some values are also used for other
7662 commands, as mentioned below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007663 Possible values (comma separated list):
7664 useopen If included, jump to the first open window that
7665 contains the specified buffer (if there is one).
7666 Otherwise: Do not examine other windows.
7667 This setting is checked with |quickfix| commands, when
7668 jumping to errors (":cc", ":cn", "cp", etc.). It is
7669 also used in all buffer related split commands, for
7670 example ":sbuffer", ":sbnext", or ":sbrewind".
Bram Moolenaar779b74b2006-04-10 14:55:34 +00007671 usetab Like "useopen", but also consider windows in other tab
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00007672 pages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007673 split If included, split the current window before loading
Bram Moolenaar15146672011-10-20 22:22:38 +02007674 a buffer for a |quickfix| command that display errors.
Bram Moolenaar63b74a82019-03-24 15:09:13 +01007675 Otherwise: do not split, use current window (when used
7676 in the quickfix window: the previously used window or
7677 split if there is no other window).
Bram Moolenaara594d772015-06-19 14:41:49 +02007678 vsplit Just like "split" but split vertically.
Bram Moolenaar446cb832008-06-24 21:56:24 +00007679 newtab Like "split", but open a new tab page. Overrules
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02007680 "split" when both are present.
Bram Moolenaar539aa6b2019-11-17 18:09:38 +01007681 uselast If included, jump to the previously used window when
7682 jumping to errors with |quickfix| commands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007683
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007684 *'synmaxcol'* *'smc'*
7685'synmaxcol' 'smc' number (default 3000)
7686 local to buffer
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007687 {not available when compiled without the |+syntax|
7688 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007689 Maximum column in which to search for syntax items. In long lines the
7690 text after this column is not highlighted and following lines may not
7691 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007692 This helps to avoid very slow redrawing for an XML file that is one
7693 long line.
7694 Set to zero to remove the limit.
7695
Bram Moolenaar071d4272004-06-13 20:20:40 +00007696 *'syntax'* *'syn'*
7697'syntax' 'syn' string (default empty)
7698 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007699 {not available when compiled without the |+syntax|
7700 feature}
7701 When this option is set, the syntax with this name is loaded, unless
7702 syntax highlighting has been switched off with ":syntax off".
7703 Otherwise this option does not always reflect the current syntax (the
7704 b:current_syntax variable does).
7705 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007706 not automatically recognized. Example, in an IDL file:
7707 /* vim: set syntax=idl : */ ~
7708 When a dot appears in the value then this separates two filetype
7709 names. Example:
7710 /* vim: set syntax=c.doxygen : */ ~
7711 This will use the "c" syntax first, then the "doxygen" syntax.
7712 Note that the second one must be prepared to be loaded as an addition,
7713 otherwise it will be skipped. More than one dot may appear.
7714 To switch off syntax highlighting for the current file, use: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007715 :set syntax=OFF
7716< To switch syntax highlighting on according to the current value of the
7717 'filetype' option: >
7718 :set syntax=ON
7719< What actually happens when setting the 'syntax' option is that the
7720 Syntax autocommand event is triggered with the value as argument.
7721 This option is not copied to another buffer, independent of the 's' or
7722 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007723 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007724
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007725 *'tabline'* *'tal'*
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007726'tabline' 'tal' string (default empty)
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007727 global
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007728 When nonempty, this option determines the content of the tab pages
7729 line at the top of the Vim window. When empty Vim will use a default
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007730 tab pages line. See |setting-tabline| for more info.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007731
7732 The tab pages line only appears as specified with the 'showtabline'
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00007733 option and only when there is no GUI tab line. When 'e' is in
7734 'guioptions' and the GUI supports a tab line 'guitablabel' is used
Bram Moolenaar7f036442010-08-15 15:24:20 +02007735 instead. Note that the two tab pages lines are very different.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007736
7737 The value is evaluated like with 'statusline'. You can use
7738 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007739 the text to be displayed. Use "%1T" for the first label, "%2T" for
7740 the second one, etc. Use "%X" items for closing labels.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007741
Bram Moolenaare12bab32019-01-08 22:02:56 +01007742 When changing something that is used in 'tabline' that does not
7743 trigger it to be updated, use |:redrawtabline|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02007744 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaare12bab32019-01-08 22:02:56 +01007745
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007746 Keep in mind that only one of the tab pages is the current one, others
7747 are invisible and you can't jump to their windows.
7748
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007749
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007750 *'tabpagemax'* *'tpm'*
7751'tabpagemax' 'tpm' number (default 10)
7752 global
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007753 Maximum number of tab pages to be opened by the |-p| command line
7754 argument or the ":tab all" command. |tabpage|
7755
7756
7757 *'tabstop'* *'ts'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007758'tabstop' 'ts' number (default 8)
7759 local to buffer
7760 Number of spaces that a <Tab> in the file counts for. Also see
7761 |:retab| command, and 'softtabstop' option.
7762
7763 Note: Setting 'tabstop' to any other value than 8 can make your file
7764 appear wrong in many places (e.g., when printing it).
7765
7766 There are four main ways to use tabs in Vim:
7767 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
7768 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007769 will use a mix of tabs and spaces, but typing <Tab> and <BS> will
Bram Moolenaar071d4272004-06-13 20:20:40 +00007770 behave like a tab appears every 4 (or 3) characters.
7771 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
7772 'expandtab'. This way you will always insert spaces. The
7773 formatting will never be messed up when 'tabstop' is changed.
7774 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007775 |modeline| to set these values when editing the file again. Only
Bram Moolenaar071d4272004-06-13 20:20:40 +00007776 works when using Vim to edit the file.
7777 4. Always set 'tabstop' and 'shiftwidth' to the same value, and
7778 'noexpandtab'. This should then work (for initial indents only)
7779 for any tabstop setting that people use. It might be nice to have
7780 tabs after the first non-blank inserted as spaces if you do this
7781 though. Otherwise aligned comments will be wrong when 'tabstop' is
7782 changed.
7783
Bram Moolenaar04958cb2018-06-23 19:23:02 +02007784 If Vim is compiled with the |+vartabs| feature then the value of
7785 'tabstop' will be ignored if |'vartabstop'| is set to anything other
7786 than an empty string.
7787
Bram Moolenaar071d4272004-06-13 20:20:40 +00007788 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
7789'tagbsearch' 'tbs' boolean (default on)
7790 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007791 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007792 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00007793 searching makes searching for a tag a LOT faster, but a linear search
7794 will find more tags if the tags file wasn't properly sorted.
7795 Vim normally assumes that your tags files are sorted, or indicate that
7796 they are not sorted. Only when this is not the case does the
7797 'tagbsearch' option need to be switched off.
7798
7799 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007800 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00007801 certain files, or retry all files with a linear search. When
7802 'tagbsearch' is off, only a linear search is done.
7803
7804 Linear searching is done anyway, for one file, when Vim finds a line
7805 at the start of the file indicating that it's not sorted: >
Bram Moolenaar446cb832008-06-24 21:56:24 +00007806 !_TAG_FILE_SORTED 0 /some comment/
Bram Moolenaar071d4272004-06-13 20:20:40 +00007807< [The whitespace before and after the '0' must be a single <Tab>]
7808
7809 When a binary search was done and no match was found in any of the
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007810 files listed in 'tags', and case is ignored or a pattern is used
Bram Moolenaar071d4272004-06-13 20:20:40 +00007811 instead of a normal tag name, a retry is done with a linear search.
7812 Tags in unsorted tags files, and matches with different case will only
7813 be found in the retry.
7814
Bram Moolenaard4755bb2004-09-02 19:12:26 +00007815 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007816 linear search can be avoided when case is ignored. Use a value of '2'
7817 in the "!_TAG_FILE_SORTED" line for this. A tag file can be case-fold
7818 sorted with the -f switch to "sort" in most unices, as in the command:
7819 "sort -f -o tags tags". For "Exuberant ctags" version 5.x or higher
7820 (at least 5.5) the --sort=foldcase switch can be used for this as
7821 well. Note that case must be folded to uppercase for this to work.
7822
7823 By default, tag searches are case-sensitive. Case is ignored when
7824 'ignorecase' is set and 'tagcase' is "followic", or when 'tagcase' is
7825 "ignore".
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007826 Also when 'tagcase' is "followscs" and 'smartcase' is set, or
7827 'tagcase' is "smart", and the pattern contains only lowercase
7828 characters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007829
7830 When 'tagbsearch' is off, tags searching is slower when a full match
7831 exists, but faster when no full match exists. Tags in unsorted tags
7832 files may only be found with 'tagbsearch' off.
7833 When the tags file is not sorted, or sorted in a wrong way (not on
7834 ASCII byte value), 'tagbsearch' should be off, or the line given above
7835 must be included in the tags file.
7836 This option doesn't affect commands that find all matching tags (e.g.,
7837 command-line completion and ":help").
Bram Moolenaar071d4272004-06-13 20:20:40 +00007838
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007839 *'tagcase'* *'tc'*
7840'tagcase' 'tc' string (default "followic")
7841 global or local to buffer |global-local|
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007842 This option specifies how case is handled when searching the tags
7843 file:
7844 followic Follow the 'ignorecase' option
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007845 followscs Follow the 'smartcase' and 'ignorecase' options
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007846 ignore Ignore case
7847 match Match case
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007848 smart Ignore case unless an upper case letter is used
Bram Moolenaar036986f2017-03-16 17:41:02 +01007849 NOTE: This option is set to the Vi default value when 'compatible' is
7850 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007851
Bram Moolenaar45e18cb2019-04-28 18:05:35 +02007852 *'tagfunc'* *'tfu'*
7853'tagfunc' 'tfu' string (default: empty)
7854 local to buffer
7855 {not available when compiled without the |+eval|
7856 feature}
7857 This option specifies a function to be used to perform tag searches.
7858 The function gets the tag pattern and should return a List of matching
7859 tags. See |tag-function| for an explanation of how to write the
Yegappan Lakshmanan19916a82021-11-24 16:32:55 +00007860 function and an example. The value can be the name of a function, a
7861 |lambda| or a |Funcref|. See |option-value-function| for more
7862 information.
Bram Moolenaar45e18cb2019-04-28 18:05:35 +02007863
Bram Moolenaar071d4272004-06-13 20:20:40 +00007864 *'taglength'* *'tl'*
7865'taglength' 'tl' number (default 0)
7866 global
7867 If non-zero, tags are significant up to this number of characters.
7868
7869 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
7870'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
7871 global
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00007872 If on and using a tags file in another directory, file names in that
7873 tags file are relative to the directory where the tags file is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007874 NOTE: This option is set to the Vi default value when 'compatible' is
7875 set and to the Vim default value when 'compatible' is reset.
7876
7877 *'tags'* *'tag'* *E433*
7878'tags' 'tag' string (default "./tags,tags", when compiled with
7879 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
7880 global or local to buffer |global-local|
7881 Filenames for the tag command, separated by spaces or commas. To
7882 include a space or comma in a file name, precede it with a backslash
7883 (see |option-backslash| about including spaces and backslashes).
7884 When a file name starts with "./", the '.' is replaced with the path
7885 of the current file. But only when the 'd' flag is not included in
7886 'cpoptions'. Environment variables are expanded |:set_env|. Also see
7887 |tags-option|.
7888 "*", "**" and other wildcards can be used to search for tags files in
Bram Moolenaare2b590e2010-08-08 18:29:48 +02007889 a directory tree. See |file-searching|. E.g., "/lib/**/tags" will
7890 find all files named "tags" below "/lib". The filename itself cannot
7891 contain wildcards, it is used as-is. E.g., "/lib/**/tags?" will find
7892 files called "tags?". {not available when compiled without the
7893 |+path_extra| feature}
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00007894 The |tagfiles()| function can be used to get a list of the file names
7895 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007896 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
7897 files are also supported. They are automatically recognized. The
7898 default value becomes "./tags,./TAGS,tags,TAGS", unless case
7899 differences are ignored (MS-Windows). |emacs-tags|
7900 The use of |:set+=| and |:set-=| is preferred when adding or removing
7901 file names from the list. This avoids problems when a future version
7902 uses another default.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007903
7904 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
7905'tagstack' 'tgst' boolean (default on)
7906 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007907 When on, the |tagstack| is used normally. When off, a ":tag" or
7908 ":tselect" command with an argument will not push the tag onto the
7909 tagstack. A following ":tag" without an argument, a ":pop" command or
7910 any other command that uses the tagstack will use the unmodified
7911 tagstack, but does change the pointer to the active entry.
7912 Resetting this option is useful when using a ":tag" command in a
7913 mapping which should not change the tagstack.
7914
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007915 *'tcldll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01007916'tcldll' string (default depends on the build)
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007917 global
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007918 {only available when compiled with the |+tcl/dyn|
7919 feature}
7920 Specifies the name of the Tcl shared library. The default is
7921 DYNAMIC_TCL_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02007922 Environment variables are expanded |:set_env|.
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007923 This option cannot be set from a |modeline| or in the |sandbox|, for
7924 security reasons.
7925
Bram Moolenaar071d4272004-06-13 20:20:40 +00007926 *'term'* *E529* *E530* *E531*
7927'term' string (default is $TERM, if that fails:
7928 in the GUI: "builtin_gui"
7929 on Amiga: "amiga"
Bram Moolenaarb3f74062020-02-26 16:16:53 +01007930 on Haiku: "xterm"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007931 on Mac: "mac-ansi"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007932 on Unix: "ansi"
7933 on VMS: "ansi"
7934 on Win 32: "win32")
7935 global
7936 Name of the terminal. Used for choosing the terminal control
7937 characters. Environment variables are expanded |:set_env|.
7938 For example: >
7939 :set term=$TERM
7940< See |termcap|.
7941
7942 *'termbidi'* *'tbidi'*
7943 *'notermbidi'* *'notbidi'*
7944'termbidi' 'tbidi' boolean (default off, on for "mlterm")
7945 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007946 {only available when compiled with the |+arabic|
7947 feature}
7948 The terminal is in charge of Bi-directionality of text (as specified
7949 by Unicode). The terminal is also expected to do the required shaping
7950 that some languages (such as Arabic) require.
7951 Setting this option implies that 'rightleft' will not be set when
7952 'arabic' is set and the value of 'arabicshape' will be ignored.
7953 Note that setting 'termbidi' has the immediate effect that
7954 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
7955 This option is reset when the GUI is started.
7956 For further details see |arabic.txt|.
7957
7958 *'termencoding'* *'tenc'*
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02007959'termencoding' 'tenc' string (default ""; with GTK+ GUI: "utf-8")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007960 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007961 Encoding used for the terminal. This specifies what character
7962 encoding the keyboard produces and the display will understand. For
Bram Moolenaar3848e002016-03-19 18:42:29 +01007963 the GUI it only applies to the keyboard ('encoding' is used for the
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02007964 display).
Bram Moolenaar4b7cdca2020-01-01 16:18:38 +01007965 *E617* *E950*
Bram Moolenaar3df01732017-02-17 22:47:16 +01007966 Note: This does not apply to the GTK+ GUI. After the GUI has been
Bram Moolenaar071d4272004-06-13 20:20:40 +00007967 successfully initialized, 'termencoding' is forcibly set to "utf-8".
7968 Any attempts to set a different value will be rejected, and an error
7969 message is shown.
Bram Moolenaarac360bf2015-09-01 20:31:20 +02007970 For the Win32 GUI and console versions 'termencoding' is not used,
Bram Moolenaar071d4272004-06-13 20:20:40 +00007971 because the Win32 system always passes Unicode characters.
7972 When empty, the same encoding is used as for the 'encoding' option.
7973 This is the normal value.
7974 Not all combinations for 'termencoding' and 'encoding' are valid. See
7975 |encoding-table|.
7976 The value for this option must be supported by internal conversions or
7977 iconv(). When this is not possible no conversion will be done and you
7978 will probably experience problems with non-ASCII characters.
7979 Example: You are working with the locale set to euc-jp (Japanese) and
7980 want to edit a UTF-8 file: >
7981 :let &termencoding = &encoding
7982 :set encoding=utf-8
7983< You need to do this when your system has no locale support for UTF-8.
7984
Bram Moolenaarcafafb32018-02-22 21:07:09 +01007985 *'termguicolors'* *'tgc'* *E954*
Bram Moolenaar61be73b2016-04-29 22:59:22 +02007986'termguicolors' 'tgc' boolean (default off)
7987 global
Bram Moolenaar61be73b2016-04-29 22:59:22 +02007988 {not available when compiled without the
7989 |+termguicolors| feature}
7990 When on, uses |highlight-guifg| and |highlight-guibg| attributes in
Bram Moolenaarcafafb32018-02-22 21:07:09 +01007991 the terminal (thus using 24-bit color).
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01007992
Bram Moolenaarcafafb32018-02-22 21:07:09 +01007993 Requires a ISO-8613-3 compatible terminal. If setting this option
7994 does not work (produces a colorless UI) reading |xterm-true-color|
7995 might help.
7996
7997 For Win32 console, Windows 10 version 1703 (Creators Update) or later
7998 is required. Use this check to find out: >
7999 if has('vcon')
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01008000< This requires Vim to be built with the |+vtp| feature.
8001
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +02008002 Note that the "cterm" attributes are still used, not the "gui" ones.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008003 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar61be73b2016-04-29 22:59:22 +02008004
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008005 *'termwinkey'* *'twk'*
8006'termwinkey' 'twk' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02008007 local to window
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008008 The key that starts a CTRL-W command in a terminal window. Other keys
Bram Moolenaar74675a62017-07-15 13:53:23 +02008009 are sent to the job running in the window.
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008010 The <> notation can be used, e.g.: >
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008011 :set termwinkey=<C-L>
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008012< The string must be one key stroke but can be multiple bytes.
8013 When not set CTRL-W is used, so that CTRL-W : gets you to the command
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008014 line. If 'termwinkey' is set to CTRL-L then CTRL-L : gets you to the
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008015 command line.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008016
Bram Moolenaar6c60f472019-04-28 16:00:35 +02008017 *'termwinscroll'* *'twsl'*
8018'termwinscroll' 'twsl' number (default 10000)
8019 local to buffer
8020 {not available when compiled without the
8021 |+terminal| feature}
8022 Number of scrollback lines to keep. When going over this limit the
8023 first 10% of the scrollback lines are deleted. This is just to reduce
8024 the memory usage. See |Terminal-Normal|.
Bram Moolenaar36968af2021-11-15 17:13:11 +00008025 Also used as a limit for text sent to the terminal in one write,
8026 multiplied by the number of columns times 3 (average number of bytes
8027 per cell).
Bram Moolenaar6c60f472019-04-28 16:00:35 +02008028
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008029 *'termwinsize'* *'tws'*
8030'termwinsize' 'tws' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02008031 local to window
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02008032 Size used when opening the |terminal| window. Format:
8033 {rows}x{columns} or {rows}*{columns}.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008034 - When empty the terminal gets the size from the window.
Bram Moolenaar498c2562018-04-15 23:45:15 +02008035 - When set with a "x" (e.g., "24x80") the terminal size is not
8036 adjusted to the window size. If the window is smaller only the
8037 top-left part is displayed.
8038 - When set with a "*" (e.g., "10*50") the terminal size follows the
8039 window size, but will not be smaller than the specified rows and/or
8040 columns.
8041 - When rows is zero then use the height of the window.
8042 - When columns is zero then use the width of the window.
8043 - Using "0x0" or "0*0" is the same as empty.
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02008044 - Can be overruled in the |term_start()| options with "term_rows" and
8045 "term_cols".
Bram Moolenaar498c2562018-04-15 23:45:15 +02008046
8047 Examples:
8048 "30x0" uses 30 rows and the current window width.
8049 "20*0" uses at least 20 rows and the current window width.
8050 "0*40" uses the current window height and at least 40 columns.
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02008051 Note that the command running in the terminal window may still change
8052 the size of the terminal. In that case the Vim window will be
8053 adjusted to that size, if possible.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008054
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008055 *'termwintype'* *'twt'*
8056'termwintype' 'twt' string (default "")
8057 global
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008058 {only available when compiled with the |terminal|
8059 feature on MS-Windows}
8060 Specify the virtual console (pty) used when opening the terminal
8061 window.
8062
8063 Possible values are:
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01008064 "" use ConPTY if it is stable, winpty otherwise
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008065 "winpty" use winpty, fail if not supported
8066 "conpty" use |ConPTY|, fail if not supported
8067
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01008068 |ConPTY| support depends on the platform. Windows 10 October 2018
8069 Update is the first version that supports ConPTY, however it is still
8070 considered unstable. ConPTY might become stable in the next release
8071 of Windows 10. winpty support needs to be installed. If neither is
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008072 supported then you cannot open a terminal window.
8073
Bram Moolenaar071d4272004-06-13 20:20:40 +00008074 *'terse'* *'noterse'*
8075'terse' boolean (default off)
8076 global
8077 When set: Add 's' flag to 'shortmess' option (this makes the message
8078 for a search that hits the start or end of the file not being
8079 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
8080 shortens a lot of messages}
8081
8082 *'textauto'* *'ta'* *'notextauto'* *'nota'*
8083'textauto' 'ta' boolean (Vim default: on, Vi default: off)
8084 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008085 This option is obsolete. Use 'fileformats'.
8086 For backwards compatibility, when 'textauto' is set, 'fileformats' is
8087 set to the default value for the current system. When 'textauto' is
8088 reset, 'fileformats' is made empty.
8089 NOTE: This option is set to the Vi default value when 'compatible' is
8090 set and to the Vim default value when 'compatible' is reset.
8091
8092 *'textmode'* *'tx'* *'notextmode'* *'notx'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008093'textmode' 'tx' boolean (Win32: default on,
Bram Moolenaar071d4272004-06-13 20:20:40 +00008094 others: default off)
8095 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00008096 This option is obsolete. Use 'fileformat'.
8097 For backwards compatibility, when 'textmode' is set, 'fileformat' is
8098 set to "dos". When 'textmode' is reset, 'fileformat' is set to
8099 "unix".
8100
8101 *'textwidth'* *'tw'*
8102'textwidth' 'tw' number (default 0)
8103 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00008104 Maximum width of text that is being inserted. A longer line will be
8105 broken after white space to get this width. A zero value disables
Bram Moolenaarca635012015-09-25 20:34:21 +02008106 this.
8107 'textwidth' is set to 0 when the 'paste' option is set and restored
8108 when 'paste' is reset.
8109 When 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00008110 'formatoptions' and |ins-textwidth|.
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00008111 When 'formatexpr' is set it will be used to break the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008112 NOTE: This option is set to 0 when 'compatible' is set.
8113
8114 *'thesaurus'* *'tsr'*
8115'thesaurus' 'tsr' string (default "")
8116 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008117 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008118 for thesaurus completion commands |i_CTRL-X_CTRL-T|. See
8119 |compl-thesaurus|.
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01008120
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008121 This option is not used if 'thesaurusfunc' is set, either for the
8122 buffer or globally.
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01008123
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008124 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00008125 after a comma are ignored, otherwise spaces are included in the file
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008126 name. See |option-backslash| about using backslashes. The use of
8127 |:set+=| and |:set-=| is preferred when adding or removing directories
8128 from the list. This avoids problems when a future version uses
8129 another default. Backticks cannot be used in this option for security
8130 reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008131
Bram Moolenaar2f0936c2022-01-08 21:51:59 +00008132 *'thesaurusfunc'* *'tsrfu'*
Yegappan Lakshmanan160e9942021-10-16 15:41:29 +01008133'thesaurusfunc' 'tsrfu' string (default: empty)
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008134 global or local to buffer |global-local|
Yegappan Lakshmanan160e9942021-10-16 15:41:29 +01008135 {not available when compiled without the |+eval|
8136 feature}
8137 This option specifies a function to be used for thesaurus completion
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008138 with CTRL-X CTRL-T. |i_CTRL-X_CTRL-T| See |compl-thesaurusfunc|.
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00008139 The value can be the name of a function, a |lambda| or a |Funcref|.
8140 See |option-value-function| for more information.
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008141
Yegappan Lakshmanan160e9942021-10-16 15:41:29 +01008142 This option cannot be set from a |modeline| or in the |sandbox|, for
8143 security reasons.
8144
Bram Moolenaar071d4272004-06-13 20:20:40 +00008145 *'tildeop'* *'top'* *'notildeop'* *'notop'*
8146'tildeop' 'top' boolean (default off)
8147 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008148 When on: The tilde command "~" behaves like an operator.
8149 NOTE: This option is reset when 'compatible' is set.
8150
8151 *'timeout'* *'to'* *'notimeout'* *'noto'*
8152'timeout' 'to' boolean (default on)
8153 global
8154 *'ttimeout'* *'nottimeout'*
Bram Moolenaar94237492017-04-23 18:40:21 +02008155'ttimeout' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008156 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008157 These two options together determine the behavior when part of a
8158 mapped key sequence or keyboard code has been received:
8159
8160 'timeout' 'ttimeout' action ~
8161 off off do not time out
8162 on on or off time out on :mappings and key codes
8163 off on time out on key codes
8164
8165 If both options are off, Vim will wait until either the complete
8166 mapping or key sequence has been received, or it is clear that there
8167 is no mapping or key sequence for the received characters. For
8168 example: if you have mapped "vl" and Vim has received 'v', the next
8169 character is needed to see if the 'v' is followed by an 'l'.
8170 When one of the options is on, Vim will wait for about 1 second for
8171 the next character to arrive. After that the already received
8172 characters are interpreted as single characters. The waiting time can
8173 be changed with the 'timeoutlen' option.
8174 On slow terminals or very busy systems timing out may cause
8175 malfunctioning cursor keys. If both options are off, Vim waits
8176 forever after an entered <Esc> if there are key codes that start
8177 with <Esc>. You will have to type <Esc> twice. If you do not have
8178 problems with key codes, but would like to have :mapped key
8179 sequences not timing out in 1 second, set the 'ttimeout' option and
8180 reset the 'timeout' option.
8181
8182 NOTE: 'ttimeout' is reset when 'compatible' is set.
8183
8184 *'timeoutlen'* *'tm'*
8185'timeoutlen' 'tm' number (default 1000)
8186 global
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008187
Bram Moolenaar071d4272004-06-13 20:20:40 +00008188 *'ttimeoutlen'* *'ttm'*
Bram Moolenaar94237492017-04-23 18:40:21 +02008189'ttimeoutlen' 'ttm' number (default -1, set to 100 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008190 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008191 The time in milliseconds that is waited for a key code or mapped key
8192 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
8193 when part of a command has been typed.
8194 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
8195 different timeout value for key codes is desired set 'ttimeoutlen' to
8196 a non-negative number.
8197
8198 ttimeoutlen mapping delay key code delay ~
8199 < 0 'timeoutlen' 'timeoutlen'
8200 >= 0 'timeoutlen' 'ttimeoutlen'
8201
8202 The timeout only happens when the 'timeout' and 'ttimeout' options
8203 tell so. A useful setting would be >
8204 :set timeout timeoutlen=3000 ttimeoutlen=100
8205< (time out on mapping after three seconds, time out on key codes after
8206 a tenth of a second).
8207
8208 *'title'* *'notitle'*
8209'title' boolean (default off, on when title can be restored)
8210 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008211 When on, the title of the window will be set to the value of
8212 'titlestring' (if it is not empty), or to:
8213 filename [+=-] (path) - VIM
8214 Where:
8215 filename the name of the file being edited
8216 - indicates the file cannot be modified, 'ma' off
8217 + indicates the file was modified
8218 = indicates the file is read-only
8219 =+ indicates the file is read-only and modified
8220 (path) is the path of the file being edited
8221 - VIM the server name |v:servername| or "VIM"
8222 Only works if the terminal supports setting window titles
8223 (currently Amiga console, Win32 console, all GUI versions and
Bram Moolenaard1caa942020-04-10 22:10:56 +02008224 terminals with a non-empty 't_ts' option - these are Unix xterm and
Bram Moolenaar071d4272004-06-13 20:20:40 +00008225 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
8226 *X11*
8227 When Vim was compiled with HAVE_X11 defined, the original title will
8228 be restored if possible. The output of ":version" will include "+X11"
8229 when HAVE_X11 was defined, otherwise it will be "-X11". This also
8230 works for the icon name |'icon'|.
8231 But: When Vim was started with the |-X| argument, restoring the title
8232 will not work (except in the GUI).
8233 If the title cannot be restored, it is set to the value of 'titleold'.
8234 You might want to restore the title outside of Vim then.
8235 When using an xterm from a remote machine you can use this command:
8236 rsh machine_name xterm -display $DISPLAY &
8237 then the WINDOWID environment variable should be inherited and the
8238 title of the window should change back to what it should be after
8239 exiting Vim.
8240
8241 *'titlelen'*
8242'titlelen' number (default 85)
8243 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008244 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008245 title. When the title is longer, only the end of the path name is
8246 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008247 Using a percentage makes this adapt to the width of the window. But
8248 it won't work perfectly, because the actual number of characters
8249 available also depends on the font used and other things in the title
8250 bar. When 'titlelen' is zero the full path is used. Otherwise,
8251 values from 1 to 30000 percent can be used.
8252 'titlelen' is also used for the 'titlestring' option.
8253
8254 *'titleold'*
8255'titleold' string (default "Thanks for flying Vim")
8256 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008257 This option will be used for the window title when exiting Vim if the
8258 original title cannot be restored. Only happens if 'title' is on or
8259 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00008260 This option cannot be set from a |modeline| or in the |sandbox|, for
8261 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008262 *'titlestring'*
8263'titlestring' string (default "")
8264 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008265 When this option is not empty, it will be used for the title of the
8266 window. This happens only when the 'title' option is on.
8267 Only works if the terminal supports setting window titles (currently
8268 Amiga console, Win32 console, all GUI versions and terminals with a
8269 non-empty 't_ts' option).
8270 When Vim was compiled with HAVE_X11 defined, the original title will
Bram Moolenaar51628222016-12-01 23:03:28 +01008271 be restored if possible, see |X11|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008272
Bram Moolenaar071d4272004-06-13 20:20:40 +00008273 When this option contains printf-style '%' items, they will be
8274 expanded according to the rules used for 'statusline'.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008275 This option cannot be set in a modeline when 'modelineexpr' is off.
8276
Bram Moolenaar071d4272004-06-13 20:20:40 +00008277 Example: >
8278 :auto BufEnter * let &titlestring = hostname() . "/" . expand("%:p")
8279 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
8280< The value of 'titlelen' is used to align items in the middle or right
8281 of the available space.
8282 Some people prefer to have the file name first: >
8283 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
8284< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008285 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00008286 separating space only when needed.
8287 NOTE: Use of special characters in 'titlestring' may cause the display
8288 to be garbled (e.g., when it contains a CR or NL character).
8289 {not available when compiled without the |+statusline| feature}
8290
8291 *'toolbar'* *'tb'*
8292'toolbar' 'tb' string (default "icons,tooltips")
8293 global
8294 {only for |+GUI_GTK|, |+GUI_Athena|, |+GUI_Motif| and
8295 |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008296 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00008297 possible values are:
8298 icons Toolbar buttons are shown with icons.
8299 text Toolbar buttons shown with text.
8300 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008301 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008302 tooltips Tooltips are active for toolbar buttons.
8303 Tooltips refer to the popup help text which appears after the mouse
8304 cursor is placed over a toolbar button for a brief moment.
8305
8306 If you want the toolbar to be shown with icons as well as text, do the
8307 following: >
8308 :set tb=icons,text
8309< Motif and Athena cannot display icons and text at the same time. They
8310 will show icons if both are requested.
8311
8312 If none of the strings specified in 'toolbar' are valid or if
8313 'toolbar' is empty, this option is ignored. If you want to disable
8314 the toolbar, you need to set the 'guioptions' option. For example: >
8315 :set guioptions-=T
8316< Also see |gui-toolbar|.
8317
8318 *'toolbariconsize'* *'tbis'*
8319'toolbariconsize' 'tbis' string (default "small")
8320 global
Bram Moolenaar3df01732017-02-17 22:47:16 +01008321 {only in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008322 Controls the size of toolbar icons. The possible values are:
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008323 tiny Use tiny icons.
8324 small Use small icons (default).
8325 medium Use medium-sized icons.
8326 large Use large icons.
8327 huge Use even larger icons.
8328 giant Use very big icons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008329 The exact dimensions in pixels of the various icon sizes depend on
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008330 the current theme. Common dimensions are giant=48x48, huge=32x32,
8331 large=24x24, medium=24x24, small=20x20 and tiny=16x16.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008332
8333 If 'toolbariconsize' is empty, the global default size as determined
8334 by user preferences or the current theme is used.
8335
8336 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
8337'ttybuiltin' 'tbi' boolean (default on)
8338 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008339 When on, the builtin termcaps are searched before the external ones.
8340 When off the builtin termcaps are searched after the external ones.
8341 When this option is changed, you should set the 'term' option next for
8342 the change to take effect, for example: >
8343 :set notbi term=$TERM
8344< See also |termcap|.
8345 Rationale: The default for this option is "on", because the builtin
8346 termcap entries are generally better (many systems contain faulty
8347 xterm entries...).
8348
8349 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
8350'ttyfast' 'tf' boolean (default off, on when 'term' is xterm, hpterm,
8351 sun-cmd, screen, rxvt, dtterm or
8352 iris-ansi; also on when running Vim in
8353 a DOS console)
8354 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008355 Indicates a fast terminal connection. More characters will be sent to
8356 the screen for redrawing, instead of using insert/delete line
8357 commands. Improves smoothness of redrawing when there are multiple
8358 windows and the terminal does not support a scrolling region.
8359 Also enables the extra writing of characters at the end of each screen
8360 line for lines that wrap. This helps when using copy/paste with the
8361 mouse in an xterm and other terminals.
8362
8363 *'ttymouse'* *'ttym'*
8364'ttymouse' 'ttym' string (default depends on 'term')
8365 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008366 {only in Unix and VMS, doesn't work in the GUI; not
8367 available when compiled without |+mouse|}
8368 Name of the terminal type for which mouse codes are to be recognized.
Bram Moolenaar2c7a7632007-05-10 18:19:11 +00008369 Currently these strings are valid:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008370 *xterm-mouse*
8371 xterm xterm-like mouse handling. The mouse generates
8372 "<Esc>[Mscr", where "scr" is three bytes:
8373 "s" = button state
8374 "c" = column plus 33
8375 "r" = row plus 33
Bram Moolenaare968e362014-05-13 20:23:24 +02008376 This only works up to 223 columns! See "dec",
8377 "urxvt", and "sgr" for solutions.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008378 xterm2 Works like "xterm", but with the xterm reporting the
8379 mouse position while the mouse is dragged. This works
8380 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00008381 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00008382 work. See below for how Vim detects this
8383 automatically.
8384 *netterm-mouse*
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008385 netterm NetTerm mouse handling. A left mouse click generates
Bram Moolenaar071d4272004-06-13 20:20:40 +00008386 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008387 for the row and column. No other mouse events are
8388 supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008389 *dec-mouse*
8390 dec DEC terminal mouse handling. The mouse generates a
8391 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00008392 This is also available for an Xterm, if it was
8393 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00008394 *jsbterm-mouse*
8395 jsbterm JSB term mouse handling.
8396 *pterm-mouse*
8397 pterm QNX pterm mouse handling.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008398 *urxvt-mouse*
8399 urxvt Mouse handling for the urxvt (rxvt-unicode) terminal.
Bram Moolenaare968e362014-05-13 20:23:24 +02008400 The mouse works only if the terminal supports this
8401 encoding style, but it does not have 223 columns limit
8402 unlike "xterm" or "xterm2".
Bram Moolenaar9b451252012-08-15 17:43:31 +02008403 *sgr-mouse*
8404 sgr Mouse handling for the terminal that emits SGR-styled
Bram Moolenaare968e362014-05-13 20:23:24 +02008405 mouse reporting. The mouse works even in columns
8406 beyond 223. This option is backward compatible with
8407 "xterm2" because it can also decode "xterm2" style
8408 mouse codes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008409
8410 The mouse handling must be enabled at compile time |+mouse_xterm|
Bram Moolenaare968e362014-05-13 20:23:24 +02008411 |+mouse_dec| |+mouse_netterm| |+mouse_jsbterm| |+mouse_urxvt|
8412 |+mouse_sgr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008413 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
8414 recognized, if enabled at compile time. DEC terminal mouse codes
8415 are recognized if enabled at compile time, and 'ttymouse' is not
Bram Moolenaare968e362014-05-13 20:23:24 +02008416 "xterm", "xterm2", "urxvt" or "sgr" (because dec mouse codes conflict
8417 with them).
Bram Moolenaar071d4272004-06-13 20:20:40 +00008418 This option is automatically set to "xterm", when the 'term' option is
Bram Moolenaar45758762016-10-12 23:08:06 +02008419 set to a name that starts with "xterm", "mlterm", "screen", "tmux",
8420 "st" (full match only), "st-" or "stterm", and 'ttymouse' is not set
8421 already.
Bram Moolenaare968e362014-05-13 20:23:24 +02008422 Additionally, if vim is compiled with the |+termresponse| feature and
8423 |t_RV| is set to the escape sequence to request the xterm version
Bram Moolenaarf8a07122019-07-01 22:06:07 +02008424 number, more intelligent detection is done.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008425 The "xterm2" value will be set if the xterm version is reported to be
Bram Moolenaard47d5222018-12-09 20:43:55 +01008426 from 95 to 276. The "sgr" value will be set if Vim detects Mac
8427 Terminal.app, iTerm2 or mintty, and when the xterm version is 277 or
8428 higher.
Bram Moolenaare968e362014-05-13 20:23:24 +02008429 If you do not want 'ttymouse' to be set to "xterm2" or "sgr"
8430 automatically, set t_RV to an empty string: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008431 :set t_RV=
8432<
8433 *'ttyscroll'* *'tsl'*
8434'ttyscroll' 'tsl' number (default 999)
8435 global
8436 Maximum number of lines to scroll the screen. If there are more lines
8437 to scroll the window is redrawn. For terminals where scrolling is
8438 very slow and redrawing is not slow this can be set to a small number,
8439 e.g., 3, to speed up displaying.
8440
8441 *'ttytype'* *'tty'*
8442'ttytype' 'tty' string (default from $TERM)
8443 global
8444 Alias for 'term', see above.
8445
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008446 *'undodir'* *'udir'*
8447'undodir' 'udir' string (default ".")
8448 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008449 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008450 List of directory names for undo files, separated with commas.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008451 See |'backupdir'| for details of the format.
Bram Moolenaar6a244fe2010-05-24 22:02:24 +02008452 "." means using the directory of the file. The undo file name for
8453 "file.txt" is ".file.txt.un~".
8454 For other directories the file name is the full path of the edited
8455 file, with path separators replaced with "%".
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008456 When writing: The first directory that exists is used. "." always
8457 works, no directories after "." will be used for writing.
8458 When reading all entries are tried to find an undo file. The first
8459 undo file that exists is used. When it cannot be read an error is
8460 given, no further entry is used.
8461 See |undo-persistence|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008462 This option cannot be set from a |modeline| or in the |sandbox|, for
8463 security reasons.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008464
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02008465 *'undofile'* *'noundofile'* *'udf'* *'noudf'*
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008466'undofile' 'udf' boolean (default off)
8467 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02008468 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008469 When on, Vim automatically saves undo history to an undo file when
8470 writing a buffer to a file, and restores undo history from the same
8471 file on buffer read.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008472 The directory where the undo file is stored is specified by 'undodir'.
8473 For more information about this feature see |undo-persistence|.
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008474 The undo file is not read when 'undoreload' causes the buffer from
8475 before a reload to be saved for undo.
Bram Moolenaar97d62492012-11-15 21:28:22 +01008476 When 'undofile' is turned off the undo file is NOT deleted.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008477 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008478
Bram Moolenaar071d4272004-06-13 20:20:40 +00008479 *'undolevels'* *'ul'*
Bram Moolenaar8024f932020-01-14 19:29:13 +01008480'undolevels' 'ul' number (default 100, 1000 for Unix, VMS and Win32)
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008481 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008482 Maximum number of changes that can be undone. Since undo information
Bram Moolenaar5be4cee2019-09-27 19:34:08 +02008483 is kept in memory, higher numbers will cause more memory to be used.
8484 Nevertheless, a single change can already use a large amount of memory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008485 Set to 0 for Vi compatibility: One level of undo and "u" undoes
8486 itself: >
8487 set ul=0
8488< But you can also get Vi compatibility by including the 'u' flag in
8489 'cpoptions', and still be able to use CTRL-R to repeat undo.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008490 Also see |undo-two-ways|.
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008491 Set to -1 for no undo at all. You might want to do this only for the
8492 current buffer: >
8493 setlocal ul=-1
Bram Moolenaar071d4272004-06-13 20:20:40 +00008494< This helps when you run out of memory for a single change.
Bram Moolenaar32efaf62014-11-05 17:02:17 +01008495
8496 The local value is set to -123456 when the global value is to be used.
8497
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008498 Also see |clear-undo|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008499
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008500 *'undoreload'* *'ur'*
8501'undoreload' 'ur' number (default 10000)
8502 global
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008503 Save the whole buffer for undo when reloading it. This applies to the
8504 ":e!" command and reloading for when the buffer changed outside of
8505 Vim. |FileChangedShell|
Bram Moolenaar24a98a02017-09-27 22:23:55 +02008506 The save only happens when this option is negative or when the number
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008507 of lines is smaller than the value of this option.
8508 Set this option to zero to disable undo for a reload.
8509
8510 When saving undo for a reload, any undo file is not read.
8511
8512 Note that this causes the whole buffer to be stored in memory. Set
8513 this option to a lower value if you run out of memory.
8514
Bram Moolenaar071d4272004-06-13 20:20:40 +00008515 *'updatecount'* *'uc'*
8516'updatecount' 'uc' number (default: 200)
8517 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008518 After typing this many characters the swap file will be written to
8519 disk. When zero, no swap file will be created at all (see chapter on
8520 recovery |crash-recovery|). 'updatecount' is set to zero by starting
8521 Vim with the "-n" option, see |startup|. When editing in readonly
8522 mode this option will be initialized to 10000.
8523 The swapfile can be disabled per buffer with |'swapfile'|.
8524 When 'updatecount' is set from zero to non-zero, swap files are
8525 created for all buffers that have 'swapfile' set. When 'updatecount'
8526 is set to zero, existing swap files are not deleted.
8527 Also see |'swapsync'|.
8528 This option has no meaning in buffers where |'buftype'| is "nofile"
8529 or "nowrite".
8530
8531 *'updatetime'* *'ut'*
8532'updatetime' 'ut' number (default 4000)
8533 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008534 If this many milliseconds nothing is typed the swap file will be
8535 written to disk (see |crash-recovery|). Also used for the
8536 |CursorHold| autocommand event.
8537
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008538 *'varsofttabstop'* *'vsts'*
8539'varsofttabstop' 'vsts' string (default "")
8540 local to buffer
8541 {only available when compiled with the |+vartabs|
8542 feature}
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008543 A list of the number of spaces that a <Tab> counts for while editing,
8544 such as inserting a <Tab> or using <BS>. It "feels" like variable-
8545 width <Tab>s are being inserted, while in fact a mixture of spaces
8546 and <Tab>s is used. Tab widths are separated with commas, with the
8547 final value applying to all subsequent tabs.
8548
8549 For example, when editing assembly language files where statements
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02008550 start in the 9th column and comments in the 41st, it may be useful
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008551 to use the following: >
8552 :set varsofttabstop=8,32,8
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02008553< This will set soft tabstops with 8 and 8 + 32 spaces, and 8 more
8554 for every column thereafter.
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008555
8556 Note that the value of |'softtabstop'| will be ignored while
8557 'varsofttabstop' is set.
8558
8559 *'vartabstop'* *'vts'*
8560'vartabstop' 'vts' string (default "")
8561 local to buffer
8562 {only available when compiled with the |+vartabs|
8563 feature}
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008564 A list of the number of spaces that a <Tab> in the file counts for,
8565 separated by commas. Each value corresponds to one tab, with the
8566 final value applying to all subsequent tabs. For example: >
8567 :set vartabstop=4,20,10,8
8568< This will make the first tab 4 spaces wide, the second 20 spaces,
8569 the third 10 spaces, and all following tabs 8 spaces.
8570
8571 Note that the value of |'tabstop'| will be ignored while 'vartabstop'
8572 is set.
8573
Bram Moolenaar071d4272004-06-13 20:20:40 +00008574 *'verbose'* *'vbs'*
8575'verbose' 'vbs' number (default 0)
8576 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008577 When bigger than zero, Vim will give messages about what it is doing.
8578 Currently, these messages are given:
8579 >= 1 When the viminfo file is read or written.
8580 >= 2 When a file is ":source"'ed.
Bram Moolenaar647a5302020-05-03 17:01:24 +02008581 >= 4 Shell commands.
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008582 >= 5 Every searched tags file and include file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008583 >= 8 Files for which a group of autocommands is executed.
8584 >= 9 Every executed autocommand.
Bram Moolenaar647a5302020-05-03 17:01:24 +02008585 >= 11 Finding items in a path
Bram Moolenaar071d4272004-06-13 20:20:40 +00008586 >= 12 Every executed function.
8587 >= 13 When an exception is thrown, caught, finished, or discarded.
8588 >= 14 Anything pending in a ":finally" clause.
Bram Moolenaar823654b2020-05-29 23:03:09 +02008589 >= 15 Every executed Ex command from a script (truncated at 200
8590 characters).
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02008591 >= 16 Every executed Ex command.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008592
8593 This option can also be set with the "-V" argument. See |-V|.
8594 This option is also set by the |:verbose| command.
8595
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008596 When the 'verbosefile' option is set then the verbose messages are not
8597 displayed.
8598
8599 *'verbosefile'* *'vfile'*
8600'verbosefile' 'vfile' string (default empty)
8601 global
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008602 When not empty all messages are written in a file with this name.
8603 When the file exists messages are appended.
8604 Writing to the file ends when Vim exits or when 'verbosefile' is made
Bram Moolenaar80794b12010-06-13 05:20:42 +02008605 empty. Writes are buffered, thus may not show up for some time.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008606 Setting 'verbosefile' to a new value is like making it empty first.
8607 The difference with |:redir| is that verbose messages are not
8608 displayed when 'verbosefile' is set.
8609
Bram Moolenaar071d4272004-06-13 20:20:40 +00008610 *'viewdir'* *'vdir'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008611'viewdir' 'vdir' string (default for Amiga and Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008612 "$VIM/vimfiles/view",
8613 for Unix: "~/.vim/view",
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02008614 for macOS: "$VIM:vimfiles:view"
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01008615 for VMS: "sys$login:vimfiles/view")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008616 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008617 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008618 feature}
8619 Name of the directory where to store files for |:mkview|.
8620 This option cannot be set from a |modeline| or in the |sandbox|, for
8621 security reasons.
8622
8623 *'viewoptions'* *'vop'*
Bram Moolenaar13e90412017-11-11 18:16:48 +01008624'viewoptions' 'vop' string (default: "folds,options,cursor,curdir")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008625 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008626 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008627 feature}
8628 Changes the effect of the |:mkview| command. It is a comma separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008629 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008630 word save and restore ~
8631 cursor cursor position in file and in window
8632 folds manually created folds, opened/closed folds and local
8633 fold options
8634 options options and mappings local to a window or buffer (not
8635 global values for local options)
Bram Moolenaar6e932462014-09-09 18:48:09 +02008636 localoptions same as "options"
Bram Moolenaar071d4272004-06-13 20:20:40 +00008637 slash backslashes in file names replaced with forward
8638 slashes
8639 unix with Unix end-of-line format (single <NL>), even when
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008640 on MS-Windows
Bram Moolenaar13e90412017-11-11 18:16:48 +01008641 curdir the window-local directory, if set with `:lcd`
Bram Moolenaar071d4272004-06-13 20:20:40 +00008642
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008643 "slash" and "unix" are useful on MS-Windows when sharing view files
Bram Moolenaar071d4272004-06-13 20:20:40 +00008644 with Unix. The Unix version of Vim cannot source dos format scripts,
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008645 but the MS-Windows version of Vim can source unix format scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008646
8647 *'viminfo'* *'vi'* *E526* *E527* *E528*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008648'viminfo' 'vi' string (Vi default: "", Vim default for
8649 MS-Windows: '100,<50,s10,h,rA:,rB:,
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01008650 for Amiga: '100,<50,s10,h,rdf0:,rdf1:,rdf2:
8651 for others: '100,<50,s10,h)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008652 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008653 {not available when compiled without the |+viminfo|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008654 feature}
8655 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008656 when exiting Vim (see |viminfo-file|). Except when 'viminfofile' is
8657 "NONE".
8658 The string should be a comma separated list of parameters, each
8659 consisting of a single character identifying the particular parameter,
8660 followed by a number or string which specifies the value of that
8661 parameter. If a particular character is left out, then the default
8662 value is used for that parameter. The following is a list of the
8663 identifying characters and the effect of their value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008664 CHAR VALUE ~
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008665 *viminfo-!*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008666 ! When included, save and restore global variables that start
8667 with an uppercase letter, and don't contain a lowercase
8668 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar680eeca2010-10-20 17:44:42 +02008669 and "_K_L_M" are not. Nested List and Dict items may not be
Bram Moolenaar166af9b2010-11-16 20:34:40 +01008670 read back correctly, you end up with an empty item.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008671 *viminfo-quote*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008672 " Maximum number of lines saved for each register. Old name of
8673 the '<' item, with the disadvantage that you need to put a
8674 backslash before the ", otherwise it will be recognized as the
8675 start of a comment!
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008676 *viminfo-%*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008677 % When included, save and restore the buffer list. If Vim is
8678 started with a file name argument, the buffer list is not
8679 restored. If Vim is started without a file name argument, the
Bram Moolenaard042dc82015-11-24 19:18:36 +01008680 buffer list is restored from the viminfo file. Quickfix
8681 ('buftype'), unlisted ('buflisted'), unnamed and buffers on
8682 removable media (|viminfo-r|) are not saved.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00008683 When followed by a number, the number specifies the maximum
8684 number of buffers that are stored. Without a number all
8685 buffers are stored.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008686 *viminfo-'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008687 ' Maximum number of previously edited files for which the marks
8688 are remembered. This parameter must always be included when
8689 'viminfo' is non-empty.
8690 Including this item also means that the |jumplist| and the
8691 |changelist| are stored in the viminfo file.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008692 *viminfo-/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008693 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008694 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00008695 patterns are also saved. When not included, the value of
8696 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008697 *viminfo-:*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008698 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008699 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008700 *viminfo-<*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008701 < Maximum number of lines saved for each register. If zero then
8702 registers are not saved. When not included, all lines are
8703 saved. '"' is the old name for this item.
8704 Also see the 's' item below: limit specified in Kbyte.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008705 *viminfo-@*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008706 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008707 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008708 *viminfo-c*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008709 c When included, convert the text in the viminfo file from the
8710 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00008711 'encoding'. See |viminfo-encoding|.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008712 *viminfo-f*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008713 f Whether file marks need to be stored. If zero, file marks ('0
8714 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008715 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00008716 cursor position (when exiting or when doing ":wviminfo").
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008717 *viminfo-h*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008718 h Disable the effect of 'hlsearch' when loading the viminfo
8719 file. When not included, it depends on whether ":nohlsearch"
8720 has been used since the last search command.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008721 *viminfo-n*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008722 n Name of the viminfo file. The name must immediately follow
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008723 the 'n'. Must be at the end of the option! If the
8724 'viminfofile' option is set, that file name overrides the one
8725 given here with 'viminfo'. Environment variables are
Bram Moolenaar063b9d12016-07-09 20:21:48 +02008726 expanded when opening the file, not when setting the option.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008727 *viminfo-r*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008728 r Removable media. The argument is a string (up to the next
8729 ','). This parameter can be given several times. Each
8730 specifies the start of a path for which no marks will be
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01008731 stored. This is to avoid removable media. For MS-Windows you
Bram Moolenaar071d4272004-06-13 20:20:40 +00008732 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
8733 also use it for temp files, e.g., for Unix: "r/tmp". Case is
8734 ignored. Maximum length of each 'r' argument is 50
8735 characters.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008736 *viminfo-s*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008737 s Maximum size of an item in Kbyte. If zero then registers are
8738 not saved. Currently only applies to registers. The default
8739 "s10" will exclude registers with more than 10 Kbyte of text.
8740 Also see the '<' item above: line count limit.
8741
8742 Example: >
8743 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
8744<
8745 '50 Marks will be remembered for the last 50 files you
8746 edited.
8747 <1000 Contents of registers (up to 1000 lines each) will be
8748 remembered.
8749 s100 Registers with more than 100 Kbyte text are skipped.
8750 :0 Command-line history will not be saved.
8751 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
8752 no / Since '/' is not specified, the default will be used,
8753 that is, save all of the search history, and also the
8754 previous search and substitute patterns.
8755 no % The buffer list will not be saved nor read back.
8756 no h 'hlsearch' highlighting will be restored.
8757
8758 When setting 'viminfo' from an empty value you can use |:rviminfo| to
8759 load the contents of the file, this is not done automatically.
8760
8761 This option cannot be set from a |modeline| or in the |sandbox|, for
8762 security reasons.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008763 NOTE: This option is set to the Vim default value when 'compatible'
8764 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008765
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008766 *'viminfofile'* *'vif'*
8767'viminfofile' 'vif' string (default: "")
8768 global
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008769 {not available when compiled without the |+viminfo|
8770 feature}
8771 When non-empty, overrides the file name used for viminfo.
8772 When equal to "NONE" no viminfo file will be read or written.
8773 This option can be set with the |-i| command line flag. The |--clean|
8774 command line flag sets it to "NONE".
Bram Moolenaar110289e2019-05-23 15:38:06 +02008775 This option cannot be set from a |modeline| or in the |sandbox|, for
8776 security reasons.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008777
Bram Moolenaar071d4272004-06-13 20:20:40 +00008778 *'virtualedit'* *'ve'*
8779'virtualedit' 've' string (default "")
Gary Johnson51ad8502021-08-03 18:33:08 +02008780 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008781 A comma separated list of these words:
8782 block Allow virtual editing in Visual block mode.
8783 insert Allow virtual editing in Insert mode.
8784 all Allow virtual editing in all modes.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008785 onemore Allow the cursor to move just past the end of the line
Gary Johnson53ba05b2021-07-26 22:19:10 +02008786 none When used as the local value, do not allow virtual
8787 editing even when the global value is set. When used
8788 as the global value, "none" is the same as "".
8789 NONE Alternative spelling of "none".
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008790
Bram Moolenaar071d4272004-06-13 20:20:40 +00008791 Virtual editing means that the cursor can be positioned where there is
Bram Moolenaarebcbd022007-05-12 14:28:25 +00008792 no actual character. This can be halfway into a tab or beyond the end
Bram Moolenaar071d4272004-06-13 20:20:40 +00008793 of the line. Useful for selecting a rectangle in Visual mode and
8794 editing a table.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008795 "onemore" is not the same, it will only allow moving the cursor just
8796 after the last character of the line. This makes some commands more
8797 consistent. Previously the cursor was always past the end of the line
8798 if the line was empty. But it is far from Vi compatible. It may also
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008799 break some plugins or Vim scripts. For example because |l| can move
8800 the cursor after the last character. Use with care!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02008801 Using the `$` command will move to the last character in the line, not
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008802 past it. This may actually move the cursor to the left!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02008803 The `g$` command will move to the end of the screen line.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008804 It doesn't make sense to combine "all" with "onemore", but you will
8805 not get a warning for it.
Bram Moolenaar53f7fcc2021-07-28 20:10:16 +02008806 When combined with other words, "none" is ignored.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008807 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008808
8809 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
8810'visualbell' 'vb' boolean (default off)
8811 global
Bram Moolenaar74675a62017-07-15 13:53:23 +02008812 Use a visual bell instead of beeping. The terminal code to display the
Bram Moolenaar071d4272004-06-13 20:20:40 +00008813 visual bell is given with 't_vb'. When no beep or flash is wanted,
Bram Moolenaar74675a62017-07-15 13:53:23 +02008814 use: >
8815 :set vb t_vb=
8816< If you want a short flash, you can use this on many terminals: >
8817 :set vb t_vb=[?5h$<100>[?5l
8818< Here $<100> specifies the time, you can use a smaller or bigger value
8819 to get a shorter or longer flash.
8820
8821 Note: Vim will limit the bell to once per half a second. This avoids
8822 having to wait for the flashing to finish when there are lots of
8823 bells, e.g. on key repeat. This also happens without 'visualbell'
8824 set.
8825
Bram Moolenaar071d4272004-06-13 20:20:40 +00008826 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
8827 for 20 msec. If you want to use a different time, use "<Esc>|40f",
8828 where 40 is the time in msec.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008829
8830 Note: When the GUI starts, 't_vb' is reset to its default value. You
8831 might want to set it again in your |gvimrc|.
8832
Bram Moolenaar071d4272004-06-13 20:20:40 +00008833 Does not work on the Amiga, you always get a screen flash.
8834 Also see 'errorbells'.
8835
8836 *'warn'* *'nowarn'*
8837'warn' boolean (default on)
8838 global
8839 Give a warning message when a shell command is used while the buffer
8840 has been changed.
8841
8842 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
8843'weirdinvert' 'wiv' boolean (default off)
8844 global
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00008845 This option has the same effect as the 't_xs' terminal option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008846 It is provided for backwards compatibility with version 4.x.
8847 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
8848 vice versa. Has no effect when the GUI is running.
8849
8850 *'whichwrap'* *'ww'*
8851'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
8852 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008853 Allow specified keys that move the cursor left/right to move to the
8854 previous/next line when the cursor is on the first/last character in
8855 the line. Concatenate characters to allow this for these keys:
8856 char key mode ~
8857 b <BS> Normal and Visual
8858 s <Space> Normal and Visual
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008859 h "h" Normal and Visual (not recommended)
8860 l "l" Normal and Visual (not recommended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008861 < <Left> Normal and Visual
8862 > <Right> Normal and Visual
8863 ~ "~" Normal
8864 [ <Left> Insert and Replace
8865 ] <Right> Insert and Replace
8866 For example: >
8867 :set ww=<,>,[,]
8868< allows wrap only when cursor keys are used.
8869 When the movement keys are used in combination with a delete or change
8870 operator, the <EOL> also counts for a character. This makes "3h"
8871 different from "3dh" when the cursor crosses the end of a line. This
8872 is also true for "x" and "X", because they do the same as "dl" and
8873 "dh". If you use this, you may also want to use the mapping
8874 ":map <BS> X" to make backspace delete the character in front of the
8875 cursor.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00008876 When 'l' is included and it is used after an operator at the end of a
Bram Moolenaar589edb32019-09-20 14:38:13 +02008877 line (not an empty line) then it will not move to the next line. This
8878 makes "dl", "cl", "yl" etc. work normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008879 NOTE: This option is set to the Vi default value when 'compatible' is
8880 set and to the Vim default value when 'compatible' is reset.
8881
8882 *'wildchar'* *'wc'*
8883'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
8884 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008885 Character you have to type to start wildcard expansion in the
8886 command-line, as specified with 'wildmode'.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008887 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008888 The character is not recognized when used inside a macro. See
8889 'wildcharm' for that.
Bram Moolenaar34cc7d82021-09-21 20:09:51 +02008890 Some keys will not work, such as CTRL-C, <CR> and Enter.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008891 Although 'wc' is a number option, you can set it to a special key: >
Bram Moolenaar34cc7d82021-09-21 20:09:51 +02008892 :set wc=<Tab>
Bram Moolenaar071d4272004-06-13 20:20:40 +00008893< NOTE: This option is set to the Vi default value when 'compatible' is
8894 set and to the Vim default value when 'compatible' is reset.
8895
8896 *'wildcharm'* *'wcm'*
8897'wildcharm' 'wcm' number (default: none (0))
8898 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008899 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00008900 recognized when used inside a macro. You can find "spare" command-line
8901 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00008902 you'll never actually type 'wildcharm', just use it in mappings that
8903 automatically invoke completion mode, e.g.: >
8904 :set wcm=<C-Z>
Bram Moolenaar446cb832008-06-24 21:56:24 +00008905 :cnoremap ss so $vim/sessions/*.vim<C-Z>
Bram Moolenaar071d4272004-06-13 20:20:40 +00008906< Then after typing :ss you can use CTRL-P & CTRL-N.
8907
8908 *'wildignore'* *'wig'*
8909'wildignore' 'wig' string (default "")
8910 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008911 {not available when compiled without the |+wildignore|
8912 feature}
8913 A list of file patterns. A file that matches with one of these
Bram Moolenaar30b65812012-07-12 22:01:11 +02008914 patterns is ignored when expanding |wildcards|, completing file or
8915 directory names, and influences the result of |expand()|, |glob()| and
8916 |globpath()| unless a flag is passed to disable this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008917 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
8918 Also see 'suffixes'.
8919 Example: >
8920 :set wildignore=*.o,*.obj
8921< The use of |:set+=| and |:set-=| is preferred when adding or removing
8922 a pattern from the list. This avoids problems when a future version
8923 uses another default.
8924
Bram Moolenaar94950a92010-12-02 16:01:29 +01008925
Bram Moolenaar81af9252010-12-10 20:35:50 +01008926 *'wildignorecase'* *'wic'* *'nowildignorecase'* *'nowic'*
Bram Moolenaar94950a92010-12-02 16:01:29 +01008927'wildignorecase' 'wic' boolean (default off)
8928 global
Bram Moolenaar94950a92010-12-02 16:01:29 +01008929 When set case is ignored when completing file names and directories.
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01008930 Has no effect when 'fileignorecase' is set.
Bram Moolenaar94950a92010-12-02 16:01:29 +01008931 Does not apply when the shell is used to expand wildcards, which
8932 happens when there are special characters.
8933
8934
Bram Moolenaar071d4272004-06-13 20:20:40 +00008935 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02008936'wildmenu' 'wmnu' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008937 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008938 {not available if compiled without the |+wildmenu|
8939 feature}
8940 When 'wildmenu' is on, command-line completion operates in an enhanced
8941 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
8942 the possible matches are shown just above the command line, with the
8943 first match highlighted (overwriting the status line, if there is
8944 one). Keys that show the previous/next match, such as <Tab> or
8945 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
8946 When 'wildmode' is used, "wildmenu" mode is used where "full" is
8947 specified. "longest" and "list" do not start "wildmenu" mode.
Bram Moolenaar26402cb2013-02-20 21:26:00 +01008948 You can check the current mode with |wildmenumode()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008949 If there are more matches than can fit in the line, a ">" is shown on
8950 the right and/or a "<" is shown on the left. The status line scrolls
8951 as needed.
8952 The "wildmenu" mode is abandoned when a key is hit that is not used
8953 for selecting a completion.
8954 While the "wildmenu" is active the following keys have special
8955 meanings:
8956
8957 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
8958 <Down> - in filename/menu name completion: move into a
8959 subdirectory or submenu.
8960 <CR> - in menu completion, when the cursor is just after a
8961 dot: move into a submenu.
8962 <Up> - in filename/menu name completion: move up into
8963 parent directory or parent menu.
8964
8965 This makes the menus accessible from the console |console-menus|.
8966
8967 If you prefer the <Left> and <Right> keys to move the cursor instead
8968 of selecting a different match, use this: >
8969 :cnoremap <Left> <Space><BS><Left>
8970 :cnoremap <Right> <Space><BS><Right>
8971<
8972 The "WildMenu" highlighting is used for displaying the current match
8973 |hl-WildMenu|.
8974
8975 *'wildmode'* *'wim'*
8976'wildmode' 'wim' string (Vim default: "full")
8977 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008978 Completion mode that is used for the character specified with
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008979 'wildchar'. It is a comma separated list of up to four parts. Each
Bram Moolenaar02467872007-05-06 13:22:01 +00008980 part specifies what to do for each consecutive use of 'wildchar'. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00008981 first part specifies the behavior for the first use of 'wildchar',
8982 The second part for the second use, etc.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02008983
8984 Each part consists of a colon separated list consisting of the
8985 following possible values:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008986 "" Complete only the first match.
8987 "full" Complete the next full match. After the last match,
8988 the original string is used and then the first match
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02008989 again. Will also start 'wildmenu' if it is enabled.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008990 "longest" Complete till longest common string. If this doesn't
8991 result in a longer string, use the next part.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008992 "list" When more than one match, list all matches.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02008993 "lastused" When completing buffer names and more than one buffer
8994 matches, sort buffers by time last used (other than
8995 the current buffer).
8996 When there is only a single match, it is fully completed in all cases.
8997
8998 Examples of useful colon-separated values:
8999 "longest:full" Like "longest", but also start 'wildmenu' if it is
9000 enabled. Will not complete to the next full match.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009001 "list:full" When more than one match, list all matches and
9002 complete first match.
9003 "list:longest" When more than one match, list all matches and
9004 complete till longest common string.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009005 "list:lastused" When more than one buffer matches, list all matches
9006 and sort buffers by time last used (other than the
9007 current buffer).
Bram Moolenaar071d4272004-06-13 20:20:40 +00009008
9009 Examples: >
9010 :set wildmode=full
Bram Moolenaar582fd852005-03-28 20:58:01 +00009011< Complete first full match, next match, etc. (the default) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00009012 :set wildmode=longest,full
9013< Complete longest common string, then each full match >
9014 :set wildmode=list:full
9015< List all matches and complete each full match >
9016 :set wildmode=list,full
9017< List all matches without completing, then each full match >
9018 :set wildmode=longest,list
9019< Complete longest common string, then list alternatives.
Bram Moolenaar446cb832008-06-24 21:56:24 +00009020 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009021
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009022 *'wildoptions'* *'wop'*
9023'wildoptions' 'wop' string (default "")
9024 global
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009025 {not available when compiled without the |+wildignore|
9026 feature}
9027 A list of words that change how command line completion is done.
9028 Currently only one word is allowed:
9029 tagfile When using CTRL-D to list matching tags, the kind of
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00009030 tag and the file of the tag is listed. Only one match
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009031 is displayed per line. Often used tag kinds are:
9032 d #define
9033 f function
9034 Also see |cmdline-completion|.
9035
Bram Moolenaar071d4272004-06-13 20:20:40 +00009036 *'winaltkeys'* *'wak'*
9037'winaltkeys' 'wak' string (default "menu")
9038 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009039 {only used in Win32, Motif, GTK and Photon GUI}
9040 Some GUI versions allow the access to menu entries by using the ALT
9041 key in combination with a character that appears underlined in the
9042 menu. This conflicts with the use of the ALT key for mappings and
9043 entering special characters. This option tells what to do:
9044 no Don't use ALT keys for menus. ALT key combinations can be
9045 mapped, but there is no automatic handling. This can then be
9046 done with the |:simalt| command.
9047 yes ALT key handling is done by the windowing system. ALT key
9048 combinations cannot be mapped.
9049 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009050 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00009051 keys can be mapped.
9052 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
9053 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00009054 This option is not used for <F10>; on Win32 and with GTK <F10> will
9055 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009056
Bram Moolenaar4d784b22019-05-25 19:51:39 +02009057 *'wincolor'* *'wcr'*
9058'wincolor' 'wcr' string (default empty)
9059 local to window
9060 Highlight group name to use for this window instead of the Normal
9061 color |hl-Normal|.
9062
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009063 *'window'* *'wi'*
9064'window' 'wi' number (default screen height - 1)
9065 global
Bram Moolenaardad44732021-03-31 20:07:33 +02009066 Window height used for |CTRL-F| and |CTRL-B| when there is only one
9067 window and the value is smaller than 'lines' minus one. The screen
9068 will scroll 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009069 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
9070 in a much smarter way, taking care of wrapping lines.
9071 When resizing the Vim window, the value is smaller than 1 or more than
9072 or equal to 'lines' it will be set to 'lines' minus 1.
Bram Moolenaardad44732021-03-31 20:07:33 +02009073 Note: Do not confuse this with the height of the Vim window, use
9074 'lines' for that.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009075
Bram Moolenaar071d4272004-06-13 20:20:40 +00009076 *'winheight'* *'wh'* *E591*
9077'winheight' 'wh' number (default 1)
9078 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009079 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009080 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar446cb832008-06-24 21:56:24 +00009081 focus goes to a window that is smaller, its size is increased, at the
9082 cost of the height of other windows.
9083 Set 'winheight' to a small number for normal editing.
9084 Set it to 999 to make the current window fill most of the screen.
9085 Other windows will be only 'winminheight' high. This has the drawback
9086 that ":all" will create only two windows. To avoid "vim -o 1 2 3 4"
9087 to create only two windows, set the option after startup is done,
9088 using the |VimEnter| event: >
9089 au VimEnter * set winheight=999
9090< Minimum value is 1.
9091 The height is not adjusted after one of the commands that change the
Bram Moolenaar071d4272004-06-13 20:20:40 +00009092 height of the current window.
9093 'winheight' applies to the current window. Use 'winminheight' to set
9094 the minimal height for other windows.
9095
9096 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
9097'winfixheight' 'wfh' boolean (default off)
9098 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00009099 Keep the window height when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00009100 'equalalways' is set. Also for |CTRL-W_=|. Set by default for the
9101 |preview-window| and |quickfix-window|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009102 The height may be changed anyway when running out of room.
9103
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009104 *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'*
9105'winfixwidth' 'wfw' boolean (default off)
9106 local to window
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009107 Keep the window width when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00009108 'equalalways' is set. Also for |CTRL-W_=|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009109 The width may be changed anyway when running out of room.
9110
Bram Moolenaar071d4272004-06-13 20:20:40 +00009111 *'winminheight'* *'wmh'*
9112'winminheight' 'wmh' number (default 1)
9113 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009114 The minimal height of a window, when it's not the current window.
9115 This is a hard minimum, windows will never become smaller.
9116 When set to zero, windows may be "squashed" to zero lines (i.e. just a
9117 status bar) if necessary. They will return to at least one line when
9118 they become active (since the cursor has to have somewhere to go.)
9119 Use 'winheight' to set the minimal height of the current window.
9120 This option is only checked when making a window smaller. Don't use a
9121 large number, it will cause errors when opening more than a few
9122 windows. A value of 0 to 3 is reasonable.
9123
9124 *'winminwidth'* *'wmw'*
9125'winminwidth' 'wmw' number (default 1)
9126 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009127 The minimal width of a window, when it's not the current window.
9128 This is a hard minimum, windows will never become smaller.
9129 When set to zero, windows may be "squashed" to zero columns (i.e. just
9130 a vertical separator) if necessary. They will return to at least one
9131 line when they become active (since the cursor has to have somewhere
9132 to go.)
9133 Use 'winwidth' to set the minimal width of the current window.
9134 This option is only checked when making a window smaller. Don't use a
9135 large number, it will cause errors when opening more than a few
9136 windows. A value of 0 to 12 is reasonable.
9137
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009138 *'winptydll'*
9139'winptydll' string (default "winpty32.dll" or "winpty64.dll")
9140 global
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009141 {only available when compiled with the |terminal|
9142 feature on MS-Windows}
9143 Specifies the name of the winpty shared library, used for the
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02009144 |:terminal| command. The default depends on whether Vim was built as a
Bram Moolenaarc572da52017-08-27 16:52:01 +02009145 32-bit or 64-bit executable. If not found, "winpty.dll" is tried as
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009146 a fallback.
9147 Environment variables are expanded |:set_env|.
9148 This option cannot be set from a |modeline| or in the |sandbox|, for
9149 security reasons.
9150
Bram Moolenaar071d4272004-06-13 20:20:40 +00009151 *'winwidth'* *'wiw'* *E592*
9152'winwidth' 'wiw' number (default 20)
9153 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009154 Minimal number of columns for the current window. This is not a hard
9155 minimum, Vim will use fewer columns if there is not enough room. If
9156 the current window is smaller, its size is increased, at the cost of
9157 the width of other windows. Set it to 999 to make the current window
9158 always fill the screen. Set it to a small number for normal editing.
9159 The width is not adjusted after one of the commands to change the
9160 width of the current window.
9161 'winwidth' applies to the current window. Use 'winminwidth' to set
9162 the minimal width for other windows.
9163
9164 *'wrap'* *'nowrap'*
9165'wrap' boolean (default on)
9166 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00009167 This option changes how text is displayed. It doesn't change the text
9168 in the buffer, see 'textwidth' for that.
9169 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009170 displaying continues on the next line. When off lines will not wrap
9171 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00009172 moved to a part that is not shown, the screen will scroll
9173 horizontally.
9174 The line will be broken in the middle of a word if necessary. See
9175 'linebreak' to get the break at a word boundary.
9176 To make scrolling horizontally a bit more useful, try this: >
9177 :set sidescroll=5
9178 :set listchars+=precedes:<,extends:>
9179< See 'sidescroll', 'listchars' and |wrap-off|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01009180 This option can't be set from a |modeline| when the 'diff' option is
9181 on.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009182
9183 *'wrapmargin'* *'wm'*
9184'wrapmargin' 'wm' number (default 0)
9185 local to buffer
9186 Number of characters from the right window border where wrapping
9187 starts. When typing text beyond this limit, an <EOL> will be inserted
9188 and inserting continues on the next line.
9189 Options that add a margin, such as 'number' and 'foldcolumn', cause
9190 the text width to be further reduced. This is Vi compatible.
9191 When 'textwidth' is non-zero, this option is not used.
Bram Moolenaarca635012015-09-25 20:34:21 +02009192 This option is set to 0 when 'paste' is set and restored when 'paste'
9193 is reset.
Bram Moolenaara6c27c42019-05-09 19:16:22 +02009194 See also 'formatoptions' and |ins-textwidth|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009195
9196 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
9197'wrapscan' 'ws' boolean (default on) *E384* *E385*
9198 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00009199 Searches wrap around the end of the file. Also applies to |]s| and
9200 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009201
9202 *'write'* *'nowrite'*
9203'write' boolean (default on)
9204 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009205 Allows writing files. When not set, writing a file is not allowed.
9206 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009207 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00009208 argument. Filtering text is still possible, even though this requires
9209 writing a temporary file.
9210
9211 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
9212'writeany' 'wa' boolean (default off)
9213 global
9214 Allows writing to any file with no need for "!" override.
9215
9216 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
9217'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
9218 otherwise)
9219 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009220 Make a backup before overwriting a file. The backup is removed after
9221 the file was successfully written, unless the 'backup' option is
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02009222 also on.
9223 WARNING: Switching this option off means that when Vim fails to write
9224 your buffer correctly and then, for whatever reason, Vim exits, you
9225 lose both the original file and what you were writing. Only reset
9226 this option if your file system is almost full and it makes the write
9227 fail (and make sure not to exit Vim until the write was successful).
9228 See |backup-table| for another explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009229 When the 'backupskip' pattern matches, a backup is not made anyway.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01009230 Depending on 'backupcopy' the backup is a new file or the original
9231 file renamed (and a new file is written).
Bram Moolenaar071d4272004-06-13 20:20:40 +00009232 NOTE: This option is set to the default value when 'compatible' is
9233 set.
9234
9235 *'writedelay'* *'wd'*
9236'writedelay' 'wd' number (default 0)
9237 global
Bram Moolenaar802a0d92016-06-26 16:17:58 +02009238 The number of milliseconds to wait for each character sent to the
Bram Moolenaar071d4272004-06-13 20:20:40 +00009239 screen. When non-zero, characters are sent to the terminal one by
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01009240 one. For debugging purposes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009241
Bram Moolenaar6f79e612021-12-21 09:12:23 +00009242 *'xtermcodes'* *'noxtermcodes'*
9243'xtermcodes' boolean (default on)
9244 global
9245 When detecting xterm patchlevel 141 or higher with the termresponse
Bram Moolenaarfa3b7232021-12-24 13:18:38 +00009246 mechanism and this option is set, Vim will request the actual terminal
Bram Moolenaar6f79e612021-12-21 09:12:23 +00009247 key codes and number of colors from the terminal. This takes care of
9248 various configuration options of the terminal that cannot be obtained
9249 from the termlib/terminfo entry, see |xterm-codes|.
9250 A side effect may be that t_Co changes and Vim will redraw the
9251 display.
9252
9253
Bram Moolenaar91f84f62018-07-29 15:07:52 +02009254 vim:tw=78:ts=8:noet:ft=help:norl: