blob: 525a3a58ba79c57e3b5f128c98fdb07b8affb847 [file] [log] [blame]
zeertzjq1dc731a2025-03-13 21:30:10 +01001*options.txt* For Vim version 9.1. Last change: 2025 Mar 13
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*
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +0100442Some options ('completefunc', 'findfunc', 'imactivatefunc', 'imstatusfunc',
443'omnifunc', 'operatorfunc', 'quickfixtextfunc', 'tagfunc' and 'thesaurusfunc')
444are set to a function name or a function reference or a lambda function. When
445using a lambda it will be converted to the name, e.g. "<lambda>123".
446Examples:
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +0000447>
448 set opfunc=MyOpFunc
Yegappan Lakshmanan19916a82021-11-24 16:32:55 +0000449 set opfunc=function('MyOpFunc')
450 set opfunc=funcref('MyOpFunc')
Yegappan Lakshmanan05e59e32021-12-01 10:30:07 +0000451 set opfunc={a\ ->\ MyOpFunc(a)}
Bram Moolenaar1fca5f32022-02-18 17:50:47 +0000452
453Set to a script-local function: >
454 set opfunc=s:MyLocalFunc
455 set opfunc=<SID>MyLocalFunc
456In |Vim9| script the "s:" and "<SID>" can be omitted if the function exists in
457the script: >
458 set opfunc=MyLocalFunc
459
460Set using a funcref variable: >
Yegappan Lakshmanan05e59e32021-12-01 10:30:07 +0000461 let Fn = function('MyTagFunc')
Bram Moolenaarfa3b7232021-12-24 13:18:38 +0000462 let &tagfunc = Fn
Bram Moolenaar1fca5f32022-02-18 17:50:47 +0000463
464Set using a lambda expression: >
Yegappan Lakshmanan64095532021-12-06 11:03:55 +0000465 let &tagfunc = {t -> MyTagFunc(t)}
Bram Moolenaar1fca5f32022-02-18 17:50:47 +0000466
467Set using a variable with lambda expression: >
Yegappan Lakshmanan05e59e32021-12-01 10:30:07 +0000468 let L = {a, b, c -> MyTagFunc(a, b , c)}
Yegappan Lakshmanan64095532021-12-06 11:03:55 +0000469 let &tagfunc = L
Bram Moolenaar7b1463b2021-12-11 17:24:39 +0000470
471In Vim9 script, in a compiled function, you can use a lambda, but a
Aliaksei Budaveib043ff32023-10-03 17:39:53 +0300472closure does not work, because the function will be called without the
Bram Moolenaar7b1463b2021-12-11 17:24:39 +0000473context of where it was defined.
474
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +0000475
Bram Moolenaar071d4272004-06-13 20:20:40 +0000476Setting the filetype
477
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200478:setf[iletype] [FALLBACK] {filetype} *:setf* *:setfiletype*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000479 Set the 'filetype' option to {filetype}, but only if
480 not done yet in a sequence of (nested) autocommands.
481 This is short for: >
482 :if !did_filetype()
483 : setlocal filetype={filetype}
484 :endif
485< This command is used in a filetype.vim file to avoid
486 setting the 'filetype' option twice, causing different
487 settings and syntax files to be loaded.
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200488
489 When the optional FALLBACK argument is present, a
490 later :setfiletype command will override the
Bram Moolenaar26967612019-03-17 17:13:16 +0100491 'filetype'. This is to be used for filetype
492 detections that are just a guess. |did_filetype()|
493 will return false after this command.
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200494
Bram Moolenaard58e9292011-02-09 17:07:58 +0100495 *option-window* *optwin*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000496:bro[wse] se[t] *:set-browse* *:browse-set* *:opt* *:options*
497:opt[ions] Open a window for viewing and setting all options.
498 Options are grouped by function.
499 Offers short help for each option. Hit <CR> on the
500 short help to open a help window with more help for
501 the option.
502 Modify the value of the option and hit <CR> on the
503 "set" line to set the new value. For window and
504 buffer specific options, the last accessed window is
505 used to set the option value in, unless this is a help
506 window, in which case the window below help window is
507 used (skipping the option-window).
Bram Moolenaarb5b75622018-03-09 22:22:21 +0100508 {not available when compiled without the |+eval|
509 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000510
511 *$HOME*
512Using "~" is like using "$HOME", but it is only recognized at the start of an
513option and after a space or comma.
514
515On Unix systems "~user" can be used too. It is replaced by the home directory
516of user "user". Example: >
517 :set path=~mool/include,/usr/include,.
518
519On Unix systems the form "${HOME}" can be used too. The name between {} can
520contain non-id characters then. Note that if you want to use this for the
521"gf" command, you need to add the '{' and '}' characters to 'isfname'.
522
523NOTE: expanding environment variables and "~/" is only done with the ":set"
524command, not when assigning a value to an option with ":let".
525
Bram Moolenaarc572da52017-08-27 16:52:01 +0200526 *$HOME-windows*
527On MS-Windows, if $HOME is not defined as an environment variable, then
528at runtime Vim will set it to the expansion of $HOMEDRIVE$HOMEPATH.
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200529If $HOMEDRIVE is not set then $USERPROFILE is used.
530
531This expanded value is not exported to the environment, this matters when
532running an external command: >
533 :echo system('set | findstr ^HOME=')
534and >
535 :echo luaeval('os.getenv("HOME")')
536should echo nothing (an empty string) despite exists('$HOME') being true.
537When setting $HOME to a non-empty string it will be exported to the
538subprocesses.
Bram Moolenaarc572da52017-08-27 16:52:01 +0200539
Bram Moolenaar071d4272004-06-13 20:20:40 +0000540
541Note the maximum length of an expanded option is limited. How much depends on
542the system, mostly it is something like 256 or 1024 characters.
543
544 *:fix* *:fixdel*
545:fix[del] Set the value of 't_kD':
546 't_kb' is 't_kD' becomes ~
547 CTRL-? CTRL-H
548 not CTRL-? CTRL-?
549
Bram Moolenaar82be4842021-01-11 19:40:15 +0100550 (CTRL-? is 0o177 octal, 0x7f hex)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000551
552 If your delete key terminal code is wrong, but the
553 code for backspace is alright, you can put this in
554 your .vimrc: >
555 :fixdel
556< This works no matter what the actual code for
557 backspace is.
558
559 If the backspace key terminal code is wrong you can
560 use this: >
561 :if &term == "termname"
562 : set t_kb=^V<BS>
563 : fixdel
564 :endif
565< Where "^V" is CTRL-V and "<BS>" is the backspace key
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000566 (don't type four characters!). Replace "termname"
Bram Moolenaar071d4272004-06-13 20:20:40 +0000567 with your terminal name.
568
569 If your <Delete> key sends a strange key sequence (not
570 CTRL-? or CTRL-H) you cannot use ":fixdel". Then use: >
571 :if &term == "termname"
572 : set t_kD=^V<Delete>
573 :endif
574< Where "^V" is CTRL-V and "<Delete>" is the delete key
575 (don't type eight characters!). Replace "termname"
576 with your terminal name.
577
578 *Linux-backspace*
579 Note about Linux: By default the backspace key
580 produces CTRL-?, which is wrong. You can fix it by
581 putting this line in your rc.local: >
582 echo "keycode 14 = BackSpace" | loadkeys
583<
584 *NetBSD-backspace*
585 Note about NetBSD: If your backspace doesn't produce
586 the right code, try this: >
587 xmodmap -e "keycode 22 = BackSpace"
588< If this works, add this in your .Xmodmap file: >
589 keysym 22 = BackSpace
590< You need to restart for this to take effect.
591
592==============================================================================
5932. Automatically setting options *auto-setting*
594
595Besides changing options with the ":set" command, there are three alternatives
596to set options automatically for one or more files:
597
5981. When starting Vim initializations are read from various places. See
599 |initialization|. Most of them are performed for all editing sessions,
600 and some of them depend on the directory where Vim is started.
601 You can create an initialization file with |:mkvimrc|, |:mkview| and
602 |:mksession|.
6032. If you start editing a new file, the automatic commands are executed.
604 This can be used to set options for files matching a particular pattern and
605 many other things. See |autocommand|.
6063. If you start editing a new file, and the 'modeline' option is on, a
607 number of lines at the beginning and end of the file are checked for
608 modelines. This is explained here.
609
610 *modeline* *vim:* *vi:* *ex:* *E520*
611There are two forms of modelines. The first form:
Bram Moolenaar664f3cf2019-12-07 16:03:51 +0100612 [text{white}]{vi:|vim:|ex:}[white]{options}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000613
Bram Moolenaar664f3cf2019-12-07 16:03:51 +0100614[text{white}] empty or any text followed by at least one blank
615 character (<Space> or <Tab>); "ex:" always requires at
616 least one blank character
Bram Moolenaar14b69452013-06-29 23:05:20 +0200617{vi:|vim:|ex:} the string "vi:", "vim:" or "ex:"
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200618[white] optional white space
619{options} a list of option settings, separated with white space
620 or ':', where each part between ':' is the argument
621 for a ":set" command (can be empty)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000622
Bram Moolenaar14b69452013-06-29 23:05:20 +0200623Examples:
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000624 vi:noai:sw=3 ts=6 ~
Bram Moolenaar14b69452013-06-29 23:05:20 +0200625 vim: tw=77 ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000626
627The second form (this is compatible with some versions of Vi):
628
Bram Moolenaarade0d392020-01-21 22:33:58 +0100629 [text{white}]{vi:|vim:|Vim:|ex:}[white]se[t] {options}:[text]
Bram Moolenaar071d4272004-06-13 20:20:40 +0000630
Bram Moolenaarade0d392020-01-21 22:33:58 +0100631[text{white}] empty or any text followed by at least one blank
632 character (<Space> or <Tab>); "ex:" always requires at
633 least one blank character
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200634{vi:|vim:|Vim:|ex:} the string "vi:", "vim:", "Vim:" or "ex:"
635[white] optional white space
Bram Moolenaar14b69452013-06-29 23:05:20 +0200636se[t] the string "set " or "se " (note the space); When
637 "Vim" is used it must be "set".
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200638{options} a list of options, separated with white space, which
639 is the argument for a ":set" command
640: a colon
641[text] any text or empty
Bram Moolenaar071d4272004-06-13 20:20:40 +0000642
Bram Moolenaar14b69452013-06-29 23:05:20 +0200643Examples:
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000644 /* vim: set ai tw=75: */ ~
Bram Moolenaar14b69452013-06-29 23:05:20 +0200645 /* Vim: set ai tw=75: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000646
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200647The white space before {vi:|vim:|Vim:|ex:} is required. This minimizes the
648chance that a normal word like "lex:" is caught. There is one exception:
649"vi:" and "vim:" can also be at the start of the line (for compatibility with
650version 3.0). Using "ex:" at the start of the line will be ignored (this
651could be short for "example:").
Bram Moolenaar071d4272004-06-13 20:20:40 +0000652
Hu Jialun9dcd3492021-08-28 20:42:50 +0200653If the modeline is disabled within a modeline, subsequent modelines will be
654ignored. This is to allow turning off modeline on a per-file basis. This is
655useful when a line looks like a modeline but isn't. For example, it would be
656good to start a YAML file containing strings like "vim:" with
657 # vim: nomodeline ~
658so as to avoid modeline misdetection. Following options on the same line
659after modeline deactivation, if any, are still evaluated (but you would
660normally not have any).
661
Bram Moolenaar071d4272004-06-13 20:20:40 +0000662 *modeline-local*
663The options are set like with ":setlocal": The new value only applies to the
Bram Moolenaar843ee412004-06-30 16:16:41 +0000664buffer and window that contain the file. Although it's possible to set global
665options from a modeline, this is unusual. If you have two windows open and
666the files in it set the same global option to a different value, the result
667depends on which one was opened last.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000668
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +0000669When editing a file that was already loaded, only the window-local options
670from the modeline are used. Thus if you manually changed a buffer-local
671option after opening the file, it won't be changed if you edit the same buffer
672in another window. But window-local options will be set.
673
Bram Moolenaar071d4272004-06-13 20:20:40 +0000674 *modeline-version*
675If the modeline is only to be used for some versions of Vim, the version
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200676number can be specified where "vim:" or "Vim:" is used:
Bram Moolenaar071d4272004-06-13 20:20:40 +0000677 vim{vers}: version {vers} or later
678 vim<{vers}: version before {vers}
679 vim={vers}: version {vers}
680 vim>{vers}: version after {vers}
Bram Moolenaar2b8388b2015-02-28 13:11:45 +0100681{vers} is 700 for Vim 7.0 (hundred times the major version plus minor).
682For example, to use a modeline only for Vim 7.0:
683 /* vim700: set foldmethod=marker */ ~
684To use a modeline for Vim after version 7.2:
685 /* vim>702: set cole=2: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000686There can be no blanks between "vim" and the ":".
687
688
689The number of lines that are checked can be set with the 'modelines' option.
690If 'modeline' is off or 'modelines' is 0 no lines are checked.
691
692Note that for the first form all of the rest of the line is used, thus a line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000693like:
694 /* vi:ts=4: */ ~
695will give an error message for the trailing "*/". This line is OK:
696 /* vi:set ts=4: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000697
698If an error is detected the rest of the line is skipped.
699
700If you want to include a ':' in a set command precede it with a '\'. The
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000701backslash in front of the ':' will be removed. Example:
Bram Moolenaar95a9dd12019-12-19 22:12:03 +0100702 /* vi:set fillchars=stl\:^,vert\:\|: */ ~
703This sets the 'fillchars' option to "stl:^,vert:\|". Only a single backslash
704before the ':' is removed. Thus to include "\:" you have to specify "\\:".
Bram Moolenaar110289e2019-05-23 15:38:06 +0200705 *E992*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000706No other commands than "set" are supported, for security reasons (somebody
Bram Moolenaar8243a792007-05-01 17:05:03 +0000707might create a Trojan horse text file with modelines). And not all options
Bram Moolenaar110289e2019-05-23 15:38:06 +0200708can be set. For some options a flag is set, so that when the value is used
709the |sandbox| is effective. Some options can only be set from the modeline
710when 'modelineexpr' is set (the default is off).
711
712Still, there is always a small risk that a modeline causes trouble. E.g.,
713when some joker sets 'textwidth' to 5 all your lines are wrapped unexpectedly.
714So disable modelines before editing untrusted text. The mail ftplugin does
715this, for example.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000716
717Hint: If you would like to do something else than setting an option, you could
718define an autocommand that checks the file for a specific string. For
719example: >
720 au BufReadPost * if getline(1) =~ "VAR" | call SetVar() | endif
721And define a function SetVar() that does something with the line containing
722"VAR".
723
724==============================================================================
7253. Options summary *option-summary*
726
727In the list below all the options are mentioned with their full name and with
728an abbreviation if there is one. Both forms may be used.
729
730In this document when a boolean option is "set" that means that ":set option"
731is entered. When an option is "reset", ":set nooption" is used.
732
733For some options there are two default values: The "Vim default", which is
734used when 'compatible' is not set, and the "Vi default", which is used when
735'compatible' is set.
736
737Most options are the same in all windows and buffers. There are a few that
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000738are specific to how the text is presented in a window. These can be set to a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000739different value in each window. For example the 'list' option can be set in
740one window and reset in another for the same text, giving both types of view
741at the same time. There are a few options that are specific to a certain
742file. These can have a different value for each file or buffer. For example
743the 'textwidth' option can be 78 for a normal text file and 0 for a C
744program.
745
746 global one option for all buffers and windows
747 local to window each window has its own copy of this option
748 local to buffer each buffer has its own copy of this option
749
750When creating a new window the option values from the currently active window
751are used as a default value for the window-specific options. For the
752buffer-specific options this depends on the 's' and 'S' flags in the
753'cpoptions' option. If 's' is included (which is the default) the values for
754buffer options are copied from the currently active buffer when a buffer is
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000755first entered. If 'S' is present the options are copied each time the buffer
756is entered, this is almost like having global options. If 's' and 'S' are not
Bram Moolenaar071d4272004-06-13 20:20:40 +0000757present, the options are copied from the currently active buffer when the
758buffer is created.
759
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000760Hidden options *hidden-options*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000761
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000762Not all options are supported in all versions. This depends on the supported
763features and sometimes on the system. A remark about this is in curly braces
764below. When an option is not supported it may still be set without getting an
765error, this is called a hidden option. You can't get the value of a hidden
766option though, it is not stored.
767
768To test if option "foo" can be used with ":set" use something like this: >
769 if exists('&foo')
770This also returns true for a hidden option. To test if option "foo" is really
771supported use something like this: >
772 if exists('+foo')
773<
Bram Moolenaar071d4272004-06-13 20:20:40 +0000774 *E355*
775A jump table for the options with a short description can be found at |Q_op|.
776
777 *'aleph'* *'al'* *aleph* *Aleph*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +0100778'aleph' 'al' number (default 128 for MS-Windows, 224 otherwise)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000779 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000780 {only available when compiled with the |+rightleft|
781 feature}
782 The ASCII code for the first letter of the Hebrew alphabet. The
783 routine that maps the keyboard in Hebrew mode, both in Insert mode
784 (when hkmap is set) and on the command-line (when hitting CTRL-_)
785 outputs the Hebrew characters in the range [aleph..aleph+26].
786 aleph=128 applies to PC code, and aleph=224 applies to ISO 8859-8.
787 See |rileft.txt|.
788
789 *'allowrevins'* *'ari'* *'noallowrevins'* *'noari'*
790'allowrevins' 'ari' boolean (default off)
791 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000792 {only available when compiled with the |+rightleft|
793 feature}
794 Allow CTRL-_ in Insert and Command-line mode. This is default off, to
795 avoid that users that accidentally type CTRL-_ instead of SHIFT-_ get
796 into reverse Insert mode, and don't know how to get out. See
797 'revins'.
798 NOTE: This option is reset when 'compatible' is set.
799
800 *'altkeymap'* *'akm'* *'noaltkeymap'* *'noakm'*
801'altkeymap' 'akm' boolean (default off)
802 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000803 {only available when compiled with the |+farsi|
804 feature}
Bram Moolenaar14184a32019-02-16 15:10:30 +0100805 This option was for using Farsi, which has been removed. See
806 |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000807
808 *'ambiwidth'* *'ambw'*
809'ambiwidth' 'ambw' string (default: "single")
810 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000811 Only effective when 'encoding' is "utf-8" or another Unicode encoding.
812 Tells Vim what to do with characters with East Asian Width Class
813 Ambiguous (such as Euro, Registered Sign, Copyright Sign, Greek
814 letters, Cyrillic letters).
815
816 There are currently two possible values:
Bram Moolenaar582fd852005-03-28 20:58:01 +0000817 "single": Use the same width as characters in US-ASCII. This is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000818 expected by most users.
819 "double": Use twice the width of ASCII characters.
Bram Moolenaar5c3bd0a2010-08-04 20:55:44 +0200820 *E834* *E835*
821 The value "double" cannot be used if 'listchars' or 'fillchars'
Bram Moolenaar079ba762021-10-23 12:08:41 +0100822 contains a character that would be double width. These errors may
823 also be given when calling setcellwidths().
Bram Moolenaar08aac3c2020-08-28 21:04:24 +0200824
825 The values are overruled for characters specified with
826 |setcellwidths()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000827
828 There are a number of CJK fonts for which the width of glyphs for
829 those characters are solely based on how many octets they take in
830 legacy/traditional CJK encodings. In those encodings, Euro,
831 Registered sign, Greek/Cyrillic letters are represented by two octets,
Bram Moolenaar582fd852005-03-28 20:58:01 +0000832 therefore those fonts have "wide" glyphs for them. This is also
Bram Moolenaar071d4272004-06-13 20:20:40 +0000833 true of some line drawing characters used to make tables in text
Bram Moolenaar582fd852005-03-28 20:58:01 +0000834 file. Therefore, when a CJK font is used for GUI Vim or
Bram Moolenaar071d4272004-06-13 20:20:40 +0000835 Vim is running inside a terminal (emulators) that uses a CJK font
836 (or Vim is run inside an xterm invoked with "-cjkwidth" option.),
837 this option should be set to "double" to match the width perceived
838 by Vim with the width of glyphs in the font. Perhaps it also has
Bram Moolenaar8024f932020-01-14 19:29:13 +0100839 to be set to "double" under CJK MS-Windows when the system locale is
840 set to one of CJK locales. See Unicode Standard Annex #11
841 (http://www.unicode.org/reports/tr11).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000842
Bram Moolenaarac7bd632013-03-19 11:35:58 +0100843 Vim may set this option automatically at startup time when Vim is
844 compiled with the |+termresponse| feature and if |t_u7| is set to the
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200845 escape sequence to request cursor position report. The response can
846 be found in |v:termu7resp|.
Bram Moolenaarac7bd632013-03-19 11:35:58 +0100847
Bram Moolenaar071d4272004-06-13 20:20:40 +0000848 *'antialias'* *'anti'* *'noantialias'* *'noanti'*
849'antialias' 'anti' boolean (default: off)
850 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000851 {only available when compiled with GUI enabled
Bram Moolenaar3d1cde82020-08-15 18:55:18 +0200852 on macOS}
853 This option only has an effect in the GUI version of Vim on macOS
Bram Moolenaar071d4272004-06-13 20:20:40 +0000854 v10.2 or later. When on, Vim will use smooth ("antialiased") fonts,
855 which can be easier to read at certain sizes on certain displays.
856 Setting this option can sometimes cause problems if 'guifont' is set
857 to its default (empty string).
Bram Moolenaar036986f2017-03-16 17:41:02 +0100858 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000859
Bram Moolenaar071d4272004-06-13 20:20:40 +0000860 *'arabic'* *'arab'* *'noarabic'* *'noarab'*
861'arabic' 'arab' boolean (default off)
862 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +0000863 {only available when compiled with the |+arabic|
864 feature}
865 This option can be set to start editing Arabic text.
866 Setting this option will:
867 - Set the 'rightleft' option, unless 'termbidi' is set.
868 - Set the 'arabicshape' option, unless 'termbidi' is set.
869 - Set the 'keymap' option to "arabic"; in Insert mode CTRL-^ toggles
870 between typing English and Arabic key mapping.
871 - Set the 'delcombine' option
872 Note that 'encoding' must be "utf-8" for working with Arabic text.
873
874 Resetting this option will:
875 - Reset the 'rightleft' option.
876 - Disable the use of 'keymap' (without changing its value).
877 Note that 'arabicshape' and 'delcombine' are not reset (it is a global
Bram Moolenaarc8734422012-06-01 22:38:45 +0200878 option).
Bram Moolenaar036986f2017-03-16 17:41:02 +0100879 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000880 Also see |arabic.txt|.
881
882 *'arabicshape'* *'arshape'*
883 *'noarabicshape'* *'noarshape'*
884'arabicshape' 'arshape' boolean (default on)
885 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000886 {only available when compiled with the |+arabic|
887 feature}
888 When on and 'termbidi' is off, the required visual character
889 corrections that need to take place for displaying the Arabic language
Bram Moolenaar3a0d8092012-10-21 03:02:54 +0200890 take effect. Shaping, in essence, gets enabled; the term is a broad
Bram Moolenaar071d4272004-06-13 20:20:40 +0000891 one which encompasses:
892 a) the changing/morphing of characters based on their location
893 within a word (initial, medial, final and stand-alone).
894 b) the enabling of the ability to compose characters
895 c) the enabling of the required combining of some characters
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100896 When disabled the display shows each character's true stand-alone
897 form.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000898 Arabic is a complex language which requires other settings, for
899 further details see |arabic.txt|.
Bram Moolenaar036986f2017-03-16 17:41:02 +0100900 NOTE: This option is set when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000901
laburnumT3f7855a2023-12-05 18:37:03 +0100902 *'autochdir'* *'acd'* *'noautochdir'* *'noacd'*
903'autochdir' 'acd' boolean (default off)
904 global
905 {only available when compiled with it, use
906 exists("+autochdir") to check}
907 When on, Vim will change the current working directory whenever you
908 open a file, switch buffers, delete a buffer or open/close a window.
909 It will change to the directory containing the file which was opened
910 or selected. When a buffer has no name it also has no directory, thus
911 the current directory won't change when navigating to it.
912 Note: When this option is on some plugins may not work.
913
Bram Moolenaar071d4272004-06-13 20:20:40 +0000914 *'autoindent'* *'ai'* *'noautoindent'* *'noai'*
915'autoindent' 'ai' boolean (default off)
916 local to buffer
917 Copy indent from current line when starting a new line (typing <CR>
918 in Insert mode or when using the "o" or "O" command). If you do not
919 type anything on the new line except <BS> or CTRL-D and then type
Bram Moolenaar02467872007-05-06 13:22:01 +0000920 <Esc>, CTRL-O or <CR>, the indent is deleted again. Moving the cursor
921 to another line has the same effect, unless the 'I' flag is included
922 in 'cpoptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000923 When autoindent is on, formatting (with the "gq" command or when you
924 reach 'textwidth' in Insert mode) uses the indentation of the first
925 line.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000926 When 'smartindent' or 'cindent' is on the indent is changed in
927 a different way.
Bram Moolenaarca635012015-09-25 20:34:21 +0200928 The 'autoindent' option is reset when the 'paste' option is set and
929 restored when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000930
931 *'autoread'* *'ar'* *'noautoread'* *'noar'*
932'autoread' 'ar' boolean (default off)
933 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000934 When a file has been detected to have been changed outside of Vim and
935 it has not been changed inside of Vim, automatically read it again.
Bram Moolenaarfd358112018-07-07 23:21:31 +0200936 When the file has been deleted this is not done, so you have the text
937 from before it was deleted. When it appears again then it is read.
938 |timestamp|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000939 If this option has a local value, use this command to switch back to
940 using the global value: >
941 :set autoread<
942<
laburnumT3f7855a2023-12-05 18:37:03 +0100943
944 *'autoshelldir'* *'asd'* *'noautoshelldir'* *'noasd'*
945'autoshelldir' 'asd' boolean (default off)
946 global
947 When on, Vim will change the current working directory whenever you
948 change the directory of the shell running in a terminal window. You
949 need proper setting-up, so whenever the shell's pwd changes an OSC 7
950 escape sequence will be emitted. For example, on Linux, you can
951 source /etc/profile.d/vte.sh in your shell profile if you use bash or
952 zsh. For bash this should work (put it in a bash init file): >
953 if [[ -n "$VIM_TERMINAL" ]]; then
954 PROMPT_COMMAND='_vim_sync_PWD'
955 function _vim_sync_PWD() {
956 printf '\033]7;file://%s\033\\' "$PWD"
957 }
958 fi
959<
960 Or, in a zsh init file: >
961 if [[ -n "$VIM_TERMINAL" ]]; then
962 autoload -Uz add-zsh-hook
963 add-zsh-hook -Uz chpwd _vim_sync_PWD
964 function _vim_sync_PWD() {
965 printf '\033]7;file://%s\033\\' "$PWD"
966 }
967 fi
968<
969 In a fish init file: >
970 if test -n "$VIM_TERMINAL"
971 function _vim_sync_PWD --on-variable=PWD
972 printf '\033]7;file://%s\033\\' "$PWD"
973 end
974 end
975<
976 You can find an alternative method at |terminal-autoshelldir|.
977 When the parsing of the OSC sequence fails you get *E1179* .
978
Bram Moolenaar071d4272004-06-13 20:20:40 +0000979 *'autowrite'* *'aw'* *'noautowrite'* *'noaw'*
980'autowrite' 'aw' boolean (default off)
981 global
982 Write the contents of the file, if it has been modified, on each
Bram Moolenaar47003982021-12-05 21:54:04 +0000983 `:next`, `:rewind`, `:last`, `:first`, `:previous`, `:stop`,
Bram Moolenaar2f0936c2022-01-08 21:51:59 +0000984 `:suspend`, `:tag`, `:!`, `:make`, CTRL-] and CTRL-^ command; and when
985 a `:buffer`, CTRL-O, CTRL-I, '{A-Z0-9}, or `{A-Z0-9} command takes one
Bram Moolenaar47003982021-12-05 21:54:04 +0000986 to another file.
987 A buffer is not written if it becomes hidden, e.g. when 'bufhidden' is
Bram Moolenaar2f0936c2022-01-08 21:51:59 +0000988 set to "hide" and `:next` is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000989 Note that for some commands the 'autowrite' option is not used, see
990 'autowriteall' for that.
Bram Moolenaar93a1df22018-09-10 11:51:50 +0200991 Some buffers will not be written, specifically when 'buftype' is
Bram Moolenaar20aac6c2018-09-02 21:07:30 +0200992 "nowrite", "nofile", "terminal" or "prompt".
Bram Moolenaarb7398fe2023-05-14 18:50:25 +0100993 USE WITH CARE: If you make temporary changes to a buffer that you
994 don't want to be saved this option may cause it to be saved anyway.
995 Renaming the buffer with ":file {name}" may help avoid this.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000996
997 *'autowriteall'* *'awa'* *'noautowriteall'* *'noawa'*
998'autowriteall' 'awa' boolean (default off)
999 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001000 Like 'autowrite', but also used for commands ":edit", ":enew", ":quit",
1001 ":qall", ":exit", ":xit", ":recover" and closing the Vim window.
1002 Setting this option also implies that Vim behaves like 'autowrite' has
1003 been set.
1004
1005 *'background'* *'bg'*
Bram Moolenaar446beb42011-05-10 17:18:44 +02001006'background' 'bg' string (default "dark" or "light", see below)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001007 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001008 When set to "dark", Vim will try to use colors that look good on a
1009 dark background. When set to "light", Vim will try to use colors that
1010 look good on a light background. Any other value is illegal.
1011 Vim tries to set the default value according to the terminal used.
1012 This will not always be correct.
1013 Setting this option does not change the background color, it tells Vim
1014 what the background color looks like. For changing the background
1015 color, see |:hi-normal|.
1016
Gregory Anders83ad2722024-01-03 19:48:51 +01001017 When 'background' is changed Vim will adjust the default color groups
1018 for the new value. But the colors used for syntax highlighting will
1019 not change. *g:colors_name*
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001020 When a color scheme is loaded (the "g:colors_name" variable is set)
Gregory Anders83ad2722024-01-03 19:48:51 +01001021 changing 'background' will cause the color scheme to be reloaded. If
Bram Moolenaar071d4272004-06-13 20:20:40 +00001022 the color scheme adjusts to the value of 'background' this will work.
1023 However, if the color scheme sets 'background' itself the effect may
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001024 be undone. First delete the "g:colors_name" variable when needed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001025
1026 When setting 'background' to the default value with: >
1027 :set background&
1028< Vim will guess the value. In the GUI this should work correctly,
1029 in other cases Vim might not be able to guess the right value.
Bram Moolenaar2e693a82019-10-16 22:35:02 +02001030 If the GUI supports a dark theme, you can use the "d" flag in
Bram Moolenaar50bf7ce2019-09-15 13:17:00 +02001031 'guioptions', see 'go-d'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001032
Bram Moolenaar37c64c72017-09-19 22:06:03 +02001033 When the |t_RB| option is set, Vim will use it to request the background
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +02001034 color from the terminal. If the returned RGB value is dark/light and
1035 'background' is not dark/light, 'background' will be set and the
Jon Parise71028a32025-01-20 20:19:18 +01001036 screen is redrawn. This may have side effects, make |t_RB| empty in
Bram Moolenaar37c64c72017-09-19 22:06:03 +02001037 your .vimrc if you suspect this problem. The response to |t_RB| can
Bram Moolenaar01164a62017-11-02 22:58:42 +01001038 be found in |v:termrbgresp|.
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +02001039
Bram Moolenaar071d4272004-06-13 20:20:40 +00001040 When starting the GUI, the default value for 'background' will be
1041 "light". When the value is not set in the .gvimrc, and Vim detects
1042 that the background is actually quite dark, 'background' is set to
1043 "dark". But this happens only AFTER the .gvimrc file has been read
1044 (because the window needs to be opened to find the actual background
1045 color). To get around this, force the GUI window to be opened by
1046 putting a ":gui" command in the .gvimrc file, before where the value
1047 of 'background' is used (e.g., before ":syntax on").
Bram Moolenaar446beb42011-05-10 17:18:44 +02001048
Bram Moolenaar6f345a12019-12-17 21:27:18 +01001049 For MS-Windows the default is "dark".
Bram Moolenaar446beb42011-05-10 17:18:44 +02001050 For other systems "dark" is used when 'term' is "linux",
1051 "screen.linux", "cygwin" or "putty", or $COLORFGBG suggests a dark
1052 background. Otherwise the default is "light".
1053
Bram Moolenaarc572da52017-08-27 16:52:01 +02001054 The |:terminal| command and the |term_start()| function use the
1055 'background' value to decide whether the terminal window will start
1056 with a white or black background.
1057
Bram Moolenaar071d4272004-06-13 20:20:40 +00001058 Normally this option would be set in the .vimrc file. Possibly
1059 depending on the terminal name. Example: >
1060 :if &term == "pcterm"
1061 : set background=dark
1062 :endif
1063< When this option is set, the default settings for the highlight groups
1064 will change. To use other settings, place ":highlight" commands AFTER
1065 the setting of the 'background' option.
1066 This option is also used in the "$VIMRUNTIME/syntax/syntax.vim" file
1067 to select the colors for syntax highlighting. After changing this
1068 option, you must load syntax.vim again to see the result. This can be
1069 done with ":syntax on".
1070
1071 *'backspace'* *'bs'*
h-eastb534e802024-12-03 20:37:52 +01001072'backspace' 'bs' string (Vim default: "indent,eol,start",
1073 Vi default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001074 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001075 Influences the working of <BS>, <Del>, CTRL-W and CTRL-U in Insert
1076 mode. This is a list of items, separated by commas. Each item allows
1077 a way to backspace over something:
1078 value effect ~
1079 indent allow backspacing over autoindent
1080 eol allow backspacing over line breaks (join lines)
1081 start allow backspacing over the start of insert; CTRL-W and CTRL-U
1082 stop once at the start of insert.
Bram Moolenaaraa0489e2020-04-17 19:41:21 +02001083 nostop like start, except CTRL-W and CTRL-U do not stop at the start of
1084 insert.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001085
Bram Moolenaar46eea442022-03-30 10:51:39 +01001086 When the value is empty, Vi compatible backspacing is used, none of
1087 the ways mentioned for the items above are possible.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001088
1089 For backwards compatibility with version 5.4 and earlier:
1090 value effect ~
1091 0 same as ":set backspace=" (Vi compatible)
1092 1 same as ":set backspace=indent,eol"
1093 2 same as ":set backspace=indent,eol,start"
Bram Moolenaaraa0489e2020-04-17 19:41:21 +02001094 3 same as ":set backspace=indent,eol,nostop"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001095
1096 See |:fixdel| if your <BS> or <Del> key does not do what you want.
1097 NOTE: This option is set to "" when 'compatible' is set.
1098
1099 *'backup'* *'bk'* *'nobackup'* *'nobk'*
1100'backup' 'bk' boolean (default off)
1101 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001102 Make a backup before overwriting a file. Leave it around after the
1103 file has been successfully written. If you do not want to keep the
1104 backup file, but you do want a backup while the file is being
1105 written, reset this option and set the 'writebackup' option (this is
1106 the default). If you do not want a backup file at all reset both
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001107 options (use this if your file system is almost full). See the
Bram Moolenaar071d4272004-06-13 20:20:40 +00001108 |backup-table| for more explanations.
1109 When the 'backupskip' pattern matches, a backup is not made anyway.
1110 When 'patchmode' is set, the backup may be renamed to become the
1111 oldest version of a file.
1112 NOTE: This option is reset when 'compatible' is set.
1113
1114 *'backupcopy'* *'bkc'*
1115'backupcopy' 'bkc' string (Vi default for Unix: "yes", otherwise: "auto")
Bram Moolenaarb8ee25a2014-09-23 15:45:08 +02001116 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001117 When writing a file and a backup is made, this option tells how it's
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001118 done. This is a comma-separated list of words.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001119
1120 The main values are:
1121 "yes" make a copy of the file and overwrite the original one
1122 "no" rename the file and write a new one
1123 "auto" one of the previous, what works best
1124
1125 Extra values that can be combined with the ones above are:
1126 "breaksymlink" always break symlinks when writing
1127 "breakhardlink" always break hardlinks when writing
1128
1129 Making a copy and overwriting the original file:
1130 - Takes extra time to copy the file.
1131 + When the file has special attributes, is a (hard/symbolic) link or
1132 has a resource fork, all this is preserved.
1133 - When the file is a link the backup will have the name of the link,
1134 not of the real file.
1135
1136 Renaming the file and writing a new one:
1137 + It's fast.
1138 - Sometimes not all attributes of the file can be copied to the new
1139 file.
1140 - When the file is a link the new file will not be a link.
1141
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001142 The "auto" value is the middle way: When Vim sees that renaming the
1143 file is possible without side effects (the attributes can be passed on
1144 and the file is not a link) that is used. When problems are expected,
1145 a copy will be made.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001146
1147 The "breaksymlink" and "breakhardlink" values can be used in
1148 combination with any of "yes", "no" and "auto". When included, they
1149 force Vim to always break either symbolic or hard links by doing
1150 exactly what the "no" option does, renaming the original file to
1151 become the backup and writing a new file in its place. This can be
1152 useful for example in source trees where all the files are symbolic or
1153 hard links and any changes should stay in the local source tree, not
1154 be propagated back to the original source.
Christian Brabandt5bcfb5a2024-10-14 22:08:22 +02001155 *crontab*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001156 One situation where "no" and "auto" will cause problems: A program
1157 that opens a file, invokes Vim to edit that file, and then tests if
1158 the open file was changed (through the file descriptor) will check the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001159 backup file instead of the newly created file. "crontab -e" is an
Christian Brabandt5bcfb5a2024-10-14 22:08:22 +02001160 example, as are several |file-watcher| daemons like inotify. In that
1161 case you probably want to switch this option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001162
1163 When a copy is made, the original file is truncated and then filled
1164 with the new text. This means that protection bits, owner and
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001165 symbolic links of the original file are unmodified. The backup file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001166 however, is a new file, owned by the user who edited the file. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00001167 group of the backup is set to the group of the original file. If this
1168 fails, the protection bits for the group are made the same as for
1169 others.
1170
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001171 When the file is renamed, this is the other way around: The backup has
Bram Moolenaar071d4272004-06-13 20:20:40 +00001172 the same attributes of the original file, and the newly written file
1173 is owned by the current user. When the file was a (hard/symbolic)
1174 link, the new file will not! That's why the "auto" value doesn't
1175 rename when the file is a link. The owner and group of the newly
1176 written file will be set to the same ones as the original file, but
1177 the system may refuse to do this. In that case the "auto" value will
1178 again not rename the file.
1179
Bram Moolenaar036986f2017-03-16 17:41:02 +01001180 NOTE: This option is set to the Vi default value when 'compatible' is
1181 set and to the Vim default value when 'compatible' is reset.
1182
Bram Moolenaar071d4272004-06-13 20:20:40 +00001183 *'backupdir'* *'bdir'*
1184'backupdir' 'bdir' string (default for Amiga: ".,t:",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01001185 for Win32: ".,$TEMP,c:/tmp,c:/temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001186 for Unix: ".,~/tmp,~/")
1187 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001188 List of directories for the backup file, separated with commas.
1189 - The backup file will be created in the first directory in the list
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001190 where this is possible. The directory must exist, Vim will not
1191 create it for you.
Bram Moolenaar3848e002016-03-19 18:42:29 +01001192 - Empty means that no backup file will be created ('patchmode' is
Bram Moolenaar071d4272004-06-13 20:20:40 +00001193 impossible!). Writing may fail because of this.
1194 - A directory "." means to put the backup file in the same directory
1195 as the edited file.
Bram Moolenaar8024f932020-01-14 19:29:13 +01001196 - A directory starting with "./" (or ".\" for MS-Windows) means to put
1197 the backup file relative to where the edited file is. The leading
1198 "." is replaced with the path name of the edited file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001199 ("." inside a directory name has no special meaning).
1200 - Spaces after the comma are ignored, other spaces are considered part
1201 of the directory name. To have a space at the start of a directory
1202 name, precede it with a backslash.
1203 - To include a comma in a directory name precede it with a backslash.
1204 - A directory name may end in an '/'.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02001205 - For Unix and Win32, if a directory ends in two path separators "//",
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01001206 the backup file name will be built from the complete path to the
1207 file with all path separators changed to percent '%' signs. This
1208 will ensure file name uniqueness in the backup directory.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02001209 On Win32, it is also possible to end with "\\". However, When a
1210 separating comma is following, you must use "//", since "\\" will
1211 include the comma in the file name. Therefore it is recommended to
1212 use '//', instead of '\\'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001213 - Environment variables are expanded |:set_env|.
1214 - Careful with '\' characters, type one before a space, type two to
1215 get one in the option (see |option-backslash|), for example: >
1216 :set bdir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
1217< - For backwards compatibility with Vim version 3.0 a '>' at the start
1218 of the option is removed.
1219 See also 'backup' and 'writebackup' options.
1220 If you want to hide your backup files on Unix, consider this value: >
1221 :set backupdir=./.backup,~/.backup,.,/tmp
1222< You must create a ".backup" directory in each directory and in your
1223 home directory for this to work properly.
1224 The use of |:set+=| and |:set-=| is preferred when adding or removing
1225 directories from the list. This avoids problems when a future version
1226 uses another default.
1227 This option cannot be set from a |modeline| or in the |sandbox|, for
1228 security reasons.
1229
1230 *'backupext'* *'bex'* *E589*
1231'backupext' 'bex' string (default "~", for VMS: "_")
1232 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001233 String which is appended to a file name to make the name of the
1234 backup file. The default is quite unusual, because this avoids
1235 accidentally overwriting existing files with a backup file. You might
1236 prefer using ".bak", but make sure that you don't have files with
1237 ".bak" that you want to keep.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001238 Only normal file name characters can be used; "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001239
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001240 If you like to keep a lot of backups, you could use a BufWritePre
1241 autocommand to change 'backupext' just before writing the file to
1242 include a timestamp. >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00001243 :au BufWritePre * let &bex = '-' .. strftime("%Y%b%d%X") .. '~'
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001244< Use 'backupdir' to put the backup in a different directory.
1245
Bram Moolenaar071d4272004-06-13 20:20:40 +00001246 *'backupskip'* *'bsk'*
Bram Moolenaarb8e22a02018-04-12 21:37:34 +02001247'backupskip' 'bsk' string (default: "$TMPDIR/*,$TMP/*,$TEMP/*"
1248 Unix: "/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*"
1249 Mac: "/private/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001250 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001251 A list of file patterns. When one of the patterns matches with the
1252 name of the file which is written, no backup file is created. Both
1253 the specified file name and the full path name of the file are used.
1254 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
1255 Watch out for special characters, see |option-backslash|.
1256 When $TMPDIR, $TMP or $TEMP is not defined, it is not used for the
Bram Moolenaar582fd852005-03-28 20:58:01 +00001257 default value. "/tmp/*" is only used for Unix.
Bram Moolenaar02467872007-05-06 13:22:01 +00001258
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02001259 WARNING: Not having a backup file means that when Vim fails to write
1260 your buffer correctly and then, for whatever reason, Vim exits, you
1261 lose both the original file and what you were writing. Only disable
1262 backups if you don't care about losing the file.
1263
Bram Moolenaar02467872007-05-06 13:22:01 +00001264 Note that environment variables are not expanded. If you want to use
1265 $HOME you must expand it explicitly, e.g.: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00001266 :let &backupskip = escape(expand('$HOME'), '\') .. '/tmp/*'
Bram Moolenaar02467872007-05-06 13:22:01 +00001267
1268< Note that the default also makes sure that "crontab -e" works (when a
Bram Moolenaara5792f52005-11-23 21:25:05 +00001269 backup would be made by renaming the original file crontab won't see
1270 the newly created file). Also see 'backupcopy' and |crontab|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001271
1272 *'balloondelay'* *'bdlay'*
1273'balloondelay' 'bdlay' number (default: 600)
1274 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001275 {only available when compiled with the |+balloon_eval|
1276 feature}
1277 Delay in milliseconds before a balloon may pop up. See |balloon-eval|.
1278
1279 *'ballooneval'* *'beval'* *'noballooneval'* *'nobeval'*
1280'ballooneval' 'beval' boolean (default off)
1281 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001282 {only available when compiled with the |+balloon_eval|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001283 feature}
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001284 Switch on the |balloon-eval| functionality for the GUI.
1285
1286 *'balloonevalterm'* *'bevalterm'* *'noballoonevalterm'*
1287 *'nobevalterm'*
1288'balloonevalterm' 'bevalterm' boolean (default off)
1289 global
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001290 {only available when compiled with the
1291 |+balloon_eval_term| feature}
1292 Switch on the |balloon-eval| functionality for the terminal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001293
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001294 *'balloonexpr'* *'bexpr'*
1295'balloonexpr' 'bexpr' string (default "")
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00001296 global or local to buffer |global-local|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001297 {only available when compiled with the |+balloon_eval|
1298 feature}
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00001299 Expression for text to show in evaluation balloon. It is only used
Bram Moolenaara6c27c42019-05-09 19:16:22 +02001300 when 'ballooneval' or 'balloonevalterm' is on. These variables can be
1301 used:
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001302
1303 v:beval_bufnr number of the buffer in which balloon is going to show
1304 v:beval_winnr number of the window
Bram Moolenaar82af8712016-06-04 20:20:29 +02001305 v:beval_winid ID of the window
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001306 v:beval_lnum line number
1307 v:beval_col column number (byte index)
1308 v:beval_text word under or after the mouse pointer
1309
Bram Moolenaar54775062019-07-31 21:07:14 +02001310 Instead of showing a balloon, which is limited to plain text, consider
1311 using a popup window, see |popup_beval_example|. A popup window can
1312 use highlighting and show a border.
1313
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001314 The evaluation of the expression must not have side effects!
1315 Example: >
Bram Moolenaara6c27c42019-05-09 19:16:22 +02001316 function MyBalloonExpr()
Bram Moolenaarc51cf032022-02-26 12:25:45 +00001317 return 'Cursor is at line ' .. v:beval_lnum ..
1318 \ ', column ' .. v:beval_col ..
1319 \ ' of file ' .. bufname(v:beval_bufnr) ..
1320 \ ' on word "' .. v:beval_text .. '"'
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001321 endfunction
1322 set bexpr=MyBalloonExpr()
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00001323 set ballooneval balloonevalterm
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001324<
Bram Moolenaar396e8292019-07-13 23:04:31 +02001325 Also see |balloon_show()|, it can be used if the content of the balloon
1326 is to be fetched asynchronously. In that case evaluating
1327 'balloonexpr' should result in an empty string. If you get a balloon
1328 with only "0" you probably didn't return anything from your function.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001329
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001330 NOTE: The balloon is displayed only if the cursor is on a text
1331 character. If the result of evaluating 'balloonexpr' is not empty,
1332 Vim does not try to send a message to an external debugger (Netbeans
1333 or Sun Workshop).
1334
Yegappan Lakshmanan8bb65f22021-12-26 10:51:39 +00001335 If the expression starts with s: or |<SID>|, then it is replaced with
1336 the script ID (|local-function|). Example: >
1337 set bexpr=s:MyBalloonExpr()
1338 set bexpr=<SID>SomeBalloonExpr()
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00001339< Otherwise, the expression is evaluated in the context of the script
1340 where the option was set, thus script-local items are available.
1341
Bram Moolenaar30b65812012-07-12 22:01:11 +02001342 The expression will be evaluated in the |sandbox| when set from a
1343 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02001344 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001345
1346 It is not allowed to change text or jump to another window while
Bram Moolenaar396e8292019-07-13 23:04:31 +02001347 evaluating 'balloonexpr', see |textlock|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001348
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001349 To check whether line breaks in the balloon text work use this check: >
Bram Moolenaar45360022005-07-21 21:08:21 +00001350 if has("balloon_multiline")
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001351< When they are supported "\n" characters will start a new line. If the
1352 expression evaluates to a |List| this is equal to using each List item
1353 as a string and putting "\n" in between them.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001354 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001355
Bram Moolenaar165bc692015-07-21 17:53:25 +02001356 *'belloff'* *'bo'*
1357'belloff' 'bo' string (default "")
1358 global
Bram Moolenaar165bc692015-07-21 17:53:25 +02001359 Specifies for which events the bell will not be rung. It is a comma
1360 separated list of items. For each item that is present, the bell
1361 will be silenced. This is most useful to specify specific events in
1362 insert mode to be silenced.
LemonBoy77771d32022-04-13 11:47:25 +01001363 You can also make it flash by using 'visualbell'.
Bram Moolenaar165bc692015-07-21 17:53:25 +02001364
1365 item meaning when present ~
1366 all All events.
1367 backspace When hitting <BS> or <Del> and deleting results in an
1368 error.
1369 cursor Fail to move around using the cursor keys or
1370 <PageUp>/<PageDown> in |Insert-mode|.
1371 complete Error occurred when using |i_CTRL-X_CTRL-K| or
1372 |i_CTRL-X_CTRL-T|.
1373 copy Cannot copy char from insert mode using |i_CTRL-Y| or
1374 |i_CTRL-E|.
1375 ctrlg Unknown Char after <C-G> in Insert mode.
1376 error Other Error occurred (e.g. try to join last line)
1377 (mostly used in |Normal-mode| or |Cmdline-mode|).
1378 esc hitting <Esc> in |Normal-mode|.
1379 ex In |Visual-mode|, hitting |Q| results in an error.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01001380 hangul Ignored.
Bram Moolenaar165bc692015-07-21 17:53:25 +02001381 insertmode Pressing <Esc> in 'insertmode'.
1382 lang Calling the beep module for Lua/Mzscheme/TCL.
1383 mess No output available for |g<|.
1384 showmatch Error occurred for 'showmatch' function.
1385 operator Empty region error |cpo-E|.
1386 register Unknown register after <C-R> in |Insert-mode|.
1387 shell Bell from shell output |:!|.
1388 spell Error happened on spell suggest.
LemonBoy77771d32022-04-13 11:47:25 +01001389 term Bell from |:terminal| output.
Bram Moolenaar165bc692015-07-21 17:53:25 +02001390 wildmode More matches in |cmdline-completion| available
1391 (depends on the 'wildmode' setting).
1392
Bram Moolenaar036986f2017-03-16 17:41:02 +01001393 This is most useful to fine tune when in Insert mode the bell should
1394 be rung. For Normal mode and Ex commands, the bell is often rung to
Bram Moolenaar165bc692015-07-21 17:53:25 +02001395 indicate that an error occurred. It can be silenced by adding the
1396 "error" keyword.
1397
Bram Moolenaar071d4272004-06-13 20:20:40 +00001398 *'binary'* *'bin'* *'nobinary'* *'nobin'*
1399'binary' 'bin' boolean (default off)
1400 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001401 This option should be set before editing a binary file. You can also
1402 use the |-b| Vim argument. When this option is switched on a few
1403 options will be changed (also when it already was on):
1404 'textwidth' will be set to 0
1405 'wrapmargin' will be set to 0
1406 'modeline' will be off
1407 'expandtab' will be off
1408 Also, 'fileformat' and 'fileformats' options will not be used, the
1409 file is read and written like 'fileformat' was "unix" (a single <NL>
1410 separates lines).
1411 The 'fileencoding' and 'fileencodings' options will not be used, the
1412 file is read without conversion.
1413 NOTE: When you start editing a(nother) file while the 'bin' option is
1414 on, settings from autocommands may change the settings again (e.g.,
1415 'textwidth'), causing trouble when editing. You might want to set
1416 'bin' again when the file has been loaded.
1417 The previous values of these options are remembered and restored when
1418 'bin' is switched from on to off. Each buffer has its own set of
1419 saved option values.
1420 To edit a file with 'binary' set you can use the |++bin| argument.
1421 This avoids you have to do ":set bin", which would have effect for all
1422 files you edit.
1423 When writing a file the <EOL> for the last line is only written if
1424 there was one in the original file (normally Vim appends an <EOL> to
1425 the last line if there is none; this would make the file longer). See
1426 the 'endofline' option.
1427
1428 *'bioskey'* *'biosk'* *'nobioskey'* *'nobiosk'*
1429'bioskey' 'biosk' boolean (default on)
1430 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02001431 {only for MS-DOS}
Bram Moolenaarf3913272016-02-25 00:00:01 +01001432 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001433
1434 *'bomb'* *'nobomb'*
1435'bomb' boolean (default off)
1436 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001437 When writing a file and the following conditions are met, a BOM (Byte
1438 Order Mark) is prepended to the file:
1439 - this option is on
1440 - the 'binary' option is off
1441 - 'fileencoding' is "utf-8", "ucs-2", "ucs-4" or one of the little/big
1442 endian variants.
1443 Some applications use the BOM to recognize the encoding of the file.
1444 Often used for UCS-2 files on MS-Windows. For other applications it
1445 causes trouble, for example: "cat file1 file2" makes the BOM of file2
njohnstonaabca252023-11-19 23:18:57 +00001446 appear halfway through the resulting file. Gcc doesn't accept a BOM.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001447 When Vim reads a file and 'fileencodings' starts with "ucs-bom", a
1448 check for the presence of the BOM is done and 'bomb' set accordingly.
1449 Unless 'binary' is set, it is removed from the first line, so that you
1450 don't see it when editing. When you don't change the options, the BOM
1451 will be restored when writing the file.
1452
1453 *'breakat'* *'brk'*
1454'breakat' 'brk' string (default " ^I!@*-+;:,./?")
1455 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02001456 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001457 feature}
1458 This option lets you choose which characters might cause a line
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00001459 break if 'linebreak' is on. Only works for ASCII and also for 8-bit
1460 characters when 'encoding' is an 8-bit encoding.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001461
Bram Moolenaar7c1c6db2016-04-03 22:08:05 +02001462 *'breakindent'* *'bri'* *'nobreakindent'* *'nobri'*
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001463'breakindent' 'bri' boolean (default off)
1464 local to window
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001465 {not available when compiled without the |+linebreak|
1466 feature}
1467 Every wrapped line will continue visually indented (same amount of
1468 space as the beginning of that line), thus preserving horizontal blocks
1469 of text.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001470 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001471
1472 *'breakindentopt'* *'briopt'*
1473'breakindentopt' 'briopt' string (default empty)
1474 local to window
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001475 {not available when compiled without the |+linebreak|
1476 feature}
1477 Settings for 'breakindent'. It can consist of the following optional
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001478 items and must be separated by a comma:
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001479 min:{n} Minimum text width that will be kept after
1480 applying 'breakindent', even if the resulting
1481 text should normally be narrower. This prevents
1482 text indented almost to the right window border
Dominique Pellédf62c622024-07-15 20:29:59 +02001483 occupying lots of vertical space when broken.
Christian Brabandtc53b4672022-01-15 10:01:05 +00001484 (default: 20)
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001485 shift:{n} After applying 'breakindent', the wrapped line's
1486 beginning will be shifted by the given number of
1487 characters. It permits dynamic French paragraph
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001488 indentation (negative) or emphasizing the line
1489 continuation (positive).
Christian Brabandte7d6dbc2022-05-06 12:21:04 +01001490 (default: 0)
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01001491 sbr Display the 'showbreak' value before applying the
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001492 additional indent.
Christian Brabandte7d6dbc2022-05-06 12:21:04 +01001493 (default: off)
Maxim Kimf674b352021-07-22 11:46:59 +02001494 list:{n} Adds an additional indent for lines that match a
Christian Brabandt4a0b85a2021-07-14 20:00:27 +02001495 numbered or bulleted list (using the
1496 'formatlistpat' setting).
Christian Brabandte7d6dbc2022-05-06 12:21:04 +01001497 (default: 0)
zeertzjq61a6ac42024-09-07 11:23:54 +02001498 list:-1 Uses the width of a match with 'formatlistpat' for
1499 indentation.
Christian Brabandte7d6dbc2022-05-06 12:21:04 +01001500 column:{n} Indent at column {n}. Will overrule the other
1501 sub-options. Note: an additional indent may be
1502 added for the 'showbreak' setting.
1503 (default: off)
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001504
Bram Moolenaar071d4272004-06-13 20:20:40 +00001505 *'browsedir'* *'bsdir'*
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001506'browsedir' 'bsdir' string (default: "last")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001507 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001508 {only for Motif, GTK, Mac and Win32 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001509 Which directory to use for the file browser:
Bram Moolenaar446cb832008-06-24 21:56:24 +00001510 last Use same directory as with last file browser, where a
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02001511 file was opened or saved.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001512 buffer Use the directory of the related buffer.
1513 current Use the current directory.
1514 {path} Use the specified directory
1515
1516 *'bufhidden'* *'bh'*
1517'bufhidden' 'bh' string (default: "")
Christian Brabandt596ad662023-08-16 00:11:09 +02001518 local to buffer |local-noglobal|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001519 This option specifies what happens when a buffer is no longer
1520 displayed in a window:
1521 <empty> follow the global 'hidden' option
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001522 hide hide the buffer (don't unload it), even if 'hidden' is
1523 not set
1524 unload unload the buffer, even if 'hidden' is set; the
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01001525 |:hide| command will also unload the buffer
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001526 delete delete the buffer from the buffer list, even if
1527 'hidden' is set; the |:hide| command will also delete
1528 the buffer, making it behave like |:bdelete|
1529 wipe wipe the buffer from the buffer list, even if
1530 'hidden' is set; the |:hide| command will also wipe
1531 out the buffer, making it behave like |:bwipeout|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001532
Bram Moolenaara14de3d2005-01-07 21:48:26 +00001533 CAREFUL: when "unload", "delete" or "wipe" is used changes in a buffer
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01001534 are lost without a warning. Also, these values may break autocommands
1535 that switch between buffers temporarily.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001536 This option is used together with 'buftype' and 'swapfile' to specify
1537 special kinds of buffers. See |special-buffers|.
1538
1539 *'buflisted'* *'bl'* *'nobuflisted'* *'nobl'* *E85*
1540'buflisted' 'bl' boolean (default: on)
1541 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001542 When this option is set, the buffer shows up in the buffer list. If
1543 it is reset it is not used for ":bnext", "ls", the Buffers menu, etc.
1544 This option is reset by Vim for buffers that are only used to remember
1545 a file name or marks. Vim sets it when starting to edit a buffer.
1546 But not when moving to a buffer with ":buffer".
1547
1548 *'buftype'* *'bt'* *E382*
1549'buftype' 'bt' string (default: "")
Christian Brabandt596ad662023-08-16 00:11:09 +02001550 local to buffer |local-noglobal|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001551 The value of this option specifies the type of a buffer:
1552 <empty> normal buffer
1553 nofile buffer which is not related to a file and will not be
1554 written
1555 nowrite buffer which will not be written
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001556 acwrite buffer which will always be written with BufWriteCmd
Bram Moolenaarb5b75622018-03-09 22:22:21 +01001557 autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001558 quickfix quickfix buffer, contains list of errors |:cwindow|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001559 or list of locations |:lwindow|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001560 help help buffer (you are not supposed to set this
1561 manually)
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02001562 terminal buffer for a |terminal| (you are not supposed to set
1563 this manually)
Bram Moolenaarf2732452018-06-03 14:47:35 +02001564 prompt buffer where only the last line can be edited, meant
1565 to be used by a plugin, see |prompt-buffer|
1566 {only when compiled with the |+channel| feature}
Bram Moolenaar4d784b22019-05-25 19:51:39 +02001567 popup buffer used in a popup window, see |popup|.
1568 {only when compiled with the |+textprop| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001569
1570 This option is used together with 'bufhidden' and 'swapfile' to
1571 specify special kinds of buffers. See |special-buffers|.
Bram Moolenaarebdf3c92020-02-15 21:41:42 +01001572 Also see |win_gettype()|, which returns the type of the window.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001573
1574 Be careful with changing this option, it can have many side effects!
Bram Moolenaar113cb512021-11-07 20:27:04 +00001575 One such effect is that Vim will not check the timestamp of the file,
1576 if the file is changed by another program this will not be noticed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001577
Bram Moolenaar280f1262006-01-30 00:14:18 +00001578 A "quickfix" buffer is only used for the error list and the location
1579 list. This value is set by the |:cwindow| and |:lwindow| commands and
1580 you are not supposed to change it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001581
1582 "nofile" and "nowrite" buffers are similar:
1583 both: The buffer is not to be written to disk, ":w" doesn't
1584 work (":w filename" does work though).
1585 both: The buffer is never considered to be |'modified'|.
1586 There is no warning when the changes will be lost, for
1587 example when you quit Vim.
1588 both: A swap file is only created when using too much memory
1589 (when 'swapfile' has been reset there is never a swap
1590 file).
1591 nofile only: The buffer name is fixed, it is not handled like a
1592 file name. It is not modified in response to a |:cd|
1593 command.
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01001594 both: When using ":e bufname" and already editing "bufname"
1595 the buffer is made empty and autocommands are
1596 triggered as usual for |:edit|.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001597 *E676*
1598 "acwrite" implies that the buffer name is not related to a file, like
1599 "nofile", but it will be written. Thus, in contrast to "nofile" and
1600 "nowrite", ":w" does work and a modified buffer can't be abandoned
1601 without saving. For writing there must be matching |BufWriteCmd|,
1602 |FileWriteCmd| or |FileAppendCmd| autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001603
1604 *'casemap'* *'cmp'*
1605'casemap' 'cmp' string (default: "internal,keepascii")
1606 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001607 Specifies details about changing the case of letters. It may contain
1608 these words, separated by a comma:
1609 internal Use internal case mapping functions, the current
1610 locale does not change the case mapping. This only
Bram Moolenaar6f16eb82005-08-23 21:02:42 +00001611 matters when 'encoding' is a Unicode encoding,
1612 "latin1" or "iso-8859-15". When "internal" is
1613 omitted, the towupper() and towlower() system library
1614 functions are used when available.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001615 keepascii For the ASCII characters (0x00 to 0x7f) use the US
1616 case mapping, the current locale is not effective.
1617 This probably only matters for Turkish.
1618
Bram Moolenaar938ae282023-02-20 20:44:55 +00001619 *'cdhome'* *'cdh'* *'nocdhome'* *'nocdh'*
Bram Moolenaar7b1463b2021-12-11 17:24:39 +00001620'cdhome' 'cdh' boolean (default: off)
1621 global
1622 When on, |:cd|, |:tcd| and |:lcd| without an argument changes the
1623 current working directory to the |$HOME| directory like in Unix.
1624 When off, those commands just print the current directory name.
1625 On Unix this option has no effect.
dkearns8ebdbc92023-10-29 06:26:19 +11001626 This option cannot be set from a |modeline| or in the |sandbox|, for
1627 security reasons.
Bram Moolenaar7b1463b2021-12-11 17:24:39 +00001628 NOTE: This option is reset when 'compatible' is set.
1629
Bram Moolenaar071d4272004-06-13 20:20:40 +00001630 *'cdpath'* *'cd'* *E344* *E346*
1631'cdpath' 'cd' string (default: equivalent to $CDPATH or ",,")
1632 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001633 This is a list of directories which will be searched when using the
Bram Moolenaar00aa0692019-04-27 20:37:57 +02001634 |:cd|, |:tcd| and |:lcd| commands, provided that the directory being
1635 searched for has a relative path, not an absolute part starting with
1636 "/", "./" or "../", the 'cdpath' option is not used then.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001637 The 'cdpath' option's value has the same form and semantics as
1638 |'path'|. Also see |file-searching|.
1639 The default value is taken from $CDPATH, with a "," prepended to look
1640 in the current directory first.
1641 If the default value taken from $CDPATH is not what you want, include
1642 a modified version of the following command in your vimrc file to
1643 override it: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00001644 :let &cdpath = ',' .. substitute(substitute($CDPATH, '[, ]', '\\\0', 'g'), ':', ',', 'g')
Bram Moolenaar071d4272004-06-13 20:20:40 +00001645< This option cannot be set from a |modeline| or in the |sandbox|, for
1646 security reasons.
1647 (parts of 'cdpath' can be passed to the shell to expand file names).
1648
1649 *'cedit'*
1650'cedit' string (Vi default: "", Vim default: CTRL-F)
1651 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001652 The key used in Command-line Mode to open the command-line window.
1653 The default is CTRL-F when 'compatible' is off.
1654 Only non-printable keys are allowed.
1655 The key can be specified as a single character, but it is difficult to
Milly25732432024-10-01 19:30:20 +02001656 type. The preferred way is to use |key-notation| (e.g. <Up>, <C-F>) or
1657 a letter preceded with a caret (e.g. `^F` is CTRL-F). Examples: >
1658 :set cedit=^Y
1659 :set cedit=<Esc>
Bram Moolenaar071d4272004-06-13 20:20:40 +00001660< |Nvi| also has this option, but it only uses the first character.
1661 See |cmdwin|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001662 NOTE: This option is set to the Vim default value when 'compatible'
1663 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001664
1665 *'charconvert'* *'ccv'* *E202* *E214* *E513*
1666'charconvert' 'ccv' string (default "")
1667 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01001668 {only available when compiled with the |+eval| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001669 An expression that is used for character encoding conversion. It is
1670 evaluated when a file that is to be read or has been written has a
1671 different encoding from what is desired.
1672 'charconvert' is not used when the internal iconv() function is
1673 supported and is able to do the conversion. Using iconv() is
1674 preferred, because it is much faster.
1675 'charconvert' is not used when reading stdin |--|, because there is no
1676 file to convert from. You will have to save the text in a file first.
Bram Moolenaarf10911e2022-01-29 22:20:48 +00001677 The expression must return zero, false or an empty string for success,
1678 non-zero or true for failure.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001679 The possible encoding names encountered are in 'encoding'.
1680 Additionally, names given in 'fileencodings' and 'fileencoding' are
1681 used.
1682 Conversion between "latin1", "unicode", "ucs-2", "ucs-4" and "utf-8"
1683 is done internally by Vim, 'charconvert' is not used for this.
1684 'charconvert' is also used to convert the viminfo file, if the 'c'
1685 flag is present in 'viminfo'. Also used for Unicode conversion.
1686 Example: >
1687 set charconvert=CharConvert()
1688 fun CharConvert()
1689 system("recode "
Bram Moolenaarc51cf032022-02-26 12:25:45 +00001690 \ .. v:charconvert_from .. ".." .. v:charconvert_to
1691 \ .. " <" .. v:fname_in .. " >" .. v:fname_out)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001692 return v:shell_error
1693 endfun
1694< The related Vim variables are:
1695 v:charconvert_from name of the current encoding
1696 v:charconvert_to name of the desired encoding
1697 v:fname_in name of the input file
1698 v:fname_out name of the output file
1699 Note that v:fname_in and v:fname_out will never be the same.
1700 Note that v:charconvert_from and v:charconvert_to may be different
1701 from 'encoding'. Vim internally uses UTF-8 instead of UCS-2 or UCS-4.
Bram Moolenaarf10911e2022-01-29 22:20:48 +00001702
Bram Moolenaara4e0b972022-10-01 19:43:52 +01001703 The advantage of using a function call without arguments is that it is
1704 faster, see |expr-option-function|.
1705
Bram Moolenaar071d4272004-06-13 20:20:40 +00001706 Encryption is not done by Vim when using 'charconvert'. If you want
1707 to encrypt the file after conversion, 'charconvert' should take care
1708 of this.
Bram Moolenaarf10911e2022-01-29 22:20:48 +00001709
1710 If the 'charconvert' expression starts with s: or |<SID>|, then it is
1711 replaced with the script ID (|local-function|). Example: >
1712 set charconvert=s:MyConvert()
1713 set charconvert=<SID>SomeConvert()
1714< Otherwise the expression is evaluated in the context of the script
1715 where the option was set, thus script-local items are available.
1716
Bram Moolenaar071d4272004-06-13 20:20:40 +00001717 This option cannot be set from a |modeline| or in the |sandbox|, for
1718 security reasons.
1719
1720 *'cindent'* *'cin'* *'nocindent'* *'nocin'*
1721'cindent' 'cin' boolean (default off)
1722 local to buffer
Bram Moolenaar446cb832008-06-24 21:56:24 +00001723 Enables automatic C program indenting. See 'cinkeys' to set the keys
Bram Moolenaar071d4272004-06-13 20:20:40 +00001724 that trigger reindenting in insert mode and 'cinoptions' to set your
1725 preferred indent style.
1726 If 'indentexpr' is not empty, it overrules 'cindent'.
1727 If 'lisp' is not on and both 'indentexpr' and 'equalprg' are empty,
1728 the "=" operator indents using this algorithm rather than calling an
1729 external program.
1730 See |C-indenting|.
1731 When you don't like the way 'cindent' works, try the 'smartindent'
1732 option or 'indentexpr'.
1733 This option is not used when 'paste' is set.
1734 NOTE: This option is reset when 'compatible' is set.
1735
1736 *'cinkeys'* *'cink'*
Bram Moolenaarce655742019-01-31 14:12:57 +01001737'cinkeys' 'cink' string (default "0{,0},0),0],:,0#,!^F,o,O,e")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001738 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001739 A list of keys that, when typed in Insert mode, cause reindenting of
1740 the current line. Only used if 'cindent' is on and 'indentexpr' is
1741 empty.
1742 For the format of this option see |cinkeys-format|.
1743 See |C-indenting|.
1744
1745 *'cinoptions'* *'cino'*
1746'cinoptions' 'cino' string (default "")
1747 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001748 The 'cinoptions' affect the way 'cindent' reindents lines in a C
1749 program. See |cinoptions-values| for the values of this option, and
1750 |C-indenting| for info on C indenting in general.
1751
laburnumT3f7855a2023-12-05 18:37:03 +01001752 *'cinscopedecls'* *'cinsd'*
1753'cinscopedecls' 'cinsd' string (default "public,protected,private")
1754 local to buffer
1755 Keywords that are interpreted as a C++ scope declaration by |cino-g|.
1756 Useful e.g. for working with the Qt framework that defines additional
1757 scope declarations "signals", "public slots" and "private slots": >
1758 set cinscopedecls+=signals,public\ slots,private\ slots
1759<
Bram Moolenaar071d4272004-06-13 20:20:40 +00001760 *'cinwords'* *'cinw'*
1761'cinwords' 'cinw' string (default "if,else,while,do,for,switch")
1762 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001763 These keywords start an extra indent in the next line when
1764 'smartindent' or 'cindent' is set. For 'cindent' this is only done at
1765 an appropriate place (inside {}).
1766 Note that 'ignorecase' isn't used for 'cinwords'. If case doesn't
1767 matter, include the keyword both the uppercase and lowercase:
1768 "if,If,IF".
1769
laburnumT3f7855a2023-12-05 18:37:03 +01001770 *'clipboard'* *'cb'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001771'clipboard' 'cb' string (default "autoselect,exclude:cons\|linux"
1772 for X-windows, "" otherwise)
1773 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001774 {only in GUI versions or when the |+xterm_clipboard|
1775 feature is included}
Tom Praschan3506cf32022-04-07 12:39:08 +01001776 This option is a list of comma-separated names.
Bram Moolenaar942db232021-02-13 18:14:48 +01001777 Note: if one of the items is "exclude:", then you can't add an item
Bram Moolenaar5ed11532022-07-06 13:18:11 +01001778 after that. Therefore do not append an item with += but use ^= to
Bram Moolenaar942db232021-02-13 18:14:48 +01001779 prepend, e.g.: >
1780 set clipboard^=unnamed
Bram Moolenaar9fbdbb82022-09-27 17:30:34 +01001781< When using the GUI see |'go-A'|.
1782 These names are recognized:
Bram Moolenaar071d4272004-06-13 20:20:40 +00001783
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001784 *clipboard-unnamed*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001785 unnamed When included, Vim will use the clipboard register '*'
1786 for all yank, delete, change and put operations which
1787 would normally go to the unnamed register. When a
1788 register is explicitly specified, it will always be
1789 used regardless of whether "unnamed" is in 'clipboard'
1790 or not. The clipboard register can always be
1791 explicitly accessed using the "* notation. Also see
1792 |gui-clipboard|.
1793
Bram Moolenaar30b65812012-07-12 22:01:11 +02001794 *clipboard-unnamedplus*
Bram Moolenaar00154502013-02-13 16:15:55 +01001795 unnamedplus A variant of the "unnamed" flag which uses the
1796 clipboard register '+' (|quoteplus|) instead of
1797 register '*' for all yank, delete, change and put
1798 operations which would normally go to the unnamed
1799 register. When "unnamed" is also included to the
1800 option, yank operations (but not delete, change or
1801 put) will additionally copy the text into register
1802 '*'.
Bram Moolenaar81af9252010-12-10 20:35:50 +01001803 Only available with the |+X11| feature.
Bram Moolenaarbf9680e2010-12-02 21:43:16 +01001804 Availability can be checked with: >
1805 if has('unnamedplus')
1806<
Bram Moolenaar30b65812012-07-12 22:01:11 +02001807 *clipboard-autoselect*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001808 autoselect Works like the 'a' flag in 'guioptions': If present,
1809 then whenever Visual mode is started, or the Visual
1810 area extended, Vim tries to become the owner of the
1811 windowing system's global selection or put the
1812 selected text on the clipboard used by the selection
Bram Moolenaarba3ff532018-11-04 14:45:49 +01001813 register "*. See |'go-a'| and |quotestar| for details.
1814 When the GUI is active, the 'a' flag in 'guioptions'
1815 is used, when the GUI is not active, this "autoselect"
1816 flag is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001817 Also applies to the modeless selection.
1818
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001819 *clipboard-autoselectplus*
1820 autoselectplus Like "autoselect" but using the + register instead of
1821 the * register. Compare to the 'P' flag in
1822 'guioptions'.
1823
1824 *clipboard-autoselectml*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001825 autoselectml Like "autoselect", but for the modeless selection
1826 only. Compare to the 'A' flag in 'guioptions'.
1827
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001828 *clipboard-html*
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001829 html When the clipboard contains HTML, use this when
1830 pasting. When putting text on the clipboard, mark it
1831 as HTML. This works to copy rendered HTML from
1832 Firefox, paste it as raw HTML in Vim, select the HTML
1833 in Vim and paste it in a rich edit box in Firefox.
Bram Moolenaar20a825a2010-05-31 21:27:30 +02001834 You probably want to add this only temporarily,
1835 possibly use BufEnter autocommands.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001836 Only supported for GTK version 2 and later.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001837
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001838 *clipboard-exclude*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001839 exclude:{pattern}
1840 Defines a pattern that is matched against the name of
1841 the terminal 'term'. If there is a match, no
1842 connection will be made to the X server. This is
1843 useful in this situation:
1844 - Running Vim in a console.
1845 - $DISPLAY is set to start applications on another
1846 display.
1847 - You do not want to connect to the X server in the
1848 console, but do want this in a terminal emulator.
1849 To never connect to the X server use: >
1850 exclude:.*
1851< This has the same effect as using the |-X| argument.
1852 Note that when there is no connection to the X server
1853 the window title won't be restored and the clipboard
1854 cannot be accessed.
1855 The value of 'magic' is ignored, {pattern} is
1856 interpreted as if 'magic' was on.
1857 The rest of the option value will be used for
1858 {pattern}, this must be the last entry.
1859
1860 *'cmdheight'* *'ch'*
1861'cmdheight' 'ch' number (default 1)
Shougo Matsushitaf39cfb72022-07-30 16:54:05 +01001862 global or local to tab page
Bram Moolenaara2a89732022-08-31 14:46:18 +01001863 Number of screen lines to use for the command-line. A larger value
1864 helps avoiding |hit-enter| prompts.
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00001865 The value of this option is stored with the tab page, so that each tab
1866 page can have a different value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001867
1868 *'cmdwinheight'* *'cwh'*
1869'cmdwinheight' 'cwh' number (default 7)
1870 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001871 Number of screen lines to use for the command-line window. |cmdwin|
1872
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001873 *'colorcolumn'* *'cc'*
1874'colorcolumn' 'cc' string (default "")
1875 local to window
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001876 {not available when compiled without the |+syntax|
1877 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001878 'colorcolumn' is a comma-separated list of screen columns that are
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001879 highlighted with ColorColumn |hl-ColorColumn|. Useful to align
1880 text. Will make screen redrawing slower.
1881 The screen column can be an absolute number, or a number preceded with
1882 '+' or '-', which is added to or subtracted from 'textwidth'. >
1883
Bram Moolenaar10e8ff92023-06-10 21:40:39 +01001884 :set cc=+1 " highlight column after 'textwidth'
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001885 :set cc=+1,+2,+3 " highlight three columns after 'textwidth'
1886 :hi ColorColumn ctermbg=lightgrey guibg=lightgrey
1887<
1888 When 'textwidth' is zero then the items with '-' and '+' are not used.
1889 A maximum of 256 columns are highlighted.
1890
Bram Moolenaar071d4272004-06-13 20:20:40 +00001891 *'columns'* *'co'* *E594*
1892'columns' 'co' number (default 80 or terminal width)
1893 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001894 Number of columns of the screen. Normally this is set by the terminal
Bram Moolenaar7c626922005-02-07 22:01:03 +00001895 initialization and does not have to be set by hand. Also see
1896 |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001897 When Vim is running in the GUI or in a resizable window, setting this
1898 option will cause the window size to be changed. When you only want
1899 to use the size for the GUI, put the command in your |gvimrc| file.
1900 When you set this option and Vim is unable to change the physical
Bram Moolenaar02467872007-05-06 13:22:01 +00001901 number of columns of the display, the display may be messed up. For
1902 the GUI it is always possible and Vim limits the number of columns to
1903 what fits on the screen. You can use this command to get the widest
1904 window possible: >
1905 :set columns=9999
1906< Minimum value is 12, maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001907
1908 *'comments'* *'com'* *E524* *E525*
1909'comments' 'com' string (default
1910 "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-")
1911 local to buffer
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001912 A comma-separated list of strings that can start a comment line. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00001913 |format-comments|. See |option-backslash| about using backslashes to
1914 insert a space.
1915
1916 *'commentstring'* *'cms'* *E537*
Riley Bruins0a083062024-06-03 20:40:45 +02001917'commentstring' 'cms' string (default "/* %s */")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001918 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001919 {not available when compiled without the |+folding|
1920 feature}
1921 A template for a comment. The "%s" in the value is replaced with the
Riley Bruins0a083062024-06-03 20:40:45 +02001922 comment text, and should be padded with a space when possible.
h-east84ac2122024-06-17 18:12:30 +02001923 Currently used to add markers for folding, see |fold-marker|. Also
Riley Bruins0a083062024-06-03 20:40:45 +02001924 commonly used by commenting plugins (e.g. |comment-install|).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001925
1926 *'compatible'* *'cp'* *'nocompatible'* *'nocp'*
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001927'compatible' 'cp' boolean (default on, off when a |vimrc| or |gvimrc|
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02001928 file is found, reset in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001929 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001930 This option has the effect of making Vim either more Vi-compatible, or
1931 make Vim behave in a more useful way.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001932
Bram Moolenaar071d4272004-06-13 20:20:40 +00001933 This is a special kind of option, because when it's set or reset,
Bram Moolenaar214641f2017-03-05 17:04:09 +01001934 other options are also changed as a side effect.
1935 NOTE: Setting or resetting this option can have a lot of unexpected
1936 effects: Mappings are interpreted in another way, undo behaves
1937 differently, etc. If you set this option in your vimrc file, you
1938 should probably put it at the very start.
1939
Bram Moolenaar071d4272004-06-13 20:20:40 +00001940 By default this option is on and the Vi defaults are used for the
1941 options. This default was chosen for those people who want to use Vim
1942 just like Vi, and don't even (want to) know about the 'compatible'
1943 option.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001944 When a |vimrc| or |gvimrc| file is found while Vim is starting up,
Bram Moolenaard042c562005-06-30 22:04:15 +00001945 this option is switched off, and all options that have not been
1946 modified will be set to the Vim defaults. Effectively, this means
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001947 that when a |vimrc| or |gvimrc| file exists, Vim will use the Vim
Bram Moolenaard042c562005-06-30 22:04:15 +00001948 defaults, otherwise it will use the Vi defaults. (Note: This doesn't
Bram Moolenaar02467872007-05-06 13:22:01 +00001949 happen for the system-wide vimrc or gvimrc file, nor for a file given
1950 with the |-u| argument). Also see |compatible-default| and
1951 |posix-compliance|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001952 You can also set this option with the "-C" argument, and reset it with
1953 "-N". See |-C| and |-N|.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001954 See 'cpoptions' for more fine tuning of Vi compatibility.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001955
Bram Moolenaar214641f2017-03-05 17:04:09 +01001956 When this option is set, numerous other options are set to make Vim as
1957 Vi-compatible as possible. When this option is unset, various options
1958 are set to make Vim more useful. The table below lists all the
1959 options affected.
1960 The {?} column indicates when the options are affected:
1961 + Means that the option is set to the value given in {set value} when
1962 'compatible' is set.
1963 & Means that the option is set to the value given in {set value} when
1964 'compatible' is set AND is set to its Vim default value when
1965 'compatible' is unset.
1966 - Means the option is NOT changed when setting 'compatible' but IS
1967 set to its Vim default when 'compatible' is unset.
1968 The {effect} column summarises the change when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001969
Bram Moolenaar036986f2017-03-16 17:41:02 +01001970 option ? set value effect ~
Bram Moolenaar214641f2017-03-05 17:04:09 +01001971
1972 'allowrevins' + off no CTRL-_ command
1973 'antialias' + off don't use antialiased fonts
Bram Moolenaarbe4e0162023-02-02 13:59:48 +00001974 'arabic' + off reset arabic-related options
Bram Moolenaar214641f2017-03-05 17:04:09 +01001975 'arabicshape' + on correct character shapes
1976 'backspace' + "" normal backspace
1977 'backup' + off no backup file
1978 'backupcopy' & Unix: "yes" backup file is a copy
1979 else: "auto" copy or rename backup file
1980 'balloonexpr' + "" text to show in evaluation balloon
1981 'breakindent' + off don't indent when wrapping lines
1982 'cedit' - {unchanged} {set vim default only on resetting 'cp'}
Bram Moolenaar7b1463b2021-12-11 17:24:39 +00001983 'cdhome' + off ":cd" don't chdir to home on non-Unix
Bram Moolenaar214641f2017-03-05 17:04:09 +01001984 'cindent' + off no C code indentation
1985 'compatible' - {unchanged} {set vim default only on resetting 'cp'}
1986 'copyindent' + off don't copy indent structure
1987 'cpoptions' & (all flags) Vi-compatible flags
1988 'cscopepathcomp'+ 0 don't show directories in tags list
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01001989 'cscoperelative'+ off don't use basename of path as prefix
Bram Moolenaar214641f2017-03-05 17:04:09 +01001990 'cscopetag' + off don't use cscope for ":tag"
Bram Moolenaar036986f2017-03-16 17:41:02 +01001991 'cscopetagorder'+ 0 see |cscopetagorder|
Bram Moolenaar214641f2017-03-05 17:04:09 +01001992 'cscopeverbose' + off see |cscopeverbose|
1993 'delcombine' + off unicode: delete whole char combination
1994 'digraph' + off no digraphs
1995 'esckeys' & off no <Esc>-keys in Insert mode
Christian Brabandt5f5131d2023-10-25 21:44:26 +02001996 this also disables |modifyOtherKeys|
1997 and |xterm-bracketed-paste|
Bram Moolenaar214641f2017-03-05 17:04:09 +01001998 'expandtab' + off tabs not expanded to spaces
1999 'fileformats' & "" no automatic file format detection,
Bram Moolenaar6f345a12019-12-17 21:27:18 +01002000 "dos,unix" except for MS-Windows
Bram Moolenaar214641f2017-03-05 17:04:09 +01002001 'formatexpr' + "" use 'formatprg' for auto-formatting
2002 'formatoptions' & "vt" Vi compatible formatting
2003 'gdefault' + off no default 'g' flag for ":s"
2004 'history' & 0 no commandline history
2005 'hkmap' + off no Hebrew keyboard mapping
2006 'hkmapp' + off no phonetic Hebrew keyboard mapping
2007 'hlsearch' + off no highlighting of search matches
2008 'incsearch' + off no incremental searching
2009 'indentexpr' + "" no indenting by expression
2010 'insertmode' + off do not start in Insert mode
2011 'iskeyword' & "@,48-57,_" keywords contain alphanumeric
Bram Moolenaar071d4272004-06-13 20:20:40 +00002012 characters and '_'
Bram Moolenaar214641f2017-03-05 17:04:09 +01002013 'joinspaces' + on insert 2 spaces after period
2014 'modeline' & off no modelines
2015 'more' & off no pauses in listings
2016 'mzquantum' - {unchanged} {set vim default only on resetting 'cp'}
2017 'numberwidth' & 8 min number of columns for line number
2018 'preserveindent'+ off don't preserve current indent structure
2019 when changing it
2020 'revins' + off no reverse insert
2021 'ruler' + off no ruler
2022 'scrolljump' + 1 no jump scroll
2023 'scrolloff' + 0 no scroll offset
2024 'shelltemp' - {unchanged} {set vim default only on resetting 'cp'}
2025 'shiftround' + off indent not rounded to shiftwidth
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02002026 'shortmess' & "S" no shortening of messages
Bram Moolenaar214641f2017-03-05 17:04:09 +01002027 'showcmd' & off command characters not shown
2028 'showmode' & off current mode not shown
2029 'sidescrolloff' + 0 cursor moves to edge of screen in scroll
2030 'smartcase' + off no automatic ignore case switch
2031 'smartindent' + off no smart indentation
2032 'smarttab' + off no smart tab size
2033 'softtabstop' + 0 tabs are always 'tabstop' positions
2034 'startofline' + on goto startofline with some commands
2035 'tagcase' & "followic" 'ignorecase' when searching tags file
2036 'tagrelative' & off tag file names are not relative
2037 'termguicolors' + off don't use highlight-(guifg|guibg)
2038 'textauto' & off no automatic textmode detection
2039 'textwidth' + 0 no automatic line wrap
2040 'tildeop' + off tilde is not an operator
2041 'ttimeout' + off no terminal timeout
2042 'undofile' + off don't use an undo file
Bram Moolenaar036986f2017-03-16 17:41:02 +01002043 'viminfo' - {unchanged} {set Vim default only on resetting 'cp'}
Bram Moolenaar214641f2017-03-05 17:04:09 +01002044 'virtualedit' + "" cursor can only be placed on characters
2045 'whichwrap' & "" left-right movements don't wrap
2046 'wildchar' & CTRL-E only when the current value is <Tab>
Bram Moolenaar071d4272004-06-13 20:20:40 +00002047 use CTRL-E for cmdline completion
Bram Moolenaar214641f2017-03-05 17:04:09 +01002048 'writebackup' + on or off depends on the |+writebackup| feature
Bram Moolenaar071d4272004-06-13 20:20:40 +00002049
2050 *'complete'* *'cpt'* *E535*
2051'complete' 'cpt' string (default: ".,w,b,u,t,i")
2052 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002053 This option specifies how keyword completion |ins-completion| works
2054 when CTRL-P or CTRL-N are used. It is also used for whole-line
2055 completion |i_CTRL-X_CTRL-L|. It indicates the type of completion
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01002056 and the places to scan. It is a comma-separated list of flags:
Bram Moolenaar3848e002016-03-19 18:42:29 +01002057 . scan the current buffer ('wrapscan' is ignored)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002058 w scan buffers from other windows
2059 b scan other loaded buffers that are in the buffer list
2060 u scan the unloaded buffers that are in the buffer list
2061 U scan the buffers that are not in the buffer list
2062 k scan the files given with the 'dictionary' option
Bram Moolenaar0b238792006-03-02 22:49:12 +00002063 kspell use the currently active spell checking |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002064 k{dict} scan the file {dict}. Several "k" flags can be given,
2065 patterns are valid too. For example: >
2066 :set cpt=k/usr/dict/*,k~/spanish
2067< s scan the files given with the 'thesaurus' option
2068 s{tsr} scan the file {tsr}. Several "s" flags can be given, patterns
2069 are valid too.
2070 i scan current and included files
2071 d scan current and included files for defined name or macro
2072 |i_CTRL-X_CTRL-D|
2073 ] tag completion
2074 t same as "]"
2075
2076 Unloaded buffers are not loaded, thus their autocmds |:autocmd| are
2077 not executed, this may lead to unexpected completions from some files
2078 (gzipped files for example). Unloaded buffers are not scanned for
2079 whole-line completion.
2080
2081 The default is ".,w,b,u,t,i", which means to scan:
2082 1. the current buffer
2083 2. buffers in other windows
2084 3. other loaded buffers
2085 4. unloaded buffers
2086 5. tags
2087 6. included files
2088
2089 As you can see, CTRL-N and CTRL-P can be used to do any 'iskeyword'-
Bram Moolenaar582fd852005-03-28 20:58:01 +00002090 based expansion (e.g., dictionary |i_CTRL-X_CTRL-K|, included patterns
2091 |i_CTRL-X_CTRL-I|, tags |i_CTRL-X_CTRL-]| and normal expansions).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002092
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00002093 *'completefunc'* *'cfu'*
2094'completefunc' 'cfu' string (default: empty)
2095 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02002096 {not available when compiled without the |+eval|
Bram Moolenaare2c453d2019-08-21 14:37:09 +02002097 feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00002098 This option specifies a function to be used for Insert mode completion
2099 with CTRL-X CTRL-U. |i_CTRL-X_CTRL-U|
Bram Moolenaar280f1262006-01-30 00:14:18 +00002100 See |complete-functions| for an explanation of how the function is
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00002101 invoked and what it should return. The value can be the name of a
2102 function, a |lambda| or a |Funcref|. See |option-value-function| for
2103 more information.
Bram Moolenaar166af9b2010-11-16 20:34:40 +01002104 This option cannot be set from a |modeline| or in the |sandbox|, for
2105 security reasons.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00002106
glepnirf31cfa22025-03-06 21:59:13 +01002107 *'completefuzzycollect'* *'cfc'*
2108'completefuzzycollect' 'cfc' string (default: empty)
2109 global
zeertzjq1dc731a2025-03-13 21:30:10 +01002110 A comma-separated list of strings to enable fuzzy collection for
2111 specific |ins-completion| modes, affecting how matches are gathered
2112 during completion. For specified modes, fuzzy matching is used to
2113 find completion candidates instead of the standard prefix-based
2114 matching. This option can contain the following values:
glepnir53b14572025-03-12 21:28:39 +01002115
glepnir58760162025-03-13 21:39:51 +01002116 keyword keywords in the current file |i_CTRL-X_CTRL-N|
2117 keywords with flags ".", "w", |i_CTRL-N| |i_CTRL-P|
2118 "b", "u", "U" and "k{dict}" in 'complete'
2119 keywords in 'dictionary' |i_CTRL-X_CTRL-K|
glepnir53b14572025-03-12 21:28:39 +01002120
glepnir58760162025-03-13 21:39:51 +01002121 files file names |i_CTRL-X_CTRL-F|
glepnir53b14572025-03-12 21:28:39 +01002122
glepnir58760162025-03-13 21:39:51 +01002123 whole_line whole lines |i_CTRL-X_CTRL-L|
glepnir53b14572025-03-12 21:28:39 +01002124
glepnir58760162025-03-13 21:39:51 +01002125 When used the 'completeopt' "longest" option value, fuzzy collection
2126 can identify the longest common string among the best fuzzy matches
2127 and insert it automatically.
glepnirf31cfa22025-03-06 21:59:13 +01002128
glepnir6a89c942024-10-01 20:32:12 +02002129 *'completeitemalign'* *'cia'*
2130'completeitemalign' 'cia' string (default: "abbr,kind,menu")
2131 global
zeertzjq85a50fe2025-02-27 19:24:32 +01002132 A comma-separated list of strings that controls the alignment and
2133 display order of items in the popup menu during Insert mode
2134 completion. The supported values are "abbr", "kind", and "menu".
2135 These values allow customizing how |complete-items| are shown in the
glepnir6a89c942024-10-01 20:32:12 +02002136 popup menu. Note: must always contain those three values in any
2137 order.
2138
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00002139 *'completeopt'* *'cot'*
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00002140'completeopt' 'cot' string (default: "menu,preview")
zeertzjq529b9ad2024-06-05 20:27:06 +02002141 global or local to buffer |global-local|
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01002142 A comma-separated list of options for Insert mode completion
Bram Moolenaarc7453f52006-02-10 23:20:28 +00002143 |ins-completion|. The supported values are:
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00002144
glepnira2c55592025-02-28 17:43:42 +01002145 fuzzy Enable |fuzzy-matching| for completion candidates. This
2146 allows for more flexible and intuitive matching, where
2147 characters can be skipped and matches can be found even
zeertzjq53d59ec2025-03-07 19:09:09 +01002148 if the exact sequence is not typed. Note: This option
glepnirf31cfa22025-03-06 21:59:13 +01002149 does not affect the collection of candidate list, it only
2150 controls how completion candidates are reduced from the
zeertzjq53d59ec2025-03-07 19:09:09 +01002151 list of alternatives. If you want to use |fuzzy-matching|
glepnirf31cfa22025-03-06 21:59:13 +01002152 to gather more alternatives for your candidate list,
2153 see |'completefuzzycollect'|.
glepnira2c55592025-02-28 17:43:42 +01002154
2155 longest Only insert the longest common text of the matches. If
2156 the menu is displayed you can use CTRL-L to add more
2157 characters. Whether case is ignored depends on the kind
2158 of completion. For buffer text the 'ignorecase' option is
2159 used.
2160
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00002161 menu Use a popup menu to show the possible completions. The
2162 menu is only shown when there is more than one match and
2163 sufficient colors are available. |ins-completion-menu|
2164
Bram Moolenaar65c923a2006-03-03 22:56:30 +00002165 menuone Use the popup menu also when there is only one match.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002166 Useful when there is additional information about the
Bram Moolenaar65c923a2006-03-03 22:56:30 +00002167 match, e.g., what file it comes from.
2168
glepnira2c55592025-02-28 17:43:42 +01002169 noinsert Do not insert any text for a match until the user selects
zeertzjq659cb282025-03-03 20:18:04 +01002170 a match from the menu. Only works in combination with
2171 "menu" or "menuone". No effect if "longest" is present.
Bram Moolenaarc7453f52006-02-10 23:20:28 +00002172
glepnira2c55592025-02-28 17:43:42 +01002173 noselect Same as "noinsert", except that no menu item is
zeertzjq659cb282025-03-03 20:18:04 +01002174 pre-selected. If both "noinsert" and "noselect" are
glepnira2c55592025-02-28 17:43:42 +01002175 present, "noselect" has precedence.
2176
2177 nosort Disable sorting of completion candidates based on fuzzy
zeertzjq659cb282025-03-03 20:18:04 +01002178 scores when "fuzzy" is enabled. Candidates will appear
glepnira2c55592025-02-28 17:43:42 +01002179 in their original order.
Bram Moolenaar02467872007-05-06 13:22:01 +00002180
Bram Moolenaar576a4a62019-08-18 15:25:17 +02002181 popup Show extra information about the currently selected
2182 completion in a popup window. Only works in combination
2183 with "menu" or "menuone". Overrides "preview".
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002184 See |'completepopup'| for specifying properties.
Bram Moolenaar2e693a82019-10-16 22:35:02 +02002185 {only works when compiled with the |+textprop| feature}
Bram Moolenaar576a4a62019-08-18 15:25:17 +02002186
Bram Moolenaardca7abe2019-10-20 18:17:57 +02002187 popuphidden
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01002188 Just like "popup" but initially hide the popup. Use a
Bram Moolenaardca7abe2019-10-20 18:17:57 +02002189 |CompleteChanged| autocommand to fetch the info and call
2190 |popup_show()| once the popup has been filled.
2191 See the example at |complete-popuphidden|.
2192 {only works when compiled with the |+textprop| feature}
2193
glepniredd4ac32025-01-29 18:53:51 +01002194 preinsert
2195 Preinsert the portion of the first candidate word that is
2196 not part of the current completion leader and using the
glepnir94a045e2025-03-01 16:12:23 +01002197 |hl-ComplMatchIns| highlight group. In order for it to
zeertzjq659cb282025-03-03 20:18:04 +01002198 work, "fuzzy" must not be set and "menuone" must be set.
glepnira2c55592025-02-28 17:43:42 +01002199
2200 preview Show extra information about the currently selected
2201 completion in the preview window. Only works in
2202 combination with "menu" or "menuone".
glepniredd4ac32025-01-29 18:53:51 +01002203
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002204 *'completepopup'* *'cpp'*
2205'completepopup' 'cpp' string (default empty)
2206 global
2207 {not available when compiled without the |+textprop|
2208 or |+quickfix| feature}
2209 When 'completeopt' contains "popup" then this option is used for the
Bram Moolenaar447bfba2020-07-18 16:07:16 +02002210 properties of the info popup when it is created. If an info popup
2211 window already exists it is closed, so that the option value is
2212 applied when it is created again.
2213 You can also use |popup_findinfo()| and then set properties for an
2214 existing info popup with |popup_setoptions()|. See |complete-popup|.
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002215
laburnumT3f7855a2023-12-05 18:37:03 +01002216 *'completeslash'* *'csl'*
2217'completeslash' 'csl' string (default: "")
2218 local to buffer
2219 {only for MS-Windows}
2220 When this option is set it overrules 'shellslash' for completion:
2221 - When this option is set to "slash", a forward slash is used for path
2222 completion in insert mode. This is useful when editing HTML tag, or
2223 Makefile with 'noshellslash' on MS-Windows.
2224 - When this option is set to "backslash", backslash is used. This is
2225 useful when editing a batch file with 'shellslash' set on MS-Windows.
2226 - When this option is empty, same character is used as for
2227 'shellslash'.
2228 For Insert mode completion the buffer-local value is used. For
2229 command line completion the global value is used.
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002230
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002231 *'concealcursor'* *'cocu'*
2232'concealcursor' 'cocu' string (default: "")
2233 local to window
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002234 {not available when compiled without the |+conceal|
2235 feature}
2236 Sets the modes in which text in the cursor line can also be concealed.
2237 When the current mode is listed then concealing happens just like in
2238 other lines.
2239 n Normal mode
2240 v Visual mode
2241 i Insert mode
Bram Moolenaarca8c9862010-07-24 15:00:38 +02002242 c Command line editing, for 'incsearch'
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002243
Bram Moolenaare6dc5732010-07-24 23:52:26 +02002244 'v' applies to all lines in the Visual area, not only the cursor.
Bram Moolenaarca8c9862010-07-24 15:00:38 +02002245 A useful value is "nc". This is used in help files. So long as you
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002246 are moving around text is concealed, but when starting to insert text
2247 or selecting a Visual area the concealed text is displayed, so that
2248 you can see what you are doing.
Bram Moolenaarf70e3d62010-07-24 13:15:07 +02002249 Keep in mind that the cursor position is not always where it's
2250 displayed. E.g., when moving vertically it may change column.
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002251
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002252 *'conceallevel'* *'cole'*
2253'conceallevel' 'cole' number (default 0)
Bram Moolenaar860cae12010-06-05 23:22:07 +02002254 local to window
Bram Moolenaar860cae12010-06-05 23:22:07 +02002255 {not available when compiled without the |+conceal|
2256 feature}
Bram Moolenaar6df6f472010-07-18 18:04:50 +02002257 Determine how text with the "conceal" syntax attribute |:syn-conceal|
2258 is shown:
Bram Moolenaar860cae12010-06-05 23:22:07 +02002259
Bram Moolenaar6df6f472010-07-18 18:04:50 +02002260 Value Effect ~
Bram Moolenaar860cae12010-06-05 23:22:07 +02002261 0 Text is shown normally
Bram Moolenaar477db062010-07-28 18:17:41 +02002262 1 Each block of concealed text is replaced with one
2263 character. If the syntax item does not have a custom
2264 replacement character defined (see |:syn-cchar|) the
2265 character defined in 'listchars' is used (default is a
2266 space).
2267 It is highlighted with the "Conceal" highlight group.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002268 2 Concealed text is completely hidden unless it has a
2269 custom replacement character defined (see
Bram Moolenaar477db062010-07-28 18:17:41 +02002270 |:syn-cchar|).
Bram Moolenaara7781e02010-07-19 20:13:22 +02002271 3 Concealed text is completely hidden.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002272
Bram Moolenaara7781e02010-07-19 20:13:22 +02002273 Note: in the cursor line concealed text is not hidden, so that you can
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002274 edit and copy the text. This can be changed with the 'concealcursor'
2275 option.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002276
Bram Moolenaar071d4272004-06-13 20:20:40 +00002277 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
2278'confirm' 'cf' boolean (default off)
2279 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002280 When 'confirm' is on, certain operations that would normally
2281 fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
2282 instead raise a |dialog| asking if you wish to save the current
2283 file(s). You can still use a ! to unconditionally |abandon| a buffer.
2284 If 'confirm' is off you can still activate confirmation for one
2285 command only (this is most useful in mappings) with the |:confirm|
2286 command.
2287 Also see the |confirm()| function and the 'v' flag in 'guioptions'.
2288
2289 *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
2290'conskey' 'consk' boolean (default off)
2291 global
Bram Moolenaarf3913272016-02-25 00:00:01 +01002292 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002293
2294 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
2295'copyindent' 'ci' boolean (default off)
2296 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002297 Copy the structure of the existing lines indent when autoindenting a
2298 new line. Normally the new indent is reconstructed by a series of
2299 tabs followed by spaces as required (unless |'expandtab'| is enabled,
2300 in which case only spaces are used). Enabling this option makes the
2301 new line copy whatever characters were used for indenting on the
Bram Moolenaar446cb832008-06-24 21:56:24 +00002302 existing line. 'expandtab' has no effect on these characters, a Tab
2303 remains a Tab. If the new indent is greater than on the existing
Bram Moolenaar071d4272004-06-13 20:20:40 +00002304 line, the remaining space is filled in the normal manner.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002305 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002306 Also see 'preserveindent'.
2307
Bram Moolenaare0fa3742016-02-20 15:47:01 +01002308 *'cpoptions'* *'cpo'* *cpo*
Illia Bobyr03d20aa2024-07-16 20:10:16 +02002309'cpoptions' 'cpo' string (Vim default: "aABceFsz",
2310 Vi default: all flags, except "#{|&/\."
h-east90e1fe42024-08-12 18:26:08 +02002311 |$VIM_POSIX|: all flags)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002312 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002313 A sequence of single character flags. When a character is present
Bram Moolenaar7cba6c02013-09-05 22:13:31 +02002314 this indicates Vi-compatible behavior. This is used for things where
2315 not being Vi-compatible is mostly or sometimes preferred.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002316 'cpoptions' stands for "compatible-options".
2317 Commas can be added for readability.
2318 To avoid problems with flags that are added in the future, use the
2319 "+=" and "-=" feature of ":set" |add-option-flags|.
Bram Moolenaar71eb3ad2021-12-26 12:07:30 +00002320
Bram Moolenaar071d4272004-06-13 20:20:40 +00002321 NOTE: This option is set to the Vi default value when 'compatible' is
2322 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar71eb3ad2021-12-26 12:07:30 +00002323
2324 NOTE: In a |Vim9| script, when `vim9script` is encountered, the value
2325 is saved, 'cpoptions' is set to the Vim default, and the saved value
2326 is restored at the end of the script. Changes to the value of
2327 'cpoptions' will be applied to the saved value, but keep in mind that
2328 removing a flag that is not present when 'cpoptions' is changed has no
2329 effect. In the |.vimrc| file the value is not restored, thus using
2330 `vim9script` in the |.vimrc| file results in using the Vim default.
2331
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002332 NOTE: This option is set to the POSIX default value at startup when
2333 the Vi default value would be used and the $VIM_POSIX environment
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002334 variable exists |posix|. This means Vim tries to behave like the
2335 POSIX specification.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002336
2337 contains behavior ~
2338 *cpo-a*
2339 a When included, a ":read" command with a file name
2340 argument will set the alternate file name for the
2341 current window.
2342 *cpo-A*
2343 A When included, a ":write" command with a file name
2344 argument will set the alternate file name for the
2345 current window.
2346 *cpo-b*
2347 b "\|" in a ":map" command is recognized as the end of
2348 the map command. The '\' is included in the mapping,
2349 the text after the '|' is interpreted as the next
2350 command. Use a CTRL-V instead of a backslash to
2351 include the '|' in the mapping. Applies to all
2352 mapping, abbreviation, menu and autocmd commands.
2353 See also |map_bar|.
2354 *cpo-B*
2355 B A backslash has no special meaning in mappings,
Bram Moolenaara9604e62018-07-21 05:56:22 +02002356 abbreviations, user commands and the "to" part of the
2357 menu commands. Remove this flag to be able to use a
2358 backslash like a CTRL-V. For example, the command
2359 ":map X \<Esc>" results in X being mapped to:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002360 'B' included: "\^[" (^[ is a real <Esc>)
2361 'B' excluded: "<Esc>" (5 characters)
2362 ('<' excluded in both cases)
2363 *cpo-c*
2364 c Searching continues at the end of any match at the
2365 cursor position, but not further than the start of the
2366 next line. When not present searching continues
2367 one character from the cursor position. With 'c'
2368 "abababababab" only gets three matches when repeating
2369 "/abab", without 'c' there are five matches.
2370 *cpo-C*
2371 C Do not concatenate sourced lines that start with a
2372 backslash. See |line-continuation|.
2373 *cpo-d*
2374 d Using "./" in the 'tags' option doesn't mean to use
2375 the tags file relative to the current file, but the
2376 tags file in the current directory.
2377 *cpo-D*
2378 D Can't use CTRL-K to enter a digraph after Normal mode
2379 commands with a character argument, like |r|, |f| and
2380 |t|.
2381 *cpo-e*
2382 e When executing a register with ":@r", always add a
2383 <CR> to the last line, also when the register is not
2384 linewise. If this flag is not present, the register
2385 is not linewise and the last line does not end in a
2386 <CR>, then the last line is put on the command-line
2387 and can be edited before hitting <CR>.
2388 *cpo-E*
2389 E It is an error when using "y", "d", "c", "g~", "gu" or
2390 "gU" on an Empty region. The operators only work when
Bram Moolenaar15142e22018-04-30 22:19:58 +02002391 at least one character is to be operated on. Example:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002392 This makes "y0" fail in the first column.
2393 *cpo-f*
2394 f When included, a ":read" command with a file name
2395 argument will set the file name for the current buffer,
2396 if the current buffer doesn't have a file name yet.
2397 *cpo-F*
2398 F When included, a ":write" command with a file name
2399 argument will set the file name for the current
2400 buffer, if the current buffer doesn't have a file name
Bram Moolenaarb3480382005-12-11 21:33:32 +00002401 yet. Also see |cpo-P|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002402 *cpo-g*
2403 g Goto line 1 when using ":edit" without argument.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002404 *cpo-H*
2405 H When using "I" on a line with only blanks, insert
2406 before the last blank. Without this flag insert after
2407 the last blank.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002408 *cpo-i*
2409 i When included, interrupting the reading of a file will
2410 leave it modified.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002411 *cpo-I*
2412 I When moving the cursor up or down just after inserting
2413 indent for 'autoindent', do not delete the indent.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002414 *cpo-j*
2415 j When joining lines, only add two spaces after a '.',
2416 not after '!' or '?'. Also see 'joinspaces'.
2417 *cpo-J*
2418 J A |sentence| has to be followed by two spaces after
Bram Moolenaar582fd852005-03-28 20:58:01 +00002419 the '.', '!' or '?'. A <Tab> is not recognized as
Bram Moolenaar071d4272004-06-13 20:20:40 +00002420 white space.
2421 *cpo-k*
2422 k Disable the recognition of raw key codes in
2423 mappings, abbreviations, and the "to" part of menu
2424 commands. For example, if <Key> sends ^[OA (where ^[
2425 is <Esc>), the command ":map X ^[OA" results in X
2426 being mapped to:
2427 'k' included: "^[OA" (3 characters)
2428 'k' excluded: "<Key>" (one key code)
2429 Also see the '<' flag below.
2430 *cpo-K*
2431 K Don't wait for a key code to complete when it is
2432 halfway a mapping. This breaks mapping <F1><F1> when
2433 only part of the second <F1> has been read. It
2434 enables cancelling the mapping by typing <F1><Esc>.
2435 *cpo-l*
2436 l Backslash in a [] range in a search pattern is taken
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002437 literally, only "\]", "\^", "\-" and "\\" are special.
2438 See |/[]|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002439 'l' included: "/[ \t]" finds <Space>, '\' and 't'
2440 'l' excluded: "/[ \t]" finds <Space> and <Tab>
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002441 Also see |cpo-\|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002442 *cpo-L*
2443 L When the 'list' option is set, 'wrapmargin',
2444 'textwidth', 'softtabstop' and Virtual Replace mode
2445 (see |gR|) count a <Tab> as two characters, instead of
2446 the normal behavior of a <Tab>.
2447 *cpo-m*
2448 m When included, a showmatch will always wait half a
2449 second. When not included, a showmatch will wait half
2450 a second or until a character is typed. |'showmatch'|
2451 *cpo-M*
2452 M When excluded, "%" matching will take backslashes into
2453 account. Thus in "( \( )" and "\( ( \)" the outer
2454 parenthesis match. When included "%" ignores
2455 backslashes, which is Vi compatible.
2456 *cpo-n*
Bram Moolenaar64486672010-05-16 15:46:46 +02002457 n When included, the column used for 'number' and
2458 'relativenumber' will also be used for text of wrapped
2459 lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002460 *cpo-o*
2461 o Line offset to search command is not remembered for
2462 next search.
2463 *cpo-O*
2464 O Don't complain if a file is being overwritten, even
2465 when it didn't exist when editing it. This is a
2466 protection against a file unexpectedly created by
2467 someone else. Vi didn't complain about this.
2468 *cpo-p*
2469 p Vi compatible Lisp indenting. When not present, a
2470 slightly better algorithm is used.
Bram Moolenaarb3480382005-12-11 21:33:32 +00002471 *cpo-P*
2472 P When included, a ":write" command that appends to a
2473 file will set the file name for the current buffer, if
2474 the current buffer doesn't have a file name yet and
2475 the 'F' flag is also included |cpo-F|.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002476 *cpo-q*
2477 q When joining multiple lines leave the cursor at the
2478 position where it would be when joining two lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002479 *cpo-r*
2480 r Redo ("." command) uses "/" to repeat a search
2481 command, instead of the actually used search string.
2482 *cpo-R*
2483 R Remove marks from filtered lines. Without this flag
2484 marks are kept like |:keepmarks| was used.
2485 *cpo-s*
2486 s Set buffer options when entering the buffer for the
2487 first time. This is like it is in Vim version 3.0.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002488 And it is the default. If not present the options are
Bram Moolenaar071d4272004-06-13 20:20:40 +00002489 set when the buffer is created.
2490 *cpo-S*
2491 S Set buffer options always when entering a buffer
2492 (except 'readonly', 'fileformat', 'filetype' and
2493 'syntax'). This is the (most) Vi compatible setting.
2494 The options are set to the values in the current
2495 buffer. When you change an option and go to another
2496 buffer, the value is copied. Effectively makes the
2497 buffer options global to all buffers.
2498
2499 's' 'S' copy buffer options
2500 no no when buffer created
2501 yes no when buffer first entered (default)
2502 X yes each time when buffer entered (vi comp.)
2503 *cpo-t*
2504 t Search pattern for the tag command is remembered for
2505 "n" command. Otherwise Vim only puts the pattern in
2506 the history for search pattern, but doesn't change the
2507 last used search pattern.
2508 *cpo-u*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002509 u Undo is Vi compatible. See |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002510 *cpo-v*
2511 v Backspaced characters remain visible on the screen in
2512 Insert mode. Without this flag the characters are
2513 erased from the screen right away. With this flag the
2514 screen newly typed text overwrites backspaced
2515 characters.
2516 *cpo-w*
2517 w When using "cw" on a blank character, only change one
2518 character and not all blanks until the start of the
2519 next word.
2520 *cpo-W*
2521 W Don't overwrite a readonly file. When omitted, ":w!"
2522 overwrites a readonly file, if possible.
2523 *cpo-x*
2524 x <Esc> on the command-line executes the command-line.
2525 The default in Vim is to abandon the command-line,
2526 because <Esc> normally aborts a command. |c_<Esc>|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002527 *cpo-X*
2528 X When using a count with "R" the replaced text is
2529 deleted only once. Also when repeating "R" with "."
2530 and a count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002531 *cpo-y*
Bram Moolenaard09091d2019-01-17 16:07:22 +01002532 y A yank command can be redone with ".". Think twice if
2533 you really want to use this, it may break some
2534 plugins, since most people expect "." to only repeat a
2535 change.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002536 *cpo-Z*
2537 Z When using "w!" while the 'readonly' option is set,
2538 don't reset 'readonly'.
Christian Brabandt22105fd2024-07-15 20:51:11 +02002539 *cpo-z*
2540 z Special casing the "cw" and "d" command (see |cw| and
2541 |d-special|).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002542 *cpo-!*
2543 ! When redoing a filter command, use the last used
2544 external command, whatever it was. Otherwise the last
2545 used -filter- command is used.
2546 *cpo-$*
2547 $ When making a change to one line, don't redisplay the
2548 line, but put a '$' at the end of the changed text.
2549 The changed text will be overwritten when you type the
2550 new text. The line is redisplayed if you type any
2551 command that moves the cursor from the insertion
2552 point.
2553 *cpo-%*
2554 % Vi-compatible matching is done for the "%" command.
2555 Does not recognize "#if", "#endif", etc.
2556 Does not recognize "/*" and "*/".
2557 Parens inside single and double quotes are also
2558 counted, causing a string that contains a paren to
2559 disturb the matching. For example, in a line like
2560 "if (strcmp("foo(", s))" the first paren does not
2561 match the last one. When this flag is not included,
2562 parens inside single and double quotes are treated
2563 specially. When matching a paren outside of quotes,
2564 everything inside quotes is ignored. When matching a
2565 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002566 there is one). This works very well for C programs.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002567 This flag is also used for other features, such as
2568 C-indenting.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002569 *cpo--*
2570 - When included, a vertical movement command fails when
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002571 it would go above the first line or below the last
2572 line. Without it the cursor moves to the first or
2573 last line, unless it already was in that line.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002574 Applies to the commands "-", "k", CTRL-P, "+", "j",
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002575 CTRL-N, CTRL-J and ":1234".
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002576 *cpo-+*
2577 + When included, a ":write file" command will reset the
2578 'modified' flag of the buffer, even though the buffer
2579 itself may still be different from its file.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002580 *cpo-star*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002581 * Use ":*" in the same way as ":@". When not included,
2582 ":*" is an alias for ":'<,'>", select the Visual area.
2583 *cpo-<*
2584 < Disable the recognition of special key codes in |<>|
2585 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002586 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00002587 ":map X <Tab>" results in X being mapped to:
2588 '<' included: "<Tab>" (5 characters)
2589 '<' excluded: "^I" (^I is a real <Tab>)
2590 Also see the 'k' flag above.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002591 *cpo->*
2592 > When appending to a register, put a line break before
2593 the appended text.
Bram Moolenaar8b3e0332011-06-26 05:36:34 +02002594 *cpo-;*
2595 ; When using |,| or |;| to repeat the last |t| search
2596 and the cursor is right in front of the searched
2597 character, the cursor won't move. When not included,
2598 the cursor would skip over it and jump to the
Bram Moolenaarc8734422012-06-01 22:38:45 +02002599 following occurrence.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002600
2601 POSIX flags. These are not included in the Vi default value, except
2602 when $VIM_POSIX was set on startup. |posix|
2603
2604 contains behavior ~
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002605 *cpo-#*
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002606 # A count before "D", "o" and "O" has no effect.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002607 *cpo-&*
2608 & When ":preserve" was used keep the swap file when
2609 exiting normally while this buffer is still loaded.
2610 This flag is tested when exiting.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002611 *cpo-\*
2612 \ Backslash in a [] range in a search pattern is taken
2613 literally, only "\]" is special See |/[]|
Bram Moolenaar90915b52005-08-21 22:17:52 +00002614 '\' included: "/[ \-]" finds <Space>, '\' and '-'
2615 '\' excluded: "/[ \-]" finds <Space> and '-'
2616 Also see |cpo-l|.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002617 *cpo-/*
2618 / When "%" is used as the replacement string in a |:s|
2619 command, use the previous replacement string. |:s%|
2620 *cpo-{*
2621 { The |{| and |}| commands also stop at a "{" character
2622 at the start of a line.
2623 *cpo-.*
2624 . The ":chdir" and ":cd" commands fail if the current
2625 buffer is modified, unless ! is used. Vim doesn't
2626 need this, since it remembers the full path of an
2627 opened file.
2628 *cpo-bar*
2629 | The value of the $LINES and $COLUMNS environment
2630 variables overrule the terminal size values obtained
2631 with system specific functions.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002632
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002633 *'cryptmethod'* *'cm'*
Bram Moolenaara86187b2018-12-16 18:20:00 +01002634'cryptmethod' 'cm' string (default "blowfish2")
Bram Moolenaar49771f42010-07-20 17:32:38 +02002635 global or local to buffer |global-local|
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002636 Method used for encryption when the buffer is written to a file:
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002637 *pkzip*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002638 zip PkZip compatible method. A weak kind of encryption.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002639 Backwards compatible with Vim 7.2 and older.
Christian Brabandtaae58342023-04-23 17:50:22 +01002640 Only use if you need to be backwards compatible.
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002641 *blowfish*
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002642 blowfish Blowfish method. Medium strong encryption but it has
2643 an implementation flaw. Requires Vim 7.3 or later,
2644 files can NOT be read by Vim 7.2 and older. This adds
2645 a "seed" to the file, every time you write the file
2646 the encrypted bytes will be different.
Christian Brabandtaae58342023-04-23 17:50:22 +01002647 Obsolete, please do no longer use.
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002648 *blowfish2*
2649 blowfish2 Blowfish method. Medium strong encryption. Requires
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01002650 Vim 7.4.401 or later, files can NOT be read by Vim 7.3
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002651 and older. This adds a "seed" to the file, every time
2652 you write the file the encrypted bytes will be
2653 different. The whole undo file is encrypted, not just
2654 the pieces of text.
Bram Moolenaara2baa732022-02-04 16:09:54 +00002655 *E1193* *E1194* *E1195* *E1196* *E1230*
Christian Brabandtf573c6e2021-06-20 14:02:16 +02002656 *E1197* *E1198* *E1199* *E1200* *E1201*
2657 xchacha20 XChaCha20 Cipher with Poly1305 Message Authentication
2658 Code. Medium strong till strong encryption.
2659 Encryption is provided by the libsodium library, it
Bram Moolenaar22863042021-10-16 15:23:36 +01002660 requires Vim to be built with |+sodium|.
Christian Brabandtf573c6e2021-06-20 14:02:16 +02002661 It adds a seed and a message authentication code (MAC)
2662 to the file. This needs at least a Vim 8.2.3022 to
2663 read the encrypted file.
2664 Encryption of swap files is not supported, therefore
2665 no swap file will be used when xchacha20 encryption is
2666 enabled.
2667 Encryption of undo files is not yet supported,
2668 therefore no undo file will currently be written.
Christian Brabandtaae58342023-04-23 17:50:22 +01002669 CAREFUL: Files written with this method might have to
2670 be read back with the same version of Vim if the
2671 binary format changes later.
2672 Obsolete, please do no longer use.
2673 xchacha20v2 Same algorithm as with "xchacha20" that correctly
2674 stores the key derivation parameters together with the
2675 encrypted file. Should work better in case the
2676 parameters in the libsodium library ever change.
2677 STILL EXPERIMENTAL: Files written with this method
Christian Brabandtf573c6e2021-06-20 14:02:16 +02002678 might have to be read back with the same version of
2679 Vim if the binary format changes later.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002680
Christian Brabandtaae58342023-04-23 17:50:22 +01002681 You should use "blowfish2", also to re-encrypt older files. The
2682 "xchacha20" method provides better encryption, but it does not work
2683 with all versions of Vim.
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01002684
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002685 When reading an encrypted file 'cryptmethod' will be set automatically
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002686 to the detected method of the file being read. Thus if you write it
2687 without changing 'cryptmethod' the same method will be used.
2688 Changing 'cryptmethod' does not mark the file as modified, you have to
Bram Moolenaar49771f42010-07-20 17:32:38 +02002689 explicitly write it, you don't get a warning unless there are other
2690 modifications. Also see |:X|.
2691
2692 When setting the global value to an empty string, it will end up with
Bram Moolenaara86187b2018-12-16 18:20:00 +01002693 the value "blowfish2". When setting the local value to an empty
2694 string the buffer will use the global value.
Bram Moolenaar49771f42010-07-20 17:32:38 +02002695
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002696 When a new encryption method is added in a later version of Vim, and
2697 the current version does not recognize it, you will get *E821* .
Bram Moolenaar49771f42010-07-20 17:32:38 +02002698 You need to edit this file with the later version of Vim.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002699
Bram Moolenaar071d4272004-06-13 20:20:40 +00002700 *'cscopepathcomp'* *'cspc'*
2701'cscopepathcomp' 'cspc' number (default 0)
2702 global
2703 {not available when compiled without the |+cscope|
2704 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002705 Determines how many components of the path to show in a list of tags.
2706 See |cscopepathcomp|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002707 NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002708
2709 *'cscopeprg'* *'csprg'*
2710'cscopeprg' 'csprg' string (default "cscope")
2711 global
2712 {not available when compiled without the |+cscope|
2713 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002714 Specifies the command to execute cscope. See |cscopeprg|.
2715 This option cannot be set from a |modeline| or in the |sandbox|, for
2716 security reasons.
2717
2718 *'cscopequickfix'* *'csqf'*
2719'cscopequickfix' 'csqf' string (default "")
2720 global
2721 {not available when compiled without the |+cscope|
2722 or |+quickfix| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002723 Specifies whether to use quickfix window to show cscope results.
2724 See |cscopequickfix|.
2725
Bram Moolenaarec7944a2013-06-12 21:29:15 +02002726 *'cscoperelative'* *'csre'* *'nocscoperelative'* *'nocsre'*
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002727'cscoperelative' 'csre' boolean (default off)
2728 global
2729 {not available when compiled without the |+cscope|
2730 feature}
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002731 In the absence of a prefix (-P) for cscope. setting this option enables
2732 to use the basename of cscope.out path as the prefix.
2733 See |cscoperelative|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002734 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002735
Bram Moolenaar071d4272004-06-13 20:20:40 +00002736 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
2737'cscopetag' 'cst' boolean (default off)
2738 global
2739 {not available when compiled without the |+cscope|
2740 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002741 Use cscope for tag commands. See |cscope-options|.
2742 NOTE: This option is reset when 'compatible' is set.
2743
2744 *'cscopetagorder'* *'csto'*
2745'cscopetagorder' 'csto' number (default 0)
2746 global
2747 {not available when compiled without the |+cscope|
2748 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002749 Determines the order in which ":cstag" performs a search. See
2750 |cscopetagorder|.
2751 NOTE: This option is set to 0 when 'compatible' is set.
2752
2753 *'cscopeverbose'* *'csverb'*
2754 *'nocscopeverbose'* *'nocsverb'*
2755'cscopeverbose' 'csverb' boolean (default off)
2756 global
2757 {not available when compiled without the |+cscope|
2758 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002759 Give messages when adding a cscope database. See |cscopeverbose|.
2760 NOTE: This option is reset when 'compatible' is set.
2761
Bram Moolenaar860cae12010-06-05 23:22:07 +02002762 *'cursorbind'* *'crb'* *'nocursorbind'* *'nocrb'*
2763'cursorbind' 'crb' boolean (default off)
2764 local to window
Bram Moolenaar860cae12010-06-05 23:22:07 +02002765 When this option is set, as the cursor in the current
2766 window moves other cursorbound windows (windows that also have
2767 this option set) move their cursors to the corresponding line and
2768 column. This option is useful for viewing the
2769 differences between two versions of a file (see 'diff'); in diff mode,
2770 inserted and deleted lines (though not characters within a line) are
Bram Moolenaar1a384422010-07-14 19:53:30 +02002771 taken into account.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002772
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002773 *'cursorcolumn'* *'cuc'* *'nocursorcolumn'* *'nocuc'*
2774'cursorcolumn' 'cuc' boolean (default off)
2775 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02002776 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002777 feature}
2778 Highlight the screen column of the cursor with CursorColumn
2779 |hl-CursorColumn|. Useful to align text. Will make screen redrawing
2780 slower.
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00002781 If you only want the highlighting in the current window you can use
2782 these autocommands: >
2783 au WinLeave * set nocursorline nocursorcolumn
2784 au WinEnter * set cursorline cursorcolumn
2785<
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002786
2787 *'cursorline'* *'cul'* *'nocursorline'* *'nocul'*
2788'cursorline' 'cul' boolean (default off)
2789 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02002790 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002791 feature}
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002792 Highlight the text line of the cursor with CursorLine |hl-CursorLine|.
2793 Useful to easily spot the cursor. Will make screen redrawing slower.
Bram Moolenaare2f98b92006-03-29 21:18:24 +00002794 When Visual mode is active the highlighting isn't used to make it
Bram Moolenaar779b74b2006-04-10 14:55:34 +00002795 easier to see the selected text.
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002796
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002797 *'cursorlineopt'* *'culopt'*
Bram Moolenaar017ba072019-09-14 21:01:23 +02002798'cursorlineopt' 'culopt' string (default: "number,line")
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002799 local to window
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002800 {not available when compiled without the |+syntax|
2801 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01002802 Comma-separated list of settings for how 'cursorline' is displayed.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002803 Valid values:
2804 "line" Highlight the text line of the cursor with
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002805 CursorLine |hl-CursorLine|.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002806 "screenline" Highlight only the screen line of the cursor with
2807 CursorLine |hl-CursorLine|.
2808 "number" Highlight the line number of the cursor with
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002809 CursorLineNr |hl-CursorLineNr|.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002810
2811 Special value:
2812 "both" Alias for the values "line,number".
2813
2814 "line" and "screenline" cannot be used together.
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002815
Bram Moolenaar071d4272004-06-13 20:20:40 +00002816 *'debug'*
2817'debug' string (default "")
2818 global
Bram Moolenaar57657d82006-04-21 22:12:41 +00002819 These values can be used:
2820 msg Error messages that would otherwise be omitted will be given
2821 anyway.
2822 throw Error messages that would otherwise be omitted will be given
2823 anyway and also throw an exception and set |v:errmsg|.
2824 beep A message will be given when otherwise only a beep would be
2825 produced.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002826 The values can be combined, separated by a comma.
Bram Moolenaar57657d82006-04-21 22:12:41 +00002827 "msg" and "throw" are useful for debugging 'foldexpr', 'formatexpr' or
2828 'indentexpr'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002829
2830 *'define'* *'def'*
2831'define' 'def' string (default "^\s*#\s*define")
2832 global or local to buffer |global-local|
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002833 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002834 pattern, just like for the "/" command. This option is used for the
2835 commands like "[i" and "[d" |include-search|. The 'isident' option is
2836 used to recognize the defined name after the match:
2837 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2838 See |option-backslash| about inserting backslashes to include a space
2839 or backslash.
2840 The default value is for C programs. For C++ this value would be
2841 useful, to include const type declarations: >
2842 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
Bram Moolenaar63b74a82019-03-24 15:09:13 +01002843< You can also use "\ze" just before the name and continue the pattern
2844 to check what is following. E.g. for Javascript, if a function is
2845 defined with "func_name = function(args)": >
2846 ^\s*\ze\i\+\s*=\s*function(
2847< If the function is defined with "func_name : function() {...": >
2848 ^\s*\ze\i\+\s*[:]\s*(*function\s*(
Bram Moolenaar071d4272004-06-13 20:20:40 +00002849< When using the ":set" command, you need to double the backslashes!
Bram Moolenaar63b74a82019-03-24 15:09:13 +01002850 To avoid that use `:let` with a single quote string: >
2851 let &l:define = '^\s*\ze\k\+\s*=\s*function('
Bram Moolenaar911ead12019-04-21 00:03:35 +02002852<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002853
2854 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2855'delcombine' 'deco' boolean (default off)
2856 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002857 If editing Unicode and this option is set, backspace and Normal mode
2858 "x" delete each combining character on its own. When it is off (the
2859 default) the character along with its combining characters are
2860 deleted.
Bram Moolenaar4f4d51a2020-10-11 13:57:40 +02002861 Note: When 'delcombine' is set "xx" may work differently from "2x"!
Bram Moolenaar071d4272004-06-13 20:20:40 +00002862
2863 This is useful for Arabic, Hebrew and many other languages where one
2864 may have combining characters overtop of base characters, and want
2865 to remove only the combining ones.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002866 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002867
2868 *'dictionary'* *'dict'*
2869'dictionary' 'dict' string (default "")
2870 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002871 List of file names, separated by commas, that are used to lookup words
2872 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2873 contain a list of words. This can be one word per line, or several
2874 words per line, separated by non-keyword characters (white space is
2875 preferred). Maximum line length is 510 bytes.
Bram Moolenaar259f26a2018-05-15 22:25:40 +02002876
2877 When this option is empty or an entry "spell" is present, and spell
2878 checking is enabled, words in the word lists for the currently active
2879 'spelllang' are used. See |spell|.
2880
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002881 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002882 after a comma are ignored, otherwise spaces are included in the file
2883 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002884 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002885 Where to find a list of words?
2886 - On FreeBSD, there is the file "/usr/share/dict/words".
2887 - In the Simtel archive, look in the "msdos/linguist" directory.
2888 - In "miscfiles" of the GNU collection.
2889 The use of |:set+=| and |:set-=| is preferred when adding or removing
2890 directories from the list. This avoids problems when a future version
2891 uses another default.
2892 Backticks cannot be used in this option for security reasons.
2893
2894 *'diff'* *'nodiff'*
2895'diff' boolean (default off)
2896 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00002897 {not available when compiled without the |+diff|
2898 feature}
2899 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002900 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002901
2902 *'dex'* *'diffexpr'*
2903'diffexpr' 'dex' string (default "")
2904 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002905 {not available when compiled without the |+diff|
2906 feature}
Bram Moolenaare828b762018-09-10 17:51:58 +02002907 Expression which is evaluated to obtain a diff file (either ed-style
2908 or unified-style) from two versions of a file. See |diff-diffexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002909 This option cannot be set from a |modeline| or in the |sandbox|, for
2910 security reasons.
2911
2912 *'dip'* *'diffopt'*
Bram Moolenaarc8234772019-11-10 21:00:27 +01002913'diffopt' 'dip' string (default "internal,filler,closeoff")
Bram Moolenaar071d4272004-06-13 20:20:40 +00002914 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002915 {not available when compiled without the |+diff|
2916 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002917 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002918 All are optional. Items must be separated by a comma.
2919
Jonathon7c7a4e62025-01-12 09:58:00 +01002920 algorithm:{text} Use the specified diff algorithm with the
2921 internal diff engine. Currently supported
2922 algorithms are:
2923 myers the default algorithm
2924 minimal spend extra time to generate the
2925 smallest possible diff
2926 patience patience diff algorithm
2927 histogram histogram diff algorithm
2928
2929 closeoff When a window is closed where 'diff' is set
2930 and there is only one window remaining in the
2931 same tab page with 'diff' set, execute
2932 `:diffoff` in that window. This undoes a
2933 `:diffsplit` command.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002934
2935 context:{n} Use a context of {n} lines between a change
2936 and a fold that contains unchanged lines.
2937 When omitted a context of six lines is used.
Bram Moolenaarf6b40102019-02-22 15:24:03 +01002938 When using zero the context is actually one,
2939 since folds require a line in between, also
dundargoc20f48d52023-10-02 21:49:23 +02002940 for a deleted line. Set it to a very large
2941 value (999999) to disable folding completely.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002942 See |fold-diff|.
2943
Jonathon7c7a4e62025-01-12 09:58:00 +01002944 filler Show filler lines, to keep the text
2945 synchronized with a window that has inserted
2946 lines at the same position. Mostly useful
2947 when windows are side-by-side and 'scrollbind'
2948 is set.
2949
2950 foldcolumn:{n} Set the 'foldcolumn' option to {n} when
2951 starting diff mode. Without this 2 is used.
2952
2953 followwrap Follow the 'wrap' option and leave as it is.
2954
2955 horizontal Start diff mode with horizontal splits (unless
2956 explicitly specified otherwise).
2957
2958 hiddenoff Do not use diff mode for a buffer when it
2959 becomes hidden.
2960
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002961 iblank Ignore changes where lines are all blank. Adds
2962 the "-B" flag to the "diff" command if
2963 'diffexpr' is empty. Check the documentation
2964 of the "diff" command for what this does
2965 exactly.
2966 NOTE: the diff windows will get out of sync,
2967 because no differences between blank lines are
2968 taken into account.
2969
Bram Moolenaar071d4272004-06-13 20:20:40 +00002970 icase Ignore changes in case of text. "a" and "A"
2971 are considered the same. Adds the "-i" flag
2972 to the "diff" command if 'diffexpr' is empty.
2973
Jonathon7c7a4e62025-01-12 09:58:00 +01002974 indent-heuristic
2975 Use the indent heuristic for the internal
2976 diff library.
2977
2978 internal Use the internal diff library. This is
2979 ignored when 'diffexpr' is set. *E960*
2980 When running out of memory when writing a
2981 buffer this item will be ignored for diffs
2982 involving that buffer. Set the 'verbose'
2983 option to see when this happens.
2984
Bram Moolenaar071d4272004-06-13 20:20:40 +00002985 iwhite Ignore changes in amount of white space. Adds
2986 the "-b" flag to the "diff" command if
2987 'diffexpr' is empty. Check the documentation
2988 of the "diff" command for what this does
2989 exactly. It should ignore adding trailing
2990 white space, but not leading white space.
2991
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002992 iwhiteall Ignore all white space changes. Adds
2993 the "-w" flag to the "diff" command if
2994 'diffexpr' is empty. Check the documentation
2995 of the "diff" command for what this does
2996 exactly.
2997
2998 iwhiteeol Ignore white space changes at end of line.
2999 Adds the "-Z" flag to the "diff" command if
3000 'diffexpr' is empty. Check the documentation
3001 of the "diff" command for what this does
3002 exactly.
3003
Jonathon7c7a4e62025-01-12 09:58:00 +01003004 linematch:{n} Align and mark changes between the most
3005 similar lines between the buffers. When the
3006 total number of lines in the diff hunk exceeds
3007 {n}, the lines will not be aligned because for
3008 very large diff hunks there will be a
3009 noticeable lag. A reasonable setting is
3010 "linematch:60", as this will enable alignment
3011 for a 2 buffer diff hunk of 30 lines each,
3012 or a 3 buffer diff hunk of 20 lines each.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00003013
3014 vertical Start diff mode with vertical splits (unless
3015 explicitly specified otherwise).
3016
Bram Moolenaare828b762018-09-10 17:51:58 +02003017 Examples: >
3018 :set diffopt=internal,filler,context:4
Bram Moolenaar071d4272004-06-13 20:20:40 +00003019 :set diffopt=
Bram Moolenaare828b762018-09-10 17:51:58 +02003020 :set diffopt=internal,filler,foldcolumn:3
3021 :set diffopt-=internal " do NOT use the internal diff parser
Bram Moolenaar071d4272004-06-13 20:20:40 +00003022<
3023 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
3024'digraph' 'dg' boolean (default off)
3025 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003026 {not available when compiled without the |+digraphs|
3027 feature}
3028 Enable the entering of digraphs in Insert mode with {char1} <BS>
3029 {char2}. See |digraphs|.
3030 NOTE: This option is reset when 'compatible' is set.
3031
3032 *'directory'* *'dir'*
3033'directory' 'dir' string (default for Amiga: ".,t:",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003034 for Win32: ".,$TEMP,c:\tmp,c:\temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00003035 for Unix: ".,~/tmp,/var/tmp,/tmp")
3036 global
3037 List of directory names for the swap file, separated with commas.
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02003038 Recommended value: ".,~/vimswap//" - this will put the swap file next
3039 to the edited file if possible, and in your personal swap directory
3040 otherwise. Make sure "~/vimswap//" is only readable for you.
3041
3042 Possible items:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003043 - The swap file will be created in the first directory where this is
3044 possible.
3045 - Empty means that no swap file will be used (recovery is
Bram Moolenaar00e192b2019-10-19 17:01:28 +02003046 impossible!) and no |E303| error will be given.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003047 - A directory "." means to put the swap file in the same directory as
3048 the edited file. On Unix, a dot is prepended to the file name, so
3049 it doesn't show in a directory listing. On MS-Windows the "hidden"
3050 attribute is set and a dot prepended if possible.
Bram Moolenaar8024f932020-01-14 19:29:13 +01003051 - A directory starting with "./" (or ".\" for MS-Windows) means to put
3052 the swap file relative to where the edited file is. The leading "."
3053 is replaced with the path name of the edited file.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02003054 - For Unix and Win32, if a directory ends in two path separators "//",
3055 the swap file name will be built from the complete path to the file
Bram Moolenaar207f0092020-08-30 17:20:20 +02003056 with all path separators replaced by percent '%' signs (including
3057 the colon following the drive letter on Win32). This will ensure
3058 file name uniqueness in the preserve directory.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02003059 On Win32, it is also possible to end with "\\". However, When a
3060 separating comma is following, you must use "//", since "\\" will
3061 include the comma in the file name. Therefore it is recommended to
3062 use '//', instead of '\\'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003063 - Spaces after the comma are ignored, other spaces are considered part
3064 of the directory name. To have a space at the start of a directory
3065 name, precede it with a backslash.
3066 - To include a comma in a directory name precede it with a backslash.
3067 - A directory name may end in an ':' or '/'.
3068 - Environment variables are expanded |:set_env|.
3069 - Careful with '\' characters, type one before a space, type two to
3070 get one in the option (see |option-backslash|), for example: >
3071 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
3072< - For backwards compatibility with Vim version 3.0 a '>' at the start
3073 of the option is removed.
3074 Using "." first in the list is recommended. This means that editing
3075 the same file twice will result in a warning. Using "/tmp" on Unix is
3076 discouraged: When the system crashes you lose the swap file.
3077 "/var/tmp" is often not cleared when rebooting, thus is a better
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02003078 choice than "/tmp". But others on the computer may be able to see the
3079 files, and it can contain a lot of files, your swap files get lost in
3080 the crowd. That is why a "tmp" directory in your home directory is
3081 tried first.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003082 The use of |:set+=| and |:set-=| is preferred when adding or removing
3083 directories from the list. This avoids problems when a future version
3084 uses another default.
3085 This option cannot be set from a |modeline| or in the |sandbox|, for
3086 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003087
3088 *'display'* *'dy'*
Bram Moolenaarbc8801c2016-08-02 21:04:33 +02003089'display' 'dy' string (default "", set to "truncate" in
3090 |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003091 global
Bram Moolenaarf269eab2022-10-03 18:04:35 +01003092 Change the way text is displayed. This is a comma-separated list of
Bram Moolenaar071d4272004-06-13 20:20:40 +00003093 flags:
3094 lastline When included, as much as possible of the last line
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02003095 in a window will be displayed. "@@@" is put in the
3096 last columns of the last screen line to indicate the
3097 rest of the line is not displayed.
3098 truncate Like "lastline", but "@@@" is displayed in the first
3099 column of the last screen line. Overrules "lastline".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003100 uhex Show unprintable characters hexadecimal as <xx>
3101 instead of using ^C and ~C.
3102
Bram Moolenaard0796902016-09-16 20:02:31 +02003103 When neither "lastline" nor "truncate" is included, a last line that
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02003104 doesn't fit is replaced with "@" lines.
3105
Bram Moolenaar4ba5f1d2022-10-04 14:36:29 +01003106 The "@" character can be changed by setting the "lastline" item in
3107 'fillchars'. The character is highlighted with |hl-NonText|.
3108
Bram Moolenaar071d4272004-06-13 20:20:40 +00003109 *'eadirection'* *'ead'*
3110'eadirection' 'ead' string (default "both")
3111 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003112 Tells when the 'equalalways' option applies:
3113 ver vertically, width of windows is not affected
3114 hor horizontally, height of windows is not affected
3115 both width and height of windows is affected
3116
3117 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
3118'edcompatible' 'ed' boolean (default off)
3119 global
3120 Makes the 'g' and 'c' flags of the ":substitute" command to be
3121 toggled each time the flag is given. See |complex-change|. See
3122 also 'gdefault' option.
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +02003123 Switching this option on may break plugins!
Bram Moolenaar4072ba52020-12-23 13:56:35 +01003124 This option is not used in |Vim9| script.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003125
Bram Moolenaar03413f42016-04-12 21:07:15 +02003126 *'emoji'* *'emo'* *'noemoji'* *'noemo'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01003127'emoji' 'emo' boolean (default: on)
3128 global
Bram Moolenaar3848e002016-03-19 18:42:29 +01003129 When on all Unicode emoji characters are considered to be full width.
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02003130 This excludes "text emoji" characters, which are normally displayed as
3131 single width. Unfortunately there is no good specification for this
3132 and it has been determined on trial-and-error basis. Use the
3133 |setcellwidths()| function to change the behavior.
Bram Moolenaar3848e002016-03-19 18:42:29 +01003134
Bram Moolenaar071d4272004-06-13 20:20:40 +00003135 *'encoding'* *'enc'* *E543*
K.Takataf883d902021-05-30 18:04:19 +02003136'encoding' 'enc' string (default for MS-Windows: "utf-8",
3137 otherwise: value from $LANG or "latin1")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003138 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003139 Sets the character encoding used inside Vim. It applies to text in
3140 the buffers, registers, Strings in expressions, text stored in the
3141 viminfo file, etc. It sets the kind of characters which Vim can work
3142 with. See |encoding-names| for the possible values.
3143
3144 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003145 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003146 It should normally be kept at its default value, or set when Vim
Bram Moolenaar02467872007-05-06 13:22:01 +00003147 starts up. See |multibyte|. To reload the menus see |:menutrans|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003148
Bram Moolenaar865242e2010-07-14 21:12:05 +02003149 This option cannot be set from a |modeline|. It would most likely
3150 corrupt the text.
3151
Bram Moolenaar3df01732017-02-17 22:47:16 +01003152 NOTE: For GTK+ 2 or later, it is highly recommended to set 'encoding'
3153 to "utf-8". Although care has been taken to allow different values of
Bram Moolenaar071d4272004-06-13 20:20:40 +00003154 'encoding', "utf-8" is the natural choice for the environment and
3155 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003156 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00003157 versions, and to avoid changing the encoding of newly created files
3158 without your knowledge (in case 'fileencodings' is empty).
3159
3160 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003161 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00003162 iconv() or as specified with 'charconvert'.
3163
Bram Moolenaar207f0092020-08-30 17:20:20 +02003164 If you need to know whether 'encoding' is a multibyte encoding, you
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003165 can use: >
3166 if has("multi_byte_encoding")
3167<
Bram Moolenaar071d4272004-06-13 20:20:40 +00003168 Normally 'encoding' will be equal to your current locale. This will
3169 be the default if Vim recognizes your environment settings. If
3170 'encoding' is not set to the current locale, 'termencoding' must be
3171 set to convert typed and displayed text. See |encoding-table|.
3172
3173 When you set this option, it fires the |EncodingChanged| autocommand
3174 event so that you can set up fonts if necessary.
3175
3176 When the option is set, the value is converted to lowercase. Thus
3177 you can set it with uppercase values too. Underscores are translated
3178 to '-' signs.
3179 When the encoding is recognized, it is changed to the standard name.
3180 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
3181 "iso-8859-2" and "utf8" becomes "utf-8".
3182
3183 Note: "latin1" is also used when the encoding could not be detected.
3184 This only works when editing files in the same encoding! When the
3185 actual character set is not latin1, make sure 'fileencoding' and
3186 'fileencodings' are empty. When conversion is needed, switch to using
3187 utf-8.
3188
3189 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
3190 You don't notice this while editing, but it does matter for the
3191 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
3192 setting 'encoding' to one of these values instead of utf-8 only has
3193 effect for encoding used for files when 'fileencoding' is empty.
3194
Bram Moolenaar661b1822005-07-28 22:36:45 +00003195 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
3196 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003197
Bram Moolenaar6ebe4f92022-10-28 20:47:54 +01003198 *'endoffile'* *'eof'* *'noendoffile'* *'noeof'*
Bram Moolenaar0aad88f2022-11-12 11:54:26 +00003199'endoffile' 'eof' boolean (default off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003200 local to buffer
Bram Moolenaar6ebe4f92022-10-28 20:47:54 +01003201 Indicates that a CTRL-Z character was found at the end of the file
3202 when reading it. Normally only happens when 'fileformat' is "dos".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003203 When writing a file and this option is off and the 'binary' option
Bram Moolenaar6ebe4f92022-10-28 20:47:54 +01003204 is on, or 'fixeol' option is off, no CTRL-Z will be written at the
Bram Moolenaarfb0cf232022-10-22 11:25:19 +01003205 end of the file.
K.Takata3af98212022-11-01 20:36:19 +00003206 See |eol-and-eof| for example settings.
Bram Moolenaarfb0cf232022-10-22 11:25:19 +01003207
3208 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
3209'endofline' 'eol' boolean (default on)
3210 local to buffer
3211 When writing a file and this option is off and the 'binary' option
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003212 is on, or 'fixeol' option is off, no <EOL> will be written for the
3213 last line in the file. This option is automatically set or reset when
3214 starting to edit a new file, depending on whether file has an <EOL>
3215 for the last line in the file. Normally you don't have to set or
3216 reset this option.
3217 When 'binary' is off and 'fixeol' is on the value is not used when
3218 writing the file. When 'binary' is on or 'fixeol' is off it is used
3219 to remember the presence of a <EOL> for the last line in the file, so
3220 that when you write the file the situation from the original file can
3221 be kept. But you can change it if you want to.
K.Takata3af98212022-11-01 20:36:19 +00003222 See |eol-and-eof| for example settings.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003223
3224 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
3225'equalalways' 'ea' boolean (default on)
3226 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003227 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00003228 splitting or closing a window. This also happens the moment the
3229 option is switched on. When off, splitting a window will reduce the
3230 size of the current window and leave the other windows the same. When
3231 closing a window the extra lines are given to the window next to it
3232 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00003233 When mixing vertically and horizontally split windows, a minimal size
3234 is computed and some windows may be larger if there is room. The
3235 'eadirection' option tells in which direction the size is affected.
Bram Moolenaar67f71312007-08-12 14:55:56 +00003236 Changing the height and width of a window can be avoided by setting
3237 'winfixheight' and 'winfixwidth', respectively.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003238 If a window size is specified when creating a new window sizes are
3239 currently not equalized (it's complicated, but may be implemented in
3240 the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +00003241
3242 *'equalprg'* *'ep'*
3243'equalprg' 'ep' string (default "")
3244 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003245 External program to use for "=" command. When this option is empty
Bram Moolenaar446cb832008-06-24 21:56:24 +00003246 the internal formatting functions are used; either 'lisp', 'cindent'
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003247 or 'indentexpr'. When Vim was compiled without internal formatting,
3248 the "indent" program is used.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003249 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003250 about including spaces and backslashes.
3251 This option cannot be set from a |modeline| or in the |sandbox|, for
3252 security reasons.
3253
3254 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
3255'errorbells' 'eb' boolean (default off)
3256 global
3257 Ring the bell (beep or screen flash) for error messages. This only
3258 makes a difference for error messages, the bell will be used always
3259 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003260 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar165bc692015-07-21 17:53:25 +02003261 screen flash or do nothing. See 'belloff' to finetune when to ring the
3262 bell.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003263
3264 *'errorfile'* *'ef'*
3265'errorfile' 'ef' string (Amiga default: "AztecC.Err",
3266 others: "errors.err")
3267 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003268 {not available when compiled without the |+quickfix|
3269 feature}
3270 Name of the errorfile for the QuickFix mode (see |:cf|).
3271 When the "-q" command-line argument is used, 'errorfile' is set to the
3272 following argument. See |-q|.
3273 NOT used for the ":make" command. See 'makeef' for that.
3274 Environment variables are expanded |:set_env|.
3275 See |option-backslash| about including spaces and backslashes.
3276 This option cannot be set from a |modeline| or in the |sandbox|, for
3277 security reasons.
3278
3279 *'errorformat'* *'efm'*
3280'errorformat' 'efm' string (default is very long)
3281 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003282 {not available when compiled without the |+quickfix|
3283 feature}
3284 Scanf-like description of the format for the lines in the error file
3285 (see |errorformat|).
3286
3287 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
3288'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
3289 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003290 Function keys that start with an <Esc> are recognized in Insert
3291 mode. When this option is off, the cursor and function keys cannot be
3292 used in Insert mode if they start with an <Esc>. The advantage of
3293 this is that the single <Esc> is recognized immediately, instead of
3294 after one second. Instead of resetting this option, you might want to
3295 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
3296 when 'esckeys' is off, you can still map anything, but the cursor keys
3297 won't work by default.
3298 NOTE: This option is set to the Vi default value when 'compatible' is
3299 set and to the Vim default value when 'compatible' is reset.
Christian Brabandt5f5131d2023-10-25 21:44:26 +02003300 NOTE: when this option is off then the |modifyOtherKeys| and
3301 |xterm-bracketed-paste| functionality is disabled while in Insert mode
3302 to avoid ending Insert mode with any key that has a modifier.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003303
3304 *'eventignore'* *'ei'*
3305'eventignore' 'ei' string (default "")
3306 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003307 A list of autocommand event names, which are to be ignored.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00003308 When set to "all" or when "all" is one of the items, all autocommand
3309 events are ignored, autocommands will not be executed.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01003310 Otherwise this is a comma-separated list of event names. Example: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00003311 :set ei=WinEnter,WinLeave
3312<
Luuk van Baalb7147f82025-02-08 18:52:39 +01003313 *'eventignorewin'* *'eiw'*
3314'eventignorewin' 'eiw' string (default "")
3315 window-local
3316 Similar to 'eventignore' but applies to a particular window and its
3317 buffers, for which window and buffer related autocommands can be
3318 ignored indefinitely without affecting the global 'eventignore'.
3319
Bram Moolenaar071d4272004-06-13 20:20:40 +00003320 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
3321'expandtab' 'et' boolean (default off)
3322 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003323 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003324 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00003325 when 'autoindent' is on. To insert a real tab when 'expandtab' is
3326 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
Bram Moolenaarca635012015-09-25 20:34:21 +02003327 This option is reset when the 'paste' option is set and restored when
3328 the 'paste' option is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003329 NOTE: This option is reset when 'compatible' is set.
3330
3331 *'exrc'* *'ex'* *'noexrc'* *'noex'*
3332'exrc' 'ex' boolean (default off)
3333 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003334 Enables the reading of .vimrc, .exrc and .gvimrc in the current
Bram Moolenaar36f44c22016-08-28 18:17:20 +02003335 directory.
3336
3337 Setting this option is a potential security leak. E.g., consider
3338 unpacking a package or fetching files from github, a .vimrc in there
3339 might be a trojan horse. BETTER NOT SET THIS OPTION!
3340 Instead, define an autocommand in your .vimrc to set options for a
3341 matching directory.
3342
3343 If you do switch this option on you should also consider setting the
3344 'secure' option (see |initialization|).
3345 Also see |.vimrc| and |gui-init|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003346 This option cannot be set from a |modeline| or in the |sandbox|, for
3347 security reasons.
3348
3349 *'fileencoding'* *'fenc'* *E213*
3350'fileencoding' 'fenc' string (default: "")
3351 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003352 Sets the character encoding for the file of this buffer.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003353
Bram Moolenaar071d4272004-06-13 20:20:40 +00003354 When 'fileencoding' is different from 'encoding', conversion will be
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003355 done when writing the file. For reading see below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003356 When 'fileencoding' is empty, the same value as 'encoding' will be
3357 used (no conversion when reading or writing a file).
Bram Moolenaar214641f2017-03-05 17:04:09 +01003358 No error will be given when the value is set, only when it is used,
3359 only when writing a file.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003360 Conversion will also be done when 'encoding' and 'fileencoding' are
3361 both a Unicode encoding and 'fileencoding' is not utf-8. That's
3362 because internally Unicode is always stored as utf-8.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003363 WARNING: Conversion can cause loss of information! When
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003364 'encoding' is "utf-8" or another Unicode encoding, conversion
3365 is most likely done in a way that the reverse conversion
3366 results in the same text. When 'encoding' is not "utf-8" some
3367 characters may be lost!
Bram Moolenaar865242e2010-07-14 21:12:05 +02003368
Bram Moolenaar071d4272004-06-13 20:20:40 +00003369 See 'encoding' for the possible values. Additionally, values may be
3370 specified that can be handled by the converter, see
3371 |mbyte-conversion|.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003372
Bram Moolenaar071d4272004-06-13 20:20:40 +00003373 When reading a file 'fileencoding' will be set from 'fileencodings'.
3374 To read a file in a certain encoding it won't work by setting
Bram Moolenaar02467872007-05-06 13:22:01 +00003375 'fileencoding', use the |++enc| argument. One exception: when
3376 'fileencodings' is empty the value of 'fileencoding' is used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003377 For a new file the global value of 'fileencoding' is used.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003378
Bram Moolenaar071d4272004-06-13 20:20:40 +00003379 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
3380 When the option is set, the value is converted to lowercase. Thus
3381 you can set it with uppercase values too. '_' characters are
3382 replaced with '-'. If a name is recognized from the list for
3383 'encoding', it is replaced by the standard name. For example
3384 "ISO8859-2" becomes "iso-8859-2".
Bram Moolenaar865242e2010-07-14 21:12:05 +02003385
Bram Moolenaar071d4272004-06-13 20:20:40 +00003386 When this option is set, after starting to edit a file, the 'modified'
3387 option is set, because the file would be different when written.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003388
3389 Keep in mind that changing 'fenc' from a modeline happens
3390 AFTER the text has been read, thus it applies to when the file will be
3391 written. If you do set 'fenc' in a modeline, you might want to set
3392 'nomodified' to avoid not being able to ":q".
3393
Bram Moolenaar071d4272004-06-13 20:20:40 +00003394 This option can not be changed when 'modifiable' is off.
3395
3396 *'fe'*
3397 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003398 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003399 old short name was 'fe', which is no longer used.
3400
3401 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003402'fileencodings' 'fencs' string (default: "ucs-bom",
3403 "ucs-bom,utf-8,default,latin1" when
3404 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003405 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003406 This is a list of character encodings considered when starting to edit
3407 an existing file. When a file is read, Vim tries to use the first
3408 mentioned character encoding. If an error is detected, the next one
3409 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003410 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00003411 an empty string, which means the value of 'encoding' is used.
3412 WARNING: Conversion can cause loss of information! When
3413 'encoding' is "utf-8" (or one of the other Unicode variants)
3414 conversion is most likely done in a way that the reverse
3415 conversion results in the same text. When 'encoding' is not
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003416 "utf-8" some non-ASCII characters may be lost! You can use
3417 the |++bad| argument to specify what is done with characters
3418 that can't be converted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003419 For an empty file or a file with only ASCII characters most encodings
3420 will work and the first entry of 'fileencodings' will be used (except
3421 "ucs-bom", which requires the BOM to be present). If you prefer
3422 another encoding use an BufReadPost autocommand event to test if your
3423 preferred encoding is to be used. Example: >
3424 au BufReadPost * if search('\S', 'w') == 0 |
3425 \ set fenc=iso-2022-jp | endif
3426< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
3427 non-blank characters.
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003428 When the |++enc| argument is used then the value of 'fileencodings' is
3429 not used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003430 Note that 'fileencodings' is not used for a new file, the global value
3431 of 'fileencoding' is used instead. You can set it with: >
3432 :setglobal fenc=iso-8859-2
3433< This means that a non-existing file may get a different encoding than
3434 an empty file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003435 The special value "ucs-bom" can be used to check for a Unicode BOM
3436 (Byte Order Mark) at the start of the file. It must not be preceded
3437 by "utf-8" or another Unicode encoding for this to work properly.
3438 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
3439 because Vim cannot detect an error, thus the encoding is always
3440 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003441 The special value "default" can be used for the encoding from the
K.Takataef8706f2021-05-31 18:40:49 +02003442 environment. On MS-Windows this is the system encoding. Otherwise
3443 this is the default value for 'encoding'. It is useful when
3444 'encoding' is set to "utf-8" and your environment uses a non-latin1
3445 encoding, such as Russian.
Bram Moolenaarca003e12006-03-17 23:19:38 +00003446 When 'encoding' is "utf-8" and a file contains an illegal byte
3447 sequence it won't be recognized as UTF-8. You can use the |8g8|
3448 command to find the illegal byte sequence.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003449 WRONG VALUES: WHAT'S WRONG:
3450 latin1,utf-8 "latin1" will always be used
3451 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
3452 file
3453 cp1250,latin1 "cp1250" will always be used
3454 If 'fileencodings' is empty, 'fileencoding' is not modified.
3455 See 'fileencoding' for the possible values.
3456 Setting this option does not have an effect until the next time a file
3457 is read.
3458
3459 *'fileformat'* *'ff'*
Bram Moolenaar00590742019-02-15 21:06:09 +01003460'fileformat' 'ff' string (MS-Windows default: "dos",
Yee Cheng Chin92b59c62024-10-22 21:16:43 +02003461 Unix default: "unix")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003462 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003463 This gives the <EOL> of the current buffer, which is used for
3464 reading/writing the buffer from/to a file:
Bram Moolenaar4072ba52020-12-23 13:56:35 +01003465 dos <CR><NL>
Bram Moolenaar071d4272004-06-13 20:20:40 +00003466 unix <NL>
3467 mac <CR>
3468 When "dos" is used, CTRL-Z at the end of a file is ignored.
3469 See |file-formats| and |file-read|.
3470 For the character encoding of the file see 'fileencoding'.
3471 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
Bram Moolenaarbf884932013-04-05 22:26:15 +02003472 works like it was set to "unix".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003473 This option is set automatically when starting to edit a file and
3474 'fileformats' is not empty and 'binary' is off.
3475 When this option is set, after starting to edit a file, the 'modified'
3476 option is set, because the file would be different when written.
3477 This option can not be changed when 'modifiable' is off.
3478 For backwards compatibility: When this option is set to "dos",
3479 'textmode' is set, otherwise 'textmode' is reset.
3480
3481 *'fileformats'* *'ffs'*
3482'fileformats' 'ffs' string (default:
Bram Moolenaar00590742019-02-15 21:06:09 +01003483 Vim+Vi MS-Windows: "dos,unix",
Yee Cheng Chin92b59c62024-10-22 21:16:43 +02003484 Vim Unix: "unix,dos",
Bram Moolenaar071d4272004-06-13 20:20:40 +00003485 Vi Cygwin: "unix,dos",
3486 Vi others: "")
3487 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003488 This gives the end-of-line (<EOL>) formats that will be tried when
3489 starting to edit a new buffer and when reading a file into an existing
3490 buffer:
3491 - When empty, the format defined with 'fileformat' will be used
3492 always. It is not set automatically.
3493 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003494 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003495 'fileformats' name will be used when a file is read into an existing
3496 buffer, no matter what 'fileformat' for that buffer is set to.
3497 - When more than one name is present, separated by commas, automatic
3498 <EOL> detection will be done when reading a file. When starting to
3499 edit a file, a check is done for the <EOL>:
3500 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
3501 'fileformat' is set to "dos".
3502 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003503 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003504 preceding <CR>, "unix" is preferred over "dos".
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01003505 3. If 'fileformat' has not yet been set, and if a <CR> is found, and
3506 if 'fileformats' includes "mac", 'fileformat' is set to "mac".
Bram Moolenaar00659062010-09-21 22:34:02 +02003507 This means that "mac" is only chosen when:
3508 "unix" is not present or no <NL> is found in the file, and
3509 "dos" is not present or no <CR><NL> is found in the file.
3510 Except: if "unix" was chosen, but there is a <CR> before
3511 the first <NL>, and there appear to be more <CR>s than <NL>s in
Bram Moolenaar166af9b2010-11-16 20:34:40 +01003512 the first few lines, "mac" is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003513 4. If 'fileformat' is still not set, the first name from
3514 'fileformats' is used.
3515 When reading a file into an existing buffer, the same is done, but
3516 this happens like 'fileformat' has been set appropriately for that
3517 file only, the option is not changed.
3518 When 'binary' is set, the value of 'fileformats' is not used.
3519
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01003520 When Vim starts up with an empty buffer the first item is used. You
3521 can overrule this by setting 'fileformat' in your .vimrc.
Bram Moolenaar81af9252010-12-10 20:35:50 +01003522
Bram Moolenaar071d4272004-06-13 20:20:40 +00003523 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
3524 are ":source"ed and for vimrc files, automatic <EOL> detection may be
3525 done:
3526 - When 'fileformats' is empty, there is no automatic detection. Dos
3527 format will be used.
3528 - When 'fileformats' is set to one or more names, automatic detection
3529 is done. This is based on the first <NL> in the file: If there is a
3530 <CR> in front of it, Dos format is used, otherwise Unix format is
3531 used.
3532 Also see |file-formats|.
3533 For backwards compatibility: When this option is set to an empty
3534 string or one format (no comma is included), 'textauto' is reset,
3535 otherwise 'textauto' is set.
3536 NOTE: This option is set to the Vi default value when 'compatible' is
3537 set and to the Vim default value when 'compatible' is reset.
3538
Bram Moolenaarbf884932013-04-05 22:26:15 +02003539 *'fileignorecase'* *'fic'* *'nofileignorecase'* *'nofic'*
3540'fileignorecase' 'fic' boolean (default on for systems where case in file
3541 names is normally ignored)
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003542 global
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003543 When set case is ignored when using file names and directories.
3544 See 'wildignorecase' for only ignoring case when doing completion.
3545
Bram Moolenaar071d4272004-06-13 20:20:40 +00003546 *'filetype'* *'ft'*
3547'filetype' 'ft' string (default: "")
Christian Brabandt596ad662023-08-16 00:11:09 +02003548 local to buffer |local-noglobal|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003549 When this option is set, the FileType autocommand event is triggered.
3550 All autocommands that match with the value of this option will be
3551 executed. Thus the value of 'filetype' is used in place of the file
3552 name.
3553 Otherwise this option does not always reflect the current file type.
3554 This option is normally set when the file type is detected. To enable
3555 this use the ":filetype on" command. |:filetype|
3556 Setting this option to a different value is most useful in a modeline,
3557 for a file for which the file type is not automatically recognized.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003558 Example, for in an IDL file:
3559 /* vim: set filetype=idl : */ ~
3560 |FileType| |filetypes|
3561 When a dot appears in the value then this separates two filetype
Millyae62fe52024-10-02 19:30:41 +02003562 names, it should therefore not be used for a filetype. Example:
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003563 /* vim: set filetype=c.doxygen : */ ~
3564 This will use the "c" filetype first, then the "doxygen" filetype.
3565 This works both for filetype plugins and for syntax files. More than
3566 one dot may appear.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003567 This option is not copied to another buffer, independent of the 's' or
3568 'S' flag in 'cpoptions'.
Millyae62fe52024-10-02 19:30:41 +02003569 Only alphanumeric characters, '-' and '_' can be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003570
3571 *'fillchars'* *'fcs'*
Yee Cheng Chin39cd9062024-11-06 20:20:57 +01003572'fillchars' 'fcs' string (default "vert:|,fold:-,eob:~,lastline:@")
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003573 global or local to window |global-local|
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003574 Characters to fill the statuslines, vertical separators and special
3575 lines in the window.
3576 It is a comma-separated list of items. Each item has a name, a colon
zeertzjq6a8d2e12024-01-17 20:54:49 +01003577 and the value of that item: |E1511|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003578
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003579 item name default Used for ~
Christian Brabandt6a650bf2023-11-08 21:23:29 +01003580 stl ' ' statusline of the current window
3581 stlnc ' ' statusline of the non-current windows
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003582 vert '|' vertical separators |:vsplit|
3583 fold '-' filling 'foldtext'
3584 foldopen '-' mark the beginning of a fold
3585 foldclose '+' show a closed fold
3586 foldsep '|' open fold middle character
3587 diff '-' deleted lines of the 'diff' option
3588 eob '~' empty lines below the end of a buffer
Bram Moolenaar4ba5f1d2022-10-04 14:36:29 +01003589 lastline '@' 'display' contains lastline/truncate
Bram Moolenaar071d4272004-06-13 20:20:40 +00003590
Christian Brabandt6a650bf2023-11-08 21:23:29 +01003591 Any one that is omitted will fall back to the default.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003592
3593 Example: >
Christian Brabandt6a650bf2023-11-08 21:23:29 +01003594 :set fillchars=stl:\ ,stlnc:\ ,vert:\|,fold:-,diff:-
3595<
Bram Moolenaar8cc5b552022-06-23 13:04:20 +01003596 For the "stl", "stlnc", "foldopen", "foldclose" and "foldsep" items
3597 single-byte and multibyte characters are supported. But double-width
zeertzjq6a8d2e12024-01-17 20:54:49 +01003598 characters are not supported. |E1512|
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003599
Bram Moolenaar071d4272004-06-13 20:20:40 +00003600 The highlighting used for these items:
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003601 item name highlight group ~
3602 stl StatusLine |hl-StatusLine|
3603 stlnc StatusLineNC |hl-StatusLineNC|
3604 vert VertSplit |hl-VertSplit|
3605 fold Folded |hl-Folded|
3606 diff DiffDelete |hl-DiffDelete|
3607 eob EndOfBuffer |hl-EndOfBuffer|
Bram Moolenaar4ba5f1d2022-10-04 14:36:29 +01003608 lastline NonText |hl-NonText|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003609
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +01003610 *'findfunc'* *'ffu'* *E1514*
3611'findfunc' 'ffu' string (default empty)
Yegappan Lakshmananaeb1c972024-10-22 23:42:20 +02003612 global or local to buffer |global-local|
3613 {not available when compiled without the |+eval|
3614 feature}
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +01003615 Function that is called to obtain the filename(s) for the |:find|
Yegappan Lakshmananaeb1c972024-10-22 23:42:20 +02003616 command. When this option is empty, the internal |file-searching|
3617 mechanism is used.
3618
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +01003619 The value can be the name of a function, a |lambda| or a |Funcref|.
3620 See |option-value-function| for more information.
Yegappan Lakshmananaeb1c972024-10-22 23:42:20 +02003621
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +01003622 The function is called with two arguments. The first argument is a
3623 |String| and is the |:find| command argument. The second argument is
3624 a |Boolean| and is set to |v:true| when the function is called to get
3625 a List of command-line completion matches for the |:find| command.
3626 The function should return a List of strings.
Yegappan Lakshmananaeb1c972024-10-22 23:42:20 +02003627
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +01003628 The function is called only once per |:find| command invocation.
3629 The function can process all the directories specified in 'path'.
zeertzjq20e045f2024-10-28 22:05:26 +01003630
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +01003631 If a match is found, the function should return a |List| containing
3632 one or more file names. If a match is not found, the function
Yegappan Lakshmananaeb1c972024-10-22 23:42:20 +02003633 should return an empty List.
3634
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +01003635 If any errors are encountered during the function invocation, an
Yegappan Lakshmananaeb1c972024-10-22 23:42:20 +02003636 empty List is used as the return value.
3637
Yegappan Lakshmananaeb1c972024-10-22 23:42:20 +02003638 It is not allowed to change text or jump to another window while
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +01003639 executing the 'findfunc' |textlock|.
Yegappan Lakshmananaeb1c972024-10-22 23:42:20 +02003640
3641 This option cannot be set from a |modeline| or in the |sandbox|, for
3642 security reasons.
3643
3644 Examples:
3645>
3646 " Use glob()
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +01003647 func FindFuncGlob(cmdarg, cmdcomplete)
3648 let pat = a:cmdcomplete ? $'{a:cmdarg}*' : a:cmdarg
zeertzjq20e045f2024-10-28 22:05:26 +01003649 return glob(pat, v:false, v:true)
Yegappan Lakshmananaeb1c972024-10-22 23:42:20 +02003650 endfunc
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +01003651 set findfunc=FindFuncGlob
Yegappan Lakshmananaeb1c972024-10-22 23:42:20 +02003652
3653 " Use the 'git ls-files' output
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +01003654 func FindGitFiles(cmdarg, cmdcomplete)
Yegappan Lakshmananaeb1c972024-10-22 23:42:20 +02003655 let fnames = systemlist('git ls-files')
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +01003656 return fnames->filter('v:val =~? a:cmdarg')
Yegappan Lakshmananaeb1c972024-10-22 23:42:20 +02003657 endfunc
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +01003658 set findfunc=FindGitFiles
Yegappan Lakshmananaeb1c972024-10-22 23:42:20 +02003659<
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003660 *'fixendofline'* *'fixeol'* *'nofixendofline'* *'nofixeol'*
3661'fixendofline' 'fixeol' boolean (default on)
3662 local to buffer
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003663 When writing a file and this option is on, <EOL> at the end of file
Bram Moolenaarfb0cf232022-10-22 11:25:19 +01003664 will be restored if missing. Turn this option off if you want to
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003665 preserve the situation from the original file.
3666 When the 'binary' option is set the value of this option doesn't
3667 matter.
3668 See the 'endofline' option.
K.Takata3af98212022-11-01 20:36:19 +00003669 See |eol-and-eof| for example settings.
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003670
Bram Moolenaar071d4272004-06-13 20:20:40 +00003671 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
Bram Moolenaar98a29d02021-01-18 19:55:44 +01003672'fkmap' 'fk' boolean (default off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003673 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003674 {only available when compiled with the |+rightleft|
3675 feature}
Bram Moolenaar14184a32019-02-16 15:10:30 +01003676 This option was for using Farsi, which has been removed. See
3677 |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003678
3679 *'foldclose'* *'fcl'*
3680'foldclose' 'fcl' string (default "")
3681 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003682 {not available when compiled without the |+folding|
3683 feature}
3684 When set to "all", a fold is closed when the cursor isn't in it and
3685 its level is higher than 'foldlevel'. Useful if you want folds to
3686 automatically close when moving out of them.
3687
3688 *'foldcolumn'* *'fdc'*
3689'foldcolumn' 'fdc' number (default 0)
3690 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003691 {not available when compiled without the |+folding|
3692 feature}
3693 When non-zero, a column with the specified width is shown at the side
3694 of the window which indicates open and closed folds. The maximum
3695 value is 12.
3696 See |folding|.
3697
3698 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
3699'foldenable' 'fen' boolean (default on)
3700 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003701 {not available when compiled without the |+folding|
3702 feature}
3703 When off, all folds are open. This option can be used to quickly
3704 switch between showing all text unfolded and viewing the text with
3705 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003706 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00003707 'foldenable' is off.
3708 This option is set by commands that create a new fold or close a fold.
3709 See |folding|.
3710
3711 *'foldexpr'* *'fde'*
3712'foldexpr' 'fde' string (default: "0")
3713 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003714 {not available when compiled without the |+folding|
Bram Moolenaardb84e452010-08-15 13:50:43 +02003715 or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003716 The expression used for when 'foldmethod' is "expr". It is evaluated
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00003717 for each line to obtain its fold level. The context is set to the
3718 script where 'foldexpr' was set, script-local items can be accessed.
3719 See |fold-expr| for the usage.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003720
Bram Moolenaar30b65812012-07-12 22:01:11 +02003721 The expression will be evaluated in the |sandbox| if set from a
3722 modeline, see |sandbox-option|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003723 This option can't be set from a |modeline| when the 'diff' option is
Bram Moolenaar110289e2019-05-23 15:38:06 +02003724 on or the 'modelineexpr' option is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003725
3726 It is not allowed to change text or jump to another window while
3727 evaluating 'foldexpr' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003728
3729 *'foldignore'* *'fdi'*
3730'foldignore' 'fdi' string (default: "#")
3731 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003732 {not available when compiled without the |+folding|
3733 feature}
3734 Used only when 'foldmethod' is "indent". Lines starting with
3735 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003736 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003737 The default "#" works well for C programs. See |fold-indent|.
3738
3739 *'foldlevel'* *'fdl'*
3740'foldlevel' 'fdl' number (default: 0)
3741 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003742 {not available when compiled without the |+folding|
3743 feature}
3744 Sets the fold level: Folds with a higher level will be closed.
3745 Setting this option to zero will close all folds. Higher numbers will
3746 close fewer folds.
3747 This option is set by commands like |zm|, |zM| and |zR|.
3748 See |fold-foldlevel|.
3749
3750 *'foldlevelstart'* *'fdls'*
3751'foldlevelstart' 'fdls' number (default: -1)
3752 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003753 {not available when compiled without the |+folding|
3754 feature}
3755 Sets 'foldlevel' when starting to edit another buffer in a window.
3756 Useful to always start editing with all folds closed (value zero),
3757 some folds closed (one) or no folds closed (99).
3758 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003759 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00003760 ignores this option and closes all folds.
3761 It is also done before BufReadPre autocommands, to allow an autocmd to
3762 overrule the 'foldlevel' value for specific files.
3763 When the value is negative, it is not used.
3764
3765 *'foldmarker'* *'fmr'* *E536*
3766'foldmarker' 'fmr' string (default: "{{{,}}}")
3767 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003768 {not available when compiled without the |+folding|
3769 feature}
3770 The start and end marker used when 'foldmethod' is "marker". There
3771 must be one comma, which separates the start and end marker. The
3772 marker is a literal string (a regular expression would be too slow).
3773 See |fold-marker|.
3774
3775 *'foldmethod'* *'fdm'*
3776'foldmethod' 'fdm' string (default: "manual")
3777 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003778 {not available when compiled without the |+folding|
3779 feature}
3780 The kind of folding used for the current window. Possible values:
3781 |fold-manual| manual Folds are created manually.
3782 |fold-indent| indent Lines with equal indent form a fold.
3783 |fold-expr| expr 'foldexpr' gives the fold level of a line.
3784 |fold-marker| marker Markers are used to specify folds.
3785 |fold-syntax| syntax Syntax highlighting items specify folds.
3786 |fold-diff| diff Fold text that is not changed.
3787
3788 *'foldminlines'* *'fml'*
3789'foldminlines' 'fml' number (default: 1)
3790 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003791 {not available when compiled without the |+folding|
3792 feature}
Bram Moolenaar00654022011-02-25 14:42:19 +01003793 Sets the number of screen lines above which a fold can be displayed
3794 closed. Also for manually closed folds. With the default value of
3795 one a fold can only be closed if it takes up two or more screen lines.
3796 Set to zero to be able to close folds of just one screen line.
Bram Moolenaar446beb42011-05-10 17:18:44 +02003797 Note that this only has an effect on what is displayed. After using
Bram Moolenaar071d4272004-06-13 20:20:40 +00003798 "zc" to close a fold, which is displayed open because it's smaller
3799 than 'foldminlines', a following "zc" may close a containing fold.
3800
3801 *'foldnestmax'* *'fdn'*
3802'foldnestmax' 'fdn' number (default: 20)
3803 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003804 {not available when compiled without the |+folding|
3805 feature}
3806 Sets the maximum nesting of folds for the "indent" and "syntax"
3807 methods. This avoids that too many folds will be created. Using more
3808 than 20 doesn't work, because the internal limit is 20.
3809
3810 *'foldopen'* *'fdo'*
3811'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
3812 search,tag,undo")
3813 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003814 {not available when compiled without the |+folding|
3815 feature}
3816 Specifies for which type of commands folds will be opened, if the
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01003817 command moves the cursor into a closed fold. It is a comma-separated
Bram Moolenaar071d4272004-06-13 20:20:40 +00003818 list of items.
Bram Moolenaar05365702010-10-27 18:34:44 +02003819 NOTE: When the command is part of a mapping this option is not used.
3820 Add the |zv| command to the mapping to get the same effect.
3821 (rationale: the mapping may want to control opening folds itself)
3822
Bram Moolenaar071d4272004-06-13 20:20:40 +00003823 item commands ~
3824 all any
3825 block "(", "{", "[[", "[{", etc.
3826 hor horizontal movements: "l", "w", "fx", etc.
3827 insert any command in Insert mode
3828 jump far jumps: "G", "gg", etc.
3829 mark jumping to a mark: "'m", CTRL-O, etc.
3830 percent "%"
3831 quickfix ":cn", ":crew", ":make", etc.
3832 search search for a pattern: "/", "n", "*", "gd", etc.
3833 (not for a search pattern in a ":" command)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003834 Also for |[s| and |]s|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003835 tag jumping to a tag: ":ta", CTRL-T, etc.
3836 undo undo or redo: "u" and CTRL-R
Bram Moolenaar071d4272004-06-13 20:20:40 +00003837 When a movement command is used for an operator (e.g., "dl" or "y%")
3838 this option is not used. This means the operator will include the
3839 whole closed fold.
3840 Note that vertical movements are not here, because it would make it
3841 very difficult to move onto a closed fold.
3842 In insert mode the folds containing the cursor will always be open
3843 when text is inserted.
3844 To close folds you can re-apply 'foldlevel' with the |zx| command or
3845 set the 'foldclose' option to "all".
3846
3847 *'foldtext'* *'fdt'*
3848'foldtext' 'fdt' string (default: "foldtext()")
3849 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003850 {not available when compiled without the |+folding|
3851 feature}
3852 An expression which is used to specify the text displayed for a closed
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00003853 fold. The context is set to the script where 'foldexpr' was set,
3854 script-local items can be accessed. See |fold-foldtext| for the
3855 usage.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003856
Bram Moolenaar30b65812012-07-12 22:01:11 +02003857 The expression will be evaluated in the |sandbox| if set from a
3858 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003859 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003860
3861 It is not allowed to change text or jump to another window while
3862 evaluating 'foldtext' |textlock|.
3863
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003864 *'formatexpr'* *'fex'*
3865'formatexpr' 'fex' string (default "")
3866 local to buffer
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003867 {not available when compiled without the |+eval|
3868 feature}
3869 Expression which is evaluated to format a range of lines for the |gq|
3870 operator or automatic formatting (see 'formatoptions'). When this
3871 option is empty 'formatprg' is used.
3872
3873 The |v:lnum| variable holds the first line to be formatted.
3874 The |v:count| variable holds the number of lines to be formatted.
3875 The |v:char| variable holds the character that is going to be
3876 inserted if the expression is being evaluated due to
3877 automatic formatting. This can be empty. Don't insert
3878 it yet!
3879
3880 Example: >
3881 :set formatexpr=mylang#Format()
3882< This will invoke the mylang#Format() function in the
3883 autoload/mylang.vim file in 'runtimepath'. |autoload|
3884
Bram Moolenaara4e0b972022-10-01 19:43:52 +01003885 The advantage of using a function call without arguments is that it is
3886 faster, see |expr-option-function|.
3887
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003888 The expression is also evaluated when 'textwidth' is set and adding
3889 text beyond that limit. This happens under the same conditions as
3890 when internal formatting is used. Make sure the cursor is kept in the
3891 same spot relative to the text then! The |mode()| function will
3892 return "i" or "R" in this situation.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01003893
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003894 When the expression evaluates to non-zero Vim will fall back to using
3895 the internal format mechanism.
3896
Yegappan Lakshmanan8bb65f22021-12-26 10:51:39 +00003897 If the expression starts with s: or |<SID>|, then it is replaced with
3898 the script ID (|local-function|). Example: >
3899 set formatexpr=s:MyFormatExpr()
3900 set formatexpr=<SID>SomeFormatExpr()
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00003901< Otherwise, the expression is evaluated in the context of the script
3902 where the option was set, thus script-local items are available.
3903
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003904 The expression will be evaluated in the |sandbox| when set from a
3905 modeline, see |sandbox-option|. That stops the option from working,
3906 since changing the buffer text is not allowed.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003907 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaar036986f2017-03-16 17:41:02 +01003908 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003909
Bram Moolenaar86b68352004-12-27 21:59:20 +00003910 *'formatlistpat'* *'flp'*
3911'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
3912 local to buffer
Bram Moolenaar86b68352004-12-27 21:59:20 +00003913 A pattern that is used to recognize a list header. This is used for
3914 the "n" flag in 'formatoptions'.
3915 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00003916 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00003917 while still checking more characters. There must be a character
3918 following the pattern, when it matches the whole line it is handled
3919 like there is no match.
3920 The default recognizes a number, followed by an optional punctuation
3921 character and white space.
3922
Bram Moolenaar6c60f472019-04-28 16:00:35 +02003923 *'formatoptions'* *'fo'*
3924'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
3925 local to buffer
3926 This is a sequence of letters which describes how automatic
Christian Brabandt1b08d2c2023-11-11 15:50:13 +01003927 formatting is to be done.
3928 See |fo-table| for possible values and |gq| for how to format text.
3929 When the 'paste' option is on, no formatting is done (like
3930 'formatoptions' is empty). Commas can be inserted for readability.
Bram Moolenaar6c60f472019-04-28 16:00:35 +02003931 To avoid problems with flags that are added in the future, use the
3932 "+=" and "-=" feature of ":set" |add-option-flags|.
3933 NOTE: This option is set to the Vi default value when 'compatible' is
3934 set and to the Vim default value when 'compatible' is reset.
3935
Bram Moolenaar071d4272004-06-13 20:20:40 +00003936 *'formatprg'* *'fp'*
3937'formatprg' 'fp' string (default "")
Bram Moolenaar9be7c042017-01-14 14:28:30 +01003938 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003939 The name of an external program that will be used to format the lines
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003940 selected with the |gq| operator. The program must take the input on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003941 stdin and produce the output on stdout. The Unix program "fmt" is
Bram Moolenaara5792f52005-11-23 21:25:05 +00003942 such a program.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003943 If the 'formatexpr' option is not empty it will be used instead.
3944 Otherwise, if 'formatprg' option is an empty string, the internal
3945 format function will be used |C-indenting|.
Bram Moolenaara5792f52005-11-23 21:25:05 +00003946 Environment variables are expanded |:set_env|. See |option-backslash|
3947 about including spaces and backslashes.
Bram Moolenaar30b65812012-07-12 22:01:11 +02003948 This option cannot be set from a |modeline| or in the |sandbox|, for
3949 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003950
Bram Moolenaard94464e2015-11-02 15:28:18 +01003951 *'fsync'* *'fs'* *'nofsync'* *'nofs'*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003952'fsync' 'fs' boolean (default on)
3953 global
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003954 When on, the library function fsync() will be called after writing a
3955 file. This will flush a file to disk, ensuring that it is safely
3956 written even on filesystems which do metadata-only journaling. This
3957 will force the harddrive to spin up on Linux systems running in laptop
3958 mode, so it may be undesirable in some situations. Be warned that
3959 turning this off increases the chances of data loss after a crash. On
3960 systems without an fsync() implementation, this variable is always
3961 off.
3962 Also see 'swapsync' for controlling fsync() on swap files.
Bram Moolenaar340dd0f2021-10-14 17:52:23 +01003963 'fsync' also applies to |writefile()| (unless a flag is used to
3964 overrule it) and when writing undo files (see |undo-persistence|).
Bram Moolenaar110289e2019-05-23 15:38:06 +02003965 This option cannot be set from a |modeline| or in the |sandbox|, for
3966 security reasons.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003967
Bram Moolenaar071d4272004-06-13 20:20:40 +00003968 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
3969'gdefault' 'gd' boolean (default off)
3970 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003971 When on, the ":substitute" flag 'g' is default on. This means that
3972 all matches in a line are substituted instead of one. When a 'g' flag
3973 is given to a ":substitute" command, this will toggle the substitution
3974 of all or one match. See |complex-change|.
3975
3976 command 'gdefault' on 'gdefault' off ~
3977 :s/// subst. all subst. one
3978 :s///g subst. one subst. all
3979 :s///gg subst. all subst. one
3980
3981 NOTE: This option is reset when 'compatible' is set.
dundargoc82f19732023-12-16 14:53:52 +01003982 Setting this option may break plugins that rely on the default
3983 behavior of the 'g' flag. This will also make the 'g' flag have the
3984 opposite effect of that documented in |:s_g|.
Bram Moolenaar4072ba52020-12-23 13:56:35 +01003985 This option is not used in |Vim9| script.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003986
3987 *'grepformat'* *'gfm'*
Bram Moolenaar6e932462014-09-09 18:48:09 +02003988'grepformat' 'gfm' string (default "%f:%l:%m,%f:%l%m,%f %l%m")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003989 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003990 Format to recognize for the ":grep" command output.
3991 This is a scanf-like string that uses the same format as the
3992 'errorformat' option: see |errorformat|.
3993
3994 *'grepprg'* *'gp'*
3995'grepprg' 'gp' string (default "grep -n ",
3996 Unix: "grep -n $* /dev/null",
3997 Win32: "findstr /n" or "grep -n",
3998 VMS: "SEARCH/NUMBERS ")
3999 global or local to buffer |global-local|
Bram Moolenaar582fd852005-03-28 20:58:01 +00004000 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00004001 and '#' characters, which are expanded like when used in a command-
4002 line. The placeholder "$*" is allowed to specify where the arguments
4003 will be included. Environment variables are expanded |:set_env|. See
4004 |option-backslash| about including spaces and backslashes.
4005 When your "grep" accepts the "-H" argument, use this to make ":grep"
4006 also work well with a single file: >
4007 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00004008< Special value: When 'grepprg' is set to "internal" the |:grep| command
Bram Moolenaara6557602006-02-04 22:43:20 +00004009 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like
4010 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00004011 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00004012 apply equally to 'grepprg'.
4013 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
4014 otherwise it's "grep -n".
4015 This option cannot be set from a |modeline| or in the |sandbox|, for
4016 security reasons.
4017
4018 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
4019'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
4020 ve:ver35-Cursor,
4021 o:hor50-Cursor,
4022 i-ci:ver25-Cursor/lCursor,
4023 r-cr:hor20-Cursor/lCursor,
4024 sm:block-Cursor
4025 -blinkwait175-blinkoff150-blinkon175",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01004026 for Win32 console:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004027 "n-v-c:block,o:hor50,i-ci:hor15,
4028 r-cr:hor30,sm:block")
4029 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004030 {only available when compiled with GUI enabled, and
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01004031 for Win32 console}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004032 This option tells Vim what the cursor should look like in different
Bram Moolenaar8024f932020-01-14 19:29:13 +01004033 modes. It fully works in the GUI. In a Win32 console, only the
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01004034 height of the cursor can be changed. This can be done by specifying a
4035 block cursor, or a percentage for a vertical or horizontal cursor.
Bram Moolenaar1e7813a2015-03-31 18:31:03 +02004036 For a console the 't_SI', 't_SR', and 't_EI' escape sequences are
4037 used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004038
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004039 The option is a comma-separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004040 mode-list and an argument-list:
4041 mode-list:argument-list,mode-list:argument-list,..
4042 The mode-list is a dash separated list of these modes:
4043 n Normal mode
4044 v Visual mode
4045 ve Visual mode with 'selection' "exclusive" (same as 'v',
4046 if not specified)
4047 o Operator-pending mode
4048 i Insert mode
4049 r Replace mode
4050 c Command-line Normal (append) mode
4051 ci Command-line Insert mode
4052 cr Command-line Replace mode
4053 sm showmatch in Insert mode
4054 a all modes
4055 The argument-list is a dash separated list of these arguments:
4056 hor{N} horizontal bar, {N} percent of the character height
4057 ver{N} vertical bar, {N} percent of the character width
4058 block block cursor, fills the whole character
4059 [only one of the above three should be present]
4060 blinkwait{N} *cursor-blinking*
4061 blinkon{N}
4062 blinkoff{N}
4063 blink times for cursor: blinkwait is the delay before
4064 the cursor starts blinking, blinkon is the time that
4065 the cursor is shown and blinkoff is the time that the
4066 cursor is not shown. The times are in msec. When one
4067 of the numbers is zero, there is no blinking. The
4068 default is: "blinkwait700-blinkon400-blinkoff250".
4069 These numbers are used for a missing entry. This
4070 means that blinking is enabled by default. To switch
4071 blinking off you can use "blinkon0". The cursor only
4072 blinks when Vim is waiting for input, not while
4073 executing a command.
4074 To make the cursor blink in an xterm, see
4075 |xterm-blink|.
4076 {group-name}
4077 a highlight group name, that sets the color and font
4078 for the cursor
4079 {group-name}/{group-name}
4080 Two highlight group names, the first is used when
4081 no language mappings are used, the other when they
4082 are. |language-mapping|
4083
4084 Examples of parts:
4085 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
4086 block cursor with colors from the "nCursor"
4087 highlight group
4088 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
4089 In Insert and Command-line Insert mode, use a
4090 30% vertical bar cursor with colors from the
4091 "iCursor" highlight group. Blink a bit
4092 faster.
4093
4094 The 'a' mode is different. It will set the given argument-list for
4095 all modes. It does not reset anything to defaults. This can be used
4096 to do a common setting for all modes. For example, to switch off
4097 blinking: "a:blinkon0"
4098
4099 Examples of cursor highlighting: >
4100 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
4101 :highlight Cursor gui=NONE guifg=bg guibg=fg
4102<
4103 *'guifont'* *'gfn'*
Bram Moolenaar251e1912011-06-19 05:09:16 +02004104 *E235* *E596*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004105'guifont' 'gfn' string (default "")
4106 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004107 {only available when compiled with GUI enabled}
4108 This is a list of fonts which will be used for the GUI version of Vim.
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02004109 In its simplest form the value is just one font name.
4110 See |gui-font| for the details.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004111
4112 *'guifontset'* *'gfs'*
4113 *E250* *E252* *E234* *E597* *E598*
4114'guifontset' 'gfs' string (default "")
4115 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004116 {only available when compiled with GUI enabled and
4117 with the |+xfontset| feature}
Bram Moolenaar3df01732017-02-17 22:47:16 +01004118 {not available in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004119 When not empty, specifies two (or more) fonts to be used. The first
4120 one for normal English, the second one for your special language. See
4121 |xfontset|.
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02004122
Bram Moolenaar071d4272004-06-13 20:20:40 +00004123 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
4124'guifontwide' 'gfw' string (default "")
4125 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004126 {only available when compiled with GUI enabled}
4127 When not empty, specifies a comma-separated list of fonts to be used
4128 for double-width characters. The first font that can be loaded is
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02004129 used. See |gui-fontwide|.
Bram Moolenaar0f272122013-01-23 18:37:40 +01004130
Bram Moolenaar071d4272004-06-13 20:20:40 +00004131 *'guiheadroom'* *'ghr'*
4132'guiheadroom' 'ghr' number (default 50)
4133 global
Bram Moolenaar110289e2019-05-23 15:38:06 +02004134 {only for GTK and X11 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004135 The number of pixels subtracted from the screen height when fitting
4136 the GUI window on the screen. Set this before the GUI is started,
4137 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004138 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00004139 lines will be left for window decorations and other items on the
4140 screen. Set it to a negative value to allow windows taller than the
4141 screen.
4142
Dusan Popovic4eeedc02021-10-16 20:52:05 +01004143 *'guiligatures'* *'gli'* *E1243*
4144'guiligatures' 'gli' string (default "")
4145 global
Erik S. V. Jansson8b1e7492024-02-24 14:26:52 +01004146 {only for GTK and Win32 GUI}
Dusan Popovic4eeedc02021-10-16 20:52:05 +01004147 List of ASCII characters that, when combined together, can create more
4148 complex shapes. Each character must be a printable ASCII character
4149 with a value in the 32-127 range.
4150 Example: >
4151 :set guiligatures=!\"#$%&()*+-./:<=>?@[]^_{\|~
4152< Changing this option updates screen output immediately. Set it to an
4153 empty string to disable ligatures.
4154
Bram Moolenaar071d4272004-06-13 20:20:40 +00004155 *'guioptions'* *'go'*
Bram Moolenaar2c64ca12018-10-19 16:22:31 +02004156'guioptions' 'go' string (default "egmrLtT" (MS-Windows,
4157 "t" is removed in |defaults.vim|),
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004158 "aegimrLtT" (GTK and Motif),
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004159 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00004160 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004161 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00004162 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004163 sequence of letters which describes what components and options of the
4164 GUI should be used.
4165 To avoid problems with flags that are added in the future, use the
4166 "+=" and "-=" feature of ":set" |add-option-flags|.
4167
Bram Moolenaar13568252018-03-16 20:46:58 +01004168 Valid characters are as follows:
4169 *'go-!'*
4170 '!' External commands are executed in a terminal window. Without
4171 this flag the MS-Windows GUI will open a console window to
4172 execute the command. The Unix GUI will simulate a dumb
4173 terminal to list the command output.
4174 The terminal window will be positioned at the bottom, and grow
4175 upwards as needed.
Bram Moolenaarba3ff532018-11-04 14:45:49 +01004176 *'go-a'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004177 'a' Autoselect: If present, then whenever VISUAL mode is started,
4178 or the Visual area extended, Vim tries to become the owner of
4179 the windowing system's global selection. This means that the
4180 Visually highlighted text is available for pasting into other
4181 applications as well as into Vim itself. When the Visual mode
4182 ends, possibly due to an operation on the text, or when an
4183 application wants to paste the selection, the highlighted text
4184 is automatically yanked into the "* selection register.
4185 Thus the selection is still available for pasting into other
4186 applications after the VISUAL mode has ended.
4187 If not present, then Vim won't become the owner of the
4188 windowing system's global selection unless explicitly told to
4189 by a yank or delete operation for the "* register.
4190 The same applies to the modeless selection.
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02004191 *'go-P'*
4192 'P' Like autoselect but using the "+ register instead of the "*
Bram Moolenaar3848e002016-03-19 18:42:29 +01004193 register.
Bram Moolenaar02467872007-05-06 13:22:01 +00004194 *'go-A'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004195 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00004196 applies to the modeless selection.
4197
4198 'guioptions' autoselect Visual autoselect modeless ~
4199 "" - -
4200 "a" yes yes
4201 "A" - yes
4202 "aA" yes yes
4203
Bram Moolenaar9fbdbb82022-09-27 17:30:34 +01004204 When using a terminal see the 'clipboard' option.
4205
Bram Moolenaar02467872007-05-06 13:22:01 +00004206 *'go-c'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004207 'c' Use console dialogs instead of popup dialogs for simple
4208 choices.
Bram Moolenaar50bf7ce2019-09-15 13:17:00 +02004209 *'go-d'*
4210 'd' Use dark theme variant if available. Currently only works for
4211 GTK+ GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00004212 *'go-e'*
Bram Moolenaare224ffa2006-03-01 00:01:28 +00004213 'e' Add tab pages when indicated with 'showtabline'.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004214 'guitablabel' can be used to change the text in the labels.
4215 When 'e' is missing a non-GUI tab pages line may be used.
Bram Moolenaard68071d2006-05-02 22:08:30 +00004216 The GUI tabs are only supported on some systems, currently
Bram Moolenaarb3f74062020-02-26 16:16:53 +01004217 GTK, Motif, Mac OS/X, Haiku, and MS-Windows.
Bram Moolenaar02467872007-05-06 13:22:01 +00004218 *'go-f'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004219 'f' Foreground: Don't use fork() to detach the GUI from the shell
4220 where it was started. Use this for programs that wait for the
4221 editor to finish (e.g., an e-mail program). Alternatively you
4222 can use "gvim -f" or ":gui -f" to start the GUI in the
4223 foreground. |gui-fork|
4224 Note: Set this option in the vimrc file. The forking may have
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004225 happened already when the |gvimrc| file is read.
Bram Moolenaar02467872007-05-06 13:22:01 +00004226 *'go-i'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004227 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
4228 corner of the window. It's black&white on non-GTK, because of
4229 limitations of X11. For a color icon, see |X11-icon|.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004230 *'go-m'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004231 'm' Menu bar is present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004232 *'go-M'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004233 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00004234 that this flag must be added in the .vimrc file, before
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004235 switching on syntax or filetype recognition (when the |gvimrc|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004236 file is sourced the system menu has already been loaded; the
Bram Moolenaar01164a62017-11-02 22:58:42 +01004237 `:syntax on` and `:filetype on` commands load the menu too).
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004238 *'go-g'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004239 'g' Grey menu items: Make menu items that are not active grey. If
4240 'g' is not included inactive menu items are not shown at all.
Bram Moolenaar02467872007-05-06 13:22:01 +00004241 *'go-t'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004242 't' Include tearoff menu items. Currently only works for Win32,
4243 GTK+, and Motif 1.2 GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00004244 *'go-T'*
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004245 'T' Include Toolbar. Currently only in Win32, GTK+, Motif and
4246 Photon GUIs.
Bram Moolenaar02467872007-05-06 13:22:01 +00004247 *'go-r'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004248 'r' Right-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004249 *'go-R'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004250 'R' Right-hand scrollbar is present when there is a vertically
4251 split window.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004252 *'go-l'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004253 'l' Left-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004254 *'go-L'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004255 'L' Left-hand scrollbar is present when there is a vertically
4256 split window.
Bram Moolenaar02467872007-05-06 13:22:01 +00004257 *'go-b'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004258 'b' Bottom (horizontal) scrollbar is present. Its size depends on
4259 the longest visible line, or on the cursor line if the 'h'
4260 flag is included. |gui-horiz-scroll|
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004261 *'go-h'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004262 'h' Limit horizontal scrollbar size to the length of the cursor
4263 line. Reduces computations. |gui-horiz-scroll|
4264
4265 And yes, you may even have scrollbars on the left AND the right if
4266 you really want to :-). See |gui-scrollbars| for more information.
4267
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004268 *'go-v'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004269 'v' Use a vertical button layout for dialogs. When not included,
4270 a horizontal layout is preferred, but when it doesn't fit a
Bram Moolenaardad44732021-03-31 20:07:33 +02004271 vertical layout is used anyway. Not supported in GTK 3.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004272 *'go-p'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004273 'p' Use Pointer callbacks for X11 GUI. This is required for some
4274 window managers. If the cursor is not blinking or hollow at
4275 the right moment, try adding this flag. This must be done
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004276 before starting the GUI. Set it in your |gvimrc|. Adding or
Bram Moolenaar071d4272004-06-13 20:20:40 +00004277 removing it after the GUI has started has no effect.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004278 *'go-F'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004279 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar8ac44152017-11-09 18:33:29 +01004280 *'go-k'*
4281 'k' Keep the GUI window size when adding/removing a scrollbar, or
4282 toolbar, tabline, etc. Instead, the behavior is similar to
4283 when the window is maximized and will adjust 'lines' and
4284 'columns' to fit to the window. Without the 'k' flag Vim will
Bram Moolenaar51b0f372017-11-18 18:52:04 +01004285 try to keep 'lines' and 'columns' the same when adding and
Bram Moolenaar8ac44152017-11-09 18:33:29 +01004286 removing GUI components.
Bram Moolenaar02467872007-05-06 13:22:01 +00004287
Bram Moolenaar071d4272004-06-13 20:20:40 +00004288 *'guipty'* *'noguipty'*
4289'guipty' boolean (default on)
4290 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004291 {only available when compiled with GUI enabled}
4292 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
4293 I/O to/from shell commands. See |gui-pty|.
4294
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004295 *'guitablabel'* *'gtl'*
4296'guitablabel' 'gtl' string (default empty)
4297 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02004298 {only available when compiled with GUI enabled}
Bram Moolenaar944697a2022-02-20 19:48:20 +00004299 When non-empty describes the text to use in a label of the GUI tab
Bram Moolenaard68071d2006-05-02 22:08:30 +00004300 pages line. When empty and when the result is empty Vim will use a
4301 default label. See |setting-guitablabel| for more info.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004302
Bram Moolenaara23ccb82006-02-27 00:08:02 +00004303 The format of this option is like that of 'statusline'.
Bram Moolenaar57657d82006-04-21 22:12:41 +00004304 'guitabtooltip' is used for the tooltip, see below.
Bram Moolenaar51628222016-12-01 23:03:28 +01004305 The expression will be evaluated in the |sandbox| when set from a
4306 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004307 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00004308
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004309 Only used when the GUI tab pages line is displayed. 'e' must be
4310 present in 'guioptions'. For the non-GUI tab pages line 'tabline' is
4311 used.
4312
Bram Moolenaar57657d82006-04-21 22:12:41 +00004313 *'guitabtooltip'* *'gtt'*
4314'guitabtooltip' 'gtt' string (default empty)
4315 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02004316 {only available when compiled with GUI enabled}
Bram Moolenaar944697a2022-02-20 19:48:20 +00004317 When non-empty describes the text to use in a tooltip for the GUI tab
Bram Moolenaar57657d82006-04-21 22:12:41 +00004318 pages line. When empty Vim will use a default tooltip.
4319 This option is otherwise just like 'guitablabel' above.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004320 You can include a line break. Simplest method is to use |:let|: >
4321 :let &guitabtooltip = "line one\nline two"
4322<
Bram Moolenaar57657d82006-04-21 22:12:41 +00004323
Bram Moolenaar071d4272004-06-13 20:20:40 +00004324 *'helpfile'* *'hf'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01004325'helpfile' 'hf' string (default (MS-Windows) "$VIMRUNTIME\doc\help.txt"
Bram Moolenaar071d4272004-06-13 20:20:40 +00004326 (others) "$VIMRUNTIME/doc/help.txt")
4327 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004328 Name of the main help file. All distributed help files should be
4329 placed together in one directory. Additionally, all "doc" directories
4330 in 'runtimepath' will be used.
4331 Environment variables are expanded |:set_env|. For example:
4332 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004333 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00004334 spaces and backslashes.
4335 This option cannot be set from a |modeline| or in the |sandbox|, for
4336 security reasons.
4337
4338 *'helpheight'* *'hh'*
4339'helpheight' 'hh' number (default 20)
4340 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004341 Minimal initial height of the help window when it is opened with the
4342 ":help" command. The initial height of the help window is half of the
4343 current window, or (when the 'ea' option is on) the same as other
4344 windows. When the height is less than 'helpheight', the height is
4345 set to 'helpheight'. Set to zero to disable.
4346
4347 *'helplang'* *'hlg'*
4348'helplang' 'hlg' string (default: messages language or empty)
4349 global
4350 {only available when compiled with the |+multi_lang|
4351 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004352 Comma-separated list of languages. Vim will use the first language
Bram Moolenaar071d4272004-06-13 20:20:40 +00004353 for which the desired help can be found. The English help will always
4354 be used as a last resort. You can add "en" to prefer English over
4355 another language, but that will only find tags that exist in that
4356 language and not in the English help.
4357 Example: >
4358 :set helplang=de,it
4359< This will first search German, then Italian and finally English help
4360 files.
4361 When using |CTRL-]| and ":help!" in a non-English help file Vim will
4362 try to find the tag in the current language before using this option.
4363 See |help-translated|.
4364
4365 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
4366'hidden' 'hid' boolean (default off)
4367 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004368 When off a buffer is unloaded when it is |abandon|ed. When on a
4369 buffer becomes hidden when it is |abandon|ed. If the buffer is still
4370 displayed in another window, it does not become hidden, of course.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004371
Bram Moolenaar071d4272004-06-13 20:20:40 +00004372 The commands that move through the buffer list sometimes make a buffer
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004373 hidden even if the 'hidden' option is off when these three are true:
4374 - the buffer is modified
4375 - 'autowrite' is off or writing is not possible
4376 - the '!' flag was used
4377 Also see |windows.txt|.
4378
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004379 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004380 This option is set for one command with ":hide {command}" |:hide|.
4381 WARNING: It's easy to forget that you have changes in hidden buffers.
4382 Think twice when using ":q!" or ":qa!".
4383
4384 *'highlight'* *'hl'*
4385'highlight' 'hl' string (default (as a single string):
Bram Moolenaar58b85342016-08-14 19:54:54 +02004386 "8:SpecialKey,~:EndOfBuffer,@:NonText,
4387 d:Directory,e:ErrorMsg,i:IncSearch,
4388 l:Search,m:MoreMsg,M:ModeMsg,n:LineNr,
Bram Moolenaarefae76a2019-10-27 22:54:58 +01004389 a:LineNrAbove,b:LineNrBelow,
Bram Moolenaar58b85342016-08-14 19:54:54 +02004390 N:CursorLineNr,r:Question,s:StatusLine,
4391 S:StatusLineNC,c:VertSplit,t:Title,
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004392 v:Visual,V:VisualNOS,w:WarningMsg,
4393 W:WildMenu,f:Folded,F:FoldColumn,
4394 A:DiffAdd,C:DiffChange,D:DiffDelete,
4395 T:DiffText,>:SignColumn,-:Conceal,
Bram Moolenaarc8c88492018-12-27 23:59:26 +01004396 B:SpellBad,P:SpellCap,R:SpellRare,
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004397 L:SpellLocal,+:Pmenu,=:PmenuSel,
glepnir40c1c332024-06-11 19:37:04 +02004398 k:PmenuMatch,<:PmenuMatchSel,
Gianmaria Bajo6a7c7742023-03-10 16:35:53 +00004399 [:PmenuKind,]:PmenuKindSel,
4400 {:PmenuExtra,}:PmenuExtraSel,
Bram Moolenaar21020352017-06-13 17:21:04 +02004401 x:PmenuSbar,X:PmenuThumb,*:TabLine,
4402 #:TabLineSel,_:TabLineFill,!:CursorColumn,
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02004403 .:CursorLine,o:ColorColumn,q:QuickFixLine,
Christian Brabandtfb745752024-05-07 21:19:03 +02004404 z:StatusLineTerm,Z:StatusLineTermNC,
glepnirad409872025-01-10 20:08:20 +01004405 g:MsgArea,h:ComplMatchIns")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004406 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004407 This option can be used to set highlighting mode for various
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004408 occasions. It is a comma-separated list of character pairs. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00004409 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004410 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004411 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
Bram Moolenaar58b85342016-08-14 19:54:54 +02004412 |hl-EndOfBuffer| ~ lines after the last line in the buffer
4413 |hl-NonText| @ '@' at the end of the window and
Bram Moolenaar071d4272004-06-13 20:20:40 +00004414 characters from 'showbreak'
4415 |hl-Directory| d directories in CTRL-D listing and other special
4416 things in listings
4417 |hl-ErrorMsg| e error messages
4418 h (obsolete, ignored)
4419 |hl-IncSearch| i 'incsearch' highlighting
LemonBoya4399382022-04-09 21:04:08 +01004420 |hl-CurSearch| y current instance of last search pattern
Bram Moolenaar071d4272004-06-13 20:20:40 +00004421 |hl-Search| l last search pattern highlighting (see 'hlsearch')
4422 |hl-MoreMsg| m |more-prompt|
4423 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
Christian Brabandtfb745752024-05-07 21:19:03 +02004424 |hl-MsgArea| g |Command-line| and message area
glepnirad409872025-01-10 20:08:20 +01004425 |hl-ComplMatchIns| h matched text of currently inserted completion
Bram Moolenaar64486672010-05-16 15:46:46 +02004426 |hl-LineNr| n line number for ":number" and ":#" commands, and
4427 when 'number' or 'relativenumber' option is set.
Bram Moolenaarefae76a2019-10-27 22:54:58 +01004428 |hl-LineNrAbove| a line number above the cursor for when the
4429 'relativenumber' option is set.
4430 |hl-LineNrBelow| b line number below the cursor for when the
4431 'relativenumber' option is set.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01004432 |hl-CursorLineNr| N like n for when 'cursorline' or 'relativenumber' is
4433 set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004434 |hl-Question| r |hit-enter| prompt and yes/no questions
4435 |hl-StatusLine| s status line of current window |status-line|
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01004436 |hl-StatusLineNC| S status lines of not-current windows
Bram Moolenaar071d4272004-06-13 20:20:40 +00004437 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
4438 |hl-VertSplit| c column used to separate vertically split windows
4439 |hl-Visual| v Visual mode
4440 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
4441 Selection" Only X11 Gui's |gui-x11| and
4442 |xterm-clipboard|.
4443 |hl-WarningMsg| w warning messages
4444 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
4445 |hl-Folded| f line used for closed folds
4446 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00004447 |hl-DiffAdd| A added line in diff mode
4448 |hl-DiffChange| C changed line in diff mode
4449 |hl-DiffDelete| D deleted line in diff mode
4450 |hl-DiffText| T inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00004451 |hl-SignColumn| > column used for |signs|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004452 |hl-Conceal| - the placeholders used for concealed characters
4453 (see 'conceallevel')
Bram Moolenaar217ad922005-03-20 22:37:15 +00004454 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02004455 |hl-SpellCap| P word that should start with capital |spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00004456 |hl-SpellRare| R rare word |spell|
4457 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004458 |hl-Pmenu| + popup menu normal line
4459 |hl-PmenuSel| = popup menu selected line
Gianmaria Bajo6a7c7742023-03-10 16:35:53 +00004460 |hl-PmenuKind| [ popup menu "kind" normal line
4461 |hl-PmenuKindSel| ] popup menu "kind" selected line
h_east59858792023-10-25 22:47:05 +09004462 |hl-PmenuExtra| { popup menu "extra" normal line
4463 |hl-PmenuExtraSel| } popup menu "extra" selected line
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004464 |hl-PmenuSbar| x popup menu scrollbar
4465 |hl-PmenuThumb| X popup menu scrollbar thumb
glepnir40c1c332024-06-11 19:37:04 +02004466 |hl-PmenuMatch| k popup menu matched text
4467 |hl-PmenuMatchSel| < popup menu matched text in selected line
Bram Moolenaar071d4272004-06-13 20:20:40 +00004468
4469 The display modes are:
4470 r reverse (termcap entry "mr" and "me")
4471 i italic (termcap entry "ZH" and "ZR")
4472 b bold (termcap entry "md" and "me")
4473 s standout (termcap entry "so" and "se")
4474 u underline (termcap entry "us" and "ue")
Bram Moolenaar84f54632022-06-29 18:39:11 +01004475 c undercurl (termcap entry "Us" and "Ce")
4476 2 double underline (termcap entry "Ds" and "Ce")
4477 d dotted underline (termcap entry "ds" and "Ce")
4478 = dashed underline (termcap entry "Ds" and "Ce")
Bram Moolenaarcf4b00c2017-09-02 18:33:56 +02004479 t strikethrough (termcap entry "Ts" and "Te")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004480 n no highlighting
4481 - no highlighting
4482 : use a highlight group
4483 The default is used for occasions that are not included.
4484 If you want to change what the display modes do, see |dos-colors|
4485 for an example.
4486 When using the ':' display mode, this must be followed by the name of
4487 a highlight group. A highlight group can be used to define any type
4488 of highlighting, including using color. See |:highlight| on how to
4489 define one. The default uses a different group for each occasion.
4490 See |highlight-default| for the default highlight groups.
4491
Bram Moolenaar071d4272004-06-13 20:20:40 +00004492 *'history'* *'hi'*
Luca Saccarolac0d30ef2024-11-28 22:27:28 +01004493'history' 'hi' number (Vim default: 200, Vi default: 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004494 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004495 A history of ":" commands, and a history of previous search patterns
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004496 is remembered. This option decides how many entries may be stored in
Christian Brabandt51d4d842024-12-06 17:26:25 +01004497 each of these histories (see |cmdline-editing| and 'messagesopt' for
Shougo Matsushita4bd9b2b2024-11-14 22:31:48 +01004498 the number of messages to remember).
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004499 The maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004500 NOTE: This option is set to the Vi default value when 'compatible' is
4501 set and to the Vim default value when 'compatible' is reset.
4502
4503 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
4504'hkmap' 'hk' boolean (default off)
4505 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004506 {only available when compiled with the |+rightleft|
4507 feature}
4508 When on, the keyboard is mapped for the Hebrew character set.
4509 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
4510 toggle this option. See |rileft.txt|.
4511 NOTE: This option is reset when 'compatible' is set.
4512
4513 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
4514'hkmapp' 'hkp' boolean (default off)
4515 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004516 {only available when compiled with the |+rightleft|
4517 feature}
4518 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
4519 This is useful if you have a non-Hebrew keyboard.
4520 See |rileft.txt|.
4521 NOTE: This option is reset when 'compatible' is set.
4522
Bram Moolenaar036986f2017-03-16 17:41:02 +01004523 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
4524'hlsearch' 'hls' boolean (default off)
4525 global
Bram Moolenaar036986f2017-03-16 17:41:02 +01004526 {not available when compiled without the
4527 |+extra_search| feature}
4528 When there is a previous search pattern, highlight all its matches.
4529 The type of highlighting used can be set with the 'l' occasion in the
4530 'highlight' option. This uses the "Search" highlight group by
4531 default. Note that only the matching text is highlighted, any offsets
Bram Moolenaarcfa8f9a2022-06-03 21:59:47 +01004532 are not applied. If the "CurSearch" highlight group is set then the
4533 current match is highlighted with that.
Bram Moolenaar036986f2017-03-16 17:41:02 +01004534 See also: 'incsearch' and |:match|.
4535 When you get bored looking at the highlighted matches, you can turn it
4536 off with |:nohlsearch|. This does not change the option value, as
4537 soon as you use a search command, the highlighting comes back.
4538 'redrawtime' specifies the maximum time spent on finding matches.
4539 When the search pattern can match an end-of-line, Vim will try to
4540 highlight all of the matched text. However, this depends on where the
4541 search starts. This will be the first line in the window or the first
4542 line below a closed fold. A match in a previous line which is not
4543 drawn may not continue in a newly drawn line.
4544 You can specify whether the highlight status is restored on startup
4545 with the 'h' flag in 'viminfo' |viminfo-h|.
4546 NOTE: This option is reset when 'compatible' is set.
4547
Bram Moolenaar071d4272004-06-13 20:20:40 +00004548 *'icon'* *'noicon'*
4549'icon' boolean (default off, on when title can be restored)
4550 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004551 When on, the icon text of the window will be set to the value of
4552 'iconstring' (if it is not empty), or to the name of the file
4553 currently being edited. Only the last part of the name is used.
4554 Overridden by the 'iconstring' option.
4555 Only works if the terminal supports setting window icons (currently
4556 only X11 GUI and terminals with a non-empty 't_IS' option - these are
4557 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
4558 builtin termcap).
4559 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00004560 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00004561 X11.
Bram Moolenaar3a991dd2014-10-02 01:41:41 +02004562 For MS-Windows the icon can be changed, see |windows-icon|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004563
4564 *'iconstring'*
4565'iconstring' string (default "")
4566 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004567 When this option is not empty, it will be used for the icon text of
4568 the window. This happens only when the 'icon' option is on.
4569 Only works if the terminal supports setting window icon text
4570 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02004571 Does not work for MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004572 When Vim was compiled with HAVE_X11 defined, the original icon will be
4573 restored if possible |X11|.
4574 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004575 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004576 'titlestring' for example settings.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004577 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004578 {not available when compiled without the |+statusline| feature}
4579
4580 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
4581'ignorecase' 'ic' boolean (default off)
4582 global
Yee Cheng Chin2bbd0d32023-10-14 02:23:45 -07004583 Ignore case in search patterns, |cmdline-completion|, when
4584 searching in the tags file, and non-|Vim9| |expr-==|.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01004585 Also see 'smartcase' and 'tagcase'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004586 Can be overruled by using "\c" or "\C" in the pattern, see
4587 |/ignorecase|.
4588
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004589 *'imactivatefunc'* *'imaf'*
4590'imactivatefunc' 'imaf' string (default "")
4591 global
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004592 This option specifies a function that will be called to
Yegappan Lakshmanan7645da52021-12-04 14:02:30 +00004593 activate or deactivate the Input Method. The value can be the name of
4594 a function, a |lambda| or a |Funcref|. See |option-value-function| for
4595 more information.
Bram Moolenaaref8c6172020-07-01 15:12:44 +02004596 It is not used in the MS-Windows GUI version.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004597 The expression will be evaluated in the |sandbox| when set from a
4598 modeline, see |sandbox-option|.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004599
4600 Example: >
4601 function ImActivateFunc(active)
4602 if a:active
4603 ... do something
4604 else
4605 ... do something
4606 endif
4607 " return value is not used
4608 endfunction
4609 set imactivatefunc=ImActivateFunc
4610<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004611 *'imactivatekey'* *'imak'*
4612'imactivatekey' 'imak' string (default "")
4613 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004614 {only available when compiled with |+xim| and
Bram Moolenaar67c53842010-05-22 18:28:27 +02004615 |+GUI_GTK|} *E599*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004616 Specifies the key that your Input Method in X-Windows uses for
4617 activation. When this is specified correctly, vim can fully control
4618 IM with 'imcmdline', 'iminsert' and 'imsearch'.
4619 You can't use this option to change the activation key, the option
4620 tells Vim what the key is.
4621 Format:
4622 [MODIFIER_FLAG-]KEY_STRING
4623
4624 These characters can be used for MODIFIER_FLAG (case is ignored):
4625 S Shift key
4626 L Lock key
4627 C Control key
4628 1 Mod1 key
4629 2 Mod2 key
4630 3 Mod3 key
4631 4 Mod4 key
4632 5 Mod5 key
4633 Combinations are allowed, for example "S-C-space" or "SC-space" are
4634 both shift+ctrl+space.
4635 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
4636
4637 Example: >
4638 :set imactivatekey=S-space
4639< "S-space" means shift+space. This is the activation key for kinput2 +
4640 canna (Japanese), and ami (Korean).
4641
4642 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
4643'imcmdline' 'imc' boolean (default off)
4644 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004645 When set the Input Method is always on when starting to edit a command
4646 line, unless entering a search pattern (see 'imsearch' for that).
4647 Setting this option is useful when your input method allows entering
4648 English characters directly, e.g., when it's used to type accented
4649 characters with dead keys.
4650
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004651 *'imdisable'* *'imd'* *'noimdisable'* *'noimd'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004652'imdisable' 'imd' boolean (default off, on for some systems (SGI))
4653 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004654 When set the Input Method is never used. This is useful to disable
4655 the IM when it doesn't work properly.
4656 Currently this option is on by default for SGI/IRIX machines. This
4657 may change in later releases.
4658
4659 *'iminsert'* *'imi'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004660'iminsert' 'imi' number (default 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004661 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004662 Specifies whether :lmap or an Input Method (IM) is to be used in
4663 Insert mode. Valid values:
4664 0 :lmap is off and IM is off
4665 1 :lmap is ON and IM is off
4666 2 :lmap is off and IM is ON
Bram Moolenaar071d4272004-06-13 20:20:40 +00004667 To always reset the option to zero when leaving Insert mode with <Esc>
4668 this can be used: >
4669 :inoremap <ESC> <ESC>:set iminsert=0<CR>
4670< This makes :lmap and IM turn off automatically when leaving Insert
4671 mode.
4672 Note that this option changes when using CTRL-^ in Insert mode
4673 |i_CTRL-^|.
4674 The value is set to 1 when setting 'keymap' to a valid keymap name.
4675 It is also used for the argument of commands like "r" and "f".
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004676 The value 0 may not work correctly with Motif with some XIM
Bram Moolenaar071d4272004-06-13 20:20:40 +00004677 methods. Use 'imdisable' to disable XIM then.
4678
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004679 You can set 'imactivatefunc' and 'imstatusfunc' to handle IME/XIM
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004680 via external command if Vim is not compiled with the |+xim|,
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004681 |+multi_byte_ime| or |global-ime|.
4682
Bram Moolenaar071d4272004-06-13 20:20:40 +00004683 *'imsearch'* *'ims'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004684'imsearch' 'ims' number (default -1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004685 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004686 Specifies whether :lmap or an Input Method (IM) is to be used when
4687 entering a search pattern. Valid values:
4688 -1 the value of 'iminsert' is used, makes it look like
4689 'iminsert' is also used when typing a search pattern
4690 0 :lmap is off and IM is off
4691 1 :lmap is ON and IM is off
4692 2 :lmap is off and IM is ON
4693 Note that this option changes when using CTRL-^ in Command-line mode
4694 |c_CTRL-^|.
4695 The value is set to 1 when it is not -1 and setting the 'keymap'
4696 option to a valid keymap name.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004697 The value 0 may not work correctly with Motif with some XIM
Bram Moolenaar071d4272004-06-13 20:20:40 +00004698 methods. Use 'imdisable' to disable XIM then.
4699
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004700 *'imstatusfunc'* *'imsf'*
4701'imstatusfunc' 'imsf' string (default "")
4702 global
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004703 This option specifies a function that is called to obtain the status
4704 of Input Method. It must return a positive number when IME is active.
Yegappan Lakshmanan7645da52021-12-04 14:02:30 +00004705 The value can be the name of a function, a |lambda| or a |Funcref|.
4706 See |option-value-function| for more information.
Bram Moolenaaref8c6172020-07-01 15:12:44 +02004707 It is not used in the MS-Windows GUI version.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004708
4709 Example: >
4710 function ImStatusFunc()
4711 let is_active = ...do something
4712 return is_active ? 1 : 0
4713 endfunction
4714 set imstatusfunc=ImStatusFunc
4715<
4716 NOTE: This function is invoked very often. Keep it fast.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004717 The expression will be evaluated in the |sandbox| when set from a
4718 modeline, see |sandbox-option|.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004719
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004720 *'imstyle'* *'imst'*
4721'imstyle' 'imst' number (default 1)
4722 global
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004723 {only available when compiled with |+xim| and
4724 |+GUI_GTK|}
Bram Moolenaar37c64c72017-09-19 22:06:03 +02004725 This option specifies the input style of Input Method:
4726 0 use on-the-spot style
4727 1 over-the-spot style
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004728 See: |xim-input-style|
4729
Bram Moolenaar24a98a02017-09-27 22:23:55 +02004730 For a long time on-the-spot style had been used in the GTK version of
4731 vim, however, it is known that it causes troubles when using mappings,
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004732 |single-repeat|, etc. Therefore over-the-spot style becomes the
4733 default now. This should work fine for most people, however if you
4734 have any problem with it, try using on-the-spot style.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004735 The expression will be evaluated in the |sandbox| when set from a
4736 modeline, see |sandbox-option|.
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004737
Bram Moolenaar071d4272004-06-13 20:20:40 +00004738 *'include'* *'inc'*
4739'include' 'inc' string (default "^\s*#\s*include")
4740 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004741 {not available when compiled without the
4742 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004743 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00004744 pattern, just like for the "/" command (See |pattern|). The default
4745 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar1e015462005-09-25 22:16:38 +00004746 "]I", "[d", etc.
4747 Normally the 'isfname' option is used to recognize the file name that
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004748 comes after the matched pattern. But if "\zs" appears in the pattern
4749 then the text matched from "\zs" to the end, or until "\ze" if it
4750 appears, is used as the file name. Use this to include characters
4751 that are not in 'isfname', such as a space. You can then use
4752 'includeexpr' to process the matched text.
Bram Moolenaar1e015462005-09-25 22:16:38 +00004753 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004754
4755 *'includeexpr'* *'inex'*
4756'includeexpr' 'inex' string (default "")
4757 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004758 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004759 |+find_in_path| or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004760 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004761 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaarb59ae592022-11-23 23:46:31 +00004762 :setlocal includeexpr=substitute(v:fname,'\\.','/','g')
Bram Moolenaar071d4272004-06-13 20:20:40 +00004763< The "v:fname" variable will be set to the file name that was detected.
Bram Moolenaarb59ae592022-11-23 23:46:31 +00004764 Note the double backslash: the `:set` command first halves them, then
4765 one remains it the value, where "\." matches a dot literally. For
4766 simple character replacements `tr()` avoids the need for escaping: >
4767 :setlocal includeexpr=tr(v:fname,'.','/')
4768<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004769 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004770 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004771 Also used for |<cfile>|.
4772
Yegappan Lakshmanan8bb65f22021-12-26 10:51:39 +00004773 If the expression starts with s: or |<SID>|, then it is replaced with
4774 the script ID (|local-function|). Example: >
Bram Moolenaarb59ae592022-11-23 23:46:31 +00004775 setlocal includeexpr=s:MyIncludeExpr()
4776 setlocal includeexpr=<SID>SomeIncludeExpr()
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00004777< Otherwise, the expression is evaluated in the context of the script
4778 where the option was set, thus script-local items are available.
4779
Bram Moolenaara4e0b972022-10-01 19:43:52 +01004780 It is more efficient if the value is just a function call without
4781 arguments, see |expr-option-function|.
4782
Bram Moolenaar30b65812012-07-12 22:01:11 +02004783 The expression will be evaluated in the |sandbox| when set from a
4784 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004785 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004786
4787 It is not allowed to change text or jump to another window while
4788 evaluating 'includeexpr' |textlock|.
4789
Bram Moolenaar071d4272004-06-13 20:20:40 +00004790 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004791'incsearch' 'is' boolean (default off, set in |defaults.vim| if the
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01004792 |+reltime| feature is supported)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004793 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004794 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004795 |+extra_search| features}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004796 While typing a search command, show where the pattern, as it was typed
4797 so far, matches. The matched string is highlighted. If the pattern
4798 is invalid or not found, nothing is shown. The screen will be updated
4799 often, this is only useful on fast terminals.
Bram Moolenaarfc65cab2018-08-28 22:58:02 +02004800 Also applies to the pattern in commands: >
4801 :global
4802 :lvimgrep
4803 :lvimgrepadd
4804 :smagic
4805 :snomagic
4806 :sort
4807 :substitute
4808 :vglobal
4809 :vimgrep
4810 :vimgrepadd
4811< Note that the match will be shown, but the cursor will return to its
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004812 original position when no match is found and when pressing <Esc>. You
4813 still need to finish the search command with <Enter> to move the
4814 cursor to the match.
Bram Moolenaardc083282016-10-11 08:57:33 +02004815 You can use the CTRL-G and CTRL-T keys to move to the next and
4816 previous match. |c_CTRL-G| |c_CTRL-T|
Bram Moolenaar91a4e822008-01-19 14:59:58 +00004817 When compiled with the |+reltime| feature Vim only searches for about
4818 half a second. With a complicated pattern and/or a lot of text the
4819 match may not be found. This is to avoid that Vim hangs while you
4820 are typing the pattern.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004821 The highlighting can be set with the 'i' flag in 'highlight'.
Bram Moolenaar2f058492017-11-30 20:27:52 +01004822 When 'hlsearch' is on, all matched strings are highlighted too while
4823 typing a search command. See also: 'hlsearch'.
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004824 If you don't want to turn 'hlsearch' on, but want to highlight all
4825 matches while searching, you can turn on and off 'hlsearch' with
4826 autocmd. Example: >
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004827 augroup vimrc-incsearch-highlight
4828 autocmd!
Bram Moolenaarf8f8b2e2017-11-02 19:08:48 +01004829 autocmd CmdlineEnter /,\? :set hlsearch
4830 autocmd CmdlineLeave /,\? :set nohlsearch
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004831 augroup END
4832<
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004833 CTRL-L can be used to add one character from after the current match
Bram Moolenaara9dc3752010-07-11 20:46:53 +02004834 to the command line. If 'ignorecase' and 'smartcase' are set and the
4835 command line has no uppercase characters, the added character is
4836 converted to lowercase.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004837 CTRL-R CTRL-W can be used to add the word at the end of the current
4838 match, excluding the characters that were already typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004839 NOTE: This option is reset when 'compatible' is set.
4840
4841 *'indentexpr'* *'inde'*
4842'indentexpr' 'inde' string (default "")
4843 local to buffer
Bram Moolenaar8e145b82022-05-21 20:17:31 +01004844 {not available when compiled without the |+eval|
4845 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004846 Expression which is evaluated to obtain the proper indent for a line.
4847 It is used when a new line is created, for the |=| operator and
4848 in Insert mode as specified with the 'indentkeys' option.
4849 When this option is not empty, it overrules the 'cindent' and
Bram Moolenaar20f90cf2011-05-19 12:22:51 +02004850 'smartindent' indenting. When 'lisp' is set, this option is
Dominique Pellédf62c622024-07-15 20:29:59 +02004851 only used when 'lispoptions' contains "expr:1".
Bram Moolenaar071d4272004-06-13 20:20:40 +00004852 When 'paste' is set this option is not used for indenting.
4853 The expression is evaluated with |v:lnum| set to the line number for
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004854 which the indent is to be computed. The cursor is also in this line
Bram Moolenaar071d4272004-06-13 20:20:40 +00004855 when the expression is evaluated (but it may be moved around).
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00004856
Yegappan Lakshmanan8bb65f22021-12-26 10:51:39 +00004857 If the expression starts with s: or |<SID>|, then it is replaced with
4858 the script ID (|local-function|). Example: >
4859 set indentexpr=s:MyIndentExpr()
4860 set indentexpr=<SID>SomeIndentExpr()
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00004861< Otherwise, the expression is evaluated in the context of the script
4862 where the option was set, thus script-local items are available.
4863
Bram Moolenaara4e0b972022-10-01 19:43:52 +01004864 The advantage of using a function call without arguments is that it is
4865 faster, see |expr-option-function|.
4866
Bram Moolenaar071d4272004-06-13 20:20:40 +00004867 The expression must return the number of spaces worth of indent. It
4868 can return "-1" to keep the current indent (this means 'autoindent' is
4869 used for the indent).
4870 Functions useful for computing the indent are |indent()|, |cindent()|
4871 and |lispindent()|.
4872 The evaluation of the expression must not have side effects! It must
4873 not change the text, jump to another window, etc. Afterwards the
4874 cursor position is always restored, thus the cursor may be moved.
4875 Normally this option would be set to call a function: >
4876 :set indentexpr=GetMyIndent()
4877< Error messages will be suppressed, unless the 'debug' option contains
4878 "msg".
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004879 See |indent-expression|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01004880 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004881
Bram Moolenaar30b65812012-07-12 22:01:11 +02004882 The expression will be evaluated in the |sandbox| when set from a
4883 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004884 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004885
4886 It is not allowed to change text or jump to another window while
4887 evaluating 'indentexpr' |textlock|.
4888
Bram Moolenaar071d4272004-06-13 20:20:40 +00004889 *'indentkeys'* *'indk'*
Bram Moolenaarce655742019-01-31 14:12:57 +01004890'indentkeys' 'indk' string (default "0{,0},0),0],:,0#,!^F,o,O,e")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004891 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004892 A list of keys that, when typed in Insert mode, cause reindenting of
4893 the current line. Only happens if 'indentexpr' isn't empty.
4894 The format is identical to 'cinkeys', see |indentkeys-format|.
4895 See |C-indenting| and |indent-expression|.
4896
4897 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
4898'infercase' 'inf' boolean (default off)
4899 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004900 When doing keyword completion in insert mode |ins-completion|, and
Bram Moolenaar446cb832008-06-24 21:56:24 +00004901 'ignorecase' is also on, the case of the match is adjusted depending
4902 on the typed text. If the typed text contains a lowercase letter
4903 where the match has an upper case letter, the completed part is made
4904 lowercase. If the typed text has no lowercase letters and the match
4905 has a lowercase letter where the typed text has an uppercase letter,
4906 and there is a letter before it, the completed part is made uppercase.
4907 With 'noinfercase' the match is used as-is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004908
4909 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
4910'insertmode' 'im' boolean (default off)
4911 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004912 Makes Vim work in a way that Insert mode is the default mode. Useful
4913 if you want to use Vim as a modeless editor. Used for |evim|.
4914 These Insert mode commands will be useful:
4915 - Use the cursor keys to move around.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02004916 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|. When
Bram Moolenaar071d4272004-06-13 20:20:40 +00004917 this is a mapping, it is executed as if 'insertmode' was off.
4918 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004919 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00004920 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
4921 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004922
4923 These items change when 'insertmode' is set:
4924 - when starting to edit of a file, Vim goes to Insert mode.
4925 - <Esc> in Insert mode is a no-op and beeps.
4926 - <Esc> in Normal mode makes Vim go to Insert mode.
4927 - CTRL-L in Insert mode is a command, it is not inserted.
4928 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
4929 However, when <Esc> is used inside a mapping, it behaves like
4930 'insertmode' was not set. This was done to be able to use the same
4931 mappings with 'insertmode' set or not set.
4932 When executing commands with |:normal| 'insertmode' is not used.
4933
4934 NOTE: This option is reset when 'compatible' is set.
4935
4936 *'isfname'* *'isf'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004937'isfname' 'isf' string (default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004938 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
4939 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
4940 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
4941 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
4942 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
4943 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004944 The characters specified by this option are included in file names and
4945 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004946 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004947 Multi-byte characters 256 and above are always included, only the
4948 characters up to 255 are specified with this option.
4949 For UTF-8 the characters 0xa0 to 0xff are included as well.
Bram Moolenaar446cb832008-06-24 21:56:24 +00004950 Think twice before adding white space to this option. Although a
4951 space may appear inside a file name, the effect will be that Vim
4952 doesn't know where a file name starts or ends when doing completion.
4953 It most likely works better without a space in 'isfname'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004954
4955 Note that on systems using a backslash as path separator, Vim tries to
4956 do its best to make it work as you would expect. That is a bit
4957 tricky, since Vi originally used the backslash to escape special
4958 characters. Vim will not remove a backslash in front of a normal file
4959 name character on these systems, but it will on Unix and alikes. The
4960 '&' and '^' are not included by default, because these are special for
4961 cmd.exe.
4962
4963 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004964 Each part can be a single character number or a range. A range is two
4965 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004966 decimal number between 0 and 255 or the ASCII character itself (does
4967 not work for digits). Example:
4968 "_,-,128-140,#-43" (include '_' and '-' and the range
4969 128 to 140 and '#' to 43)
4970 If a part starts with '^', the following character number or range
4971 will be excluded from the option. The option is interpreted from left
4972 to right. Put the excluded character after the range where it is
4973 included. To include '^' itself use it as the last character of the
4974 option or the end of a range. Example:
4975 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
4976 If the character is '@', all characters where isalpha() returns TRUE
4977 are included. Normally these are the characters a to z and A to Z,
4978 plus accented characters. To include '@' itself use "@-@". Examples:
4979 "@,^a-z" All alphabetic characters, excluding lower
Bram Moolenaar446cb832008-06-24 21:56:24 +00004980 case ASCII letters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004981 "a-z,A-Z,@-@" All letters plus the '@' character.
4982 A comma can be included by using it where a character number is
4983 expected. Example:
4984 "48-57,,,_" Digits, comma and underscore.
4985 A comma can be excluded by prepending a '^'. Example:
4986 " -~,^,,9" All characters from space to '~', excluding
4987 comma, plus <Tab>.
4988 See |option-backslash| about including spaces and backslashes.
4989
4990 *'isident'* *'isi'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004991'isident' 'isi' string (default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004992 "@,48-57,_,128-167,224-235"
4993 otherwise: "@,48-57,_,192-255")
4994 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004995 The characters given by this option are included in identifiers.
4996 Identifiers are used in recognizing environment variables and after a
4997 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00004998 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004999 option. For '@' only characters up to 255 are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005000 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005001 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00005002 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
5003
5004 *'iskeyword'* *'isk'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01005005'iskeyword' 'isk' string (Vim default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00005006 "@,48-57,_,128-167,224-235"
5007 otherwise: "@,48-57,_,192-255"
5008 Vi default: "@,48-57,_")
5009 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005010 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005011 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005012 'isfname' for a description of the format of this option. For '@'
Bram Moolenaar4c295022021-05-02 17:19:11 +02005013 characters above 255 check the "word" character class (any character
5014 that is not white space or punctuation).
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005015 For C programs you could use "a-z,A-Z,48-57,_,.,-,>".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005016 For a help file it is set to all non-blank printable characters except
5017 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
5018 command).
5019 When the 'lisp' option is on the '-' character is always included.
Bram Moolenaarb8060fe2016-01-19 22:29:28 +01005020 This option also influences syntax highlighting, unless the syntax
5021 uses |:syn-iskeyword|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005022 NOTE: This option is set to the Vi default value when 'compatible' is
5023 set and to the Vim default value when 'compatible' is reset.
5024
5025 *'isprint'* *'isp'*
Yee Cheng Chin92b59c62024-10-22 21:16:43 +02005026'isprint' 'isp' string (default for Win32 and VMS:
Bram Moolenaar071d4272004-06-13 20:20:40 +00005027 "@,~-255"; otherwise: "@,161-255")
5028 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005029 The characters given by this option are displayed directly on the
5030 screen. It is also used for "\p" in a |pattern|. The characters from
5031 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
5032 even when they are not included in 'isprint' or excluded. See
5033 'isfname' for a description of the format of this option.
5034
5035 Non-printable characters are displayed with two characters:
5036 0 - 31 "^@" - "^_"
5037 32 - 126 always single characters
5038 127 "^?"
5039 128 - 159 "~@" - "~_"
5040 160 - 254 "| " - "|~"
5041 255 "~?"
5042 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
5043 displayed as <xx>, with the hexadecimal value of the byte.
5044 When 'display' contains "uhex" all unprintable characters are
5045 displayed as <xx>.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005046 The SpecialKey highlighting will be used for unprintable characters.
5047 |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005048
5049 Multi-byte characters 256 and above are always included, only the
5050 characters up to 255 are specified with this option. When a character
5051 is printable but it is not available in the current font, a
5052 replacement character will be shown.
5053 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
5054 There is no option to specify these characters.
5055
5056 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
5057'joinspaces' 'js' boolean (default on)
5058 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005059 Insert two spaces after a '.', '?' and '!' with a join command.
5060 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
5061 Otherwise only one space is inserted.
5062 NOTE: This option is set when 'compatible' is set.
5063
Yegappan Lakshmanan87018252023-09-20 20:20:04 +02005064 *'jumpoptions'* *'jop'*
5065'jumpoptions' 'jop' string (default "")
5066 global
5067 List of words that change the behavior of the |jumplist|.
5068 stack Make the jumplist behave like the tagstack.
5069 Relative location of entries in the jumplist is
5070 preserved at the cost of discarding subsequent entries
5071 when navigating backwards in the jumplist and then
5072 jumping to a location. |jumplist-stack|
5073
Bram Moolenaar071d4272004-06-13 20:20:40 +00005074 *'key'*
5075'key' string (default "")
5076 local to buffer
Bram Moolenaar996343d2010-07-04 22:20:21 +02005077 {only available when compiled with the |+cryptv|
5078 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005079 The key that is used for encrypting and decrypting the current buffer.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02005080 See |encryption| and 'cryptmethod'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005081 Careful: Do not set the key value by hand, someone might see the typed
5082 key. Use the |:X| command. But you can make 'key' empty: >
5083 :set key=
5084< It is not possible to get the value of this option with ":set key" or
5085 "echo &key". This is to avoid showing it to someone who shouldn't
5086 know. It also means you cannot see it yourself once you have set it,
5087 be careful not to make a typing error!
Yee Cheng Chin6ee7b522023-10-01 09:13:22 +02005088 You also cannot use |:set-=|, |:set+=|, |:set^=| on this option to
5089 prevent an attacker from guessing substrings in your key.
Bram Moolenaard58e9292011-02-09 17:07:58 +01005090 You can use "&key" in an expression to detect whether encryption is
5091 enabled. When 'key' is set it returns "*****" (five stars).
Bram Moolenaar071d4272004-06-13 20:20:40 +00005092
5093 *'keymap'* *'kmp'* *E544*
5094'keymap' 'kmp' string (default "")
5095 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005096 {only available when compiled with the |+keymap|
5097 feature}
5098 Name of a keyboard mapping. See |mbyte-keymap|.
5099 Setting this option to a valid keymap name has the side effect of
5100 setting 'iminsert' to one, so that the keymap becomes effective.
5101 'imsearch' is also set to one, unless it was -1
Millyae62fe52024-10-02 19:30:41 +02005102 Only alphanumeric characters, '.', '-' and '_' can be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005103
5104 *'keymodel'* *'km'*
5105'keymodel' 'km' string (default "")
5106 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01005107 List of comma-separated words, which enable special things that keys
Bram Moolenaar071d4272004-06-13 20:20:40 +00005108 can do. These values can be used:
5109 startsel Using a shifted special key starts selection (either
5110 Select mode or Visual mode, depending on "key" being
5111 present in 'selectmode').
5112 stopsel Using a not-shifted special key stops selection.
5113 Special keys in this context are the cursor keys, <End>, <Home>,
5114 <PageUp> and <PageDown>.
5115 The 'keymodel' option is set by the |:behave| command.
5116
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005117 *'keyprotocol'* *'kpc'*
5118'keyprotocol' 'kpc' string (default: see below)
5119 global
5120 Specifies what keyboard protocol to use depending on the value of
5121 'term'. The supported keyboard protocols names are:
5122 none whatever the terminal uses
5123 mok2 modifyOtherKeys level 2, as supported by xterm
5124 kitty Kitty keyboard protocol, as supported by Kitty
5125
Bram Moolenaara87749e2022-11-30 10:23:17 +00005126 The option value is a list of comma separated items. Each item has
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005127 a pattern that is matched against the 'term' option, a colon and the
5128 protocol name to be used. To illustrate this, the default value would
5129 be set with: >
Christian Brabandtf6ba8de2024-12-28 17:15:05 +01005130 set keyprotocol=kitty:kitty,foot:kitty,ghostty:kitty,wezterm:kitty
5131 set keyprotocol+=xterm:mok2
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005132
Hirohito Higashi195fcc92025-02-01 10:26:58 +01005133< This means that when 'term' contains "kitty, "foot", "ghostty" or
Christian Brabandtf6ba8de2024-12-28 17:15:05 +01005134 "wezterm" somewhere, then the "kitty" protocol is used. When 'term'
5135 contains "xterm" somewhere, then the "mok2" protocol is used.
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005136
5137 The first match is used, thus if you want to have "kitty" use the
5138 kitty protocol, but "badkitty" not, then you should match "badkitty"
5139 first and use the "none" value: >
5140 set keyprotocol=badkitty:none,kitty:kitty
5141<
5142 The option is used after 'term' has been changed. First the termcap
5143 entries are set, possibly using the builtin list, see |builtin-terms|.
5144 Then this option is inspected and if there is a match and a protocol
5145 is specified the following happens:
5146 none Nothing, the regular t_TE and t_TI values remain
5147
5148 mok2 The t_TE value is changed to:
5149 CSI >4;m disables modifyOtherKeys
5150 The t_TI value is changed to:
5151 CSI >4;2m enables modifyOtherKeys
Bram Moolenaara87749e2022-11-30 10:23:17 +00005152 CSI ?4m request the modifyOtherKeys state
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005153
5154 kitty The t_TE value is changed to:
5155 CSI >4;m disables modifyOtherKeys
Bram Moolenaara87749e2022-11-30 10:23:17 +00005156 CSI =0;1u disables the kitty keyboard protocol
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005157 The t_TI value is changed to:
Bram Moolenaara87749e2022-11-30 10:23:17 +00005158 CSI =1;1u enables the kitty keyboard protocol
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005159 CSI ?u request kitty keyboard protocol state
5160 CSI >c request the termresponse
5161
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00005162 If you notice problems, such as characters being displayed that
5163 disappear after `CTRL-L`, you might want to try making this option
5164 empty. Then set the 'term' option to have it take effect: >
5165 set keyprotocol=
5166 let &term = &term
Bram Moolenaarbe4e0162023-02-02 13:59:48 +00005167<
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005168
Bram Moolenaar071d4272004-06-13 20:20:40 +00005169 *'keywordprg'* *'kp'*
5170'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02005171 VMS: "help")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005172 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005173 Program to use for the |K| command. Environment variables are
5174 expanded |:set_env|. ":help" may be used to access the Vim internal
5175 help. (Note that previously setting the global option to the empty
5176 value did this, which is now deprecated.)
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02005177 When the first character is ":", the command is invoked as a Vim
Bram Moolenaarb529cfb2022-07-25 15:42:07 +01005178 Ex command with [count] added as an argument if it is not zero.
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02005179 When "man", "man -s" or an Ex command is used, Vim will automatically
5180 translate a count for the "K" command and pass it as the first
5181 argument. For "man -s" the "-s" is removed when there is no count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005182 See |option-backslash| about including spaces and backslashes.
5183 Example: >
5184 :set keywordprg=man\ -s
5185< This option cannot be set from a |modeline| or in the |sandbox|, for
5186 security reasons.
5187
5188 *'langmap'* *'lmap'* *E357* *E358*
5189'langmap' 'lmap' string (default "")
5190 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005191 {only available when compiled with the |+langmap|
5192 feature}
5193 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005194 mode. When you are typing text in Insert mode the characters are
Bram Moolenaarfa735342016-01-03 22:14:44 +01005195 inserted directly. When in Normal mode the 'langmap' option takes
Bram Moolenaar071d4272004-06-13 20:20:40 +00005196 care of translating these special characters to the original meaning
5197 of the key. This means you don't have to change the keyboard mode to
5198 be able to execute Normal mode commands.
5199 This is the opposite of the 'keymap' option, where characters are
5200 mapped in Insert mode.
Bram Moolenaarb17893a2020-03-14 08:19:51 +01005201 Also consider setting 'langremap' to off, to prevent 'langmap' from
5202 applying to characters resulting from a mapping.
Bram Moolenaare968e362014-05-13 20:23:24 +02005203 This option cannot be set from a |modeline| or in the |sandbox|, for
5204 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005205
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00005206 Example (for Greek, in UTF-8): *greek* >
5207 :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 +00005208< Example (exchanges meaning of z and y for commands): >
5209 :set langmap=zy,yz,ZY,YZ
5210<
5211 The 'langmap' option is a list of parts, separated with commas. Each
5212 part can be in one of two forms:
5213 1. A list of pairs. Each pair is a "from" character immediately
5214 followed by the "to" character. Examples: "aA", "aAbBcC".
Dominique Pellédf62c622024-07-15 20:29:59 +02005215 2. A list of "from" characters, a semicolon and a list of "to"
Bram Moolenaar071d4272004-06-13 20:20:40 +00005216 characters. Example: "abc;ABC"
5217 Example: "aA,fgh;FGH,cCdDeE"
5218 Special characters need to be preceded with a backslash. These are
Bram Moolenaar4f4d51a2020-10-11 13:57:40 +02005219 ";", ',', '"', '|' and backslash itself.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005220
5221 This will allow you to activate vim actions without having to switch
5222 back and forth between the languages. Your language characters will
5223 be understood as normal vim English characters (according to the
5224 langmap mappings) in the following cases:
5225 o Normal/Visual mode (commands, buffer/register names, user mappings)
5226 o Insert/Replace Mode: Register names after CTRL-R
5227 o Insert/Replace Mode: Mappings
5228 Characters entered in Command-line mode will NOT be affected by
5229 this option. Note that this option can be changed at any time
5230 allowing to switch between mappings for different languages/encodings.
5231 Use a mapping to avoid having to type it each time!
5232
5233 *'langmenu'* *'lm'*
5234'langmenu' 'lm' string (default "")
5235 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005236 {only available when compiled with the |+menu| and
5237 |+multi_lang| features}
5238 Language to use for menu translation. Tells which file is loaded
5239 from the "lang" directory in 'runtimepath': >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00005240 "lang/menu_" .. &langmenu .. ".vim"
Bram Moolenaar071d4272004-06-13 20:20:40 +00005241< (without the spaces). For example, to always use the Dutch menus, no
5242 matter what $LANG is set to: >
5243 :set langmenu=nl_NL.ISO_8859-1
5244< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005245 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005246 If your $LANG is set to a non-English language but you do want to use
5247 the English menus: >
5248 :set langmenu=none
5249< This option must be set before loading menus, switching on filetype
5250 detection or syntax highlighting. Once the menus are defined setting
5251 this option has no effect. But you could do this: >
5252 :source $VIMRUNTIME/delmenu.vim
5253 :set langmenu=de_DE.ISO_8859-1
5254 :source $VIMRUNTIME/menu.vim
5255< Warning: This deletes all menus that you defined yourself!
5256
Bram Moolenaard94464e2015-11-02 15:28:18 +01005257 *'langnoremap'* *'lnr'* *'nolangnoremap'* *'nolnr'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02005258'langnoremap' 'lnr' boolean (default off, set in |defaults.vim|)
Bram Moolenaar4391cf92014-11-05 17:44:52 +01005259 global
Bram Moolenaar4391cf92014-11-05 17:44:52 +01005260 {only available when compiled with the |+langmap|
5261 feature}
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02005262 This is just like 'langremap' but with the value inverted. It only
5263 exists for backwards compatibility. When setting 'langremap' then
5264 'langnoremap' is set to the inverted value, and the other way around.
5265
5266 *'langremap'* *'lrm'* *'nolangremap'* *'nolrm'*
Bram Moolenaarb17893a2020-03-14 08:19:51 +01005267'langremap' 'lrm' boolean (default on, set to off in |defaults.vim|)
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02005268 global
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02005269 {only available when compiled with the |+langmap|
5270 feature}
5271 When off, setting 'langmap' does not apply to characters resulting from
Bram Moolenaar4391cf92014-11-05 17:44:52 +01005272 a mapping. This basically means, if you noticed that setting
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02005273 'langmap' disables some of your mappings, try resetting this option.
5274 This option defaults to on for backwards compatibility. Set it off if
Bram Moolenaar4391cf92014-11-05 17:44:52 +01005275 that works for you to avoid mappings to break.
5276
Bram Moolenaar071d4272004-06-13 20:20:40 +00005277 *'laststatus'* *'ls'*
5278'laststatus' 'ls' number (default 1)
5279 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005280 The value of this option influences when the last window will have a
5281 status line:
5282 0: never
5283 1: only if there are at least two windows
5284 2: always
5285 The screen looks nicer with a status line if you have several
5286 windows, but it takes another screen line. |status-line|
5287
5288 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
5289'lazyredraw' 'lz' boolean (default off)
5290 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005291 When this option is set, the screen will not be redrawn while
5292 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005293 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00005294 update use |:redraw|.
Bram Moolenaara57b5532022-06-24 11:48:03 +01005295 This may occasionally cause display errors. It is only meant to be set
5296 temporarily when performing an operation where redrawing may cause
Dominique Pellédf62c622024-07-15 20:29:59 +02005297 flickering or cause a slowdown.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005298
5299 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
5300'linebreak' 'lbr' boolean (default off)
5301 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02005302 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005303 feature}
Bram Moolenaar946e27a2014-06-25 18:50:27 +02005304 If on, Vim will wrap long lines at a character in 'breakat' rather
Bram Moolenaar071d4272004-06-13 20:20:40 +00005305 than at the last character that fits on the screen. Unlike
5306 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
Bram Moolenaar946e27a2014-06-25 18:50:27 +02005307 it only affects the way the file is displayed, not its contents.
5308 If 'breakindent' is set, line is visually indented. Then, the value
5309 of 'showbreak' is used to put in front of wrapped lines. This option
Bram Moolenaar86b17e92014-07-02 20:00:47 +02005310 is not used when the 'wrap' option is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005311 Note that <Tab> characters after an <EOL> are mostly not displayed
5312 with the right amount of white space.
5313
5314 *'lines'* *E593*
5315'lines' number (default 24 or terminal height)
5316 global
5317 Number of lines of the Vim window.
5318 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00005319 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005320 When Vim is running in the GUI or in a resizable window, setting this
5321 option will cause the window size to be changed. When you only want
5322 to use the size for the GUI, put the command in your |gvimrc| file.
5323 Vim limits the number of lines to what fits on the screen. You can
5324 use this command to get the tallest window possible: >
5325 :set lines=999
Bram Moolenaarf4d11452005-12-02 00:46:37 +00005326< Minimum value is 2, maximum value is 1000.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02005327 If you get fewer lines than expected, check the 'guiheadroom' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005328 When you set this option and Vim is unable to change the physical
5329 number of lines of the display, the display may be messed up.
5330
5331 *'linespace'* *'lsp'*
5332'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
5333 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005334 {only in the GUI}
5335 Number of pixel lines inserted between characters. Useful if the font
5336 uses the full character cell height, making lines touch each other.
5337 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005338 With some fonts there can be too much room between lines (to have
5339 space for ascents and descents). Then it makes sense to set
5340 'linespace' to a negative value. This may cause display problems
5341 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00005342
5343 *'lisp'* *'nolisp'*
5344'lisp' boolean (default off)
5345 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005346 Lisp mode: When <Enter> is typed in insert mode set the indent for
5347 the next line to Lisp standards (well, sort of). Also happens with
5348 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
5349 flag in 'cpoptions' changes the method of indenting: Vi compatible or
5350 better. Also see 'lispwords'.
5351 The '-' character is included in keyword characters. Redefines the
5352 "=" operator to use this same indentation algorithm rather than
5353 calling an external program if 'equalprg' is empty.
5354 This option is not used when 'paste' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005355
Bram Moolenaar49846fb2022-10-15 16:05:33 +01005356 *'lispoptions'* *'lop'*
5357'lispoptions' 'lop' string (default "")
5358 local to buffer
5359 Comma-separated list of items that influence the Lisp indenting when
5360 enabled with the |'lisp'| option. Currently only one item is
5361 supported:
5362 expr:1 use 'indentexpr' for Lisp indenting when it is set
5363 expr:0 do not use 'indentexpr' for Lisp indenting (default)
5364 Note that when using 'indentexpr' the `=` operator indents all the
5365 lines, otherwise the first line is not indented (Vi-compatible).
5366
Bram Moolenaar071d4272004-06-13 20:20:40 +00005367 *'lispwords'* *'lw'*
5368'lispwords' 'lw' string (default is very long)
Bram Moolenaaraf6c1312014-03-12 18:55:58 +01005369 global or local to buffer |global-local|
Bram Moolenaar48c3f4e2022-08-08 15:42:38 +01005370 Comma-separated list of words that influence the Lisp indenting when
5371 enabled with the |'lisp'| option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005372
5373 *'list'* *'nolist'*
5374'list' boolean (default off)
5375 local to window
Bram Moolenaar113cb512021-11-07 20:27:04 +00005376 List mode: By default show tabs as CTRL-I is displayed, display $
5377 after end of line. Useful to see the difference between tabs and
5378 spaces and for trailing blanks. Further changed by the 'listchars'
5379 option.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005380
5381 The cursor is displayed at the start of the space a Tab character
5382 occupies, not at the end as usual in Normal mode. To get this cursor
5383 position while displaying Tabs with spaces, use: >
Bram Moolenaardd007ed2013-07-09 15:44:17 +02005384 :set list lcs=tab:\ \
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005385<
5386 Note that list mode will also affect formatting (set with 'textwidth'
5387 or 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005388 changing the way tabs are displayed.
5389
5390 *'listchars'* *'lcs'*
5391'listchars' 'lcs' string (default "eol:$")
Bram Moolenaareed9d462021-02-15 20:38:25 +01005392 global or local to window |global-local|
Bram Moolenaarf9d5ca12010-08-01 16:13:51 +02005393 Strings to use in 'list' mode and for the |:list| command. It is a
zeertzjq6a8d2e12024-01-17 20:54:49 +01005394 comma-separated list of string settings. *E1511*
Bram Moolenaar79278362015-04-21 18:33:48 +02005395 *lcs-eol*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005396 eol:c Character to show at the end of each line. When
5397 omitted, there is no extra character at the end of the
5398 line.
Bram Moolenaar79278362015-04-21 18:33:48 +02005399 *lcs-tab*
Bram Moolenaar83a52172019-01-16 22:41:54 +01005400 tab:xy[z] Two or three characters to be used to show a tab.
5401 The third character is optional.
5402
5403 tab:xy The 'x' is always used, then 'y' as many times as will
5404 fit. Thus "tab:>-" displays:
5405 >
5406 >-
5407 >--
5408 etc.
5409
5410 tab:xyz The 'z' is always used, then 'x' is prepended, and
5411 then 'y' is used as many times as will fit. Thus
5412 "tab:<->" displays:
5413 >
5414 <>
5415 <->
5416 <-->
5417 etc.
5418
5419 When "tab:" is omitted, a tab is shown as ^I.
Bram Moolenaar79278362015-04-21 18:33:48 +02005420 *lcs-space*
5421 space:c Character to show for a space. When omitted, spaces
5422 are left blank.
zeertzjqf14b8ba2021-09-10 16:58:30 +02005423 *lcs-multispace*
5424 multispace:c...
Bram Moolenaarbe4e0162023-02-02 13:59:48 +00005425 One or more characters to use cyclically to show for
5426 multiple consecutive spaces. Overrides the "space"
zeertzjqf14b8ba2021-09-10 16:58:30 +02005427 setting, except for single spaces. When omitted, the
5428 "space" setting is used. For example,
5429 `:set listchars=multispace:---+` shows ten consecutive
5430 spaces as:
Bram Moolenaaraca12fd2022-06-07 10:16:15 +01005431 ---+---+-- ~
Bram Moolenaar91478ae2021-02-03 15:58:13 +01005432 *lcs-lead*
5433 lead:c Character to show for leading spaces. When omitted,
zeertzjqf14b8ba2021-09-10 16:58:30 +02005434 leading spaces are blank. Overrides the "space" and
5435 "multispace" settings for leading spaces. You can
5436 combine it with "tab:", for example: >
Bram Moolenaar942db232021-02-13 18:14:48 +01005437 :set listchars+=tab:>-,lead:.
Bram Moolenaaraca12fd2022-06-07 10:16:15 +01005438< *lcs-leadmultispace*
5439 leadmultispace:c...
Bram Moolenaar069a7d52022-06-27 22:16:08 +01005440 Like the |lcs-multispace| value, but for leading
5441 spaces only. Also overrides |lcs-lead| for leading
5442 multiple spaces.
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01005443 `:set listchars=leadmultispace:---+` shows ten
5444 consecutive leading spaces as:
Bram Moolenaaraca12fd2022-06-07 10:16:15 +01005445 ---+---+--XXX ~
5446 Where "XXX" denotes the first non-blank characters in
5447 the line.
5448 *lcs-trail*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005449 trail:c Character to show for trailing spaces. When omitted,
zeertzjqf14b8ba2021-09-10 16:58:30 +02005450 trailing spaces are blank. Overrides the "space" and
5451 "multispace" settings for trailing spaces.
Bram Moolenaar79278362015-04-21 18:33:48 +02005452 *lcs-extends*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005453 extends:c Character to show in the last column, when 'wrap' is
5454 off and the line continues beyond the right of the
5455 screen.
Bram Moolenaar79278362015-04-21 18:33:48 +02005456 *lcs-precedes*
Bram Moolenaarbffba7f2019-09-20 17:00:17 +02005457 precedes:c Character to show in the first visible column of the
5458 physical line, when there is text preceding the
5459 character visible in the first column.
Bram Moolenaar79278362015-04-21 18:33:48 +02005460 *lcs-conceal*
Bram Moolenaar860cae12010-06-05 23:22:07 +02005461 conceal:c Character to show in place of concealed text, when
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02005462 'conceallevel' is set to 1.
Bram Moolenaar79278362015-04-21 18:33:48 +02005463 *lcs-nbsp*
Bram Moolenaar73284b92015-05-04 17:28:22 +02005464 nbsp:c Character to show for a non-breakable space character
5465 (0xA0 (160 decimal) and U+202F). Left blank when
5466 omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005467
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005468 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00005469 be used when 'encoding' is "utf-8", otherwise only printable
zeertzjq6a8d2e12024-01-17 20:54:49 +01005470 characters are allowed. All characters must be single width. *E1512*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005471
Bram Moolenaar93ff6722021-10-16 17:51:40 +01005472 Each character can be specified as hex: >
5473 set listchars=eol:\\x24
5474 set listchars=eol:\\u21b5
5475 set listchars=eol:\\U000021b5
5476< Note that a double backslash is used. The number of hex characters
5477 must be exactly 2 for \\x, 4 for \\u and 8 for \\U.
5478
Bram Moolenaar071d4272004-06-13 20:20:40 +00005479 Examples: >
5480 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005481 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00005482 :set lcs=extends:>,precedes:<
5483< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaar34cc7d82021-09-21 20:09:51 +02005484 "precedes". "SpecialKey" will be used for "tab", "nbsp", "space",
5485 "multispace", "lead" and "trail".
Bram Moolenaar02467872007-05-06 13:22:01 +00005486 |hl-NonText| |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005487
5488 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
5489'loadplugins' 'lpl' boolean (default on)
5490 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005491 When on the plugin scripts are loaded when starting up |load-plugins|.
5492 This option can be reset in your |vimrc| file to disable the loading
5493 of plugins.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02005494 Note that using the "-u NONE", "-u DEFAULTS" and "--noplugin" command
5495 line arguments reset this option. See |-u| and |--noplugin|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005496
Bram Moolenaard94464e2015-11-02 15:28:18 +01005497 *'luadll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01005498'luadll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01005499 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01005500 {only available when compiled with the |+lua/dyn|
5501 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005502 Specifies the name of the Lua shared library. The default is
5503 DYNAMIC_LUA_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005504 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01005505 This option cannot be set from a |modeline| or in the |sandbox|, for
5506 security reasons.
5507
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00005508 *'macatsui'* *'nomacatsui'*
5509'macatsui' boolean (default on)
5510 global
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02005511 {not supported}
5512 No longer supported, as the Mac OS X GUI code was removed.
Bram Moolenaar02467872007-05-06 13:22:01 +00005513
Bram Moolenaar071d4272004-06-13 20:20:40 +00005514 *'magic'* *'nomagic'*
5515'magic' boolean (default on)
5516 global
5517 Changes the special characters that can be used in search patterns.
5518 See |pattern|.
Bram Moolenaar64d8e252016-09-06 22:12:34 +02005519 WARNING: Switching this option off most likely breaks plugins! That
5520 is because many patterns assume it's on and will fail when it's off.
5521 Only switch it off when working with old Vi scripts. In any other
5522 situation write patterns that work when 'magic' is on. Include "\M"
5523 when you want to |/\M|.
Bram Moolenaar4072ba52020-12-23 13:56:35 +01005524 In |Vim9| script the value of 'magic' is ignored, patterns behave like
5525 it is always set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005526
5527 *'makeef'* *'mef'*
5528'makeef' 'mef' string (default: "")
5529 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005530 {not available when compiled without the |+quickfix|
5531 feature}
5532 Name of the errorfile for the |:make| command (see |:make_makeprg|)
5533 and the |:grep| command.
5534 When it is empty, an internally generated temp file will be used.
5535 When "##" is included, it is replaced by a number to make the name
5536 unique. This makes sure that the ":make" command doesn't overwrite an
5537 existing file.
5538 NOT used for the ":cf" command. See 'errorfile' for that.
5539 Environment variables are expanded |:set_env|.
5540 See |option-backslash| about including spaces and backslashes.
5541 This option cannot be set from a |modeline| or in the |sandbox|, for
5542 security reasons.
5543
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01005544 *'makeencoding'* *'menc'*
5545'makeencoding' 'menc' string (default "")
5546 global or local to buffer |global-local|
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01005547 Encoding used for reading the output of external commands. When empty,
5548 encoding is not converted.
5549 This is used for `:make`, `:lmake`, `:grep`, `:lgrep`, `:grepadd`,
5550 `:lgrepadd`, `:cfile`, `:cgetfile`, `:caddfile`, `:lfile`, `:lgetfile`,
5551 and `:laddfile`.
5552
5553 This would be mostly useful when you use MS-Windows and set 'encoding'
5554 to "utf-8". If |+iconv| is enabled and GNU libiconv is used, setting
5555 'makeencoding' to "char" has the same effect as setting to the system
5556 locale encoding. Example: >
5557 :set encoding=utf-8
5558 :set makeencoding=char " system locale is used
5559<
Bram Moolenaar071d4272004-06-13 20:20:40 +00005560 *'makeprg'* *'mp'*
5561'makeprg' 'mp' string (default "make", VMS: "MMS")
5562 global or local to buffer |global-local|
Bram Moolenaar02467872007-05-06 13:22:01 +00005563 Program to use for the ":make" command. See |:make_makeprg|.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01005564 This option may contain '%' and '#' characters (see |:_%| and |:_#|),
5565 which are expanded to the current and alternate file name. Use |::S|
Bram Moolenaar26df0922014-02-23 23:39:13 +01005566 to escape file names in case they contain special characters.
Bram Moolenaar02467872007-05-06 13:22:01 +00005567 Environment variables are expanded |:set_env|. See |option-backslash|
5568 about including spaces and backslashes.
5569 Note that a '|' must be escaped twice: once for ":set" and once for
5570 the interpretation of a command. When you use a filter called
5571 "myfilter" do it like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005572 :set makeprg=gmake\ \\\|\ myfilter
5573< The placeholder "$*" can be given (even multiple times) to specify
5574 where the arguments will be included, for example: >
5575 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
5576< This option cannot be set from a |modeline| or in the |sandbox|, for
5577 security reasons.
5578
5579 *'matchpairs'* *'mps'*
5580'matchpairs' 'mps' string (default "(:),{:},[:]")
5581 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005582 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01005583 other.
5584 Only character pairs are allowed that are different, thus you cannot
5585 jump between two double quotes.
5586 The characters must be separated by a colon.
Bram Moolenaar02467872007-05-06 13:22:01 +00005587 The pairs must be separated by a comma. Example for including '<' and
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02005588 '>' (for HTML): >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005589 :set mps+=<:>
5590
5591< A more exotic example, to jump between the '=' and ';' in an
5592 assignment, useful for languages like C and Java: >
5593 :au FileType c,cpp,java set mps+==:;
5594
5595< For a more advanced way of using "%", see the matchit.vim plugin in
Bram Moolenaar01164a62017-11-02 22:58:42 +01005596 the $VIMRUNTIME/pack/dist/opt/matchit directory. |add-local-help|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005597
5598 *'matchtime'* *'mat'*
5599'matchtime' 'mat' number (default 5)
5600 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005601 Tenths of a second to show the matching paren, when 'showmatch' is
5602 set. Note that this is not in milliseconds, like other options that
5603 set a time. This is to be compatible with Nvi.
5604
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005605 *'maxcombine'* *'mco'*
5606'maxcombine' 'mco' number (default 2)
5607 global
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005608 The maximum number of combining characters supported for displaying.
5609 Only used when 'encoding' is "utf-8".
5610 The default is OK for most languages. Hebrew may require 4.
5611 Maximum value is 6.
5612 Even when this option is set to 2 you can still edit text with more
5613 combining characters, you just can't see them. Use |g8| or |ga|.
5614 See |mbyte-combining|.
5615
Bram Moolenaar071d4272004-06-13 20:20:40 +00005616 *'maxfuncdepth'* *'mfd'*
5617'maxfuncdepth' 'mfd' number (default 100)
5618 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02005619 {not available when compiled without the |+eval|
Bram Moolenaar02467872007-05-06 13:22:01 +00005620 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005621 Maximum depth of function calls for user functions. This normally
5622 catches endless recursion. When using a recursive function with
5623 more depth, set 'maxfuncdepth' to a bigger number. But this will use
5624 more memory, there is the danger of failing when memory is exhausted.
Bram Moolenaarbc2eada2017-01-02 21:27:47 +01005625 Increasing this limit above 200 also changes the maximum for Ex
Bram Moolenaar0b0f0992018-05-22 21:41:30 +02005626 command recursion, see |E169|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005627 See also |:function|.
zeertzjqfe583b12023-12-21 16:59:26 +01005628 Also used for maximum depth of callback functions.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005629
5630 *'maxmapdepth'* *'mmd'* *E223*
5631'maxmapdepth' 'mmd' number (default 1000)
5632 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005633 Maximum number of times a mapping is done without resulting in a
5634 character to be used. This normally catches endless mappings, like
5635 ":map x y" with ":map y x". It still does not catch ":map g wg",
5636 because the 'w' is used before the next mapping is done. See also
5637 |key-mapping|.
5638
5639 *'maxmem'* *'mm'*
5640'maxmem' 'mm' number (default between 256 to 5120 (system
5641 dependent) or half the amount of memory
5642 available)
5643 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005644 Maximum amount of memory (in Kbyte) to use for one buffer. When this
5645 limit is reached allocating extra memory for a buffer will cause
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005646 other memory to be freed.
5647 The maximum usable value is about 2000000. Use this to work without a
5648 limit.
5649 The value is ignored when 'swapfile' is off.
5650 Also see 'maxmemtot'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005651
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005652 *'maxmempattern'* *'mmp'*
5653'maxmempattern' 'mmp' number (default 1000)
5654 global
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005655 Maximum amount of memory (in Kbyte) to use for pattern matching.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005656 The maximum value is about 2000000. Use this to work without a limit.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005657 *E363*
Bram Moolenaar02467872007-05-06 13:22:01 +00005658 When Vim runs into the limit it gives an error message and mostly
5659 behaves like CTRL-C was typed.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005660 Running into the limit often means that the pattern is very
5661 inefficient or too complex. This may already happen with the pattern
5662 "\(.\)*" on a very long line. ".*" works much better.
Bram Moolenaarfd358112018-07-07 23:21:31 +02005663 Might also happen on redraw, when syntax rules try to match a complex
5664 text structure.
5665 Vim may run out of memory before hitting the 'maxmempattern' limit, in
5666 which case you get an "Out of memory" error instead.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005667
Bram Moolenaar071d4272004-06-13 20:20:40 +00005668 *'maxmemtot'* *'mmt'*
5669'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
5670 dependent) or half the amount of memory
5671 available)
5672 global
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005673 Maximum amount of memory in Kbyte to use for all buffers together.
5674 The maximum usable value is about 2000000 (2 Gbyte). Use this to work
Bram Moolenaarfa735342016-01-03 22:14:44 +01005675 without a limit.
5676 On 64 bit machines higher values might work. But hey, do you really
5677 need more than 2 Gbyte for text editing? Keep in mind that text is
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005678 stored in the swap file, one can edit files > 2 Gbyte anyway. We do
Bram Moolenaarfa735342016-01-03 22:14:44 +01005679 need the memory to store undo info.
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005680 Buffers with 'swapfile' off still count to the total amount of memory
5681 used.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005682 Also see 'maxmem'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005683
5684 *'menuitems'* *'mis'*
5685'menuitems' 'mis' number (default 25)
5686 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005687 {not available when compiled without the |+menu|
5688 feature}
5689 Maximum number of items to use in a menu. Used for menus that are
5690 generated from a list of items, e.g., the Buffers menu. Changing this
5691 option has no direct effect, the menu must be refreshed first.
5692
Christian Brabandt51d4d842024-12-06 17:26:25 +01005693 *'messagesopt'* *'mopt'*
5694'messagesopt' 'mopt' string (default "hit-enter,history:500")
5695 global
5696
zeertzjq8cc43da2024-12-07 16:09:08 +01005697 Option settings for outputting messages. It can consist of the
Christian Brabandt51d4d842024-12-06 17:26:25 +01005698 following items. Items must be separated by a comma.
5699
zeertzjq8cc43da2024-12-07 16:09:08 +01005700 hit-enter Use a |hit-enter| prompt when the message is longer than
Christian Brabandt51d4d842024-12-06 17:26:25 +01005701 'cmdheight' size.
5702
zeertzjq8cc43da2024-12-07 16:09:08 +01005703 wait:{n} Instead of using a |hit-enter| prompt, simply wait for
5704 {n} milliseconds so that the user has a chance to read
5705 the message. The maximum value of {n} is 10000. Use
5706 0 to disable the wait (but then the user may miss an
5707 important message).
5708 This item is ignored when "hit-enter" is present, but
5709 required when "hit-enter" is not present.
Christian Brabandt51d4d842024-12-06 17:26:25 +01005710
5711 history:{n} Determines how many entries are remembered in the
5712 |:messages| history. The maximum value is 10000.
5713 Setting it to zero clears the message history.
zeertzjq8cc43da2024-12-07 16:09:08 +01005714 This item must always be present.
Christian Brabandt51d4d842024-12-06 17:26:25 +01005715
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005716 *'mkspellmem'* *'msm'*
5717'mkspellmem' 'msm' string (default "460000,2000,500")
5718 global
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005719 {not available when compiled without the |+syntax|
5720 feature}
5721 Parameters for |:mkspell|. This tunes when to start compressing the
5722 word tree. Compression can be slow when there are many words, but
5723 it's needed to avoid running out of memory. The amount of memory used
5724 per word depends very much on how similar the words are, that's why
5725 this tuning is complicated.
5726
5727 There are three numbers, separated by commas:
5728 {start},{inc},{added}
5729
5730 For most languages the uncompressed word tree fits in memory. {start}
5731 gives the amount of memory in Kbyte that can be used before any
5732 compression is done. It should be a bit smaller than the amount of
5733 memory that is available to Vim.
5734
5735 When going over the {start} limit the {inc} number specifies the
5736 amount of memory in Kbyte that can be allocated before another
5737 compression is done. A low number means compression is done after
5738 less words are added, which is slow. A high number means more memory
5739 will be allocated.
5740
5741 After doing compression, {added} times 1024 words can be added before
5742 the {inc} limit is ignored and compression is done when any extra
5743 amount of memory is needed. A low number means there is a smaller
5744 chance of hitting the {inc} limit, less memory is used but it's
5745 slower.
5746
5747 The languages for which these numbers are important are Italian and
5748 Hungarian. The default works for when you have about 512 Mbyte. If
5749 you have 1 Gbyte you could use: >
5750 :set mkspellmem=900000,3000,800
5751< If you have less than 512 Mbyte |:mkspell| may fail for some
5752 languages, no matter what you set 'mkspellmem' to.
5753
dkearns8ebdbc92023-10-29 06:26:19 +11005754 This option cannot be set from a |modeline| or in the |sandbox|, for
5755 security reasons.
Bram Moolenaar07607392019-05-26 19:20:43 +02005756
Bram Moolenaar071d4272004-06-13 20:20:40 +00005757 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
Bram Moolenaar8243a792007-05-01 17:05:03 +00005758'modeline' 'ml' boolean (Vim default: on (off for root),
5759 Vi default: off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005760 local to buffer
Bram Moolenaar110289e2019-05-23 15:38:06 +02005761 If 'modeline' is on 'modelines' gives the number of lines that is
5762 checked for set commands. If 'modeline' is off or 'modelines' is zero
5763 no lines are checked. See |modeline|.
5764
5765 *'modelineexpr'* *'mle'* *'nomodelineexpr'* *'nomle'*
5766'modelineexpr' 'mle' boolean (default: off)
5767 global
5768 When on allow some options that are an expression to be set in the
5769 modeline. Check the option for whether it is affected by
5770 'modelineexpr'. Also see |modeline|.
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02005771 This option cannot be set from a |modeline| or in the |sandbox|, for
5772 security reasons.
Bram Moolenaar110289e2019-05-23 15:38:06 +02005773
Bram Moolenaar071d4272004-06-13 20:20:40 +00005774 *'modelines'* *'mls'*
5775'modelines' 'mls' number (default 5)
5776 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005777 If 'modeline' is on 'modelines' gives the number of lines that is
5778 checked for set commands. If 'modeline' is off or 'modelines' is zero
5779 no lines are checked. See |modeline|.
5780 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
5781 set and to the Vim default value when 'compatible' is reset.
5782
5783 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
Bram Moolenaar110289e2019-05-23 15:38:06 +02005784 *E21*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005785'modifiable' 'ma' boolean (default on)
5786 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005787 When off the buffer contents cannot be changed. The 'fileformat' and
5788 'fileencoding' options also can't be changed.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01005789 Can be reset on startup with the |-M| command line argument.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005790
5791 *'modified'* *'mod'* *'nomodified'* *'nomod'*
5792'modified' 'mod' boolean (default off)
Christian Brabandt596ad662023-08-16 00:11:09 +02005793 local to buffer |local-noglobal|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005794 When on, the buffer is considered to be modified. This option is set
5795 when:
5796 1. A change was made to the text since it was last written. Using the
5797 |undo| command to go back to the original text will reset the
5798 option. But undoing changes that were made before writing the
5799 buffer will set the option again, since the text is different from
5800 when it was written.
5801 2. 'fileformat' or 'fileencoding' is different from its original
5802 value. The original value is set when the buffer is read or
5803 written. A ":set nomodified" command also resets the original
5804 values to the current values and the 'modified' option will be
5805 reset.
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01005806 Similarly for 'eol' and 'bomb'.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02005807 This option is not set when a change is made to the buffer as the
5808 result of a BufNewFile, BufRead/BufReadPost, BufWritePost,
5809 FileAppendPost or VimLeave autocommand event. See |gzip-example| for
5810 an explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005811 When 'buftype' is "nowrite" or "nofile" this option may be set, but
5812 will be ignored.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01005813 Note that the text may actually be the same, e.g. 'modified' is set
5814 when using "rA" on an "A".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005815
5816 *'more'* *'nomore'*
5817'more' boolean (Vim default: on, Vi default: off)
5818 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005819 When on, listings pause when the whole screen is filled. You will get
5820 the |more-prompt|. When this option is off there are no pauses, the
5821 listing continues until finished.
5822 NOTE: This option is set to the Vi default value when 'compatible' is
5823 set and to the Vim default value when 'compatible' is reset.
5824
Bram Moolenaar98a29d02021-01-18 19:55:44 +01005825 *'mouse'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005826'mouse' string (default "", "a" for GUI and Win32,
Bram Moolenaar5b418992019-10-27 18:50:25 +01005827 set to "a" or "nvi" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005828 global
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005829 Enable the use of the mouse. Works for most terminals (xterm, Win32
5830 |win32-mouse|, QNX pterm, *BSD console with sysmouse and Linux console
5831 with gpm). For using the mouse in the GUI, see |gui-mouse|. The
5832 mouse can be enabled for different modes:
Bram Moolenaar7f2e9d72017-11-11 20:58:53 +01005833 n Normal mode and Terminal modes
Bram Moolenaar071d4272004-06-13 20:20:40 +00005834 v Visual mode
5835 i Insert mode
5836 c Command-line mode
5837 h all previous modes when editing a help file
5838 a all previous modes
5839 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005840 Normally you would enable the mouse in all five modes with: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005841 :set mouse=a
Bram Moolenaar5b418992019-10-27 18:50:25 +01005842< If your terminal can't overrule the mouse events going to the
5843 application, use: >
5844 :set mouse=nvi
Bram Moolenaar65e0d772020-06-14 17:29:55 +02005845< Then you can press ":", select text for the system, and press Esc to go
Bram Moolenaar5b418992019-10-27 18:50:25 +01005846 back to Vim using the mouse events.
5847 In |defaults.vim| "nvi" is used if the 'term' option is not matching
5848 "xterm".
5849
5850 When the mouse is not enabled, the GUI will still use the mouse for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005851 modeless selection. This doesn't move the text cursor.
5852
5853 See |mouse-using|. Also see |'clipboard'|.
5854
5855 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005856 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005857 the mouse buttons can still be used by keeping the shift key pressed.
5858 Also see the 'clipboard' option.
5859
5860 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
5861'mousefocus' 'mousef' boolean (default off)
5862 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005863 {only works in the GUI}
5864 The window that the mouse pointer is on is automatically activated.
5865 When changing the window layout or window focus in another way, the
5866 mouse pointer is moved to the window with keyboard focus. Off is the
5867 default because it makes using the pull down menus a little goofy, as
5868 a pointer transit may activate a window unintentionally.
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01005869 MS-Windows: Also see 'scrollfocus' for what window is scrolled when
Bram Moolenaar1d9215b2020-01-25 13:27:42 +01005870 using the mouse scroll wheel.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005871
5872 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
5873'mousehide' 'mh' boolean (default on)
5874 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005875 {only works in the GUI}
5876 When on, the mouse pointer is hidden when characters are typed.
5877 The mouse pointer is restored when the mouse is moved.
5878
5879 *'mousemodel'* *'mousem'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005880'mousemodel' 'mousem' string (default "extend", "popup" for Win32)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005881 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005882 Sets the model to use for the mouse. The name mostly specifies what
5883 the right mouse button is used for:
5884 extend Right mouse button extends a selection. This works
5885 like in an xterm.
5886 popup Right mouse button pops up a menu. The shifted left
5887 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00005888 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005889 popup_setpos Like "popup", but the cursor will be moved to the
5890 position where the mouse was clicked, and thus the
5891 selected operation will act upon the clicked object.
5892 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00005893 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005894 course, that right clicking outside a selection will
5895 end Visual mode.
5896 Overview of what button does what for each model:
5897 mouse extend popup(_setpos) ~
5898 left click place cursor place cursor
5899 left drag start selection start selection
5900 shift-left search word extend selection
5901 right click extend selection popup menu (place cursor)
5902 right drag extend selection -
5903 middle click paste paste
5904
5905 In the "popup" model the right mouse button produces a pop-up menu.
5906 You need to define this first, see |popup-menu|.
5907
5908 Note that you can further refine the meaning of buttons with mappings.
5909 See |gui-mouse-mapping|. But mappings are NOT used for modeless
5910 selection (because that's handled in the GUI code directly).
5911
5912 The 'mousemodel' option is set by the |:behave| command.
5913
h_east59858792023-10-25 22:47:05 +09005914 *'mousemoveevent'* *'mousemev'* *'nomousemoveevent'* *'nomousemev'*
Ernie Raelc4cb5442022-04-03 15:47:28 +01005915'mousemoveevent' 'mousemev' boolean (default off)
5916 global
5917 {only works in the GUI}
5918 When on, mouse move events are delivered to the input queue and are
5919 available for mapping. The default, off, avoids the mouse movement
5920 overhead except when needed. See |gui-mouse-mapping|.
5921 Warning: Setting this option can make pending mappings to be aborted
5922 when the mouse is moved.
5923 Currently only works in the GUI, may be made to work in a terminal
5924 later.
5925
Bram Moolenaar071d4272004-06-13 20:20:40 +00005926 *'mouseshape'* *'mouses'* *E547*
Bram Moolenaarf6b40102019-02-22 15:24:03 +01005927'mouseshape' 'mouses' string (default "i-r:beam,s:updown,sd:udsizing,
5928 vs:leftright,vd:lrsizing,m:no,
5929 ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005930 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005931 {only available when compiled with the |+mouseshape|
5932 feature}
5933 This option tells Vim what the mouse pointer should look like in
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01005934 different modes. The option is a comma-separated list of parts, much
Bram Moolenaar071d4272004-06-13 20:20:40 +00005935 like used for 'guicursor'. Each part consist of a mode/location-list
5936 and an argument-list:
5937 mode-list:shape,mode-list:shape,..
5938 The mode-list is a dash separated list of these modes/locations:
5939 In a normal window: ~
5940 n Normal mode
5941 v Visual mode
5942 ve Visual mode with 'selection' "exclusive" (same as 'v',
5943 if not specified)
5944 o Operator-pending mode
5945 i Insert mode
5946 r Replace mode
5947
5948 Others: ~
5949 c appending to the command-line
5950 ci inserting in the command-line
5951 cr replacing in the command-line
5952 m at the 'Hit ENTER' or 'More' prompts
5953 ml idem, but cursor in the last line
5954 e any mode, pointer below last window
5955 s any mode, pointer on a status line
5956 sd any mode, while dragging a status line
5957 vs any mode, pointer on a vertical separator line
5958 vd any mode, while dragging a vertical separator line
5959 a everywhere
5960
5961 The shape is one of the following:
5962 avail name looks like ~
5963 w x arrow Normal mouse pointer
5964 w x blank no pointer at all (use with care!)
5965 w x beam I-beam
5966 w x updown up-down sizing arrows
5967 w x leftright left-right sizing arrows
5968 w x busy The system's usual busy pointer
5969 w x no The system's usual 'no input' pointer
5970 x udsizing indicates up-down resizing
5971 x lrsizing indicates left-right resizing
5972 x crosshair like a big thin +
5973 x hand1 black hand
5974 x hand2 white hand
5975 x pencil what you write with
5976 x question big ?
5977 x rightup-arrow arrow pointing right-up
5978 w x up-arrow arrow pointing up
5979 x <number> any X11 pointer number (see X11/cursorfont.h)
5980
5981 The "avail" column contains a 'w' if the shape is available for Win32,
5982 x for X11.
5983 Any modes not specified or shapes not available use the normal mouse
5984 pointer.
5985
5986 Example: >
5987 :set mouseshape=s:udsizing,m:no
5988< will make the mouse turn to a sizing arrow over the status lines and
5989 indicate no input when the hit-enter prompt is displayed (since
5990 clicking the mouse has no effect in this state.)
5991
5992 *'mousetime'* *'mouset'*
5993'mousetime' 'mouset' number (default 500)
5994 global
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005995 Only for GUI, Win32 and Unix with xterm. Defines the maximum
Bram Moolenaar071d4272004-06-13 20:20:40 +00005996 time in msec between two mouse clicks for the second click to be
5997 recognized as a multi click.
5998
Shougo Matsushita4bd9b2b2024-11-14 22:31:48 +01005999
laburnumT3f7855a2023-12-05 18:37:03 +01006000 *'mzquantum'* *'mzq'*
6001'mzquantum' 'mzq' number (default 100)
6002 global
6003 {not available when compiled without the |+mzscheme|
6004 feature}
6005 The number of milliseconds between polls for MzScheme threads.
6006 Negative or zero value means no thread scheduling.
6007 NOTE: This option is set to the Vim default value when 'compatible'
6008 is reset.
6009
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02006010 *'mzschemedll'*
6011'mzschemedll' string (default depends on the build)
6012 global
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02006013 {only available when compiled with the |+mzscheme/dyn|
6014 feature}
6015 Specifies the name of the MzScheme shared library. The default is
6016 DYNAMIC_MZSCH_DLL which was specified at compile time.
6017 Environment variables are expanded |:set_env|.
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01006018 The value must be set in the |vimrc| script or earlier. In the
Bram Moolenaar01164a62017-11-02 22:58:42 +01006019 startup, before the |load-plugins| step.
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02006020 This option cannot be set from a |modeline| or in the |sandbox|, for
6021 security reasons.
6022
6023 *'mzschemegcdll'*
6024'mzschemegcdll' string (default depends on the build)
6025 global
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02006026 {only available when compiled with the |+mzscheme/dyn|
6027 feature}
6028 Specifies the name of the MzScheme GC shared library. The default is
6029 DYNAMIC_MZGC_DLL which was specified at compile time.
6030 The value can be equal to 'mzschemedll' if it includes the GC code.
6031 Environment variables are expanded |:set_env|.
6032 This option cannot be set from a |modeline| or in the |sandbox|, for
6033 security reasons.
6034
Bram Moolenaar071d4272004-06-13 20:20:40 +00006035 *'nrformats'* *'nf'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02006036'nrformats' 'nf' string (default "bin,octal,hex",
6037 set to "bin,hex" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006038 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00006039 This defines what bases Vim will consider for numbers when using the
6040 CTRL-A and CTRL-X commands for adding to and subtracting from a number
6041 respectively; see |CTRL-A| for more info on these commands.
Bram Moolenaar4770d092006-01-12 23:22:24 +00006042 alpha If included, single alphabetical characters will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00006043 incremented or decremented. This is useful for a list with a
Bram Moolenaar3848e002016-03-19 18:42:29 +01006044 letter index a), b), etc. *octal-nrformats*
Bram Moolenaar4770d092006-01-12 23:22:24 +00006045 octal If included, numbers that start with a zero will be considered
Bram Moolenaar071d4272004-06-13 20:20:40 +00006046 to be octal. Example: Using CTRL-A on "007" results in "010".
Bram Moolenaar4770d092006-01-12 23:22:24 +00006047 hex If included, numbers starting with "0x" or "0X" will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00006048 considered to be hexadecimal. Example: Using CTRL-X on
6049 "0x100" results in "0x0ff".
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006050 bin If included, numbers starting with "0b" or "0B" will be
6051 considered to be binary. Example: Using CTRL-X on
6052 "0b1000" subtracts one, resulting in "0b0111".
Bram Moolenaaraaad9952020-05-31 15:08:59 +02006053 unsigned If included, numbers are recognized as unsigned. Thus a
6054 leading dash or negative sign won't be considered as part of
6055 the number. Examples:
6056 Using CTRL-X on "2020" in "9-2020" results in "9-2019"
6057 (without "unsigned" it would become "9-2021").
6058 Using CTRL-A on "2020" in "9-2020" results in "9-2021"
6059 (without "unsigned" it would become "9-2019").
Bram Moolenaaracc22402020-06-07 21:07:18 +02006060 Using CTRL-X on "0" or CTRL-A on "18446744073709551615"
6061 (2^64 - 1) has no effect, overflow is prevented.
distobs25ac6d62024-07-06 17:50:09 +02006062 blank If included, treat numbers as signed or unsigned based on
h-east52e7cc22024-07-28 17:03:29 +02006063 preceding whitespace. If a number with a leading dash has its
distobs25ac6d62024-07-06 17:50:09 +02006064 dash immediately preceded by a non-whitespace character (i.e.,
6065 not a tab or a " "), the negative sign won't be considered as
6066 part of the number. For example:
6067 Using CTRL-A on "14" in "Carbon-14" results in "Carbon-15"
6068 (without "blank" it would become "Carbon-13").
6069 Using CTRL-X on "8" in "Carbon -8" results in "Carbon -9"
h-east52e7cc22024-07-28 17:03:29 +02006070 (because -8 is preceded by whitespace. If "unsigned" was
distobs25ac6d62024-07-06 17:50:09 +02006071 set, it would result in "Carbon -7").
6072 If this format is included, overflow is prevented as if
h-east52e7cc22024-07-28 17:03:29 +02006073 "unsigned" were set. If both this format and "unsigned" are
distobs25ac6d62024-07-06 17:50:09 +02006074 included, "unsigned" will take precedence.
6075
Bram Moolenaar071d4272004-06-13 20:20:40 +00006076 Numbers which simply begin with a digit in the range 1-9 are always
6077 considered decimal. This also happens for numbers that are not
6078 recognized as octal or hex.
6079
6080 *'number'* *'nu'* *'nonumber'* *'nonu'*
6081'number' 'nu' boolean (default off)
6082 local to window
6083 Print the line number in front of each line. When the 'n' option is
6084 excluded from 'cpoptions' a wrapped line will not use the column of
6085 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00006086 The 'numberwidth' option can be used to set the room used for the line
6087 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006088 When a long, wrapped line doesn't start with the first character, '-'
6089 characters are put before the number.
James McCoya80aad72021-12-22 19:45:28 +00006090 For highlighting see |hl-LineNr|, and |hl-CursorLineNr|, and the
6091 |:sign-define| "numhl" argument.
Bram Moolenaar203d04d2013-06-06 21:36:40 +02006092 *number_relativenumber*
6093 The 'relativenumber' option changes the displayed number to be
6094 relative to the cursor. Together with 'number' there are these
6095 four combinations (cursor in line 3):
6096
Bram Moolenaar3848e002016-03-19 18:42:29 +01006097 'nonu' 'nu' 'nonu' 'nu'
Bram Moolenaar203d04d2013-06-06 21:36:40 +02006098 'nornu' 'nornu' 'rnu' 'rnu'
6099
6100 |apple | 1 apple | 2 apple | 2 apple
6101 |pear | 2 pear | 1 pear | 1 pear
6102 |nobody | 3 nobody | 0 nobody |3 nobody
6103 |there | 4 there | 1 there | 1 there
Bram Moolenaar071d4272004-06-13 20:20:40 +00006104
Bram Moolenaar592e0a22004-07-03 16:05:59 +00006105 *'numberwidth'* *'nuw'*
6106'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
6107 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00006108 {only available when compiled with the |+linebreak|
6109 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00006110 Minimal number of columns to use for the line number. Only relevant
Bram Moolenaar64486672010-05-16 15:46:46 +02006111 when the 'number' or 'relativenumber' option is set or printing lines
6112 with a line number. Since one space is always between the number and
6113 the text, there is one less character for the number itself.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00006114 The value is the minimum width. A bigger width is used when needed to
Bram Moolenaar64486672010-05-16 15:46:46 +02006115 fit the highest line number in the buffer respectively the number of
6116 rows in the window, depending on whether 'number' or 'relativenumber'
6117 is set. Thus with the Vim default of 4 there is room for a line number
6118 up to 999. When the buffer has 1000 lines five columns will be used.
Bram Moolenaarf8a07122019-07-01 22:06:07 +02006119 The minimum value is 1, the maximum value is 20.
Bram Moolenaar036986f2017-03-16 17:41:02 +01006120 NOTE: This option is set to the Vi default value when 'compatible' is
6121 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00006122
Bram Moolenaarf75a9632005-09-13 21:20:47 +00006123 *'omnifunc'* *'ofu'*
6124'omnifunc' 'ofu' string (default: empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00006125 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02006126 {not available when compiled without the |+eval|
Bram Moolenaare2c453d2019-08-21 14:37:09 +02006127 feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00006128 This option specifies a function to be used for Insert mode omni
6129 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
Bram Moolenaar280f1262006-01-30 00:14:18 +00006130 See |complete-functions| for an explanation of how the function is
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00006131 invoked and what it should return. The value can be the name of a
6132 function, a |lambda| or a |Funcref|. See |option-value-function| for
6133 more information.
Bram Moolenaar043545e2006-10-10 16:44:07 +00006134 This option is usually set by a filetype plugin:
Bram Moolenaar9c102382006-05-03 21:26:49 +00006135 |:filetype-plugin-on|
Bram Moolenaar30b65812012-07-12 22:01:11 +02006136 This option cannot be set from a |modeline| or in the |sandbox|, for
6137 security reasons.
Bram Moolenaare344bea2005-09-01 20:46:49 +00006138
Bram Moolenaar02467872007-05-06 13:22:01 +00006139 *'opendevice'* *'odev'* *'noopendevice'* *'noodev'*
Bram Moolenaar043545e2006-10-10 16:44:07 +00006140'opendevice' 'odev' boolean (default off)
6141 global
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00006142 {only for MS-Windows} *E796*
Bram Moolenaar043545e2006-10-10 16:44:07 +00006143 Enable reading and writing from devices. This may get Vim stuck on a
6144 device that can be opened but doesn't actually do the I/O. Therefore
6145 it is off by default.
6146 Note that on MS-Windows editing "aux.h", "lpt1.txt" and the like also
6147 result in editing a device.
6148
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006149 *'operatorfunc'* *'opfunc'*
6150'operatorfunc' 'opfunc' string (default: empty)
6151 global
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006152 This option specifies a function to be called by the |g@| operator.
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +00006153 See |:map-operator| for more info and an example. The value can be
6154 the name of a function, a |lambda| or a |Funcref|. See
6155 |option-value-function| for more information.
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006156
6157 This option cannot be set from a |modeline| or in the |sandbox|, for
6158 security reasons.
6159
Bram Moolenaar251e1912011-06-19 05:09:16 +02006160 *'osfiletype'* *'oft'*
6161'osfiletype' 'oft' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006162 local to buffer
Bram Moolenaar251e1912011-06-19 05:09:16 +02006163 This option was supported on RISC OS, which has been removed.
6164
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01006165 *'packpath'* *'pp'*
6166'packpath' 'pp' string (default: see 'runtimepath')
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01006167 Directories used to find packages. See |packages|.
dkearns8ebdbc92023-10-29 06:26:19 +11006168 This option cannot be set from a |modeline| or in the |sandbox|, for
6169 security reasons.
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01006170
Bram Moolenaar071d4272004-06-13 20:20:40 +00006171 *'paragraphs'* *'para'*
Bram Moolenaar57e48462008-03-12 16:38:55 +00006172'paragraphs' 'para' string (default "IPLPPPQPP TPHPLIPpLpItpplpipbp")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006173 global
6174 Specifies the nroff macros that separate paragraphs. These are pairs
6175 of two letters (see |object-motions|).
6176
6177 *'paste'* *'nopaste'*
6178'paste' boolean (default off)
6179 global
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006180 Put Vim in Paste mode. This is useful if you want to cut or copy
6181 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00006182 unexpected effects.
6183 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006184 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00006185 knows about pasting and will mostly do the right thing without 'paste'
6186 being set. The same is true for a terminal where Vim handles the
6187 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00006188 This option is reset when starting the GUI. Thus if you set it in
6189 your .vimrc it will work in a terminal, but not in the GUI. Setting
6190 'paste' in the GUI has side effects: e.g., the Paste toolbar button
6191 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006192 When the 'paste' option is switched on (also when it was already on):
6193 - mapping in Insert mode and Command-line mode is disabled
6194 - abbreviations are disabled
Bram Moolenaar071d4272004-06-13 20:20:40 +00006195 - 'autoindent' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02006196 - 'expandtab' is reset
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02006197 - 'hkmap' is reset
Bram Moolenaar071d4272004-06-13 20:20:40 +00006198 - 'revins' is reset
6199 - 'ruler' is reset
6200 - 'showmatch' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02006201 - 'smarttab' is reset
6202 - 'softtabstop' is set to 0
6203 - 'textwidth' is set to 0
6204 - 'wrapmargin' is set to 0
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02006205 - 'varsofttabstop' is made empty
Bram Moolenaar071d4272004-06-13 20:20:40 +00006206 These options keep their value, but their effect is disabled:
Bram Moolenaar071d4272004-06-13 20:20:40 +00006207 - 'cindent'
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02006208 - 'formatoptions' is used like it is empty
Bram Moolenaarca635012015-09-25 20:34:21 +02006209 - 'indentexpr'
6210 - 'lisp'
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02006211 - 'smartindent'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006212 NOTE: When you start editing another file while the 'paste' option is
6213 on, settings from the modelines or autocommands may change the
6214 settings again, causing trouble when pasting text. You might want to
6215 set the 'paste' option again.
6216 When the 'paste' option is reset the mentioned options are restored to
6217 the value before the moment 'paste' was switched from off to on.
6218 Resetting 'paste' before ever setting it does not have any effect.
6219 Since mapping doesn't work while 'paste' is active, you need to use
6220 the 'pastetoggle' option to toggle the 'paste' option with some key.
6221
6222 *'pastetoggle'* *'pt'*
6223'pastetoggle' 'pt' string (default "")
6224 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006225 When non-empty, specifies the key sequence that toggles the 'paste'
6226 option. This is like specifying a mapping: >
6227 :map {keys} :set invpaste<CR>
6228< Where {keys} is the value of 'pastetoggle'.
6229 The difference is that it will work even when 'paste' is set.
6230 'pastetoggle' works in Insert mode and Normal mode, but not in
6231 Command-line mode.
6232 Mappings are checked first, thus overrule 'pastetoggle'. However,
6233 when 'paste' is on mappings are ignored in Insert mode, thus you can do
6234 this: >
6235 :map <F10> :set paste<CR>
6236 :map <F11> :set nopaste<CR>
6237 :imap <F10> <C-O>:set paste<CR>
6238 :imap <F11> <nop>
6239 :set pastetoggle=<F11>
6240< This will make <F10> start paste mode and <F11> stop paste mode.
6241 Note that typing <F10> in paste mode inserts "<F10>", since in paste
6242 mode everything is inserted literally, except the 'pastetoggle' key
6243 sequence.
Bram Moolenaar446cb832008-06-24 21:56:24 +00006244 When the value has several bytes 'ttimeoutlen' applies.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006245
6246 *'pex'* *'patchexpr'*
6247'patchexpr' 'pex' string (default "")
6248 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006249 {not available when compiled without the |+diff|
6250 feature}
6251 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006252 the resulting new version of the file. See |diff-patchexpr|.
dkearns8ebdbc92023-10-29 06:26:19 +11006253 This option cannot be set from a |modeline| or in the |sandbox|, for
6254 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006255
Bram Moolenaardbc28022014-07-26 13:40:44 +02006256 *'patchmode'* *'pm'* *E205* *E206*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006257'patchmode' 'pm' string (default "")
6258 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006259 When non-empty the oldest version of a file is kept. This can be used
6260 to keep the original version of a file if you are changing files in a
6261 source distribution. Only the first time that a file is written a
6262 copy of the original file will be kept. The name of the copy is the
6263 name of the original file with the string in the 'patchmode' option
6264 appended. This option should start with a dot. Use a string like
Bram Moolenaardf980db2017-12-24 13:22:00 +01006265 ".orig" or ".org". 'backupdir' must not be empty for this to work
6266 (Detail: The backup file is renamed to the patchmode file after the
6267 new file has been successfully written, that's why it must be possible
6268 to write a backup file). If there was no file to be backed up, an
6269 empty file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006270 When the 'backupskip' pattern matches, a patchmode file is not made.
6271 Using 'patchmode' for compressed files appends the extension at the
6272 end (e.g., "file.gz.orig"), thus the resulting name isn't always
6273 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006274 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006275
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01006276 *'path'* *'pa'* *E343* *E345* *E347* *E854*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006277'path' 'pa' string (default on Unix: ".,/usr/include,,"
Bram Moolenaar071d4272004-06-13 20:20:40 +00006278 other systems: ".,,")
6279 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006280 This is a list of directories which will be searched when using the
Bram Moolenaarc236c162008-07-13 17:41:49 +00006281 |gf|, [f, ]f, ^Wf, |:find|, |:sfind|, |:tabfind| and other commands,
6282 provided that the file being searched for has a relative path (not
6283 starting with "/", "./" or "../"). The directories in the 'path'
6284 option may be relative or absolute.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006285 - Use commas to separate directory names: >
6286 :set path=.,/usr/local/include,/usr/include
6287< - Spaces can also be used to separate directory names (for backwards
6288 compatibility with version 3.0). To have a space in a directory
6289 name, precede it with an extra backslash, and escape the space: >
6290 :set path=.,/dir/with\\\ space
6291< - To include a comma in a directory name precede it with an extra
6292 backslash: >
6293 :set path=.,/dir/with\\,comma
6294< - To search relative to the directory of the current file, use: >
6295 :set path=.
6296< - To search in the current directory use an empty string between two
6297 commas: >
6298 :set path=,,
6299< - A directory name may end in a ':' or '/'.
6300 - Environment variables are expanded |:set_env|.
6301 - When using |netrw.vim| URLs can be used. For example, adding
6302 "http://www.vim.org" will make ":find index.html" work.
Bram Moolenaarc236c162008-07-13 17:41:49 +00006303 - Search upwards and downwards in a directory tree using "*", "**" and
6304 ";". See |file-searching| for info and syntax.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006305 - Careful with '\' characters, type two to get one in the option: >
6306 :set path=.,c:\\include
6307< Or just use '/' instead: >
6308 :set path=.,c:/include
6309< Don't forget "." or files won't even be found in the same directory as
6310 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006311 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00006312 it is something like 256 or 1024 characters.
6313 You can check if all the include files are found, using the value of
6314 'path', see |:checkpath|.
6315 The use of |:set+=| and |:set-=| is preferred when adding or removing
6316 directories from the list. This avoids problems when a future version
6317 uses another default. To remove the current directory use: >
6318 :set path-=
6319< To add the current directory use: >
6320 :set path+=
6321< To use an environment variable, you probably need to replace the
6322 separator. Here is an example to append $INCL, in which directory
Dominique Pellédf62c622024-07-15 20:29:59 +02006323 names are separated with a semicolon: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00006324 :let &path = &path .. "," .. substitute($INCL, ';', ',', 'g')
Bram Moolenaar071d4272004-06-13 20:20:40 +00006325< Replace the ';' with a ':' or whatever separator is used. Note that
6326 this doesn't work when $INCL contains a comma or white space.
6327
Bram Moolenaar37c64c72017-09-19 22:06:03 +02006328 *'perldll'*
6329'perldll' string (default depends on the build)
6330 global
Bram Moolenaar37c64c72017-09-19 22:06:03 +02006331 {only available when compiled with the |+perl/dyn|
6332 feature}
6333 Specifies the name of the Perl shared library. The default is
6334 DYNAMIC_PERL_DLL, which was specified at compile time.
6335 Environment variables are expanded |:set_env|.
6336 This option cannot be set from a |modeline| or in the |sandbox|, for
6337 security reasons.
6338
Bram Moolenaar071d4272004-06-13 20:20:40 +00006339 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
6340'preserveindent' 'pi' boolean (default off)
6341 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00006342 When changing the indent of the current line, preserve as much of the
6343 indent structure as possible. Normally the indent is replaced by a
6344 series of tabs followed by spaces as required (unless |'expandtab'| is
6345 enabled, in which case only spaces are used). Enabling this option
6346 means the indent will preserve as many existing characters as possible
6347 for indenting, and only add additional tabs or spaces as required.
Bram Moolenaar446cb832008-06-24 21:56:24 +00006348 'expandtab' does not apply to the preserved white space, a Tab remains
6349 a Tab.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006350 NOTE: When using ">>" multiple times the resulting indent is a mix of
6351 tabs and spaces. You might not like this.
Bram Moolenaar036986f2017-03-16 17:41:02 +01006352 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006353 Also see 'copyindent'.
6354 Use |:retab| to clean up white space.
6355
6356 *'previewheight'* *'pvh'*
6357'previewheight' 'pvh' number (default 12)
6358 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02006359 {not available when compiled without the |+quickfix|
6360 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006361 Default height for a preview window. Used for |:ptag| and associated
Bram Moolenaar79648732019-07-18 21:43:07 +02006362 commands. Used for |CTRL-W_}| when no count is given. Not used when
6363 'previewpopup' is set.
6364
6365 *'previewpopup'* *'pvp'*
6366'previewpopup' 'pvp' string (default empty)
6367 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02006368 {not available when compiled without the |+textprop|
6369 or |+quickfix| feature}
Bram Moolenaar79648732019-07-18 21:43:07 +02006370 When not empty a popup window is used for commands that would open a
6371 preview window. See |preview-popup|.
Bram Moolenaar576a4a62019-08-18 15:25:17 +02006372 Not used for the insert completion info, add "popup" to
6373 'completeopt' for that.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006374
6375 *'previewwindow'* *'nopreviewwindow'*
6376 *'pvw'* *'nopvw'* *E590*
6377'previewwindow' 'pvw' boolean (default off)
Christian Brabandt596ad662023-08-16 00:11:09 +02006378 local to window |local-noglobal|
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02006379 {not available when compiled without the |+quickfix|
6380 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006381 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00006382 set. It's normally not set directly, but by using one of the commands
6383 |:ptag|, |:pedit|, etc.
6384
6385 *'printdevice'* *'pdev'*
6386'printdevice' 'pdev' string (default empty)
6387 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006388 {only available when compiled with the |+printer|
6389 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006390 The name of the printer to be used for |:hardcopy|.
6391 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006392 This option cannot be set from a |modeline| or in the |sandbox|, for
6393 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006394
Bram Moolenaar8299df92004-07-10 09:47:34 +00006395 *'printencoding'* *'penc'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02006396'printencoding' 'penc' string (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006397 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006398 {only available when compiled with the |+printer|
6399 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006400 Sets the character encoding used when printing.
6401 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006402
6403 *'printexpr'* *'pexpr'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02006404'printexpr' 'pexpr' string (default: see below)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006405 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006406 {only available when compiled with the |+printer|
6407 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006408 Expression used to print the PostScript produced with |:hardcopy|.
6409 See |pexpr-option|.
Bram Moolenaar51628222016-12-01 23:03:28 +01006410 This option cannot be set from a |modeline| or in the |sandbox|, for
6411 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006412
Bram Moolenaar8299df92004-07-10 09:47:34 +00006413 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006414'printfont' 'pfn' string (default "courier")
6415 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006416 {only available when compiled with the |+printer|
6417 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006418 The name of the font that will be used for |:hardcopy|.
6419 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006420
6421 *'printheader'* *'pheader'*
6422'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
6423 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006424 {only available when compiled with the |+printer|
6425 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006426 The format of the header produced in |:hardcopy| output.
6427 See |pheader-option|.
6428
6429 *'printmbcharset'* *'pmbcs'*
6430'printmbcharset' 'pmbcs' string (default "")
6431 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01006432 {only available when compiled with the |+printer|
6433 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006434 The CJK character set to be used for CJK output from |:hardcopy|.
6435 See |pmbcs-option|.
6436
6437 *'printmbfont'* *'pmbfn'*
6438'printmbfont' 'pmbfn' string (default "")
6439 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01006440 {only available when compiled with the |+printer|
6441 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006442 List of font names to be used for CJK output from |:hardcopy|.
6443 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006444
6445 *'printoptions'* *'popt'*
6446'printoptions' 'popt' string (default "")
6447 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006448 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006449 List of items that control the format of the output of |:hardcopy|.
6450 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006451
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006452 *'prompt'* *'noprompt'*
6453'prompt' boolean (default on)
6454 global
6455 When on a ":" prompt is used in Ex mode.
6456
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00006457 *'pumheight'* *'ph'*
6458'pumheight' 'ph' number (default 0)
6459 global
Bram Moolenaar06a89a52006-04-29 22:01:03 +00006460 Determines the maximum number of items to show in the popup menu for
6461 Insert mode completion. When zero as much space as available is used.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00006462 |ins-completion-menu|.
6463
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01006464 *'pumwidth'* *'pw'*
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006465'pumwidth' 'pw' number (default 15)
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01006466 global
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01006467 Determines the minimum width to use for the popup menu for Insert mode
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006468 completion. |ins-completion-menu|.
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01006469
Bram Moolenaard94464e2015-11-02 15:28:18 +01006470 *'pythondll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01006471'pythondll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01006472 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01006473 {only available when compiled with the |+python/dyn|
6474 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006475 Specifies the name of the Python 2.x shared library. The default is
6476 DYNAMIC_PYTHON_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006477 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01006478 This option cannot be set from a |modeline| or in the |sandbox|, for
6479 security reasons.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00006480
Bram Moolenaar94073162018-01-31 21:49:05 +01006481 *'pythonhome'*
6482'pythonhome' string (default "")
6483 global
Bram Moolenaar94073162018-01-31 21:49:05 +01006484 {only available when compiled with the |+python/dyn|
6485 feature}
6486 Specifies the name of the Python 2.x home directory. When 'pythonhome'
6487 and the PYTHONHOME environment variable are not set, PYTHON_HOME,
6488 which was specified at compile time, will be used for the Python 2.x
6489 home directory.
6490 Environment variables are expanded |:set_env|.
6491 This option cannot be set from a |modeline| or in the |sandbox|, for
6492 security reasons.
6493
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006494 *'pythonthreedll'*
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006495'pythonthreedll' string (default depends on the build)
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006496 global
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006497 {only available when compiled with the |+python3/dyn|
6498 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006499 Specifies the name of the Python 3 shared library. The default is
6500 DYNAMIC_PYTHON3_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006501 Environment variables are expanded |:set_env|.
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006502 This option cannot be set from a |modeline| or in the |sandbox|, for
6503 security reasons.
6504
Bram Moolenaar94073162018-01-31 21:49:05 +01006505 *'pythonthreehome'*
6506'pythonthreehome' string (default "")
6507 global
Bram Moolenaar94073162018-01-31 21:49:05 +01006508 {only available when compiled with the |+python3/dyn|
6509 feature}
6510 Specifies the name of the Python 3 home directory. When
6511 'pythonthreehome' and the PYTHONHOME environment variable are not set,
6512 PYTHON3_HOME, which was specified at compile time, will be used for
6513 the Python 3 home directory.
6514 Environment variables are expanded |:set_env|.
6515 This option cannot be set from a |modeline| or in the |sandbox|, for
6516 security reasons.
6517
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01006518 *'pyxversion'* *'pyx'*
6519'pyxversion' 'pyx' number (default depends on the build)
6520 global
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01006521 {only available when compiled with the |+python| or
6522 the |+python3| feature}
6523 Specifies the python version used for pyx* functions and commands
6524 |python_x|. The default value is as follows:
6525
6526 Compiled with Default ~
6527 |+python| and |+python3| 0
6528 only |+python| 2
6529 only |+python3| 3
6530
6531 Available values are 0, 2 and 3.
6532 If 'pyxversion' is 0, it is set to 2 or 3 after the first execution of
6533 any python2/3 commands or functions. E.g. `:py` sets to 2, and `:py3`
6534 sets to 3. `:pyx` sets it to 3 if Python 3 is available, otherwise sets
6535 to 2 if Python 2 is available.
6536 See also: |has-pythonx|
6537
6538 If Vim is compiled with only |+python| or |+python3| setting
6539 'pyxversion' has no effect. The pyx* functions and commands are
6540 always the same as the compiled version.
6541
6542 This option cannot be set from a |modeline| or in the |sandbox|, for
6543 security reasons.
6544
Bram Moolenaar858ba062020-05-31 23:11:59 +02006545 *'quickfixtextfunc'* *'qftf'*
6546'quickfixtextfunc' 'qftf' string (default "")
6547 global
6548 {only available when compiled with the |+quickfix|
6549 feature}
6550 This option specifies a function to be used to get the text to display
6551 in the quickfix and location list windows. This can be used to
6552 customize the information displayed in the quickfix or location window
6553 for each entry in the corresponding quickfix or location list. See
6554 |quickfix-window-function| for an explanation of how to write the
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +00006555 function and an example. The value can be the name of a function, a
6556 |lambda| or a |Funcref|. See |option-value-function| for more
6557 information.
Bram Moolenaar858ba062020-05-31 23:11:59 +02006558
6559 This option cannot be set from a |modeline| or in the |sandbox|, for
6560 security reasons.
6561
Bram Moolenaar677ee682005-01-27 14:41:15 +00006562 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00006563'quoteescape' 'qe' string (default "\")
6564 local to buffer
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00006565 The characters that are used to escape quotes in a string. Used for
6566 objects like a', a" and a` |a'|.
6567 When one of the characters in this option is found inside a string,
6568 the following character will be skipped. The default value makes the
6569 text "foo\"bar\\" considered to be one string.
6570
Bram Moolenaar071d4272004-06-13 20:20:40 +00006571 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
6572'readonly' 'ro' boolean (default off)
Christian Brabandt596ad662023-08-16 00:11:09 +02006573 local to buffer |local-noglobal|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006574 If on, writes fail unless you use a '!'. Protects you from
6575 accidentally overwriting a file. Default on when Vim is started
6576 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006577 When using ":w!" the 'readonly' option is reset for the current
6578 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar6c60f472019-04-28 16:00:35 +02006579 When using the ":view" command the 'readonly' option is set for the
6580 newly edited buffer.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01006581 See 'modifiable' for disallowing changes to the buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006582
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006583 *'redrawtime'* *'rdt'*
6584'redrawtime' 'rdt' number (default 2000)
6585 global
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006586 {only available when compiled with the |+reltime|
6587 feature}
6588 The time in milliseconds for redrawing the display. This applies to
Bram Moolenaar15142e22018-04-30 22:19:58 +02006589 searching for patterns for 'hlsearch', |:match| highlighting and syntax
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02006590 highlighting.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006591 When redrawing takes more than this many milliseconds no further
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02006592 matches will be highlighted.
6593 For syntax highlighting the time applies per window. When over the
6594 limit syntax highlighting is disabled until |CTRL-L| is used.
6595 This is used to avoid that Vim hangs when using a very complicated
6596 pattern.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006597
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02006598 *'regexpengine'* *'re'*
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006599'regexpengine' 're' number (default 0)
6600 global
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006601 This selects the default regexp engine. |two-engines|
6602 The possible values are:
6603 0 automatic selection
6604 1 old engine
6605 2 NFA engine
6606 Note that when using the NFA engine and the pattern contains something
6607 that is not supported the pattern will not match. This is only useful
6608 for debugging the regexp engine.
Bram Moolenaarfda37292014-11-05 14:27:36 +01006609 Using automatic selection enables Vim to switch the engine, if the
6610 default engine becomes too costly. E.g., when the NFA engine uses too
6611 many states. This should prevent Vim from hanging on a combination of
6612 a complex pattern with long text.
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006613
Bram Moolenaar64486672010-05-16 15:46:46 +02006614 *'relativenumber'* *'rnu'* *'norelativenumber'* *'nornu'*
6615'relativenumber' 'rnu' boolean (default off)
6616 local to window
Bram Moolenaar64486672010-05-16 15:46:46 +02006617 Show the line number relative to the line with the cursor in front of
Bram Moolenaar06b5d512010-05-22 15:37:44 +02006618 each line. Relative line numbers help you use the |count| you can
Bram Moolenaar64486672010-05-16 15:46:46 +02006619 precede some vertical motion commands (e.g. j k + -) with, without
6620 having to calculate it yourself. Especially useful in combination with
6621 other commands (e.g. y d c < > gq gw =).
6622 When the 'n' option is excluded from 'cpoptions' a wrapped
6623 line will not use the column of line numbers (this is the default when
6624 'compatible' isn't set).
6625 The 'numberwidth' option can be used to set the room used for the line
6626 number.
6627 When a long, wrapped line doesn't start with the first character, '-'
6628 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02006629 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
6630 the number.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01006631
Bram Moolenaar203d04d2013-06-06 21:36:40 +02006632 The number in front of the cursor line also depends on the value of
6633 'number', see |number_relativenumber| for all combinations of the two
6634 options.
Bram Moolenaar64486672010-05-16 15:46:46 +02006635
Bram Moolenaar071d4272004-06-13 20:20:40 +00006636 *'remap'* *'noremap'*
6637'remap' boolean (default on)
6638 global
6639 Allows for mappings to work recursively. If you do not want this for
6640 a single entry, use the :noremap[!] command.
Bram Moolenaara3227e22006-03-08 21:32:40 +00006641 NOTE: To avoid portability problems with Vim scripts, always keep
6642 this option at the default "on". Only switch it off when working with
6643 old Vi scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006644
zeertzjqd086b8f2024-02-25 15:42:52 +08006645 *'renderoptions'* *'rop'*
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006646'renderoptions' 'rop' string (default: empty)
6647 global
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006648 {only available when compiled with GUI and DIRECTX on
6649 MS-Windows}
6650 Select a text renderer and set its options. The options depend on the
6651 renderer.
6652
6653 Syntax: >
6654 set rop=type:{renderer}(,{name}:{value})*
6655<
6656 Currently, only one optional renderer is available.
6657
6658 render behavior ~
6659 directx Vim will draw text using DirectX (DirectWrite). It makes
6660 drawn glyphs more beautiful than default GDI.
6661 It requires 'encoding' is "utf-8", and only works on
6662 MS-Windows Vista or newer version.
6663
6664 Options:
6665 name meaning type value ~
6666 gamma gamma float 1.0 - 2.2 (maybe)
6667 contrast enhancedContrast float (unknown)
6668 level clearTypeLevel float (unknown)
6669 geom pixelGeometry int 0 - 2 (see below)
6670 renmode renderingMode int 0 - 6 (see below)
6671 taamode textAntialiasMode int 0 - 3 (see below)
Bram Moolenaara338adc2018-01-31 20:51:47 +01006672 scrlines Scroll Lines int (deprecated)
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006673
Bram Moolenaar92467d32017-12-05 13:22:16 +01006674 See this URL for detail (except for scrlines):
6675 https://msdn.microsoft.com/en-us/library/dd368190.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006676
6677 For geom: structure of a device pixel.
6678 0 - DWRITE_PIXEL_GEOMETRY_FLAT
6679 1 - DWRITE_PIXEL_GEOMETRY_RGB
6680 2 - DWRITE_PIXEL_GEOMETRY_BGR
6681
6682 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006683 https://msdn.microsoft.com/en-us/library/dd368114.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006684
6685 For renmode: method of rendering glyphs.
6686 0 - DWRITE_RENDERING_MODE_DEFAULT
6687 1 - DWRITE_RENDERING_MODE_ALIASED
6688 2 - DWRITE_RENDERING_MODE_GDI_CLASSIC
6689 3 - DWRITE_RENDERING_MODE_GDI_NATURAL
6690 4 - DWRITE_RENDERING_MODE_NATURAL
6691 5 - DWRITE_RENDERING_MODE_NATURAL_SYMMETRIC
6692 6 - DWRITE_RENDERING_MODE_OUTLINE
6693
6694 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006695 https://msdn.microsoft.com/en-us/library/dd368118.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006696
6697 For taamode: antialiasing mode used for drawing text.
6698 0 - D2D1_TEXT_ANTIALIAS_MODE_DEFAULT
6699 1 - D2D1_TEXT_ANTIALIAS_MODE_CLEARTYPE
6700 2 - D2D1_TEXT_ANTIALIAS_MODE_GRAYSCALE
6701 3 - D2D1_TEXT_ANTIALIAS_MODE_ALIASED
6702
6703 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006704 https://msdn.microsoft.com/en-us/library/dd368170.aspx
6705
Bram Moolenaara338adc2018-01-31 20:51:47 +01006706 For scrlines:
6707 This was used for optimizing scrolling behavior, however this
6708 is now deprecated. If specified, it is simply ignored.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006709
6710 Example: >
6711 set encoding=utf-8
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006712 set gfn=Ricty_Diminished:h12
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006713 set rop=type:directx
6714<
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006715 If select a raster font (Courier, Terminal or FixedSys which
6716 have ".fon" extension in file name) to 'guifont', it will be
Bram Moolenaar92467d32017-12-05 13:22:16 +01006717 drawn by GDI as a fallback.
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006718
6719 NOTE: It is known that some fonts and options combination
6720 causes trouble on drawing glyphs.
6721
Bram Moolenaar92467d32017-12-05 13:22:16 +01006722 - 'renmode:5' and 'renmode:6' will not work with some
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006723 special made fonts (True-Type fonts which includes only
6724 bitmap glyphs).
6725 - 'taamode:3' will not work with some vector fonts.
6726
6727 NOTE: With this option, you can display colored emoji
6728 (emoticon) in Windows 8.1 or later. To display colored emoji,
6729 there are some conditions which you should notice.
6730
6731 - If your font includes non-colored emoji already, it will
6732 be used.
6733 - If your font doesn't have emoji, the system chooses an
6734 alternative symbol font. On Windows 10, "Segoe UI Emoji"
6735 will be used.
6736 - When this alternative font didn't have fixed width glyph,
6737 emoji might be rendered beyond the bounding box of drawing
6738 cell.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006739
6740 Other render types are currently not supported.
6741
Bram Moolenaar071d4272004-06-13 20:20:40 +00006742 *'report'*
6743'report' number (default 2)
6744 global
6745 Threshold for reporting number of lines changed. When the number of
6746 changed lines is more than 'report' a message will be given for most
6747 ":" commands. If you want it always, set 'report' to 0.
6748 For the ":substitute" command the number of substitutions is used
6749 instead of the number of lines.
6750
6751 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
6752'restorescreen' 'rs' boolean (default on)
6753 global
Bram Moolenaar8024f932020-01-14 19:29:13 +01006754 {only in MS-Windows console version}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006755 When set, the screen contents is restored when exiting Vim. This also
6756 happens when executing external commands.
6757
6758 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
6759 options in your .vimrc. To disable restoring:
6760 set t_ti= t_te=
6761 To enable restoring (for an xterm):
6762 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
6763 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
6764
6765 *'revins'* *'ri'* *'norevins'* *'nori'*
6766'revins' 'ri' boolean (default off)
6767 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006768 {only available when compiled with the |+rightleft|
6769 feature}
6770 Inserting characters in Insert mode will work backwards. See "typing
6771 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
6772 command in Insert mode, when 'allowrevins' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02006773 NOTE: This option is reset when 'compatible' is set.
6774 This option is reset when 'paste' is set and restored when 'paste' is
6775 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006776
6777 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
6778'rightleft' 'rl' boolean (default off)
6779 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006780 {only available when compiled with the |+rightleft|
6781 feature}
6782 When on, display orientation becomes right-to-left, i.e., characters
6783 that are stored in the file appear from the right to the left.
6784 Using this option, it is possible to edit files for languages that
6785 are written from the right to the left such as Hebrew and Arabic.
6786 This option is per window, so it is possible to edit mixed files
6787 simultaneously, or to view the same file in both ways (this is
6788 useful whenever you have a mixed text file with both right-to-left
6789 and left-to-right strings so that both sets are displayed properly
6790 in different windows). Also see |rileft.txt|.
6791
Bram Moolenaar607cc1e2010-07-18 18:47:44 +02006792 *'rightleftcmd'* *'rlc'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006793'rightleftcmd' 'rlc' string (default "search")
6794 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006795 {only available when compiled with the |+rightleft|
6796 feature}
6797 Each word in this option enables the command line editing to work in
6798 right-to-left mode for a group of commands:
6799
6800 search "/" and "?" commands
6801
6802 This is useful for languages such as Hebrew, Arabic and Farsi.
6803 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
6804
Bram Moolenaard94464e2015-11-02 15:28:18 +01006805 *'rubydll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01006806'rubydll' string (default: depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01006807 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01006808 {only available when compiled with the |+ruby/dyn|
6809 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006810 Specifies the name of the Ruby shared library. The default is
6811 DYNAMIC_RUBY_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006812 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01006813 This option cannot be set from a |modeline| or in the |sandbox|, for
6814 security reasons.
6815
Bram Moolenaar071d4272004-06-13 20:20:40 +00006816 *'ruler'* *'ru'* *'noruler'* *'noru'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02006817'ruler' 'ru' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006818 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006819 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006820 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00006821 text in the file is shown on the far right:
6822 Top first line is visible
6823 Bot last line is visible
6824 All first and last line are visible
6825 45% relative position in the file
6826 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006827 Each window has its own ruler. If a window has a status line, the
Bram Moolenaara2a89732022-08-31 14:46:18 +01006828 ruler is shown there. Otherwise it is shown in the last line of the
6829 screen. If the statusline is given by 'statusline' (i.e. not empty),
6830 this option takes precedence over 'ruler' and 'rulerformat'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006831 If the number of characters displayed is different from the number of
Bram Moolenaar207f0092020-08-30 17:20:20 +02006832 bytes in the text (e.g., for a TAB or a multibyte character), both
Bram Moolenaar071d4272004-06-13 20:20:40 +00006833 the text column (byte number) and the screen column are shown,
6834 separated with a dash.
6835 For an empty line "0-1" is shown.
6836 For an empty buffer the line number will also be zero: "0,0-1".
Bram Moolenaarca635012015-09-25 20:34:21 +02006837 This option is reset when 'paste' is set and restored when 'paste' is
6838 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006839 If you don't want to see the ruler all the time but want to know where
6840 you are, use "g CTRL-G" |g_CTRL-G|.
6841 NOTE: This option is reset when 'compatible' is set.
6842
6843 *'rulerformat'* *'ruf'*
6844'rulerformat' 'ruf' string (default empty)
6845 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006846 {not available when compiled without the |+statusline|
6847 feature}
6848 When this option is not empty, it determines the content of the ruler
6849 string, as displayed for the 'ruler' option.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00006850 The format of this option is like that of 'statusline'.
Bram Moolenaar110289e2019-05-23 15:38:06 +02006851 This option cannot be set in a modeline when 'modelineexpr' is off.
6852
Bram Moolenaar071d4272004-06-13 20:20:40 +00006853 The default ruler width is 17 characters. To make the ruler 15
6854 characters wide, put "%15(" at the start and "%)" at the end.
6855 Example: >
6856 :set rulerformat=%15(%c%V\ %p%%%)
6857<
6858 *'runtimepath'* *'rtp'* *vimfiles*
6859'runtimepath' 'rtp' string (default:
Christian Brabandtc3e6e392024-05-04 09:48:15 +02006860 Unix: "$HOME/.vim or
6861 $XDG_CONFIG_HOME/vim,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006862 $VIM/vimfiles,
6863 $VIMRUNTIME,
6864 $VIM/vimfiles/after,
6865 $HOME/.vim/after"
6866 Amiga: "home:vimfiles,
6867 $VIM/vimfiles,
6868 $VIMRUNTIME,
6869 $VIM/vimfiles/after,
6870 home:vimfiles/after"
Bram Moolenaar942db232021-02-13 18:14:48 +01006871 MS-Windows: "$HOME/vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006872 $VIM/vimfiles,
6873 $VIMRUNTIME,
6874 $VIM/vimfiles/after,
6875 $HOME/vimfiles/after"
Bram Moolenaarb3f74062020-02-26 16:16:53 +01006876 Haiku: "$BE_USER_SETTINGS/vim,
6877 $VIM/vimfiles,
6878 $VIMRUNTIME,
6879 $VIM/vimfiles/after,
Bram Moolenaar942db232021-02-13 18:14:48 +01006880 $BE_USER_SETTINGS/vim/after"
6881 VMS: "sys$login:vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006882 $VIM/vimfiles,
6883 $VIMRUNTIME,
6884 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00006885 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006886 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006887 This is a list of directories which will be searched for runtime
6888 files:
6889 filetype.vim filetypes by file name |new-filetype|
6890 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006891 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006892 colors/ color scheme files |:colorscheme|
6893 compiler/ compiler files |:compiler|
6894 doc/ documentation |write-local-help|
6895 ftplugin/ filetype plugins |write-filetype-plugin|
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01006896 import/ files that are found by `:import`
Bram Moolenaar071d4272004-06-13 20:20:40 +00006897 indent/ indent scripts |indent-expression|
6898 keymap/ key mapping files |mbyte-keymap|
RestorerZ96509102024-07-11 21:14:15 +02006899 lang/ message translations |:menutrans| and |multi-lang|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006900 menu.vim GUI menus |menu.vim|
Bram Moolenaar26852122016-05-24 20:02:38 +02006901 pack/ packages |:packadd|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006902 plugin/ plugin scripts |write-plugin|
6903 print/ files for printing |postscript-print-encoding|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006904 spell/ spell checking files |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006905 syntax/ syntax files |mysyntaxfile|
6906 tutor/ files for vimtutor |tutor|
6907
6908 And any other file searched for with the |:runtime| command.
6909
Christian Brabandtc3e6e392024-05-04 09:48:15 +02006910 For $XDG_CONFIG_HOME see |xdg-base-dir|.
6911
Bram Moolenaar071d4272004-06-13 20:20:40 +00006912 The defaults for most systems are setup to search five locations:
6913 1. In your home directory, for your personal preferences.
6914 2. In a system-wide Vim directory, for preferences from the system
6915 administrator.
6916 3. In $VIMRUNTIME, for files distributed with Vim.
6917 *after-directory*
6918 4. In the "after" directory in the system-wide Vim directory. This is
6919 for the system administrator to overrule or add to the distributed
6920 defaults (rarely needed)
6921 5. In the "after" directory in your home directory. This is for
6922 personal preferences to overrule or add to the distributed defaults
6923 or system-wide settings (rarely needed).
6924
Bram Moolenaard0796902016-09-16 20:02:31 +02006925 More entries are added when using |packages|. If it gets very long
6926 then `:set rtp` will be truncated, use `:echo &rtp` to see the full
6927 string.
Bram Moolenaar26852122016-05-24 20:02:38 +02006928
Bram Moolenaar071d4272004-06-13 20:20:40 +00006929 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
6930 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006931 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00006932 wildcards.
6933 See |:runtime|.
6934 Example: >
6935 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
6936< This will use the directory "~/vimruntime" first (containing your
6937 personal Vim runtime files), then "/mygroup/vim" (shared between a
6938 group of people) and finally "$VIMRUNTIME" (the distributed runtime
6939 files).
6940 You probably should always include $VIMRUNTIME somewhere, to use the
6941 distributed runtime files. You can put a directory before $VIMRUNTIME
6942 to find files which replace a distributed runtime files. You can put
6943 a directory after $VIMRUNTIME to find files which add to distributed
6944 runtime files.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006945 When Vim is started with |--clean| the home directory entries are not
6946 included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006947 This option cannot be set from a |modeline| or in the |sandbox|, for
6948 security reasons.
6949
6950 *'scroll'* *'scr'*
6951'scroll' 'scr' number (default: half the window height)
Christian Brabandt596ad662023-08-16 00:11:09 +02006952 local to window |local-noglobal|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006953 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
6954 set to half the number of lines in the window when the window size
Bram Moolenaar74667062020-12-28 15:41:41 +01006955 changes. This may happen when enabling the |status-line| or
6956 'tabline' option after setting the 'scroll' option.
6957 If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006958 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar25c9c682019-05-05 18:13:34 +02006959 height with ":set scroll=0".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006960
6961 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
6962'scrollbind' 'scb' boolean (default off)
6963 local to window
zeertzjq5277cfa2023-09-28 01:00:12 +08006964 See also |scroll-binding|. When this option is set, scrolling the
6965 current window also scrolls other scrollbind windows (windows that
6966 also have this option set). This option is useful for viewing the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006967 differences between two versions of a file, see 'diff'.
6968 See |'scrollopt'| for options that determine how this option should be
6969 interpreted.
6970 This option is mostly reset when splitting a window to edit another
6971 file. This means that ":split | edit file" results in two windows
6972 with scroll-binding, but ":split file" does not.
6973
Bram Moolenaarae20f342019-11-05 21:09:23 +01006974 *'scrollfocus'* *'scf'* *'noscrollfocus'* *'noscf'*
6975'scrollfocus' 'scf' boolean (default off)
6976 global
6977 {only for MS-Windows GUI}
6978 When using the scroll wheel and this option is set, the window under
6979 the mouse pointer is scrolled. With this option off the current
6980 window is scrolled.
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01006981 Systems other than MS-Windows always behave like this option is on.
Bram Moolenaarae20f342019-11-05 21:09:23 +01006982
Bram Moolenaar071d4272004-06-13 20:20:40 +00006983 *'scrolljump'* *'sj'*
6984'scrolljump' 'sj' number (default 1)
6985 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006986 Minimal number of lines to scroll when the cursor gets off the
6987 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
6988 CTRL-D). Useful if your terminal scrolls very slowly.
Bram Moolenaar1e015462005-09-25 22:16:38 +00006989 When set to a negative number from -1 to -100 this is used as the
6990 percentage of the window height. Thus -50 scrolls half the window
6991 height.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006992 NOTE: This option is set to 1 when 'compatible' is set.
6993
6994 *'scrolloff'* *'so'*
Bram Moolenaar50ba5262016-09-22 22:33:02 +02006995'scrolloff' 'so' number (default 0, set to 5 in |defaults.vim|)
Bram Moolenaar375e3392019-01-31 18:26:10 +01006996 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006997 Minimal number of screen lines to keep above and below the cursor.
6998 This will make some context visible around where you are working. If
6999 you set it to a very large value (999) the cursor line will always be
7000 in the middle of the window (except at the start or end of the file or
7001 when long lines wrap).
Bram Moolenaar375e3392019-01-31 18:26:10 +01007002 After using the local value, go back the global value with one of
7003 these two: >
7004 setlocal scrolloff<
7005 setlocal scrolloff=-1
7006< For scrolling horizontally see 'sidescrolloff'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007007 NOTE: This option is set to 0 when 'compatible' is set.
7008
7009 *'scrollopt'* *'sbo'*
7010'scrollopt' 'sbo' string (default "ver,jump")
7011 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007012 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007013 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
7014 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007015 The following words are available:
7016 ver Bind vertical scrolling for 'scrollbind' windows
7017 hor Bind horizontal scrolling for 'scrollbind' windows
7018 jump Applies to the offset between two windows for vertical
7019 scrolling. This offset is the difference in the first
7020 displayed line of the bound windows. When moving
7021 around in a window, another 'scrollbind' window may
7022 reach a position before the start or after the end of
7023 the buffer. The offset is not changed though, when
7024 moving back the 'scrollbind' window will try to scroll
7025 to the desired position when possible.
7026 When now making that window the current one, two
7027 things can be done with the relative offset:
7028 1. When "jump" is not included, the relative offset is
7029 adjusted for the scroll position in the new current
7030 window. When going back to the other window, the
Bram Moolenaar02467872007-05-06 13:22:01 +00007031 new relative offset will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007032 2. When "jump" is included, the other windows are
7033 scrolled to keep the same relative offset. When
7034 going back to the other window, it still uses the
7035 same relative offset.
7036 Also see |scroll-binding|.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00007037 When 'diff' mode is active there always is vertical scroll binding,
7038 even when "ver" isn't there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007039
7040 *'sections'* *'sect'*
7041'sections' 'sect' string (default "SHNHH HUnhsh")
7042 global
7043 Specifies the nroff macros that separate sections. These are pairs of
7044 two letters (See |object-motions|). The default makes a section start
7045 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
7046
7047 *'secure'* *'nosecure'* *E523*
7048'secure' boolean (default off)
7049 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007050 When on, ":autocmd", shell and write commands are not allowed in
7051 ".vimrc" and ".exrc" in the current directory and map commands are
7052 displayed. Switch it off only if you know that you will not run into
7053 problems, or when the 'exrc' option is off. On Unix this option is
7054 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007055 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00007056 'secure' at the end of your ~/.vimrc then.
7057 This option cannot be set from a |modeline| or in the |sandbox|, for
7058 security reasons.
7059
7060 *'selection'* *'sel'*
7061'selection' 'sel' string (default "inclusive")
7062 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007063 This option defines the behavior of the selection. It is only used
7064 in Visual and Select mode.
7065 Possible values:
7066 value past line inclusive ~
7067 old no yes
7068 inclusive yes yes
7069 exclusive yes no
7070 "past line" means that the cursor is allowed to be positioned one
7071 character past the line.
7072 "inclusive" means that the last character of the selection is included
7073 in an operation. For example, when "x" is used to delete the
7074 selection.
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02007075 When "old" is used and 'virtualedit' allows the cursor to move past
7076 the end of line the line break still isn't included.
Christian Brabandted892062024-12-14 20:23:39 +01007077 When "exclusive" is used, cursor position in visual mode will be
7078 adjusted for inclusive motions |inclusive-motion-selection-exclusive|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007079 Note that when "exclusive" is used and selecting from the end
7080 backwards, you cannot include the last character of a line, when
7081 starting in Normal mode and 'virtualedit' empty.
7082
7083 The 'selection' option is set by the |:behave| command.
7084
7085 *'selectmode'* *'slm'*
7086'selectmode' 'slm' string (default "")
7087 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007088 This is a comma-separated list of words, which specifies when to start
Bram Moolenaar071d4272004-06-13 20:20:40 +00007089 Select mode instead of Visual mode, when a selection is started.
7090 Possible values:
7091 mouse when using the mouse
7092 key when using shifted special keys
7093 cmd when using "v", "V" or CTRL-V
7094 See |Select-mode|.
7095 The 'selectmode' option is set by the |:behave| command.
7096
7097 *'sessionoptions'* *'ssop'*
7098'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
Bram Moolenaarb5b75622018-03-09 22:22:21 +01007099 help,options,tabpages,winsize,terminal")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007100 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02007101 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007102 feature}
7103 Changes the effect of the |:mksession| command. It is a comma
7104 separated list of words. Each word enables saving and restoring
7105 something:
7106 word save and restore ~
7107 blank empty windows
7108 buffers hidden and unloaded buffers, not just those in windows
7109 curdir the current directory
7110 folds manually created folds, opened/closed folds and local
7111 fold options
7112 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00007113 and contain at least one lowercase letter. Only
7114 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007115 help the help window
7116 localoptions options and mappings local to a window or buffer (not
7117 global values for local options)
7118 options all options and mappings (also global values for local
7119 options)
Bram Moolenaard23b7142021-04-17 21:04:34 +02007120 skiprtp exclude 'runtimepath' and 'packpath' from the options
Bram Moolenaar071d4272004-06-13 20:20:40 +00007121 resize size of the Vim window: 'lines' and 'columns'
7122 sesdir the directory in which the session file is located
7123 will become the current directory (useful with
7124 projects accessed over a network from different
7125 systems)
7126 slash backslashes in file names replaced with forward
7127 slashes
Bram Moolenaar18144c82006-04-12 21:52:12 +00007128 tabpages all tab pages; without this only the current tab page
7129 is restored, so that you can make a session for each
7130 tab page separately
Bram Moolenaard473c8c2018-08-11 18:00:22 +02007131 terminal include terminal windows where the command can be
7132 restored
Bram Moolenaar071d4272004-06-13 20:20:40 +00007133 unix with Unix end-of-line format (single <NL>), even when
7134 on Windows or DOS
7135 winpos position of the whole Vim window
7136 winsize window sizes
7137
7138 Don't include both "curdir" and "sesdir".
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007139 When neither "curdir" nor "sesdir" is included, file names are stored
7140 with absolute paths.
Bram Moolenaar2f0936c2022-01-08 21:51:59 +00007141 If you leave out "options" many things won't work well after restoring
7142 the session.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007143 "slash" and "unix" are useful on Windows when sharing session files
7144 with Unix. The Unix version of Vim cannot source dos format scripts,
7145 but the Windows version of Vim can source unix format scripts.
7146
7147 *'shell'* *'sh'* *E91*
Bram Moolenaar95a9dd12019-12-19 22:12:03 +01007148'shell' 'sh' string (default $SHELL or "sh", Win32: "cmd.exe")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007149 global
7150 Name of the shell to use for ! and :! commands. When changing the
7151 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
7152 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007153 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007154 See |option-backslash| about including spaces and backslashes.
7155 Environment variables are expanded |:set_env|.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01007156
Bram Moolenaara2baa732022-02-04 16:09:54 +00007157 In |restricted-mode| shell commands will not be possible. This mode
7158 is used if the value of $SHELL ends in "false" or "nologin".
7159
Bram Moolenaar1ff14ba2019-11-02 14:09:23 +01007160 If the name of the shell contains a space, you need to enclose it in
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01007161 quotes and escape the space. Example with quotes: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007162 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
7163< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007164 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00007165 "-f" is not inside the quotes, because it is not part of the command
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01007166 name. Vim automagically recognizes the backslashes that are path
Bram Moolenaar071d4272004-06-13 20:20:40 +00007167 separators.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01007168 Example with escaped space (Vim will do this when initializing the
7169 option from $SHELL): >
7170 :set shell=/bin/with\\\ space/sh
Bram Moolenaard473c8c2018-08-11 18:00:22 +02007171< The resulting value of 'shell' is "/bin/with\ space/sh", two
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01007172 backslashes are consumed by `:set`.
7173
Bram Moolenaar071d4272004-06-13 20:20:40 +00007174 Under MS-Windows, when the executable ends in ".com" it must be
7175 included. Thus setting the shell to "command.com" or "4dos.com"
7176 works, but "command" and "4dos" do not work for all commands (e.g.,
7177 filtering).
7178 For unknown reasons, when using "4dos.com" the current directory is
7179 changed to "C:\". To avoid this set 'shell' like this: >
7180 :set shell=command.com\ /c\ 4dos
7181< This option cannot be set from a |modeline| or in the |sandbox|, for
7182 security reasons.
7183
7184 *'shellcmdflag'* *'shcf'*
Bram Moolenaar5dc62522012-02-13 00:05:22 +01007185'shellcmdflag' 'shcf' string (default: "-c";
Mike Williams12795022021-06-28 20:53:58 +02007186 Win32, when 'shell' contains "powershell":
7187 "-Command", or when it does not contain "sh"
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01007188 somewhere: "/c")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007189 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007190 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
Mike Williams12795022021-06-28 20:53:58 +02007191 "bash.exe -c ls", "powershell.exe -Command dir", or "cmd.exe /c dir".
7192 For MS-Windows, the default is set according to the value of 'shell',
7193 to reduce the need to set this option by the user.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02007194 On Unix it can have more than one flag. Each white space separated
7195 part is passed as an argument to the shell command.
7196 See |option-backslash| about including spaces and backslashes.
Mike Williams12795022021-06-28 20:53:58 +02007197 Also see |dos-shell| and |dos-powershell| for MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007198 This option cannot be set from a |modeline| or in the |sandbox|, for
7199 security reasons.
7200
7201 *'shellpipe'* *'sp'*
Mike Williams12795022021-06-28 20:53:58 +02007202'shellpipe' 'sp' string (default ">", ">%s 2>&1", "| tee", "|& tee"
7203 "2>&1| tee", or
7204 "2>&1 | Out-File -Encoding default")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007205 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007206 {not available when compiled without the |+quickfix|
7207 feature}
7208 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007209 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00007210 including spaces and backslashes.
7211 The name of the temporary file can be represented by "%s" if necessary
7212 (the file name is appended automatically if no %s appears in the value
7213 of this option).
Mike Williams12795022021-06-28 20:53:58 +02007214 For the Amiga the default is ">". For MS-Windows using powershell the
7215 default is "2>&1 | Out-File -Encoding default", otherwise the default
7216 is ">%s 2>&1". The output is directly saved in a file and not echoed
7217 to the screen.
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02007218 For Unix the default is "| tee". The stdout of the compiler is saved
Bram Moolenaar071d4272004-06-13 20:20:40 +00007219 in a file and echoed to the screen. If the 'shell' option is "csh" or
7220 "tcsh" after initializations, the default becomes "|& tee". If the
Bram Moolenaar96f45c02019-10-26 19:53:45 +02007221 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh", "zsh-beta",
Natanael Copa56318362021-05-06 18:46:35 +02007222 "bash", "fish", "ash" or "dash" the default becomes "2>&1| tee". This
7223 means that stderr is also included. Before using the 'shell' option a
7224 path is removed, thus "/bin/sh" uses "sh".
Mike Williamsa3d1b292021-06-30 20:56:00 +02007225 For Unix and MS-Windows, when the 'shell' option is "pwsh" the default
7226 becomes ">%s 2>&1" and the output is not echoed to the screen.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007227 The initialization of this option is done after reading the ".vimrc"
7228 and the other initializations, so that when the 'shell' option is set
7229 there, the 'shellpipe' option changes automatically, unless it was
7230 explicitly set before.
7231 When 'shellpipe' is set to an empty string, no redirection of the
7232 ":make" output will be done. This is useful if you use a 'makeprg'
7233 that writes to 'makeef' by itself. If you want no piping, but do
7234 want to include the 'makeef', set 'shellpipe' to a single space.
7235 Don't forget to precede the space with a backslash: ":set sp=\ ".
7236 In the future pipes may be used for filtering and this option will
7237 become obsolete (at least for Unix).
7238 This option cannot be set from a |modeline| or in the |sandbox|, for
7239 security reasons.
7240
7241 *'shellquote'* *'shq'*
Mike Williamsa3d1b292021-06-30 20:56:00 +02007242'shellquote' 'shq' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007243 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007244 Quoting character(s), put around the command passed to the shell, for
7245 the "!" and ":!" commands. The redirection is kept outside of the
7246 quoting. See 'shellxquote' to include the redirection. It's
7247 probably not useful to set both options.
7248 This is an empty string by default. Only known to be useful for
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01007249 third-party shells on MS-Windows-like systems, such as the MKS Korn
Mike Williamsa3d1b292021-06-30 20:56:00 +02007250 Shell or bash, where it should be "\"". See |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007251 This option cannot be set from a |modeline| or in the |sandbox|, for
7252 security reasons.
7253
7254 *'shellredir'* *'srr'*
Mike Williams12795022021-06-28 20:53:58 +02007255'shellredir' 'srr' string (default ">", ">&", ">%s 2>&1", or
7256 "2>&1 | Out-File -Encoding default")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007257 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007258 String to be used to put the output of a filter command in a temporary
7259 file. See also |:!|. See |option-backslash| about including spaces
7260 and backslashes.
7261 The name of the temporary file can be represented by "%s" if necessary
7262 (the file name is appended automatically if no %s appears in the value
7263 of this option).
Bram Moolenaar96f45c02019-10-26 19:53:45 +02007264 The default is ">". For Unix, if the 'shell' option is "csh" or
7265 "tcsh" during initializations, the default becomes ">&". If the
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007266 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh", "zsh-beta",
Mike Williamsa3d1b292021-06-30 20:56:00 +02007267 "bash", "fish", or "pwsh", the default becomes ">%s 2>&1". This means
7268 that stderr is also included. For Win32, the Unix checks are done and
Mike Williams12795022021-06-28 20:53:58 +02007269 additionally "cmd" is checked for, which makes the default ">%s 2>&1",
7270 and "powershell" is checked for which makes the default
Mike Williamsa3d1b292021-06-30 20:56:00 +02007271 "2>&1 | Out-File -Encoding default" (see |dos-powershell|). Also, the
7272 same names with ".exe" appended are checked for.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007273 The initialization of this option is done after reading the ".vimrc"
7274 and the other initializations, so that when the 'shell' option is set
7275 there, the 'shellredir' option changes automatically unless it was
7276 explicitly set before.
7277 In the future pipes may be used for filtering and this option will
7278 become obsolete (at least for Unix).
7279 This option cannot be set from a |modeline| or in the |sandbox|, for
7280 security reasons.
7281
7282 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
7283'shellslash' 'ssl' boolean (default off)
7284 global
Bram Moolenaar6f345a12019-12-17 21:27:18 +01007285 {only for MS-Windows}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007286 When set, a forward slash is used when expanding file names. This is
Mike Williamsa3d1b292021-06-30 20:56:00 +02007287 useful when a Unix-like shell is used instead of cmd.exe, pwsh.exe, or
Mike Williams12795022021-06-28 20:53:58 +02007288 powershell.exe. Backward slashes can still be typed, but they are
7289 changed to forward slashes by Vim.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007290 Note that setting or resetting this option has no effect for some
7291 existing file names, thus this option needs to be set before opening
7292 any file for best results. This might change in the future.
7293 'shellslash' only works when a backslash can be used as a path
7294 separator. To test if this is so use: >
7295 if exists('+shellslash')
Bram Moolenaarac3150d2019-07-28 16:36:39 +02007296< Also see 'completeslash'.
7297
Bram Moolenaar26a60b42005-02-22 08:49:11 +00007298 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
7299'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
7300 global
Bram Moolenaar26a60b42005-02-22 08:49:11 +00007301 When on, use temp files for shell commands. When off use a pipe.
7302 When using a pipe is not possible temp files are used anyway.
Bram Moolenaar97293012011-07-18 19:40:27 +02007303 Currently a pipe is only supported on Unix and MS-Windows 2K and
7304 later. You can check it with: >
Bram Moolenaar26a60b42005-02-22 08:49:11 +00007305 :if has("filterpipe")
7306< The advantage of using a pipe is that nobody can read the temp file
7307 and the 'shell' command does not need to support redirection.
7308 The advantage of using a temp file is that the file type and encoding
7309 can be detected.
7310 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
7311 |FilterWritePost| autocommands event are not triggered when
7312 'shelltemp' is off.
Bram Moolenaar269f5952016-07-15 22:54:41 +02007313 The `system()` function does not respect this option and always uses
7314 temp files.
Bram Moolenaar036986f2017-03-16 17:41:02 +01007315 NOTE: This option is set to the Vim default value when 'compatible'
7316 is reset.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00007317
Bram Moolenaar071d4272004-06-13 20:20:40 +00007318 *'shelltype'* *'st'*
7319'shelltype' 'st' number (default 0)
7320 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02007321 {only for the Amiga}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007322 On the Amiga this option influences the way how the commands work
7323 which use a shell.
7324 0 and 1: always use the shell
7325 2 and 3: use the shell only to filter lines
7326 4 and 5: use shell only for ':sh' command
7327 When not using the shell, the command is executed directly.
7328
7329 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
7330 1 and 3: use "shell cmd" to start external commands
7331
Bram Moolenaardb7207e2012-02-22 17:30:19 +01007332 *'shellxescape'* *'sxe'*
7333'shellxescape' 'sxe' string (default: "";
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01007334 for MS-Windows: "\"&|<>()@^")
Bram Moolenaardb7207e2012-02-22 17:30:19 +01007335 global
Bram Moolenaardb7207e2012-02-22 17:30:19 +01007336 When 'shellxquote' is set to "(" then the characters listed in this
7337 option will be escaped with a '^' character. This makes it possible
7338 to execute most external commands with cmd.exe.
dkearns8ebdbc92023-10-29 06:26:19 +11007339 This option cannot be set from a |modeline| or in the |sandbox|, for
7340 security reasons.
Bram Moolenaardb7207e2012-02-22 17:30:19 +01007341
Bram Moolenaar071d4272004-06-13 20:20:40 +00007342 *'shellxquote'* *'sxq'*
7343'shellxquote' 'sxq' string (default: "";
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01007344 for Win32, when 'shell' is cmd.exe: "("
Mike Williams12795022021-06-28 20:53:58 +02007345 for Win32, when 'shell' is
7346 powershell.exe: "\""
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01007347 for Win32, when 'shell' contains "sh"
7348 somewhere: "\""
Bram Moolenaar071d4272004-06-13 20:20:40 +00007349 for Unix, when using system(): "\"")
7350 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007351 Quoting character(s), put around the command passed to the shell, for
7352 the "!" and ":!" commands. Includes the redirection. See
7353 'shellquote' to exclude the redirection. It's probably not useful
7354 to set both options.
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01007355 When the value is '(' then ')' is appended. When the value is '"('
7356 then ')"' is appended.
7357 When the value is '(' then also see 'shellxescape'.
Bram Moolenaara64ba222012-02-12 23:23:31 +01007358 This is an empty string by default on most systems, but is known to be
Mike Williamsa3d1b292021-06-30 20:56:00 +02007359 useful for on Win32 version, either for cmd.exe, powershell.exe, or
7360 pwsh.exe which automatically strips off the first and last quote on a
7361 command, or 3rd-party shells such as the MKS Korn Shell or bash, where
7362 it should be "\"". The default is adjusted according the value of
Mike Williams12795022021-06-28 20:53:58 +02007363 'shell', to reduce the need to set this option by the user. See
7364 |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007365 This option cannot be set from a |modeline| or in the |sandbox|, for
7366 security reasons.
7367
7368 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
7369'shiftround' 'sr' boolean (default off)
7370 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007371 Round indent to multiple of 'shiftwidth'. Applies to > and <
7372 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
7373 a multiple of 'shiftwidth' (this is Vi compatible).
7374 NOTE: This option is reset when 'compatible' is set.
7375
7376 *'shiftwidth'* *'sw'*
7377'shiftwidth' 'sw' number (default 8)
7378 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007379 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00007380 |'cindent'|, |>>|, |<<|, etc.
Bram Moolenaar10e8ff92023-06-10 21:40:39 +01007381 When zero the 'tabstop' value will be used. Use the |shiftwidth()|
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02007382 function to get the effective shiftwidth value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007383
7384 *'shortmess'* *'shm'*
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02007385'shortmess' 'shm' string (Vim default "filnxtToOS", Vi default: "S",
7386 POSIX default: "AS")
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007387 global *E1336*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007388 This option helps to avoid all the |hit-enter| prompts caused by file
Dominique Pellédf62c622024-07-15 20:29:59 +02007389 messages, for example with CTRL-G, and to avoid some other messages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007390 It is a list of flags:
7391 flag meaning when present ~
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007392 f use "(3 of 5)" instead of "(file 3 of 5)" *shm-f*
7393 i use "[noeol]" instead of "[Incomplete last line]" *shm-i*
7394 l use "999L, 888B" instead of "999 lines, 888 bytes" *shm-l*
7395 m use "[+]" instead of "[Modified]" *shm-m*
7396 n use "[New]" instead of "[New File]" *shm-n*
7397 r use "[RO]" instead of "[readonly]" *shm-r*
7398 w use "[w]" instead of "written" for file write message *shm-w*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007399 and "[a]" instead of "appended" for ':w >> file' command
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007400 x use "[dos]" instead of "[dos format]", "[unix]" *shm-x*
7401 instead of "[unix format]" and "[mac]" instead of "[mac
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007402 format]"
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007403 a all of the above abbreviations *shm-a*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007404
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007405 o overwrite message for writing a file with subsequent *shm-o*
7406 message for reading a file (useful for ":wn" or when
7407 'autowrite' on)
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007408 O message for reading a file overwrites any previous *shm-O*
7409 message; also for quickfix message (e.g., ":cn")
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007410 s don't give "search hit BOTTOM, continuing at TOP" or *shm-s*
7411 "search hit TOP, continuing at BOTTOM" messages; when using
Christian Brabandte2995912024-06-01 20:40:25 +02007412 the search count do not show "W" before the count message
7413 (see |shm-S| below)
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007414 t truncate file message at the start if it is too long *shm-t*
7415 to fit on the command-line, "<" will appear in the left most
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007416 column; ignored in Ex mode
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007417 T truncate other messages in the middle if they are too *shm-T*
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007418 long to fit on the command line; "..." will appear in the
7419 middle; ignored in Ex mode
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007420 W don't give "written" or "[w]" when writing a file *shm-W*
7421 A don't give the "ATTENTION" message when an existing *shm-A*
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007422 swap file is found
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007423 I don't give the intro message when starting Vim, *shm-I*
Bram Moolenaar938ae282023-02-20 20:44:55 +00007424 see |:intro|
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007425 c don't give |ins-completion-menu| messages; for *shm-c*
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007426 example, "-- XXX completion (YYY)", "match 1 of 2", "The only
7427 match", "Pattern not found", "Back at original", etc.
7428 C don't give messages while scanning for ins-completion *shm-C*
7429 items, for instance "scanning tags"
7430 q use "recording" instead of "recording @a" *shm-q*
7431 F don't give the file info when editing a file, like *shm-F*
7432 `:silent` was used for the command; note that this also
Shougo Matsushita9db39b02024-03-06 20:58:41 +01007433 affects messages from autocommands and 'autoread' reloading
Bram Moolenaar938ae282023-02-20 20:44:55 +00007434 S do not show search count message when searching, e.g. *shm-S*
Christian Brabandte2995912024-06-01 20:40:25 +02007435 "[1/5]". When the "S" flag is not present (e.g. search count
7436 is shown), the "search hit BOTTOM, continuing at TOP" and
7437 "search hit TOP, continuing at BOTTOM" messages are only
7438 indicated by a "W" (Mnemonic: Wrapped) letter before the
7439 search count statistics.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007440
7441 This gives you the opportunity to avoid that a change between buffers
7442 requires you to hit <Enter>, but still gives as useful a message as
7443 possible for the space available. To get the whole message that you
7444 would have got with 'shm' empty, use ":file!"
7445 Useful values:
7446 shm= No abbreviation of message.
7447 shm=a Abbreviation, but no loss of information.
7448 shm=at Abbreviation, and truncate message when necessary.
7449
7450 NOTE: This option is set to the Vi default value when 'compatible' is
7451 set and to the Vim default value when 'compatible' is reset.
7452
7453 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
7454'shortname' 'sn' boolean (default off)
7455 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007456 Filenames are assumed to be 8 characters plus one extension of 3
7457 characters. Multiple dots in file names are not allowed. When this
7458 option is on, dots in file names are replaced with underscores when
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01007459 adding an extension (".~" or ".swp"). This option is useful
Bram Moolenaar071d4272004-06-13 20:20:40 +00007460 when editing files on an MS-DOS compatible filesystem, e.g., messydos
Bram Moolenaarade0d392020-01-21 22:33:58 +01007461 or crossdos.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007462
7463 *'showbreak'* *'sbr'* *E595*
7464'showbreak' 'sbr' string (default "")
Bram Moolenaaree857022019-11-09 23:26:40 +01007465 global or local to window |global-local|
Bram Moolenaardb84e452010-08-15 13:50:43 +02007466 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007467 feature}
7468 String to put at the start of lines that have been wrapped. Useful
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007469 values are "> " or "+++ ": >
7470 :set showbreak=>\
7471< Note the backslash to escape the trailing space. It's easier like
7472 this: >
Bram Moolenaar1a384422010-07-14 19:53:30 +02007473 :let &showbreak = '+++ '
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007474< Only printable single-cell characters are allowed, excluding <Tab> and
Bram Moolenaar071d4272004-06-13 20:20:40 +00007475 comma (in a future version the comma might be used to separate the
7476 part that is shown at the end and at the start of a line).
7477 The characters are highlighted according to the '@' flag in
7478 'highlight'.
7479 Note that tabs after the showbreak will be displayed differently.
7480 If you want the 'showbreak' to appear in between line numbers, add the
7481 "n" flag to 'cpoptions'.
Bram Moolenaaree857022019-11-09 23:26:40 +01007482 A window-local value overrules a global value. If the global value is
7483 set and you want no value in the current window use NONE: >
7484 :setlocal showbreak=NONE
7485<
Bram Moolenaar071d4272004-06-13 20:20:40 +00007486 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02007487'showcmd' 'sc' boolean (Vim default: on, off for Unix,
7488 Vi default: off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007489 global
Bram Moolenaar02467872007-05-06 13:22:01 +00007490 Show (partial) command in the last line of the screen. Set this
7491 option off if your terminal is slow.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007492 In Visual mode the size of the selected area is shown:
7493 - When selecting characters within a line, the number of characters.
Bram Moolenaarf91787c2010-07-17 12:47:16 +02007494 If the number of bytes is different it is also displayed: "2-6"
7495 means two characters and six bytes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007496 - When selecting more than one line, the number of lines.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007497 - When selecting a block, the size in screen characters:
7498 {lines}x{columns}.
Luuk van Baalba936f62022-12-15 13:15:39 +00007499 This information can be displayed in an alternative location using the
7500 'showcmdloc' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007501 NOTE: This option is set to the Vi default value when 'compatible' is
7502 set and to the Vim default value when 'compatible' is reset.
7503
Luuk van Baalba936f62022-12-15 13:15:39 +00007504 *'showcmdloc'* *'sloc'*
7505'showcmdloc' 'sloc' string (default "last")
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007506 global
Luuk van Baalba936f62022-12-15 13:15:39 +00007507 This option can be used to display the (partially) entered command in
7508 another location. Possible values are:
7509 last Last line of the screen (default).
7510 statusline Status line of the current window.
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007511 tabline First line of the screen if 'showtabline' is enabled.
Luuk van Baalba936f62022-12-15 13:15:39 +00007512 Setting this option to "statusline" or "tabline" means that these will
7513 be redrawn whenever the command changes, which can be on every key
7514 pressed.
7515 The %S 'statusline' item can be used in 'statusline' or 'tabline' to
7516 place the text. Without a custom 'statusline' or 'tabline' it will be
7517 displayed in a convenient location.
7518
Bram Moolenaar071d4272004-06-13 20:20:40 +00007519 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
7520'showfulltag' 'sft' boolean (default off)
7521 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007522 When completing a word in insert mode (see |ins-completion|) from the
7523 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007524 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00007525 matched a C function, you can see a template for what arguments are
7526 required (coding style permitting).
Bram Moolenaar446cb832008-06-24 21:56:24 +00007527 Note that this doesn't work well together with having "longest" in
7528 'completeopt', because the completion from the search pattern may not
7529 match the typed text.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007530
7531 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
7532'showmatch' 'sm' boolean (default off)
7533 global
7534 When a bracket is inserted, briefly jump to the matching one. The
7535 jump is only done if the match can be seen on the screen. The time to
7536 show the match can be set with 'matchtime'.
7537 A Beep is given if there is no match (no matter if the match can be
Bram Moolenaarca635012015-09-25 20:34:21 +02007538 seen or not).
7539 This option is reset when 'paste' is set and restored when 'paste' is
7540 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007541 When the 'm' flag is not included in 'cpoptions', typing a character
7542 will immediately move the cursor back to where it belongs.
7543 See the "sm" field in 'guicursor' for setting the cursor shape and
7544 blinking when showing the match.
7545 The 'matchpairs' option can be used to specify the characters to show
7546 matches for. 'rightleft' and 'revins' are used to look for opposite
7547 matches.
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007548 Also see the matchparen plugin for highlighting the match when moving
7549 around |pi_paren.txt|.
7550 Note: Use of the short form is rated PG.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007551
7552 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
7553'showmode' 'smd' boolean (Vim default: on, Vi default: off)
7554 global
7555 If in Insert, Replace or Visual mode put a message on the last line.
7556 Use the 'M' flag in 'highlight' to set the type of highlighting for
7557 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007558 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00007559 doesn't mean XIM is really active, especially when 'imactivatekey' is
7560 not set.
7561 NOTE: This option is set to the Vi default value when 'compatible' is
7562 set and to the Vim default value when 'compatible' is reset.
7563
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007564 *'showtabline'* *'stal'*
7565'showtabline' 'stal' number (default 1)
7566 global
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007567 The value of this option specifies when the line with tab page labels
7568 will be displayed:
7569 0: never
7570 1: only if there are at least two tab pages
7571 2: always
7572 This is both for the GUI and non-GUI implementation of the tab pages
7573 line.
7574 See |tab-page| for more information about tab pages.
7575
Bram Moolenaar071d4272004-06-13 20:20:40 +00007576 *'sidescroll'* *'ss'*
7577'sidescroll' 'ss' number (default 0)
7578 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007579 The minimal number of columns to scroll horizontally. Used only when
7580 the 'wrap' option is off and the cursor is moved off of the screen.
7581 When it is zero the cursor will be put in the middle of the screen.
7582 When using a slow terminal set it to a large number or 0. When using
7583 a fast terminal use a small number or 1. Not used for "zh" and "zl"
7584 commands.
7585
7586 *'sidescrolloff'* *'siso'*
7587'sidescrolloff' 'siso' number (default 0)
Bram Moolenaar375e3392019-01-31 18:26:10 +01007588 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007589 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00007590 right of the cursor if 'nowrap' is set. Setting this option to a
7591 value greater than 0 while having |'sidescroll'| also at a non-zero
7592 value makes some context visible in the line you are scrolling in
7593 horizontally (except at beginning of the line). Setting this option
7594 to a large value (like 999) has the effect of keeping the cursor
7595 horizontally centered in the window, as long as one does not come too
7596 close to the beginning of the line.
Bram Moolenaar375e3392019-01-31 18:26:10 +01007597 After using the local value, go back the global value with one of
7598 these two: >
7599 setlocal sidescrolloff<
7600 setlocal sidescrolloff=-1
7601< NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007602
7603 Example: Try this together with 'sidescroll' and 'listchars' as
7604 in the following example to never allow the cursor to move
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007605 onto the "extends" character: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007606
7607 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
7608 :set sidescrolloff=1
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007609<
7610 *'signcolumn'* *'scl'*
7611'signcolumn' 'scl' string (default "auto")
7612 local to window
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007613 {not available when compiled without the |+signs|
7614 feature}
Bram Moolenaar09521312016-08-12 22:54:35 +02007615 Whether or not to draw the signcolumn. Valid values are:
Bram Moolenaar938ae282023-02-20 20:44:55 +00007616 "auto" only when there is a sign to display
7617 "no" never
7618 "yes" always
Bram Moolenaar394c5d82019-06-17 21:48:05 +02007619 "number" display signs in the 'number' column. If the number
Bram Moolenaar6c1e1572019-06-22 02:13:00 +02007620 column is not present, then behaves like "auto".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007621
Bram Moolenaar071d4272004-06-13 20:20:40 +00007622 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
7623'smartcase' 'scs' boolean (default off)
7624 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007625 Override the 'ignorecase' option if the search pattern contains upper
7626 case characters. Only used when the search pattern is typed and
7627 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarc8734422012-06-01 22:38:45 +02007628 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00007629 "*" and "#" you can make 'smartcase' used by doing a "/" command,
7630 recalling the search pattern from history and hitting <Enter>.
7631 NOTE: This option is reset when 'compatible' is set.
7632
7633 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
7634'smartindent' 'si' boolean (default off)
7635 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007636 Do smart autoindenting when starting a new line. Works for C-like
7637 programs, but can also be used for other languages. 'cindent' does
7638 something like this, works better in most cases, but is more strict,
Bram Moolenaar81af9252010-12-10 20:35:50 +01007639 see |C-indenting|. When 'cindent' is on or 'indentexpr' is set,
Bram Moolenaar166af9b2010-11-16 20:34:40 +01007640 setting 'si' has no effect. 'indentexpr' is a more advanced
7641 alternative.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007642 Normally 'autoindent' should also be on when using 'smartindent'.
7643 An indent is automatically inserted:
7644 - After a line ending in '{'.
7645 - After a line starting with a keyword from 'cinwords'.
7646 - Before a line starting with '}' (only with the "O" command).
7647 When typing '}' as the first character in a new line, that line is
7648 given the same indent as the matching '{'.
7649 When typing '#' as the first character in a new line, the indent for
7650 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007651 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00007652 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
7653 When using the ">>" command, lines starting with '#' are not shifted
7654 right.
Bram Moolenaar036986f2017-03-16 17:41:02 +01007655 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02007656 This option is reset when 'paste' is set and restored when 'paste' is
7657 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007658
7659 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
7660'smarttab' 'sta' boolean (default off)
7661 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007662 When on, a <Tab> in front of a line inserts blanks according to
Bram Moolenaar280f1262006-01-30 00:14:18 +00007663 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A
7664 <BS> will delete a 'shiftwidth' worth of space at the start of the
7665 line.
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00007666 When off, a <Tab> always inserts blanks according to 'tabstop' or
Bram Moolenaar280f1262006-01-30 00:14:18 +00007667 'softtabstop'. 'shiftwidth' is only used for shifting text left or
7668 right |shift-left-right|.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007669 What gets inserted (a <Tab> or spaces) depends on the 'expandtab'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007670 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00007671 number of spaces is minimized by using <Tab>s.
Bram Moolenaarca635012015-09-25 20:34:21 +02007672 This option is reset when 'paste' is set and restored when 'paste' is
7673 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007674 NOTE: This option is reset when 'compatible' is set.
7675
Bram Moolenaarf6196f42022-10-02 21:29:55 +01007676 *'smoothscroll'* *'sms'* *'nosmoothscroll'* *'nosms'*
7677'smoothscroll' 'sms' boolean (default off)
7678 local to window
7679 Scrolling works with screen lines. When 'wrap' is set and the first
7680 line in the window wraps part of it may not be visible, as if it is
Bram Moolenaarf269eab2022-10-03 18:04:35 +01007681 above the window. "<<<" is displayed at the start of the first line,
7682 highlighted with |hl-NonText|.
Bram Moolenaar10e8ff92023-06-10 21:40:39 +01007683 You may also want to add "lastline" to the 'display' option to show as
7684 much of the last line as possible.
zeertzjqad493ef2024-03-29 10:23:19 +01007685 NOTE: partly implemented, doesn't work yet for |gj| and |gk|.
Bram Moolenaarf6196f42022-10-02 21:29:55 +01007686
Bram Moolenaar071d4272004-06-13 20:20:40 +00007687 *'softtabstop'* *'sts'*
7688'softtabstop' 'sts' number (default 0)
7689 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007690 Number of spaces that a <Tab> counts for while performing editing
7691 operations, like inserting a <Tab> or using <BS>. It "feels" like
7692 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
7693 used. This is useful to keep the 'ts' setting at its standard value
7694 of 8, while being able to edit like it is set to 'sts'. However,
7695 commands like "x" still work on the actual characters.
7696 When 'sts' is zero, this feature is off.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02007697 When 'sts' is negative, the value of 'shiftwidth' is used.
Bram Moolenaarca635012015-09-25 20:34:21 +02007698 'softtabstop' is set to 0 when the 'paste' option is set and restored
7699 when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007700 See also |ins-expandtab|. When 'expandtab' is not set, the number of
7701 spaces is minimized by using <Tab>s.
7702 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
7703 set.
7704 NOTE: This option is set to 0 when 'compatible' is set.
7705
Bram Moolenaar04958cb2018-06-23 19:23:02 +02007706 If Vim is compiled with the |+vartabs| feature then the value of
7707 'softtabstop' will be ignored if |'varsofttabstop'| is set to
7708 anything other than an empty string.
7709
Bram Moolenaar217ad922005-03-20 22:37:15 +00007710 *'spell'* *'nospell'*
7711'spell' boolean (default off)
7712 local to window
Bram Moolenaar217ad922005-03-20 22:37:15 +00007713 {not available when compiled without the |+syntax|
7714 feature}
7715 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007716 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007717
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007718 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00007719'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007720 local to buffer
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007721 {not available when compiled without the |+syntax|
7722 feature}
7723 Pattern to locate the end of a sentence. The following word will be
7724 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007725 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007726 When this check is not wanted make this option empty.
7727 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00007728 Be careful with special characters, see |option-backslash| about
7729 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007730 To set this option automatically depending on the language, see
7731 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007732
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007733 *'spellfile'* *'spf'*
7734'spellfile' 'spf' string (default empty)
7735 local to buffer
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007736 {not available when compiled without the |+syntax|
7737 feature}
7738 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00007739 commands. It must end in ".{encoding}.add". You need to include the
7740 path, otherwise the file is placed in the current directory.
Bram Moolenaar48c3f4e2022-08-08 15:42:38 +01007741 The path may include characters from 'isfname', space, comma and '@'.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007742 *E765*
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007743 It may also be a comma-separated list of names. A count before the
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007744 |zg| and |zw| commands can be used to access each. This allows using
7745 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007746 When a word is added while this option is empty Vim will set it for
Bram Moolenaar910f66f2006-04-05 20:41:53 +00007747 you: Using the first directory in 'runtimepath' that is writable. If
7748 there is no "spell" directory yet it will be created. For the file
7749 name the first language name that appears in 'spelllang' is used,
Bram Moolenaar3b506942005-06-23 22:36:45 +00007750 ignoring the region.
7751 The resulting ".spl" file will be used for spell checking, it does not
7752 have to appear in 'spelllang'.
7753 Normally one file is used for all regions, but you can add the region
7754 name if you want to. However, it will then only be used when
7755 'spellfile' is set to it, for entries in 'spelllang' only files
7756 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00007757 This option cannot be set from a |modeline| or in the |sandbox|, for
7758 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007759
Bram Moolenaar217ad922005-03-20 22:37:15 +00007760 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007761'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00007762 local to buffer
Bram Moolenaar217ad922005-03-20 22:37:15 +00007763 {not available when compiled without the |+syntax|
7764 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007765 A comma-separated list of word list names. When the 'spell' option is
Bram Moolenaar3b506942005-06-23 22:36:45 +00007766 on spellchecking will be done for these languages. Example: >
7767 set spelllang=en_us,nl,medical
7768< This means US English, Dutch and medical words are recognized. Words
7769 that are not recognized will be highlighted.
Bram Moolenaar911ead12019-04-21 00:03:35 +02007770 The word list name must consist of alphanumeric characters, a dash or
7771 an underscore. It should not include a comma or dot. Using a dash is
Bram Moolenaar3b506942005-06-23 22:36:45 +00007772 recommended to separate the two letter language name from a
7773 specification. Thus "en-rare" is used for rare English words.
7774 A region name must come last and have the form "_xx", where "xx" is
7775 the two-letter, lower case region name. You can use more than one
7776 region by listing them: "en_us,en_ca" supports both US and Canadian
7777 English, but not words specific for Australia, New Zealand or Great
Bram Moolenaarfa735342016-01-03 22:14:44 +01007778 Britain. (Note: currently en_au and en_nz dictionaries are older than
7779 en_ca, en_gb and en_us).
Bram Moolenaarcc63c642013-11-12 04:44:01 +01007780 If the name "cjk" is included East Asian characters are excluded from
7781 spell checking. This is useful when editing text that also has Asian
7782 words.
Bram Moolenaar6c391a72021-09-09 21:55:11 +02007783 Note that the "medical" dictionary does not exist, it is just an
7784 example of a longer name.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007785 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007786 As a special case the name of a .spl file can be given as-is. The
7787 first "_xx" in the name is removed and used as the region name
7788 (_xx is an underscore, two letters and followed by a non-letter).
7789 This is mainly for testing purposes. You must make sure the correct
7790 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007791 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007792 idea to set 'spelllang' after setting 'encoding' to avoid loading the
7793 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00007794 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007795
Bram Moolenaar98692072006-02-04 00:57:42 +00007796 If the |spellfile.vim| plugin is active and you use a language name
7797 for which Vim cannot find the .spl file in 'runtimepath' the plugin
7798 will ask you if you want to download the file.
7799
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007800 After this option has been set successfully, Vim will source the files
7801 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
Bram Moolenaarb730f0c2018-11-25 03:56:26 +01007802 up to the first character that is not an ASCII letter or number and
7803 not a dash. Also see |set-spc-auto|.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007804
Bram Moolenaar362b44b2020-06-10 21:47:00 +02007805 *'spelloptions'* *'spo'*
7806'spelloptions' 'spo' string (default "")
7807 local to buffer
7808 {not available when compiled without the |+syntax|
7809 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007810 A comma-separated list of options for spell checking:
Bram Moolenaar362b44b2020-06-10 21:47:00 +02007811 camel When a word is CamelCased, assume "Cased" is a
7812 separate word: every upper-case character in a word
7813 that comes after a lower case character indicates the
7814 start of a new word.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007815
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007816 *'spellsuggest'* *'sps'*
7817'spellsuggest' 'sps' string (default "best")
7818 global
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007819 {not available when compiled without the |+syntax|
7820 feature}
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007821 Methods used for spelling suggestions. Both for the |z=| command and
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007822 the |spellsuggest()| function. This is a comma-separated list of
7823 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007824
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007825 best Internal method that works best for English. Finds
7826 changes like "fast" and uses a bit of sound-a-like
7827 scoring to improve the ordering.
7828
7829 double Internal method that uses two methods and mixes the
7830 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007831 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007832 word. That only works when the language specifies
7833 sound folding. Can be slow and doesn't always give
7834 better results.
7835
7836 fast Internal method that only checks for simple changes:
7837 character inserts/deletes/swaps. Works well for
7838 simple typing mistakes.
7839
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007840 {number} The maximum number of suggestions listed for |z=|.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007841 Not used for |spellsuggest()|. The number of
7842 suggestions is never more than the value of 'lines'
7843 minus two.
7844
Bram Moolenaar585ee072022-01-29 11:22:17 +00007845 timeout:{millisec} Limit the time searching for suggestions to
Dominique Pellédf62c622024-07-15 20:29:59 +02007846 {millisec} milliseconds. Applies to the following
Bram Moolenaar585ee072022-01-29 11:22:17 +00007847 methods. When omitted the limit is 5000. When
7848 negative there is no limit. {only works when built
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01007849 with the |+reltime| feature}
Bram Moolenaar585ee072022-01-29 11:22:17 +00007850
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007851 file:{filename} Read file {filename}, which must have two columns,
7852 separated by a slash. The first column contains the
7853 bad word, the second column the suggested good word.
7854 Example:
7855 theribal/terrible ~
7856 Use this for common mistakes that do not appear at the
7857 top of the suggestion list with the internal methods.
7858 Lines without a slash are ignored, use this for
7859 comments.
Bram Moolenaarbcb98982014-05-01 14:08:19 +02007860 The word in the second column must be correct,
7861 otherwise it will not be used. Add the word to an
7862 ".add" file if it is currently flagged as a spelling
7863 mistake.
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007864 The file is used for all languages.
7865
7866 expr:{expr} Evaluate expression {expr}. Use a function to avoid
Bram Moolenaara4e0b972022-10-01 19:43:52 +01007867 trouble with spaces. Best is to call a function
7868 without arguments, see |expr-option-function|.
7869 |v:val| holds the badly spelled word. The expression
7870 must evaluate to a List of Lists, each with a
7871 suggestion and a score.
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007872 Example:
Bram Moolenaar214641f2017-03-05 17:04:09 +01007873 [['the', 33], ['that', 44]] ~
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007874 Set 'verbose' and use |z=| to see the scores that the
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007875 internal methods use. A lower score is better.
7876 This may invoke |spellsuggest()| if you temporarily
7877 set 'spellsuggest' to exclude the "expr:" part.
7878 Errors are silently ignored, unless you set the
7879 'verbose' option to a non-zero value.
7880
7881 Only one of "best", "double" or "fast" may be used. The others may
7882 appear several times in any order. Example: >
7883 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
7884<
7885 This option cannot be set from a |modeline| or in the |sandbox|, for
7886 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007887
Bram Moolenaar071d4272004-06-13 20:20:40 +00007888 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
7889'splitbelow' 'sb' boolean (default off)
7890 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007891 When on, splitting a window will put the new window below the current
7892 one. |:split|
7893
Bram Moolenaar3c053a12022-10-16 13:11:12 +01007894 *'splitkeep'* *'spk'*
Luuk van Baal13ece2a2022-10-03 15:28:08 +01007895'splitkeep' 'spk' string (default "cursor")
7896 global
7897 The value of this option determines the scroll behavior when opening,
7898 closing or resizing horizontal splits.
7899
7900 Possible values are:
7901 cursor Keep the same relative cursor position.
7902 screen Keep the text on the same screen line.
7903 topline Keep the topline the same.
7904
7905 For the "screen" and "topline" values, the cursor position will be
7906 changed when necessary. In this case, the jumplist will be populated
7907 with the previous cursor position. For "screen", the text cannot always
Bram Moolenaar3c053a12022-10-16 13:11:12 +01007908 be kept on the same screen line when 'wrap' is enabled.
Luuk van Baal13ece2a2022-10-03 15:28:08 +01007909
Bram Moolenaar071d4272004-06-13 20:20:40 +00007910 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
7911'splitright' 'spr' boolean (default off)
7912 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007913 When on, splitting a window will put the new window right of the
7914 current one. |:vsplit|
7915
7916 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
7917'startofline' 'sol' boolean (default on)
7918 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007919 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00007920 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaar71badf92023-04-22 22:40:14 +01007921 (if possible). This applies to the commands:
7922 - CTRL-D, CTRL-U, CTRL-B, CTRL-F, "G", "H", "M", "L", "gg"
Christian Brabandtfd4e47e2024-10-06 17:57:53 +02007923 - "d", "<<", "==" and ">>" with a linewise operator
7924 (|operator-resulting-pos|)
Bram Moolenaar71badf92023-04-22 22:40:14 +01007925 - "%" with a count
7926 - buffer changing commands (CTRL-^, :bnext, :bNext, etc.)
7927 - Ex commands that only has a line number, e.g., ":25" or ":+".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007928 In case of buffer changing commands the cursor is placed at the column
7929 where it was the last time the buffer was edited.
7930 NOTE: This option is set when 'compatible' is set.
7931
Bram Moolenaar00654022011-02-25 14:42:19 +01007932 *'statusline'* *'stl'* *E540* *E542*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007933'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007934 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007935 {not available when compiled without the |+statusline|
7936 feature}
Bram Moolenaar944697a2022-02-20 19:48:20 +00007937 When non-empty, this option determines the content of the status line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007938 Also see |status-line|.
7939
7940 The option consists of printf style '%' items interspersed with
7941 normal text. Each status line item is of the form:
7942 %-0{minwid}.{maxwid}{item}
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01007943 All fields except the {item} are optional. A single percent sign can
Bram Moolenaar8133cc62020-10-26 21:05:27 +01007944 be given as "%%".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007945
Yegappan Lakshmananac023e82024-11-27 20:55:45 +01007946 *stl-%!*
Bram Moolenaar238a5642006-02-21 22:12:05 +00007947 When the option starts with "%!" then it is used as an expression,
7948 evaluated and the result is used as the option value. Example: >
7949 :set statusline=%!MyStatusLine()
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02007950< The *g:statusline_winid* variable will be set to the |window-ID| of the
7951 window that the status line belongs to.
7952 The result can contain %{} items that will be evaluated too.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02007953 Note that the "%!" expression is evaluated in the context of the
7954 current window and buffer, while %{} items are evaluated in the
7955 context of the window that the statusline belongs to.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007956
7957 When there is error while evaluating the option then it will be made
7958 empty to avoid further errors. Otherwise screen updating would loop.
Bram Moolenaar1b5f03e2023-01-09 20:12:45 +00007959 When the result contains unprintable characters the result is
7960 unpredictable.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007961
Bram Moolenaar071d4272004-06-13 20:20:40 +00007962 Note that the only effect of 'ruler' when this option is set (and
7963 'laststatus' is 2) is controlling the output of |CTRL-G|.
7964
7965 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00007966 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00007967 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007968 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007969 minwid Minimum width of the item, padding as set by '-' & '0'.
7970 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007971 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007972 on the left for text items. Numeric items will be
7973 shifted down to maxwid-2 digits followed by '>'number
7974 where number is the amount of missing digits, much like
7975 an exponential notation.
7976 item A one letter code as described below.
7977
7978 Following is a description of the possible statusline items. The
7979 second character in "item" is the type:
7980 N for number
7981 S for string
7982 F for flags as described below
7983 - not applicable
7984
7985 item meaning ~
Bram Moolenaar02467872007-05-06 13:22:01 +00007986 f S Path to the file in the buffer, as typed or relative to current
7987 directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007988 F S Full path to the file in the buffer.
7989 t S File name (tail) of file in the buffer.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007990 m F Modified flag, text is "[+]"; "[-]" if 'modifiable' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007991 M F Modified flag, text is ",+" or ",-".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007992 r F Readonly flag, text is "[RO]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007993 R F Readonly flag, text is ",RO".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007994 h F Help buffer flag, text is "[help]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007995 H F Help buffer flag, text is ",HLP".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007996 w F Preview window flag, text is "[Preview]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007997 W F Preview window flag, text is ",PRV".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007998 y F Type of file in the buffer, e.g., "[vim]". See 'filetype'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007999 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
Bram Moolenaar7fd73202010-07-25 16:58:46 +02008000 q S "[Quickfix List]", "[Location List]" or empty.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008001 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
8002 being used: "<keymap>"
8003 n N Buffer number.
Bram Moolenaar00654022011-02-25 14:42:19 +01008004 b N Value of character under cursor.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008005 B N As above, in hexadecimal.
8006 o N Byte number in file of byte under cursor, first byte is 1.
8007 Mnemonic: Offset from start of file (with one added)
8008 {not available when compiled without |+byte_offset| feature}
8009 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00008010 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008011 l N Line number.
8012 L N Number of lines in buffer.
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02008013 c N Column number (byte index).
8014 v N Virtual column number (screen column).
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008015 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008016 p N Percentage through file in lines as in |CTRL-G|.
8017 P S Percentage through file of displayed window. This is like the
Bram Moolenaar14b69452013-06-29 23:05:20 +02008018 percentage described for 'ruler'. Always 3 in length, unless
8019 translated.
Luuk van Baalba936f62022-12-15 13:15:39 +00008020 S S 'showcmd' content, see 'showcmdloc'.
Bram Moolenaar582fd852005-03-28 20:58:01 +00008021 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00008022 Empty if the argument file count is zero or one.
Bram Moolenaar238a5642006-02-21 22:12:05 +00008023 { NF Evaluate expression between '%{' and '}' and substitute result.
Bram Moolenaar6d150f72018-04-21 20:03:20 +02008024 Note that there is no '%' before the closing '}'. The
8025 expression cannot contain a '}' character, call a function to
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01008026 work around that. See |stl-%{| below.
shadmansaleh30e3de22021-05-15 17:23:28 +02008027 {% - This is almost same as { except the result of the expression is
8028 re-evaluated as a statusline format string. Thus if the
8029 return value of expr contains % items they will get expanded.
8030 The expression can contain the } character, the end of
8031 expression is denoted by %}.
Bram Moolenaar22863042021-10-16 15:23:36 +01008032 For example: >
shadmansaleh30e3de22021-05-15 17:23:28 +02008033 func! Stl_filename() abort
8034 return "%t"
8035 endfunc
8036< `stl=%{Stl_filename()}` results in `"%t"`
8037 `stl=%{%Stl_filename()%}` results in `"Name of current file"`
Bram Moolenaar22863042021-10-16 15:23:36 +01008038 %} - End of `{%` expression
Bram Moolenaar071d4272004-06-13 20:20:40 +00008039 ( - Start of item group. Can be used for setting the width and
8040 alignment of a section. Must be followed by %) somewhere.
8041 ) - End of item group. No width fields allowed.
Bram Moolenaard1f56e62006-02-22 21:25:37 +00008042 T N For 'tabline': start of tab page N label. Use %T after the last
8043 label. This information is used for mouse clicks.
8044 X N For 'tabline': start of close tab N label. Use %X after the
8045 label, e.g.: %3Xclose%X. Use %999X for a "close current tab"
8046 mark. This information is used for mouse clicks.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008047 < - Where to truncate line if too long. Default is at the start.
8048 No width fields allowed.
Yegappan Lakshmanan3ec78f92023-02-11 11:15:25 +00008049 = - Separation point between alignment sections. Each section will
8050 be separated by an equal number of spaces. With one %= what
8051 comes after it will be right-aligned. With two %= there is a
8052 middle part, with white space left and right of it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008053 No width fields allowed.
Bram Moolenaar238a5642006-02-21 22:12:05 +00008054 # - Set highlight group. The name must follow and then a # again.
8055 Thus use %#HLname# for highlight group HLname. The same
8056 highlighting is used, also for the statusline of non-current
8057 windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008058 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00008059 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaarbe4e0162023-02-02 13:59:48 +00008060 The difference between User{N} and StatusLine will be applied to
8061 StatusLineNC for the statusline of non-current windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008062 The number N must be between 1 and 9. See |hl-User1..9|
8063
Bram Moolenaare37d50a2008-08-06 17:06:04 +00008064 When displaying a flag, Vim removes the leading comma, if any, when
8065 that flag comes right after plaintext. This will make a nice display
8066 when flags are used like in the examples below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008067
Bram Moolenaar582fd852005-03-28 20:58:01 +00008068 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00008069 not set) and a minwid is not set for the group, the whole group will
8070 become empty. This will make a group like the following disappear
8071 completely from the statusline when none of the flags are set. >
8072 :set statusline=...%(\ [%M%R%H]%)...
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02008073< Beware that an expression is evaluated each and every time the status
8074 line is displayed.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01008075 *stl-%{* *g:actual_curbuf* *g:actual_curwin*
Bram Moolenaarade0d392020-01-21 22:33:58 +01008076 While evaluating %{} the current buffer and current window will be set
8077 temporarily to that of the window (and buffer) whose statusline is
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01008078 currently being drawn. The expression will evaluate in this context.
8079 The variable "g:actual_curbuf" is set to the `bufnr()` number of the
8080 real current buffer and "g:actual_curwin" to the |window-ID| of the
8081 real current window. These values are strings.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00008082
Bram Moolenaar30b65812012-07-12 22:01:11 +02008083 The 'statusline' option will be evaluated in the |sandbox| if set from
8084 a modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008085 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00008086
8087 It is not allowed to change text or jump to another window while
8088 evaluating 'statusline' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008089
8090 If the statusline is not updated when you want it (e.g., after setting
8091 a variable that's used in an expression), you can force an update by
Bram Moolenaarcfa8f9a2022-06-03 21:59:47 +01008092 using `:redrawstatus`.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008093
Bram Moolenaarcfa8f9a2022-06-03 21:59:47 +01008094 A result of all digits is regarded a number for display purposes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008095 Otherwise the result is taken as flag text and applied to the rules
8096 described above.
8097
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00008098 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00008099 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008100 edit your .vimrc or whatever with "vim --clean" to get it right.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008101
8102 Examples:
8103 Emulate standard status line with 'ruler' set >
saher7b5e52d2024-10-14 19:52:50 +02008104 :set statusline=%<%f\ %h%w%m%r%=%-14.(%l,%c%V%)\ %P
Bram Moolenaar071d4272004-06-13 20:20:40 +00008105< Similar, but add ASCII value of char under the cursor (like "ga") >
8106 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
8107< Display byte count and byte value, modified flag in red. >
8108 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
8109 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
8110< Display a ,GZ flag if a compressed file is loaded >
8111 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
8112< In the |:autocmd|'s: >
8113 :let b:gzflag = 1
8114< And: >
8115 :unlet b:gzflag
8116< And define this function: >
8117 :function VarExists(var, val)
8118 : if exists(a:var) | return a:val | else | return '' | endif
8119 :endfunction
8120<
8121 *'suffixes'* *'su'*
8122'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
8123 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008124 Files with these suffixes get a lower priority when multiple files
8125 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008126 suffixes. Spaces after the comma are ignored. A dot is also seen as
8127 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00008128 separator, precede it with a backslash (see |option-backslash| about
8129 including spaces and backslashes).
8130 See 'wildignore' for completely ignoring files.
8131 The use of |:set+=| and |:set-=| is preferred when adding or removing
8132 suffixes from the list. This avoids problems when a future version
8133 uses another default.
8134
8135 *'suffixesadd'* *'sua'*
8136'suffixesadd' 'sua' string (default "")
8137 local to buffer
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01008138 Comma-separated list of suffixes, which are used when searching for a
Bram Moolenaar071d4272004-06-13 20:20:40 +00008139 file for the "gf", "[I", etc. commands. Example: >
8140 :set suffixesadd=.java
8141<
8142 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
8143'swapfile' 'swf' boolean (default on)
8144 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008145 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00008146 swapfile is not wanted for a specific buffer. For example, with
8147 confidential information that even root must not be able to access.
8148 Careful: All text will be in memory:
8149 - Don't use this for big files.
8150 - Recovery will be impossible!
8151 A swapfile will only be present when |'updatecount'| is non-zero and
8152 'swapfile' is set.
8153 When 'swapfile' is reset, the swap file for the current buffer is
8154 immediately deleted. When 'swapfile' is set, and 'updatecount' is
8155 non-zero, a swap file is immediately created.
8156 Also see |swap-file| and |'swapsync'|.
Bram Moolenaar76f3b1a2014-03-27 22:30:07 +01008157 If you want to open a new buffer without creating a swap file for it,
8158 use the |:noswapfile| modifier.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01008159 See 'directory' for where the swap file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008160
8161 This option is used together with 'bufhidden' and 'buftype' to
8162 specify special kinds of buffers. See |special-buffers|.
8163
8164 *'swapsync'* *'sws'*
8165'swapsync' 'sws' string (default "fsync")
8166 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008167 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008168 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008169 When this option is empty parts of the swap file may be in memory and
8170 not written to disk. When the system crashes you may lose more work.
8171 On Unix the system does a sync now and then without Vim asking for it,
8172 so the disadvantage of setting this option off is small. On some
8173 systems the swap file will not be written at all. For a unix system
8174 setting it to "sync" will use the sync() call instead of the default
8175 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00008176 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008177
8178 *'switchbuf'* *'swb'*
8179'switchbuf' 'swb' string (default "")
8180 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008181 This option controls the behavior when switching between buffers.
Yegappan Lakshmanan54be5fb2023-05-12 17:49:13 +01008182 This option is checked, when
8183 - jumping to errors with the |quickfix| commands (|:cc|, |:cn|, |:cp|,
h_east59858792023-10-25 22:47:05 +09008184 etc.).
Yegappan Lakshmanan54be5fb2023-05-12 17:49:13 +01008185 - jumping to a tag using the |:stag| command.
8186 - opening a file using the |CTRL-W_f| or |CTRL-W_F| command.
8187 - jumping to a buffer using a buffer split command (e.g. |:sbuffer|,
8188 |:sbnext|, or |:sbrewind|).
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01008189 Possible values (comma-separated list):
Yegappan Lakshmanan54be5fb2023-05-12 17:49:13 +01008190 useopen If included, jump to the first open window in the
8191 current tab page that contains the specified buffer
8192 (if there is one). Otherwise: Do not examine other
8193 windows.
Bram Moolenaar779b74b2006-04-10 14:55:34 +00008194 usetab Like "useopen", but also consider windows in other tab
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00008195 pages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008196 split If included, split the current window before loading
Bram Moolenaar15146672011-10-20 22:22:38 +02008197 a buffer for a |quickfix| command that display errors.
Bram Moolenaar63b74a82019-03-24 15:09:13 +01008198 Otherwise: do not split, use current window (when used
8199 in the quickfix window: the previously used window or
8200 split if there is no other window).
Bram Moolenaara594d772015-06-19 14:41:49 +02008201 vsplit Just like "split" but split vertically.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008202 newtab Like "split", but open a new tab page. Overrules
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02008203 "split" when both are present.
Bram Moolenaar539aa6b2019-11-17 18:09:38 +01008204 uselast If included, jump to the previously used window when
8205 jumping to errors with |quickfix| commands.
Colin Kennedy21570352024-03-03 16:16:47 +01008206 If a window has 'winfixbuf' enabled, 'switchbuf' is currently not
8207 applied to the split window.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008208
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00008209 *'synmaxcol'* *'smc'*
8210'synmaxcol' 'smc' number (default 3000)
8211 local to buffer
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00008212 {not available when compiled without the |+syntax|
8213 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00008214 Maximum column in which to search for syntax items. In long lines the
8215 text after this column is not highlighted and following lines may not
8216 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00008217 This helps to avoid very slow redrawing for an XML file that is one
8218 long line.
8219 Set to zero to remove the limit.
8220
Bram Moolenaar071d4272004-06-13 20:20:40 +00008221 *'syntax'* *'syn'*
8222'syntax' 'syn' string (default empty)
Christian Brabandt596ad662023-08-16 00:11:09 +02008223 local to buffer |local-noglobal|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008224 {not available when compiled without the |+syntax|
8225 feature}
8226 When this option is set, the syntax with this name is loaded, unless
8227 syntax highlighting has been switched off with ":syntax off".
8228 Otherwise this option does not always reflect the current syntax (the
8229 b:current_syntax variable does).
8230 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008231 not automatically recognized. Example, in an IDL file:
8232 /* vim: set syntax=idl : */ ~
8233 When a dot appears in the value then this separates two filetype
8234 names. Example:
8235 /* vim: set syntax=c.doxygen : */ ~
8236 This will use the "c" syntax first, then the "doxygen" syntax.
8237 Note that the second one must be prepared to be loaded as an addition,
8238 otherwise it will be skipped. More than one dot may appear.
8239 To switch off syntax highlighting for the current file, use: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008240 :set syntax=OFF
8241< To switch syntax highlighting on according to the current value of the
8242 'filetype' option: >
8243 :set syntax=ON
8244< What actually happens when setting the 'syntax' option is that the
8245 Syntax autocommand event is triggered with the value as argument.
8246 This option is not copied to another buffer, independent of the 's' or
8247 'S' flag in 'cpoptions'.
Millyae62fe52024-10-02 19:30:41 +02008248 Only alphanumeric characters, '.', '-' and '_' can be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008249
LemonBoy5247b0b2024-07-12 19:30:58 +02008250 *'tabclose'* *'tcl'*
8251'tabclose' 'tcl' string (default "")
8252 global
8253 This option controls the behavior when closing tab pages (e.g., using
8254 |:tabclose|). When empty Vim goes to the next (right) tab page.
8255
8256 Possible values (comma-separated list):
8257 left If included, go to the previous tab page instead of
8258 the next one.
8259 uselast If included, go to the previously used tab page if
8260 possible. This option takes precedence over the
8261 others.
8262
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00008263 *'tabline'* *'tal'*
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008264'tabline' 'tal' string (default empty)
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00008265 global
Bram Moolenaar944697a2022-02-20 19:48:20 +00008266 When non-empty, this option determines the content of the tab pages
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008267 line at the top of the Vim window. When empty Vim will use a default
Bram Moolenaard1f56e62006-02-22 21:25:37 +00008268 tab pages line. See |setting-tabline| for more info.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008269
8270 The tab pages line only appears as specified with the 'showtabline'
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00008271 option and only when there is no GUI tab line. When 'e' is in
8272 'guioptions' and the GUI supports a tab line 'guitablabel' is used
Bram Moolenaar7f036442010-08-15 15:24:20 +02008273 instead. Note that the two tab pages lines are very different.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008274
8275 The value is evaluated like with 'statusline'. You can use
8276 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out
Bram Moolenaard1f56e62006-02-22 21:25:37 +00008277 the text to be displayed. Use "%1T" for the first label, "%2T" for
8278 the second one, etc. Use "%X" items for closing labels.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008279
Bram Moolenaare12bab32019-01-08 22:02:56 +01008280 When changing something that is used in 'tabline' that does not
8281 trigger it to be updated, use |:redrawtabline|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008282 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaare12bab32019-01-08 22:02:56 +01008283
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008284 Keep in mind that only one of the tab pages is the current one, others
8285 are invisible and you can't jump to their windows.
8286
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00008287 *'tabpagemax'* *'tpm'*
8288'tabpagemax' 'tpm' number (default 10)
8289 global
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00008290 Maximum number of tab pages to be opened by the |-p| command line
8291 argument or the ":tab all" command. |tabpage|
8292
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00008293 *'tabstop'* *'ts'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008294'tabstop' 'ts' number (default 8)
8295 local to buffer
8296 Number of spaces that a <Tab> in the file counts for. Also see
Bram Moolenaarf10911e2022-01-29 22:20:48 +00008297 the |:retab| command, and the 'softtabstop' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008298
8299 Note: Setting 'tabstop' to any other value than 8 can make your file
Bram Moolenaarf10911e2022-01-29 22:20:48 +00008300 appear wrong in many places, e.g., when printing it.
8301 The value must be more than 0 and less than 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008302
Song-Tianxiangab01adf2024-03-25 16:31:02 +01008303 There are five main ways to use tabs in Vim:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008304 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
8305 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
Bram Moolenaarebcbd022007-05-12 14:28:25 +00008306 will use a mix of tabs and spaces, but typing <Tab> and <BS> will
Bram Moolenaar071d4272004-06-13 20:20:40 +00008307 behave like a tab appears every 4 (or 3) characters.
Bram Moolenaar10e8ff92023-06-10 21:40:39 +01008308 This is the recommended way, the file will look the same with other
8309 tools and when listing it in a terminal.
8310 2. Set 'softtabstop' and 'shiftwidth' to whatever you prefer and use
8311 'expandtab'. This way you will always insert spaces. The
8312 formatting will never be messed up when 'tabstop' is changed (leave
8313 it at 8 just in case). The file will be a bit larger.
8314 You do need to check if no Tabs exist in the file. You can get rid
8315 of them by first setting 'expandtab' and using `%retab!`, making
8316 sure the value of 'tabstop' is set correctly.
8317 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
Bram Moolenaar071d4272004-06-13 20:20:40 +00008318 'expandtab'. This way you will always insert spaces. The
8319 formatting will never be messed up when 'tabstop' is changed.
Bram Moolenaar10e8ff92023-06-10 21:40:39 +01008320 You do need to check if no Tabs exist in the file, just like in the
8321 item just above.
8322 4. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008323 |modeline| to set these values when editing the file again. Only
Bram Moolenaar10e8ff92023-06-10 21:40:39 +01008324 works when using Vim to edit the file, other tools assume a tabstop
8325 is worth 8 spaces.
8326 5. Always set 'tabstop' and 'shiftwidth' to the same value, and
Bram Moolenaar071d4272004-06-13 20:20:40 +00008327 'noexpandtab'. This should then work (for initial indents only)
8328 for any tabstop setting that people use. It might be nice to have
8329 tabs after the first non-blank inserted as spaces if you do this
8330 though. Otherwise aligned comments will be wrong when 'tabstop' is
8331 changed.
8332
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008333 If Vim is compiled with the |+vartabs| feature then the value of
8334 'tabstop' will be ignored if |'vartabstop'| is set to anything other
8335 than an empty string.
8336
Bram Moolenaar071d4272004-06-13 20:20:40 +00008337 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
8338'tagbsearch' 'tbs' boolean (default on)
8339 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008340 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008341 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00008342 searching makes searching for a tag a LOT faster, but a linear search
8343 will find more tags if the tags file wasn't properly sorted.
8344 Vim normally assumes that your tags files are sorted, or indicate that
8345 they are not sorted. Only when this is not the case does the
8346 'tagbsearch' option need to be switched off.
8347
8348 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008349 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00008350 certain files, or retry all files with a linear search. When
8351 'tagbsearch' is off, only a linear search is done.
8352
8353 Linear searching is done anyway, for one file, when Vim finds a line
8354 at the start of the file indicating that it's not sorted: >
Bram Moolenaar446cb832008-06-24 21:56:24 +00008355 !_TAG_FILE_SORTED 0 /some comment/
Bram Moolenaar071d4272004-06-13 20:20:40 +00008356< [The whitespace before and after the '0' must be a single <Tab>]
8357
8358 When a binary search was done and no match was found in any of the
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008359 files listed in 'tags', and case is ignored or a pattern is used
Bram Moolenaar071d4272004-06-13 20:20:40 +00008360 instead of a normal tag name, a retry is done with a linear search.
8361 Tags in unsorted tags files, and matches with different case will only
8362 be found in the retry.
8363
Bram Moolenaard4755bb2004-09-02 19:12:26 +00008364 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008365 linear search can be avoided when case is ignored. Use a value of '2'
8366 in the "!_TAG_FILE_SORTED" line for this. A tag file can be case-fold
8367 sorted with the -f switch to "sort" in most unices, as in the command:
Bram Moolenaar47c532e2022-03-19 15:18:53 +00008368 "sort -f -o tags tags". For Universal ctags and Exuberant ctags
8369 version 5.x or higher (at least 5.5) the --sort=foldcase switch can be
8370 used for this as well. Note that case must be folded to uppercase for
8371 this to work.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008372
8373 By default, tag searches are case-sensitive. Case is ignored when
8374 'ignorecase' is set and 'tagcase' is "followic", or when 'tagcase' is
8375 "ignore".
Bram Moolenaar66e29d72016-08-20 16:57:02 +02008376 Also when 'tagcase' is "followscs" and 'smartcase' is set, or
8377 'tagcase' is "smart", and the pattern contains only lowercase
8378 characters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008379
8380 When 'tagbsearch' is off, tags searching is slower when a full match
8381 exists, but faster when no full match exists. Tags in unsorted tags
8382 files may only be found with 'tagbsearch' off.
8383 When the tags file is not sorted, or sorted in a wrong way (not on
8384 ASCII byte value), 'tagbsearch' should be off, or the line given above
8385 must be included in the tags file.
8386 This option doesn't affect commands that find all matching tags (e.g.,
8387 command-line completion and ":help").
Bram Moolenaar071d4272004-06-13 20:20:40 +00008388
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008389 *'tagcase'* *'tc'*
8390'tagcase' 'tc' string (default "followic")
8391 global or local to buffer |global-local|
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008392 This option specifies how case is handled when searching the tags
8393 file:
8394 followic Follow the 'ignorecase' option
Bram Moolenaar66e29d72016-08-20 16:57:02 +02008395 followscs Follow the 'smartcase' and 'ignorecase' options
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008396 ignore Ignore case
8397 match Match case
Bram Moolenaar66e29d72016-08-20 16:57:02 +02008398 smart Ignore case unless an upper case letter is used
Bram Moolenaar036986f2017-03-16 17:41:02 +01008399 NOTE: This option is set to the Vi default value when 'compatible' is
8400 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008401
Bram Moolenaar45e18cb2019-04-28 18:05:35 +02008402 *'tagfunc'* *'tfu'*
8403'tagfunc' 'tfu' string (default: empty)
8404 local to buffer
8405 {not available when compiled without the |+eval|
8406 feature}
8407 This option specifies a function to be used to perform tag searches.
8408 The function gets the tag pattern and should return a List of matching
8409 tags. See |tag-function| for an explanation of how to write the
Yegappan Lakshmanan19916a82021-11-24 16:32:55 +00008410 function and an example. The value can be the name of a function, a
8411 |lambda| or a |Funcref|. See |option-value-function| for more
8412 information.
dkearns8ebdbc92023-10-29 06:26:19 +11008413 This option cannot be set from a |modeline| or in the |sandbox|, for
8414 security reasons.
Bram Moolenaar45e18cb2019-04-28 18:05:35 +02008415
Bram Moolenaar071d4272004-06-13 20:20:40 +00008416 *'taglength'* *'tl'*
8417'taglength' 'tl' number (default 0)
8418 global
8419 If non-zero, tags are significant up to this number of characters.
8420
8421 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
8422'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
8423 global
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00008424 If on and using a tags file in another directory, file names in that
8425 tags file are relative to the directory where the tags file is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008426 NOTE: This option is set to the Vi default value when 'compatible' is
8427 set and to the Vim default value when 'compatible' is reset.
8428
8429 *'tags'* *'tag'* *E433*
8430'tags' 'tag' string (default "./tags,tags", when compiled with
8431 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
8432 global or local to buffer |global-local|
8433 Filenames for the tag command, separated by spaces or commas. To
Yee Cheng Chin54844852023-10-09 18:12:31 +02008434 include a space or comma in a file name, precede it with backslashes
8435 (see |option-backslash| about including spaces/commas and backslashes).
Bram Moolenaar071d4272004-06-13 20:20:40 +00008436 When a file name starts with "./", the '.' is replaced with the path
8437 of the current file. But only when the 'd' flag is not included in
8438 'cpoptions'. Environment variables are expanded |:set_env|. Also see
8439 |tags-option|.
8440 "*", "**" and other wildcards can be used to search for tags files in
Bram Moolenaare2b590e2010-08-08 18:29:48 +02008441 a directory tree. See |file-searching|. E.g., "/lib/**/tags" will
8442 find all files named "tags" below "/lib". The filename itself cannot
8443 contain wildcards, it is used as-is. E.g., "/lib/**/tags?" will find
Bram Moolenaar2bd9dbc2022-08-25 18:12:06 +01008444 files called "tags?".
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00008445 The |tagfiles()| function can be used to get a list of the file names
8446 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008447 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
8448 files are also supported. They are automatically recognized. The
8449 default value becomes "./tags,./TAGS,tags,TAGS", unless case
8450 differences are ignored (MS-Windows). |emacs-tags|
8451 The use of |:set+=| and |:set-=| is preferred when adding or removing
8452 file names from the list. This avoids problems when a future version
8453 uses another default.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008454
8455 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
8456'tagstack' 'tgst' boolean (default on)
8457 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008458 When on, the |tagstack| is used normally. When off, a ":tag" or
8459 ":tselect" command with an argument will not push the tag onto the
8460 tagstack. A following ":tag" without an argument, a ":pop" command or
8461 any other command that uses the tagstack will use the unmodified
8462 tagstack, but does change the pointer to the active entry.
8463 Resetting this option is useful when using a ":tag" command in a
8464 mapping which should not change the tagstack.
8465
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01008466 *'tcldll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01008467'tcldll' string (default depends on the build)
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01008468 global
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01008469 {only available when compiled with the |+tcl/dyn|
8470 feature}
8471 Specifies the name of the Tcl shared library. The default is
8472 DYNAMIC_TCL_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02008473 Environment variables are expanded |:set_env|.
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01008474 This option cannot be set from a |modeline| or in the |sandbox|, for
8475 security reasons.
8476
Bram Moolenaar071d4272004-06-13 20:20:40 +00008477 *'term'* *E529* *E530* *E531*
8478'term' string (default is $TERM, if that fails:
8479 in the GUI: "builtin_gui"
8480 on Amiga: "amiga"
Bram Moolenaarb3f74062020-02-26 16:16:53 +01008481 on Haiku: "xterm"
Bram Moolenaar071d4272004-06-13 20:20:40 +00008482 on Mac: "mac-ansi"
Bram Moolenaar071d4272004-06-13 20:20:40 +00008483 on Unix: "ansi"
8484 on VMS: "ansi"
8485 on Win 32: "win32")
8486 global
8487 Name of the terminal. Used for choosing the terminal control
8488 characters. Environment variables are expanded |:set_env|.
8489 For example: >
8490 :set term=$TERM
8491< See |termcap|.
8492
8493 *'termbidi'* *'tbidi'*
8494 *'notermbidi'* *'notbidi'*
8495'termbidi' 'tbidi' boolean (default off, on for "mlterm")
8496 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008497 {only available when compiled with the |+arabic|
8498 feature}
8499 The terminal is in charge of Bi-directionality of text (as specified
8500 by Unicode). The terminal is also expected to do the required shaping
8501 that some languages (such as Arabic) require.
8502 Setting this option implies that 'rightleft' will not be set when
8503 'arabic' is set and the value of 'arabicshape' will be ignored.
8504 Note that setting 'termbidi' has the immediate effect that
8505 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
8506 This option is reset when the GUI is started.
8507 For further details see |arabic.txt|.
8508
8509 *'termencoding'* *'tenc'*
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02008510'termencoding' 'tenc' string (default ""; with GTK+ GUI: "utf-8")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008511 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008512 Encoding used for the terminal. This specifies what character
8513 encoding the keyboard produces and the display will understand. For
Bram Moolenaar3848e002016-03-19 18:42:29 +01008514 the GUI it only applies to the keyboard ('encoding' is used for the
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02008515 display).
Bram Moolenaar4b7cdca2020-01-01 16:18:38 +01008516 *E617* *E950*
Bram Moolenaar3df01732017-02-17 22:47:16 +01008517 Note: This does not apply to the GTK+ GUI. After the GUI has been
Bram Moolenaar071d4272004-06-13 20:20:40 +00008518 successfully initialized, 'termencoding' is forcibly set to "utf-8".
8519 Any attempts to set a different value will be rejected, and an error
8520 message is shown.
Bram Moolenaarac360bf2015-09-01 20:31:20 +02008521 For the Win32 GUI and console versions 'termencoding' is not used,
Bram Moolenaar071d4272004-06-13 20:20:40 +00008522 because the Win32 system always passes Unicode characters.
8523 When empty, the same encoding is used as for the 'encoding' option.
8524 This is the normal value.
8525 Not all combinations for 'termencoding' and 'encoding' are valid. See
8526 |encoding-table|.
8527 The value for this option must be supported by internal conversions or
8528 iconv(). When this is not possible no conversion will be done and you
8529 will probably experience problems with non-ASCII characters.
8530 Example: You are working with the locale set to euc-jp (Japanese) and
8531 want to edit a UTF-8 file: >
8532 :let &termencoding = &encoding
8533 :set encoding=utf-8
8534< You need to do this when your system has no locale support for UTF-8.
8535
Bram Moolenaar938ae282023-02-20 20:44:55 +00008536 *'termguicolors'* *'tgc'* *'notermguicolors'* *'notgc'* *E954*
Christian Brabandtd7f58542025-01-31 16:13:14 +01008537'termguicolors' 'tgc' boolean (default off unless Vim detects that it runs
8538 in a capable terminal)
Bram Moolenaar61be73b2016-04-29 22:59:22 +02008539 global
Bram Moolenaar61be73b2016-04-29 22:59:22 +02008540 {not available when compiled without the
8541 |+termguicolors| feature}
8542 When on, uses |highlight-guifg| and |highlight-guibg| attributes in
Bram Moolenaarcafafb32018-02-22 21:07:09 +01008543 the terminal (thus using 24-bit color).
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01008544
Bram Moolenaarcafafb32018-02-22 21:07:09 +01008545 Requires a ISO-8613-3 compatible terminal. If setting this option
8546 does not work (produces a colorless UI) reading |xterm-true-color|
8547 might help.
8548
8549 For Win32 console, Windows 10 version 1703 (Creators Update) or later
8550 is required. Use this check to find out: >
8551 if has('vcon')
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01008552< This requires Vim to be built with the |+vtp| feature.
8553
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +02008554 Note that the "cterm" attributes are still used, not the "gui" ones.
Yasuhiro Matsumotoaa04e1b2022-05-07 14:09:19 +01008555
8556 When using Vim with Windows Terminal, the background of Windows
8557 Terminal is normally filled with the Vim background color. Setting
8558 'termguicolors' and the guibg of the Normal highlight group to NONE
8559 will make the background transparent: >
8560 :hi Normal guibg=NONE
8561<
Bram Moolenaar036986f2017-03-16 17:41:02 +01008562 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar61be73b2016-04-29 22:59:22 +02008563
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008564 *'termwinkey'* *'twk'*
8565'termwinkey' 'twk' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02008566 local to window
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008567 The key that starts a CTRL-W command in a terminal window. Other keys
Bram Moolenaar74675a62017-07-15 13:53:23 +02008568 are sent to the job running in the window.
Millya9c6f902024-10-06 16:47:02 +02008569 The key can be specified as a single character, a |key-notation| (e.g.
8570 <Up>, <C-F>) or a letter preceded with a caret (e.g. `^F` is CTRL-F): >
8571 :set twk=X
8572 :set twk=^I
8573 :set twk=<C-L>
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008574< The string must be one key stroke but can be multiple bytes.
8575 When not set CTRL-W is used, so that CTRL-W : gets you to the command
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008576 line. If 'termwinkey' is set to CTRL-L then CTRL-L : gets you to the
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008577 command line.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008578
Bram Moolenaar6c60f472019-04-28 16:00:35 +02008579 *'termwinscroll'* *'twsl'*
8580'termwinscroll' 'twsl' number (default 10000)
8581 local to buffer
8582 {not available when compiled without the
8583 |+terminal| feature}
8584 Number of scrollback lines to keep. When going over this limit the
8585 first 10% of the scrollback lines are deleted. This is just to reduce
8586 the memory usage. See |Terminal-Normal|.
Bram Moolenaar36968af2021-11-15 17:13:11 +00008587 Also used as a limit for text sent to the terminal in one write,
8588 multiplied by the number of columns times 3 (average number of bytes
8589 per cell).
Bram Moolenaar6c60f472019-04-28 16:00:35 +02008590
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008591 *'termwinsize'* *'tws'*
8592'termwinsize' 'tws' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02008593 local to window
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02008594 Size used when opening the |terminal| window. Format:
8595 {rows}x{columns} or {rows}*{columns}.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008596 - When empty the terminal gets the size from the window.
Bram Moolenaar498c2562018-04-15 23:45:15 +02008597 - When set with a "x" (e.g., "24x80") the terminal size is not
8598 adjusted to the window size. If the window is smaller only the
8599 top-left part is displayed.
8600 - When set with a "*" (e.g., "10*50") the terminal size follows the
8601 window size, but will not be smaller than the specified rows and/or
8602 columns.
8603 - When rows is zero then use the height of the window.
8604 - When columns is zero then use the width of the window.
8605 - Using "0x0" or "0*0" is the same as empty.
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02008606 - Can be overruled in the |term_start()| options with "term_rows" and
8607 "term_cols".
Bram Moolenaar498c2562018-04-15 23:45:15 +02008608
8609 Examples:
8610 "30x0" uses 30 rows and the current window width.
8611 "20*0" uses at least 20 rows and the current window width.
8612 "0*40" uses the current window height and at least 40 columns.
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02008613 Note that the command running in the terminal window may still change
8614 the size of the terminal. In that case the Vim window will be
8615 adjusted to that size, if possible.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008616
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008617 *'termwintype'* *'twt'*
8618'termwintype' 'twt' string (default "")
8619 global
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008620 {only available when compiled with the |terminal|
8621 feature on MS-Windows}
8622 Specify the virtual console (pty) used when opening the terminal
8623 window.
8624
8625 Possible values are:
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01008626 "" use ConPTY if it is stable, winpty otherwise
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008627 "winpty" use winpty, fail if not supported
8628 "conpty" use |ConPTY|, fail if not supported
8629
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01008630 |ConPTY| support depends on the platform. Windows 10 October 2018
8631 Update is the first version that supports ConPTY, however it is still
8632 considered unstable. ConPTY might become stable in the next release
8633 of Windows 10. winpty support needs to be installed. If neither is
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008634 supported then you cannot open a terminal window.
8635
Bram Moolenaar071d4272004-06-13 20:20:40 +00008636 *'terse'* *'noterse'*
8637'terse' boolean (default off)
8638 global
8639 When set: Add 's' flag to 'shortmess' option (this makes the message
8640 for a search that hits the start or end of the file not being
8641 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
8642 shortens a lot of messages}
8643
8644 *'textauto'* *'ta'* *'notextauto'* *'nota'*
8645'textauto' 'ta' boolean (Vim default: on, Vi default: off)
8646 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008647 This option is obsolete. Use 'fileformats'.
8648 For backwards compatibility, when 'textauto' is set, 'fileformats' is
8649 set to the default value for the current system. When 'textauto' is
8650 reset, 'fileformats' is made empty.
8651 NOTE: This option is set to the Vi default value when 'compatible' is
8652 set and to the Vim default value when 'compatible' is reset.
8653
8654 *'textmode'* *'tx'* *'notextmode'* *'notx'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008655'textmode' 'tx' boolean (Win32: default on,
Bram Moolenaar071d4272004-06-13 20:20:40 +00008656 others: default off)
8657 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00008658 This option is obsolete. Use 'fileformat'.
8659 For backwards compatibility, when 'textmode' is set, 'fileformat' is
8660 set to "dos". When 'textmode' is reset, 'fileformat' is set to
8661 "unix".
8662
8663 *'textwidth'* *'tw'*
8664'textwidth' 'tw' number (default 0)
8665 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00008666 Maximum width of text that is being inserted. A longer line will be
8667 broken after white space to get this width. A zero value disables
Bram Moolenaarca635012015-09-25 20:34:21 +02008668 this.
8669 'textwidth' is set to 0 when the 'paste' option is set and restored
8670 when 'paste' is reset.
8671 When 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00008672 'formatoptions' and |ins-textwidth|.
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00008673 When 'formatexpr' is set it will be used to break the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008674 NOTE: This option is set to 0 when 'compatible' is set.
8675
8676 *'thesaurus'* *'tsr'*
8677'thesaurus' 'tsr' string (default "")
8678 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008679 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008680 for thesaurus completion commands |i_CTRL-X_CTRL-T|. See
8681 |compl-thesaurus|.
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01008682
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008683 This option is not used if 'thesaurusfunc' is set, either for the
8684 buffer or globally.
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01008685
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008686 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00008687 after a comma are ignored, otherwise spaces are included in the file
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008688 name. See |option-backslash| about using backslashes. The use of
8689 |:set+=| and |:set-=| is preferred when adding or removing directories
8690 from the list. This avoids problems when a future version uses
8691 another default. Backticks cannot be used in this option for security
8692 reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008693
Bram Moolenaar2f0936c2022-01-08 21:51:59 +00008694 *'thesaurusfunc'* *'tsrfu'*
Yegappan Lakshmanan160e9942021-10-16 15:41:29 +01008695'thesaurusfunc' 'tsrfu' string (default: empty)
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008696 global or local to buffer |global-local|
Yegappan Lakshmanan160e9942021-10-16 15:41:29 +01008697 {not available when compiled without the |+eval|
8698 feature}
8699 This option specifies a function to be used for thesaurus completion
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008700 with CTRL-X CTRL-T. |i_CTRL-X_CTRL-T| See |compl-thesaurusfunc|.
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00008701 The value can be the name of a function, a |lambda| or a |Funcref|.
8702 See |option-value-function| for more information.
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008703
Yegappan Lakshmanan160e9942021-10-16 15:41:29 +01008704 This option cannot be set from a |modeline| or in the |sandbox|, for
8705 security reasons.
8706
Bram Moolenaar071d4272004-06-13 20:20:40 +00008707 *'tildeop'* *'top'* *'notildeop'* *'notop'*
8708'tildeop' 'top' boolean (default off)
8709 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008710 When on: The tilde command "~" behaves like an operator.
8711 NOTE: This option is reset when 'compatible' is set.
8712
8713 *'timeout'* *'to'* *'notimeout'* *'noto'*
8714'timeout' 'to' boolean (default on)
8715 global
laburnumT3f7855a2023-12-05 18:37:03 +01008716
Bram Moolenaar071d4272004-06-13 20:20:40 +00008717 *'ttimeout'* *'nottimeout'*
Bram Moolenaar94237492017-04-23 18:40:21 +02008718'ttimeout' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008719 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008720 These two options together determine the behavior when part of a
8721 mapped key sequence or keyboard code has been received:
8722
8723 'timeout' 'ttimeout' action ~
8724 off off do not time out
8725 on on or off time out on :mappings and key codes
8726 off on time out on key codes
8727
8728 If both options are off, Vim will wait until either the complete
8729 mapping or key sequence has been received, or it is clear that there
8730 is no mapping or key sequence for the received characters. For
8731 example: if you have mapped "vl" and Vim has received 'v', the next
8732 character is needed to see if the 'v' is followed by an 'l'.
8733 When one of the options is on, Vim will wait for about 1 second for
8734 the next character to arrive. After that the already received
8735 characters are interpreted as single characters. The waiting time can
8736 be changed with the 'timeoutlen' option.
8737 On slow terminals or very busy systems timing out may cause
8738 malfunctioning cursor keys. If both options are off, Vim waits
8739 forever after an entered <Esc> if there are key codes that start
8740 with <Esc>. You will have to type <Esc> twice. If you do not have
8741 problems with key codes, but would like to have :mapped key
8742 sequences not timing out in 1 second, set the 'ttimeout' option and
8743 reset the 'timeout' option.
8744
8745 NOTE: 'ttimeout' is reset when 'compatible' is set.
8746
8747 *'timeoutlen'* *'tm'*
8748'timeoutlen' 'tm' number (default 1000)
8749 global
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008750
Bram Moolenaar071d4272004-06-13 20:20:40 +00008751 *'ttimeoutlen'* *'ttm'*
Bram Moolenaar94237492017-04-23 18:40:21 +02008752'ttimeoutlen' 'ttm' number (default -1, set to 100 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008753 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008754 The time in milliseconds that is waited for a key code or mapped key
8755 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
8756 when part of a command has been typed.
8757 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
8758 different timeout value for key codes is desired set 'ttimeoutlen' to
8759 a non-negative number.
8760
8761 ttimeoutlen mapping delay key code delay ~
8762 < 0 'timeoutlen' 'timeoutlen'
8763 >= 0 'timeoutlen' 'ttimeoutlen'
8764
8765 The timeout only happens when the 'timeout' and 'ttimeout' options
8766 tell so. A useful setting would be >
8767 :set timeout timeoutlen=3000 ttimeoutlen=100
8768< (time out on mapping after three seconds, time out on key codes after
8769 a tenth of a second).
8770
8771 *'title'* *'notitle'*
8772'title' boolean (default off, on when title can be restored)
8773 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008774 When on, the title of the window will be set to the value of
8775 'titlestring' (if it is not empty), or to:
8776 filename [+=-] (path) - VIM
8777 Where:
8778 filename the name of the file being edited
8779 - indicates the file cannot be modified, 'ma' off
8780 + indicates the file was modified
8781 = indicates the file is read-only
8782 =+ indicates the file is read-only and modified
8783 (path) is the path of the file being edited
8784 - VIM the server name |v:servername| or "VIM"
8785 Only works if the terminal supports setting window titles
8786 (currently Amiga console, Win32 console, all GUI versions and
Bram Moolenaard1caa942020-04-10 22:10:56 +02008787 terminals with a non-empty 't_ts' option - these are Unix xterm and
Bram Moolenaar071d4272004-06-13 20:20:40 +00008788 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
8789 *X11*
8790 When Vim was compiled with HAVE_X11 defined, the original title will
8791 be restored if possible. The output of ":version" will include "+X11"
8792 when HAVE_X11 was defined, otherwise it will be "-X11". This also
8793 works for the icon name |'icon'|.
8794 But: When Vim was started with the |-X| argument, restoring the title
8795 will not work (except in the GUI).
8796 If the title cannot be restored, it is set to the value of 'titleold'.
8797 You might want to restore the title outside of Vim then.
Christian Brabandt1b7fbe72024-01-30 20:41:07 +01008798 When using an xterm from a remote machine you can use this command: >
8799
Bram Moolenaar071d4272004-06-13 20:20:40 +00008800 rsh machine_name xterm -display $DISPLAY &
Christian Brabandt1b7fbe72024-01-30 20:41:07 +01008801 ssh -X machine_name xterm &
8802<
Bram Moolenaar071d4272004-06-13 20:20:40 +00008803 then the WINDOWID environment variable should be inherited and the
8804 title of the window should change back to what it should be after
8805 exiting Vim.
8806
8807 *'titlelen'*
8808'titlelen' number (default 85)
8809 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008810 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008811 title. When the title is longer, only the end of the path name is
8812 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008813 Using a percentage makes this adapt to the width of the window. But
8814 it won't work perfectly, because the actual number of characters
8815 available also depends on the font used and other things in the title
8816 bar. When 'titlelen' is zero the full path is used. Otherwise,
8817 values from 1 to 30000 percent can be used.
8818 'titlelen' is also used for the 'titlestring' option.
8819
8820 *'titleold'*
8821'titleold' string (default "Thanks for flying Vim")
8822 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008823 This option will be used for the window title when exiting Vim if the
8824 original title cannot be restored. Only happens if 'title' is on or
8825 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00008826 This option cannot be set from a |modeline| or in the |sandbox|, for
8827 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008828 *'titlestring'*
8829'titlestring' string (default "")
8830 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008831 When this option is not empty, it will be used for the title of the
8832 window. This happens only when the 'title' option is on.
8833 Only works if the terminal supports setting window titles (currently
8834 Amiga console, Win32 console, all GUI versions and terminals with a
8835 non-empty 't_ts' option).
8836 When Vim was compiled with HAVE_X11 defined, the original title will
Bram Moolenaar51628222016-12-01 23:03:28 +01008837 be restored if possible, see |X11|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008838
Bram Moolenaar071d4272004-06-13 20:20:40 +00008839 When this option contains printf-style '%' items, they will be
Milly6c2fc372024-10-16 22:11:17 +02008840 expanded according to the rules used for 'statusline'. If it contains
8841 an invalid '%' format, the value is used as-is and no error or warning
8842 will be given when the value is set.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008843 This option cannot be set in a modeline when 'modelineexpr' is off.
8844
Bram Moolenaar071d4272004-06-13 20:20:40 +00008845 Example: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00008846 :auto BufEnter * let &titlestring = hostname() .. "/" .. expand("%:p")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008847 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
8848< The value of 'titlelen' is used to align items in the middle or right
8849 of the available space.
8850 Some people prefer to have the file name first: >
8851 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
8852< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008853 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00008854 separating space only when needed.
8855 NOTE: Use of special characters in 'titlestring' may cause the display
8856 to be garbled (e.g., when it contains a CR or NL character).
8857 {not available when compiled without the |+statusline| feature}
8858
8859 *'toolbar'* *'tb'*
8860'toolbar' 'tb' string (default "icons,tooltips")
8861 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01008862 {only for |+GUI_GTK|, |+GUI_Motif| and |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008863 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00008864 possible values are:
8865 icons Toolbar buttons are shown with icons.
8866 text Toolbar buttons shown with text.
8867 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008868 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008869 tooltips Tooltips are active for toolbar buttons.
8870 Tooltips refer to the popup help text which appears after the mouse
8871 cursor is placed over a toolbar button for a brief moment.
8872
8873 If you want the toolbar to be shown with icons as well as text, do the
8874 following: >
8875 :set tb=icons,text
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01008876< Motif cannot display icons and text at the same time. They
Bram Moolenaar071d4272004-06-13 20:20:40 +00008877 will show icons if both are requested.
8878
8879 If none of the strings specified in 'toolbar' are valid or if
8880 'toolbar' is empty, this option is ignored. If you want to disable
8881 the toolbar, you need to set the 'guioptions' option. For example: >
8882 :set guioptions-=T
8883< Also see |gui-toolbar|.
8884
8885 *'toolbariconsize'* *'tbis'*
8886'toolbariconsize' 'tbis' string (default "small")
8887 global
Bram Moolenaar3df01732017-02-17 22:47:16 +01008888 {only in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008889 Controls the size of toolbar icons. The possible values are:
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008890 tiny Use tiny icons.
8891 small Use small icons (default).
8892 medium Use medium-sized icons.
8893 large Use large icons.
8894 huge Use even larger icons.
8895 giant Use very big icons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008896 The exact dimensions in pixels of the various icon sizes depend on
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008897 the current theme. Common dimensions are giant=48x48, huge=32x32,
8898 large=24x24, medium=24x24, small=20x20 and tiny=16x16.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008899
8900 If 'toolbariconsize' is empty, the global default size as determined
8901 by user preferences or the current theme is used.
8902
8903 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
8904'ttybuiltin' 'tbi' boolean (default on)
8905 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008906 When on, the builtin termcaps are searched before the external ones.
8907 When off the builtin termcaps are searched after the external ones.
8908 When this option is changed, you should set the 'term' option next for
8909 the change to take effect, for example: >
8910 :set notbi term=$TERM
8911< See also |termcap|.
8912 Rationale: The default for this option is "on", because the builtin
8913 termcap entries are generally better (many systems contain faulty
8914 xterm entries...).
8915
8916 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
Bram Moolenaarc1cf4c92022-11-25 15:09:35 +00008917'ttyfast' 'tf' boolean (default on)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008918 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008919 Indicates a fast terminal connection. More characters will be sent to
8920 the screen for redrawing, instead of using insert/delete line
8921 commands. Improves smoothness of redrawing when there are multiple
8922 windows and the terminal does not support a scrolling region.
8923 Also enables the extra writing of characters at the end of each screen
8924 line for lines that wrap. This helps when using copy/paste with the
8925 mouse in an xterm and other terminals.
8926
Bram Moolenaarc1cf4c92022-11-25 15:09:35 +00008927 The default used to be set only for some terminal names, but these
8928 days nearly all terminals are fast, therefore the default is now "on".
8929 If you have a slow connection you may want to set this option off,
8930 e.g. depending on the host name: >
8931 if hostname() =~ 'faraway'
8932 set nottyfast
8933 endif
8934<
Bram Moolenaar071d4272004-06-13 20:20:40 +00008935 *'ttymouse'* *'ttym'*
8936'ttymouse' 'ttym' string (default depends on 'term')
8937 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008938 {only in Unix and VMS, doesn't work in the GUI; not
8939 available when compiled without |+mouse|}
8940 Name of the terminal type for which mouse codes are to be recognized.
Bram Moolenaar2c7a7632007-05-10 18:19:11 +00008941 Currently these strings are valid:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008942 *xterm-mouse*
8943 xterm xterm-like mouse handling. The mouse generates
8944 "<Esc>[Mscr", where "scr" is three bytes:
8945 "s" = button state
8946 "c" = column plus 33
8947 "r" = row plus 33
Bram Moolenaare968e362014-05-13 20:23:24 +02008948 This only works up to 223 columns! See "dec",
8949 "urxvt", and "sgr" for solutions.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008950 xterm2 Works like "xterm", but with the xterm reporting the
8951 mouse position while the mouse is dragged. This works
8952 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00008953 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00008954 work. See below for how Vim detects this
8955 automatically.
8956 *netterm-mouse*
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008957 netterm NetTerm mouse handling. A left mouse click generates
Bram Moolenaar071d4272004-06-13 20:20:40 +00008958 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008959 for the row and column. No other mouse events are
8960 supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008961 *dec-mouse*
8962 dec DEC terminal mouse handling. The mouse generates a
8963 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00008964 This is also available for an Xterm, if it was
8965 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00008966 *jsbterm-mouse*
8967 jsbterm JSB term mouse handling.
8968 *pterm-mouse*
8969 pterm QNX pterm mouse handling.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008970 *urxvt-mouse*
8971 urxvt Mouse handling for the urxvt (rxvt-unicode) terminal.
Bram Moolenaare968e362014-05-13 20:23:24 +02008972 The mouse works only if the terminal supports this
8973 encoding style, but it does not have 223 columns limit
8974 unlike "xterm" or "xterm2".
Bram Moolenaar9b451252012-08-15 17:43:31 +02008975 *sgr-mouse*
8976 sgr Mouse handling for the terminal that emits SGR-styled
Bram Moolenaare968e362014-05-13 20:23:24 +02008977 mouse reporting. The mouse works even in columns
8978 beyond 223. This option is backward compatible with
8979 "xterm2" because it can also decode "xterm2" style
8980 mouse codes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008981
8982 The mouse handling must be enabled at compile time |+mouse_xterm|
Bram Moolenaare968e362014-05-13 20:23:24 +02008983 |+mouse_dec| |+mouse_netterm| |+mouse_jsbterm| |+mouse_urxvt|
8984 |+mouse_sgr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008985 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
8986 recognized, if enabled at compile time. DEC terminal mouse codes
8987 are recognized if enabled at compile time, and 'ttymouse' is not
Bram Moolenaare968e362014-05-13 20:23:24 +02008988 "xterm", "xterm2", "urxvt" or "sgr" (because dec mouse codes conflict
8989 with them).
Bram Moolenaar071d4272004-06-13 20:20:40 +00008990 This option is automatically set to "xterm", when the 'term' option is
Bram Moolenaar45758762016-10-12 23:08:06 +02008991 set to a name that starts with "xterm", "mlterm", "screen", "tmux",
8992 "st" (full match only), "st-" or "stterm", and 'ttymouse' is not set
8993 already.
Bram Moolenaar06cd14d2023-01-10 12:37:38 +00008994 If the terminfo/termcap entry "XM" exists and the first number is
8995 "1006" then 'ttymouse' will be set to "sgr". This works for many
8996 modern terminals.
Bram Moolenaare968e362014-05-13 20:23:24 +02008997 Additionally, if vim is compiled with the |+termresponse| feature and
8998 |t_RV| is set to the escape sequence to request the xterm version
Bram Moolenaarf8a07122019-07-01 22:06:07 +02008999 number, more intelligent detection is done.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009000 The "xterm2" value will be set if the xterm version is reported to be
Bram Moolenaard47d5222018-12-09 20:43:55 +01009001 from 95 to 276. The "sgr" value will be set if Vim detects Mac
9002 Terminal.app, iTerm2 or mintty, and when the xterm version is 277 or
9003 higher.
Bram Moolenaare968e362014-05-13 20:23:24 +02009004 If you do not want 'ttymouse' to be set to "xterm2" or "sgr"
9005 automatically, set t_RV to an empty string: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00009006 :set t_RV=
9007<
9008 *'ttyscroll'* *'tsl'*
9009'ttyscroll' 'tsl' number (default 999)
9010 global
9011 Maximum number of lines to scroll the screen. If there are more lines
9012 to scroll the window is redrawn. For terminals where scrolling is
9013 very slow and redrawing is not slow this can be set to a small number,
9014 e.g., 3, to speed up displaying.
9015
9016 *'ttytype'* *'tty'*
9017'ttytype' 'tty' string (default from $TERM)
9018 global
9019 Alias for 'term', see above.
9020
Bram Moolenaar55debbe2010-05-23 23:34:36 +02009021 *'undodir'* *'udir'*
9022'undodir' 'udir' string (default ".")
9023 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02009024 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02009025 List of directory names for undo files, separated with commas.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02009026 See |'backupdir'| for details of the format.
Bram Moolenaar6a244fe2010-05-24 22:02:24 +02009027 "." means using the directory of the file. The undo file name for
9028 "file.txt" is ".file.txt.un~".
9029 For other directories the file name is the full path of the edited
9030 file, with path separators replaced with "%".
Bram Moolenaar55debbe2010-05-23 23:34:36 +02009031 When writing: The first directory that exists is used. "." always
9032 works, no directories after "." will be used for writing.
9033 When reading all entries are tried to find an undo file. The first
9034 undo file that exists is used. When it cannot be read an error is
9035 given, no further entry is used.
9036 See |undo-persistence|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02009037 This option cannot be set from a |modeline| or in the |sandbox|, for
9038 security reasons.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02009039
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02009040 *'undofile'* *'noundofile'* *'udf'* *'noudf'*
Bram Moolenaar55debbe2010-05-23 23:34:36 +02009041'undofile' 'udf' boolean (default off)
9042 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02009043 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02009044 When on, Vim automatically saves undo history to an undo file when
9045 writing a buffer to a file, and restores undo history from the same
9046 file on buffer read.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02009047 The directory where the undo file is stored is specified by 'undodir'.
9048 For more information about this feature see |undo-persistence|.
Bram Moolenaar59f931e2010-07-24 20:27:03 +02009049 The undo file is not read when 'undoreload' causes the buffer from
9050 before a reload to be saved for undo.
Bram Moolenaar97d62492012-11-15 21:28:22 +01009051 When 'undofile' is turned off the undo file is NOT deleted.
Bram Moolenaar036986f2017-03-16 17:41:02 +01009052 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02009053
Bram Moolenaar071d4272004-06-13 20:20:40 +00009054 *'undolevels'* *'ul'*
Bram Moolenaar8024f932020-01-14 19:29:13 +01009055'undolevels' 'ul' number (default 100, 1000 for Unix, VMS and Win32)
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01009056 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00009057 Maximum number of changes that can be undone. Since undo information
Bram Moolenaar5be4cee2019-09-27 19:34:08 +02009058 is kept in memory, higher numbers will cause more memory to be used.
9059 Nevertheless, a single change can already use a large amount of memory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009060 Set to 0 for Vi compatibility: One level of undo and "u" undoes
9061 itself: >
9062 set ul=0
9063< But you can also get Vi compatibility by including the 'u' flag in
9064 'cpoptions', and still be able to use CTRL-R to repeat undo.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02009065 Also see |undo-two-ways|.
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01009066 Set to -1 for no undo at all. You might want to do this only for the
9067 current buffer: >
9068 setlocal ul=-1
Bram Moolenaar071d4272004-06-13 20:20:40 +00009069< This helps when you run out of memory for a single change.
Bram Moolenaar32efaf62014-11-05 17:02:17 +01009070
9071 The local value is set to -123456 when the global value is to be used.
9072
Bram Moolenaar945e2db2010-06-05 17:43:32 +02009073 Also see |clear-undo|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009074
Bram Moolenaar59f931e2010-07-24 20:27:03 +02009075 *'undoreload'* *'ur'*
9076'undoreload' 'ur' number (default 10000)
9077 global
Bram Moolenaar59f931e2010-07-24 20:27:03 +02009078 Save the whole buffer for undo when reloading it. This applies to the
9079 ":e!" command and reloading for when the buffer changed outside of
9080 Vim. |FileChangedShell|
Bram Moolenaar24a98a02017-09-27 22:23:55 +02009081 The save only happens when this option is negative or when the number
Bram Moolenaar59f931e2010-07-24 20:27:03 +02009082 of lines is smaller than the value of this option.
9083 Set this option to zero to disable undo for a reload.
9084
9085 When saving undo for a reload, any undo file is not read.
9086
9087 Note that this causes the whole buffer to be stored in memory. Set
9088 this option to a lower value if you run out of memory.
9089
Bram Moolenaar071d4272004-06-13 20:20:40 +00009090 *'updatecount'* *'uc'*
9091'updatecount' 'uc' number (default: 200)
9092 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009093 After typing this many characters the swap file will be written to
9094 disk. When zero, no swap file will be created at all (see chapter on
9095 recovery |crash-recovery|). 'updatecount' is set to zero by starting
9096 Vim with the "-n" option, see |startup|. When editing in readonly
9097 mode this option will be initialized to 10000.
9098 The swapfile can be disabled per buffer with |'swapfile'|.
9099 When 'updatecount' is set from zero to non-zero, swap files are
9100 created for all buffers that have 'swapfile' set. When 'updatecount'
9101 is set to zero, existing swap files are not deleted.
9102 Also see |'swapsync'|.
9103 This option has no meaning in buffers where |'buftype'| is "nofile"
9104 or "nowrite".
9105
9106 *'updatetime'* *'ut'*
9107'updatetime' 'ut' number (default 4000)
9108 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009109 If this many milliseconds nothing is typed the swap file will be
9110 written to disk (see |crash-recovery|). Also used for the
9111 |CursorHold| autocommand event.
9112
Bram Moolenaar04958cb2018-06-23 19:23:02 +02009113 *'varsofttabstop'* *'vsts'*
9114'varsofttabstop' 'vsts' string (default "")
9115 local to buffer
9116 {only available when compiled with the |+vartabs|
9117 feature}
Bram Moolenaar04958cb2018-06-23 19:23:02 +02009118 A list of the number of spaces that a <Tab> counts for while editing,
9119 such as inserting a <Tab> or using <BS>. It "feels" like variable-
9120 width <Tab>s are being inserted, while in fact a mixture of spaces
9121 and <Tab>s is used. Tab widths are separated with commas, with the
9122 final value applying to all subsequent tabs.
9123
9124 For example, when editing assembly language files where statements
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02009125 start in the 9th column and comments in the 41st, it may be useful
Bram Moolenaar04958cb2018-06-23 19:23:02 +02009126 to use the following: >
9127 :set varsofttabstop=8,32,8
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02009128< This will set soft tabstops with 8 and 8 + 32 spaces, and 8 more
9129 for every column thereafter.
Bram Moolenaar04958cb2018-06-23 19:23:02 +02009130
9131 Note that the value of |'softtabstop'| will be ignored while
9132 'varsofttabstop' is set.
9133
9134 *'vartabstop'* *'vts'*
9135'vartabstop' 'vts' string (default "")
9136 local to buffer
9137 {only available when compiled with the |+vartabs|
9138 feature}
Bram Moolenaar04958cb2018-06-23 19:23:02 +02009139 A list of the number of spaces that a <Tab> in the file counts for,
9140 separated by commas. Each value corresponds to one tab, with the
9141 final value applying to all subsequent tabs. For example: >
9142 :set vartabstop=4,20,10,8
9143< This will make the first tab 4 spaces wide, the second 20 spaces,
9144 the third 10 spaces, and all following tabs 8 spaces.
9145
9146 Note that the value of |'tabstop'| will be ignored while 'vartabstop'
9147 is set.
9148
Bram Moolenaar071d4272004-06-13 20:20:40 +00009149 *'verbose'* *'vbs'*
9150'verbose' 'vbs' number (default 0)
9151 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009152 When bigger than zero, Vim will give messages about what it is doing.
9153 Currently, these messages are given:
9154 >= 1 When the viminfo file is read or written.
9155 >= 2 When a file is ":source"'ed.
Bram Moolenaar647a5302020-05-03 17:01:24 +02009156 >= 4 Shell commands.
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00009157 >= 5 Every searched tags file and include file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009158 >= 8 Files for which a group of autocommands is executed.
9159 >= 9 Every executed autocommand.
Bram Moolenaar647a5302020-05-03 17:01:24 +02009160 >= 11 Finding items in a path
Bram Moolenaar071d4272004-06-13 20:20:40 +00009161 >= 12 Every executed function.
9162 >= 13 When an exception is thrown, caught, finished, or discarded.
9163 >= 14 Anything pending in a ":finally" clause.
Bram Moolenaar823654b2020-05-29 23:03:09 +02009164 >= 15 Every executed Ex command from a script (truncated at 200
9165 characters).
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02009166 >= 16 Every executed Ex command.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009167
9168 This option can also be set with the "-V" argument. See |-V|.
9169 This option is also set by the |:verbose| command.
9170
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00009171 When the 'verbosefile' option is set then the verbose messages are not
9172 displayed.
9173
9174 *'verbosefile'* *'vfile'*
9175'verbosefile' 'vfile' string (default empty)
9176 global
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00009177 When not empty all messages are written in a file with this name.
9178 When the file exists messages are appended.
9179 Writing to the file ends when Vim exits or when 'verbosefile' is made
Bram Moolenaar80794b12010-06-13 05:20:42 +02009180 empty. Writes are buffered, thus may not show up for some time.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00009181 Setting 'verbosefile' to a new value is like making it empty first.
9182 The difference with |:redir| is that verbose messages are not
9183 displayed when 'verbosefile' is set.
dkearns8ebdbc92023-10-29 06:26:19 +11009184 This option cannot be set from a |modeline| or in the |sandbox|, for
9185 security reasons.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00009186
Bram Moolenaar071d4272004-06-13 20:20:40 +00009187 *'viewdir'* *'vdir'*
h_east59858792023-10-25 22:47:05 +09009188'viewdir' 'vdir' string (default for Amiga: "home:vimfiles/view",
Bram Moolenaar801961d2023-06-23 16:15:13 +01009189 for Win32: "$HOME/vimfiles/view",
Christian Brabandtc3e6e392024-05-04 09:48:15 +02009190 for Unix: "$HOME/.vim/view" or
9191 "$XDG_CONFIG_HOME/vim/view"
Bram Moolenaar801961d2023-06-23 16:15:13 +01009192 for VMS: "sys$login:vimfiles/view")
Bram Moolenaar071d4272004-06-13 20:20:40 +00009193 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02009194 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00009195 feature}
9196 Name of the directory where to store files for |:mkview|.
Christian Brabandtc3e6e392024-05-04 09:48:15 +02009197 For $XDG_CONFIG_HOME see |xdg-base-dir|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009198 This option cannot be set from a |modeline| or in the |sandbox|, for
9199 security reasons.
9200
9201 *'viewoptions'* *'vop'*
Bram Moolenaar13e90412017-11-11 18:16:48 +01009202'viewoptions' 'vop' string (default: "folds,options,cursor,curdir")
Bram Moolenaar071d4272004-06-13 20:20:40 +00009203 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02009204 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00009205 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01009206 Changes the effect of the |:mkview| command. It is a comma-separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009207 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00009208 word save and restore ~
9209 cursor cursor position in file and in window
9210 folds manually created folds, opened/closed folds and local
9211 fold options
9212 options options and mappings local to a window or buffer (not
9213 global values for local options)
Bram Moolenaar6e932462014-09-09 18:48:09 +02009214 localoptions same as "options"
Bram Moolenaar071d4272004-06-13 20:20:40 +00009215 slash backslashes in file names replaced with forward
9216 slashes
9217 unix with Unix end-of-line format (single <NL>), even when
Bram Moolenaar6f345a12019-12-17 21:27:18 +01009218 on MS-Windows
Bram Moolenaar13e90412017-11-11 18:16:48 +01009219 curdir the window-local directory, if set with `:lcd`
Bram Moolenaar071d4272004-06-13 20:20:40 +00009220
Bram Moolenaar6f345a12019-12-17 21:27:18 +01009221 "slash" and "unix" are useful on MS-Windows when sharing view files
Bram Moolenaar071d4272004-06-13 20:20:40 +00009222 with Unix. The Unix version of Vim cannot source dos format scripts,
Bram Moolenaar6f345a12019-12-17 21:27:18 +01009223 but the MS-Windows version of Vim can source unix format scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009224
9225 *'viminfo'* *'vi'* *E526* *E527* *E528*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01009226'viminfo' 'vi' string (Vi default: "", Vim default for
9227 MS-Windows: '100,<50,s10,h,rA:,rB:,
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01009228 for Amiga: '100,<50,s10,h,rdf0:,rdf1:,rdf2:
9229 for others: '100,<50,s10,h)
Bram Moolenaar071d4272004-06-13 20:20:40 +00009230 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02009231 {not available when compiled without the |+viminfo|
Bram Moolenaar071d4272004-06-13 20:20:40 +00009232 feature}
9233 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarc4da1132017-07-15 19:39:43 +02009234 when exiting Vim (see |viminfo-file|). Except when 'viminfofile' is
9235 "NONE".
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01009236 The string should be a comma-separated list of parameters, each
Bram Moolenaarc4da1132017-07-15 19:39:43 +02009237 consisting of a single character identifying the particular parameter,
9238 followed by a number or string which specifies the value of that
9239 parameter. If a particular character is left out, then the default
9240 value is used for that parameter. The following is a list of the
9241 identifying characters and the effect of their value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009242 CHAR VALUE ~
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009243 *viminfo-!*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009244 ! When included, save and restore global variables that start
9245 with an uppercase letter, and don't contain a lowercase
9246 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar680eeca2010-10-20 17:44:42 +02009247 and "_K_L_M" are not. Nested List and Dict items may not be
Bram Moolenaar166af9b2010-11-16 20:34:40 +01009248 read back correctly, you end up with an empty item.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009249 *viminfo-quote*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009250 " Maximum number of lines saved for each register. Old name of
9251 the '<' item, with the disadvantage that you need to put a
9252 backslash before the ", otherwise it will be recognized as the
9253 start of a comment!
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009254 *viminfo-%*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009255 % When included, save and restore the buffer list. If Vim is
9256 started with a file name argument, the buffer list is not
9257 restored. If Vim is started without a file name argument, the
Bram Moolenaard042dc82015-11-24 19:18:36 +01009258 buffer list is restored from the viminfo file. Quickfix
9259 ('buftype'), unlisted ('buflisted'), unnamed and buffers on
9260 removable media (|viminfo-r|) are not saved.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00009261 When followed by a number, the number specifies the maximum
9262 number of buffers that are stored. Without a number all
9263 buffers are stored.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009264 *viminfo-'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009265 ' Maximum number of previously edited files for which the marks
9266 are remembered. This parameter must always be included when
9267 'viminfo' is non-empty.
9268 Including this item also means that the |jumplist| and the
9269 |changelist| are stored in the viminfo file.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009270 *viminfo-/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009271 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009272 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00009273 patterns are also saved. When not included, the value of
9274 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009275 *viminfo-:*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009276 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009277 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009278 *viminfo-<*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009279 < Maximum number of lines saved for each register. If zero then
9280 registers are not saved. When not included, all lines are
9281 saved. '"' is the old name for this item.
9282 Also see the 's' item below: limit specified in Kbyte.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009283 *viminfo-@*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009284 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009285 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009286 *viminfo-c*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009287 c When included, convert the text in the viminfo file from the
9288 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00009289 'encoding'. See |viminfo-encoding|.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009290 *viminfo-f*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009291 f Whether file marks need to be stored. If zero, file marks ('0
9292 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009293 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00009294 cursor position (when exiting or when doing ":wviminfo").
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009295 *viminfo-h*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009296 h Disable the effect of 'hlsearch' when loading the viminfo
9297 file. When not included, it depends on whether ":nohlsearch"
9298 has been used since the last search command.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009299 *viminfo-n*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009300 n Name of the viminfo file. The name must immediately follow
Bram Moolenaarc4da1132017-07-15 19:39:43 +02009301 the 'n'. Must be at the end of the option! If the
9302 'viminfofile' option is set, that file name overrides the one
9303 given here with 'viminfo'. Environment variables are
Bram Moolenaar063b9d12016-07-09 20:21:48 +02009304 expanded when opening the file, not when setting the option.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009305 *viminfo-r*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009306 r Removable media. The argument is a string (up to the next
9307 ','). This parameter can be given several times. Each
9308 specifies the start of a path for which no marks will be
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01009309 stored. This is to avoid removable media. For MS-Windows you
Bram Moolenaar071d4272004-06-13 20:20:40 +00009310 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
9311 also use it for temp files, e.g., for Unix: "r/tmp". Case is
9312 ignored. Maximum length of each 'r' argument is 50
9313 characters.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009314 *viminfo-s*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009315 s Maximum size of an item in Kbyte. If zero then registers are
9316 not saved. Currently only applies to registers. The default
9317 "s10" will exclude registers with more than 10 Kbyte of text.
9318 Also see the '<' item above: line count limit.
9319
9320 Example: >
9321 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
9322<
9323 '50 Marks will be remembered for the last 50 files you
9324 edited.
9325 <1000 Contents of registers (up to 1000 lines each) will be
9326 remembered.
9327 s100 Registers with more than 100 Kbyte text are skipped.
9328 :0 Command-line history will not be saved.
9329 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
9330 no / Since '/' is not specified, the default will be used,
9331 that is, save all of the search history, and also the
9332 previous search and substitute patterns.
9333 no % The buffer list will not be saved nor read back.
9334 no h 'hlsearch' highlighting will be restored.
9335
9336 When setting 'viminfo' from an empty value you can use |:rviminfo| to
9337 load the contents of the file, this is not done automatically.
9338
9339 This option cannot be set from a |modeline| or in the |sandbox|, for
9340 security reasons.
Bram Moolenaar036986f2017-03-16 17:41:02 +01009341 NOTE: This option is set to the Vim default value when 'compatible'
9342 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009343
Bram Moolenaarc4da1132017-07-15 19:39:43 +02009344 *'viminfofile'* *'vif'*
9345'viminfofile' 'vif' string (default: "")
9346 global
Bram Moolenaarc4da1132017-07-15 19:39:43 +02009347 {not available when compiled without the |+viminfo|
9348 feature}
9349 When non-empty, overrides the file name used for viminfo.
9350 When equal to "NONE" no viminfo file will be read or written.
9351 This option can be set with the |-i| command line flag. The |--clean|
9352 command line flag sets it to "NONE".
Bram Moolenaar110289e2019-05-23 15:38:06 +02009353 This option cannot be set from a |modeline| or in the |sandbox|, for
9354 security reasons.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02009355
Bram Moolenaar071d4272004-06-13 20:20:40 +00009356 *'virtualedit'* *'ve'*
9357'virtualedit' 've' string (default "")
Gary Johnson51ad8502021-08-03 18:33:08 +02009358 global or local to window |global-local|
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01009359 A comma-separated list of these words:
Bram Moolenaar071d4272004-06-13 20:20:40 +00009360 block Allow virtual editing in Visual block mode.
9361 insert Allow virtual editing in Insert mode.
9362 all Allow virtual editing in all modes.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00009363 onemore Allow the cursor to move just past the end of the line
Gary Johnson53ba05b2021-07-26 22:19:10 +02009364 none When used as the local value, do not allow virtual
9365 editing even when the global value is set. When used
9366 as the global value, "none" is the same as "".
9367 NONE Alternative spelling of "none".
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009368
Bram Moolenaar071d4272004-06-13 20:20:40 +00009369 Virtual editing means that the cursor can be positioned where there is
Bram Moolenaarebcbd022007-05-12 14:28:25 +00009370 no actual character. This can be halfway into a tab or beyond the end
Bram Moolenaar071d4272004-06-13 20:20:40 +00009371 of the line. Useful for selecting a rectangle in Visual mode and
9372 editing a table.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00009373 "onemore" is not the same, it will only allow moving the cursor just
9374 after the last character of the line. This makes some commands more
9375 consistent. Previously the cursor was always past the end of the line
9376 if the line was empty. But it is far from Vi compatible. It may also
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009377 break some plugins or Vim scripts. For example because |l| can move
9378 the cursor after the last character. Use with care!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02009379 Using the `$` command will move to the last character in the line, not
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009380 past it. This may actually move the cursor to the left!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02009381 The `g$` command will move to the end of the screen line.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00009382 It doesn't make sense to combine "all" with "onemore", but you will
9383 not get a warning for it.
Bram Moolenaar53f7fcc2021-07-28 20:10:16 +02009384 When combined with other words, "none" is ignored.
Bram Moolenaar036986f2017-03-16 17:41:02 +01009385 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009386
9387 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
9388'visualbell' 'vb' boolean (default off)
9389 global
Bram Moolenaar74675a62017-07-15 13:53:23 +02009390 Use a visual bell instead of beeping. The terminal code to display the
Bram Moolenaar071d4272004-06-13 20:20:40 +00009391 visual bell is given with 't_vb'. When no beep or flash is wanted,
Bram Moolenaar74675a62017-07-15 13:53:23 +02009392 use: >
9393 :set vb t_vb=
9394< If you want a short flash, you can use this on many terminals: >
9395 :set vb t_vb=[?5h$<100>[?5l
9396< Here $<100> specifies the time, you can use a smaller or bigger value
9397 to get a shorter or longer flash.
9398
9399 Note: Vim will limit the bell to once per half a second. This avoids
9400 having to wait for the flashing to finish when there are lots of
9401 bells, e.g. on key repeat. This also happens without 'visualbell'
9402 set.
9403
Bram Moolenaar071d4272004-06-13 20:20:40 +00009404 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
9405 for 20 msec. If you want to use a different time, use "<Esc>|40f",
9406 where 40 is the time in msec.
Bram Moolenaar74675a62017-07-15 13:53:23 +02009407
9408 Note: When the GUI starts, 't_vb' is reset to its default value. You
9409 might want to set it again in your |gvimrc|.
9410
Bram Moolenaar071d4272004-06-13 20:20:40 +00009411 Does not work on the Amiga, you always get a screen flash.
9412 Also see 'errorbells'.
9413
9414 *'warn'* *'nowarn'*
9415'warn' boolean (default on)
9416 global
9417 Give a warning message when a shell command is used while the buffer
9418 has been changed.
9419
9420 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
9421'weirdinvert' 'wiv' boolean (default off)
9422 global
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00009423 This option has the same effect as the 't_xs' terminal option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009424 It is provided for backwards compatibility with version 4.x.
9425 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
9426 vice versa. Has no effect when the GUI is running.
9427
9428 *'whichwrap'* *'ww'*
9429'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
9430 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009431 Allow specified keys that move the cursor left/right to move to the
9432 previous/next line when the cursor is on the first/last character in
9433 the line. Concatenate characters to allow this for these keys:
9434 char key mode ~
9435 b <BS> Normal and Visual
9436 s <Space> Normal and Visual
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00009437 h "h" Normal and Visual (not recommended)
9438 l "l" Normal and Visual (not recommended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00009439 < <Left> Normal and Visual
9440 > <Right> Normal and Visual
9441 ~ "~" Normal
9442 [ <Left> Insert and Replace
9443 ] <Right> Insert and Replace
9444 For example: >
9445 :set ww=<,>,[,]
9446< allows wrap only when cursor keys are used.
9447 When the movement keys are used in combination with a delete or change
9448 operator, the <EOL> also counts for a character. This makes "3h"
9449 different from "3dh" when the cursor crosses the end of a line. This
9450 is also true for "x" and "X", because they do the same as "dl" and
9451 "dh". If you use this, you may also want to use the mapping
9452 ":map <BS> X" to make backspace delete the character in front of the
9453 cursor.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00009454 When 'l' is included and it is used after an operator at the end of a
Bram Moolenaar589edb32019-09-20 14:38:13 +02009455 line (not an empty line) then it will not move to the next line. This
9456 makes "dl", "cl", "yl" etc. work normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009457 NOTE: This option is set to the Vi default value when 'compatible' is
9458 set and to the Vim default value when 'compatible' is reset.
9459
9460 *'wildchar'* *'wc'*
9461'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
9462 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009463 Character you have to type to start wildcard expansion in the
9464 command-line, as specified with 'wildmode'.
Bram Moolenaar446cb832008-06-24 21:56:24 +00009465 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009466 The character is not recognized when used inside a macro. See
9467 'wildcharm' for that.
Bram Moolenaar34cc7d82021-09-21 20:09:51 +02009468 Some keys will not work, such as CTRL-C, <CR> and Enter.
Yee Cheng Chin8f4fb002023-10-17 10:06:56 +02009469 <Esc> can be used, but hitting it twice in a row will still exit
9470 command-line as a failsafe measure.
Millya9c6f902024-10-06 16:47:02 +02009471 Although 'wc' is a number option, it can be specified as a number, a
9472 single character, a |key-notation| (e.g. <Up>, <C-F>) or a letter
9473 preceded with a caret (e.g. `^F` is CTRL-F): >
9474 :set wc=27
9475 :set wc=X
9476 :set wc=^I
Bram Moolenaar34cc7d82021-09-21 20:09:51 +02009477 :set wc=<Tab>
Bram Moolenaar071d4272004-06-13 20:20:40 +00009478< NOTE: This option is set to the Vi default value when 'compatible' is
9479 set and to the Vim default value when 'compatible' is reset.
9480
9481 *'wildcharm'* *'wcm'*
9482'wildcharm' 'wcm' number (default: none (0))
9483 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009484 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00009485 recognized when used inside a macro. You can find "spare" command-line
9486 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00009487 you'll never actually type 'wildcharm', just use it in mappings that
9488 automatically invoke completion mode, e.g.: >
9489 :set wcm=<C-Z>
Bram Moolenaar446cb832008-06-24 21:56:24 +00009490 :cnoremap ss so $vim/sessions/*.vim<C-Z>
Bram Moolenaar071d4272004-06-13 20:20:40 +00009491< Then after typing :ss you can use CTRL-P & CTRL-N.
9492
9493 *'wildignore'* *'wig'*
9494'wildignore' 'wig' string (default "")
9495 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009496 A list of file patterns. A file that matches with one of these
Bram Moolenaar30b65812012-07-12 22:01:11 +02009497 patterns is ignored when expanding |wildcards|, completing file or
9498 directory names, and influences the result of |expand()|, |glob()| and
9499 |globpath()| unless a flag is passed to disable this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009500 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
9501 Also see 'suffixes'.
9502 Example: >
9503 :set wildignore=*.o,*.obj
9504< The use of |:set+=| and |:set-=| is preferred when adding or removing
9505 a pattern from the list. This avoids problems when a future version
9506 uses another default.
9507
h_east596a9f22023-11-21 21:24:23 +09009508 *'wildignorecase'* *'wic'* *'nowildignorecase'* *'nowic'*
Bram Moolenaar94950a92010-12-02 16:01:29 +01009509'wildignorecase' 'wic' boolean (default off)
9510 global
Bram Moolenaar94950a92010-12-02 16:01:29 +01009511 When set case is ignored when completing file names and directories.
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01009512 Has no effect when 'fileignorecase' is set.
Bram Moolenaar94950a92010-12-02 16:01:29 +01009513 Does not apply when the shell is used to expand wildcards, which
9514 happens when there are special characters.
9515
Bram Moolenaar071d4272004-06-13 20:20:40 +00009516 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
Luca Saccarola437bc132024-11-14 21:21:17 +01009517'wildmenu' 'wmnu' boolean (default on)
Bram Moolenaar071d4272004-06-13 20:20:40 +00009518 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009519 When 'wildmenu' is on, command-line completion operates in an enhanced
9520 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
Bram Moolenaar54162322022-08-26 16:58:51 +01009521 the possible matches are shown.
9522 When 'wildoptions' contains "pum", then the completion matches are
9523 shown in a popup menu. Otherwise they are displayed just above the
9524 command line, with the first match highlighted (overwriting the status
9525 line, if there is one).
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009526 Keys that show the previous/next match, such as <Tab> or
Bram Moolenaar071d4272004-06-13 20:20:40 +00009527 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
9528 When 'wildmode' is used, "wildmenu" mode is used where "full" is
9529 specified. "longest" and "list" do not start "wildmenu" mode.
Bram Moolenaar26402cb2013-02-20 21:26:00 +01009530 You can check the current mode with |wildmenumode()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009531 If there are more matches than can fit in the line, a ">" is shown on
9532 the right and/or a "<" is shown on the left. The status line scrolls
9533 as needed.
9534 The "wildmenu" mode is abandoned when a key is hit that is not used
9535 for selecting a completion.
Yee Cheng Chin2bbd0d32023-10-14 02:23:45 -07009536 While the "wildmenu" is active, the following keys have special
9537 meanings:
9538 CTRL-P - go to the previous entry
9539 CTRL-N - go to the next entry
Bram Moolenaar071d4272004-06-13 20:20:40 +00009540 <CR> - in menu completion, when the cursor is just after a
9541 dot: move into a submenu.
Yee Cheng Chin209ec902023-10-17 10:56:25 +02009542 CTRL-E - end completion, go back to what was there before
9543 selecting a match.
9544 CTRL-Y - accept the currently selected match and stop
9545 completion.
Yee Cheng Chin2bbd0d32023-10-14 02:23:45 -07009546
9547 When not using the popup menu for command line completion, the
9548 following keys have special meanings:
9549 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
Bram Moolenaar071d4272004-06-13 20:20:40 +00009550 <Up> - in filename/menu name completion: move up into
9551 parent directory or parent menu.
Yee Cheng Chin2bbd0d32023-10-14 02:23:45 -07009552 <Down> - in filename/menu name completion: move into a
9553 subdirectory or submenu.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009554
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009555 When using the popup menu for command line completion, the following
9556 keys have special meanings:
Yee Cheng Chin2bbd0d32023-10-14 02:23:45 -07009557 <Up> <Down> - select previous/next match (like CTRL-P/CTRL-N)
zeertzjq3c81f472023-10-15 16:02:08 +08009558 <PageUp> - select a match several entries back
9559 <PageDown> - select a match several entries further
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009560 <Left> - in filename/menu name completion: move up into
9561 parent directory or parent menu.
9562 <Right> - in filename/menu name completion: move into a
9563 subdirectory or submenu.
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009564
Bram Moolenaar071d4272004-06-13 20:20:40 +00009565 This makes the menus accessible from the console |console-menus|.
9566
9567 If you prefer the <Left> and <Right> keys to move the cursor instead
9568 of selecting a different match, use this: >
9569 :cnoremap <Left> <Space><BS><Left>
9570 :cnoremap <Right> <Space><BS><Right>
9571<
9572 The "WildMenu" highlighting is used for displaying the current match
9573 |hl-WildMenu|.
9574
9575 *'wildmode'* *'wim'*
9576'wildmode' 'wim' string (Vim default: "full")
9577 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009578 Completion mode that is used for the character specified with
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01009579 'wildchar'. It is a comma-separated list of up to four parts. Each
Bram Moolenaar02467872007-05-06 13:22:01 +00009580 part specifies what to do for each consecutive use of 'wildchar'. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00009581 first part specifies the behavior for the first use of 'wildchar',
9582 The second part for the second use, etc.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009583
9584 Each part consists of a colon separated list consisting of the
9585 following possible values:
Bram Moolenaar071d4272004-06-13 20:20:40 +00009586 "" Complete only the first match.
9587 "full" Complete the next full match. After the last match,
9588 the original string is used and then the first match
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009589 again. Will also start 'wildmenu' if it is enabled.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009590 "longest" Complete till longest common string. If this doesn't
9591 result in a longer string, use the next part.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009592 "list" When more than one match, list all matches.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009593 "lastused" When completing buffer names and more than one buffer
9594 matches, sort buffers by time last used (other than
9595 the current buffer).
Girish Palya2bacc3e2025-03-02 22:55:57 +01009596 "noselect" Do not pre-select first menu item and start 'wildmenu'
9597 if it is enabled.
9598 When there is only a single match, it is fully completed in all cases
9599 except when "noselect" is present.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009600
9601 Examples of useful colon-separated values:
9602 "longest:full" Like "longest", but also start 'wildmenu' if it is
9603 enabled. Will not complete to the next full match.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009604 "list:full" When more than one match, list all matches and
9605 complete first match.
9606 "list:longest" When more than one match, list all matches and
9607 complete till longest common string.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009608 "list:lastused" When more than one buffer matches, list all matches
9609 and sort buffers by time last used (other than the
9610 current buffer).
Bram Moolenaar071d4272004-06-13 20:20:40 +00009611
9612 Examples: >
9613 :set wildmode=full
Bram Moolenaar582fd852005-03-28 20:58:01 +00009614< Complete first full match, next match, etc. (the default) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00009615 :set wildmode=longest,full
9616< Complete longest common string, then each full match >
9617 :set wildmode=list:full
9618< List all matches and complete each full match >
9619 :set wildmode=list,full
9620< List all matches without completing, then each full match >
9621 :set wildmode=longest,list
Girish Palya2bacc3e2025-03-02 22:55:57 +01009622< Complete longest common string, then list alternatives >
9623 :set wildmode=noselect:full
9624< Display 'wildmenu' without completing, then each full match >
9625 :set wildmode=noselect:lastused,full
9626< Same as above, but sort buffers by time last used.
Bram Moolenaar446cb832008-06-24 21:56:24 +00009627 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009628
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009629 *'wildoptions'* *'wop'*
9630'wildoptions' 'wop' string (default "")
9631 global
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009632 A list of words that change how |cmdline-completion| is done.
9633 The following values are supported:
Bram Moolenaar1588bc82022-03-08 21:35:07 +00009634 fuzzy Use |fuzzy-matching| to find completion matches. When
Yegappan Lakshmanan38b85cb2022-02-24 13:28:41 +00009635 this value is specified, wildcard expansion will not
9636 be used for completion. The matches will be sorted by
9637 the "best match" rather than alphabetically sorted.
9638 This will find more matches than the wildcard
9639 expansion. Currently fuzzy matching based completion
9640 is not supported for file and directory names and
9641 instead wildcard expansion is used.
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01009642 pum Display the completion matches using the popup menu
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009643 in the same style as the |ins-completion-menu|.
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009644 tagfile When using CTRL-D to list matching tags, the kind of
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00009645 tag and the file of the tag is listed. Only one match
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009646 is displayed per line. Often used tag kinds are:
9647 d #define
9648 f function
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009649
Bram Moolenaar071d4272004-06-13 20:20:40 +00009650 *'winaltkeys'* *'wak'*
9651'winaltkeys' 'wak' string (default "menu")
9652 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009653 {only used in Win32, Motif, GTK and Photon GUI}
9654 Some GUI versions allow the access to menu entries by using the ALT
9655 key in combination with a character that appears underlined in the
9656 menu. This conflicts with the use of the ALT key for mappings and
9657 entering special characters. This option tells what to do:
9658 no Don't use ALT keys for menus. ALT key combinations can be
9659 mapped, but there is no automatic handling. This can then be
9660 done with the |:simalt| command.
9661 yes ALT key handling is done by the windowing system. ALT key
9662 combinations cannot be mapped.
9663 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009664 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00009665 keys can be mapped.
9666 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
9667 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00009668 This option is not used for <F10>; on Win32 and with GTK <F10> will
9669 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009670
Bram Moolenaar4d784b22019-05-25 19:51:39 +02009671 *'wincolor'* *'wcr'*
9672'wincolor' 'wcr' string (default empty)
9673 local to window
9674 Highlight group name to use for this window instead of the Normal
9675 color |hl-Normal|.
9676
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009677 *'window'* *'wi'*
9678'window' 'wi' number (default screen height - 1)
9679 global
Bram Moolenaardad44732021-03-31 20:07:33 +02009680 Window height used for |CTRL-F| and |CTRL-B| when there is only one
9681 window and the value is smaller than 'lines' minus one. The screen
9682 will scroll 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009683 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
9684 in a much smarter way, taking care of wrapping lines.
Luuk van Baal5a2e3ec2024-03-28 10:07:29 +01009685 When resizing the Vim window, and the value is smaller than 1 or more
9686 than or equal to 'lines' it will be set to 'lines' minus 1.
Bram Moolenaardad44732021-03-31 20:07:33 +02009687 Note: Do not confuse this with the height of the Vim window, use
9688 'lines' for that.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009689
Colin Kennedy21570352024-03-03 16:16:47 +01009690 *'winfixbuf'*
9691'winfixbuf' 'wfb' boolean (default off)
9692 local to window
zeertzjq0049a492024-03-11 23:13:16 +08009693 If enabled, the window and the buffer it is displaying are paired.
Colin Kennedy21570352024-03-03 16:16:47 +01009694 For example, attempting to change the buffer with |:edit| will fail.
9695 Other commands which change a window's buffer such as |:cnext| will
zeertzjq0049a492024-03-11 23:13:16 +08009696 also skip any window with 'winfixbuf' enabled. However if an Ex
9697 command has a "!" modifier, it can force switching buffers.
Colin Kennedy21570352024-03-03 16:16:47 +01009698
laburnumT3f7855a2023-12-05 18:37:03 +01009699 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
9700'winfixheight' 'wfh' boolean (default off)
9701 local to window |local-noglobal|
9702 Keep the window height when windows are opened or closed and
9703 'equalalways' is set. Also for |CTRL-W_=|. Set by default for the
9704 |preview-window| and |quickfix-window|.
9705 The height may be changed anyway when running out of room.
9706
9707 *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'*
9708'winfixwidth' 'wfw' boolean (default off)
9709 local to window |local-noglobal|
9710 Keep the window width when windows are opened or closed and
9711 'equalalways' is set. Also for |CTRL-W_=|.
9712 The width may be changed anyway when running out of room.
9713
Bram Moolenaar071d4272004-06-13 20:20:40 +00009714 *'winheight'* *'wh'* *E591*
9715'winheight' 'wh' number (default 1)
9716 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009717 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009718 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar446cb832008-06-24 21:56:24 +00009719 focus goes to a window that is smaller, its size is increased, at the
9720 cost of the height of other windows.
9721 Set 'winheight' to a small number for normal editing.
9722 Set it to 999 to make the current window fill most of the screen.
9723 Other windows will be only 'winminheight' high. This has the drawback
9724 that ":all" will create only two windows. To avoid "vim -o 1 2 3 4"
9725 to create only two windows, set the option after startup is done,
9726 using the |VimEnter| event: >
9727 au VimEnter * set winheight=999
9728< Minimum value is 1.
9729 The height is not adjusted after one of the commands that change the
Bram Moolenaar071d4272004-06-13 20:20:40 +00009730 height of the current window.
9731 'winheight' applies to the current window. Use 'winminheight' to set
9732 the minimal height for other windows.
9733
Bram Moolenaar071d4272004-06-13 20:20:40 +00009734 *'winminheight'* *'wmh'*
9735'winminheight' 'wmh' number (default 1)
9736 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009737 The minimal height of a window, when it's not the current window.
9738 This is a hard minimum, windows will never become smaller.
9739 When set to zero, windows may be "squashed" to zero lines (i.e. just a
9740 status bar) if necessary. They will return to at least one line when
9741 they become active (since the cursor has to have somewhere to go.)
9742 Use 'winheight' to set the minimal height of the current window.
9743 This option is only checked when making a window smaller. Don't use a
9744 large number, it will cause errors when opening more than a few
9745 windows. A value of 0 to 3 is reasonable.
9746
9747 *'winminwidth'* *'wmw'*
9748'winminwidth' 'wmw' number (default 1)
9749 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009750 The minimal width of a window, when it's not the current window.
9751 This is a hard minimum, windows will never become smaller.
9752 When set to zero, windows may be "squashed" to zero columns (i.e. just
9753 a vertical separator) if necessary. They will return to at least one
9754 line when they become active (since the cursor has to have somewhere
9755 to go.)
9756 Use 'winwidth' to set the minimal width of the current window.
9757 This option is only checked when making a window smaller. Don't use a
9758 large number, it will cause errors when opening more than a few
9759 windows. A value of 0 to 12 is reasonable.
9760
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009761 *'winptydll'*
9762'winptydll' string (default "winpty32.dll" or "winpty64.dll")
9763 global
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009764 {only available when compiled with the |terminal|
9765 feature on MS-Windows}
9766 Specifies the name of the winpty shared library, used for the
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02009767 |:terminal| command. The default depends on whether Vim was built as a
Bram Moolenaarc572da52017-08-27 16:52:01 +02009768 32-bit or 64-bit executable. If not found, "winpty.dll" is tried as
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009769 a fallback.
9770 Environment variables are expanded |:set_env|.
9771 This option cannot be set from a |modeline| or in the |sandbox|, for
9772 security reasons.
9773
Bram Moolenaar071d4272004-06-13 20:20:40 +00009774 *'winwidth'* *'wiw'* *E592*
9775'winwidth' 'wiw' number (default 20)
9776 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009777 Minimal number of columns for the current window. This is not a hard
9778 minimum, Vim will use fewer columns if there is not enough room. If
9779 the current window is smaller, its size is increased, at the cost of
9780 the width of other windows. Set it to 999 to make the current window
9781 always fill the screen. Set it to a small number for normal editing.
9782 The width is not adjusted after one of the commands to change the
9783 width of the current window.
9784 'winwidth' applies to the current window. Use 'winminwidth' to set
9785 the minimal width for other windows.
9786
9787 *'wrap'* *'nowrap'*
9788'wrap' boolean (default on)
9789 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00009790 This option changes how text is displayed. It doesn't change the text
9791 in the buffer, see 'textwidth' for that.
9792 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009793 displaying continues on the next line. When off lines will not wrap
9794 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00009795 moved to a part that is not shown, the screen will scroll
9796 horizontally.
9797 The line will be broken in the middle of a word if necessary. See
9798 'linebreak' to get the break at a word boundary.
9799 To make scrolling horizontally a bit more useful, try this: >
9800 :set sidescroll=5
9801 :set listchars+=precedes:<,extends:>
9802< See 'sidescroll', 'listchars' and |wrap-off|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01009803 This option can't be set from a |modeline| when the 'diff' option is
9804 on.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009805
9806 *'wrapmargin'* *'wm'*
9807'wrapmargin' 'wm' number (default 0)
9808 local to buffer
9809 Number of characters from the right window border where wrapping
9810 starts. When typing text beyond this limit, an <EOL> will be inserted
9811 and inserting continues on the next line.
9812 Options that add a margin, such as 'number' and 'foldcolumn', cause
9813 the text width to be further reduced. This is Vi compatible.
9814 When 'textwidth' is non-zero, this option is not used.
Bram Moolenaarca635012015-09-25 20:34:21 +02009815 This option is set to 0 when 'paste' is set and restored when 'paste'
9816 is reset.
Bram Moolenaara6c27c42019-05-09 19:16:22 +02009817 See also 'formatoptions' and |ins-textwidth|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009818
9819 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
9820'wrapscan' 'ws' boolean (default on) *E384* *E385*
9821 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00009822 Searches wrap around the end of the file. Also applies to |]s| and
9823 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009824
9825 *'write'* *'nowrite'*
9826'write' boolean (default on)
9827 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009828 Allows writing files. When not set, writing a file is not allowed.
9829 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009830 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00009831 argument. Filtering text is still possible, even though this requires
9832 writing a temporary file.
9833
9834 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
9835'writeany' 'wa' boolean (default off)
9836 global
9837 Allows writing to any file with no need for "!" override.
9838
9839 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
9840'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
9841 otherwise)
9842 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009843 Make a backup before overwriting a file. The backup is removed after
9844 the file was successfully written, unless the 'backup' option is
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02009845 also on.
9846 WARNING: Switching this option off means that when Vim fails to write
9847 your buffer correctly and then, for whatever reason, Vim exits, you
9848 lose both the original file and what you were writing. Only reset
9849 this option if your file system is almost full and it makes the write
9850 fail (and make sure not to exit Vim until the write was successful).
9851 See |backup-table| for another explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009852 When the 'backupskip' pattern matches, a backup is not made anyway.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01009853 Depending on 'backupcopy' the backup is a new file or the original
9854 file renamed (and a new file is written).
Bram Moolenaar071d4272004-06-13 20:20:40 +00009855 NOTE: This option is set to the default value when 'compatible' is
9856 set.
9857
9858 *'writedelay'* *'wd'*
9859'writedelay' 'wd' number (default 0)
9860 global
Bram Moolenaar802a0d92016-06-26 16:17:58 +02009861 The number of milliseconds to wait for each character sent to the
Bram Moolenaar071d4272004-06-13 20:20:40 +00009862 screen. When non-zero, characters are sent to the terminal one by
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01009863 one. For debugging purposes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009864
Bram Moolenaar6f79e612021-12-21 09:12:23 +00009865 *'xtermcodes'* *'noxtermcodes'*
9866'xtermcodes' boolean (default on)
9867 global
9868 When detecting xterm patchlevel 141 or higher with the termresponse
Bram Moolenaarfa3b7232021-12-24 13:18:38 +00009869 mechanism and this option is set, Vim will request the actual terminal
Bram Moolenaar6f79e612021-12-21 09:12:23 +00009870 key codes and number of colors from the terminal. This takes care of
9871 various configuration options of the terminal that cannot be obtained
9872 from the termlib/terminfo entry, see |xterm-codes|.
9873 A side effect may be that t_Co changes and Vim will redraw the
9874 display.
9875
9876
Bram Moolenaar91f84f62018-07-29 15:07:52 +02009877 vim:tw=78:ts=8:noet:ft=help:norl: