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
22
33
44 VIM REFERENCE MANUAL by Bram Moolenaar
@@ -80,7 +80,7 @@ achieve special effects. These options come in three forms:
8080 '0o').
8181 The old value can be inserted by typing 'wildchar' (by
8282 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
8484 also support completing known values. See
8585 | cmdline-completion | and | complete-set-option | .
8686 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|.
973973'autoshelldir' 'asd' boolean (default off)
974974 global
975975 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
977977 need proper setting-up, so whenever the shell's pwd changes an OSC 7
978978 escape sequence will be emitted. For example, on Linux, you can
979979 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|.
12321232 - A directory name may end in an '/'.
12331233 - For Unix and Win32, if a directory ends in two path separators "//",
12341234 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
12361236 will ensure file name uniqueness in the backup directory.
12371237 On Win32, it is also possible to end with "\\". However, When a
12381238 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
12401240 use '//', instead of '\\'.
12411241 - Environment variables are expanded | :set_env | .
12421242 - 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|.
13611361 or Sun Workshop).
13621362
13631363 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: >
13651365 set bexpr=s:MyBalloonExpr()
13661366 set bexpr=<SID>SomeBalloonExpr()
13671367< 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|.
13841384 *'belloff'* *'bo'*
13851385'belloff' 'bo' string (default "")
13861386 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.
13911391 You can also make it flash by using 'visualbell' .
13921392
13931393 item meaning when present ~
@@ -1419,8 +1419,8 @@ A jump table for the options with a short description can be found at |Q_op|.
14191419 (depends on the 'wildmode' setting).
14201420
14211421 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
14241424 "error" keyword.
14251425
14261426 *'binary'* *'bin'* *'nobinary'* *'nobin'*
@@ -1502,11 +1502,11 @@ A jump table for the options with a short description can be found at |Q_op|.
15021502 local to window
15031503 {not available when compiled without the | +linebreak |
15041504 feature}
1505- Settings for 'breakindent' . It can consist of the following optional
1505+ Settings for 'breakindent' . It can consist of the following optional
15061506 items and must be separated by a comma:
15071507 min:{n} Minimum text width that will be kept after
15081508 applying 'breakindent' , even if the resulting
1509- text should normally be narrower. This prevents
1509+ text should normally be narrower. This prevents
15101510 text indented almost to the right window border
15111511 occupying lots of vertical space when broken.
15121512 (default: 20)
@@ -1525,8 +1525,8 @@ A jump table for the options with a short description can be found at |Q_op|.
15251525 (default: 0)
15261526 list:-1 Uses the width of a match with 'formatlistpat' for
15271527 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
15301530 added for the 'showbreak' setting.
15311531 (default: off)
15321532
@@ -1736,7 +1736,7 @@ A jump table for the options with a short description can be found at |Q_op|.
17361736 of this.
17371737
17381738 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: >
17401740 set charconvert=s:MyConvert()
17411741 set charconvert=<SID>SomeConvert()
17421742< 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|.
22032203 with CTRL-X CTRL-U . | i_CTRL-X_CTRL-U |
22042204 See | complete-functions | for an explanation of how the function is
22052205 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
22072207 more information.
22082208 This option cannot be set from a | modeline | or in the | sandbox | , for
22092209 security reasons.
@@ -2319,7 +2319,7 @@ A jump table for the options with a short description can be found at |Q_op|.
23192319 Only "fuzzy", "popup", "popuphidden", "preinsert" and "preview" have
23202320 an effect when 'autocomplete' is enabled.
23212321
2322- This option does not apply to | cmdline-completion | . See 'wildoptions'
2322+ This option does not apply to | cmdline-completion | . See 'wildoptions'
23232323 for that.
23242324
23252325 *'completepopup'* *'cpp'*
@@ -3235,7 +3235,7 @@ A jump table for the options with a short description can be found at |Q_op|.
32353235 - For Unix and Win32, if a directory ends in two path separators "//",
32363236 the swap file name will be built from the complete path to the file
32373237 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
32393239 file name uniqueness in the preserve directory.
32403240 On Win32, it is also possible to end with "\\". However, When a
32413241 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|.
41564156 the internal format mechanism.
41574157
41584158 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: >
41604160 set formatexpr=s:MyFormatExpr()
41614161 set formatexpr=<SID>SomeFormatExpr()
41624162< 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|.
48544854 global
48554855 This option specifies a function that will be called to
48564856 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.
48594859 It is not used in the MS-Windows GUI version.
48604860 The expression will be evaluated in the | sandbox | when set from a
48614861 modeline, see | sandbox-option | .
@@ -5034,7 +5034,7 @@ A jump table for the options with a short description can be found at |Q_op|.
50345034 Note: Not used for | <cfile> | .
50355035
50365036 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: >
50385038 setlocal includeexpr=s:MyIncludeExpr()
50395039 setlocal includeexpr=<SID>SomeIncludeExpr()
50405040< 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|.
51185118 when the expression is evaluated (but it may be moved around).
51195119
51205120 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: >
51225122 set indentexpr=s:MyIndentExpr()
51235123 set indentexpr=<SID>SomeIndentExpr()
51245124< 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|.
64166416 fit the highest line number in the buffer respectively the number of
64176417 rows in the window, depending on whether 'number' or 'relativenumber'
64186418 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
64206420 used. The minimum value is 1, the maximum value is 20.
64216421 NOTE: This option is set to the Vi default value when 'compatible' is
64226422 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|.
64306430 completion with CTRL-X CTRL-O . | i_CTRL-X_CTRL-O |
64316431 See | complete-functions | for an explanation of how the function is
64326432 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
64346434 more information.
64356435 This option is usually set by a filetype plugin:
64366436 | :filetype-plugin-on |
@@ -6452,7 +6452,7 @@ A jump table for the options with a short description can be found at |Q_op|.
64526452 global
64536453 This option specifies a function to be called by the | g@ | operator.
64546454 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
64566456 | option-value-function | for more information.
64576457
64586458 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|.
68516851 Available values are 0, 2 and 3.
68526852 If 'pyxversion' is 0, it is set to 2 or 3 after the first execution of
68536853 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.
68566856 See also: | has-pythonx |
68576857
68586858 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|.
68736873 for each entry in the corresponding quickfix or location list. See
68746874 | quickfix-window-function | for an explanation of how to write the
68756875 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
68776877 information.
68786878
68796879 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|.
77607760 `:silent ` was used for the command; note that this also
77617761 affects messages from autocommands and 'autoread' reloading
77627762 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
77647764 is shown), the "search hit BOTTOM, continuing at TOP" and
77657765 "search hit TOP, continuing at BOTTOM" messages are only
77667766 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|.
81868186
81878187 timeout:{millisec} Limit the time searching for suggestions to
81888188 {millisec} milliseconds. Applies to the following
8189- methods. When omitted the limit is 5000. When
8189+ methods. When omitted the limit is 5000. When
81908190 negative there is no limit. {only works when built
81918191 with the | +reltime | feature}
81928192
@@ -8780,7 +8780,7 @@ A jump table for the options with a short description can be found at |Q_op|.
87808780 The function gets the tag pattern and should return a List of matching
87818781 tags. See | tag-function | for an explanation of how to write the
87828782 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
87848784 information.
87858785 This option cannot be set from a | modeline | or in the | sandbox | , for
87868786 security reasons.
@@ -9606,7 +9606,7 @@ A jump table for the options with a short description can be found at |Q_op|.
96069606 {not available when compiled without the | +viminfo |
96079607 feature}
96089608 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
96109610 "NONE".
96119611 The string should be a comma-separated list of parameters, each
96129612 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|.
1005010050 d #define
1005110051 f function
1005210052
10053- This option does not apply to | ins-completion | . See 'completeopt' for
10053+ This option does not apply to | ins-completion | . See 'completeopt' for
1005410054 that.
1005510055
1005610056 *'winaltkeys'* *'wak'*
0 commit comments