1- *options.txt* For Vim version 9.1. Last change: 2025 Jul 25
1+ *options.txt* For Vim version 9.1. Last change: 2025 Aug 06
22
33
44 VIM REFERENCE MANUAL by Bram Moolenaar
@@ -1035,7 +1035,7 @@ A jump table for the options with a short description can be found at |Q_op|.
10351035< Vim will guess the value. In the GUI this should work correctly,
10361036 in other cases Vim might not be able to guess the right value.
10371037 If the GUI supports a dark theme, you can use the "d" flag in
1038- 'guioptions' , see 'go-d'.
1038+ 'guioptions' , see | 'go-d' | .
10391039
10401040 When the | t_RB | option is set, Vim will use it to request the background
10411041 color from the terminal. If the returned RGB value is dark/light and
@@ -1589,7 +1589,7 @@ A jump table for the options with a short description can be found at |Q_op|.
15891589 "nofile" and "nowrite" buffers are similar:
15901590 both: The buffer is not to be written to disk, ":w" doesn't
15911591 work (":w filename" does work though).
1592- both: The buffer is never considered to be | 'modified' | .
1592+ both: The buffer is never considered to be 'modified' .
15931593 There is no warning when the changes will be lost, for
15941594 example when you quit Vim.
15951595 both: A swap file is only created when using too much memory
@@ -1642,7 +1642,7 @@ A jump table for the options with a short description can be found at |Q_op|.
16421642 searched for has a relative path, not an absolute part starting with
16431643 "/", "./" or "../", the 'cdpath' option is not used then.
16441644 The 'cdpath' option's value has the same form and semantics as
1645- | 'path' | . Also see | file-searching | .
1645+ 'path' . Also see | file-searching | .
16461646 The default value is taken from $CDPATH, with a "," prepended to look
16471647 in the current directory first.
16481648 If the default value taken from $CDPATH is not what you want, include
@@ -2228,7 +2228,7 @@ A jump table for the options with a short description can be found at |Q_op|.
22282228 controls how completion candidates are reduced from the
22292229 list of alternatives. If you want to use | fuzzy-matching |
22302230 to gather more alternatives for your candidate list,
2231- see | 'completefuzzycollect' | .
2231+ see 'completefuzzycollect' .
22322232
22332233 longest Only insert the longest common text of the matches. If
22342234 the menu is displayed you can use CTRL-L to add more
@@ -2265,7 +2265,7 @@ A jump table for the options with a short description can be found at |Q_op|.
22652265 popup Show extra information about the currently selected
22662266 completion in a popup window. Only works in combination
22672267 with "menu" or "menuone". Overrides "preview".
2268- See | 'completepopup' | for specifying properties.
2268+ See 'completepopup' for specifying properties.
22692269 {only works when compiled with the | +textprop | feature}
22702270
22712271 popuphidden
@@ -2386,7 +2386,7 @@ A jump table for the options with a short description can be found at |Q_op|.
23862386 local to buffer
23872387 Copy the structure of the existing lines indent when autoindenting a
23882388 new line. Normally the new indent is reconstructed by a series of
2389- tabs followed by spaces as required (unless | 'expandtab' | is enabled,
2389+ tabs followed by spaces as required (unless 'expandtab' is enabled,
23902390 in which case only spaces are used). Enabling this option makes the
23912391 new line copy whatever characters were used for indenting on the
23922392 existing line. 'expandtab' has no effect on these characters, a Tab
@@ -2537,7 +2537,7 @@ A jump table for the options with a short description can be found at |Q_op|.
25372537 *cpo-m*
25382538 m When included, a showmatch will always wait half a
25392539 second. When not included, a showmatch will wait half
2540- a second or until a character is typed. | 'showmatch' |
2540+ a second or until a character is typed. 'showmatch'
25412541 *cpo-M*
25422542 M When excluded, "%" matching will take backslashes into
25432543 account. Thus in "( \( )" and "\( ( \)" the outer
@@ -5609,8 +5609,7 @@ A jump table for the options with a short description can be found at |Q_op|.
56095609'lispoptions' 'lop' string (default "")
56105610 local to buffer
56115611 Comma-separated list of items that influence the Lisp indenting when
5612- enabled with the | 'lisp' | option. Currently only one item is
5613- supported:
5612+ enabled with the 'lisp' option. Currently only one item is supported:
56145613 expr:1 use 'indentexpr' for Lisp indenting when it is set
56155614 expr:0 do not use 'indentexpr' for Lisp indenting (default)
56165615 Note that when using 'indentexpr' the `= ` operator indents all the
@@ -5620,7 +5619,7 @@ A jump table for the options with a short description can be found at |Q_op|.
56205619'lispwords' 'lw' string (default is very long)
56215620 global or local to buffer | global-local |
56225621 Comma-separated list of words that influence the Lisp indenting when
5623- enabled with the | 'lisp' | option.
5622+ enabled with the 'lisp' option.
56245623
56255624 *'list'* *'nolist'*
56265625'list' boolean (default off)
@@ -6112,7 +6111,7 @@ A jump table for the options with a short description can be found at |Q_op|.
61126111 When the mouse is not enabled, the GUI will still use the mouse for
61136112 modeless selection. This doesn't move the text cursor.
61146113
6115- See | mouse-using | . Also see | 'clipboard' | .
6114+ See | mouse-using | . Also see 'clipboard' .
61166115
61176116 Note: When enabling the mouse in a terminal, copy/paste will use the
61186117 "* register if there is access to an X-server. The xterm handling of
@@ -6603,7 +6602,7 @@ A jump table for the options with a short description can be found at |Q_op|.
66036602 local to buffer
66046603 When changing the indent of the current line, preserve as much of the
66056604 indent structure as possible. Normally the indent is replaced by a
6606- series of tabs followed by spaces as required (unless | 'expandtab' | is
6605+ series of tabs followed by spaces as required (unless 'expandtab' is
66076606 enabled, in which case only spaces are used). Enabling this option
66086607 means the indent will preserve as many existing characters as possible
66096608 for indenting, and only add additional tabs or spaces as required.
@@ -7238,7 +7237,7 @@ A jump table for the options with a short description can be found at |Q_op|.
72387237 current window also scrolls other scrollbind windows (windows that
72397238 also have this option set). This option is useful for viewing the
72407239 differences between two versions of a file, see 'diff' .
7241- See | 'scrollopt' | for options that determine how this option should be
7240+ See 'scrollopt' for options that determine how this option should be
72427241 interpreted.
72437242 This option is mostly reset when splitting a window to edit another
72447243 file. This means that ":split | edit file" results in two windows
@@ -7658,7 +7657,7 @@ A jump table for the options with a short description can be found at |Q_op|.
76587657'shiftwidth' 'sw' number (default 8)
76597658 local to buffer
76607659 Number of columns that make up one level of (auto)indentation. Used
7661- by | 'cindent' | , | << | , | >> | , etc.
7660+ by 'cindent' , | << | , | >> | , etc.
76627661 If set to 0, Vim uses the current 'tabstop' value. Use | shiftwidth() |
76637662 to obtain the effective value in scripts.
76647663
@@ -7881,7 +7880,7 @@ A jump table for the options with a short description can be found at |Q_op|.
78817880 global or local to window | global-local |
78827881 The minimal number of screen columns to keep to the left and to the
78837882 right of the cursor if 'nowrap' is set. Setting this option to a
7884- value greater than 0 while having | 'sidescroll' | also at a non-zero
7883+ value greater than 0 while having 'sidescroll' also at a non-zero
78857884 value makes some context visible in the line you are scrolling in
78867885 horizontally (except at beginning of the line). Setting this option
78877886 to a large value (like 999) has the effect of keeping the cursor
@@ -7893,9 +7892,9 @@ A jump table for the options with a short description can be found at |Q_op|.
78937892 setlocal sidescrolloff=-1
78947893< NOTE: This option is set to 0 when 'compatible' is set.
78957894
7896- Example: Try this together with 'sidescroll' and 'listchars' as
7897- in the following example to never allow the cursor to move
7898- onto the "extends" character: >
7895+ Example: Try this together with 'sidescroll' and 'listchars' as in the
7896+ following example to never allow the cursor to move onto the
7897+ "extends" character: >
78997898
79007899 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
79017900 :set sidescrolloff=1
@@ -7999,8 +7998,8 @@ A jump table for the options with a short description can be found at |Q_op|.
79997998 in-depth explanations.
80007999
80018000 If Vim is compiled with the | +vartabs | feature then the value of
8002- 'softtabstop' will be ignored if | 'varsofttabstop' | is set to
8003- anything other than an empty string.
8001+ 'softtabstop' will be ignored if 'varsofttabstop' is set to anything
8002+ other than an empty string.
80048003
80058004 *'spell'* *'nospell'*
80068005'spell' boolean (default off)
@@ -8443,12 +8442,12 @@ A jump table for the options with a short description can be found at |Q_op|.
84438442 Careful: All text will be in memory:
84448443 - Don't use this for big files.
84458444 - Recovery will be impossible!
8446- A swapfile will only be present when | 'updatecount' | is non-zero and
8445+ A swapfile will only be present when 'updatecount' is non-zero and
84478446 'swapfile' is set.
84488447 When 'swapfile' is reset, the swap file for the current buffer is
84498448 immediately deleted. When 'swapfile' is set, and 'updatecount' is
84508449 non-zero, a swap file is immediately created.
8451- Also see | swap-file | and | 'swapsync' | .
8450+ Also see | swap-file | and 'swapsync' .
84528451 If you want to open a new buffer without creating a swap file for it,
84538452 use the | :noswapfile | modifier.
84548453 See 'directory' for where the swap file is created.
@@ -8653,7 +8652,7 @@ A jump table for the options with a short description can be found at |Q_op|.
86538652 character (ASCII 9); a Horizontal Tab always advances to the next tab
86548653 stop.
86558654 The value must be at least 1 and at most 9999.
8656- If Vim was compiled with | +vartabs | and | 'vartabstop' | is set, this
8655+ If Vim was compiled with | +vartabs | and 'vartabstop' is set, this
86578656 option is ignored.
86588657 Leave it at 8 unless you have a strong reason (see usr | 30.5 | ).
86598658
@@ -9115,7 +9114,7 @@ A jump table for the options with a short description can be found at |Q_op|.
91159114 When Vim was compiled with HAVE_X11 defined, the original title will
91169115 be restored if possible. The output of ":version" will include "+X11"
91179116 when HAVE_X11 was defined, otherwise it will be "-X11". This also
9118- works for the icon name | 'icon' | .
9117+ works for the icon name 'icon' .
91199118 But: When Vim was started with the | -X | argument, restoring the title
91209119 will not work (except in the GUI).
91219120 If the title cannot be restored, it is set to the value of 'titleold' .
@@ -9348,7 +9347,7 @@ A jump table for the options with a short description can be found at |Q_op|.
93489347 global
93499348 {only when compiled with the | +persistent_undo | feature}
93509349 List of directory names for undo files, separated with commas.
9351- See | 'backupdir' | for details of the format.
9350+ See 'backupdir' for details of the format.
93529351 "." means using the directory of the file. The undo file name for
93539352 "file.txt" is ".file.txt.un~".
93549353 For other directories the file name is the full path of the edited
@@ -9420,13 +9419,13 @@ A jump table for the options with a short description can be found at |Q_op|.
94209419 recovery | crash-recovery | ). 'updatecount' is set to zero by starting
94219420 Vim with the "-n" option, see | startup | . When editing in readonly
94229421 mode this option will be initialized to 10000.
9423- The swapfile can be disabled per buffer with | 'swapfile' | .
9422+ The swapfile can be disabled per buffer with 'swapfile' .
94249423 When 'updatecount' is set from zero to non-zero, swap files are
94259424 created for all buffers that have 'swapfile' set. When 'updatecount'
94269425 is set to zero, existing swap files are not deleted.
9427- Also see | 'swapsync' | .
9428- This option has no meaning in buffers where | 'buftype' | is "nofile"
9429- or "nowrite".
9426+ Also see 'swapsync' .
9427+ This option has no meaning in buffers where 'buftype' is "nofile" or
9428+ "nowrite".
94309429
94319430 *'updatetime'* *'ut'*
94329431'updatetime' 'ut' number (default 4000)
0 commit comments