1
- *options.txt* For Vim version 9.1. Last change: 2025 Sep 13
1
+ *options.txt* For Vim version 9.1. Last change: 2025 Sep 14
2
2
3
3
4
4
VIM REFERENCE MANUAL by Bram Moolenaar
@@ -80,7 +80,7 @@ achieve special effects. These options come in three forms:
80
80
'0o').
81
81
The old value can be inserted by typing 'wildchar' (by
82
82
default this is a <Tab> or CTRL-E if 'compatible' is
83
- set). Many string options with fixed syntax and names
83
+ set). Many string options with fixed syntax and names
84
84
also support completing known values. See
85
85
| cmdline-completion | and | complete-set-option | .
86
86
White space between {option} and '=' is allowed and
@@ -973,7 +973,7 @@ A jump table for the options with a short description can be found at |Q_op|.
973
973
'autoshelldir' 'asd' boolean (default off)
974
974
global
975
975
When on, Vim will change the current working directory whenever you
976
- change the directory of the shell running in a terminal window. You
976
+ change the directory of the shell running in a terminal window. You
977
977
need proper setting-up, so whenever the shell's pwd changes an OSC 7
978
978
escape sequence will be emitted. For example, on Linux, you can
979
979
source /etc/profile.d/vte.sh in your shell profile if you use bash or
@@ -1232,11 +1232,11 @@ A jump table for the options with a short description can be found at |Q_op|.
1232
1232
- A directory name may end in an '/'.
1233
1233
- For Unix and Win32, if a directory ends in two path separators "//",
1234
1234
the backup file name will be built from the complete path to the
1235
- file with all path separators changed to percent '%' signs. This
1235
+ file with all path separators changed to percent '%' signs. This
1236
1236
will ensure file name uniqueness in the backup directory.
1237
1237
On Win32, it is also possible to end with "\\". However, When a
1238
1238
separating comma is following, you must use "//", since "\\" will
1239
- include the comma in the file name. Therefore it is recommended to
1239
+ include the comma in the file name. Therefore it is recommended to
1240
1240
use '//', instead of '\\'.
1241
1241
- Environment variables are expanded | :set_env | .
1242
1242
- Careful with '\' characters, type one before a space, type two to
@@ -1361,7 +1361,7 @@ A jump table for the options with a short description can be found at |Q_op|.
1361
1361
or Sun Workshop).
1362
1362
1363
1363
If the expression starts with s: or | <SID> | , then it is replaced with
1364
- the script ID (| local-function | ). Example: >
1364
+ the script ID (| local-function | ). Example: >
1365
1365
set bexpr=s:MyBalloonExpr()
1366
1366
set bexpr=<SID>SomeBalloonExpr()
1367
1367
< Otherwise, the expression is evaluated in the context of the script
@@ -1384,10 +1384,10 @@ A jump table for the options with a short description can be found at |Q_op|.
1384
1384
*'belloff'* *'bo'*
1385
1385
'belloff' 'bo' string (default "")
1386
1386
global
1387
- Specifies for which events the bell will not be rung. It is a comma
1388
- separated list of items. For each item that is present, the bell
1389
- will be silenced. This is most useful to specify specific events in
1390
- insert mode to be silenced.
1387
+ Specifies for which events the bell will not be rung. It is a comma
1388
+ separated list of items. For each item that is present, the bell will
1389
+ be silenced. This is most useful to specify specific events in insert
1390
+ mode to be silenced.
1391
1391
You can also make it flash by using 'visualbell' .
1392
1392
1393
1393
item meaning when present ~
@@ -1419,8 +1419,8 @@ A jump table for the options with a short description can be found at |Q_op|.
1419
1419
(depends on the 'wildmode' setting).
1420
1420
1421
1421
This is most useful to fine tune when in Insert mode the bell should
1422
- be rung. For Normal mode and Ex commands, the bell is often rung to
1423
- indicate that an error occurred. It can be silenced by adding the
1422
+ be rung. For Normal mode and Ex commands, the bell is often rung to
1423
+ indicate that an error occurred. It can be silenced by adding the
1424
1424
"error" keyword.
1425
1425
1426
1426
*'binary'* *'bin'* *'nobinary'* *'nobin'*
@@ -1502,11 +1502,11 @@ A jump table for the options with a short description can be found at |Q_op|.
1502
1502
local to window
1503
1503
{not available when compiled without the | +linebreak |
1504
1504
feature}
1505
- Settings for 'breakindent' . It can consist of the following optional
1505
+ Settings for 'breakindent' . It can consist of the following optional
1506
1506
items and must be separated by a comma:
1507
1507
min:{n} Minimum text width that will be kept after
1508
1508
applying 'breakindent' , even if the resulting
1509
- text should normally be narrower. This prevents
1509
+ text should normally be narrower. This prevents
1510
1510
text indented almost to the right window border
1511
1511
occupying lots of vertical space when broken.
1512
1512
(default: 20)
@@ -1525,8 +1525,8 @@ A jump table for the options with a short description can be found at |Q_op|.
1525
1525
(default: 0)
1526
1526
list:-1 Uses the width of a match with 'formatlistpat' for
1527
1527
indentation.
1528
- column:{n} Indent at column {n} . Will overrule the other
1529
- sub-options. Note: an additional indent may be
1528
+ column:{n} Indent at column {n} . Will overrule the other
1529
+ sub-options. Note: an additional indent may be
1530
1530
added for the 'showbreak' setting.
1531
1531
(default: off)
1532
1532
@@ -1736,7 +1736,7 @@ A jump table for the options with a short description can be found at |Q_op|.
1736
1736
of this.
1737
1737
1738
1738
If the 'charconvert' expression starts with s: or | <SID> | , then it is
1739
- replaced with the script ID (| local-function | ). Example: >
1739
+ replaced with the script ID (| local-function | ). Example: >
1740
1740
set charconvert=s:MyConvert()
1741
1741
set charconvert=<SID>SomeConvert()
1742
1742
< Otherwise the expression is evaluated in the context of the script
@@ -2203,7 +2203,7 @@ A jump table for the options with a short description can be found at |Q_op|.
2203
2203
with CTRL-X CTRL-U . | i_CTRL-X_CTRL-U |
2204
2204
See | complete-functions | for an explanation of how the function is
2205
2205
invoked and what it should return. The value can be the name of a
2206
- function, a | lambda | or a | Funcref | . See | option-value-function | for
2206
+ function, a | lambda | or a | Funcref | . See | option-value-function | for
2207
2207
more information.
2208
2208
This option cannot be set from a | modeline | or in the | sandbox | , for
2209
2209
security reasons.
@@ -2319,7 +2319,7 @@ A jump table for the options with a short description can be found at |Q_op|.
2319
2319
Only "fuzzy", "popup", "popuphidden", "preinsert" and "preview" have
2320
2320
an effect when 'autocomplete' is enabled.
2321
2321
2322
- This option does not apply to | cmdline-completion | . See 'wildoptions'
2322
+ This option does not apply to | cmdline-completion | . See 'wildoptions'
2323
2323
for that.
2324
2324
2325
2325
*'completepopup'* *'cpp'*
@@ -3235,7 +3235,7 @@ A jump table for the options with a short description can be found at |Q_op|.
3235
3235
- For Unix and Win32, if a directory ends in two path separators "//",
3236
3236
the swap file name will be built from the complete path to the file
3237
3237
with all path separators replaced by percent '%' signs (including
3238
- the colon following the drive letter on Win32). This will ensure
3238
+ the colon following the drive letter on Win32). This will ensure
3239
3239
file name uniqueness in the preserve directory.
3240
3240
On Win32, it is also possible to end with "\\". However, When a
3241
3241
separating comma is following, you must use "//", since "\\" will
@@ -4156,7 +4156,7 @@ A jump table for the options with a short description can be found at |Q_op|.
4156
4156
the internal format mechanism.
4157
4157
4158
4158
If the expression starts with s: or | <SID> | , then it is replaced with
4159
- the script ID (| local-function | ). Example: >
4159
+ the script ID (| local-function | ). Example: >
4160
4160
set formatexpr=s:MyFormatExpr()
4161
4161
set formatexpr=<SID>SomeFormatExpr()
4162
4162
< Otherwise, the expression is evaluated in the context of the script
@@ -4854,8 +4854,8 @@ A jump table for the options with a short description can be found at |Q_op|.
4854
4854
global
4855
4855
This option specifies a function that will be called to
4856
4856
activate or deactivate the Input Method. The value can be the name of
4857
- a function, a | lambda | or a | Funcref | . See | option-value-function | for
4858
- more information.
4857
+ a function, a | lambda | or a | Funcref | . See | option-value-function |
4858
+ for more information.
4859
4859
It is not used in the MS-Windows GUI version.
4860
4860
The expression will be evaluated in the | sandbox | when set from a
4861
4861
modeline, see | sandbox-option | .
@@ -5034,7 +5034,7 @@ A jump table for the options with a short description can be found at |Q_op|.
5034
5034
Note: Not used for | <cfile> | .
5035
5035
5036
5036
If the expression starts with s: or | <SID> | , then it is replaced with
5037
- the script ID (| local-function | ). Example: >
5037
+ the script ID (| local-function | ). Example: >
5038
5038
setlocal includeexpr=s:MyIncludeExpr()
5039
5039
setlocal includeexpr=<SID>SomeIncludeExpr()
5040
5040
< Otherwise, the expression is evaluated in the context of the script
@@ -5118,7 +5118,7 @@ A jump table for the options with a short description can be found at |Q_op|.
5118
5118
when the expression is evaluated (but it may be moved around).
5119
5119
5120
5120
If the expression starts with s: or | <SID> | , then it is replaced with
5121
- the script ID (| local-function | ). Example: >
5121
+ the script ID (| local-function | ). Example: >
5122
5122
set indentexpr=s:MyIndentExpr()
5123
5123
set indentexpr=<SID>SomeIndentExpr()
5124
5124
< Otherwise, the expression is evaluated in the context of the script
@@ -6416,7 +6416,7 @@ A jump table for the options with a short description can be found at |Q_op|.
6416
6416
fit the highest line number in the buffer respectively the number of
6417
6417
rows in the window, depending on whether 'number' or 'relativenumber'
6418
6418
is set. Thus with the Vim default of 4 there is room for a line
6419
- number up to 999. When the buffer has 1000 lines five columns will be
6419
+ number up to 999. When the buffer has 1000 lines five columns will be
6420
6420
used. The minimum value is 1, the maximum value is 20.
6421
6421
NOTE: This option is set to the Vi default value when 'compatible' is
6422
6422
set and to the Vim default value when 'compatible' is reset.
@@ -6430,7 +6430,7 @@ A jump table for the options with a short description can be found at |Q_op|.
6430
6430
completion with CTRL-X CTRL-O . | i_CTRL-X_CTRL-O |
6431
6431
See | complete-functions | for an explanation of how the function is
6432
6432
invoked and what it should return. The value can be the name of a
6433
- function, a | lambda | or a | Funcref | . See | option-value-function | for
6433
+ function, a | lambda | or a | Funcref | . See | option-value-function | for
6434
6434
more information.
6435
6435
This option is usually set by a filetype plugin:
6436
6436
| :filetype-plugin-on |
@@ -6452,7 +6452,7 @@ A jump table for the options with a short description can be found at |Q_op|.
6452
6452
global
6453
6453
This option specifies a function to be called by the | g@ | operator.
6454
6454
See | :map-operator | for more info and an example. The value can be
6455
- the name of a function, a | lambda | or a | Funcref | . See
6455
+ the name of a function, a | lambda | or a | Funcref | . See
6456
6456
| option-value-function | for more information.
6457
6457
6458
6458
This option cannot be set from a | modeline | or in the | sandbox | , for
@@ -6851,8 +6851,8 @@ A jump table for the options with a short description can be found at |Q_op|.
6851
6851
Available values are 0, 2 and 3.
6852
6852
If 'pyxversion' is 0, it is set to 2 or 3 after the first execution of
6853
6853
any python2/3 commands or functions. E.g. `:py ` sets to 2, and `:py3 `
6854
- sets to 3. `:pyx ` sets it to 3 if Python 3 is available, otherwise sets
6855
- to 2 if Python 2 is available.
6854
+ sets to 3. `:pyx ` sets it to 3 if Python 3 is available, otherwise
6855
+ sets to 2 if Python 2 is available.
6856
6856
See also: | has-pythonx |
6857
6857
6858
6858
If Vim is compiled with only | +python | or | +python3 | setting
@@ -6873,7 +6873,7 @@ A jump table for the options with a short description can be found at |Q_op|.
6873
6873
for each entry in the corresponding quickfix or location list. See
6874
6874
| quickfix-window-function | for an explanation of how to write the
6875
6875
function and an example. The value can be the name of a function, a
6876
- | lambda | or a | Funcref | . See | option-value-function | for more
6876
+ | lambda | or a | Funcref | . See | option-value-function | for more
6877
6877
information.
6878
6878
6879
6879
This option cannot be set from a | modeline | or in the | sandbox | , for
@@ -7760,7 +7760,7 @@ A jump table for the options with a short description can be found at |Q_op|.
7760
7760
`:silent ` was used for the command; note that this also
7761
7761
affects messages from autocommands and 'autoread' reloading
7762
7762
S do not show search count message when searching, e.g. *shm-S*
7763
- "[1/5]". When the "S" flag is not present (e.g. search count
7763
+ "[1/5]". When the "S" flag is not present (e.g. search count
7764
7764
is shown), the "search hit BOTTOM, continuing at TOP" and
7765
7765
"search hit TOP, continuing at BOTTOM" messages are only
7766
7766
indicated by a "W" (Mnemonic: Wrapped) letter before the
@@ -8186,7 +8186,7 @@ A jump table for the options with a short description can be found at |Q_op|.
8186
8186
8187
8187
timeout:{millisec} Limit the time searching for suggestions to
8188
8188
{millisec} milliseconds. Applies to the following
8189
- methods. When omitted the limit is 5000. When
8189
+ methods. When omitted the limit is 5000. When
8190
8190
negative there is no limit. {only works when built
8191
8191
with the | +reltime | feature}
8192
8192
@@ -8780,7 +8780,7 @@ A jump table for the options with a short description can be found at |Q_op|.
8780
8780
The function gets the tag pattern and should return a List of matching
8781
8781
tags. See | tag-function | for an explanation of how to write the
8782
8782
function and an example. The value can be the name of a function, a
8783
- | lambda | or a | Funcref | . See | option-value-function | for more
8783
+ | lambda | or a | Funcref | . See | option-value-function | for more
8784
8784
information.
8785
8785
This option cannot be set from a | modeline | or in the | sandbox | , for
8786
8786
security reasons.
@@ -9606,7 +9606,7 @@ A jump table for the options with a short description can be found at |Q_op|.
9606
9606
{not available when compiled without the | +viminfo |
9607
9607
feature}
9608
9608
When non-empty, the viminfo file is read upon startup and written
9609
- when exiting Vim (see | viminfo-file | ). Except when 'viminfofile' is
9609
+ when exiting Vim (see | viminfo-file | ). Except when 'viminfofile' is
9610
9610
"NONE".
9611
9611
The string should be a comma-separated list of parameters, each
9612
9612
consisting of a single character identifying the particular parameter,
@@ -10050,7 +10050,7 @@ A jump table for the options with a short description can be found at |Q_op|.
10050
10050
d #define
10051
10051
f function
10052
10052
10053
- This option does not apply to | ins-completion | . See 'completeopt' for
10053
+ This option does not apply to | ins-completion | . See 'completeopt' for
10054
10054
that.
10055
10055
10056
10056
*'winaltkeys'* *'wak'*
0 commit comments