blob: 588daf643627c718bb5fcaf80862e8e9e8da9615 [file] [log] [blame]
zeertzjq53d59ec2025-03-07 19:09:09 +01001*options.txt* For Vim version 9.1. Last change: 2025 Mar 07
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
2110 This option enables fuzzy collection for (only some) specific
2111 |ins-completion| modes, adjusting how items are gathered for fuzzy
2112 matching based on input.
2113 The option can contain the following values (separated by commas),
2114 each enabling fuzzy collection for a specific completion mode:
2115 files file names
2116 keyword keyword completion in 'complete' and current file
2117 whole_line whole lines
2118
glepnir6a89c942024-10-01 20:32:12 +02002119 *'completeitemalign'* *'cia'*
2120'completeitemalign' 'cia' string (default: "abbr,kind,menu")
2121 global
zeertzjq85a50fe2025-02-27 19:24:32 +01002122 A comma-separated list of strings that controls the alignment and
2123 display order of items in the popup menu during Insert mode
2124 completion. The supported values are "abbr", "kind", and "menu".
2125 These values allow customizing how |complete-items| are shown in the
glepnir6a89c942024-10-01 20:32:12 +02002126 popup menu. Note: must always contain those three values in any
2127 order.
2128
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00002129 *'completeopt'* *'cot'*
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00002130'completeopt' 'cot' string (default: "menu,preview")
zeertzjq529b9ad2024-06-05 20:27:06 +02002131 global or local to buffer |global-local|
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01002132 A comma-separated list of options for Insert mode completion
Bram Moolenaarc7453f52006-02-10 23:20:28 +00002133 |ins-completion|. The supported values are:
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00002134
glepnira2c55592025-02-28 17:43:42 +01002135 fuzzy Enable |fuzzy-matching| for completion candidates. This
2136 allows for more flexible and intuitive matching, where
2137 characters can be skipped and matches can be found even
zeertzjq53d59ec2025-03-07 19:09:09 +01002138 if the exact sequence is not typed. Note: This option
glepnirf31cfa22025-03-06 21:59:13 +01002139 does not affect the collection of candidate list, it only
2140 controls how completion candidates are reduced from the
zeertzjq53d59ec2025-03-07 19:09:09 +01002141 list of alternatives. If you want to use |fuzzy-matching|
glepnirf31cfa22025-03-06 21:59:13 +01002142 to gather more alternatives for your candidate list,
2143 see |'completefuzzycollect'|.
glepnira2c55592025-02-28 17:43:42 +01002144
2145 longest Only insert the longest common text of the matches. If
2146 the menu is displayed you can use CTRL-L to add more
2147 characters. Whether case is ignored depends on the kind
2148 of completion. For buffer text the 'ignorecase' option is
2149 used.
2150
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00002151 menu Use a popup menu to show the possible completions. The
2152 menu is only shown when there is more than one match and
2153 sufficient colors are available. |ins-completion-menu|
2154
Bram Moolenaar65c923a2006-03-03 22:56:30 +00002155 menuone Use the popup menu also when there is only one match.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002156 Useful when there is additional information about the
Bram Moolenaar65c923a2006-03-03 22:56:30 +00002157 match, e.g., what file it comes from.
2158
glepnira2c55592025-02-28 17:43:42 +01002159 noinsert Do not insert any text for a match until the user selects
zeertzjq659cb282025-03-03 20:18:04 +01002160 a match from the menu. Only works in combination with
2161 "menu" or "menuone". No effect if "longest" is present.
Bram Moolenaarc7453f52006-02-10 23:20:28 +00002162
glepnira2c55592025-02-28 17:43:42 +01002163 noselect Same as "noinsert", except that no menu item is
zeertzjq659cb282025-03-03 20:18:04 +01002164 pre-selected. If both "noinsert" and "noselect" are
glepnira2c55592025-02-28 17:43:42 +01002165 present, "noselect" has precedence.
2166
2167 nosort Disable sorting of completion candidates based on fuzzy
zeertzjq659cb282025-03-03 20:18:04 +01002168 scores when "fuzzy" is enabled. Candidates will appear
glepnira2c55592025-02-28 17:43:42 +01002169 in their original order.
Bram Moolenaar02467872007-05-06 13:22:01 +00002170
Bram Moolenaar576a4a62019-08-18 15:25:17 +02002171 popup Show extra information about the currently selected
2172 completion in a popup window. Only works in combination
2173 with "menu" or "menuone". Overrides "preview".
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002174 See |'completepopup'| for specifying properties.
Bram Moolenaar2e693a82019-10-16 22:35:02 +02002175 {only works when compiled with the |+textprop| feature}
Bram Moolenaar576a4a62019-08-18 15:25:17 +02002176
Bram Moolenaardca7abe2019-10-20 18:17:57 +02002177 popuphidden
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01002178 Just like "popup" but initially hide the popup. Use a
Bram Moolenaardca7abe2019-10-20 18:17:57 +02002179 |CompleteChanged| autocommand to fetch the info and call
2180 |popup_show()| once the popup has been filled.
2181 See the example at |complete-popuphidden|.
2182 {only works when compiled with the |+textprop| feature}
2183
glepniredd4ac32025-01-29 18:53:51 +01002184 preinsert
2185 Preinsert the portion of the first candidate word that is
2186 not part of the current completion leader and using the
glepnir94a045e2025-03-01 16:12:23 +01002187 |hl-ComplMatchIns| highlight group. In order for it to
zeertzjq659cb282025-03-03 20:18:04 +01002188 work, "fuzzy" must not be set and "menuone" must be set.
glepnira2c55592025-02-28 17:43:42 +01002189
2190 preview Show extra information about the currently selected
2191 completion in the preview window. Only works in
2192 combination with "menu" or "menuone".
glepniredd4ac32025-01-29 18:53:51 +01002193
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002194 *'completepopup'* *'cpp'*
2195'completepopup' 'cpp' string (default empty)
2196 global
2197 {not available when compiled without the |+textprop|
2198 or |+quickfix| feature}
2199 When 'completeopt' contains "popup" then this option is used for the
Bram Moolenaar447bfba2020-07-18 16:07:16 +02002200 properties of the info popup when it is created. If an info popup
2201 window already exists it is closed, so that the option value is
2202 applied when it is created again.
2203 You can also use |popup_findinfo()| and then set properties for an
2204 existing info popup with |popup_setoptions()|. See |complete-popup|.
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002205
laburnumT3f7855a2023-12-05 18:37:03 +01002206 *'completeslash'* *'csl'*
2207'completeslash' 'csl' string (default: "")
2208 local to buffer
2209 {only for MS-Windows}
2210 When this option is set it overrules 'shellslash' for completion:
2211 - When this option is set to "slash", a forward slash is used for path
2212 completion in insert mode. This is useful when editing HTML tag, or
2213 Makefile with 'noshellslash' on MS-Windows.
2214 - When this option is set to "backslash", backslash is used. This is
2215 useful when editing a batch file with 'shellslash' set on MS-Windows.
2216 - When this option is empty, same character is used as for
2217 'shellslash'.
2218 For Insert mode completion the buffer-local value is used. For
2219 command line completion the global value is used.
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002220
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002221 *'concealcursor'* *'cocu'*
2222'concealcursor' 'cocu' string (default: "")
2223 local to window
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002224 {not available when compiled without the |+conceal|
2225 feature}
2226 Sets the modes in which text in the cursor line can also be concealed.
2227 When the current mode is listed then concealing happens just like in
2228 other lines.
2229 n Normal mode
2230 v Visual mode
2231 i Insert mode
Bram Moolenaarca8c9862010-07-24 15:00:38 +02002232 c Command line editing, for 'incsearch'
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002233
Bram Moolenaare6dc5732010-07-24 23:52:26 +02002234 'v' applies to all lines in the Visual area, not only the cursor.
Bram Moolenaarca8c9862010-07-24 15:00:38 +02002235 A useful value is "nc". This is used in help files. So long as you
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002236 are moving around text is concealed, but when starting to insert text
2237 or selecting a Visual area the concealed text is displayed, so that
2238 you can see what you are doing.
Bram Moolenaarf70e3d62010-07-24 13:15:07 +02002239 Keep in mind that the cursor position is not always where it's
2240 displayed. E.g., when moving vertically it may change column.
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002241
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002242 *'conceallevel'* *'cole'*
2243'conceallevel' 'cole' number (default 0)
Bram Moolenaar860cae12010-06-05 23:22:07 +02002244 local to window
Bram Moolenaar860cae12010-06-05 23:22:07 +02002245 {not available when compiled without the |+conceal|
2246 feature}
Bram Moolenaar6df6f472010-07-18 18:04:50 +02002247 Determine how text with the "conceal" syntax attribute |:syn-conceal|
2248 is shown:
Bram Moolenaar860cae12010-06-05 23:22:07 +02002249
Bram Moolenaar6df6f472010-07-18 18:04:50 +02002250 Value Effect ~
Bram Moolenaar860cae12010-06-05 23:22:07 +02002251 0 Text is shown normally
Bram Moolenaar477db062010-07-28 18:17:41 +02002252 1 Each block of concealed text is replaced with one
2253 character. If the syntax item does not have a custom
2254 replacement character defined (see |:syn-cchar|) the
2255 character defined in 'listchars' is used (default is a
2256 space).
2257 It is highlighted with the "Conceal" highlight group.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002258 2 Concealed text is completely hidden unless it has a
2259 custom replacement character defined (see
Bram Moolenaar477db062010-07-28 18:17:41 +02002260 |:syn-cchar|).
Bram Moolenaara7781e02010-07-19 20:13:22 +02002261 3 Concealed text is completely hidden.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002262
Bram Moolenaara7781e02010-07-19 20:13:22 +02002263 Note: in the cursor line concealed text is not hidden, so that you can
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002264 edit and copy the text. This can be changed with the 'concealcursor'
2265 option.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002266
Bram Moolenaar071d4272004-06-13 20:20:40 +00002267 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
2268'confirm' 'cf' boolean (default off)
2269 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002270 When 'confirm' is on, certain operations that would normally
2271 fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
2272 instead raise a |dialog| asking if you wish to save the current
2273 file(s). You can still use a ! to unconditionally |abandon| a buffer.
2274 If 'confirm' is off you can still activate confirmation for one
2275 command only (this is most useful in mappings) with the |:confirm|
2276 command.
2277 Also see the |confirm()| function and the 'v' flag in 'guioptions'.
2278
2279 *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
2280'conskey' 'consk' boolean (default off)
2281 global
Bram Moolenaarf3913272016-02-25 00:00:01 +01002282 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002283
2284 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
2285'copyindent' 'ci' boolean (default off)
2286 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002287 Copy the structure of the existing lines indent when autoindenting a
2288 new line. Normally the new indent is reconstructed by a series of
2289 tabs followed by spaces as required (unless |'expandtab'| is enabled,
2290 in which case only spaces are used). Enabling this option makes the
2291 new line copy whatever characters were used for indenting on the
Bram Moolenaar446cb832008-06-24 21:56:24 +00002292 existing line. 'expandtab' has no effect on these characters, a Tab
2293 remains a Tab. If the new indent is greater than on the existing
Bram Moolenaar071d4272004-06-13 20:20:40 +00002294 line, the remaining space is filled in the normal manner.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002295 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002296 Also see 'preserveindent'.
2297
Bram Moolenaare0fa3742016-02-20 15:47:01 +01002298 *'cpoptions'* *'cpo'* *cpo*
Illia Bobyr03d20aa2024-07-16 20:10:16 +02002299'cpoptions' 'cpo' string (Vim default: "aABceFsz",
2300 Vi default: all flags, except "#{|&/\."
h-east90e1fe42024-08-12 18:26:08 +02002301 |$VIM_POSIX|: all flags)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002302 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002303 A sequence of single character flags. When a character is present
Bram Moolenaar7cba6c02013-09-05 22:13:31 +02002304 this indicates Vi-compatible behavior. This is used for things where
2305 not being Vi-compatible is mostly or sometimes preferred.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002306 'cpoptions' stands for "compatible-options".
2307 Commas can be added for readability.
2308 To avoid problems with flags that are added in the future, use the
2309 "+=" and "-=" feature of ":set" |add-option-flags|.
Bram Moolenaar71eb3ad2021-12-26 12:07:30 +00002310
Bram Moolenaar071d4272004-06-13 20:20:40 +00002311 NOTE: This option is set to the Vi default value when 'compatible' is
2312 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar71eb3ad2021-12-26 12:07:30 +00002313
2314 NOTE: In a |Vim9| script, when `vim9script` is encountered, the value
2315 is saved, 'cpoptions' is set to the Vim default, and the saved value
2316 is restored at the end of the script. Changes to the value of
2317 'cpoptions' will be applied to the saved value, but keep in mind that
2318 removing a flag that is not present when 'cpoptions' is changed has no
2319 effect. In the |.vimrc| file the value is not restored, thus using
2320 `vim9script` in the |.vimrc| file results in using the Vim default.
2321
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002322 NOTE: This option is set to the POSIX default value at startup when
2323 the Vi default value would be used and the $VIM_POSIX environment
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002324 variable exists |posix|. This means Vim tries to behave like the
2325 POSIX specification.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002326
2327 contains behavior ~
2328 *cpo-a*
2329 a When included, a ":read" command with a file name
2330 argument will set the alternate file name for the
2331 current window.
2332 *cpo-A*
2333 A When included, a ":write" command with a file name
2334 argument will set the alternate file name for the
2335 current window.
2336 *cpo-b*
2337 b "\|" in a ":map" command is recognized as the end of
2338 the map command. The '\' is included in the mapping,
2339 the text after the '|' is interpreted as the next
2340 command. Use a CTRL-V instead of a backslash to
2341 include the '|' in the mapping. Applies to all
2342 mapping, abbreviation, menu and autocmd commands.
2343 See also |map_bar|.
2344 *cpo-B*
2345 B A backslash has no special meaning in mappings,
Bram Moolenaara9604e62018-07-21 05:56:22 +02002346 abbreviations, user commands and the "to" part of the
2347 menu commands. Remove this flag to be able to use a
2348 backslash like a CTRL-V. For example, the command
2349 ":map X \<Esc>" results in X being mapped to:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002350 'B' included: "\^[" (^[ is a real <Esc>)
2351 'B' excluded: "<Esc>" (5 characters)
2352 ('<' excluded in both cases)
2353 *cpo-c*
2354 c Searching continues at the end of any match at the
2355 cursor position, but not further than the start of the
2356 next line. When not present searching continues
2357 one character from the cursor position. With 'c'
2358 "abababababab" only gets three matches when repeating
2359 "/abab", without 'c' there are five matches.
2360 *cpo-C*
2361 C Do not concatenate sourced lines that start with a
2362 backslash. See |line-continuation|.
2363 *cpo-d*
2364 d Using "./" in the 'tags' option doesn't mean to use
2365 the tags file relative to the current file, but the
2366 tags file in the current directory.
2367 *cpo-D*
2368 D Can't use CTRL-K to enter a digraph after Normal mode
2369 commands with a character argument, like |r|, |f| and
2370 |t|.
2371 *cpo-e*
2372 e When executing a register with ":@r", always add a
2373 <CR> to the last line, also when the register is not
2374 linewise. If this flag is not present, the register
2375 is not linewise and the last line does not end in a
2376 <CR>, then the last line is put on the command-line
2377 and can be edited before hitting <CR>.
2378 *cpo-E*
2379 E It is an error when using "y", "d", "c", "g~", "gu" or
2380 "gU" on an Empty region. The operators only work when
Bram Moolenaar15142e22018-04-30 22:19:58 +02002381 at least one character is to be operated on. Example:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002382 This makes "y0" fail in the first column.
2383 *cpo-f*
2384 f When included, a ":read" command with a file name
2385 argument will set the file name for the current buffer,
2386 if the current buffer doesn't have a file name yet.
2387 *cpo-F*
2388 F When included, a ":write" command with a file name
2389 argument will set the file name for the current
2390 buffer, if the current buffer doesn't have a file name
Bram Moolenaarb3480382005-12-11 21:33:32 +00002391 yet. Also see |cpo-P|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002392 *cpo-g*
2393 g Goto line 1 when using ":edit" without argument.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002394 *cpo-H*
2395 H When using "I" on a line with only blanks, insert
2396 before the last blank. Without this flag insert after
2397 the last blank.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002398 *cpo-i*
2399 i When included, interrupting the reading of a file will
2400 leave it modified.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002401 *cpo-I*
2402 I When moving the cursor up or down just after inserting
2403 indent for 'autoindent', do not delete the indent.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002404 *cpo-j*
2405 j When joining lines, only add two spaces after a '.',
2406 not after '!' or '?'. Also see 'joinspaces'.
2407 *cpo-J*
2408 J A |sentence| has to be followed by two spaces after
Bram Moolenaar582fd852005-03-28 20:58:01 +00002409 the '.', '!' or '?'. A <Tab> is not recognized as
Bram Moolenaar071d4272004-06-13 20:20:40 +00002410 white space.
2411 *cpo-k*
2412 k Disable the recognition of raw key codes in
2413 mappings, abbreviations, and the "to" part of menu
2414 commands. For example, if <Key> sends ^[OA (where ^[
2415 is <Esc>), the command ":map X ^[OA" results in X
2416 being mapped to:
2417 'k' included: "^[OA" (3 characters)
2418 'k' excluded: "<Key>" (one key code)
2419 Also see the '<' flag below.
2420 *cpo-K*
2421 K Don't wait for a key code to complete when it is
2422 halfway a mapping. This breaks mapping <F1><F1> when
2423 only part of the second <F1> has been read. It
2424 enables cancelling the mapping by typing <F1><Esc>.
2425 *cpo-l*
2426 l Backslash in a [] range in a search pattern is taken
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002427 literally, only "\]", "\^", "\-" and "\\" are special.
2428 See |/[]|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002429 'l' included: "/[ \t]" finds <Space>, '\' and 't'
2430 'l' excluded: "/[ \t]" finds <Space> and <Tab>
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002431 Also see |cpo-\|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002432 *cpo-L*
2433 L When the 'list' option is set, 'wrapmargin',
2434 'textwidth', 'softtabstop' and Virtual Replace mode
2435 (see |gR|) count a <Tab> as two characters, instead of
2436 the normal behavior of a <Tab>.
2437 *cpo-m*
2438 m When included, a showmatch will always wait half a
2439 second. When not included, a showmatch will wait half
2440 a second or until a character is typed. |'showmatch'|
2441 *cpo-M*
2442 M When excluded, "%" matching will take backslashes into
2443 account. Thus in "( \( )" and "\( ( \)" the outer
2444 parenthesis match. When included "%" ignores
2445 backslashes, which is Vi compatible.
2446 *cpo-n*
Bram Moolenaar64486672010-05-16 15:46:46 +02002447 n When included, the column used for 'number' and
2448 'relativenumber' will also be used for text of wrapped
2449 lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002450 *cpo-o*
2451 o Line offset to search command is not remembered for
2452 next search.
2453 *cpo-O*
2454 O Don't complain if a file is being overwritten, even
2455 when it didn't exist when editing it. This is a
2456 protection against a file unexpectedly created by
2457 someone else. Vi didn't complain about this.
2458 *cpo-p*
2459 p Vi compatible Lisp indenting. When not present, a
2460 slightly better algorithm is used.
Bram Moolenaarb3480382005-12-11 21:33:32 +00002461 *cpo-P*
2462 P When included, a ":write" command that appends to a
2463 file will set the file name for the current buffer, if
2464 the current buffer doesn't have a file name yet and
2465 the 'F' flag is also included |cpo-F|.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002466 *cpo-q*
2467 q When joining multiple lines leave the cursor at the
2468 position where it would be when joining two lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002469 *cpo-r*
2470 r Redo ("." command) uses "/" to repeat a search
2471 command, instead of the actually used search string.
2472 *cpo-R*
2473 R Remove marks from filtered lines. Without this flag
2474 marks are kept like |:keepmarks| was used.
2475 *cpo-s*
2476 s Set buffer options when entering the buffer for the
2477 first time. This is like it is in Vim version 3.0.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002478 And it is the default. If not present the options are
Bram Moolenaar071d4272004-06-13 20:20:40 +00002479 set when the buffer is created.
2480 *cpo-S*
2481 S Set buffer options always when entering a buffer
2482 (except 'readonly', 'fileformat', 'filetype' and
2483 'syntax'). This is the (most) Vi compatible setting.
2484 The options are set to the values in the current
2485 buffer. When you change an option and go to another
2486 buffer, the value is copied. Effectively makes the
2487 buffer options global to all buffers.
2488
2489 's' 'S' copy buffer options
2490 no no when buffer created
2491 yes no when buffer first entered (default)
2492 X yes each time when buffer entered (vi comp.)
2493 *cpo-t*
2494 t Search pattern for the tag command is remembered for
2495 "n" command. Otherwise Vim only puts the pattern in
2496 the history for search pattern, but doesn't change the
2497 last used search pattern.
2498 *cpo-u*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002499 u Undo is Vi compatible. See |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002500 *cpo-v*
2501 v Backspaced characters remain visible on the screen in
2502 Insert mode. Without this flag the characters are
2503 erased from the screen right away. With this flag the
2504 screen newly typed text overwrites backspaced
2505 characters.
2506 *cpo-w*
2507 w When using "cw" on a blank character, only change one
2508 character and not all blanks until the start of the
2509 next word.
2510 *cpo-W*
2511 W Don't overwrite a readonly file. When omitted, ":w!"
2512 overwrites a readonly file, if possible.
2513 *cpo-x*
2514 x <Esc> on the command-line executes the command-line.
2515 The default in Vim is to abandon the command-line,
2516 because <Esc> normally aborts a command. |c_<Esc>|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002517 *cpo-X*
2518 X When using a count with "R" the replaced text is
2519 deleted only once. Also when repeating "R" with "."
2520 and a count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002521 *cpo-y*
Bram Moolenaard09091d2019-01-17 16:07:22 +01002522 y A yank command can be redone with ".". Think twice if
2523 you really want to use this, it may break some
2524 plugins, since most people expect "." to only repeat a
2525 change.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002526 *cpo-Z*
2527 Z When using "w!" while the 'readonly' option is set,
2528 don't reset 'readonly'.
Christian Brabandt22105fd2024-07-15 20:51:11 +02002529 *cpo-z*
2530 z Special casing the "cw" and "d" command (see |cw| and
2531 |d-special|).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002532 *cpo-!*
2533 ! When redoing a filter command, use the last used
2534 external command, whatever it was. Otherwise the last
2535 used -filter- command is used.
2536 *cpo-$*
2537 $ When making a change to one line, don't redisplay the
2538 line, but put a '$' at the end of the changed text.
2539 The changed text will be overwritten when you type the
2540 new text. The line is redisplayed if you type any
2541 command that moves the cursor from the insertion
2542 point.
2543 *cpo-%*
2544 % Vi-compatible matching is done for the "%" command.
2545 Does not recognize "#if", "#endif", etc.
2546 Does not recognize "/*" and "*/".
2547 Parens inside single and double quotes are also
2548 counted, causing a string that contains a paren to
2549 disturb the matching. For example, in a line like
2550 "if (strcmp("foo(", s))" the first paren does not
2551 match the last one. When this flag is not included,
2552 parens inside single and double quotes are treated
2553 specially. When matching a paren outside of quotes,
2554 everything inside quotes is ignored. When matching a
2555 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002556 there is one). This works very well for C programs.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002557 This flag is also used for other features, such as
2558 C-indenting.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002559 *cpo--*
2560 - When included, a vertical movement command fails when
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002561 it would go above the first line or below the last
2562 line. Without it the cursor moves to the first or
2563 last line, unless it already was in that line.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002564 Applies to the commands "-", "k", CTRL-P, "+", "j",
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002565 CTRL-N, CTRL-J and ":1234".
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002566 *cpo-+*
2567 + When included, a ":write file" command will reset the
2568 'modified' flag of the buffer, even though the buffer
2569 itself may still be different from its file.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002570 *cpo-star*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002571 * Use ":*" in the same way as ":@". When not included,
2572 ":*" is an alias for ":'<,'>", select the Visual area.
2573 *cpo-<*
2574 < Disable the recognition of special key codes in |<>|
2575 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002576 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00002577 ":map X <Tab>" results in X being mapped to:
2578 '<' included: "<Tab>" (5 characters)
2579 '<' excluded: "^I" (^I is a real <Tab>)
2580 Also see the 'k' flag above.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002581 *cpo->*
2582 > When appending to a register, put a line break before
2583 the appended text.
Bram Moolenaar8b3e0332011-06-26 05:36:34 +02002584 *cpo-;*
2585 ; When using |,| or |;| to repeat the last |t| search
2586 and the cursor is right in front of the searched
2587 character, the cursor won't move. When not included,
2588 the cursor would skip over it and jump to the
Bram Moolenaarc8734422012-06-01 22:38:45 +02002589 following occurrence.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002590
2591 POSIX flags. These are not included in the Vi default value, except
2592 when $VIM_POSIX was set on startup. |posix|
2593
2594 contains behavior ~
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002595 *cpo-#*
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002596 # A count before "D", "o" and "O" has no effect.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002597 *cpo-&*
2598 & When ":preserve" was used keep the swap file when
2599 exiting normally while this buffer is still loaded.
2600 This flag is tested when exiting.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002601 *cpo-\*
2602 \ Backslash in a [] range in a search pattern is taken
2603 literally, only "\]" is special See |/[]|
Bram Moolenaar90915b52005-08-21 22:17:52 +00002604 '\' included: "/[ \-]" finds <Space>, '\' and '-'
2605 '\' excluded: "/[ \-]" finds <Space> and '-'
2606 Also see |cpo-l|.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002607 *cpo-/*
2608 / When "%" is used as the replacement string in a |:s|
2609 command, use the previous replacement string. |:s%|
2610 *cpo-{*
2611 { The |{| and |}| commands also stop at a "{" character
2612 at the start of a line.
2613 *cpo-.*
2614 . The ":chdir" and ":cd" commands fail if the current
2615 buffer is modified, unless ! is used. Vim doesn't
2616 need this, since it remembers the full path of an
2617 opened file.
2618 *cpo-bar*
2619 | The value of the $LINES and $COLUMNS environment
2620 variables overrule the terminal size values obtained
2621 with system specific functions.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002622
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002623 *'cryptmethod'* *'cm'*
Bram Moolenaara86187b2018-12-16 18:20:00 +01002624'cryptmethod' 'cm' string (default "blowfish2")
Bram Moolenaar49771f42010-07-20 17:32:38 +02002625 global or local to buffer |global-local|
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002626 Method used for encryption when the buffer is written to a file:
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002627 *pkzip*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002628 zip PkZip compatible method. A weak kind of encryption.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002629 Backwards compatible with Vim 7.2 and older.
Christian Brabandtaae58342023-04-23 17:50:22 +01002630 Only use if you need to be backwards compatible.
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002631 *blowfish*
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002632 blowfish Blowfish method. Medium strong encryption but it has
2633 an implementation flaw. Requires Vim 7.3 or later,
2634 files can NOT be read by Vim 7.2 and older. This adds
2635 a "seed" to the file, every time you write the file
2636 the encrypted bytes will be different.
Christian Brabandtaae58342023-04-23 17:50:22 +01002637 Obsolete, please do no longer use.
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002638 *blowfish2*
2639 blowfish2 Blowfish method. Medium strong encryption. Requires
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01002640 Vim 7.4.401 or later, files can NOT be read by Vim 7.3
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002641 and older. This adds a "seed" to the file, every time
2642 you write the file the encrypted bytes will be
2643 different. The whole undo file is encrypted, not just
2644 the pieces of text.
Bram Moolenaara2baa732022-02-04 16:09:54 +00002645 *E1193* *E1194* *E1195* *E1196* *E1230*
Christian Brabandtf573c6e2021-06-20 14:02:16 +02002646 *E1197* *E1198* *E1199* *E1200* *E1201*
2647 xchacha20 XChaCha20 Cipher with Poly1305 Message Authentication
2648 Code. Medium strong till strong encryption.
2649 Encryption is provided by the libsodium library, it
Bram Moolenaar22863042021-10-16 15:23:36 +01002650 requires Vim to be built with |+sodium|.
Christian Brabandtf573c6e2021-06-20 14:02:16 +02002651 It adds a seed and a message authentication code (MAC)
2652 to the file. This needs at least a Vim 8.2.3022 to
2653 read the encrypted file.
2654 Encryption of swap files is not supported, therefore
2655 no swap file will be used when xchacha20 encryption is
2656 enabled.
2657 Encryption of undo files is not yet supported,
2658 therefore no undo file will currently be written.
Christian Brabandtaae58342023-04-23 17:50:22 +01002659 CAREFUL: Files written with this method might have to
2660 be read back with the same version of Vim if the
2661 binary format changes later.
2662 Obsolete, please do no longer use.
2663 xchacha20v2 Same algorithm as with "xchacha20" that correctly
2664 stores the key derivation parameters together with the
2665 encrypted file. Should work better in case the
2666 parameters in the libsodium library ever change.
2667 STILL EXPERIMENTAL: Files written with this method
Christian Brabandtf573c6e2021-06-20 14:02:16 +02002668 might have to be read back with the same version of
2669 Vim if the binary format changes later.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002670
Christian Brabandtaae58342023-04-23 17:50:22 +01002671 You should use "blowfish2", also to re-encrypt older files. The
2672 "xchacha20" method provides better encryption, but it does not work
2673 with all versions of Vim.
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01002674
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002675 When reading an encrypted file 'cryptmethod' will be set automatically
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002676 to the detected method of the file being read. Thus if you write it
2677 without changing 'cryptmethod' the same method will be used.
2678 Changing 'cryptmethod' does not mark the file as modified, you have to
Bram Moolenaar49771f42010-07-20 17:32:38 +02002679 explicitly write it, you don't get a warning unless there are other
2680 modifications. Also see |:X|.
2681
2682 When setting the global value to an empty string, it will end up with
Bram Moolenaara86187b2018-12-16 18:20:00 +01002683 the value "blowfish2". When setting the local value to an empty
2684 string the buffer will use the global value.
Bram Moolenaar49771f42010-07-20 17:32:38 +02002685
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002686 When a new encryption method is added in a later version of Vim, and
2687 the current version does not recognize it, you will get *E821* .
Bram Moolenaar49771f42010-07-20 17:32:38 +02002688 You need to edit this file with the later version of Vim.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002689
Bram Moolenaar071d4272004-06-13 20:20:40 +00002690 *'cscopepathcomp'* *'cspc'*
2691'cscopepathcomp' 'cspc' number (default 0)
2692 global
2693 {not available when compiled without the |+cscope|
2694 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002695 Determines how many components of the path to show in a list of tags.
2696 See |cscopepathcomp|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002697 NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002698
2699 *'cscopeprg'* *'csprg'*
2700'cscopeprg' 'csprg' string (default "cscope")
2701 global
2702 {not available when compiled without the |+cscope|
2703 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002704 Specifies the command to execute cscope. See |cscopeprg|.
2705 This option cannot be set from a |modeline| or in the |sandbox|, for
2706 security reasons.
2707
2708 *'cscopequickfix'* *'csqf'*
2709'cscopequickfix' 'csqf' string (default "")
2710 global
2711 {not available when compiled without the |+cscope|
2712 or |+quickfix| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002713 Specifies whether to use quickfix window to show cscope results.
2714 See |cscopequickfix|.
2715
Bram Moolenaarec7944a2013-06-12 21:29:15 +02002716 *'cscoperelative'* *'csre'* *'nocscoperelative'* *'nocsre'*
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002717'cscoperelative' 'csre' boolean (default off)
2718 global
2719 {not available when compiled without the |+cscope|
2720 feature}
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002721 In the absence of a prefix (-P) for cscope. setting this option enables
2722 to use the basename of cscope.out path as the prefix.
2723 See |cscoperelative|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002724 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002725
Bram Moolenaar071d4272004-06-13 20:20:40 +00002726 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
2727'cscopetag' 'cst' boolean (default off)
2728 global
2729 {not available when compiled without the |+cscope|
2730 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002731 Use cscope for tag commands. See |cscope-options|.
2732 NOTE: This option is reset when 'compatible' is set.
2733
2734 *'cscopetagorder'* *'csto'*
2735'cscopetagorder' 'csto' number (default 0)
2736 global
2737 {not available when compiled without the |+cscope|
2738 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002739 Determines the order in which ":cstag" performs a search. See
2740 |cscopetagorder|.
2741 NOTE: This option is set to 0 when 'compatible' is set.
2742
2743 *'cscopeverbose'* *'csverb'*
2744 *'nocscopeverbose'* *'nocsverb'*
2745'cscopeverbose' 'csverb' boolean (default off)
2746 global
2747 {not available when compiled without the |+cscope|
2748 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002749 Give messages when adding a cscope database. See |cscopeverbose|.
2750 NOTE: This option is reset when 'compatible' is set.
2751
Bram Moolenaar860cae12010-06-05 23:22:07 +02002752 *'cursorbind'* *'crb'* *'nocursorbind'* *'nocrb'*
2753'cursorbind' 'crb' boolean (default off)
2754 local to window
Bram Moolenaar860cae12010-06-05 23:22:07 +02002755 When this option is set, as the cursor in the current
2756 window moves other cursorbound windows (windows that also have
2757 this option set) move their cursors to the corresponding line and
2758 column. This option is useful for viewing the
2759 differences between two versions of a file (see 'diff'); in diff mode,
2760 inserted and deleted lines (though not characters within a line) are
Bram Moolenaar1a384422010-07-14 19:53:30 +02002761 taken into account.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002762
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002763 *'cursorcolumn'* *'cuc'* *'nocursorcolumn'* *'nocuc'*
2764'cursorcolumn' 'cuc' boolean (default off)
2765 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02002766 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002767 feature}
2768 Highlight the screen column of the cursor with CursorColumn
2769 |hl-CursorColumn|. Useful to align text. Will make screen redrawing
2770 slower.
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00002771 If you only want the highlighting in the current window you can use
2772 these autocommands: >
2773 au WinLeave * set nocursorline nocursorcolumn
2774 au WinEnter * set cursorline cursorcolumn
2775<
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002776
2777 *'cursorline'* *'cul'* *'nocursorline'* *'nocul'*
2778'cursorline' 'cul' boolean (default off)
2779 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02002780 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002781 feature}
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002782 Highlight the text line of the cursor with CursorLine |hl-CursorLine|.
2783 Useful to easily spot the cursor. Will make screen redrawing slower.
Bram Moolenaare2f98b92006-03-29 21:18:24 +00002784 When Visual mode is active the highlighting isn't used to make it
Bram Moolenaar779b74b2006-04-10 14:55:34 +00002785 easier to see the selected text.
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002786
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002787 *'cursorlineopt'* *'culopt'*
Bram Moolenaar017ba072019-09-14 21:01:23 +02002788'cursorlineopt' 'culopt' string (default: "number,line")
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002789 local to window
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002790 {not available when compiled without the |+syntax|
2791 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01002792 Comma-separated list of settings for how 'cursorline' is displayed.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002793 Valid values:
2794 "line" Highlight the text line of the cursor with
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002795 CursorLine |hl-CursorLine|.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002796 "screenline" Highlight only the screen line of the cursor with
2797 CursorLine |hl-CursorLine|.
2798 "number" Highlight the line number of the cursor with
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002799 CursorLineNr |hl-CursorLineNr|.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002800
2801 Special value:
2802 "both" Alias for the values "line,number".
2803
2804 "line" and "screenline" cannot be used together.
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002805
Bram Moolenaar071d4272004-06-13 20:20:40 +00002806 *'debug'*
2807'debug' string (default "")
2808 global
Bram Moolenaar57657d82006-04-21 22:12:41 +00002809 These values can be used:
2810 msg Error messages that would otherwise be omitted will be given
2811 anyway.
2812 throw Error messages that would otherwise be omitted will be given
2813 anyway and also throw an exception and set |v:errmsg|.
2814 beep A message will be given when otherwise only a beep would be
2815 produced.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002816 The values can be combined, separated by a comma.
Bram Moolenaar57657d82006-04-21 22:12:41 +00002817 "msg" and "throw" are useful for debugging 'foldexpr', 'formatexpr' or
2818 'indentexpr'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002819
2820 *'define'* *'def'*
2821'define' 'def' string (default "^\s*#\s*define")
2822 global or local to buffer |global-local|
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002823 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002824 pattern, just like for the "/" command. This option is used for the
2825 commands like "[i" and "[d" |include-search|. The 'isident' option is
2826 used to recognize the defined name after the match:
2827 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2828 See |option-backslash| about inserting backslashes to include a space
2829 or backslash.
2830 The default value is for C programs. For C++ this value would be
2831 useful, to include const type declarations: >
2832 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
Bram Moolenaar63b74a82019-03-24 15:09:13 +01002833< You can also use "\ze" just before the name and continue the pattern
2834 to check what is following. E.g. for Javascript, if a function is
2835 defined with "func_name = function(args)": >
2836 ^\s*\ze\i\+\s*=\s*function(
2837< If the function is defined with "func_name : function() {...": >
2838 ^\s*\ze\i\+\s*[:]\s*(*function\s*(
Bram Moolenaar071d4272004-06-13 20:20:40 +00002839< When using the ":set" command, you need to double the backslashes!
Bram Moolenaar63b74a82019-03-24 15:09:13 +01002840 To avoid that use `:let` with a single quote string: >
2841 let &l:define = '^\s*\ze\k\+\s*=\s*function('
Bram Moolenaar911ead12019-04-21 00:03:35 +02002842<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002843
2844 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2845'delcombine' 'deco' boolean (default off)
2846 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002847 If editing Unicode and this option is set, backspace and Normal mode
2848 "x" delete each combining character on its own. When it is off (the
2849 default) the character along with its combining characters are
2850 deleted.
Bram Moolenaar4f4d51a2020-10-11 13:57:40 +02002851 Note: When 'delcombine' is set "xx" may work differently from "2x"!
Bram Moolenaar071d4272004-06-13 20:20:40 +00002852
2853 This is useful for Arabic, Hebrew and many other languages where one
2854 may have combining characters overtop of base characters, and want
2855 to remove only the combining ones.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002856 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002857
2858 *'dictionary'* *'dict'*
2859'dictionary' 'dict' string (default "")
2860 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002861 List of file names, separated by commas, that are used to lookup words
2862 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2863 contain a list of words. This can be one word per line, or several
2864 words per line, separated by non-keyword characters (white space is
2865 preferred). Maximum line length is 510 bytes.
Bram Moolenaar259f26a2018-05-15 22:25:40 +02002866
2867 When this option is empty or an entry "spell" is present, and spell
2868 checking is enabled, words in the word lists for the currently active
2869 'spelllang' are used. See |spell|.
2870
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002871 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002872 after a comma are ignored, otherwise spaces are included in the file
2873 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002874 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002875 Where to find a list of words?
2876 - On FreeBSD, there is the file "/usr/share/dict/words".
2877 - In the Simtel archive, look in the "msdos/linguist" directory.
2878 - In "miscfiles" of the GNU collection.
2879 The use of |:set+=| and |:set-=| is preferred when adding or removing
2880 directories from the list. This avoids problems when a future version
2881 uses another default.
2882 Backticks cannot be used in this option for security reasons.
2883
2884 *'diff'* *'nodiff'*
2885'diff' boolean (default off)
2886 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00002887 {not available when compiled without the |+diff|
2888 feature}
2889 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002890 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002891
2892 *'dex'* *'diffexpr'*
2893'diffexpr' 'dex' string (default "")
2894 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002895 {not available when compiled without the |+diff|
2896 feature}
Bram Moolenaare828b762018-09-10 17:51:58 +02002897 Expression which is evaluated to obtain a diff file (either ed-style
2898 or unified-style) from two versions of a file. See |diff-diffexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002899 This option cannot be set from a |modeline| or in the |sandbox|, for
2900 security reasons.
2901
2902 *'dip'* *'diffopt'*
Bram Moolenaarc8234772019-11-10 21:00:27 +01002903'diffopt' 'dip' string (default "internal,filler,closeoff")
Bram Moolenaar071d4272004-06-13 20:20:40 +00002904 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002905 {not available when compiled without the |+diff|
2906 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002907 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002908 All are optional. Items must be separated by a comma.
2909
Jonathon7c7a4e62025-01-12 09:58:00 +01002910 algorithm:{text} Use the specified diff algorithm with the
2911 internal diff engine. Currently supported
2912 algorithms are:
2913 myers the default algorithm
2914 minimal spend extra time to generate the
2915 smallest possible diff
2916 patience patience diff algorithm
2917 histogram histogram diff algorithm
2918
2919 closeoff When a window is closed where 'diff' is set
2920 and there is only one window remaining in the
2921 same tab page with 'diff' set, execute
2922 `:diffoff` in that window. This undoes a
2923 `:diffsplit` command.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002924
2925 context:{n} Use a context of {n} lines between a change
2926 and a fold that contains unchanged lines.
2927 When omitted a context of six lines is used.
Bram Moolenaarf6b40102019-02-22 15:24:03 +01002928 When using zero the context is actually one,
2929 since folds require a line in between, also
dundargoc20f48d52023-10-02 21:49:23 +02002930 for a deleted line. Set it to a very large
2931 value (999999) to disable folding completely.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002932 See |fold-diff|.
2933
Jonathon7c7a4e62025-01-12 09:58:00 +01002934 filler Show filler lines, to keep the text
2935 synchronized with a window that has inserted
2936 lines at the same position. Mostly useful
2937 when windows are side-by-side and 'scrollbind'
2938 is set.
2939
2940 foldcolumn:{n} Set the 'foldcolumn' option to {n} when
2941 starting diff mode. Without this 2 is used.
2942
2943 followwrap Follow the 'wrap' option and leave as it is.
2944
2945 horizontal Start diff mode with horizontal splits (unless
2946 explicitly specified otherwise).
2947
2948 hiddenoff Do not use diff mode for a buffer when it
2949 becomes hidden.
2950
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002951 iblank Ignore changes where lines are all blank. Adds
2952 the "-B" flag to the "diff" command if
2953 'diffexpr' is empty. Check the documentation
2954 of the "diff" command for what this does
2955 exactly.
2956 NOTE: the diff windows will get out of sync,
2957 because no differences between blank lines are
2958 taken into account.
2959
Bram Moolenaar071d4272004-06-13 20:20:40 +00002960 icase Ignore changes in case of text. "a" and "A"
2961 are considered the same. Adds the "-i" flag
2962 to the "diff" command if 'diffexpr' is empty.
2963
Jonathon7c7a4e62025-01-12 09:58:00 +01002964 indent-heuristic
2965 Use the indent heuristic for the internal
2966 diff library.
2967
2968 internal Use the internal diff library. This is
2969 ignored when 'diffexpr' is set. *E960*
2970 When running out of memory when writing a
2971 buffer this item will be ignored for diffs
2972 involving that buffer. Set the 'verbose'
2973 option to see when this happens.
2974
Bram Moolenaar071d4272004-06-13 20:20:40 +00002975 iwhite Ignore changes in amount of white space. Adds
2976 the "-b" flag to the "diff" command if
2977 'diffexpr' is empty. Check the documentation
2978 of the "diff" command for what this does
2979 exactly. It should ignore adding trailing
2980 white space, but not leading white space.
2981
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002982 iwhiteall Ignore all white space changes. Adds
2983 the "-w" flag to the "diff" command if
2984 'diffexpr' is empty. Check the documentation
2985 of the "diff" command for what this does
2986 exactly.
2987
2988 iwhiteeol Ignore white space changes at end of line.
2989 Adds the "-Z" flag to the "diff" command if
2990 'diffexpr' is empty. Check the documentation
2991 of the "diff" command for what this does
2992 exactly.
2993
Jonathon7c7a4e62025-01-12 09:58:00 +01002994 linematch:{n} Align and mark changes between the most
2995 similar lines between the buffers. When the
2996 total number of lines in the diff hunk exceeds
2997 {n}, the lines will not be aligned because for
2998 very large diff hunks there will be a
2999 noticeable lag. A reasonable setting is
3000 "linematch:60", as this will enable alignment
3001 for a 2 buffer diff hunk of 30 lines each,
3002 or a 3 buffer diff hunk of 20 lines each.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00003003
3004 vertical Start diff mode with vertical splits (unless
3005 explicitly specified otherwise).
3006
Bram Moolenaare828b762018-09-10 17:51:58 +02003007 Examples: >
3008 :set diffopt=internal,filler,context:4
Bram Moolenaar071d4272004-06-13 20:20:40 +00003009 :set diffopt=
Bram Moolenaare828b762018-09-10 17:51:58 +02003010 :set diffopt=internal,filler,foldcolumn:3
3011 :set diffopt-=internal " do NOT use the internal diff parser
Bram Moolenaar071d4272004-06-13 20:20:40 +00003012<
3013 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
3014'digraph' 'dg' boolean (default off)
3015 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003016 {not available when compiled without the |+digraphs|
3017 feature}
3018 Enable the entering of digraphs in Insert mode with {char1} <BS>
3019 {char2}. See |digraphs|.
3020 NOTE: This option is reset when 'compatible' is set.
3021
3022 *'directory'* *'dir'*
3023'directory' 'dir' string (default for Amiga: ".,t:",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003024 for Win32: ".,$TEMP,c:\tmp,c:\temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00003025 for Unix: ".,~/tmp,/var/tmp,/tmp")
3026 global
3027 List of directory names for the swap file, separated with commas.
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02003028 Recommended value: ".,~/vimswap//" - this will put the swap file next
3029 to the edited file if possible, and in your personal swap directory
3030 otherwise. Make sure "~/vimswap//" is only readable for you.
3031
3032 Possible items:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003033 - The swap file will be created in the first directory where this is
3034 possible.
3035 - Empty means that no swap file will be used (recovery is
Bram Moolenaar00e192b2019-10-19 17:01:28 +02003036 impossible!) and no |E303| error will be given.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003037 - A directory "." means to put the swap file in the same directory as
3038 the edited file. On Unix, a dot is prepended to the file name, so
3039 it doesn't show in a directory listing. On MS-Windows the "hidden"
3040 attribute is set and a dot prepended if possible.
Bram Moolenaar8024f932020-01-14 19:29:13 +01003041 - A directory starting with "./" (or ".\" for MS-Windows) means to put
3042 the swap file relative to where the edited file is. The leading "."
3043 is replaced with the path name of the edited file.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02003044 - For Unix and Win32, if a directory ends in two path separators "//",
3045 the swap file name will be built from the complete path to the file
Bram Moolenaar207f0092020-08-30 17:20:20 +02003046 with all path separators replaced by percent '%' signs (including
3047 the colon following the drive letter on Win32). This will ensure
3048 file name uniqueness in the preserve directory.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02003049 On Win32, it is also possible to end with "\\". However, When a
3050 separating comma is following, you must use "//", since "\\" will
3051 include the comma in the file name. Therefore it is recommended to
3052 use '//', instead of '\\'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003053 - Spaces after the comma are ignored, other spaces are considered part
3054 of the directory name. To have a space at the start of a directory
3055 name, precede it with a backslash.
3056 - To include a comma in a directory name precede it with a backslash.
3057 - A directory name may end in an ':' or '/'.
3058 - Environment variables are expanded |:set_env|.
3059 - Careful with '\' characters, type one before a space, type two to
3060 get one in the option (see |option-backslash|), for example: >
3061 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
3062< - For backwards compatibility with Vim version 3.0 a '>' at the start
3063 of the option is removed.
3064 Using "." first in the list is recommended. This means that editing
3065 the same file twice will result in a warning. Using "/tmp" on Unix is
3066 discouraged: When the system crashes you lose the swap file.
3067 "/var/tmp" is often not cleared when rebooting, thus is a better
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02003068 choice than "/tmp". But others on the computer may be able to see the
3069 files, and it can contain a lot of files, your swap files get lost in
3070 the crowd. That is why a "tmp" directory in your home directory is
3071 tried first.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003072 The use of |:set+=| and |:set-=| is preferred when adding or removing
3073 directories from the list. This avoids problems when a future version
3074 uses another default.
3075 This option cannot be set from a |modeline| or in the |sandbox|, for
3076 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003077
3078 *'display'* *'dy'*
Bram Moolenaarbc8801c2016-08-02 21:04:33 +02003079'display' 'dy' string (default "", set to "truncate" in
3080 |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003081 global
Bram Moolenaarf269eab2022-10-03 18:04:35 +01003082 Change the way text is displayed. This is a comma-separated list of
Bram Moolenaar071d4272004-06-13 20:20:40 +00003083 flags:
3084 lastline When included, as much as possible of the last line
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02003085 in a window will be displayed. "@@@" is put in the
3086 last columns of the last screen line to indicate the
3087 rest of the line is not displayed.
3088 truncate Like "lastline", but "@@@" is displayed in the first
3089 column of the last screen line. Overrules "lastline".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003090 uhex Show unprintable characters hexadecimal as <xx>
3091 instead of using ^C and ~C.
3092
Bram Moolenaard0796902016-09-16 20:02:31 +02003093 When neither "lastline" nor "truncate" is included, a last line that
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02003094 doesn't fit is replaced with "@" lines.
3095
Bram Moolenaar4ba5f1d2022-10-04 14:36:29 +01003096 The "@" character can be changed by setting the "lastline" item in
3097 'fillchars'. The character is highlighted with |hl-NonText|.
3098
Bram Moolenaar071d4272004-06-13 20:20:40 +00003099 *'eadirection'* *'ead'*
3100'eadirection' 'ead' string (default "both")
3101 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003102 Tells when the 'equalalways' option applies:
3103 ver vertically, width of windows is not affected
3104 hor horizontally, height of windows is not affected
3105 both width and height of windows is affected
3106
3107 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
3108'edcompatible' 'ed' boolean (default off)
3109 global
3110 Makes the 'g' and 'c' flags of the ":substitute" command to be
3111 toggled each time the flag is given. See |complex-change|. See
3112 also 'gdefault' option.
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +02003113 Switching this option on may break plugins!
Bram Moolenaar4072ba52020-12-23 13:56:35 +01003114 This option is not used in |Vim9| script.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003115
Bram Moolenaar03413f42016-04-12 21:07:15 +02003116 *'emoji'* *'emo'* *'noemoji'* *'noemo'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01003117'emoji' 'emo' boolean (default: on)
3118 global
Bram Moolenaar3848e002016-03-19 18:42:29 +01003119 When on all Unicode emoji characters are considered to be full width.
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02003120 This excludes "text emoji" characters, which are normally displayed as
3121 single width. Unfortunately there is no good specification for this
3122 and it has been determined on trial-and-error basis. Use the
3123 |setcellwidths()| function to change the behavior.
Bram Moolenaar3848e002016-03-19 18:42:29 +01003124
Bram Moolenaar071d4272004-06-13 20:20:40 +00003125 *'encoding'* *'enc'* *E543*
K.Takataf883d902021-05-30 18:04:19 +02003126'encoding' 'enc' string (default for MS-Windows: "utf-8",
3127 otherwise: value from $LANG or "latin1")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003128 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003129 Sets the character encoding used inside Vim. It applies to text in
3130 the buffers, registers, Strings in expressions, text stored in the
3131 viminfo file, etc. It sets the kind of characters which Vim can work
3132 with. See |encoding-names| for the possible values.
3133
3134 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003135 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003136 It should normally be kept at its default value, or set when Vim
Bram Moolenaar02467872007-05-06 13:22:01 +00003137 starts up. See |multibyte|. To reload the menus see |:menutrans|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003138
Bram Moolenaar865242e2010-07-14 21:12:05 +02003139 This option cannot be set from a |modeline|. It would most likely
3140 corrupt the text.
3141
Bram Moolenaar3df01732017-02-17 22:47:16 +01003142 NOTE: For GTK+ 2 or later, it is highly recommended to set 'encoding'
3143 to "utf-8". Although care has been taken to allow different values of
Bram Moolenaar071d4272004-06-13 20:20:40 +00003144 'encoding', "utf-8" is the natural choice for the environment and
3145 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003146 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00003147 versions, and to avoid changing the encoding of newly created files
3148 without your knowledge (in case 'fileencodings' is empty).
3149
3150 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003151 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00003152 iconv() or as specified with 'charconvert'.
3153
Bram Moolenaar207f0092020-08-30 17:20:20 +02003154 If you need to know whether 'encoding' is a multibyte encoding, you
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003155 can use: >
3156 if has("multi_byte_encoding")
3157<
Bram Moolenaar071d4272004-06-13 20:20:40 +00003158 Normally 'encoding' will be equal to your current locale. This will
3159 be the default if Vim recognizes your environment settings. If
3160 'encoding' is not set to the current locale, 'termencoding' must be
3161 set to convert typed and displayed text. See |encoding-table|.
3162
3163 When you set this option, it fires the |EncodingChanged| autocommand
3164 event so that you can set up fonts if necessary.
3165
3166 When the option is set, the value is converted to lowercase. Thus
3167 you can set it with uppercase values too. Underscores are translated
3168 to '-' signs.
3169 When the encoding is recognized, it is changed to the standard name.
3170 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
3171 "iso-8859-2" and "utf8" becomes "utf-8".
3172
3173 Note: "latin1" is also used when the encoding could not be detected.
3174 This only works when editing files in the same encoding! When the
3175 actual character set is not latin1, make sure 'fileencoding' and
3176 'fileencodings' are empty. When conversion is needed, switch to using
3177 utf-8.
3178
3179 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
3180 You don't notice this while editing, but it does matter for the
3181 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
3182 setting 'encoding' to one of these values instead of utf-8 only has
3183 effect for encoding used for files when 'fileencoding' is empty.
3184
Bram Moolenaar661b1822005-07-28 22:36:45 +00003185 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
3186 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003187
Bram Moolenaar6ebe4f92022-10-28 20:47:54 +01003188 *'endoffile'* *'eof'* *'noendoffile'* *'noeof'*
Bram Moolenaar0aad88f2022-11-12 11:54:26 +00003189'endoffile' 'eof' boolean (default off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003190 local to buffer
Bram Moolenaar6ebe4f92022-10-28 20:47:54 +01003191 Indicates that a CTRL-Z character was found at the end of the file
3192 when reading it. Normally only happens when 'fileformat' is "dos".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003193 When writing a file and this option is off and the 'binary' option
Bram Moolenaar6ebe4f92022-10-28 20:47:54 +01003194 is on, or 'fixeol' option is off, no CTRL-Z will be written at the
Bram Moolenaarfb0cf232022-10-22 11:25:19 +01003195 end of the file.
K.Takata3af98212022-11-01 20:36:19 +00003196 See |eol-and-eof| for example settings.
Bram Moolenaarfb0cf232022-10-22 11:25:19 +01003197
3198 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
3199'endofline' 'eol' boolean (default on)
3200 local to buffer
3201 When writing a file and this option is off and the 'binary' option
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003202 is on, or 'fixeol' option is off, no <EOL> will be written for the
3203 last line in the file. This option is automatically set or reset when
3204 starting to edit a new file, depending on whether file has an <EOL>
3205 for the last line in the file. Normally you don't have to set or
3206 reset this option.
3207 When 'binary' is off and 'fixeol' is on the value is not used when
3208 writing the file. When 'binary' is on or 'fixeol' is off it is used
3209 to remember the presence of a <EOL> for the last line in the file, so
3210 that when you write the file the situation from the original file can
3211 be kept. But you can change it if you want to.
K.Takata3af98212022-11-01 20:36:19 +00003212 See |eol-and-eof| for example settings.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003213
3214 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
3215'equalalways' 'ea' boolean (default on)
3216 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003217 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00003218 splitting or closing a window. This also happens the moment the
3219 option is switched on. When off, splitting a window will reduce the
3220 size of the current window and leave the other windows the same. When
3221 closing a window the extra lines are given to the window next to it
3222 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00003223 When mixing vertically and horizontally split windows, a minimal size
3224 is computed and some windows may be larger if there is room. The
3225 'eadirection' option tells in which direction the size is affected.
Bram Moolenaar67f71312007-08-12 14:55:56 +00003226 Changing the height and width of a window can be avoided by setting
3227 'winfixheight' and 'winfixwidth', respectively.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003228 If a window size is specified when creating a new window sizes are
3229 currently not equalized (it's complicated, but may be implemented in
3230 the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +00003231
3232 *'equalprg'* *'ep'*
3233'equalprg' 'ep' string (default "")
3234 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003235 External program to use for "=" command. When this option is empty
Bram Moolenaar446cb832008-06-24 21:56:24 +00003236 the internal formatting functions are used; either 'lisp', 'cindent'
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003237 or 'indentexpr'. When Vim was compiled without internal formatting,
3238 the "indent" program is used.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003239 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003240 about including spaces and backslashes.
3241 This option cannot be set from a |modeline| or in the |sandbox|, for
3242 security reasons.
3243
3244 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
3245'errorbells' 'eb' boolean (default off)
3246 global
3247 Ring the bell (beep or screen flash) for error messages. This only
3248 makes a difference for error messages, the bell will be used always
3249 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003250 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar165bc692015-07-21 17:53:25 +02003251 screen flash or do nothing. See 'belloff' to finetune when to ring the
3252 bell.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003253
3254 *'errorfile'* *'ef'*
3255'errorfile' 'ef' string (Amiga default: "AztecC.Err",
3256 others: "errors.err")
3257 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003258 {not available when compiled without the |+quickfix|
3259 feature}
3260 Name of the errorfile for the QuickFix mode (see |:cf|).
3261 When the "-q" command-line argument is used, 'errorfile' is set to the
3262 following argument. See |-q|.
3263 NOT used for the ":make" command. See 'makeef' for that.
3264 Environment variables are expanded |:set_env|.
3265 See |option-backslash| about including spaces and backslashes.
3266 This option cannot be set from a |modeline| or in the |sandbox|, for
3267 security reasons.
3268
3269 *'errorformat'* *'efm'*
3270'errorformat' 'efm' string (default is very long)
3271 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003272 {not available when compiled without the |+quickfix|
3273 feature}
3274 Scanf-like description of the format for the lines in the error file
3275 (see |errorformat|).
3276
3277 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
3278'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
3279 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003280 Function keys that start with an <Esc> are recognized in Insert
3281 mode. When this option is off, the cursor and function keys cannot be
3282 used in Insert mode if they start with an <Esc>. The advantage of
3283 this is that the single <Esc> is recognized immediately, instead of
3284 after one second. Instead of resetting this option, you might want to
3285 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
3286 when 'esckeys' is off, you can still map anything, but the cursor keys
3287 won't work by default.
3288 NOTE: This option is set to the Vi default value when 'compatible' is
3289 set and to the Vim default value when 'compatible' is reset.
Christian Brabandt5f5131d2023-10-25 21:44:26 +02003290 NOTE: when this option is off then the |modifyOtherKeys| and
3291 |xterm-bracketed-paste| functionality is disabled while in Insert mode
3292 to avoid ending Insert mode with any key that has a modifier.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003293
3294 *'eventignore'* *'ei'*
3295'eventignore' 'ei' string (default "")
3296 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003297 A list of autocommand event names, which are to be ignored.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00003298 When set to "all" or when "all" is one of the items, all autocommand
3299 events are ignored, autocommands will not be executed.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01003300 Otherwise this is a comma-separated list of event names. Example: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00003301 :set ei=WinEnter,WinLeave
3302<
Luuk van Baalb7147f82025-02-08 18:52:39 +01003303 *'eventignorewin'* *'eiw'*
3304'eventignorewin' 'eiw' string (default "")
3305 window-local
3306 Similar to 'eventignore' but applies to a particular window and its
3307 buffers, for which window and buffer related autocommands can be
3308 ignored indefinitely without affecting the global 'eventignore'.
3309
Bram Moolenaar071d4272004-06-13 20:20:40 +00003310 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
3311'expandtab' 'et' boolean (default off)
3312 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003313 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003314 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00003315 when 'autoindent' is on. To insert a real tab when 'expandtab' is
3316 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
Bram Moolenaarca635012015-09-25 20:34:21 +02003317 This option is reset when the 'paste' option is set and restored when
3318 the 'paste' option is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003319 NOTE: This option is reset when 'compatible' is set.
3320
3321 *'exrc'* *'ex'* *'noexrc'* *'noex'*
3322'exrc' 'ex' boolean (default off)
3323 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003324 Enables the reading of .vimrc, .exrc and .gvimrc in the current
Bram Moolenaar36f44c22016-08-28 18:17:20 +02003325 directory.
3326
3327 Setting this option is a potential security leak. E.g., consider
3328 unpacking a package or fetching files from github, a .vimrc in there
3329 might be a trojan horse. BETTER NOT SET THIS OPTION!
3330 Instead, define an autocommand in your .vimrc to set options for a
3331 matching directory.
3332
3333 If you do switch this option on you should also consider setting the
3334 'secure' option (see |initialization|).
3335 Also see |.vimrc| and |gui-init|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003336 This option cannot be set from a |modeline| or in the |sandbox|, for
3337 security reasons.
3338
3339 *'fileencoding'* *'fenc'* *E213*
3340'fileencoding' 'fenc' string (default: "")
3341 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003342 Sets the character encoding for the file of this buffer.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003343
Bram Moolenaar071d4272004-06-13 20:20:40 +00003344 When 'fileencoding' is different from 'encoding', conversion will be
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003345 done when writing the file. For reading see below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003346 When 'fileencoding' is empty, the same value as 'encoding' will be
3347 used (no conversion when reading or writing a file).
Bram Moolenaar214641f2017-03-05 17:04:09 +01003348 No error will be given when the value is set, only when it is used,
3349 only when writing a file.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003350 Conversion will also be done when 'encoding' and 'fileencoding' are
3351 both a Unicode encoding and 'fileencoding' is not utf-8. That's
3352 because internally Unicode is always stored as utf-8.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003353 WARNING: Conversion can cause loss of information! When
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003354 'encoding' is "utf-8" or another Unicode encoding, conversion
3355 is most likely done in a way that the reverse conversion
3356 results in the same text. When 'encoding' is not "utf-8" some
3357 characters may be lost!
Bram Moolenaar865242e2010-07-14 21:12:05 +02003358
Bram Moolenaar071d4272004-06-13 20:20:40 +00003359 See 'encoding' for the possible values. Additionally, values may be
3360 specified that can be handled by the converter, see
3361 |mbyte-conversion|.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003362
Bram Moolenaar071d4272004-06-13 20:20:40 +00003363 When reading a file 'fileencoding' will be set from 'fileencodings'.
3364 To read a file in a certain encoding it won't work by setting
Bram Moolenaar02467872007-05-06 13:22:01 +00003365 'fileencoding', use the |++enc| argument. One exception: when
3366 'fileencodings' is empty the value of 'fileencoding' is used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003367 For a new file the global value of 'fileencoding' is used.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003368
Bram Moolenaar071d4272004-06-13 20:20:40 +00003369 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
3370 When the option is set, the value is converted to lowercase. Thus
3371 you can set it with uppercase values too. '_' characters are
3372 replaced with '-'. If a name is recognized from the list for
3373 'encoding', it is replaced by the standard name. For example
3374 "ISO8859-2" becomes "iso-8859-2".
Bram Moolenaar865242e2010-07-14 21:12:05 +02003375
Bram Moolenaar071d4272004-06-13 20:20:40 +00003376 When this option is set, after starting to edit a file, the 'modified'
3377 option is set, because the file would be different when written.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003378
3379 Keep in mind that changing 'fenc' from a modeline happens
3380 AFTER the text has been read, thus it applies to when the file will be
3381 written. If you do set 'fenc' in a modeline, you might want to set
3382 'nomodified' to avoid not being able to ":q".
3383
Bram Moolenaar071d4272004-06-13 20:20:40 +00003384 This option can not be changed when 'modifiable' is off.
3385
3386 *'fe'*
3387 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003388 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003389 old short name was 'fe', which is no longer used.
3390
3391 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003392'fileencodings' 'fencs' string (default: "ucs-bom",
3393 "ucs-bom,utf-8,default,latin1" when
3394 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003395 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003396 This is a list of character encodings considered when starting to edit
3397 an existing file. When a file is read, Vim tries to use the first
3398 mentioned character encoding. If an error is detected, the next one
3399 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003400 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00003401 an empty string, which means the value of 'encoding' is used.
3402 WARNING: Conversion can cause loss of information! When
3403 'encoding' is "utf-8" (or one of the other Unicode variants)
3404 conversion is most likely done in a way that the reverse
3405 conversion results in the same text. When 'encoding' is not
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003406 "utf-8" some non-ASCII characters may be lost! You can use
3407 the |++bad| argument to specify what is done with characters
3408 that can't be converted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003409 For an empty file or a file with only ASCII characters most encodings
3410 will work and the first entry of 'fileencodings' will be used (except
3411 "ucs-bom", which requires the BOM to be present). If you prefer
3412 another encoding use an BufReadPost autocommand event to test if your
3413 preferred encoding is to be used. Example: >
3414 au BufReadPost * if search('\S', 'w') == 0 |
3415 \ set fenc=iso-2022-jp | endif
3416< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
3417 non-blank characters.
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003418 When the |++enc| argument is used then the value of 'fileencodings' is
3419 not used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003420 Note that 'fileencodings' is not used for a new file, the global value
3421 of 'fileencoding' is used instead. You can set it with: >
3422 :setglobal fenc=iso-8859-2
3423< This means that a non-existing file may get a different encoding than
3424 an empty file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003425 The special value "ucs-bom" can be used to check for a Unicode BOM
3426 (Byte Order Mark) at the start of the file. It must not be preceded
3427 by "utf-8" or another Unicode encoding for this to work properly.
3428 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
3429 because Vim cannot detect an error, thus the encoding is always
3430 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003431 The special value "default" can be used for the encoding from the
K.Takataef8706f2021-05-31 18:40:49 +02003432 environment. On MS-Windows this is the system encoding. Otherwise
3433 this is the default value for 'encoding'. It is useful when
3434 'encoding' is set to "utf-8" and your environment uses a non-latin1
3435 encoding, such as Russian.
Bram Moolenaarca003e12006-03-17 23:19:38 +00003436 When 'encoding' is "utf-8" and a file contains an illegal byte
3437 sequence it won't be recognized as UTF-8. You can use the |8g8|
3438 command to find the illegal byte sequence.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003439 WRONG VALUES: WHAT'S WRONG:
3440 latin1,utf-8 "latin1" will always be used
3441 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
3442 file
3443 cp1250,latin1 "cp1250" will always be used
3444 If 'fileencodings' is empty, 'fileencoding' is not modified.
3445 See 'fileencoding' for the possible values.
3446 Setting this option does not have an effect until the next time a file
3447 is read.
3448
3449 *'fileformat'* *'ff'*
Bram Moolenaar00590742019-02-15 21:06:09 +01003450'fileformat' 'ff' string (MS-Windows default: "dos",
Yee Cheng Chin92b59c62024-10-22 21:16:43 +02003451 Unix default: "unix")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003452 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003453 This gives the <EOL> of the current buffer, which is used for
3454 reading/writing the buffer from/to a file:
Bram Moolenaar4072ba52020-12-23 13:56:35 +01003455 dos <CR><NL>
Bram Moolenaar071d4272004-06-13 20:20:40 +00003456 unix <NL>
3457 mac <CR>
3458 When "dos" is used, CTRL-Z at the end of a file is ignored.
3459 See |file-formats| and |file-read|.
3460 For the character encoding of the file see 'fileencoding'.
3461 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
Bram Moolenaarbf884932013-04-05 22:26:15 +02003462 works like it was set to "unix".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003463 This option is set automatically when starting to edit a file and
3464 'fileformats' is not empty and 'binary' is off.
3465 When this option is set, after starting to edit a file, the 'modified'
3466 option is set, because the file would be different when written.
3467 This option can not be changed when 'modifiable' is off.
3468 For backwards compatibility: When this option is set to "dos",
3469 'textmode' is set, otherwise 'textmode' is reset.
3470
3471 *'fileformats'* *'ffs'*
3472'fileformats' 'ffs' string (default:
Bram Moolenaar00590742019-02-15 21:06:09 +01003473 Vim+Vi MS-Windows: "dos,unix",
Yee Cheng Chin92b59c62024-10-22 21:16:43 +02003474 Vim Unix: "unix,dos",
Bram Moolenaar071d4272004-06-13 20:20:40 +00003475 Vi Cygwin: "unix,dos",
3476 Vi others: "")
3477 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003478 This gives the end-of-line (<EOL>) formats that will be tried when
3479 starting to edit a new buffer and when reading a file into an existing
3480 buffer:
3481 - When empty, the format defined with 'fileformat' will be used
3482 always. It is not set automatically.
3483 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003484 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003485 'fileformats' name will be used when a file is read into an existing
3486 buffer, no matter what 'fileformat' for that buffer is set to.
3487 - When more than one name is present, separated by commas, automatic
3488 <EOL> detection will be done when reading a file. When starting to
3489 edit a file, a check is done for the <EOL>:
3490 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
3491 'fileformat' is set to "dos".
3492 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003493 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003494 preceding <CR>, "unix" is preferred over "dos".
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01003495 3. If 'fileformat' has not yet been set, and if a <CR> is found, and
3496 if 'fileformats' includes "mac", 'fileformat' is set to "mac".
Bram Moolenaar00659062010-09-21 22:34:02 +02003497 This means that "mac" is only chosen when:
3498 "unix" is not present or no <NL> is found in the file, and
3499 "dos" is not present or no <CR><NL> is found in the file.
3500 Except: if "unix" was chosen, but there is a <CR> before
3501 the first <NL>, and there appear to be more <CR>s than <NL>s in
Bram Moolenaar166af9b2010-11-16 20:34:40 +01003502 the first few lines, "mac" is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003503 4. If 'fileformat' is still not set, the first name from
3504 'fileformats' is used.
3505 When reading a file into an existing buffer, the same is done, but
3506 this happens like 'fileformat' has been set appropriately for that
3507 file only, the option is not changed.
3508 When 'binary' is set, the value of 'fileformats' is not used.
3509
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01003510 When Vim starts up with an empty buffer the first item is used. You
3511 can overrule this by setting 'fileformat' in your .vimrc.
Bram Moolenaar81af9252010-12-10 20:35:50 +01003512
Bram Moolenaar071d4272004-06-13 20:20:40 +00003513 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
3514 are ":source"ed and for vimrc files, automatic <EOL> detection may be
3515 done:
3516 - When 'fileformats' is empty, there is no automatic detection. Dos
3517 format will be used.
3518 - When 'fileformats' is set to one or more names, automatic detection
3519 is done. This is based on the first <NL> in the file: If there is a
3520 <CR> in front of it, Dos format is used, otherwise Unix format is
3521 used.
3522 Also see |file-formats|.
3523 For backwards compatibility: When this option is set to an empty
3524 string or one format (no comma is included), 'textauto' is reset,
3525 otherwise 'textauto' is set.
3526 NOTE: This option is set to the Vi default value when 'compatible' is
3527 set and to the Vim default value when 'compatible' is reset.
3528
Bram Moolenaarbf884932013-04-05 22:26:15 +02003529 *'fileignorecase'* *'fic'* *'nofileignorecase'* *'nofic'*
3530'fileignorecase' 'fic' boolean (default on for systems where case in file
3531 names is normally ignored)
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003532 global
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003533 When set case is ignored when using file names and directories.
3534 See 'wildignorecase' for only ignoring case when doing completion.
3535
Bram Moolenaar071d4272004-06-13 20:20:40 +00003536 *'filetype'* *'ft'*
3537'filetype' 'ft' string (default: "")
Christian Brabandt596ad662023-08-16 00:11:09 +02003538 local to buffer |local-noglobal|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003539 When this option is set, the FileType autocommand event is triggered.
3540 All autocommands that match with the value of this option will be
3541 executed. Thus the value of 'filetype' is used in place of the file
3542 name.
3543 Otherwise this option does not always reflect the current file type.
3544 This option is normally set when the file type is detected. To enable
3545 this use the ":filetype on" command. |:filetype|
3546 Setting this option to a different value is most useful in a modeline,
3547 for a file for which the file type is not automatically recognized.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003548 Example, for in an IDL file:
3549 /* vim: set filetype=idl : */ ~
3550 |FileType| |filetypes|
3551 When a dot appears in the value then this separates two filetype
Millyae62fe52024-10-02 19:30:41 +02003552 names, it should therefore not be used for a filetype. Example:
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003553 /* vim: set filetype=c.doxygen : */ ~
3554 This will use the "c" filetype first, then the "doxygen" filetype.
3555 This works both for filetype plugins and for syntax files. More than
3556 one dot may appear.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003557 This option is not copied to another buffer, independent of the 's' or
3558 'S' flag in 'cpoptions'.
Millyae62fe52024-10-02 19:30:41 +02003559 Only alphanumeric characters, '-' and '_' can be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003560
3561 *'fillchars'* *'fcs'*
Yee Cheng Chin39cd9062024-11-06 20:20:57 +01003562'fillchars' 'fcs' string (default "vert:|,fold:-,eob:~,lastline:@")
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003563 global or local to window |global-local|
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003564 Characters to fill the statuslines, vertical separators and special
3565 lines in the window.
3566 It is a comma-separated list of items. Each item has a name, a colon
zeertzjq6a8d2e12024-01-17 20:54:49 +01003567 and the value of that item: |E1511|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003568
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003569 item name default Used for ~
Christian Brabandt6a650bf2023-11-08 21:23:29 +01003570 stl ' ' statusline of the current window
3571 stlnc ' ' statusline of the non-current windows
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003572 vert '|' vertical separators |:vsplit|
3573 fold '-' filling 'foldtext'
3574 foldopen '-' mark the beginning of a fold
3575 foldclose '+' show a closed fold
3576 foldsep '|' open fold middle character
3577 diff '-' deleted lines of the 'diff' option
3578 eob '~' empty lines below the end of a buffer
Bram Moolenaar4ba5f1d2022-10-04 14:36:29 +01003579 lastline '@' 'display' contains lastline/truncate
Bram Moolenaar071d4272004-06-13 20:20:40 +00003580
Christian Brabandt6a650bf2023-11-08 21:23:29 +01003581 Any one that is omitted will fall back to the default.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003582
3583 Example: >
Christian Brabandt6a650bf2023-11-08 21:23:29 +01003584 :set fillchars=stl:\ ,stlnc:\ ,vert:\|,fold:-,diff:-
3585<
Bram Moolenaar8cc5b552022-06-23 13:04:20 +01003586 For the "stl", "stlnc", "foldopen", "foldclose" and "foldsep" items
3587 single-byte and multibyte characters are supported. But double-width
zeertzjq6a8d2e12024-01-17 20:54:49 +01003588 characters are not supported. |E1512|
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003589
Bram Moolenaar071d4272004-06-13 20:20:40 +00003590 The highlighting used for these items:
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003591 item name highlight group ~
3592 stl StatusLine |hl-StatusLine|
3593 stlnc StatusLineNC |hl-StatusLineNC|
3594 vert VertSplit |hl-VertSplit|
3595 fold Folded |hl-Folded|
3596 diff DiffDelete |hl-DiffDelete|
3597 eob EndOfBuffer |hl-EndOfBuffer|
Bram Moolenaar4ba5f1d2022-10-04 14:36:29 +01003598 lastline NonText |hl-NonText|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003599
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +01003600 *'findfunc'* *'ffu'* *E1514*
3601'findfunc' 'ffu' string (default empty)
Yegappan Lakshmananaeb1c972024-10-22 23:42:20 +02003602 global or local to buffer |global-local|
3603 {not available when compiled without the |+eval|
3604 feature}
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +01003605 Function that is called to obtain the filename(s) for the |:find|
Yegappan Lakshmananaeb1c972024-10-22 23:42:20 +02003606 command. When this option is empty, the internal |file-searching|
3607 mechanism is used.
3608
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +01003609 The value can be the name of a function, a |lambda| or a |Funcref|.
3610 See |option-value-function| for more information.
Yegappan Lakshmananaeb1c972024-10-22 23:42:20 +02003611
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +01003612 The function is called with two arguments. The first argument is a
3613 |String| and is the |:find| command argument. The second argument is
3614 a |Boolean| and is set to |v:true| when the function is called to get
3615 a List of command-line completion matches for the |:find| command.
3616 The function should return a List of strings.
Yegappan Lakshmananaeb1c972024-10-22 23:42:20 +02003617
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +01003618 The function is called only once per |:find| command invocation.
3619 The function can process all the directories specified in 'path'.
zeertzjq20e045f2024-10-28 22:05:26 +01003620
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +01003621 If a match is found, the function should return a |List| containing
3622 one or more file names. If a match is not found, the function
Yegappan Lakshmananaeb1c972024-10-22 23:42:20 +02003623 should return an empty List.
3624
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +01003625 If any errors are encountered during the function invocation, an
Yegappan Lakshmananaeb1c972024-10-22 23:42:20 +02003626 empty List is used as the return value.
3627
Yegappan Lakshmananaeb1c972024-10-22 23:42:20 +02003628 It is not allowed to change text or jump to another window while
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +01003629 executing the 'findfunc' |textlock|.
Yegappan Lakshmananaeb1c972024-10-22 23:42:20 +02003630
3631 This option cannot be set from a |modeline| or in the |sandbox|, for
3632 security reasons.
3633
3634 Examples:
3635>
3636 " Use glob()
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +01003637 func FindFuncGlob(cmdarg, cmdcomplete)
3638 let pat = a:cmdcomplete ? $'{a:cmdarg}*' : a:cmdarg
zeertzjq20e045f2024-10-28 22:05:26 +01003639 return glob(pat, v:false, v:true)
Yegappan Lakshmananaeb1c972024-10-22 23:42:20 +02003640 endfunc
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +01003641 set findfunc=FindFuncGlob
Yegappan Lakshmananaeb1c972024-10-22 23:42:20 +02003642
3643 " Use the 'git ls-files' output
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +01003644 func FindGitFiles(cmdarg, cmdcomplete)
Yegappan Lakshmananaeb1c972024-10-22 23:42:20 +02003645 let fnames = systemlist('git ls-files')
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +01003646 return fnames->filter('v:val =~? a:cmdarg')
Yegappan Lakshmananaeb1c972024-10-22 23:42:20 +02003647 endfunc
Yegappan Lakshmanana13f3a42024-11-02 18:40:10 +01003648 set findfunc=FindGitFiles
Yegappan Lakshmananaeb1c972024-10-22 23:42:20 +02003649<
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003650 *'fixendofline'* *'fixeol'* *'nofixendofline'* *'nofixeol'*
3651'fixendofline' 'fixeol' boolean (default on)
3652 local to buffer
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003653 When writing a file and this option is on, <EOL> at the end of file
Bram Moolenaarfb0cf232022-10-22 11:25:19 +01003654 will be restored if missing. Turn this option off if you want to
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003655 preserve the situation from the original file.
3656 When the 'binary' option is set the value of this option doesn't
3657 matter.
3658 See the 'endofline' option.
K.Takata3af98212022-11-01 20:36:19 +00003659 See |eol-and-eof| for example settings.
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003660
Bram Moolenaar071d4272004-06-13 20:20:40 +00003661 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
Bram Moolenaar98a29d02021-01-18 19:55:44 +01003662'fkmap' 'fk' boolean (default off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003663 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003664 {only available when compiled with the |+rightleft|
3665 feature}
Bram Moolenaar14184a32019-02-16 15:10:30 +01003666 This option was for using Farsi, which has been removed. See
3667 |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003668
3669 *'foldclose'* *'fcl'*
3670'foldclose' 'fcl' string (default "")
3671 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003672 {not available when compiled without the |+folding|
3673 feature}
3674 When set to "all", a fold is closed when the cursor isn't in it and
3675 its level is higher than 'foldlevel'. Useful if you want folds to
3676 automatically close when moving out of them.
3677
3678 *'foldcolumn'* *'fdc'*
3679'foldcolumn' 'fdc' number (default 0)
3680 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003681 {not available when compiled without the |+folding|
3682 feature}
3683 When non-zero, a column with the specified width is shown at the side
3684 of the window which indicates open and closed folds. The maximum
3685 value is 12.
3686 See |folding|.
3687
3688 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
3689'foldenable' 'fen' boolean (default on)
3690 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003691 {not available when compiled without the |+folding|
3692 feature}
3693 When off, all folds are open. This option can be used to quickly
3694 switch between showing all text unfolded and viewing the text with
3695 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003696 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00003697 'foldenable' is off.
3698 This option is set by commands that create a new fold or close a fold.
3699 See |folding|.
3700
3701 *'foldexpr'* *'fde'*
3702'foldexpr' 'fde' string (default: "0")
3703 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003704 {not available when compiled without the |+folding|
Bram Moolenaardb84e452010-08-15 13:50:43 +02003705 or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003706 The expression used for when 'foldmethod' is "expr". It is evaluated
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00003707 for each line to obtain its fold level. The context is set to the
3708 script where 'foldexpr' was set, script-local items can be accessed.
3709 See |fold-expr| for the usage.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003710
Bram Moolenaar30b65812012-07-12 22:01:11 +02003711 The expression will be evaluated in the |sandbox| if set from a
3712 modeline, see |sandbox-option|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003713 This option can't be set from a |modeline| when the 'diff' option is
Bram Moolenaar110289e2019-05-23 15:38:06 +02003714 on or the 'modelineexpr' option is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003715
3716 It is not allowed to change text or jump to another window while
3717 evaluating 'foldexpr' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003718
3719 *'foldignore'* *'fdi'*
3720'foldignore' 'fdi' string (default: "#")
3721 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003722 {not available when compiled without the |+folding|
3723 feature}
3724 Used only when 'foldmethod' is "indent". Lines starting with
3725 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003726 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003727 The default "#" works well for C programs. See |fold-indent|.
3728
3729 *'foldlevel'* *'fdl'*
3730'foldlevel' 'fdl' number (default: 0)
3731 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003732 {not available when compiled without the |+folding|
3733 feature}
3734 Sets the fold level: Folds with a higher level will be closed.
3735 Setting this option to zero will close all folds. Higher numbers will
3736 close fewer folds.
3737 This option is set by commands like |zm|, |zM| and |zR|.
3738 See |fold-foldlevel|.
3739
3740 *'foldlevelstart'* *'fdls'*
3741'foldlevelstart' 'fdls' number (default: -1)
3742 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003743 {not available when compiled without the |+folding|
3744 feature}
3745 Sets 'foldlevel' when starting to edit another buffer in a window.
3746 Useful to always start editing with all folds closed (value zero),
3747 some folds closed (one) or no folds closed (99).
3748 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003749 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00003750 ignores this option and closes all folds.
3751 It is also done before BufReadPre autocommands, to allow an autocmd to
3752 overrule the 'foldlevel' value for specific files.
3753 When the value is negative, it is not used.
3754
3755 *'foldmarker'* *'fmr'* *E536*
3756'foldmarker' 'fmr' string (default: "{{{,}}}")
3757 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003758 {not available when compiled without the |+folding|
3759 feature}
3760 The start and end marker used when 'foldmethod' is "marker". There
3761 must be one comma, which separates the start and end marker. The
3762 marker is a literal string (a regular expression would be too slow).
3763 See |fold-marker|.
3764
3765 *'foldmethod'* *'fdm'*
3766'foldmethod' 'fdm' string (default: "manual")
3767 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003768 {not available when compiled without the |+folding|
3769 feature}
3770 The kind of folding used for the current window. Possible values:
3771 |fold-manual| manual Folds are created manually.
3772 |fold-indent| indent Lines with equal indent form a fold.
3773 |fold-expr| expr 'foldexpr' gives the fold level of a line.
3774 |fold-marker| marker Markers are used to specify folds.
3775 |fold-syntax| syntax Syntax highlighting items specify folds.
3776 |fold-diff| diff Fold text that is not changed.
3777
3778 *'foldminlines'* *'fml'*
3779'foldminlines' 'fml' number (default: 1)
3780 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003781 {not available when compiled without the |+folding|
3782 feature}
Bram Moolenaar00654022011-02-25 14:42:19 +01003783 Sets the number of screen lines above which a fold can be displayed
3784 closed. Also for manually closed folds. With the default value of
3785 one a fold can only be closed if it takes up two or more screen lines.
3786 Set to zero to be able to close folds of just one screen line.
Bram Moolenaar446beb42011-05-10 17:18:44 +02003787 Note that this only has an effect on what is displayed. After using
Bram Moolenaar071d4272004-06-13 20:20:40 +00003788 "zc" to close a fold, which is displayed open because it's smaller
3789 than 'foldminlines', a following "zc" may close a containing fold.
3790
3791 *'foldnestmax'* *'fdn'*
3792'foldnestmax' 'fdn' number (default: 20)
3793 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003794 {not available when compiled without the |+folding|
3795 feature}
3796 Sets the maximum nesting of folds for the "indent" and "syntax"
3797 methods. This avoids that too many folds will be created. Using more
3798 than 20 doesn't work, because the internal limit is 20.
3799
3800 *'foldopen'* *'fdo'*
3801'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
3802 search,tag,undo")
3803 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003804 {not available when compiled without the |+folding|
3805 feature}
3806 Specifies for which type of commands folds will be opened, if the
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01003807 command moves the cursor into a closed fold. It is a comma-separated
Bram Moolenaar071d4272004-06-13 20:20:40 +00003808 list of items.
Bram Moolenaar05365702010-10-27 18:34:44 +02003809 NOTE: When the command is part of a mapping this option is not used.
3810 Add the |zv| command to the mapping to get the same effect.
3811 (rationale: the mapping may want to control opening folds itself)
3812
Bram Moolenaar071d4272004-06-13 20:20:40 +00003813 item commands ~
3814 all any
3815 block "(", "{", "[[", "[{", etc.
3816 hor horizontal movements: "l", "w", "fx", etc.
3817 insert any command in Insert mode
3818 jump far jumps: "G", "gg", etc.
3819 mark jumping to a mark: "'m", CTRL-O, etc.
3820 percent "%"
3821 quickfix ":cn", ":crew", ":make", etc.
3822 search search for a pattern: "/", "n", "*", "gd", etc.
3823 (not for a search pattern in a ":" command)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003824 Also for |[s| and |]s|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003825 tag jumping to a tag: ":ta", CTRL-T, etc.
3826 undo undo or redo: "u" and CTRL-R
Bram Moolenaar071d4272004-06-13 20:20:40 +00003827 When a movement command is used for an operator (e.g., "dl" or "y%")
3828 this option is not used. This means the operator will include the
3829 whole closed fold.
3830 Note that vertical movements are not here, because it would make it
3831 very difficult to move onto a closed fold.
3832 In insert mode the folds containing the cursor will always be open
3833 when text is inserted.
3834 To close folds you can re-apply 'foldlevel' with the |zx| command or
3835 set the 'foldclose' option to "all".
3836
3837 *'foldtext'* *'fdt'*
3838'foldtext' 'fdt' string (default: "foldtext()")
3839 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003840 {not available when compiled without the |+folding|
3841 feature}
3842 An expression which is used to specify the text displayed for a closed
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00003843 fold. The context is set to the script where 'foldexpr' was set,
3844 script-local items can be accessed. See |fold-foldtext| for the
3845 usage.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003846
Bram Moolenaar30b65812012-07-12 22:01:11 +02003847 The expression will be evaluated in the |sandbox| if set from a
3848 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003849 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003850
3851 It is not allowed to change text or jump to another window while
3852 evaluating 'foldtext' |textlock|.
3853
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003854 *'formatexpr'* *'fex'*
3855'formatexpr' 'fex' string (default "")
3856 local to buffer
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003857 {not available when compiled without the |+eval|
3858 feature}
3859 Expression which is evaluated to format a range of lines for the |gq|
3860 operator or automatic formatting (see 'formatoptions'). When this
3861 option is empty 'formatprg' is used.
3862
3863 The |v:lnum| variable holds the first line to be formatted.
3864 The |v:count| variable holds the number of lines to be formatted.
3865 The |v:char| variable holds the character that is going to be
3866 inserted if the expression is being evaluated due to
3867 automatic formatting. This can be empty. Don't insert
3868 it yet!
3869
3870 Example: >
3871 :set formatexpr=mylang#Format()
3872< This will invoke the mylang#Format() function in the
3873 autoload/mylang.vim file in 'runtimepath'. |autoload|
3874
Bram Moolenaara4e0b972022-10-01 19:43:52 +01003875 The advantage of using a function call without arguments is that it is
3876 faster, see |expr-option-function|.
3877
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003878 The expression is also evaluated when 'textwidth' is set and adding
3879 text beyond that limit. This happens under the same conditions as
3880 when internal formatting is used. Make sure the cursor is kept in the
3881 same spot relative to the text then! The |mode()| function will
3882 return "i" or "R" in this situation.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01003883
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003884 When the expression evaluates to non-zero Vim will fall back to using
3885 the internal format mechanism.
3886
Yegappan Lakshmanan8bb65f22021-12-26 10:51:39 +00003887 If the expression starts with s: or |<SID>|, then it is replaced with
3888 the script ID (|local-function|). Example: >
3889 set formatexpr=s:MyFormatExpr()
3890 set formatexpr=<SID>SomeFormatExpr()
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00003891< Otherwise, the expression is evaluated in the context of the script
3892 where the option was set, thus script-local items are available.
3893
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003894 The expression will be evaluated in the |sandbox| when set from a
3895 modeline, see |sandbox-option|. That stops the option from working,
3896 since changing the buffer text is not allowed.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003897 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaar036986f2017-03-16 17:41:02 +01003898 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003899
Bram Moolenaar86b68352004-12-27 21:59:20 +00003900 *'formatlistpat'* *'flp'*
3901'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
3902 local to buffer
Bram Moolenaar86b68352004-12-27 21:59:20 +00003903 A pattern that is used to recognize a list header. This is used for
3904 the "n" flag in 'formatoptions'.
3905 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00003906 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00003907 while still checking more characters. There must be a character
3908 following the pattern, when it matches the whole line it is handled
3909 like there is no match.
3910 The default recognizes a number, followed by an optional punctuation
3911 character and white space.
3912
Bram Moolenaar6c60f472019-04-28 16:00:35 +02003913 *'formatoptions'* *'fo'*
3914'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
3915 local to buffer
3916 This is a sequence of letters which describes how automatic
Christian Brabandt1b08d2c2023-11-11 15:50:13 +01003917 formatting is to be done.
3918 See |fo-table| for possible values and |gq| for how to format text.
3919 When the 'paste' option is on, no formatting is done (like
3920 'formatoptions' is empty). Commas can be inserted for readability.
Bram Moolenaar6c60f472019-04-28 16:00:35 +02003921 To avoid problems with flags that are added in the future, use the
3922 "+=" and "-=" feature of ":set" |add-option-flags|.
3923 NOTE: This option is set to the Vi default value when 'compatible' is
3924 set and to the Vim default value when 'compatible' is reset.
3925
Bram Moolenaar071d4272004-06-13 20:20:40 +00003926 *'formatprg'* *'fp'*
3927'formatprg' 'fp' string (default "")
Bram Moolenaar9be7c042017-01-14 14:28:30 +01003928 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003929 The name of an external program that will be used to format the lines
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003930 selected with the |gq| operator. The program must take the input on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003931 stdin and produce the output on stdout. The Unix program "fmt" is
Bram Moolenaara5792f52005-11-23 21:25:05 +00003932 such a program.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003933 If the 'formatexpr' option is not empty it will be used instead.
3934 Otherwise, if 'formatprg' option is an empty string, the internal
3935 format function will be used |C-indenting|.
Bram Moolenaara5792f52005-11-23 21:25:05 +00003936 Environment variables are expanded |:set_env|. See |option-backslash|
3937 about including spaces and backslashes.
Bram Moolenaar30b65812012-07-12 22:01:11 +02003938 This option cannot be set from a |modeline| or in the |sandbox|, for
3939 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003940
Bram Moolenaard94464e2015-11-02 15:28:18 +01003941 *'fsync'* *'fs'* *'nofsync'* *'nofs'*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003942'fsync' 'fs' boolean (default on)
3943 global
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003944 When on, the library function fsync() will be called after writing a
3945 file. This will flush a file to disk, ensuring that it is safely
3946 written even on filesystems which do metadata-only journaling. This
3947 will force the harddrive to spin up on Linux systems running in laptop
3948 mode, so it may be undesirable in some situations. Be warned that
3949 turning this off increases the chances of data loss after a crash. On
3950 systems without an fsync() implementation, this variable is always
3951 off.
3952 Also see 'swapsync' for controlling fsync() on swap files.
Bram Moolenaar340dd0f2021-10-14 17:52:23 +01003953 'fsync' also applies to |writefile()| (unless a flag is used to
3954 overrule it) and when writing undo files (see |undo-persistence|).
Bram Moolenaar110289e2019-05-23 15:38:06 +02003955 This option cannot be set from a |modeline| or in the |sandbox|, for
3956 security reasons.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003957
Bram Moolenaar071d4272004-06-13 20:20:40 +00003958 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
3959'gdefault' 'gd' boolean (default off)
3960 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003961 When on, the ":substitute" flag 'g' is default on. This means that
3962 all matches in a line are substituted instead of one. When a 'g' flag
3963 is given to a ":substitute" command, this will toggle the substitution
3964 of all or one match. See |complex-change|.
3965
3966 command 'gdefault' on 'gdefault' off ~
3967 :s/// subst. all subst. one
3968 :s///g subst. one subst. all
3969 :s///gg subst. all subst. one
3970
3971 NOTE: This option is reset when 'compatible' is set.
dundargoc82f19732023-12-16 14:53:52 +01003972 Setting this option may break plugins that rely on the default
3973 behavior of the 'g' flag. This will also make the 'g' flag have the
3974 opposite effect of that documented in |:s_g|.
Bram Moolenaar4072ba52020-12-23 13:56:35 +01003975 This option is not used in |Vim9| script.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003976
3977 *'grepformat'* *'gfm'*
Bram Moolenaar6e932462014-09-09 18:48:09 +02003978'grepformat' 'gfm' string (default "%f:%l:%m,%f:%l%m,%f %l%m")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003979 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003980 Format to recognize for the ":grep" command output.
3981 This is a scanf-like string that uses the same format as the
3982 'errorformat' option: see |errorformat|.
3983
3984 *'grepprg'* *'gp'*
3985'grepprg' 'gp' string (default "grep -n ",
3986 Unix: "grep -n $* /dev/null",
3987 Win32: "findstr /n" or "grep -n",
3988 VMS: "SEARCH/NUMBERS ")
3989 global or local to buffer |global-local|
Bram Moolenaar582fd852005-03-28 20:58:01 +00003990 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003991 and '#' characters, which are expanded like when used in a command-
3992 line. The placeholder "$*" is allowed to specify where the arguments
3993 will be included. Environment variables are expanded |:set_env|. See
3994 |option-backslash| about including spaces and backslashes.
3995 When your "grep" accepts the "-H" argument, use this to make ":grep"
3996 also work well with a single file: >
3997 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00003998< Special value: When 'grepprg' is set to "internal" the |:grep| command
Bram Moolenaara6557602006-02-04 22:43:20 +00003999 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like
4000 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00004001 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00004002 apply equally to 'grepprg'.
4003 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
4004 otherwise it's "grep -n".
4005 This option cannot be set from a |modeline| or in the |sandbox|, for
4006 security reasons.
4007
4008 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
4009'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
4010 ve:ver35-Cursor,
4011 o:hor50-Cursor,
4012 i-ci:ver25-Cursor/lCursor,
4013 r-cr:hor20-Cursor/lCursor,
4014 sm:block-Cursor
4015 -blinkwait175-blinkoff150-blinkon175",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01004016 for Win32 console:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004017 "n-v-c:block,o:hor50,i-ci:hor15,
4018 r-cr:hor30,sm:block")
4019 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004020 {only available when compiled with GUI enabled, and
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01004021 for Win32 console}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004022 This option tells Vim what the cursor should look like in different
Bram Moolenaar8024f932020-01-14 19:29:13 +01004023 modes. It fully works in the GUI. In a Win32 console, only the
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01004024 height of the cursor can be changed. This can be done by specifying a
4025 block cursor, or a percentage for a vertical or horizontal cursor.
Bram Moolenaar1e7813a2015-03-31 18:31:03 +02004026 For a console the 't_SI', 't_SR', and 't_EI' escape sequences are
4027 used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004028
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004029 The option is a comma-separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004030 mode-list and an argument-list:
4031 mode-list:argument-list,mode-list:argument-list,..
4032 The mode-list is a dash separated list of these modes:
4033 n Normal mode
4034 v Visual mode
4035 ve Visual mode with 'selection' "exclusive" (same as 'v',
4036 if not specified)
4037 o Operator-pending mode
4038 i Insert mode
4039 r Replace mode
4040 c Command-line Normal (append) mode
4041 ci Command-line Insert mode
4042 cr Command-line Replace mode
4043 sm showmatch in Insert mode
4044 a all modes
4045 The argument-list is a dash separated list of these arguments:
4046 hor{N} horizontal bar, {N} percent of the character height
4047 ver{N} vertical bar, {N} percent of the character width
4048 block block cursor, fills the whole character
4049 [only one of the above three should be present]
4050 blinkwait{N} *cursor-blinking*
4051 blinkon{N}
4052 blinkoff{N}
4053 blink times for cursor: blinkwait is the delay before
4054 the cursor starts blinking, blinkon is the time that
4055 the cursor is shown and blinkoff is the time that the
4056 cursor is not shown. The times are in msec. When one
4057 of the numbers is zero, there is no blinking. The
4058 default is: "blinkwait700-blinkon400-blinkoff250".
4059 These numbers are used for a missing entry. This
4060 means that blinking is enabled by default. To switch
4061 blinking off you can use "blinkon0". The cursor only
4062 blinks when Vim is waiting for input, not while
4063 executing a command.
4064 To make the cursor blink in an xterm, see
4065 |xterm-blink|.
4066 {group-name}
4067 a highlight group name, that sets the color and font
4068 for the cursor
4069 {group-name}/{group-name}
4070 Two highlight group names, the first is used when
4071 no language mappings are used, the other when they
4072 are. |language-mapping|
4073
4074 Examples of parts:
4075 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
4076 block cursor with colors from the "nCursor"
4077 highlight group
4078 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
4079 In Insert and Command-line Insert mode, use a
4080 30% vertical bar cursor with colors from the
4081 "iCursor" highlight group. Blink a bit
4082 faster.
4083
4084 The 'a' mode is different. It will set the given argument-list for
4085 all modes. It does not reset anything to defaults. This can be used
4086 to do a common setting for all modes. For example, to switch off
4087 blinking: "a:blinkon0"
4088
4089 Examples of cursor highlighting: >
4090 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
4091 :highlight Cursor gui=NONE guifg=bg guibg=fg
4092<
4093 *'guifont'* *'gfn'*
Bram Moolenaar251e1912011-06-19 05:09:16 +02004094 *E235* *E596*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004095'guifont' 'gfn' string (default "")
4096 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004097 {only available when compiled with GUI enabled}
4098 This is a list of fonts which will be used for the GUI version of Vim.
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02004099 In its simplest form the value is just one font name.
4100 See |gui-font| for the details.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004101
4102 *'guifontset'* *'gfs'*
4103 *E250* *E252* *E234* *E597* *E598*
4104'guifontset' 'gfs' string (default "")
4105 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004106 {only available when compiled with GUI enabled and
4107 with the |+xfontset| feature}
Bram Moolenaar3df01732017-02-17 22:47:16 +01004108 {not available in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004109 When not empty, specifies two (or more) fonts to be used. The first
4110 one for normal English, the second one for your special language. See
4111 |xfontset|.
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02004112
Bram Moolenaar071d4272004-06-13 20:20:40 +00004113 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
4114'guifontwide' 'gfw' string (default "")
4115 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004116 {only available when compiled with GUI enabled}
4117 When not empty, specifies a comma-separated list of fonts to be used
4118 for double-width characters. The first font that can be loaded is
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02004119 used. See |gui-fontwide|.
Bram Moolenaar0f272122013-01-23 18:37:40 +01004120
Bram Moolenaar071d4272004-06-13 20:20:40 +00004121 *'guiheadroom'* *'ghr'*
4122'guiheadroom' 'ghr' number (default 50)
4123 global
Bram Moolenaar110289e2019-05-23 15:38:06 +02004124 {only for GTK and X11 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004125 The number of pixels subtracted from the screen height when fitting
4126 the GUI window on the screen. Set this before the GUI is started,
4127 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004128 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00004129 lines will be left for window decorations and other items on the
4130 screen. Set it to a negative value to allow windows taller than the
4131 screen.
4132
Dusan Popovic4eeedc02021-10-16 20:52:05 +01004133 *'guiligatures'* *'gli'* *E1243*
4134'guiligatures' 'gli' string (default "")
4135 global
Erik S. V. Jansson8b1e7492024-02-24 14:26:52 +01004136 {only for GTK and Win32 GUI}
Dusan Popovic4eeedc02021-10-16 20:52:05 +01004137 List of ASCII characters that, when combined together, can create more
4138 complex shapes. Each character must be a printable ASCII character
4139 with a value in the 32-127 range.
4140 Example: >
4141 :set guiligatures=!\"#$%&()*+-./:<=>?@[]^_{\|~
4142< Changing this option updates screen output immediately. Set it to an
4143 empty string to disable ligatures.
4144
Bram Moolenaar071d4272004-06-13 20:20:40 +00004145 *'guioptions'* *'go'*
Bram Moolenaar2c64ca12018-10-19 16:22:31 +02004146'guioptions' 'go' string (default "egmrLtT" (MS-Windows,
4147 "t" is removed in |defaults.vim|),
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004148 "aegimrLtT" (GTK and Motif),
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004149 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00004150 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004151 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00004152 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004153 sequence of letters which describes what components and options of the
4154 GUI should be used.
4155 To avoid problems with flags that are added in the future, use the
4156 "+=" and "-=" feature of ":set" |add-option-flags|.
4157
Bram Moolenaar13568252018-03-16 20:46:58 +01004158 Valid characters are as follows:
4159 *'go-!'*
4160 '!' External commands are executed in a terminal window. Without
4161 this flag the MS-Windows GUI will open a console window to
4162 execute the command. The Unix GUI will simulate a dumb
4163 terminal to list the command output.
4164 The terminal window will be positioned at the bottom, and grow
4165 upwards as needed.
Bram Moolenaarba3ff532018-11-04 14:45:49 +01004166 *'go-a'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004167 'a' Autoselect: If present, then whenever VISUAL mode is started,
4168 or the Visual area extended, Vim tries to become the owner of
4169 the windowing system's global selection. This means that the
4170 Visually highlighted text is available for pasting into other
4171 applications as well as into Vim itself. When the Visual mode
4172 ends, possibly due to an operation on the text, or when an
4173 application wants to paste the selection, the highlighted text
4174 is automatically yanked into the "* selection register.
4175 Thus the selection is still available for pasting into other
4176 applications after the VISUAL mode has ended.
4177 If not present, then Vim won't become the owner of the
4178 windowing system's global selection unless explicitly told to
4179 by a yank or delete operation for the "* register.
4180 The same applies to the modeless selection.
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02004181 *'go-P'*
4182 'P' Like autoselect but using the "+ register instead of the "*
Bram Moolenaar3848e002016-03-19 18:42:29 +01004183 register.
Bram Moolenaar02467872007-05-06 13:22:01 +00004184 *'go-A'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004185 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00004186 applies to the modeless selection.
4187
4188 'guioptions' autoselect Visual autoselect modeless ~
4189 "" - -
4190 "a" yes yes
4191 "A" - yes
4192 "aA" yes yes
4193
Bram Moolenaar9fbdbb82022-09-27 17:30:34 +01004194 When using a terminal see the 'clipboard' option.
4195
Bram Moolenaar02467872007-05-06 13:22:01 +00004196 *'go-c'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004197 'c' Use console dialogs instead of popup dialogs for simple
4198 choices.
Bram Moolenaar50bf7ce2019-09-15 13:17:00 +02004199 *'go-d'*
4200 'd' Use dark theme variant if available. Currently only works for
4201 GTK+ GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00004202 *'go-e'*
Bram Moolenaare224ffa2006-03-01 00:01:28 +00004203 'e' Add tab pages when indicated with 'showtabline'.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004204 'guitablabel' can be used to change the text in the labels.
4205 When 'e' is missing a non-GUI tab pages line may be used.
Bram Moolenaard68071d2006-05-02 22:08:30 +00004206 The GUI tabs are only supported on some systems, currently
Bram Moolenaarb3f74062020-02-26 16:16:53 +01004207 GTK, Motif, Mac OS/X, Haiku, and MS-Windows.
Bram Moolenaar02467872007-05-06 13:22:01 +00004208 *'go-f'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004209 'f' Foreground: Don't use fork() to detach the GUI from the shell
4210 where it was started. Use this for programs that wait for the
4211 editor to finish (e.g., an e-mail program). Alternatively you
4212 can use "gvim -f" or ":gui -f" to start the GUI in the
4213 foreground. |gui-fork|
4214 Note: Set this option in the vimrc file. The forking may have
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004215 happened already when the |gvimrc| file is read.
Bram Moolenaar02467872007-05-06 13:22:01 +00004216 *'go-i'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004217 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
4218 corner of the window. It's black&white on non-GTK, because of
4219 limitations of X11. For a color icon, see |X11-icon|.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004220 *'go-m'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004221 'm' Menu bar is present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004222 *'go-M'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004223 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00004224 that this flag must be added in the .vimrc file, before
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004225 switching on syntax or filetype recognition (when the |gvimrc|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004226 file is sourced the system menu has already been loaded; the
Bram Moolenaar01164a62017-11-02 22:58:42 +01004227 `:syntax on` and `:filetype on` commands load the menu too).
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004228 *'go-g'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004229 'g' Grey menu items: Make menu items that are not active grey. If
4230 'g' is not included inactive menu items are not shown at all.
Bram Moolenaar02467872007-05-06 13:22:01 +00004231 *'go-t'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004232 't' Include tearoff menu items. Currently only works for Win32,
4233 GTK+, and Motif 1.2 GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00004234 *'go-T'*
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004235 'T' Include Toolbar. Currently only in Win32, GTK+, Motif and
4236 Photon GUIs.
Bram Moolenaar02467872007-05-06 13:22:01 +00004237 *'go-r'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004238 'r' Right-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004239 *'go-R'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004240 'R' Right-hand scrollbar is present when there is a vertically
4241 split window.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004242 *'go-l'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004243 'l' Left-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004244 *'go-L'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004245 'L' Left-hand scrollbar is present when there is a vertically
4246 split window.
Bram Moolenaar02467872007-05-06 13:22:01 +00004247 *'go-b'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004248 'b' Bottom (horizontal) scrollbar is present. Its size depends on
4249 the longest visible line, or on the cursor line if the 'h'
4250 flag is included. |gui-horiz-scroll|
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004251 *'go-h'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004252 'h' Limit horizontal scrollbar size to the length of the cursor
4253 line. Reduces computations. |gui-horiz-scroll|
4254
4255 And yes, you may even have scrollbars on the left AND the right if
4256 you really want to :-). See |gui-scrollbars| for more information.
4257
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004258 *'go-v'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004259 'v' Use a vertical button layout for dialogs. When not included,
4260 a horizontal layout is preferred, but when it doesn't fit a
Bram Moolenaardad44732021-03-31 20:07:33 +02004261 vertical layout is used anyway. Not supported in GTK 3.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004262 *'go-p'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004263 'p' Use Pointer callbacks for X11 GUI. This is required for some
4264 window managers. If the cursor is not blinking or hollow at
4265 the right moment, try adding this flag. This must be done
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004266 before starting the GUI. Set it in your |gvimrc|. Adding or
Bram Moolenaar071d4272004-06-13 20:20:40 +00004267 removing it after the GUI has started has no effect.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004268 *'go-F'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004269 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar8ac44152017-11-09 18:33:29 +01004270 *'go-k'*
4271 'k' Keep the GUI window size when adding/removing a scrollbar, or
4272 toolbar, tabline, etc. Instead, the behavior is similar to
4273 when the window is maximized and will adjust 'lines' and
4274 'columns' to fit to the window. Without the 'k' flag Vim will
Bram Moolenaar51b0f372017-11-18 18:52:04 +01004275 try to keep 'lines' and 'columns' the same when adding and
Bram Moolenaar8ac44152017-11-09 18:33:29 +01004276 removing GUI components.
Bram Moolenaar02467872007-05-06 13:22:01 +00004277
Bram Moolenaar071d4272004-06-13 20:20:40 +00004278 *'guipty'* *'noguipty'*
4279'guipty' boolean (default on)
4280 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004281 {only available when compiled with GUI enabled}
4282 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
4283 I/O to/from shell commands. See |gui-pty|.
4284
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004285 *'guitablabel'* *'gtl'*
4286'guitablabel' 'gtl' string (default empty)
4287 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02004288 {only available when compiled with GUI enabled}
Bram Moolenaar944697a2022-02-20 19:48:20 +00004289 When non-empty describes the text to use in a label of the GUI tab
Bram Moolenaard68071d2006-05-02 22:08:30 +00004290 pages line. When empty and when the result is empty Vim will use a
4291 default label. See |setting-guitablabel| for more info.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004292
Bram Moolenaara23ccb82006-02-27 00:08:02 +00004293 The format of this option is like that of 'statusline'.
Bram Moolenaar57657d82006-04-21 22:12:41 +00004294 'guitabtooltip' is used for the tooltip, see below.
Bram Moolenaar51628222016-12-01 23:03:28 +01004295 The expression will be evaluated in the |sandbox| when set from a
4296 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004297 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00004298
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004299 Only used when the GUI tab pages line is displayed. 'e' must be
4300 present in 'guioptions'. For the non-GUI tab pages line 'tabline' is
4301 used.
4302
Bram Moolenaar57657d82006-04-21 22:12:41 +00004303 *'guitabtooltip'* *'gtt'*
4304'guitabtooltip' 'gtt' string (default empty)
4305 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02004306 {only available when compiled with GUI enabled}
Bram Moolenaar944697a2022-02-20 19:48:20 +00004307 When non-empty describes the text to use in a tooltip for the GUI tab
Bram Moolenaar57657d82006-04-21 22:12:41 +00004308 pages line. When empty Vim will use a default tooltip.
4309 This option is otherwise just like 'guitablabel' above.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004310 You can include a line break. Simplest method is to use |:let|: >
4311 :let &guitabtooltip = "line one\nline two"
4312<
Bram Moolenaar57657d82006-04-21 22:12:41 +00004313
Bram Moolenaar071d4272004-06-13 20:20:40 +00004314 *'helpfile'* *'hf'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01004315'helpfile' 'hf' string (default (MS-Windows) "$VIMRUNTIME\doc\help.txt"
Bram Moolenaar071d4272004-06-13 20:20:40 +00004316 (others) "$VIMRUNTIME/doc/help.txt")
4317 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004318 Name of the main help file. All distributed help files should be
4319 placed together in one directory. Additionally, all "doc" directories
4320 in 'runtimepath' will be used.
4321 Environment variables are expanded |:set_env|. For example:
4322 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004323 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00004324 spaces and backslashes.
4325 This option cannot be set from a |modeline| or in the |sandbox|, for
4326 security reasons.
4327
4328 *'helpheight'* *'hh'*
4329'helpheight' 'hh' number (default 20)
4330 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004331 Minimal initial height of the help window when it is opened with the
4332 ":help" command. The initial height of the help window is half of the
4333 current window, or (when the 'ea' option is on) the same as other
4334 windows. When the height is less than 'helpheight', the height is
4335 set to 'helpheight'. Set to zero to disable.
4336
4337 *'helplang'* *'hlg'*
4338'helplang' 'hlg' string (default: messages language or empty)
4339 global
4340 {only available when compiled with the |+multi_lang|
4341 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004342 Comma-separated list of languages. Vim will use the first language
Bram Moolenaar071d4272004-06-13 20:20:40 +00004343 for which the desired help can be found. The English help will always
4344 be used as a last resort. You can add "en" to prefer English over
4345 another language, but that will only find tags that exist in that
4346 language and not in the English help.
4347 Example: >
4348 :set helplang=de,it
4349< This will first search German, then Italian and finally English help
4350 files.
4351 When using |CTRL-]| and ":help!" in a non-English help file Vim will
4352 try to find the tag in the current language before using this option.
4353 See |help-translated|.
4354
4355 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
4356'hidden' 'hid' boolean (default off)
4357 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004358 When off a buffer is unloaded when it is |abandon|ed. When on a
4359 buffer becomes hidden when it is |abandon|ed. If the buffer is still
4360 displayed in another window, it does not become hidden, of course.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004361
Bram Moolenaar071d4272004-06-13 20:20:40 +00004362 The commands that move through the buffer list sometimes make a buffer
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004363 hidden even if the 'hidden' option is off when these three are true:
4364 - the buffer is modified
4365 - 'autowrite' is off or writing is not possible
4366 - the '!' flag was used
4367 Also see |windows.txt|.
4368
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004369 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004370 This option is set for one command with ":hide {command}" |:hide|.
4371 WARNING: It's easy to forget that you have changes in hidden buffers.
4372 Think twice when using ":q!" or ":qa!".
4373
4374 *'highlight'* *'hl'*
4375'highlight' 'hl' string (default (as a single string):
Bram Moolenaar58b85342016-08-14 19:54:54 +02004376 "8:SpecialKey,~:EndOfBuffer,@:NonText,
4377 d:Directory,e:ErrorMsg,i:IncSearch,
4378 l:Search,m:MoreMsg,M:ModeMsg,n:LineNr,
Bram Moolenaarefae76a2019-10-27 22:54:58 +01004379 a:LineNrAbove,b:LineNrBelow,
Bram Moolenaar58b85342016-08-14 19:54:54 +02004380 N:CursorLineNr,r:Question,s:StatusLine,
4381 S:StatusLineNC,c:VertSplit,t:Title,
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004382 v:Visual,V:VisualNOS,w:WarningMsg,
4383 W:WildMenu,f:Folded,F:FoldColumn,
4384 A:DiffAdd,C:DiffChange,D:DiffDelete,
4385 T:DiffText,>:SignColumn,-:Conceal,
Bram Moolenaarc8c88492018-12-27 23:59:26 +01004386 B:SpellBad,P:SpellCap,R:SpellRare,
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004387 L:SpellLocal,+:Pmenu,=:PmenuSel,
glepnir40c1c332024-06-11 19:37:04 +02004388 k:PmenuMatch,<:PmenuMatchSel,
Gianmaria Bajo6a7c7742023-03-10 16:35:53 +00004389 [:PmenuKind,]:PmenuKindSel,
4390 {:PmenuExtra,}:PmenuExtraSel,
Bram Moolenaar21020352017-06-13 17:21:04 +02004391 x:PmenuSbar,X:PmenuThumb,*:TabLine,
4392 #:TabLineSel,_:TabLineFill,!:CursorColumn,
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02004393 .:CursorLine,o:ColorColumn,q:QuickFixLine,
Christian Brabandtfb745752024-05-07 21:19:03 +02004394 z:StatusLineTerm,Z:StatusLineTermNC,
glepnirad409872025-01-10 20:08:20 +01004395 g:MsgArea,h:ComplMatchIns")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004396 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004397 This option can be used to set highlighting mode for various
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004398 occasions. It is a comma-separated list of character pairs. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00004399 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004400 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004401 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
Bram Moolenaar58b85342016-08-14 19:54:54 +02004402 |hl-EndOfBuffer| ~ lines after the last line in the buffer
4403 |hl-NonText| @ '@' at the end of the window and
Bram Moolenaar071d4272004-06-13 20:20:40 +00004404 characters from 'showbreak'
4405 |hl-Directory| d directories in CTRL-D listing and other special
4406 things in listings
4407 |hl-ErrorMsg| e error messages
4408 h (obsolete, ignored)
4409 |hl-IncSearch| i 'incsearch' highlighting
LemonBoya4399382022-04-09 21:04:08 +01004410 |hl-CurSearch| y current instance of last search pattern
Bram Moolenaar071d4272004-06-13 20:20:40 +00004411 |hl-Search| l last search pattern highlighting (see 'hlsearch')
4412 |hl-MoreMsg| m |more-prompt|
4413 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
Christian Brabandtfb745752024-05-07 21:19:03 +02004414 |hl-MsgArea| g |Command-line| and message area
glepnirad409872025-01-10 20:08:20 +01004415 |hl-ComplMatchIns| h matched text of currently inserted completion
Bram Moolenaar64486672010-05-16 15:46:46 +02004416 |hl-LineNr| n line number for ":number" and ":#" commands, and
4417 when 'number' or 'relativenumber' option is set.
Bram Moolenaarefae76a2019-10-27 22:54:58 +01004418 |hl-LineNrAbove| a line number above the cursor for when the
4419 'relativenumber' option is set.
4420 |hl-LineNrBelow| b line number below the cursor for when the
4421 'relativenumber' option is set.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01004422 |hl-CursorLineNr| N like n for when 'cursorline' or 'relativenumber' is
4423 set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004424 |hl-Question| r |hit-enter| prompt and yes/no questions
4425 |hl-StatusLine| s status line of current window |status-line|
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01004426 |hl-StatusLineNC| S status lines of not-current windows
Bram Moolenaar071d4272004-06-13 20:20:40 +00004427 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
4428 |hl-VertSplit| c column used to separate vertically split windows
4429 |hl-Visual| v Visual mode
4430 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
4431 Selection" Only X11 Gui's |gui-x11| and
4432 |xterm-clipboard|.
4433 |hl-WarningMsg| w warning messages
4434 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
4435 |hl-Folded| f line used for closed folds
4436 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00004437 |hl-DiffAdd| A added line in diff mode
4438 |hl-DiffChange| C changed line in diff mode
4439 |hl-DiffDelete| D deleted line in diff mode
4440 |hl-DiffText| T inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00004441 |hl-SignColumn| > column used for |signs|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004442 |hl-Conceal| - the placeholders used for concealed characters
4443 (see 'conceallevel')
Bram Moolenaar217ad922005-03-20 22:37:15 +00004444 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02004445 |hl-SpellCap| P word that should start with capital |spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00004446 |hl-SpellRare| R rare word |spell|
4447 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004448 |hl-Pmenu| + popup menu normal line
4449 |hl-PmenuSel| = popup menu selected line
Gianmaria Bajo6a7c7742023-03-10 16:35:53 +00004450 |hl-PmenuKind| [ popup menu "kind" normal line
4451 |hl-PmenuKindSel| ] popup menu "kind" selected line
h_east59858792023-10-25 22:47:05 +09004452 |hl-PmenuExtra| { popup menu "extra" normal line
4453 |hl-PmenuExtraSel| } popup menu "extra" selected line
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004454 |hl-PmenuSbar| x popup menu scrollbar
4455 |hl-PmenuThumb| X popup menu scrollbar thumb
glepnir40c1c332024-06-11 19:37:04 +02004456 |hl-PmenuMatch| k popup menu matched text
4457 |hl-PmenuMatchSel| < popup menu matched text in selected line
Bram Moolenaar071d4272004-06-13 20:20:40 +00004458
4459 The display modes are:
4460 r reverse (termcap entry "mr" and "me")
4461 i italic (termcap entry "ZH" and "ZR")
4462 b bold (termcap entry "md" and "me")
4463 s standout (termcap entry "so" and "se")
4464 u underline (termcap entry "us" and "ue")
Bram Moolenaar84f54632022-06-29 18:39:11 +01004465 c undercurl (termcap entry "Us" and "Ce")
4466 2 double underline (termcap entry "Ds" and "Ce")
4467 d dotted underline (termcap entry "ds" and "Ce")
4468 = dashed underline (termcap entry "Ds" and "Ce")
Bram Moolenaarcf4b00c2017-09-02 18:33:56 +02004469 t strikethrough (termcap entry "Ts" and "Te")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004470 n no highlighting
4471 - no highlighting
4472 : use a highlight group
4473 The default is used for occasions that are not included.
4474 If you want to change what the display modes do, see |dos-colors|
4475 for an example.
4476 When using the ':' display mode, this must be followed by the name of
4477 a highlight group. A highlight group can be used to define any type
4478 of highlighting, including using color. See |:highlight| on how to
4479 define one. The default uses a different group for each occasion.
4480 See |highlight-default| for the default highlight groups.
4481
Bram Moolenaar071d4272004-06-13 20:20:40 +00004482 *'history'* *'hi'*
Luca Saccarolac0d30ef2024-11-28 22:27:28 +01004483'history' 'hi' number (Vim default: 200, Vi default: 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004484 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004485 A history of ":" commands, and a history of previous search patterns
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004486 is remembered. This option decides how many entries may be stored in
Christian Brabandt51d4d842024-12-06 17:26:25 +01004487 each of these histories (see |cmdline-editing| and 'messagesopt' for
Shougo Matsushita4bd9b2b2024-11-14 22:31:48 +01004488 the number of messages to remember).
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004489 The maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004490 NOTE: This option is set to the Vi default value when 'compatible' is
4491 set and to the Vim default value when 'compatible' is reset.
4492
4493 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
4494'hkmap' 'hk' boolean (default off)
4495 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004496 {only available when compiled with the |+rightleft|
4497 feature}
4498 When on, the keyboard is mapped for the Hebrew character set.
4499 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
4500 toggle this option. See |rileft.txt|.
4501 NOTE: This option is reset when 'compatible' is set.
4502
4503 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
4504'hkmapp' 'hkp' 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, phonetic keyboard mapping is used. 'hkmap' must also be on.
4509 This is useful if you have a non-Hebrew keyboard.
4510 See |rileft.txt|.
4511 NOTE: This option is reset when 'compatible' is set.
4512
Bram Moolenaar036986f2017-03-16 17:41:02 +01004513 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
4514'hlsearch' 'hls' boolean (default off)
4515 global
Bram Moolenaar036986f2017-03-16 17:41:02 +01004516 {not available when compiled without the
4517 |+extra_search| feature}
4518 When there is a previous search pattern, highlight all its matches.
4519 The type of highlighting used can be set with the 'l' occasion in the
4520 'highlight' option. This uses the "Search" highlight group by
4521 default. Note that only the matching text is highlighted, any offsets
Bram Moolenaarcfa8f9a2022-06-03 21:59:47 +01004522 are not applied. If the "CurSearch" highlight group is set then the
4523 current match is highlighted with that.
Bram Moolenaar036986f2017-03-16 17:41:02 +01004524 See also: 'incsearch' and |:match|.
4525 When you get bored looking at the highlighted matches, you can turn it
4526 off with |:nohlsearch|. This does not change the option value, as
4527 soon as you use a search command, the highlighting comes back.
4528 'redrawtime' specifies the maximum time spent on finding matches.
4529 When the search pattern can match an end-of-line, Vim will try to
4530 highlight all of the matched text. However, this depends on where the
4531 search starts. This will be the first line in the window or the first
4532 line below a closed fold. A match in a previous line which is not
4533 drawn may not continue in a newly drawn line.
4534 You can specify whether the highlight status is restored on startup
4535 with the 'h' flag in 'viminfo' |viminfo-h|.
4536 NOTE: This option is reset when 'compatible' is set.
4537
Bram Moolenaar071d4272004-06-13 20:20:40 +00004538 *'icon'* *'noicon'*
4539'icon' boolean (default off, on when title can be restored)
4540 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004541 When on, the icon text of the window will be set to the value of
4542 'iconstring' (if it is not empty), or to the name of the file
4543 currently being edited. Only the last part of the name is used.
4544 Overridden by the 'iconstring' option.
4545 Only works if the terminal supports setting window icons (currently
4546 only X11 GUI and terminals with a non-empty 't_IS' option - these are
4547 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
4548 builtin termcap).
4549 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00004550 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00004551 X11.
Bram Moolenaar3a991dd2014-10-02 01:41:41 +02004552 For MS-Windows the icon can be changed, see |windows-icon|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004553
4554 *'iconstring'*
4555'iconstring' string (default "")
4556 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004557 When this option is not empty, it will be used for the icon text of
4558 the window. This happens only when the 'icon' option is on.
4559 Only works if the terminal supports setting window icon text
4560 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02004561 Does not work for MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004562 When Vim was compiled with HAVE_X11 defined, the original icon will be
4563 restored if possible |X11|.
4564 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004565 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004566 'titlestring' for example settings.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004567 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004568 {not available when compiled without the |+statusline| feature}
4569
4570 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
4571'ignorecase' 'ic' boolean (default off)
4572 global
Yee Cheng Chin2bbd0d32023-10-14 02:23:45 -07004573 Ignore case in search patterns, |cmdline-completion|, when
4574 searching in the tags file, and non-|Vim9| |expr-==|.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01004575 Also see 'smartcase' and 'tagcase'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004576 Can be overruled by using "\c" or "\C" in the pattern, see
4577 |/ignorecase|.
4578
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004579 *'imactivatefunc'* *'imaf'*
4580'imactivatefunc' 'imaf' string (default "")
4581 global
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004582 This option specifies a function that will be called to
Yegappan Lakshmanan7645da52021-12-04 14:02:30 +00004583 activate or deactivate the Input Method. The value can be the name of
4584 a function, a |lambda| or a |Funcref|. See |option-value-function| for
4585 more information.
Bram Moolenaaref8c6172020-07-01 15:12:44 +02004586 It is not used in the MS-Windows GUI version.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004587 The expression will be evaluated in the |sandbox| when set from a
4588 modeline, see |sandbox-option|.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004589
4590 Example: >
4591 function ImActivateFunc(active)
4592 if a:active
4593 ... do something
4594 else
4595 ... do something
4596 endif
4597 " return value is not used
4598 endfunction
4599 set imactivatefunc=ImActivateFunc
4600<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004601 *'imactivatekey'* *'imak'*
4602'imactivatekey' 'imak' string (default "")
4603 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004604 {only available when compiled with |+xim| and
Bram Moolenaar67c53842010-05-22 18:28:27 +02004605 |+GUI_GTK|} *E599*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004606 Specifies the key that your Input Method in X-Windows uses for
4607 activation. When this is specified correctly, vim can fully control
4608 IM with 'imcmdline', 'iminsert' and 'imsearch'.
4609 You can't use this option to change the activation key, the option
4610 tells Vim what the key is.
4611 Format:
4612 [MODIFIER_FLAG-]KEY_STRING
4613
4614 These characters can be used for MODIFIER_FLAG (case is ignored):
4615 S Shift key
4616 L Lock key
4617 C Control key
4618 1 Mod1 key
4619 2 Mod2 key
4620 3 Mod3 key
4621 4 Mod4 key
4622 5 Mod5 key
4623 Combinations are allowed, for example "S-C-space" or "SC-space" are
4624 both shift+ctrl+space.
4625 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
4626
4627 Example: >
4628 :set imactivatekey=S-space
4629< "S-space" means shift+space. This is the activation key for kinput2 +
4630 canna (Japanese), and ami (Korean).
4631
4632 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
4633'imcmdline' 'imc' boolean (default off)
4634 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004635 When set the Input Method is always on when starting to edit a command
4636 line, unless entering a search pattern (see 'imsearch' for that).
4637 Setting this option is useful when your input method allows entering
4638 English characters directly, e.g., when it's used to type accented
4639 characters with dead keys.
4640
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004641 *'imdisable'* *'imd'* *'noimdisable'* *'noimd'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004642'imdisable' 'imd' boolean (default off, on for some systems (SGI))
4643 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004644 When set the Input Method is never used. This is useful to disable
4645 the IM when it doesn't work properly.
4646 Currently this option is on by default for SGI/IRIX machines. This
4647 may change in later releases.
4648
4649 *'iminsert'* *'imi'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004650'iminsert' 'imi' number (default 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004651 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004652 Specifies whether :lmap or an Input Method (IM) is to be used in
4653 Insert mode. Valid values:
4654 0 :lmap is off and IM is off
4655 1 :lmap is ON and IM is off
4656 2 :lmap is off and IM is ON
Bram Moolenaar071d4272004-06-13 20:20:40 +00004657 To always reset the option to zero when leaving Insert mode with <Esc>
4658 this can be used: >
4659 :inoremap <ESC> <ESC>:set iminsert=0<CR>
4660< This makes :lmap and IM turn off automatically when leaving Insert
4661 mode.
4662 Note that this option changes when using CTRL-^ in Insert mode
4663 |i_CTRL-^|.
4664 The value is set to 1 when setting 'keymap' to a valid keymap name.
4665 It is also used for the argument of commands like "r" and "f".
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004666 The value 0 may not work correctly with Motif with some XIM
Bram Moolenaar071d4272004-06-13 20:20:40 +00004667 methods. Use 'imdisable' to disable XIM then.
4668
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004669 You can set 'imactivatefunc' and 'imstatusfunc' to handle IME/XIM
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004670 via external command if Vim is not compiled with the |+xim|,
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004671 |+multi_byte_ime| or |global-ime|.
4672
Bram Moolenaar071d4272004-06-13 20:20:40 +00004673 *'imsearch'* *'ims'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004674'imsearch' 'ims' number (default -1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004675 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004676 Specifies whether :lmap or an Input Method (IM) is to be used when
4677 entering a search pattern. Valid values:
4678 -1 the value of 'iminsert' is used, makes it look like
4679 'iminsert' is also used when typing a search pattern
4680 0 :lmap is off and IM is off
4681 1 :lmap is ON and IM is off
4682 2 :lmap is off and IM is ON
4683 Note that this option changes when using CTRL-^ in Command-line mode
4684 |c_CTRL-^|.
4685 The value is set to 1 when it is not -1 and setting the 'keymap'
4686 option to a valid keymap name.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004687 The value 0 may not work correctly with Motif with some XIM
Bram Moolenaar071d4272004-06-13 20:20:40 +00004688 methods. Use 'imdisable' to disable XIM then.
4689
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004690 *'imstatusfunc'* *'imsf'*
4691'imstatusfunc' 'imsf' string (default "")
4692 global
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004693 This option specifies a function that is called to obtain the status
4694 of Input Method. It must return a positive number when IME is active.
Yegappan Lakshmanan7645da52021-12-04 14:02:30 +00004695 The value can be the name of a function, a |lambda| or a |Funcref|.
4696 See |option-value-function| for more information.
Bram Moolenaaref8c6172020-07-01 15:12:44 +02004697 It is not used in the MS-Windows GUI version.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004698
4699 Example: >
4700 function ImStatusFunc()
4701 let is_active = ...do something
4702 return is_active ? 1 : 0
4703 endfunction
4704 set imstatusfunc=ImStatusFunc
4705<
4706 NOTE: This function is invoked very often. Keep it fast.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004707 The expression will be evaluated in the |sandbox| when set from a
4708 modeline, see |sandbox-option|.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004709
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004710 *'imstyle'* *'imst'*
4711'imstyle' 'imst' number (default 1)
4712 global
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004713 {only available when compiled with |+xim| and
4714 |+GUI_GTK|}
Bram Moolenaar37c64c72017-09-19 22:06:03 +02004715 This option specifies the input style of Input Method:
4716 0 use on-the-spot style
4717 1 over-the-spot style
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004718 See: |xim-input-style|
4719
Bram Moolenaar24a98a02017-09-27 22:23:55 +02004720 For a long time on-the-spot style had been used in the GTK version of
4721 vim, however, it is known that it causes troubles when using mappings,
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004722 |single-repeat|, etc. Therefore over-the-spot style becomes the
4723 default now. This should work fine for most people, however if you
4724 have any problem with it, try using on-the-spot style.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004725 The expression will be evaluated in the |sandbox| when set from a
4726 modeline, see |sandbox-option|.
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004727
Bram Moolenaar071d4272004-06-13 20:20:40 +00004728 *'include'* *'inc'*
4729'include' 'inc' string (default "^\s*#\s*include")
4730 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004731 {not available when compiled without the
4732 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004733 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00004734 pattern, just like for the "/" command (See |pattern|). The default
4735 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar1e015462005-09-25 22:16:38 +00004736 "]I", "[d", etc.
4737 Normally the 'isfname' option is used to recognize the file name that
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004738 comes after the matched pattern. But if "\zs" appears in the pattern
4739 then the text matched from "\zs" to the end, or until "\ze" if it
4740 appears, is used as the file name. Use this to include characters
4741 that are not in 'isfname', such as a space. You can then use
4742 'includeexpr' to process the matched text.
Bram Moolenaar1e015462005-09-25 22:16:38 +00004743 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004744
4745 *'includeexpr'* *'inex'*
4746'includeexpr' 'inex' string (default "")
4747 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004748 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004749 |+find_in_path| or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004750 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004751 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaarb59ae592022-11-23 23:46:31 +00004752 :setlocal includeexpr=substitute(v:fname,'\\.','/','g')
Bram Moolenaar071d4272004-06-13 20:20:40 +00004753< The "v:fname" variable will be set to the file name that was detected.
Bram Moolenaarb59ae592022-11-23 23:46:31 +00004754 Note the double backslash: the `:set` command first halves them, then
4755 one remains it the value, where "\." matches a dot literally. For
4756 simple character replacements `tr()` avoids the need for escaping: >
4757 :setlocal includeexpr=tr(v:fname,'.','/')
4758<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004759 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004760 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004761 Also used for |<cfile>|.
4762
Yegappan Lakshmanan8bb65f22021-12-26 10:51:39 +00004763 If the expression starts with s: or |<SID>|, then it is replaced with
4764 the script ID (|local-function|). Example: >
Bram Moolenaarb59ae592022-11-23 23:46:31 +00004765 setlocal includeexpr=s:MyIncludeExpr()
4766 setlocal includeexpr=<SID>SomeIncludeExpr()
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00004767< Otherwise, the expression is evaluated in the context of the script
4768 where the option was set, thus script-local items are available.
4769
Bram Moolenaara4e0b972022-10-01 19:43:52 +01004770 It is more efficient if the value is just a function call without
4771 arguments, see |expr-option-function|.
4772
Bram Moolenaar30b65812012-07-12 22:01:11 +02004773 The expression will be evaluated in the |sandbox| when set from a
4774 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004775 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004776
4777 It is not allowed to change text or jump to another window while
4778 evaluating 'includeexpr' |textlock|.
4779
Bram Moolenaar071d4272004-06-13 20:20:40 +00004780 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004781'incsearch' 'is' boolean (default off, set in |defaults.vim| if the
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01004782 |+reltime| feature is supported)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004783 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004784 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004785 |+extra_search| features}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004786 While typing a search command, show where the pattern, as it was typed
4787 so far, matches. The matched string is highlighted. If the pattern
4788 is invalid or not found, nothing is shown. The screen will be updated
4789 often, this is only useful on fast terminals.
Bram Moolenaarfc65cab2018-08-28 22:58:02 +02004790 Also applies to the pattern in commands: >
4791 :global
4792 :lvimgrep
4793 :lvimgrepadd
4794 :smagic
4795 :snomagic
4796 :sort
4797 :substitute
4798 :vglobal
4799 :vimgrep
4800 :vimgrepadd
4801< Note that the match will be shown, but the cursor will return to its
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004802 original position when no match is found and when pressing <Esc>. You
4803 still need to finish the search command with <Enter> to move the
4804 cursor to the match.
Bram Moolenaardc083282016-10-11 08:57:33 +02004805 You can use the CTRL-G and CTRL-T keys to move to the next and
4806 previous match. |c_CTRL-G| |c_CTRL-T|
Bram Moolenaar91a4e822008-01-19 14:59:58 +00004807 When compiled with the |+reltime| feature Vim only searches for about
4808 half a second. With a complicated pattern and/or a lot of text the
4809 match may not be found. This is to avoid that Vim hangs while you
4810 are typing the pattern.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004811 The highlighting can be set with the 'i' flag in 'highlight'.
Bram Moolenaar2f058492017-11-30 20:27:52 +01004812 When 'hlsearch' is on, all matched strings are highlighted too while
4813 typing a search command. See also: 'hlsearch'.
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004814 If you don't want to turn 'hlsearch' on, but want to highlight all
4815 matches while searching, you can turn on and off 'hlsearch' with
4816 autocmd. Example: >
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004817 augroup vimrc-incsearch-highlight
4818 autocmd!
Bram Moolenaarf8f8b2e2017-11-02 19:08:48 +01004819 autocmd CmdlineEnter /,\? :set hlsearch
4820 autocmd CmdlineLeave /,\? :set nohlsearch
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004821 augroup END
4822<
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004823 CTRL-L can be used to add one character from after the current match
Bram Moolenaara9dc3752010-07-11 20:46:53 +02004824 to the command line. If 'ignorecase' and 'smartcase' are set and the
4825 command line has no uppercase characters, the added character is
4826 converted to lowercase.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004827 CTRL-R CTRL-W can be used to add the word at the end of the current
4828 match, excluding the characters that were already typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004829 NOTE: This option is reset when 'compatible' is set.
4830
4831 *'indentexpr'* *'inde'*
4832'indentexpr' 'inde' string (default "")
4833 local to buffer
Bram Moolenaar8e145b82022-05-21 20:17:31 +01004834 {not available when compiled without the |+eval|
4835 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004836 Expression which is evaluated to obtain the proper indent for a line.
4837 It is used when a new line is created, for the |=| operator and
4838 in Insert mode as specified with the 'indentkeys' option.
4839 When this option is not empty, it overrules the 'cindent' and
Bram Moolenaar20f90cf2011-05-19 12:22:51 +02004840 'smartindent' indenting. When 'lisp' is set, this option is
Dominique Pellédf62c622024-07-15 20:29:59 +02004841 only used when 'lispoptions' contains "expr:1".
Bram Moolenaar071d4272004-06-13 20:20:40 +00004842 When 'paste' is set this option is not used for indenting.
4843 The expression is evaluated with |v:lnum| set to the line number for
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004844 which the indent is to be computed. The cursor is also in this line
Bram Moolenaar071d4272004-06-13 20:20:40 +00004845 when the expression is evaluated (but it may be moved around).
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00004846
Yegappan Lakshmanan8bb65f22021-12-26 10:51:39 +00004847 If the expression starts with s: or |<SID>|, then it is replaced with
4848 the script ID (|local-function|). Example: >
4849 set indentexpr=s:MyIndentExpr()
4850 set indentexpr=<SID>SomeIndentExpr()
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00004851< Otherwise, the expression is evaluated in the context of the script
4852 where the option was set, thus script-local items are available.
4853
Bram Moolenaara4e0b972022-10-01 19:43:52 +01004854 The advantage of using a function call without arguments is that it is
4855 faster, see |expr-option-function|.
4856
Bram Moolenaar071d4272004-06-13 20:20:40 +00004857 The expression must return the number of spaces worth of indent. It
4858 can return "-1" to keep the current indent (this means 'autoindent' is
4859 used for the indent).
4860 Functions useful for computing the indent are |indent()|, |cindent()|
4861 and |lispindent()|.
4862 The evaluation of the expression must not have side effects! It must
4863 not change the text, jump to another window, etc. Afterwards the
4864 cursor position is always restored, thus the cursor may be moved.
4865 Normally this option would be set to call a function: >
4866 :set indentexpr=GetMyIndent()
4867< Error messages will be suppressed, unless the 'debug' option contains
4868 "msg".
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004869 See |indent-expression|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01004870 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004871
Bram Moolenaar30b65812012-07-12 22:01:11 +02004872 The expression will be evaluated in the |sandbox| when set from a
4873 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004874 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004875
4876 It is not allowed to change text or jump to another window while
4877 evaluating 'indentexpr' |textlock|.
4878
Bram Moolenaar071d4272004-06-13 20:20:40 +00004879 *'indentkeys'* *'indk'*
Bram Moolenaarce655742019-01-31 14:12:57 +01004880'indentkeys' 'indk' string (default "0{,0},0),0],:,0#,!^F,o,O,e")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004881 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004882 A list of keys that, when typed in Insert mode, cause reindenting of
4883 the current line. Only happens if 'indentexpr' isn't empty.
4884 The format is identical to 'cinkeys', see |indentkeys-format|.
4885 See |C-indenting| and |indent-expression|.
4886
4887 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
4888'infercase' 'inf' boolean (default off)
4889 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004890 When doing keyword completion in insert mode |ins-completion|, and
Bram Moolenaar446cb832008-06-24 21:56:24 +00004891 'ignorecase' is also on, the case of the match is adjusted depending
4892 on the typed text. If the typed text contains a lowercase letter
4893 where the match has an upper case letter, the completed part is made
4894 lowercase. If the typed text has no lowercase letters and the match
4895 has a lowercase letter where the typed text has an uppercase letter,
4896 and there is a letter before it, the completed part is made uppercase.
4897 With 'noinfercase' the match is used as-is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004898
4899 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
4900'insertmode' 'im' boolean (default off)
4901 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004902 Makes Vim work in a way that Insert mode is the default mode. Useful
4903 if you want to use Vim as a modeless editor. Used for |evim|.
4904 These Insert mode commands will be useful:
4905 - Use the cursor keys to move around.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02004906 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|. When
Bram Moolenaar071d4272004-06-13 20:20:40 +00004907 this is a mapping, it is executed as if 'insertmode' was off.
4908 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004909 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00004910 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
4911 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004912
4913 These items change when 'insertmode' is set:
4914 - when starting to edit of a file, Vim goes to Insert mode.
4915 - <Esc> in Insert mode is a no-op and beeps.
4916 - <Esc> in Normal mode makes Vim go to Insert mode.
4917 - CTRL-L in Insert mode is a command, it is not inserted.
4918 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
4919 However, when <Esc> is used inside a mapping, it behaves like
4920 'insertmode' was not set. This was done to be able to use the same
4921 mappings with 'insertmode' set or not set.
4922 When executing commands with |:normal| 'insertmode' is not used.
4923
4924 NOTE: This option is reset when 'compatible' is set.
4925
4926 *'isfname'* *'isf'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004927'isfname' 'isf' string (default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004928 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
4929 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
4930 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
4931 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
4932 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
4933 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004934 The characters specified by this option are included in file names and
4935 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004936 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004937 Multi-byte characters 256 and above are always included, only the
4938 characters up to 255 are specified with this option.
4939 For UTF-8 the characters 0xa0 to 0xff are included as well.
Bram Moolenaar446cb832008-06-24 21:56:24 +00004940 Think twice before adding white space to this option. Although a
4941 space may appear inside a file name, the effect will be that Vim
4942 doesn't know where a file name starts or ends when doing completion.
4943 It most likely works better without a space in 'isfname'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004944
4945 Note that on systems using a backslash as path separator, Vim tries to
4946 do its best to make it work as you would expect. That is a bit
4947 tricky, since Vi originally used the backslash to escape special
4948 characters. Vim will not remove a backslash in front of a normal file
4949 name character on these systems, but it will on Unix and alikes. The
4950 '&' and '^' are not included by default, because these are special for
4951 cmd.exe.
4952
4953 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004954 Each part can be a single character number or a range. A range is two
4955 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004956 decimal number between 0 and 255 or the ASCII character itself (does
4957 not work for digits). Example:
4958 "_,-,128-140,#-43" (include '_' and '-' and the range
4959 128 to 140 and '#' to 43)
4960 If a part starts with '^', the following character number or range
4961 will be excluded from the option. The option is interpreted from left
4962 to right. Put the excluded character after the range where it is
4963 included. To include '^' itself use it as the last character of the
4964 option or the end of a range. Example:
4965 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
4966 If the character is '@', all characters where isalpha() returns TRUE
4967 are included. Normally these are the characters a to z and A to Z,
4968 plus accented characters. To include '@' itself use "@-@". Examples:
4969 "@,^a-z" All alphabetic characters, excluding lower
Bram Moolenaar446cb832008-06-24 21:56:24 +00004970 case ASCII letters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004971 "a-z,A-Z,@-@" All letters plus the '@' character.
4972 A comma can be included by using it where a character number is
4973 expected. Example:
4974 "48-57,,,_" Digits, comma and underscore.
4975 A comma can be excluded by prepending a '^'. Example:
4976 " -~,^,,9" All characters from space to '~', excluding
4977 comma, plus <Tab>.
4978 See |option-backslash| about including spaces and backslashes.
4979
4980 *'isident'* *'isi'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004981'isident' 'isi' string (default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004982 "@,48-57,_,128-167,224-235"
4983 otherwise: "@,48-57,_,192-255")
4984 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004985 The characters given by this option are included in identifiers.
4986 Identifiers are used in recognizing environment variables and after a
4987 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00004988 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004989 option. For '@' only characters up to 255 are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004990 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004991 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00004992 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
4993
4994 *'iskeyword'* *'isk'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004995'iskeyword' 'isk' string (Vim default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004996 "@,48-57,_,128-167,224-235"
4997 otherwise: "@,48-57,_,192-255"
4998 Vi default: "@,48-57,_")
4999 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005000 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005001 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005002 'isfname' for a description of the format of this option. For '@'
Bram Moolenaar4c295022021-05-02 17:19:11 +02005003 characters above 255 check the "word" character class (any character
5004 that is not white space or punctuation).
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005005 For C programs you could use "a-z,A-Z,48-57,_,.,-,>".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005006 For a help file it is set to all non-blank printable characters except
5007 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
5008 command).
5009 When the 'lisp' option is on the '-' character is always included.
Bram Moolenaarb8060fe2016-01-19 22:29:28 +01005010 This option also influences syntax highlighting, unless the syntax
5011 uses |:syn-iskeyword|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005012 NOTE: This option is set to the Vi default value when 'compatible' is
5013 set and to the Vim default value when 'compatible' is reset.
5014
5015 *'isprint'* *'isp'*
Yee Cheng Chin92b59c62024-10-22 21:16:43 +02005016'isprint' 'isp' string (default for Win32 and VMS:
Bram Moolenaar071d4272004-06-13 20:20:40 +00005017 "@,~-255"; otherwise: "@,161-255")
5018 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005019 The characters given by this option are displayed directly on the
5020 screen. It is also used for "\p" in a |pattern|. The characters from
5021 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
5022 even when they are not included in 'isprint' or excluded. See
5023 'isfname' for a description of the format of this option.
5024
5025 Non-printable characters are displayed with two characters:
5026 0 - 31 "^@" - "^_"
5027 32 - 126 always single characters
5028 127 "^?"
5029 128 - 159 "~@" - "~_"
5030 160 - 254 "| " - "|~"
5031 255 "~?"
5032 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
5033 displayed as <xx>, with the hexadecimal value of the byte.
5034 When 'display' contains "uhex" all unprintable characters are
5035 displayed as <xx>.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005036 The SpecialKey highlighting will be used for unprintable characters.
5037 |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005038
5039 Multi-byte characters 256 and above are always included, only the
5040 characters up to 255 are specified with this option. When a character
5041 is printable but it is not available in the current font, a
5042 replacement character will be shown.
5043 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
5044 There is no option to specify these characters.
5045
5046 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
5047'joinspaces' 'js' boolean (default on)
5048 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005049 Insert two spaces after a '.', '?' and '!' with a join command.
5050 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
5051 Otherwise only one space is inserted.
5052 NOTE: This option is set when 'compatible' is set.
5053
Yegappan Lakshmanan87018252023-09-20 20:20:04 +02005054 *'jumpoptions'* *'jop'*
5055'jumpoptions' 'jop' string (default "")
5056 global
5057 List of words that change the behavior of the |jumplist|.
5058 stack Make the jumplist behave like the tagstack.
5059 Relative location of entries in the jumplist is
5060 preserved at the cost of discarding subsequent entries
5061 when navigating backwards in the jumplist and then
5062 jumping to a location. |jumplist-stack|
5063
Bram Moolenaar071d4272004-06-13 20:20:40 +00005064 *'key'*
5065'key' string (default "")
5066 local to buffer
Bram Moolenaar996343d2010-07-04 22:20:21 +02005067 {only available when compiled with the |+cryptv|
5068 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005069 The key that is used for encrypting and decrypting the current buffer.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02005070 See |encryption| and 'cryptmethod'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005071 Careful: Do not set the key value by hand, someone might see the typed
5072 key. Use the |:X| command. But you can make 'key' empty: >
5073 :set key=
5074< It is not possible to get the value of this option with ":set key" or
5075 "echo &key". This is to avoid showing it to someone who shouldn't
5076 know. It also means you cannot see it yourself once you have set it,
5077 be careful not to make a typing error!
Yee Cheng Chin6ee7b522023-10-01 09:13:22 +02005078 You also cannot use |:set-=|, |:set+=|, |:set^=| on this option to
5079 prevent an attacker from guessing substrings in your key.
Bram Moolenaard58e9292011-02-09 17:07:58 +01005080 You can use "&key" in an expression to detect whether encryption is
5081 enabled. When 'key' is set it returns "*****" (five stars).
Bram Moolenaar071d4272004-06-13 20:20:40 +00005082
5083 *'keymap'* *'kmp'* *E544*
5084'keymap' 'kmp' string (default "")
5085 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005086 {only available when compiled with the |+keymap|
5087 feature}
5088 Name of a keyboard mapping. See |mbyte-keymap|.
5089 Setting this option to a valid keymap name has the side effect of
5090 setting 'iminsert' to one, so that the keymap becomes effective.
5091 'imsearch' is also set to one, unless it was -1
Millyae62fe52024-10-02 19:30:41 +02005092 Only alphanumeric characters, '.', '-' and '_' can be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005093
5094 *'keymodel'* *'km'*
5095'keymodel' 'km' string (default "")
5096 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01005097 List of comma-separated words, which enable special things that keys
Bram Moolenaar071d4272004-06-13 20:20:40 +00005098 can do. These values can be used:
5099 startsel Using a shifted special key starts selection (either
5100 Select mode or Visual mode, depending on "key" being
5101 present in 'selectmode').
5102 stopsel Using a not-shifted special key stops selection.
5103 Special keys in this context are the cursor keys, <End>, <Home>,
5104 <PageUp> and <PageDown>.
5105 The 'keymodel' option is set by the |:behave| command.
5106
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005107 *'keyprotocol'* *'kpc'*
5108'keyprotocol' 'kpc' string (default: see below)
5109 global
5110 Specifies what keyboard protocol to use depending on the value of
5111 'term'. The supported keyboard protocols names are:
5112 none whatever the terminal uses
5113 mok2 modifyOtherKeys level 2, as supported by xterm
5114 kitty Kitty keyboard protocol, as supported by Kitty
5115
Bram Moolenaara87749e2022-11-30 10:23:17 +00005116 The option value is a list of comma separated items. Each item has
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005117 a pattern that is matched against the 'term' option, a colon and the
5118 protocol name to be used. To illustrate this, the default value would
5119 be set with: >
Christian Brabandtf6ba8de2024-12-28 17:15:05 +01005120 set keyprotocol=kitty:kitty,foot:kitty,ghostty:kitty,wezterm:kitty
5121 set keyprotocol+=xterm:mok2
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005122
Hirohito Higashi195fcc92025-02-01 10:26:58 +01005123< This means that when 'term' contains "kitty, "foot", "ghostty" or
Christian Brabandtf6ba8de2024-12-28 17:15:05 +01005124 "wezterm" somewhere, then the "kitty" protocol is used. When 'term'
5125 contains "xterm" somewhere, then the "mok2" protocol is used.
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005126
5127 The first match is used, thus if you want to have "kitty" use the
5128 kitty protocol, but "badkitty" not, then you should match "badkitty"
5129 first and use the "none" value: >
5130 set keyprotocol=badkitty:none,kitty:kitty
5131<
5132 The option is used after 'term' has been changed. First the termcap
5133 entries are set, possibly using the builtin list, see |builtin-terms|.
5134 Then this option is inspected and if there is a match and a protocol
5135 is specified the following happens:
5136 none Nothing, the regular t_TE and t_TI values remain
5137
5138 mok2 The t_TE value is changed to:
5139 CSI >4;m disables modifyOtherKeys
5140 The t_TI value is changed to:
5141 CSI >4;2m enables modifyOtherKeys
Bram Moolenaara87749e2022-11-30 10:23:17 +00005142 CSI ?4m request the modifyOtherKeys state
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005143
5144 kitty The t_TE value is changed to:
5145 CSI >4;m disables modifyOtherKeys
Bram Moolenaara87749e2022-11-30 10:23:17 +00005146 CSI =0;1u disables the kitty keyboard protocol
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005147 The t_TI value is changed to:
Bram Moolenaara87749e2022-11-30 10:23:17 +00005148 CSI =1;1u enables the kitty keyboard protocol
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005149 CSI ?u request kitty keyboard protocol state
5150 CSI >c request the termresponse
5151
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00005152 If you notice problems, such as characters being displayed that
5153 disappear after `CTRL-L`, you might want to try making this option
5154 empty. Then set the 'term' option to have it take effect: >
5155 set keyprotocol=
5156 let &term = &term
Bram Moolenaarbe4e0162023-02-02 13:59:48 +00005157<
Bram Moolenaar63a2e362022-11-23 20:20:18 +00005158
Bram Moolenaar071d4272004-06-13 20:20:40 +00005159 *'keywordprg'* *'kp'*
5160'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02005161 VMS: "help")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005162 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005163 Program to use for the |K| command. Environment variables are
5164 expanded |:set_env|. ":help" may be used to access the Vim internal
5165 help. (Note that previously setting the global option to the empty
5166 value did this, which is now deprecated.)
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02005167 When the first character is ":", the command is invoked as a Vim
Bram Moolenaarb529cfb2022-07-25 15:42:07 +01005168 Ex command with [count] added as an argument if it is not zero.
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02005169 When "man", "man -s" or an Ex command is used, Vim will automatically
5170 translate a count for the "K" command and pass it as the first
5171 argument. For "man -s" the "-s" is removed when there is no count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005172 See |option-backslash| about including spaces and backslashes.
5173 Example: >
5174 :set keywordprg=man\ -s
5175< This option cannot be set from a |modeline| or in the |sandbox|, for
5176 security reasons.
5177
5178 *'langmap'* *'lmap'* *E357* *E358*
5179'langmap' 'lmap' string (default "")
5180 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005181 {only available when compiled with the |+langmap|
5182 feature}
5183 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005184 mode. When you are typing text in Insert mode the characters are
Bram Moolenaarfa735342016-01-03 22:14:44 +01005185 inserted directly. When in Normal mode the 'langmap' option takes
Bram Moolenaar071d4272004-06-13 20:20:40 +00005186 care of translating these special characters to the original meaning
5187 of the key. This means you don't have to change the keyboard mode to
5188 be able to execute Normal mode commands.
5189 This is the opposite of the 'keymap' option, where characters are
5190 mapped in Insert mode.
Bram Moolenaarb17893a2020-03-14 08:19:51 +01005191 Also consider setting 'langremap' to off, to prevent 'langmap' from
5192 applying to characters resulting from a mapping.
Bram Moolenaare968e362014-05-13 20:23:24 +02005193 This option cannot be set from a |modeline| or in the |sandbox|, for
5194 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005195
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00005196 Example (for Greek, in UTF-8): *greek* >
5197 :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 +00005198< Example (exchanges meaning of z and y for commands): >
5199 :set langmap=zy,yz,ZY,YZ
5200<
5201 The 'langmap' option is a list of parts, separated with commas. Each
5202 part can be in one of two forms:
5203 1. A list of pairs. Each pair is a "from" character immediately
5204 followed by the "to" character. Examples: "aA", "aAbBcC".
Dominique Pellédf62c622024-07-15 20:29:59 +02005205 2. A list of "from" characters, a semicolon and a list of "to"
Bram Moolenaar071d4272004-06-13 20:20:40 +00005206 characters. Example: "abc;ABC"
5207 Example: "aA,fgh;FGH,cCdDeE"
5208 Special characters need to be preceded with a backslash. These are
Bram Moolenaar4f4d51a2020-10-11 13:57:40 +02005209 ";", ',', '"', '|' and backslash itself.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005210
5211 This will allow you to activate vim actions without having to switch
5212 back and forth between the languages. Your language characters will
5213 be understood as normal vim English characters (according to the
5214 langmap mappings) in the following cases:
5215 o Normal/Visual mode (commands, buffer/register names, user mappings)
5216 o Insert/Replace Mode: Register names after CTRL-R
5217 o Insert/Replace Mode: Mappings
5218 Characters entered in Command-line mode will NOT be affected by
5219 this option. Note that this option can be changed at any time
5220 allowing to switch between mappings for different languages/encodings.
5221 Use a mapping to avoid having to type it each time!
5222
5223 *'langmenu'* *'lm'*
5224'langmenu' 'lm' string (default "")
5225 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005226 {only available when compiled with the |+menu| and
5227 |+multi_lang| features}
5228 Language to use for menu translation. Tells which file is loaded
5229 from the "lang" directory in 'runtimepath': >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00005230 "lang/menu_" .. &langmenu .. ".vim"
Bram Moolenaar071d4272004-06-13 20:20:40 +00005231< (without the spaces). For example, to always use the Dutch menus, no
5232 matter what $LANG is set to: >
5233 :set langmenu=nl_NL.ISO_8859-1
5234< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005235 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005236 If your $LANG is set to a non-English language but you do want to use
5237 the English menus: >
5238 :set langmenu=none
5239< This option must be set before loading menus, switching on filetype
5240 detection or syntax highlighting. Once the menus are defined setting
5241 this option has no effect. But you could do this: >
5242 :source $VIMRUNTIME/delmenu.vim
5243 :set langmenu=de_DE.ISO_8859-1
5244 :source $VIMRUNTIME/menu.vim
5245< Warning: This deletes all menus that you defined yourself!
5246
Bram Moolenaard94464e2015-11-02 15:28:18 +01005247 *'langnoremap'* *'lnr'* *'nolangnoremap'* *'nolnr'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02005248'langnoremap' 'lnr' boolean (default off, set in |defaults.vim|)
Bram Moolenaar4391cf92014-11-05 17:44:52 +01005249 global
Bram Moolenaar4391cf92014-11-05 17:44:52 +01005250 {only available when compiled with the |+langmap|
5251 feature}
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02005252 This is just like 'langremap' but with the value inverted. It only
5253 exists for backwards compatibility. When setting 'langremap' then
5254 'langnoremap' is set to the inverted value, and the other way around.
5255
5256 *'langremap'* *'lrm'* *'nolangremap'* *'nolrm'*
Bram Moolenaarb17893a2020-03-14 08:19:51 +01005257'langremap' 'lrm' boolean (default on, set to off in |defaults.vim|)
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02005258 global
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02005259 {only available when compiled with the |+langmap|
5260 feature}
5261 When off, setting 'langmap' does not apply to characters resulting from
Bram Moolenaar4391cf92014-11-05 17:44:52 +01005262 a mapping. This basically means, if you noticed that setting
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02005263 'langmap' disables some of your mappings, try resetting this option.
5264 This option defaults to on for backwards compatibility. Set it off if
Bram Moolenaar4391cf92014-11-05 17:44:52 +01005265 that works for you to avoid mappings to break.
5266
Bram Moolenaar071d4272004-06-13 20:20:40 +00005267 *'laststatus'* *'ls'*
5268'laststatus' 'ls' number (default 1)
5269 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005270 The value of this option influences when the last window will have a
5271 status line:
5272 0: never
5273 1: only if there are at least two windows
5274 2: always
5275 The screen looks nicer with a status line if you have several
5276 windows, but it takes another screen line. |status-line|
5277
5278 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
5279'lazyredraw' 'lz' boolean (default off)
5280 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005281 When this option is set, the screen will not be redrawn while
5282 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005283 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00005284 update use |:redraw|.
Bram Moolenaara57b5532022-06-24 11:48:03 +01005285 This may occasionally cause display errors. It is only meant to be set
5286 temporarily when performing an operation where redrawing may cause
Dominique Pellédf62c622024-07-15 20:29:59 +02005287 flickering or cause a slowdown.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005288
5289 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
5290'linebreak' 'lbr' boolean (default off)
5291 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02005292 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005293 feature}
Bram Moolenaar946e27a2014-06-25 18:50:27 +02005294 If on, Vim will wrap long lines at a character in 'breakat' rather
Bram Moolenaar071d4272004-06-13 20:20:40 +00005295 than at the last character that fits on the screen. Unlike
5296 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
Bram Moolenaar946e27a2014-06-25 18:50:27 +02005297 it only affects the way the file is displayed, not its contents.
5298 If 'breakindent' is set, line is visually indented. Then, the value
5299 of 'showbreak' is used to put in front of wrapped lines. This option
Bram Moolenaar86b17e92014-07-02 20:00:47 +02005300 is not used when the 'wrap' option is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005301 Note that <Tab> characters after an <EOL> are mostly not displayed
5302 with the right amount of white space.
5303
5304 *'lines'* *E593*
5305'lines' number (default 24 or terminal height)
5306 global
5307 Number of lines of the Vim window.
5308 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00005309 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005310 When Vim is running in the GUI or in a resizable window, setting this
5311 option will cause the window size to be changed. When you only want
5312 to use the size for the GUI, put the command in your |gvimrc| file.
5313 Vim limits the number of lines to what fits on the screen. You can
5314 use this command to get the tallest window possible: >
5315 :set lines=999
Bram Moolenaarf4d11452005-12-02 00:46:37 +00005316< Minimum value is 2, maximum value is 1000.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02005317 If you get fewer lines than expected, check the 'guiheadroom' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005318 When you set this option and Vim is unable to change the physical
5319 number of lines of the display, the display may be messed up.
5320
5321 *'linespace'* *'lsp'*
5322'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
5323 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005324 {only in the GUI}
5325 Number of pixel lines inserted between characters. Useful if the font
5326 uses the full character cell height, making lines touch each other.
5327 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005328 With some fonts there can be too much room between lines (to have
5329 space for ascents and descents). Then it makes sense to set
5330 'linespace' to a negative value. This may cause display problems
5331 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00005332
5333 *'lisp'* *'nolisp'*
5334'lisp' boolean (default off)
5335 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005336 Lisp mode: When <Enter> is typed in insert mode set the indent for
5337 the next line to Lisp standards (well, sort of). Also happens with
5338 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
5339 flag in 'cpoptions' changes the method of indenting: Vi compatible or
5340 better. Also see 'lispwords'.
5341 The '-' character is included in keyword characters. Redefines the
5342 "=" operator to use this same indentation algorithm rather than
5343 calling an external program if 'equalprg' is empty.
5344 This option is not used when 'paste' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005345
Bram Moolenaar49846fb2022-10-15 16:05:33 +01005346 *'lispoptions'* *'lop'*
5347'lispoptions' 'lop' string (default "")
5348 local to buffer
5349 Comma-separated list of items that influence the Lisp indenting when
5350 enabled with the |'lisp'| option. Currently only one item is
5351 supported:
5352 expr:1 use 'indentexpr' for Lisp indenting when it is set
5353 expr:0 do not use 'indentexpr' for Lisp indenting (default)
5354 Note that when using 'indentexpr' the `=` operator indents all the
5355 lines, otherwise the first line is not indented (Vi-compatible).
5356
Bram Moolenaar071d4272004-06-13 20:20:40 +00005357 *'lispwords'* *'lw'*
5358'lispwords' 'lw' string (default is very long)
Bram Moolenaaraf6c1312014-03-12 18:55:58 +01005359 global or local to buffer |global-local|
Bram Moolenaar48c3f4e2022-08-08 15:42:38 +01005360 Comma-separated list of words that influence the Lisp indenting when
5361 enabled with the |'lisp'| option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005362
5363 *'list'* *'nolist'*
5364'list' boolean (default off)
5365 local to window
Bram Moolenaar113cb512021-11-07 20:27:04 +00005366 List mode: By default show tabs as CTRL-I is displayed, display $
5367 after end of line. Useful to see the difference between tabs and
5368 spaces and for trailing blanks. Further changed by the 'listchars'
5369 option.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005370
5371 The cursor is displayed at the start of the space a Tab character
5372 occupies, not at the end as usual in Normal mode. To get this cursor
5373 position while displaying Tabs with spaces, use: >
Bram Moolenaardd007ed2013-07-09 15:44:17 +02005374 :set list lcs=tab:\ \
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005375<
5376 Note that list mode will also affect formatting (set with 'textwidth'
5377 or 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005378 changing the way tabs are displayed.
5379
5380 *'listchars'* *'lcs'*
5381'listchars' 'lcs' string (default "eol:$")
Bram Moolenaareed9d462021-02-15 20:38:25 +01005382 global or local to window |global-local|
Bram Moolenaarf9d5ca12010-08-01 16:13:51 +02005383 Strings to use in 'list' mode and for the |:list| command. It is a
zeertzjq6a8d2e12024-01-17 20:54:49 +01005384 comma-separated list of string settings. *E1511*
Bram Moolenaar79278362015-04-21 18:33:48 +02005385 *lcs-eol*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005386 eol:c Character to show at the end of each line. When
5387 omitted, there is no extra character at the end of the
5388 line.
Bram Moolenaar79278362015-04-21 18:33:48 +02005389 *lcs-tab*
Bram Moolenaar83a52172019-01-16 22:41:54 +01005390 tab:xy[z] Two or three characters to be used to show a tab.
5391 The third character is optional.
5392
5393 tab:xy The 'x' is always used, then 'y' as many times as will
5394 fit. Thus "tab:>-" displays:
5395 >
5396 >-
5397 >--
5398 etc.
5399
5400 tab:xyz The 'z' is always used, then 'x' is prepended, and
5401 then 'y' is used as many times as will fit. Thus
5402 "tab:<->" displays:
5403 >
5404 <>
5405 <->
5406 <-->
5407 etc.
5408
5409 When "tab:" is omitted, a tab is shown as ^I.
Bram Moolenaar79278362015-04-21 18:33:48 +02005410 *lcs-space*
5411 space:c Character to show for a space. When omitted, spaces
5412 are left blank.
zeertzjqf14b8ba2021-09-10 16:58:30 +02005413 *lcs-multispace*
5414 multispace:c...
Bram Moolenaarbe4e0162023-02-02 13:59:48 +00005415 One or more characters to use cyclically to show for
5416 multiple consecutive spaces. Overrides the "space"
zeertzjqf14b8ba2021-09-10 16:58:30 +02005417 setting, except for single spaces. When omitted, the
5418 "space" setting is used. For example,
5419 `:set listchars=multispace:---+` shows ten consecutive
5420 spaces as:
Bram Moolenaaraca12fd2022-06-07 10:16:15 +01005421 ---+---+-- ~
Bram Moolenaar91478ae2021-02-03 15:58:13 +01005422 *lcs-lead*
5423 lead:c Character to show for leading spaces. When omitted,
zeertzjqf14b8ba2021-09-10 16:58:30 +02005424 leading spaces are blank. Overrides the "space" and
5425 "multispace" settings for leading spaces. You can
5426 combine it with "tab:", for example: >
Bram Moolenaar942db232021-02-13 18:14:48 +01005427 :set listchars+=tab:>-,lead:.
Bram Moolenaaraca12fd2022-06-07 10:16:15 +01005428< *lcs-leadmultispace*
5429 leadmultispace:c...
Bram Moolenaar069a7d52022-06-27 22:16:08 +01005430 Like the |lcs-multispace| value, but for leading
5431 spaces only. Also overrides |lcs-lead| for leading
5432 multiple spaces.
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01005433 `:set listchars=leadmultispace:---+` shows ten
5434 consecutive leading spaces as:
Bram Moolenaaraca12fd2022-06-07 10:16:15 +01005435 ---+---+--XXX ~
5436 Where "XXX" denotes the first non-blank characters in
5437 the line.
5438 *lcs-trail*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005439 trail:c Character to show for trailing spaces. When omitted,
zeertzjqf14b8ba2021-09-10 16:58:30 +02005440 trailing spaces are blank. Overrides the "space" and
5441 "multispace" settings for trailing spaces.
Bram Moolenaar79278362015-04-21 18:33:48 +02005442 *lcs-extends*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005443 extends:c Character to show in the last column, when 'wrap' is
5444 off and the line continues beyond the right of the
5445 screen.
Bram Moolenaar79278362015-04-21 18:33:48 +02005446 *lcs-precedes*
Bram Moolenaarbffba7f2019-09-20 17:00:17 +02005447 precedes:c Character to show in the first visible column of the
5448 physical line, when there is text preceding the
5449 character visible in the first column.
Bram Moolenaar79278362015-04-21 18:33:48 +02005450 *lcs-conceal*
Bram Moolenaar860cae12010-06-05 23:22:07 +02005451 conceal:c Character to show in place of concealed text, when
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02005452 'conceallevel' is set to 1.
Bram Moolenaar79278362015-04-21 18:33:48 +02005453 *lcs-nbsp*
Bram Moolenaar73284b92015-05-04 17:28:22 +02005454 nbsp:c Character to show for a non-breakable space character
5455 (0xA0 (160 decimal) and U+202F). Left blank when
5456 omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005457
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005458 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00005459 be used when 'encoding' is "utf-8", otherwise only printable
zeertzjq6a8d2e12024-01-17 20:54:49 +01005460 characters are allowed. All characters must be single width. *E1512*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005461
Bram Moolenaar93ff6722021-10-16 17:51:40 +01005462 Each character can be specified as hex: >
5463 set listchars=eol:\\x24
5464 set listchars=eol:\\u21b5
5465 set listchars=eol:\\U000021b5
5466< Note that a double backslash is used. The number of hex characters
5467 must be exactly 2 for \\x, 4 for \\u and 8 for \\U.
5468
Bram Moolenaar071d4272004-06-13 20:20:40 +00005469 Examples: >
5470 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005471 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00005472 :set lcs=extends:>,precedes:<
5473< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaar34cc7d82021-09-21 20:09:51 +02005474 "precedes". "SpecialKey" will be used for "tab", "nbsp", "space",
5475 "multispace", "lead" and "trail".
Bram Moolenaar02467872007-05-06 13:22:01 +00005476 |hl-NonText| |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005477
5478 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
5479'loadplugins' 'lpl' boolean (default on)
5480 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005481 When on the plugin scripts are loaded when starting up |load-plugins|.
5482 This option can be reset in your |vimrc| file to disable the loading
5483 of plugins.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02005484 Note that using the "-u NONE", "-u DEFAULTS" and "--noplugin" command
5485 line arguments reset this option. See |-u| and |--noplugin|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005486
Bram Moolenaard94464e2015-11-02 15:28:18 +01005487 *'luadll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01005488'luadll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01005489 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01005490 {only available when compiled with the |+lua/dyn|
5491 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005492 Specifies the name of the Lua shared library. The default is
5493 DYNAMIC_LUA_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005494 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01005495 This option cannot be set from a |modeline| or in the |sandbox|, for
5496 security reasons.
5497
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00005498 *'macatsui'* *'nomacatsui'*
5499'macatsui' boolean (default on)
5500 global
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02005501 {not supported}
5502 No longer supported, as the Mac OS X GUI code was removed.
Bram Moolenaar02467872007-05-06 13:22:01 +00005503
Bram Moolenaar071d4272004-06-13 20:20:40 +00005504 *'magic'* *'nomagic'*
5505'magic' boolean (default on)
5506 global
5507 Changes the special characters that can be used in search patterns.
5508 See |pattern|.
Bram Moolenaar64d8e252016-09-06 22:12:34 +02005509 WARNING: Switching this option off most likely breaks plugins! That
5510 is because many patterns assume it's on and will fail when it's off.
5511 Only switch it off when working with old Vi scripts. In any other
5512 situation write patterns that work when 'magic' is on. Include "\M"
5513 when you want to |/\M|.
Bram Moolenaar4072ba52020-12-23 13:56:35 +01005514 In |Vim9| script the value of 'magic' is ignored, patterns behave like
5515 it is always set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005516
5517 *'makeef'* *'mef'*
5518'makeef' 'mef' string (default: "")
5519 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005520 {not available when compiled without the |+quickfix|
5521 feature}
5522 Name of the errorfile for the |:make| command (see |:make_makeprg|)
5523 and the |:grep| command.
5524 When it is empty, an internally generated temp file will be used.
5525 When "##" is included, it is replaced by a number to make the name
5526 unique. This makes sure that the ":make" command doesn't overwrite an
5527 existing file.
5528 NOT used for the ":cf" command. See 'errorfile' for that.
5529 Environment variables are expanded |:set_env|.
5530 See |option-backslash| about including spaces and backslashes.
5531 This option cannot be set from a |modeline| or in the |sandbox|, for
5532 security reasons.
5533
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01005534 *'makeencoding'* *'menc'*
5535'makeencoding' 'menc' string (default "")
5536 global or local to buffer |global-local|
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01005537 Encoding used for reading the output of external commands. When empty,
5538 encoding is not converted.
5539 This is used for `:make`, `:lmake`, `:grep`, `:lgrep`, `:grepadd`,
5540 `:lgrepadd`, `:cfile`, `:cgetfile`, `:caddfile`, `:lfile`, `:lgetfile`,
5541 and `:laddfile`.
5542
5543 This would be mostly useful when you use MS-Windows and set 'encoding'
5544 to "utf-8". If |+iconv| is enabled and GNU libiconv is used, setting
5545 'makeencoding' to "char" has the same effect as setting to the system
5546 locale encoding. Example: >
5547 :set encoding=utf-8
5548 :set makeencoding=char " system locale is used
5549<
Bram Moolenaar071d4272004-06-13 20:20:40 +00005550 *'makeprg'* *'mp'*
5551'makeprg' 'mp' string (default "make", VMS: "MMS")
5552 global or local to buffer |global-local|
Bram Moolenaar02467872007-05-06 13:22:01 +00005553 Program to use for the ":make" command. See |:make_makeprg|.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01005554 This option may contain '%' and '#' characters (see |:_%| and |:_#|),
5555 which are expanded to the current and alternate file name. Use |::S|
Bram Moolenaar26df0922014-02-23 23:39:13 +01005556 to escape file names in case they contain special characters.
Bram Moolenaar02467872007-05-06 13:22:01 +00005557 Environment variables are expanded |:set_env|. See |option-backslash|
5558 about including spaces and backslashes.
5559 Note that a '|' must be escaped twice: once for ":set" and once for
5560 the interpretation of a command. When you use a filter called
5561 "myfilter" do it like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005562 :set makeprg=gmake\ \\\|\ myfilter
5563< The placeholder "$*" can be given (even multiple times) to specify
5564 where the arguments will be included, for example: >
5565 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
5566< This option cannot be set from a |modeline| or in the |sandbox|, for
5567 security reasons.
5568
5569 *'matchpairs'* *'mps'*
5570'matchpairs' 'mps' string (default "(:),{:},[:]")
5571 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005572 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01005573 other.
5574 Only character pairs are allowed that are different, thus you cannot
5575 jump between two double quotes.
5576 The characters must be separated by a colon.
Bram Moolenaar02467872007-05-06 13:22:01 +00005577 The pairs must be separated by a comma. Example for including '<' and
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02005578 '>' (for HTML): >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005579 :set mps+=<:>
5580
5581< A more exotic example, to jump between the '=' and ';' in an
5582 assignment, useful for languages like C and Java: >
5583 :au FileType c,cpp,java set mps+==:;
5584
5585< For a more advanced way of using "%", see the matchit.vim plugin in
Bram Moolenaar01164a62017-11-02 22:58:42 +01005586 the $VIMRUNTIME/pack/dist/opt/matchit directory. |add-local-help|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005587
5588 *'matchtime'* *'mat'*
5589'matchtime' 'mat' number (default 5)
5590 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005591 Tenths of a second to show the matching paren, when 'showmatch' is
5592 set. Note that this is not in milliseconds, like other options that
5593 set a time. This is to be compatible with Nvi.
5594
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005595 *'maxcombine'* *'mco'*
5596'maxcombine' 'mco' number (default 2)
5597 global
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005598 The maximum number of combining characters supported for displaying.
5599 Only used when 'encoding' is "utf-8".
5600 The default is OK for most languages. Hebrew may require 4.
5601 Maximum value is 6.
5602 Even when this option is set to 2 you can still edit text with more
5603 combining characters, you just can't see them. Use |g8| or |ga|.
5604 See |mbyte-combining|.
5605
Bram Moolenaar071d4272004-06-13 20:20:40 +00005606 *'maxfuncdepth'* *'mfd'*
5607'maxfuncdepth' 'mfd' number (default 100)
5608 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02005609 {not available when compiled without the |+eval|
Bram Moolenaar02467872007-05-06 13:22:01 +00005610 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005611 Maximum depth of function calls for user functions. This normally
5612 catches endless recursion. When using a recursive function with
5613 more depth, set 'maxfuncdepth' to a bigger number. But this will use
5614 more memory, there is the danger of failing when memory is exhausted.
Bram Moolenaarbc2eada2017-01-02 21:27:47 +01005615 Increasing this limit above 200 also changes the maximum for Ex
Bram Moolenaar0b0f0992018-05-22 21:41:30 +02005616 command recursion, see |E169|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005617 See also |:function|.
zeertzjqfe583b12023-12-21 16:59:26 +01005618 Also used for maximum depth of callback functions.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005619
5620 *'maxmapdepth'* *'mmd'* *E223*
5621'maxmapdepth' 'mmd' number (default 1000)
5622 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005623 Maximum number of times a mapping is done without resulting in a
5624 character to be used. This normally catches endless mappings, like
5625 ":map x y" with ":map y x". It still does not catch ":map g wg",
5626 because the 'w' is used before the next mapping is done. See also
5627 |key-mapping|.
5628
5629 *'maxmem'* *'mm'*
5630'maxmem' 'mm' number (default between 256 to 5120 (system
5631 dependent) or half the amount of memory
5632 available)
5633 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005634 Maximum amount of memory (in Kbyte) to use for one buffer. When this
5635 limit is reached allocating extra memory for a buffer will cause
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005636 other memory to be freed.
5637 The maximum usable value is about 2000000. Use this to work without a
5638 limit.
5639 The value is ignored when 'swapfile' is off.
5640 Also see 'maxmemtot'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005641
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005642 *'maxmempattern'* *'mmp'*
5643'maxmempattern' 'mmp' number (default 1000)
5644 global
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005645 Maximum amount of memory (in Kbyte) to use for pattern matching.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005646 The maximum value is about 2000000. Use this to work without a limit.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005647 *E363*
Bram Moolenaar02467872007-05-06 13:22:01 +00005648 When Vim runs into the limit it gives an error message and mostly
5649 behaves like CTRL-C was typed.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005650 Running into the limit often means that the pattern is very
5651 inefficient or too complex. This may already happen with the pattern
5652 "\(.\)*" on a very long line. ".*" works much better.
Bram Moolenaarfd358112018-07-07 23:21:31 +02005653 Might also happen on redraw, when syntax rules try to match a complex
5654 text structure.
5655 Vim may run out of memory before hitting the 'maxmempattern' limit, in
5656 which case you get an "Out of memory" error instead.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005657
Bram Moolenaar071d4272004-06-13 20:20:40 +00005658 *'maxmemtot'* *'mmt'*
5659'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
5660 dependent) or half the amount of memory
5661 available)
5662 global
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005663 Maximum amount of memory in Kbyte to use for all buffers together.
5664 The maximum usable value is about 2000000 (2 Gbyte). Use this to work
Bram Moolenaarfa735342016-01-03 22:14:44 +01005665 without a limit.
5666 On 64 bit machines higher values might work. But hey, do you really
5667 need more than 2 Gbyte for text editing? Keep in mind that text is
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005668 stored in the swap file, one can edit files > 2 Gbyte anyway. We do
Bram Moolenaarfa735342016-01-03 22:14:44 +01005669 need the memory to store undo info.
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005670 Buffers with 'swapfile' off still count to the total amount of memory
5671 used.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005672 Also see 'maxmem'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005673
5674 *'menuitems'* *'mis'*
5675'menuitems' 'mis' number (default 25)
5676 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005677 {not available when compiled without the |+menu|
5678 feature}
5679 Maximum number of items to use in a menu. Used for menus that are
5680 generated from a list of items, e.g., the Buffers menu. Changing this
5681 option has no direct effect, the menu must be refreshed first.
5682
Christian Brabandt51d4d842024-12-06 17:26:25 +01005683 *'messagesopt'* *'mopt'*
5684'messagesopt' 'mopt' string (default "hit-enter,history:500")
5685 global
5686
zeertzjq8cc43da2024-12-07 16:09:08 +01005687 Option settings for outputting messages. It can consist of the
Christian Brabandt51d4d842024-12-06 17:26:25 +01005688 following items. Items must be separated by a comma.
5689
zeertzjq8cc43da2024-12-07 16:09:08 +01005690 hit-enter Use a |hit-enter| prompt when the message is longer than
Christian Brabandt51d4d842024-12-06 17:26:25 +01005691 'cmdheight' size.
5692
zeertzjq8cc43da2024-12-07 16:09:08 +01005693 wait:{n} Instead of using a |hit-enter| prompt, simply wait for
5694 {n} milliseconds so that the user has a chance to read
5695 the message. The maximum value of {n} is 10000. Use
5696 0 to disable the wait (but then the user may miss an
5697 important message).
5698 This item is ignored when "hit-enter" is present, but
5699 required when "hit-enter" is not present.
Christian Brabandt51d4d842024-12-06 17:26:25 +01005700
5701 history:{n} Determines how many entries are remembered in the
5702 |:messages| history. The maximum value is 10000.
5703 Setting it to zero clears the message history.
zeertzjq8cc43da2024-12-07 16:09:08 +01005704 This item must always be present.
Christian Brabandt51d4d842024-12-06 17:26:25 +01005705
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005706 *'mkspellmem'* *'msm'*
5707'mkspellmem' 'msm' string (default "460000,2000,500")
5708 global
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005709 {not available when compiled without the |+syntax|
5710 feature}
5711 Parameters for |:mkspell|. This tunes when to start compressing the
5712 word tree. Compression can be slow when there are many words, but
5713 it's needed to avoid running out of memory. The amount of memory used
5714 per word depends very much on how similar the words are, that's why
5715 this tuning is complicated.
5716
5717 There are three numbers, separated by commas:
5718 {start},{inc},{added}
5719
5720 For most languages the uncompressed word tree fits in memory. {start}
5721 gives the amount of memory in Kbyte that can be used before any
5722 compression is done. It should be a bit smaller than the amount of
5723 memory that is available to Vim.
5724
5725 When going over the {start} limit the {inc} number specifies the
5726 amount of memory in Kbyte that can be allocated before another
5727 compression is done. A low number means compression is done after
5728 less words are added, which is slow. A high number means more memory
5729 will be allocated.
5730
5731 After doing compression, {added} times 1024 words can be added before
5732 the {inc} limit is ignored and compression is done when any extra
5733 amount of memory is needed. A low number means there is a smaller
5734 chance of hitting the {inc} limit, less memory is used but it's
5735 slower.
5736
5737 The languages for which these numbers are important are Italian and
5738 Hungarian. The default works for when you have about 512 Mbyte. If
5739 you have 1 Gbyte you could use: >
5740 :set mkspellmem=900000,3000,800
5741< If you have less than 512 Mbyte |:mkspell| may fail for some
5742 languages, no matter what you set 'mkspellmem' to.
5743
dkearns8ebdbc92023-10-29 06:26:19 +11005744 This option cannot be set from a |modeline| or in the |sandbox|, for
5745 security reasons.
Bram Moolenaar07607392019-05-26 19:20:43 +02005746
Bram Moolenaar071d4272004-06-13 20:20:40 +00005747 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
Bram Moolenaar8243a792007-05-01 17:05:03 +00005748'modeline' 'ml' boolean (Vim default: on (off for root),
5749 Vi default: off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005750 local to buffer
Bram Moolenaar110289e2019-05-23 15:38:06 +02005751 If 'modeline' is on 'modelines' gives the number of lines that is
5752 checked for set commands. If 'modeline' is off or 'modelines' is zero
5753 no lines are checked. See |modeline|.
5754
5755 *'modelineexpr'* *'mle'* *'nomodelineexpr'* *'nomle'*
5756'modelineexpr' 'mle' boolean (default: off)
5757 global
5758 When on allow some options that are an expression to be set in the
5759 modeline. Check the option for whether it is affected by
5760 'modelineexpr'. Also see |modeline|.
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02005761 This option cannot be set from a |modeline| or in the |sandbox|, for
5762 security reasons.
Bram Moolenaar110289e2019-05-23 15:38:06 +02005763
Bram Moolenaar071d4272004-06-13 20:20:40 +00005764 *'modelines'* *'mls'*
5765'modelines' 'mls' number (default 5)
5766 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005767 If 'modeline' is on 'modelines' gives the number of lines that is
5768 checked for set commands. If 'modeline' is off or 'modelines' is zero
5769 no lines are checked. See |modeline|.
5770 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
5771 set and to the Vim default value when 'compatible' is reset.
5772
5773 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
Bram Moolenaar110289e2019-05-23 15:38:06 +02005774 *E21*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005775'modifiable' 'ma' boolean (default on)
5776 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005777 When off the buffer contents cannot be changed. The 'fileformat' and
5778 'fileencoding' options also can't be changed.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01005779 Can be reset on startup with the |-M| command line argument.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005780
5781 *'modified'* *'mod'* *'nomodified'* *'nomod'*
5782'modified' 'mod' boolean (default off)
Christian Brabandt596ad662023-08-16 00:11:09 +02005783 local to buffer |local-noglobal|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005784 When on, the buffer is considered to be modified. This option is set
5785 when:
5786 1. A change was made to the text since it was last written. Using the
5787 |undo| command to go back to the original text will reset the
5788 option. But undoing changes that were made before writing the
5789 buffer will set the option again, since the text is different from
5790 when it was written.
5791 2. 'fileformat' or 'fileencoding' is different from its original
5792 value. The original value is set when the buffer is read or
5793 written. A ":set nomodified" command also resets the original
5794 values to the current values and the 'modified' option will be
5795 reset.
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01005796 Similarly for 'eol' and 'bomb'.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02005797 This option is not set when a change is made to the buffer as the
5798 result of a BufNewFile, BufRead/BufReadPost, BufWritePost,
5799 FileAppendPost or VimLeave autocommand event. See |gzip-example| for
5800 an explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005801 When 'buftype' is "nowrite" or "nofile" this option may be set, but
5802 will be ignored.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01005803 Note that the text may actually be the same, e.g. 'modified' is set
5804 when using "rA" on an "A".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005805
5806 *'more'* *'nomore'*
5807'more' boolean (Vim default: on, Vi default: off)
5808 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005809 When on, listings pause when the whole screen is filled. You will get
5810 the |more-prompt|. When this option is off there are no pauses, the
5811 listing continues until finished.
5812 NOTE: This option is set to the Vi default value when 'compatible' is
5813 set and to the Vim default value when 'compatible' is reset.
5814
Bram Moolenaar98a29d02021-01-18 19:55:44 +01005815 *'mouse'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005816'mouse' string (default "", "a" for GUI and Win32,
Bram Moolenaar5b418992019-10-27 18:50:25 +01005817 set to "a" or "nvi" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005818 global
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005819 Enable the use of the mouse. Works for most terminals (xterm, Win32
5820 |win32-mouse|, QNX pterm, *BSD console with sysmouse and Linux console
5821 with gpm). For using the mouse in the GUI, see |gui-mouse|. The
5822 mouse can be enabled for different modes:
Bram Moolenaar7f2e9d72017-11-11 20:58:53 +01005823 n Normal mode and Terminal modes
Bram Moolenaar071d4272004-06-13 20:20:40 +00005824 v Visual mode
5825 i Insert mode
5826 c Command-line mode
5827 h all previous modes when editing a help file
5828 a all previous modes
5829 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005830 Normally you would enable the mouse in all five modes with: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005831 :set mouse=a
Bram Moolenaar5b418992019-10-27 18:50:25 +01005832< If your terminal can't overrule the mouse events going to the
5833 application, use: >
5834 :set mouse=nvi
Bram Moolenaar65e0d772020-06-14 17:29:55 +02005835< Then you can press ":", select text for the system, and press Esc to go
Bram Moolenaar5b418992019-10-27 18:50:25 +01005836 back to Vim using the mouse events.
5837 In |defaults.vim| "nvi" is used if the 'term' option is not matching
5838 "xterm".
5839
5840 When the mouse is not enabled, the GUI will still use the mouse for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005841 modeless selection. This doesn't move the text cursor.
5842
5843 See |mouse-using|. Also see |'clipboard'|.
5844
5845 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005846 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005847 the mouse buttons can still be used by keeping the shift key pressed.
5848 Also see the 'clipboard' option.
5849
5850 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
5851'mousefocus' 'mousef' boolean (default off)
5852 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005853 {only works in the GUI}
5854 The window that the mouse pointer is on is automatically activated.
5855 When changing the window layout or window focus in another way, the
5856 mouse pointer is moved to the window with keyboard focus. Off is the
5857 default because it makes using the pull down menus a little goofy, as
5858 a pointer transit may activate a window unintentionally.
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01005859 MS-Windows: Also see 'scrollfocus' for what window is scrolled when
Bram Moolenaar1d9215b2020-01-25 13:27:42 +01005860 using the mouse scroll wheel.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005861
5862 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
5863'mousehide' 'mh' boolean (default on)
5864 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005865 {only works in the GUI}
5866 When on, the mouse pointer is hidden when characters are typed.
5867 The mouse pointer is restored when the mouse is moved.
5868
5869 *'mousemodel'* *'mousem'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005870'mousemodel' 'mousem' string (default "extend", "popup" for Win32)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005871 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005872 Sets the model to use for the mouse. The name mostly specifies what
5873 the right mouse button is used for:
5874 extend Right mouse button extends a selection. This works
5875 like in an xterm.
5876 popup Right mouse button pops up a menu. The shifted left
5877 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00005878 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005879 popup_setpos Like "popup", but the cursor will be moved to the
5880 position where the mouse was clicked, and thus the
5881 selected operation will act upon the clicked object.
5882 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00005883 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005884 course, that right clicking outside a selection will
5885 end Visual mode.
5886 Overview of what button does what for each model:
5887 mouse extend popup(_setpos) ~
5888 left click place cursor place cursor
5889 left drag start selection start selection
5890 shift-left search word extend selection
5891 right click extend selection popup menu (place cursor)
5892 right drag extend selection -
5893 middle click paste paste
5894
5895 In the "popup" model the right mouse button produces a pop-up menu.
5896 You need to define this first, see |popup-menu|.
5897
5898 Note that you can further refine the meaning of buttons with mappings.
5899 See |gui-mouse-mapping|. But mappings are NOT used for modeless
5900 selection (because that's handled in the GUI code directly).
5901
5902 The 'mousemodel' option is set by the |:behave| command.
5903
h_east59858792023-10-25 22:47:05 +09005904 *'mousemoveevent'* *'mousemev'* *'nomousemoveevent'* *'nomousemev'*
Ernie Raelc4cb5442022-04-03 15:47:28 +01005905'mousemoveevent' 'mousemev' boolean (default off)
5906 global
5907 {only works in the GUI}
5908 When on, mouse move events are delivered to the input queue and are
5909 available for mapping. The default, off, avoids the mouse movement
5910 overhead except when needed. See |gui-mouse-mapping|.
5911 Warning: Setting this option can make pending mappings to be aborted
5912 when the mouse is moved.
5913 Currently only works in the GUI, may be made to work in a terminal
5914 later.
5915
Bram Moolenaar071d4272004-06-13 20:20:40 +00005916 *'mouseshape'* *'mouses'* *E547*
Bram Moolenaarf6b40102019-02-22 15:24:03 +01005917'mouseshape' 'mouses' string (default "i-r:beam,s:updown,sd:udsizing,
5918 vs:leftright,vd:lrsizing,m:no,
5919 ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005920 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005921 {only available when compiled with the |+mouseshape|
5922 feature}
5923 This option tells Vim what the mouse pointer should look like in
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01005924 different modes. The option is a comma-separated list of parts, much
Bram Moolenaar071d4272004-06-13 20:20:40 +00005925 like used for 'guicursor'. Each part consist of a mode/location-list
5926 and an argument-list:
5927 mode-list:shape,mode-list:shape,..
5928 The mode-list is a dash separated list of these modes/locations:
5929 In a normal window: ~
5930 n Normal mode
5931 v Visual mode
5932 ve Visual mode with 'selection' "exclusive" (same as 'v',
5933 if not specified)
5934 o Operator-pending mode
5935 i Insert mode
5936 r Replace mode
5937
5938 Others: ~
5939 c appending to the command-line
5940 ci inserting in the command-line
5941 cr replacing in the command-line
5942 m at the 'Hit ENTER' or 'More' prompts
5943 ml idem, but cursor in the last line
5944 e any mode, pointer below last window
5945 s any mode, pointer on a status line
5946 sd any mode, while dragging a status line
5947 vs any mode, pointer on a vertical separator line
5948 vd any mode, while dragging a vertical separator line
5949 a everywhere
5950
5951 The shape is one of the following:
5952 avail name looks like ~
5953 w x arrow Normal mouse pointer
5954 w x blank no pointer at all (use with care!)
5955 w x beam I-beam
5956 w x updown up-down sizing arrows
5957 w x leftright left-right sizing arrows
5958 w x busy The system's usual busy pointer
5959 w x no The system's usual 'no input' pointer
5960 x udsizing indicates up-down resizing
5961 x lrsizing indicates left-right resizing
5962 x crosshair like a big thin +
5963 x hand1 black hand
5964 x hand2 white hand
5965 x pencil what you write with
5966 x question big ?
5967 x rightup-arrow arrow pointing right-up
5968 w x up-arrow arrow pointing up
5969 x <number> any X11 pointer number (see X11/cursorfont.h)
5970
5971 The "avail" column contains a 'w' if the shape is available for Win32,
5972 x for X11.
5973 Any modes not specified or shapes not available use the normal mouse
5974 pointer.
5975
5976 Example: >
5977 :set mouseshape=s:udsizing,m:no
5978< will make the mouse turn to a sizing arrow over the status lines and
5979 indicate no input when the hit-enter prompt is displayed (since
5980 clicking the mouse has no effect in this state.)
5981
5982 *'mousetime'* *'mouset'*
5983'mousetime' 'mouset' number (default 500)
5984 global
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005985 Only for GUI, Win32 and Unix with xterm. Defines the maximum
Bram Moolenaar071d4272004-06-13 20:20:40 +00005986 time in msec between two mouse clicks for the second click to be
5987 recognized as a multi click.
5988
Shougo Matsushita4bd9b2b2024-11-14 22:31:48 +01005989
laburnumT3f7855a2023-12-05 18:37:03 +01005990 *'mzquantum'* *'mzq'*
5991'mzquantum' 'mzq' number (default 100)
5992 global
5993 {not available when compiled without the |+mzscheme|
5994 feature}
5995 The number of milliseconds between polls for MzScheme threads.
5996 Negative or zero value means no thread scheduling.
5997 NOTE: This option is set to the Vim default value when 'compatible'
5998 is reset.
5999
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02006000 *'mzschemedll'*
6001'mzschemedll' string (default depends on the build)
6002 global
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02006003 {only available when compiled with the |+mzscheme/dyn|
6004 feature}
6005 Specifies the name of the MzScheme shared library. The default is
6006 DYNAMIC_MZSCH_DLL which was specified at compile time.
6007 Environment variables are expanded |:set_env|.
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01006008 The value must be set in the |vimrc| script or earlier. In the
Bram Moolenaar01164a62017-11-02 22:58:42 +01006009 startup, before the |load-plugins| step.
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02006010 This option cannot be set from a |modeline| or in the |sandbox|, for
6011 security reasons.
6012
6013 *'mzschemegcdll'*
6014'mzschemegcdll' string (default depends on the build)
6015 global
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02006016 {only available when compiled with the |+mzscheme/dyn|
6017 feature}
6018 Specifies the name of the MzScheme GC shared library. The default is
6019 DYNAMIC_MZGC_DLL which was specified at compile time.
6020 The value can be equal to 'mzschemedll' if it includes the GC code.
6021 Environment variables are expanded |:set_env|.
6022 This option cannot be set from a |modeline| or in the |sandbox|, for
6023 security reasons.
6024
Bram Moolenaar071d4272004-06-13 20:20:40 +00006025 *'nrformats'* *'nf'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02006026'nrformats' 'nf' string (default "bin,octal,hex",
6027 set to "bin,hex" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006028 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00006029 This defines what bases Vim will consider for numbers when using the
6030 CTRL-A and CTRL-X commands for adding to and subtracting from a number
6031 respectively; see |CTRL-A| for more info on these commands.
Bram Moolenaar4770d092006-01-12 23:22:24 +00006032 alpha If included, single alphabetical characters will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00006033 incremented or decremented. This is useful for a list with a
Bram Moolenaar3848e002016-03-19 18:42:29 +01006034 letter index a), b), etc. *octal-nrformats*
Bram Moolenaar4770d092006-01-12 23:22:24 +00006035 octal If included, numbers that start with a zero will be considered
Bram Moolenaar071d4272004-06-13 20:20:40 +00006036 to be octal. Example: Using CTRL-A on "007" results in "010".
Bram Moolenaar4770d092006-01-12 23:22:24 +00006037 hex If included, numbers starting with "0x" or "0X" will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00006038 considered to be hexadecimal. Example: Using CTRL-X on
6039 "0x100" results in "0x0ff".
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006040 bin If included, numbers starting with "0b" or "0B" will be
6041 considered to be binary. Example: Using CTRL-X on
6042 "0b1000" subtracts one, resulting in "0b0111".
Bram Moolenaaraaad9952020-05-31 15:08:59 +02006043 unsigned If included, numbers are recognized as unsigned. Thus a
6044 leading dash or negative sign won't be considered as part of
6045 the number. Examples:
6046 Using CTRL-X on "2020" in "9-2020" results in "9-2019"
6047 (without "unsigned" it would become "9-2021").
6048 Using CTRL-A on "2020" in "9-2020" results in "9-2021"
6049 (without "unsigned" it would become "9-2019").
Bram Moolenaaracc22402020-06-07 21:07:18 +02006050 Using CTRL-X on "0" or CTRL-A on "18446744073709551615"
6051 (2^64 - 1) has no effect, overflow is prevented.
distobs25ac6d62024-07-06 17:50:09 +02006052 blank If included, treat numbers as signed or unsigned based on
h-east52e7cc22024-07-28 17:03:29 +02006053 preceding whitespace. If a number with a leading dash has its
distobs25ac6d62024-07-06 17:50:09 +02006054 dash immediately preceded by a non-whitespace character (i.e.,
6055 not a tab or a " "), the negative sign won't be considered as
6056 part of the number. For example:
6057 Using CTRL-A on "14" in "Carbon-14" results in "Carbon-15"
6058 (without "blank" it would become "Carbon-13").
6059 Using CTRL-X on "8" in "Carbon -8" results in "Carbon -9"
h-east52e7cc22024-07-28 17:03:29 +02006060 (because -8 is preceded by whitespace. If "unsigned" was
distobs25ac6d62024-07-06 17:50:09 +02006061 set, it would result in "Carbon -7").
6062 If this format is included, overflow is prevented as if
h-east52e7cc22024-07-28 17:03:29 +02006063 "unsigned" were set. If both this format and "unsigned" are
distobs25ac6d62024-07-06 17:50:09 +02006064 included, "unsigned" will take precedence.
6065
Bram Moolenaar071d4272004-06-13 20:20:40 +00006066 Numbers which simply begin with a digit in the range 1-9 are always
6067 considered decimal. This also happens for numbers that are not
6068 recognized as octal or hex.
6069
6070 *'number'* *'nu'* *'nonumber'* *'nonu'*
6071'number' 'nu' boolean (default off)
6072 local to window
6073 Print the line number in front of each line. When the 'n' option is
6074 excluded from 'cpoptions' a wrapped line will not use the column of
6075 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00006076 The 'numberwidth' option can be used to set the room used for the line
6077 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006078 When a long, wrapped line doesn't start with the first character, '-'
6079 characters are put before the number.
James McCoya80aad72021-12-22 19:45:28 +00006080 For highlighting see |hl-LineNr|, and |hl-CursorLineNr|, and the
6081 |:sign-define| "numhl" argument.
Bram Moolenaar203d04d2013-06-06 21:36:40 +02006082 *number_relativenumber*
6083 The 'relativenumber' option changes the displayed number to be
6084 relative to the cursor. Together with 'number' there are these
6085 four combinations (cursor in line 3):
6086
Bram Moolenaar3848e002016-03-19 18:42:29 +01006087 'nonu' 'nu' 'nonu' 'nu'
Bram Moolenaar203d04d2013-06-06 21:36:40 +02006088 'nornu' 'nornu' 'rnu' 'rnu'
6089
6090 |apple | 1 apple | 2 apple | 2 apple
6091 |pear | 2 pear | 1 pear | 1 pear
6092 |nobody | 3 nobody | 0 nobody |3 nobody
6093 |there | 4 there | 1 there | 1 there
Bram Moolenaar071d4272004-06-13 20:20:40 +00006094
Bram Moolenaar592e0a22004-07-03 16:05:59 +00006095 *'numberwidth'* *'nuw'*
6096'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
6097 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00006098 {only available when compiled with the |+linebreak|
6099 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00006100 Minimal number of columns to use for the line number. Only relevant
Bram Moolenaar64486672010-05-16 15:46:46 +02006101 when the 'number' or 'relativenumber' option is set or printing lines
6102 with a line number. Since one space is always between the number and
6103 the text, there is one less character for the number itself.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00006104 The value is the minimum width. A bigger width is used when needed to
Bram Moolenaar64486672010-05-16 15:46:46 +02006105 fit the highest line number in the buffer respectively the number of
6106 rows in the window, depending on whether 'number' or 'relativenumber'
6107 is set. Thus with the Vim default of 4 there is room for a line number
6108 up to 999. When the buffer has 1000 lines five columns will be used.
Bram Moolenaarf8a07122019-07-01 22:06:07 +02006109 The minimum value is 1, the maximum value is 20.
Bram Moolenaar036986f2017-03-16 17:41:02 +01006110 NOTE: This option is set to the Vi default value when 'compatible' is
6111 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00006112
Bram Moolenaarf75a9632005-09-13 21:20:47 +00006113 *'omnifunc'* *'ofu'*
6114'omnifunc' 'ofu' string (default: empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00006115 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02006116 {not available when compiled without the |+eval|
Bram Moolenaare2c453d2019-08-21 14:37:09 +02006117 feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00006118 This option specifies a function to be used for Insert mode omni
6119 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
Bram Moolenaar280f1262006-01-30 00:14:18 +00006120 See |complete-functions| for an explanation of how the function is
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00006121 invoked and what it should return. The value can be the name of a
6122 function, a |lambda| or a |Funcref|. See |option-value-function| for
6123 more information.
Bram Moolenaar043545e2006-10-10 16:44:07 +00006124 This option is usually set by a filetype plugin:
Bram Moolenaar9c102382006-05-03 21:26:49 +00006125 |:filetype-plugin-on|
Bram Moolenaar30b65812012-07-12 22:01:11 +02006126 This option cannot be set from a |modeline| or in the |sandbox|, for
6127 security reasons.
Bram Moolenaare344bea2005-09-01 20:46:49 +00006128
Bram Moolenaar02467872007-05-06 13:22:01 +00006129 *'opendevice'* *'odev'* *'noopendevice'* *'noodev'*
Bram Moolenaar043545e2006-10-10 16:44:07 +00006130'opendevice' 'odev' boolean (default off)
6131 global
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00006132 {only for MS-Windows} *E796*
Bram Moolenaar043545e2006-10-10 16:44:07 +00006133 Enable reading and writing from devices. This may get Vim stuck on a
6134 device that can be opened but doesn't actually do the I/O. Therefore
6135 it is off by default.
6136 Note that on MS-Windows editing "aux.h", "lpt1.txt" and the like also
6137 result in editing a device.
6138
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006139 *'operatorfunc'* *'opfunc'*
6140'operatorfunc' 'opfunc' string (default: empty)
6141 global
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006142 This option specifies a function to be called by the |g@| operator.
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +00006143 See |:map-operator| for more info and an example. The value can be
6144 the name of a function, a |lambda| or a |Funcref|. See
6145 |option-value-function| for more information.
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006146
6147 This option cannot be set from a |modeline| or in the |sandbox|, for
6148 security reasons.
6149
Bram Moolenaar251e1912011-06-19 05:09:16 +02006150 *'osfiletype'* *'oft'*
6151'osfiletype' 'oft' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006152 local to buffer
Bram Moolenaar251e1912011-06-19 05:09:16 +02006153 This option was supported on RISC OS, which has been removed.
6154
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01006155 *'packpath'* *'pp'*
6156'packpath' 'pp' string (default: see 'runtimepath')
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01006157 Directories used to find packages. See |packages|.
dkearns8ebdbc92023-10-29 06:26:19 +11006158 This option cannot be set from a |modeline| or in the |sandbox|, for
6159 security reasons.
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01006160
Bram Moolenaar071d4272004-06-13 20:20:40 +00006161 *'paragraphs'* *'para'*
Bram Moolenaar57e48462008-03-12 16:38:55 +00006162'paragraphs' 'para' string (default "IPLPPPQPP TPHPLIPpLpItpplpipbp")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006163 global
6164 Specifies the nroff macros that separate paragraphs. These are pairs
6165 of two letters (see |object-motions|).
6166
6167 *'paste'* *'nopaste'*
6168'paste' boolean (default off)
6169 global
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006170 Put Vim in Paste mode. This is useful if you want to cut or copy
6171 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00006172 unexpected effects.
6173 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006174 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00006175 knows about pasting and will mostly do the right thing without 'paste'
6176 being set. The same is true for a terminal where Vim handles the
6177 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00006178 This option is reset when starting the GUI. Thus if you set it in
6179 your .vimrc it will work in a terminal, but not in the GUI. Setting
6180 'paste' in the GUI has side effects: e.g., the Paste toolbar button
6181 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006182 When the 'paste' option is switched on (also when it was already on):
6183 - mapping in Insert mode and Command-line mode is disabled
6184 - abbreviations are disabled
Bram Moolenaar071d4272004-06-13 20:20:40 +00006185 - 'autoindent' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02006186 - 'expandtab' is reset
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02006187 - 'hkmap' is reset
Bram Moolenaar071d4272004-06-13 20:20:40 +00006188 - 'revins' is reset
6189 - 'ruler' is reset
6190 - 'showmatch' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02006191 - 'smarttab' is reset
6192 - 'softtabstop' is set to 0
6193 - 'textwidth' is set to 0
6194 - 'wrapmargin' is set to 0
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02006195 - 'varsofttabstop' is made empty
Bram Moolenaar071d4272004-06-13 20:20:40 +00006196 These options keep their value, but their effect is disabled:
Bram Moolenaar071d4272004-06-13 20:20:40 +00006197 - 'cindent'
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02006198 - 'formatoptions' is used like it is empty
Bram Moolenaarca635012015-09-25 20:34:21 +02006199 - 'indentexpr'
6200 - 'lisp'
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02006201 - 'smartindent'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006202 NOTE: When you start editing another file while the 'paste' option is
6203 on, settings from the modelines or autocommands may change the
6204 settings again, causing trouble when pasting text. You might want to
6205 set the 'paste' option again.
6206 When the 'paste' option is reset the mentioned options are restored to
6207 the value before the moment 'paste' was switched from off to on.
6208 Resetting 'paste' before ever setting it does not have any effect.
6209 Since mapping doesn't work while 'paste' is active, you need to use
6210 the 'pastetoggle' option to toggle the 'paste' option with some key.
6211
6212 *'pastetoggle'* *'pt'*
6213'pastetoggle' 'pt' string (default "")
6214 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006215 When non-empty, specifies the key sequence that toggles the 'paste'
6216 option. This is like specifying a mapping: >
6217 :map {keys} :set invpaste<CR>
6218< Where {keys} is the value of 'pastetoggle'.
6219 The difference is that it will work even when 'paste' is set.
6220 'pastetoggle' works in Insert mode and Normal mode, but not in
6221 Command-line mode.
6222 Mappings are checked first, thus overrule 'pastetoggle'. However,
6223 when 'paste' is on mappings are ignored in Insert mode, thus you can do
6224 this: >
6225 :map <F10> :set paste<CR>
6226 :map <F11> :set nopaste<CR>
6227 :imap <F10> <C-O>:set paste<CR>
6228 :imap <F11> <nop>
6229 :set pastetoggle=<F11>
6230< This will make <F10> start paste mode and <F11> stop paste mode.
6231 Note that typing <F10> in paste mode inserts "<F10>", since in paste
6232 mode everything is inserted literally, except the 'pastetoggle' key
6233 sequence.
Bram Moolenaar446cb832008-06-24 21:56:24 +00006234 When the value has several bytes 'ttimeoutlen' applies.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006235
6236 *'pex'* *'patchexpr'*
6237'patchexpr' 'pex' string (default "")
6238 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006239 {not available when compiled without the |+diff|
6240 feature}
6241 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006242 the resulting new version of the file. See |diff-patchexpr|.
dkearns8ebdbc92023-10-29 06:26:19 +11006243 This option cannot be set from a |modeline| or in the |sandbox|, for
6244 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006245
Bram Moolenaardbc28022014-07-26 13:40:44 +02006246 *'patchmode'* *'pm'* *E205* *E206*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006247'patchmode' 'pm' string (default "")
6248 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006249 When non-empty the oldest version of a file is kept. This can be used
6250 to keep the original version of a file if you are changing files in a
6251 source distribution. Only the first time that a file is written a
6252 copy of the original file will be kept. The name of the copy is the
6253 name of the original file with the string in the 'patchmode' option
6254 appended. This option should start with a dot. Use a string like
Bram Moolenaardf980db2017-12-24 13:22:00 +01006255 ".orig" or ".org". 'backupdir' must not be empty for this to work
6256 (Detail: The backup file is renamed to the patchmode file after the
6257 new file has been successfully written, that's why it must be possible
6258 to write a backup file). If there was no file to be backed up, an
6259 empty file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006260 When the 'backupskip' pattern matches, a patchmode file is not made.
6261 Using 'patchmode' for compressed files appends the extension at the
6262 end (e.g., "file.gz.orig"), thus the resulting name isn't always
6263 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006264 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006265
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01006266 *'path'* *'pa'* *E343* *E345* *E347* *E854*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006267'path' 'pa' string (default on Unix: ".,/usr/include,,"
Bram Moolenaar071d4272004-06-13 20:20:40 +00006268 other systems: ".,,")
6269 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006270 This is a list of directories which will be searched when using the
Bram Moolenaarc236c162008-07-13 17:41:49 +00006271 |gf|, [f, ]f, ^Wf, |:find|, |:sfind|, |:tabfind| and other commands,
6272 provided that the file being searched for has a relative path (not
6273 starting with "/", "./" or "../"). The directories in the 'path'
6274 option may be relative or absolute.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006275 - Use commas to separate directory names: >
6276 :set path=.,/usr/local/include,/usr/include
6277< - Spaces can also be used to separate directory names (for backwards
6278 compatibility with version 3.0). To have a space in a directory
6279 name, precede it with an extra backslash, and escape the space: >
6280 :set path=.,/dir/with\\\ space
6281< - To include a comma in a directory name precede it with an extra
6282 backslash: >
6283 :set path=.,/dir/with\\,comma
6284< - To search relative to the directory of the current file, use: >
6285 :set path=.
6286< - To search in the current directory use an empty string between two
6287 commas: >
6288 :set path=,,
6289< - A directory name may end in a ':' or '/'.
6290 - Environment variables are expanded |:set_env|.
6291 - When using |netrw.vim| URLs can be used. For example, adding
6292 "http://www.vim.org" will make ":find index.html" work.
Bram Moolenaarc236c162008-07-13 17:41:49 +00006293 - Search upwards and downwards in a directory tree using "*", "**" and
6294 ";". See |file-searching| for info and syntax.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006295 - Careful with '\' characters, type two to get one in the option: >
6296 :set path=.,c:\\include
6297< Or just use '/' instead: >
6298 :set path=.,c:/include
6299< Don't forget "." or files won't even be found in the same directory as
6300 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006301 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00006302 it is something like 256 or 1024 characters.
6303 You can check if all the include files are found, using the value of
6304 'path', see |:checkpath|.
6305 The use of |:set+=| and |:set-=| is preferred when adding or removing
6306 directories from the list. This avoids problems when a future version
6307 uses another default. To remove the current directory use: >
6308 :set path-=
6309< To add the current directory use: >
6310 :set path+=
6311< To use an environment variable, you probably need to replace the
6312 separator. Here is an example to append $INCL, in which directory
Dominique Pellédf62c622024-07-15 20:29:59 +02006313 names are separated with a semicolon: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00006314 :let &path = &path .. "," .. substitute($INCL, ';', ',', 'g')
Bram Moolenaar071d4272004-06-13 20:20:40 +00006315< Replace the ';' with a ':' or whatever separator is used. Note that
6316 this doesn't work when $INCL contains a comma or white space.
6317
Bram Moolenaar37c64c72017-09-19 22:06:03 +02006318 *'perldll'*
6319'perldll' string (default depends on the build)
6320 global
Bram Moolenaar37c64c72017-09-19 22:06:03 +02006321 {only available when compiled with the |+perl/dyn|
6322 feature}
6323 Specifies the name of the Perl shared library. The default is
6324 DYNAMIC_PERL_DLL, which was specified at compile time.
6325 Environment variables are expanded |:set_env|.
6326 This option cannot be set from a |modeline| or in the |sandbox|, for
6327 security reasons.
6328
Bram Moolenaar071d4272004-06-13 20:20:40 +00006329 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
6330'preserveindent' 'pi' boolean (default off)
6331 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00006332 When changing the indent of the current line, preserve as much of the
6333 indent structure as possible. Normally the indent is replaced by a
6334 series of tabs followed by spaces as required (unless |'expandtab'| is
6335 enabled, in which case only spaces are used). Enabling this option
6336 means the indent will preserve as many existing characters as possible
6337 for indenting, and only add additional tabs or spaces as required.
Bram Moolenaar446cb832008-06-24 21:56:24 +00006338 'expandtab' does not apply to the preserved white space, a Tab remains
6339 a Tab.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006340 NOTE: When using ">>" multiple times the resulting indent is a mix of
6341 tabs and spaces. You might not like this.
Bram Moolenaar036986f2017-03-16 17:41:02 +01006342 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006343 Also see 'copyindent'.
6344 Use |:retab| to clean up white space.
6345
6346 *'previewheight'* *'pvh'*
6347'previewheight' 'pvh' number (default 12)
6348 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02006349 {not available when compiled without the |+quickfix|
6350 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006351 Default height for a preview window. Used for |:ptag| and associated
Bram Moolenaar79648732019-07-18 21:43:07 +02006352 commands. Used for |CTRL-W_}| when no count is given. Not used when
6353 'previewpopup' is set.
6354
6355 *'previewpopup'* *'pvp'*
6356'previewpopup' 'pvp' string (default empty)
6357 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02006358 {not available when compiled without the |+textprop|
6359 or |+quickfix| feature}
Bram Moolenaar79648732019-07-18 21:43:07 +02006360 When not empty a popup window is used for commands that would open a
6361 preview window. See |preview-popup|.
Bram Moolenaar576a4a62019-08-18 15:25:17 +02006362 Not used for the insert completion info, add "popup" to
6363 'completeopt' for that.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006364
6365 *'previewwindow'* *'nopreviewwindow'*
6366 *'pvw'* *'nopvw'* *E590*
6367'previewwindow' 'pvw' boolean (default off)
Christian Brabandt596ad662023-08-16 00:11:09 +02006368 local to window |local-noglobal|
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02006369 {not available when compiled without the |+quickfix|
6370 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006371 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00006372 set. It's normally not set directly, but by using one of the commands
6373 |:ptag|, |:pedit|, etc.
6374
6375 *'printdevice'* *'pdev'*
6376'printdevice' 'pdev' string (default empty)
6377 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006378 {only available when compiled with the |+printer|
6379 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006380 The name of the printer to be used for |:hardcopy|.
6381 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006382 This option cannot be set from a |modeline| or in the |sandbox|, for
6383 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006384
Bram Moolenaar8299df92004-07-10 09:47:34 +00006385 *'printencoding'* *'penc'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02006386'printencoding' 'penc' string (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006387 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006388 {only available when compiled with the |+printer|
6389 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006390 Sets the character encoding used when printing.
6391 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006392
6393 *'printexpr'* *'pexpr'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02006394'printexpr' 'pexpr' string (default: see below)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006395 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006396 {only available when compiled with the |+printer|
6397 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006398 Expression used to print the PostScript produced with |:hardcopy|.
6399 See |pexpr-option|.
Bram Moolenaar51628222016-12-01 23:03:28 +01006400 This option cannot be set from a |modeline| or in the |sandbox|, for
6401 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006402
Bram Moolenaar8299df92004-07-10 09:47:34 +00006403 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006404'printfont' 'pfn' string (default "courier")
6405 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006406 {only available when compiled with the |+printer|
6407 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006408 The name of the font that will be used for |:hardcopy|.
6409 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006410
6411 *'printheader'* *'pheader'*
6412'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
6413 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006414 {only available when compiled with the |+printer|
6415 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006416 The format of the header produced in |:hardcopy| output.
6417 See |pheader-option|.
6418
6419 *'printmbcharset'* *'pmbcs'*
6420'printmbcharset' 'pmbcs' string (default "")
6421 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01006422 {only available when compiled with the |+printer|
6423 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006424 The CJK character set to be used for CJK output from |:hardcopy|.
6425 See |pmbcs-option|.
6426
6427 *'printmbfont'* *'pmbfn'*
6428'printmbfont' 'pmbfn' string (default "")
6429 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01006430 {only available when compiled with the |+printer|
6431 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006432 List of font names to be used for CJK output from |:hardcopy|.
6433 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006434
6435 *'printoptions'* *'popt'*
6436'printoptions' 'popt' string (default "")
6437 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006438 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006439 List of items that control the format of the output of |:hardcopy|.
6440 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006441
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006442 *'prompt'* *'noprompt'*
6443'prompt' boolean (default on)
6444 global
6445 When on a ":" prompt is used in Ex mode.
6446
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00006447 *'pumheight'* *'ph'*
6448'pumheight' 'ph' number (default 0)
6449 global
Bram Moolenaar06a89a52006-04-29 22:01:03 +00006450 Determines the maximum number of items to show in the popup menu for
6451 Insert mode completion. When zero as much space as available is used.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00006452 |ins-completion-menu|.
6453
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01006454 *'pumwidth'* *'pw'*
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006455'pumwidth' 'pw' number (default 15)
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01006456 global
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01006457 Determines the minimum width to use for the popup menu for Insert mode
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006458 completion. |ins-completion-menu|.
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01006459
Bram Moolenaard94464e2015-11-02 15:28:18 +01006460 *'pythondll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01006461'pythondll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01006462 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01006463 {only available when compiled with the |+python/dyn|
6464 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006465 Specifies the name of the Python 2.x shared library. The default is
6466 DYNAMIC_PYTHON_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006467 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01006468 This option cannot be set from a |modeline| or in the |sandbox|, for
6469 security reasons.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00006470
Bram Moolenaar94073162018-01-31 21:49:05 +01006471 *'pythonhome'*
6472'pythonhome' string (default "")
6473 global
Bram Moolenaar94073162018-01-31 21:49:05 +01006474 {only available when compiled with the |+python/dyn|
6475 feature}
6476 Specifies the name of the Python 2.x home directory. When 'pythonhome'
6477 and the PYTHONHOME environment variable are not set, PYTHON_HOME,
6478 which was specified at compile time, will be used for the Python 2.x
6479 home directory.
6480 Environment variables are expanded |:set_env|.
6481 This option cannot be set from a |modeline| or in the |sandbox|, for
6482 security reasons.
6483
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006484 *'pythonthreedll'*
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006485'pythonthreedll' string (default depends on the build)
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006486 global
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006487 {only available when compiled with the |+python3/dyn|
6488 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006489 Specifies the name of the Python 3 shared library. The default is
6490 DYNAMIC_PYTHON3_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006491 Environment variables are expanded |:set_env|.
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006492 This option cannot be set from a |modeline| or in the |sandbox|, for
6493 security reasons.
6494
Bram Moolenaar94073162018-01-31 21:49:05 +01006495 *'pythonthreehome'*
6496'pythonthreehome' string (default "")
6497 global
Bram Moolenaar94073162018-01-31 21:49:05 +01006498 {only available when compiled with the |+python3/dyn|
6499 feature}
6500 Specifies the name of the Python 3 home directory. When
6501 'pythonthreehome' and the PYTHONHOME environment variable are not set,
6502 PYTHON3_HOME, which was specified at compile time, will be used for
6503 the Python 3 home directory.
6504 Environment variables are expanded |:set_env|.
6505 This option cannot be set from a |modeline| or in the |sandbox|, for
6506 security reasons.
6507
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01006508 *'pyxversion'* *'pyx'*
6509'pyxversion' 'pyx' number (default depends on the build)
6510 global
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01006511 {only available when compiled with the |+python| or
6512 the |+python3| feature}
6513 Specifies the python version used for pyx* functions and commands
6514 |python_x|. The default value is as follows:
6515
6516 Compiled with Default ~
6517 |+python| and |+python3| 0
6518 only |+python| 2
6519 only |+python3| 3
6520
6521 Available values are 0, 2 and 3.
6522 If 'pyxversion' is 0, it is set to 2 or 3 after the first execution of
6523 any python2/3 commands or functions. E.g. `:py` sets to 2, and `:py3`
6524 sets to 3. `:pyx` sets it to 3 if Python 3 is available, otherwise sets
6525 to 2 if Python 2 is available.
6526 See also: |has-pythonx|
6527
6528 If Vim is compiled with only |+python| or |+python3| setting
6529 'pyxversion' has no effect. The pyx* functions and commands are
6530 always the same as the compiled version.
6531
6532 This option cannot be set from a |modeline| or in the |sandbox|, for
6533 security reasons.
6534
Bram Moolenaar858ba062020-05-31 23:11:59 +02006535 *'quickfixtextfunc'* *'qftf'*
6536'quickfixtextfunc' 'qftf' string (default "")
6537 global
6538 {only available when compiled with the |+quickfix|
6539 feature}
6540 This option specifies a function to be used to get the text to display
6541 in the quickfix and location list windows. This can be used to
6542 customize the information displayed in the quickfix or location window
6543 for each entry in the corresponding quickfix or location list. See
6544 |quickfix-window-function| for an explanation of how to write the
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +00006545 function and an example. The value can be the name of a function, a
6546 |lambda| or a |Funcref|. See |option-value-function| for more
6547 information.
Bram Moolenaar858ba062020-05-31 23:11:59 +02006548
6549 This option cannot be set from a |modeline| or in the |sandbox|, for
6550 security reasons.
6551
Bram Moolenaar677ee682005-01-27 14:41:15 +00006552 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00006553'quoteescape' 'qe' string (default "\")
6554 local to buffer
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00006555 The characters that are used to escape quotes in a string. Used for
6556 objects like a', a" and a` |a'|.
6557 When one of the characters in this option is found inside a string,
6558 the following character will be skipped. The default value makes the
6559 text "foo\"bar\\" considered to be one string.
6560
Bram Moolenaar071d4272004-06-13 20:20:40 +00006561 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
6562'readonly' 'ro' boolean (default off)
Christian Brabandt596ad662023-08-16 00:11:09 +02006563 local to buffer |local-noglobal|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006564 If on, writes fail unless you use a '!'. Protects you from
6565 accidentally overwriting a file. Default on when Vim is started
6566 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006567 When using ":w!" the 'readonly' option is reset for the current
6568 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar6c60f472019-04-28 16:00:35 +02006569 When using the ":view" command the 'readonly' option is set for the
6570 newly edited buffer.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01006571 See 'modifiable' for disallowing changes to the buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006572
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006573 *'redrawtime'* *'rdt'*
6574'redrawtime' 'rdt' number (default 2000)
6575 global
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006576 {only available when compiled with the |+reltime|
6577 feature}
6578 The time in milliseconds for redrawing the display. This applies to
Bram Moolenaar15142e22018-04-30 22:19:58 +02006579 searching for patterns for 'hlsearch', |:match| highlighting and syntax
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02006580 highlighting.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006581 When redrawing takes more than this many milliseconds no further
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02006582 matches will be highlighted.
6583 For syntax highlighting the time applies per window. When over the
6584 limit syntax highlighting is disabled until |CTRL-L| is used.
6585 This is used to avoid that Vim hangs when using a very complicated
6586 pattern.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006587
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02006588 *'regexpengine'* *'re'*
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006589'regexpengine' 're' number (default 0)
6590 global
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006591 This selects the default regexp engine. |two-engines|
6592 The possible values are:
6593 0 automatic selection
6594 1 old engine
6595 2 NFA engine
6596 Note that when using the NFA engine and the pattern contains something
6597 that is not supported the pattern will not match. This is only useful
6598 for debugging the regexp engine.
Bram Moolenaarfda37292014-11-05 14:27:36 +01006599 Using automatic selection enables Vim to switch the engine, if the
6600 default engine becomes too costly. E.g., when the NFA engine uses too
6601 many states. This should prevent Vim from hanging on a combination of
6602 a complex pattern with long text.
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006603
Bram Moolenaar64486672010-05-16 15:46:46 +02006604 *'relativenumber'* *'rnu'* *'norelativenumber'* *'nornu'*
6605'relativenumber' 'rnu' boolean (default off)
6606 local to window
Bram Moolenaar64486672010-05-16 15:46:46 +02006607 Show the line number relative to the line with the cursor in front of
Bram Moolenaar06b5d512010-05-22 15:37:44 +02006608 each line. Relative line numbers help you use the |count| you can
Bram Moolenaar64486672010-05-16 15:46:46 +02006609 precede some vertical motion commands (e.g. j k + -) with, without
6610 having to calculate it yourself. Especially useful in combination with
6611 other commands (e.g. y d c < > gq gw =).
6612 When the 'n' option is excluded from 'cpoptions' a wrapped
6613 line will not use the column of line numbers (this is the default when
6614 'compatible' isn't set).
6615 The 'numberwidth' option can be used to set the room used for the line
6616 number.
6617 When a long, wrapped line doesn't start with the first character, '-'
6618 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02006619 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
6620 the number.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01006621
Bram Moolenaar203d04d2013-06-06 21:36:40 +02006622 The number in front of the cursor line also depends on the value of
6623 'number', see |number_relativenumber| for all combinations of the two
6624 options.
Bram Moolenaar64486672010-05-16 15:46:46 +02006625
Bram Moolenaar071d4272004-06-13 20:20:40 +00006626 *'remap'* *'noremap'*
6627'remap' boolean (default on)
6628 global
6629 Allows for mappings to work recursively. If you do not want this for
6630 a single entry, use the :noremap[!] command.
Bram Moolenaara3227e22006-03-08 21:32:40 +00006631 NOTE: To avoid portability problems with Vim scripts, always keep
6632 this option at the default "on". Only switch it off when working with
6633 old Vi scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006634
zeertzjqd086b8f2024-02-25 15:42:52 +08006635 *'renderoptions'* *'rop'*
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006636'renderoptions' 'rop' string (default: empty)
6637 global
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006638 {only available when compiled with GUI and DIRECTX on
6639 MS-Windows}
6640 Select a text renderer and set its options. The options depend on the
6641 renderer.
6642
6643 Syntax: >
6644 set rop=type:{renderer}(,{name}:{value})*
6645<
6646 Currently, only one optional renderer is available.
6647
6648 render behavior ~
6649 directx Vim will draw text using DirectX (DirectWrite). It makes
6650 drawn glyphs more beautiful than default GDI.
6651 It requires 'encoding' is "utf-8", and only works on
6652 MS-Windows Vista or newer version.
6653
6654 Options:
6655 name meaning type value ~
6656 gamma gamma float 1.0 - 2.2 (maybe)
6657 contrast enhancedContrast float (unknown)
6658 level clearTypeLevel float (unknown)
6659 geom pixelGeometry int 0 - 2 (see below)
6660 renmode renderingMode int 0 - 6 (see below)
6661 taamode textAntialiasMode int 0 - 3 (see below)
Bram Moolenaara338adc2018-01-31 20:51:47 +01006662 scrlines Scroll Lines int (deprecated)
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006663
Bram Moolenaar92467d32017-12-05 13:22:16 +01006664 See this URL for detail (except for scrlines):
6665 https://msdn.microsoft.com/en-us/library/dd368190.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006666
6667 For geom: structure of a device pixel.
6668 0 - DWRITE_PIXEL_GEOMETRY_FLAT
6669 1 - DWRITE_PIXEL_GEOMETRY_RGB
6670 2 - DWRITE_PIXEL_GEOMETRY_BGR
6671
6672 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006673 https://msdn.microsoft.com/en-us/library/dd368114.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006674
6675 For renmode: method of rendering glyphs.
6676 0 - DWRITE_RENDERING_MODE_DEFAULT
6677 1 - DWRITE_RENDERING_MODE_ALIASED
6678 2 - DWRITE_RENDERING_MODE_GDI_CLASSIC
6679 3 - DWRITE_RENDERING_MODE_GDI_NATURAL
6680 4 - DWRITE_RENDERING_MODE_NATURAL
6681 5 - DWRITE_RENDERING_MODE_NATURAL_SYMMETRIC
6682 6 - DWRITE_RENDERING_MODE_OUTLINE
6683
6684 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006685 https://msdn.microsoft.com/en-us/library/dd368118.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006686
6687 For taamode: antialiasing mode used for drawing text.
6688 0 - D2D1_TEXT_ANTIALIAS_MODE_DEFAULT
6689 1 - D2D1_TEXT_ANTIALIAS_MODE_CLEARTYPE
6690 2 - D2D1_TEXT_ANTIALIAS_MODE_GRAYSCALE
6691 3 - D2D1_TEXT_ANTIALIAS_MODE_ALIASED
6692
6693 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006694 https://msdn.microsoft.com/en-us/library/dd368170.aspx
6695
Bram Moolenaara338adc2018-01-31 20:51:47 +01006696 For scrlines:
6697 This was used for optimizing scrolling behavior, however this
6698 is now deprecated. If specified, it is simply ignored.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006699
6700 Example: >
6701 set encoding=utf-8
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006702 set gfn=Ricty_Diminished:h12
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006703 set rop=type:directx
6704<
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006705 If select a raster font (Courier, Terminal or FixedSys which
6706 have ".fon" extension in file name) to 'guifont', it will be
Bram Moolenaar92467d32017-12-05 13:22:16 +01006707 drawn by GDI as a fallback.
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006708
6709 NOTE: It is known that some fonts and options combination
6710 causes trouble on drawing glyphs.
6711
Bram Moolenaar92467d32017-12-05 13:22:16 +01006712 - 'renmode:5' and 'renmode:6' will not work with some
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006713 special made fonts (True-Type fonts which includes only
6714 bitmap glyphs).
6715 - 'taamode:3' will not work with some vector fonts.
6716
6717 NOTE: With this option, you can display colored emoji
6718 (emoticon) in Windows 8.1 or later. To display colored emoji,
6719 there are some conditions which you should notice.
6720
6721 - If your font includes non-colored emoji already, it will
6722 be used.
6723 - If your font doesn't have emoji, the system chooses an
6724 alternative symbol font. On Windows 10, "Segoe UI Emoji"
6725 will be used.
6726 - When this alternative font didn't have fixed width glyph,
6727 emoji might be rendered beyond the bounding box of drawing
6728 cell.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006729
6730 Other render types are currently not supported.
6731
Bram Moolenaar071d4272004-06-13 20:20:40 +00006732 *'report'*
6733'report' number (default 2)
6734 global
6735 Threshold for reporting number of lines changed. When the number of
6736 changed lines is more than 'report' a message will be given for most
6737 ":" commands. If you want it always, set 'report' to 0.
6738 For the ":substitute" command the number of substitutions is used
6739 instead of the number of lines.
6740
6741 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
6742'restorescreen' 'rs' boolean (default on)
6743 global
Bram Moolenaar8024f932020-01-14 19:29:13 +01006744 {only in MS-Windows console version}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006745 When set, the screen contents is restored when exiting Vim. This also
6746 happens when executing external commands.
6747
6748 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
6749 options in your .vimrc. To disable restoring:
6750 set t_ti= t_te=
6751 To enable restoring (for an xterm):
6752 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
6753 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
6754
6755 *'revins'* *'ri'* *'norevins'* *'nori'*
6756'revins' 'ri' boolean (default off)
6757 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006758 {only available when compiled with the |+rightleft|
6759 feature}
6760 Inserting characters in Insert mode will work backwards. See "typing
6761 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
6762 command in Insert mode, when 'allowrevins' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02006763 NOTE: This option is reset when 'compatible' is set.
6764 This option is reset when 'paste' is set and restored when 'paste' is
6765 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006766
6767 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
6768'rightleft' 'rl' boolean (default off)
6769 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006770 {only available when compiled with the |+rightleft|
6771 feature}
6772 When on, display orientation becomes right-to-left, i.e., characters
6773 that are stored in the file appear from the right to the left.
6774 Using this option, it is possible to edit files for languages that
6775 are written from the right to the left such as Hebrew and Arabic.
6776 This option is per window, so it is possible to edit mixed files
6777 simultaneously, or to view the same file in both ways (this is
6778 useful whenever you have a mixed text file with both right-to-left
6779 and left-to-right strings so that both sets are displayed properly
6780 in different windows). Also see |rileft.txt|.
6781
Bram Moolenaar607cc1e2010-07-18 18:47:44 +02006782 *'rightleftcmd'* *'rlc'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006783'rightleftcmd' 'rlc' string (default "search")
6784 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006785 {only available when compiled with the |+rightleft|
6786 feature}
6787 Each word in this option enables the command line editing to work in
6788 right-to-left mode for a group of commands:
6789
6790 search "/" and "?" commands
6791
6792 This is useful for languages such as Hebrew, Arabic and Farsi.
6793 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
6794
Bram Moolenaard94464e2015-11-02 15:28:18 +01006795 *'rubydll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01006796'rubydll' string (default: depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01006797 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01006798 {only available when compiled with the |+ruby/dyn|
6799 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006800 Specifies the name of the Ruby shared library. The default is
6801 DYNAMIC_RUBY_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006802 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01006803 This option cannot be set from a |modeline| or in the |sandbox|, for
6804 security reasons.
6805
Bram Moolenaar071d4272004-06-13 20:20:40 +00006806 *'ruler'* *'ru'* *'noruler'* *'noru'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02006807'ruler' 'ru' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006808 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006809 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006810 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00006811 text in the file is shown on the far right:
6812 Top first line is visible
6813 Bot last line is visible
6814 All first and last line are visible
6815 45% relative position in the file
6816 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006817 Each window has its own ruler. If a window has a status line, the
Bram Moolenaara2a89732022-08-31 14:46:18 +01006818 ruler is shown there. Otherwise it is shown in the last line of the
6819 screen. If the statusline is given by 'statusline' (i.e. not empty),
6820 this option takes precedence over 'ruler' and 'rulerformat'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006821 If the number of characters displayed is different from the number of
Bram Moolenaar207f0092020-08-30 17:20:20 +02006822 bytes in the text (e.g., for a TAB or a multibyte character), both
Bram Moolenaar071d4272004-06-13 20:20:40 +00006823 the text column (byte number) and the screen column are shown,
6824 separated with a dash.
6825 For an empty line "0-1" is shown.
6826 For an empty buffer the line number will also be zero: "0,0-1".
Bram Moolenaarca635012015-09-25 20:34:21 +02006827 This option is reset when 'paste' is set and restored when 'paste' is
6828 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006829 If you don't want to see the ruler all the time but want to know where
6830 you are, use "g CTRL-G" |g_CTRL-G|.
6831 NOTE: This option is reset when 'compatible' is set.
6832
6833 *'rulerformat'* *'ruf'*
6834'rulerformat' 'ruf' string (default empty)
6835 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006836 {not available when compiled without the |+statusline|
6837 feature}
6838 When this option is not empty, it determines the content of the ruler
6839 string, as displayed for the 'ruler' option.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00006840 The format of this option is like that of 'statusline'.
Bram Moolenaar110289e2019-05-23 15:38:06 +02006841 This option cannot be set in a modeline when 'modelineexpr' is off.
6842
Bram Moolenaar071d4272004-06-13 20:20:40 +00006843 The default ruler width is 17 characters. To make the ruler 15
6844 characters wide, put "%15(" at the start and "%)" at the end.
6845 Example: >
6846 :set rulerformat=%15(%c%V\ %p%%%)
6847<
6848 *'runtimepath'* *'rtp'* *vimfiles*
6849'runtimepath' 'rtp' string (default:
Christian Brabandtc3e6e392024-05-04 09:48:15 +02006850 Unix: "$HOME/.vim or
6851 $XDG_CONFIG_HOME/vim,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006852 $VIM/vimfiles,
6853 $VIMRUNTIME,
6854 $VIM/vimfiles/after,
6855 $HOME/.vim/after"
6856 Amiga: "home:vimfiles,
6857 $VIM/vimfiles,
6858 $VIMRUNTIME,
6859 $VIM/vimfiles/after,
6860 home:vimfiles/after"
Bram Moolenaar942db232021-02-13 18:14:48 +01006861 MS-Windows: "$HOME/vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006862 $VIM/vimfiles,
6863 $VIMRUNTIME,
6864 $VIM/vimfiles/after,
6865 $HOME/vimfiles/after"
Bram Moolenaarb3f74062020-02-26 16:16:53 +01006866 Haiku: "$BE_USER_SETTINGS/vim,
6867 $VIM/vimfiles,
6868 $VIMRUNTIME,
6869 $VIM/vimfiles/after,
Bram Moolenaar942db232021-02-13 18:14:48 +01006870 $BE_USER_SETTINGS/vim/after"
6871 VMS: "sys$login:vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006872 $VIM/vimfiles,
6873 $VIMRUNTIME,
6874 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00006875 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006876 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006877 This is a list of directories which will be searched for runtime
6878 files:
6879 filetype.vim filetypes by file name |new-filetype|
6880 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006881 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006882 colors/ color scheme files |:colorscheme|
6883 compiler/ compiler files |:compiler|
6884 doc/ documentation |write-local-help|
6885 ftplugin/ filetype plugins |write-filetype-plugin|
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01006886 import/ files that are found by `:import`
Bram Moolenaar071d4272004-06-13 20:20:40 +00006887 indent/ indent scripts |indent-expression|
6888 keymap/ key mapping files |mbyte-keymap|
RestorerZ96509102024-07-11 21:14:15 +02006889 lang/ message translations |:menutrans| and |multi-lang|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006890 menu.vim GUI menus |menu.vim|
Bram Moolenaar26852122016-05-24 20:02:38 +02006891 pack/ packages |:packadd|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006892 plugin/ plugin scripts |write-plugin|
6893 print/ files for printing |postscript-print-encoding|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006894 spell/ spell checking files |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006895 syntax/ syntax files |mysyntaxfile|
6896 tutor/ files for vimtutor |tutor|
6897
6898 And any other file searched for with the |:runtime| command.
6899
Christian Brabandtc3e6e392024-05-04 09:48:15 +02006900 For $XDG_CONFIG_HOME see |xdg-base-dir|.
6901
Bram Moolenaar071d4272004-06-13 20:20:40 +00006902 The defaults for most systems are setup to search five locations:
6903 1. In your home directory, for your personal preferences.
6904 2. In a system-wide Vim directory, for preferences from the system
6905 administrator.
6906 3. In $VIMRUNTIME, for files distributed with Vim.
6907 *after-directory*
6908 4. In the "after" directory in the system-wide Vim directory. This is
6909 for the system administrator to overrule or add to the distributed
6910 defaults (rarely needed)
6911 5. In the "after" directory in your home directory. This is for
6912 personal preferences to overrule or add to the distributed defaults
6913 or system-wide settings (rarely needed).
6914
Bram Moolenaard0796902016-09-16 20:02:31 +02006915 More entries are added when using |packages|. If it gets very long
6916 then `:set rtp` will be truncated, use `:echo &rtp` to see the full
6917 string.
Bram Moolenaar26852122016-05-24 20:02:38 +02006918
Bram Moolenaar071d4272004-06-13 20:20:40 +00006919 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
6920 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006921 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00006922 wildcards.
6923 See |:runtime|.
6924 Example: >
6925 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
6926< This will use the directory "~/vimruntime" first (containing your
6927 personal Vim runtime files), then "/mygroup/vim" (shared between a
6928 group of people) and finally "$VIMRUNTIME" (the distributed runtime
6929 files).
6930 You probably should always include $VIMRUNTIME somewhere, to use the
6931 distributed runtime files. You can put a directory before $VIMRUNTIME
6932 to find files which replace a distributed runtime files. You can put
6933 a directory after $VIMRUNTIME to find files which add to distributed
6934 runtime files.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006935 When Vim is started with |--clean| the home directory entries are not
6936 included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006937 This option cannot be set from a |modeline| or in the |sandbox|, for
6938 security reasons.
6939
6940 *'scroll'* *'scr'*
6941'scroll' 'scr' number (default: half the window height)
Christian Brabandt596ad662023-08-16 00:11:09 +02006942 local to window |local-noglobal|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006943 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
6944 set to half the number of lines in the window when the window size
Bram Moolenaar74667062020-12-28 15:41:41 +01006945 changes. This may happen when enabling the |status-line| or
6946 'tabline' option after setting the 'scroll' option.
6947 If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006948 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar25c9c682019-05-05 18:13:34 +02006949 height with ":set scroll=0".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006950
6951 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
6952'scrollbind' 'scb' boolean (default off)
6953 local to window
zeertzjq5277cfa2023-09-28 01:00:12 +08006954 See also |scroll-binding|. When this option is set, scrolling the
6955 current window also scrolls other scrollbind windows (windows that
6956 also have this option set). This option is useful for viewing the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006957 differences between two versions of a file, see 'diff'.
6958 See |'scrollopt'| for options that determine how this option should be
6959 interpreted.
6960 This option is mostly reset when splitting a window to edit another
6961 file. This means that ":split | edit file" results in two windows
6962 with scroll-binding, but ":split file" does not.
6963
Bram Moolenaarae20f342019-11-05 21:09:23 +01006964 *'scrollfocus'* *'scf'* *'noscrollfocus'* *'noscf'*
6965'scrollfocus' 'scf' boolean (default off)
6966 global
6967 {only for MS-Windows GUI}
6968 When using the scroll wheel and this option is set, the window under
6969 the mouse pointer is scrolled. With this option off the current
6970 window is scrolled.
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01006971 Systems other than MS-Windows always behave like this option is on.
Bram Moolenaarae20f342019-11-05 21:09:23 +01006972
Bram Moolenaar071d4272004-06-13 20:20:40 +00006973 *'scrolljump'* *'sj'*
6974'scrolljump' 'sj' number (default 1)
6975 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006976 Minimal number of lines to scroll when the cursor gets off the
6977 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
6978 CTRL-D). Useful if your terminal scrolls very slowly.
Bram Moolenaar1e015462005-09-25 22:16:38 +00006979 When set to a negative number from -1 to -100 this is used as the
6980 percentage of the window height. Thus -50 scrolls half the window
6981 height.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006982 NOTE: This option is set to 1 when 'compatible' is set.
6983
6984 *'scrolloff'* *'so'*
Bram Moolenaar50ba5262016-09-22 22:33:02 +02006985'scrolloff' 'so' number (default 0, set to 5 in |defaults.vim|)
Bram Moolenaar375e3392019-01-31 18:26:10 +01006986 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006987 Minimal number of screen lines to keep above and below the cursor.
6988 This will make some context visible around where you are working. If
6989 you set it to a very large value (999) the cursor line will always be
6990 in the middle of the window (except at the start or end of the file or
6991 when long lines wrap).
Bram Moolenaar375e3392019-01-31 18:26:10 +01006992 After using the local value, go back the global value with one of
6993 these two: >
6994 setlocal scrolloff<
6995 setlocal scrolloff=-1
6996< For scrolling horizontally see 'sidescrolloff'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006997 NOTE: This option is set to 0 when 'compatible' is set.
6998
6999 *'scrollopt'* *'sbo'*
7000'scrollopt' 'sbo' string (default "ver,jump")
7001 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007002 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007003 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
7004 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007005 The following words are available:
7006 ver Bind vertical scrolling for 'scrollbind' windows
7007 hor Bind horizontal scrolling for 'scrollbind' windows
7008 jump Applies to the offset between two windows for vertical
7009 scrolling. This offset is the difference in the first
7010 displayed line of the bound windows. When moving
7011 around in a window, another 'scrollbind' window may
7012 reach a position before the start or after the end of
7013 the buffer. The offset is not changed though, when
7014 moving back the 'scrollbind' window will try to scroll
7015 to the desired position when possible.
7016 When now making that window the current one, two
7017 things can be done with the relative offset:
7018 1. When "jump" is not included, the relative offset is
7019 adjusted for the scroll position in the new current
7020 window. When going back to the other window, the
Bram Moolenaar02467872007-05-06 13:22:01 +00007021 new relative offset will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007022 2. When "jump" is included, the other windows are
7023 scrolled to keep the same relative offset. When
7024 going back to the other window, it still uses the
7025 same relative offset.
7026 Also see |scroll-binding|.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00007027 When 'diff' mode is active there always is vertical scroll binding,
7028 even when "ver" isn't there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007029
7030 *'sections'* *'sect'*
7031'sections' 'sect' string (default "SHNHH HUnhsh")
7032 global
7033 Specifies the nroff macros that separate sections. These are pairs of
7034 two letters (See |object-motions|). The default makes a section start
7035 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
7036
7037 *'secure'* *'nosecure'* *E523*
7038'secure' boolean (default off)
7039 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007040 When on, ":autocmd", shell and write commands are not allowed in
7041 ".vimrc" and ".exrc" in the current directory and map commands are
7042 displayed. Switch it off only if you know that you will not run into
7043 problems, or when the 'exrc' option is off. On Unix this option is
7044 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007045 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00007046 'secure' at the end of your ~/.vimrc then.
7047 This option cannot be set from a |modeline| or in the |sandbox|, for
7048 security reasons.
7049
7050 *'selection'* *'sel'*
7051'selection' 'sel' string (default "inclusive")
7052 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007053 This option defines the behavior of the selection. It is only used
7054 in Visual and Select mode.
7055 Possible values:
7056 value past line inclusive ~
7057 old no yes
7058 inclusive yes yes
7059 exclusive yes no
7060 "past line" means that the cursor is allowed to be positioned one
7061 character past the line.
7062 "inclusive" means that the last character of the selection is included
7063 in an operation. For example, when "x" is used to delete the
7064 selection.
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02007065 When "old" is used and 'virtualedit' allows the cursor to move past
7066 the end of line the line break still isn't included.
Christian Brabandted892062024-12-14 20:23:39 +01007067 When "exclusive" is used, cursor position in visual mode will be
7068 adjusted for inclusive motions |inclusive-motion-selection-exclusive|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007069 Note that when "exclusive" is used and selecting from the end
7070 backwards, you cannot include the last character of a line, when
7071 starting in Normal mode and 'virtualedit' empty.
7072
7073 The 'selection' option is set by the |:behave| command.
7074
7075 *'selectmode'* *'slm'*
7076'selectmode' 'slm' string (default "")
7077 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007078 This is a comma-separated list of words, which specifies when to start
Bram Moolenaar071d4272004-06-13 20:20:40 +00007079 Select mode instead of Visual mode, when a selection is started.
7080 Possible values:
7081 mouse when using the mouse
7082 key when using shifted special keys
7083 cmd when using "v", "V" or CTRL-V
7084 See |Select-mode|.
7085 The 'selectmode' option is set by the |:behave| command.
7086
7087 *'sessionoptions'* *'ssop'*
7088'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
Bram Moolenaarb5b75622018-03-09 22:22:21 +01007089 help,options,tabpages,winsize,terminal")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007090 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02007091 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007092 feature}
7093 Changes the effect of the |:mksession| command. It is a comma
7094 separated list of words. Each word enables saving and restoring
7095 something:
7096 word save and restore ~
7097 blank empty windows
7098 buffers hidden and unloaded buffers, not just those in windows
7099 curdir the current directory
7100 folds manually created folds, opened/closed folds and local
7101 fold options
7102 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00007103 and contain at least one lowercase letter. Only
7104 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007105 help the help window
7106 localoptions options and mappings local to a window or buffer (not
7107 global values for local options)
7108 options all options and mappings (also global values for local
7109 options)
Bram Moolenaard23b7142021-04-17 21:04:34 +02007110 skiprtp exclude 'runtimepath' and 'packpath' from the options
Bram Moolenaar071d4272004-06-13 20:20:40 +00007111 resize size of the Vim window: 'lines' and 'columns'
7112 sesdir the directory in which the session file is located
7113 will become the current directory (useful with
7114 projects accessed over a network from different
7115 systems)
7116 slash backslashes in file names replaced with forward
7117 slashes
Bram Moolenaar18144c82006-04-12 21:52:12 +00007118 tabpages all tab pages; without this only the current tab page
7119 is restored, so that you can make a session for each
7120 tab page separately
Bram Moolenaard473c8c2018-08-11 18:00:22 +02007121 terminal include terminal windows where the command can be
7122 restored
Bram Moolenaar071d4272004-06-13 20:20:40 +00007123 unix with Unix end-of-line format (single <NL>), even when
7124 on Windows or DOS
7125 winpos position of the whole Vim window
7126 winsize window sizes
7127
7128 Don't include both "curdir" and "sesdir".
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007129 When neither "curdir" nor "sesdir" is included, file names are stored
7130 with absolute paths.
Bram Moolenaar2f0936c2022-01-08 21:51:59 +00007131 If you leave out "options" many things won't work well after restoring
7132 the session.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007133 "slash" and "unix" are useful on Windows when sharing session files
7134 with Unix. The Unix version of Vim cannot source dos format scripts,
7135 but the Windows version of Vim can source unix format scripts.
7136
7137 *'shell'* *'sh'* *E91*
Bram Moolenaar95a9dd12019-12-19 22:12:03 +01007138'shell' 'sh' string (default $SHELL or "sh", Win32: "cmd.exe")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007139 global
7140 Name of the shell to use for ! and :! commands. When changing the
7141 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
7142 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007143 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007144 See |option-backslash| about including spaces and backslashes.
7145 Environment variables are expanded |:set_env|.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01007146
Bram Moolenaara2baa732022-02-04 16:09:54 +00007147 In |restricted-mode| shell commands will not be possible. This mode
7148 is used if the value of $SHELL ends in "false" or "nologin".
7149
Bram Moolenaar1ff14ba2019-11-02 14:09:23 +01007150 If the name of the shell contains a space, you need to enclose it in
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01007151 quotes and escape the space. Example with quotes: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007152 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
7153< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007154 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00007155 "-f" is not inside the quotes, because it is not part of the command
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01007156 name. Vim automagically recognizes the backslashes that are path
Bram Moolenaar071d4272004-06-13 20:20:40 +00007157 separators.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01007158 Example with escaped space (Vim will do this when initializing the
7159 option from $SHELL): >
7160 :set shell=/bin/with\\\ space/sh
Bram Moolenaard473c8c2018-08-11 18:00:22 +02007161< The resulting value of 'shell' is "/bin/with\ space/sh", two
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01007162 backslashes are consumed by `:set`.
7163
Bram Moolenaar071d4272004-06-13 20:20:40 +00007164 Under MS-Windows, when the executable ends in ".com" it must be
7165 included. Thus setting the shell to "command.com" or "4dos.com"
7166 works, but "command" and "4dos" do not work for all commands (e.g.,
7167 filtering).
7168 For unknown reasons, when using "4dos.com" the current directory is
7169 changed to "C:\". To avoid this set 'shell' like this: >
7170 :set shell=command.com\ /c\ 4dos
7171< This option cannot be set from a |modeline| or in the |sandbox|, for
7172 security reasons.
7173
7174 *'shellcmdflag'* *'shcf'*
Bram Moolenaar5dc62522012-02-13 00:05:22 +01007175'shellcmdflag' 'shcf' string (default: "-c";
Mike Williams12795022021-06-28 20:53:58 +02007176 Win32, when 'shell' contains "powershell":
7177 "-Command", or when it does not contain "sh"
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01007178 somewhere: "/c")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007179 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007180 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
Mike Williams12795022021-06-28 20:53:58 +02007181 "bash.exe -c ls", "powershell.exe -Command dir", or "cmd.exe /c dir".
7182 For MS-Windows, the default is set according to the value of 'shell',
7183 to reduce the need to set this option by the user.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02007184 On Unix it can have more than one flag. Each white space separated
7185 part is passed as an argument to the shell command.
7186 See |option-backslash| about including spaces and backslashes.
Mike Williams12795022021-06-28 20:53:58 +02007187 Also see |dos-shell| and |dos-powershell| for MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007188 This option cannot be set from a |modeline| or in the |sandbox|, for
7189 security reasons.
7190
7191 *'shellpipe'* *'sp'*
Mike Williams12795022021-06-28 20:53:58 +02007192'shellpipe' 'sp' string (default ">", ">%s 2>&1", "| tee", "|& tee"
7193 "2>&1| tee", or
7194 "2>&1 | Out-File -Encoding default")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007195 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007196 {not available when compiled without the |+quickfix|
7197 feature}
7198 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007199 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00007200 including spaces and backslashes.
7201 The name of the temporary file can be represented by "%s" if necessary
7202 (the file name is appended automatically if no %s appears in the value
7203 of this option).
Mike Williams12795022021-06-28 20:53:58 +02007204 For the Amiga the default is ">". For MS-Windows using powershell the
7205 default is "2>&1 | Out-File -Encoding default", otherwise the default
7206 is ">%s 2>&1". The output is directly saved in a file and not echoed
7207 to the screen.
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02007208 For Unix the default is "| tee". The stdout of the compiler is saved
Bram Moolenaar071d4272004-06-13 20:20:40 +00007209 in a file and echoed to the screen. If the 'shell' option is "csh" or
7210 "tcsh" after initializations, the default becomes "|& tee". If the
Bram Moolenaar96f45c02019-10-26 19:53:45 +02007211 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh", "zsh-beta",
Natanael Copa56318362021-05-06 18:46:35 +02007212 "bash", "fish", "ash" or "dash" the default becomes "2>&1| tee". This
7213 means that stderr is also included. Before using the 'shell' option a
7214 path is removed, thus "/bin/sh" uses "sh".
Mike Williamsa3d1b292021-06-30 20:56:00 +02007215 For Unix and MS-Windows, when the 'shell' option is "pwsh" the default
7216 becomes ">%s 2>&1" and the output is not echoed to the screen.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007217 The initialization of this option is done after reading the ".vimrc"
7218 and the other initializations, so that when the 'shell' option is set
7219 there, the 'shellpipe' option changes automatically, unless it was
7220 explicitly set before.
7221 When 'shellpipe' is set to an empty string, no redirection of the
7222 ":make" output will be done. This is useful if you use a 'makeprg'
7223 that writes to 'makeef' by itself. If you want no piping, but do
7224 want to include the 'makeef', set 'shellpipe' to a single space.
7225 Don't forget to precede the space with a backslash: ":set sp=\ ".
7226 In the future pipes may be used for filtering and this option will
7227 become obsolete (at least for Unix).
7228 This option cannot be set from a |modeline| or in the |sandbox|, for
7229 security reasons.
7230
7231 *'shellquote'* *'shq'*
Mike Williamsa3d1b292021-06-30 20:56:00 +02007232'shellquote' 'shq' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007233 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007234 Quoting character(s), put around the command passed to the shell, for
7235 the "!" and ":!" commands. The redirection is kept outside of the
7236 quoting. See 'shellxquote' to include the redirection. It's
7237 probably not useful to set both options.
7238 This is an empty string by default. Only known to be useful for
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01007239 third-party shells on MS-Windows-like systems, such as the MKS Korn
Mike Williamsa3d1b292021-06-30 20:56:00 +02007240 Shell or bash, where it should be "\"". See |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007241 This option cannot be set from a |modeline| or in the |sandbox|, for
7242 security reasons.
7243
7244 *'shellredir'* *'srr'*
Mike Williams12795022021-06-28 20:53:58 +02007245'shellredir' 'srr' string (default ">", ">&", ">%s 2>&1", or
7246 "2>&1 | Out-File -Encoding default")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007247 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007248 String to be used to put the output of a filter command in a temporary
7249 file. See also |:!|. See |option-backslash| about including spaces
7250 and backslashes.
7251 The name of the temporary file can be represented by "%s" if necessary
7252 (the file name is appended automatically if no %s appears in the value
7253 of this option).
Bram Moolenaar96f45c02019-10-26 19:53:45 +02007254 The default is ">". For Unix, if the 'shell' option is "csh" or
7255 "tcsh" during initializations, the default becomes ">&". If the
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007256 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh", "zsh-beta",
Mike Williamsa3d1b292021-06-30 20:56:00 +02007257 "bash", "fish", or "pwsh", the default becomes ">%s 2>&1". This means
7258 that stderr is also included. For Win32, the Unix checks are done and
Mike Williams12795022021-06-28 20:53:58 +02007259 additionally "cmd" is checked for, which makes the default ">%s 2>&1",
7260 and "powershell" is checked for which makes the default
Mike Williamsa3d1b292021-06-30 20:56:00 +02007261 "2>&1 | Out-File -Encoding default" (see |dos-powershell|). Also, the
7262 same names with ".exe" appended are checked for.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007263 The initialization of this option is done after reading the ".vimrc"
7264 and the other initializations, so that when the 'shell' option is set
7265 there, the 'shellredir' option changes automatically unless it was
7266 explicitly set before.
7267 In the future pipes may be used for filtering and this option will
7268 become obsolete (at least for Unix).
7269 This option cannot be set from a |modeline| or in the |sandbox|, for
7270 security reasons.
7271
7272 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
7273'shellslash' 'ssl' boolean (default off)
7274 global
Bram Moolenaar6f345a12019-12-17 21:27:18 +01007275 {only for MS-Windows}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007276 When set, a forward slash is used when expanding file names. This is
Mike Williamsa3d1b292021-06-30 20:56:00 +02007277 useful when a Unix-like shell is used instead of cmd.exe, pwsh.exe, or
Mike Williams12795022021-06-28 20:53:58 +02007278 powershell.exe. Backward slashes can still be typed, but they are
7279 changed to forward slashes by Vim.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007280 Note that setting or resetting this option has no effect for some
7281 existing file names, thus this option needs to be set before opening
7282 any file for best results. This might change in the future.
7283 'shellslash' only works when a backslash can be used as a path
7284 separator. To test if this is so use: >
7285 if exists('+shellslash')
Bram Moolenaarac3150d2019-07-28 16:36:39 +02007286< Also see 'completeslash'.
7287
Bram Moolenaar26a60b42005-02-22 08:49:11 +00007288 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
7289'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
7290 global
Bram Moolenaar26a60b42005-02-22 08:49:11 +00007291 When on, use temp files for shell commands. When off use a pipe.
7292 When using a pipe is not possible temp files are used anyway.
Bram Moolenaar97293012011-07-18 19:40:27 +02007293 Currently a pipe is only supported on Unix and MS-Windows 2K and
7294 later. You can check it with: >
Bram Moolenaar26a60b42005-02-22 08:49:11 +00007295 :if has("filterpipe")
7296< The advantage of using a pipe is that nobody can read the temp file
7297 and the 'shell' command does not need to support redirection.
7298 The advantage of using a temp file is that the file type and encoding
7299 can be detected.
7300 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
7301 |FilterWritePost| autocommands event are not triggered when
7302 'shelltemp' is off.
Bram Moolenaar269f5952016-07-15 22:54:41 +02007303 The `system()` function does not respect this option and always uses
7304 temp files.
Bram Moolenaar036986f2017-03-16 17:41:02 +01007305 NOTE: This option is set to the Vim default value when 'compatible'
7306 is reset.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00007307
Bram Moolenaar071d4272004-06-13 20:20:40 +00007308 *'shelltype'* *'st'*
7309'shelltype' 'st' number (default 0)
7310 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02007311 {only for the Amiga}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007312 On the Amiga this option influences the way how the commands work
7313 which use a shell.
7314 0 and 1: always use the shell
7315 2 and 3: use the shell only to filter lines
7316 4 and 5: use shell only for ':sh' command
7317 When not using the shell, the command is executed directly.
7318
7319 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
7320 1 and 3: use "shell cmd" to start external commands
7321
Bram Moolenaardb7207e2012-02-22 17:30:19 +01007322 *'shellxescape'* *'sxe'*
7323'shellxescape' 'sxe' string (default: "";
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01007324 for MS-Windows: "\"&|<>()@^")
Bram Moolenaardb7207e2012-02-22 17:30:19 +01007325 global
Bram Moolenaardb7207e2012-02-22 17:30:19 +01007326 When 'shellxquote' is set to "(" then the characters listed in this
7327 option will be escaped with a '^' character. This makes it possible
7328 to execute most external commands with cmd.exe.
dkearns8ebdbc92023-10-29 06:26:19 +11007329 This option cannot be set from a |modeline| or in the |sandbox|, for
7330 security reasons.
Bram Moolenaardb7207e2012-02-22 17:30:19 +01007331
Bram Moolenaar071d4272004-06-13 20:20:40 +00007332 *'shellxquote'* *'sxq'*
7333'shellxquote' 'sxq' string (default: "";
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01007334 for Win32, when 'shell' is cmd.exe: "("
Mike Williams12795022021-06-28 20:53:58 +02007335 for Win32, when 'shell' is
7336 powershell.exe: "\""
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01007337 for Win32, when 'shell' contains "sh"
7338 somewhere: "\""
Bram Moolenaar071d4272004-06-13 20:20:40 +00007339 for Unix, when using system(): "\"")
7340 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007341 Quoting character(s), put around the command passed to the shell, for
7342 the "!" and ":!" commands. Includes the redirection. See
7343 'shellquote' to exclude the redirection. It's probably not useful
7344 to set both options.
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01007345 When the value is '(' then ')' is appended. When the value is '"('
7346 then ')"' is appended.
7347 When the value is '(' then also see 'shellxescape'.
Bram Moolenaara64ba222012-02-12 23:23:31 +01007348 This is an empty string by default on most systems, but is known to be
Mike Williamsa3d1b292021-06-30 20:56:00 +02007349 useful for on Win32 version, either for cmd.exe, powershell.exe, or
7350 pwsh.exe which automatically strips off the first and last quote on a
7351 command, or 3rd-party shells such as the MKS Korn Shell or bash, where
7352 it should be "\"". The default is adjusted according the value of
Mike Williams12795022021-06-28 20:53:58 +02007353 'shell', to reduce the need to set this option by the user. See
7354 |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007355 This option cannot be set from a |modeline| or in the |sandbox|, for
7356 security reasons.
7357
7358 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
7359'shiftround' 'sr' boolean (default off)
7360 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007361 Round indent to multiple of 'shiftwidth'. Applies to > and <
7362 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
7363 a multiple of 'shiftwidth' (this is Vi compatible).
7364 NOTE: This option is reset when 'compatible' is set.
7365
7366 *'shiftwidth'* *'sw'*
7367'shiftwidth' 'sw' number (default 8)
7368 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007369 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00007370 |'cindent'|, |>>|, |<<|, etc.
Bram Moolenaar10e8ff92023-06-10 21:40:39 +01007371 When zero the 'tabstop' value will be used. Use the |shiftwidth()|
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02007372 function to get the effective shiftwidth value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007373
7374 *'shortmess'* *'shm'*
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02007375'shortmess' 'shm' string (Vim default "filnxtToOS", Vi default: "S",
7376 POSIX default: "AS")
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007377 global *E1336*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007378 This option helps to avoid all the |hit-enter| prompts caused by file
Dominique Pellédf62c622024-07-15 20:29:59 +02007379 messages, for example with CTRL-G, and to avoid some other messages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007380 It is a list of flags:
7381 flag meaning when present ~
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007382 f use "(3 of 5)" instead of "(file 3 of 5)" *shm-f*
7383 i use "[noeol]" instead of "[Incomplete last line]" *shm-i*
7384 l use "999L, 888B" instead of "999 lines, 888 bytes" *shm-l*
7385 m use "[+]" instead of "[Modified]" *shm-m*
7386 n use "[New]" instead of "[New File]" *shm-n*
7387 r use "[RO]" instead of "[readonly]" *shm-r*
7388 w use "[w]" instead of "written" for file write message *shm-w*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007389 and "[a]" instead of "appended" for ':w >> file' command
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007390 x use "[dos]" instead of "[dos format]", "[unix]" *shm-x*
7391 instead of "[unix format]" and "[mac]" instead of "[mac
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007392 format]"
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007393 a all of the above abbreviations *shm-a*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007394
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007395 o overwrite message for writing a file with subsequent *shm-o*
7396 message for reading a file (useful for ":wn" or when
7397 'autowrite' on)
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007398 O message for reading a file overwrites any previous *shm-O*
7399 message; also for quickfix message (e.g., ":cn")
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007400 s don't give "search hit BOTTOM, continuing at TOP" or *shm-s*
7401 "search hit TOP, continuing at BOTTOM" messages; when using
Christian Brabandte2995912024-06-01 20:40:25 +02007402 the search count do not show "W" before the count message
7403 (see |shm-S| below)
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007404 t truncate file message at the start if it is too long *shm-t*
7405 to fit on the command-line, "<" will appear in the left most
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007406 column; ignored in Ex mode
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007407 T truncate other messages in the middle if they are too *shm-T*
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007408 long to fit on the command line; "..." will appear in the
7409 middle; ignored in Ex mode
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007410 W don't give "written" or "[w]" when writing a file *shm-W*
7411 A don't give the "ATTENTION" message when an existing *shm-A*
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007412 swap file is found
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007413 I don't give the intro message when starting Vim, *shm-I*
Bram Moolenaar938ae282023-02-20 20:44:55 +00007414 see |:intro|
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007415 c don't give |ins-completion-menu| messages; for *shm-c*
Bram Moolenaar7db29e42022-12-11 15:53:04 +00007416 example, "-- XXX completion (YYY)", "match 1 of 2", "The only
7417 match", "Pattern not found", "Back at original", etc.
7418 C don't give messages while scanning for ins-completion *shm-C*
7419 items, for instance "scanning tags"
7420 q use "recording" instead of "recording @a" *shm-q*
7421 F don't give the file info when editing a file, like *shm-F*
7422 `:silent` was used for the command; note that this also
Shougo Matsushita9db39b02024-03-06 20:58:41 +01007423 affects messages from autocommands and 'autoread' reloading
Bram Moolenaar938ae282023-02-20 20:44:55 +00007424 S do not show search count message when searching, e.g. *shm-S*
Christian Brabandte2995912024-06-01 20:40:25 +02007425 "[1/5]". When the "S" flag is not present (e.g. search count
7426 is shown), the "search hit BOTTOM, continuing at TOP" and
7427 "search hit TOP, continuing at BOTTOM" messages are only
7428 indicated by a "W" (Mnemonic: Wrapped) letter before the
7429 search count statistics.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007430
7431 This gives you the opportunity to avoid that a change between buffers
7432 requires you to hit <Enter>, but still gives as useful a message as
7433 possible for the space available. To get the whole message that you
7434 would have got with 'shm' empty, use ":file!"
7435 Useful values:
7436 shm= No abbreviation of message.
7437 shm=a Abbreviation, but no loss of information.
7438 shm=at Abbreviation, and truncate message when necessary.
7439
7440 NOTE: This option is set to the Vi default value when 'compatible' is
7441 set and to the Vim default value when 'compatible' is reset.
7442
7443 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
7444'shortname' 'sn' boolean (default off)
7445 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007446 Filenames are assumed to be 8 characters plus one extension of 3
7447 characters. Multiple dots in file names are not allowed. When this
7448 option is on, dots in file names are replaced with underscores when
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01007449 adding an extension (".~" or ".swp"). This option is useful
Bram Moolenaar071d4272004-06-13 20:20:40 +00007450 when editing files on an MS-DOS compatible filesystem, e.g., messydos
Bram Moolenaarade0d392020-01-21 22:33:58 +01007451 or crossdos.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007452
7453 *'showbreak'* *'sbr'* *E595*
7454'showbreak' 'sbr' string (default "")
Bram Moolenaaree857022019-11-09 23:26:40 +01007455 global or local to window |global-local|
Bram Moolenaardb84e452010-08-15 13:50:43 +02007456 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007457 feature}
7458 String to put at the start of lines that have been wrapped. Useful
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007459 values are "> " or "+++ ": >
7460 :set showbreak=>\
7461< Note the backslash to escape the trailing space. It's easier like
7462 this: >
Bram Moolenaar1a384422010-07-14 19:53:30 +02007463 :let &showbreak = '+++ '
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007464< Only printable single-cell characters are allowed, excluding <Tab> and
Bram Moolenaar071d4272004-06-13 20:20:40 +00007465 comma (in a future version the comma might be used to separate the
7466 part that is shown at the end and at the start of a line).
7467 The characters are highlighted according to the '@' flag in
7468 'highlight'.
7469 Note that tabs after the showbreak will be displayed differently.
7470 If you want the 'showbreak' to appear in between line numbers, add the
7471 "n" flag to 'cpoptions'.
Bram Moolenaaree857022019-11-09 23:26:40 +01007472 A window-local value overrules a global value. If the global value is
7473 set and you want no value in the current window use NONE: >
7474 :setlocal showbreak=NONE
7475<
Bram Moolenaar071d4272004-06-13 20:20:40 +00007476 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02007477'showcmd' 'sc' boolean (Vim default: on, off for Unix,
7478 Vi default: off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007479 global
Bram Moolenaar02467872007-05-06 13:22:01 +00007480 Show (partial) command in the last line of the screen. Set this
7481 option off if your terminal is slow.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007482 In Visual mode the size of the selected area is shown:
7483 - When selecting characters within a line, the number of characters.
Bram Moolenaarf91787c2010-07-17 12:47:16 +02007484 If the number of bytes is different it is also displayed: "2-6"
7485 means two characters and six bytes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007486 - When selecting more than one line, the number of lines.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007487 - When selecting a block, the size in screen characters:
7488 {lines}x{columns}.
Luuk van Baalba936f62022-12-15 13:15:39 +00007489 This information can be displayed in an alternative location using the
7490 'showcmdloc' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007491 NOTE: This option is set to the Vi default value when 'compatible' is
7492 set and to the Vim default value when 'compatible' is reset.
7493
Luuk van Baalba936f62022-12-15 13:15:39 +00007494 *'showcmdloc'* *'sloc'*
7495'showcmdloc' 'sloc' string (default "last")
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007496 global
Luuk van Baalba936f62022-12-15 13:15:39 +00007497 This option can be used to display the (partially) entered command in
7498 another location. Possible values are:
7499 last Last line of the screen (default).
7500 statusline Status line of the current window.
Bram Moolenaarf1dcd142022-12-31 15:30:45 +00007501 tabline First line of the screen if 'showtabline' is enabled.
Luuk van Baalba936f62022-12-15 13:15:39 +00007502 Setting this option to "statusline" or "tabline" means that these will
7503 be redrawn whenever the command changes, which can be on every key
7504 pressed.
7505 The %S 'statusline' item can be used in 'statusline' or 'tabline' to
7506 place the text. Without a custom 'statusline' or 'tabline' it will be
7507 displayed in a convenient location.
7508
Bram Moolenaar071d4272004-06-13 20:20:40 +00007509 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
7510'showfulltag' 'sft' boolean (default off)
7511 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007512 When completing a word in insert mode (see |ins-completion|) from the
7513 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007514 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00007515 matched a C function, you can see a template for what arguments are
7516 required (coding style permitting).
Bram Moolenaar446cb832008-06-24 21:56:24 +00007517 Note that this doesn't work well together with having "longest" in
7518 'completeopt', because the completion from the search pattern may not
7519 match the typed text.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007520
7521 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
7522'showmatch' 'sm' boolean (default off)
7523 global
7524 When a bracket is inserted, briefly jump to the matching one. The
7525 jump is only done if the match can be seen on the screen. The time to
7526 show the match can be set with 'matchtime'.
7527 A Beep is given if there is no match (no matter if the match can be
Bram Moolenaarca635012015-09-25 20:34:21 +02007528 seen or not).
7529 This option is reset when 'paste' is set and restored when 'paste' is
7530 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007531 When the 'm' flag is not included in 'cpoptions', typing a character
7532 will immediately move the cursor back to where it belongs.
7533 See the "sm" field in 'guicursor' for setting the cursor shape and
7534 blinking when showing the match.
7535 The 'matchpairs' option can be used to specify the characters to show
7536 matches for. 'rightleft' and 'revins' are used to look for opposite
7537 matches.
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007538 Also see the matchparen plugin for highlighting the match when moving
7539 around |pi_paren.txt|.
7540 Note: Use of the short form is rated PG.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007541
7542 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
7543'showmode' 'smd' boolean (Vim default: on, Vi default: off)
7544 global
7545 If in Insert, Replace or Visual mode put a message on the last line.
7546 Use the 'M' flag in 'highlight' to set the type of highlighting for
7547 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007548 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00007549 doesn't mean XIM is really active, especially when 'imactivatekey' is
7550 not set.
7551 NOTE: This option is set to the Vi default value when 'compatible' is
7552 set and to the Vim default value when 'compatible' is reset.
7553
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007554 *'showtabline'* *'stal'*
7555'showtabline' 'stal' number (default 1)
7556 global
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007557 The value of this option specifies when the line with tab page labels
7558 will be displayed:
7559 0: never
7560 1: only if there are at least two tab pages
7561 2: always
7562 This is both for the GUI and non-GUI implementation of the tab pages
7563 line.
7564 See |tab-page| for more information about tab pages.
7565
Bram Moolenaar071d4272004-06-13 20:20:40 +00007566 *'sidescroll'* *'ss'*
7567'sidescroll' 'ss' number (default 0)
7568 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007569 The minimal number of columns to scroll horizontally. Used only when
7570 the 'wrap' option is off and the cursor is moved off of the screen.
7571 When it is zero the cursor will be put in the middle of the screen.
7572 When using a slow terminal set it to a large number or 0. When using
7573 a fast terminal use a small number or 1. Not used for "zh" and "zl"
7574 commands.
7575
7576 *'sidescrolloff'* *'siso'*
7577'sidescrolloff' 'siso' number (default 0)
Bram Moolenaar375e3392019-01-31 18:26:10 +01007578 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007579 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00007580 right of the cursor if 'nowrap' is set. Setting this option to a
7581 value greater than 0 while having |'sidescroll'| also at a non-zero
7582 value makes some context visible in the line you are scrolling in
7583 horizontally (except at beginning of the line). Setting this option
7584 to a large value (like 999) has the effect of keeping the cursor
7585 horizontally centered in the window, as long as one does not come too
7586 close to the beginning of the line.
Bram Moolenaar375e3392019-01-31 18:26:10 +01007587 After using the local value, go back the global value with one of
7588 these two: >
7589 setlocal sidescrolloff<
7590 setlocal sidescrolloff=-1
7591< NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007592
7593 Example: Try this together with 'sidescroll' and 'listchars' as
7594 in the following example to never allow the cursor to move
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007595 onto the "extends" character: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007596
7597 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
7598 :set sidescrolloff=1
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007599<
7600 *'signcolumn'* *'scl'*
7601'signcolumn' 'scl' string (default "auto")
7602 local to window
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007603 {not available when compiled without the |+signs|
7604 feature}
Bram Moolenaar09521312016-08-12 22:54:35 +02007605 Whether or not to draw the signcolumn. Valid values are:
Bram Moolenaar938ae282023-02-20 20:44:55 +00007606 "auto" only when there is a sign to display
7607 "no" never
7608 "yes" always
Bram Moolenaar394c5d82019-06-17 21:48:05 +02007609 "number" display signs in the 'number' column. If the number
Bram Moolenaar6c1e1572019-06-22 02:13:00 +02007610 column is not present, then behaves like "auto".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007611
Bram Moolenaar071d4272004-06-13 20:20:40 +00007612 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
7613'smartcase' 'scs' boolean (default off)
7614 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007615 Override the 'ignorecase' option if the search pattern contains upper
7616 case characters. Only used when the search pattern is typed and
7617 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarc8734422012-06-01 22:38:45 +02007618 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00007619 "*" and "#" you can make 'smartcase' used by doing a "/" command,
7620 recalling the search pattern from history and hitting <Enter>.
7621 NOTE: This option is reset when 'compatible' is set.
7622
7623 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
7624'smartindent' 'si' boolean (default off)
7625 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007626 Do smart autoindenting when starting a new line. Works for C-like
7627 programs, but can also be used for other languages. 'cindent' does
7628 something like this, works better in most cases, but is more strict,
Bram Moolenaar81af9252010-12-10 20:35:50 +01007629 see |C-indenting|. When 'cindent' is on or 'indentexpr' is set,
Bram Moolenaar166af9b2010-11-16 20:34:40 +01007630 setting 'si' has no effect. 'indentexpr' is a more advanced
7631 alternative.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007632 Normally 'autoindent' should also be on when using 'smartindent'.
7633 An indent is automatically inserted:
7634 - After a line ending in '{'.
7635 - After a line starting with a keyword from 'cinwords'.
7636 - Before a line starting with '}' (only with the "O" command).
7637 When typing '}' as the first character in a new line, that line is
7638 given the same indent as the matching '{'.
7639 When typing '#' as the first character in a new line, the indent for
7640 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007641 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00007642 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
7643 When using the ">>" command, lines starting with '#' are not shifted
7644 right.
Bram Moolenaar036986f2017-03-16 17:41:02 +01007645 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02007646 This option is reset when 'paste' is set and restored when 'paste' is
7647 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007648
7649 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
7650'smarttab' 'sta' boolean (default off)
7651 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007652 When on, a <Tab> in front of a line inserts blanks according to
Bram Moolenaar280f1262006-01-30 00:14:18 +00007653 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A
7654 <BS> will delete a 'shiftwidth' worth of space at the start of the
7655 line.
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00007656 When off, a <Tab> always inserts blanks according to 'tabstop' or
Bram Moolenaar280f1262006-01-30 00:14:18 +00007657 'softtabstop'. 'shiftwidth' is only used for shifting text left or
7658 right |shift-left-right|.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007659 What gets inserted (a <Tab> or spaces) depends on the 'expandtab'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007660 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00007661 number of spaces is minimized by using <Tab>s.
Bram Moolenaarca635012015-09-25 20:34:21 +02007662 This option is reset when 'paste' is set and restored when 'paste' is
7663 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007664 NOTE: This option is reset when 'compatible' is set.
7665
Bram Moolenaarf6196f42022-10-02 21:29:55 +01007666 *'smoothscroll'* *'sms'* *'nosmoothscroll'* *'nosms'*
7667'smoothscroll' 'sms' boolean (default off)
7668 local to window
7669 Scrolling works with screen lines. When 'wrap' is set and the first
7670 line in the window wraps part of it may not be visible, as if it is
Bram Moolenaarf269eab2022-10-03 18:04:35 +01007671 above the window. "<<<" is displayed at the start of the first line,
7672 highlighted with |hl-NonText|.
Bram Moolenaar10e8ff92023-06-10 21:40:39 +01007673 You may also want to add "lastline" to the 'display' option to show as
7674 much of the last line as possible.
zeertzjqad493ef2024-03-29 10:23:19 +01007675 NOTE: partly implemented, doesn't work yet for |gj| and |gk|.
Bram Moolenaarf6196f42022-10-02 21:29:55 +01007676
Bram Moolenaar071d4272004-06-13 20:20:40 +00007677 *'softtabstop'* *'sts'*
7678'softtabstop' 'sts' number (default 0)
7679 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007680 Number of spaces that a <Tab> counts for while performing editing
7681 operations, like inserting a <Tab> or using <BS>. It "feels" like
7682 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
7683 used. This is useful to keep the 'ts' setting at its standard value
7684 of 8, while being able to edit like it is set to 'sts'. However,
7685 commands like "x" still work on the actual characters.
7686 When 'sts' is zero, this feature is off.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02007687 When 'sts' is negative, the value of 'shiftwidth' is used.
Bram Moolenaarca635012015-09-25 20:34:21 +02007688 'softtabstop' is set to 0 when the 'paste' option is set and restored
7689 when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007690 See also |ins-expandtab|. When 'expandtab' is not set, the number of
7691 spaces is minimized by using <Tab>s.
7692 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
7693 set.
7694 NOTE: This option is set to 0 when 'compatible' is set.
7695
Bram Moolenaar04958cb2018-06-23 19:23:02 +02007696 If Vim is compiled with the |+vartabs| feature then the value of
7697 'softtabstop' will be ignored if |'varsofttabstop'| is set to
7698 anything other than an empty string.
7699
Bram Moolenaar217ad922005-03-20 22:37:15 +00007700 *'spell'* *'nospell'*
7701'spell' boolean (default off)
7702 local to window
Bram Moolenaar217ad922005-03-20 22:37:15 +00007703 {not available when compiled without the |+syntax|
7704 feature}
7705 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007706 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007707
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007708 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00007709'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007710 local to buffer
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007711 {not available when compiled without the |+syntax|
7712 feature}
7713 Pattern to locate the end of a sentence. The following word will be
7714 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007715 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007716 When this check is not wanted make this option empty.
7717 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00007718 Be careful with special characters, see |option-backslash| about
7719 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007720 To set this option automatically depending on the language, see
7721 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007722
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007723 *'spellfile'* *'spf'*
7724'spellfile' 'spf' string (default empty)
7725 local to buffer
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007726 {not available when compiled without the |+syntax|
7727 feature}
7728 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00007729 commands. It must end in ".{encoding}.add". You need to include the
7730 path, otherwise the file is placed in the current directory.
Bram Moolenaar48c3f4e2022-08-08 15:42:38 +01007731 The path may include characters from 'isfname', space, comma and '@'.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007732 *E765*
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007733 It may also be a comma-separated list of names. A count before the
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007734 |zg| and |zw| commands can be used to access each. This allows using
7735 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007736 When a word is added while this option is empty Vim will set it for
Bram Moolenaar910f66f2006-04-05 20:41:53 +00007737 you: Using the first directory in 'runtimepath' that is writable. If
7738 there is no "spell" directory yet it will be created. For the file
7739 name the first language name that appears in 'spelllang' is used,
Bram Moolenaar3b506942005-06-23 22:36:45 +00007740 ignoring the region.
7741 The resulting ".spl" file will be used for spell checking, it does not
7742 have to appear in 'spelllang'.
7743 Normally one file is used for all regions, but you can add the region
7744 name if you want to. However, it will then only be used when
7745 'spellfile' is set to it, for entries in 'spelllang' only files
7746 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00007747 This option cannot be set from a |modeline| or in the |sandbox|, for
7748 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007749
Bram Moolenaar217ad922005-03-20 22:37:15 +00007750 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007751'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00007752 local to buffer
Bram Moolenaar217ad922005-03-20 22:37:15 +00007753 {not available when compiled without the |+syntax|
7754 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007755 A comma-separated list of word list names. When the 'spell' option is
Bram Moolenaar3b506942005-06-23 22:36:45 +00007756 on spellchecking will be done for these languages. Example: >
7757 set spelllang=en_us,nl,medical
7758< This means US English, Dutch and medical words are recognized. Words
7759 that are not recognized will be highlighted.
Bram Moolenaar911ead12019-04-21 00:03:35 +02007760 The word list name must consist of alphanumeric characters, a dash or
7761 an underscore. It should not include a comma or dot. Using a dash is
Bram Moolenaar3b506942005-06-23 22:36:45 +00007762 recommended to separate the two letter language name from a
7763 specification. Thus "en-rare" is used for rare English words.
7764 A region name must come last and have the form "_xx", where "xx" is
7765 the two-letter, lower case region name. You can use more than one
7766 region by listing them: "en_us,en_ca" supports both US and Canadian
7767 English, but not words specific for Australia, New Zealand or Great
Bram Moolenaarfa735342016-01-03 22:14:44 +01007768 Britain. (Note: currently en_au and en_nz dictionaries are older than
7769 en_ca, en_gb and en_us).
Bram Moolenaarcc63c642013-11-12 04:44:01 +01007770 If the name "cjk" is included East Asian characters are excluded from
7771 spell checking. This is useful when editing text that also has Asian
7772 words.
Bram Moolenaar6c391a72021-09-09 21:55:11 +02007773 Note that the "medical" dictionary does not exist, it is just an
7774 example of a longer name.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007775 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007776 As a special case the name of a .spl file can be given as-is. The
7777 first "_xx" in the name is removed and used as the region name
7778 (_xx is an underscore, two letters and followed by a non-letter).
7779 This is mainly for testing purposes. You must make sure the correct
7780 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007781 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007782 idea to set 'spelllang' after setting 'encoding' to avoid loading the
7783 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00007784 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007785
Bram Moolenaar98692072006-02-04 00:57:42 +00007786 If the |spellfile.vim| plugin is active and you use a language name
7787 for which Vim cannot find the .spl file in 'runtimepath' the plugin
7788 will ask you if you want to download the file.
7789
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007790 After this option has been set successfully, Vim will source the files
7791 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
Bram Moolenaarb730f0c2018-11-25 03:56:26 +01007792 up to the first character that is not an ASCII letter or number and
7793 not a dash. Also see |set-spc-auto|.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007794
Bram Moolenaar362b44b2020-06-10 21:47:00 +02007795 *'spelloptions'* *'spo'*
7796'spelloptions' 'spo' string (default "")
7797 local to buffer
7798 {not available when compiled without the |+syntax|
7799 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007800 A comma-separated list of options for spell checking:
Bram Moolenaar362b44b2020-06-10 21:47:00 +02007801 camel When a word is CamelCased, assume "Cased" is a
7802 separate word: every upper-case character in a word
7803 that comes after a lower case character indicates the
7804 start of a new word.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007805
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007806 *'spellsuggest'* *'sps'*
7807'spellsuggest' 'sps' string (default "best")
7808 global
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007809 {not available when compiled without the |+syntax|
7810 feature}
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007811 Methods used for spelling suggestions. Both for the |z=| command and
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007812 the |spellsuggest()| function. This is a comma-separated list of
7813 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007814
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007815 best Internal method that works best for English. Finds
7816 changes like "fast" and uses a bit of sound-a-like
7817 scoring to improve the ordering.
7818
7819 double Internal method that uses two methods and mixes the
7820 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007821 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007822 word. That only works when the language specifies
7823 sound folding. Can be slow and doesn't always give
7824 better results.
7825
7826 fast Internal method that only checks for simple changes:
7827 character inserts/deletes/swaps. Works well for
7828 simple typing mistakes.
7829
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007830 {number} The maximum number of suggestions listed for |z=|.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007831 Not used for |spellsuggest()|. The number of
7832 suggestions is never more than the value of 'lines'
7833 minus two.
7834
Bram Moolenaar585ee072022-01-29 11:22:17 +00007835 timeout:{millisec} Limit the time searching for suggestions to
Dominique Pellédf62c622024-07-15 20:29:59 +02007836 {millisec} milliseconds. Applies to the following
Bram Moolenaar585ee072022-01-29 11:22:17 +00007837 methods. When omitted the limit is 5000. When
7838 negative there is no limit. {only works when built
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01007839 with the |+reltime| feature}
Bram Moolenaar585ee072022-01-29 11:22:17 +00007840
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007841 file:{filename} Read file {filename}, which must have two columns,
7842 separated by a slash. The first column contains the
7843 bad word, the second column the suggested good word.
7844 Example:
7845 theribal/terrible ~
7846 Use this for common mistakes that do not appear at the
7847 top of the suggestion list with the internal methods.
7848 Lines without a slash are ignored, use this for
7849 comments.
Bram Moolenaarbcb98982014-05-01 14:08:19 +02007850 The word in the second column must be correct,
7851 otherwise it will not be used. Add the word to an
7852 ".add" file if it is currently flagged as a spelling
7853 mistake.
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007854 The file is used for all languages.
7855
7856 expr:{expr} Evaluate expression {expr}. Use a function to avoid
Bram Moolenaara4e0b972022-10-01 19:43:52 +01007857 trouble with spaces. Best is to call a function
7858 without arguments, see |expr-option-function|.
7859 |v:val| holds the badly spelled word. The expression
7860 must evaluate to a List of Lists, each with a
7861 suggestion and a score.
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007862 Example:
Bram Moolenaar214641f2017-03-05 17:04:09 +01007863 [['the', 33], ['that', 44]] ~
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007864 Set 'verbose' and use |z=| to see the scores that the
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007865 internal methods use. A lower score is better.
7866 This may invoke |spellsuggest()| if you temporarily
7867 set 'spellsuggest' to exclude the "expr:" part.
7868 Errors are silently ignored, unless you set the
7869 'verbose' option to a non-zero value.
7870
7871 Only one of "best", "double" or "fast" may be used. The others may
7872 appear several times in any order. Example: >
7873 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
7874<
7875 This option cannot be set from a |modeline| or in the |sandbox|, for
7876 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007877
Bram Moolenaar071d4272004-06-13 20:20:40 +00007878 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
7879'splitbelow' 'sb' boolean (default off)
7880 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007881 When on, splitting a window will put the new window below the current
7882 one. |:split|
7883
Bram Moolenaar3c053a12022-10-16 13:11:12 +01007884 *'splitkeep'* *'spk'*
Luuk van Baal13ece2a2022-10-03 15:28:08 +01007885'splitkeep' 'spk' string (default "cursor")
7886 global
7887 The value of this option determines the scroll behavior when opening,
7888 closing or resizing horizontal splits.
7889
7890 Possible values are:
7891 cursor Keep the same relative cursor position.
7892 screen Keep the text on the same screen line.
7893 topline Keep the topline the same.
7894
7895 For the "screen" and "topline" values, the cursor position will be
7896 changed when necessary. In this case, the jumplist will be populated
7897 with the previous cursor position. For "screen", the text cannot always
Bram Moolenaar3c053a12022-10-16 13:11:12 +01007898 be kept on the same screen line when 'wrap' is enabled.
Luuk van Baal13ece2a2022-10-03 15:28:08 +01007899
Bram Moolenaar071d4272004-06-13 20:20:40 +00007900 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
7901'splitright' 'spr' boolean (default off)
7902 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007903 When on, splitting a window will put the new window right of the
7904 current one. |:vsplit|
7905
7906 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
7907'startofline' 'sol' boolean (default on)
7908 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007909 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00007910 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaar71badf92023-04-22 22:40:14 +01007911 (if possible). This applies to the commands:
7912 - CTRL-D, CTRL-U, CTRL-B, CTRL-F, "G", "H", "M", "L", "gg"
Christian Brabandtfd4e47e2024-10-06 17:57:53 +02007913 - "d", "<<", "==" and ">>" with a linewise operator
7914 (|operator-resulting-pos|)
Bram Moolenaar71badf92023-04-22 22:40:14 +01007915 - "%" with a count
7916 - buffer changing commands (CTRL-^, :bnext, :bNext, etc.)
7917 - Ex commands that only has a line number, e.g., ":25" or ":+".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007918 In case of buffer changing commands the cursor is placed at the column
7919 where it was the last time the buffer was edited.
7920 NOTE: This option is set when 'compatible' is set.
7921
Bram Moolenaar00654022011-02-25 14:42:19 +01007922 *'statusline'* *'stl'* *E540* *E542*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007923'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007924 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007925 {not available when compiled without the |+statusline|
7926 feature}
Bram Moolenaar944697a2022-02-20 19:48:20 +00007927 When non-empty, this option determines the content of the status line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007928 Also see |status-line|.
7929
7930 The option consists of printf style '%' items interspersed with
7931 normal text. Each status line item is of the form:
7932 %-0{minwid}.{maxwid}{item}
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01007933 All fields except the {item} are optional. A single percent sign can
Bram Moolenaar8133cc62020-10-26 21:05:27 +01007934 be given as "%%".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007935
Yegappan Lakshmananac023e82024-11-27 20:55:45 +01007936 *stl-%!*
Bram Moolenaar238a5642006-02-21 22:12:05 +00007937 When the option starts with "%!" then it is used as an expression,
7938 evaluated and the result is used as the option value. Example: >
7939 :set statusline=%!MyStatusLine()
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02007940< The *g:statusline_winid* variable will be set to the |window-ID| of the
7941 window that the status line belongs to.
7942 The result can contain %{} items that will be evaluated too.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02007943 Note that the "%!" expression is evaluated in the context of the
7944 current window and buffer, while %{} items are evaluated in the
7945 context of the window that the statusline belongs to.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007946
7947 When there is error while evaluating the option then it will be made
7948 empty to avoid further errors. Otherwise screen updating would loop.
Bram Moolenaar1b5f03e2023-01-09 20:12:45 +00007949 When the result contains unprintable characters the result is
7950 unpredictable.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007951
Bram Moolenaar071d4272004-06-13 20:20:40 +00007952 Note that the only effect of 'ruler' when this option is set (and
7953 'laststatus' is 2) is controlling the output of |CTRL-G|.
7954
7955 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00007956 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00007957 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007958 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007959 minwid Minimum width of the item, padding as set by '-' & '0'.
7960 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007961 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007962 on the left for text items. Numeric items will be
7963 shifted down to maxwid-2 digits followed by '>'number
7964 where number is the amount of missing digits, much like
7965 an exponential notation.
7966 item A one letter code as described below.
7967
7968 Following is a description of the possible statusline items. The
7969 second character in "item" is the type:
7970 N for number
7971 S for string
7972 F for flags as described below
7973 - not applicable
7974
7975 item meaning ~
Bram Moolenaar02467872007-05-06 13:22:01 +00007976 f S Path to the file in the buffer, as typed or relative to current
7977 directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007978 F S Full path to the file in the buffer.
7979 t S File name (tail) of file in the buffer.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007980 m F Modified flag, text is "[+]"; "[-]" if 'modifiable' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007981 M F Modified flag, text is ",+" or ",-".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007982 r F Readonly flag, text is "[RO]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007983 R F Readonly flag, text is ",RO".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007984 h F Help buffer flag, text is "[help]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007985 H F Help buffer flag, text is ",HLP".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007986 w F Preview window flag, text is "[Preview]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007987 W F Preview window flag, text is ",PRV".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007988 y F Type of file in the buffer, e.g., "[vim]". See 'filetype'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007989 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
Bram Moolenaar7fd73202010-07-25 16:58:46 +02007990 q S "[Quickfix List]", "[Location List]" or empty.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007991 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
7992 being used: "<keymap>"
7993 n N Buffer number.
Bram Moolenaar00654022011-02-25 14:42:19 +01007994 b N Value of character under cursor.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007995 B N As above, in hexadecimal.
7996 o N Byte number in file of byte under cursor, first byte is 1.
7997 Mnemonic: Offset from start of file (with one added)
7998 {not available when compiled without |+byte_offset| feature}
7999 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00008000 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008001 l N Line number.
8002 L N Number of lines in buffer.
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02008003 c N Column number (byte index).
8004 v N Virtual column number (screen column).
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008005 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008006 p N Percentage through file in lines as in |CTRL-G|.
8007 P S Percentage through file of displayed window. This is like the
Bram Moolenaar14b69452013-06-29 23:05:20 +02008008 percentage described for 'ruler'. Always 3 in length, unless
8009 translated.
Luuk van Baalba936f62022-12-15 13:15:39 +00008010 S S 'showcmd' content, see 'showcmdloc'.
Bram Moolenaar582fd852005-03-28 20:58:01 +00008011 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00008012 Empty if the argument file count is zero or one.
Bram Moolenaar238a5642006-02-21 22:12:05 +00008013 { NF Evaluate expression between '%{' and '}' and substitute result.
Bram Moolenaar6d150f72018-04-21 20:03:20 +02008014 Note that there is no '%' before the closing '}'. The
8015 expression cannot contain a '}' character, call a function to
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01008016 work around that. See |stl-%{| below.
shadmansaleh30e3de22021-05-15 17:23:28 +02008017 {% - This is almost same as { except the result of the expression is
8018 re-evaluated as a statusline format string. Thus if the
8019 return value of expr contains % items they will get expanded.
8020 The expression can contain the } character, the end of
8021 expression is denoted by %}.
Bram Moolenaar22863042021-10-16 15:23:36 +01008022 For example: >
shadmansaleh30e3de22021-05-15 17:23:28 +02008023 func! Stl_filename() abort
8024 return "%t"
8025 endfunc
8026< `stl=%{Stl_filename()}` results in `"%t"`
8027 `stl=%{%Stl_filename()%}` results in `"Name of current file"`
Bram Moolenaar22863042021-10-16 15:23:36 +01008028 %} - End of `{%` expression
Bram Moolenaar071d4272004-06-13 20:20:40 +00008029 ( - Start of item group. Can be used for setting the width and
8030 alignment of a section. Must be followed by %) somewhere.
8031 ) - End of item group. No width fields allowed.
Bram Moolenaard1f56e62006-02-22 21:25:37 +00008032 T N For 'tabline': start of tab page N label. Use %T after the last
8033 label. This information is used for mouse clicks.
8034 X N For 'tabline': start of close tab N label. Use %X after the
8035 label, e.g.: %3Xclose%X. Use %999X for a "close current tab"
8036 mark. This information is used for mouse clicks.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008037 < - Where to truncate line if too long. Default is at the start.
8038 No width fields allowed.
Yegappan Lakshmanan3ec78f92023-02-11 11:15:25 +00008039 = - Separation point between alignment sections. Each section will
8040 be separated by an equal number of spaces. With one %= what
8041 comes after it will be right-aligned. With two %= there is a
8042 middle part, with white space left and right of it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008043 No width fields allowed.
Bram Moolenaar238a5642006-02-21 22:12:05 +00008044 # - Set highlight group. The name must follow and then a # again.
8045 Thus use %#HLname# for highlight group HLname. The same
8046 highlighting is used, also for the statusline of non-current
8047 windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008048 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00008049 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaarbe4e0162023-02-02 13:59:48 +00008050 The difference between User{N} and StatusLine will be applied to
8051 StatusLineNC for the statusline of non-current windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008052 The number N must be between 1 and 9. See |hl-User1..9|
8053
Bram Moolenaare37d50a2008-08-06 17:06:04 +00008054 When displaying a flag, Vim removes the leading comma, if any, when
8055 that flag comes right after plaintext. This will make a nice display
8056 when flags are used like in the examples below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008057
Bram Moolenaar582fd852005-03-28 20:58:01 +00008058 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00008059 not set) and a minwid is not set for the group, the whole group will
8060 become empty. This will make a group like the following disappear
8061 completely from the statusline when none of the flags are set. >
8062 :set statusline=...%(\ [%M%R%H]%)...
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02008063< Beware that an expression is evaluated each and every time the status
8064 line is displayed.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01008065 *stl-%{* *g:actual_curbuf* *g:actual_curwin*
Bram Moolenaarade0d392020-01-21 22:33:58 +01008066 While evaluating %{} the current buffer and current window will be set
8067 temporarily to that of the window (and buffer) whose statusline is
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01008068 currently being drawn. The expression will evaluate in this context.
8069 The variable "g:actual_curbuf" is set to the `bufnr()` number of the
8070 real current buffer and "g:actual_curwin" to the |window-ID| of the
8071 real current window. These values are strings.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00008072
Bram Moolenaar30b65812012-07-12 22:01:11 +02008073 The 'statusline' option will be evaluated in the |sandbox| if set from
8074 a modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008075 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00008076
8077 It is not allowed to change text or jump to another window while
8078 evaluating 'statusline' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008079
8080 If the statusline is not updated when you want it (e.g., after setting
8081 a variable that's used in an expression), you can force an update by
Bram Moolenaarcfa8f9a2022-06-03 21:59:47 +01008082 using `:redrawstatus`.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008083
Bram Moolenaarcfa8f9a2022-06-03 21:59:47 +01008084 A result of all digits is regarded a number for display purposes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008085 Otherwise the result is taken as flag text and applied to the rules
8086 described above.
8087
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00008088 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00008089 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008090 edit your .vimrc or whatever with "vim --clean" to get it right.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008091
8092 Examples:
8093 Emulate standard status line with 'ruler' set >
saher7b5e52d2024-10-14 19:52:50 +02008094 :set statusline=%<%f\ %h%w%m%r%=%-14.(%l,%c%V%)\ %P
Bram Moolenaar071d4272004-06-13 20:20:40 +00008095< Similar, but add ASCII value of char under the cursor (like "ga") >
8096 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
8097< Display byte count and byte value, modified flag in red. >
8098 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
8099 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
8100< Display a ,GZ flag if a compressed file is loaded >
8101 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
8102< In the |:autocmd|'s: >
8103 :let b:gzflag = 1
8104< And: >
8105 :unlet b:gzflag
8106< And define this function: >
8107 :function VarExists(var, val)
8108 : if exists(a:var) | return a:val | else | return '' | endif
8109 :endfunction
8110<
8111 *'suffixes'* *'su'*
8112'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
8113 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008114 Files with these suffixes get a lower priority when multiple files
8115 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008116 suffixes. Spaces after the comma are ignored. A dot is also seen as
8117 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00008118 separator, precede it with a backslash (see |option-backslash| about
8119 including spaces and backslashes).
8120 See 'wildignore' for completely ignoring files.
8121 The use of |:set+=| and |:set-=| is preferred when adding or removing
8122 suffixes from the list. This avoids problems when a future version
8123 uses another default.
8124
8125 *'suffixesadd'* *'sua'*
8126'suffixesadd' 'sua' string (default "")
8127 local to buffer
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01008128 Comma-separated list of suffixes, which are used when searching for a
Bram Moolenaar071d4272004-06-13 20:20:40 +00008129 file for the "gf", "[I", etc. commands. Example: >
8130 :set suffixesadd=.java
8131<
8132 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
8133'swapfile' 'swf' boolean (default on)
8134 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008135 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00008136 swapfile is not wanted for a specific buffer. For example, with
8137 confidential information that even root must not be able to access.
8138 Careful: All text will be in memory:
8139 - Don't use this for big files.
8140 - Recovery will be impossible!
8141 A swapfile will only be present when |'updatecount'| is non-zero and
8142 'swapfile' is set.
8143 When 'swapfile' is reset, the swap file for the current buffer is
8144 immediately deleted. When 'swapfile' is set, and 'updatecount' is
8145 non-zero, a swap file is immediately created.
8146 Also see |swap-file| and |'swapsync'|.
Bram Moolenaar76f3b1a2014-03-27 22:30:07 +01008147 If you want to open a new buffer without creating a swap file for it,
8148 use the |:noswapfile| modifier.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01008149 See 'directory' for where the swap file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008150
8151 This option is used together with 'bufhidden' and 'buftype' to
8152 specify special kinds of buffers. See |special-buffers|.
8153
8154 *'swapsync'* *'sws'*
8155'swapsync' 'sws' string (default "fsync")
8156 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008157 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008158 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008159 When this option is empty parts of the swap file may be in memory and
8160 not written to disk. When the system crashes you may lose more work.
8161 On Unix the system does a sync now and then without Vim asking for it,
8162 so the disadvantage of setting this option off is small. On some
8163 systems the swap file will not be written at all. For a unix system
8164 setting it to "sync" will use the sync() call instead of the default
8165 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00008166 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008167
8168 *'switchbuf'* *'swb'*
8169'switchbuf' 'swb' string (default "")
8170 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008171 This option controls the behavior when switching between buffers.
Yegappan Lakshmanan54be5fb2023-05-12 17:49:13 +01008172 This option is checked, when
8173 - jumping to errors with the |quickfix| commands (|:cc|, |:cn|, |:cp|,
h_east59858792023-10-25 22:47:05 +09008174 etc.).
Yegappan Lakshmanan54be5fb2023-05-12 17:49:13 +01008175 - jumping to a tag using the |:stag| command.
8176 - opening a file using the |CTRL-W_f| or |CTRL-W_F| command.
8177 - jumping to a buffer using a buffer split command (e.g. |:sbuffer|,
8178 |:sbnext|, or |:sbrewind|).
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01008179 Possible values (comma-separated list):
Yegappan Lakshmanan54be5fb2023-05-12 17:49:13 +01008180 useopen If included, jump to the first open window in the
8181 current tab page that contains the specified buffer
8182 (if there is one). Otherwise: Do not examine other
8183 windows.
Bram Moolenaar779b74b2006-04-10 14:55:34 +00008184 usetab Like "useopen", but also consider windows in other tab
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00008185 pages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008186 split If included, split the current window before loading
Bram Moolenaar15146672011-10-20 22:22:38 +02008187 a buffer for a |quickfix| command that display errors.
Bram Moolenaar63b74a82019-03-24 15:09:13 +01008188 Otherwise: do not split, use current window (when used
8189 in the quickfix window: the previously used window or
8190 split if there is no other window).
Bram Moolenaara594d772015-06-19 14:41:49 +02008191 vsplit Just like "split" but split vertically.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008192 newtab Like "split", but open a new tab page. Overrules
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02008193 "split" when both are present.
Bram Moolenaar539aa6b2019-11-17 18:09:38 +01008194 uselast If included, jump to the previously used window when
8195 jumping to errors with |quickfix| commands.
Colin Kennedy21570352024-03-03 16:16:47 +01008196 If a window has 'winfixbuf' enabled, 'switchbuf' is currently not
8197 applied to the split window.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008198
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00008199 *'synmaxcol'* *'smc'*
8200'synmaxcol' 'smc' number (default 3000)
8201 local to buffer
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00008202 {not available when compiled without the |+syntax|
8203 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00008204 Maximum column in which to search for syntax items. In long lines the
8205 text after this column is not highlighted and following lines may not
8206 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00008207 This helps to avoid very slow redrawing for an XML file that is one
8208 long line.
8209 Set to zero to remove the limit.
8210
Bram Moolenaar071d4272004-06-13 20:20:40 +00008211 *'syntax'* *'syn'*
8212'syntax' 'syn' string (default empty)
Christian Brabandt596ad662023-08-16 00:11:09 +02008213 local to buffer |local-noglobal|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008214 {not available when compiled without the |+syntax|
8215 feature}
8216 When this option is set, the syntax with this name is loaded, unless
8217 syntax highlighting has been switched off with ":syntax off".
8218 Otherwise this option does not always reflect the current syntax (the
8219 b:current_syntax variable does).
8220 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008221 not automatically recognized. Example, in an IDL file:
8222 /* vim: set syntax=idl : */ ~
8223 When a dot appears in the value then this separates two filetype
8224 names. Example:
8225 /* vim: set syntax=c.doxygen : */ ~
8226 This will use the "c" syntax first, then the "doxygen" syntax.
8227 Note that the second one must be prepared to be loaded as an addition,
8228 otherwise it will be skipped. More than one dot may appear.
8229 To switch off syntax highlighting for the current file, use: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008230 :set syntax=OFF
8231< To switch syntax highlighting on according to the current value of the
8232 'filetype' option: >
8233 :set syntax=ON
8234< What actually happens when setting the 'syntax' option is that the
8235 Syntax autocommand event is triggered with the value as argument.
8236 This option is not copied to another buffer, independent of the 's' or
8237 'S' flag in 'cpoptions'.
Millyae62fe52024-10-02 19:30:41 +02008238 Only alphanumeric characters, '.', '-' and '_' can be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008239
LemonBoy5247b0b2024-07-12 19:30:58 +02008240 *'tabclose'* *'tcl'*
8241'tabclose' 'tcl' string (default "")
8242 global
8243 This option controls the behavior when closing tab pages (e.g., using
8244 |:tabclose|). When empty Vim goes to the next (right) tab page.
8245
8246 Possible values (comma-separated list):
8247 left If included, go to the previous tab page instead of
8248 the next one.
8249 uselast If included, go to the previously used tab page if
8250 possible. This option takes precedence over the
8251 others.
8252
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00008253 *'tabline'* *'tal'*
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008254'tabline' 'tal' string (default empty)
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00008255 global
Bram Moolenaar944697a2022-02-20 19:48:20 +00008256 When non-empty, this option determines the content of the tab pages
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008257 line at the top of the Vim window. When empty Vim will use a default
Bram Moolenaard1f56e62006-02-22 21:25:37 +00008258 tab pages line. See |setting-tabline| for more info.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008259
8260 The tab pages line only appears as specified with the 'showtabline'
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00008261 option and only when there is no GUI tab line. When 'e' is in
8262 'guioptions' and the GUI supports a tab line 'guitablabel' is used
Bram Moolenaar7f036442010-08-15 15:24:20 +02008263 instead. Note that the two tab pages lines are very different.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008264
8265 The value is evaluated like with 'statusline'. You can use
8266 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out
Bram Moolenaard1f56e62006-02-22 21:25:37 +00008267 the text to be displayed. Use "%1T" for the first label, "%2T" for
8268 the second one, etc. Use "%X" items for closing labels.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008269
Bram Moolenaare12bab32019-01-08 22:02:56 +01008270 When changing something that is used in 'tabline' that does not
8271 trigger it to be updated, use |:redrawtabline|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008272 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaare12bab32019-01-08 22:02:56 +01008273
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008274 Keep in mind that only one of the tab pages is the current one, others
8275 are invisible and you can't jump to their windows.
8276
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00008277 *'tabpagemax'* *'tpm'*
8278'tabpagemax' 'tpm' number (default 10)
8279 global
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00008280 Maximum number of tab pages to be opened by the |-p| command line
8281 argument or the ":tab all" command. |tabpage|
8282
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00008283 *'tabstop'* *'ts'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008284'tabstop' 'ts' number (default 8)
8285 local to buffer
8286 Number of spaces that a <Tab> in the file counts for. Also see
Bram Moolenaarf10911e2022-01-29 22:20:48 +00008287 the |:retab| command, and the 'softtabstop' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008288
8289 Note: Setting 'tabstop' to any other value than 8 can make your file
Bram Moolenaarf10911e2022-01-29 22:20:48 +00008290 appear wrong in many places, e.g., when printing it.
8291 The value must be more than 0 and less than 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008292
Song-Tianxiangab01adf2024-03-25 16:31:02 +01008293 There are five main ways to use tabs in Vim:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008294 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
8295 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
Bram Moolenaarebcbd022007-05-12 14:28:25 +00008296 will use a mix of tabs and spaces, but typing <Tab> and <BS> will
Bram Moolenaar071d4272004-06-13 20:20:40 +00008297 behave like a tab appears every 4 (or 3) characters.
Bram Moolenaar10e8ff92023-06-10 21:40:39 +01008298 This is the recommended way, the file will look the same with other
8299 tools and when listing it in a terminal.
8300 2. Set 'softtabstop' and 'shiftwidth' to whatever you prefer and use
8301 'expandtab'. This way you will always insert spaces. The
8302 formatting will never be messed up when 'tabstop' is changed (leave
8303 it at 8 just in case). The file will be a bit larger.
8304 You do need to check if no Tabs exist in the file. You can get rid
8305 of them by first setting 'expandtab' and using `%retab!`, making
8306 sure the value of 'tabstop' is set correctly.
8307 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
Bram Moolenaar071d4272004-06-13 20:20:40 +00008308 'expandtab'. This way you will always insert spaces. The
8309 formatting will never be messed up when 'tabstop' is changed.
Bram Moolenaar10e8ff92023-06-10 21:40:39 +01008310 You do need to check if no Tabs exist in the file, just like in the
8311 item just above.
8312 4. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008313 |modeline| to set these values when editing the file again. Only
Bram Moolenaar10e8ff92023-06-10 21:40:39 +01008314 works when using Vim to edit the file, other tools assume a tabstop
8315 is worth 8 spaces.
8316 5. Always set 'tabstop' and 'shiftwidth' to the same value, and
Bram Moolenaar071d4272004-06-13 20:20:40 +00008317 'noexpandtab'. This should then work (for initial indents only)
8318 for any tabstop setting that people use. It might be nice to have
8319 tabs after the first non-blank inserted as spaces if you do this
8320 though. Otherwise aligned comments will be wrong when 'tabstop' is
8321 changed.
8322
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008323 If Vim is compiled with the |+vartabs| feature then the value of
8324 'tabstop' will be ignored if |'vartabstop'| is set to anything other
8325 than an empty string.
8326
Bram Moolenaar071d4272004-06-13 20:20:40 +00008327 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
8328'tagbsearch' 'tbs' boolean (default on)
8329 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008330 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008331 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00008332 searching makes searching for a tag a LOT faster, but a linear search
8333 will find more tags if the tags file wasn't properly sorted.
8334 Vim normally assumes that your tags files are sorted, or indicate that
8335 they are not sorted. Only when this is not the case does the
8336 'tagbsearch' option need to be switched off.
8337
8338 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008339 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00008340 certain files, or retry all files with a linear search. When
8341 'tagbsearch' is off, only a linear search is done.
8342
8343 Linear searching is done anyway, for one file, when Vim finds a line
8344 at the start of the file indicating that it's not sorted: >
Bram Moolenaar446cb832008-06-24 21:56:24 +00008345 !_TAG_FILE_SORTED 0 /some comment/
Bram Moolenaar071d4272004-06-13 20:20:40 +00008346< [The whitespace before and after the '0' must be a single <Tab>]
8347
8348 When a binary search was done and no match was found in any of the
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008349 files listed in 'tags', and case is ignored or a pattern is used
Bram Moolenaar071d4272004-06-13 20:20:40 +00008350 instead of a normal tag name, a retry is done with a linear search.
8351 Tags in unsorted tags files, and matches with different case will only
8352 be found in the retry.
8353
Bram Moolenaard4755bb2004-09-02 19:12:26 +00008354 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008355 linear search can be avoided when case is ignored. Use a value of '2'
8356 in the "!_TAG_FILE_SORTED" line for this. A tag file can be case-fold
8357 sorted with the -f switch to "sort" in most unices, as in the command:
Bram Moolenaar47c532e2022-03-19 15:18:53 +00008358 "sort -f -o tags tags". For Universal ctags and Exuberant ctags
8359 version 5.x or higher (at least 5.5) the --sort=foldcase switch can be
8360 used for this as well. Note that case must be folded to uppercase for
8361 this to work.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008362
8363 By default, tag searches are case-sensitive. Case is ignored when
8364 'ignorecase' is set and 'tagcase' is "followic", or when 'tagcase' is
8365 "ignore".
Bram Moolenaar66e29d72016-08-20 16:57:02 +02008366 Also when 'tagcase' is "followscs" and 'smartcase' is set, or
8367 'tagcase' is "smart", and the pattern contains only lowercase
8368 characters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008369
8370 When 'tagbsearch' is off, tags searching is slower when a full match
8371 exists, but faster when no full match exists. Tags in unsorted tags
8372 files may only be found with 'tagbsearch' off.
8373 When the tags file is not sorted, or sorted in a wrong way (not on
8374 ASCII byte value), 'tagbsearch' should be off, or the line given above
8375 must be included in the tags file.
8376 This option doesn't affect commands that find all matching tags (e.g.,
8377 command-line completion and ":help").
Bram Moolenaar071d4272004-06-13 20:20:40 +00008378
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008379 *'tagcase'* *'tc'*
8380'tagcase' 'tc' string (default "followic")
8381 global or local to buffer |global-local|
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008382 This option specifies how case is handled when searching the tags
8383 file:
8384 followic Follow the 'ignorecase' option
Bram Moolenaar66e29d72016-08-20 16:57:02 +02008385 followscs Follow the 'smartcase' and 'ignorecase' options
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008386 ignore Ignore case
8387 match Match case
Bram Moolenaar66e29d72016-08-20 16:57:02 +02008388 smart Ignore case unless an upper case letter is used
Bram Moolenaar036986f2017-03-16 17:41:02 +01008389 NOTE: This option is set to the Vi default value when 'compatible' is
8390 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008391
Bram Moolenaar45e18cb2019-04-28 18:05:35 +02008392 *'tagfunc'* *'tfu'*
8393'tagfunc' 'tfu' string (default: empty)
8394 local to buffer
8395 {not available when compiled without the |+eval|
8396 feature}
8397 This option specifies a function to be used to perform tag searches.
8398 The function gets the tag pattern and should return a List of matching
8399 tags. See |tag-function| for an explanation of how to write the
Yegappan Lakshmanan19916a82021-11-24 16:32:55 +00008400 function and an example. The value can be the name of a function, a
8401 |lambda| or a |Funcref|. See |option-value-function| for more
8402 information.
dkearns8ebdbc92023-10-29 06:26:19 +11008403 This option cannot be set from a |modeline| or in the |sandbox|, for
8404 security reasons.
Bram Moolenaar45e18cb2019-04-28 18:05:35 +02008405
Bram Moolenaar071d4272004-06-13 20:20:40 +00008406 *'taglength'* *'tl'*
8407'taglength' 'tl' number (default 0)
8408 global
8409 If non-zero, tags are significant up to this number of characters.
8410
8411 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
8412'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
8413 global
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00008414 If on and using a tags file in another directory, file names in that
8415 tags file are relative to the directory where the tags file is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008416 NOTE: This option is set to the Vi default value when 'compatible' is
8417 set and to the Vim default value when 'compatible' is reset.
8418
8419 *'tags'* *'tag'* *E433*
8420'tags' 'tag' string (default "./tags,tags", when compiled with
8421 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
8422 global or local to buffer |global-local|
8423 Filenames for the tag command, separated by spaces or commas. To
Yee Cheng Chin54844852023-10-09 18:12:31 +02008424 include a space or comma in a file name, precede it with backslashes
8425 (see |option-backslash| about including spaces/commas and backslashes).
Bram Moolenaar071d4272004-06-13 20:20:40 +00008426 When a file name starts with "./", the '.' is replaced with the path
8427 of the current file. But only when the 'd' flag is not included in
8428 'cpoptions'. Environment variables are expanded |:set_env|. Also see
8429 |tags-option|.
8430 "*", "**" and other wildcards can be used to search for tags files in
Bram Moolenaare2b590e2010-08-08 18:29:48 +02008431 a directory tree. See |file-searching|. E.g., "/lib/**/tags" will
8432 find all files named "tags" below "/lib". The filename itself cannot
8433 contain wildcards, it is used as-is. E.g., "/lib/**/tags?" will find
Bram Moolenaar2bd9dbc2022-08-25 18:12:06 +01008434 files called "tags?".
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00008435 The |tagfiles()| function can be used to get a list of the file names
8436 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008437 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
8438 files are also supported. They are automatically recognized. The
8439 default value becomes "./tags,./TAGS,tags,TAGS", unless case
8440 differences are ignored (MS-Windows). |emacs-tags|
8441 The use of |:set+=| and |:set-=| is preferred when adding or removing
8442 file names from the list. This avoids problems when a future version
8443 uses another default.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008444
8445 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
8446'tagstack' 'tgst' boolean (default on)
8447 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008448 When on, the |tagstack| is used normally. When off, a ":tag" or
8449 ":tselect" command with an argument will not push the tag onto the
8450 tagstack. A following ":tag" without an argument, a ":pop" command or
8451 any other command that uses the tagstack will use the unmodified
8452 tagstack, but does change the pointer to the active entry.
8453 Resetting this option is useful when using a ":tag" command in a
8454 mapping which should not change the tagstack.
8455
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01008456 *'tcldll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01008457'tcldll' string (default depends on the build)
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01008458 global
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01008459 {only available when compiled with the |+tcl/dyn|
8460 feature}
8461 Specifies the name of the Tcl shared library. The default is
8462 DYNAMIC_TCL_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02008463 Environment variables are expanded |:set_env|.
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01008464 This option cannot be set from a |modeline| or in the |sandbox|, for
8465 security reasons.
8466
Bram Moolenaar071d4272004-06-13 20:20:40 +00008467 *'term'* *E529* *E530* *E531*
8468'term' string (default is $TERM, if that fails:
8469 in the GUI: "builtin_gui"
8470 on Amiga: "amiga"
Bram Moolenaarb3f74062020-02-26 16:16:53 +01008471 on Haiku: "xterm"
Bram Moolenaar071d4272004-06-13 20:20:40 +00008472 on Mac: "mac-ansi"
Bram Moolenaar071d4272004-06-13 20:20:40 +00008473 on Unix: "ansi"
8474 on VMS: "ansi"
8475 on Win 32: "win32")
8476 global
8477 Name of the terminal. Used for choosing the terminal control
8478 characters. Environment variables are expanded |:set_env|.
8479 For example: >
8480 :set term=$TERM
8481< See |termcap|.
8482
8483 *'termbidi'* *'tbidi'*
8484 *'notermbidi'* *'notbidi'*
8485'termbidi' 'tbidi' boolean (default off, on for "mlterm")
8486 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008487 {only available when compiled with the |+arabic|
8488 feature}
8489 The terminal is in charge of Bi-directionality of text (as specified
8490 by Unicode). The terminal is also expected to do the required shaping
8491 that some languages (such as Arabic) require.
8492 Setting this option implies that 'rightleft' will not be set when
8493 'arabic' is set and the value of 'arabicshape' will be ignored.
8494 Note that setting 'termbidi' has the immediate effect that
8495 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
8496 This option is reset when the GUI is started.
8497 For further details see |arabic.txt|.
8498
8499 *'termencoding'* *'tenc'*
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02008500'termencoding' 'tenc' string (default ""; with GTK+ GUI: "utf-8")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008501 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008502 Encoding used for the terminal. This specifies what character
8503 encoding the keyboard produces and the display will understand. For
Bram Moolenaar3848e002016-03-19 18:42:29 +01008504 the GUI it only applies to the keyboard ('encoding' is used for the
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02008505 display).
Bram Moolenaar4b7cdca2020-01-01 16:18:38 +01008506 *E617* *E950*
Bram Moolenaar3df01732017-02-17 22:47:16 +01008507 Note: This does not apply to the GTK+ GUI. After the GUI has been
Bram Moolenaar071d4272004-06-13 20:20:40 +00008508 successfully initialized, 'termencoding' is forcibly set to "utf-8".
8509 Any attempts to set a different value will be rejected, and an error
8510 message is shown.
Bram Moolenaarac360bf2015-09-01 20:31:20 +02008511 For the Win32 GUI and console versions 'termencoding' is not used,
Bram Moolenaar071d4272004-06-13 20:20:40 +00008512 because the Win32 system always passes Unicode characters.
8513 When empty, the same encoding is used as for the 'encoding' option.
8514 This is the normal value.
8515 Not all combinations for 'termencoding' and 'encoding' are valid. See
8516 |encoding-table|.
8517 The value for this option must be supported by internal conversions or
8518 iconv(). When this is not possible no conversion will be done and you
8519 will probably experience problems with non-ASCII characters.
8520 Example: You are working with the locale set to euc-jp (Japanese) and
8521 want to edit a UTF-8 file: >
8522 :let &termencoding = &encoding
8523 :set encoding=utf-8
8524< You need to do this when your system has no locale support for UTF-8.
8525
Bram Moolenaar938ae282023-02-20 20:44:55 +00008526 *'termguicolors'* *'tgc'* *'notermguicolors'* *'notgc'* *E954*
Christian Brabandtd7f58542025-01-31 16:13:14 +01008527'termguicolors' 'tgc' boolean (default off unless Vim detects that it runs
8528 in a capable terminal)
Bram Moolenaar61be73b2016-04-29 22:59:22 +02008529 global
Bram Moolenaar61be73b2016-04-29 22:59:22 +02008530 {not available when compiled without the
8531 |+termguicolors| feature}
8532 When on, uses |highlight-guifg| and |highlight-guibg| attributes in
Bram Moolenaarcafafb32018-02-22 21:07:09 +01008533 the terminal (thus using 24-bit color).
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01008534
Bram Moolenaarcafafb32018-02-22 21:07:09 +01008535 Requires a ISO-8613-3 compatible terminal. If setting this option
8536 does not work (produces a colorless UI) reading |xterm-true-color|
8537 might help.
8538
8539 For Win32 console, Windows 10 version 1703 (Creators Update) or later
8540 is required. Use this check to find out: >
8541 if has('vcon')
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01008542< This requires Vim to be built with the |+vtp| feature.
8543
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +02008544 Note that the "cterm" attributes are still used, not the "gui" ones.
Yasuhiro Matsumotoaa04e1b2022-05-07 14:09:19 +01008545
8546 When using Vim with Windows Terminal, the background of Windows
8547 Terminal is normally filled with the Vim background color. Setting
8548 'termguicolors' and the guibg of the Normal highlight group to NONE
8549 will make the background transparent: >
8550 :hi Normal guibg=NONE
8551<
Bram Moolenaar036986f2017-03-16 17:41:02 +01008552 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar61be73b2016-04-29 22:59:22 +02008553
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008554 *'termwinkey'* *'twk'*
8555'termwinkey' 'twk' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02008556 local to window
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008557 The key that starts a CTRL-W command in a terminal window. Other keys
Bram Moolenaar74675a62017-07-15 13:53:23 +02008558 are sent to the job running in the window.
Millya9c6f902024-10-06 16:47:02 +02008559 The key can be specified as a single character, a |key-notation| (e.g.
8560 <Up>, <C-F>) or a letter preceded with a caret (e.g. `^F` is CTRL-F): >
8561 :set twk=X
8562 :set twk=^I
8563 :set twk=<C-L>
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008564< The string must be one key stroke but can be multiple bytes.
8565 When not set CTRL-W is used, so that CTRL-W : gets you to the command
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008566 line. If 'termwinkey' is set to CTRL-L then CTRL-L : gets you to the
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008567 command line.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008568
Bram Moolenaar6c60f472019-04-28 16:00:35 +02008569 *'termwinscroll'* *'twsl'*
8570'termwinscroll' 'twsl' number (default 10000)
8571 local to buffer
8572 {not available when compiled without the
8573 |+terminal| feature}
8574 Number of scrollback lines to keep. When going over this limit the
8575 first 10% of the scrollback lines are deleted. This is just to reduce
8576 the memory usage. See |Terminal-Normal|.
Bram Moolenaar36968af2021-11-15 17:13:11 +00008577 Also used as a limit for text sent to the terminal in one write,
8578 multiplied by the number of columns times 3 (average number of bytes
8579 per cell).
Bram Moolenaar6c60f472019-04-28 16:00:35 +02008580
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008581 *'termwinsize'* *'tws'*
8582'termwinsize' 'tws' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02008583 local to window
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02008584 Size used when opening the |terminal| window. Format:
8585 {rows}x{columns} or {rows}*{columns}.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008586 - When empty the terminal gets the size from the window.
Bram Moolenaar498c2562018-04-15 23:45:15 +02008587 - When set with a "x" (e.g., "24x80") the terminal size is not
8588 adjusted to the window size. If the window is smaller only the
8589 top-left part is displayed.
8590 - When set with a "*" (e.g., "10*50") the terminal size follows the
8591 window size, but will not be smaller than the specified rows and/or
8592 columns.
8593 - When rows is zero then use the height of the window.
8594 - When columns is zero then use the width of the window.
8595 - Using "0x0" or "0*0" is the same as empty.
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02008596 - Can be overruled in the |term_start()| options with "term_rows" and
8597 "term_cols".
Bram Moolenaar498c2562018-04-15 23:45:15 +02008598
8599 Examples:
8600 "30x0" uses 30 rows and the current window width.
8601 "20*0" uses at least 20 rows and the current window width.
8602 "0*40" uses the current window height and at least 40 columns.
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02008603 Note that the command running in the terminal window may still change
8604 the size of the terminal. In that case the Vim window will be
8605 adjusted to that size, if possible.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008606
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008607 *'termwintype'* *'twt'*
8608'termwintype' 'twt' string (default "")
8609 global
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008610 {only available when compiled with the |terminal|
8611 feature on MS-Windows}
8612 Specify the virtual console (pty) used when opening the terminal
8613 window.
8614
8615 Possible values are:
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01008616 "" use ConPTY if it is stable, winpty otherwise
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008617 "winpty" use winpty, fail if not supported
8618 "conpty" use |ConPTY|, fail if not supported
8619
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01008620 |ConPTY| support depends on the platform. Windows 10 October 2018
8621 Update is the first version that supports ConPTY, however it is still
8622 considered unstable. ConPTY might become stable in the next release
8623 of Windows 10. winpty support needs to be installed. If neither is
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008624 supported then you cannot open a terminal window.
8625
Bram Moolenaar071d4272004-06-13 20:20:40 +00008626 *'terse'* *'noterse'*
8627'terse' boolean (default off)
8628 global
8629 When set: Add 's' flag to 'shortmess' option (this makes the message
8630 for a search that hits the start or end of the file not being
8631 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
8632 shortens a lot of messages}
8633
8634 *'textauto'* *'ta'* *'notextauto'* *'nota'*
8635'textauto' 'ta' boolean (Vim default: on, Vi default: off)
8636 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008637 This option is obsolete. Use 'fileformats'.
8638 For backwards compatibility, when 'textauto' is set, 'fileformats' is
8639 set to the default value for the current system. When 'textauto' is
8640 reset, 'fileformats' is made empty.
8641 NOTE: This option is set to the Vi default value when 'compatible' is
8642 set and to the Vim default value when 'compatible' is reset.
8643
8644 *'textmode'* *'tx'* *'notextmode'* *'notx'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008645'textmode' 'tx' boolean (Win32: default on,
Bram Moolenaar071d4272004-06-13 20:20:40 +00008646 others: default off)
8647 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00008648 This option is obsolete. Use 'fileformat'.
8649 For backwards compatibility, when 'textmode' is set, 'fileformat' is
8650 set to "dos". When 'textmode' is reset, 'fileformat' is set to
8651 "unix".
8652
8653 *'textwidth'* *'tw'*
8654'textwidth' 'tw' number (default 0)
8655 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00008656 Maximum width of text that is being inserted. A longer line will be
8657 broken after white space to get this width. A zero value disables
Bram Moolenaarca635012015-09-25 20:34:21 +02008658 this.
8659 'textwidth' is set to 0 when the 'paste' option is set and restored
8660 when 'paste' is reset.
8661 When 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00008662 'formatoptions' and |ins-textwidth|.
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00008663 When 'formatexpr' is set it will be used to break the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008664 NOTE: This option is set to 0 when 'compatible' is set.
8665
8666 *'thesaurus'* *'tsr'*
8667'thesaurus' 'tsr' string (default "")
8668 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008669 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008670 for thesaurus completion commands |i_CTRL-X_CTRL-T|. See
8671 |compl-thesaurus|.
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01008672
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008673 This option is not used if 'thesaurusfunc' is set, either for the
8674 buffer or globally.
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01008675
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008676 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00008677 after a comma are ignored, otherwise spaces are included in the file
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008678 name. See |option-backslash| about using backslashes. The use of
8679 |:set+=| and |:set-=| is preferred when adding or removing directories
8680 from the list. This avoids problems when a future version uses
8681 another default. Backticks cannot be used in this option for security
8682 reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008683
Bram Moolenaar2f0936c2022-01-08 21:51:59 +00008684 *'thesaurusfunc'* *'tsrfu'*
Yegappan Lakshmanan160e9942021-10-16 15:41:29 +01008685'thesaurusfunc' 'tsrfu' string (default: empty)
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008686 global or local to buffer |global-local|
Yegappan Lakshmanan160e9942021-10-16 15:41:29 +01008687 {not available when compiled without the |+eval|
8688 feature}
8689 This option specifies a function to be used for thesaurus completion
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008690 with CTRL-X CTRL-T. |i_CTRL-X_CTRL-T| See |compl-thesaurusfunc|.
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00008691 The value can be the name of a function, a |lambda| or a |Funcref|.
8692 See |option-value-function| for more information.
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008693
Yegappan Lakshmanan160e9942021-10-16 15:41:29 +01008694 This option cannot be set from a |modeline| or in the |sandbox|, for
8695 security reasons.
8696
Bram Moolenaar071d4272004-06-13 20:20:40 +00008697 *'tildeop'* *'top'* *'notildeop'* *'notop'*
8698'tildeop' 'top' boolean (default off)
8699 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008700 When on: The tilde command "~" behaves like an operator.
8701 NOTE: This option is reset when 'compatible' is set.
8702
8703 *'timeout'* *'to'* *'notimeout'* *'noto'*
8704'timeout' 'to' boolean (default on)
8705 global
laburnumT3f7855a2023-12-05 18:37:03 +01008706
Bram Moolenaar071d4272004-06-13 20:20:40 +00008707 *'ttimeout'* *'nottimeout'*
Bram Moolenaar94237492017-04-23 18:40:21 +02008708'ttimeout' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008709 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008710 These two options together determine the behavior when part of a
8711 mapped key sequence or keyboard code has been received:
8712
8713 'timeout' 'ttimeout' action ~
8714 off off do not time out
8715 on on or off time out on :mappings and key codes
8716 off on time out on key codes
8717
8718 If both options are off, Vim will wait until either the complete
8719 mapping or key sequence has been received, or it is clear that there
8720 is no mapping or key sequence for the received characters. For
8721 example: if you have mapped "vl" and Vim has received 'v', the next
8722 character is needed to see if the 'v' is followed by an 'l'.
8723 When one of the options is on, Vim will wait for about 1 second for
8724 the next character to arrive. After that the already received
8725 characters are interpreted as single characters. The waiting time can
8726 be changed with the 'timeoutlen' option.
8727 On slow terminals or very busy systems timing out may cause
8728 malfunctioning cursor keys. If both options are off, Vim waits
8729 forever after an entered <Esc> if there are key codes that start
8730 with <Esc>. You will have to type <Esc> twice. If you do not have
8731 problems with key codes, but would like to have :mapped key
8732 sequences not timing out in 1 second, set the 'ttimeout' option and
8733 reset the 'timeout' option.
8734
8735 NOTE: 'ttimeout' is reset when 'compatible' is set.
8736
8737 *'timeoutlen'* *'tm'*
8738'timeoutlen' 'tm' number (default 1000)
8739 global
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008740
Bram Moolenaar071d4272004-06-13 20:20:40 +00008741 *'ttimeoutlen'* *'ttm'*
Bram Moolenaar94237492017-04-23 18:40:21 +02008742'ttimeoutlen' 'ttm' number (default -1, set to 100 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008743 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008744 The time in milliseconds that is waited for a key code or mapped key
8745 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
8746 when part of a command has been typed.
8747 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
8748 different timeout value for key codes is desired set 'ttimeoutlen' to
8749 a non-negative number.
8750
8751 ttimeoutlen mapping delay key code delay ~
8752 < 0 'timeoutlen' 'timeoutlen'
8753 >= 0 'timeoutlen' 'ttimeoutlen'
8754
8755 The timeout only happens when the 'timeout' and 'ttimeout' options
8756 tell so. A useful setting would be >
8757 :set timeout timeoutlen=3000 ttimeoutlen=100
8758< (time out on mapping after three seconds, time out on key codes after
8759 a tenth of a second).
8760
8761 *'title'* *'notitle'*
8762'title' boolean (default off, on when title can be restored)
8763 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008764 When on, the title of the window will be set to the value of
8765 'titlestring' (if it is not empty), or to:
8766 filename [+=-] (path) - VIM
8767 Where:
8768 filename the name of the file being edited
8769 - indicates the file cannot be modified, 'ma' off
8770 + indicates the file was modified
8771 = indicates the file is read-only
8772 =+ indicates the file is read-only and modified
8773 (path) is the path of the file being edited
8774 - VIM the server name |v:servername| or "VIM"
8775 Only works if the terminal supports setting window titles
8776 (currently Amiga console, Win32 console, all GUI versions and
Bram Moolenaard1caa942020-04-10 22:10:56 +02008777 terminals with a non-empty 't_ts' option - these are Unix xterm and
Bram Moolenaar071d4272004-06-13 20:20:40 +00008778 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
8779 *X11*
8780 When Vim was compiled with HAVE_X11 defined, the original title will
8781 be restored if possible. The output of ":version" will include "+X11"
8782 when HAVE_X11 was defined, otherwise it will be "-X11". This also
8783 works for the icon name |'icon'|.
8784 But: When Vim was started with the |-X| argument, restoring the title
8785 will not work (except in the GUI).
8786 If the title cannot be restored, it is set to the value of 'titleold'.
8787 You might want to restore the title outside of Vim then.
Christian Brabandt1b7fbe72024-01-30 20:41:07 +01008788 When using an xterm from a remote machine you can use this command: >
8789
Bram Moolenaar071d4272004-06-13 20:20:40 +00008790 rsh machine_name xterm -display $DISPLAY &
Christian Brabandt1b7fbe72024-01-30 20:41:07 +01008791 ssh -X machine_name xterm &
8792<
Bram Moolenaar071d4272004-06-13 20:20:40 +00008793 then the WINDOWID environment variable should be inherited and the
8794 title of the window should change back to what it should be after
8795 exiting Vim.
8796
8797 *'titlelen'*
8798'titlelen' number (default 85)
8799 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008800 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008801 title. When the title is longer, only the end of the path name is
8802 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008803 Using a percentage makes this adapt to the width of the window. But
8804 it won't work perfectly, because the actual number of characters
8805 available also depends on the font used and other things in the title
8806 bar. When 'titlelen' is zero the full path is used. Otherwise,
8807 values from 1 to 30000 percent can be used.
8808 'titlelen' is also used for the 'titlestring' option.
8809
8810 *'titleold'*
8811'titleold' string (default "Thanks for flying Vim")
8812 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008813 This option will be used for the window title when exiting Vim if the
8814 original title cannot be restored. Only happens if 'title' is on or
8815 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00008816 This option cannot be set from a |modeline| or in the |sandbox|, for
8817 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008818 *'titlestring'*
8819'titlestring' string (default "")
8820 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008821 When this option is not empty, it will be used for the title of the
8822 window. This happens only when the 'title' option is on.
8823 Only works if the terminal supports setting window titles (currently
8824 Amiga console, Win32 console, all GUI versions and terminals with a
8825 non-empty 't_ts' option).
8826 When Vim was compiled with HAVE_X11 defined, the original title will
Bram Moolenaar51628222016-12-01 23:03:28 +01008827 be restored if possible, see |X11|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008828
Bram Moolenaar071d4272004-06-13 20:20:40 +00008829 When this option contains printf-style '%' items, they will be
Milly6c2fc372024-10-16 22:11:17 +02008830 expanded according to the rules used for 'statusline'. If it contains
8831 an invalid '%' format, the value is used as-is and no error or warning
8832 will be given when the value is set.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008833 This option cannot be set in a modeline when 'modelineexpr' is off.
8834
Bram Moolenaar071d4272004-06-13 20:20:40 +00008835 Example: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00008836 :auto BufEnter * let &titlestring = hostname() .. "/" .. expand("%:p")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008837 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
8838< The value of 'titlelen' is used to align items in the middle or right
8839 of the available space.
8840 Some people prefer to have the file name first: >
8841 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
8842< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008843 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00008844 separating space only when needed.
8845 NOTE: Use of special characters in 'titlestring' may cause the display
8846 to be garbled (e.g., when it contains a CR or NL character).
8847 {not available when compiled without the |+statusline| feature}
8848
8849 *'toolbar'* *'tb'*
8850'toolbar' 'tb' string (default "icons,tooltips")
8851 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01008852 {only for |+GUI_GTK|, |+GUI_Motif| and |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008853 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00008854 possible values are:
8855 icons Toolbar buttons are shown with icons.
8856 text Toolbar buttons shown with text.
8857 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008858 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008859 tooltips Tooltips are active for toolbar buttons.
8860 Tooltips refer to the popup help text which appears after the mouse
8861 cursor is placed over a toolbar button for a brief moment.
8862
8863 If you want the toolbar to be shown with icons as well as text, do the
8864 following: >
8865 :set tb=icons,text
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01008866< Motif cannot display icons and text at the same time. They
Bram Moolenaar071d4272004-06-13 20:20:40 +00008867 will show icons if both are requested.
8868
8869 If none of the strings specified in 'toolbar' are valid or if
8870 'toolbar' is empty, this option is ignored. If you want to disable
8871 the toolbar, you need to set the 'guioptions' option. For example: >
8872 :set guioptions-=T
8873< Also see |gui-toolbar|.
8874
8875 *'toolbariconsize'* *'tbis'*
8876'toolbariconsize' 'tbis' string (default "small")
8877 global
Bram Moolenaar3df01732017-02-17 22:47:16 +01008878 {only in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008879 Controls the size of toolbar icons. The possible values are:
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008880 tiny Use tiny icons.
8881 small Use small icons (default).
8882 medium Use medium-sized icons.
8883 large Use large icons.
8884 huge Use even larger icons.
8885 giant Use very big icons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008886 The exact dimensions in pixels of the various icon sizes depend on
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008887 the current theme. Common dimensions are giant=48x48, huge=32x32,
8888 large=24x24, medium=24x24, small=20x20 and tiny=16x16.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008889
8890 If 'toolbariconsize' is empty, the global default size as determined
8891 by user preferences or the current theme is used.
8892
8893 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
8894'ttybuiltin' 'tbi' boolean (default on)
8895 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008896 When on, the builtin termcaps are searched before the external ones.
8897 When off the builtin termcaps are searched after the external ones.
8898 When this option is changed, you should set the 'term' option next for
8899 the change to take effect, for example: >
8900 :set notbi term=$TERM
8901< See also |termcap|.
8902 Rationale: The default for this option is "on", because the builtin
8903 termcap entries are generally better (many systems contain faulty
8904 xterm entries...).
8905
8906 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
Bram Moolenaarc1cf4c92022-11-25 15:09:35 +00008907'ttyfast' 'tf' boolean (default on)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008908 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008909 Indicates a fast terminal connection. More characters will be sent to
8910 the screen for redrawing, instead of using insert/delete line
8911 commands. Improves smoothness of redrawing when there are multiple
8912 windows and the terminal does not support a scrolling region.
8913 Also enables the extra writing of characters at the end of each screen
8914 line for lines that wrap. This helps when using copy/paste with the
8915 mouse in an xterm and other terminals.
8916
Bram Moolenaarc1cf4c92022-11-25 15:09:35 +00008917 The default used to be set only for some terminal names, but these
8918 days nearly all terminals are fast, therefore the default is now "on".
8919 If you have a slow connection you may want to set this option off,
8920 e.g. depending on the host name: >
8921 if hostname() =~ 'faraway'
8922 set nottyfast
8923 endif
8924<
Bram Moolenaar071d4272004-06-13 20:20:40 +00008925 *'ttymouse'* *'ttym'*
8926'ttymouse' 'ttym' string (default depends on 'term')
8927 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008928 {only in Unix and VMS, doesn't work in the GUI; not
8929 available when compiled without |+mouse|}
8930 Name of the terminal type for which mouse codes are to be recognized.
Bram Moolenaar2c7a7632007-05-10 18:19:11 +00008931 Currently these strings are valid:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008932 *xterm-mouse*
8933 xterm xterm-like mouse handling. The mouse generates
8934 "<Esc>[Mscr", where "scr" is three bytes:
8935 "s" = button state
8936 "c" = column plus 33
8937 "r" = row plus 33
Bram Moolenaare968e362014-05-13 20:23:24 +02008938 This only works up to 223 columns! See "dec",
8939 "urxvt", and "sgr" for solutions.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008940 xterm2 Works like "xterm", but with the xterm reporting the
8941 mouse position while the mouse is dragged. This works
8942 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00008943 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00008944 work. See below for how Vim detects this
8945 automatically.
8946 *netterm-mouse*
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008947 netterm NetTerm mouse handling. A left mouse click generates
Bram Moolenaar071d4272004-06-13 20:20:40 +00008948 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008949 for the row and column. No other mouse events are
8950 supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008951 *dec-mouse*
8952 dec DEC terminal mouse handling. The mouse generates a
8953 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00008954 This is also available for an Xterm, if it was
8955 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00008956 *jsbterm-mouse*
8957 jsbterm JSB term mouse handling.
8958 *pterm-mouse*
8959 pterm QNX pterm mouse handling.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008960 *urxvt-mouse*
8961 urxvt Mouse handling for the urxvt (rxvt-unicode) terminal.
Bram Moolenaare968e362014-05-13 20:23:24 +02008962 The mouse works only if the terminal supports this
8963 encoding style, but it does not have 223 columns limit
8964 unlike "xterm" or "xterm2".
Bram Moolenaar9b451252012-08-15 17:43:31 +02008965 *sgr-mouse*
8966 sgr Mouse handling for the terminal that emits SGR-styled
Bram Moolenaare968e362014-05-13 20:23:24 +02008967 mouse reporting. The mouse works even in columns
8968 beyond 223. This option is backward compatible with
8969 "xterm2" because it can also decode "xterm2" style
8970 mouse codes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008971
8972 The mouse handling must be enabled at compile time |+mouse_xterm|
Bram Moolenaare968e362014-05-13 20:23:24 +02008973 |+mouse_dec| |+mouse_netterm| |+mouse_jsbterm| |+mouse_urxvt|
8974 |+mouse_sgr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008975 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
8976 recognized, if enabled at compile time. DEC terminal mouse codes
8977 are recognized if enabled at compile time, and 'ttymouse' is not
Bram Moolenaare968e362014-05-13 20:23:24 +02008978 "xterm", "xterm2", "urxvt" or "sgr" (because dec mouse codes conflict
8979 with them).
Bram Moolenaar071d4272004-06-13 20:20:40 +00008980 This option is automatically set to "xterm", when the 'term' option is
Bram Moolenaar45758762016-10-12 23:08:06 +02008981 set to a name that starts with "xterm", "mlterm", "screen", "tmux",
8982 "st" (full match only), "st-" or "stterm", and 'ttymouse' is not set
8983 already.
Bram Moolenaar06cd14d2023-01-10 12:37:38 +00008984 If the terminfo/termcap entry "XM" exists and the first number is
8985 "1006" then 'ttymouse' will be set to "sgr". This works for many
8986 modern terminals.
Bram Moolenaare968e362014-05-13 20:23:24 +02008987 Additionally, if vim is compiled with the |+termresponse| feature and
8988 |t_RV| is set to the escape sequence to request the xterm version
Bram Moolenaarf8a07122019-07-01 22:06:07 +02008989 number, more intelligent detection is done.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008990 The "xterm2" value will be set if the xterm version is reported to be
Bram Moolenaard47d5222018-12-09 20:43:55 +01008991 from 95 to 276. The "sgr" value will be set if Vim detects Mac
8992 Terminal.app, iTerm2 or mintty, and when the xterm version is 277 or
8993 higher.
Bram Moolenaare968e362014-05-13 20:23:24 +02008994 If you do not want 'ttymouse' to be set to "xterm2" or "sgr"
8995 automatically, set t_RV to an empty string: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008996 :set t_RV=
8997<
8998 *'ttyscroll'* *'tsl'*
8999'ttyscroll' 'tsl' number (default 999)
9000 global
9001 Maximum number of lines to scroll the screen. If there are more lines
9002 to scroll the window is redrawn. For terminals where scrolling is
9003 very slow and redrawing is not slow this can be set to a small number,
9004 e.g., 3, to speed up displaying.
9005
9006 *'ttytype'* *'tty'*
9007'ttytype' 'tty' string (default from $TERM)
9008 global
9009 Alias for 'term', see above.
9010
Bram Moolenaar55debbe2010-05-23 23:34:36 +02009011 *'undodir'* *'udir'*
9012'undodir' 'udir' string (default ".")
9013 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02009014 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02009015 List of directory names for undo files, separated with commas.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02009016 See |'backupdir'| for details of the format.
Bram Moolenaar6a244fe2010-05-24 22:02:24 +02009017 "." means using the directory of the file. The undo file name for
9018 "file.txt" is ".file.txt.un~".
9019 For other directories the file name is the full path of the edited
9020 file, with path separators replaced with "%".
Bram Moolenaar55debbe2010-05-23 23:34:36 +02009021 When writing: The first directory that exists is used. "." always
9022 works, no directories after "." will be used for writing.
9023 When reading all entries are tried to find an undo file. The first
9024 undo file that exists is used. When it cannot be read an error is
9025 given, no further entry is used.
9026 See |undo-persistence|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02009027 This option cannot be set from a |modeline| or in the |sandbox|, for
9028 security reasons.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02009029
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02009030 *'undofile'* *'noundofile'* *'udf'* *'noudf'*
Bram Moolenaar55debbe2010-05-23 23:34:36 +02009031'undofile' 'udf' boolean (default off)
9032 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02009033 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02009034 When on, Vim automatically saves undo history to an undo file when
9035 writing a buffer to a file, and restores undo history from the same
9036 file on buffer read.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02009037 The directory where the undo file is stored is specified by 'undodir'.
9038 For more information about this feature see |undo-persistence|.
Bram Moolenaar59f931e2010-07-24 20:27:03 +02009039 The undo file is not read when 'undoreload' causes the buffer from
9040 before a reload to be saved for undo.
Bram Moolenaar97d62492012-11-15 21:28:22 +01009041 When 'undofile' is turned off the undo file is NOT deleted.
Bram Moolenaar036986f2017-03-16 17:41:02 +01009042 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02009043
Bram Moolenaar071d4272004-06-13 20:20:40 +00009044 *'undolevels'* *'ul'*
Bram Moolenaar8024f932020-01-14 19:29:13 +01009045'undolevels' 'ul' number (default 100, 1000 for Unix, VMS and Win32)
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01009046 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00009047 Maximum number of changes that can be undone. Since undo information
Bram Moolenaar5be4cee2019-09-27 19:34:08 +02009048 is kept in memory, higher numbers will cause more memory to be used.
9049 Nevertheless, a single change can already use a large amount of memory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009050 Set to 0 for Vi compatibility: One level of undo and "u" undoes
9051 itself: >
9052 set ul=0
9053< But you can also get Vi compatibility by including the 'u' flag in
9054 'cpoptions', and still be able to use CTRL-R to repeat undo.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02009055 Also see |undo-two-ways|.
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01009056 Set to -1 for no undo at all. You might want to do this only for the
9057 current buffer: >
9058 setlocal ul=-1
Bram Moolenaar071d4272004-06-13 20:20:40 +00009059< This helps when you run out of memory for a single change.
Bram Moolenaar32efaf62014-11-05 17:02:17 +01009060
9061 The local value is set to -123456 when the global value is to be used.
9062
Bram Moolenaar945e2db2010-06-05 17:43:32 +02009063 Also see |clear-undo|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009064
Bram Moolenaar59f931e2010-07-24 20:27:03 +02009065 *'undoreload'* *'ur'*
9066'undoreload' 'ur' number (default 10000)
9067 global
Bram Moolenaar59f931e2010-07-24 20:27:03 +02009068 Save the whole buffer for undo when reloading it. This applies to the
9069 ":e!" command and reloading for when the buffer changed outside of
9070 Vim. |FileChangedShell|
Bram Moolenaar24a98a02017-09-27 22:23:55 +02009071 The save only happens when this option is negative or when the number
Bram Moolenaar59f931e2010-07-24 20:27:03 +02009072 of lines is smaller than the value of this option.
9073 Set this option to zero to disable undo for a reload.
9074
9075 When saving undo for a reload, any undo file is not read.
9076
9077 Note that this causes the whole buffer to be stored in memory. Set
9078 this option to a lower value if you run out of memory.
9079
Bram Moolenaar071d4272004-06-13 20:20:40 +00009080 *'updatecount'* *'uc'*
9081'updatecount' 'uc' number (default: 200)
9082 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009083 After typing this many characters the swap file will be written to
9084 disk. When zero, no swap file will be created at all (see chapter on
9085 recovery |crash-recovery|). 'updatecount' is set to zero by starting
9086 Vim with the "-n" option, see |startup|. When editing in readonly
9087 mode this option will be initialized to 10000.
9088 The swapfile can be disabled per buffer with |'swapfile'|.
9089 When 'updatecount' is set from zero to non-zero, swap files are
9090 created for all buffers that have 'swapfile' set. When 'updatecount'
9091 is set to zero, existing swap files are not deleted.
9092 Also see |'swapsync'|.
9093 This option has no meaning in buffers where |'buftype'| is "nofile"
9094 or "nowrite".
9095
9096 *'updatetime'* *'ut'*
9097'updatetime' 'ut' number (default 4000)
9098 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009099 If this many milliseconds nothing is typed the swap file will be
9100 written to disk (see |crash-recovery|). Also used for the
9101 |CursorHold| autocommand event.
9102
Bram Moolenaar04958cb2018-06-23 19:23:02 +02009103 *'varsofttabstop'* *'vsts'*
9104'varsofttabstop' 'vsts' string (default "")
9105 local to buffer
9106 {only available when compiled with the |+vartabs|
9107 feature}
Bram Moolenaar04958cb2018-06-23 19:23:02 +02009108 A list of the number of spaces that a <Tab> counts for while editing,
9109 such as inserting a <Tab> or using <BS>. It "feels" like variable-
9110 width <Tab>s are being inserted, while in fact a mixture of spaces
9111 and <Tab>s is used. Tab widths are separated with commas, with the
9112 final value applying to all subsequent tabs.
9113
9114 For example, when editing assembly language files where statements
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02009115 start in the 9th column and comments in the 41st, it may be useful
Bram Moolenaar04958cb2018-06-23 19:23:02 +02009116 to use the following: >
9117 :set varsofttabstop=8,32,8
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02009118< This will set soft tabstops with 8 and 8 + 32 spaces, and 8 more
9119 for every column thereafter.
Bram Moolenaar04958cb2018-06-23 19:23:02 +02009120
9121 Note that the value of |'softtabstop'| will be ignored while
9122 'varsofttabstop' is set.
9123
9124 *'vartabstop'* *'vts'*
9125'vartabstop' 'vts' string (default "")
9126 local to buffer
9127 {only available when compiled with the |+vartabs|
9128 feature}
Bram Moolenaar04958cb2018-06-23 19:23:02 +02009129 A list of the number of spaces that a <Tab> in the file counts for,
9130 separated by commas. Each value corresponds to one tab, with the
9131 final value applying to all subsequent tabs. For example: >
9132 :set vartabstop=4,20,10,8
9133< This will make the first tab 4 spaces wide, the second 20 spaces,
9134 the third 10 spaces, and all following tabs 8 spaces.
9135
9136 Note that the value of |'tabstop'| will be ignored while 'vartabstop'
9137 is set.
9138
Bram Moolenaar071d4272004-06-13 20:20:40 +00009139 *'verbose'* *'vbs'*
9140'verbose' 'vbs' number (default 0)
9141 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009142 When bigger than zero, Vim will give messages about what it is doing.
9143 Currently, these messages are given:
9144 >= 1 When the viminfo file is read or written.
9145 >= 2 When a file is ":source"'ed.
Bram Moolenaar647a5302020-05-03 17:01:24 +02009146 >= 4 Shell commands.
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00009147 >= 5 Every searched tags file and include file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009148 >= 8 Files for which a group of autocommands is executed.
9149 >= 9 Every executed autocommand.
Bram Moolenaar647a5302020-05-03 17:01:24 +02009150 >= 11 Finding items in a path
Bram Moolenaar071d4272004-06-13 20:20:40 +00009151 >= 12 Every executed function.
9152 >= 13 When an exception is thrown, caught, finished, or discarded.
9153 >= 14 Anything pending in a ":finally" clause.
Bram Moolenaar823654b2020-05-29 23:03:09 +02009154 >= 15 Every executed Ex command from a script (truncated at 200
9155 characters).
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02009156 >= 16 Every executed Ex command.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009157
9158 This option can also be set with the "-V" argument. See |-V|.
9159 This option is also set by the |:verbose| command.
9160
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00009161 When the 'verbosefile' option is set then the verbose messages are not
9162 displayed.
9163
9164 *'verbosefile'* *'vfile'*
9165'verbosefile' 'vfile' string (default empty)
9166 global
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00009167 When not empty all messages are written in a file with this name.
9168 When the file exists messages are appended.
9169 Writing to the file ends when Vim exits or when 'verbosefile' is made
Bram Moolenaar80794b12010-06-13 05:20:42 +02009170 empty. Writes are buffered, thus may not show up for some time.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00009171 Setting 'verbosefile' to a new value is like making it empty first.
9172 The difference with |:redir| is that verbose messages are not
9173 displayed when 'verbosefile' is set.
dkearns8ebdbc92023-10-29 06:26:19 +11009174 This option cannot be set from a |modeline| or in the |sandbox|, for
9175 security reasons.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00009176
Bram Moolenaar071d4272004-06-13 20:20:40 +00009177 *'viewdir'* *'vdir'*
h_east59858792023-10-25 22:47:05 +09009178'viewdir' 'vdir' string (default for Amiga: "home:vimfiles/view",
Bram Moolenaar801961d2023-06-23 16:15:13 +01009179 for Win32: "$HOME/vimfiles/view",
Christian Brabandtc3e6e392024-05-04 09:48:15 +02009180 for Unix: "$HOME/.vim/view" or
9181 "$XDG_CONFIG_HOME/vim/view"
Bram Moolenaar801961d2023-06-23 16:15:13 +01009182 for VMS: "sys$login:vimfiles/view")
Bram Moolenaar071d4272004-06-13 20:20:40 +00009183 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02009184 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00009185 feature}
9186 Name of the directory where to store files for |:mkview|.
Christian Brabandtc3e6e392024-05-04 09:48:15 +02009187 For $XDG_CONFIG_HOME see |xdg-base-dir|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009188 This option cannot be set from a |modeline| or in the |sandbox|, for
9189 security reasons.
9190
9191 *'viewoptions'* *'vop'*
Bram Moolenaar13e90412017-11-11 18:16:48 +01009192'viewoptions' 'vop' string (default: "folds,options,cursor,curdir")
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}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01009196 Changes the effect of the |:mkview| command. It is a comma-separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009197 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00009198 word save and restore ~
9199 cursor cursor position in file and in window
9200 folds manually created folds, opened/closed folds and local
9201 fold options
9202 options options and mappings local to a window or buffer (not
9203 global values for local options)
Bram Moolenaar6e932462014-09-09 18:48:09 +02009204 localoptions same as "options"
Bram Moolenaar071d4272004-06-13 20:20:40 +00009205 slash backslashes in file names replaced with forward
9206 slashes
9207 unix with Unix end-of-line format (single <NL>), even when
Bram Moolenaar6f345a12019-12-17 21:27:18 +01009208 on MS-Windows
Bram Moolenaar13e90412017-11-11 18:16:48 +01009209 curdir the window-local directory, if set with `:lcd`
Bram Moolenaar071d4272004-06-13 20:20:40 +00009210
Bram Moolenaar6f345a12019-12-17 21:27:18 +01009211 "slash" and "unix" are useful on MS-Windows when sharing view files
Bram Moolenaar071d4272004-06-13 20:20:40 +00009212 with Unix. The Unix version of Vim cannot source dos format scripts,
Bram Moolenaar6f345a12019-12-17 21:27:18 +01009213 but the MS-Windows version of Vim can source unix format scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009214
9215 *'viminfo'* *'vi'* *E526* *E527* *E528*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01009216'viminfo' 'vi' string (Vi default: "", Vim default for
9217 MS-Windows: '100,<50,s10,h,rA:,rB:,
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01009218 for Amiga: '100,<50,s10,h,rdf0:,rdf1:,rdf2:
9219 for others: '100,<50,s10,h)
Bram Moolenaar071d4272004-06-13 20:20:40 +00009220 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02009221 {not available when compiled without the |+viminfo|
Bram Moolenaar071d4272004-06-13 20:20:40 +00009222 feature}
9223 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarc4da1132017-07-15 19:39:43 +02009224 when exiting Vim (see |viminfo-file|). Except when 'viminfofile' is
9225 "NONE".
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01009226 The string should be a comma-separated list of parameters, each
Bram Moolenaarc4da1132017-07-15 19:39:43 +02009227 consisting of a single character identifying the particular parameter,
9228 followed by a number or string which specifies the value of that
9229 parameter. If a particular character is left out, then the default
9230 value is used for that parameter. The following is a list of the
9231 identifying characters and the effect of their value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009232 CHAR VALUE ~
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009233 *viminfo-!*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009234 ! When included, save and restore global variables that start
9235 with an uppercase letter, and don't contain a lowercase
9236 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar680eeca2010-10-20 17:44:42 +02009237 and "_K_L_M" are not. Nested List and Dict items may not be
Bram Moolenaar166af9b2010-11-16 20:34:40 +01009238 read back correctly, you end up with an empty item.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009239 *viminfo-quote*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009240 " Maximum number of lines saved for each register. Old name of
9241 the '<' item, with the disadvantage that you need to put a
9242 backslash before the ", otherwise it will be recognized as the
9243 start of a comment!
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009244 *viminfo-%*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009245 % When included, save and restore the buffer list. If Vim is
9246 started with a file name argument, the buffer list is not
9247 restored. If Vim is started without a file name argument, the
Bram Moolenaard042dc82015-11-24 19:18:36 +01009248 buffer list is restored from the viminfo file. Quickfix
9249 ('buftype'), unlisted ('buflisted'), unnamed and buffers on
9250 removable media (|viminfo-r|) are not saved.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00009251 When followed by a number, the number specifies the maximum
9252 number of buffers that are stored. Without a number all
9253 buffers are stored.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009254 *viminfo-'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009255 ' Maximum number of previously edited files for which the marks
9256 are remembered. This parameter must always be included when
9257 'viminfo' is non-empty.
9258 Including this item also means that the |jumplist| and the
9259 |changelist| are stored in the viminfo file.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009260 *viminfo-/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009261 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009262 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00009263 patterns are also saved. When not included, the value of
9264 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009265 *viminfo-:*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009266 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009267 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009268 *viminfo-<*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009269 < Maximum number of lines saved for each register. If zero then
9270 registers are not saved. When not included, all lines are
9271 saved. '"' is the old name for this item.
9272 Also see the 's' item below: limit specified in Kbyte.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009273 *viminfo-@*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009274 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009275 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009276 *viminfo-c*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009277 c When included, convert the text in the viminfo file from the
9278 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00009279 'encoding'. See |viminfo-encoding|.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009280 *viminfo-f*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009281 f Whether file marks need to be stored. If zero, file marks ('0
9282 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009283 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00009284 cursor position (when exiting or when doing ":wviminfo").
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009285 *viminfo-h*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009286 h Disable the effect of 'hlsearch' when loading the viminfo
9287 file. When not included, it depends on whether ":nohlsearch"
9288 has been used since the last search command.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009289 *viminfo-n*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009290 n Name of the viminfo file. The name must immediately follow
Bram Moolenaarc4da1132017-07-15 19:39:43 +02009291 the 'n'. Must be at the end of the option! If the
9292 'viminfofile' option is set, that file name overrides the one
9293 given here with 'viminfo'. Environment variables are
Bram Moolenaar063b9d12016-07-09 20:21:48 +02009294 expanded when opening the file, not when setting the option.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009295 *viminfo-r*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009296 r Removable media. The argument is a string (up to the next
9297 ','). This parameter can be given several times. Each
9298 specifies the start of a path for which no marks will be
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01009299 stored. This is to avoid removable media. For MS-Windows you
Bram Moolenaar071d4272004-06-13 20:20:40 +00009300 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
9301 also use it for temp files, e.g., for Unix: "r/tmp". Case is
9302 ignored. Maximum length of each 'r' argument is 50
9303 characters.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01009304 *viminfo-s*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009305 s Maximum size of an item in Kbyte. If zero then registers are
9306 not saved. Currently only applies to registers. The default
9307 "s10" will exclude registers with more than 10 Kbyte of text.
9308 Also see the '<' item above: line count limit.
9309
9310 Example: >
9311 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
9312<
9313 '50 Marks will be remembered for the last 50 files you
9314 edited.
9315 <1000 Contents of registers (up to 1000 lines each) will be
9316 remembered.
9317 s100 Registers with more than 100 Kbyte text are skipped.
9318 :0 Command-line history will not be saved.
9319 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
9320 no / Since '/' is not specified, the default will be used,
9321 that is, save all of the search history, and also the
9322 previous search and substitute patterns.
9323 no % The buffer list will not be saved nor read back.
9324 no h 'hlsearch' highlighting will be restored.
9325
9326 When setting 'viminfo' from an empty value you can use |:rviminfo| to
9327 load the contents of the file, this is not done automatically.
9328
9329 This option cannot be set from a |modeline| or in the |sandbox|, for
9330 security reasons.
Bram Moolenaar036986f2017-03-16 17:41:02 +01009331 NOTE: This option is set to the Vim default value when 'compatible'
9332 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009333
Bram Moolenaarc4da1132017-07-15 19:39:43 +02009334 *'viminfofile'* *'vif'*
9335'viminfofile' 'vif' string (default: "")
9336 global
Bram Moolenaarc4da1132017-07-15 19:39:43 +02009337 {not available when compiled without the |+viminfo|
9338 feature}
9339 When non-empty, overrides the file name used for viminfo.
9340 When equal to "NONE" no viminfo file will be read or written.
9341 This option can be set with the |-i| command line flag. The |--clean|
9342 command line flag sets it to "NONE".
Bram Moolenaar110289e2019-05-23 15:38:06 +02009343 This option cannot be set from a |modeline| or in the |sandbox|, for
9344 security reasons.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02009345
Bram Moolenaar071d4272004-06-13 20:20:40 +00009346 *'virtualedit'* *'ve'*
9347'virtualedit' 've' string (default "")
Gary Johnson51ad8502021-08-03 18:33:08 +02009348 global or local to window |global-local|
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01009349 A comma-separated list of these words:
Bram Moolenaar071d4272004-06-13 20:20:40 +00009350 block Allow virtual editing in Visual block mode.
9351 insert Allow virtual editing in Insert mode.
9352 all Allow virtual editing in all modes.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00009353 onemore Allow the cursor to move just past the end of the line
Gary Johnson53ba05b2021-07-26 22:19:10 +02009354 none When used as the local value, do not allow virtual
9355 editing even when the global value is set. When used
9356 as the global value, "none" is the same as "".
9357 NONE Alternative spelling of "none".
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009358
Bram Moolenaar071d4272004-06-13 20:20:40 +00009359 Virtual editing means that the cursor can be positioned where there is
Bram Moolenaarebcbd022007-05-12 14:28:25 +00009360 no actual character. This can be halfway into a tab or beyond the end
Bram Moolenaar071d4272004-06-13 20:20:40 +00009361 of the line. Useful for selecting a rectangle in Visual mode and
9362 editing a table.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00009363 "onemore" is not the same, it will only allow moving the cursor just
9364 after the last character of the line. This makes some commands more
9365 consistent. Previously the cursor was always past the end of the line
9366 if the line was empty. But it is far from Vi compatible. It may also
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009367 break some plugins or Vim scripts. For example because |l| can move
9368 the cursor after the last character. Use with care!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02009369 Using the `$` command will move to the last character in the line, not
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009370 past it. This may actually move the cursor to the left!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02009371 The `g$` command will move to the end of the screen line.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00009372 It doesn't make sense to combine "all" with "onemore", but you will
9373 not get a warning for it.
Bram Moolenaar53f7fcc2021-07-28 20:10:16 +02009374 When combined with other words, "none" is ignored.
Bram Moolenaar036986f2017-03-16 17:41:02 +01009375 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009376
9377 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
9378'visualbell' 'vb' boolean (default off)
9379 global
Bram Moolenaar74675a62017-07-15 13:53:23 +02009380 Use a visual bell instead of beeping. The terminal code to display the
Bram Moolenaar071d4272004-06-13 20:20:40 +00009381 visual bell is given with 't_vb'. When no beep or flash is wanted,
Bram Moolenaar74675a62017-07-15 13:53:23 +02009382 use: >
9383 :set vb t_vb=
9384< If you want a short flash, you can use this on many terminals: >
9385 :set vb t_vb=[?5h$<100>[?5l
9386< Here $<100> specifies the time, you can use a smaller or bigger value
9387 to get a shorter or longer flash.
9388
9389 Note: Vim will limit the bell to once per half a second. This avoids
9390 having to wait for the flashing to finish when there are lots of
9391 bells, e.g. on key repeat. This also happens without 'visualbell'
9392 set.
9393
Bram Moolenaar071d4272004-06-13 20:20:40 +00009394 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
9395 for 20 msec. If you want to use a different time, use "<Esc>|40f",
9396 where 40 is the time in msec.
Bram Moolenaar74675a62017-07-15 13:53:23 +02009397
9398 Note: When the GUI starts, 't_vb' is reset to its default value. You
9399 might want to set it again in your |gvimrc|.
9400
Bram Moolenaar071d4272004-06-13 20:20:40 +00009401 Does not work on the Amiga, you always get a screen flash.
9402 Also see 'errorbells'.
9403
9404 *'warn'* *'nowarn'*
9405'warn' boolean (default on)
9406 global
9407 Give a warning message when a shell command is used while the buffer
9408 has been changed.
9409
9410 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
9411'weirdinvert' 'wiv' boolean (default off)
9412 global
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00009413 This option has the same effect as the 't_xs' terminal option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009414 It is provided for backwards compatibility with version 4.x.
9415 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
9416 vice versa. Has no effect when the GUI is running.
9417
9418 *'whichwrap'* *'ww'*
9419'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
9420 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009421 Allow specified keys that move the cursor left/right to move to the
9422 previous/next line when the cursor is on the first/last character in
9423 the line. Concatenate characters to allow this for these keys:
9424 char key mode ~
9425 b <BS> Normal and Visual
9426 s <Space> Normal and Visual
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00009427 h "h" Normal and Visual (not recommended)
9428 l "l" Normal and Visual (not recommended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00009429 < <Left> Normal and Visual
9430 > <Right> Normal and Visual
9431 ~ "~" Normal
9432 [ <Left> Insert and Replace
9433 ] <Right> Insert and Replace
9434 For example: >
9435 :set ww=<,>,[,]
9436< allows wrap only when cursor keys are used.
9437 When the movement keys are used in combination with a delete or change
9438 operator, the <EOL> also counts for a character. This makes "3h"
9439 different from "3dh" when the cursor crosses the end of a line. This
9440 is also true for "x" and "X", because they do the same as "dl" and
9441 "dh". If you use this, you may also want to use the mapping
9442 ":map <BS> X" to make backspace delete the character in front of the
9443 cursor.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00009444 When 'l' is included and it is used after an operator at the end of a
Bram Moolenaar589edb32019-09-20 14:38:13 +02009445 line (not an empty line) then it will not move to the next line. This
9446 makes "dl", "cl", "yl" etc. work normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009447 NOTE: This option is set to the Vi default value when 'compatible' is
9448 set and to the Vim default value when 'compatible' is reset.
9449
9450 *'wildchar'* *'wc'*
9451'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
9452 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009453 Character you have to type to start wildcard expansion in the
9454 command-line, as specified with 'wildmode'.
Bram Moolenaar446cb832008-06-24 21:56:24 +00009455 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009456 The character is not recognized when used inside a macro. See
9457 'wildcharm' for that.
Bram Moolenaar34cc7d82021-09-21 20:09:51 +02009458 Some keys will not work, such as CTRL-C, <CR> and Enter.
Yee Cheng Chin8f4fb002023-10-17 10:06:56 +02009459 <Esc> can be used, but hitting it twice in a row will still exit
9460 command-line as a failsafe measure.
Millya9c6f902024-10-06 16:47:02 +02009461 Although 'wc' is a number option, it can be specified as a number, a
9462 single character, a |key-notation| (e.g. <Up>, <C-F>) or a letter
9463 preceded with a caret (e.g. `^F` is CTRL-F): >
9464 :set wc=27
9465 :set wc=X
9466 :set wc=^I
Bram Moolenaar34cc7d82021-09-21 20:09:51 +02009467 :set wc=<Tab>
Bram Moolenaar071d4272004-06-13 20:20:40 +00009468< NOTE: This option is set to the Vi default value when 'compatible' is
9469 set and to the Vim default value when 'compatible' is reset.
9470
9471 *'wildcharm'* *'wcm'*
9472'wildcharm' 'wcm' number (default: none (0))
9473 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009474 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00009475 recognized when used inside a macro. You can find "spare" command-line
9476 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00009477 you'll never actually type 'wildcharm', just use it in mappings that
9478 automatically invoke completion mode, e.g.: >
9479 :set wcm=<C-Z>
Bram Moolenaar446cb832008-06-24 21:56:24 +00009480 :cnoremap ss so $vim/sessions/*.vim<C-Z>
Bram Moolenaar071d4272004-06-13 20:20:40 +00009481< Then after typing :ss you can use CTRL-P & CTRL-N.
9482
9483 *'wildignore'* *'wig'*
9484'wildignore' 'wig' string (default "")
9485 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009486 A list of file patterns. A file that matches with one of these
Bram Moolenaar30b65812012-07-12 22:01:11 +02009487 patterns is ignored when expanding |wildcards|, completing file or
9488 directory names, and influences the result of |expand()|, |glob()| and
9489 |globpath()| unless a flag is passed to disable this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009490 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
9491 Also see 'suffixes'.
9492 Example: >
9493 :set wildignore=*.o,*.obj
9494< The use of |:set+=| and |:set-=| is preferred when adding or removing
9495 a pattern from the list. This avoids problems when a future version
9496 uses another default.
9497
h_east596a9f22023-11-21 21:24:23 +09009498 *'wildignorecase'* *'wic'* *'nowildignorecase'* *'nowic'*
Bram Moolenaar94950a92010-12-02 16:01:29 +01009499'wildignorecase' 'wic' boolean (default off)
9500 global
Bram Moolenaar94950a92010-12-02 16:01:29 +01009501 When set case is ignored when completing file names and directories.
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01009502 Has no effect when 'fileignorecase' is set.
Bram Moolenaar94950a92010-12-02 16:01:29 +01009503 Does not apply when the shell is used to expand wildcards, which
9504 happens when there are special characters.
9505
Bram Moolenaar071d4272004-06-13 20:20:40 +00009506 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
Luca Saccarola437bc132024-11-14 21:21:17 +01009507'wildmenu' 'wmnu' boolean (default on)
Bram Moolenaar071d4272004-06-13 20:20:40 +00009508 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009509 When 'wildmenu' is on, command-line completion operates in an enhanced
9510 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
Bram Moolenaar54162322022-08-26 16:58:51 +01009511 the possible matches are shown.
9512 When 'wildoptions' contains "pum", then the completion matches are
9513 shown in a popup menu. Otherwise they are displayed just above the
9514 command line, with the first match highlighted (overwriting the status
9515 line, if there is one).
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009516 Keys that show the previous/next match, such as <Tab> or
Bram Moolenaar071d4272004-06-13 20:20:40 +00009517 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
9518 When 'wildmode' is used, "wildmenu" mode is used where "full" is
9519 specified. "longest" and "list" do not start "wildmenu" mode.
Bram Moolenaar26402cb2013-02-20 21:26:00 +01009520 You can check the current mode with |wildmenumode()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009521 If there are more matches than can fit in the line, a ">" is shown on
9522 the right and/or a "<" is shown on the left. The status line scrolls
9523 as needed.
9524 The "wildmenu" mode is abandoned when a key is hit that is not used
9525 for selecting a completion.
Yee Cheng Chin2bbd0d32023-10-14 02:23:45 -07009526 While the "wildmenu" is active, the following keys have special
9527 meanings:
9528 CTRL-P - go to the previous entry
9529 CTRL-N - go to the next entry
Bram Moolenaar071d4272004-06-13 20:20:40 +00009530 <CR> - in menu completion, when the cursor is just after a
9531 dot: move into a submenu.
Yee Cheng Chin209ec902023-10-17 10:56:25 +02009532 CTRL-E - end completion, go back to what was there before
9533 selecting a match.
9534 CTRL-Y - accept the currently selected match and stop
9535 completion.
Yee Cheng Chin2bbd0d32023-10-14 02:23:45 -07009536
9537 When not using the popup menu for command line completion, the
9538 following keys have special meanings:
9539 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
Bram Moolenaar071d4272004-06-13 20:20:40 +00009540 <Up> - in filename/menu name completion: move up into
9541 parent directory or parent menu.
Yee Cheng Chin2bbd0d32023-10-14 02:23:45 -07009542 <Down> - in filename/menu name completion: move into a
9543 subdirectory or submenu.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009544
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009545 When using the popup menu for command line completion, the following
9546 keys have special meanings:
Yee Cheng Chin2bbd0d32023-10-14 02:23:45 -07009547 <Up> <Down> - select previous/next match (like CTRL-P/CTRL-N)
zeertzjq3c81f472023-10-15 16:02:08 +08009548 <PageUp> - select a match several entries back
9549 <PageDown> - select a match several entries further
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009550 <Left> - in filename/menu name completion: move up into
9551 parent directory or parent menu.
9552 <Right> - in filename/menu name completion: move into a
9553 subdirectory or submenu.
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009554
Bram Moolenaar071d4272004-06-13 20:20:40 +00009555 This makes the menus accessible from the console |console-menus|.
9556
9557 If you prefer the <Left> and <Right> keys to move the cursor instead
9558 of selecting a different match, use this: >
9559 :cnoremap <Left> <Space><BS><Left>
9560 :cnoremap <Right> <Space><BS><Right>
9561<
9562 The "WildMenu" highlighting is used for displaying the current match
9563 |hl-WildMenu|.
9564
9565 *'wildmode'* *'wim'*
9566'wildmode' 'wim' string (Vim default: "full")
9567 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009568 Completion mode that is used for the character specified with
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01009569 'wildchar'. It is a comma-separated list of up to four parts. Each
Bram Moolenaar02467872007-05-06 13:22:01 +00009570 part specifies what to do for each consecutive use of 'wildchar'. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00009571 first part specifies the behavior for the first use of 'wildchar',
9572 The second part for the second use, etc.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009573
9574 Each part consists of a colon separated list consisting of the
9575 following possible values:
Bram Moolenaar071d4272004-06-13 20:20:40 +00009576 "" Complete only the first match.
9577 "full" Complete the next full match. After the last match,
9578 the original string is used and then the first match
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009579 again. Will also start 'wildmenu' if it is enabled.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009580 "longest" Complete till longest common string. If this doesn't
9581 result in a longer string, use the next part.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009582 "list" When more than one match, list all matches.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009583 "lastused" When completing buffer names and more than one buffer
9584 matches, sort buffers by time last used (other than
9585 the current buffer).
Girish Palya2bacc3e2025-03-02 22:55:57 +01009586 "noselect" Do not pre-select first menu item and start 'wildmenu'
9587 if it is enabled.
9588 When there is only a single match, it is fully completed in all cases
9589 except when "noselect" is present.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009590
9591 Examples of useful colon-separated values:
9592 "longest:full" Like "longest", but also start 'wildmenu' if it is
9593 enabled. Will not complete to the next full match.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009594 "list:full" When more than one match, list all matches and
9595 complete first match.
9596 "list:longest" When more than one match, list all matches and
9597 complete till longest common string.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009598 "list:lastused" When more than one buffer matches, list all matches
9599 and sort buffers by time last used (other than the
9600 current buffer).
Bram Moolenaar071d4272004-06-13 20:20:40 +00009601
9602 Examples: >
9603 :set wildmode=full
Bram Moolenaar582fd852005-03-28 20:58:01 +00009604< Complete first full match, next match, etc. (the default) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00009605 :set wildmode=longest,full
9606< Complete longest common string, then each full match >
9607 :set wildmode=list:full
9608< List all matches and complete each full match >
9609 :set wildmode=list,full
9610< List all matches without completing, then each full match >
9611 :set wildmode=longest,list
Girish Palya2bacc3e2025-03-02 22:55:57 +01009612< Complete longest common string, then list alternatives >
9613 :set wildmode=noselect:full
9614< Display 'wildmenu' without completing, then each full match >
9615 :set wildmode=noselect:lastused,full
9616< Same as above, but sort buffers by time last used.
Bram Moolenaar446cb832008-06-24 21:56:24 +00009617 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009618
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009619 *'wildoptions'* *'wop'*
9620'wildoptions' 'wop' string (default "")
9621 global
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009622 A list of words that change how |cmdline-completion| is done.
9623 The following values are supported:
Bram Moolenaar1588bc82022-03-08 21:35:07 +00009624 fuzzy Use |fuzzy-matching| to find completion matches. When
Yegappan Lakshmanan38b85cb2022-02-24 13:28:41 +00009625 this value is specified, wildcard expansion will not
9626 be used for completion. The matches will be sorted by
9627 the "best match" rather than alphabetically sorted.
9628 This will find more matches than the wildcard
9629 expansion. Currently fuzzy matching based completion
9630 is not supported for file and directory names and
9631 instead wildcard expansion is used.
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01009632 pum Display the completion matches using the popup menu
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009633 in the same style as the |ins-completion-menu|.
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009634 tagfile When using CTRL-D to list matching tags, the kind of
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00009635 tag and the file of the tag is listed. Only one match
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009636 is displayed per line. Often used tag kinds are:
9637 d #define
9638 f function
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009639
Bram Moolenaar071d4272004-06-13 20:20:40 +00009640 *'winaltkeys'* *'wak'*
9641'winaltkeys' 'wak' string (default "menu")
9642 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009643 {only used in Win32, Motif, GTK and Photon GUI}
9644 Some GUI versions allow the access to menu entries by using the ALT
9645 key in combination with a character that appears underlined in the
9646 menu. This conflicts with the use of the ALT key for mappings and
9647 entering special characters. This option tells what to do:
9648 no Don't use ALT keys for menus. ALT key combinations can be
9649 mapped, but there is no automatic handling. This can then be
9650 done with the |:simalt| command.
9651 yes ALT key handling is done by the windowing system. ALT key
9652 combinations cannot be mapped.
9653 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009654 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00009655 keys can be mapped.
9656 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
9657 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00009658 This option is not used for <F10>; on Win32 and with GTK <F10> will
9659 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009660
Bram Moolenaar4d784b22019-05-25 19:51:39 +02009661 *'wincolor'* *'wcr'*
9662'wincolor' 'wcr' string (default empty)
9663 local to window
9664 Highlight group name to use for this window instead of the Normal
9665 color |hl-Normal|.
9666
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009667 *'window'* *'wi'*
9668'window' 'wi' number (default screen height - 1)
9669 global
Bram Moolenaardad44732021-03-31 20:07:33 +02009670 Window height used for |CTRL-F| and |CTRL-B| when there is only one
9671 window and the value is smaller than 'lines' minus one. The screen
9672 will scroll 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009673 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
9674 in a much smarter way, taking care of wrapping lines.
Luuk van Baal5a2e3ec2024-03-28 10:07:29 +01009675 When resizing the Vim window, and the value is smaller than 1 or more
9676 than or equal to 'lines' it will be set to 'lines' minus 1.
Bram Moolenaardad44732021-03-31 20:07:33 +02009677 Note: Do not confuse this with the height of the Vim window, use
9678 'lines' for that.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009679
Colin Kennedy21570352024-03-03 16:16:47 +01009680 *'winfixbuf'*
9681'winfixbuf' 'wfb' boolean (default off)
9682 local to window
zeertzjq0049a492024-03-11 23:13:16 +08009683 If enabled, the window and the buffer it is displaying are paired.
Colin Kennedy21570352024-03-03 16:16:47 +01009684 For example, attempting to change the buffer with |:edit| will fail.
9685 Other commands which change a window's buffer such as |:cnext| will
zeertzjq0049a492024-03-11 23:13:16 +08009686 also skip any window with 'winfixbuf' enabled. However if an Ex
9687 command has a "!" modifier, it can force switching buffers.
Colin Kennedy21570352024-03-03 16:16:47 +01009688
laburnumT3f7855a2023-12-05 18:37:03 +01009689 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
9690'winfixheight' 'wfh' boolean (default off)
9691 local to window |local-noglobal|
9692 Keep the window height when windows are opened or closed and
9693 'equalalways' is set. Also for |CTRL-W_=|. Set by default for the
9694 |preview-window| and |quickfix-window|.
9695 The height may be changed anyway when running out of room.
9696
9697 *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'*
9698'winfixwidth' 'wfw' boolean (default off)
9699 local to window |local-noglobal|
9700 Keep the window width when windows are opened or closed and
9701 'equalalways' is set. Also for |CTRL-W_=|.
9702 The width may be changed anyway when running out of room.
9703
Bram Moolenaar071d4272004-06-13 20:20:40 +00009704 *'winheight'* *'wh'* *E591*
9705'winheight' 'wh' number (default 1)
9706 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009707 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009708 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar446cb832008-06-24 21:56:24 +00009709 focus goes to a window that is smaller, its size is increased, at the
9710 cost of the height of other windows.
9711 Set 'winheight' to a small number for normal editing.
9712 Set it to 999 to make the current window fill most of the screen.
9713 Other windows will be only 'winminheight' high. This has the drawback
9714 that ":all" will create only two windows. To avoid "vim -o 1 2 3 4"
9715 to create only two windows, set the option after startup is done,
9716 using the |VimEnter| event: >
9717 au VimEnter * set winheight=999
9718< Minimum value is 1.
9719 The height is not adjusted after one of the commands that change the
Bram Moolenaar071d4272004-06-13 20:20:40 +00009720 height of the current window.
9721 'winheight' applies to the current window. Use 'winminheight' to set
9722 the minimal height for other windows.
9723
Bram Moolenaar071d4272004-06-13 20:20:40 +00009724 *'winminheight'* *'wmh'*
9725'winminheight' 'wmh' number (default 1)
9726 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009727 The minimal height of a window, when it's not the current window.
9728 This is a hard minimum, windows will never become smaller.
9729 When set to zero, windows may be "squashed" to zero lines (i.e. just a
9730 status bar) if necessary. They will return to at least one line when
9731 they become active (since the cursor has to have somewhere to go.)
9732 Use 'winheight' to set the minimal height of the current window.
9733 This option is only checked when making a window smaller. Don't use a
9734 large number, it will cause errors when opening more than a few
9735 windows. A value of 0 to 3 is reasonable.
9736
9737 *'winminwidth'* *'wmw'*
9738'winminwidth' 'wmw' number (default 1)
9739 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009740 The minimal width of a window, when it's not the current window.
9741 This is a hard minimum, windows will never become smaller.
9742 When set to zero, windows may be "squashed" to zero columns (i.e. just
9743 a vertical separator) if necessary. They will return to at least one
9744 line when they become active (since the cursor has to have somewhere
9745 to go.)
9746 Use 'winwidth' to set the minimal width of the current window.
9747 This option is only checked when making a window smaller. Don't use a
9748 large number, it will cause errors when opening more than a few
9749 windows. A value of 0 to 12 is reasonable.
9750
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009751 *'winptydll'*
9752'winptydll' string (default "winpty32.dll" or "winpty64.dll")
9753 global
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009754 {only available when compiled with the |terminal|
9755 feature on MS-Windows}
9756 Specifies the name of the winpty shared library, used for the
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02009757 |:terminal| command. The default depends on whether Vim was built as a
Bram Moolenaarc572da52017-08-27 16:52:01 +02009758 32-bit or 64-bit executable. If not found, "winpty.dll" is tried as
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009759 a fallback.
9760 Environment variables are expanded |:set_env|.
9761 This option cannot be set from a |modeline| or in the |sandbox|, for
9762 security reasons.
9763
Bram Moolenaar071d4272004-06-13 20:20:40 +00009764 *'winwidth'* *'wiw'* *E592*
9765'winwidth' 'wiw' number (default 20)
9766 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009767 Minimal number of columns for the current window. This is not a hard
9768 minimum, Vim will use fewer columns if there is not enough room. If
9769 the current window is smaller, its size is increased, at the cost of
9770 the width of other windows. Set it to 999 to make the current window
9771 always fill the screen. Set it to a small number for normal editing.
9772 The width is not adjusted after one of the commands to change the
9773 width of the current window.
9774 'winwidth' applies to the current window. Use 'winminwidth' to set
9775 the minimal width for other windows.
9776
9777 *'wrap'* *'nowrap'*
9778'wrap' boolean (default on)
9779 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00009780 This option changes how text is displayed. It doesn't change the text
9781 in the buffer, see 'textwidth' for that.
9782 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009783 displaying continues on the next line. When off lines will not wrap
9784 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00009785 moved to a part that is not shown, the screen will scroll
9786 horizontally.
9787 The line will be broken in the middle of a word if necessary. See
9788 'linebreak' to get the break at a word boundary.
9789 To make scrolling horizontally a bit more useful, try this: >
9790 :set sidescroll=5
9791 :set listchars+=precedes:<,extends:>
9792< See 'sidescroll', 'listchars' and |wrap-off|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01009793 This option can't be set from a |modeline| when the 'diff' option is
9794 on.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009795
9796 *'wrapmargin'* *'wm'*
9797'wrapmargin' 'wm' number (default 0)
9798 local to buffer
9799 Number of characters from the right window border where wrapping
9800 starts. When typing text beyond this limit, an <EOL> will be inserted
9801 and inserting continues on the next line.
9802 Options that add a margin, such as 'number' and 'foldcolumn', cause
9803 the text width to be further reduced. This is Vi compatible.
9804 When 'textwidth' is non-zero, this option is not used.
Bram Moolenaarca635012015-09-25 20:34:21 +02009805 This option is set to 0 when 'paste' is set and restored when 'paste'
9806 is reset.
Bram Moolenaara6c27c42019-05-09 19:16:22 +02009807 See also 'formatoptions' and |ins-textwidth|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009808
9809 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
9810'wrapscan' 'ws' boolean (default on) *E384* *E385*
9811 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00009812 Searches wrap around the end of the file. Also applies to |]s| and
9813 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009814
9815 *'write'* *'nowrite'*
9816'write' boolean (default on)
9817 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009818 Allows writing files. When not set, writing a file is not allowed.
9819 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009820 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00009821 argument. Filtering text is still possible, even though this requires
9822 writing a temporary file.
9823
9824 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
9825'writeany' 'wa' boolean (default off)
9826 global
9827 Allows writing to any file with no need for "!" override.
9828
9829 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
9830'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
9831 otherwise)
9832 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009833 Make a backup before overwriting a file. The backup is removed after
9834 the file was successfully written, unless the 'backup' option is
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02009835 also on.
9836 WARNING: Switching this option off means that when Vim fails to write
9837 your buffer correctly and then, for whatever reason, Vim exits, you
9838 lose both the original file and what you were writing. Only reset
9839 this option if your file system is almost full and it makes the write
9840 fail (and make sure not to exit Vim until the write was successful).
9841 See |backup-table| for another explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009842 When the 'backupskip' pattern matches, a backup is not made anyway.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01009843 Depending on 'backupcopy' the backup is a new file or the original
9844 file renamed (and a new file is written).
Bram Moolenaar071d4272004-06-13 20:20:40 +00009845 NOTE: This option is set to the default value when 'compatible' is
9846 set.
9847
9848 *'writedelay'* *'wd'*
9849'writedelay' 'wd' number (default 0)
9850 global
Bram Moolenaar802a0d92016-06-26 16:17:58 +02009851 The number of milliseconds to wait for each character sent to the
Bram Moolenaar071d4272004-06-13 20:20:40 +00009852 screen. When non-zero, characters are sent to the terminal one by
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01009853 one. For debugging purposes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009854
Bram Moolenaar6f79e612021-12-21 09:12:23 +00009855 *'xtermcodes'* *'noxtermcodes'*
9856'xtermcodes' boolean (default on)
9857 global
9858 When detecting xterm patchlevel 141 or higher with the termresponse
Bram Moolenaarfa3b7232021-12-24 13:18:38 +00009859 mechanism and this option is set, Vim will request the actual terminal
Bram Moolenaar6f79e612021-12-21 09:12:23 +00009860 key codes and number of colors from the terminal. This takes care of
9861 various configuration options of the terminal that cannot be obtained
9862 from the termlib/terminfo entry, see |xterm-codes|.
9863 A side effect may be that t_Co changes and Vim will redraw the
9864 display.
9865
9866
Bram Moolenaar91f84f62018-07-29 15:07:52 +02009867 vim:tw=78:ts=8:noet:ft=help:norl: