blob: e221fe3e29542ab3901130ac17ad15ae6e0f32c8 [file] [log] [blame]
zeertzjq20e045f2024-10-28 22:05:26 +01001*options.txt* For Vim version 9.1. Last change: 2024 Oct 28
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...
Bram Moolenaarf1dcd142022-12-31 15:30:45 +000037 The options have the form t_AB, see
38 |terminal-options|.
Bram Moolenaar071d4272004-06-13 20:20:40 +000039
Bram Moolenaar47003982021-12-05 21:54:04 +000040:se[t]! termcap Idem, but don't use multiple columns.
41
Bram Moolenaar071d4272004-06-13 20:20:40 +000042 *E518* *E519*
43:se[t] {option}? Show value of {option}.
44
45:se[t] {option} Toggle option: set, switch it on.
46 Number option: show value.
47 String option: show value.
48
49:se[t] no{option} Toggle option: Reset, switch it off.
50
Bram Moolenaar00a927d2010-05-14 23:24:24 +020051 *:set-!* *:set-inv*
Bram Moolenaar071d4272004-06-13 20:20:40 +000052:se[t] {option}! or
Bram Moolenaar6c60f472019-04-28 16:00:35 +020053:se[t] inv{option} Toggle option: Invert value.
Bram Moolenaar071d4272004-06-13 20:20:40 +000054
55 *:set-default* *:set-&* *:set-&vi* *:set-&vim*
56:se[t] {option}& Reset option to its default value. May depend on the
Bram Moolenaar6c60f472019-04-28 16:00:35 +020057 current value of 'compatible'.
58:se[t] {option}&vi Reset option to its Vi default value.
59:se[t] {option}&vim Reset option to its Vim default value.
Bram Moolenaar071d4272004-06-13 20:20:40 +000060
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +010061:se[t] all& Set all options to their default value. The values of
Bram Moolenaar88774fd2015-08-25 19:52:04 +020062 these options are not changed:
63 all terminal options, starting with t_
64 'columns'
65 'cryptmethod'
66 'encoding'
67 'key'
68 'lines'
69 'term'
70 'ttymouse'
71 'ttytype'
72 Warning: This may have a lot of side effects.
Bram Moolenaar071d4272004-06-13 20:20:40 +000073
h_east59858792023-10-25 22:47:05 +090074 *:set-args* *:set=* *E487* *E521*
Bram Moolenaar071d4272004-06-13 20:20:40 +000075:se[t] {option}={value} or
76:se[t] {option}:{value}
77 Set string or number option to {value}.
78 For numeric options the value can be given in decimal,
Doug Kearnsddbb6fe2024-07-24 20:21:22 +020079 hex (preceded with 0x) or octal (preceded with '0' or
80 '0o').
Bram Moolenaar071d4272004-06-13 20:20:40 +000081 The old value can be inserted by typing 'wildchar' (by
82 default this is a <Tab> or CTRL-E if 'compatible' is
Yee Cheng Chin900894b2023-09-29 20:42:32 +020083 set). Many string options with fixed syntax and names
84 also support completing known values. See
85 |cmdline-completion| and |complete-set-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +000086 White space between {option} and '=' is allowed and
87 will be ignored. White space between '=' and {value}
88 is not allowed.
89 See |option-backslash| for using white space and
90 backslashes in {value}.
91
92:se[t] {option}+={value} *:set+=*
93 Add the {value} to a number option, or append the
94 {value} to a string option. When the option is a
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +010095 comma-separated list, a comma is added, unless the
Bram Moolenaar071d4272004-06-13 20:20:40 +000096 value was empty.
97 If the option is a list of flags, superfluous flags
Bram Moolenaara5792f52005-11-23 21:25:05 +000098 are removed. When adding a flag that was already
99 present the option value doesn't change.
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000100 Also see |:set-args| above.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000101
102:se[t] {option}^={value} *:set^=*
103 Multiply the {value} to a number option, or prepend
104 the {value} to a string option. When the option is a
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +0100105 comma-separated list, a comma is added, unless the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000106 value was empty.
107 Also see |:set-args| above.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000108
109:se[t] {option}-={value} *:set-=*
110 Subtract the {value} from a number option, or remove
111 the {value} from a string option, if it is there.
112 If the {value} is not found in a string option, there
113 is no error or warning. When the option is a comma
114 separated list, a comma is deleted, unless the option
115 becomes empty.
116 When the option is a list of flags, {value} must be
117 exactly as they appear in the option. Remove flags
118 one by one to avoid problems.
Yee Cheng Chin900894b2023-09-29 20:42:32 +0200119 The individual values from a comma separated list or
120 list of flags can be inserted by typing 'wildchar'.
121 See |complete-set-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000122 Also see |:set-args| above.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000123
124The {option} arguments to ":set" may be repeated. For example: >
125 :set ai nosi sw=3 ts=3
126If you make an error in one of the arguments, an error message will be given
127and the following arguments will be ignored.
128
129 *:set-verbose*
130When 'verbose' is non-zero, displaying an option value will also tell where it
131was last set. Example: >
132 :verbose set shiftwidth cindent?
Bram Moolenaar95bafa22018-10-02 13:26:25 +0200133< shiftwidth=4 ~
134 Last set from modeline line 1 ~
135 cindent ~
136 Last set from /usr/local/share/vim/vim60/ftplugin/c.vim line 30 ~
Bram Moolenaar446cb832008-06-24 21:56:24 +0000137This is only done when specific option values are requested, not for ":verbose
138set all" or ":verbose set" without an argument.
139When the option was set by hand there is no "Last set" message.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000140When the option was set while executing a function, user command or
141autocommand, the script in which it was defined is reported.
142Note that an option may also have been set as a side effect of setting
143'compatible'.
Bram Moolenaar446cb832008-06-24 21:56:24 +0000144A few special texts:
Bram Moolenaar95bafa22018-10-02 13:26:25 +0200145 Last set from modeline line 1 ~
Bram Moolenaar446cb832008-06-24 21:56:24 +0000146 Option was set in a |modeline|.
147 Last set from --cmd argument ~
148 Option was set with command line argument |--cmd| or +.
149 Last set from -c argument ~
150 Option was set with command line argument |-c|, +, |-S| or
151 |-q|.
152 Last set from environment variable ~
153 Option was set from an environment variable, $VIMINIT,
154 $GVIMINIT or $EXINIT.
155 Last set from error handler ~
156 Option was cleared when evaluating it resulted in an error.
157
Bram Moolenaardb84e452010-08-15 13:50:43 +0200158{not available when compiled without the |+eval| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000159
160 *:set-termcap* *E522*
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +0000161For {option} the form "t_xx" may be used to set a terminal option. This will
Bram Moolenaar071d4272004-06-13 20:20:40 +0000162override the value from the termcap. You can then use it in a mapping. If
163the "xx" part contains special characters, use the <t_xx> form: >
164 :set <t_#4>=^[Ot
165This can also be used to translate a special code for a normal key. For
166example, if Alt-b produces <Esc>b, use this: >
167 :set <M-b>=^[b
168(the ^[ is a real <Esc> here, use CTRL-V <Esc> to enter it)
169The advantage over a mapping is that it works in all situations.
170
Bram Moolenaar0b2f94d2011-03-22 14:35:05 +0100171You can define any key codes, e.g.: >
172 :set t_xy=^[foo;
173There is no warning for using a name that isn't recognized. You can map these
174codes as you like: >
175 :map <t_xy> something
176< *E846*
177When a key code is not set, it's like it does not exist. Trying to get its
178value will result in an error: >
179 :set t_kb=
180 :set t_kb
Bram Moolenaar6f4754b2022-01-23 12:07:04 +0000181< E846: Key code not set: t_kb ~
Bram Moolenaar0b2f94d2011-03-22 14:35:05 +0100182
Bram Moolenaar293ee4d2004-12-09 21:34:53 +0000183The t_xx options cannot be set from a |modeline| or in the |sandbox|, for
184security reasons.
185
Bram Moolenaar071d4272004-06-13 20:20:40 +0000186The listing from ":set" looks different from Vi. Long string options are put
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000187at the end of the list. The number of options is quite large. The output of
Bram Moolenaar071d4272004-06-13 20:20:40 +0000188"set all" probably does not fit on the screen, causing Vim to give the
189|more-prompt|.
190
191 *option-backslash*
192To include white space in a string option value it has to be preceded with a
193backslash. To include a backslash you have to use two. Effectively this
194means that the number of backslashes in an option value is halved (rounded
195down).
Yee Cheng Chin54844852023-10-09 18:12:31 +0200196In options 'path', 'cdpath', and 'tags', spaces have to be preceded with three
197backslashes instead for compatibility with version 3.0 where the options can
198be separated by either commas or spaces.
199Comma-separated options like 'backupdir' and 'tags' will also require commas
200to be escaped with two backslashes, whereas this is not needed for
201non-comma-separated ones like 'makeprg'.
202When setting options using |:let| and |literal-string|, you need to use one
203fewer layer of backslash.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000204A few examples: >
Yee Cheng Chin54844852023-10-09 18:12:31 +0200205 :set makeprg=make\ file results in "make file"
206 :let &makeprg='make file' (same as above)
207 :set makeprg=make\\\ file results in "make\ file"
208 :set tags=tags\ /usr/tags results in "tags" and "/usr/tags"
209 :set tags=tags\\\ file results in "tags file"
210 :let &tags='tags\ file' (same as above)
211
212 :set makeprg=make,file results in "make,file"
213 :set makeprg=make\\,file results in "make\,file"
214 :set tags=tags,file results in "tags" and "file"
215 :set tags=tags\\,file results in "tags,file"
216 :let &tags='tags\,file' (same as above)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000217
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000218The "|" character separates a ":set" command from a following command. To
219include the "|" in the option value, use "\|" instead. This example sets the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000220'titlestring' option to "hi|there": >
221 :set titlestring=hi\|there
222This sets the 'titlestring' option to "hi" and 'iconstring' to "there": >
223 :set titlestring=hi|set iconstring=there
224
Bram Moolenaar89a9c152021-08-29 21:55:35 +0200225Similarly, in legacy script the double quote character starts a comment. To
226include the '"' in the option value, use '\"' instead. This example sets the
227'titlestring' option to 'hi "there"': >
Bram Moolenaar7df351e2006-01-23 22:30:28 +0000228 :set titlestring=hi\ \"there\"
229
Bram Moolenaar89a9c152021-08-29 21:55:35 +0200230In |Vim9| script it's simpler, comments start with a '#' character, and only
231when preceded by white space. A backslash is needed less often: >
232 vim9script
233 set titlestring=hi\ "there"
234 set titlestring=hi#there#
235 set titlestring=hi\ \#there#
236
Bram Moolenaar5666fcd2019-12-26 14:35:26 +0100237For Win32 backslashes in file names are mostly not removed. More precise: For
238options that expect a file name (those where environment variables are
239expanded) a backslash before a normal file name character is not removed. But
240a backslash before a special character (space, backslash, comma, etc.) is used
241like explained above.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000242There is one special situation, when the value starts with "\\": >
243 :set dir=\\machine\path results in "\\machine\path"
244 :set dir=\\\\machine\\path results in "\\machine\path"
245 :set dir=\\path\\file results in "\\path\file" (wrong!)
246For the first one the start is kept, but for the second one the backslashes
247are halved. This makes sure it works both when you expect backslashes to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000248halved and when you expect the backslashes to be kept. The third gives a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000249result which is probably not what you want. Avoid it.
250
251 *add-option-flags* *remove-option-flags*
252 *E539* *E550* *E551* *E552*
253Some options are a list of flags. When you want to add a flag to such an
254option, without changing the existing ones, you can do it like this: >
255 :set guioptions+=a
256Remove a flag from an option like this: >
257 :set guioptions-=a
258This removes the 'a' flag from 'guioptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000259Note that you should add or remove one flag at a time. If 'guioptions' has
Bram Moolenaar071d4272004-06-13 20:20:40 +0000260the value "ab", using "set guioptions-=ba" won't work, because the string "ba"
261doesn't appear.
262
263 *:set_env* *expand-env* *expand-environment-var*
Bram Moolenaard4755bb2004-09-02 19:12:26 +0000264Environment variables in specific string options will be expanded. If the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000265environment variable exists the '$' and the following environment variable
266name is replaced with its value. If it does not exist the '$' and the name
267are not modified. Any non-id character (not a letter, digit or '_') may
268follow the environment variable name. That character and what follows is
269appended to the value of the environment variable. Examples: >
270 :set term=$TERM.new
271 :set path=/usr/$INCLUDE,$HOME/include,.
272When adding or removing a string from an option with ":set opt-=val" or ":set
273opt+=val" the expansion is done before the adding or removing.
274
275
276Handling of local options *local-options*
277
Christian Brabandt4a8eb6e2023-08-13 19:43:42 +0200278Note: The following also applies to |global-local| options.
279
Bram Moolenaar071d4272004-06-13 20:20:40 +0000280Some of the options only apply to a window or buffer. Each window or buffer
Bram Moolenaar51628222016-12-01 23:03:28 +0100281has its own copy of this option, thus each can have its own value. This
Bram Moolenaar071d4272004-06-13 20:20:40 +0000282allows you to set 'list' in one window but not in another. And set
283'shiftwidth' to 3 in one buffer and 4 in another.
284
285The following explains what happens to these local options in specific
286situations. You don't really need to know all of this, since Vim mostly uses
287the option values you would expect. Unfortunately, doing what the user
288expects is a bit complicated...
289
290When splitting a window, the local options are copied to the new window. Thus
291right after the split the contents of the two windows look the same.
292
293When editing a new buffer, its local option values must be initialized. Since
294the local options of the current buffer might be specifically for that buffer,
295these are not used. Instead, for each buffer-local option there also is a
296global value, which is used for new buffers. With ":set" both the local and
297global value is changed. With "setlocal" only the local value is changed,
298thus this value is not used when editing a new buffer.
299
Bram Moolenaar95ec9d62016-08-12 18:29:59 +0200300When editing a buffer that has been edited before, the options from the window
301that was last closed are used again. If this buffer has been edited in this
302window, the values from back then are used. Otherwise the values from the
303last closed window where the buffer was edited last are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000304
305It's possible to set a local window option specifically for a type of buffer.
306When you edit another buffer in the same window, you don't want to keep
307using these local window options. Therefore Vim keeps a global value of the
308local window options, which is used when editing another buffer. Each window
309has its own copy of these values. Thus these are local to the window, but
310global to all buffers in the window. With this you can do: >
311 :e one
312 :set list
313 :e two
314Now the 'list' option will also be set in "two", since with the ":set list"
315command you have also set the global value. >
316 :set nolist
317 :e one
318 :setlocal list
319 :e two
320Now the 'list' option is not set, because ":set nolist" resets the global
321value, ":setlocal list" only changes the local value and ":e two" gets the
322global value. Note that if you do this next: >
323 :e one
Bram Moolenaar531da592013-05-06 05:58:55 +0200324You will get back the 'list' value as it was the last time you edited "one".
325The options local to a window are remembered for each buffer. This also
326happens when the buffer is not loaded, but they are lost when the buffer is
327wiped out |:bwipe|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000328
Christian Brabandt596ad662023-08-16 00:11:09 +0200329Special local window options *local-noglobal*
Christian Brabandt4a8eb6e2023-08-13 19:43:42 +0200330
331The following local window options won't be copied over when new windows are
332created, thus they behave slightly differently:
333
334 Option Reason ~
335 'previewwindow' there can only be a single one
336 'scroll' specific to existing window
zeertzjq0049a492024-03-11 23:13:16 +0800337 'winfixbuf' specific to existing window
Christian Brabandt4a8eb6e2023-08-13 19:43:42 +0200338 'winfixheight' specific to existing window
339 'winfixwidth' specific to existing window
340
Christian Brabandt596ad662023-08-16 00:11:09 +0200341Special local buffer options
Christian Brabandt4a8eb6e2023-08-13 19:43:42 +0200342
343The following local buffer options won't be copied over when new buffers are
344created, thus they behave slightly differently:
345
346 Option Reason ~
347 'filetype' explicitly set by autocommands
348 'syntax' explicitly set by autocommands
349 'bufhidden' denote |special-buffers|
350 'buftype' denote |special-buffers|
351 'readonly' will be detected automatically
352 'modified' will be detected automatically
353
Bram Moolenaar071d4272004-06-13 20:20:40 +0000354 *:setl* *:setlocal*
Bram Moolenaar6b915c02020-01-18 15:53:19 +0100355:setl[ocal][!] ... Like ":set" but set only the value local to the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000356 current buffer or window. Not all options have a
357 local value. If the option does not have a local
358 value the global value is set.
Bram Moolenaarc3301872010-07-25 20:53:06 +0200359 With the "all" argument: display local values for all
360 local options.
361 Without argument: Display local values for all local
362 options which are different from the default.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000363 When displaying a specific local option, show the
Bram Moolenaar446cb832008-06-24 21:56:24 +0000364 local value. For a global/local boolean option, when
365 the global value is being used, "--" is displayed
366 before the option name.
367 For a global option the global value is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000368 shown (but that might change in the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000369
Matt Ellis374e26a2024-02-24 17:02:43 +0100370:se[t] {option}< Set the effective value of {option} to its global
zeertzjqd086b8f2024-02-25 15:42:52 +0800371 value.
Matt Ellis374e26a2024-02-24 17:02:43 +0100372 For string |global-local| options, the local value is
373 removed, so that the global value will be used.
374 For all other options, the global value is copied to
375 the local value.
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000376
Matt Ellis374e26a2024-02-24 17:02:43 +0100377:setl[ocal] {option}< Set the effective value of {option} to its global
zeertzjqd086b8f2024-02-25 15:42:52 +0800378 value.
Matt Ellis374e26a2024-02-24 17:02:43 +0100379 For number and boolean |global-local| options, the
380 local value is removed, so that the global value will
381 be used.
382 For all other options, including string |global-local|
383 options, the global value is copied to the local
384 value.
385
386Note that the behaviour for |global-local| options is slightly different
387between string and number-based options.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000388
389 *:setg* *:setglobal*
Bram Moolenaar6b915c02020-01-18 15:53:19 +0100390:setg[lobal][!] ... Like ":set" but set only the global value for a local
Bram Moolenaar071d4272004-06-13 20:20:40 +0000391 option without changing the local value.
392 When displaying an option, the global value is shown.
Bram Moolenaarc3301872010-07-25 20:53:06 +0200393 With the "all" argument: display global values for all
394 local options.
395 Without argument: display global values for all local
396 options which are different from the default.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000397
398For buffer-local and window-local options:
Millyd9af78b2024-09-26 15:54:43 +0200399 Command global value local value condition ~
400 :set option=value set set
401 :setlocal option=value - set
402:setglobal option=value set -
403 :set option? - display local value is set
404 :set option? display - local value is not set
405 :setlocal option? - display
406:setglobal option? display -
Bram Moolenaar071d4272004-06-13 20:20:40 +0000407
408
409Global options with a local value *global-local*
410
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +0000411Options are global when you mostly use one value for all buffers and windows.
412For some global options it's useful to sometimes have a different local value.
413You can set the local value with ":setlocal". That buffer or window will then
414use the local value, while other buffers and windows continue using the global
415value.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000416
417For example, you have two windows, both on C source code. They use the global
418'makeprg' option. If you do this in one of the two windows: >
419 :set makeprg=gmake
420then the other window will switch to the same value. There is no need to set
421the 'makeprg' option in the other C source window too.
422However, if you start editing a Perl file in a new window, you want to use
Bram Moolenaar02467872007-05-06 13:22:01 +0000423another 'makeprg' for it, without changing the value used for the C source
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000424files. You use this command: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000425 :setlocal makeprg=perlmake
426You can switch back to using the global value by making the local value empty: >
427 :setlocal makeprg=
Bram Moolenaar314dd792019-02-03 15:27:20 +0100428This only works for a string option. For a number or boolean option you need
429to use the "<" flag, like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000430 :setlocal autoread<
Bram Moolenaar314dd792019-02-03 15:27:20 +0100431Note that for non-boolean and non-number options using "<" copies the global
432value to the local value, it doesn't switch back to using the global value
433(that matters when the global value changes later). You can also use: >
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000434 :set path<
435This will make the local value of 'path' empty, so that the global value is
436used. Thus it does the same as: >
437 :setlocal path=
Bram Moolenaar2f0936c2022-01-08 21:51:59 +0000438Note: In the future more global options can be made |global-local|. Using
Bram Moolenaar071d4272004-06-13 20:20:40 +0000439":setlocal" on a global option might work differently then.
440
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +0000441 *option-value-function*
442Some options ('completefunc', 'imactivatefunc', 'imstatusfunc', 'omnifunc',
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +0000443'operatorfunc', 'quickfixtextfunc', 'tagfunc' and 'thesaurusfunc') are set to
Yegappan Lakshmanan64095532021-12-06 11:03:55 +0000444a function name or a function reference or a lambda function. When using a
445lambda it will be converted to the name, e.g. "<lambda>123". Examples:
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +0000446>
447 set opfunc=MyOpFunc
Yegappan Lakshmanan19916a82021-11-24 16:32:55 +0000448 set opfunc=function('MyOpFunc')
449 set opfunc=funcref('MyOpFunc')
Yegappan Lakshmanan05e59e32021-12-01 10:30:07 +0000450 set opfunc={a\ ->\ MyOpFunc(a)}
Bram Moolenaar1fca5f32022-02-18 17:50:47 +0000451
452Set to a script-local function: >
453 set opfunc=s:MyLocalFunc
454 set opfunc=<SID>MyLocalFunc
455In |Vim9| script the "s:" and "<SID>" can be omitted if the function exists in
456the script: >
457 set opfunc=MyLocalFunc
458
459Set using a funcref variable: >
Yegappan Lakshmanan05e59e32021-12-01 10:30:07 +0000460 let Fn = function('MyTagFunc')
Bram Moolenaarfa3b7232021-12-24 13:18:38 +0000461 let &tagfunc = Fn
Bram Moolenaar1fca5f32022-02-18 17:50:47 +0000462
463Set using a lambda expression: >
Yegappan Lakshmanan64095532021-12-06 11:03:55 +0000464 let &tagfunc = {t -> MyTagFunc(t)}
Bram Moolenaar1fca5f32022-02-18 17:50:47 +0000465
466Set using a variable with lambda expression: >
Yegappan Lakshmanan05e59e32021-12-01 10:30:07 +0000467 let L = {a, b, c -> MyTagFunc(a, b , c)}
Yegappan Lakshmanan64095532021-12-06 11:03:55 +0000468 let &tagfunc = L
Bram Moolenaar7b1463b2021-12-11 17:24:39 +0000469
470In Vim9 script, in a compiled function, you can use a lambda, but a
Aliaksei Budaveib043ff32023-10-03 17:39:53 +0300471closure does not work, because the function will be called without the
Bram Moolenaar7b1463b2021-12-11 17:24:39 +0000472context of where it was defined.
473
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +0000474
Bram Moolenaar071d4272004-06-13 20:20:40 +0000475Setting the filetype
476
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200477:setf[iletype] [FALLBACK] {filetype} *:setf* *:setfiletype*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000478 Set the 'filetype' option to {filetype}, but only if
479 not done yet in a sequence of (nested) autocommands.
480 This is short for: >
481 :if !did_filetype()
482 : setlocal filetype={filetype}
483 :endif
484< This command is used in a filetype.vim file to avoid
485 setting the 'filetype' option twice, causing different
486 settings and syntax files to be loaded.
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200487
488 When the optional FALLBACK argument is present, a
489 later :setfiletype command will override the
Bram Moolenaar26967612019-03-17 17:13:16 +0100490 'filetype'. This is to be used for filetype
491 detections that are just a guess. |did_filetype()|
492 will return false after this command.
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200493
Bram Moolenaard58e9292011-02-09 17:07:58 +0100494 *option-window* *optwin*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000495:bro[wse] se[t] *:set-browse* *:browse-set* *:opt* *:options*
496:opt[ions] Open a window for viewing and setting all options.
497 Options are grouped by function.
498 Offers short help for each option. Hit <CR> on the
499 short help to open a help window with more help for
500 the option.
501 Modify the value of the option and hit <CR> on the
502 "set" line to set the new value. For window and
503 buffer specific options, the last accessed window is
504 used to set the option value in, unless this is a help
505 window, in which case the window below help window is
506 used (skipping the option-window).
Bram Moolenaarb5b75622018-03-09 22:22:21 +0100507 {not available when compiled without the |+eval|
508 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000509
510 *$HOME*
511Using "~" is like using "$HOME", but it is only recognized at the start of an
512option and after a space or comma.
513
514On Unix systems "~user" can be used too. It is replaced by the home directory
515of user "user". Example: >
516 :set path=~mool/include,/usr/include,.
517
518On Unix systems the form "${HOME}" can be used too. The name between {} can
519contain non-id characters then. Note that if you want to use this for the
520"gf" command, you need to add the '{' and '}' characters to 'isfname'.
521
522NOTE: expanding environment variables and "~/" is only done with the ":set"
523command, not when assigning a value to an option with ":let".
524
Bram Moolenaarc572da52017-08-27 16:52:01 +0200525 *$HOME-windows*
526On MS-Windows, if $HOME is not defined as an environment variable, then
527at runtime Vim will set it to the expansion of $HOMEDRIVE$HOMEPATH.
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200528If $HOMEDRIVE is not set then $USERPROFILE is used.
529
530This expanded value is not exported to the environment, this matters when
531running an external command: >
532 :echo system('set | findstr ^HOME=')
533and >
534 :echo luaeval('os.getenv("HOME")')
535should echo nothing (an empty string) despite exists('$HOME') being true.
536When setting $HOME to a non-empty string it will be exported to the
537subprocesses.
Bram Moolenaarc572da52017-08-27 16:52:01 +0200538
Bram Moolenaar071d4272004-06-13 20:20:40 +0000539
540Note the maximum length of an expanded option is limited. How much depends on
541the system, mostly it is something like 256 or 1024 characters.
542
543 *:fix* *:fixdel*
544:fix[del] Set the value of 't_kD':
545 't_kb' is 't_kD' becomes ~
546 CTRL-? CTRL-H
547 not CTRL-? CTRL-?
548
Bram Moolenaar82be4842021-01-11 19:40:15 +0100549 (CTRL-? is 0o177 octal, 0x7f hex)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000550
551 If your delete key terminal code is wrong, but the
552 code for backspace is alright, you can put this in
553 your .vimrc: >
554 :fixdel
555< This works no matter what the actual code for
556 backspace is.
557
558 If the backspace key terminal code is wrong you can
559 use this: >
560 :if &term == "termname"
561 : set t_kb=^V<BS>
562 : fixdel
563 :endif
564< Where "^V" is CTRL-V and "<BS>" is the backspace key
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000565 (don't type four characters!). Replace "termname"
Bram Moolenaar071d4272004-06-13 20:20:40 +0000566 with your terminal name.
567
568 If your <Delete> key sends a strange key sequence (not
569 CTRL-? or CTRL-H) you cannot use ":fixdel". Then use: >
570 :if &term == "termname"
571 : set t_kD=^V<Delete>
572 :endif
573< Where "^V" is CTRL-V and "<Delete>" is the delete key
574 (don't type eight characters!). Replace "termname"
575 with your terminal name.
576
577 *Linux-backspace*
578 Note about Linux: By default the backspace key
579 produces CTRL-?, which is wrong. You can fix it by
580 putting this line in your rc.local: >
581 echo "keycode 14 = BackSpace" | loadkeys
582<
583 *NetBSD-backspace*
584 Note about NetBSD: If your backspace doesn't produce
585 the right code, try this: >
586 xmodmap -e "keycode 22 = BackSpace"
587< If this works, add this in your .Xmodmap file: >
588 keysym 22 = BackSpace
589< You need to restart for this to take effect.
590
591==============================================================================
5922. Automatically setting options *auto-setting*
593
594Besides changing options with the ":set" command, there are three alternatives
595to set options automatically for one or more files:
596
5971. When starting Vim initializations are read from various places. See
598 |initialization|. Most of them are performed for all editing sessions,
599 and some of them depend on the directory where Vim is started.
600 You can create an initialization file with |:mkvimrc|, |:mkview| and
601 |:mksession|.
6022. If you start editing a new file, the automatic commands are executed.
603 This can be used to set options for files matching a particular pattern and
604 many other things. See |autocommand|.
6053. If you start editing a new file, and the 'modeline' option is on, a
606 number of lines at the beginning and end of the file are checked for
607 modelines. This is explained here.
608
609 *modeline* *vim:* *vi:* *ex:* *E520*
610There are two forms of modelines. The first form:
Bram Moolenaar664f3cf2019-12-07 16:03:51 +0100611 [text{white}]{vi:|vim:|ex:}[white]{options}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000612
Bram Moolenaar664f3cf2019-12-07 16:03:51 +0100613[text{white}] empty or any text followed by at least one blank
614 character (<Space> or <Tab>); "ex:" always requires at
615 least one blank character
Bram Moolenaar14b69452013-06-29 23:05:20 +0200616{vi:|vim:|ex:} the string "vi:", "vim:" or "ex:"
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200617[white] optional white space
618{options} a list of option settings, separated with white space
619 or ':', where each part between ':' is the argument
620 for a ":set" command (can be empty)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000621
Bram Moolenaar14b69452013-06-29 23:05:20 +0200622Examples:
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000623 vi:noai:sw=3 ts=6 ~
Bram Moolenaar14b69452013-06-29 23:05:20 +0200624 vim: tw=77 ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000625
626The second form (this is compatible with some versions of Vi):
627
Bram Moolenaarade0d392020-01-21 22:33:58 +0100628 [text{white}]{vi:|vim:|Vim:|ex:}[white]se[t] {options}:[text]
Bram Moolenaar071d4272004-06-13 20:20:40 +0000629
Bram Moolenaarade0d392020-01-21 22:33:58 +0100630[text{white}] empty or any text followed by at least one blank
631 character (<Space> or <Tab>); "ex:" always requires at
632 least one blank character
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200633{vi:|vim:|Vim:|ex:} the string "vi:", "vim:", "Vim:" or "ex:"
634[white] optional white space
Bram Moolenaar14b69452013-06-29 23:05:20 +0200635se[t] the string "set " or "se " (note the space); When
636 "Vim" is used it must be "set".
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200637{options} a list of options, separated with white space, which
638 is the argument for a ":set" command
639: a colon
640[text] any text or empty
Bram Moolenaar071d4272004-06-13 20:20:40 +0000641
Bram Moolenaar14b69452013-06-29 23:05:20 +0200642Examples:
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000643 /* vim: set ai tw=75: */ ~
Bram Moolenaar14b69452013-06-29 23:05:20 +0200644 /* Vim: set ai tw=75: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000645
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200646The white space before {vi:|vim:|Vim:|ex:} is required. This minimizes the
647chance that a normal word like "lex:" is caught. There is one exception:
648"vi:" and "vim:" can also be at the start of the line (for compatibility with
649version 3.0). Using "ex:" at the start of the line will be ignored (this
650could be short for "example:").
Bram Moolenaar071d4272004-06-13 20:20:40 +0000651
Hu Jialun9dcd3492021-08-28 20:42:50 +0200652If the modeline is disabled within a modeline, subsequent modelines will be
653ignored. This is to allow turning off modeline on a per-file basis. This is
654useful when a line looks like a modeline but isn't. For example, it would be
655good to start a YAML file containing strings like "vim:" with
656 # vim: nomodeline ~
657so as to avoid modeline misdetection. Following options on the same line
658after modeline deactivation, if any, are still evaluated (but you would
659normally not have any).
660
Bram Moolenaar071d4272004-06-13 20:20:40 +0000661 *modeline-local*
662The options are set like with ":setlocal": The new value only applies to the
Bram Moolenaar843ee412004-06-30 16:16:41 +0000663buffer and window that contain the file. Although it's possible to set global
664options from a modeline, this is unusual. If you have two windows open and
665the files in it set the same global option to a different value, the result
666depends on which one was opened last.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000667
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +0000668When editing a file that was already loaded, only the window-local options
669from the modeline are used. Thus if you manually changed a buffer-local
670option after opening the file, it won't be changed if you edit the same buffer
671in another window. But window-local options will be set.
672
Bram Moolenaar071d4272004-06-13 20:20:40 +0000673 *modeline-version*
674If the modeline is only to be used for some versions of Vim, the version
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200675number can be specified where "vim:" or "Vim:" is used:
Bram Moolenaar071d4272004-06-13 20:20:40 +0000676 vim{vers}: version {vers} or later
677 vim<{vers}: version before {vers}
678 vim={vers}: version {vers}
679 vim>{vers}: version after {vers}
Bram Moolenaar2b8388b2015-02-28 13:11:45 +0100680{vers} is 700 for Vim 7.0 (hundred times the major version plus minor).
681For example, to use a modeline only for Vim 7.0:
682 /* vim700: set foldmethod=marker */ ~
683To use a modeline for Vim after version 7.2:
684 /* vim>702: set cole=2: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000685There can be no blanks between "vim" and the ":".
686
687
688The number of lines that are checked can be set with the 'modelines' option.
689If 'modeline' is off or 'modelines' is 0 no lines are checked.
690
691Note that for the first form all of the rest of the line is used, thus a line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000692like:
693 /* vi:ts=4: */ ~
694will give an error message for the trailing "*/". This line is OK:
695 /* vi:set ts=4: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000696
697If an error is detected the rest of the line is skipped.
698
699If you want to include a ':' in a set command precede it with a '\'. The
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000700backslash in front of the ':' will be removed. Example:
Bram Moolenaar95a9dd12019-12-19 22:12:03 +0100701 /* vi:set fillchars=stl\:^,vert\:\|: */ ~
702This sets the 'fillchars' option to "stl:^,vert:\|". Only a single backslash
703before the ':' is removed. Thus to include "\:" you have to specify "\\:".
Bram Moolenaar110289e2019-05-23 15:38:06 +0200704 *E992*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000705No other commands than "set" are supported, for security reasons (somebody
Bram Moolenaar8243a792007-05-01 17:05:03 +0000706might create a Trojan horse text file with modelines). And not all options
Bram Moolenaar110289e2019-05-23 15:38:06 +0200707can be set. For some options a flag is set, so that when the value is used
708the |sandbox| is effective. Some options can only be set from the modeline
709when 'modelineexpr' is set (the default is off).
710
711Still, there is always a small risk that a modeline causes trouble. E.g.,
712when some joker sets 'textwidth' to 5 all your lines are wrapped unexpectedly.
713So disable modelines before editing untrusted text. The mail ftplugin does
714this, for example.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000715
716Hint: If you would like to do something else than setting an option, you could
717define an autocommand that checks the file for a specific string. For
718example: >
719 au BufReadPost * if getline(1) =~ "VAR" | call SetVar() | endif
720And define a function SetVar() that does something with the line containing
721"VAR".
722
723==============================================================================
7243. Options summary *option-summary*
725
726In the list below all the options are mentioned with their full name and with
727an abbreviation if there is one. Both forms may be used.
728
729In this document when a boolean option is "set" that means that ":set option"
730is entered. When an option is "reset", ":set nooption" is used.
731
732For some options there are two default values: The "Vim default", which is
733used when 'compatible' is not set, and the "Vi default", which is used when
734'compatible' is set.
735
736Most options are the same in all windows and buffers. There are a few that
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000737are specific to how the text is presented in a window. These can be set to a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000738different value in each window. For example the 'list' option can be set in
739one window and reset in another for the same text, giving both types of view
740at the same time. There are a few options that are specific to a certain
741file. These can have a different value for each file or buffer. For example
742the 'textwidth' option can be 78 for a normal text file and 0 for a C
743program.
744
745 global one option for all buffers and windows
746 local to window each window has its own copy of this option
747 local to buffer each buffer has its own copy of this option
748
749When creating a new window the option values from the currently active window
750are used as a default value for the window-specific options. For the
751buffer-specific options this depends on the 's' and 'S' flags in the
752'cpoptions' option. If 's' is included (which is the default) the values for
753buffer options are copied from the currently active buffer when a buffer is
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000754first entered. If 'S' is present the options are copied each time the buffer
755is entered, this is almost like having global options. If 's' and 'S' are not
Bram Moolenaar071d4272004-06-13 20:20:40 +0000756present, the options are copied from the currently active buffer when the
757buffer is created.
758
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000759Hidden options *hidden-options*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000760
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000761Not all options are supported in all versions. This depends on the supported
762features and sometimes on the system. A remark about this is in curly braces
763below. When an option is not supported it may still be set without getting an
764error, this is called a hidden option. You can't get the value of a hidden
765option though, it is not stored.
766
767To test if option "foo" can be used with ":set" use something like this: >
768 if exists('&foo')
769This also returns true for a hidden option. To test if option "foo" is really
770supported use something like this: >
771 if exists('+foo')
772<
Bram Moolenaar071d4272004-06-13 20:20:40 +0000773 *E355*
774A jump table for the options with a short description can be found at |Q_op|.
775
776 *'aleph'* *'al'* *aleph* *Aleph*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +0100777'aleph' 'al' number (default 128 for MS-Windows, 224 otherwise)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000778 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000779 {only available when compiled with the |+rightleft|
780 feature}
781 The ASCII code for the first letter of the Hebrew alphabet. The
782 routine that maps the keyboard in Hebrew mode, both in Insert mode
783 (when hkmap is set) and on the command-line (when hitting CTRL-_)
784 outputs the Hebrew characters in the range [aleph..aleph+26].
785 aleph=128 applies to PC code, and aleph=224 applies to ISO 8859-8.
786 See |rileft.txt|.
787
788 *'allowrevins'* *'ari'* *'noallowrevins'* *'noari'*
789'allowrevins' 'ari' boolean (default off)
790 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000791 {only available when compiled with the |+rightleft|
792 feature}
793 Allow CTRL-_ in Insert and Command-line mode. This is default off, to
794 avoid that users that accidentally type CTRL-_ instead of SHIFT-_ get
795 into reverse Insert mode, and don't know how to get out. See
796 'revins'.
797 NOTE: This option is reset when 'compatible' is set.
798
799 *'altkeymap'* *'akm'* *'noaltkeymap'* *'noakm'*
800'altkeymap' 'akm' boolean (default off)
801 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000802 {only available when compiled with the |+farsi|
803 feature}
Bram Moolenaar14184a32019-02-16 15:10:30 +0100804 This option was for using Farsi, which has been removed. See
805 |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000806
807 *'ambiwidth'* *'ambw'*
808'ambiwidth' 'ambw' string (default: "single")
809 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000810 Only effective when 'encoding' is "utf-8" or another Unicode encoding.
811 Tells Vim what to do with characters with East Asian Width Class
812 Ambiguous (such as Euro, Registered Sign, Copyright Sign, Greek
813 letters, Cyrillic letters).
814
815 There are currently two possible values:
Bram Moolenaar582fd852005-03-28 20:58:01 +0000816 "single": Use the same width as characters in US-ASCII. This is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000817 expected by most users.
818 "double": Use twice the width of ASCII characters.
Bram Moolenaar5c3bd0a2010-08-04 20:55:44 +0200819 *E834* *E835*
820 The value "double" cannot be used if 'listchars' or 'fillchars'
Bram Moolenaar079ba762021-10-23 12:08:41 +0100821 contains a character that would be double width. These errors may
822 also be given when calling setcellwidths().
Bram Moolenaar08aac3c2020-08-28 21:04:24 +0200823
824 The values are overruled for characters specified with
825 |setcellwidths()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000826
827 There are a number of CJK fonts for which the width of glyphs for
828 those characters are solely based on how many octets they take in
829 legacy/traditional CJK encodings. In those encodings, Euro,
830 Registered sign, Greek/Cyrillic letters are represented by two octets,
Bram Moolenaar582fd852005-03-28 20:58:01 +0000831 therefore those fonts have "wide" glyphs for them. This is also
Bram Moolenaar071d4272004-06-13 20:20:40 +0000832 true of some line drawing characters used to make tables in text
Bram Moolenaar582fd852005-03-28 20:58:01 +0000833 file. Therefore, when a CJK font is used for GUI Vim or
Bram Moolenaar071d4272004-06-13 20:20:40 +0000834 Vim is running inside a terminal (emulators) that uses a CJK font
835 (or Vim is run inside an xterm invoked with "-cjkwidth" option.),
836 this option should be set to "double" to match the width perceived
837 by Vim with the width of glyphs in the font. Perhaps it also has
Bram Moolenaar8024f932020-01-14 19:29:13 +0100838 to be set to "double" under CJK MS-Windows when the system locale is
839 set to one of CJK locales. See Unicode Standard Annex #11
840 (http://www.unicode.org/reports/tr11).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000841
Bram Moolenaarac7bd632013-03-19 11:35:58 +0100842 Vim may set this option automatically at startup time when Vim is
843 compiled with the |+termresponse| feature and if |t_u7| is set to the
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200844 escape sequence to request cursor position report. The response can
845 be found in |v:termu7resp|.
Bram Moolenaarac7bd632013-03-19 11:35:58 +0100846
Bram Moolenaar071d4272004-06-13 20:20:40 +0000847 *'antialias'* *'anti'* *'noantialias'* *'noanti'*
848'antialias' 'anti' boolean (default: off)
849 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000850 {only available when compiled with GUI enabled
Bram Moolenaar3d1cde82020-08-15 18:55:18 +0200851 on macOS}
852 This option only has an effect in the GUI version of Vim on macOS
Bram Moolenaar071d4272004-06-13 20:20:40 +0000853 v10.2 or later. When on, Vim will use smooth ("antialiased") fonts,
854 which can be easier to read at certain sizes on certain displays.
855 Setting this option can sometimes cause problems if 'guifont' is set
856 to its default (empty string).
Bram Moolenaar036986f2017-03-16 17:41:02 +0100857 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000858
Bram Moolenaar071d4272004-06-13 20:20:40 +0000859 *'arabic'* *'arab'* *'noarabic'* *'noarab'*
860'arabic' 'arab' boolean (default off)
861 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +0000862 {only available when compiled with the |+arabic|
863 feature}
864 This option can be set to start editing Arabic text.
865 Setting this option will:
866 - Set the 'rightleft' option, unless 'termbidi' is set.
867 - Set the 'arabicshape' option, unless 'termbidi' is set.
868 - Set the 'keymap' option to "arabic"; in Insert mode CTRL-^ toggles
869 between typing English and Arabic key mapping.
870 - Set the 'delcombine' option
871 Note that 'encoding' must be "utf-8" for working with Arabic text.
872
873 Resetting this option will:
874 - Reset the 'rightleft' option.
875 - Disable the use of 'keymap' (without changing its value).
876 Note that 'arabicshape' and 'delcombine' are not reset (it is a global
Bram Moolenaarc8734422012-06-01 22:38:45 +0200877 option).
Bram Moolenaar036986f2017-03-16 17:41:02 +0100878 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000879 Also see |arabic.txt|.
880
881 *'arabicshape'* *'arshape'*
882 *'noarabicshape'* *'noarshape'*
883'arabicshape' 'arshape' boolean (default on)
884 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000885 {only available when compiled with the |+arabic|
886 feature}
887 When on and 'termbidi' is off, the required visual character
888 corrections that need to take place for displaying the Arabic language
Bram Moolenaar3a0d8092012-10-21 03:02:54 +0200889 take effect. Shaping, in essence, gets enabled; the term is a broad
Bram Moolenaar071d4272004-06-13 20:20:40 +0000890 one which encompasses:
891 a) the changing/morphing of characters based on their location
892 within a word (initial, medial, final and stand-alone).
893 b) the enabling of the ability to compose characters
894 c) the enabling of the required combining of some characters
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100895 When disabled the display shows each character's true stand-alone
896 form.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000897 Arabic is a complex language which requires other settings, for
898 further details see |arabic.txt|.
Bram Moolenaar036986f2017-03-16 17:41:02 +0100899 NOTE: This option is set when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000900
laburnumT3f7855a2023-12-05 18:37:03 +0100901 *'autochdir'* *'acd'* *'noautochdir'* *'noacd'*
902'autochdir' 'acd' boolean (default off)
903 global
904 {only available when compiled with it, use
905 exists("+autochdir") to check}
906 When on, Vim will change the current working directory whenever you
907 open a file, switch buffers, delete a buffer or open/close a window.
908 It will change to the directory containing the file which was opened
909 or selected. When a buffer has no name it also has no directory, thus
910 the current directory won't change when navigating to it.
911 Note: When this option is on some plugins may not work.
912
Bram Moolenaar071d4272004-06-13 20:20:40 +0000913 *'autoindent'* *'ai'* *'noautoindent'* *'noai'*
914'autoindent' 'ai' boolean (default off)
915 local to buffer
916 Copy indent from current line when starting a new line (typing <CR>
917 in Insert mode or when using the "o" or "O" command). If you do not
918 type anything on the new line except <BS> or CTRL-D and then type
Bram Moolenaar02467872007-05-06 13:22:01 +0000919 <Esc>, CTRL-O or <CR>, the indent is deleted again. Moving the cursor
920 to another line has the same effect, unless the 'I' flag is included
921 in 'cpoptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000922 When autoindent is on, formatting (with the "gq" command or when you
923 reach 'textwidth' in Insert mode) uses the indentation of the first
924 line.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000925 When 'smartindent' or 'cindent' is on the indent is changed in
926 a different way.
Bram Moolenaarca635012015-09-25 20:34:21 +0200927 The 'autoindent' option is reset when the 'paste' option is set and
928 restored when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000929
930 *'autoread'* *'ar'* *'noautoread'* *'noar'*
931'autoread' 'ar' boolean (default off)
932 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000933 When a file has been detected to have been changed outside of Vim and
934 it has not been changed inside of Vim, automatically read it again.
Bram Moolenaarfd358112018-07-07 23:21:31 +0200935 When the file has been deleted this is not done, so you have the text
936 from before it was deleted. When it appears again then it is read.
937 |timestamp|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000938 If this option has a local value, use this command to switch back to
939 using the global value: >
940 :set autoread<
941<
laburnumT3f7855a2023-12-05 18:37:03 +0100942
943 *'autoshelldir'* *'asd'* *'noautoshelldir'* *'noasd'*
944'autoshelldir' 'asd' boolean (default off)
945 global
946 When on, Vim will change the current working directory whenever you
947 change the directory of the shell running in a terminal window. You
948 need proper setting-up, so whenever the shell's pwd changes an OSC 7
949 escape sequence will be emitted. For example, on Linux, you can
950 source /etc/profile.d/vte.sh in your shell profile if you use bash or
951 zsh. For bash this should work (put it in a bash init file): >
952 if [[ -n "$VIM_TERMINAL" ]]; then
953 PROMPT_COMMAND='_vim_sync_PWD'
954 function _vim_sync_PWD() {
955 printf '\033]7;file://%s\033\\' "$PWD"
956 }
957 fi
958<
959 Or, in a zsh init file: >
960 if [[ -n "$VIM_TERMINAL" ]]; then
961 autoload -Uz add-zsh-hook
962 add-zsh-hook -Uz chpwd _vim_sync_PWD
963 function _vim_sync_PWD() {
964 printf '\033]7;file://%s\033\\' "$PWD"
965 }
966 fi
967<
968 In a fish init file: >
969 if test -n "$VIM_TERMINAL"
970 function _vim_sync_PWD --on-variable=PWD
971 printf '\033]7;file://%s\033\\' "$PWD"
972 end
973 end
974<
975 You can find an alternative method at |terminal-autoshelldir|.
976 When the parsing of the OSC sequence fails you get *E1179* .
977
Bram Moolenaar071d4272004-06-13 20:20:40 +0000978 *'autowrite'* *'aw'* *'noautowrite'* *'noaw'*
979'autowrite' 'aw' boolean (default off)
980 global
981 Write the contents of the file, if it has been modified, on each
Bram Moolenaar47003982021-12-05 21:54:04 +0000982 `:next`, `:rewind`, `:last`, `:first`, `:previous`, `:stop`,
Bram Moolenaar2f0936c2022-01-08 21:51:59 +0000983 `:suspend`, `:tag`, `:!`, `:make`, CTRL-] and CTRL-^ command; and when
984 a `:buffer`, CTRL-O, CTRL-I, '{A-Z0-9}, or `{A-Z0-9} command takes one
Bram Moolenaar47003982021-12-05 21:54:04 +0000985 to another file.
986 A buffer is not written if it becomes hidden, e.g. when 'bufhidden' is
Bram Moolenaar2f0936c2022-01-08 21:51:59 +0000987 set to "hide" and `:next` is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000988 Note that for some commands the 'autowrite' option is not used, see
989 'autowriteall' for that.
Bram Moolenaar93a1df22018-09-10 11:51:50 +0200990 Some buffers will not be written, specifically when 'buftype' is
Bram Moolenaar20aac6c2018-09-02 21:07:30 +0200991 "nowrite", "nofile", "terminal" or "prompt".
Bram Moolenaarb7398fe2023-05-14 18:50:25 +0100992 USE WITH CARE: If you make temporary changes to a buffer that you
993 don't want to be saved this option may cause it to be saved anyway.
994 Renaming the buffer with ":file {name}" may help avoid this.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000995
996 *'autowriteall'* *'awa'* *'noautowriteall'* *'noawa'*
997'autowriteall' 'awa' boolean (default off)
998 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000999 Like 'autowrite', but also used for commands ":edit", ":enew", ":quit",
1000 ":qall", ":exit", ":xit", ":recover" and closing the Vim window.
1001 Setting this option also implies that Vim behaves like 'autowrite' has
1002 been set.
1003
1004 *'background'* *'bg'*
Bram Moolenaar446beb42011-05-10 17:18:44 +02001005'background' 'bg' string (default "dark" or "light", see below)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001006 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001007 When set to "dark", Vim will try to use colors that look good on a
1008 dark background. When set to "light", Vim will try to use colors that
1009 look good on a light background. Any other value is illegal.
1010 Vim tries to set the default value according to the terminal used.
1011 This will not always be correct.
1012 Setting this option does not change the background color, it tells Vim
1013 what the background color looks like. For changing the background
1014 color, see |:hi-normal|.
1015
Gregory Anders83ad2722024-01-03 19:48:51 +01001016 When 'background' is changed Vim will adjust the default color groups
1017 for the new value. But the colors used for syntax highlighting will
1018 not change. *g:colors_name*
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001019 When a color scheme is loaded (the "g:colors_name" variable is set)
Gregory Anders83ad2722024-01-03 19:48:51 +01001020 changing 'background' will cause the color scheme to be reloaded. If
Bram Moolenaar071d4272004-06-13 20:20:40 +00001021 the color scheme adjusts to the value of 'background' this will work.
1022 However, if the color scheme sets 'background' itself the effect may
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001023 be undone. First delete the "g:colors_name" variable when needed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001024
1025 When setting 'background' to the default value with: >
1026 :set background&
1027< Vim will guess the value. In the GUI this should work correctly,
1028 in other cases Vim might not be able to guess the right value.
Bram Moolenaar2e693a82019-10-16 22:35:02 +02001029 If the GUI supports a dark theme, you can use the "d" flag in
Bram Moolenaar50bf7ce2019-09-15 13:17:00 +02001030 'guioptions', see 'go-d'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001031
Bram Moolenaar37c64c72017-09-19 22:06:03 +02001032 When the |t_RB| option is set, Vim will use it to request the background
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +02001033 color from the terminal. If the returned RGB value is dark/light and
1034 'background' is not dark/light, 'background' will be set and the
1035 screen is redrawn. This may have side effects, make t_BG empty in
Bram Moolenaar37c64c72017-09-19 22:06:03 +02001036 your .vimrc if you suspect this problem. The response to |t_RB| can
Bram Moolenaar01164a62017-11-02 22:58:42 +01001037 be found in |v:termrbgresp|.
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +02001038
Bram Moolenaar071d4272004-06-13 20:20:40 +00001039 When starting the GUI, the default value for 'background' will be
1040 "light". When the value is not set in the .gvimrc, and Vim detects
1041 that the background is actually quite dark, 'background' is set to
1042 "dark". But this happens only AFTER the .gvimrc file has been read
1043 (because the window needs to be opened to find the actual background
1044 color). To get around this, force the GUI window to be opened by
1045 putting a ":gui" command in the .gvimrc file, before where the value
1046 of 'background' is used (e.g., before ":syntax on").
Bram Moolenaar446beb42011-05-10 17:18:44 +02001047
Bram Moolenaar6f345a12019-12-17 21:27:18 +01001048 For MS-Windows the default is "dark".
Bram Moolenaar446beb42011-05-10 17:18:44 +02001049 For other systems "dark" is used when 'term' is "linux",
1050 "screen.linux", "cygwin" or "putty", or $COLORFGBG suggests a dark
1051 background. Otherwise the default is "light".
1052
Bram Moolenaarc572da52017-08-27 16:52:01 +02001053 The |:terminal| command and the |term_start()| function use the
1054 'background' value to decide whether the terminal window will start
1055 with a white or black background.
1056
Bram Moolenaar071d4272004-06-13 20:20:40 +00001057 Normally this option would be set in the .vimrc file. Possibly
1058 depending on the terminal name. Example: >
1059 :if &term == "pcterm"
1060 : set background=dark
1061 :endif
1062< When this option is set, the default settings for the highlight groups
1063 will change. To use other settings, place ":highlight" commands AFTER
1064 the setting of the 'background' option.
1065 This option is also used in the "$VIMRUNTIME/syntax/syntax.vim" file
1066 to select the colors for syntax highlighting. After changing this
1067 option, you must load syntax.vim again to see the result. This can be
1068 done with ":syntax on".
1069
1070 *'backspace'* *'bs'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02001071'backspace' 'bs' string (default "", set to "indent,eol,start"
1072 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001073 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001074 Influences the working of <BS>, <Del>, CTRL-W and CTRL-U in Insert
1075 mode. This is a list of items, separated by commas. Each item allows
1076 a way to backspace over something:
1077 value effect ~
1078 indent allow backspacing over autoindent
1079 eol allow backspacing over line breaks (join lines)
1080 start allow backspacing over the start of insert; CTRL-W and CTRL-U
1081 stop once at the start of insert.
Bram Moolenaaraa0489e2020-04-17 19:41:21 +02001082 nostop like start, except CTRL-W and CTRL-U do not stop at the start of
1083 insert.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001084
Bram Moolenaar46eea442022-03-30 10:51:39 +01001085 When the value is empty, Vi compatible backspacing is used, none of
1086 the ways mentioned for the items above are possible.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001087
1088 For backwards compatibility with version 5.4 and earlier:
1089 value effect ~
1090 0 same as ":set backspace=" (Vi compatible)
1091 1 same as ":set backspace=indent,eol"
1092 2 same as ":set backspace=indent,eol,start"
Bram Moolenaaraa0489e2020-04-17 19:41:21 +02001093 3 same as ":set backspace=indent,eol,nostop"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001094
1095 See |:fixdel| if your <BS> or <Del> key does not do what you want.
1096 NOTE: This option is set to "" when 'compatible' is set.
1097
1098 *'backup'* *'bk'* *'nobackup'* *'nobk'*
1099'backup' 'bk' boolean (default off)
1100 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001101 Make a backup before overwriting a file. Leave it around after the
1102 file has been successfully written. If you do not want to keep the
1103 backup file, but you do want a backup while the file is being
1104 written, reset this option and set the 'writebackup' option (this is
1105 the default). If you do not want a backup file at all reset both
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001106 options (use this if your file system is almost full). See the
Bram Moolenaar071d4272004-06-13 20:20:40 +00001107 |backup-table| for more explanations.
1108 When the 'backupskip' pattern matches, a backup is not made anyway.
1109 When 'patchmode' is set, the backup may be renamed to become the
1110 oldest version of a file.
1111 NOTE: This option is reset when 'compatible' is set.
1112
1113 *'backupcopy'* *'bkc'*
1114'backupcopy' 'bkc' string (Vi default for Unix: "yes", otherwise: "auto")
Bram Moolenaarb8ee25a2014-09-23 15:45:08 +02001115 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001116 When writing a file and a backup is made, this option tells how it's
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001117 done. This is a comma-separated list of words.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001118
1119 The main values are:
1120 "yes" make a copy of the file and overwrite the original one
1121 "no" rename the file and write a new one
1122 "auto" one of the previous, what works best
1123
1124 Extra values that can be combined with the ones above are:
1125 "breaksymlink" always break symlinks when writing
1126 "breakhardlink" always break hardlinks when writing
1127
1128 Making a copy and overwriting the original file:
1129 - Takes extra time to copy the file.
1130 + When the file has special attributes, is a (hard/symbolic) link or
1131 has a resource fork, all this is preserved.
1132 - When the file is a link the backup will have the name of the link,
1133 not of the real file.
1134
1135 Renaming the file and writing a new one:
1136 + It's fast.
1137 - Sometimes not all attributes of the file can be copied to the new
1138 file.
1139 - When the file is a link the new file will not be a link.
1140
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001141 The "auto" value is the middle way: When Vim sees that renaming the
1142 file is possible without side effects (the attributes can be passed on
1143 and the file is not a link) that is used. When problems are expected,
1144 a copy will be made.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001145
1146 The "breaksymlink" and "breakhardlink" values can be used in
1147 combination with any of "yes", "no" and "auto". When included, they
1148 force Vim to always break either symbolic or hard links by doing
1149 exactly what the "no" option does, renaming the original file to
1150 become the backup and writing a new file in its place. This can be
1151 useful for example in source trees where all the files are symbolic or
1152 hard links and any changes should stay in the local source tree, not
1153 be propagated back to the original source.
Christian Brabandt5bcfb5a2024-10-14 22:08:22 +02001154 *crontab*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001155 One situation where "no" and "auto" will cause problems: A program
1156 that opens a file, invokes Vim to edit that file, and then tests if
1157 the open file was changed (through the file descriptor) will check the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001158 backup file instead of the newly created file. "crontab -e" is an
Christian Brabandt5bcfb5a2024-10-14 22:08:22 +02001159 example, as are several |file-watcher| daemons like inotify. In that
1160 case you probably want to switch this option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001161
1162 When a copy is made, the original file is truncated and then filled
1163 with the new text. This means that protection bits, owner and
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001164 symbolic links of the original file are unmodified. The backup file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001165 however, is a new file, owned by the user who edited the file. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00001166 group of the backup is set to the group of the original file. If this
1167 fails, the protection bits for the group are made the same as for
1168 others.
1169
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001170 When the file is renamed, this is the other way around: The backup has
Bram Moolenaar071d4272004-06-13 20:20:40 +00001171 the same attributes of the original file, and the newly written file
1172 is owned by the current user. When the file was a (hard/symbolic)
1173 link, the new file will not! That's why the "auto" value doesn't
1174 rename when the file is a link. The owner and group of the newly
1175 written file will be set to the same ones as the original file, but
1176 the system may refuse to do this. In that case the "auto" value will
1177 again not rename the file.
1178
Bram Moolenaar036986f2017-03-16 17:41:02 +01001179 NOTE: This option is set to the Vi default value when 'compatible' is
1180 set and to the Vim default value when 'compatible' is reset.
1181
Bram Moolenaar071d4272004-06-13 20:20:40 +00001182 *'backupdir'* *'bdir'*
1183'backupdir' 'bdir' string (default for Amiga: ".,t:",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01001184 for Win32: ".,$TEMP,c:/tmp,c:/temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001185 for Unix: ".,~/tmp,~/")
1186 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001187 List of directories for the backup file, separated with commas.
1188 - The backup file will be created in the first directory in the list
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001189 where this is possible. The directory must exist, Vim will not
1190 create it for you.
Bram Moolenaar3848e002016-03-19 18:42:29 +01001191 - Empty means that no backup file will be created ('patchmode' is
Bram Moolenaar071d4272004-06-13 20:20:40 +00001192 impossible!). Writing may fail because of this.
1193 - A directory "." means to put the backup file in the same directory
1194 as the edited file.
Bram Moolenaar8024f932020-01-14 19:29:13 +01001195 - A directory starting with "./" (or ".\" for MS-Windows) means to put
1196 the backup file relative to where the edited file is. The leading
1197 "." is replaced with the path name of the edited file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001198 ("." inside a directory name has no special meaning).
1199 - Spaces after the comma are ignored, other spaces are considered part
1200 of the directory name. To have a space at the start of a directory
1201 name, precede it with a backslash.
1202 - To include a comma in a directory name precede it with a backslash.
1203 - A directory name may end in an '/'.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02001204 - For Unix and Win32, if a directory ends in two path separators "//",
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01001205 the backup file name will be built from the complete path to the
1206 file with all path separators changed to percent '%' signs. This
1207 will ensure file name uniqueness in the backup directory.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02001208 On Win32, it is also possible to end with "\\". However, When a
1209 separating comma is following, you must use "//", since "\\" will
1210 include the comma in the file name. Therefore it is recommended to
1211 use '//', instead of '\\'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001212 - Environment variables are expanded |:set_env|.
1213 - Careful with '\' characters, type one before a space, type two to
1214 get one in the option (see |option-backslash|), for example: >
1215 :set bdir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
1216< - For backwards compatibility with Vim version 3.0 a '>' at the start
1217 of the option is removed.
1218 See also 'backup' and 'writebackup' options.
1219 If you want to hide your backup files on Unix, consider this value: >
1220 :set backupdir=./.backup,~/.backup,.,/tmp
1221< You must create a ".backup" directory in each directory and in your
1222 home directory for this to work properly.
1223 The use of |:set+=| and |:set-=| is preferred when adding or removing
1224 directories from the list. This avoids problems when a future version
1225 uses another default.
1226 This option cannot be set from a |modeline| or in the |sandbox|, for
1227 security reasons.
1228
1229 *'backupext'* *'bex'* *E589*
1230'backupext' 'bex' string (default "~", for VMS: "_")
1231 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001232 String which is appended to a file name to make the name of the
1233 backup file. The default is quite unusual, because this avoids
1234 accidentally overwriting existing files with a backup file. You might
1235 prefer using ".bak", but make sure that you don't have files with
1236 ".bak" that you want to keep.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001237 Only normal file name characters can be used; "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001238
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001239 If you like to keep a lot of backups, you could use a BufWritePre
1240 autocommand to change 'backupext' just before writing the file to
1241 include a timestamp. >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00001242 :au BufWritePre * let &bex = '-' .. strftime("%Y%b%d%X") .. '~'
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001243< Use 'backupdir' to put the backup in a different directory.
1244
Bram Moolenaar071d4272004-06-13 20:20:40 +00001245 *'backupskip'* *'bsk'*
Bram Moolenaarb8e22a02018-04-12 21:37:34 +02001246'backupskip' 'bsk' string (default: "$TMPDIR/*,$TMP/*,$TEMP/*"
1247 Unix: "/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*"
1248 Mac: "/private/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001249 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001250 A list of file patterns. When one of the patterns matches with the
1251 name of the file which is written, no backup file is created. Both
1252 the specified file name and the full path name of the file are used.
1253 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
1254 Watch out for special characters, see |option-backslash|.
1255 When $TMPDIR, $TMP or $TEMP is not defined, it is not used for the
Bram Moolenaar582fd852005-03-28 20:58:01 +00001256 default value. "/tmp/*" is only used for Unix.
Bram Moolenaar02467872007-05-06 13:22:01 +00001257
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02001258 WARNING: Not having a backup file means that when Vim fails to write
1259 your buffer correctly and then, for whatever reason, Vim exits, you
1260 lose both the original file and what you were writing. Only disable
1261 backups if you don't care about losing the file.
1262
Bram Moolenaar02467872007-05-06 13:22:01 +00001263 Note that environment variables are not expanded. If you want to use
1264 $HOME you must expand it explicitly, e.g.: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00001265 :let &backupskip = escape(expand('$HOME'), '\') .. '/tmp/*'
Bram Moolenaar02467872007-05-06 13:22:01 +00001266
1267< Note that the default also makes sure that "crontab -e" works (when a
Bram Moolenaara5792f52005-11-23 21:25:05 +00001268 backup would be made by renaming the original file crontab won't see
1269 the newly created file). Also see 'backupcopy' and |crontab|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001270
1271 *'balloondelay'* *'bdlay'*
1272'balloondelay' 'bdlay' number (default: 600)
1273 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001274 {only available when compiled with the |+balloon_eval|
1275 feature}
1276 Delay in milliseconds before a balloon may pop up. See |balloon-eval|.
1277
1278 *'ballooneval'* *'beval'* *'noballooneval'* *'nobeval'*
1279'ballooneval' 'beval' boolean (default off)
1280 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001281 {only available when compiled with the |+balloon_eval|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001282 feature}
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001283 Switch on the |balloon-eval| functionality for the GUI.
1284
1285 *'balloonevalterm'* *'bevalterm'* *'noballoonevalterm'*
1286 *'nobevalterm'*
1287'balloonevalterm' 'bevalterm' boolean (default off)
1288 global
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001289 {only available when compiled with the
1290 |+balloon_eval_term| feature}
1291 Switch on the |balloon-eval| functionality for the terminal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001292
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001293 *'balloonexpr'* *'bexpr'*
1294'balloonexpr' 'bexpr' string (default "")
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00001295 global or local to buffer |global-local|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001296 {only available when compiled with the |+balloon_eval|
1297 feature}
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00001298 Expression for text to show in evaluation balloon. It is only used
Bram Moolenaara6c27c42019-05-09 19:16:22 +02001299 when 'ballooneval' or 'balloonevalterm' is on. These variables can be
1300 used:
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001301
1302 v:beval_bufnr number of the buffer in which balloon is going to show
1303 v:beval_winnr number of the window
Bram Moolenaar82af8712016-06-04 20:20:29 +02001304 v:beval_winid ID of the window
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001305 v:beval_lnum line number
1306 v:beval_col column number (byte index)
1307 v:beval_text word under or after the mouse pointer
1308
Bram Moolenaar54775062019-07-31 21:07:14 +02001309 Instead of showing a balloon, which is limited to plain text, consider
1310 using a popup window, see |popup_beval_example|. A popup window can
1311 use highlighting and show a border.
1312
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001313 The evaluation of the expression must not have side effects!
1314 Example: >
Bram Moolenaara6c27c42019-05-09 19:16:22 +02001315 function MyBalloonExpr()
Bram Moolenaarc51cf032022-02-26 12:25:45 +00001316 return 'Cursor is at line ' .. v:beval_lnum ..
1317 \ ', column ' .. v:beval_col ..
1318 \ ' of file ' .. bufname(v:beval_bufnr) ..
1319 \ ' on word "' .. v:beval_text .. '"'
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001320 endfunction
1321 set bexpr=MyBalloonExpr()
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00001322 set ballooneval balloonevalterm
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001323<
Bram Moolenaar396e8292019-07-13 23:04:31 +02001324 Also see |balloon_show()|, it can be used if the content of the balloon
1325 is to be fetched asynchronously. In that case evaluating
1326 'balloonexpr' should result in an empty string. If you get a balloon
1327 with only "0" you probably didn't return anything from your function.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001328
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001329 NOTE: The balloon is displayed only if the cursor is on a text
1330 character. If the result of evaluating 'balloonexpr' is not empty,
1331 Vim does not try to send a message to an external debugger (Netbeans
1332 or Sun Workshop).
1333
Yegappan Lakshmanan8bb65f22021-12-26 10:51:39 +00001334 If the expression starts with s: or |<SID>|, then it is replaced with
1335 the script ID (|local-function|). Example: >
1336 set bexpr=s:MyBalloonExpr()
1337 set bexpr=<SID>SomeBalloonExpr()
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00001338< Otherwise, the expression is evaluated in the context of the script
1339 where the option was set, thus script-local items are available.
1340
Bram Moolenaar30b65812012-07-12 22:01:11 +02001341 The expression will be evaluated in the |sandbox| when set from a
1342 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02001343 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001344
1345 It is not allowed to change text or jump to another window while
Bram Moolenaar396e8292019-07-13 23:04:31 +02001346 evaluating 'balloonexpr', see |textlock|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001347
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001348 To check whether line breaks in the balloon text work use this check: >
Bram Moolenaar45360022005-07-21 21:08:21 +00001349 if has("balloon_multiline")
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001350< When they are supported "\n" characters will start a new line. If the
1351 expression evaluates to a |List| this is equal to using each List item
1352 as a string and putting "\n" in between them.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001353 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001354
Bram Moolenaar165bc692015-07-21 17:53:25 +02001355 *'belloff'* *'bo'*
1356'belloff' 'bo' string (default "")
1357 global
Bram Moolenaar165bc692015-07-21 17:53:25 +02001358 Specifies for which events the bell will not be rung. It is a comma
1359 separated list of items. For each item that is present, the bell
1360 will be silenced. This is most useful to specify specific events in
1361 insert mode to be silenced.
LemonBoy77771d32022-04-13 11:47:25 +01001362 You can also make it flash by using 'visualbell'.
Bram Moolenaar165bc692015-07-21 17:53:25 +02001363
1364 item meaning when present ~
1365 all All events.
1366 backspace When hitting <BS> or <Del> and deleting results in an
1367 error.
1368 cursor Fail to move around using the cursor keys or
1369 <PageUp>/<PageDown> in |Insert-mode|.
1370 complete Error occurred when using |i_CTRL-X_CTRL-K| or
1371 |i_CTRL-X_CTRL-T|.
1372 copy Cannot copy char from insert mode using |i_CTRL-Y| or
1373 |i_CTRL-E|.
1374 ctrlg Unknown Char after <C-G> in Insert mode.
1375 error Other Error occurred (e.g. try to join last line)
1376 (mostly used in |Normal-mode| or |Cmdline-mode|).
1377 esc hitting <Esc> in |Normal-mode|.
1378 ex In |Visual-mode|, hitting |Q| results in an error.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01001379 hangul Ignored.
Bram Moolenaar165bc692015-07-21 17:53:25 +02001380 insertmode Pressing <Esc> in 'insertmode'.
1381 lang Calling the beep module for Lua/Mzscheme/TCL.
1382 mess No output available for |g<|.
1383 showmatch Error occurred for 'showmatch' function.
1384 operator Empty region error |cpo-E|.
1385 register Unknown register after <C-R> in |Insert-mode|.
1386 shell Bell from shell output |:!|.
1387 spell Error happened on spell suggest.
LemonBoy77771d32022-04-13 11:47:25 +01001388 term Bell from |:terminal| output.
Bram Moolenaar165bc692015-07-21 17:53:25 +02001389 wildmode More matches in |cmdline-completion| available
1390 (depends on the 'wildmode' setting).
1391
Bram Moolenaar036986f2017-03-16 17:41:02 +01001392 This is most useful to fine tune when in Insert mode the bell should
1393 be rung. For Normal mode and Ex commands, the bell is often rung to
Bram Moolenaar165bc692015-07-21 17:53:25 +02001394 indicate that an error occurred. It can be silenced by adding the
1395 "error" keyword.
1396
Bram Moolenaar071d4272004-06-13 20:20:40 +00001397 *'binary'* *'bin'* *'nobinary'* *'nobin'*
1398'binary' 'bin' boolean (default off)
1399 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001400 This option should be set before editing a binary file. You can also
1401 use the |-b| Vim argument. When this option is switched on a few
1402 options will be changed (also when it already was on):
1403 'textwidth' will be set to 0
1404 'wrapmargin' will be set to 0
1405 'modeline' will be off
1406 'expandtab' will be off
1407 Also, 'fileformat' and 'fileformats' options will not be used, the
1408 file is read and written like 'fileformat' was "unix" (a single <NL>
1409 separates lines).
1410 The 'fileencoding' and 'fileencodings' options will not be used, the
1411 file is read without conversion.
1412 NOTE: When you start editing a(nother) file while the 'bin' option is
1413 on, settings from autocommands may change the settings again (e.g.,
1414 'textwidth'), causing trouble when editing. You might want to set
1415 'bin' again when the file has been loaded.
1416 The previous values of these options are remembered and restored when
1417 'bin' is switched from on to off. Each buffer has its own set of
1418 saved option values.
1419 To edit a file with 'binary' set you can use the |++bin| argument.
1420 This avoids you have to do ":set bin", which would have effect for all
1421 files you edit.
1422 When writing a file the <EOL> for the last line is only written if
1423 there was one in the original file (normally Vim appends an <EOL> to
1424 the last line if there is none; this would make the file longer). See
1425 the 'endofline' option.
1426
1427 *'bioskey'* *'biosk'* *'nobioskey'* *'nobiosk'*
1428'bioskey' 'biosk' boolean (default on)
1429 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02001430 {only for MS-DOS}
Bram Moolenaarf3913272016-02-25 00:00:01 +01001431 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001432
1433 *'bomb'* *'nobomb'*
1434'bomb' boolean (default off)
1435 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001436 When writing a file and the following conditions are met, a BOM (Byte
1437 Order Mark) is prepended to the file:
1438 - this option is on
1439 - the 'binary' option is off
1440 - 'fileencoding' is "utf-8", "ucs-2", "ucs-4" or one of the little/big
1441 endian variants.
1442 Some applications use the BOM to recognize the encoding of the file.
1443 Often used for UCS-2 files on MS-Windows. For other applications it
1444 causes trouble, for example: "cat file1 file2" makes the BOM of file2
njohnstonaabca252023-11-19 23:18:57 +00001445 appear halfway through the resulting file. Gcc doesn't accept a BOM.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001446 When Vim reads a file and 'fileencodings' starts with "ucs-bom", a
1447 check for the presence of the BOM is done and 'bomb' set accordingly.
1448 Unless 'binary' is set, it is removed from the first line, so that you
1449 don't see it when editing. When you don't change the options, the BOM
1450 will be restored when writing the file.
1451
1452 *'breakat'* *'brk'*
1453'breakat' 'brk' string (default " ^I!@*-+;:,./?")
1454 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02001455 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001456 feature}
1457 This option lets you choose which characters might cause a line
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00001458 break if 'linebreak' is on. Only works for ASCII and also for 8-bit
1459 characters when 'encoding' is an 8-bit encoding.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001460
Bram Moolenaar7c1c6db2016-04-03 22:08:05 +02001461 *'breakindent'* *'bri'* *'nobreakindent'* *'nobri'*
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001462'breakindent' 'bri' boolean (default off)
1463 local to window
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001464 {not available when compiled without the |+linebreak|
1465 feature}
1466 Every wrapped line will continue visually indented (same amount of
1467 space as the beginning of that line), thus preserving horizontal blocks
1468 of text.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001469 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001470
1471 *'breakindentopt'* *'briopt'*
1472'breakindentopt' 'briopt' string (default empty)
1473 local to window
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001474 {not available when compiled without the |+linebreak|
1475 feature}
1476 Settings for 'breakindent'. It can consist of the following optional
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001477 items and must be separated by a comma:
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001478 min:{n} Minimum text width that will be kept after
1479 applying 'breakindent', even if the resulting
1480 text should normally be narrower. This prevents
1481 text indented almost to the right window border
Dominique Pellédf62c622024-07-15 20:29:59 +02001482 occupying lots of vertical space when broken.
Christian Brabandtc53b4672022-01-15 10:01:05 +00001483 (default: 20)
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001484 shift:{n} After applying 'breakindent', the wrapped line's
1485 beginning will be shifted by the given number of
1486 characters. It permits dynamic French paragraph
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001487 indentation (negative) or emphasizing the line
1488 continuation (positive).
Christian Brabandte7d6dbc2022-05-06 12:21:04 +01001489 (default: 0)
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01001490 sbr Display the 'showbreak' value before applying the
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001491 additional indent.
Christian Brabandte7d6dbc2022-05-06 12:21:04 +01001492 (default: off)
Maxim Kimf674b352021-07-22 11:46:59 +02001493 list:{n} Adds an additional indent for lines that match a
Christian Brabandt4a0b85a2021-07-14 20:00:27 +02001494 numbered or bulleted list (using the
1495 'formatlistpat' setting).
Christian Brabandte7d6dbc2022-05-06 12:21:04 +01001496 (default: 0)
zeertzjq61a6ac42024-09-07 11:23:54 +02001497 list:-1 Uses the width of a match with 'formatlistpat' for
1498 indentation.
Christian Brabandte7d6dbc2022-05-06 12:21:04 +01001499 column:{n} Indent at column {n}. Will overrule the other
1500 sub-options. Note: an additional indent may be
1501 added for the 'showbreak' setting.
1502 (default: off)
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001503
Bram Moolenaar071d4272004-06-13 20:20:40 +00001504 *'browsedir'* *'bsdir'*
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001505'browsedir' 'bsdir' string (default: "last")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001506 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001507 {only for Motif, GTK, Mac and Win32 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001508 Which directory to use for the file browser:
Bram Moolenaar446cb832008-06-24 21:56:24 +00001509 last Use same directory as with last file browser, where a
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02001510 file was opened or saved.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001511 buffer Use the directory of the related buffer.
1512 current Use the current directory.
1513 {path} Use the specified directory
1514
1515 *'bufhidden'* *'bh'*
1516'bufhidden' 'bh' string (default: "")
Christian Brabandt596ad662023-08-16 00:11:09 +02001517 local to buffer |local-noglobal|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001518 This option specifies what happens when a buffer is no longer
1519 displayed in a window:
1520 <empty> follow the global 'hidden' option
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001521 hide hide the buffer (don't unload it), even if 'hidden' is
1522 not set
1523 unload unload the buffer, even if 'hidden' is set; the
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01001524 |:hide| command will also unload the buffer
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001525 delete delete the buffer from the buffer list, even if
1526 'hidden' is set; the |:hide| command will also delete
1527 the buffer, making it behave like |:bdelete|
1528 wipe wipe the buffer from the buffer list, even if
1529 'hidden' is set; the |:hide| command will also wipe
1530 out the buffer, making it behave like |:bwipeout|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001531
Bram Moolenaara14de3d2005-01-07 21:48:26 +00001532 CAREFUL: when "unload", "delete" or "wipe" is used changes in a buffer
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01001533 are lost without a warning. Also, these values may break autocommands
1534 that switch between buffers temporarily.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001535 This option is used together with 'buftype' and 'swapfile' to specify
1536 special kinds of buffers. See |special-buffers|.
1537
1538 *'buflisted'* *'bl'* *'nobuflisted'* *'nobl'* *E85*
1539'buflisted' 'bl' boolean (default: on)
1540 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001541 When this option is set, the buffer shows up in the buffer list. If
1542 it is reset it is not used for ":bnext", "ls", the Buffers menu, etc.
1543 This option is reset by Vim for buffers that are only used to remember
1544 a file name or marks. Vim sets it when starting to edit a buffer.
1545 But not when moving to a buffer with ":buffer".
1546
1547 *'buftype'* *'bt'* *E382*
1548'buftype' 'bt' string (default: "")
Christian Brabandt596ad662023-08-16 00:11:09 +02001549 local to buffer |local-noglobal|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001550 The value of this option specifies the type of a buffer:
1551 <empty> normal buffer
1552 nofile buffer which is not related to a file and will not be
1553 written
1554 nowrite buffer which will not be written
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001555 acwrite buffer which will always be written with BufWriteCmd
Bram Moolenaarb5b75622018-03-09 22:22:21 +01001556 autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001557 quickfix quickfix buffer, contains list of errors |:cwindow|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001558 or list of locations |:lwindow|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001559 help help buffer (you are not supposed to set this
1560 manually)
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02001561 terminal buffer for a |terminal| (you are not supposed to set
1562 this manually)
Bram Moolenaarf2732452018-06-03 14:47:35 +02001563 prompt buffer where only the last line can be edited, meant
1564 to be used by a plugin, see |prompt-buffer|
1565 {only when compiled with the |+channel| feature}
Bram Moolenaar4d784b22019-05-25 19:51:39 +02001566 popup buffer used in a popup window, see |popup|.
1567 {only when compiled with the |+textprop| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001568
1569 This option is used together with 'bufhidden' and 'swapfile' to
1570 specify special kinds of buffers. See |special-buffers|.
Bram Moolenaarebdf3c92020-02-15 21:41:42 +01001571 Also see |win_gettype()|, which returns the type of the window.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001572
1573 Be careful with changing this option, it can have many side effects!
Bram Moolenaar113cb512021-11-07 20:27:04 +00001574 One such effect is that Vim will not check the timestamp of the file,
1575 if the file is changed by another program this will not be noticed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001576
Bram Moolenaar280f1262006-01-30 00:14:18 +00001577 A "quickfix" buffer is only used for the error list and the location
1578 list. This value is set by the |:cwindow| and |:lwindow| commands and
1579 you are not supposed to change it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001580
1581 "nofile" and "nowrite" buffers are similar:
1582 both: The buffer is not to be written to disk, ":w" doesn't
1583 work (":w filename" does work though).
1584 both: The buffer is never considered to be |'modified'|.
1585 There is no warning when the changes will be lost, for
1586 example when you quit Vim.
1587 both: A swap file is only created when using too much memory
1588 (when 'swapfile' has been reset there is never a swap
1589 file).
1590 nofile only: The buffer name is fixed, it is not handled like a
1591 file name. It is not modified in response to a |:cd|
1592 command.
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01001593 both: When using ":e bufname" and already editing "bufname"
1594 the buffer is made empty and autocommands are
1595 triggered as usual for |:edit|.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001596 *E676*
1597 "acwrite" implies that the buffer name is not related to a file, like
1598 "nofile", but it will be written. Thus, in contrast to "nofile" and
1599 "nowrite", ":w" does work and a modified buffer can't be abandoned
1600 without saving. For writing there must be matching |BufWriteCmd|,
1601 |FileWriteCmd| or |FileAppendCmd| autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001602
1603 *'casemap'* *'cmp'*
1604'casemap' 'cmp' string (default: "internal,keepascii")
1605 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001606 Specifies details about changing the case of letters. It may contain
1607 these words, separated by a comma:
1608 internal Use internal case mapping functions, the current
1609 locale does not change the case mapping. This only
Bram Moolenaar6f16eb82005-08-23 21:02:42 +00001610 matters when 'encoding' is a Unicode encoding,
1611 "latin1" or "iso-8859-15". When "internal" is
1612 omitted, the towupper() and towlower() system library
1613 functions are used when available.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001614 keepascii For the ASCII characters (0x00 to 0x7f) use the US
1615 case mapping, the current locale is not effective.
1616 This probably only matters for Turkish.
1617
Bram Moolenaar938ae282023-02-20 20:44:55 +00001618 *'cdhome'* *'cdh'* *'nocdhome'* *'nocdh'*
Bram Moolenaar7b1463b2021-12-11 17:24:39 +00001619'cdhome' 'cdh' boolean (default: off)
1620 global
1621 When on, |:cd|, |:tcd| and |:lcd| without an argument changes the
1622 current working directory to the |$HOME| directory like in Unix.
1623 When off, those commands just print the current directory name.
1624 On Unix this option has no effect.
dkearns8ebdbc92023-10-29 06:26:19 +11001625 This option cannot be set from a |modeline| or in the |sandbox|, for
1626 security reasons.
Bram Moolenaar7b1463b2021-12-11 17:24:39 +00001627 NOTE: This option is reset when 'compatible' is set.
1628
Bram Moolenaar071d4272004-06-13 20:20:40 +00001629 *'cdpath'* *'cd'* *E344* *E346*
1630'cdpath' 'cd' string (default: equivalent to $CDPATH or ",,")
1631 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001632 This is a list of directories which will be searched when using the
Bram Moolenaar00aa0692019-04-27 20:37:57 +02001633 |:cd|, |:tcd| and |:lcd| commands, provided that the directory being
1634 searched for has a relative path, not an absolute part starting with
1635 "/", "./" or "../", the 'cdpath' option is not used then.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001636 The 'cdpath' option's value has the same form and semantics as
1637 |'path'|. Also see |file-searching|.
1638 The default value is taken from $CDPATH, with a "," prepended to look
1639 in the current directory first.
1640 If the default value taken from $CDPATH is not what you want, include
1641 a modified version of the following command in your vimrc file to
1642 override it: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00001643 :let &cdpath = ',' .. substitute(substitute($CDPATH, '[, ]', '\\\0', 'g'), ':', ',', 'g')
Bram Moolenaar071d4272004-06-13 20:20:40 +00001644< This option cannot be set from a |modeline| or in the |sandbox|, for
1645 security reasons.
1646 (parts of 'cdpath' can be passed to the shell to expand file names).
1647
1648 *'cedit'*
1649'cedit' string (Vi default: "", Vim default: CTRL-F)
1650 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001651 The key used in Command-line Mode to open the command-line window.
1652 The default is CTRL-F when 'compatible' is off.
1653 Only non-printable keys are allowed.
1654 The key can be specified as a single character, but it is difficult to
Milly25732432024-10-01 19:30:20 +02001655 type. The preferred way is to use |key-notation| (e.g. <Up>, <C-F>) or
1656 a letter preceded with a caret (e.g. `^F` is CTRL-F). Examples: >
1657 :set cedit=^Y
1658 :set cedit=<Esc>
Bram Moolenaar071d4272004-06-13 20:20:40 +00001659< |Nvi| also has this option, but it only uses the first character.
1660 See |cmdwin|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001661 NOTE: This option is set to the Vim default value when 'compatible'
1662 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001663
1664 *'charconvert'* *'ccv'* *E202* *E214* *E513*
1665'charconvert' 'ccv' string (default "")
1666 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01001667 {only available when compiled with the |+eval| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001668 An expression that is used for character encoding conversion. It is
1669 evaluated when a file that is to be read or has been written has a
1670 different encoding from what is desired.
1671 'charconvert' is not used when the internal iconv() function is
1672 supported and is able to do the conversion. Using iconv() is
1673 preferred, because it is much faster.
1674 'charconvert' is not used when reading stdin |--|, because there is no
1675 file to convert from. You will have to save the text in a file first.
Bram Moolenaarf10911e2022-01-29 22:20:48 +00001676 The expression must return zero, false or an empty string for success,
1677 non-zero or true for failure.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001678 The possible encoding names encountered are in 'encoding'.
1679 Additionally, names given in 'fileencodings' and 'fileencoding' are
1680 used.
1681 Conversion between "latin1", "unicode", "ucs-2", "ucs-4" and "utf-8"
1682 is done internally by Vim, 'charconvert' is not used for this.
1683 'charconvert' is also used to convert the viminfo file, if the 'c'
1684 flag is present in 'viminfo'. Also used for Unicode conversion.
1685 Example: >
1686 set charconvert=CharConvert()
1687 fun CharConvert()
1688 system("recode "
Bram Moolenaarc51cf032022-02-26 12:25:45 +00001689 \ .. v:charconvert_from .. ".." .. v:charconvert_to
1690 \ .. " <" .. v:fname_in .. " >" .. v:fname_out)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001691 return v:shell_error
1692 endfun
1693< The related Vim variables are:
1694 v:charconvert_from name of the current encoding
1695 v:charconvert_to name of the desired encoding
1696 v:fname_in name of the input file
1697 v:fname_out name of the output file
1698 Note that v:fname_in and v:fname_out will never be the same.
1699 Note that v:charconvert_from and v:charconvert_to may be different
1700 from 'encoding'. Vim internally uses UTF-8 instead of UCS-2 or UCS-4.
Bram Moolenaarf10911e2022-01-29 22:20:48 +00001701
Bram Moolenaara4e0b972022-10-01 19:43:52 +01001702 The advantage of using a function call without arguments is that it is
1703 faster, see |expr-option-function|.
1704
Bram Moolenaar071d4272004-06-13 20:20:40 +00001705 Encryption is not done by Vim when using 'charconvert'. If you want
1706 to encrypt the file after conversion, 'charconvert' should take care
1707 of this.
Bram Moolenaarf10911e2022-01-29 22:20:48 +00001708
1709 If the 'charconvert' expression starts with s: or |<SID>|, then it is
1710 replaced with the script ID (|local-function|). Example: >
1711 set charconvert=s:MyConvert()
1712 set charconvert=<SID>SomeConvert()
1713< Otherwise the expression is evaluated in the context of the script
1714 where the option was set, thus script-local items are available.
1715
Bram Moolenaar071d4272004-06-13 20:20:40 +00001716 This option cannot be set from a |modeline| or in the |sandbox|, for
1717 security reasons.
1718
1719 *'cindent'* *'cin'* *'nocindent'* *'nocin'*
1720'cindent' 'cin' boolean (default off)
1721 local to buffer
Bram Moolenaar446cb832008-06-24 21:56:24 +00001722 Enables automatic C program indenting. See 'cinkeys' to set the keys
Bram Moolenaar071d4272004-06-13 20:20:40 +00001723 that trigger reindenting in insert mode and 'cinoptions' to set your
1724 preferred indent style.
1725 If 'indentexpr' is not empty, it overrules 'cindent'.
1726 If 'lisp' is not on and both 'indentexpr' and 'equalprg' are empty,
1727 the "=" operator indents using this algorithm rather than calling an
1728 external program.
1729 See |C-indenting|.
1730 When you don't like the way 'cindent' works, try the 'smartindent'
1731 option or 'indentexpr'.
1732 This option is not used when 'paste' is set.
1733 NOTE: This option is reset when 'compatible' is set.
1734
1735 *'cinkeys'* *'cink'*
Bram Moolenaarce655742019-01-31 14:12:57 +01001736'cinkeys' 'cink' string (default "0{,0},0),0],:,0#,!^F,o,O,e")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001737 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001738 A list of keys that, when typed in Insert mode, cause reindenting of
1739 the current line. Only used if 'cindent' is on and 'indentexpr' is
1740 empty.
1741 For the format of this option see |cinkeys-format|.
1742 See |C-indenting|.
1743
1744 *'cinoptions'* *'cino'*
1745'cinoptions' 'cino' string (default "")
1746 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001747 The 'cinoptions' affect the way 'cindent' reindents lines in a C
1748 program. See |cinoptions-values| for the values of this option, and
1749 |C-indenting| for info on C indenting in general.
1750
laburnumT3f7855a2023-12-05 18:37:03 +01001751 *'cinscopedecls'* *'cinsd'*
1752'cinscopedecls' 'cinsd' string (default "public,protected,private")
1753 local to buffer
1754 Keywords that are interpreted as a C++ scope declaration by |cino-g|.
1755 Useful e.g. for working with the Qt framework that defines additional
1756 scope declarations "signals", "public slots" and "private slots": >
1757 set cinscopedecls+=signals,public\ slots,private\ slots
1758<
Bram Moolenaar071d4272004-06-13 20:20:40 +00001759 *'cinwords'* *'cinw'*
1760'cinwords' 'cinw' string (default "if,else,while,do,for,switch")
1761 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001762 These keywords start an extra indent in the next line when
1763 'smartindent' or 'cindent' is set. For 'cindent' this is only done at
1764 an appropriate place (inside {}).
1765 Note that 'ignorecase' isn't used for 'cinwords'. If case doesn't
1766 matter, include the keyword both the uppercase and lowercase:
1767 "if,If,IF".
1768
laburnumT3f7855a2023-12-05 18:37:03 +01001769 *'clipboard'* *'cb'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001770'clipboard' 'cb' string (default "autoselect,exclude:cons\|linux"
1771 for X-windows, "" otherwise)
1772 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001773 {only in GUI versions or when the |+xterm_clipboard|
1774 feature is included}
Tom Praschan3506cf32022-04-07 12:39:08 +01001775 This option is a list of comma-separated names.
Bram Moolenaar942db232021-02-13 18:14:48 +01001776 Note: if one of the items is "exclude:", then you can't add an item
Bram Moolenaar5ed11532022-07-06 13:18:11 +01001777 after that. Therefore do not append an item with += but use ^= to
Bram Moolenaar942db232021-02-13 18:14:48 +01001778 prepend, e.g.: >
1779 set clipboard^=unnamed
Bram Moolenaar9fbdbb82022-09-27 17:30:34 +01001780< When using the GUI see |'go-A'|.
1781 These names are recognized:
Bram Moolenaar071d4272004-06-13 20:20:40 +00001782
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001783 *clipboard-unnamed*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001784 unnamed When included, Vim will use the clipboard register '*'
1785 for all yank, delete, change and put operations which
1786 would normally go to the unnamed register. When a
1787 register is explicitly specified, it will always be
1788 used regardless of whether "unnamed" is in 'clipboard'
1789 or not. The clipboard register can always be
1790 explicitly accessed using the "* notation. Also see
1791 |gui-clipboard|.
1792
Bram Moolenaar30b65812012-07-12 22:01:11 +02001793 *clipboard-unnamedplus*
Bram Moolenaar00154502013-02-13 16:15:55 +01001794 unnamedplus A variant of the "unnamed" flag which uses the
1795 clipboard register '+' (|quoteplus|) instead of
1796 register '*' for all yank, delete, change and put
1797 operations which would normally go to the unnamed
1798 register. When "unnamed" is also included to the
1799 option, yank operations (but not delete, change or
1800 put) will additionally copy the text into register
1801 '*'.
Bram Moolenaar81af9252010-12-10 20:35:50 +01001802 Only available with the |+X11| feature.
Bram Moolenaarbf9680e2010-12-02 21:43:16 +01001803 Availability can be checked with: >
1804 if has('unnamedplus')
1805<
Bram Moolenaar30b65812012-07-12 22:01:11 +02001806 *clipboard-autoselect*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001807 autoselect Works like the 'a' flag in 'guioptions': If present,
1808 then whenever Visual mode is started, or the Visual
1809 area extended, Vim tries to become the owner of the
1810 windowing system's global selection or put the
1811 selected text on the clipboard used by the selection
Bram Moolenaarba3ff532018-11-04 14:45:49 +01001812 register "*. See |'go-a'| and |quotestar| for details.
1813 When the GUI is active, the 'a' flag in 'guioptions'
1814 is used, when the GUI is not active, this "autoselect"
1815 flag is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001816 Also applies to the modeless selection.
1817
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001818 *clipboard-autoselectplus*
1819 autoselectplus Like "autoselect" but using the + register instead of
1820 the * register. Compare to the 'P' flag in
1821 'guioptions'.
1822
1823 *clipboard-autoselectml*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001824 autoselectml Like "autoselect", but for the modeless selection
1825 only. Compare to the 'A' flag in 'guioptions'.
1826
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001827 *clipboard-html*
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001828 html When the clipboard contains HTML, use this when
1829 pasting. When putting text on the clipboard, mark it
1830 as HTML. This works to copy rendered HTML from
1831 Firefox, paste it as raw HTML in Vim, select the HTML
1832 in Vim and paste it in a rich edit box in Firefox.
Bram Moolenaar20a825a2010-05-31 21:27:30 +02001833 You probably want to add this only temporarily,
1834 possibly use BufEnter autocommands.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001835 Only supported for GTK version 2 and later.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001836
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001837 *clipboard-exclude*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001838 exclude:{pattern}
1839 Defines a pattern that is matched against the name of
1840 the terminal 'term'. If there is a match, no
1841 connection will be made to the X server. This is
1842 useful in this situation:
1843 - Running Vim in a console.
1844 - $DISPLAY is set to start applications on another
1845 display.
1846 - You do not want to connect to the X server in the
1847 console, but do want this in a terminal emulator.
1848 To never connect to the X server use: >
1849 exclude:.*
1850< This has the same effect as using the |-X| argument.
1851 Note that when there is no connection to the X server
1852 the window title won't be restored and the clipboard
1853 cannot be accessed.
1854 The value of 'magic' is ignored, {pattern} is
1855 interpreted as if 'magic' was on.
1856 The rest of the option value will be used for
1857 {pattern}, this must be the last entry.
1858
1859 *'cmdheight'* *'ch'*
1860'cmdheight' 'ch' number (default 1)
Shougo Matsushitaf39cfb72022-07-30 16:54:05 +01001861 global or local to tab page
Bram Moolenaara2a89732022-08-31 14:46:18 +01001862 Number of screen lines to use for the command-line. A larger value
1863 helps avoiding |hit-enter| prompts.
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00001864 The value of this option is stored with the tab page, so that each tab
1865 page can have a different value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001866
1867 *'cmdwinheight'* *'cwh'*
1868'cmdwinheight' 'cwh' number (default 7)
1869 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001870 Number of screen lines to use for the command-line window. |cmdwin|
1871
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001872 *'colorcolumn'* *'cc'*
1873'colorcolumn' 'cc' string (default "")
1874 local to window
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001875 {not available when compiled without the |+syntax|
1876 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001877 'colorcolumn' is a comma-separated list of screen columns that are
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001878 highlighted with ColorColumn |hl-ColorColumn|. Useful to align
1879 text. Will make screen redrawing slower.
1880 The screen column can be an absolute number, or a number preceded with
1881 '+' or '-', which is added to or subtracted from 'textwidth'. >
1882
Bram Moolenaar10e8ff92023-06-10 21:40:39 +01001883 :set cc=+1 " highlight column after 'textwidth'
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001884 :set cc=+1,+2,+3 " highlight three columns after 'textwidth'
1885 :hi ColorColumn ctermbg=lightgrey guibg=lightgrey
1886<
1887 When 'textwidth' is zero then the items with '-' and '+' are not used.
1888 A maximum of 256 columns are highlighted.
1889
Bram Moolenaar071d4272004-06-13 20:20:40 +00001890 *'columns'* *'co'* *E594*
1891'columns' 'co' number (default 80 or terminal width)
1892 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001893 Number of columns of the screen. Normally this is set by the terminal
Bram Moolenaar7c626922005-02-07 22:01:03 +00001894 initialization and does not have to be set by hand. Also see
1895 |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001896 When Vim is running in the GUI or in a resizable window, setting this
1897 option will cause the window size to be changed. When you only want
1898 to use the size for the GUI, put the command in your |gvimrc| file.
1899 When you set this option and Vim is unable to change the physical
Bram Moolenaar02467872007-05-06 13:22:01 +00001900 number of columns of the display, the display may be messed up. For
1901 the GUI it is always possible and Vim limits the number of columns to
1902 what fits on the screen. You can use this command to get the widest
1903 window possible: >
1904 :set columns=9999
1905< Minimum value is 12, maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001906
1907 *'comments'* *'com'* *E524* *E525*
1908'comments' 'com' string (default
1909 "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-")
1910 local to buffer
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001911 A comma-separated list of strings that can start a comment line. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00001912 |format-comments|. See |option-backslash| about using backslashes to
1913 insert a space.
1914
1915 *'commentstring'* *'cms'* *E537*
Riley Bruins0a083062024-06-03 20:40:45 +02001916'commentstring' 'cms' string (default "/* %s */")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001917 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001918 {not available when compiled without the |+folding|
1919 feature}
1920 A template for a comment. The "%s" in the value is replaced with the
Riley Bruins0a083062024-06-03 20:40:45 +02001921 comment text, and should be padded with a space when possible.
h-east84ac2122024-06-17 18:12:30 +02001922 Currently used to add markers for folding, see |fold-marker|. Also
Riley Bruins0a083062024-06-03 20:40:45 +02001923 commonly used by commenting plugins (e.g. |comment-install|).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001924
1925 *'compatible'* *'cp'* *'nocompatible'* *'nocp'*
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001926'compatible' 'cp' boolean (default on, off when a |vimrc| or |gvimrc|
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02001927 file is found, reset in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001928 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001929 This option has the effect of making Vim either more Vi-compatible, or
1930 make Vim behave in a more useful way.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001931
Bram Moolenaar071d4272004-06-13 20:20:40 +00001932 This is a special kind of option, because when it's set or reset,
Bram Moolenaar214641f2017-03-05 17:04:09 +01001933 other options are also changed as a side effect.
1934 NOTE: Setting or resetting this option can have a lot of unexpected
1935 effects: Mappings are interpreted in another way, undo behaves
1936 differently, etc. If you set this option in your vimrc file, you
1937 should probably put it at the very start.
1938
Bram Moolenaar071d4272004-06-13 20:20:40 +00001939 By default this option is on and the Vi defaults are used for the
1940 options. This default was chosen for those people who want to use Vim
1941 just like Vi, and don't even (want to) know about the 'compatible'
1942 option.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001943 When a |vimrc| or |gvimrc| file is found while Vim is starting up,
Bram Moolenaard042c562005-06-30 22:04:15 +00001944 this option is switched off, and all options that have not been
1945 modified will be set to the Vim defaults. Effectively, this means
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001946 that when a |vimrc| or |gvimrc| file exists, Vim will use the Vim
Bram Moolenaard042c562005-06-30 22:04:15 +00001947 defaults, otherwise it will use the Vi defaults. (Note: This doesn't
Bram Moolenaar02467872007-05-06 13:22:01 +00001948 happen for the system-wide vimrc or gvimrc file, nor for a file given
1949 with the |-u| argument). Also see |compatible-default| and
1950 |posix-compliance|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001951 You can also set this option with the "-C" argument, and reset it with
1952 "-N". See |-C| and |-N|.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001953 See 'cpoptions' for more fine tuning of Vi compatibility.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001954
Bram Moolenaar214641f2017-03-05 17:04:09 +01001955 When this option is set, numerous other options are set to make Vim as
1956 Vi-compatible as possible. When this option is unset, various options
1957 are set to make Vim more useful. The table below lists all the
1958 options affected.
1959 The {?} column indicates when the options are affected:
1960 + Means that the option is set to the value given in {set value} when
1961 'compatible' is set.
1962 & Means that the option is set to the value given in {set value} when
1963 'compatible' is set AND is set to its Vim default value when
1964 'compatible' is unset.
1965 - Means the option is NOT changed when setting 'compatible' but IS
1966 set to its Vim default when 'compatible' is unset.
1967 The {effect} column summarises the change when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001968
Bram Moolenaar036986f2017-03-16 17:41:02 +01001969 option ? set value effect ~
Bram Moolenaar214641f2017-03-05 17:04:09 +01001970
1971 'allowrevins' + off no CTRL-_ command
1972 'antialias' + off don't use antialiased fonts
Bram Moolenaarbe4e0162023-02-02 13:59:48 +00001973 'arabic' + off reset arabic-related options
Bram Moolenaar214641f2017-03-05 17:04:09 +01001974 'arabicshape' + on correct character shapes
1975 'backspace' + "" normal backspace
1976 'backup' + off no backup file
1977 'backupcopy' & Unix: "yes" backup file is a copy
1978 else: "auto" copy or rename backup file
1979 'balloonexpr' + "" text to show in evaluation balloon
1980 'breakindent' + off don't indent when wrapping lines
1981 'cedit' - {unchanged} {set vim default only on resetting 'cp'}
Bram Moolenaar7b1463b2021-12-11 17:24:39 +00001982 'cdhome' + off ":cd" don't chdir to home on non-Unix
Bram Moolenaar214641f2017-03-05 17:04:09 +01001983 'cindent' + off no C code indentation
1984 'compatible' - {unchanged} {set vim default only on resetting 'cp'}
1985 'copyindent' + off don't copy indent structure
1986 'cpoptions' & (all flags) Vi-compatible flags
1987 'cscopepathcomp'+ 0 don't show directories in tags list
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01001988 'cscoperelative'+ off don't use basename of path as prefix
Bram Moolenaar214641f2017-03-05 17:04:09 +01001989 'cscopetag' + off don't use cscope for ":tag"
Bram Moolenaar036986f2017-03-16 17:41:02 +01001990 'cscopetagorder'+ 0 see |cscopetagorder|
Bram Moolenaar214641f2017-03-05 17:04:09 +01001991 'cscopeverbose' + off see |cscopeverbose|
1992 'delcombine' + off unicode: delete whole char combination
1993 'digraph' + off no digraphs
1994 'esckeys' & off no <Esc>-keys in Insert mode
Christian Brabandt5f5131d2023-10-25 21:44:26 +02001995 this also disables |modifyOtherKeys|
1996 and |xterm-bracketed-paste|
Bram Moolenaar214641f2017-03-05 17:04:09 +01001997 'expandtab' + off tabs not expanded to spaces
1998 'fileformats' & "" no automatic file format detection,
Bram Moolenaar6f345a12019-12-17 21:27:18 +01001999 "dos,unix" except for MS-Windows
Bram Moolenaar214641f2017-03-05 17:04:09 +01002000 'formatexpr' + "" use 'formatprg' for auto-formatting
2001 'formatoptions' & "vt" Vi compatible formatting
2002 'gdefault' + off no default 'g' flag for ":s"
2003 'history' & 0 no commandline history
2004 'hkmap' + off no Hebrew keyboard mapping
2005 'hkmapp' + off no phonetic Hebrew keyboard mapping
2006 'hlsearch' + off no highlighting of search matches
2007 'incsearch' + off no incremental searching
2008 'indentexpr' + "" no indenting by expression
2009 'insertmode' + off do not start in Insert mode
2010 'iskeyword' & "@,48-57,_" keywords contain alphanumeric
Bram Moolenaar071d4272004-06-13 20:20:40 +00002011 characters and '_'
Bram Moolenaar214641f2017-03-05 17:04:09 +01002012 'joinspaces' + on insert 2 spaces after period
2013 'modeline' & off no modelines
2014 'more' & off no pauses in listings
2015 'mzquantum' - {unchanged} {set vim default only on resetting 'cp'}
2016 'numberwidth' & 8 min number of columns for line number
2017 'preserveindent'+ off don't preserve current indent structure
2018 when changing it
2019 'revins' + off no reverse insert
2020 'ruler' + off no ruler
2021 'scrolljump' + 1 no jump scroll
2022 'scrolloff' + 0 no scroll offset
2023 'shelltemp' - {unchanged} {set vim default only on resetting 'cp'}
2024 'shiftround' + off indent not rounded to shiftwidth
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02002025 'shortmess' & "S" no shortening of messages
Bram Moolenaar214641f2017-03-05 17:04:09 +01002026 'showcmd' & off command characters not shown
2027 'showmode' & off current mode not shown
2028 'sidescrolloff' + 0 cursor moves to edge of screen in scroll
2029 'smartcase' + off no automatic ignore case switch
2030 'smartindent' + off no smart indentation
2031 'smarttab' + off no smart tab size
2032 'softtabstop' + 0 tabs are always 'tabstop' positions
2033 'startofline' + on goto startofline with some commands
2034 'tagcase' & "followic" 'ignorecase' when searching tags file
2035 'tagrelative' & off tag file names are not relative
2036 'termguicolors' + off don't use highlight-(guifg|guibg)
2037 'textauto' & off no automatic textmode detection
2038 'textwidth' + 0 no automatic line wrap
2039 'tildeop' + off tilde is not an operator
2040 'ttimeout' + off no terminal timeout
2041 'undofile' + off don't use an undo file
Bram Moolenaar036986f2017-03-16 17:41:02 +01002042 'viminfo' - {unchanged} {set Vim default only on resetting 'cp'}
Bram Moolenaar214641f2017-03-05 17:04:09 +01002043 'virtualedit' + "" cursor can only be placed on characters
2044 'whichwrap' & "" left-right movements don't wrap
2045 'wildchar' & CTRL-E only when the current value is <Tab>
Bram Moolenaar071d4272004-06-13 20:20:40 +00002046 use CTRL-E for cmdline completion
Bram Moolenaar214641f2017-03-05 17:04:09 +01002047 'writebackup' + on or off depends on the |+writebackup| feature
Bram Moolenaar071d4272004-06-13 20:20:40 +00002048
2049 *'complete'* *'cpt'* *E535*
2050'complete' 'cpt' string (default: ".,w,b,u,t,i")
2051 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002052 This option specifies how keyword completion |ins-completion| works
2053 when CTRL-P or CTRL-N are used. It is also used for whole-line
2054 completion |i_CTRL-X_CTRL-L|. It indicates the type of completion
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01002055 and the places to scan. It is a comma-separated list of flags:
Bram Moolenaar3848e002016-03-19 18:42:29 +01002056 . scan the current buffer ('wrapscan' is ignored)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002057 w scan buffers from other windows
2058 b scan other loaded buffers that are in the buffer list
2059 u scan the unloaded buffers that are in the buffer list
2060 U scan the buffers that are not in the buffer list
2061 k scan the files given with the 'dictionary' option
Bram Moolenaar0b238792006-03-02 22:49:12 +00002062 kspell use the currently active spell checking |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002063 k{dict} scan the file {dict}. Several "k" flags can be given,
2064 patterns are valid too. For example: >
2065 :set cpt=k/usr/dict/*,k~/spanish
2066< s scan the files given with the 'thesaurus' option
2067 s{tsr} scan the file {tsr}. Several "s" flags can be given, patterns
2068 are valid too.
2069 i scan current and included files
2070 d scan current and included files for defined name or macro
2071 |i_CTRL-X_CTRL-D|
2072 ] tag completion
2073 t same as "]"
2074
2075 Unloaded buffers are not loaded, thus their autocmds |:autocmd| are
2076 not executed, this may lead to unexpected completions from some files
2077 (gzipped files for example). Unloaded buffers are not scanned for
2078 whole-line completion.
2079
2080 The default is ".,w,b,u,t,i", which means to scan:
2081 1. the current buffer
2082 2. buffers in other windows
2083 3. other loaded buffers
2084 4. unloaded buffers
2085 5. tags
2086 6. included files
2087
2088 As you can see, CTRL-N and CTRL-P can be used to do any 'iskeyword'-
Bram Moolenaar582fd852005-03-28 20:58:01 +00002089 based expansion (e.g., dictionary |i_CTRL-X_CTRL-K|, included patterns
2090 |i_CTRL-X_CTRL-I|, tags |i_CTRL-X_CTRL-]| and normal expansions).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002091
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00002092 *'completefunc'* *'cfu'*
2093'completefunc' 'cfu' string (default: empty)
2094 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02002095 {not available when compiled without the |+eval|
Bram Moolenaare2c453d2019-08-21 14:37:09 +02002096 feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00002097 This option specifies a function to be used for Insert mode completion
2098 with CTRL-X CTRL-U. |i_CTRL-X_CTRL-U|
Bram Moolenaar280f1262006-01-30 00:14:18 +00002099 See |complete-functions| for an explanation of how the function is
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00002100 invoked and what it should return. The value can be the name of a
2101 function, a |lambda| or a |Funcref|. See |option-value-function| for
2102 more information.
Bram Moolenaar166af9b2010-11-16 20:34:40 +01002103 This option cannot be set from a |modeline| or in the |sandbox|, for
2104 security reasons.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00002105
glepnir6a89c942024-10-01 20:32:12 +02002106 *'completeitemalign'* *'cia'*
2107'completeitemalign' 'cia' string (default: "abbr,kind,menu")
2108 global
2109 A comma-separated list of |complete-items| that controls the alignment
2110 and display order of items in the popup menu during Insert mode
2111 completion. The supported values are abbr, kind, and menu. These
2112 options allow to customize how the completion items are shown in the
2113 popup menu. Note: must always contain those three values in any
2114 order.
2115
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00002116 *'completeopt'* *'cot'*
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00002117'completeopt' 'cot' string (default: "menu,preview")
zeertzjq529b9ad2024-06-05 20:27:06 +02002118 global or local to buffer |global-local|
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01002119 A comma-separated list of options for Insert mode completion
Bram Moolenaarc7453f52006-02-10 23:20:28 +00002120 |ins-completion|. The supported values are:
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00002121
2122 menu Use a popup menu to show the possible completions. The
2123 menu is only shown when there is more than one match and
2124 sufficient colors are available. |ins-completion-menu|
2125
Bram Moolenaar65c923a2006-03-03 22:56:30 +00002126 menuone Use the popup menu also when there is only one match.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002127 Useful when there is additional information about the
Bram Moolenaar65c923a2006-03-03 22:56:30 +00002128 match, e.g., what file it comes from.
2129
Bram Moolenaarc1e37902006-04-18 21:55:01 +00002130 longest Only insert the longest common text of the matches. If
2131 the menu is displayed you can use CTRL-L to add more
2132 characters. Whether case is ignored depends on the kind
2133 of completion. For buffer text the 'ignorecase' option is
2134 used.
Bram Moolenaarc7453f52006-02-10 23:20:28 +00002135
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00002136 preview Show extra information about the currently selected
Bram Moolenaar02467872007-05-06 13:22:01 +00002137 completion in the preview window. Only works in
2138 combination with "menu" or "menuone".
2139
Bram Moolenaar576a4a62019-08-18 15:25:17 +02002140 popup Show extra information about the currently selected
2141 completion in a popup window. Only works in combination
2142 with "menu" or "menuone". Overrides "preview".
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002143 See |'completepopup'| for specifying properties.
Bram Moolenaar2e693a82019-10-16 22:35:02 +02002144 {only works when compiled with the |+textprop| feature}
Bram Moolenaar576a4a62019-08-18 15:25:17 +02002145
Bram Moolenaardca7abe2019-10-20 18:17:57 +02002146 popuphidden
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01002147 Just like "popup" but initially hide the popup. Use a
Bram Moolenaardca7abe2019-10-20 18:17:57 +02002148 |CompleteChanged| autocommand to fetch the info and call
2149 |popup_show()| once the popup has been filled.
2150 See the example at |complete-popuphidden|.
2151 {only works when compiled with the |+textprop| feature}
2152
Bram Moolenaarb6be1e22015-07-10 18:18:40 +02002153 noinsert Do not insert any text for a match until the user selects
2154 a match from the menu. Only works in combination with
2155 "menu" or "menuone". No effect if "longest" is present.
2156
2157 noselect Do not select a match in the menu, force the user to
2158 select one from the menu. Only works in combination with
2159 "menu" or "menuone".
2160
glepnira218cc62024-06-03 19:32:39 +02002161 fuzzy Enable |fuzzy-matching| for completion candidates. This
2162 allows for more flexible and intuitive matching, where
2163 characters can be skipped and matches can be found even
Yee Cheng Chin26e4b002024-09-10 20:50:08 +02002164 if the exact sequence is not typed.
glepnira218cc62024-06-03 19:32:39 +02002165
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002166 *'completepopup'* *'cpp'*
2167'completepopup' 'cpp' string (default empty)
2168 global
2169 {not available when compiled without the |+textprop|
2170 or |+quickfix| feature}
2171 When 'completeopt' contains "popup" then this option is used for the
Bram Moolenaar447bfba2020-07-18 16:07:16 +02002172 properties of the info popup when it is created. If an info popup
2173 window already exists it is closed, so that the option value is
2174 applied when it is created again.
2175 You can also use |popup_findinfo()| and then set properties for an
2176 existing info popup with |popup_setoptions()|. See |complete-popup|.
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002177
laburnumT3f7855a2023-12-05 18:37:03 +01002178 *'completeslash'* *'csl'*
2179'completeslash' 'csl' string (default: "")
2180 local to buffer
2181 {only for MS-Windows}
2182 When this option is set it overrules 'shellslash' for completion:
2183 - When this option is set to "slash", a forward slash is used for path
2184 completion in insert mode. This is useful when editing HTML tag, or
2185 Makefile with 'noshellslash' on MS-Windows.
2186 - When this option is set to "backslash", backslash is used. This is
2187 useful when editing a batch file with 'shellslash' set on MS-Windows.
2188 - When this option is empty, same character is used as for
2189 'shellslash'.
2190 For Insert mode completion the buffer-local value is used. For
2191 command line completion the global value is used.
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002192
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002193 *'concealcursor'* *'cocu'*
2194'concealcursor' 'cocu' string (default: "")
2195 local to window
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002196 {not available when compiled without the |+conceal|
2197 feature}
2198 Sets the modes in which text in the cursor line can also be concealed.
2199 When the current mode is listed then concealing happens just like in
2200 other lines.
2201 n Normal mode
2202 v Visual mode
2203 i Insert mode
Bram Moolenaarca8c9862010-07-24 15:00:38 +02002204 c Command line editing, for 'incsearch'
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002205
Bram Moolenaare6dc5732010-07-24 23:52:26 +02002206 'v' applies to all lines in the Visual area, not only the cursor.
Bram Moolenaarca8c9862010-07-24 15:00:38 +02002207 A useful value is "nc". This is used in help files. So long as you
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002208 are moving around text is concealed, but when starting to insert text
2209 or selecting a Visual area the concealed text is displayed, so that
2210 you can see what you are doing.
Bram Moolenaarf70e3d62010-07-24 13:15:07 +02002211 Keep in mind that the cursor position is not always where it's
2212 displayed. E.g., when moving vertically it may change column.
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002213
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002214 *'conceallevel'* *'cole'*
2215'conceallevel' 'cole' number (default 0)
Bram Moolenaar860cae12010-06-05 23:22:07 +02002216 local to window
Bram Moolenaar860cae12010-06-05 23:22:07 +02002217 {not available when compiled without the |+conceal|
2218 feature}
Bram Moolenaar6df6f472010-07-18 18:04:50 +02002219 Determine how text with the "conceal" syntax attribute |:syn-conceal|
2220 is shown:
Bram Moolenaar860cae12010-06-05 23:22:07 +02002221
Bram Moolenaar6df6f472010-07-18 18:04:50 +02002222 Value Effect ~
Bram Moolenaar860cae12010-06-05 23:22:07 +02002223 0 Text is shown normally
Bram Moolenaar477db062010-07-28 18:17:41 +02002224 1 Each block of concealed text is replaced with one
2225 character. If the syntax item does not have a custom
2226 replacement character defined (see |:syn-cchar|) the
2227 character defined in 'listchars' is used (default is a
2228 space).
2229 It is highlighted with the "Conceal" highlight group.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002230 2 Concealed text is completely hidden unless it has a
2231 custom replacement character defined (see
Bram Moolenaar477db062010-07-28 18:17:41 +02002232 |:syn-cchar|).
Bram Moolenaara7781e02010-07-19 20:13:22 +02002233 3 Concealed text is completely hidden.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002234
Bram Moolenaara7781e02010-07-19 20:13:22 +02002235 Note: in the cursor line concealed text is not hidden, so that you can
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002236 edit and copy the text. This can be changed with the 'concealcursor'
2237 option.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002238
Bram Moolenaar071d4272004-06-13 20:20:40 +00002239 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
2240'confirm' 'cf' boolean (default off)
2241 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002242 When 'confirm' is on, certain operations that would normally
2243 fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
2244 instead raise a |dialog| asking if you wish to save the current
2245 file(s). You can still use a ! to unconditionally |abandon| a buffer.
2246 If 'confirm' is off you can still activate confirmation for one
2247 command only (this is most useful in mappings) with the |:confirm|
2248 command.
2249 Also see the |confirm()| function and the 'v' flag in 'guioptions'.
2250
2251 *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
2252'conskey' 'consk' boolean (default off)
2253 global
Bram Moolenaarf3913272016-02-25 00:00:01 +01002254 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002255
2256 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
2257'copyindent' 'ci' boolean (default off)
2258 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002259 Copy the structure of the existing lines indent when autoindenting a
2260 new line. Normally the new indent is reconstructed by a series of
2261 tabs followed by spaces as required (unless |'expandtab'| is enabled,
2262 in which case only spaces are used). Enabling this option makes the
2263 new line copy whatever characters were used for indenting on the
Bram Moolenaar446cb832008-06-24 21:56:24 +00002264 existing line. 'expandtab' has no effect on these characters, a Tab
2265 remains a Tab. If the new indent is greater than on the existing
Bram Moolenaar071d4272004-06-13 20:20:40 +00002266 line, the remaining space is filled in the normal manner.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002267 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002268 Also see 'preserveindent'.
2269
Bram Moolenaare0fa3742016-02-20 15:47:01 +01002270 *'cpoptions'* *'cpo'* *cpo*
Illia Bobyr03d20aa2024-07-16 20:10:16 +02002271'cpoptions' 'cpo' string (Vim default: "aABceFsz",
2272 Vi default: all flags, except "#{|&/\."
h-east90e1fe42024-08-12 18:26:08 +02002273 |$VIM_POSIX|: all flags)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002274 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002275 A sequence of single character flags. When a character is present
Bram Moolenaar7cba6c02013-09-05 22:13:31 +02002276 this indicates Vi-compatible behavior. This is used for things where
2277 not being Vi-compatible is mostly or sometimes preferred.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002278 'cpoptions' stands for "compatible-options".
2279 Commas can be added for readability.
2280 To avoid problems with flags that are added in the future, use the
2281 "+=" and "-=" feature of ":set" |add-option-flags|.
Bram Moolenaar71eb3ad2021-12-26 12:07:30 +00002282
Bram Moolenaar071d4272004-06-13 20:20:40 +00002283 NOTE: This option is set to the Vi default value when 'compatible' is
2284 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar71eb3ad2021-12-26 12:07:30 +00002285
2286 NOTE: In a |Vim9| script, when `vim9script` is encountered, the value
2287 is saved, 'cpoptions' is set to the Vim default, and the saved value
2288 is restored at the end of the script. Changes to the value of
2289 'cpoptions' will be applied to the saved value, but keep in mind that
2290 removing a flag that is not present when 'cpoptions' is changed has no
2291 effect. In the |.vimrc| file the value is not restored, thus using
2292 `vim9script` in the |.vimrc| file results in using the Vim default.
2293
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002294 NOTE: This option is set to the POSIX default value at startup when
2295 the Vi default value would be used and the $VIM_POSIX environment
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002296 variable exists |posix|. This means Vim tries to behave like the
2297 POSIX specification.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002298
2299 contains behavior ~
2300 *cpo-a*
2301 a When included, a ":read" command with a file name
2302 argument will set the alternate file name for the
2303 current window.
2304 *cpo-A*
2305 A When included, a ":write" command with a file name
2306 argument will set the alternate file name for the
2307 current window.
2308 *cpo-b*
2309 b "\|" in a ":map" command is recognized as the end of
2310 the map command. The '\' is included in the mapping,
2311 the text after the '|' is interpreted as the next
2312 command. Use a CTRL-V instead of a backslash to
2313 include the '|' in the mapping. Applies to all
2314 mapping, abbreviation, menu and autocmd commands.
2315 See also |map_bar|.
2316 *cpo-B*
2317 B A backslash has no special meaning in mappings,
Bram Moolenaara9604e62018-07-21 05:56:22 +02002318 abbreviations, user commands and the "to" part of the
2319 menu commands. Remove this flag to be able to use a
2320 backslash like a CTRL-V. For example, the command
2321 ":map X \<Esc>" results in X being mapped to:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002322 'B' included: "\^[" (^[ is a real <Esc>)
2323 'B' excluded: "<Esc>" (5 characters)
2324 ('<' excluded in both cases)
2325 *cpo-c*
2326 c Searching continues at the end of any match at the
2327 cursor position, but not further than the start of the
2328 next line. When not present searching continues
2329 one character from the cursor position. With 'c'
2330 "abababababab" only gets three matches when repeating
2331 "/abab", without 'c' there are five matches.
2332 *cpo-C*
2333 C Do not concatenate sourced lines that start with a
2334 backslash. See |line-continuation|.
2335 *cpo-d*
2336 d Using "./" in the 'tags' option doesn't mean to use
2337 the tags file relative to the current file, but the
2338 tags file in the current directory.
2339 *cpo-D*
2340 D Can't use CTRL-K to enter a digraph after Normal mode
2341 commands with a character argument, like |r|, |f| and
2342 |t|.
2343 *cpo-e*
2344 e When executing a register with ":@r", always add a
2345 <CR> to the last line, also when the register is not
2346 linewise. If this flag is not present, the register
2347 is not linewise and the last line does not end in a
2348 <CR>, then the last line is put on the command-line
2349 and can be edited before hitting <CR>.
2350 *cpo-E*
2351 E It is an error when using "y", "d", "c", "g~", "gu" or
2352 "gU" on an Empty region. The operators only work when
Bram Moolenaar15142e22018-04-30 22:19:58 +02002353 at least one character is to be operated on. Example:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002354 This makes "y0" fail in the first column.
2355 *cpo-f*
2356 f When included, a ":read" command with a file name
2357 argument will set the file name for the current buffer,
2358 if the current buffer doesn't have a file name yet.
2359 *cpo-F*
2360 F When included, a ":write" command with a file name
2361 argument will set the file name for the current
2362 buffer, if the current buffer doesn't have a file name
Bram Moolenaarb3480382005-12-11 21:33:32 +00002363 yet. Also see |cpo-P|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002364 *cpo-g*
2365 g Goto line 1 when using ":edit" without argument.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002366 *cpo-H*
2367 H When using "I" on a line with only blanks, insert
2368 before the last blank. Without this flag insert after
2369 the last blank.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002370 *cpo-i*
2371 i When included, interrupting the reading of a file will
2372 leave it modified.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002373 *cpo-I*
2374 I When moving the cursor up or down just after inserting
2375 indent for 'autoindent', do not delete the indent.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002376 *cpo-j*
2377 j When joining lines, only add two spaces after a '.',
2378 not after '!' or '?'. Also see 'joinspaces'.
2379 *cpo-J*
2380 J A |sentence| has to be followed by two spaces after
Bram Moolenaar582fd852005-03-28 20:58:01 +00002381 the '.', '!' or '?'. A <Tab> is not recognized as
Bram Moolenaar071d4272004-06-13 20:20:40 +00002382 white space.
2383 *cpo-k*
2384 k Disable the recognition of raw key codes in
2385 mappings, abbreviations, and the "to" part of menu
2386 commands. For example, if <Key> sends ^[OA (where ^[
2387 is <Esc>), the command ":map X ^[OA" results in X
2388 being mapped to:
2389 'k' included: "^[OA" (3 characters)
2390 'k' excluded: "<Key>" (one key code)
2391 Also see the '<' flag below.
2392 *cpo-K*
2393 K Don't wait for a key code to complete when it is
2394 halfway a mapping. This breaks mapping <F1><F1> when
2395 only part of the second <F1> has been read. It
2396 enables cancelling the mapping by typing <F1><Esc>.
2397 *cpo-l*
2398 l Backslash in a [] range in a search pattern is taken
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002399 literally, only "\]", "\^", "\-" and "\\" are special.
2400 See |/[]|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002401 'l' included: "/[ \t]" finds <Space>, '\' and 't'
2402 'l' excluded: "/[ \t]" finds <Space> and <Tab>
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002403 Also see |cpo-\|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002404 *cpo-L*
2405 L When the 'list' option is set, 'wrapmargin',
2406 'textwidth', 'softtabstop' and Virtual Replace mode
2407 (see |gR|) count a <Tab> as two characters, instead of
2408 the normal behavior of a <Tab>.
2409 *cpo-m*
2410 m When included, a showmatch will always wait half a
2411 second. When not included, a showmatch will wait half
2412 a second or until a character is typed. |'showmatch'|
2413 *cpo-M*
2414 M When excluded, "%" matching will take backslashes into
2415 account. Thus in "( \( )" and "\( ( \)" the outer
2416 parenthesis match. When included "%" ignores
2417 backslashes, which is Vi compatible.
2418 *cpo-n*
Bram Moolenaar64486672010-05-16 15:46:46 +02002419 n When included, the column used for 'number' and
2420 'relativenumber' will also be used for text of wrapped
2421 lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002422 *cpo-o*
2423 o Line offset to search command is not remembered for
2424 next search.
2425 *cpo-O*
2426 O Don't complain if a file is being overwritten, even
2427 when it didn't exist when editing it. This is a
2428 protection against a file unexpectedly created by
2429 someone else. Vi didn't complain about this.
2430 *cpo-p*
2431 p Vi compatible Lisp indenting. When not present, a
2432 slightly better algorithm is used.
Bram Moolenaarb3480382005-12-11 21:33:32 +00002433 *cpo-P*
2434 P When included, a ":write" command that appends to a
2435 file will set the file name for the current buffer, if
2436 the current buffer doesn't have a file name yet and
2437 the 'F' flag is also included |cpo-F|.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002438 *cpo-q*
2439 q When joining multiple lines leave the cursor at the
2440 position where it would be when joining two lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002441 *cpo-r*
2442 r Redo ("." command) uses "/" to repeat a search
2443 command, instead of the actually used search string.
2444 *cpo-R*
2445 R Remove marks from filtered lines. Without this flag
2446 marks are kept like |:keepmarks| was used.
2447 *cpo-s*
2448 s Set buffer options when entering the buffer for the
2449 first time. This is like it is in Vim version 3.0.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002450 And it is the default. If not present the options are
Bram Moolenaar071d4272004-06-13 20:20:40 +00002451 set when the buffer is created.
2452 *cpo-S*
2453 S Set buffer options always when entering a buffer
2454 (except 'readonly', 'fileformat', 'filetype' and
2455 'syntax'). This is the (most) Vi compatible setting.
2456 The options are set to the values in the current
2457 buffer. When you change an option and go to another
2458 buffer, the value is copied. Effectively makes the
2459 buffer options global to all buffers.
2460
2461 's' 'S' copy buffer options
2462 no no when buffer created
2463 yes no when buffer first entered (default)
2464 X yes each time when buffer entered (vi comp.)
2465 *cpo-t*
2466 t Search pattern for the tag command is remembered for
2467 "n" command. Otherwise Vim only puts the pattern in
2468 the history for search pattern, but doesn't change the
2469 last used search pattern.
2470 *cpo-u*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002471 u Undo is Vi compatible. See |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002472 *cpo-v*
2473 v Backspaced characters remain visible on the screen in
2474 Insert mode. Without this flag the characters are
2475 erased from the screen right away. With this flag the
2476 screen newly typed text overwrites backspaced
2477 characters.
2478 *cpo-w*
2479 w When using "cw" on a blank character, only change one
2480 character and not all blanks until the start of the
2481 next word.
2482 *cpo-W*
2483 W Don't overwrite a readonly file. When omitted, ":w!"
2484 overwrites a readonly file, if possible.
2485 *cpo-x*
2486 x <Esc> on the command-line executes the command-line.
2487 The default in Vim is to abandon the command-line,
2488 because <Esc> normally aborts a command. |c_<Esc>|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002489 *cpo-X*
2490 X When using a count with "R" the replaced text is
2491 deleted only once. Also when repeating "R" with "."
2492 and a count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002493 *cpo-y*
Bram Moolenaard09091d2019-01-17 16:07:22 +01002494 y A yank command can be redone with ".". Think twice if
2495 you really want to use this, it may break some
2496 plugins, since most people expect "." to only repeat a
2497 change.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002498 *cpo-Z*
2499 Z When using "w!" while the 'readonly' option is set,
2500 don't reset 'readonly'.
Christian Brabandt22105fd2024-07-15 20:51:11 +02002501 *cpo-z*
2502 z Special casing the "cw" and "d" command (see |cw| and
2503 |d-special|).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002504 *cpo-!*
2505 ! When redoing a filter command, use the last used
2506 external command, whatever it was. Otherwise the last
2507 used -filter- command is used.
2508 *cpo-$*
2509 $ When making a change to one line, don't redisplay the
2510 line, but put a '$' at the end of the changed text.
2511 The changed text will be overwritten when you type the
2512 new text. The line is redisplayed if you type any
2513 command that moves the cursor from the insertion
2514 point.
2515 *cpo-%*
2516 % Vi-compatible matching is done for the "%" command.
2517 Does not recognize "#if", "#endif", etc.
2518 Does not recognize "/*" and "*/".
2519 Parens inside single and double quotes are also
2520 counted, causing a string that contains a paren to
2521 disturb the matching. For example, in a line like
2522 "if (strcmp("foo(", s))" the first paren does not
2523 match the last one. When this flag is not included,
2524 parens inside single and double quotes are treated
2525 specially. When matching a paren outside of quotes,
2526 everything inside quotes is ignored. When matching a
2527 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002528 there is one). This works very well for C programs.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002529 This flag is also used for other features, such as
2530 C-indenting.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002531 *cpo--*
2532 - When included, a vertical movement command fails when
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002533 it would go above the first line or below the last
2534 line. Without it the cursor moves to the first or
2535 last line, unless it already was in that line.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002536 Applies to the commands "-", "k", CTRL-P, "+", "j",
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002537 CTRL-N, CTRL-J and ":1234".
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002538 *cpo-+*
2539 + When included, a ":write file" command will reset the
2540 'modified' flag of the buffer, even though the buffer
2541 itself may still be different from its file.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002542 *cpo-star*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002543 * Use ":*" in the same way as ":@". When not included,
2544 ":*" is an alias for ":'<,'>", select the Visual area.
2545 *cpo-<*
2546 < Disable the recognition of special key codes in |<>|
2547 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002548 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00002549 ":map X <Tab>" results in X being mapped to:
2550 '<' included: "<Tab>" (5 characters)
2551 '<' excluded: "^I" (^I is a real <Tab>)
2552 Also see the 'k' flag above.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002553 *cpo->*
2554 > When appending to a register, put a line break before
2555 the appended text.
Bram Moolenaar8b3e0332011-06-26 05:36:34 +02002556 *cpo-;*
2557 ; When using |,| or |;| to repeat the last |t| search
2558 and the cursor is right in front of the searched
2559 character, the cursor won't move. When not included,
2560 the cursor would skip over it and jump to the
Bram Moolenaarc8734422012-06-01 22:38:45 +02002561 following occurrence.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002562
2563 POSIX flags. These are not included in the Vi default value, except
2564 when $VIM_POSIX was set on startup. |posix|
2565
2566 contains behavior ~
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002567 *cpo-#*
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002568 # A count before "D", "o" and "O" has no effect.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002569 *cpo-&*
2570 & When ":preserve" was used keep the swap file when
2571 exiting normally while this buffer is still loaded.
2572 This flag is tested when exiting.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002573 *cpo-\*
2574 \ Backslash in a [] range in a search pattern is taken
2575 literally, only "\]" is special See |/[]|
Bram Moolenaar90915b52005-08-21 22:17:52 +00002576 '\' included: "/[ \-]" finds <Space>, '\' and '-'
2577 '\' excluded: "/[ \-]" finds <Space> and '-'
2578 Also see |cpo-l|.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002579 *cpo-/*
2580 / When "%" is used as the replacement string in a |:s|
2581 command, use the previous replacement string. |:s%|
2582 *cpo-{*
2583 { The |{| and |}| commands also stop at a "{" character
2584 at the start of a line.
2585 *cpo-.*
2586 . The ":chdir" and ":cd" commands fail if the current
2587 buffer is modified, unless ! is used. Vim doesn't
2588 need this, since it remembers the full path of an
2589 opened file.
2590 *cpo-bar*
2591 | The value of the $LINES and $COLUMNS environment
2592 variables overrule the terminal size values obtained
2593 with system specific functions.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002594
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002595 *'cryptmethod'* *'cm'*
Bram Moolenaara86187b2018-12-16 18:20:00 +01002596'cryptmethod' 'cm' string (default "blowfish2")
Bram Moolenaar49771f42010-07-20 17:32:38 +02002597 global or local to buffer |global-local|
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002598 Method used for encryption when the buffer is written to a file:
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002599 *pkzip*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002600 zip PkZip compatible method. A weak kind of encryption.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002601 Backwards compatible with Vim 7.2 and older.
Christian Brabandtaae58342023-04-23 17:50:22 +01002602 Only use if you need to be backwards compatible.
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002603 *blowfish*
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002604 blowfish Blowfish method. Medium strong encryption but it has
2605 an implementation flaw. Requires Vim 7.3 or later,
2606 files can NOT be read by Vim 7.2 and older. This adds
2607 a "seed" to the file, every time you write the file
2608 the encrypted bytes will be different.
Christian Brabandtaae58342023-04-23 17:50:22 +01002609 Obsolete, please do no longer use.
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002610 *blowfish2*
2611 blowfish2 Blowfish method. Medium strong encryption. Requires
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01002612 Vim 7.4.401 or later, files can NOT be read by Vim 7.3
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002613 and older. This adds a "seed" to the file, every time
2614 you write the file the encrypted bytes will be
2615 different. The whole undo file is encrypted, not just
2616 the pieces of text.
Bram Moolenaara2baa732022-02-04 16:09:54 +00002617 *E1193* *E1194* *E1195* *E1196* *E1230*
Christian Brabandtf573c6e2021-06-20 14:02:16 +02002618 *E1197* *E1198* *E1199* *E1200* *E1201*
2619 xchacha20 XChaCha20 Cipher with Poly1305 Message Authentication
2620 Code. Medium strong till strong encryption.
2621 Encryption is provided by the libsodium library, it
Bram Moolenaar22863042021-10-16 15:23:36 +01002622 requires Vim to be built with |+sodium|.
Christian Brabandtf573c6e2021-06-20 14:02:16 +02002623 It adds a seed and a message authentication code (MAC)
2624 to the file. This needs at least a Vim 8.2.3022 to
2625 read the encrypted file.
2626 Encryption of swap files is not supported, therefore
2627 no swap file will be used when xchacha20 encryption is
2628 enabled.
2629 Encryption of undo files is not yet supported,
2630 therefore no undo file will currently be written.
Christian Brabandtaae58342023-04-23 17:50:22 +01002631 CAREFUL: Files written with this method might have to
2632 be read back with the same version of Vim if the
2633 binary format changes later.
2634 Obsolete, please do no longer use.
2635 xchacha20v2 Same algorithm as with "xchacha20" that correctly
2636 stores the key derivation parameters together with the
2637 encrypted file. Should work better in case the
2638 parameters in the libsodium library ever change.
2639 STILL EXPERIMENTAL: Files written with this method
Christian Brabandtf573c6e2021-06-20 14:02:16 +02002640 might have to be read back with the same version of
2641 Vim if the binary format changes later.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002642
Christian Brabandtaae58342023-04-23 17:50:22 +01002643 You should use "blowfish2", also to re-encrypt older files. The
2644 "xchacha20" method provides better encryption, but it does not work
2645 with all versions of Vim.
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01002646
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002647 When reading an encrypted file 'cryptmethod' will be set automatically
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002648 to the detected method of the file being read. Thus if you write it
2649 without changing 'cryptmethod' the same method will be used.
2650 Changing 'cryptmethod' does not mark the file as modified, you have to
Bram Moolenaar49771f42010-07-20 17:32:38 +02002651 explicitly write it, you don't get a warning unless there are other
2652 modifications. Also see |:X|.
2653
2654 When setting the global value to an empty string, it will end up with
Bram Moolenaara86187b2018-12-16 18:20:00 +01002655 the value "blowfish2". When setting the local value to an empty
2656 string the buffer will use the global value.
Bram Moolenaar49771f42010-07-20 17:32:38 +02002657
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002658 When a new encryption method is added in a later version of Vim, and
2659 the current version does not recognize it, you will get *E821* .
Bram Moolenaar49771f42010-07-20 17:32:38 +02002660 You need to edit this file with the later version of Vim.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002661
Bram Moolenaar071d4272004-06-13 20:20:40 +00002662 *'cscopepathcomp'* *'cspc'*
2663'cscopepathcomp' 'cspc' number (default 0)
2664 global
2665 {not available when compiled without the |+cscope|
2666 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002667 Determines how many components of the path to show in a list of tags.
2668 See |cscopepathcomp|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002669 NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002670
2671 *'cscopeprg'* *'csprg'*
2672'cscopeprg' 'csprg' string (default "cscope")
2673 global
2674 {not available when compiled without the |+cscope|
2675 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002676 Specifies the command to execute cscope. See |cscopeprg|.
2677 This option cannot be set from a |modeline| or in the |sandbox|, for
2678 security reasons.
2679
2680 *'cscopequickfix'* *'csqf'*
2681'cscopequickfix' 'csqf' string (default "")
2682 global
2683 {not available when compiled without the |+cscope|
2684 or |+quickfix| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002685 Specifies whether to use quickfix window to show cscope results.
2686 See |cscopequickfix|.
2687
Bram Moolenaarec7944a2013-06-12 21:29:15 +02002688 *'cscoperelative'* *'csre'* *'nocscoperelative'* *'nocsre'*
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002689'cscoperelative' 'csre' boolean (default off)
2690 global
2691 {not available when compiled without the |+cscope|
2692 feature}
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002693 In the absence of a prefix (-P) for cscope. setting this option enables
2694 to use the basename of cscope.out path as the prefix.
2695 See |cscoperelative|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002696 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002697
Bram Moolenaar071d4272004-06-13 20:20:40 +00002698 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
2699'cscopetag' 'cst' boolean (default off)
2700 global
2701 {not available when compiled without the |+cscope|
2702 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002703 Use cscope for tag commands. See |cscope-options|.
2704 NOTE: This option is reset when 'compatible' is set.
2705
2706 *'cscopetagorder'* *'csto'*
2707'cscopetagorder' 'csto' number (default 0)
2708 global
2709 {not available when compiled without the |+cscope|
2710 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002711 Determines the order in which ":cstag" performs a search. See
2712 |cscopetagorder|.
2713 NOTE: This option is set to 0 when 'compatible' is set.
2714
2715 *'cscopeverbose'* *'csverb'*
2716 *'nocscopeverbose'* *'nocsverb'*
2717'cscopeverbose' 'csverb' boolean (default off)
2718 global
2719 {not available when compiled without the |+cscope|
2720 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002721 Give messages when adding a cscope database. See |cscopeverbose|.
2722 NOTE: This option is reset when 'compatible' is set.
2723
Bram Moolenaar860cae12010-06-05 23:22:07 +02002724 *'cursorbind'* *'crb'* *'nocursorbind'* *'nocrb'*
2725'cursorbind' 'crb' boolean (default off)
2726 local to window
Bram Moolenaar860cae12010-06-05 23:22:07 +02002727 When this option is set, as the cursor in the current
2728 window moves other cursorbound windows (windows that also have
2729 this option set) move their cursors to the corresponding line and
2730 column. This option is useful for viewing the
2731 differences between two versions of a file (see 'diff'); in diff mode,
2732 inserted and deleted lines (though not characters within a line) are
Bram Moolenaar1a384422010-07-14 19:53:30 +02002733 taken into account.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002734
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002735 *'cursorcolumn'* *'cuc'* *'nocursorcolumn'* *'nocuc'*
2736'cursorcolumn' 'cuc' boolean (default off)
2737 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02002738 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002739 feature}
2740 Highlight the screen column of the cursor with CursorColumn
2741 |hl-CursorColumn|. Useful to align text. Will make screen redrawing
2742 slower.
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00002743 If you only want the highlighting in the current window you can use
2744 these autocommands: >
2745 au WinLeave * set nocursorline nocursorcolumn
2746 au WinEnter * set cursorline cursorcolumn
2747<
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002748
2749 *'cursorline'* *'cul'* *'nocursorline'* *'nocul'*
2750'cursorline' 'cul' boolean (default off)
2751 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02002752 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002753 feature}
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002754 Highlight the text line of the cursor with CursorLine |hl-CursorLine|.
2755 Useful to easily spot the cursor. Will make screen redrawing slower.
Bram Moolenaare2f98b92006-03-29 21:18:24 +00002756 When Visual mode is active the highlighting isn't used to make it
Bram Moolenaar779b74b2006-04-10 14:55:34 +00002757 easier to see the selected text.
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002758
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002759 *'cursorlineopt'* *'culopt'*
Bram Moolenaar017ba072019-09-14 21:01:23 +02002760'cursorlineopt' 'culopt' string (default: "number,line")
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002761 local to window
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002762 {not available when compiled without the |+syntax|
2763 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01002764 Comma-separated list of settings for how 'cursorline' is displayed.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002765 Valid values:
2766 "line" Highlight the text line of the cursor with
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002767 CursorLine |hl-CursorLine|.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002768 "screenline" Highlight only the screen line of the cursor with
2769 CursorLine |hl-CursorLine|.
2770 "number" Highlight the line number of the cursor with
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002771 CursorLineNr |hl-CursorLineNr|.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002772
2773 Special value:
2774 "both" Alias for the values "line,number".
2775
2776 "line" and "screenline" cannot be used together.
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002777
Bram Moolenaar071d4272004-06-13 20:20:40 +00002778 *'debug'*
2779'debug' string (default "")
2780 global
Bram Moolenaar57657d82006-04-21 22:12:41 +00002781 These values can be used:
2782 msg Error messages that would otherwise be omitted will be given
2783 anyway.
2784 throw Error messages that would otherwise be omitted will be given
2785 anyway and also throw an exception and set |v:errmsg|.
2786 beep A message will be given when otherwise only a beep would be
2787 produced.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002788 The values can be combined, separated by a comma.
Bram Moolenaar57657d82006-04-21 22:12:41 +00002789 "msg" and "throw" are useful for debugging 'foldexpr', 'formatexpr' or
2790 'indentexpr'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002791
2792 *'define'* *'def'*
2793'define' 'def' string (default "^\s*#\s*define")
2794 global or local to buffer |global-local|
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002795 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002796 pattern, just like for the "/" command. This option is used for the
2797 commands like "[i" and "[d" |include-search|. The 'isident' option is
2798 used to recognize the defined name after the match:
2799 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2800 See |option-backslash| about inserting backslashes to include a space
2801 or backslash.
2802 The default value is for C programs. For C++ this value would be
2803 useful, to include const type declarations: >
2804 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
Bram Moolenaar63b74a82019-03-24 15:09:13 +01002805< You can also use "\ze" just before the name and continue the pattern
2806 to check what is following. E.g. for Javascript, if a function is
2807 defined with "func_name = function(args)": >
2808 ^\s*\ze\i\+\s*=\s*function(
2809< If the function is defined with "func_name : function() {...": >
2810 ^\s*\ze\i\+\s*[:]\s*(*function\s*(
Bram Moolenaar071d4272004-06-13 20:20:40 +00002811< When using the ":set" command, you need to double the backslashes!
Bram Moolenaar63b74a82019-03-24 15:09:13 +01002812 To avoid that use `:let` with a single quote string: >
2813 let &l:define = '^\s*\ze\k\+\s*=\s*function('
Bram Moolenaar911ead12019-04-21 00:03:35 +02002814<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002815
2816 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2817'delcombine' 'deco' boolean (default off)
2818 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002819 If editing Unicode and this option is set, backspace and Normal mode
2820 "x" delete each combining character on its own. When it is off (the
2821 default) the character along with its combining characters are
2822 deleted.
Bram Moolenaar4f4d51a2020-10-11 13:57:40 +02002823 Note: When 'delcombine' is set "xx" may work differently from "2x"!
Bram Moolenaar071d4272004-06-13 20:20:40 +00002824
2825 This is useful for Arabic, Hebrew and many other languages where one
2826 may have combining characters overtop of base characters, and want
2827 to remove only the combining ones.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002828 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002829
2830 *'dictionary'* *'dict'*
2831'dictionary' 'dict' string (default "")
2832 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002833 List of file names, separated by commas, that are used to lookup words
2834 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2835 contain a list of words. This can be one word per line, or several
2836 words per line, separated by non-keyword characters (white space is
2837 preferred). Maximum line length is 510 bytes.
Bram Moolenaar259f26a2018-05-15 22:25:40 +02002838
2839 When this option is empty or an entry "spell" is present, and spell
2840 checking is enabled, words in the word lists for the currently active
2841 'spelllang' are used. See |spell|.
2842
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002843 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002844 after a comma are ignored, otherwise spaces are included in the file
2845 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002846 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002847 Where to find a list of words?
2848 - On FreeBSD, there is the file "/usr/share/dict/words".
2849 - In the Simtel archive, look in the "msdos/linguist" directory.
2850 - In "miscfiles" of the GNU collection.
2851 The use of |:set+=| and |:set-=| is preferred when adding or removing
2852 directories from the list. This avoids problems when a future version
2853 uses another default.
2854 Backticks cannot be used in this option for security reasons.
2855
2856 *'diff'* *'nodiff'*
2857'diff' boolean (default off)
2858 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00002859 {not available when compiled without the |+diff|
2860 feature}
2861 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002862 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002863
2864 *'dex'* *'diffexpr'*
2865'diffexpr' 'dex' string (default "")
2866 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002867 {not available when compiled without the |+diff|
2868 feature}
Bram Moolenaare828b762018-09-10 17:51:58 +02002869 Expression which is evaluated to obtain a diff file (either ed-style
2870 or unified-style) from two versions of a file. See |diff-diffexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002871 This option cannot be set from a |modeline| or in the |sandbox|, for
2872 security reasons.
2873
2874 *'dip'* *'diffopt'*
Bram Moolenaarc8234772019-11-10 21:00:27 +01002875'diffopt' 'dip' string (default "internal,filler,closeoff")
Bram Moolenaar071d4272004-06-13 20:20:40 +00002876 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002877 {not available when compiled without the |+diff|
2878 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002879 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002880 All are optional. Items must be separated by a comma.
2881
2882 filler Show filler lines, to keep the text
2883 synchronized with a window that has inserted
2884 lines at the same position. Mostly useful
2885 when windows are side-by-side and 'scrollbind'
2886 is set.
2887
2888 context:{n} Use a context of {n} lines between a change
2889 and a fold that contains unchanged lines.
2890 When omitted a context of six lines is used.
Bram Moolenaarf6b40102019-02-22 15:24:03 +01002891 When using zero the context is actually one,
2892 since folds require a line in between, also
dundargoc20f48d52023-10-02 21:49:23 +02002893 for a deleted line. Set it to a very large
2894 value (999999) to disable folding completely.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002895 See |fold-diff|.
2896
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002897 iblank Ignore changes where lines are all blank. Adds
2898 the "-B" flag to the "diff" command if
2899 'diffexpr' is empty. Check the documentation
2900 of the "diff" command for what this does
2901 exactly.
2902 NOTE: the diff windows will get out of sync,
2903 because no differences between blank lines are
2904 taken into account.
2905
Bram Moolenaar071d4272004-06-13 20:20:40 +00002906 icase Ignore changes in case of text. "a" and "A"
2907 are considered the same. Adds the "-i" flag
2908 to the "diff" command if 'diffexpr' is empty.
2909
2910 iwhite Ignore changes in amount of white space. Adds
2911 the "-b" flag to the "diff" command if
2912 'diffexpr' is empty. Check the documentation
2913 of the "diff" command for what this does
2914 exactly. It should ignore adding trailing
2915 white space, but not leading white space.
2916
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002917 iwhiteall Ignore all white space changes. Adds
2918 the "-w" flag to the "diff" command if
2919 'diffexpr' is empty. Check the documentation
2920 of the "diff" command for what this does
2921 exactly.
2922
2923 iwhiteeol Ignore white space changes at end of line.
2924 Adds the "-Z" flag to the "diff" command if
2925 'diffexpr' is empty. Check the documentation
2926 of the "diff" command for what this does
2927 exactly.
2928
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002929 horizontal Start diff mode with horizontal splits (unless
2930 explicitly specified otherwise).
2931
2932 vertical Start diff mode with vertical splits (unless
2933 explicitly specified otherwise).
2934
Bram Moolenaarc8234772019-11-10 21:00:27 +01002935 closeoff When a window is closed where 'diff' is set
2936 and there is only one window remaining in the
2937 same tab page with 'diff' set, execute
2938 `:diffoff` in that window. This undoes a
2939 `:diffsplit` command.
2940
Bram Moolenaar97ce4192017-12-01 20:35:58 +01002941 hiddenoff Do not use diff mode for a buffer when it
2942 becomes hidden.
2943
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002944 foldcolumn:{n} Set the 'foldcolumn' option to {n} when
2945 starting diff mode. Without this 2 is used.
2946
Bram Moolenaar4223d432021-02-10 13:18:17 +01002947 followwrap Follow the 'wrap' option and leave as it is.
2948
Bram Moolenaare828b762018-09-10 17:51:58 +02002949 internal Use the internal diff library. This is
2950 ignored when 'diffexpr' is set. *E960*
2951 When running out of memory when writing a
2952 buffer this item will be ignored for diffs
2953 involving that buffer. Set the 'verbose'
2954 option to see when this happens.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002955
Bram Moolenaare828b762018-09-10 17:51:58 +02002956 indent-heuristic
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01002957 Use the indent heuristic for the internal
2958 diff library.
Bram Moolenaare828b762018-09-10 17:51:58 +02002959
zeertzjqd086b8f2024-02-25 15:42:52 +08002960 algorithm:{text} Use the specified diff algorithm with the
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01002961 internal diff engine. Currently supported
Bram Moolenaare828b762018-09-10 17:51:58 +02002962 algorithms are:
2963 myers the default algorithm
2964 minimal spend extra time to generate the
2965 smallest possible diff
2966 patience patience diff algorithm
2967 histogram histogram diff algorithm
2968
2969 Examples: >
2970 :set diffopt=internal,filler,context:4
Bram Moolenaar071d4272004-06-13 20:20:40 +00002971 :set diffopt=
Bram Moolenaare828b762018-09-10 17:51:58 +02002972 :set diffopt=internal,filler,foldcolumn:3
2973 :set diffopt-=internal " do NOT use the internal diff parser
Bram Moolenaar071d4272004-06-13 20:20:40 +00002974<
2975 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
2976'digraph' 'dg' boolean (default off)
2977 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002978 {not available when compiled without the |+digraphs|
2979 feature}
2980 Enable the entering of digraphs in Insert mode with {char1} <BS>
2981 {char2}. See |digraphs|.
2982 NOTE: This option is reset when 'compatible' is set.
2983
2984 *'directory'* *'dir'*
2985'directory' 'dir' string (default for Amiga: ".,t:",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01002986 for Win32: ".,$TEMP,c:\tmp,c:\temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00002987 for Unix: ".,~/tmp,/var/tmp,/tmp")
2988 global
2989 List of directory names for the swap file, separated with commas.
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02002990 Recommended value: ".,~/vimswap//" - this will put the swap file next
2991 to the edited file if possible, and in your personal swap directory
2992 otherwise. Make sure "~/vimswap//" is only readable for you.
2993
2994 Possible items:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002995 - The swap file will be created in the first directory where this is
2996 possible.
2997 - Empty means that no swap file will be used (recovery is
Bram Moolenaar00e192b2019-10-19 17:01:28 +02002998 impossible!) and no |E303| error will be given.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002999 - A directory "." means to put the swap file in the same directory as
3000 the edited file. On Unix, a dot is prepended to the file name, so
3001 it doesn't show in a directory listing. On MS-Windows the "hidden"
3002 attribute is set and a dot prepended if possible.
Bram Moolenaar8024f932020-01-14 19:29:13 +01003003 - A directory starting with "./" (or ".\" for MS-Windows) means to put
3004 the swap file relative to where the edited file is. The leading "."
3005 is replaced with the path name of the edited file.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02003006 - For Unix and Win32, if a directory ends in two path separators "//",
3007 the swap file name will be built from the complete path to the file
Bram Moolenaar207f0092020-08-30 17:20:20 +02003008 with all path separators replaced by percent '%' signs (including
3009 the colon following the drive letter on Win32). This will ensure
3010 file name uniqueness in the preserve directory.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02003011 On Win32, it is also possible to end with "\\". However, When a
3012 separating comma is following, you must use "//", since "\\" will
3013 include the comma in the file name. Therefore it is recommended to
3014 use '//', instead of '\\'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003015 - Spaces after the comma are ignored, other spaces are considered part
3016 of the directory name. To have a space at the start of a directory
3017 name, precede it with a backslash.
3018 - To include a comma in a directory name precede it with a backslash.
3019 - A directory name may end in an ':' or '/'.
3020 - Environment variables are expanded |:set_env|.
3021 - Careful with '\' characters, type one before a space, type two to
3022 get one in the option (see |option-backslash|), for example: >
3023 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
3024< - For backwards compatibility with Vim version 3.0 a '>' at the start
3025 of the option is removed.
3026 Using "." first in the list is recommended. This means that editing
3027 the same file twice will result in a warning. Using "/tmp" on Unix is
3028 discouraged: When the system crashes you lose the swap file.
3029 "/var/tmp" is often not cleared when rebooting, thus is a better
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02003030 choice than "/tmp". But others on the computer may be able to see the
3031 files, and it can contain a lot of files, your swap files get lost in
3032 the crowd. That is why a "tmp" directory in your home directory is
3033 tried first.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003034 The use of |:set+=| and |:set-=| is preferred when adding or removing
3035 directories from the list. This avoids problems when a future version
3036 uses another default.
3037 This option cannot be set from a |modeline| or in the |sandbox|, for
3038 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003039
3040 *'display'* *'dy'*
Bram Moolenaarbc8801c2016-08-02 21:04:33 +02003041'display' 'dy' string (default "", set to "truncate" in
3042 |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003043 global
Bram Moolenaarf269eab2022-10-03 18:04:35 +01003044 Change the way text is displayed. This is a comma-separated list of
Bram Moolenaar071d4272004-06-13 20:20:40 +00003045 flags:
3046 lastline When included, as much as possible of the last line
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02003047 in a window will be displayed. "@@@" is put in the
3048 last columns of the last screen line to indicate the
3049 rest of the line is not displayed.
3050 truncate Like "lastline", but "@@@" is displayed in the first
3051 column of the last screen line. Overrules "lastline".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003052 uhex Show unprintable characters hexadecimal as <xx>
3053 instead of using ^C and ~C.
3054
Bram Moolenaard0796902016-09-16 20:02:31 +02003055 When neither "lastline" nor "truncate" is included, a last line that
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02003056 doesn't fit is replaced with "@" lines.
3057
Bram Moolenaar4ba5f1d2022-10-04 14:36:29 +01003058 The "@" character can be changed by setting the "lastline" item in
3059 'fillchars'. The character is highlighted with |hl-NonText|.
3060
Bram Moolenaar071d4272004-06-13 20:20:40 +00003061 *'eadirection'* *'ead'*
3062'eadirection' 'ead' string (default "both")
3063 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003064 Tells when the 'equalalways' option applies:
3065 ver vertically, width of windows is not affected
3066 hor horizontally, height of windows is not affected
3067 both width and height of windows is affected
3068
3069 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
3070'edcompatible' 'ed' boolean (default off)
3071 global
3072 Makes the 'g' and 'c' flags of the ":substitute" command to be
3073 toggled each time the flag is given. See |complex-change|. See
3074 also 'gdefault' option.
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +02003075 Switching this option on may break plugins!
Bram Moolenaar4072ba52020-12-23 13:56:35 +01003076 This option is not used in |Vim9| script.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003077
Bram Moolenaar03413f42016-04-12 21:07:15 +02003078 *'emoji'* *'emo'* *'noemoji'* *'noemo'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01003079'emoji' 'emo' boolean (default: on)
3080 global
Bram Moolenaar3848e002016-03-19 18:42:29 +01003081 When on all Unicode emoji characters are considered to be full width.
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02003082 This excludes "text emoji" characters, which are normally displayed as
3083 single width. Unfortunately there is no good specification for this
3084 and it has been determined on trial-and-error basis. Use the
3085 |setcellwidths()| function to change the behavior.
Bram Moolenaar3848e002016-03-19 18:42:29 +01003086
Bram Moolenaar071d4272004-06-13 20:20:40 +00003087 *'encoding'* *'enc'* *E543*
K.Takataf883d902021-05-30 18:04:19 +02003088'encoding' 'enc' string (default for MS-Windows: "utf-8",
3089 otherwise: value from $LANG or "latin1")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003090 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003091 Sets the character encoding used inside Vim. It applies to text in
3092 the buffers, registers, Strings in expressions, text stored in the
3093 viminfo file, etc. It sets the kind of characters which Vim can work
3094 with. See |encoding-names| for the possible values.
3095
3096 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003097 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003098 It should normally be kept at its default value, or set when Vim
Bram Moolenaar02467872007-05-06 13:22:01 +00003099 starts up. See |multibyte|. To reload the menus see |:menutrans|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003100
Bram Moolenaar865242e2010-07-14 21:12:05 +02003101 This option cannot be set from a |modeline|. It would most likely
3102 corrupt the text.
3103
Bram Moolenaar3df01732017-02-17 22:47:16 +01003104 NOTE: For GTK+ 2 or later, it is highly recommended to set 'encoding'
3105 to "utf-8". Although care has been taken to allow different values of
Bram Moolenaar071d4272004-06-13 20:20:40 +00003106 'encoding', "utf-8" is the natural choice for the environment and
3107 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003108 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00003109 versions, and to avoid changing the encoding of newly created files
3110 without your knowledge (in case 'fileencodings' is empty).
3111
3112 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003113 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00003114 iconv() or as specified with 'charconvert'.
3115
Bram Moolenaar207f0092020-08-30 17:20:20 +02003116 If you need to know whether 'encoding' is a multibyte encoding, you
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003117 can use: >
3118 if has("multi_byte_encoding")
3119<
Bram Moolenaar071d4272004-06-13 20:20:40 +00003120 Normally 'encoding' will be equal to your current locale. This will
3121 be the default if Vim recognizes your environment settings. If
3122 'encoding' is not set to the current locale, 'termencoding' must be
3123 set to convert typed and displayed text. See |encoding-table|.
3124
3125 When you set this option, it fires the |EncodingChanged| autocommand
3126 event so that you can set up fonts if necessary.
3127
3128 When the option is set, the value is converted to lowercase. Thus
3129 you can set it with uppercase values too. Underscores are translated
3130 to '-' signs.
3131 When the encoding is recognized, it is changed to the standard name.
3132 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
3133 "iso-8859-2" and "utf8" becomes "utf-8".
3134
3135 Note: "latin1" is also used when the encoding could not be detected.
3136 This only works when editing files in the same encoding! When the
3137 actual character set is not latin1, make sure 'fileencoding' and
3138 'fileencodings' are empty. When conversion is needed, switch to using
3139 utf-8.
3140
3141 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
3142 You don't notice this while editing, but it does matter for the
3143 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
3144 setting 'encoding' to one of these values instead of utf-8 only has
3145 effect for encoding used for files when 'fileencoding' is empty.
3146
Bram Moolenaar661b1822005-07-28 22:36:45 +00003147 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
3148 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003149
Bram Moolenaar6ebe4f92022-10-28 20:47:54 +01003150 *'endoffile'* *'eof'* *'noendoffile'* *'noeof'*
Bram Moolenaar0aad88f2022-11-12 11:54:26 +00003151'endoffile' 'eof' boolean (default off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003152 local to buffer
Bram Moolenaar6ebe4f92022-10-28 20:47:54 +01003153 Indicates that a CTRL-Z character was found at the end of the file
3154 when reading it. Normally only happens when 'fileformat' is "dos".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003155 When writing a file and this option is off and the 'binary' option
Bram Moolenaar6ebe4f92022-10-28 20:47:54 +01003156 is on, or 'fixeol' option is off, no CTRL-Z will be written at the
Bram Moolenaarfb0cf232022-10-22 11:25:19 +01003157 end of the file.
K.Takata3af98212022-11-01 20:36:19 +00003158 See |eol-and-eof| for example settings.
Bram Moolenaarfb0cf232022-10-22 11:25:19 +01003159
3160 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
3161'endofline' 'eol' boolean (default on)
3162 local to buffer
3163 When writing a file and this option is off and the 'binary' option
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003164 is on, or 'fixeol' option is off, no <EOL> will be written for the
3165 last line in the file. This option is automatically set or reset when
3166 starting to edit a new file, depending on whether file has an <EOL>
3167 for the last line in the file. Normally you don't have to set or
3168 reset this option.
3169 When 'binary' is off and 'fixeol' is on the value is not used when
3170 writing the file. When 'binary' is on or 'fixeol' is off it is used
3171 to remember the presence of a <EOL> for the last line in the file, so
3172 that when you write the file the situation from the original file can
3173 be kept. But you can change it if you want to.
K.Takata3af98212022-11-01 20:36:19 +00003174 See |eol-and-eof| for example settings.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003175
3176 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
3177'equalalways' 'ea' boolean (default on)
3178 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003179 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00003180 splitting or closing a window. This also happens the moment the
3181 option is switched on. When off, splitting a window will reduce the
3182 size of the current window and leave the other windows the same. When
3183 closing a window the extra lines are given to the window next to it
3184 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00003185 When mixing vertically and horizontally split windows, a minimal size
3186 is computed and some windows may be larger if there is room. The
3187 'eadirection' option tells in which direction the size is affected.
Bram Moolenaar67f71312007-08-12 14:55:56 +00003188 Changing the height and width of a window can be avoided by setting
3189 'winfixheight' and 'winfixwidth', respectively.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003190 If a window size is specified when creating a new window sizes are
3191 currently not equalized (it's complicated, but may be implemented in
3192 the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +00003193
3194 *'equalprg'* *'ep'*
3195'equalprg' 'ep' string (default "")
3196 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003197 External program to use for "=" command. When this option is empty
Bram Moolenaar446cb832008-06-24 21:56:24 +00003198 the internal formatting functions are used; either 'lisp', 'cindent'
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003199 or 'indentexpr'. When Vim was compiled without internal formatting,
3200 the "indent" program is used.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003201 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003202 about including spaces and backslashes.
3203 This option cannot be set from a |modeline| or in the |sandbox|, for
3204 security reasons.
3205
3206 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
3207'errorbells' 'eb' boolean (default off)
3208 global
3209 Ring the bell (beep or screen flash) for error messages. This only
3210 makes a difference for error messages, the bell will be used always
3211 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003212 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar165bc692015-07-21 17:53:25 +02003213 screen flash or do nothing. See 'belloff' to finetune when to ring the
3214 bell.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003215
3216 *'errorfile'* *'ef'*
3217'errorfile' 'ef' string (Amiga default: "AztecC.Err",
3218 others: "errors.err")
3219 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003220 {not available when compiled without the |+quickfix|
3221 feature}
3222 Name of the errorfile for the QuickFix mode (see |:cf|).
3223 When the "-q" command-line argument is used, 'errorfile' is set to the
3224 following argument. See |-q|.
3225 NOT used for the ":make" command. See 'makeef' for that.
3226 Environment variables are expanded |:set_env|.
3227 See |option-backslash| about including spaces and backslashes.
3228 This option cannot be set from a |modeline| or in the |sandbox|, for
3229 security reasons.
3230
3231 *'errorformat'* *'efm'*
3232'errorformat' 'efm' string (default is very long)
3233 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003234 {not available when compiled without the |+quickfix|
3235 feature}
3236 Scanf-like description of the format for the lines in the error file
3237 (see |errorformat|).
3238
3239 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
3240'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
3241 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003242 Function keys that start with an <Esc> are recognized in Insert
3243 mode. When this option is off, the cursor and function keys cannot be
3244 used in Insert mode if they start with an <Esc>. The advantage of
3245 this is that the single <Esc> is recognized immediately, instead of
3246 after one second. Instead of resetting this option, you might want to
3247 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
3248 when 'esckeys' is off, you can still map anything, but the cursor keys
3249 won't work by default.
3250 NOTE: This option is set to the Vi default value when 'compatible' is
3251 set and to the Vim default value when 'compatible' is reset.
Christian Brabandt5f5131d2023-10-25 21:44:26 +02003252 NOTE: when this option is off then the |modifyOtherKeys| and
3253 |xterm-bracketed-paste| functionality is disabled while in Insert mode
3254 to avoid ending Insert mode with any key that has a modifier.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003255
3256 *'eventignore'* *'ei'*
3257'eventignore' 'ei' string (default "")
3258 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003259 A list of autocommand event names, which are to be ignored.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00003260 When set to "all" or when "all" is one of the items, all autocommand
3261 events are ignored, autocommands will not be executed.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01003262 Otherwise this is a comma-separated list of event names. Example: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00003263 :set ei=WinEnter,WinLeave
3264<
3265 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
3266'expandtab' 'et' boolean (default off)
3267 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003268 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003269 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00003270 when 'autoindent' is on. To insert a real tab when 'expandtab' is
3271 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
Bram Moolenaarca635012015-09-25 20:34:21 +02003272 This option is reset when the 'paste' option is set and restored when
3273 the 'paste' option is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003274 NOTE: This option is reset when 'compatible' is set.
3275
3276 *'exrc'* *'ex'* *'noexrc'* *'noex'*
3277'exrc' 'ex' boolean (default off)
3278 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003279 Enables the reading of .vimrc, .exrc and .gvimrc in the current
Bram Moolenaar36f44c22016-08-28 18:17:20 +02003280 directory.
3281
3282 Setting this option is a potential security leak. E.g., consider
3283 unpacking a package or fetching files from github, a .vimrc in there
3284 might be a trojan horse. BETTER NOT SET THIS OPTION!
3285 Instead, define an autocommand in your .vimrc to set options for a
3286 matching directory.
3287
3288 If you do switch this option on you should also consider setting the
3289 'secure' option (see |initialization|).
3290 Also see |.vimrc| and |gui-init|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003291 This option cannot be set from a |modeline| or in the |sandbox|, for
3292 security reasons.
3293
3294 *'fileencoding'* *'fenc'* *E213*
3295'fileencoding' 'fenc' string (default: "")
3296 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003297 Sets the character encoding for the file of this buffer.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003298
Bram Moolenaar071d4272004-06-13 20:20:40 +00003299 When 'fileencoding' is different from 'encoding', conversion will be
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003300 done when writing the file. For reading see below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003301 When 'fileencoding' is empty, the same value as 'encoding' will be
3302 used (no conversion when reading or writing a file).
Bram Moolenaar214641f2017-03-05 17:04:09 +01003303 No error will be given when the value is set, only when it is used,
3304 only when writing a file.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003305 Conversion will also be done when 'encoding' and 'fileencoding' are
3306 both a Unicode encoding and 'fileencoding' is not utf-8. That's
3307 because internally Unicode is always stored as utf-8.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003308 WARNING: Conversion can cause loss of information! When
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003309 'encoding' is "utf-8" or another Unicode encoding, conversion
3310 is most likely done in a way that the reverse conversion
3311 results in the same text. When 'encoding' is not "utf-8" some
3312 characters may be lost!
Bram Moolenaar865242e2010-07-14 21:12:05 +02003313
Bram Moolenaar071d4272004-06-13 20:20:40 +00003314 See 'encoding' for the possible values. Additionally, values may be
3315 specified that can be handled by the converter, see
3316 |mbyte-conversion|.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003317
Bram Moolenaar071d4272004-06-13 20:20:40 +00003318 When reading a file 'fileencoding' will be set from 'fileencodings'.
3319 To read a file in a certain encoding it won't work by setting
Bram Moolenaar02467872007-05-06 13:22:01 +00003320 'fileencoding', use the |++enc| argument. One exception: when
3321 'fileencodings' is empty the value of 'fileencoding' is used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003322 For a new file the global value of 'fileencoding' is used.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003323
Bram Moolenaar071d4272004-06-13 20:20:40 +00003324 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
3325 When the option is set, the value is converted to lowercase. Thus
3326 you can set it with uppercase values too. '_' characters are
3327 replaced with '-'. If a name is recognized from the list for
3328 'encoding', it is replaced by the standard name. For example
3329 "ISO8859-2" becomes "iso-8859-2".
Bram Moolenaar865242e2010-07-14 21:12:05 +02003330
Bram Moolenaar071d4272004-06-13 20:20:40 +00003331 When this option is set, after starting to edit a file, the 'modified'
3332 option is set, because the file would be different when written.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003333
3334 Keep in mind that changing 'fenc' from a modeline happens
3335 AFTER the text has been read, thus it applies to when the file will be
3336 written. If you do set 'fenc' in a modeline, you might want to set
3337 'nomodified' to avoid not being able to ":q".
3338
Bram Moolenaar071d4272004-06-13 20:20:40 +00003339 This option can not be changed when 'modifiable' is off.
3340
3341 *'fe'*
3342 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003343 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003344 old short name was 'fe', which is no longer used.
3345
3346 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003347'fileencodings' 'fencs' string (default: "ucs-bom",
3348 "ucs-bom,utf-8,default,latin1" when
3349 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003350 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003351 This is a list of character encodings considered when starting to edit
3352 an existing file. When a file is read, Vim tries to use the first
3353 mentioned character encoding. If an error is detected, the next one
3354 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003355 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00003356 an empty string, which means the value of 'encoding' is used.
3357 WARNING: Conversion can cause loss of information! When
3358 'encoding' is "utf-8" (or one of the other Unicode variants)
3359 conversion is most likely done in a way that the reverse
3360 conversion results in the same text. When 'encoding' is not
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003361 "utf-8" some non-ASCII characters may be lost! You can use
3362 the |++bad| argument to specify what is done with characters
3363 that can't be converted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003364 For an empty file or a file with only ASCII characters most encodings
3365 will work and the first entry of 'fileencodings' will be used (except
3366 "ucs-bom", which requires the BOM to be present). If you prefer
3367 another encoding use an BufReadPost autocommand event to test if your
3368 preferred encoding is to be used. Example: >
3369 au BufReadPost * if search('\S', 'w') == 0 |
3370 \ set fenc=iso-2022-jp | endif
3371< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
3372 non-blank characters.
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003373 When the |++enc| argument is used then the value of 'fileencodings' is
3374 not used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003375 Note that 'fileencodings' is not used for a new file, the global value
3376 of 'fileencoding' is used instead. You can set it with: >
3377 :setglobal fenc=iso-8859-2
3378< This means that a non-existing file may get a different encoding than
3379 an empty file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003380 The special value "ucs-bom" can be used to check for a Unicode BOM
3381 (Byte Order Mark) at the start of the file. It must not be preceded
3382 by "utf-8" or another Unicode encoding for this to work properly.
3383 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
3384 because Vim cannot detect an error, thus the encoding is always
3385 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003386 The special value "default" can be used for the encoding from the
K.Takataef8706f2021-05-31 18:40:49 +02003387 environment. On MS-Windows this is the system encoding. Otherwise
3388 this is the default value for 'encoding'. It is useful when
3389 'encoding' is set to "utf-8" and your environment uses a non-latin1
3390 encoding, such as Russian.
Bram Moolenaarca003e12006-03-17 23:19:38 +00003391 When 'encoding' is "utf-8" and a file contains an illegal byte
3392 sequence it won't be recognized as UTF-8. You can use the |8g8|
3393 command to find the illegal byte sequence.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003394 WRONG VALUES: WHAT'S WRONG:
3395 latin1,utf-8 "latin1" will always be used
3396 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
3397 file
3398 cp1250,latin1 "cp1250" will always be used
3399 If 'fileencodings' is empty, 'fileencoding' is not modified.
3400 See 'fileencoding' for the possible values.
3401 Setting this option does not have an effect until the next time a file
3402 is read.
3403
3404 *'fileformat'* *'ff'*
Bram Moolenaar00590742019-02-15 21:06:09 +01003405'fileformat' 'ff' string (MS-Windows default: "dos",
Yee Cheng Chin92b59c62024-10-22 21:16:43 +02003406 Unix default: "unix")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003407 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003408 This gives the <EOL> of the current buffer, which is used for
3409 reading/writing the buffer from/to a file:
Bram Moolenaar4072ba52020-12-23 13:56:35 +01003410 dos <CR><NL>
Bram Moolenaar071d4272004-06-13 20:20:40 +00003411 unix <NL>
3412 mac <CR>
3413 When "dos" is used, CTRL-Z at the end of a file is ignored.
3414 See |file-formats| and |file-read|.
3415 For the character encoding of the file see 'fileencoding'.
3416 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
Bram Moolenaarbf884932013-04-05 22:26:15 +02003417 works like it was set to "unix".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003418 This option is set automatically when starting to edit a file and
3419 'fileformats' is not empty and 'binary' is off.
3420 When this option is set, after starting to edit a file, the 'modified'
3421 option is set, because the file would be different when written.
3422 This option can not be changed when 'modifiable' is off.
3423 For backwards compatibility: When this option is set to "dos",
3424 'textmode' is set, otherwise 'textmode' is reset.
3425
3426 *'fileformats'* *'ffs'*
3427'fileformats' 'ffs' string (default:
Bram Moolenaar00590742019-02-15 21:06:09 +01003428 Vim+Vi MS-Windows: "dos,unix",
Yee Cheng Chin92b59c62024-10-22 21:16:43 +02003429 Vim Unix: "unix,dos",
Bram Moolenaar071d4272004-06-13 20:20:40 +00003430 Vi Cygwin: "unix,dos",
3431 Vi others: "")
3432 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003433 This gives the end-of-line (<EOL>) formats that will be tried when
3434 starting to edit a new buffer and when reading a file into an existing
3435 buffer:
3436 - When empty, the format defined with 'fileformat' will be used
3437 always. It is not set automatically.
3438 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003439 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003440 'fileformats' name will be used when a file is read into an existing
3441 buffer, no matter what 'fileformat' for that buffer is set to.
3442 - When more than one name is present, separated by commas, automatic
3443 <EOL> detection will be done when reading a file. When starting to
3444 edit a file, a check is done for the <EOL>:
3445 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
3446 'fileformat' is set to "dos".
3447 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003448 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003449 preceding <CR>, "unix" is preferred over "dos".
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01003450 3. If 'fileformat' has not yet been set, and if a <CR> is found, and
3451 if 'fileformats' includes "mac", 'fileformat' is set to "mac".
Bram Moolenaar00659062010-09-21 22:34:02 +02003452 This means that "mac" is only chosen when:
3453 "unix" is not present or no <NL> is found in the file, and
3454 "dos" is not present or no <CR><NL> is found in the file.
3455 Except: if "unix" was chosen, but there is a <CR> before
3456 the first <NL>, and there appear to be more <CR>s than <NL>s in
Bram Moolenaar166af9b2010-11-16 20:34:40 +01003457 the first few lines, "mac" is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003458 4. If 'fileformat' is still not set, the first name from
3459 'fileformats' is used.
3460 When reading a file into an existing buffer, the same is done, but
3461 this happens like 'fileformat' has been set appropriately for that
3462 file only, the option is not changed.
3463 When 'binary' is set, the value of 'fileformats' is not used.
3464
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01003465 When Vim starts up with an empty buffer the first item is used. You
3466 can overrule this by setting 'fileformat' in your .vimrc.
Bram Moolenaar81af9252010-12-10 20:35:50 +01003467
Bram Moolenaar071d4272004-06-13 20:20:40 +00003468 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
3469 are ":source"ed and for vimrc files, automatic <EOL> detection may be
3470 done:
3471 - When 'fileformats' is empty, there is no automatic detection. Dos
3472 format will be used.
3473 - When 'fileformats' is set to one or more names, automatic detection
3474 is done. This is based on the first <NL> in the file: If there is a
3475 <CR> in front of it, Dos format is used, otherwise Unix format is
3476 used.
3477 Also see |file-formats|.
3478 For backwards compatibility: When this option is set to an empty
3479 string or one format (no comma is included), 'textauto' is reset,
3480 otherwise 'textauto' is set.
3481 NOTE: This option is set to the Vi default value when 'compatible' is
3482 set and to the Vim default value when 'compatible' is reset.
3483
Bram Moolenaarbf884932013-04-05 22:26:15 +02003484 *'fileignorecase'* *'fic'* *'nofileignorecase'* *'nofic'*
3485'fileignorecase' 'fic' boolean (default on for systems where case in file
3486 names is normally ignored)
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003487 global
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003488 When set case is ignored when using file names and directories.
3489 See 'wildignorecase' for only ignoring case when doing completion.
3490
Bram Moolenaar071d4272004-06-13 20:20:40 +00003491 *'filetype'* *'ft'*
3492'filetype' 'ft' string (default: "")
Christian Brabandt596ad662023-08-16 00:11:09 +02003493 local to buffer |local-noglobal|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003494 When this option is set, the FileType autocommand event is triggered.
3495 All autocommands that match with the value of this option will be
3496 executed. Thus the value of 'filetype' is used in place of the file
3497 name.
3498 Otherwise this option does not always reflect the current file type.
3499 This option is normally set when the file type is detected. To enable
3500 this use the ":filetype on" command. |:filetype|
3501 Setting this option to a different value is most useful in a modeline,
3502 for a file for which the file type is not automatically recognized.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003503 Example, for in an IDL file:
3504 /* vim: set filetype=idl : */ ~
3505 |FileType| |filetypes|
3506 When a dot appears in the value then this separates two filetype
Millyae62fe52024-10-02 19:30:41 +02003507 names, it should therefore not be used for a filetype. Example:
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003508 /* vim: set filetype=c.doxygen : */ ~
3509 This will use the "c" filetype first, then the "doxygen" filetype.
3510 This works both for filetype plugins and for syntax files. More than
3511 one dot may appear.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003512 This option is not copied to another buffer, independent of the 's' or
3513 'S' flag in 'cpoptions'.
Millyae62fe52024-10-02 19:30:41 +02003514 Only alphanumeric characters, '-' and '_' can be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003515
3516 *'fillchars'* *'fcs'*
Bram Moolenaara98f8a22021-02-13 18:24:23 +01003517'fillchars' 'fcs' string (default "vert:|,fold:-,eob:~")
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003518 global or local to window |global-local|
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003519 Characters to fill the statuslines, vertical separators and special
3520 lines in the window.
3521 It is a comma-separated list of items. Each item has a name, a colon
zeertzjq6a8d2e12024-01-17 20:54:49 +01003522 and the value of that item: |E1511|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003523
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003524 item name default Used for ~
Christian Brabandt6a650bf2023-11-08 21:23:29 +01003525 stl ' ' statusline of the current window
3526 stlnc ' ' statusline of the non-current windows
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003527 vert '|' vertical separators |:vsplit|
3528 fold '-' filling 'foldtext'
3529 foldopen '-' mark the beginning of a fold
3530 foldclose '+' show a closed fold
3531 foldsep '|' open fold middle character
3532 diff '-' deleted lines of the 'diff' option
3533 eob '~' empty lines below the end of a buffer
Bram Moolenaar4ba5f1d2022-10-04 14:36:29 +01003534 lastline '@' 'display' contains lastline/truncate
Bram Moolenaar071d4272004-06-13 20:20:40 +00003535
Christian Brabandt6a650bf2023-11-08 21:23:29 +01003536 Any one that is omitted will fall back to the default.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003537
3538 Example: >
Christian Brabandt6a650bf2023-11-08 21:23:29 +01003539 :set fillchars=stl:\ ,stlnc:\ ,vert:\|,fold:-,diff:-
3540<
Bram Moolenaar8cc5b552022-06-23 13:04:20 +01003541 For the "stl", "stlnc", "foldopen", "foldclose" and "foldsep" items
3542 single-byte and multibyte characters are supported. But double-width
zeertzjq6a8d2e12024-01-17 20:54:49 +01003543 characters are not supported. |E1512|
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003544
Bram Moolenaar071d4272004-06-13 20:20:40 +00003545 The highlighting used for these items:
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003546 item name highlight group ~
3547 stl StatusLine |hl-StatusLine|
3548 stlnc StatusLineNC |hl-StatusLineNC|
3549 vert VertSplit |hl-VertSplit|
3550 fold Folded |hl-Folded|
3551 diff DiffDelete |hl-DiffDelete|
3552 eob EndOfBuffer |hl-EndOfBuffer|
Bram Moolenaar4ba5f1d2022-10-04 14:36:29 +01003553 lastline NonText |hl-NonText|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003554
Yegappan Lakshmanan2f6efac2024-10-23 21:06:10 +02003555 *'findexpr'* *'fexpr'* *E1514*
Yegappan Lakshmananaeb1c972024-10-22 23:42:20 +02003556'findexpr' 'fexpr' string (default "")
3557 global or local to buffer |global-local|
3558 {not available when compiled without the |+eval|
3559 feature}
3560 Expression that is evaluated to obtain the filename(s) for the |:find|
3561 command. When this option is empty, the internal |file-searching|
3562 mechanism is used.
3563
3564 While evaluating the expression, the |v:fname| variable is set to the
3565 argument of the |:find| command.
3566
3567 The expression is evaluated only once per |:find| command invocation.
3568 The expression can process all the directories specified in 'path'.
3569
zeertzjq20e045f2024-10-28 22:05:26 +01003570 The expression may be evaluated for command-line completion as well,
3571 in which case the |v:cmdcomplete| variable will be set to |v:true|,
3572 otherwise it will be set to |v:false|.
3573
Yegappan Lakshmananaeb1c972024-10-22 23:42:20 +02003574 If a match is found, the expression should return a |List| containing
3575 one or more file names. If a match is not found, the expression
3576 should return an empty List.
3577
3578 If any errors are encountered during the expression evaluation, an
3579 empty List is used as the return value.
3580
3581 Using a function call without arguments is faster |expr-option-function|
3582
3583 It is not allowed to change text or jump to another window while
3584 evaluating 'findexpr' |textlock|.
3585
3586 This option cannot be set from a |modeline| or in the |sandbox|, for
3587 security reasons.
3588
3589 Examples:
3590>
3591 " Use glob()
3592 func FindExprGlob()
zeertzjq20e045f2024-10-28 22:05:26 +01003593 let pat = v:cmdcomplete ? $'{v:fname}*' : v:fname
3594 return glob(pat, v:false, v:true)
Yegappan Lakshmananaeb1c972024-10-22 23:42:20 +02003595 endfunc
3596 set findexpr=FindExprGlob()
3597
3598 " Use the 'git ls-files' output
3599 func FindGitFiles()
3600 let fnames = systemlist('git ls-files')
3601 return fnames->filter('v:val =~? v:fname')
3602 endfunc
3603 set findexpr=FindGitFiles()
3604<
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003605 *'fixendofline'* *'fixeol'* *'nofixendofline'* *'nofixeol'*
3606'fixendofline' 'fixeol' boolean (default on)
3607 local to buffer
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003608 When writing a file and this option is on, <EOL> at the end of file
Bram Moolenaarfb0cf232022-10-22 11:25:19 +01003609 will be restored if missing. Turn this option off if you want to
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003610 preserve the situation from the original file.
3611 When the 'binary' option is set the value of this option doesn't
3612 matter.
3613 See the 'endofline' option.
K.Takata3af98212022-11-01 20:36:19 +00003614 See |eol-and-eof| for example settings.
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003615
Bram Moolenaar071d4272004-06-13 20:20:40 +00003616 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
Bram Moolenaar98a29d02021-01-18 19:55:44 +01003617'fkmap' 'fk' boolean (default off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003618 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003619 {only available when compiled with the |+rightleft|
3620 feature}
Bram Moolenaar14184a32019-02-16 15:10:30 +01003621 This option was for using Farsi, which has been removed. See
3622 |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003623
3624 *'foldclose'* *'fcl'*
3625'foldclose' 'fcl' string (default "")
3626 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003627 {not available when compiled without the |+folding|
3628 feature}
3629 When set to "all", a fold is closed when the cursor isn't in it and
3630 its level is higher than 'foldlevel'. Useful if you want folds to
3631 automatically close when moving out of them.
3632
3633 *'foldcolumn'* *'fdc'*
3634'foldcolumn' 'fdc' number (default 0)
3635 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003636 {not available when compiled without the |+folding|
3637 feature}
3638 When non-zero, a column with the specified width is shown at the side
3639 of the window which indicates open and closed folds. The maximum
3640 value is 12.
3641 See |folding|.
3642
3643 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
3644'foldenable' 'fen' boolean (default on)
3645 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003646 {not available when compiled without the |+folding|
3647 feature}
3648 When off, all folds are open. This option can be used to quickly
3649 switch between showing all text unfolded and viewing the text with
3650 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003651 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00003652 'foldenable' is off.
3653 This option is set by commands that create a new fold or close a fold.
3654 See |folding|.
3655
3656 *'foldexpr'* *'fde'*
3657'foldexpr' 'fde' string (default: "0")
3658 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003659 {not available when compiled without the |+folding|
Bram Moolenaardb84e452010-08-15 13:50:43 +02003660 or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003661 The expression used for when 'foldmethod' is "expr". It is evaluated
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00003662 for each line to obtain its fold level. The context is set to the
3663 script where 'foldexpr' was set, script-local items can be accessed.
3664 See |fold-expr| for the usage.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003665
Bram Moolenaar30b65812012-07-12 22:01:11 +02003666 The expression will be evaluated in the |sandbox| if set from a
3667 modeline, see |sandbox-option|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003668 This option can't be set from a |modeline| when the 'diff' option is
Bram Moolenaar110289e2019-05-23 15:38:06 +02003669 on or the 'modelineexpr' option is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003670
3671 It is not allowed to change text or jump to another window while
3672 evaluating 'foldexpr' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003673
3674 *'foldignore'* *'fdi'*
3675'foldignore' 'fdi' string (default: "#")
3676 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003677 {not available when compiled without the |+folding|
3678 feature}
3679 Used only when 'foldmethod' is "indent". Lines starting with
3680 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003681 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003682 The default "#" works well for C programs. See |fold-indent|.
3683
3684 *'foldlevel'* *'fdl'*
3685'foldlevel' 'fdl' number (default: 0)
3686 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003687 {not available when compiled without the |+folding|
3688 feature}
3689 Sets the fold level: Folds with a higher level will be closed.
3690 Setting this option to zero will close all folds. Higher numbers will
3691 close fewer folds.
3692 This option is set by commands like |zm|, |zM| and |zR|.
3693 See |fold-foldlevel|.
3694
3695 *'foldlevelstart'* *'fdls'*
3696'foldlevelstart' 'fdls' number (default: -1)
3697 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003698 {not available when compiled without the |+folding|
3699 feature}
3700 Sets 'foldlevel' when starting to edit another buffer in a window.
3701 Useful to always start editing with all folds closed (value zero),
3702 some folds closed (one) or no folds closed (99).
3703 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003704 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00003705 ignores this option and closes all folds.
3706 It is also done before BufReadPre autocommands, to allow an autocmd to
3707 overrule the 'foldlevel' value for specific files.
3708 When the value is negative, it is not used.
3709
3710 *'foldmarker'* *'fmr'* *E536*
3711'foldmarker' 'fmr' string (default: "{{{,}}}")
3712 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003713 {not available when compiled without the |+folding|
3714 feature}
3715 The start and end marker used when 'foldmethod' is "marker". There
3716 must be one comma, which separates the start and end marker. The
3717 marker is a literal string (a regular expression would be too slow).
3718 See |fold-marker|.
3719
3720 *'foldmethod'* *'fdm'*
3721'foldmethod' 'fdm' string (default: "manual")
3722 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003723 {not available when compiled without the |+folding|
3724 feature}
3725 The kind of folding used for the current window. Possible values:
3726 |fold-manual| manual Folds are created manually.
3727 |fold-indent| indent Lines with equal indent form a fold.
3728 |fold-expr| expr 'foldexpr' gives the fold level of a line.
3729 |fold-marker| marker Markers are used to specify folds.
3730 |fold-syntax| syntax Syntax highlighting items specify folds.
3731 |fold-diff| diff Fold text that is not changed.
3732
3733 *'foldminlines'* *'fml'*
3734'foldminlines' 'fml' number (default: 1)
3735 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003736 {not available when compiled without the |+folding|
3737 feature}
Bram Moolenaar00654022011-02-25 14:42:19 +01003738 Sets the number of screen lines above which a fold can be displayed
3739 closed. Also for manually closed folds. With the default value of
3740 one a fold can only be closed if it takes up two or more screen lines.
3741 Set to zero to be able to close folds of just one screen line.
Bram Moolenaar446beb42011-05-10 17:18:44 +02003742 Note that this only has an effect on what is displayed. After using
Bram Moolenaar071d4272004-06-13 20:20:40 +00003743 "zc" to close a fold, which is displayed open because it's smaller
3744 than 'foldminlines', a following "zc" may close a containing fold.
3745
3746 *'foldnestmax'* *'fdn'*
3747'foldnestmax' 'fdn' number (default: 20)
3748 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003749 {not available when compiled without the |+folding|
3750 feature}
3751 Sets the maximum nesting of folds for the "indent" and "syntax"
3752 methods. This avoids that too many folds will be created. Using more
3753 than 20 doesn't work, because the internal limit is 20.
3754
3755 *'foldopen'* *'fdo'*
3756'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
3757 search,tag,undo")
3758 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003759 {not available when compiled without the |+folding|
3760 feature}
3761 Specifies for which type of commands folds will be opened, if the
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01003762 command moves the cursor into a closed fold. It is a comma-separated
Bram Moolenaar071d4272004-06-13 20:20:40 +00003763 list of items.
Bram Moolenaar05365702010-10-27 18:34:44 +02003764 NOTE: When the command is part of a mapping this option is not used.
3765 Add the |zv| command to the mapping to get the same effect.
3766 (rationale: the mapping may want to control opening folds itself)
3767
Bram Moolenaar071d4272004-06-13 20:20:40 +00003768 item commands ~
3769 all any
3770 block "(", "{", "[[", "[{", etc.
3771 hor horizontal movements: "l", "w", "fx", etc.
3772 insert any command in Insert mode
3773 jump far jumps: "G", "gg", etc.
3774 mark jumping to a mark: "'m", CTRL-O, etc.
3775 percent "%"
3776 quickfix ":cn", ":crew", ":make", etc.
3777 search search for a pattern: "/", "n", "*", "gd", etc.
3778 (not for a search pattern in a ":" command)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003779 Also for |[s| and |]s|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003780 tag jumping to a tag: ":ta", CTRL-T, etc.
3781 undo undo or redo: "u" and CTRL-R
Bram Moolenaar071d4272004-06-13 20:20:40 +00003782 When a movement command is used for an operator (e.g., "dl" or "y%")
3783 this option is not used. This means the operator will include the
3784 whole closed fold.
3785 Note that vertical movements are not here, because it would make it
3786 very difficult to move onto a closed fold.
3787 In insert mode the folds containing the cursor will always be open
3788 when text is inserted.
3789 To close folds you can re-apply 'foldlevel' with the |zx| command or
3790 set the 'foldclose' option to "all".
3791
3792 *'foldtext'* *'fdt'*
3793'foldtext' 'fdt' string (default: "foldtext()")
3794 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003795 {not available when compiled without the |+folding|
3796 feature}
3797 An expression which is used to specify the text displayed for a closed
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00003798 fold. The context is set to the script where 'foldexpr' was set,
3799 script-local items can be accessed. See |fold-foldtext| for the
3800 usage.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003801
Bram Moolenaar30b65812012-07-12 22:01:11 +02003802 The expression will be evaluated in the |sandbox| if set from a
3803 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003804 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003805
3806 It is not allowed to change text or jump to another window while
3807 evaluating 'foldtext' |textlock|.
3808
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003809 *'formatexpr'* *'fex'*
3810'formatexpr' 'fex' string (default "")
3811 local to buffer
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003812 {not available when compiled without the |+eval|
3813 feature}
3814 Expression which is evaluated to format a range of lines for the |gq|
3815 operator or automatic formatting (see 'formatoptions'). When this
3816 option is empty 'formatprg' is used.
3817
3818 The |v:lnum| variable holds the first line to be formatted.
3819 The |v:count| variable holds the number of lines to be formatted.
3820 The |v:char| variable holds the character that is going to be
3821 inserted if the expression is being evaluated due to
3822 automatic formatting. This can be empty. Don't insert
3823 it yet!
3824
3825 Example: >
3826 :set formatexpr=mylang#Format()
3827< This will invoke the mylang#Format() function in the
3828 autoload/mylang.vim file in 'runtimepath'. |autoload|
3829
Bram Moolenaara4e0b972022-10-01 19:43:52 +01003830 The advantage of using a function call without arguments is that it is
3831 faster, see |expr-option-function|.
3832
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003833 The expression is also evaluated when 'textwidth' is set and adding
3834 text beyond that limit. This happens under the same conditions as
3835 when internal formatting is used. Make sure the cursor is kept in the
3836 same spot relative to the text then! The |mode()| function will
3837 return "i" or "R" in this situation.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01003838
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003839 When the expression evaluates to non-zero Vim will fall back to using
3840 the internal format mechanism.
3841
Yegappan Lakshmanan8bb65f22021-12-26 10:51:39 +00003842 If the expression starts with s: or |<SID>|, then it is replaced with
3843 the script ID (|local-function|). Example: >
3844 set formatexpr=s:MyFormatExpr()
3845 set formatexpr=<SID>SomeFormatExpr()
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00003846< Otherwise, the expression is evaluated in the context of the script
3847 where the option was set, thus script-local items are available.
3848
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003849 The expression will be evaluated in the |sandbox| when set from a
3850 modeline, see |sandbox-option|. That stops the option from working,
3851 since changing the buffer text is not allowed.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003852 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaar036986f2017-03-16 17:41:02 +01003853 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003854
Bram Moolenaar86b68352004-12-27 21:59:20 +00003855 *'formatlistpat'* *'flp'*
3856'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
3857 local to buffer
Bram Moolenaar86b68352004-12-27 21:59:20 +00003858 A pattern that is used to recognize a list header. This is used for
3859 the "n" flag in 'formatoptions'.
3860 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00003861 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00003862 while still checking more characters. There must be a character
3863 following the pattern, when it matches the whole line it is handled
3864 like there is no match.
3865 The default recognizes a number, followed by an optional punctuation
3866 character and white space.
3867
Bram Moolenaar6c60f472019-04-28 16:00:35 +02003868 *'formatoptions'* *'fo'*
3869'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
3870 local to buffer
3871 This is a sequence of letters which describes how automatic
Christian Brabandt1b08d2c2023-11-11 15:50:13 +01003872 formatting is to be done.
3873 See |fo-table| for possible values and |gq| for how to format text.
3874 When the 'paste' option is on, no formatting is done (like
3875 'formatoptions' is empty). Commas can be inserted for readability.
Bram Moolenaar6c60f472019-04-28 16:00:35 +02003876 To avoid problems with flags that are added in the future, use the
3877 "+=" and "-=" feature of ":set" |add-option-flags|.
3878 NOTE: This option is set to the Vi default value when 'compatible' is
3879 set and to the Vim default value when 'compatible' is reset.
3880
Bram Moolenaar071d4272004-06-13 20:20:40 +00003881 *'formatprg'* *'fp'*
3882'formatprg' 'fp' string (default "")
Bram Moolenaar9be7c042017-01-14 14:28:30 +01003883 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003884 The name of an external program that will be used to format the lines
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003885 selected with the |gq| operator. The program must take the input on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003886 stdin and produce the output on stdout. The Unix program "fmt" is
Bram Moolenaara5792f52005-11-23 21:25:05 +00003887 such a program.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003888 If the 'formatexpr' option is not empty it will be used instead.
3889 Otherwise, if 'formatprg' option is an empty string, the internal
3890 format function will be used |C-indenting|.
Bram Moolenaara5792f52005-11-23 21:25:05 +00003891 Environment variables are expanded |:set_env|. See |option-backslash|
3892 about including spaces and backslashes.
Bram Moolenaar30b65812012-07-12 22:01:11 +02003893 This option cannot be set from a |modeline| or in the |sandbox|, for
3894 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003895
Bram Moolenaard94464e2015-11-02 15:28:18 +01003896 *'fsync'* *'fs'* *'nofsync'* *'nofs'*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003897'fsync' 'fs' boolean (default on)
3898 global
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003899 When on, the library function fsync() will be called after writing a
3900 file. This will flush a file to disk, ensuring that it is safely
3901 written even on filesystems which do metadata-only journaling. This
3902 will force the harddrive to spin up on Linux systems running in laptop
3903 mode, so it may be undesirable in some situations. Be warned that
3904 turning this off increases the chances of data loss after a crash. On
3905 systems without an fsync() implementation, this variable is always
3906 off.
3907 Also see 'swapsync' for controlling fsync() on swap files.
Bram Moolenaar340dd0f2021-10-14 17:52:23 +01003908 'fsync' also applies to |writefile()| (unless a flag is used to
3909 overrule it) and when writing undo files (see |undo-persistence|).
Bram Moolenaar110289e2019-05-23 15:38:06 +02003910 This option cannot be set from a |modeline| or in the |sandbox|, for
3911 security reasons.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003912
Bram Moolenaar071d4272004-06-13 20:20:40 +00003913 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
3914'gdefault' 'gd' boolean (default off)
3915 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003916 When on, the ":substitute" flag 'g' is default on. This means that
3917 all matches in a line are substituted instead of one. When a 'g' flag
3918 is given to a ":substitute" command, this will toggle the substitution
3919 of all or one match. See |complex-change|.
3920
3921 command 'gdefault' on 'gdefault' off ~
3922 :s/// subst. all subst. one
3923 :s///g subst. one subst. all
3924 :s///gg subst. all subst. one
3925
3926 NOTE: This option is reset when 'compatible' is set.
dundargoc82f19732023-12-16 14:53:52 +01003927 Setting this option may break plugins that rely on the default
3928 behavior of the 'g' flag. This will also make the 'g' flag have the
3929 opposite effect of that documented in |:s_g|.
Bram Moolenaar4072ba52020-12-23 13:56:35 +01003930 This option is not used in |Vim9| script.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003931
3932 *'grepformat'* *'gfm'*
Bram Moolenaar6e932462014-09-09 18:48:09 +02003933'grepformat' 'gfm' string (default "%f:%l:%m,%f:%l%m,%f %l%m")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003934 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003935 Format to recognize for the ":grep" command output.
3936 This is a scanf-like string that uses the same format as the
3937 'errorformat' option: see |errorformat|.
3938
3939 *'grepprg'* *'gp'*
3940'grepprg' 'gp' string (default "grep -n ",
3941 Unix: "grep -n $* /dev/null",
3942 Win32: "findstr /n" or "grep -n",
3943 VMS: "SEARCH/NUMBERS ")
3944 global or local to buffer |global-local|
Bram Moolenaar582fd852005-03-28 20:58:01 +00003945 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003946 and '#' characters, which are expanded like when used in a command-
3947 line. The placeholder "$*" is allowed to specify where the arguments
3948 will be included. Environment variables are expanded |:set_env|. See
3949 |option-backslash| about including spaces and backslashes.
3950 When your "grep" accepts the "-H" argument, use this to make ":grep"
3951 also work well with a single file: >
3952 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00003953< Special value: When 'grepprg' is set to "internal" the |:grep| command
Bram Moolenaara6557602006-02-04 22:43:20 +00003954 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like
3955 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00003956 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00003957 apply equally to 'grepprg'.
3958 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
3959 otherwise it's "grep -n".
3960 This option cannot be set from a |modeline| or in the |sandbox|, for
3961 security reasons.
3962
3963 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
3964'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
3965 ve:ver35-Cursor,
3966 o:hor50-Cursor,
3967 i-ci:ver25-Cursor/lCursor,
3968 r-cr:hor20-Cursor/lCursor,
3969 sm:block-Cursor
3970 -blinkwait175-blinkoff150-blinkon175",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003971 for Win32 console:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003972 "n-v-c:block,o:hor50,i-ci:hor15,
3973 r-cr:hor30,sm:block")
3974 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003975 {only available when compiled with GUI enabled, and
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003976 for Win32 console}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003977 This option tells Vim what the cursor should look like in different
Bram Moolenaar8024f932020-01-14 19:29:13 +01003978 modes. It fully works in the GUI. In a Win32 console, only the
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003979 height of the cursor can be changed. This can be done by specifying a
3980 block cursor, or a percentage for a vertical or horizontal cursor.
Bram Moolenaar1e7813a2015-03-31 18:31:03 +02003981 For a console the 't_SI', 't_SR', and 't_EI' escape sequences are
3982 used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003983
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01003984 The option is a comma-separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003985 mode-list and an argument-list:
3986 mode-list:argument-list,mode-list:argument-list,..
3987 The mode-list is a dash separated list of these modes:
3988 n Normal mode
3989 v Visual mode
3990 ve Visual mode with 'selection' "exclusive" (same as 'v',
3991 if not specified)
3992 o Operator-pending mode
3993 i Insert mode
3994 r Replace mode
3995 c Command-line Normal (append) mode
3996 ci Command-line Insert mode
3997 cr Command-line Replace mode
3998 sm showmatch in Insert mode
3999 a all modes
4000 The argument-list is a dash separated list of these arguments:
4001 hor{N} horizontal bar, {N} percent of the character height
4002 ver{N} vertical bar, {N} percent of the character width
4003 block block cursor, fills the whole character
4004 [only one of the above three should be present]
4005 blinkwait{N} *cursor-blinking*
4006 blinkon{N}
4007 blinkoff{N}
4008 blink times for cursor: blinkwait is the delay before
4009 the cursor starts blinking, blinkon is the time that
4010 the cursor is shown and blinkoff is the time that the
4011 cursor is not shown. The times are in msec. When one
4012 of the numbers is zero, there is no blinking. The
4013 default is: "blinkwait700-blinkon400-blinkoff250".
4014 These numbers are used for a missing entry. This
4015 means that blinking is enabled by default. To switch
4016 blinking off you can use "blinkon0". The cursor only
4017 blinks when Vim is waiting for input, not while
4018 executing a command.
4019 To make the cursor blink in an xterm, see
4020 |xterm-blink|.
4021 {group-name}
4022 a highlight group name, that sets the color and font
4023 for the cursor
4024 {group-name}/{group-name}
4025 Two highlight group names, the first is used when
4026 no language mappings are used, the other when they
4027 are. |language-mapping|
4028
4029 Examples of parts:
4030 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
4031 block cursor with colors from the "nCursor"
4032 highlight group
4033 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
4034 In Insert and Command-line Insert mode, use a
4035 30% vertical bar cursor with colors from the
4036 "iCursor" highlight group. Blink a bit
4037 faster.
4038
4039 The 'a' mode is different. It will set the given argument-list for
4040 all modes. It does not reset anything to defaults. This can be used
4041 to do a common setting for all modes. For example, to switch off
4042 blinking: "a:blinkon0"
4043
4044 Examples of cursor highlighting: >
4045 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
4046 :highlight Cursor gui=NONE guifg=bg guibg=fg
4047<
4048 *'guifont'* *'gfn'*
Bram Moolenaar251e1912011-06-19 05:09:16 +02004049 *E235* *E596*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004050'guifont' 'gfn' string (default "")
4051 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004052 {only available when compiled with GUI enabled}
4053 This is a list of fonts which will be used for the GUI version of Vim.
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02004054 In its simplest form the value is just one font name.
4055 See |gui-font| for the details.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004056
4057 *'guifontset'* *'gfs'*
4058 *E250* *E252* *E234* *E597* *E598*
4059'guifontset' 'gfs' string (default "")
4060 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004061 {only available when compiled with GUI enabled and
4062 with the |+xfontset| feature}
Bram Moolenaar3df01732017-02-17 22:47:16 +01004063 {not available in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004064 When not empty, specifies two (or more) fonts to be used. The first
4065 one for normal English, the second one for your special language. See
4066 |xfontset|.
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02004067
Bram Moolenaar071d4272004-06-13 20:20:40 +00004068 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
4069'guifontwide' 'gfw' string (default "")
4070 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004071 {only available when compiled with GUI enabled}
4072 When not empty, specifies a comma-separated list of fonts to be used
4073 for double-width characters. The first font that can be loaded is
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02004074 used. See |gui-fontwide|.
Bram Moolenaar0f272122013-01-23 18:37:40 +01004075
Bram Moolenaar071d4272004-06-13 20:20:40 +00004076 *'guiheadroom'* *'ghr'*
4077'guiheadroom' 'ghr' number (default 50)
4078 global
Bram Moolenaar110289e2019-05-23 15:38:06 +02004079 {only for GTK and X11 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004080 The number of pixels subtracted from the screen height when fitting
4081 the GUI window on the screen. Set this before the GUI is started,
4082 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004083 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00004084 lines will be left for window decorations and other items on the
4085 screen. Set it to a negative value to allow windows taller than the
4086 screen.
4087
Dusan Popovic4eeedc02021-10-16 20:52:05 +01004088 *'guiligatures'* *'gli'* *E1243*
4089'guiligatures' 'gli' string (default "")
4090 global
Erik S. V. Jansson8b1e7492024-02-24 14:26:52 +01004091 {only for GTK and Win32 GUI}
Dusan Popovic4eeedc02021-10-16 20:52:05 +01004092 List of ASCII characters that, when combined together, can create more
4093 complex shapes. Each character must be a printable ASCII character
4094 with a value in the 32-127 range.
4095 Example: >
4096 :set guiligatures=!\"#$%&()*+-./:<=>?@[]^_{\|~
4097< Changing this option updates screen output immediately. Set it to an
4098 empty string to disable ligatures.
4099
Bram Moolenaar071d4272004-06-13 20:20:40 +00004100 *'guioptions'* *'go'*
Bram Moolenaar2c64ca12018-10-19 16:22:31 +02004101'guioptions' 'go' string (default "egmrLtT" (MS-Windows,
4102 "t" is removed in |defaults.vim|),
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004103 "aegimrLtT" (GTK and Motif),
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004104 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00004105 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004106 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00004107 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004108 sequence of letters which describes what components and options of the
4109 GUI should be used.
4110 To avoid problems with flags that are added in the future, use the
4111 "+=" and "-=" feature of ":set" |add-option-flags|.
4112
Bram Moolenaar13568252018-03-16 20:46:58 +01004113 Valid characters are as follows:
4114 *'go-!'*
4115 '!' External commands are executed in a terminal window. Without
4116 this flag the MS-Windows GUI will open a console window to
4117 execute the command. The Unix GUI will simulate a dumb
4118 terminal to list the command output.
4119 The terminal window will be positioned at the bottom, and grow
4120 upwards as needed.
Bram Moolenaarba3ff532018-11-04 14:45:49 +01004121 *'go-a'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004122 'a' Autoselect: If present, then whenever VISUAL mode is started,
4123 or the Visual area extended, Vim tries to become the owner of
4124 the windowing system's global selection. This means that the
4125 Visually highlighted text is available for pasting into other
4126 applications as well as into Vim itself. When the Visual mode
4127 ends, possibly due to an operation on the text, or when an
4128 application wants to paste the selection, the highlighted text
4129 is automatically yanked into the "* selection register.
4130 Thus the selection is still available for pasting into other
4131 applications after the VISUAL mode has ended.
4132 If not present, then Vim won't become the owner of the
4133 windowing system's global selection unless explicitly told to
4134 by a yank or delete operation for the "* register.
4135 The same applies to the modeless selection.
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02004136 *'go-P'*
4137 'P' Like autoselect but using the "+ register instead of the "*
Bram Moolenaar3848e002016-03-19 18:42:29 +01004138 register.
Bram Moolenaar02467872007-05-06 13:22:01 +00004139 *'go-A'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004140 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00004141 applies to the modeless selection.
4142
4143 'guioptions' autoselect Visual autoselect modeless ~
4144 "" - -
4145 "a" yes yes
4146 "A" - yes
4147 "aA" yes yes
4148
Bram Moolenaar9fbdbb82022-09-27 17:30:34 +01004149 When using a terminal see the 'clipboard' option.
4150
Bram Moolenaar02467872007-05-06 13:22:01 +00004151 *'go-c'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004152 'c' Use console dialogs instead of popup dialogs for simple
4153 choices.
Bram Moolenaar50bf7ce2019-09-15 13:17:00 +02004154 *'go-d'*
4155 'd' Use dark theme variant if available. Currently only works for
4156 GTK+ GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00004157 *'go-e'*
Bram Moolenaare224ffa2006-03-01 00:01:28 +00004158 'e' Add tab pages when indicated with 'showtabline'.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004159 'guitablabel' can be used to change the text in the labels.
4160 When 'e' is missing a non-GUI tab pages line may be used.
Bram Moolenaard68071d2006-05-02 22:08:30 +00004161 The GUI tabs are only supported on some systems, currently
Bram Moolenaarb3f74062020-02-26 16:16:53 +01004162 GTK, Motif, Mac OS/X, Haiku, and MS-Windows.
Bram Moolenaar02467872007-05-06 13:22:01 +00004163 *'go-f'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004164 'f' Foreground: Don't use fork() to detach the GUI from the shell
4165 where it was started. Use this for programs that wait for the
4166 editor to finish (e.g., an e-mail program). Alternatively you
4167 can use "gvim -f" or ":gui -f" to start the GUI in the
4168 foreground. |gui-fork|
4169 Note: Set this option in the vimrc file. The forking may have
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004170 happened already when the |gvimrc| file is read.
Bram Moolenaar02467872007-05-06 13:22:01 +00004171 *'go-i'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004172 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
4173 corner of the window. It's black&white on non-GTK, because of
4174 limitations of X11. For a color icon, see |X11-icon|.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004175 *'go-m'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004176 'm' Menu bar is present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004177 *'go-M'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004178 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00004179 that this flag must be added in the .vimrc file, before
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004180 switching on syntax or filetype recognition (when the |gvimrc|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004181 file is sourced the system menu has already been loaded; the
Bram Moolenaar01164a62017-11-02 22:58:42 +01004182 `:syntax on` and `:filetype on` commands load the menu too).
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004183 *'go-g'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004184 'g' Grey menu items: Make menu items that are not active grey. If
4185 'g' is not included inactive menu items are not shown at all.
Bram Moolenaar02467872007-05-06 13:22:01 +00004186 *'go-t'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004187 't' Include tearoff menu items. Currently only works for Win32,
4188 GTK+, and Motif 1.2 GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00004189 *'go-T'*
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004190 'T' Include Toolbar. Currently only in Win32, GTK+, Motif and
4191 Photon GUIs.
Bram Moolenaar02467872007-05-06 13:22:01 +00004192 *'go-r'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004193 'r' Right-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004194 *'go-R'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004195 'R' Right-hand scrollbar is present when there is a vertically
4196 split window.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004197 *'go-l'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004198 'l' Left-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004199 *'go-L'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004200 'L' Left-hand scrollbar is present when there is a vertically
4201 split window.
Bram Moolenaar02467872007-05-06 13:22:01 +00004202 *'go-b'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004203 'b' Bottom (horizontal) scrollbar is present. Its size depends on
4204 the longest visible line, or on the cursor line if the 'h'
4205 flag is included. |gui-horiz-scroll|
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004206 *'go-h'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004207 'h' Limit horizontal scrollbar size to the length of the cursor
4208 line. Reduces computations. |gui-horiz-scroll|
4209
4210 And yes, you may even have scrollbars on the left AND the right if
4211 you really want to :-). See |gui-scrollbars| for more information.
4212
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004213 *'go-v'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004214 'v' Use a vertical button layout for dialogs. When not included,
4215 a horizontal layout is preferred, but when it doesn't fit a
Bram Moolenaardad44732021-03-31 20:07:33 +02004216 vertical layout is used anyway. Not supported in GTK 3.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004217 *'go-p'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004218 'p' Use Pointer callbacks for X11 GUI. This is required for some
4219 window managers. If the cursor is not blinking or hollow at
4220 the right moment, try adding this flag. This must be done
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004221 before starting the GUI. Set it in your |gvimrc|. Adding or
Bram Moolenaar071d4272004-06-13 20:20:40 +00004222 removing it after the GUI has started has no effect.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004223 *'go-F'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004224 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar8ac44152017-11-09 18:33:29 +01004225 *'go-k'*
4226 'k' Keep the GUI window size when adding/removing a scrollbar, or
4227 toolbar, tabline, etc. Instead, the behavior is similar to
4228 when the window is maximized and will adjust 'lines' and
4229 'columns' to fit to the window. Without the 'k' flag Vim will
Bram Moolenaar51b0f372017-11-18 18:52:04 +01004230 try to keep 'lines' and 'columns' the same when adding and
Bram Moolenaar8ac44152017-11-09 18:33:29 +01004231 removing GUI components.
Bram Moolenaar02467872007-05-06 13:22:01 +00004232
Bram Moolenaar071d4272004-06-13 20:20:40 +00004233 *'guipty'* *'noguipty'*
4234'guipty' boolean (default on)
4235 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004236 {only available when compiled with GUI enabled}
4237 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
4238 I/O to/from shell commands. See |gui-pty|.
4239
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004240 *'guitablabel'* *'gtl'*
4241'guitablabel' 'gtl' string (default empty)
4242 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02004243 {only available when compiled with GUI enabled}
Bram Moolenaar944697a2022-02-20 19:48:20 +00004244 When non-empty describes the text to use in a label of the GUI tab
Bram Moolenaard68071d2006-05-02 22:08:30 +00004245 pages line. When empty and when the result is empty Vim will use a
4246 default label. See |setting-guitablabel| for more info.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004247
Bram Moolenaara23ccb82006-02-27 00:08:02 +00004248 The format of this option is like that of 'statusline'.
Bram Moolenaar57657d82006-04-21 22:12:41 +00004249 'guitabtooltip' is used for the tooltip, see below.
Bram Moolenaar51628222016-12-01 23:03:28 +01004250 The expression will be evaluated in the |sandbox| when set from a
4251 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004252 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00004253
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004254 Only used when the GUI tab pages line is displayed. 'e' must be
4255 present in 'guioptions'. For the non-GUI tab pages line 'tabline' is
4256 used.
4257
Bram Moolenaar57657d82006-04-21 22:12:41 +00004258 *'guitabtooltip'* *'gtt'*
4259'guitabtooltip' 'gtt' string (default empty)
4260 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02004261 {only available when compiled with GUI enabled}
Bram Moolenaar944697a2022-02-20 19:48:20 +00004262 When non-empty describes the text to use in a tooltip for the GUI tab
Bram Moolenaar57657d82006-04-21 22:12:41 +00004263 pages line. When empty Vim will use a default tooltip.
4264 This option is otherwise just like 'guitablabel' above.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004265 You can include a line break. Simplest method is to use |:let|: >
4266 :let &guitabtooltip = "line one\nline two"
4267<
Bram Moolenaar57657d82006-04-21 22:12:41 +00004268
Bram Moolenaar071d4272004-06-13 20:20:40 +00004269 *'helpfile'* *'hf'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01004270'helpfile' 'hf' string (default (MS-Windows) "$VIMRUNTIME\doc\help.txt"
Bram Moolenaar071d4272004-06-13 20:20:40 +00004271 (others) "$VIMRUNTIME/doc/help.txt")
4272 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004273 Name of the main help file. All distributed help files should be
4274 placed together in one directory. Additionally, all "doc" directories
4275 in 'runtimepath' will be used.
4276 Environment variables are expanded |:set_env|. For example:
4277 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004278 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00004279 spaces and backslashes.
4280 This option cannot be set from a |modeline| or in the |sandbox|, for
4281 security reasons.
4282
4283 *'helpheight'* *'hh'*
4284'helpheight' 'hh' number (default 20)
4285 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004286 Minimal initial height of the help window when it is opened with the
4287 ":help" command. The initial height of the help window is half of the
4288 current window, or (when the 'ea' option is on) the same as other
4289 windows. When the height is less than 'helpheight', the height is
4290 set to 'helpheight'. Set to zero to disable.
4291
4292 *'helplang'* *'hlg'*
4293'helplang' 'hlg' string (default: messages language or empty)
4294 global
4295 {only available when compiled with the |+multi_lang|
4296 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004297 Comma-separated list of languages. Vim will use the first language
Bram Moolenaar071d4272004-06-13 20:20:40 +00004298 for which the desired help can be found. The English help will always
4299 be used as a last resort. You can add "en" to prefer English over
4300 another language, but that will only find tags that exist in that
4301 language and not in the English help.
4302 Example: >
4303 :set helplang=de,it
4304< This will first search German, then Italian and finally English help
4305 files.
4306 When using |CTRL-]| and ":help!" in a non-English help file Vim will
4307 try to find the tag in the current language before using this option.
4308 See |help-translated|.
4309
4310 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
4311'hidden' 'hid' boolean (default off)
4312 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004313 When off a buffer is unloaded when it is |abandon|ed. When on a
4314 buffer becomes hidden when it is |abandon|ed. If the buffer is still
4315 displayed in another window, it does not become hidden, of course.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004316
Bram Moolenaar071d4272004-06-13 20:20:40 +00004317 The commands that move through the buffer list sometimes make a buffer
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004318 hidden even if the 'hidden' option is off when these three are true:
4319 - the buffer is modified
4320 - 'autowrite' is off or writing is not possible
4321 - the '!' flag was used
4322 Also see |windows.txt|.
4323
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004324 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004325 This option is set for one command with ":hide {command}" |:hide|.
4326 WARNING: It's easy to forget that you have changes in hidden buffers.
4327 Think twice when using ":q!" or ":qa!".
4328
4329 *'highlight'* *'hl'*
4330'highlight' 'hl' string (default (as a single string):
Bram Moolenaar58b85342016-08-14 19:54:54 +02004331 "8:SpecialKey,~:EndOfBuffer,@:NonText,
4332 d:Directory,e:ErrorMsg,i:IncSearch,
4333 l:Search,m:MoreMsg,M:ModeMsg,n:LineNr,
Bram Moolenaarefae76a2019-10-27 22:54:58 +01004334 a:LineNrAbove,b:LineNrBelow,
Bram Moolenaar58b85342016-08-14 19:54:54 +02004335 N:CursorLineNr,r:Question,s:StatusLine,
4336 S:StatusLineNC,c:VertSplit,t:Title,
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004337 v:Visual,V:VisualNOS,w:WarningMsg,
4338 W:WildMenu,f:Folded,F:FoldColumn,
4339 A:DiffAdd,C:DiffChange,D:DiffDelete,
4340 T:DiffText,>:SignColumn,-:Conceal,
Bram Moolenaarc8c88492018-12-27 23:59:26 +01004341 B:SpellBad,P:SpellCap,R:SpellRare,
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004342 L:SpellLocal,+:Pmenu,=:PmenuSel,
glepnir40c1c332024-06-11 19:37:04 +02004343 k:PmenuMatch,<:PmenuMatchSel,
Gianmaria Bajo6a7c7742023-03-10 16:35:53 +00004344 [:PmenuKind,]:PmenuKindSel,
4345 {:PmenuExtra,}:PmenuExtraSel,
Bram Moolenaar21020352017-06-13 17:21:04 +02004346 x:PmenuSbar,X:PmenuThumb,*:TabLine,
4347 #:TabLineSel,_:TabLineFill,!:CursorColumn,
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02004348 .:CursorLine,o:ColorColumn,q:QuickFixLine,
Christian Brabandtfb745752024-05-07 21:19:03 +02004349 z:StatusLineTerm,Z:StatusLineTermNC,
4350 g:MsgArea")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004351 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004352 This option can be used to set highlighting mode for various
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004353 occasions. It is a comma-separated list of character pairs. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00004354 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004355 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004356 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
Bram Moolenaar58b85342016-08-14 19:54:54 +02004357 |hl-EndOfBuffer| ~ lines after the last line in the buffer
4358 |hl-NonText| @ '@' at the end of the window and
Bram Moolenaar071d4272004-06-13 20:20:40 +00004359 characters from 'showbreak'
4360 |hl-Directory| d directories in CTRL-D listing and other special
4361 things in listings
4362 |hl-ErrorMsg| e error messages
4363 h (obsolete, ignored)
4364 |hl-IncSearch| i 'incsearch' highlighting
LemonBoya4399382022-04-09 21:04:08 +01004365 |hl-CurSearch| y current instance of last search pattern
Bram Moolenaar071d4272004-06-13 20:20:40 +00004366 |hl-Search| l last search pattern highlighting (see 'hlsearch')
4367 |hl-MoreMsg| m |more-prompt|
4368 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
Christian Brabandtfb745752024-05-07 21:19:03 +02004369 |hl-MsgArea| g |Command-line| and message area
Bram Moolenaar64486672010-05-16 15:46:46 +02004370 |hl-LineNr| n line number for ":number" and ":#" commands, and
4371 when 'number' or 'relativenumber' option is set.
Bram Moolenaarefae76a2019-10-27 22:54:58 +01004372 |hl-LineNrAbove| a line number above the cursor for when the
4373 'relativenumber' option is set.
4374 |hl-LineNrBelow| b line number below the cursor for when the
4375 'relativenumber' option is set.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01004376 |hl-CursorLineNr| N like n for when 'cursorline' or 'relativenumber' is
4377 set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004378 |hl-Question| r |hit-enter| prompt and yes/no questions
4379 |hl-StatusLine| s status line of current window |status-line|
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01004380 |hl-StatusLineNC| S status lines of not-current windows
Bram Moolenaar071d4272004-06-13 20:20:40 +00004381 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
4382 |hl-VertSplit| c column used to separate vertically split windows
4383 |hl-Visual| v Visual mode
4384 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
4385 Selection" Only X11 Gui's |gui-x11| and
4386 |xterm-clipboard|.
4387 |hl-WarningMsg| w warning messages
4388 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
4389 |hl-Folded| f line used for closed folds
4390 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00004391 |hl-DiffAdd| A added line in diff mode
4392 |hl-DiffChange| C changed line in diff mode
4393 |hl-DiffDelete| D deleted line in diff mode
4394 |hl-DiffText| T inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00004395 |hl-SignColumn| > column used for |signs|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004396 |hl-Conceal| - the placeholders used for concealed characters
4397 (see 'conceallevel')
Bram Moolenaar217ad922005-03-20 22:37:15 +00004398 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02004399 |hl-SpellCap| P word that should start with capital |spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00004400 |hl-SpellRare| R rare word |spell|
4401 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004402 |hl-Pmenu| + popup menu normal line
4403 |hl-PmenuSel| = popup menu selected line
Gianmaria Bajo6a7c7742023-03-10 16:35:53 +00004404 |hl-PmenuKind| [ popup menu "kind" normal line
4405 |hl-PmenuKindSel| ] popup menu "kind" selected line
h_east59858792023-10-25 22:47:05 +09004406 |hl-PmenuExtra| { popup menu "extra" normal line
4407 |hl-PmenuExtraSel| } popup menu "extra" selected line
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004408 |hl-PmenuSbar| x popup menu scrollbar
4409 |hl-PmenuThumb| X popup menu scrollbar thumb
glepnir40c1c332024-06-11 19:37:04 +02004410 |hl-PmenuMatch| k popup menu matched text
4411 |hl-PmenuMatchSel| < popup menu matched text in selected line
Bram Moolenaar071d4272004-06-13 20:20:40 +00004412
4413 The display modes are:
4414 r reverse (termcap entry "mr" and "me")
4415 i italic (termcap entry "ZH" and "ZR")
4416 b bold (termcap entry "md" and "me")
4417 s standout (termcap entry "so" and "se")
4418 u underline (termcap entry "us" and "ue")
Bram Moolenaar84f54632022-06-29 18:39:11 +01004419 c undercurl (termcap entry "Us" and "Ce")
4420 2 double underline (termcap entry "Ds" and "Ce")
4421 d dotted underline (termcap entry "ds" and "Ce")
4422 = dashed underline (termcap entry "Ds" and "Ce")
Bram Moolenaarcf4b00c2017-09-02 18:33:56 +02004423 t strikethrough (termcap entry "Ts" and "Te")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004424 n no highlighting
4425 - no highlighting
4426 : use a highlight group
4427 The default is used for occasions that are not included.
4428 If you want to change what the display modes do, see |dos-colors|
4429 for an example.
4430 When using the ':' display mode, this must be followed by the name of
4431 a highlight group. A highlight group can be used to define any type
4432 of highlighting, including using color. See |:highlight| on how to
4433 define one. The default uses a different group for each occasion.
4434 See |highlight-default| for the default highlight groups.
4435
Bram Moolenaar071d4272004-06-13 20:20:40 +00004436 *'history'* *'hi'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004437'history' 'hi' number (Vim default: 50, Vi default: 0,
4438 set to 200 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004439 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004440 A history of ":" commands, and a history of previous search patterns
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004441 is remembered. This option decides how many entries may be stored in
Bram Moolenaar071d4272004-06-13 20:20:40 +00004442 each of these histories (see |cmdline-editing|).
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004443 The maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004444 NOTE: This option is set to the Vi default value when 'compatible' is
4445 set and to the Vim default value when 'compatible' is reset.
4446
4447 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
4448'hkmap' 'hk' boolean (default off)
4449 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004450 {only available when compiled with the |+rightleft|
4451 feature}
4452 When on, the keyboard is mapped for the Hebrew character set.
4453 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
4454 toggle this option. See |rileft.txt|.
4455 NOTE: This option is reset when 'compatible' is set.
4456
4457 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
4458'hkmapp' 'hkp' boolean (default off)
4459 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004460 {only available when compiled with the |+rightleft|
4461 feature}
4462 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
4463 This is useful if you have a non-Hebrew keyboard.
4464 See |rileft.txt|.
4465 NOTE: This option is reset when 'compatible' is set.
4466
Bram Moolenaar036986f2017-03-16 17:41:02 +01004467 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
4468'hlsearch' 'hls' boolean (default off)
4469 global
Bram Moolenaar036986f2017-03-16 17:41:02 +01004470 {not available when compiled without the
4471 |+extra_search| feature}
4472 When there is a previous search pattern, highlight all its matches.
4473 The type of highlighting used can be set with the 'l' occasion in the
4474 'highlight' option. This uses the "Search" highlight group by
4475 default. Note that only the matching text is highlighted, any offsets
Bram Moolenaarcfa8f9a2022-06-03 21:59:47 +01004476 are not applied. If the "CurSearch" highlight group is set then the
4477 current match is highlighted with that.
Bram Moolenaar036986f2017-03-16 17:41:02 +01004478 See also: 'incsearch' and |:match|.
4479 When you get bored looking at the highlighted matches, you can turn it
4480 off with |:nohlsearch|. This does not change the option value, as
4481 soon as you use a search command, the highlighting comes back.
4482 'redrawtime' specifies the maximum time spent on finding matches.
4483 When the search pattern can match an end-of-line, Vim will try to
4484 highlight all of the matched text. However, this depends on where the
4485 search starts. This will be the first line in the window or the first
4486 line below a closed fold. A match in a previous line which is not
4487 drawn may not continue in a newly drawn line.
4488 You can specify whether the highlight status is restored on startup
4489 with the 'h' flag in 'viminfo' |viminfo-h|.
4490 NOTE: This option is reset when 'compatible' is set.
4491
Bram Moolenaar071d4272004-06-13 20:20:40 +00004492 *'icon'* *'noicon'*
4493'icon' boolean (default off, on when title can be restored)
4494 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004495 When on, the icon text of the window will be set to the value of
4496 'iconstring' (if it is not empty), or to the name of the file
4497 currently being edited. Only the last part of the name is used.
4498 Overridden by the 'iconstring' option.
4499 Only works if the terminal supports setting window icons (currently
4500 only X11 GUI and terminals with a non-empty 't_IS' option - these are
4501 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
4502 builtin termcap).
4503 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00004504 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00004505 X11.
Bram Moolenaar3a991dd2014-10-02 01:41:41 +02004506 For MS-Windows the icon can be changed, see |windows-icon|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004507
4508 *'iconstring'*
4509'iconstring' string (default "")
4510 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004511 When this option is not empty, it will be used for the icon text of
4512 the window. This happens only when the 'icon' option is on.
4513 Only works if the terminal supports setting window icon text
4514 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02004515 Does not work for MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004516 When Vim was compiled with HAVE_X11 defined, the original icon will be
4517 restored if possible |X11|.
4518 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004519 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004520 'titlestring' for example settings.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004521 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004522 {not available when compiled without the |+statusline| feature}
4523
4524 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
4525'ignorecase' 'ic' boolean (default off)
4526 global
Yee Cheng Chin2bbd0d32023-10-14 02:23:45 -07004527 Ignore case in search patterns, |cmdline-completion|, when
4528 searching in the tags file, and non-|Vim9| |expr-==|.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01004529 Also see 'smartcase' and 'tagcase'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004530 Can be overruled by using "\c" or "\C" in the pattern, see
4531 |/ignorecase|.
4532
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004533 *'imactivatefunc'* *'imaf'*
4534'imactivatefunc' 'imaf' string (default "")
4535 global
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004536 This option specifies a function that will be called to
Yegappan Lakshmanan7645da52021-12-04 14:02:30 +00004537 activate or deactivate the Input Method. The value can be the name of
4538 a function, a |lambda| or a |Funcref|. See |option-value-function| for
4539 more information.
Bram Moolenaaref8c6172020-07-01 15:12:44 +02004540 It is not used in the MS-Windows GUI version.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004541 The expression will be evaluated in the |sandbox| when set from a
4542 modeline, see |sandbox-option|.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004543
4544 Example: >
4545 function ImActivateFunc(active)
4546 if a:active
4547 ... do something
4548 else
4549 ... do something
4550 endif
4551 " return value is not used
4552 endfunction
4553 set imactivatefunc=ImActivateFunc
4554<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004555 *'imactivatekey'* *'imak'*
4556'imactivatekey' 'imak' string (default "")
4557 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004558 {only available when compiled with |+xim| and
Bram Moolenaar67c53842010-05-22 18:28:27 +02004559 |+GUI_GTK|} *E599*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004560 Specifies the key that your Input Method in X-Windows uses for
4561 activation. When this is specified correctly, vim can fully control
4562 IM with 'imcmdline', 'iminsert' and 'imsearch'.
4563 You can't use this option to change the activation key, the option
4564 tells Vim what the key is.
4565 Format:
4566 [MODIFIER_FLAG-]KEY_STRING
4567
4568 These characters can be used for MODIFIER_FLAG (case is ignored):
4569 S Shift key
4570 L Lock key
4571 C Control key
4572 1 Mod1 key
4573 2 Mod2 key
4574 3 Mod3 key
4575 4 Mod4 key
4576 5 Mod5 key
4577 Combinations are allowed, for example "S-C-space" or "SC-space" are
4578 both shift+ctrl+space.
4579 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
4580
4581 Example: >
4582 :set imactivatekey=S-space
4583< "S-space" means shift+space. This is the activation key for kinput2 +
4584 canna (Japanese), and ami (Korean).
4585
4586 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
4587'imcmdline' 'imc' boolean (default off)
4588 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004589 When set the Input Method is always on when starting to edit a command
4590 line, unless entering a search pattern (see 'imsearch' for that).
4591 Setting this option is useful when your input method allows entering
4592 English characters directly, e.g., when it's used to type accented
4593 characters with dead keys.
4594
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004595 *'imdisable'* *'imd'* *'noimdisable'* *'noimd'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004596'imdisable' 'imd' boolean (default off, on for some systems (SGI))
4597 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004598 When set the Input Method is never used. This is useful to disable
4599 the IM when it doesn't work properly.
4600 Currently this option is on by default for SGI/IRIX machines. This
4601 may change in later releases.
4602
4603 *'iminsert'* *'imi'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004604'iminsert' 'imi' number (default 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004605 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004606 Specifies whether :lmap or an Input Method (IM) is to be used in
4607 Insert mode. Valid values:
4608 0 :lmap is off and IM is off
4609 1 :lmap is ON and IM is off
4610 2 :lmap is off and IM is ON
Bram Moolenaar071d4272004-06-13 20:20:40 +00004611 To always reset the option to zero when leaving Insert mode with <Esc>
4612 this can be used: >
4613 :inoremap <ESC> <ESC>:set iminsert=0<CR>
4614< This makes :lmap and IM turn off automatically when leaving Insert
4615 mode.
4616 Note that this option changes when using CTRL-^ in Insert mode
4617 |i_CTRL-^|.
4618 The value is set to 1 when setting 'keymap' to a valid keymap name.
4619 It is also used for the argument of commands like "r" and "f".
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004620 The value 0 may not work correctly with Motif with some XIM
Bram Moolenaar071d4272004-06-13 20:20:40 +00004621 methods. Use 'imdisable' to disable XIM then.
4622
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004623 You can set 'imactivatefunc' and 'imstatusfunc' to handle IME/XIM
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004624 via external command if Vim is not compiled with the |+xim|,
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004625 |+multi_byte_ime| or |global-ime|.
4626
Bram Moolenaar071d4272004-06-13 20:20:40 +00004627 *'imsearch'* *'ims'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004628'imsearch' 'ims' number (default -1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004629 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004630 Specifies whether :lmap or an Input Method (IM) is to be used when
4631 entering a search pattern. Valid values:
4632 -1 the value of 'iminsert' is used, makes it look like
4633 'iminsert' is also used when typing a search pattern
4634 0 :lmap is off and IM is off
4635 1 :lmap is ON and IM is off
4636 2 :lmap is off and IM is ON
4637 Note that this option changes when using CTRL-^ in Command-line mode
4638 |c_CTRL-^|.
4639 The value is set to 1 when it is not -1 and setting the 'keymap'
4640 option to a valid keymap name.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004641 The value 0 may not work correctly with Motif with some XIM
Bram Moolenaar071d4272004-06-13 20:20:40 +00004642 methods. Use 'imdisable' to disable XIM then.
4643
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004644 *'imstatusfunc'* *'imsf'*
4645'imstatusfunc' 'imsf' string (default "")
4646 global
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004647 This option specifies a function that is called to obtain the status
4648 of Input Method. It must return a positive number when IME is active.
Yegappan Lakshmanan7645da52021-12-04 14:02:30 +00004649 The value can be the name of a function, a |lambda| or a |Funcref|.
4650 See |option-value-function| for more information.
Bram Moolenaaref8c6172020-07-01 15:12:44 +02004651 It is not used in the MS-Windows GUI version.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004652
4653 Example: >
4654 function ImStatusFunc()
4655 let is_active = ...do something
4656 return is_active ? 1 : 0
4657 endfunction
4658 set imstatusfunc=ImStatusFunc
4659<
4660 NOTE: This function is invoked very often. Keep it fast.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004661 The expression will be evaluated in the |sandbox| when set from a
4662 modeline, see |sandbox-option|.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004663
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004664 *'imstyle'* *'imst'*
4665'imstyle' 'imst' number (default 1)
4666 global
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004667 {only available when compiled with |+xim| and
4668 |+GUI_GTK|}
Bram Moolenaar37c64c72017-09-19 22:06:03 +02004669 This option specifies the input style of Input Method:
4670 0 use on-the-spot style
4671 1 over-the-spot style
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004672 See: |xim-input-style|
4673
Bram Moolenaar24a98a02017-09-27 22:23:55 +02004674 For a long time on-the-spot style had been used in the GTK version of
4675 vim, however, it is known that it causes troubles when using mappings,
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004676 |single-repeat|, etc. Therefore over-the-spot style becomes the
4677 default now. This should work fine for most people, however if you
4678 have any problem with it, try using on-the-spot style.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004679 The expression will be evaluated in the |sandbox| when set from a
4680 modeline, see |sandbox-option|.
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004681
Bram Moolenaar071d4272004-06-13 20:20:40 +00004682 *'include'* *'inc'*
4683'include' 'inc' string (default "^\s*#\s*include")
4684 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004685 {not available when compiled without the
4686 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004687 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00004688 pattern, just like for the "/" command (See |pattern|). The default
4689 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar1e015462005-09-25 22:16:38 +00004690 "]I", "[d", etc.
4691 Normally the 'isfname' option is used to recognize the file name that
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004692 comes after the matched pattern. But if "\zs" appears in the pattern
4693 then the text matched from "\zs" to the end, or until "\ze" if it
4694 appears, is used as the file name. Use this to include characters
4695 that are not in 'isfname', such as a space. You can then use
4696 'includeexpr' to process the matched text.
Bram Moolenaar1e015462005-09-25 22:16:38 +00004697 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004698
4699 *'includeexpr'* *'inex'*
4700'includeexpr' 'inex' string (default "")
4701 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004702 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004703 |+find_in_path| or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004704 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004705 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaarb59ae592022-11-23 23:46:31 +00004706 :setlocal includeexpr=substitute(v:fname,'\\.','/','g')
Bram Moolenaar071d4272004-06-13 20:20:40 +00004707< The "v:fname" variable will be set to the file name that was detected.
Bram Moolenaarb59ae592022-11-23 23:46:31 +00004708 Note the double backslash: the `:set` command first halves them, then
4709 one remains it the value, where "\." matches a dot literally. For
4710 simple character replacements `tr()` avoids the need for escaping: >
4711 :setlocal includeexpr=tr(v:fname,'.','/')
4712<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004713 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004714 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004715 Also used for |<cfile>|.
4716
Yegappan Lakshmanan8bb65f22021-12-26 10:51:39 +00004717 If the expression starts with s: or |<SID>|, then it is replaced with
4718 the script ID (|local-function|). Example: >
Bram Moolenaarb59ae592022-11-23 23:46:31 +00004719 setlocal includeexpr=s:MyIncludeExpr()
4720 setlocal includeexpr=<SID>SomeIncludeExpr()
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00004721< Otherwise, the expression is evaluated in the context of the script
4722 where the option was set, thus script-local items are available.
4723
Bram Moolenaara4e0b972022-10-01 19:43:52 +01004724 It is more efficient if the value is just a function call without
4725 arguments, see |expr-option-function|.
4726
Bram Moolenaar30b65812012-07-12 22:01:11 +02004727 The expression will be evaluated in the |sandbox| when set from a
4728 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004729 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004730
4731 It is not allowed to change text or jump to another window while
4732 evaluating 'includeexpr' |textlock|.
4733
Bram Moolenaar071d4272004-06-13 20:20:40 +00004734 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004735'incsearch' 'is' boolean (default off, set in |defaults.vim| if the
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01004736 |+reltime| feature is supported)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004737 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004738 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004739 |+extra_search| features}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004740 While typing a search command, show where the pattern, as it was typed
4741 so far, matches. The matched string is highlighted. If the pattern
4742 is invalid or not found, nothing is shown. The screen will be updated
4743 often, this is only useful on fast terminals.
Bram Moolenaarfc65cab2018-08-28 22:58:02 +02004744 Also applies to the pattern in commands: >
4745 :global
4746 :lvimgrep
4747 :lvimgrepadd
4748 :smagic
4749 :snomagic
4750 :sort
4751 :substitute
4752 :vglobal
4753 :vimgrep
4754 :vimgrepadd
4755< Note that the match will be shown, but the cursor will return to its
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004756 original position when no match is found and when pressing <Esc>. You
4757 still need to finish the search command with <Enter> to move the
4758 cursor to the match.
Bram Moolenaardc083282016-10-11 08:57:33 +02004759 You can use the CTRL-G and CTRL-T keys to move to the next and
4760 previous match. |c_CTRL-G| |c_CTRL-T|
Bram Moolenaar91a4e822008-01-19 14:59:58 +00004761 When compiled with the |+reltime| feature Vim only searches for about
4762 half a second. With a complicated pattern and/or a lot of text the
4763 match may not be found. This is to avoid that Vim hangs while you
4764 are typing the pattern.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004765 The highlighting can be set with the 'i' flag in 'highlight'.
Bram Moolenaar2f058492017-11-30 20:27:52 +01004766 When 'hlsearch' is on, all matched strings are highlighted too while
4767 typing a search command. See also: 'hlsearch'.
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004768 If you don't want to turn 'hlsearch' on, but want to highlight all
4769 matches while searching, you can turn on and off 'hlsearch' with
4770 autocmd. Example: >
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004771 augroup vimrc-incsearch-highlight
4772 autocmd!
Bram Moolenaarf8f8b2e2017-11-02 19:08:48 +01004773 autocmd CmdlineEnter /,\? :set hlsearch
4774 autocmd CmdlineLeave /,\? :set nohlsearch
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004775 augroup END
4776<
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004777 CTRL-L can be used to add one character from after the current match
Bram Moolenaara9dc3752010-07-11 20:46:53 +02004778 to the command line. If 'ignorecase' and 'smartcase' are set and the
4779 command line has no uppercase characters, the added character is
4780 converted to lowercase.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004781 CTRL-R CTRL-W can be used to add the word at the end of the current
4782 match, excluding the characters that were already typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004783 NOTE: This option is reset when 'compatible' is set.
4784
4785 *'indentexpr'* *'inde'*
4786'indentexpr' 'inde' string (default "")
4787 local to buffer
Bram Moolenaar8e145b82022-05-21 20:17:31 +01004788 {not available when compiled without the |+eval|
4789 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004790 Expression which is evaluated to obtain the proper indent for a line.
4791 It is used when a new line is created, for the |=| operator and
4792 in Insert mode as specified with the 'indentkeys' option.
4793 When this option is not empty, it overrules the 'cindent' and
Bram Moolenaar20f90cf2011-05-19 12:22:51 +02004794 'smartindent' indenting. When 'lisp' is set, this option is
Dominique Pellédf62c622024-07-15 20:29:59 +02004795 only used when 'lispoptions' contains "expr:1".
Bram Moolenaar071d4272004-06-13 20:20:40 +00004796 When 'paste' is set this option is not used for indenting.
4797 The expression is evaluated with |v:lnum| set to the line number for
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004798 which the indent is to be computed. The cursor is also in this line
Bram Moolenaar071d4272004-06-13 20:20:40 +00004799 when the expression is evaluated (but it may be moved around).
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00004800
Yegappan Lakshmanan8bb65f22021-12-26 10:51:39 +00004801 If the expression starts with s: or |<SID>|, then it is replaced with
4802 the script ID (|local-function|). Example: >
4803 set indentexpr=s:MyIndentExpr()
4804 set indentexpr=<SID>SomeIndentExpr()
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00004805< Otherwise, the expression is evaluated in the context of the script
4806 where the option was set, thus script-local items are available.
4807
Bram Moolenaara4e0b972022-10-01 19:43:52 +01004808 The advantage of using a function call without arguments is that it is
4809 faster, see |expr-option-function|.
4810
Bram Moolenaar071d4272004-06-13 20:20:40 +00004811 The expression must return the number of spaces worth of indent. It
4812 can return "-1" to keep the current indent (this means 'autoindent' is
4813 used for the indent).
4814 Functions useful for computing the indent are |indent()|, |cindent()|
4815 and |lispindent()|.
4816 The evaluation of the expression must not have side effects! It must
4817 not change the text, jump to another window, etc. Afterwards the
4818 cursor position is always restored, thus the cursor may be moved.
4819 Normally this option would be set to call a function: >
4820 :set indentexpr=GetMyIndent()
4821< Error messages will be suppressed, unless the 'debug' option contains
4822 "msg".
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004823 See |indent-expression|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01004824 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004825
Bram Moolenaar30b65812012-07-12 22:01:11 +02004826 The expression will be evaluated in the |sandbox| when set from a
4827 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004828 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004829
4830 It is not allowed to change text or jump to another window while
4831 evaluating 'indentexpr' |textlock|.
4832
Bram Moolenaar071d4272004-06-13 20:20:40 +00004833 *'indentkeys'* *'indk'*
Bram Moolenaarce655742019-01-31 14:12:57 +01004834'indentkeys' 'indk' string (default "0{,0},0),0],:,0#,!^F,o,O,e")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004835 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004836 A list of keys that, when typed in Insert mode, cause reindenting of
4837 the current line. Only happens if 'indentexpr' isn't empty.
4838 The format is identical to 'cinkeys', see |indentkeys-format|.
4839 See |C-indenting| and |indent-expression|.
4840
4841 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
4842'infercase' 'inf' boolean (default off)
4843 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004844 When doing keyword completion in insert mode |ins-completion|, and
Bram Moolenaar446cb832008-06-24 21:56:24 +00004845 'ignorecase' is also on, the case of the match is adjusted depending
4846 on the typed text. If the typed text contains a lowercase letter
4847 where the match has an upper case letter, the completed part is made
4848 lowercase. If the typed text has no lowercase letters and the match
4849 has a lowercase letter where the typed text has an uppercase letter,
4850 and there is a letter before it, the completed part is made uppercase.
4851 With 'noinfercase' the match is used as-is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004852
4853 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
4854'insertmode' 'im' boolean (default off)
4855 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004856 Makes Vim work in a way that Insert mode is the default mode. Useful
4857 if you want to use Vim as a modeless editor. Used for |evim|.
4858 These Insert mode commands will be useful:
4859 - Use the cursor keys to move around.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02004860 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|. When
Bram Moolenaar071d4272004-06-13 20:20:40 +00004861 this is a mapping, it is executed as if 'insertmode' was off.
4862 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004863 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00004864 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
4865 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004866
4867 These items change when 'insertmode' is set:
4868 - when starting to edit of a file, Vim goes to Insert mode.
4869 - <Esc> in Insert mode is a no-op and beeps.
4870 - <Esc> in Normal mode makes Vim go to Insert mode.
4871 - CTRL-L in Insert mode is a command, it is not inserted.
4872 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
4873 However, when <Esc> is used inside a mapping, it behaves like
4874 'insertmode' was not set. This was done to be able to use the same
4875 mappings with 'insertmode' set or not set.
4876 When executing commands with |:normal| 'insertmode' is not used.
4877
4878 NOTE: This option is reset when 'compatible' is set.
4879
4880 *'isfname'* *'isf'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004881'isfname' 'isf' string (default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004882 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
4883 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
4884 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
4885 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
4886 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
4887 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004888 The characters specified by this option are included in file names and
4889 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004890 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004891 Multi-byte characters 256 and above are always included, only the
4892 characters up to 255 are specified with this option.
4893 For UTF-8 the characters 0xa0 to 0xff are included as well.
Bram Moolenaar446cb832008-06-24 21:56:24 +00004894 Think twice before adding white space to this option. Although a
4895 space may appear inside a file name, the effect will be that Vim
4896 doesn't know where a file name starts or ends when doing completion.
4897 It most likely works better without a space in 'isfname'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004898
4899 Note that on systems using a backslash as path separator, Vim tries to
4900 do its best to make it work as you would expect. That is a bit
4901 tricky, since Vi originally used the backslash to escape special
4902 characters. Vim will not remove a backslash in front of a normal file
4903 name character on these systems, but it will on Unix and alikes. The
4904 '&' and '^' are not included by default, because these are special for
4905 cmd.exe.
4906
4907 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004908 Each part can be a single character number or a range. A range is two
4909 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004910 decimal number between 0 and 255 or the ASCII character itself (does
4911 not work for digits). Example:
4912 "_,-,128-140,#-43" (include '_' and '-' and the range
4913 128 to 140 and '#' to 43)
4914 If a part starts with '^', the following character number or range
4915 will be excluded from the option. The option is interpreted from left
4916 to right. Put the excluded character after the range where it is
4917 included. To include '^' itself use it as the last character of the
4918 option or the end of a range. Example:
4919 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
4920 If the character is '@', all characters where isalpha() returns TRUE
4921 are included. Normally these are the characters a to z and A to Z,
4922 plus accented characters. To include '@' itself use "@-@". Examples:
4923 "@,^a-z" All alphabetic characters, excluding lower
Bram Moolenaar446cb832008-06-24 21:56:24 +00004924 case ASCII letters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004925 "a-z,A-Z,@-@" All letters plus the '@' character.
4926 A comma can be included by using it where a character number is
4927 expected. Example:
4928 "48-57,,,_" Digits, comma and underscore.
4929 A comma can be excluded by prepending a '^'. Example:
4930 " -~,^,,9" All characters from space to '~', excluding
4931 comma, plus <Tab>.
4932 See |option-backslash| about including spaces and backslashes.
4933
4934 *'isident'* *'isi'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004935'isident' 'isi' string (default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004936 "@,48-57,_,128-167,224-235"
4937 otherwise: "@,48-57,_,192-255")
4938 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004939 The characters given by this option are included in identifiers.
4940 Identifiers are used in recognizing environment variables and after a
4941 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00004942 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004943 option. For '@' only characters up to 255 are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004944 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004945 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00004946 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
4947
4948 *'iskeyword'* *'isk'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004949'iskeyword' 'isk' string (Vim default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004950 "@,48-57,_,128-167,224-235"
4951 otherwise: "@,48-57,_,192-255"
4952 Vi default: "@,48-57,_")
4953 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004954 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004955 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004956 'isfname' for a description of the format of this option. For '@'
Bram Moolenaar4c295022021-05-02 17:19:11 +02004957 characters above 255 check the "word" character class (any character
4958 that is not white space or punctuation).
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004959 For C programs you could use "a-z,A-Z,48-57,_,.,-,>".
Bram Moolenaar071d4272004-06-13 20:20:40 +00004960 For a help file it is set to all non-blank printable characters except
4961 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
4962 command).
4963 When the 'lisp' option is on the '-' character is always included.
Bram Moolenaarb8060fe2016-01-19 22:29:28 +01004964 This option also influences syntax highlighting, unless the syntax
4965 uses |:syn-iskeyword|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004966 NOTE: This option is set to the Vi default value when 'compatible' is
4967 set and to the Vim default value when 'compatible' is reset.
4968
4969 *'isprint'* *'isp'*
Yee Cheng Chin92b59c62024-10-22 21:16:43 +02004970'isprint' 'isp' string (default for Win32 and VMS:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004971 "@,~-255"; otherwise: "@,161-255")
4972 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004973 The characters given by this option are displayed directly on the
4974 screen. It is also used for "\p" in a |pattern|. The characters from
4975 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
4976 even when they are not included in 'isprint' or excluded. See
4977 'isfname' for a description of the format of this option.
4978
4979 Non-printable characters are displayed with two characters:
4980 0 - 31 "^@" - "^_"
4981 32 - 126 always single characters
4982 127 "^?"
4983 128 - 159 "~@" - "~_"
4984 160 - 254 "| " - "|~"
4985 255 "~?"
4986 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
4987 displayed as <xx>, with the hexadecimal value of the byte.
4988 When 'display' contains "uhex" all unprintable characters are
4989 displayed as <xx>.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004990 The SpecialKey highlighting will be used for unprintable characters.
4991 |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004992
4993 Multi-byte characters 256 and above are always included, only the
4994 characters up to 255 are specified with this option. When a character
4995 is printable but it is not available in the current font, a
4996 replacement character will be shown.
4997 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
4998 There is no option to specify these characters.
4999
5000 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
5001'joinspaces' 'js' boolean (default on)
5002 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005003 Insert two spaces after a '.', '?' and '!' with a join command.
5004 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
5005 Otherwise only one space is inserted.
5006 NOTE: This option is set when 'compatible' is set.
5007
Yegappan Lakshmanan87018252023-09-20 20:20:04 +02005008 *'jumpoptions'* *'jop'*
5009'jumpoptions' 'jop' string (default "")
5010 global
5011 List of words that change the behavior of the |jumplist|.
5012 stack Make the jumplist behave like the tagstack.
5013 Relative location of entries in the jumplist is
5014 preserved at the cost of discarding subsequent entries
5015 when navigating backwards in the jumplist and then
5016 jumping to a location. |jumplist-stack|
5017
Bram Moolenaar071d4272004-06-13 20:20:40 +00005018 *'key'*
5019'key' string (default "")
5020 local to buffer
Bram Moolenaar996343d2010-07-04 22:20:21 +02005021 {only available when compiled with the |+cryptv|
5022 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005023 The key that is used for encrypting and decrypting the current buffer.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02005024 See |encryption| and 'cryptmethod'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005025 Careful: Do not set the key value by hand, someone might see the typed
5026 key. Use the |:X| command. But you can make 'key' empty: >
5027 :set key=
5028< It is not possible to get the value of this option with ":set key" or
5029 "echo &key". This is to avoid showing it to someone who shouldn't
5030 know. It also means you cannot see it yourself once you have set it,
5031 be careful not to make a typing error!
Yee Cheng Chin6ee7b522023-10-01 09:13:22 +02005032 You also cannot use |:set-=|, |:set+=|, |:set^=| on this option to
5033 prevent an attacker from guessing substrings in your key.
Bram Moolenaard58e9292011-02-09 17:07:58 +01005034 You can use "&key" in an expression to detect whether encryption is
5035 enabled. When 'key' is set it returns "*****" (five stars).
Bram Moolenaar071d4272004-06-13 20:20:40 +00005036
5037 *'keymap'* *'kmp'* *E544*
5038'keymap' 'kmp' string (default "")
5039 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005040 {only available when compiled with the |+keymap|
5041 feature}
5042 Name of a keyboard mapping. See |mbyte-keymap|.
5043 Setting this option to a valid keymap name has the side effect of
5044 setting 'iminsert' to one, so that the keymap becomes effective.
5045 'imsearch' is also set to one, unless it was -1
Millyae62fe52024-10-02 19:30:41 +02005046 Only alphanumeric characters, '.', '-' and '_' can be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005047
5048 *'keymodel'* *'km'*
5049'keymodel' 'km' string (default "")
5050 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01005051 List of comma-separated words, which enable special things that keys
Bram Moolenaar071d4272004-06-13 20:20:40 +00005052 can do. These values can be used:
5053 startsel Using a shifted special key starts selection (either
5054 Select mode or Visual mode, depending on "key" being
5055 present in 'selectmode').
5056 stopsel Using a not-shifted special key stops selection.
5057 Special keys in this context are the cursor keys, <End>, <Home>,
5058 <PageUp> and <PageDown>.
5059 The 'keymodel' option is set by the |:behave| command.
5060
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005061 *'keyprotocol'* *'kpc'*
5062'keyprotocol' 'kpc' string (default: see below)
5063 global
5064 Specifies what keyboard protocol to use depending on the value of
5065 'term'. The supported keyboard protocols names are:
5066 none whatever the terminal uses
5067 mok2 modifyOtherKeys level 2, as supported by xterm
5068 kitty Kitty keyboard protocol, as supported by Kitty
5069
Bram Moolenaara87749e2022-11-30 10:23:17 +00005070 The option value is a list of comma separated items. Each item has
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005071 a pattern that is matched against the 'term' option, a colon and the
5072 protocol name to be used. To illustrate this, the default value would
5073 be set with: >
5074 set keyprotocol=kitty:kitty,foot:kitty,wezterm:kitty,xterm:mok2
5075
5076< This means that when 'term' contains "kitty, "foot" or "wezterm"
5077 somewhere then the "kitty" protocol is used. When 'term' contains
Bram Moolenaar938ae282023-02-20 20:44:55 +00005078 "xterm" somewhere, then the "mok2" protocol is used.
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005079
5080 The first match is used, thus if you want to have "kitty" use the
5081 kitty protocol, but "badkitty" not, then you should match "badkitty"
5082 first and use the "none" value: >
5083 set keyprotocol=badkitty:none,kitty:kitty
5084<
5085 The option is used after 'term' has been changed. First the termcap
5086 entries are set, possibly using the builtin list, see |builtin-terms|.
5087 Then this option is inspected and if there is a match and a protocol
5088 is specified the following happens:
5089 none Nothing, the regular t_TE and t_TI values remain
5090
5091 mok2 The t_TE value is changed to:
5092 CSI >4;m disables modifyOtherKeys
5093 The t_TI value is changed to:
5094 CSI >4;2m enables modifyOtherKeys
Bram Moolenaara87749e2022-11-30 10:23:17 +00005095 CSI ?4m request the modifyOtherKeys state
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005096
5097 kitty The t_TE value is changed to:
5098 CSI >4;m disables modifyOtherKeys
Bram Moolenaara87749e2022-11-30 10:23:17 +00005099 CSI =0;1u disables the kitty keyboard protocol
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005100 The t_TI value is changed to:
Bram Moolenaara87749e2022-11-30 10:23:17 +00005101 CSI =1;1u enables the kitty keyboard protocol
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005102 CSI ?u request kitty keyboard protocol state
5103 CSI >c request the termresponse
5104
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00005105 If you notice problems, such as characters being displayed that
5106 disappear after `CTRL-L`, you might want to try making this option
5107 empty. Then set the 'term' option to have it take effect: >
5108 set keyprotocol=
5109 let &term = &term
Bram Moolenaarbe4e0162023-02-02 13:59:48 +00005110<
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005111
Bram Moolenaar071d4272004-06-13 20:20:40 +00005112 *'keywordprg'* *'kp'*
5113'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02005114 VMS: "help")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005115 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005116 Program to use for the |K| command. Environment variables are
5117 expanded |:set_env|. ":help" may be used to access the Vim internal
5118 help. (Note that previously setting the global option to the empty
5119 value did this, which is now deprecated.)
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02005120 When the first character is ":", the command is invoked as a Vim
Bram Moolenaarb529cfb2022-07-25 15:42:07 +01005121 Ex command with [count] added as an argument if it is not zero.
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02005122 When "man", "man -s" or an Ex command is used, Vim will automatically
5123 translate a count for the "K" command and pass it as the first
5124 argument. For "man -s" the "-s" is removed when there is no count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005125 See |option-backslash| about including spaces and backslashes.
5126 Example: >
5127 :set keywordprg=man\ -s
5128< This option cannot be set from a |modeline| or in the |sandbox|, for
5129 security reasons.
5130
5131 *'langmap'* *'lmap'* *E357* *E358*
5132'langmap' 'lmap' string (default "")
5133 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005134 {only available when compiled with the |+langmap|
5135 feature}
5136 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005137 mode. When you are typing text in Insert mode the characters are
Bram Moolenaarfa735342016-01-03 22:14:44 +01005138 inserted directly. When in Normal mode the 'langmap' option takes
Bram Moolenaar071d4272004-06-13 20:20:40 +00005139 care of translating these special characters to the original meaning
5140 of the key. This means you don't have to change the keyboard mode to
5141 be able to execute Normal mode commands.
5142 This is the opposite of the 'keymap' option, where characters are
5143 mapped in Insert mode.
Bram Moolenaarb17893a2020-03-14 08:19:51 +01005144 Also consider setting 'langremap' to off, to prevent 'langmap' from
5145 applying to characters resulting from a mapping.
Bram Moolenaare968e362014-05-13 20:23:24 +02005146 This option cannot be set from a |modeline| or in the |sandbox|, for
5147 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005148
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00005149 Example (for Greek, in UTF-8): *greek* >
5150 :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 +00005151< Example (exchanges meaning of z and y for commands): >
5152 :set langmap=zy,yz,ZY,YZ
5153<
5154 The 'langmap' option is a list of parts, separated with commas. Each
5155 part can be in one of two forms:
5156 1. A list of pairs. Each pair is a "from" character immediately
5157 followed by the "to" character. Examples: "aA", "aAbBcC".
Dominique Pellédf62c622024-07-15 20:29:59 +02005158 2. A list of "from" characters, a semicolon and a list of "to"
Bram Moolenaar071d4272004-06-13 20:20:40 +00005159 characters. Example: "abc;ABC"
5160 Example: "aA,fgh;FGH,cCdDeE"
5161 Special characters need to be preceded with a backslash. These are
Bram Moolenaar4f4d51a2020-10-11 13:57:40 +02005162 ";", ',', '"', '|' and backslash itself.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005163
5164 This will allow you to activate vim actions without having to switch
5165 back and forth between the languages. Your language characters will
5166 be understood as normal vim English characters (according to the
5167 langmap mappings) in the following cases:
5168 o Normal/Visual mode (commands, buffer/register names, user mappings)
5169 o Insert/Replace Mode: Register names after CTRL-R
5170 o Insert/Replace Mode: Mappings
5171 Characters entered in Command-line mode will NOT be affected by
5172 this option. Note that this option can be changed at any time
5173 allowing to switch between mappings for different languages/encodings.
5174 Use a mapping to avoid having to type it each time!
5175
5176 *'langmenu'* *'lm'*
5177'langmenu' 'lm' string (default "")
5178 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005179 {only available when compiled with the |+menu| and
5180 |+multi_lang| features}
5181 Language to use for menu translation. Tells which file is loaded
5182 from the "lang" directory in 'runtimepath': >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00005183 "lang/menu_" .. &langmenu .. ".vim"
Bram Moolenaar071d4272004-06-13 20:20:40 +00005184< (without the spaces). For example, to always use the Dutch menus, no
5185 matter what $LANG is set to: >
5186 :set langmenu=nl_NL.ISO_8859-1
5187< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005188 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005189 If your $LANG is set to a non-English language but you do want to use
5190 the English menus: >
5191 :set langmenu=none
5192< This option must be set before loading menus, switching on filetype
5193 detection or syntax highlighting. Once the menus are defined setting
5194 this option has no effect. But you could do this: >
5195 :source $VIMRUNTIME/delmenu.vim
5196 :set langmenu=de_DE.ISO_8859-1
5197 :source $VIMRUNTIME/menu.vim
5198< Warning: This deletes all menus that you defined yourself!
5199
Bram Moolenaard94464e2015-11-02 15:28:18 +01005200 *'langnoremap'* *'lnr'* *'nolangnoremap'* *'nolnr'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02005201'langnoremap' 'lnr' boolean (default off, set in |defaults.vim|)
Bram Moolenaar4391cf92014-11-05 17:44:52 +01005202 global
Bram Moolenaar4391cf92014-11-05 17:44:52 +01005203 {only available when compiled with the |+langmap|
5204 feature}
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02005205 This is just like 'langremap' but with the value inverted. It only
5206 exists for backwards compatibility. When setting 'langremap' then
5207 'langnoremap' is set to the inverted value, and the other way around.
5208
5209 *'langremap'* *'lrm'* *'nolangremap'* *'nolrm'*
Bram Moolenaarb17893a2020-03-14 08:19:51 +01005210'langremap' 'lrm' boolean (default on, set to off in |defaults.vim|)
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02005211 global
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02005212 {only available when compiled with the |+langmap|
5213 feature}
5214 When off, setting 'langmap' does not apply to characters resulting from
Bram Moolenaar4391cf92014-11-05 17:44:52 +01005215 a mapping. This basically means, if you noticed that setting
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02005216 'langmap' disables some of your mappings, try resetting this option.
5217 This option defaults to on for backwards compatibility. Set it off if
Bram Moolenaar4391cf92014-11-05 17:44:52 +01005218 that works for you to avoid mappings to break.
5219
Bram Moolenaar071d4272004-06-13 20:20:40 +00005220 *'laststatus'* *'ls'*
5221'laststatus' 'ls' number (default 1)
5222 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005223 The value of this option influences when the last window will have a
5224 status line:
5225 0: never
5226 1: only if there are at least two windows
5227 2: always
5228 The screen looks nicer with a status line if you have several
5229 windows, but it takes another screen line. |status-line|
5230
5231 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
5232'lazyredraw' 'lz' boolean (default off)
5233 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005234 When this option is set, the screen will not be redrawn while
5235 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005236 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00005237 update use |:redraw|.
Bram Moolenaara57b5532022-06-24 11:48:03 +01005238 This may occasionally cause display errors. It is only meant to be set
5239 temporarily when performing an operation where redrawing may cause
Dominique Pellédf62c622024-07-15 20:29:59 +02005240 flickering or cause a slowdown.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005241
5242 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
5243'linebreak' 'lbr' boolean (default off)
5244 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02005245 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005246 feature}
Bram Moolenaar946e27a2014-06-25 18:50:27 +02005247 If on, Vim will wrap long lines at a character in 'breakat' rather
Bram Moolenaar071d4272004-06-13 20:20:40 +00005248 than at the last character that fits on the screen. Unlike
5249 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
Bram Moolenaar946e27a2014-06-25 18:50:27 +02005250 it only affects the way the file is displayed, not its contents.
5251 If 'breakindent' is set, line is visually indented. Then, the value
5252 of 'showbreak' is used to put in front of wrapped lines. This option
Bram Moolenaar86b17e92014-07-02 20:00:47 +02005253 is not used when the 'wrap' option is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005254 Note that <Tab> characters after an <EOL> are mostly not displayed
5255 with the right amount of white space.
5256
5257 *'lines'* *E593*
5258'lines' number (default 24 or terminal height)
5259 global
5260 Number of lines of the Vim window.
5261 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00005262 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005263 When Vim is running in the GUI or in a resizable window, setting this
5264 option will cause the window size to be changed. When you only want
5265 to use the size for the GUI, put the command in your |gvimrc| file.
5266 Vim limits the number of lines to what fits on the screen. You can
5267 use this command to get the tallest window possible: >
5268 :set lines=999
Bram Moolenaarf4d11452005-12-02 00:46:37 +00005269< Minimum value is 2, maximum value is 1000.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02005270 If you get fewer lines than expected, check the 'guiheadroom' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005271 When you set this option and Vim is unable to change the physical
5272 number of lines of the display, the display may be messed up.
5273
5274 *'linespace'* *'lsp'*
5275'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
5276 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005277 {only in the GUI}
5278 Number of pixel lines inserted between characters. Useful if the font
5279 uses the full character cell height, making lines touch each other.
5280 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005281 With some fonts there can be too much room between lines (to have
5282 space for ascents and descents). Then it makes sense to set
5283 'linespace' to a negative value. This may cause display problems
5284 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00005285
5286 *'lisp'* *'nolisp'*
5287'lisp' boolean (default off)
5288 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005289 Lisp mode: When <Enter> is typed in insert mode set the indent for
5290 the next line to Lisp standards (well, sort of). Also happens with
5291 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
5292 flag in 'cpoptions' changes the method of indenting: Vi compatible or
5293 better. Also see 'lispwords'.
5294 The '-' character is included in keyword characters. Redefines the
5295 "=" operator to use this same indentation algorithm rather than
5296 calling an external program if 'equalprg' is empty.
5297 This option is not used when 'paste' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005298
Bram Moolenaar49846fb2022-10-15 16:05:33 +01005299 *'lispoptions'* *'lop'*
5300'lispoptions' 'lop' string (default "")
5301 local to buffer
5302 Comma-separated list of items that influence the Lisp indenting when
5303 enabled with the |'lisp'| option. Currently only one item is
5304 supported:
5305 expr:1 use 'indentexpr' for Lisp indenting when it is set
5306 expr:0 do not use 'indentexpr' for Lisp indenting (default)
5307 Note that when using 'indentexpr' the `=` operator indents all the
5308 lines, otherwise the first line is not indented (Vi-compatible).
5309
Bram Moolenaar071d4272004-06-13 20:20:40 +00005310 *'lispwords'* *'lw'*
5311'lispwords' 'lw' string (default is very long)
Bram Moolenaaraf6c1312014-03-12 18:55:58 +01005312 global or local to buffer |global-local|
Bram Moolenaar48c3f4e2022-08-08 15:42:38 +01005313 Comma-separated list of words that influence the Lisp indenting when
5314 enabled with the |'lisp'| option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005315
5316 *'list'* *'nolist'*
5317'list' boolean (default off)
5318 local to window
Bram Moolenaar113cb512021-11-07 20:27:04 +00005319 List mode: By default show tabs as CTRL-I is displayed, display $
5320 after end of line. Useful to see the difference between tabs and
5321 spaces and for trailing blanks. Further changed by the 'listchars'
5322 option.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005323
5324 The cursor is displayed at the start of the space a Tab character
5325 occupies, not at the end as usual in Normal mode. To get this cursor
5326 position while displaying Tabs with spaces, use: >
Bram Moolenaardd007ed2013-07-09 15:44:17 +02005327 :set list lcs=tab:\ \
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005328<
5329 Note that list mode will also affect formatting (set with 'textwidth'
5330 or 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005331 changing the way tabs are displayed.
5332
5333 *'listchars'* *'lcs'*
5334'listchars' 'lcs' string (default "eol:$")
Bram Moolenaareed9d462021-02-15 20:38:25 +01005335 global or local to window |global-local|
Bram Moolenaarf9d5ca12010-08-01 16:13:51 +02005336 Strings to use in 'list' mode and for the |:list| command. It is a
zeertzjq6a8d2e12024-01-17 20:54:49 +01005337 comma-separated list of string settings. *E1511*
Bram Moolenaar79278362015-04-21 18:33:48 +02005338 *lcs-eol*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005339 eol:c Character to show at the end of each line. When
5340 omitted, there is no extra character at the end of the
5341 line.
Bram Moolenaar79278362015-04-21 18:33:48 +02005342 *lcs-tab*
Bram Moolenaar83a52172019-01-16 22:41:54 +01005343 tab:xy[z] Two or three characters to be used to show a tab.
5344 The third character is optional.
5345
5346 tab:xy The 'x' is always used, then 'y' as many times as will
5347 fit. Thus "tab:>-" displays:
5348 >
5349 >-
5350 >--
5351 etc.
5352
5353 tab:xyz The 'z' is always used, then 'x' is prepended, and
5354 then 'y' is used as many times as will fit. Thus
5355 "tab:<->" displays:
5356 >
5357 <>
5358 <->
5359 <-->
5360 etc.
5361
5362 When "tab:" is omitted, a tab is shown as ^I.
Bram Moolenaar79278362015-04-21 18:33:48 +02005363 *lcs-space*
5364 space:c Character to show for a space. When omitted, spaces
5365 are left blank.
zeertzjqf14b8ba2021-09-10 16:58:30 +02005366 *lcs-multispace*
5367 multispace:c...
Bram Moolenaarbe4e0162023-02-02 13:59:48 +00005368 One or more characters to use cyclically to show for
5369 multiple consecutive spaces. Overrides the "space"
zeertzjqf14b8ba2021-09-10 16:58:30 +02005370 setting, except for single spaces. When omitted, the
5371 "space" setting is used. For example,
5372 `:set listchars=multispace:---+` shows ten consecutive
5373 spaces as:
Bram Moolenaaraca12fd2022-06-07 10:16:15 +01005374 ---+---+-- ~
Bram Moolenaar91478ae2021-02-03 15:58:13 +01005375 *lcs-lead*
5376 lead:c Character to show for leading spaces. When omitted,
zeertzjqf14b8ba2021-09-10 16:58:30 +02005377 leading spaces are blank. Overrides the "space" and
5378 "multispace" settings for leading spaces. You can
5379 combine it with "tab:", for example: >
Bram Moolenaar942db232021-02-13 18:14:48 +01005380 :set listchars+=tab:>-,lead:.
Bram Moolenaaraca12fd2022-06-07 10:16:15 +01005381< *lcs-leadmultispace*
5382 leadmultispace:c...
Bram Moolenaar069a7d52022-06-27 22:16:08 +01005383 Like the |lcs-multispace| value, but for leading
5384 spaces only. Also overrides |lcs-lead| for leading
5385 multiple spaces.
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01005386 `:set listchars=leadmultispace:---+` shows ten
5387 consecutive leading spaces as:
Bram Moolenaaraca12fd2022-06-07 10:16:15 +01005388 ---+---+--XXX ~
5389 Where "XXX" denotes the first non-blank characters in
5390 the line.
5391 *lcs-trail*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005392 trail:c Character to show for trailing spaces. When omitted,
zeertzjqf14b8ba2021-09-10 16:58:30 +02005393 trailing spaces are blank. Overrides the "space" and
5394 "multispace" settings for trailing spaces.
Bram Moolenaar79278362015-04-21 18:33:48 +02005395 *lcs-extends*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005396 extends:c Character to show in the last column, when 'wrap' is
5397 off and the line continues beyond the right of the
5398 screen.
Bram Moolenaar79278362015-04-21 18:33:48 +02005399 *lcs-precedes*
Bram Moolenaarbffba7f2019-09-20 17:00:17 +02005400 precedes:c Character to show in the first visible column of the
5401 physical line, when there is text preceding the
5402 character visible in the first column.
Bram Moolenaar79278362015-04-21 18:33:48 +02005403 *lcs-conceal*
Bram Moolenaar860cae12010-06-05 23:22:07 +02005404 conceal:c Character to show in place of concealed text, when
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02005405 'conceallevel' is set to 1.
Bram Moolenaar79278362015-04-21 18:33:48 +02005406 *lcs-nbsp*
Bram Moolenaar73284b92015-05-04 17:28:22 +02005407 nbsp:c Character to show for a non-breakable space character
5408 (0xA0 (160 decimal) and U+202F). Left blank when
5409 omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005410
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005411 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00005412 be used when 'encoding' is "utf-8", otherwise only printable
zeertzjq6a8d2e12024-01-17 20:54:49 +01005413 characters are allowed. All characters must be single width. *E1512*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005414
Bram Moolenaar93ff6722021-10-16 17:51:40 +01005415 Each character can be specified as hex: >
5416 set listchars=eol:\\x24
5417 set listchars=eol:\\u21b5
5418 set listchars=eol:\\U000021b5
5419< Note that a double backslash is used. The number of hex characters
5420 must be exactly 2 for \\x, 4 for \\u and 8 for \\U.
5421
Bram Moolenaar071d4272004-06-13 20:20:40 +00005422 Examples: >
5423 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005424 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00005425 :set lcs=extends:>,precedes:<
5426< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaar34cc7d82021-09-21 20:09:51 +02005427 "precedes". "SpecialKey" will be used for "tab", "nbsp", "space",
5428 "multispace", "lead" and "trail".
Bram Moolenaar02467872007-05-06 13:22:01 +00005429 |hl-NonText| |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005430
5431 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
5432'loadplugins' 'lpl' boolean (default on)
5433 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005434 When on the plugin scripts are loaded when starting up |load-plugins|.
5435 This option can be reset in your |vimrc| file to disable the loading
5436 of plugins.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02005437 Note that using the "-u NONE", "-u DEFAULTS" and "--noplugin" command
5438 line arguments reset this option. See |-u| and |--noplugin|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005439
Bram Moolenaard94464e2015-11-02 15:28:18 +01005440 *'luadll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01005441'luadll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01005442 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01005443 {only available when compiled with the |+lua/dyn|
5444 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005445 Specifies the name of the Lua shared library. The default is
5446 DYNAMIC_LUA_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005447 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01005448 This option cannot be set from a |modeline| or in the |sandbox|, for
5449 security reasons.
5450
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00005451 *'macatsui'* *'nomacatsui'*
5452'macatsui' boolean (default on)
5453 global
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02005454 {not supported}
5455 No longer supported, as the Mac OS X GUI code was removed.
Bram Moolenaar02467872007-05-06 13:22:01 +00005456
Bram Moolenaar071d4272004-06-13 20:20:40 +00005457 *'magic'* *'nomagic'*
5458'magic' boolean (default on)
5459 global
5460 Changes the special characters that can be used in search patterns.
5461 See |pattern|.
Bram Moolenaar64d8e252016-09-06 22:12:34 +02005462 WARNING: Switching this option off most likely breaks plugins! That
5463 is because many patterns assume it's on and will fail when it's off.
5464 Only switch it off when working with old Vi scripts. In any other
5465 situation write patterns that work when 'magic' is on. Include "\M"
5466 when you want to |/\M|.
Bram Moolenaar4072ba52020-12-23 13:56:35 +01005467 In |Vim9| script the value of 'magic' is ignored, patterns behave like
5468 it is always set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005469
5470 *'makeef'* *'mef'*
5471'makeef' 'mef' string (default: "")
5472 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005473 {not available when compiled without the |+quickfix|
5474 feature}
5475 Name of the errorfile for the |:make| command (see |:make_makeprg|)
5476 and the |:grep| command.
5477 When it is empty, an internally generated temp file will be used.
5478 When "##" is included, it is replaced by a number to make the name
5479 unique. This makes sure that the ":make" command doesn't overwrite an
5480 existing file.
5481 NOT used for the ":cf" command. See 'errorfile' for that.
5482 Environment variables are expanded |:set_env|.
5483 See |option-backslash| about including spaces and backslashes.
5484 This option cannot be set from a |modeline| or in the |sandbox|, for
5485 security reasons.
5486
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01005487 *'makeencoding'* *'menc'*
5488'makeencoding' 'menc' string (default "")
5489 global or local to buffer |global-local|
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01005490 Encoding used for reading the output of external commands. When empty,
5491 encoding is not converted.
5492 This is used for `:make`, `:lmake`, `:grep`, `:lgrep`, `:grepadd`,
5493 `:lgrepadd`, `:cfile`, `:cgetfile`, `:caddfile`, `:lfile`, `:lgetfile`,
5494 and `:laddfile`.
5495
5496 This would be mostly useful when you use MS-Windows and set 'encoding'
5497 to "utf-8". If |+iconv| is enabled and GNU libiconv is used, setting
5498 'makeencoding' to "char" has the same effect as setting to the system
5499 locale encoding. Example: >
5500 :set encoding=utf-8
5501 :set makeencoding=char " system locale is used
5502<
Bram Moolenaar071d4272004-06-13 20:20:40 +00005503 *'makeprg'* *'mp'*
5504'makeprg' 'mp' string (default "make", VMS: "MMS")
5505 global or local to buffer |global-local|
Bram Moolenaar02467872007-05-06 13:22:01 +00005506 Program to use for the ":make" command. See |:make_makeprg|.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01005507 This option may contain '%' and '#' characters (see |:_%| and |:_#|),
5508 which are expanded to the current and alternate file name. Use |::S|
Bram Moolenaar26df0922014-02-23 23:39:13 +01005509 to escape file names in case they contain special characters.
Bram Moolenaar02467872007-05-06 13:22:01 +00005510 Environment variables are expanded |:set_env|. See |option-backslash|
5511 about including spaces and backslashes.
5512 Note that a '|' must be escaped twice: once for ":set" and once for
5513 the interpretation of a command. When you use a filter called
5514 "myfilter" do it like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005515 :set makeprg=gmake\ \\\|\ myfilter
5516< The placeholder "$*" can be given (even multiple times) to specify
5517 where the arguments will be included, for example: >
5518 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
5519< This option cannot be set from a |modeline| or in the |sandbox|, for
5520 security reasons.
5521
5522 *'matchpairs'* *'mps'*
5523'matchpairs' 'mps' string (default "(:),{:},[:]")
5524 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005525 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01005526 other.
5527 Only character pairs are allowed that are different, thus you cannot
5528 jump between two double quotes.
5529 The characters must be separated by a colon.
Bram Moolenaar02467872007-05-06 13:22:01 +00005530 The pairs must be separated by a comma. Example for including '<' and
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02005531 '>' (for HTML): >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005532 :set mps+=<:>
5533
5534< A more exotic example, to jump between the '=' and ';' in an
5535 assignment, useful for languages like C and Java: >
5536 :au FileType c,cpp,java set mps+==:;
5537
5538< For a more advanced way of using "%", see the matchit.vim plugin in
Bram Moolenaar01164a62017-11-02 22:58:42 +01005539 the $VIMRUNTIME/pack/dist/opt/matchit directory. |add-local-help|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005540
5541 *'matchtime'* *'mat'*
5542'matchtime' 'mat' number (default 5)
5543 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005544 Tenths of a second to show the matching paren, when 'showmatch' is
5545 set. Note that this is not in milliseconds, like other options that
5546 set a time. This is to be compatible with Nvi.
5547
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005548 *'maxcombine'* *'mco'*
5549'maxcombine' 'mco' number (default 2)
5550 global
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005551 The maximum number of combining characters supported for displaying.
5552 Only used when 'encoding' is "utf-8".
5553 The default is OK for most languages. Hebrew may require 4.
5554 Maximum value is 6.
5555 Even when this option is set to 2 you can still edit text with more
5556 combining characters, you just can't see them. Use |g8| or |ga|.
5557 See |mbyte-combining|.
5558
Bram Moolenaar071d4272004-06-13 20:20:40 +00005559 *'maxfuncdepth'* *'mfd'*
5560'maxfuncdepth' 'mfd' number (default 100)
5561 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02005562 {not available when compiled without the |+eval|
Bram Moolenaar02467872007-05-06 13:22:01 +00005563 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005564 Maximum depth of function calls for user functions. This normally
5565 catches endless recursion. When using a recursive function with
5566 more depth, set 'maxfuncdepth' to a bigger number. But this will use
5567 more memory, there is the danger of failing when memory is exhausted.
Bram Moolenaarbc2eada2017-01-02 21:27:47 +01005568 Increasing this limit above 200 also changes the maximum for Ex
Bram Moolenaar0b0f0992018-05-22 21:41:30 +02005569 command recursion, see |E169|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005570 See also |:function|.
zeertzjqfe583b12023-12-21 16:59:26 +01005571 Also used for maximum depth of callback functions.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005572
5573 *'maxmapdepth'* *'mmd'* *E223*
5574'maxmapdepth' 'mmd' number (default 1000)
5575 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005576 Maximum number of times a mapping is done without resulting in a
5577 character to be used. This normally catches endless mappings, like
5578 ":map x y" with ":map y x". It still does not catch ":map g wg",
5579 because the 'w' is used before the next mapping is done. See also
5580 |key-mapping|.
5581
5582 *'maxmem'* *'mm'*
5583'maxmem' 'mm' number (default between 256 to 5120 (system
5584 dependent) or half the amount of memory
5585 available)
5586 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005587 Maximum amount of memory (in Kbyte) to use for one buffer. When this
5588 limit is reached allocating extra memory for a buffer will cause
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005589 other memory to be freed.
5590 The maximum usable value is about 2000000. Use this to work without a
5591 limit.
5592 The value is ignored when 'swapfile' is off.
5593 Also see 'maxmemtot'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005594
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005595 *'maxmempattern'* *'mmp'*
5596'maxmempattern' 'mmp' number (default 1000)
5597 global
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005598 Maximum amount of memory (in Kbyte) to use for pattern matching.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005599 The maximum value is about 2000000. Use this to work without a limit.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005600 *E363*
Bram Moolenaar02467872007-05-06 13:22:01 +00005601 When Vim runs into the limit it gives an error message and mostly
5602 behaves like CTRL-C was typed.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005603 Running into the limit often means that the pattern is very
5604 inefficient or too complex. This may already happen with the pattern
5605 "\(.\)*" on a very long line. ".*" works much better.
Bram Moolenaarfd358112018-07-07 23:21:31 +02005606 Might also happen on redraw, when syntax rules try to match a complex
5607 text structure.
5608 Vim may run out of memory before hitting the 'maxmempattern' limit, in
5609 which case you get an "Out of memory" error instead.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005610
Bram Moolenaar071d4272004-06-13 20:20:40 +00005611 *'maxmemtot'* *'mmt'*
5612'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
5613 dependent) or half the amount of memory
5614 available)
5615 global
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005616 Maximum amount of memory in Kbyte to use for all buffers together.
5617 The maximum usable value is about 2000000 (2 Gbyte). Use this to work
Bram Moolenaarfa735342016-01-03 22:14:44 +01005618 without a limit.
5619 On 64 bit machines higher values might work. But hey, do you really
5620 need more than 2 Gbyte for text editing? Keep in mind that text is
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005621 stored in the swap file, one can edit files > 2 Gbyte anyway. We do
Bram Moolenaarfa735342016-01-03 22:14:44 +01005622 need the memory to store undo info.
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005623 Buffers with 'swapfile' off still count to the total amount of memory
5624 used.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005625 Also see 'maxmem'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005626
5627 *'menuitems'* *'mis'*
5628'menuitems' 'mis' number (default 25)
5629 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005630 {not available when compiled without the |+menu|
5631 feature}
5632 Maximum number of items to use in a menu. Used for menus that are
5633 generated from a list of items, e.g., the Buffers menu. Changing this
5634 option has no direct effect, the menu must be refreshed first.
5635
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005636 *'mkspellmem'* *'msm'*
5637'mkspellmem' 'msm' string (default "460000,2000,500")
5638 global
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005639 {not available when compiled without the |+syntax|
5640 feature}
5641 Parameters for |:mkspell|. This tunes when to start compressing the
5642 word tree. Compression can be slow when there are many words, but
5643 it's needed to avoid running out of memory. The amount of memory used
5644 per word depends very much on how similar the words are, that's why
5645 this tuning is complicated.
5646
5647 There are three numbers, separated by commas:
5648 {start},{inc},{added}
5649
5650 For most languages the uncompressed word tree fits in memory. {start}
5651 gives the amount of memory in Kbyte that can be used before any
5652 compression is done. It should be a bit smaller than the amount of
5653 memory that is available to Vim.
5654
5655 When going over the {start} limit the {inc} number specifies the
5656 amount of memory in Kbyte that can be allocated before another
5657 compression is done. A low number means compression is done after
5658 less words are added, which is slow. A high number means more memory
5659 will be allocated.
5660
5661 After doing compression, {added} times 1024 words can be added before
5662 the {inc} limit is ignored and compression is done when any extra
5663 amount of memory is needed. A low number means there is a smaller
5664 chance of hitting the {inc} limit, less memory is used but it's
5665 slower.
5666
5667 The languages for which these numbers are important are Italian and
5668 Hungarian. The default works for when you have about 512 Mbyte. If
5669 you have 1 Gbyte you could use: >
5670 :set mkspellmem=900000,3000,800
5671< If you have less than 512 Mbyte |:mkspell| may fail for some
5672 languages, no matter what you set 'mkspellmem' to.
5673
dkearns8ebdbc92023-10-29 06:26:19 +11005674 This option cannot be set from a |modeline| or in the |sandbox|, for
5675 security reasons.
Bram Moolenaar07607392019-05-26 19:20:43 +02005676
Bram Moolenaar071d4272004-06-13 20:20:40 +00005677 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
Bram Moolenaar8243a792007-05-01 17:05:03 +00005678'modeline' 'ml' boolean (Vim default: on (off for root),
5679 Vi default: off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005680 local to buffer
Bram Moolenaar110289e2019-05-23 15:38:06 +02005681 If 'modeline' is on 'modelines' gives the number of lines that is
5682 checked for set commands. If 'modeline' is off or 'modelines' is zero
5683 no lines are checked. See |modeline|.
5684
5685 *'modelineexpr'* *'mle'* *'nomodelineexpr'* *'nomle'*
5686'modelineexpr' 'mle' boolean (default: off)
5687 global
5688 When on allow some options that are an expression to be set in the
5689 modeline. Check the option for whether it is affected by
5690 'modelineexpr'. Also see |modeline|.
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02005691 This option cannot be set from a |modeline| or in the |sandbox|, for
5692 security reasons.
Bram Moolenaar110289e2019-05-23 15:38:06 +02005693
Bram Moolenaar071d4272004-06-13 20:20:40 +00005694 *'modelines'* *'mls'*
5695'modelines' 'mls' number (default 5)
5696 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005697 If 'modeline' is on 'modelines' gives the number of lines that is
5698 checked for set commands. If 'modeline' is off or 'modelines' is zero
5699 no lines are checked. See |modeline|.
5700 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
5701 set and to the Vim default value when 'compatible' is reset.
5702
5703 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
Bram Moolenaar110289e2019-05-23 15:38:06 +02005704 *E21*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005705'modifiable' 'ma' boolean (default on)
5706 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005707 When off the buffer contents cannot be changed. The 'fileformat' and
5708 'fileencoding' options also can't be changed.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01005709 Can be reset on startup with the |-M| command line argument.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005710
5711 *'modified'* *'mod'* *'nomodified'* *'nomod'*
5712'modified' 'mod' boolean (default off)
Christian Brabandt596ad662023-08-16 00:11:09 +02005713 local to buffer |local-noglobal|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005714 When on, the buffer is considered to be modified. This option is set
5715 when:
5716 1. A change was made to the text since it was last written. Using the
5717 |undo| command to go back to the original text will reset the
5718 option. But undoing changes that were made before writing the
5719 buffer will set the option again, since the text is different from
5720 when it was written.
5721 2. 'fileformat' or 'fileencoding' is different from its original
5722 value. The original value is set when the buffer is read or
5723 written. A ":set nomodified" command also resets the original
5724 values to the current values and the 'modified' option will be
5725 reset.
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01005726 Similarly for 'eol' and 'bomb'.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02005727 This option is not set when a change is made to the buffer as the
5728 result of a BufNewFile, BufRead/BufReadPost, BufWritePost,
5729 FileAppendPost or VimLeave autocommand event. See |gzip-example| for
5730 an explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005731 When 'buftype' is "nowrite" or "nofile" this option may be set, but
5732 will be ignored.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01005733 Note that the text may actually be the same, e.g. 'modified' is set
5734 when using "rA" on an "A".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005735
5736 *'more'* *'nomore'*
5737'more' boolean (Vim default: on, Vi default: off)
5738 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005739 When on, listings pause when the whole screen is filled. You will get
5740 the |more-prompt|. When this option is off there are no pauses, the
5741 listing continues until finished.
5742 NOTE: This option is set to the Vi default value when 'compatible' is
5743 set and to the Vim default value when 'compatible' is reset.
5744
Bram Moolenaar98a29d02021-01-18 19:55:44 +01005745 *'mouse'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005746'mouse' string (default "", "a" for GUI and Win32,
Bram Moolenaar5b418992019-10-27 18:50:25 +01005747 set to "a" or "nvi" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005748 global
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005749 Enable the use of the mouse. Works for most terminals (xterm, Win32
5750 |win32-mouse|, QNX pterm, *BSD console with sysmouse and Linux console
5751 with gpm). For using the mouse in the GUI, see |gui-mouse|. The
5752 mouse can be enabled for different modes:
Bram Moolenaar7f2e9d72017-11-11 20:58:53 +01005753 n Normal mode and Terminal modes
Bram Moolenaar071d4272004-06-13 20:20:40 +00005754 v Visual mode
5755 i Insert mode
5756 c Command-line mode
5757 h all previous modes when editing a help file
5758 a all previous modes
5759 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005760 Normally you would enable the mouse in all five modes with: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005761 :set mouse=a
Bram Moolenaar5b418992019-10-27 18:50:25 +01005762< If your terminal can't overrule the mouse events going to the
5763 application, use: >
5764 :set mouse=nvi
Bram Moolenaar65e0d772020-06-14 17:29:55 +02005765< Then you can press ":", select text for the system, and press Esc to go
Bram Moolenaar5b418992019-10-27 18:50:25 +01005766 back to Vim using the mouse events.
5767 In |defaults.vim| "nvi" is used if the 'term' option is not matching
5768 "xterm".
5769
5770 When the mouse is not enabled, the GUI will still use the mouse for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005771 modeless selection. This doesn't move the text cursor.
5772
5773 See |mouse-using|. Also see |'clipboard'|.
5774
5775 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005776 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005777 the mouse buttons can still be used by keeping the shift key pressed.
5778 Also see the 'clipboard' option.
5779
5780 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
5781'mousefocus' 'mousef' boolean (default off)
5782 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005783 {only works in the GUI}
5784 The window that the mouse pointer is on is automatically activated.
5785 When changing the window layout or window focus in another way, the
5786 mouse pointer is moved to the window with keyboard focus. Off is the
5787 default because it makes using the pull down menus a little goofy, as
5788 a pointer transit may activate a window unintentionally.
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01005789 MS-Windows: Also see 'scrollfocus' for what window is scrolled when
Bram Moolenaar1d9215b2020-01-25 13:27:42 +01005790 using the mouse scroll wheel.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005791
5792 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
5793'mousehide' 'mh' boolean (default on)
5794 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005795 {only works in the GUI}
5796 When on, the mouse pointer is hidden when characters are typed.
5797 The mouse pointer is restored when the mouse is moved.
5798
5799 *'mousemodel'* *'mousem'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005800'mousemodel' 'mousem' string (default "extend", "popup" for Win32)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005801 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005802 Sets the model to use for the mouse. The name mostly specifies what
5803 the right mouse button is used for:
5804 extend Right mouse button extends a selection. This works
5805 like in an xterm.
5806 popup Right mouse button pops up a menu. The shifted left
5807 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00005808 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005809 popup_setpos Like "popup", but the cursor will be moved to the
5810 position where the mouse was clicked, and thus the
5811 selected operation will act upon the clicked object.
5812 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00005813 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005814 course, that right clicking outside a selection will
5815 end Visual mode.
5816 Overview of what button does what for each model:
5817 mouse extend popup(_setpos) ~
5818 left click place cursor place cursor
5819 left drag start selection start selection
5820 shift-left search word extend selection
5821 right click extend selection popup menu (place cursor)
5822 right drag extend selection -
5823 middle click paste paste
5824
5825 In the "popup" model the right mouse button produces a pop-up menu.
5826 You need to define this first, see |popup-menu|.
5827
5828 Note that you can further refine the meaning of buttons with mappings.
5829 See |gui-mouse-mapping|. But mappings are NOT used for modeless
5830 selection (because that's handled in the GUI code directly).
5831
5832 The 'mousemodel' option is set by the |:behave| command.
5833
h_east59858792023-10-25 22:47:05 +09005834 *'mousemoveevent'* *'mousemev'* *'nomousemoveevent'* *'nomousemev'*
Ernie Raelc4cb5442022-04-03 15:47:28 +01005835'mousemoveevent' 'mousemev' boolean (default off)
5836 global
5837 {only works in the GUI}
5838 When on, mouse move events are delivered to the input queue and are
5839 available for mapping. The default, off, avoids the mouse movement
5840 overhead except when needed. See |gui-mouse-mapping|.
5841 Warning: Setting this option can make pending mappings to be aborted
5842 when the mouse is moved.
5843 Currently only works in the GUI, may be made to work in a terminal
5844 later.
5845
Bram Moolenaar071d4272004-06-13 20:20:40 +00005846 *'mouseshape'* *'mouses'* *E547*
Bram Moolenaarf6b40102019-02-22 15:24:03 +01005847'mouseshape' 'mouses' string (default "i-r:beam,s:updown,sd:udsizing,
5848 vs:leftright,vd:lrsizing,m:no,
5849 ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005850 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005851 {only available when compiled with the |+mouseshape|
5852 feature}
5853 This option tells Vim what the mouse pointer should look like in
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01005854 different modes. The option is a comma-separated list of parts, much
Bram Moolenaar071d4272004-06-13 20:20:40 +00005855 like used for 'guicursor'. Each part consist of a mode/location-list
5856 and an argument-list:
5857 mode-list:shape,mode-list:shape,..
5858 The mode-list is a dash separated list of these modes/locations:
5859 In a normal window: ~
5860 n Normal mode
5861 v Visual mode
5862 ve Visual mode with 'selection' "exclusive" (same as 'v',
5863 if not specified)
5864 o Operator-pending mode
5865 i Insert mode
5866 r Replace mode
5867
5868 Others: ~
5869 c appending to the command-line
5870 ci inserting in the command-line
5871 cr replacing in the command-line
5872 m at the 'Hit ENTER' or 'More' prompts
5873 ml idem, but cursor in the last line
5874 e any mode, pointer below last window
5875 s any mode, pointer on a status line
5876 sd any mode, while dragging a status line
5877 vs any mode, pointer on a vertical separator line
5878 vd any mode, while dragging a vertical separator line
5879 a everywhere
5880
5881 The shape is one of the following:
5882 avail name looks like ~
5883 w x arrow Normal mouse pointer
5884 w x blank no pointer at all (use with care!)
5885 w x beam I-beam
5886 w x updown up-down sizing arrows
5887 w x leftright left-right sizing arrows
5888 w x busy The system's usual busy pointer
5889 w x no The system's usual 'no input' pointer
5890 x udsizing indicates up-down resizing
5891 x lrsizing indicates left-right resizing
5892 x crosshair like a big thin +
5893 x hand1 black hand
5894 x hand2 white hand
5895 x pencil what you write with
5896 x question big ?
5897 x rightup-arrow arrow pointing right-up
5898 w x up-arrow arrow pointing up
5899 x <number> any X11 pointer number (see X11/cursorfont.h)
5900
5901 The "avail" column contains a 'w' if the shape is available for Win32,
5902 x for X11.
5903 Any modes not specified or shapes not available use the normal mouse
5904 pointer.
5905
5906 Example: >
5907 :set mouseshape=s:udsizing,m:no
5908< will make the mouse turn to a sizing arrow over the status lines and
5909 indicate no input when the hit-enter prompt is displayed (since
5910 clicking the mouse has no effect in this state.)
5911
5912 *'mousetime'* *'mouset'*
5913'mousetime' 'mouset' number (default 500)
5914 global
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005915 Only for GUI, Win32 and Unix with xterm. Defines the maximum
Bram Moolenaar071d4272004-06-13 20:20:40 +00005916 time in msec between two mouse clicks for the second click to be
5917 recognized as a multi click.
5918
laburnumT3f7855a2023-12-05 18:37:03 +01005919 *'mzquantum'* *'mzq'*
5920'mzquantum' 'mzq' number (default 100)
5921 global
5922 {not available when compiled without the |+mzscheme|
5923 feature}
5924 The number of milliseconds between polls for MzScheme threads.
5925 Negative or zero value means no thread scheduling.
5926 NOTE: This option is set to the Vim default value when 'compatible'
5927 is reset.
5928
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005929 *'mzschemedll'*
5930'mzschemedll' string (default depends on the build)
5931 global
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005932 {only available when compiled with the |+mzscheme/dyn|
5933 feature}
5934 Specifies the name of the MzScheme shared library. The default is
5935 DYNAMIC_MZSCH_DLL which was specified at compile time.
5936 Environment variables are expanded |:set_env|.
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01005937 The value must be set in the |vimrc| script or earlier. In the
Bram Moolenaar01164a62017-11-02 22:58:42 +01005938 startup, before the |load-plugins| step.
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005939 This option cannot be set from a |modeline| or in the |sandbox|, for
5940 security reasons.
5941
5942 *'mzschemegcdll'*
5943'mzschemegcdll' string (default depends on the build)
5944 global
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005945 {only available when compiled with the |+mzscheme/dyn|
5946 feature}
5947 Specifies the name of the MzScheme GC shared library. The default is
5948 DYNAMIC_MZGC_DLL which was specified at compile time.
5949 The value can be equal to 'mzschemedll' if it includes the GC code.
5950 Environment variables are expanded |:set_env|.
5951 This option cannot be set from a |modeline| or in the |sandbox|, for
5952 security reasons.
5953
Bram Moolenaar071d4272004-06-13 20:20:40 +00005954 *'nrformats'* *'nf'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02005955'nrformats' 'nf' string (default "bin,octal,hex",
5956 set to "bin,hex" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005957 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005958 This defines what bases Vim will consider for numbers when using the
5959 CTRL-A and CTRL-X commands for adding to and subtracting from a number
5960 respectively; see |CTRL-A| for more info on these commands.
Bram Moolenaar4770d092006-01-12 23:22:24 +00005961 alpha If included, single alphabetical characters will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005962 incremented or decremented. This is useful for a list with a
Bram Moolenaar3848e002016-03-19 18:42:29 +01005963 letter index a), b), etc. *octal-nrformats*
Bram Moolenaar4770d092006-01-12 23:22:24 +00005964 octal If included, numbers that start with a zero will be considered
Bram Moolenaar071d4272004-06-13 20:20:40 +00005965 to be octal. Example: Using CTRL-A on "007" results in "010".
Bram Moolenaar4770d092006-01-12 23:22:24 +00005966 hex If included, numbers starting with "0x" or "0X" will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005967 considered to be hexadecimal. Example: Using CTRL-X on
5968 "0x100" results in "0x0ff".
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005969 bin If included, numbers starting with "0b" or "0B" will be
5970 considered to be binary. Example: Using CTRL-X on
5971 "0b1000" subtracts one, resulting in "0b0111".
Bram Moolenaaraaad9952020-05-31 15:08:59 +02005972 unsigned If included, numbers are recognized as unsigned. Thus a
5973 leading dash or negative sign won't be considered as part of
5974 the number. Examples:
5975 Using CTRL-X on "2020" in "9-2020" results in "9-2019"
5976 (without "unsigned" it would become "9-2021").
5977 Using CTRL-A on "2020" in "9-2020" results in "9-2021"
5978 (without "unsigned" it would become "9-2019").
Bram Moolenaaracc22402020-06-07 21:07:18 +02005979 Using CTRL-X on "0" or CTRL-A on "18446744073709551615"
5980 (2^64 - 1) has no effect, overflow is prevented.
distobs25ac6d62024-07-06 17:50:09 +02005981 blank If included, treat numbers as signed or unsigned based on
h-east52e7cc22024-07-28 17:03:29 +02005982 preceding whitespace. If a number with a leading dash has its
distobs25ac6d62024-07-06 17:50:09 +02005983 dash immediately preceded by a non-whitespace character (i.e.,
5984 not a tab or a " "), the negative sign won't be considered as
5985 part of the number. For example:
5986 Using CTRL-A on "14" in "Carbon-14" results in "Carbon-15"
5987 (without "blank" it would become "Carbon-13").
5988 Using CTRL-X on "8" in "Carbon -8" results in "Carbon -9"
h-east52e7cc22024-07-28 17:03:29 +02005989 (because -8 is preceded by whitespace. If "unsigned" was
distobs25ac6d62024-07-06 17:50:09 +02005990 set, it would result in "Carbon -7").
5991 If this format is included, overflow is prevented as if
h-east52e7cc22024-07-28 17:03:29 +02005992 "unsigned" were set. If both this format and "unsigned" are
distobs25ac6d62024-07-06 17:50:09 +02005993 included, "unsigned" will take precedence.
5994
Bram Moolenaar071d4272004-06-13 20:20:40 +00005995 Numbers which simply begin with a digit in the range 1-9 are always
5996 considered decimal. This also happens for numbers that are not
5997 recognized as octal or hex.
5998
5999 *'number'* *'nu'* *'nonumber'* *'nonu'*
6000'number' 'nu' boolean (default off)
6001 local to window
6002 Print the line number in front of each line. When the 'n' option is
6003 excluded from 'cpoptions' a wrapped line will not use the column of
6004 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00006005 The 'numberwidth' option can be used to set the room used for the line
6006 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006007 When a long, wrapped line doesn't start with the first character, '-'
6008 characters are put before the number.
James McCoya80aad72021-12-22 19:45:28 +00006009 For highlighting see |hl-LineNr|, and |hl-CursorLineNr|, and the
6010 |:sign-define| "numhl" argument.
Bram Moolenaar203d04d2013-06-06 21:36:40 +02006011 *number_relativenumber*
6012 The 'relativenumber' option changes the displayed number to be
6013 relative to the cursor. Together with 'number' there are these
6014 four combinations (cursor in line 3):
6015
Bram Moolenaar3848e002016-03-19 18:42:29 +01006016 'nonu' 'nu' 'nonu' 'nu'
Bram Moolenaar203d04d2013-06-06 21:36:40 +02006017 'nornu' 'nornu' 'rnu' 'rnu'
6018
6019 |apple | 1 apple | 2 apple | 2 apple
6020 |pear | 2 pear | 1 pear | 1 pear
6021 |nobody | 3 nobody | 0 nobody |3 nobody
6022 |there | 4 there | 1 there | 1 there
Bram Moolenaar071d4272004-06-13 20:20:40 +00006023
Bram Moolenaar592e0a22004-07-03 16:05:59 +00006024 *'numberwidth'* *'nuw'*
6025'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
6026 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00006027 {only available when compiled with the |+linebreak|
6028 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00006029 Minimal number of columns to use for the line number. Only relevant
Bram Moolenaar64486672010-05-16 15:46:46 +02006030 when the 'number' or 'relativenumber' option is set or printing lines
6031 with a line number. Since one space is always between the number and
6032 the text, there is one less character for the number itself.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00006033 The value is the minimum width. A bigger width is used when needed to
Bram Moolenaar64486672010-05-16 15:46:46 +02006034 fit the highest line number in the buffer respectively the number of
6035 rows in the window, depending on whether 'number' or 'relativenumber'
6036 is set. Thus with the Vim default of 4 there is room for a line number
6037 up to 999. When the buffer has 1000 lines five columns will be used.
Bram Moolenaarf8a07122019-07-01 22:06:07 +02006038 The minimum value is 1, the maximum value is 20.
Bram Moolenaar036986f2017-03-16 17:41:02 +01006039 NOTE: This option is set to the Vi default value when 'compatible' is
6040 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00006041
Bram Moolenaarf75a9632005-09-13 21:20:47 +00006042 *'omnifunc'* *'ofu'*
6043'omnifunc' 'ofu' string (default: empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00006044 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02006045 {not available when compiled without the |+eval|
Bram Moolenaare2c453d2019-08-21 14:37:09 +02006046 feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00006047 This option specifies a function to be used for Insert mode omni
6048 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
Bram Moolenaar280f1262006-01-30 00:14:18 +00006049 See |complete-functions| for an explanation of how the function is
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00006050 invoked and what it should return. The value can be the name of a
6051 function, a |lambda| or a |Funcref|. See |option-value-function| for
6052 more information.
Bram Moolenaar043545e2006-10-10 16:44:07 +00006053 This option is usually set by a filetype plugin:
Bram Moolenaar9c102382006-05-03 21:26:49 +00006054 |:filetype-plugin-on|
Bram Moolenaar30b65812012-07-12 22:01:11 +02006055 This option cannot be set from a |modeline| or in the |sandbox|, for
6056 security reasons.
Bram Moolenaare344bea2005-09-01 20:46:49 +00006057
Bram Moolenaar02467872007-05-06 13:22:01 +00006058 *'opendevice'* *'odev'* *'noopendevice'* *'noodev'*
Bram Moolenaar043545e2006-10-10 16:44:07 +00006059'opendevice' 'odev' boolean (default off)
6060 global
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00006061 {only for MS-Windows} *E796*
Bram Moolenaar043545e2006-10-10 16:44:07 +00006062 Enable reading and writing from devices. This may get Vim stuck on a
6063 device that can be opened but doesn't actually do the I/O. Therefore
6064 it is off by default.
6065 Note that on MS-Windows editing "aux.h", "lpt1.txt" and the like also
6066 result in editing a device.
6067
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006068 *'operatorfunc'* *'opfunc'*
6069'operatorfunc' 'opfunc' string (default: empty)
6070 global
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006071 This option specifies a function to be called by the |g@| operator.
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +00006072 See |:map-operator| for more info and an example. The value can be
6073 the name of a function, a |lambda| or a |Funcref|. See
6074 |option-value-function| for more information.
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006075
6076 This option cannot be set from a |modeline| or in the |sandbox|, for
6077 security reasons.
6078
Bram Moolenaar251e1912011-06-19 05:09:16 +02006079 *'osfiletype'* *'oft'*
6080'osfiletype' 'oft' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006081 local to buffer
Bram Moolenaar251e1912011-06-19 05:09:16 +02006082 This option was supported on RISC OS, which has been removed.
6083
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01006084 *'packpath'* *'pp'*
6085'packpath' 'pp' string (default: see 'runtimepath')
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01006086 Directories used to find packages. See |packages|.
dkearns8ebdbc92023-10-29 06:26:19 +11006087 This option cannot be set from a |modeline| or in the |sandbox|, for
6088 security reasons.
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01006089
Bram Moolenaar071d4272004-06-13 20:20:40 +00006090 *'paragraphs'* *'para'*
Bram Moolenaar57e48462008-03-12 16:38:55 +00006091'paragraphs' 'para' string (default "IPLPPPQPP TPHPLIPpLpItpplpipbp")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006092 global
6093 Specifies the nroff macros that separate paragraphs. These are pairs
6094 of two letters (see |object-motions|).
6095
6096 *'paste'* *'nopaste'*
6097'paste' boolean (default off)
6098 global
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006099 Put Vim in Paste mode. This is useful if you want to cut or copy
6100 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00006101 unexpected effects.
6102 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006103 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00006104 knows about pasting and will mostly do the right thing without 'paste'
6105 being set. The same is true for a terminal where Vim handles the
6106 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00006107 This option is reset when starting the GUI. Thus if you set it in
6108 your .vimrc it will work in a terminal, but not in the GUI. Setting
6109 'paste' in the GUI has side effects: e.g., the Paste toolbar button
6110 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006111 When the 'paste' option is switched on (also when it was already on):
6112 - mapping in Insert mode and Command-line mode is disabled
6113 - abbreviations are disabled
Bram Moolenaar071d4272004-06-13 20:20:40 +00006114 - 'autoindent' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02006115 - 'expandtab' is reset
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02006116 - 'hkmap' is reset
Bram Moolenaar071d4272004-06-13 20:20:40 +00006117 - 'revins' is reset
6118 - 'ruler' is reset
6119 - 'showmatch' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02006120 - 'smarttab' is reset
6121 - 'softtabstop' is set to 0
6122 - 'textwidth' is set to 0
6123 - 'wrapmargin' is set to 0
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02006124 - 'varsofttabstop' is made empty
Bram Moolenaar071d4272004-06-13 20:20:40 +00006125 These options keep their value, but their effect is disabled:
Bram Moolenaar071d4272004-06-13 20:20:40 +00006126 - 'cindent'
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02006127 - 'formatoptions' is used like it is empty
Bram Moolenaarca635012015-09-25 20:34:21 +02006128 - 'indentexpr'
6129 - 'lisp'
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02006130 - 'smartindent'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006131 NOTE: When you start editing another file while the 'paste' option is
6132 on, settings from the modelines or autocommands may change the
6133 settings again, causing trouble when pasting text. You might want to
6134 set the 'paste' option again.
6135 When the 'paste' option is reset the mentioned options are restored to
6136 the value before the moment 'paste' was switched from off to on.
6137 Resetting 'paste' before ever setting it does not have any effect.
6138 Since mapping doesn't work while 'paste' is active, you need to use
6139 the 'pastetoggle' option to toggle the 'paste' option with some key.
6140
6141 *'pastetoggle'* *'pt'*
6142'pastetoggle' 'pt' string (default "")
6143 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006144 When non-empty, specifies the key sequence that toggles the 'paste'
6145 option. This is like specifying a mapping: >
6146 :map {keys} :set invpaste<CR>
6147< Where {keys} is the value of 'pastetoggle'.
6148 The difference is that it will work even when 'paste' is set.
6149 'pastetoggle' works in Insert mode and Normal mode, but not in
6150 Command-line mode.
6151 Mappings are checked first, thus overrule 'pastetoggle'. However,
6152 when 'paste' is on mappings are ignored in Insert mode, thus you can do
6153 this: >
6154 :map <F10> :set paste<CR>
6155 :map <F11> :set nopaste<CR>
6156 :imap <F10> <C-O>:set paste<CR>
6157 :imap <F11> <nop>
6158 :set pastetoggle=<F11>
6159< This will make <F10> start paste mode and <F11> stop paste mode.
6160 Note that typing <F10> in paste mode inserts "<F10>", since in paste
6161 mode everything is inserted literally, except the 'pastetoggle' key
6162 sequence.
Bram Moolenaar446cb832008-06-24 21:56:24 +00006163 When the value has several bytes 'ttimeoutlen' applies.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006164
6165 *'pex'* *'patchexpr'*
6166'patchexpr' 'pex' string (default "")
6167 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006168 {not available when compiled without the |+diff|
6169 feature}
6170 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006171 the resulting new version of the file. See |diff-patchexpr|.
dkearns8ebdbc92023-10-29 06:26:19 +11006172 This option cannot be set from a |modeline| or in the |sandbox|, for
6173 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006174
Bram Moolenaardbc28022014-07-26 13:40:44 +02006175 *'patchmode'* *'pm'* *E205* *E206*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006176'patchmode' 'pm' string (default "")
6177 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006178 When non-empty the oldest version of a file is kept. This can be used
6179 to keep the original version of a file if you are changing files in a
6180 source distribution. Only the first time that a file is written a
6181 copy of the original file will be kept. The name of the copy is the
6182 name of the original file with the string in the 'patchmode' option
6183 appended. This option should start with a dot. Use a string like
Bram Moolenaardf980db2017-12-24 13:22:00 +01006184 ".orig" or ".org". 'backupdir' must not be empty for this to work
6185 (Detail: The backup file is renamed to the patchmode file after the
6186 new file has been successfully written, that's why it must be possible
6187 to write a backup file). If there was no file to be backed up, an
6188 empty file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006189 When the 'backupskip' pattern matches, a patchmode file is not made.
6190 Using 'patchmode' for compressed files appends the extension at the
6191 end (e.g., "file.gz.orig"), thus the resulting name isn't always
6192 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006193 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006194
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01006195 *'path'* *'pa'* *E343* *E345* *E347* *E854*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006196'path' 'pa' string (default on Unix: ".,/usr/include,,"
Bram Moolenaar071d4272004-06-13 20:20:40 +00006197 other systems: ".,,")
6198 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006199 This is a list of directories which will be searched when using the
Bram Moolenaarc236c162008-07-13 17:41:49 +00006200 |gf|, [f, ]f, ^Wf, |:find|, |:sfind|, |:tabfind| and other commands,
6201 provided that the file being searched for has a relative path (not
6202 starting with "/", "./" or "../"). The directories in the 'path'
6203 option may be relative or absolute.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006204 - Use commas to separate directory names: >
6205 :set path=.,/usr/local/include,/usr/include
6206< - Spaces can also be used to separate directory names (for backwards
6207 compatibility with version 3.0). To have a space in a directory
6208 name, precede it with an extra backslash, and escape the space: >
6209 :set path=.,/dir/with\\\ space
6210< - To include a comma in a directory name precede it with an extra
6211 backslash: >
6212 :set path=.,/dir/with\\,comma
6213< - To search relative to the directory of the current file, use: >
6214 :set path=.
6215< - To search in the current directory use an empty string between two
6216 commas: >
6217 :set path=,,
6218< - A directory name may end in a ':' or '/'.
6219 - Environment variables are expanded |:set_env|.
6220 - When using |netrw.vim| URLs can be used. For example, adding
6221 "http://www.vim.org" will make ":find index.html" work.
Bram Moolenaarc236c162008-07-13 17:41:49 +00006222 - Search upwards and downwards in a directory tree using "*", "**" and
6223 ";". See |file-searching| for info and syntax.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006224 - Careful with '\' characters, type two to get one in the option: >
6225 :set path=.,c:\\include
6226< Or just use '/' instead: >
6227 :set path=.,c:/include
6228< Don't forget "." or files won't even be found in the same directory as
6229 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006230 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00006231 it is something like 256 or 1024 characters.
6232 You can check if all the include files are found, using the value of
6233 'path', see |:checkpath|.
6234 The use of |:set+=| and |:set-=| is preferred when adding or removing
6235 directories from the list. This avoids problems when a future version
6236 uses another default. To remove the current directory use: >
6237 :set path-=
6238< To add the current directory use: >
6239 :set path+=
6240< To use an environment variable, you probably need to replace the
6241 separator. Here is an example to append $INCL, in which directory
Dominique Pellédf62c622024-07-15 20:29:59 +02006242 names are separated with a semicolon: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00006243 :let &path = &path .. "," .. substitute($INCL, ';', ',', 'g')
Bram Moolenaar071d4272004-06-13 20:20:40 +00006244< Replace the ';' with a ':' or whatever separator is used. Note that
6245 this doesn't work when $INCL contains a comma or white space.
6246
Bram Moolenaar37c64c72017-09-19 22:06:03 +02006247 *'perldll'*
6248'perldll' string (default depends on the build)
6249 global
Bram Moolenaar37c64c72017-09-19 22:06:03 +02006250 {only available when compiled with the |+perl/dyn|
6251 feature}
6252 Specifies the name of the Perl shared library. The default is
6253 DYNAMIC_PERL_DLL, which was specified at compile time.
6254 Environment variables are expanded |:set_env|.
6255 This option cannot be set from a |modeline| or in the |sandbox|, for
6256 security reasons.
6257
Bram Moolenaar071d4272004-06-13 20:20:40 +00006258 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
6259'preserveindent' 'pi' boolean (default off)
6260 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00006261 When changing the indent of the current line, preserve as much of the
6262 indent structure as possible. Normally the indent is replaced by a
6263 series of tabs followed by spaces as required (unless |'expandtab'| is
6264 enabled, in which case only spaces are used). Enabling this option
6265 means the indent will preserve as many existing characters as possible
6266 for indenting, and only add additional tabs or spaces as required.
Bram Moolenaar446cb832008-06-24 21:56:24 +00006267 'expandtab' does not apply to the preserved white space, a Tab remains
6268 a Tab.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006269 NOTE: When using ">>" multiple times the resulting indent is a mix of
6270 tabs and spaces. You might not like this.
Bram Moolenaar036986f2017-03-16 17:41:02 +01006271 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006272 Also see 'copyindent'.
6273 Use |:retab| to clean up white space.
6274
6275 *'previewheight'* *'pvh'*
6276'previewheight' 'pvh' number (default 12)
6277 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02006278 {not available when compiled without the |+quickfix|
6279 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006280 Default height for a preview window. Used for |:ptag| and associated
Bram Moolenaar79648732019-07-18 21:43:07 +02006281 commands. Used for |CTRL-W_}| when no count is given. Not used when
6282 'previewpopup' is set.
6283
6284 *'previewpopup'* *'pvp'*
6285'previewpopup' 'pvp' string (default empty)
6286 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02006287 {not available when compiled without the |+textprop|
6288 or |+quickfix| feature}
Bram Moolenaar79648732019-07-18 21:43:07 +02006289 When not empty a popup window is used for commands that would open a
6290 preview window. See |preview-popup|.
Bram Moolenaar576a4a62019-08-18 15:25:17 +02006291 Not used for the insert completion info, add "popup" to
6292 'completeopt' for that.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006293
6294 *'previewwindow'* *'nopreviewwindow'*
6295 *'pvw'* *'nopvw'* *E590*
6296'previewwindow' 'pvw' boolean (default off)
Christian Brabandt596ad662023-08-16 00:11:09 +02006297 local to window |local-noglobal|
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02006298 {not available when compiled without the |+quickfix|
6299 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006300 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00006301 set. It's normally not set directly, but by using one of the commands
6302 |:ptag|, |:pedit|, etc.
6303
6304 *'printdevice'* *'pdev'*
6305'printdevice' 'pdev' string (default empty)
6306 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006307 {only available when compiled with the |+printer|
6308 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006309 The name of the printer to be used for |:hardcopy|.
6310 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006311 This option cannot be set from a |modeline| or in the |sandbox|, for
6312 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006313
Bram Moolenaar8299df92004-07-10 09:47:34 +00006314 *'printencoding'* *'penc'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02006315'printencoding' 'penc' string (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006316 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006317 {only available when compiled with the |+printer|
6318 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006319 Sets the character encoding used when printing.
6320 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006321
6322 *'printexpr'* *'pexpr'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02006323'printexpr' 'pexpr' string (default: see below)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006324 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006325 {only available when compiled with the |+printer|
6326 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006327 Expression used to print the PostScript produced with |:hardcopy|.
6328 See |pexpr-option|.
Bram Moolenaar51628222016-12-01 23:03:28 +01006329 This option cannot be set from a |modeline| or in the |sandbox|, for
6330 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006331
Bram Moolenaar8299df92004-07-10 09:47:34 +00006332 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006333'printfont' 'pfn' string (default "courier")
6334 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006335 {only available when compiled with the |+printer|
6336 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006337 The name of the font that will be used for |:hardcopy|.
6338 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006339
6340 *'printheader'* *'pheader'*
6341'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
6342 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006343 {only available when compiled with the |+printer|
6344 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006345 The format of the header produced in |:hardcopy| output.
6346 See |pheader-option|.
6347
6348 *'printmbcharset'* *'pmbcs'*
6349'printmbcharset' 'pmbcs' string (default "")
6350 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01006351 {only available when compiled with the |+printer|
6352 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006353 The CJK character set to be used for CJK output from |:hardcopy|.
6354 See |pmbcs-option|.
6355
6356 *'printmbfont'* *'pmbfn'*
6357'printmbfont' 'pmbfn' string (default "")
6358 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01006359 {only available when compiled with the |+printer|
6360 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006361 List of font names to be used for CJK output from |:hardcopy|.
6362 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006363
6364 *'printoptions'* *'popt'*
6365'printoptions' 'popt' string (default "")
6366 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006367 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006368 List of items that control the format of the output of |:hardcopy|.
6369 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006370
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006371 *'prompt'* *'noprompt'*
6372'prompt' boolean (default on)
6373 global
6374 When on a ":" prompt is used in Ex mode.
6375
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00006376 *'pumheight'* *'ph'*
6377'pumheight' 'ph' number (default 0)
6378 global
Bram Moolenaar06a89a52006-04-29 22:01:03 +00006379 Determines the maximum number of items to show in the popup menu for
6380 Insert mode completion. When zero as much space as available is used.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00006381 |ins-completion-menu|.
6382
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01006383 *'pumwidth'* *'pw'*
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006384'pumwidth' 'pw' number (default 15)
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01006385 global
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01006386 Determines the minimum width to use for the popup menu for Insert mode
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006387 completion. |ins-completion-menu|.
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01006388
Bram Moolenaard94464e2015-11-02 15:28:18 +01006389 *'pythondll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01006390'pythondll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01006391 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01006392 {only available when compiled with the |+python/dyn|
6393 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006394 Specifies the name of the Python 2.x shared library. The default is
6395 DYNAMIC_PYTHON_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006396 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01006397 This option cannot be set from a |modeline| or in the |sandbox|, for
6398 security reasons.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00006399
Bram Moolenaar94073162018-01-31 21:49:05 +01006400 *'pythonhome'*
6401'pythonhome' string (default "")
6402 global
Bram Moolenaar94073162018-01-31 21:49:05 +01006403 {only available when compiled with the |+python/dyn|
6404 feature}
6405 Specifies the name of the Python 2.x home directory. When 'pythonhome'
6406 and the PYTHONHOME environment variable are not set, PYTHON_HOME,
6407 which was specified at compile time, will be used for the Python 2.x
6408 home directory.
6409 Environment variables are expanded |:set_env|.
6410 This option cannot be set from a |modeline| or in the |sandbox|, for
6411 security reasons.
6412
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006413 *'pythonthreedll'*
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006414'pythonthreedll' string (default depends on the build)
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006415 global
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006416 {only available when compiled with the |+python3/dyn|
6417 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006418 Specifies the name of the Python 3 shared library. The default is
6419 DYNAMIC_PYTHON3_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006420 Environment variables are expanded |:set_env|.
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006421 This option cannot be set from a |modeline| or in the |sandbox|, for
6422 security reasons.
6423
Bram Moolenaar94073162018-01-31 21:49:05 +01006424 *'pythonthreehome'*
6425'pythonthreehome' string (default "")
6426 global
Bram Moolenaar94073162018-01-31 21:49:05 +01006427 {only available when compiled with the |+python3/dyn|
6428 feature}
6429 Specifies the name of the Python 3 home directory. When
6430 'pythonthreehome' and the PYTHONHOME environment variable are not set,
6431 PYTHON3_HOME, which was specified at compile time, will be used for
6432 the Python 3 home directory.
6433 Environment variables are expanded |:set_env|.
6434 This option cannot be set from a |modeline| or in the |sandbox|, for
6435 security reasons.
6436
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01006437 *'pyxversion'* *'pyx'*
6438'pyxversion' 'pyx' number (default depends on the build)
6439 global
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01006440 {only available when compiled with the |+python| or
6441 the |+python3| feature}
6442 Specifies the python version used for pyx* functions and commands
6443 |python_x|. The default value is as follows:
6444
6445 Compiled with Default ~
6446 |+python| and |+python3| 0
6447 only |+python| 2
6448 only |+python3| 3
6449
6450 Available values are 0, 2 and 3.
6451 If 'pyxversion' is 0, it is set to 2 or 3 after the first execution of
6452 any python2/3 commands or functions. E.g. `:py` sets to 2, and `:py3`
6453 sets to 3. `:pyx` sets it to 3 if Python 3 is available, otherwise sets
6454 to 2 if Python 2 is available.
6455 See also: |has-pythonx|
6456
6457 If Vim is compiled with only |+python| or |+python3| setting
6458 'pyxversion' has no effect. The pyx* functions and commands are
6459 always the same as the compiled version.
6460
6461 This option cannot be set from a |modeline| or in the |sandbox|, for
6462 security reasons.
6463
Bram Moolenaar858ba062020-05-31 23:11:59 +02006464 *'quickfixtextfunc'* *'qftf'*
6465'quickfixtextfunc' 'qftf' string (default "")
6466 global
6467 {only available when compiled with the |+quickfix|
6468 feature}
6469 This option specifies a function to be used to get the text to display
6470 in the quickfix and location list windows. This can be used to
6471 customize the information displayed in the quickfix or location window
6472 for each entry in the corresponding quickfix or location list. See
6473 |quickfix-window-function| for an explanation of how to write the
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +00006474 function and an example. The value can be the name of a function, a
6475 |lambda| or a |Funcref|. See |option-value-function| for more
6476 information.
Bram Moolenaar858ba062020-05-31 23:11:59 +02006477
6478 This option cannot be set from a |modeline| or in the |sandbox|, for
6479 security reasons.
6480
Bram Moolenaar677ee682005-01-27 14:41:15 +00006481 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00006482'quoteescape' 'qe' string (default "\")
6483 local to buffer
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00006484 The characters that are used to escape quotes in a string. Used for
6485 objects like a', a" and a` |a'|.
6486 When one of the characters in this option is found inside a string,
6487 the following character will be skipped. The default value makes the
6488 text "foo\"bar\\" considered to be one string.
6489
Bram Moolenaar071d4272004-06-13 20:20:40 +00006490 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
6491'readonly' 'ro' boolean (default off)
Christian Brabandt596ad662023-08-16 00:11:09 +02006492 local to buffer |local-noglobal|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006493 If on, writes fail unless you use a '!'. Protects you from
6494 accidentally overwriting a file. Default on when Vim is started
6495 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006496 When using ":w!" the 'readonly' option is reset for the current
6497 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar6c60f472019-04-28 16:00:35 +02006498 When using the ":view" command the 'readonly' option is set for the
6499 newly edited buffer.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01006500 See 'modifiable' for disallowing changes to the buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006501
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006502 *'redrawtime'* *'rdt'*
6503'redrawtime' 'rdt' number (default 2000)
6504 global
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006505 {only available when compiled with the |+reltime|
6506 feature}
6507 The time in milliseconds for redrawing the display. This applies to
Bram Moolenaar15142e22018-04-30 22:19:58 +02006508 searching for patterns for 'hlsearch', |:match| highlighting and syntax
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02006509 highlighting.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006510 When redrawing takes more than this many milliseconds no further
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02006511 matches will be highlighted.
6512 For syntax highlighting the time applies per window. When over the
6513 limit syntax highlighting is disabled until |CTRL-L| is used.
6514 This is used to avoid that Vim hangs when using a very complicated
6515 pattern.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006516
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02006517 *'regexpengine'* *'re'*
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006518'regexpengine' 're' number (default 0)
6519 global
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006520 This selects the default regexp engine. |two-engines|
6521 The possible values are:
6522 0 automatic selection
6523 1 old engine
6524 2 NFA engine
6525 Note that when using the NFA engine and the pattern contains something
6526 that is not supported the pattern will not match. This is only useful
6527 for debugging the regexp engine.
Bram Moolenaarfda37292014-11-05 14:27:36 +01006528 Using automatic selection enables Vim to switch the engine, if the
6529 default engine becomes too costly. E.g., when the NFA engine uses too
6530 many states. This should prevent Vim from hanging on a combination of
6531 a complex pattern with long text.
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006532
Bram Moolenaar64486672010-05-16 15:46:46 +02006533 *'relativenumber'* *'rnu'* *'norelativenumber'* *'nornu'*
6534'relativenumber' 'rnu' boolean (default off)
6535 local to window
Bram Moolenaar64486672010-05-16 15:46:46 +02006536 Show the line number relative to the line with the cursor in front of
Bram Moolenaar06b5d512010-05-22 15:37:44 +02006537 each line. Relative line numbers help you use the |count| you can
Bram Moolenaar64486672010-05-16 15:46:46 +02006538 precede some vertical motion commands (e.g. j k + -) with, without
6539 having to calculate it yourself. Especially useful in combination with
6540 other commands (e.g. y d c < > gq gw =).
6541 When the 'n' option is excluded from 'cpoptions' a wrapped
6542 line will not use the column of line numbers (this is the default when
6543 'compatible' isn't set).
6544 The 'numberwidth' option can be used to set the room used for the line
6545 number.
6546 When a long, wrapped line doesn't start with the first character, '-'
6547 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02006548 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
6549 the number.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01006550
Bram Moolenaar203d04d2013-06-06 21:36:40 +02006551 The number in front of the cursor line also depends on the value of
6552 'number', see |number_relativenumber| for all combinations of the two
6553 options.
Bram Moolenaar64486672010-05-16 15:46:46 +02006554
Bram Moolenaar071d4272004-06-13 20:20:40 +00006555 *'remap'* *'noremap'*
6556'remap' boolean (default on)
6557 global
6558 Allows for mappings to work recursively. If you do not want this for
6559 a single entry, use the :noremap[!] command.
Bram Moolenaara3227e22006-03-08 21:32:40 +00006560 NOTE: To avoid portability problems with Vim scripts, always keep
6561 this option at the default "on". Only switch it off when working with
6562 old Vi scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006563
zeertzjqd086b8f2024-02-25 15:42:52 +08006564 *'renderoptions'* *'rop'*
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006565'renderoptions' 'rop' string (default: empty)
6566 global
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006567 {only available when compiled with GUI and DIRECTX on
6568 MS-Windows}
6569 Select a text renderer and set its options. The options depend on the
6570 renderer.
6571
6572 Syntax: >
6573 set rop=type:{renderer}(,{name}:{value})*
6574<
6575 Currently, only one optional renderer is available.
6576
6577 render behavior ~
6578 directx Vim will draw text using DirectX (DirectWrite). It makes
6579 drawn glyphs more beautiful than default GDI.
6580 It requires 'encoding' is "utf-8", and only works on
6581 MS-Windows Vista or newer version.
6582
6583 Options:
6584 name meaning type value ~
6585 gamma gamma float 1.0 - 2.2 (maybe)
6586 contrast enhancedContrast float (unknown)
6587 level clearTypeLevel float (unknown)
6588 geom pixelGeometry int 0 - 2 (see below)
6589 renmode renderingMode int 0 - 6 (see below)
6590 taamode textAntialiasMode int 0 - 3 (see below)
Bram Moolenaara338adc2018-01-31 20:51:47 +01006591 scrlines Scroll Lines int (deprecated)
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006592
Bram Moolenaar92467d32017-12-05 13:22:16 +01006593 See this URL for detail (except for scrlines):
6594 https://msdn.microsoft.com/en-us/library/dd368190.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006595
6596 For geom: structure of a device pixel.
6597 0 - DWRITE_PIXEL_GEOMETRY_FLAT
6598 1 - DWRITE_PIXEL_GEOMETRY_RGB
6599 2 - DWRITE_PIXEL_GEOMETRY_BGR
6600
6601 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006602 https://msdn.microsoft.com/en-us/library/dd368114.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006603
6604 For renmode: method of rendering glyphs.
6605 0 - DWRITE_RENDERING_MODE_DEFAULT
6606 1 - DWRITE_RENDERING_MODE_ALIASED
6607 2 - DWRITE_RENDERING_MODE_GDI_CLASSIC
6608 3 - DWRITE_RENDERING_MODE_GDI_NATURAL
6609 4 - DWRITE_RENDERING_MODE_NATURAL
6610 5 - DWRITE_RENDERING_MODE_NATURAL_SYMMETRIC
6611 6 - DWRITE_RENDERING_MODE_OUTLINE
6612
6613 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006614 https://msdn.microsoft.com/en-us/library/dd368118.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006615
6616 For taamode: antialiasing mode used for drawing text.
6617 0 - D2D1_TEXT_ANTIALIAS_MODE_DEFAULT
6618 1 - D2D1_TEXT_ANTIALIAS_MODE_CLEARTYPE
6619 2 - D2D1_TEXT_ANTIALIAS_MODE_GRAYSCALE
6620 3 - D2D1_TEXT_ANTIALIAS_MODE_ALIASED
6621
6622 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006623 https://msdn.microsoft.com/en-us/library/dd368170.aspx
6624
Bram Moolenaara338adc2018-01-31 20:51:47 +01006625 For scrlines:
6626 This was used for optimizing scrolling behavior, however this
6627 is now deprecated. If specified, it is simply ignored.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006628
6629 Example: >
6630 set encoding=utf-8
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006631 set gfn=Ricty_Diminished:h12
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006632 set rop=type:directx
6633<
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006634 If select a raster font (Courier, Terminal or FixedSys which
6635 have ".fon" extension in file name) to 'guifont', it will be
Bram Moolenaar92467d32017-12-05 13:22:16 +01006636 drawn by GDI as a fallback.
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006637
6638 NOTE: It is known that some fonts and options combination
6639 causes trouble on drawing glyphs.
6640
Bram Moolenaar92467d32017-12-05 13:22:16 +01006641 - 'renmode:5' and 'renmode:6' will not work with some
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006642 special made fonts (True-Type fonts which includes only
6643 bitmap glyphs).
6644 - 'taamode:3' will not work with some vector fonts.
6645
6646 NOTE: With this option, you can display colored emoji
6647 (emoticon) in Windows 8.1 or later. To display colored emoji,
6648 there are some conditions which you should notice.
6649
6650 - If your font includes non-colored emoji already, it will
6651 be used.
6652 - If your font doesn't have emoji, the system chooses an
6653 alternative symbol font. On Windows 10, "Segoe UI Emoji"
6654 will be used.
6655 - When this alternative font didn't have fixed width glyph,
6656 emoji might be rendered beyond the bounding box of drawing
6657 cell.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006658
6659 Other render types are currently not supported.
6660
Bram Moolenaar071d4272004-06-13 20:20:40 +00006661 *'report'*
6662'report' number (default 2)
6663 global
6664 Threshold for reporting number of lines changed. When the number of
6665 changed lines is more than 'report' a message will be given for most
6666 ":" commands. If you want it always, set 'report' to 0.
6667 For the ":substitute" command the number of substitutions is used
6668 instead of the number of lines.
6669
6670 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
6671'restorescreen' 'rs' boolean (default on)
6672 global
Bram Moolenaar8024f932020-01-14 19:29:13 +01006673 {only in MS-Windows console version}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006674 When set, the screen contents is restored when exiting Vim. This also
6675 happens when executing external commands.
6676
6677 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
6678 options in your .vimrc. To disable restoring:
6679 set t_ti= t_te=
6680 To enable restoring (for an xterm):
6681 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
6682 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
6683
6684 *'revins'* *'ri'* *'norevins'* *'nori'*
6685'revins' 'ri' boolean (default off)
6686 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006687 {only available when compiled with the |+rightleft|
6688 feature}
6689 Inserting characters in Insert mode will work backwards. See "typing
6690 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
6691 command in Insert mode, when 'allowrevins' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02006692 NOTE: This option is reset when 'compatible' is set.
6693 This option is reset when 'paste' is set and restored when 'paste' is
6694 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006695
6696 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
6697'rightleft' 'rl' boolean (default off)
6698 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006699 {only available when compiled with the |+rightleft|
6700 feature}
6701 When on, display orientation becomes right-to-left, i.e., characters
6702 that are stored in the file appear from the right to the left.
6703 Using this option, it is possible to edit files for languages that
6704 are written from the right to the left such as Hebrew and Arabic.
6705 This option is per window, so it is possible to edit mixed files
6706 simultaneously, or to view the same file in both ways (this is
6707 useful whenever you have a mixed text file with both right-to-left
6708 and left-to-right strings so that both sets are displayed properly
6709 in different windows). Also see |rileft.txt|.
6710
Bram Moolenaar607cc1e2010-07-18 18:47:44 +02006711 *'rightleftcmd'* *'rlc'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006712'rightleftcmd' 'rlc' string (default "search")
6713 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006714 {only available when compiled with the |+rightleft|
6715 feature}
6716 Each word in this option enables the command line editing to work in
6717 right-to-left mode for a group of commands:
6718
6719 search "/" and "?" commands
6720
6721 This is useful for languages such as Hebrew, Arabic and Farsi.
6722 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
6723
Bram Moolenaard94464e2015-11-02 15:28:18 +01006724 *'rubydll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01006725'rubydll' string (default: depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01006726 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01006727 {only available when compiled with the |+ruby/dyn|
6728 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006729 Specifies the name of the Ruby shared library. The default is
6730 DYNAMIC_RUBY_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006731 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01006732 This option cannot be set from a |modeline| or in the |sandbox|, for
6733 security reasons.
6734
Bram Moolenaar071d4272004-06-13 20:20:40 +00006735 *'ruler'* *'ru'* *'noruler'* *'noru'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02006736'ruler' 'ru' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006737 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006738 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006739 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00006740 text in the file is shown on the far right:
6741 Top first line is visible
6742 Bot last line is visible
6743 All first and last line are visible
6744 45% relative position in the file
6745 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006746 Each window has its own ruler. If a window has a status line, the
Bram Moolenaara2a89732022-08-31 14:46:18 +01006747 ruler is shown there. Otherwise it is shown in the last line of the
6748 screen. If the statusline is given by 'statusline' (i.e. not empty),
6749 this option takes precedence over 'ruler' and 'rulerformat'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006750 If the number of characters displayed is different from the number of
Bram Moolenaar207f0092020-08-30 17:20:20 +02006751 bytes in the text (e.g., for a TAB or a multibyte character), both
Bram Moolenaar071d4272004-06-13 20:20:40 +00006752 the text column (byte number) and the screen column are shown,
6753 separated with a dash.
6754 For an empty line "0-1" is shown.
6755 For an empty buffer the line number will also be zero: "0,0-1".
Bram Moolenaarca635012015-09-25 20:34:21 +02006756 This option is reset when 'paste' is set and restored when 'paste' is
6757 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006758 If you don't want to see the ruler all the time but want to know where
6759 you are, use "g CTRL-G" |g_CTRL-G|.
6760 NOTE: This option is reset when 'compatible' is set.
6761
6762 *'rulerformat'* *'ruf'*
6763'rulerformat' 'ruf' string (default empty)
6764 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006765 {not available when compiled without the |+statusline|
6766 feature}
6767 When this option is not empty, it determines the content of the ruler
6768 string, as displayed for the 'ruler' option.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00006769 The format of this option is like that of 'statusline'.
Bram Moolenaar110289e2019-05-23 15:38:06 +02006770 This option cannot be set in a modeline when 'modelineexpr' is off.
6771
Bram Moolenaar071d4272004-06-13 20:20:40 +00006772 The default ruler width is 17 characters. To make the ruler 15
6773 characters wide, put "%15(" at the start and "%)" at the end.
6774 Example: >
6775 :set rulerformat=%15(%c%V\ %p%%%)
6776<
6777 *'runtimepath'* *'rtp'* *vimfiles*
6778'runtimepath' 'rtp' string (default:
Christian Brabandtc3e6e392024-05-04 09:48:15 +02006779 Unix: "$HOME/.vim or
6780 $XDG_CONFIG_HOME/vim,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006781 $VIM/vimfiles,
6782 $VIMRUNTIME,
6783 $VIM/vimfiles/after,
6784 $HOME/.vim/after"
6785 Amiga: "home:vimfiles,
6786 $VIM/vimfiles,
6787 $VIMRUNTIME,
6788 $VIM/vimfiles/after,
6789 home:vimfiles/after"
Bram Moolenaar942db232021-02-13 18:14:48 +01006790 MS-Windows: "$HOME/vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006791 $VIM/vimfiles,
6792 $VIMRUNTIME,
6793 $VIM/vimfiles/after,
6794 $HOME/vimfiles/after"
Bram Moolenaarb3f74062020-02-26 16:16:53 +01006795 Haiku: "$BE_USER_SETTINGS/vim,
6796 $VIM/vimfiles,
6797 $VIMRUNTIME,
6798 $VIM/vimfiles/after,
Bram Moolenaar942db232021-02-13 18:14:48 +01006799 $BE_USER_SETTINGS/vim/after"
6800 VMS: "sys$login:vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006801 $VIM/vimfiles,
6802 $VIMRUNTIME,
6803 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00006804 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006805 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006806 This is a list of directories which will be searched for runtime
6807 files:
6808 filetype.vim filetypes by file name |new-filetype|
6809 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006810 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006811 colors/ color scheme files |:colorscheme|
6812 compiler/ compiler files |:compiler|
6813 doc/ documentation |write-local-help|
6814 ftplugin/ filetype plugins |write-filetype-plugin|
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01006815 import/ files that are found by `:import`
Bram Moolenaar071d4272004-06-13 20:20:40 +00006816 indent/ indent scripts |indent-expression|
6817 keymap/ key mapping files |mbyte-keymap|
RestorerZ96509102024-07-11 21:14:15 +02006818 lang/ message translations |:menutrans| and |multi-lang|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006819 menu.vim GUI menus |menu.vim|
Bram Moolenaar26852122016-05-24 20:02:38 +02006820 pack/ packages |:packadd|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006821 plugin/ plugin scripts |write-plugin|
6822 print/ files for printing |postscript-print-encoding|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006823 spell/ spell checking files |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006824 syntax/ syntax files |mysyntaxfile|
6825 tutor/ files for vimtutor |tutor|
6826
6827 And any other file searched for with the |:runtime| command.
6828
Christian Brabandtc3e6e392024-05-04 09:48:15 +02006829 For $XDG_CONFIG_HOME see |xdg-base-dir|.
6830
Bram Moolenaar071d4272004-06-13 20:20:40 +00006831 The defaults for most systems are setup to search five locations:
6832 1. In your home directory, for your personal preferences.
6833 2. In a system-wide Vim directory, for preferences from the system
6834 administrator.
6835 3. In $VIMRUNTIME, for files distributed with Vim.
6836 *after-directory*
6837 4. In the "after" directory in the system-wide Vim directory. This is
6838 for the system administrator to overrule or add to the distributed
6839 defaults (rarely needed)
6840 5. In the "after" directory in your home directory. This is for
6841 personal preferences to overrule or add to the distributed defaults
6842 or system-wide settings (rarely needed).
6843
Bram Moolenaard0796902016-09-16 20:02:31 +02006844 More entries are added when using |packages|. If it gets very long
6845 then `:set rtp` will be truncated, use `:echo &rtp` to see the full
6846 string.
Bram Moolenaar26852122016-05-24 20:02:38 +02006847
Bram Moolenaar071d4272004-06-13 20:20:40 +00006848 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
6849 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006850 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00006851 wildcards.
6852 See |:runtime|.
6853 Example: >
6854 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
6855< This will use the directory "~/vimruntime" first (containing your
6856 personal Vim runtime files), then "/mygroup/vim" (shared between a
6857 group of people) and finally "$VIMRUNTIME" (the distributed runtime
6858 files).
6859 You probably should always include $VIMRUNTIME somewhere, to use the
6860 distributed runtime files. You can put a directory before $VIMRUNTIME
6861 to find files which replace a distributed runtime files. You can put
6862 a directory after $VIMRUNTIME to find files which add to distributed
6863 runtime files.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006864 When Vim is started with |--clean| the home directory entries are not
6865 included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006866 This option cannot be set from a |modeline| or in the |sandbox|, for
6867 security reasons.
6868
6869 *'scroll'* *'scr'*
6870'scroll' 'scr' number (default: half the window height)
Christian Brabandt596ad662023-08-16 00:11:09 +02006871 local to window |local-noglobal|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006872 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
6873 set to half the number of lines in the window when the window size
Bram Moolenaar74667062020-12-28 15:41:41 +01006874 changes. This may happen when enabling the |status-line| or
6875 'tabline' option after setting the 'scroll' option.
6876 If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006877 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar25c9c682019-05-05 18:13:34 +02006878 height with ":set scroll=0".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006879
6880 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
6881'scrollbind' 'scb' boolean (default off)
6882 local to window
zeertzjq5277cfa2023-09-28 01:00:12 +08006883 See also |scroll-binding|. When this option is set, scrolling the
6884 current window also scrolls other scrollbind windows (windows that
6885 also have this option set). This option is useful for viewing the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006886 differences between two versions of a file, see 'diff'.
6887 See |'scrollopt'| for options that determine how this option should be
6888 interpreted.
6889 This option is mostly reset when splitting a window to edit another
6890 file. This means that ":split | edit file" results in two windows
6891 with scroll-binding, but ":split file" does not.
6892
Bram Moolenaarae20f342019-11-05 21:09:23 +01006893 *'scrollfocus'* *'scf'* *'noscrollfocus'* *'noscf'*
6894'scrollfocus' 'scf' boolean (default off)
6895 global
6896 {only for MS-Windows GUI}
6897 When using the scroll wheel and this option is set, the window under
6898 the mouse pointer is scrolled. With this option off the current
6899 window is scrolled.
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01006900 Systems other than MS-Windows always behave like this option is on.
Bram Moolenaarae20f342019-11-05 21:09:23 +01006901
Bram Moolenaar071d4272004-06-13 20:20:40 +00006902 *'scrolljump'* *'sj'*
6903'scrolljump' 'sj' number (default 1)
6904 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006905 Minimal number of lines to scroll when the cursor gets off the
6906 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
6907 CTRL-D). Useful if your terminal scrolls very slowly.
Bram Moolenaar1e015462005-09-25 22:16:38 +00006908 When set to a negative number from -1 to -100 this is used as the
6909 percentage of the window height. Thus -50 scrolls half the window
6910 height.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006911 NOTE: This option is set to 1 when 'compatible' is set.
6912
6913 *'scrolloff'* *'so'*
Bram Moolenaar50ba5262016-09-22 22:33:02 +02006914'scrolloff' 'so' number (default 0, set to 5 in |defaults.vim|)
Bram Moolenaar375e3392019-01-31 18:26:10 +01006915 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006916 Minimal number of screen lines to keep above and below the cursor.
6917 This will make some context visible around where you are working. If
6918 you set it to a very large value (999) the cursor line will always be
6919 in the middle of the window (except at the start or end of the file or
6920 when long lines wrap).
Bram Moolenaar375e3392019-01-31 18:26:10 +01006921 After using the local value, go back the global value with one of
6922 these two: >
6923 setlocal scrolloff<
6924 setlocal scrolloff=-1
6925< For scrolling horizontally see 'sidescrolloff'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006926 NOTE: This option is set to 0 when 'compatible' is set.
6927
6928 *'scrollopt'* *'sbo'*
6929'scrollopt' 'sbo' string (default "ver,jump")
6930 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006931 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006932 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
6933 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006934 The following words are available:
6935 ver Bind vertical scrolling for 'scrollbind' windows
6936 hor Bind horizontal scrolling for 'scrollbind' windows
6937 jump Applies to the offset between two windows for vertical
6938 scrolling. This offset is the difference in the first
6939 displayed line of the bound windows. When moving
6940 around in a window, another 'scrollbind' window may
6941 reach a position before the start or after the end of
6942 the buffer. The offset is not changed though, when
6943 moving back the 'scrollbind' window will try to scroll
6944 to the desired position when possible.
6945 When now making that window the current one, two
6946 things can be done with the relative offset:
6947 1. When "jump" is not included, the relative offset is
6948 adjusted for the scroll position in the new current
6949 window. When going back to the other window, the
Bram Moolenaar02467872007-05-06 13:22:01 +00006950 new relative offset will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006951 2. When "jump" is included, the other windows are
6952 scrolled to keep the same relative offset. When
6953 going back to the other window, it still uses the
6954 same relative offset.
6955 Also see |scroll-binding|.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006956 When 'diff' mode is active there always is vertical scroll binding,
6957 even when "ver" isn't there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006958
6959 *'sections'* *'sect'*
6960'sections' 'sect' string (default "SHNHH HUnhsh")
6961 global
6962 Specifies the nroff macros that separate sections. These are pairs of
6963 two letters (See |object-motions|). The default makes a section start
6964 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
6965
6966 *'secure'* *'nosecure'* *E523*
6967'secure' boolean (default off)
6968 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006969 When on, ":autocmd", shell and write commands are not allowed in
6970 ".vimrc" and ".exrc" in the current directory and map commands are
6971 displayed. Switch it off only if you know that you will not run into
6972 problems, or when the 'exrc' option is off. On Unix this option is
6973 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006974 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00006975 'secure' at the end of your ~/.vimrc then.
6976 This option cannot be set from a |modeline| or in the |sandbox|, for
6977 security reasons.
6978
6979 *'selection'* *'sel'*
6980'selection' 'sel' string (default "inclusive")
6981 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006982 This option defines the behavior of the selection. It is only used
6983 in Visual and Select mode.
6984 Possible values:
6985 value past line inclusive ~
6986 old no yes
6987 inclusive yes yes
6988 exclusive yes no
6989 "past line" means that the cursor is allowed to be positioned one
6990 character past the line.
6991 "inclusive" means that the last character of the selection is included
6992 in an operation. For example, when "x" is used to delete the
6993 selection.
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02006994 When "old" is used and 'virtualedit' allows the cursor to move past
6995 the end of line the line break still isn't included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006996 Note that when "exclusive" is used and selecting from the end
6997 backwards, you cannot include the last character of a line, when
6998 starting in Normal mode and 'virtualedit' empty.
6999
7000 The 'selection' option is set by the |:behave| command.
7001
7002 *'selectmode'* *'slm'*
7003'selectmode' 'slm' string (default "")
7004 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007005 This is a comma-separated list of words, which specifies when to start
Bram Moolenaar071d4272004-06-13 20:20:40 +00007006 Select mode instead of Visual mode, when a selection is started.
7007 Possible values:
7008 mouse when using the mouse
7009 key when using shifted special keys
7010 cmd when using "v", "V" or CTRL-V
7011 See |Select-mode|.
7012 The 'selectmode' option is set by the |:behave| command.
7013
7014 *'sessionoptions'* *'ssop'*
7015'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
Bram Moolenaarb5b75622018-03-09 22:22:21 +01007016 help,options,tabpages,winsize,terminal")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007017 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02007018 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007019 feature}
7020 Changes the effect of the |:mksession| command. It is a comma
7021 separated list of words. Each word enables saving and restoring
7022 something:
7023 word save and restore ~
7024 blank empty windows
7025 buffers hidden and unloaded buffers, not just those in windows
7026 curdir the current directory
7027 folds manually created folds, opened/closed folds and local
7028 fold options
7029 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00007030 and contain at least one lowercase letter. Only
7031 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007032 help the help window
7033 localoptions options and mappings local to a window or buffer (not
7034 global values for local options)
7035 options all options and mappings (also global values for local
7036 options)
Bram Moolenaard23b7142021-04-17 21:04:34 +02007037 skiprtp exclude 'runtimepath' and 'packpath' from the options
Bram Moolenaar071d4272004-06-13 20:20:40 +00007038 resize size of the Vim window: 'lines' and 'columns'
7039 sesdir the directory in which the session file is located
7040 will become the current directory (useful with
7041 projects accessed over a network from different
7042 systems)
7043 slash backslashes in file names replaced with forward
7044 slashes
Bram Moolenaar18144c82006-04-12 21:52:12 +00007045 tabpages all tab pages; without this only the current tab page
7046 is restored, so that you can make a session for each
7047 tab page separately
Bram Moolenaard473c8c2018-08-11 18:00:22 +02007048 terminal include terminal windows where the command can be
7049 restored
Bram Moolenaar071d4272004-06-13 20:20:40 +00007050 unix with Unix end-of-line format (single <NL>), even when
7051 on Windows or DOS
7052 winpos position of the whole Vim window
7053 winsize window sizes
7054
7055 Don't include both "curdir" and "sesdir".
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007056 When neither "curdir" nor "sesdir" is included, file names are stored
7057 with absolute paths.
Bram Moolenaar2f0936c2022-01-08 21:51:59 +00007058 If you leave out "options" many things won't work well after restoring
7059 the session.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007060 "slash" and "unix" are useful on Windows when sharing session files
7061 with Unix. The Unix version of Vim cannot source dos format scripts,
7062 but the Windows version of Vim can source unix format scripts.
7063
7064 *'shell'* *'sh'* *E91*
Bram Moolenaar95a9dd12019-12-19 22:12:03 +01007065'shell' 'sh' string (default $SHELL or "sh", Win32: "cmd.exe")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007066 global
7067 Name of the shell to use for ! and :! commands. When changing the
7068 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
7069 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007070 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007071 See |option-backslash| about including spaces and backslashes.
7072 Environment variables are expanded |:set_env|.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01007073
Bram Moolenaara2baa732022-02-04 16:09:54 +00007074 In |restricted-mode| shell commands will not be possible. This mode
7075 is used if the value of $SHELL ends in "false" or "nologin".
7076
Bram Moolenaar1ff14ba2019-11-02 14:09:23 +01007077 If the name of the shell contains a space, you need to enclose it in
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01007078 quotes and escape the space. Example with quotes: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007079 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
7080< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007081 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00007082 "-f" is not inside the quotes, because it is not part of the command
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01007083 name. Vim automagically recognizes the backslashes that are path
Bram Moolenaar071d4272004-06-13 20:20:40 +00007084 separators.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01007085 Example with escaped space (Vim will do this when initializing the
7086 option from $SHELL): >
7087 :set shell=/bin/with\\\ space/sh
Bram Moolenaard473c8c2018-08-11 18:00:22 +02007088< The resulting value of 'shell' is "/bin/with\ space/sh", two
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01007089 backslashes are consumed by `:set`.
7090
Bram Moolenaar071d4272004-06-13 20:20:40 +00007091 Under MS-Windows, when the executable ends in ".com" it must be
7092 included. Thus setting the shell to "command.com" or "4dos.com"
7093 works, but "command" and "4dos" do not work for all commands (e.g.,
7094 filtering).
7095 For unknown reasons, when using "4dos.com" the current directory is
7096 changed to "C:\". To avoid this set 'shell' like this: >
7097 :set shell=command.com\ /c\ 4dos
7098< This option cannot be set from a |modeline| or in the |sandbox|, for
7099 security reasons.
7100
7101 *'shellcmdflag'* *'shcf'*
Bram Moolenaar5dc62522012-02-13 00:05:22 +01007102'shellcmdflag' 'shcf' string (default: "-c";
Mike Williams12795022021-06-28 20:53:58 +02007103 Win32, when 'shell' contains "powershell":
7104 "-Command", or when it does not contain "sh"
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01007105 somewhere: "/c")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007106 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007107 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
Mike Williams12795022021-06-28 20:53:58 +02007108 "bash.exe -c ls", "powershell.exe -Command dir", or "cmd.exe /c dir".
7109 For MS-Windows, the default is set according to the value of 'shell',
7110 to reduce the need to set this option by the user.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02007111 On Unix it can have more than one flag. Each white space separated
7112 part is passed as an argument to the shell command.
7113 See |option-backslash| about including spaces and backslashes.
Mike Williams12795022021-06-28 20:53:58 +02007114 Also see |dos-shell| and |dos-powershell| for MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007115 This option cannot be set from a |modeline| or in the |sandbox|, for
7116 security reasons.
7117
7118 *'shellpipe'* *'sp'*
Mike Williams12795022021-06-28 20:53:58 +02007119'shellpipe' 'sp' string (default ">", ">%s 2>&1", "| tee", "|& tee"
7120 "2>&1| tee", or
7121 "2>&1 | Out-File -Encoding default")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007122 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007123 {not available when compiled without the |+quickfix|
7124 feature}
7125 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007126 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00007127 including spaces and backslashes.
7128 The name of the temporary file can be represented by "%s" if necessary
7129 (the file name is appended automatically if no %s appears in the value
7130 of this option).
Mike Williams12795022021-06-28 20:53:58 +02007131 For the Amiga the default is ">". For MS-Windows using powershell the
7132 default is "2>&1 | Out-File -Encoding default", otherwise the default
7133 is ">%s 2>&1". The output is directly saved in a file and not echoed
7134 to the screen.
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02007135 For Unix the default is "| tee". The stdout of the compiler is saved
Bram Moolenaar071d4272004-06-13 20:20:40 +00007136 in a file and echoed to the screen. If the 'shell' option is "csh" or
7137 "tcsh" after initializations, the default becomes "|& tee". If the
Bram Moolenaar96f45c02019-10-26 19:53:45 +02007138 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh", "zsh-beta",
Natanael Copa56318362021-05-06 18:46:35 +02007139 "bash", "fish", "ash" or "dash" the default becomes "2>&1| tee". This
7140 means that stderr is also included. Before using the 'shell' option a
7141 path is removed, thus "/bin/sh" uses "sh".
Mike Williamsa3d1b292021-06-30 20:56:00 +02007142 For Unix and MS-Windows, when the 'shell' option is "pwsh" the default
7143 becomes ">%s 2>&1" and the output is not echoed to the screen.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007144 The initialization of this option is done after reading the ".vimrc"
7145 and the other initializations, so that when the 'shell' option is set
7146 there, the 'shellpipe' option changes automatically, unless it was
7147 explicitly set before.
7148 When 'shellpipe' is set to an empty string, no redirection of the
7149 ":make" output will be done. This is useful if you use a 'makeprg'
7150 that writes to 'makeef' by itself. If you want no piping, but do
7151 want to include the 'makeef', set 'shellpipe' to a single space.
7152 Don't forget to precede the space with a backslash: ":set sp=\ ".
7153 In the future pipes may be used for filtering and this option will
7154 become obsolete (at least for Unix).
7155 This option cannot be set from a |modeline| or in the |sandbox|, for
7156 security reasons.
7157
7158 *'shellquote'* *'shq'*
Mike Williamsa3d1b292021-06-30 20:56:00 +02007159'shellquote' 'shq' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007160 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007161 Quoting character(s), put around the command passed to the shell, for
7162 the "!" and ":!" commands. The redirection is kept outside of the
7163 quoting. See 'shellxquote' to include the redirection. It's
7164 probably not useful to set both options.
7165 This is an empty string by default. Only known to be useful for
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01007166 third-party shells on MS-Windows-like systems, such as the MKS Korn
Mike Williamsa3d1b292021-06-30 20:56:00 +02007167 Shell or bash, where it should be "\"". See |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007168 This option cannot be set from a |modeline| or in the |sandbox|, for
7169 security reasons.
7170
7171 *'shellredir'* *'srr'*
Mike Williams12795022021-06-28 20:53:58 +02007172'shellredir' 'srr' string (default ">", ">&", ">%s 2>&1", or
7173 "2>&1 | Out-File -Encoding default")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007174 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007175 String to be used to put the output of a filter command in a temporary
7176 file. See also |:!|. See |option-backslash| about including spaces
7177 and backslashes.
7178 The name of the temporary file can be represented by "%s" if necessary
7179 (the file name is appended automatically if no %s appears in the value
7180 of this option).
Bram Moolenaar96f45c02019-10-26 19:53:45 +02007181 The default is ">". For Unix, if the 'shell' option is "csh" or
7182 "tcsh" during initializations, the default becomes ">&". If the
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007183 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh", "zsh-beta",
Mike Williamsa3d1b292021-06-30 20:56:00 +02007184 "bash", "fish", or "pwsh", the default becomes ">%s 2>&1". This means
7185 that stderr is also included. For Win32, the Unix checks are done and
Mike Williams12795022021-06-28 20:53:58 +02007186 additionally "cmd" is checked for, which makes the default ">%s 2>&1",
7187 and "powershell" is checked for which makes the default
Mike Williamsa3d1b292021-06-30 20:56:00 +02007188 "2>&1 | Out-File -Encoding default" (see |dos-powershell|). Also, the
7189 same names with ".exe" appended are checked for.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007190 The initialization of this option is done after reading the ".vimrc"
7191 and the other initializations, so that when the 'shell' option is set
7192 there, the 'shellredir' option changes automatically unless it was
7193 explicitly set before.
7194 In the future pipes may be used for filtering and this option will
7195 become obsolete (at least for Unix).
7196 This option cannot be set from a |modeline| or in the |sandbox|, for
7197 security reasons.
7198
7199 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
7200'shellslash' 'ssl' boolean (default off)
7201 global
Bram Moolenaar6f345a12019-12-17 21:27:18 +01007202 {only for MS-Windows}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007203 When set, a forward slash is used when expanding file names. This is
Mike Williamsa3d1b292021-06-30 20:56:00 +02007204 useful when a Unix-like shell is used instead of cmd.exe, pwsh.exe, or
Mike Williams12795022021-06-28 20:53:58 +02007205 powershell.exe. Backward slashes can still be typed, but they are
7206 changed to forward slashes by Vim.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007207 Note that setting or resetting this option has no effect for some
7208 existing file names, thus this option needs to be set before opening
7209 any file for best results. This might change in the future.
7210 'shellslash' only works when a backslash can be used as a path
7211 separator. To test if this is so use: >
7212 if exists('+shellslash')
Bram Moolenaarac3150d2019-07-28 16:36:39 +02007213< Also see 'completeslash'.
7214
Bram Moolenaar26a60b42005-02-22 08:49:11 +00007215 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
7216'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
7217 global
Bram Moolenaar26a60b42005-02-22 08:49:11 +00007218 When on, use temp files for shell commands. When off use a pipe.
7219 When using a pipe is not possible temp files are used anyway.
Bram Moolenaar97293012011-07-18 19:40:27 +02007220 Currently a pipe is only supported on Unix and MS-Windows 2K and
7221 later. You can check it with: >
Bram Moolenaar26a60b42005-02-22 08:49:11 +00007222 :if has("filterpipe")
7223< The advantage of using a pipe is that nobody can read the temp file
7224 and the 'shell' command does not need to support redirection.
7225 The advantage of using a temp file is that the file type and encoding
7226 can be detected.
7227 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
7228 |FilterWritePost| autocommands event are not triggered when
7229 'shelltemp' is off.
Bram Moolenaar269f5952016-07-15 22:54:41 +02007230 The `system()` function does not respect this option and always uses
7231 temp files.
Bram Moolenaar036986f2017-03-16 17:41:02 +01007232 NOTE: This option is set to the Vim default value when 'compatible'
7233 is reset.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00007234
Bram Moolenaar071d4272004-06-13 20:20:40 +00007235 *'shelltype'* *'st'*
7236'shelltype' 'st' number (default 0)
7237 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02007238 {only for the Amiga}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007239 On the Amiga this option influences the way how the commands work
7240 which use a shell.
7241 0 and 1: always use the shell
7242 2 and 3: use the shell only to filter lines
7243 4 and 5: use shell only for ':sh' command
7244 When not using the shell, the command is executed directly.
7245
7246 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
7247 1 and 3: use "shell cmd" to start external commands
7248
Bram Moolenaardb7207e2012-02-22 17:30:19 +01007249 *'shellxescape'* *'sxe'*
7250'shellxescape' 'sxe' string (default: "";
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01007251 for MS-Windows: "\"&|<>()@^")
Bram Moolenaardb7207e2012-02-22 17:30:19 +01007252 global
Bram Moolenaardb7207e2012-02-22 17:30:19 +01007253 When 'shellxquote' is set to "(" then the characters listed in this
7254 option will be escaped with a '^' character. This makes it possible
7255 to execute most external commands with cmd.exe.
dkearns8ebdbc92023-10-29 06:26:19 +11007256 This option cannot be set from a |modeline| or in the |sandbox|, for
7257 security reasons.
Bram Moolenaardb7207e2012-02-22 17:30:19 +01007258
Bram Moolenaar071d4272004-06-13 20:20:40 +00007259 *'shellxquote'* *'sxq'*
7260'shellxquote' 'sxq' string (default: "";
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01007261 for Win32, when 'shell' is cmd.exe: "("
Mike Williams12795022021-06-28 20:53:58 +02007262 for Win32, when 'shell' is
7263 powershell.exe: "\""
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01007264 for Win32, when 'shell' contains "sh"
7265 somewhere: "\""
Bram Moolenaar071d4272004-06-13 20:20:40 +00007266 for Unix, when using system(): "\"")
7267 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007268 Quoting character(s), put around the command passed to the shell, for
7269 the "!" and ":!" commands. Includes the redirection. See
7270 'shellquote' to exclude the redirection. It's probably not useful
7271 to set both options.
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01007272 When the value is '(' then ')' is appended. When the value is '"('
7273 then ')"' is appended.
7274 When the value is '(' then also see 'shellxescape'.
Bram Moolenaara64ba222012-02-12 23:23:31 +01007275 This is an empty string by default on most systems, but is known to be
Mike Williamsa3d1b292021-06-30 20:56:00 +02007276 useful for on Win32 version, either for cmd.exe, powershell.exe, or
7277 pwsh.exe which automatically strips off the first and last quote on a
7278 command, or 3rd-party shells such as the MKS Korn Shell or bash, where
7279 it should be "\"". The default is adjusted according the value of
Mike Williams12795022021-06-28 20:53:58 +02007280 'shell', to reduce the need to set this option by the user. See
7281 |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007282 This option cannot be set from a |modeline| or in the |sandbox|, for
7283 security reasons.
7284
7285 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
7286'shiftround' 'sr' boolean (default off)
7287 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007288 Round indent to multiple of 'shiftwidth'. Applies to > and <
7289 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
7290 a multiple of 'shiftwidth' (this is Vi compatible).
7291 NOTE: This option is reset when 'compatible' is set.
7292
7293 *'shiftwidth'* *'sw'*
7294'shiftwidth' 'sw' number (default 8)
7295 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007296 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00007297 |'cindent'|, |>>|, |<<|, etc.
Bram Moolenaar10e8ff92023-06-10 21:40:39 +01007298 When zero the 'tabstop' value will be used. Use the |shiftwidth()|
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02007299 function to get the effective shiftwidth value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007300
7301 *'shortmess'* *'shm'*
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02007302'shortmess' 'shm' string (Vim default "filnxtToOS", Vi default: "S",
7303 POSIX default: "AS")
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007304 global *E1336*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007305 This option helps to avoid all the |hit-enter| prompts caused by file
Dominique Pellédf62c622024-07-15 20:29:59 +02007306 messages, for example with CTRL-G, and to avoid some other messages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007307 It is a list of flags:
7308 flag meaning when present ~
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007309 f use "(3 of 5)" instead of "(file 3 of 5)" *shm-f*
7310 i use "[noeol]" instead of "[Incomplete last line]" *shm-i*
7311 l use "999L, 888B" instead of "999 lines, 888 bytes" *shm-l*
7312 m use "[+]" instead of "[Modified]" *shm-m*
7313 n use "[New]" instead of "[New File]" *shm-n*
7314 r use "[RO]" instead of "[readonly]" *shm-r*
7315 w use "[w]" instead of "written" for file write message *shm-w*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007316 and "[a]" instead of "appended" for ':w >> file' command
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007317 x use "[dos]" instead of "[dos format]", "[unix]" *shm-x*
7318 instead of "[unix format]" and "[mac]" instead of "[mac
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007319 format]"
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007320 a all of the above abbreviations *shm-a*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007321
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007322 o overwrite message for writing a file with subsequent *shm-o*
7323 message for reading a file (useful for ":wn" or when
7324 'autowrite' on)
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007325 O message for reading a file overwrites any previous *shm-O*
7326 message; also for quickfix message (e.g., ":cn")
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007327 s don't give "search hit BOTTOM, continuing at TOP" or *shm-s*
7328 "search hit TOP, continuing at BOTTOM" messages; when using
Christian Brabandte2995912024-06-01 20:40:25 +02007329 the search count do not show "W" before the count message
7330 (see |shm-S| below)
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007331 t truncate file message at the start if it is too long *shm-t*
7332 to fit on the command-line, "<" will appear in the left most
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007333 column; ignored in Ex mode
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007334 T truncate other messages in the middle if they are too *shm-T*
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007335 long to fit on the command line; "..." will appear in the
7336 middle; ignored in Ex mode
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007337 W don't give "written" or "[w]" when writing a file *shm-W*
7338 A don't give the "ATTENTION" message when an existing *shm-A*
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007339 swap file is found
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007340 I don't give the intro message when starting Vim, *shm-I*
Bram Moolenaar938ae282023-02-20 20:44:55 +00007341 see |:intro|
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007342 c don't give |ins-completion-menu| messages; for *shm-c*
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007343 example, "-- XXX completion (YYY)", "match 1 of 2", "The only
7344 match", "Pattern not found", "Back at original", etc.
7345 C don't give messages while scanning for ins-completion *shm-C*
7346 items, for instance "scanning tags"
7347 q use "recording" instead of "recording @a" *shm-q*
7348 F don't give the file info when editing a file, like *shm-F*
7349 `:silent` was used for the command; note that this also
Shougo Matsushita9db39b02024-03-06 20:58:41 +01007350 affects messages from autocommands and 'autoread' reloading
Bram Moolenaar938ae282023-02-20 20:44:55 +00007351 S do not show search count message when searching, e.g. *shm-S*
Christian Brabandte2995912024-06-01 20:40:25 +02007352 "[1/5]". When the "S" flag is not present (e.g. search count
7353 is shown), the "search hit BOTTOM, continuing at TOP" and
7354 "search hit TOP, continuing at BOTTOM" messages are only
7355 indicated by a "W" (Mnemonic: Wrapped) letter before the
7356 search count statistics.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007357
7358 This gives you the opportunity to avoid that a change between buffers
7359 requires you to hit <Enter>, but still gives as useful a message as
7360 possible for the space available. To get the whole message that you
7361 would have got with 'shm' empty, use ":file!"
7362 Useful values:
7363 shm= No abbreviation of message.
7364 shm=a Abbreviation, but no loss of information.
7365 shm=at Abbreviation, and truncate message when necessary.
7366
7367 NOTE: This option is set to the Vi default value when 'compatible' is
7368 set and to the Vim default value when 'compatible' is reset.
7369
7370 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
7371'shortname' 'sn' boolean (default off)
7372 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007373 Filenames are assumed to be 8 characters plus one extension of 3
7374 characters. Multiple dots in file names are not allowed. When this
7375 option is on, dots in file names are replaced with underscores when
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01007376 adding an extension (".~" or ".swp"). This option is useful
Bram Moolenaar071d4272004-06-13 20:20:40 +00007377 when editing files on an MS-DOS compatible filesystem, e.g., messydos
Bram Moolenaarade0d392020-01-21 22:33:58 +01007378 or crossdos.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007379
7380 *'showbreak'* *'sbr'* *E595*
7381'showbreak' 'sbr' string (default "")
Bram Moolenaaree857022019-11-09 23:26:40 +01007382 global or local to window |global-local|
Bram Moolenaardb84e452010-08-15 13:50:43 +02007383 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007384 feature}
7385 String to put at the start of lines that have been wrapped. Useful
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007386 values are "> " or "+++ ": >
7387 :set showbreak=>\
7388< Note the backslash to escape the trailing space. It's easier like
7389 this: >
Bram Moolenaar1a384422010-07-14 19:53:30 +02007390 :let &showbreak = '+++ '
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007391< Only printable single-cell characters are allowed, excluding <Tab> and
Bram Moolenaar071d4272004-06-13 20:20:40 +00007392 comma (in a future version the comma might be used to separate the
7393 part that is shown at the end and at the start of a line).
7394 The characters are highlighted according to the '@' flag in
7395 'highlight'.
7396 Note that tabs after the showbreak will be displayed differently.
7397 If you want the 'showbreak' to appear in between line numbers, add the
7398 "n" flag to 'cpoptions'.
Bram Moolenaaree857022019-11-09 23:26:40 +01007399 A window-local value overrules a global value. If the global value is
7400 set and you want no value in the current window use NONE: >
7401 :setlocal showbreak=NONE
7402<
Bram Moolenaar071d4272004-06-13 20:20:40 +00007403 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02007404'showcmd' 'sc' boolean (Vim default: on, off for Unix,
7405 Vi default: off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007406 global
Bram Moolenaar02467872007-05-06 13:22:01 +00007407 Show (partial) command in the last line of the screen. Set this
7408 option off if your terminal is slow.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007409 In Visual mode the size of the selected area is shown:
7410 - When selecting characters within a line, the number of characters.
Bram Moolenaarf91787c2010-07-17 12:47:16 +02007411 If the number of bytes is different it is also displayed: "2-6"
7412 means two characters and six bytes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007413 - When selecting more than one line, the number of lines.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007414 - When selecting a block, the size in screen characters:
7415 {lines}x{columns}.
Luuk van Baalba936f62022-12-15 13:15:39 +00007416 This information can be displayed in an alternative location using the
7417 'showcmdloc' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007418 NOTE: This option is set to the Vi default value when 'compatible' is
7419 set and to the Vim default value when 'compatible' is reset.
7420
Luuk van Baalba936f62022-12-15 13:15:39 +00007421 *'showcmdloc'* *'sloc'*
7422'showcmdloc' 'sloc' string (default "last")
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007423 global
Luuk van Baalba936f62022-12-15 13:15:39 +00007424 This option can be used to display the (partially) entered command in
7425 another location. Possible values are:
7426 last Last line of the screen (default).
7427 statusline Status line of the current window.
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007428 tabline First line of the screen if 'showtabline' is enabled.
Luuk van Baalba936f62022-12-15 13:15:39 +00007429 Setting this option to "statusline" or "tabline" means that these will
7430 be redrawn whenever the command changes, which can be on every key
7431 pressed.
7432 The %S 'statusline' item can be used in 'statusline' or 'tabline' to
7433 place the text. Without a custom 'statusline' or 'tabline' it will be
7434 displayed in a convenient location.
7435
Bram Moolenaar071d4272004-06-13 20:20:40 +00007436 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
7437'showfulltag' 'sft' boolean (default off)
7438 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007439 When completing a word in insert mode (see |ins-completion|) from the
7440 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007441 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00007442 matched a C function, you can see a template for what arguments are
7443 required (coding style permitting).
Bram Moolenaar446cb832008-06-24 21:56:24 +00007444 Note that this doesn't work well together with having "longest" in
7445 'completeopt', because the completion from the search pattern may not
7446 match the typed text.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007447
7448 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
7449'showmatch' 'sm' boolean (default off)
7450 global
7451 When a bracket is inserted, briefly jump to the matching one. The
7452 jump is only done if the match can be seen on the screen. The time to
7453 show the match can be set with 'matchtime'.
7454 A Beep is given if there is no match (no matter if the match can be
Bram Moolenaarca635012015-09-25 20:34:21 +02007455 seen or not).
7456 This option is reset when 'paste' is set and restored when 'paste' is
7457 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007458 When the 'm' flag is not included in 'cpoptions', typing a character
7459 will immediately move the cursor back to where it belongs.
7460 See the "sm" field in 'guicursor' for setting the cursor shape and
7461 blinking when showing the match.
7462 The 'matchpairs' option can be used to specify the characters to show
7463 matches for. 'rightleft' and 'revins' are used to look for opposite
7464 matches.
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007465 Also see the matchparen plugin for highlighting the match when moving
7466 around |pi_paren.txt|.
7467 Note: Use of the short form is rated PG.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007468
7469 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
7470'showmode' 'smd' boolean (Vim default: on, Vi default: off)
7471 global
7472 If in Insert, Replace or Visual mode put a message on the last line.
7473 Use the 'M' flag in 'highlight' to set the type of highlighting for
7474 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007475 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00007476 doesn't mean XIM is really active, especially when 'imactivatekey' is
7477 not set.
7478 NOTE: This option is set to the Vi default value when 'compatible' is
7479 set and to the Vim default value when 'compatible' is reset.
7480
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007481 *'showtabline'* *'stal'*
7482'showtabline' 'stal' number (default 1)
7483 global
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007484 The value of this option specifies when the line with tab page labels
7485 will be displayed:
7486 0: never
7487 1: only if there are at least two tab pages
7488 2: always
7489 This is both for the GUI and non-GUI implementation of the tab pages
7490 line.
7491 See |tab-page| for more information about tab pages.
7492
Bram Moolenaar071d4272004-06-13 20:20:40 +00007493 *'sidescroll'* *'ss'*
7494'sidescroll' 'ss' number (default 0)
7495 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007496 The minimal number of columns to scroll horizontally. Used only when
7497 the 'wrap' option is off and the cursor is moved off of the screen.
7498 When it is zero the cursor will be put in the middle of the screen.
7499 When using a slow terminal set it to a large number or 0. When using
7500 a fast terminal use a small number or 1. Not used for "zh" and "zl"
7501 commands.
7502
7503 *'sidescrolloff'* *'siso'*
7504'sidescrolloff' 'siso' number (default 0)
Bram Moolenaar375e3392019-01-31 18:26:10 +01007505 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007506 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00007507 right of the cursor if 'nowrap' is set. Setting this option to a
7508 value greater than 0 while having |'sidescroll'| also at a non-zero
7509 value makes some context visible in the line you are scrolling in
7510 horizontally (except at beginning of the line). Setting this option
7511 to a large value (like 999) has the effect of keeping the cursor
7512 horizontally centered in the window, as long as one does not come too
7513 close to the beginning of the line.
Bram Moolenaar375e3392019-01-31 18:26:10 +01007514 After using the local value, go back the global value with one of
7515 these two: >
7516 setlocal sidescrolloff<
7517 setlocal sidescrolloff=-1
7518< NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007519
7520 Example: Try this together with 'sidescroll' and 'listchars' as
7521 in the following example to never allow the cursor to move
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007522 onto the "extends" character: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007523
7524 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
7525 :set sidescrolloff=1
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007526<
7527 *'signcolumn'* *'scl'*
7528'signcolumn' 'scl' string (default "auto")
7529 local to window
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007530 {not available when compiled without the |+signs|
7531 feature}
Bram Moolenaar09521312016-08-12 22:54:35 +02007532 Whether or not to draw the signcolumn. Valid values are:
Bram Moolenaar938ae282023-02-20 20:44:55 +00007533 "auto" only when there is a sign to display
7534 "no" never
7535 "yes" always
Bram Moolenaar394c5d82019-06-17 21:48:05 +02007536 "number" display signs in the 'number' column. If the number
Bram Moolenaar6c1e1572019-06-22 02:13:00 +02007537 column is not present, then behaves like "auto".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007538
Bram Moolenaar071d4272004-06-13 20:20:40 +00007539 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
7540'smartcase' 'scs' boolean (default off)
7541 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007542 Override the 'ignorecase' option if the search pattern contains upper
7543 case characters. Only used when the search pattern is typed and
7544 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarc8734422012-06-01 22:38:45 +02007545 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00007546 "*" and "#" you can make 'smartcase' used by doing a "/" command,
7547 recalling the search pattern from history and hitting <Enter>.
7548 NOTE: This option is reset when 'compatible' is set.
7549
7550 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
7551'smartindent' 'si' boolean (default off)
7552 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007553 Do smart autoindenting when starting a new line. Works for C-like
7554 programs, but can also be used for other languages. 'cindent' does
7555 something like this, works better in most cases, but is more strict,
Bram Moolenaar81af9252010-12-10 20:35:50 +01007556 see |C-indenting|. When 'cindent' is on or 'indentexpr' is set,
Bram Moolenaar166af9b2010-11-16 20:34:40 +01007557 setting 'si' has no effect. 'indentexpr' is a more advanced
7558 alternative.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007559 Normally 'autoindent' should also be on when using 'smartindent'.
7560 An indent is automatically inserted:
7561 - After a line ending in '{'.
7562 - After a line starting with a keyword from 'cinwords'.
7563 - Before a line starting with '}' (only with the "O" command).
7564 When typing '}' as the first character in a new line, that line is
7565 given the same indent as the matching '{'.
7566 When typing '#' as the first character in a new line, the indent for
7567 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007568 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00007569 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
7570 When using the ">>" command, lines starting with '#' are not shifted
7571 right.
Bram Moolenaar036986f2017-03-16 17:41:02 +01007572 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02007573 This option is reset when 'paste' is set and restored when 'paste' is
7574 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007575
7576 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
7577'smarttab' 'sta' boolean (default off)
7578 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007579 When on, a <Tab> in front of a line inserts blanks according to
Bram Moolenaar280f1262006-01-30 00:14:18 +00007580 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A
7581 <BS> will delete a 'shiftwidth' worth of space at the start of the
7582 line.
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00007583 When off, a <Tab> always inserts blanks according to 'tabstop' or
Bram Moolenaar280f1262006-01-30 00:14:18 +00007584 'softtabstop'. 'shiftwidth' is only used for shifting text left or
7585 right |shift-left-right|.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007586 What gets inserted (a <Tab> or spaces) depends on the 'expandtab'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007587 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00007588 number of spaces is minimized by using <Tab>s.
Bram Moolenaarca635012015-09-25 20:34:21 +02007589 This option is reset when 'paste' is set and restored when 'paste' is
7590 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007591 NOTE: This option is reset when 'compatible' is set.
7592
Bram Moolenaarf6196f42022-10-02 21:29:55 +01007593 *'smoothscroll'* *'sms'* *'nosmoothscroll'* *'nosms'*
7594'smoothscroll' 'sms' boolean (default off)
7595 local to window
7596 Scrolling works with screen lines. When 'wrap' is set and the first
7597 line in the window wraps part of it may not be visible, as if it is
Bram Moolenaarf269eab2022-10-03 18:04:35 +01007598 above the window. "<<<" is displayed at the start of the first line,
7599 highlighted with |hl-NonText|.
Bram Moolenaar10e8ff92023-06-10 21:40:39 +01007600 You may also want to add "lastline" to the 'display' option to show as
7601 much of the last line as possible.
zeertzjqad493ef2024-03-29 10:23:19 +01007602 NOTE: partly implemented, doesn't work yet for |gj| and |gk|.
Bram Moolenaarf6196f42022-10-02 21:29:55 +01007603
Bram Moolenaar071d4272004-06-13 20:20:40 +00007604 *'softtabstop'* *'sts'*
7605'softtabstop' 'sts' number (default 0)
7606 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007607 Number of spaces that a <Tab> counts for while performing editing
7608 operations, like inserting a <Tab> or using <BS>. It "feels" like
7609 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
7610 used. This is useful to keep the 'ts' setting at its standard value
7611 of 8, while being able to edit like it is set to 'sts'. However,
7612 commands like "x" still work on the actual characters.
7613 When 'sts' is zero, this feature is off.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02007614 When 'sts' is negative, the value of 'shiftwidth' is used.
Bram Moolenaarca635012015-09-25 20:34:21 +02007615 'softtabstop' is set to 0 when the 'paste' option is set and restored
7616 when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007617 See also |ins-expandtab|. When 'expandtab' is not set, the number of
7618 spaces is minimized by using <Tab>s.
7619 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
7620 set.
7621 NOTE: This option is set to 0 when 'compatible' is set.
7622
Bram Moolenaar04958cb2018-06-23 19:23:02 +02007623 If Vim is compiled with the |+vartabs| feature then the value of
7624 'softtabstop' will be ignored if |'varsofttabstop'| is set to
7625 anything other than an empty string.
7626
Bram Moolenaar217ad922005-03-20 22:37:15 +00007627 *'spell'* *'nospell'*
7628'spell' boolean (default off)
7629 local to window
Bram Moolenaar217ad922005-03-20 22:37:15 +00007630 {not available when compiled without the |+syntax|
7631 feature}
7632 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007633 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007634
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007635 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00007636'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007637 local to buffer
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007638 {not available when compiled without the |+syntax|
7639 feature}
7640 Pattern to locate the end of a sentence. The following word will be
7641 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007642 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007643 When this check is not wanted make this option empty.
7644 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00007645 Be careful with special characters, see |option-backslash| about
7646 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007647 To set this option automatically depending on the language, see
7648 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007649
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007650 *'spellfile'* *'spf'*
7651'spellfile' 'spf' string (default empty)
7652 local to buffer
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007653 {not available when compiled without the |+syntax|
7654 feature}
7655 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00007656 commands. It must end in ".{encoding}.add". You need to include the
7657 path, otherwise the file is placed in the current directory.
Bram Moolenaar48c3f4e2022-08-08 15:42:38 +01007658 The path may include characters from 'isfname', space, comma and '@'.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007659 *E765*
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007660 It may also be a comma-separated list of names. A count before the
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007661 |zg| and |zw| commands can be used to access each. This allows using
7662 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007663 When a word is added while this option is empty Vim will set it for
Bram Moolenaar910f66f2006-04-05 20:41:53 +00007664 you: Using the first directory in 'runtimepath' that is writable. If
7665 there is no "spell" directory yet it will be created. For the file
7666 name the first language name that appears in 'spelllang' is used,
Bram Moolenaar3b506942005-06-23 22:36:45 +00007667 ignoring the region.
7668 The resulting ".spl" file will be used for spell checking, it does not
7669 have to appear in 'spelllang'.
7670 Normally one file is used for all regions, but you can add the region
7671 name if you want to. However, it will then only be used when
7672 'spellfile' is set to it, for entries in 'spelllang' only files
7673 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00007674 This option cannot be set from a |modeline| or in the |sandbox|, for
7675 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007676
Bram Moolenaar217ad922005-03-20 22:37:15 +00007677 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007678'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00007679 local to buffer
Bram Moolenaar217ad922005-03-20 22:37:15 +00007680 {not available when compiled without the |+syntax|
7681 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007682 A comma-separated list of word list names. When the 'spell' option is
Bram Moolenaar3b506942005-06-23 22:36:45 +00007683 on spellchecking will be done for these languages. Example: >
7684 set spelllang=en_us,nl,medical
7685< This means US English, Dutch and medical words are recognized. Words
7686 that are not recognized will be highlighted.
Bram Moolenaar911ead12019-04-21 00:03:35 +02007687 The word list name must consist of alphanumeric characters, a dash or
7688 an underscore. It should not include a comma or dot. Using a dash is
Bram Moolenaar3b506942005-06-23 22:36:45 +00007689 recommended to separate the two letter language name from a
7690 specification. Thus "en-rare" is used for rare English words.
7691 A region name must come last and have the form "_xx", where "xx" is
7692 the two-letter, lower case region name. You can use more than one
7693 region by listing them: "en_us,en_ca" supports both US and Canadian
7694 English, but not words specific for Australia, New Zealand or Great
Bram Moolenaarfa735342016-01-03 22:14:44 +01007695 Britain. (Note: currently en_au and en_nz dictionaries are older than
7696 en_ca, en_gb and en_us).
Bram Moolenaarcc63c642013-11-12 04:44:01 +01007697 If the name "cjk" is included East Asian characters are excluded from
7698 spell checking. This is useful when editing text that also has Asian
7699 words.
Bram Moolenaar6c391a72021-09-09 21:55:11 +02007700 Note that the "medical" dictionary does not exist, it is just an
7701 example of a longer name.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007702 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007703 As a special case the name of a .spl file can be given as-is. The
7704 first "_xx" in the name is removed and used as the region name
7705 (_xx is an underscore, two letters and followed by a non-letter).
7706 This is mainly for testing purposes. You must make sure the correct
7707 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007708 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007709 idea to set 'spelllang' after setting 'encoding' to avoid loading the
7710 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00007711 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007712
Bram Moolenaar98692072006-02-04 00:57:42 +00007713 If the |spellfile.vim| plugin is active and you use a language name
7714 for which Vim cannot find the .spl file in 'runtimepath' the plugin
7715 will ask you if you want to download the file.
7716
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007717 After this option has been set successfully, Vim will source the files
7718 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
Bram Moolenaarb730f0c2018-11-25 03:56:26 +01007719 up to the first character that is not an ASCII letter or number and
7720 not a dash. Also see |set-spc-auto|.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007721
Bram Moolenaar362b44b2020-06-10 21:47:00 +02007722 *'spelloptions'* *'spo'*
7723'spelloptions' 'spo' string (default "")
7724 local to buffer
7725 {not available when compiled without the |+syntax|
7726 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007727 A comma-separated list of options for spell checking:
Bram Moolenaar362b44b2020-06-10 21:47:00 +02007728 camel When a word is CamelCased, assume "Cased" is a
7729 separate word: every upper-case character in a word
7730 that comes after a lower case character indicates the
7731 start of a new word.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007732
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007733 *'spellsuggest'* *'sps'*
7734'spellsuggest' 'sps' string (default "best")
7735 global
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007736 {not available when compiled without the |+syntax|
7737 feature}
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007738 Methods used for spelling suggestions. Both for the |z=| command and
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007739 the |spellsuggest()| function. This is a comma-separated list of
7740 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007741
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007742 best Internal method that works best for English. Finds
7743 changes like "fast" and uses a bit of sound-a-like
7744 scoring to improve the ordering.
7745
7746 double Internal method that uses two methods and mixes the
7747 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007748 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007749 word. That only works when the language specifies
7750 sound folding. Can be slow and doesn't always give
7751 better results.
7752
7753 fast Internal method that only checks for simple changes:
7754 character inserts/deletes/swaps. Works well for
7755 simple typing mistakes.
7756
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007757 {number} The maximum number of suggestions listed for |z=|.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007758 Not used for |spellsuggest()|. The number of
7759 suggestions is never more than the value of 'lines'
7760 minus two.
7761
Bram Moolenaar585ee072022-01-29 11:22:17 +00007762 timeout:{millisec} Limit the time searching for suggestions to
Dominique Pellédf62c622024-07-15 20:29:59 +02007763 {millisec} milliseconds. Applies to the following
Bram Moolenaar585ee072022-01-29 11:22:17 +00007764 methods. When omitted the limit is 5000. When
7765 negative there is no limit. {only works when built
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01007766 with the |+reltime| feature}
Bram Moolenaar585ee072022-01-29 11:22:17 +00007767
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007768 file:{filename} Read file {filename}, which must have two columns,
7769 separated by a slash. The first column contains the
7770 bad word, the second column the suggested good word.
7771 Example:
7772 theribal/terrible ~
7773 Use this for common mistakes that do not appear at the
7774 top of the suggestion list with the internal methods.
7775 Lines without a slash are ignored, use this for
7776 comments.
Bram Moolenaarbcb98982014-05-01 14:08:19 +02007777 The word in the second column must be correct,
7778 otherwise it will not be used. Add the word to an
7779 ".add" file if it is currently flagged as a spelling
7780 mistake.
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007781 The file is used for all languages.
7782
7783 expr:{expr} Evaluate expression {expr}. Use a function to avoid
Bram Moolenaara4e0b972022-10-01 19:43:52 +01007784 trouble with spaces. Best is to call a function
7785 without arguments, see |expr-option-function|.
7786 |v:val| holds the badly spelled word. The expression
7787 must evaluate to a List of Lists, each with a
7788 suggestion and a score.
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007789 Example:
Bram Moolenaar214641f2017-03-05 17:04:09 +01007790 [['the', 33], ['that', 44]] ~
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007791 Set 'verbose' and use |z=| to see the scores that the
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007792 internal methods use. A lower score is better.
7793 This may invoke |spellsuggest()| if you temporarily
7794 set 'spellsuggest' to exclude the "expr:" part.
7795 Errors are silently ignored, unless you set the
7796 'verbose' option to a non-zero value.
7797
7798 Only one of "best", "double" or "fast" may be used. The others may
7799 appear several times in any order. Example: >
7800 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
7801<
7802 This option cannot be set from a |modeline| or in the |sandbox|, for
7803 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007804
Bram Moolenaar071d4272004-06-13 20:20:40 +00007805 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
7806'splitbelow' 'sb' boolean (default off)
7807 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007808 When on, splitting a window will put the new window below the current
7809 one. |:split|
7810
Bram Moolenaar3c053a12022-10-16 13:11:12 +01007811 *'splitkeep'* *'spk'*
Luuk van Baal13ece2a2022-10-03 15:28:08 +01007812'splitkeep' 'spk' string (default "cursor")
7813 global
7814 The value of this option determines the scroll behavior when opening,
7815 closing or resizing horizontal splits.
7816
7817 Possible values are:
7818 cursor Keep the same relative cursor position.
7819 screen Keep the text on the same screen line.
7820 topline Keep the topline the same.
7821
7822 For the "screen" and "topline" values, the cursor position will be
7823 changed when necessary. In this case, the jumplist will be populated
7824 with the previous cursor position. For "screen", the text cannot always
Bram Moolenaar3c053a12022-10-16 13:11:12 +01007825 be kept on the same screen line when 'wrap' is enabled.
Luuk van Baal13ece2a2022-10-03 15:28:08 +01007826
Bram Moolenaar071d4272004-06-13 20:20:40 +00007827 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
7828'splitright' 'spr' boolean (default off)
7829 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007830 When on, splitting a window will put the new window right of the
7831 current one. |:vsplit|
7832
7833 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
7834'startofline' 'sol' boolean (default on)
7835 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007836 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00007837 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaar71badf92023-04-22 22:40:14 +01007838 (if possible). This applies to the commands:
7839 - CTRL-D, CTRL-U, CTRL-B, CTRL-F, "G", "H", "M", "L", "gg"
Christian Brabandtfd4e47e2024-10-06 17:57:53 +02007840 - "d", "<<", "==" and ">>" with a linewise operator
7841 (|operator-resulting-pos|)
Bram Moolenaar71badf92023-04-22 22:40:14 +01007842 - "%" with a count
7843 - buffer changing commands (CTRL-^, :bnext, :bNext, etc.)
7844 - Ex commands that only has a line number, e.g., ":25" or ":+".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007845 In case of buffer changing commands the cursor is placed at the column
7846 where it was the last time the buffer was edited.
7847 NOTE: This option is set when 'compatible' is set.
7848
Bram Moolenaar00654022011-02-25 14:42:19 +01007849 *'statusline'* *'stl'* *E540* *E542*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007850'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007851 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007852 {not available when compiled without the |+statusline|
7853 feature}
Bram Moolenaar944697a2022-02-20 19:48:20 +00007854 When non-empty, this option determines the content of the status line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007855 Also see |status-line|.
7856
7857 The option consists of printf style '%' items interspersed with
7858 normal text. Each status line item is of the form:
7859 %-0{minwid}.{maxwid}{item}
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01007860 All fields except the {item} are optional. A single percent sign can
Bram Moolenaar8133cc62020-10-26 21:05:27 +01007861 be given as "%%".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007862
Bram Moolenaar238a5642006-02-21 22:12:05 +00007863 When the option starts with "%!" then it is used as an expression,
7864 evaluated and the result is used as the option value. Example: >
7865 :set statusline=%!MyStatusLine()
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02007866< The *g:statusline_winid* variable will be set to the |window-ID| of the
7867 window that the status line belongs to.
7868 The result can contain %{} items that will be evaluated too.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02007869 Note that the "%!" expression is evaluated in the context of the
7870 current window and buffer, while %{} items are evaluated in the
7871 context of the window that the statusline belongs to.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007872
7873 When there is error while evaluating the option then it will be made
7874 empty to avoid further errors. Otherwise screen updating would loop.
Bram Moolenaar1b5f03e2023-01-09 20:12:45 +00007875 When the result contains unprintable characters the result is
7876 unpredictable.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007877
Bram Moolenaar071d4272004-06-13 20:20:40 +00007878 Note that the only effect of 'ruler' when this option is set (and
7879 'laststatus' is 2) is controlling the output of |CTRL-G|.
7880
7881 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00007882 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00007883 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007884 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007885 minwid Minimum width of the item, padding as set by '-' & '0'.
7886 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007887 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007888 on the left for text items. Numeric items will be
7889 shifted down to maxwid-2 digits followed by '>'number
7890 where number is the amount of missing digits, much like
7891 an exponential notation.
7892 item A one letter code as described below.
7893
7894 Following is a description of the possible statusline items. The
7895 second character in "item" is the type:
7896 N for number
7897 S for string
7898 F for flags as described below
7899 - not applicable
7900
7901 item meaning ~
Bram Moolenaar02467872007-05-06 13:22:01 +00007902 f S Path to the file in the buffer, as typed or relative to current
7903 directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007904 F S Full path to the file in the buffer.
7905 t S File name (tail) of file in the buffer.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007906 m F Modified flag, text is "[+]"; "[-]" if 'modifiable' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007907 M F Modified flag, text is ",+" or ",-".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007908 r F Readonly flag, text is "[RO]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007909 R F Readonly flag, text is ",RO".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007910 h F Help buffer flag, text is "[help]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007911 H F Help buffer flag, text is ",HLP".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007912 w F Preview window flag, text is "[Preview]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007913 W F Preview window flag, text is ",PRV".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007914 y F Type of file in the buffer, e.g., "[vim]". See 'filetype'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007915 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
Bram Moolenaar7fd73202010-07-25 16:58:46 +02007916 q S "[Quickfix List]", "[Location List]" or empty.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007917 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
7918 being used: "<keymap>"
7919 n N Buffer number.
Bram Moolenaar00654022011-02-25 14:42:19 +01007920 b N Value of character under cursor.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007921 B N As above, in hexadecimal.
7922 o N Byte number in file of byte under cursor, first byte is 1.
7923 Mnemonic: Offset from start of file (with one added)
7924 {not available when compiled without |+byte_offset| feature}
7925 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007926 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007927 l N Line number.
7928 L N Number of lines in buffer.
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02007929 c N Column number (byte index).
7930 v N Virtual column number (screen column).
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007931 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007932 p N Percentage through file in lines as in |CTRL-G|.
7933 P S Percentage through file of displayed window. This is like the
Bram Moolenaar14b69452013-06-29 23:05:20 +02007934 percentage described for 'ruler'. Always 3 in length, unless
7935 translated.
Luuk van Baalba936f62022-12-15 13:15:39 +00007936 S S 'showcmd' content, see 'showcmdloc'.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007937 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00007938 Empty if the argument file count is zero or one.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007939 { NF Evaluate expression between '%{' and '}' and substitute result.
Bram Moolenaar6d150f72018-04-21 20:03:20 +02007940 Note that there is no '%' before the closing '}'. The
7941 expression cannot contain a '}' character, call a function to
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007942 work around that. See |stl-%{| below.
shadmansaleh30e3de22021-05-15 17:23:28 +02007943 {% - This is almost same as { except the result of the expression is
7944 re-evaluated as a statusline format string. Thus if the
7945 return value of expr contains % items they will get expanded.
7946 The expression can contain the } character, the end of
7947 expression is denoted by %}.
Bram Moolenaar22863042021-10-16 15:23:36 +01007948 For example: >
shadmansaleh30e3de22021-05-15 17:23:28 +02007949 func! Stl_filename() abort
7950 return "%t"
7951 endfunc
7952< `stl=%{Stl_filename()}` results in `"%t"`
7953 `stl=%{%Stl_filename()%}` results in `"Name of current file"`
Bram Moolenaar22863042021-10-16 15:23:36 +01007954 %} - End of `{%` expression
Bram Moolenaar071d4272004-06-13 20:20:40 +00007955 ( - Start of item group. Can be used for setting the width and
7956 alignment of a section. Must be followed by %) somewhere.
7957 ) - End of item group. No width fields allowed.
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007958 T N For 'tabline': start of tab page N label. Use %T after the last
7959 label. This information is used for mouse clicks.
7960 X N For 'tabline': start of close tab N label. Use %X after the
7961 label, e.g.: %3Xclose%X. Use %999X for a "close current tab"
7962 mark. This information is used for mouse clicks.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007963 < - Where to truncate line if too long. Default is at the start.
7964 No width fields allowed.
Yegappan Lakshmanan3ec78f92023-02-11 11:15:25 +00007965 = - Separation point between alignment sections. Each section will
7966 be separated by an equal number of spaces. With one %= what
7967 comes after it will be right-aligned. With two %= there is a
7968 middle part, with white space left and right of it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007969 No width fields allowed.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007970 # - Set highlight group. The name must follow and then a # again.
7971 Thus use %#HLname# for highlight group HLname. The same
7972 highlighting is used, also for the statusline of non-current
7973 windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007974 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00007975 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaarbe4e0162023-02-02 13:59:48 +00007976 The difference between User{N} and StatusLine will be applied to
7977 StatusLineNC for the statusline of non-current windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007978 The number N must be between 1 and 9. See |hl-User1..9|
7979
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007980 When displaying a flag, Vim removes the leading comma, if any, when
7981 that flag comes right after plaintext. This will make a nice display
7982 when flags are used like in the examples below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007983
Bram Moolenaar582fd852005-03-28 20:58:01 +00007984 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00007985 not set) and a minwid is not set for the group, the whole group will
7986 become empty. This will make a group like the following disappear
7987 completely from the statusline when none of the flags are set. >
7988 :set statusline=...%(\ [%M%R%H]%)...
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02007989< Beware that an expression is evaluated each and every time the status
7990 line is displayed.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007991 *stl-%{* *g:actual_curbuf* *g:actual_curwin*
Bram Moolenaarade0d392020-01-21 22:33:58 +01007992 While evaluating %{} the current buffer and current window will be set
7993 temporarily to that of the window (and buffer) whose statusline is
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007994 currently being drawn. The expression will evaluate in this context.
7995 The variable "g:actual_curbuf" is set to the `bufnr()` number of the
7996 real current buffer and "g:actual_curwin" to the |window-ID| of the
7997 real current window. These values are strings.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007998
Bram Moolenaar30b65812012-07-12 22:01:11 +02007999 The 'statusline' option will be evaluated in the |sandbox| if set from
8000 a modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008001 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00008002
8003 It is not allowed to change text or jump to another window while
8004 evaluating 'statusline' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008005
8006 If the statusline is not updated when you want it (e.g., after setting
8007 a variable that's used in an expression), you can force an update by
Bram Moolenaarcfa8f9a2022-06-03 21:59:47 +01008008 using `:redrawstatus`.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008009
Bram Moolenaarcfa8f9a2022-06-03 21:59:47 +01008010 A result of all digits is regarded a number for display purposes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008011 Otherwise the result is taken as flag text and applied to the rules
8012 described above.
8013
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00008014 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00008015 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008016 edit your .vimrc or whatever with "vim --clean" to get it right.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008017
8018 Examples:
8019 Emulate standard status line with 'ruler' set >
saher7b5e52d2024-10-14 19:52:50 +02008020 :set statusline=%<%f\ %h%w%m%r%=%-14.(%l,%c%V%)\ %P
Bram Moolenaar071d4272004-06-13 20:20:40 +00008021< Similar, but add ASCII value of char under the cursor (like "ga") >
8022 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
8023< Display byte count and byte value, modified flag in red. >
8024 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
8025 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
8026< Display a ,GZ flag if a compressed file is loaded >
8027 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
8028< In the |:autocmd|'s: >
8029 :let b:gzflag = 1
8030< And: >
8031 :unlet b:gzflag
8032< And define this function: >
8033 :function VarExists(var, val)
8034 : if exists(a:var) | return a:val | else | return '' | endif
8035 :endfunction
8036<
8037 *'suffixes'* *'su'*
8038'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
8039 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008040 Files with these suffixes get a lower priority when multiple files
8041 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008042 suffixes. Spaces after the comma are ignored. A dot is also seen as
8043 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00008044 separator, precede it with a backslash (see |option-backslash| about
8045 including spaces and backslashes).
8046 See 'wildignore' for completely ignoring files.
8047 The use of |:set+=| and |:set-=| is preferred when adding or removing
8048 suffixes from the list. This avoids problems when a future version
8049 uses another default.
8050
8051 *'suffixesadd'* *'sua'*
8052'suffixesadd' 'sua' string (default "")
8053 local to buffer
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01008054 Comma-separated list of suffixes, which are used when searching for a
Bram Moolenaar071d4272004-06-13 20:20:40 +00008055 file for the "gf", "[I", etc. commands. Example: >
8056 :set suffixesadd=.java
8057<
8058 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
8059'swapfile' 'swf' boolean (default on)
8060 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008061 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00008062 swapfile is not wanted for a specific buffer. For example, with
8063 confidential information that even root must not be able to access.
8064 Careful: All text will be in memory:
8065 - Don't use this for big files.
8066 - Recovery will be impossible!
8067 A swapfile will only be present when |'updatecount'| is non-zero and
8068 'swapfile' is set.
8069 When 'swapfile' is reset, the swap file for the current buffer is
8070 immediately deleted. When 'swapfile' is set, and 'updatecount' is
8071 non-zero, a swap file is immediately created.
8072 Also see |swap-file| and |'swapsync'|.
Bram Moolenaar76f3b1a2014-03-27 22:30:07 +01008073 If you want to open a new buffer without creating a swap file for it,
8074 use the |:noswapfile| modifier.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01008075 See 'directory' for where the swap file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008076
8077 This option is used together with 'bufhidden' and 'buftype' to
8078 specify special kinds of buffers. See |special-buffers|.
8079
8080 *'swapsync'* *'sws'*
8081'swapsync' 'sws' string (default "fsync")
8082 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008083 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008084 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008085 When this option is empty parts of the swap file may be in memory and
8086 not written to disk. When the system crashes you may lose more work.
8087 On Unix the system does a sync now and then without Vim asking for it,
8088 so the disadvantage of setting this option off is small. On some
8089 systems the swap file will not be written at all. For a unix system
8090 setting it to "sync" will use the sync() call instead of the default
8091 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00008092 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008093
8094 *'switchbuf'* *'swb'*
8095'switchbuf' 'swb' string (default "")
8096 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008097 This option controls the behavior when switching between buffers.
Yegappan Lakshmanan54be5fb2023-05-12 17:49:13 +01008098 This option is checked, when
8099 - jumping to errors with the |quickfix| commands (|:cc|, |:cn|, |:cp|,
h_east59858792023-10-25 22:47:05 +09008100 etc.).
Yegappan Lakshmanan54be5fb2023-05-12 17:49:13 +01008101 - jumping to a tag using the |:stag| command.
8102 - opening a file using the |CTRL-W_f| or |CTRL-W_F| command.
8103 - jumping to a buffer using a buffer split command (e.g. |:sbuffer|,
8104 |:sbnext|, or |:sbrewind|).
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01008105 Possible values (comma-separated list):
Yegappan Lakshmanan54be5fb2023-05-12 17:49:13 +01008106 useopen If included, jump to the first open window in the
8107 current tab page that contains the specified buffer
8108 (if there is one). Otherwise: Do not examine other
8109 windows.
Bram Moolenaar779b74b2006-04-10 14:55:34 +00008110 usetab Like "useopen", but also consider windows in other tab
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00008111 pages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008112 split If included, split the current window before loading
Bram Moolenaar15146672011-10-20 22:22:38 +02008113 a buffer for a |quickfix| command that display errors.
Bram Moolenaar63b74a82019-03-24 15:09:13 +01008114 Otherwise: do not split, use current window (when used
8115 in the quickfix window: the previously used window or
8116 split if there is no other window).
Bram Moolenaara594d772015-06-19 14:41:49 +02008117 vsplit Just like "split" but split vertically.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008118 newtab Like "split", but open a new tab page. Overrules
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02008119 "split" when both are present.
Bram Moolenaar539aa6b2019-11-17 18:09:38 +01008120 uselast If included, jump to the previously used window when
8121 jumping to errors with |quickfix| commands.
Colin Kennedy21570352024-03-03 16:16:47 +01008122 If a window has 'winfixbuf' enabled, 'switchbuf' is currently not
8123 applied to the split window.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008124
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00008125 *'synmaxcol'* *'smc'*
8126'synmaxcol' 'smc' number (default 3000)
8127 local to buffer
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00008128 {not available when compiled without the |+syntax|
8129 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00008130 Maximum column in which to search for syntax items. In long lines the
8131 text after this column is not highlighted and following lines may not
8132 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00008133 This helps to avoid very slow redrawing for an XML file that is one
8134 long line.
8135 Set to zero to remove the limit.
8136
Bram Moolenaar071d4272004-06-13 20:20:40 +00008137 *'syntax'* *'syn'*
8138'syntax' 'syn' string (default empty)
Christian Brabandt596ad662023-08-16 00:11:09 +02008139 local to buffer |local-noglobal|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008140 {not available when compiled without the |+syntax|
8141 feature}
8142 When this option is set, the syntax with this name is loaded, unless
8143 syntax highlighting has been switched off with ":syntax off".
8144 Otherwise this option does not always reflect the current syntax (the
8145 b:current_syntax variable does).
8146 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008147 not automatically recognized. Example, in an IDL file:
8148 /* vim: set syntax=idl : */ ~
8149 When a dot appears in the value then this separates two filetype
8150 names. Example:
8151 /* vim: set syntax=c.doxygen : */ ~
8152 This will use the "c" syntax first, then the "doxygen" syntax.
8153 Note that the second one must be prepared to be loaded as an addition,
8154 otherwise it will be skipped. More than one dot may appear.
8155 To switch off syntax highlighting for the current file, use: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008156 :set syntax=OFF
8157< To switch syntax highlighting on according to the current value of the
8158 'filetype' option: >
8159 :set syntax=ON
8160< What actually happens when setting the 'syntax' option is that the
8161 Syntax autocommand event is triggered with the value as argument.
8162 This option is not copied to another buffer, independent of the 's' or
8163 'S' flag in 'cpoptions'.
Millyae62fe52024-10-02 19:30:41 +02008164 Only alphanumeric characters, '.', '-' and '_' can be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008165
LemonBoy5247b0b2024-07-12 19:30:58 +02008166 *'tabclose'* *'tcl'*
8167'tabclose' 'tcl' string (default "")
8168 global
8169 This option controls the behavior when closing tab pages (e.g., using
8170 |:tabclose|). When empty Vim goes to the next (right) tab page.
8171
8172 Possible values (comma-separated list):
8173 left If included, go to the previous tab page instead of
8174 the next one.
8175 uselast If included, go to the previously used tab page if
8176 possible. This option takes precedence over the
8177 others.
8178
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00008179 *'tabline'* *'tal'*
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008180'tabline' 'tal' string (default empty)
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00008181 global
Bram Moolenaar944697a2022-02-20 19:48:20 +00008182 When non-empty, this option determines the content of the tab pages
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008183 line at the top of the Vim window. When empty Vim will use a default
Bram Moolenaard1f56e62006-02-22 21:25:37 +00008184 tab pages line. See |setting-tabline| for more info.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008185
8186 The tab pages line only appears as specified with the 'showtabline'
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00008187 option and only when there is no GUI tab line. When 'e' is in
8188 'guioptions' and the GUI supports a tab line 'guitablabel' is used
Bram Moolenaar7f036442010-08-15 15:24:20 +02008189 instead. Note that the two tab pages lines are very different.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008190
8191 The value is evaluated like with 'statusline'. You can use
8192 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out
Bram Moolenaard1f56e62006-02-22 21:25:37 +00008193 the text to be displayed. Use "%1T" for the first label, "%2T" for
8194 the second one, etc. Use "%X" items for closing labels.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008195
Bram Moolenaare12bab32019-01-08 22:02:56 +01008196 When changing something that is used in 'tabline' that does not
8197 trigger it to be updated, use |:redrawtabline|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008198 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaare12bab32019-01-08 22:02:56 +01008199
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008200 Keep in mind that only one of the tab pages is the current one, others
8201 are invisible and you can't jump to their windows.
8202
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00008203 *'tabpagemax'* *'tpm'*
8204'tabpagemax' 'tpm' number (default 10)
8205 global
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00008206 Maximum number of tab pages to be opened by the |-p| command line
8207 argument or the ":tab all" command. |tabpage|
8208
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00008209 *'tabstop'* *'ts'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008210'tabstop' 'ts' number (default 8)
8211 local to buffer
8212 Number of spaces that a <Tab> in the file counts for. Also see
Bram Moolenaarf10911e2022-01-29 22:20:48 +00008213 the |:retab| command, and the 'softtabstop' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008214
8215 Note: Setting 'tabstop' to any other value than 8 can make your file
Bram Moolenaarf10911e2022-01-29 22:20:48 +00008216 appear wrong in many places, e.g., when printing it.
8217 The value must be more than 0 and less than 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008218
Song-Tianxiangab01adf2024-03-25 16:31:02 +01008219 There are five main ways to use tabs in Vim:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008220 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
8221 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
Bram Moolenaarebcbd022007-05-12 14:28:25 +00008222 will use a mix of tabs and spaces, but typing <Tab> and <BS> will
Bram Moolenaar071d4272004-06-13 20:20:40 +00008223 behave like a tab appears every 4 (or 3) characters.
Bram Moolenaar10e8ff92023-06-10 21:40:39 +01008224 This is the recommended way, the file will look the same with other
8225 tools and when listing it in a terminal.
8226 2. Set 'softtabstop' and 'shiftwidth' to whatever you prefer and use
8227 'expandtab'. This way you will always insert spaces. The
8228 formatting will never be messed up when 'tabstop' is changed (leave
8229 it at 8 just in case). The file will be a bit larger.
8230 You do need to check if no Tabs exist in the file. You can get rid
8231 of them by first setting 'expandtab' and using `%retab!`, making
8232 sure the value of 'tabstop' is set correctly.
8233 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
Bram Moolenaar071d4272004-06-13 20:20:40 +00008234 'expandtab'. This way you will always insert spaces. The
8235 formatting will never be messed up when 'tabstop' is changed.
Bram Moolenaar10e8ff92023-06-10 21:40:39 +01008236 You do need to check if no Tabs exist in the file, just like in the
8237 item just above.
8238 4. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008239 |modeline| to set these values when editing the file again. Only
Bram Moolenaar10e8ff92023-06-10 21:40:39 +01008240 works when using Vim to edit the file, other tools assume a tabstop
8241 is worth 8 spaces.
8242 5. Always set 'tabstop' and 'shiftwidth' to the same value, and
Bram Moolenaar071d4272004-06-13 20:20:40 +00008243 'noexpandtab'. This should then work (for initial indents only)
8244 for any tabstop setting that people use. It might be nice to have
8245 tabs after the first non-blank inserted as spaces if you do this
8246 though. Otherwise aligned comments will be wrong when 'tabstop' is
8247 changed.
8248
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008249 If Vim is compiled with the |+vartabs| feature then the value of
8250 'tabstop' will be ignored if |'vartabstop'| is set to anything other
8251 than an empty string.
8252
Bram Moolenaar071d4272004-06-13 20:20:40 +00008253 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
8254'tagbsearch' 'tbs' boolean (default on)
8255 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008256 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008257 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00008258 searching makes searching for a tag a LOT faster, but a linear search
8259 will find more tags if the tags file wasn't properly sorted.
8260 Vim normally assumes that your tags files are sorted, or indicate that
8261 they are not sorted. Only when this is not the case does the
8262 'tagbsearch' option need to be switched off.
8263
8264 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008265 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00008266 certain files, or retry all files with a linear search. When
8267 'tagbsearch' is off, only a linear search is done.
8268
8269 Linear searching is done anyway, for one file, when Vim finds a line
8270 at the start of the file indicating that it's not sorted: >
Bram Moolenaar446cb832008-06-24 21:56:24 +00008271 !_TAG_FILE_SORTED 0 /some comment/
Bram Moolenaar071d4272004-06-13 20:20:40 +00008272< [The whitespace before and after the '0' must be a single <Tab>]
8273
8274 When a binary search was done and no match was found in any of the
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008275 files listed in 'tags', and case is ignored or a pattern is used
Bram Moolenaar071d4272004-06-13 20:20:40 +00008276 instead of a normal tag name, a retry is done with a linear search.
8277 Tags in unsorted tags files, and matches with different case will only
8278 be found in the retry.
8279
Bram Moolenaard4755bb2004-09-02 19:12:26 +00008280 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008281 linear search can be avoided when case is ignored. Use a value of '2'
8282 in the "!_TAG_FILE_SORTED" line for this. A tag file can be case-fold
8283 sorted with the -f switch to "sort" in most unices, as in the command:
Bram Moolenaar47c532e2022-03-19 15:18:53 +00008284 "sort -f -o tags tags". For Universal ctags and Exuberant ctags
8285 version 5.x or higher (at least 5.5) the --sort=foldcase switch can be
8286 used for this as well. Note that case must be folded to uppercase for
8287 this to work.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008288
8289 By default, tag searches are case-sensitive. Case is ignored when
8290 'ignorecase' is set and 'tagcase' is "followic", or when 'tagcase' is
8291 "ignore".
Bram Moolenaar66e29d72016-08-20 16:57:02 +02008292 Also when 'tagcase' is "followscs" and 'smartcase' is set, or
8293 'tagcase' is "smart", and the pattern contains only lowercase
8294 characters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008295
8296 When 'tagbsearch' is off, tags searching is slower when a full match
8297 exists, but faster when no full match exists. Tags in unsorted tags
8298 files may only be found with 'tagbsearch' off.
8299 When the tags file is not sorted, or sorted in a wrong way (not on
8300 ASCII byte value), 'tagbsearch' should be off, or the line given above
8301 must be included in the tags file.
8302 This option doesn't affect commands that find all matching tags (e.g.,
8303 command-line completion and ":help").
Bram Moolenaar071d4272004-06-13 20:20:40 +00008304
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008305 *'tagcase'* *'tc'*
8306'tagcase' 'tc' string (default "followic")
8307 global or local to buffer |global-local|
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008308 This option specifies how case is handled when searching the tags
8309 file:
8310 followic Follow the 'ignorecase' option
Bram Moolenaar66e29d72016-08-20 16:57:02 +02008311 followscs Follow the 'smartcase' and 'ignorecase' options
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008312 ignore Ignore case
8313 match Match case
Bram Moolenaar66e29d72016-08-20 16:57:02 +02008314 smart Ignore case unless an upper case letter is used
Bram Moolenaar036986f2017-03-16 17:41:02 +01008315 NOTE: This option is set to the Vi default value when 'compatible' is
8316 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008317
Bram Moolenaar45e18cb2019-04-28 18:05:35 +02008318 *'tagfunc'* *'tfu'*
8319'tagfunc' 'tfu' string (default: empty)
8320 local to buffer
8321 {not available when compiled without the |+eval|
8322 feature}
8323 This option specifies a function to be used to perform tag searches.
8324 The function gets the tag pattern and should return a List of matching
8325 tags. See |tag-function| for an explanation of how to write the
Yegappan Lakshmanan19916a82021-11-24 16:32:55 +00008326 function and an example. The value can be the name of a function, a
8327 |lambda| or a |Funcref|. See |option-value-function| for more
8328 information.
dkearns8ebdbc92023-10-29 06:26:19 +11008329 This option cannot be set from a |modeline| or in the |sandbox|, for
8330 security reasons.
Bram Moolenaar45e18cb2019-04-28 18:05:35 +02008331
Bram Moolenaar071d4272004-06-13 20:20:40 +00008332 *'taglength'* *'tl'*
8333'taglength' 'tl' number (default 0)
8334 global
8335 If non-zero, tags are significant up to this number of characters.
8336
8337 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
8338'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
8339 global
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00008340 If on and using a tags file in another directory, file names in that
8341 tags file are relative to the directory where the tags file is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008342 NOTE: This option is set to the Vi default value when 'compatible' is
8343 set and to the Vim default value when 'compatible' is reset.
8344
8345 *'tags'* *'tag'* *E433*
8346'tags' 'tag' string (default "./tags,tags", when compiled with
8347 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
8348 global or local to buffer |global-local|
8349 Filenames for the tag command, separated by spaces or commas. To
Yee Cheng Chin54844852023-10-09 18:12:31 +02008350 include a space or comma in a file name, precede it with backslashes
8351 (see |option-backslash| about including spaces/commas and backslashes).
Bram Moolenaar071d4272004-06-13 20:20:40 +00008352 When a file name starts with "./", the '.' is replaced with the path
8353 of the current file. But only when the 'd' flag is not included in
8354 'cpoptions'. Environment variables are expanded |:set_env|. Also see
8355 |tags-option|.
8356 "*", "**" and other wildcards can be used to search for tags files in
Bram Moolenaare2b590e2010-08-08 18:29:48 +02008357 a directory tree. See |file-searching|. E.g., "/lib/**/tags" will
8358 find all files named "tags" below "/lib". The filename itself cannot
8359 contain wildcards, it is used as-is. E.g., "/lib/**/tags?" will find
Bram Moolenaar2bd9dbc2022-08-25 18:12:06 +01008360 files called "tags?".
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00008361 The |tagfiles()| function can be used to get a list of the file names
8362 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008363 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
8364 files are also supported. They are automatically recognized. The
8365 default value becomes "./tags,./TAGS,tags,TAGS", unless case
8366 differences are ignored (MS-Windows). |emacs-tags|
8367 The use of |:set+=| and |:set-=| is preferred when adding or removing
8368 file names from the list. This avoids problems when a future version
8369 uses another default.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008370
8371 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
8372'tagstack' 'tgst' boolean (default on)
8373 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008374 When on, the |tagstack| is used normally. When off, a ":tag" or
8375 ":tselect" command with an argument will not push the tag onto the
8376 tagstack. A following ":tag" without an argument, a ":pop" command or
8377 any other command that uses the tagstack will use the unmodified
8378 tagstack, but does change the pointer to the active entry.
8379 Resetting this option is useful when using a ":tag" command in a
8380 mapping which should not change the tagstack.
8381
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01008382 *'tcldll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01008383'tcldll' string (default depends on the build)
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01008384 global
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01008385 {only available when compiled with the |+tcl/dyn|
8386 feature}
8387 Specifies the name of the Tcl shared library. The default is
8388 DYNAMIC_TCL_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02008389 Environment variables are expanded |:set_env|.
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01008390 This option cannot be set from a |modeline| or in the |sandbox|, for
8391 security reasons.
8392
Bram Moolenaar071d4272004-06-13 20:20:40 +00008393 *'term'* *E529* *E530* *E531*
8394'term' string (default is $TERM, if that fails:
8395 in the GUI: "builtin_gui"
8396 on Amiga: "amiga"
Bram Moolenaarb3f74062020-02-26 16:16:53 +01008397 on Haiku: "xterm"
Bram Moolenaar071d4272004-06-13 20:20:40 +00008398 on Mac: "mac-ansi"
Bram Moolenaar071d4272004-06-13 20:20:40 +00008399 on Unix: "ansi"
8400 on VMS: "ansi"
8401 on Win 32: "win32")
8402 global
8403 Name of the terminal. Used for choosing the terminal control
8404 characters. Environment variables are expanded |:set_env|.
8405 For example: >
8406 :set term=$TERM
8407< See |termcap|.
8408
8409 *'termbidi'* *'tbidi'*
8410 *'notermbidi'* *'notbidi'*
8411'termbidi' 'tbidi' boolean (default off, on for "mlterm")
8412 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008413 {only available when compiled with the |+arabic|
8414 feature}
8415 The terminal is in charge of Bi-directionality of text (as specified
8416 by Unicode). The terminal is also expected to do the required shaping
8417 that some languages (such as Arabic) require.
8418 Setting this option implies that 'rightleft' will not be set when
8419 'arabic' is set and the value of 'arabicshape' will be ignored.
8420 Note that setting 'termbidi' has the immediate effect that
8421 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
8422 This option is reset when the GUI is started.
8423 For further details see |arabic.txt|.
8424
8425 *'termencoding'* *'tenc'*
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02008426'termencoding' 'tenc' string (default ""; with GTK+ GUI: "utf-8")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008427 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008428 Encoding used for the terminal. This specifies what character
8429 encoding the keyboard produces and the display will understand. For
Bram Moolenaar3848e002016-03-19 18:42:29 +01008430 the GUI it only applies to the keyboard ('encoding' is used for the
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02008431 display).
Bram Moolenaar4b7cdca2020-01-01 16:18:38 +01008432 *E617* *E950*
Bram Moolenaar3df01732017-02-17 22:47:16 +01008433 Note: This does not apply to the GTK+ GUI. After the GUI has been
Bram Moolenaar071d4272004-06-13 20:20:40 +00008434 successfully initialized, 'termencoding' is forcibly set to "utf-8".
8435 Any attempts to set a different value will be rejected, and an error
8436 message is shown.
Bram Moolenaarac360bf2015-09-01 20:31:20 +02008437 For the Win32 GUI and console versions 'termencoding' is not used,
Bram Moolenaar071d4272004-06-13 20:20:40 +00008438 because the Win32 system always passes Unicode characters.
8439 When empty, the same encoding is used as for the 'encoding' option.
8440 This is the normal value.
8441 Not all combinations for 'termencoding' and 'encoding' are valid. See
8442 |encoding-table|.
8443 The value for this option must be supported by internal conversions or
8444 iconv(). When this is not possible no conversion will be done and you
8445 will probably experience problems with non-ASCII characters.
8446 Example: You are working with the locale set to euc-jp (Japanese) and
8447 want to edit a UTF-8 file: >
8448 :let &termencoding = &encoding
8449 :set encoding=utf-8
8450< You need to do this when your system has no locale support for UTF-8.
8451
Bram Moolenaar938ae282023-02-20 20:44:55 +00008452 *'termguicolors'* *'tgc'* *'notermguicolors'* *'notgc'* *E954*
Bram Moolenaar61be73b2016-04-29 22:59:22 +02008453'termguicolors' 'tgc' boolean (default off)
8454 global
Bram Moolenaar61be73b2016-04-29 22:59:22 +02008455 {not available when compiled without the
8456 |+termguicolors| feature}
8457 When on, uses |highlight-guifg| and |highlight-guibg| attributes in
Bram Moolenaarcafafb32018-02-22 21:07:09 +01008458 the terminal (thus using 24-bit color).
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01008459
Bram Moolenaarcafafb32018-02-22 21:07:09 +01008460 Requires a ISO-8613-3 compatible terminal. If setting this option
8461 does not work (produces a colorless UI) reading |xterm-true-color|
8462 might help.
8463
8464 For Win32 console, Windows 10 version 1703 (Creators Update) or later
8465 is required. Use this check to find out: >
8466 if has('vcon')
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01008467< This requires Vim to be built with the |+vtp| feature.
8468
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +02008469 Note that the "cterm" attributes are still used, not the "gui" ones.
Yasuhiro Matsumotoaa04e1b2022-05-07 14:09:19 +01008470
8471 When using Vim with Windows Terminal, the background of Windows
8472 Terminal is normally filled with the Vim background color. Setting
8473 'termguicolors' and the guibg of the Normal highlight group to NONE
8474 will make the background transparent: >
8475 :hi Normal guibg=NONE
8476<
Bram Moolenaar036986f2017-03-16 17:41:02 +01008477 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar61be73b2016-04-29 22:59:22 +02008478
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008479 *'termwinkey'* *'twk'*
8480'termwinkey' 'twk' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02008481 local to window
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008482 The key that starts a CTRL-W command in a terminal window. Other keys
Bram Moolenaar74675a62017-07-15 13:53:23 +02008483 are sent to the job running in the window.
Millya9c6f902024-10-06 16:47:02 +02008484 The key can be specified as a single character, a |key-notation| (e.g.
8485 <Up>, <C-F>) or a letter preceded with a caret (e.g. `^F` is CTRL-F): >
8486 :set twk=X
8487 :set twk=^I
8488 :set twk=<C-L>
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008489< The string must be one key stroke but can be multiple bytes.
8490 When not set CTRL-W is used, so that CTRL-W : gets you to the command
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008491 line. If 'termwinkey' is set to CTRL-L then CTRL-L : gets you to the
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008492 command line.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008493
Bram Moolenaar6c60f472019-04-28 16:00:35 +02008494 *'termwinscroll'* *'twsl'*
8495'termwinscroll' 'twsl' number (default 10000)
8496 local to buffer
8497 {not available when compiled without the
8498 |+terminal| feature}
8499 Number of scrollback lines to keep. When going over this limit the
8500 first 10% of the scrollback lines are deleted. This is just to reduce
8501 the memory usage. See |Terminal-Normal|.
Bram Moolenaar36968af2021-11-15 17:13:11 +00008502 Also used as a limit for text sent to the terminal in one write,
8503 multiplied by the number of columns times 3 (average number of bytes
8504 per cell).
Bram Moolenaar6c60f472019-04-28 16:00:35 +02008505
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008506 *'termwinsize'* *'tws'*
8507'termwinsize' 'tws' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02008508 local to window
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02008509 Size used when opening the |terminal| window. Format:
8510 {rows}x{columns} or {rows}*{columns}.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008511 - When empty the terminal gets the size from the window.
Bram Moolenaar498c2562018-04-15 23:45:15 +02008512 - When set with a "x" (e.g., "24x80") the terminal size is not
8513 adjusted to the window size. If the window is smaller only the
8514 top-left part is displayed.
8515 - When set with a "*" (e.g., "10*50") the terminal size follows the
8516 window size, but will not be smaller than the specified rows and/or
8517 columns.
8518 - When rows is zero then use the height of the window.
8519 - When columns is zero then use the width of the window.
8520 - Using "0x0" or "0*0" is the same as empty.
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02008521 - Can be overruled in the |term_start()| options with "term_rows" and
8522 "term_cols".
Bram Moolenaar498c2562018-04-15 23:45:15 +02008523
8524 Examples:
8525 "30x0" uses 30 rows and the current window width.
8526 "20*0" uses at least 20 rows and the current window width.
8527 "0*40" uses the current window height and at least 40 columns.
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02008528 Note that the command running in the terminal window may still change
8529 the size of the terminal. In that case the Vim window will be
8530 adjusted to that size, if possible.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008531
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008532 *'termwintype'* *'twt'*
8533'termwintype' 'twt' string (default "")
8534 global
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008535 {only available when compiled with the |terminal|
8536 feature on MS-Windows}
8537 Specify the virtual console (pty) used when opening the terminal
8538 window.
8539
8540 Possible values are:
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01008541 "" use ConPTY if it is stable, winpty otherwise
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008542 "winpty" use winpty, fail if not supported
8543 "conpty" use |ConPTY|, fail if not supported
8544
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01008545 |ConPTY| support depends on the platform. Windows 10 October 2018
8546 Update is the first version that supports ConPTY, however it is still
8547 considered unstable. ConPTY might become stable in the next release
8548 of Windows 10. winpty support needs to be installed. If neither is
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008549 supported then you cannot open a terminal window.
8550
Bram Moolenaar071d4272004-06-13 20:20:40 +00008551 *'terse'* *'noterse'*
8552'terse' boolean (default off)
8553 global
8554 When set: Add 's' flag to 'shortmess' option (this makes the message
8555 for a search that hits the start or end of the file not being
8556 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
8557 shortens a lot of messages}
8558
8559 *'textauto'* *'ta'* *'notextauto'* *'nota'*
8560'textauto' 'ta' boolean (Vim default: on, Vi default: off)
8561 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008562 This option is obsolete. Use 'fileformats'.
8563 For backwards compatibility, when 'textauto' is set, 'fileformats' is
8564 set to the default value for the current system. When 'textauto' is
8565 reset, 'fileformats' is made empty.
8566 NOTE: This option is set to the Vi default value when 'compatible' is
8567 set and to the Vim default value when 'compatible' is reset.
8568
8569 *'textmode'* *'tx'* *'notextmode'* *'notx'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008570'textmode' 'tx' boolean (Win32: default on,
Bram Moolenaar071d4272004-06-13 20:20:40 +00008571 others: default off)
8572 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00008573 This option is obsolete. Use 'fileformat'.
8574 For backwards compatibility, when 'textmode' is set, 'fileformat' is
8575 set to "dos". When 'textmode' is reset, 'fileformat' is set to
8576 "unix".
8577
8578 *'textwidth'* *'tw'*
8579'textwidth' 'tw' number (default 0)
8580 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00008581 Maximum width of text that is being inserted. A longer line will be
8582 broken after white space to get this width. A zero value disables
Bram Moolenaarca635012015-09-25 20:34:21 +02008583 this.
8584 'textwidth' is set to 0 when the 'paste' option is set and restored
8585 when 'paste' is reset.
8586 When 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00008587 'formatoptions' and |ins-textwidth|.
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00008588 When 'formatexpr' is set it will be used to break the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008589 NOTE: This option is set to 0 when 'compatible' is set.
8590
8591 *'thesaurus'* *'tsr'*
8592'thesaurus' 'tsr' string (default "")
8593 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008594 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008595 for thesaurus completion commands |i_CTRL-X_CTRL-T|. See
8596 |compl-thesaurus|.
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01008597
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008598 This option is not used if 'thesaurusfunc' is set, either for the
8599 buffer or globally.
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01008600
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008601 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00008602 after a comma are ignored, otherwise spaces are included in the file
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008603 name. See |option-backslash| about using backslashes. The use of
8604 |:set+=| and |:set-=| is preferred when adding or removing directories
8605 from the list. This avoids problems when a future version uses
8606 another default. Backticks cannot be used in this option for security
8607 reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008608
Bram Moolenaar2f0936c2022-01-08 21:51:59 +00008609 *'thesaurusfunc'* *'tsrfu'*
Yegappan Lakshmanan160e9942021-10-16 15:41:29 +01008610'thesaurusfunc' 'tsrfu' string (default: empty)
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008611 global or local to buffer |global-local|
Yegappan Lakshmanan160e9942021-10-16 15:41:29 +01008612 {not available when compiled without the |+eval|
8613 feature}
8614 This option specifies a function to be used for thesaurus completion
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008615 with CTRL-X CTRL-T. |i_CTRL-X_CTRL-T| See |compl-thesaurusfunc|.
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00008616 The value can be the name of a function, a |lambda| or a |Funcref|.
8617 See |option-value-function| for more information.
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008618
Yegappan Lakshmanan160e9942021-10-16 15:41:29 +01008619 This option cannot be set from a |modeline| or in the |sandbox|, for
8620 security reasons.
8621
Bram Moolenaar071d4272004-06-13 20:20:40 +00008622 *'tildeop'* *'top'* *'notildeop'* *'notop'*
8623'tildeop' 'top' boolean (default off)
8624 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008625 When on: The tilde command "~" behaves like an operator.
8626 NOTE: This option is reset when 'compatible' is set.
8627
8628 *'timeout'* *'to'* *'notimeout'* *'noto'*
8629'timeout' 'to' boolean (default on)
8630 global
laburnumT3f7855a2023-12-05 18:37:03 +01008631
Bram Moolenaar071d4272004-06-13 20:20:40 +00008632 *'ttimeout'* *'nottimeout'*
Bram Moolenaar94237492017-04-23 18:40:21 +02008633'ttimeout' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008634 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008635 These two options together determine the behavior when part of a
8636 mapped key sequence or keyboard code has been received:
8637
8638 'timeout' 'ttimeout' action ~
8639 off off do not time out
8640 on on or off time out on :mappings and key codes
8641 off on time out on key codes
8642
8643 If both options are off, Vim will wait until either the complete
8644 mapping or key sequence has been received, or it is clear that there
8645 is no mapping or key sequence for the received characters. For
8646 example: if you have mapped "vl" and Vim has received 'v', the next
8647 character is needed to see if the 'v' is followed by an 'l'.
8648 When one of the options is on, Vim will wait for about 1 second for
8649 the next character to arrive. After that the already received
8650 characters are interpreted as single characters. The waiting time can
8651 be changed with the 'timeoutlen' option.
8652 On slow terminals or very busy systems timing out may cause
8653 malfunctioning cursor keys. If both options are off, Vim waits
8654 forever after an entered <Esc> if there are key codes that start
8655 with <Esc>. You will have to type <Esc> twice. If you do not have
8656 problems with key codes, but would like to have :mapped key
8657 sequences not timing out in 1 second, set the 'ttimeout' option and
8658 reset the 'timeout' option.
8659
8660 NOTE: 'ttimeout' is reset when 'compatible' is set.
8661
8662 *'timeoutlen'* *'tm'*
8663'timeoutlen' 'tm' number (default 1000)
8664 global
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008665
Bram Moolenaar071d4272004-06-13 20:20:40 +00008666 *'ttimeoutlen'* *'ttm'*
Bram Moolenaar94237492017-04-23 18:40:21 +02008667'ttimeoutlen' 'ttm' number (default -1, set to 100 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008668 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008669 The time in milliseconds that is waited for a key code or mapped key
8670 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
8671 when part of a command has been typed.
8672 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
8673 different timeout value for key codes is desired set 'ttimeoutlen' to
8674 a non-negative number.
8675
8676 ttimeoutlen mapping delay key code delay ~
8677 < 0 'timeoutlen' 'timeoutlen'
8678 >= 0 'timeoutlen' 'ttimeoutlen'
8679
8680 The timeout only happens when the 'timeout' and 'ttimeout' options
8681 tell so. A useful setting would be >
8682 :set timeout timeoutlen=3000 ttimeoutlen=100
8683< (time out on mapping after three seconds, time out on key codes after
8684 a tenth of a second).
8685
8686 *'title'* *'notitle'*
8687'title' boolean (default off, on when title can be restored)
8688 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008689 When on, the title of the window will be set to the value of
8690 'titlestring' (if it is not empty), or to:
8691 filename [+=-] (path) - VIM
8692 Where:
8693 filename the name of the file being edited
8694 - indicates the file cannot be modified, 'ma' off
8695 + indicates the file was modified
8696 = indicates the file is read-only
8697 =+ indicates the file is read-only and modified
8698 (path) is the path of the file being edited
8699 - VIM the server name |v:servername| or "VIM"
8700 Only works if the terminal supports setting window titles
8701 (currently Amiga console, Win32 console, all GUI versions and
Bram Moolenaard1caa942020-04-10 22:10:56 +02008702 terminals with a non-empty 't_ts' option - these are Unix xterm and
Bram Moolenaar071d4272004-06-13 20:20:40 +00008703 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
8704 *X11*
8705 When Vim was compiled with HAVE_X11 defined, the original title will
8706 be restored if possible. The output of ":version" will include "+X11"
8707 when HAVE_X11 was defined, otherwise it will be "-X11". This also
8708 works for the icon name |'icon'|.
8709 But: When Vim was started with the |-X| argument, restoring the title
8710 will not work (except in the GUI).
8711 If the title cannot be restored, it is set to the value of 'titleold'.
8712 You might want to restore the title outside of Vim then.
Christian Brabandt1b7fbe72024-01-30 20:41:07 +01008713 When using an xterm from a remote machine you can use this command: >
8714
Bram Moolenaar071d4272004-06-13 20:20:40 +00008715 rsh machine_name xterm -display $DISPLAY &
Christian Brabandt1b7fbe72024-01-30 20:41:07 +01008716 ssh -X machine_name xterm &
8717<
Bram Moolenaar071d4272004-06-13 20:20:40 +00008718 then the WINDOWID environment variable should be inherited and the
8719 title of the window should change back to what it should be after
8720 exiting Vim.
8721
8722 *'titlelen'*
8723'titlelen' number (default 85)
8724 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008725 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008726 title. When the title is longer, only the end of the path name is
8727 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008728 Using a percentage makes this adapt to the width of the window. But
8729 it won't work perfectly, because the actual number of characters
8730 available also depends on the font used and other things in the title
8731 bar. When 'titlelen' is zero the full path is used. Otherwise,
8732 values from 1 to 30000 percent can be used.
8733 'titlelen' is also used for the 'titlestring' option.
8734
8735 *'titleold'*
8736'titleold' string (default "Thanks for flying Vim")
8737 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008738 This option will be used for the window title when exiting Vim if the
8739 original title cannot be restored. Only happens if 'title' is on or
8740 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00008741 This option cannot be set from a |modeline| or in the |sandbox|, for
8742 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008743 *'titlestring'*
8744'titlestring' string (default "")
8745 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008746 When this option is not empty, it will be used for the title of the
8747 window. This happens only when the 'title' option is on.
8748 Only works if the terminal supports setting window titles (currently
8749 Amiga console, Win32 console, all GUI versions and terminals with a
8750 non-empty 't_ts' option).
8751 When Vim was compiled with HAVE_X11 defined, the original title will
Bram Moolenaar51628222016-12-01 23:03:28 +01008752 be restored if possible, see |X11|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008753
Bram Moolenaar071d4272004-06-13 20:20:40 +00008754 When this option contains printf-style '%' items, they will be
Milly6c2fc372024-10-16 22:11:17 +02008755 expanded according to the rules used for 'statusline'. If it contains
8756 an invalid '%' format, the value is used as-is and no error or warning
8757 will be given when the value is set.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008758 This option cannot be set in a modeline when 'modelineexpr' is off.
8759
Bram Moolenaar071d4272004-06-13 20:20:40 +00008760 Example: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00008761 :auto BufEnter * let &titlestring = hostname() .. "/" .. expand("%:p")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008762 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
8763< The value of 'titlelen' is used to align items in the middle or right
8764 of the available space.
8765 Some people prefer to have the file name first: >
8766 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
8767< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008768 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00008769 separating space only when needed.
8770 NOTE: Use of special characters in 'titlestring' may cause the display
8771 to be garbled (e.g., when it contains a CR or NL character).
8772 {not available when compiled without the |+statusline| feature}
8773
8774 *'toolbar'* *'tb'*
8775'toolbar' 'tb' string (default "icons,tooltips")
8776 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01008777 {only for |+GUI_GTK|, |+GUI_Motif| and |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008778 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00008779 possible values are:
8780 icons Toolbar buttons are shown with icons.
8781 text Toolbar buttons shown with text.
8782 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008783 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008784 tooltips Tooltips are active for toolbar buttons.
8785 Tooltips refer to the popup help text which appears after the mouse
8786 cursor is placed over a toolbar button for a brief moment.
8787
8788 If you want the toolbar to be shown with icons as well as text, do the
8789 following: >
8790 :set tb=icons,text
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01008791< Motif cannot display icons and text at the same time. They
Bram Moolenaar071d4272004-06-13 20:20:40 +00008792 will show icons if both are requested.
8793
8794 If none of the strings specified in 'toolbar' are valid or if
8795 'toolbar' is empty, this option is ignored. If you want to disable
8796 the toolbar, you need to set the 'guioptions' option. For example: >
8797 :set guioptions-=T
8798< Also see |gui-toolbar|.
8799
8800 *'toolbariconsize'* *'tbis'*
8801'toolbariconsize' 'tbis' string (default "small")
8802 global
Bram Moolenaar3df01732017-02-17 22:47:16 +01008803 {only in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008804 Controls the size of toolbar icons. The possible values are:
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008805 tiny Use tiny icons.
8806 small Use small icons (default).
8807 medium Use medium-sized icons.
8808 large Use large icons.
8809 huge Use even larger icons.
8810 giant Use very big icons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008811 The exact dimensions in pixels of the various icon sizes depend on
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008812 the current theme. Common dimensions are giant=48x48, huge=32x32,
8813 large=24x24, medium=24x24, small=20x20 and tiny=16x16.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008814
8815 If 'toolbariconsize' is empty, the global default size as determined
8816 by user preferences or the current theme is used.
8817
8818 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
8819'ttybuiltin' 'tbi' boolean (default on)
8820 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008821 When on, the builtin termcaps are searched before the external ones.
8822 When off the builtin termcaps are searched after the external ones.
8823 When this option is changed, you should set the 'term' option next for
8824 the change to take effect, for example: >
8825 :set notbi term=$TERM
8826< See also |termcap|.
8827 Rationale: The default for this option is "on", because the builtin
8828 termcap entries are generally better (many systems contain faulty
8829 xterm entries...).
8830
8831 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
Bram Moolenaarc1cf4c92022-11-25 15:09:35 +00008832'ttyfast' 'tf' boolean (default on)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008833 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008834 Indicates a fast terminal connection. More characters will be sent to
8835 the screen for redrawing, instead of using insert/delete line
8836 commands. Improves smoothness of redrawing when there are multiple
8837 windows and the terminal does not support a scrolling region.
8838 Also enables the extra writing of characters at the end of each screen
8839 line for lines that wrap. This helps when using copy/paste with the
8840 mouse in an xterm and other terminals.
8841
Bram Moolenaarc1cf4c92022-11-25 15:09:35 +00008842 The default used to be set only for some terminal names, but these
8843 days nearly all terminals are fast, therefore the default is now "on".
8844 If you have a slow connection you may want to set this option off,
8845 e.g. depending on the host name: >
8846 if hostname() =~ 'faraway'
8847 set nottyfast
8848 endif
8849<
Bram Moolenaar071d4272004-06-13 20:20:40 +00008850 *'ttymouse'* *'ttym'*
8851'ttymouse' 'ttym' string (default depends on 'term')
8852 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008853 {only in Unix and VMS, doesn't work in the GUI; not
8854 available when compiled without |+mouse|}
8855 Name of the terminal type for which mouse codes are to be recognized.
Bram Moolenaar2c7a7632007-05-10 18:19:11 +00008856 Currently these strings are valid:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008857 *xterm-mouse*
8858 xterm xterm-like mouse handling. The mouse generates
8859 "<Esc>[Mscr", where "scr" is three bytes:
8860 "s" = button state
8861 "c" = column plus 33
8862 "r" = row plus 33
Bram Moolenaare968e362014-05-13 20:23:24 +02008863 This only works up to 223 columns! See "dec",
8864 "urxvt", and "sgr" for solutions.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008865 xterm2 Works like "xterm", but with the xterm reporting the
8866 mouse position while the mouse is dragged. This works
8867 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00008868 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00008869 work. See below for how Vim detects this
8870 automatically.
8871 *netterm-mouse*
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008872 netterm NetTerm mouse handling. A left mouse click generates
Bram Moolenaar071d4272004-06-13 20:20:40 +00008873 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008874 for the row and column. No other mouse events are
8875 supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008876 *dec-mouse*
8877 dec DEC terminal mouse handling. The mouse generates a
8878 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00008879 This is also available for an Xterm, if it was
8880 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00008881 *jsbterm-mouse*
8882 jsbterm JSB term mouse handling.
8883 *pterm-mouse*
8884 pterm QNX pterm mouse handling.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008885 *urxvt-mouse*
8886 urxvt Mouse handling for the urxvt (rxvt-unicode) terminal.
Bram Moolenaare968e362014-05-13 20:23:24 +02008887 The mouse works only if the terminal supports this
8888 encoding style, but it does not have 223 columns limit
8889 unlike "xterm" or "xterm2".
Bram Moolenaar9b451252012-08-15 17:43:31 +02008890 *sgr-mouse*
8891 sgr Mouse handling for the terminal that emits SGR-styled
Bram Moolenaare968e362014-05-13 20:23:24 +02008892 mouse reporting. The mouse works even in columns
8893 beyond 223. This option is backward compatible with
8894 "xterm2" because it can also decode "xterm2" style
8895 mouse codes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008896
8897 The mouse handling must be enabled at compile time |+mouse_xterm|
Bram Moolenaare968e362014-05-13 20:23:24 +02008898 |+mouse_dec| |+mouse_netterm| |+mouse_jsbterm| |+mouse_urxvt|
8899 |+mouse_sgr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008900 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
8901 recognized, if enabled at compile time. DEC terminal mouse codes
8902 are recognized if enabled at compile time, and 'ttymouse' is not
Bram Moolenaare968e362014-05-13 20:23:24 +02008903 "xterm", "xterm2", "urxvt" or "sgr" (because dec mouse codes conflict
8904 with them).
Bram Moolenaar071d4272004-06-13 20:20:40 +00008905 This option is automatically set to "xterm", when the 'term' option is
Bram Moolenaar45758762016-10-12 23:08:06 +02008906 set to a name that starts with "xterm", "mlterm", "screen", "tmux",
8907 "st" (full match only), "st-" or "stterm", and 'ttymouse' is not set
8908 already.
Bram Moolenaar06cd14d2023-01-10 12:37:38 +00008909 If the terminfo/termcap entry "XM" exists and the first number is
8910 "1006" then 'ttymouse' will be set to "sgr". This works for many
8911 modern terminals.
Bram Moolenaare968e362014-05-13 20:23:24 +02008912 Additionally, if vim is compiled with the |+termresponse| feature and
8913 |t_RV| is set to the escape sequence to request the xterm version
Bram Moolenaarf8a07122019-07-01 22:06:07 +02008914 number, more intelligent detection is done.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008915 The "xterm2" value will be set if the xterm version is reported to be
Bram Moolenaard47d5222018-12-09 20:43:55 +01008916 from 95 to 276. The "sgr" value will be set if Vim detects Mac
8917 Terminal.app, iTerm2 or mintty, and when the xterm version is 277 or
8918 higher.
Bram Moolenaare968e362014-05-13 20:23:24 +02008919 If you do not want 'ttymouse' to be set to "xterm2" or "sgr"
8920 automatically, set t_RV to an empty string: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008921 :set t_RV=
8922<
8923 *'ttyscroll'* *'tsl'*
8924'ttyscroll' 'tsl' number (default 999)
8925 global
8926 Maximum number of lines to scroll the screen. If there are more lines
8927 to scroll the window is redrawn. For terminals where scrolling is
8928 very slow and redrawing is not slow this can be set to a small number,
8929 e.g., 3, to speed up displaying.
8930
8931 *'ttytype'* *'tty'*
8932'ttytype' 'tty' string (default from $TERM)
8933 global
8934 Alias for 'term', see above.
8935
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008936 *'undodir'* *'udir'*
8937'undodir' 'udir' string (default ".")
8938 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008939 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008940 List of directory names for undo files, separated with commas.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008941 See |'backupdir'| for details of the format.
Bram Moolenaar6a244fe2010-05-24 22:02:24 +02008942 "." means using the directory of the file. The undo file name for
8943 "file.txt" is ".file.txt.un~".
8944 For other directories the file name is the full path of the edited
8945 file, with path separators replaced with "%".
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008946 When writing: The first directory that exists is used. "." always
8947 works, no directories after "." will be used for writing.
8948 When reading all entries are tried to find an undo file. The first
8949 undo file that exists is used. When it cannot be read an error is
8950 given, no further entry is used.
8951 See |undo-persistence|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008952 This option cannot be set from a |modeline| or in the |sandbox|, for
8953 security reasons.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008954
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02008955 *'undofile'* *'noundofile'* *'udf'* *'noudf'*
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008956'undofile' 'udf' boolean (default off)
8957 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02008958 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008959 When on, Vim automatically saves undo history to an undo file when
8960 writing a buffer to a file, and restores undo history from the same
8961 file on buffer read.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008962 The directory where the undo file is stored is specified by 'undodir'.
8963 For more information about this feature see |undo-persistence|.
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008964 The undo file is not read when 'undoreload' causes the buffer from
8965 before a reload to be saved for undo.
Bram Moolenaar97d62492012-11-15 21:28:22 +01008966 When 'undofile' is turned off the undo file is NOT deleted.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008967 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008968
Bram Moolenaar071d4272004-06-13 20:20:40 +00008969 *'undolevels'* *'ul'*
Bram Moolenaar8024f932020-01-14 19:29:13 +01008970'undolevels' 'ul' number (default 100, 1000 for Unix, VMS and Win32)
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008971 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008972 Maximum number of changes that can be undone. Since undo information
Bram Moolenaar5be4cee2019-09-27 19:34:08 +02008973 is kept in memory, higher numbers will cause more memory to be used.
8974 Nevertheless, a single change can already use a large amount of memory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008975 Set to 0 for Vi compatibility: One level of undo and "u" undoes
8976 itself: >
8977 set ul=0
8978< But you can also get Vi compatibility by including the 'u' flag in
8979 'cpoptions', and still be able to use CTRL-R to repeat undo.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008980 Also see |undo-two-ways|.
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008981 Set to -1 for no undo at all. You might want to do this only for the
8982 current buffer: >
8983 setlocal ul=-1
Bram Moolenaar071d4272004-06-13 20:20:40 +00008984< This helps when you run out of memory for a single change.
Bram Moolenaar32efaf62014-11-05 17:02:17 +01008985
8986 The local value is set to -123456 when the global value is to be used.
8987
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008988 Also see |clear-undo|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008989
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008990 *'undoreload'* *'ur'*
8991'undoreload' 'ur' number (default 10000)
8992 global
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008993 Save the whole buffer for undo when reloading it. This applies to the
8994 ":e!" command and reloading for when the buffer changed outside of
8995 Vim. |FileChangedShell|
Bram Moolenaar24a98a02017-09-27 22:23:55 +02008996 The save only happens when this option is negative or when the number
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008997 of lines is smaller than the value of this option.
8998 Set this option to zero to disable undo for a reload.
8999
9000 When saving undo for a reload, any undo file is not read.
9001
9002 Note that this causes the whole buffer to be stored in memory. Set
9003 this option to a lower value if you run out of memory.
9004
Bram Moolenaar071d4272004-06-13 20:20:40 +00009005 *'updatecount'* *'uc'*
9006'updatecount' 'uc' number (default: 200)
9007 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009008 After typing this many characters the swap file will be written to
9009 disk. When zero, no swap file will be created at all (see chapter on
9010 recovery |crash-recovery|). 'updatecount' is set to zero by starting
9011 Vim with the "-n" option, see |startup|. When editing in readonly
9012 mode this option will be initialized to 10000.
9013 The swapfile can be disabled per buffer with |'swapfile'|.
9014 When 'updatecount' is set from zero to non-zero, swap files are
9015 created for all buffers that have 'swapfile' set. When 'updatecount'
9016 is set to zero, existing swap files are not deleted.
9017 Also see |'swapsync'|.
9018 This option has no meaning in buffers where |'buftype'| is "nofile"
9019 or "nowrite".
9020
9021 *'updatetime'* *'ut'*
9022'updatetime' 'ut' number (default 4000)
9023 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009024 If this many milliseconds nothing is typed the swap file will be
9025 written to disk (see |crash-recovery|). Also used for the
9026 |CursorHold| autocommand event.
9027
Bram Moolenaar04958cb2018-06-23 19:23:02 +02009028 *'varsofttabstop'* *'vsts'*
9029'varsofttabstop' 'vsts' string (default "")
9030 local to buffer
9031 {only available when compiled with the |+vartabs|
9032 feature}
Bram Moolenaar04958cb2018-06-23 19:23:02 +02009033 A list of the number of spaces that a <Tab> counts for while editing,
9034 such as inserting a <Tab> or using <BS>. It "feels" like variable-
9035 width <Tab>s are being inserted, while in fact a mixture of spaces
9036 and <Tab>s is used. Tab widths are separated with commas, with the
9037 final value applying to all subsequent tabs.
9038
9039 For example, when editing assembly language files where statements
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02009040 start in the 9th column and comments in the 41st, it may be useful
Bram Moolenaar04958cb2018-06-23 19:23:02 +02009041 to use the following: >
9042 :set varsofttabstop=8,32,8
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02009043< This will set soft tabstops with 8 and 8 + 32 spaces, and 8 more
9044 for every column thereafter.
Bram Moolenaar04958cb2018-06-23 19:23:02 +02009045
9046 Note that the value of |'softtabstop'| will be ignored while
9047 'varsofttabstop' is set.
9048
9049 *'vartabstop'* *'vts'*
9050'vartabstop' 'vts' string (default "")
9051 local to buffer
9052 {only available when compiled with the |+vartabs|
9053 feature}
Bram Moolenaar04958cb2018-06-23 19:23:02 +02009054 A list of the number of spaces that a <Tab> in the file counts for,
9055 separated by commas. Each value corresponds to one tab, with the
9056 final value applying to all subsequent tabs. For example: >
9057 :set vartabstop=4,20,10,8
9058< This will make the first tab 4 spaces wide, the second 20 spaces,
9059 the third 10 spaces, and all following tabs 8 spaces.
9060
9061 Note that the value of |'tabstop'| will be ignored while 'vartabstop'
9062 is set.
9063
Bram Moolenaar071d4272004-06-13 20:20:40 +00009064 *'verbose'* *'vbs'*
9065'verbose' 'vbs' number (default 0)
9066 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009067 When bigger than zero, Vim will give messages about what it is doing.
9068 Currently, these messages are given:
9069 >= 1 When the viminfo file is read or written.
9070 >= 2 When a file is ":source"'ed.
Bram Moolenaar647a5302020-05-03 17:01:24 +02009071 >= 4 Shell commands.
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00009072 >= 5 Every searched tags file and include file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009073 >= 8 Files for which a group of autocommands is executed.
9074 >= 9 Every executed autocommand.
Bram Moolenaar647a5302020-05-03 17:01:24 +02009075 >= 11 Finding items in a path
Bram Moolenaar071d4272004-06-13 20:20:40 +00009076 >= 12 Every executed function.
9077 >= 13 When an exception is thrown, caught, finished, or discarded.
9078 >= 14 Anything pending in a ":finally" clause.
Bram Moolenaar823654b2020-05-29 23:03:09 +02009079 >= 15 Every executed Ex command from a script (truncated at 200
9080 characters).
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02009081 >= 16 Every executed Ex command.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009082
9083 This option can also be set with the "-V" argument. See |-V|.
9084 This option is also set by the |:verbose| command.
9085
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00009086 When the 'verbosefile' option is set then the verbose messages are not
9087 displayed.
9088
9089 *'verbosefile'* *'vfile'*
9090'verbosefile' 'vfile' string (default empty)
9091 global
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00009092 When not empty all messages are written in a file with this name.
9093 When the file exists messages are appended.
9094 Writing to the file ends when Vim exits or when 'verbosefile' is made
Bram Moolenaar80794b12010-06-13 05:20:42 +02009095 empty. Writes are buffered, thus may not show up for some time.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00009096 Setting 'verbosefile' to a new value is like making it empty first.
9097 The difference with |:redir| is that verbose messages are not
9098 displayed when 'verbosefile' is set.
dkearns8ebdbc92023-10-29 06:26:19 +11009099 This option cannot be set from a |modeline| or in the |sandbox|, for
9100 security reasons.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00009101
Bram Moolenaar071d4272004-06-13 20:20:40 +00009102 *'viewdir'* *'vdir'*
h_east59858792023-10-25 22:47:05 +09009103'viewdir' 'vdir' string (default for Amiga: "home:vimfiles/view",
Bram Moolenaar801961d2023-06-23 16:15:13 +01009104 for Win32: "$HOME/vimfiles/view",
Christian Brabandtc3e6e392024-05-04 09:48:15 +02009105 for Unix: "$HOME/.vim/view" or
9106 "$XDG_CONFIG_HOME/vim/view"
Bram Moolenaar801961d2023-06-23 16:15:13 +01009107 for VMS: "sys$login:vimfiles/view")
Bram Moolenaar071d4272004-06-13 20:20:40 +00009108 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02009109 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00009110 feature}
9111 Name of the directory where to store files for |:mkview|.
Christian Brabandtc3e6e392024-05-04 09:48:15 +02009112 For $XDG_CONFIG_HOME see |xdg-base-dir|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009113 This option cannot be set from a |modeline| or in the |sandbox|, for
9114 security reasons.
9115
9116 *'viewoptions'* *'vop'*
Bram Moolenaar13e90412017-11-11 18:16:48 +01009117'viewoptions' 'vop' string (default: "folds,options,cursor,curdir")
Bram Moolenaar071d4272004-06-13 20:20:40 +00009118 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02009119 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00009120 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01009121 Changes the effect of the |:mkview| command. It is a comma-separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009122 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00009123 word save and restore ~
9124 cursor cursor position in file and in window
9125 folds manually created folds, opened/closed folds and local
9126 fold options
9127 options options and mappings local to a window or buffer (not
9128 global values for local options)
Bram Moolenaar6e932462014-09-09 18:48:09 +02009129 localoptions same as "options"
Bram Moolenaar071d4272004-06-13 20:20:40 +00009130 slash backslashes in file names replaced with forward
9131 slashes
9132 unix with Unix end-of-line format (single <NL>), even when
Bram Moolenaar6f345a12019-12-17 21:27:18 +01009133 on MS-Windows
Bram Moolenaar13e90412017-11-11 18:16:48 +01009134 curdir the window-local directory, if set with `:lcd`
Bram Moolenaar071d4272004-06-13 20:20:40 +00009135
Bram Moolenaar6f345a12019-12-17 21:27:18 +01009136 "slash" and "unix" are useful on MS-Windows when sharing view files
Bram Moolenaar071d4272004-06-13 20:20:40 +00009137 with Unix. The Unix version of Vim cannot source dos format scripts,
Bram Moolenaar6f345a12019-12-17 21:27:18 +01009138 but the MS-Windows version of Vim can source unix format scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009139
9140 *'viminfo'* *'vi'* *E526* *E527* *E528*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01009141'viminfo' 'vi' string (Vi default: "", Vim default for
9142 MS-Windows: '100,<50,s10,h,rA:,rB:,
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01009143 for Amiga: '100,<50,s10,h,rdf0:,rdf1:,rdf2:
9144 for others: '100,<50,s10,h)
Bram Moolenaar071d4272004-06-13 20:20:40 +00009145 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02009146 {not available when compiled without the |+viminfo|
Bram Moolenaar071d4272004-06-13 20:20:40 +00009147 feature}
9148 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarc4da1132017-07-15 19:39:43 +02009149 when exiting Vim (see |viminfo-file|). Except when 'viminfofile' is
9150 "NONE".
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01009151 The string should be a comma-separated list of parameters, each
Bram Moolenaarc4da1132017-07-15 19:39:43 +02009152 consisting of a single character identifying the particular parameter,
9153 followed by a number or string which specifies the value of that
9154 parameter. If a particular character is left out, then the default
9155 value is used for that parameter. The following is a list of the
9156 identifying characters and the effect of their value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009157 CHAR VALUE ~
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009158 *viminfo-!*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009159 ! When included, save and restore global variables that start
9160 with an uppercase letter, and don't contain a lowercase
9161 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar680eeca2010-10-20 17:44:42 +02009162 and "_K_L_M" are not. Nested List and Dict items may not be
Bram Moolenaar166af9b2010-11-16 20:34:40 +01009163 read back correctly, you end up with an empty item.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009164 *viminfo-quote*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009165 " Maximum number of lines saved for each register. Old name of
9166 the '<' item, with the disadvantage that you need to put a
9167 backslash before the ", otherwise it will be recognized as the
9168 start of a comment!
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009169 *viminfo-%*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009170 % When included, save and restore the buffer list. If Vim is
9171 started with a file name argument, the buffer list is not
9172 restored. If Vim is started without a file name argument, the
Bram Moolenaard042dc82015-11-24 19:18:36 +01009173 buffer list is restored from the viminfo file. Quickfix
9174 ('buftype'), unlisted ('buflisted'), unnamed and buffers on
9175 removable media (|viminfo-r|) are not saved.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00009176 When followed by a number, the number specifies the maximum
9177 number of buffers that are stored. Without a number all
9178 buffers are stored.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009179 *viminfo-'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009180 ' Maximum number of previously edited files for which the marks
9181 are remembered. This parameter must always be included when
9182 'viminfo' is non-empty.
9183 Including this item also means that the |jumplist| and the
9184 |changelist| are stored in the viminfo file.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009185 *viminfo-/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009186 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009187 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00009188 patterns are also saved. When not included, the value of
9189 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009190 *viminfo-:*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009191 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009192 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009193 *viminfo-<*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009194 < Maximum number of lines saved for each register. If zero then
9195 registers are not saved. When not included, all lines are
9196 saved. '"' is the old name for this item.
9197 Also see the 's' item below: limit specified in Kbyte.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009198 *viminfo-@*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009199 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009200 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009201 *viminfo-c*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009202 c When included, convert the text in the viminfo file from the
9203 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00009204 'encoding'. See |viminfo-encoding|.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009205 *viminfo-f*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009206 f Whether file marks need to be stored. If zero, file marks ('0
9207 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009208 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00009209 cursor position (when exiting or when doing ":wviminfo").
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009210 *viminfo-h*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009211 h Disable the effect of 'hlsearch' when loading the viminfo
9212 file. When not included, it depends on whether ":nohlsearch"
9213 has been used since the last search command.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009214 *viminfo-n*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009215 n Name of the viminfo file. The name must immediately follow
Bram Moolenaarc4da1132017-07-15 19:39:43 +02009216 the 'n'. Must be at the end of the option! If the
9217 'viminfofile' option is set, that file name overrides the one
9218 given here with 'viminfo'. Environment variables are
Bram Moolenaar063b9d12016-07-09 20:21:48 +02009219 expanded when opening the file, not when setting the option.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009220 *viminfo-r*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009221 r Removable media. The argument is a string (up to the next
9222 ','). This parameter can be given several times. Each
9223 specifies the start of a path for which no marks will be
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01009224 stored. This is to avoid removable media. For MS-Windows you
Bram Moolenaar071d4272004-06-13 20:20:40 +00009225 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
9226 also use it for temp files, e.g., for Unix: "r/tmp". Case is
9227 ignored. Maximum length of each 'r' argument is 50
9228 characters.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009229 *viminfo-s*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009230 s Maximum size of an item in Kbyte. If zero then registers are
9231 not saved. Currently only applies to registers. The default
9232 "s10" will exclude registers with more than 10 Kbyte of text.
9233 Also see the '<' item above: line count limit.
9234
9235 Example: >
9236 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
9237<
9238 '50 Marks will be remembered for the last 50 files you
9239 edited.
9240 <1000 Contents of registers (up to 1000 lines each) will be
9241 remembered.
9242 s100 Registers with more than 100 Kbyte text are skipped.
9243 :0 Command-line history will not be saved.
9244 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
9245 no / Since '/' is not specified, the default will be used,
9246 that is, save all of the search history, and also the
9247 previous search and substitute patterns.
9248 no % The buffer list will not be saved nor read back.
9249 no h 'hlsearch' highlighting will be restored.
9250
9251 When setting 'viminfo' from an empty value you can use |:rviminfo| to
9252 load the contents of the file, this is not done automatically.
9253
9254 This option cannot be set from a |modeline| or in the |sandbox|, for
9255 security reasons.
Bram Moolenaar036986f2017-03-16 17:41:02 +01009256 NOTE: This option is set to the Vim default value when 'compatible'
9257 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009258
Bram Moolenaarc4da1132017-07-15 19:39:43 +02009259 *'viminfofile'* *'vif'*
9260'viminfofile' 'vif' string (default: "")
9261 global
Bram Moolenaarc4da1132017-07-15 19:39:43 +02009262 {not available when compiled without the |+viminfo|
9263 feature}
9264 When non-empty, overrides the file name used for viminfo.
9265 When equal to "NONE" no viminfo file will be read or written.
9266 This option can be set with the |-i| command line flag. The |--clean|
9267 command line flag sets it to "NONE".
Bram Moolenaar110289e2019-05-23 15:38:06 +02009268 This option cannot be set from a |modeline| or in the |sandbox|, for
9269 security reasons.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02009270
Bram Moolenaar071d4272004-06-13 20:20:40 +00009271 *'virtualedit'* *'ve'*
9272'virtualedit' 've' string (default "")
Gary Johnson51ad8502021-08-03 18:33:08 +02009273 global or local to window |global-local|
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01009274 A comma-separated list of these words:
Bram Moolenaar071d4272004-06-13 20:20:40 +00009275 block Allow virtual editing in Visual block mode.
9276 insert Allow virtual editing in Insert mode.
9277 all Allow virtual editing in all modes.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00009278 onemore Allow the cursor to move just past the end of the line
Gary Johnson53ba05b2021-07-26 22:19:10 +02009279 none When used as the local value, do not allow virtual
9280 editing even when the global value is set. When used
9281 as the global value, "none" is the same as "".
9282 NONE Alternative spelling of "none".
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009283
Bram Moolenaar071d4272004-06-13 20:20:40 +00009284 Virtual editing means that the cursor can be positioned where there is
Bram Moolenaarebcbd022007-05-12 14:28:25 +00009285 no actual character. This can be halfway into a tab or beyond the end
Bram Moolenaar071d4272004-06-13 20:20:40 +00009286 of the line. Useful for selecting a rectangle in Visual mode and
9287 editing a table.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00009288 "onemore" is not the same, it will only allow moving the cursor just
9289 after the last character of the line. This makes some commands more
9290 consistent. Previously the cursor was always past the end of the line
9291 if the line was empty. But it is far from Vi compatible. It may also
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009292 break some plugins or Vim scripts. For example because |l| can move
9293 the cursor after the last character. Use with care!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02009294 Using the `$` command will move to the last character in the line, not
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009295 past it. This may actually move the cursor to the left!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02009296 The `g$` command will move to the end of the screen line.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00009297 It doesn't make sense to combine "all" with "onemore", but you will
9298 not get a warning for it.
Bram Moolenaar53f7fcc2021-07-28 20:10:16 +02009299 When combined with other words, "none" is ignored.
Bram Moolenaar036986f2017-03-16 17:41:02 +01009300 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009301
9302 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
9303'visualbell' 'vb' boolean (default off)
9304 global
Bram Moolenaar74675a62017-07-15 13:53:23 +02009305 Use a visual bell instead of beeping. The terminal code to display the
Bram Moolenaar071d4272004-06-13 20:20:40 +00009306 visual bell is given with 't_vb'. When no beep or flash is wanted,
Bram Moolenaar74675a62017-07-15 13:53:23 +02009307 use: >
9308 :set vb t_vb=
9309< If you want a short flash, you can use this on many terminals: >
9310 :set vb t_vb=[?5h$<100>[?5l
9311< Here $<100> specifies the time, you can use a smaller or bigger value
9312 to get a shorter or longer flash.
9313
9314 Note: Vim will limit the bell to once per half a second. This avoids
9315 having to wait for the flashing to finish when there are lots of
9316 bells, e.g. on key repeat. This also happens without 'visualbell'
9317 set.
9318
Bram Moolenaar071d4272004-06-13 20:20:40 +00009319 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
9320 for 20 msec. If you want to use a different time, use "<Esc>|40f",
9321 where 40 is the time in msec.
Bram Moolenaar74675a62017-07-15 13:53:23 +02009322
9323 Note: When the GUI starts, 't_vb' is reset to its default value. You
9324 might want to set it again in your |gvimrc|.
9325
Bram Moolenaar071d4272004-06-13 20:20:40 +00009326 Does not work on the Amiga, you always get a screen flash.
9327 Also see 'errorbells'.
9328
9329 *'warn'* *'nowarn'*
9330'warn' boolean (default on)
9331 global
9332 Give a warning message when a shell command is used while the buffer
9333 has been changed.
9334
9335 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
9336'weirdinvert' 'wiv' boolean (default off)
9337 global
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00009338 This option has the same effect as the 't_xs' terminal option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009339 It is provided for backwards compatibility with version 4.x.
9340 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
9341 vice versa. Has no effect when the GUI is running.
9342
9343 *'whichwrap'* *'ww'*
9344'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
9345 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009346 Allow specified keys that move the cursor left/right to move to the
9347 previous/next line when the cursor is on the first/last character in
9348 the line. Concatenate characters to allow this for these keys:
9349 char key mode ~
9350 b <BS> Normal and Visual
9351 s <Space> Normal and Visual
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00009352 h "h" Normal and Visual (not recommended)
9353 l "l" Normal and Visual (not recommended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00009354 < <Left> Normal and Visual
9355 > <Right> Normal and Visual
9356 ~ "~" Normal
9357 [ <Left> Insert and Replace
9358 ] <Right> Insert and Replace
9359 For example: >
9360 :set ww=<,>,[,]
9361< allows wrap only when cursor keys are used.
9362 When the movement keys are used in combination with a delete or change
9363 operator, the <EOL> also counts for a character. This makes "3h"
9364 different from "3dh" when the cursor crosses the end of a line. This
9365 is also true for "x" and "X", because they do the same as "dl" and
9366 "dh". If you use this, you may also want to use the mapping
9367 ":map <BS> X" to make backspace delete the character in front of the
9368 cursor.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00009369 When 'l' is included and it is used after an operator at the end of a
Bram Moolenaar589edb32019-09-20 14:38:13 +02009370 line (not an empty line) then it will not move to the next line. This
9371 makes "dl", "cl", "yl" etc. work normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009372 NOTE: This option is set to the Vi default value when 'compatible' is
9373 set and to the Vim default value when 'compatible' is reset.
9374
9375 *'wildchar'* *'wc'*
9376'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
9377 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009378 Character you have to type to start wildcard expansion in the
9379 command-line, as specified with 'wildmode'.
Bram Moolenaar446cb832008-06-24 21:56:24 +00009380 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009381 The character is not recognized when used inside a macro. See
9382 'wildcharm' for that.
Bram Moolenaar34cc7d82021-09-21 20:09:51 +02009383 Some keys will not work, such as CTRL-C, <CR> and Enter.
Yee Cheng Chin8f4fb002023-10-17 10:06:56 +02009384 <Esc> can be used, but hitting it twice in a row will still exit
9385 command-line as a failsafe measure.
Millya9c6f902024-10-06 16:47:02 +02009386 Although 'wc' is a number option, it can be specified as a number, a
9387 single character, a |key-notation| (e.g. <Up>, <C-F>) or a letter
9388 preceded with a caret (e.g. `^F` is CTRL-F): >
9389 :set wc=27
9390 :set wc=X
9391 :set wc=^I
Bram Moolenaar34cc7d82021-09-21 20:09:51 +02009392 :set wc=<Tab>
Bram Moolenaar071d4272004-06-13 20:20:40 +00009393< NOTE: This option is set to the Vi default value when 'compatible' is
9394 set and to the Vim default value when 'compatible' is reset.
9395
9396 *'wildcharm'* *'wcm'*
9397'wildcharm' 'wcm' number (default: none (0))
9398 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009399 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00009400 recognized when used inside a macro. You can find "spare" command-line
9401 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00009402 you'll never actually type 'wildcharm', just use it in mappings that
9403 automatically invoke completion mode, e.g.: >
9404 :set wcm=<C-Z>
Bram Moolenaar446cb832008-06-24 21:56:24 +00009405 :cnoremap ss so $vim/sessions/*.vim<C-Z>
Bram Moolenaar071d4272004-06-13 20:20:40 +00009406< Then after typing :ss you can use CTRL-P & CTRL-N.
9407
9408 *'wildignore'* *'wig'*
9409'wildignore' 'wig' string (default "")
9410 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009411 A list of file patterns. A file that matches with one of these
Bram Moolenaar30b65812012-07-12 22:01:11 +02009412 patterns is ignored when expanding |wildcards|, completing file or
9413 directory names, and influences the result of |expand()|, |glob()| and
9414 |globpath()| unless a flag is passed to disable this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009415 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
9416 Also see 'suffixes'.
9417 Example: >
9418 :set wildignore=*.o,*.obj
9419< The use of |:set+=| and |:set-=| is preferred when adding or removing
9420 a pattern from the list. This avoids problems when a future version
9421 uses another default.
9422
h_east596a9f22023-11-21 21:24:23 +09009423 *'wildignorecase'* *'wic'* *'nowildignorecase'* *'nowic'*
Bram Moolenaar94950a92010-12-02 16:01:29 +01009424'wildignorecase' 'wic' boolean (default off)
9425 global
Bram Moolenaar94950a92010-12-02 16:01:29 +01009426 When set case is ignored when completing file names and directories.
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01009427 Has no effect when 'fileignorecase' is set.
Bram Moolenaar94950a92010-12-02 16:01:29 +01009428 Does not apply when the shell is used to expand wildcards, which
9429 happens when there are special characters.
9430
Bram Moolenaar071d4272004-06-13 20:20:40 +00009431 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02009432'wildmenu' 'wmnu' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00009433 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009434 When 'wildmenu' is on, command-line completion operates in an enhanced
9435 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
Bram Moolenaar54162322022-08-26 16:58:51 +01009436 the possible matches are shown.
9437 When 'wildoptions' contains "pum", then the completion matches are
9438 shown in a popup menu. Otherwise they are displayed just above the
9439 command line, with the first match highlighted (overwriting the status
9440 line, if there is one).
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009441 Keys that show the previous/next match, such as <Tab> or
Bram Moolenaar071d4272004-06-13 20:20:40 +00009442 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
9443 When 'wildmode' is used, "wildmenu" mode is used where "full" is
9444 specified. "longest" and "list" do not start "wildmenu" mode.
Bram Moolenaar26402cb2013-02-20 21:26:00 +01009445 You can check the current mode with |wildmenumode()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009446 If there are more matches than can fit in the line, a ">" is shown on
9447 the right and/or a "<" is shown on the left. The status line scrolls
9448 as needed.
9449 The "wildmenu" mode is abandoned when a key is hit that is not used
9450 for selecting a completion.
Yee Cheng Chin2bbd0d32023-10-14 02:23:45 -07009451 While the "wildmenu" is active, the following keys have special
9452 meanings:
9453 CTRL-P - go to the previous entry
9454 CTRL-N - go to the next entry
Bram Moolenaar071d4272004-06-13 20:20:40 +00009455 <CR> - in menu completion, when the cursor is just after a
9456 dot: move into a submenu.
Yee Cheng Chin209ec902023-10-17 10:56:25 +02009457 CTRL-E - end completion, go back to what was there before
9458 selecting a match.
9459 CTRL-Y - accept the currently selected match and stop
9460 completion.
Yee Cheng Chin2bbd0d32023-10-14 02:23:45 -07009461
9462 When not using the popup menu for command line completion, the
9463 following keys have special meanings:
9464 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
Bram Moolenaar071d4272004-06-13 20:20:40 +00009465 <Up> - in filename/menu name completion: move up into
9466 parent directory or parent menu.
Yee Cheng Chin2bbd0d32023-10-14 02:23:45 -07009467 <Down> - in filename/menu name completion: move into a
9468 subdirectory or submenu.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009469
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009470 When using the popup menu for command line completion, the following
9471 keys have special meanings:
Yee Cheng Chin2bbd0d32023-10-14 02:23:45 -07009472 <Up> <Down> - select previous/next match (like CTRL-P/CTRL-N)
zeertzjq3c81f472023-10-15 16:02:08 +08009473 <PageUp> - select a match several entries back
9474 <PageDown> - select a match several entries further
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009475 <Left> - in filename/menu name completion: move up into
9476 parent directory or parent menu.
9477 <Right> - in filename/menu name completion: move into a
9478 subdirectory or submenu.
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009479
Bram Moolenaar071d4272004-06-13 20:20:40 +00009480 This makes the menus accessible from the console |console-menus|.
9481
9482 If you prefer the <Left> and <Right> keys to move the cursor instead
9483 of selecting a different match, use this: >
9484 :cnoremap <Left> <Space><BS><Left>
9485 :cnoremap <Right> <Space><BS><Right>
9486<
9487 The "WildMenu" highlighting is used for displaying the current match
9488 |hl-WildMenu|.
9489
9490 *'wildmode'* *'wim'*
9491'wildmode' 'wim' string (Vim default: "full")
9492 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009493 Completion mode that is used for the character specified with
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01009494 'wildchar'. It is a comma-separated list of up to four parts. Each
Bram Moolenaar02467872007-05-06 13:22:01 +00009495 part specifies what to do for each consecutive use of 'wildchar'. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00009496 first part specifies the behavior for the first use of 'wildchar',
9497 The second part for the second use, etc.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009498
9499 Each part consists of a colon separated list consisting of the
9500 following possible values:
Bram Moolenaar071d4272004-06-13 20:20:40 +00009501 "" Complete only the first match.
9502 "full" Complete the next full match. After the last match,
9503 the original string is used and then the first match
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009504 again. Will also start 'wildmenu' if it is enabled.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009505 "longest" Complete till longest common string. If this doesn't
9506 result in a longer string, use the next part.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009507 "list" When more than one match, list all matches.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009508 "lastused" When completing buffer names and more than one buffer
9509 matches, sort buffers by time last used (other than
9510 the current buffer).
9511 When there is only a single match, it is fully completed in all cases.
9512
9513 Examples of useful colon-separated values:
9514 "longest:full" Like "longest", but also start 'wildmenu' if it is
9515 enabled. Will not complete to the next full match.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009516 "list:full" When more than one match, list all matches and
9517 complete first match.
9518 "list:longest" When more than one match, list all matches and
9519 complete till longest common string.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009520 "list:lastused" When more than one buffer matches, list all matches
9521 and sort buffers by time last used (other than the
9522 current buffer).
Bram Moolenaar071d4272004-06-13 20:20:40 +00009523
9524 Examples: >
9525 :set wildmode=full
Bram Moolenaar582fd852005-03-28 20:58:01 +00009526< Complete first full match, next match, etc. (the default) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00009527 :set wildmode=longest,full
9528< Complete longest common string, then each full match >
9529 :set wildmode=list:full
9530< List all matches and complete each full match >
9531 :set wildmode=list,full
9532< List all matches without completing, then each full match >
9533 :set wildmode=longest,list
9534< Complete longest common string, then list alternatives.
Bram Moolenaar446cb832008-06-24 21:56:24 +00009535 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009536
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009537 *'wildoptions'* *'wop'*
9538'wildoptions' 'wop' string (default "")
9539 global
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009540 A list of words that change how |cmdline-completion| is done.
9541 The following values are supported:
Bram Moolenaar1588bc82022-03-08 21:35:07 +00009542 fuzzy Use |fuzzy-matching| to find completion matches. When
Yegappan Lakshmanan38b85cb2022-02-24 13:28:41 +00009543 this value is specified, wildcard expansion will not
9544 be used for completion. The matches will be sorted by
9545 the "best match" rather than alphabetically sorted.
9546 This will find more matches than the wildcard
9547 expansion. Currently fuzzy matching based completion
9548 is not supported for file and directory names and
9549 instead wildcard expansion is used.
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01009550 pum Display the completion matches using the popup menu
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009551 in the same style as the |ins-completion-menu|.
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009552 tagfile When using CTRL-D to list matching tags, the kind of
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00009553 tag and the file of the tag is listed. Only one match
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009554 is displayed per line. Often used tag kinds are:
9555 d #define
9556 f function
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009557
Bram Moolenaar071d4272004-06-13 20:20:40 +00009558 *'winaltkeys'* *'wak'*
9559'winaltkeys' 'wak' string (default "menu")
9560 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009561 {only used in Win32, Motif, GTK and Photon GUI}
9562 Some GUI versions allow the access to menu entries by using the ALT
9563 key in combination with a character that appears underlined in the
9564 menu. This conflicts with the use of the ALT key for mappings and
9565 entering special characters. This option tells what to do:
9566 no Don't use ALT keys for menus. ALT key combinations can be
9567 mapped, but there is no automatic handling. This can then be
9568 done with the |:simalt| command.
9569 yes ALT key handling is done by the windowing system. ALT key
9570 combinations cannot be mapped.
9571 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009572 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00009573 keys can be mapped.
9574 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
9575 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00009576 This option is not used for <F10>; on Win32 and with GTK <F10> will
9577 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009578
Bram Moolenaar4d784b22019-05-25 19:51:39 +02009579 *'wincolor'* *'wcr'*
9580'wincolor' 'wcr' string (default empty)
9581 local to window
9582 Highlight group name to use for this window instead of the Normal
9583 color |hl-Normal|.
9584
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009585 *'window'* *'wi'*
9586'window' 'wi' number (default screen height - 1)
9587 global
Bram Moolenaardad44732021-03-31 20:07:33 +02009588 Window height used for |CTRL-F| and |CTRL-B| when there is only one
9589 window and the value is smaller than 'lines' minus one. The screen
9590 will scroll 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009591 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
9592 in a much smarter way, taking care of wrapping lines.
Luuk van Baal5a2e3ec2024-03-28 10:07:29 +01009593 When resizing the Vim window, and the value is smaller than 1 or more
9594 than or equal to 'lines' it will be set to 'lines' minus 1.
Bram Moolenaardad44732021-03-31 20:07:33 +02009595 Note: Do not confuse this with the height of the Vim window, use
9596 'lines' for that.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009597
Colin Kennedy21570352024-03-03 16:16:47 +01009598 *'winfixbuf'*
9599'winfixbuf' 'wfb' boolean (default off)
9600 local to window
zeertzjq0049a492024-03-11 23:13:16 +08009601 If enabled, the window and the buffer it is displaying are paired.
Colin Kennedy21570352024-03-03 16:16:47 +01009602 For example, attempting to change the buffer with |:edit| will fail.
9603 Other commands which change a window's buffer such as |:cnext| will
zeertzjq0049a492024-03-11 23:13:16 +08009604 also skip any window with 'winfixbuf' enabled. However if an Ex
9605 command has a "!" modifier, it can force switching buffers.
Colin Kennedy21570352024-03-03 16:16:47 +01009606
laburnumT3f7855a2023-12-05 18:37:03 +01009607 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
9608'winfixheight' 'wfh' boolean (default off)
9609 local to window |local-noglobal|
9610 Keep the window height when windows are opened or closed and
9611 'equalalways' is set. Also for |CTRL-W_=|. Set by default for the
9612 |preview-window| and |quickfix-window|.
9613 The height may be changed anyway when running out of room.
9614
9615 *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'*
9616'winfixwidth' 'wfw' boolean (default off)
9617 local to window |local-noglobal|
9618 Keep the window width when windows are opened or closed and
9619 'equalalways' is set. Also for |CTRL-W_=|.
9620 The width may be changed anyway when running out of room.
9621
Bram Moolenaar071d4272004-06-13 20:20:40 +00009622 *'winheight'* *'wh'* *E591*
9623'winheight' 'wh' number (default 1)
9624 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009625 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009626 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar446cb832008-06-24 21:56:24 +00009627 focus goes to a window that is smaller, its size is increased, at the
9628 cost of the height of other windows.
9629 Set 'winheight' to a small number for normal editing.
9630 Set it to 999 to make the current window fill most of the screen.
9631 Other windows will be only 'winminheight' high. This has the drawback
9632 that ":all" will create only two windows. To avoid "vim -o 1 2 3 4"
9633 to create only two windows, set the option after startup is done,
9634 using the |VimEnter| event: >
9635 au VimEnter * set winheight=999
9636< Minimum value is 1.
9637 The height is not adjusted after one of the commands that change the
Bram Moolenaar071d4272004-06-13 20:20:40 +00009638 height of the current window.
9639 'winheight' applies to the current window. Use 'winminheight' to set
9640 the minimal height for other windows.
9641
Bram Moolenaar071d4272004-06-13 20:20:40 +00009642 *'winminheight'* *'wmh'*
9643'winminheight' 'wmh' number (default 1)
9644 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009645 The minimal height of a window, when it's not the current window.
9646 This is a hard minimum, windows will never become smaller.
9647 When set to zero, windows may be "squashed" to zero lines (i.e. just a
9648 status bar) if necessary. They will return to at least one line when
9649 they become active (since the cursor has to have somewhere to go.)
9650 Use 'winheight' to set the minimal height of the current window.
9651 This option is only checked when making a window smaller. Don't use a
9652 large number, it will cause errors when opening more than a few
9653 windows. A value of 0 to 3 is reasonable.
9654
9655 *'winminwidth'* *'wmw'*
9656'winminwidth' 'wmw' number (default 1)
9657 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009658 The minimal width of a window, when it's not the current window.
9659 This is a hard minimum, windows will never become smaller.
9660 When set to zero, windows may be "squashed" to zero columns (i.e. just
9661 a vertical separator) if necessary. They will return to at least one
9662 line when they become active (since the cursor has to have somewhere
9663 to go.)
9664 Use 'winwidth' to set the minimal width of the current window.
9665 This option is only checked when making a window smaller. Don't use a
9666 large number, it will cause errors when opening more than a few
9667 windows. A value of 0 to 12 is reasonable.
9668
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009669 *'winptydll'*
9670'winptydll' string (default "winpty32.dll" or "winpty64.dll")
9671 global
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009672 {only available when compiled with the |terminal|
9673 feature on MS-Windows}
9674 Specifies the name of the winpty shared library, used for the
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02009675 |:terminal| command. The default depends on whether Vim was built as a
Bram Moolenaarc572da52017-08-27 16:52:01 +02009676 32-bit or 64-bit executable. If not found, "winpty.dll" is tried as
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009677 a fallback.
9678 Environment variables are expanded |:set_env|.
9679 This option cannot be set from a |modeline| or in the |sandbox|, for
9680 security reasons.
9681
Bram Moolenaar071d4272004-06-13 20:20:40 +00009682 *'winwidth'* *'wiw'* *E592*
9683'winwidth' 'wiw' number (default 20)
9684 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009685 Minimal number of columns for the current window. This is not a hard
9686 minimum, Vim will use fewer columns if there is not enough room. If
9687 the current window is smaller, its size is increased, at the cost of
9688 the width of other windows. Set it to 999 to make the current window
9689 always fill the screen. Set it to a small number for normal editing.
9690 The width is not adjusted after one of the commands to change the
9691 width of the current window.
9692 'winwidth' applies to the current window. Use 'winminwidth' to set
9693 the minimal width for other windows.
9694
9695 *'wrap'* *'nowrap'*
9696'wrap' boolean (default on)
9697 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00009698 This option changes how text is displayed. It doesn't change the text
9699 in the buffer, see 'textwidth' for that.
9700 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009701 displaying continues on the next line. When off lines will not wrap
9702 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00009703 moved to a part that is not shown, the screen will scroll
9704 horizontally.
9705 The line will be broken in the middle of a word if necessary. See
9706 'linebreak' to get the break at a word boundary.
9707 To make scrolling horizontally a bit more useful, try this: >
9708 :set sidescroll=5
9709 :set listchars+=precedes:<,extends:>
9710< See 'sidescroll', 'listchars' and |wrap-off|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01009711 This option can't be set from a |modeline| when the 'diff' option is
9712 on.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009713
9714 *'wrapmargin'* *'wm'*
9715'wrapmargin' 'wm' number (default 0)
9716 local to buffer
9717 Number of characters from the right window border where wrapping
9718 starts. When typing text beyond this limit, an <EOL> will be inserted
9719 and inserting continues on the next line.
9720 Options that add a margin, such as 'number' and 'foldcolumn', cause
9721 the text width to be further reduced. This is Vi compatible.
9722 When 'textwidth' is non-zero, this option is not used.
Bram Moolenaarca635012015-09-25 20:34:21 +02009723 This option is set to 0 when 'paste' is set and restored when 'paste'
9724 is reset.
Bram Moolenaara6c27c42019-05-09 19:16:22 +02009725 See also 'formatoptions' and |ins-textwidth|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009726
9727 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
9728'wrapscan' 'ws' boolean (default on) *E384* *E385*
9729 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00009730 Searches wrap around the end of the file. Also applies to |]s| and
9731 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009732
9733 *'write'* *'nowrite'*
9734'write' boolean (default on)
9735 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009736 Allows writing files. When not set, writing a file is not allowed.
9737 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009738 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00009739 argument. Filtering text is still possible, even though this requires
9740 writing a temporary file.
9741
9742 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
9743'writeany' 'wa' boolean (default off)
9744 global
9745 Allows writing to any file with no need for "!" override.
9746
9747 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
9748'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
9749 otherwise)
9750 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009751 Make a backup before overwriting a file. The backup is removed after
9752 the file was successfully written, unless the 'backup' option is
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02009753 also on.
9754 WARNING: Switching this option off means that when Vim fails to write
9755 your buffer correctly and then, for whatever reason, Vim exits, you
9756 lose both the original file and what you were writing. Only reset
9757 this option if your file system is almost full and it makes the write
9758 fail (and make sure not to exit Vim until the write was successful).
9759 See |backup-table| for another explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009760 When the 'backupskip' pattern matches, a backup is not made anyway.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01009761 Depending on 'backupcopy' the backup is a new file or the original
9762 file renamed (and a new file is written).
Bram Moolenaar071d4272004-06-13 20:20:40 +00009763 NOTE: This option is set to the default value when 'compatible' is
9764 set.
9765
9766 *'writedelay'* *'wd'*
9767'writedelay' 'wd' number (default 0)
9768 global
Bram Moolenaar802a0d92016-06-26 16:17:58 +02009769 The number of milliseconds to wait for each character sent to the
Bram Moolenaar071d4272004-06-13 20:20:40 +00009770 screen. When non-zero, characters are sent to the terminal one by
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01009771 one. For debugging purposes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009772
Bram Moolenaar6f79e612021-12-21 09:12:23 +00009773 *'xtermcodes'* *'noxtermcodes'*
9774'xtermcodes' boolean (default on)
9775 global
9776 When detecting xterm patchlevel 141 or higher with the termresponse
Bram Moolenaarfa3b7232021-12-24 13:18:38 +00009777 mechanism and this option is set, Vim will request the actual terminal
Bram Moolenaar6f79e612021-12-21 09:12:23 +00009778 key codes and number of colors from the terminal. This takes care of
9779 various configuration options of the terminal that cannot be obtained
9780 from the termlib/terminfo entry, see |xterm-codes|.
9781 A side effect may be that t_Co changes and Vim will redraw the
9782 display.
9783
9784
Bram Moolenaar91f84f62018-07-29 15:07:52 +02009785 vim:tw=78:ts=8:noet:ft=help:norl: